~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

merge merge tweaks from aaron, which includes latest .dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
# Copyright (C) 2005 Canonical Ltd
2
 
#
 
2
 
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
#
 
12
 
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18
18
"""
19
19
 
20
20
import os
21
 
from collections import deque
22
 
from cStringIO import StringIO
23
21
 
24
22
import bzrlib
25
 
from bzrlib import (
26
 
    delta,
27
 
    osutils,
28
 
    symbol_versioning,
29
 
    )
30
 
from bzrlib.decorators import needs_read_lock
31
 
from bzrlib.errors import BzrError, BzrCheckError
32
 
from bzrlib import errors
33
 
from bzrlib.inventory import Inventory, InventoryFile
34
 
from bzrlib.inter import InterObject
35
 
from bzrlib.osutils import fingerprint_file
36
 
import bzrlib.revision
37
23
from bzrlib.trace import mutter, note
38
 
 
 
24
from bzrlib.errors import BzrError
 
25
from bzrlib.inventory import Inventory
 
26
from bzrlib.osutils import pumpfile, appendpath, fingerprint_file
 
27
 
 
28
 
 
29
exporters = {}
39
30
 
40
31
class Tree(object):
41
32
    """Abstract file tree.
46
37
 
47
38
    * `RevisionTree` is a tree as recorded at some point in the past.
48
39
 
 
40
    * `EmptyTree`
 
41
 
49
42
    Trees contain an `Inventory` object, and also know how to retrieve
50
43
    file texts mentioned in the inventory, either from a working
51
44
    directory or from a store.
57
50
    trees or versioned trees.
58
51
    """
59
52
    
60
 
    def changes_from(self, other, want_unchanged=False, specific_files=None,
61
 
        extra_trees=None, require_versioned=False, include_root=False,
62
 
        want_unversioned=False):
63
 
        """Return a TreeDelta of the changes from other to this tree.
64
 
 
65
 
        :param other: A tree to compare with.
66
 
        :param specific_files: An optional list of file paths to restrict the
67
 
            comparison to. When mapping filenames to ids, all matches in all
68
 
            trees (including optional extra_trees) are used, and all children of
69
 
            matched directories are included.
70
 
        :param want_unchanged: An optional boolean requesting the inclusion of
71
 
            unchanged entries in the result.
72
 
        :param extra_trees: An optional list of additional trees to use when
73
 
            mapping the contents of specific_files (paths) to file_ids.
74
 
        :param require_versioned: An optional boolean (defaults to False). When
75
 
            supplied and True all the 'specific_files' must be versioned, or
76
 
            a PathsNotVersionedError will be thrown.
77
 
        :param want_unversioned: Scan for unversioned paths.
78
 
 
79
 
        The comparison will be performed by an InterTree object looked up on 
80
 
        self and other.
81
 
        """
82
 
        # Martin observes that Tree.changes_from returns a TreeDelta and this
83
 
        # may confuse people, because the class name of the returned object is
84
 
        # a synonym of the object referenced in the method name.
85
 
        return InterTree.get(other, self).compare(
86
 
            want_unchanged=want_unchanged,
87
 
            specific_files=specific_files,
88
 
            extra_trees=extra_trees,
89
 
            require_versioned=require_versioned,
90
 
            include_root=include_root,
91
 
            want_unversioned=want_unversioned,
92
 
            )
93
 
 
94
 
    def _iter_changes(self, from_tree, include_unchanged=False,
95
 
                     specific_files=None, pb=None, extra_trees=None,
96
 
                     require_versioned=True, want_unversioned=False):
97
 
        intertree = InterTree.get(from_tree, self)
98
 
        return intertree._iter_changes(include_unchanged, specific_files, pb,
99
 
            extra_trees, require_versioned, want_unversioned=want_unversioned)
100
 
    
101
 
    def conflicts(self):
102
 
        """Get a list of the conflicts in the tree.
103
 
 
104
 
        Each conflict is an instance of bzrlib.conflicts.Conflict.
105
 
        """
106
 
        return []
107
 
 
108
 
    def extras(self):
109
 
        """For trees that can have unversioned files, return all such paths."""
110
 
        return []
111
 
 
112
 
    def get_parent_ids(self):
113
 
        """Get the parent ids for this tree. 
114
 
 
115
 
        :return: a list of parent ids. [] is returned to indicate
116
 
        a tree with no parents.
117
 
        :raises: BzrError if the parents are not known.
118
 
        """
119
 
        raise NotImplementedError(self.get_parent_ids)
120
 
    
121
53
    def has_filename(self, filename):
122
54
        """True if the tree has given filename."""
123
55
        raise NotImplementedError()
124
56
 
125
57
    def has_id(self, file_id):
126
 
        file_id = osutils.safe_file_id(file_id)
127
58
        return self.inventory.has_id(file_id)
128
59
 
129
60
    __contains__ = has_id
130
61
 
131
 
    def has_or_had_id(self, file_id):
132
 
        file_id = osutils.safe_file_id(file_id)
133
 
        if file_id == self.inventory.root.file_id:
134
 
            return True
135
 
        return self.inventory.has_id(file_id)
136
 
 
137
 
    def is_ignored(self, filename):
138
 
        """Check whether the filename is ignored by this tree.
139
 
 
140
 
        :param filename: The relative filename within the tree.
141
 
        :return: True if the filename is ignored.
142
 
        """
143
 
        return False
144
 
 
145
62
    def __iter__(self):
146
63
        return iter(self.inventory)
147
64
 
148
65
    def id2path(self, file_id):
149
 
        """Return the path for a file id.
150
 
 
151
 
        :raises NoSuchId:
152
 
        """
153
 
        file_id = osutils.safe_file_id(file_id)
154
66
        return self.inventory.id2path(file_id)
155
67
 
156
 
    def is_control_filename(self, filename):
157
 
        """True if filename is the name of a control file in this tree.
158
 
        
159
 
        :param filename: A filename within the tree. This is a relative path
160
 
        from the root of this tree.
161
 
 
162
 
        This is true IF and ONLY IF the filename is part of the meta data
163
 
        that bzr controls in this tree. I.E. a random .bzr directory placed
164
 
        on disk will not be a control file for this tree.
165
 
        """
166
 
        return self.bzrdir.is_control_filename(filename)
167
 
 
168
 
    @needs_read_lock
169
 
    def iter_entries_by_dir(self, specific_file_ids=None):
170
 
        """Walk the tree in 'by_dir' order.
171
 
 
172
 
        This will yield each entry in the tree as a (path, entry) tuple. The
173
 
        order that they are yielded is: the contents of a directory are 
174
 
        preceeded by the parent of a directory, and all the contents of a 
175
 
        directory are grouped together.
176
 
        """
177
 
        return self.inventory.iter_entries_by_dir(
178
 
            specific_file_ids=specific_file_ids)
179
 
 
180
 
    def iter_references(self):
181
 
        for path, entry in self.iter_entries_by_dir():
182
 
            if entry.kind == 'tree-reference':
183
 
                yield path, entry.file_id
184
 
 
185
 
    def kind(self, file_id):
186
 
        raise NotImplementedError("Tree subclass %s must implement kind"
187
 
            % self.__class__.__name__)
188
 
 
189
 
    def get_reference_revision(self, file_id, path=None):
190
 
        raise NotImplementedError("Tree subclass %s must implement "
191
 
                                  "get_reference_revision"
192
 
            % self.__class__.__name__)
193
 
 
194
 
    def _comparison_data(self, entry, path):
195
 
        """Return a tuple of kind, executable, stat_value for a file.
196
 
 
197
 
        entry may be None if there is no inventory entry for the file, but
198
 
        path must always be supplied.
199
 
 
200
 
        kind is None if there is no file present (even if an inventory id is
201
 
        present).  executable is False for non-file entries.
202
 
        """
203
 
        raise NotImplementedError(self._comparison_data)
204
 
 
205
 
    def _file_size(self, entry, stat_value):
206
 
        raise NotImplementedError(self._file_size)
207
 
 
208
68
    def _get_inventory(self):
209
69
        return self._inventory
210
70
    
211
 
    def get_file(self, file_id):
212
 
        """Return a file object for the file file_id in the tree."""
213
 
        raise NotImplementedError(self.get_file)
214
 
 
215
 
    def get_file_mtime(self, file_id, path=None):
216
 
        """Return the modification time for a file.
217
 
 
218
 
        :param file_id: The handle for this file.
219
 
        :param path: The path that this file can be found at.
220
 
            These must point to the same object.
221
 
        """
222
 
        raise NotImplementedError(self.get_file_mtime)
223
 
 
224
71
    def get_file_by_path(self, path):
225
72
        return self.get_file(self._inventory.path2id(path))
226
73
 
227
 
    def get_symlink_target(self, file_id):
228
 
        """Get the target for a given file_id.
229
 
 
230
 
        It is assumed that the caller already knows that file_id is referencing
231
 
        a symlink.
232
 
        :param file_id: Handle for the symlink entry.
233
 
        :return: The path the symlink points to.
234
 
        """
235
 
        raise NotImplementedError(self.get_symlink_target)
236
 
 
237
 
    def annotate_iter(self, file_id):
238
 
        """Return an iterator of revision_id, line tuples
239
 
 
240
 
        For working trees (and mutable trees in general), the special
241
 
        revision_id 'current:' will be used for lines that are new in this
242
 
        tree, e.g. uncommitted changes.
243
 
        :param file_id: The file to produce an annotated version from
244
 
        """
245
 
        raise NotImplementedError(self.annotate_iter)
246
 
 
247
74
    inventory = property(_get_inventory,
248
75
                         doc="Inventory of this Tree")
249
76
 
250
77
    def _check_retrieved(self, ie, f):
251
 
        if not __debug__:
252
 
            return  
253
78
        fp = fingerprint_file(f)
254
79
        f.seek(0)
255
80
        
256
 
        if ie.text_size is not None:
 
81
        if ie.text_size != None:
257
82
            if ie.text_size != fp['size']:
258
83
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
259
84
                        ["inventory expects %d bytes" % ie.text_size,
266
91
                     "file is actually %s" % fp['sha1'],
267
92
                     "store is probably damaged/corrupt"])
268
93
 
269
 
    def path2id(self, path):
270
 
        """Return the id for path in this tree."""
271
 
        return self._inventory.path2id(path)
272
 
 
273
 
    def paths2ids(self, paths, trees=[], require_versioned=True):
274
 
        """Return all the ids that can be reached by walking from paths.
275
 
        
276
 
        Each path is looked up in each this tree and any extras provided in
277
 
        trees, and this is repeated recursively: the children in an extra tree
278
 
        of a directory that has been renamed under a provided path in this tree
279
 
        are all returned, even if none exist until a provided path in this
280
 
        tree, and vice versa.
281
 
 
282
 
        :param paths: An iterable of paths to start converting to ids from.
283
 
            Alternatively, if paths is None, no ids should be calculated and None
284
 
            will be returned. This is offered to make calling the api unconditional
285
 
            for code that *might* take a list of files.
286
 
        :param trees: Additional trees to consider.
287
 
        :param require_versioned: If False, do not raise NotVersionedError if
288
 
            an element of paths is not versioned in this tree and all of trees.
289
 
        """
290
 
        return find_ids_across_trees(paths, [self] + list(trees), require_versioned)
291
 
 
292
 
    def print_file(self, file_id):
293
 
        """Print file with id `file_id` to stdout."""
294
 
        file_id = osutils.safe_file_id(file_id)
 
94
 
 
95
    def print_file(self, fileid):
 
96
        """Print file with id `fileid` to stdout."""
295
97
        import sys
296
 
        sys.stdout.write(self.get_file_text(file_id))
297
 
 
298
 
    def lock_read(self):
299
 
        pass
300
 
 
301
 
    def revision_tree(self, revision_id):
302
 
        """Obtain a revision tree for the revision revision_id.
303
 
 
304
 
        The intention of this method is to allow access to possibly cached
305
 
        tree data. Implementors of this method should raise NoSuchRevision if
306
 
        the tree is not locally available, even if they could obtain the 
307
 
        tree via a repository or some other means. Callers are responsible 
308
 
        for finding the ultimate source for a revision tree.
309
 
 
310
 
        :param revision_id: The revision_id of the requested tree.
311
 
        :return: A Tree.
312
 
        :raises: NoSuchRevision if the tree cannot be obtained.
313
 
        """
314
 
        raise errors.NoSuchRevisionInTree(self, revision_id)
315
 
 
316
 
    def unknowns(self):
317
 
        """What files are present in this tree and unknown.
318
 
        
319
 
        :return: an iterator over the unknown files.
320
 
        """
321
 
        return iter([])
322
 
 
323
 
    def unlock(self):
324
 
        pass
325
 
 
326
 
    def filter_unversioned_files(self, paths):
327
 
        """Filter out paths that are versioned.
328
 
 
329
 
        :return: set of paths.
330
 
        """
331
 
        # NB: we specifically *don't* call self.has_filename, because for
332
 
        # WorkingTrees that can indicate files that exist on disk but that 
333
 
        # are not versioned.
334
 
        pred = self.inventory.has_filename
335
 
        return set((p for p in paths if not pred(p)))
336
 
 
337
 
    def walkdirs(self, prefix=""):
338
 
        """Walk the contents of this tree from path down.
339
 
 
340
 
        This yields all the data about the contents of a directory at a time.
341
 
        After each directory has been yielded, if the caller has mutated the
342
 
        list to exclude some directories, they are then not descended into.
343
 
        
344
 
        The data yielded is of the form:
345
 
        ((directory-relpath, directory-path-from-root, directory-fileid),
346
 
        [(relpath, basename, kind, lstat, path_from_tree_root, file_id, 
347
 
          versioned_kind), ...]),
348
 
         - directory-relpath is the containing dirs relpath from prefix
349
 
         - directory-path-from-root is the containing dirs path from /
350
 
         - directory-fileid is the id of the directory if it is versioned.
351
 
         - relpath is the relative path within the subtree being walked.
352
 
         - basename is the basename
353
 
         - kind is the kind of the file now. If unknonwn then the file is not
354
 
           present within the tree - but it may be recorded as versioned. See
355
 
           versioned_kind.
356
 
         - lstat is the stat data *if* the file was statted.
357
 
         - path_from_tree_root is the path from the root of the tree.
358
 
         - file_id is the file_id is the entry is versioned.
359
 
         - versioned_kind is the kind of the file as last recorded in the 
360
 
           versioning system. If 'unknown' the file is not versioned.
361
 
        One of 'kind' and 'versioned_kind' must not be 'unknown'.
362
 
 
363
 
        :param prefix: Start walking from prefix within the tree rather than
364
 
        at the root. This allows one to walk a subtree but get paths that are
365
 
        relative to a tree rooted higher up.
366
 
        :return: an iterator over the directory data.
367
 
        """
368
 
        raise NotImplementedError(self.walkdirs)
 
98
        pumpfile(self.get_file(fileid), sys.stdout)
 
99
        
 
100
        
 
101
    def export(self, dest, format='dir', root=None):
 
102
        """Export this tree."""
 
103
        try:
 
104
            exporter = exporters[format]
 
105
        except KeyError:
 
106
            from bzrlib.errors import BzrCommandError
 
107
            raise BzrCommandError("export format %r not supported" % format)
 
108
        exporter(self, dest, root)
 
109
 
 
110
 
 
111
 
 
112
class RevisionTree(Tree):
 
113
    """Tree viewing a previous revision.
 
114
 
 
115
    File text can be retrieved from the text store.
 
116
 
 
117
    TODO: Some kind of `__repr__` method, but a good one
 
118
           probably means knowing the branch and revision number,
 
119
           or at least passing a description to the constructor.
 
120
    """
 
121
    
 
122
    def __init__(self, store, inv):
 
123
        self._store = store
 
124
        self._inventory = inv
 
125
 
 
126
    def get_file(self, file_id):
 
127
        ie = self._inventory[file_id]
 
128
        f = self._store[ie.text_id]
 
129
        mutter("  get fileid{%s} from %r" % (file_id, self))
 
130
        self._check_retrieved(ie, f)
 
131
        return f
 
132
 
 
133
    def get_file_size(self, file_id):
 
134
        return self._inventory[file_id].text_size
 
135
 
 
136
    def get_file_sha1(self, file_id):
 
137
        ie = self._inventory[file_id]
 
138
        if ie.kind == "file":
 
139
            return ie.text_sha1
 
140
 
 
141
    def has_filename(self, filename):
 
142
        return bool(self.inventory.path2id(filename))
 
143
 
 
144
    def list_files(self):
 
145
        # The only files returned by this are those from the version
 
146
        for path, entry in self.inventory.iter_entries():
 
147
            yield path, 'V', entry.kind, entry.file_id
369
148
 
370
149
 
371
150
class EmptyTree(Tree):
372
 
 
373
151
    def __init__(self):
374
 
        self._inventory = Inventory(root_id=None)
375
 
        symbol_versioning.warn('EmptyTree is deprecated as of bzr 0.9 please'
376
 
                               ' use repository.revision_tree instead.',
377
 
                               DeprecationWarning, stacklevel=2)
378
 
 
379
 
    def get_parent_ids(self):
380
 
        return []
381
 
 
382
 
    def get_symlink_target(self, file_id):
383
 
        return None
 
152
        self._inventory = Inventory()
384
153
 
385
154
    def has_filename(self, filename):
386
155
        return False
387
156
 
388
 
    def kind(self, file_id):
389
 
        file_id = osutils.safe_file_id(file_id)
390
 
        assert self._inventory[file_id].kind == "directory"
391
 
        return "directory"
392
 
 
393
 
    def list_files(self, include_root=False):
394
 
        return iter([])
 
157
    def list_files(self):
 
158
        if False:  # just to make it a generator
 
159
            yield None
395
160
    
396
161
    def __contains__(self, file_id):
397
 
        file_id = osutils.safe_file_id(file_id)
398
 
        return (file_id in self._inventory)
 
162
        return file_id in self._inventory
399
163
 
400
 
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
164
    def get_file_sha1(self, file_id):
 
165
        assert self._inventory[file_id].kind == "root_directory"
401
166
        return None
402
167
 
403
168
 
 
169
 
 
170
 
404
171
######################################################################
405
172
# diff
406
173
 
466
233
            yield (old_name, new_name)
467
234
            
468
235
 
469
 
def find_ids_across_trees(filenames, trees, require_versioned=True):
470
 
    """Find the ids corresponding to specified filenames.
471
 
    
472
 
    All matches in all trees will be used, and all children of matched
473
 
    directories will be used.
474
 
 
475
 
    :param filenames: The filenames to find file_ids for (if None, returns
476
 
        None)
477
 
    :param trees: The trees to find file_ids within
478
 
    :param require_versioned: if true, all specified filenames must occur in
479
 
    at least one tree.
480
 
    :return: a set of file ids for the specified filenames and their children.
481
 
    """
482
 
    if not filenames:
483
 
        return None
484
 
    specified_path_ids = _find_ids_across_trees(filenames, trees,
485
 
        require_versioned)
486
 
    return _find_children_across_trees(specified_path_ids, trees)
487
 
 
488
 
 
489
 
def _find_ids_across_trees(filenames, trees, require_versioned):
490
 
    """Find the ids corresponding to specified filenames.
491
 
    
492
 
    All matches in all trees will be used, but subdirectories are not scanned.
493
 
 
494
 
    :param filenames: The filenames to find file_ids for
495
 
    :param trees: The trees to find file_ids within
496
 
    :param require_versioned: if true, all specified filenames must occur in
497
 
        at least one tree.
498
 
    :return: a set of (path, file ids) for the specified filenames
499
 
    """
500
 
    not_versioned = []
501
 
    interesting_ids = set()
502
 
    for tree_path in filenames:
503
 
        not_found = True
504
 
        for tree in trees:
505
 
            file_id = tree.path2id(tree_path)
506
 
            if file_id is not None:
507
 
                interesting_ids.add(file_id)
508
 
                not_found = False
509
 
        if not_found:
510
 
            not_versioned.append(tree_path)
511
 
    if len(not_versioned) > 0 and require_versioned:
512
 
        raise errors.PathsNotVersionedError(not_versioned)
513
 
    return interesting_ids
514
 
 
515
 
 
516
 
def _find_children_across_trees(specified_ids, trees):
517
 
    """Return a set including specified ids and their children
518
 
    
519
 
    All matches in all trees will be used.
520
 
 
521
 
    :param trees: The trees to find file_ids within
522
 
    :return: a set containing all specified ids and their children 
523
 
    """
524
 
    interesting_ids = set(specified_ids)
525
 
    pending = interesting_ids
526
 
    # now handle children of interesting ids
527
 
    # we loop so that we handle all children of each id in both trees
528
 
    while len(pending) > 0:
529
 
        new_pending = set()
530
 
        for file_id in pending:
531
 
            for tree in trees:
532
 
                if not tree.has_id(file_id):
533
 
                    continue
534
 
                entry = tree.inventory[file_id]
535
 
                for child in getattr(entry, 'children', {}).itervalues():
536
 
                    if child.file_id not in interesting_ids:
537
 
                        new_pending.add(child.file_id)
538
 
        interesting_ids.update(new_pending)
539
 
        pending = new_pending
540
 
    return interesting_ids
541
 
 
542
 
 
543
 
class InterTree(InterObject):
544
 
    """This class represents operations taking place between two Trees.
545
 
 
546
 
    Its instances have methods like 'compare' and contain references to the
547
 
    source and target trees these operations are to be carried out on.
548
 
 
549
 
    clients of bzrlib should not need to use InterTree directly, rather they
550
 
    should use the convenience methods on Tree such as 'Tree.compare()' which
551
 
    will pass through to InterTree as appropriate.
552
 
    """
553
 
 
554
 
    _optimisers = []
555
 
 
556
 
    @needs_read_lock
557
 
    def compare(self, want_unchanged=False, specific_files=None,
558
 
        extra_trees=None, require_versioned=False, include_root=False,
559
 
        want_unversioned=False):
560
 
        """Return the changes from source to target.
561
 
 
562
 
        :return: A TreeDelta.
563
 
        :param specific_files: An optional list of file paths to restrict the
564
 
            comparison to. When mapping filenames to ids, all matches in all
565
 
            trees (including optional extra_trees) are used, and all children of
566
 
            matched directories are included.
567
 
        :param want_unchanged: An optional boolean requesting the inclusion of
568
 
            unchanged entries in the result.
569
 
        :param extra_trees: An optional list of additional trees to use when
570
 
            mapping the contents of specific_files (paths) to file_ids.
571
 
        :param require_versioned: An optional boolean (defaults to False). When
572
 
            supplied and True all the 'specific_files' must be versioned, or
573
 
            a PathsNotVersionedError will be thrown.
574
 
        :param want_unversioned: Scan for unversioned paths.
575
 
        """
576
 
        # NB: show_status depends on being able to pass in non-versioned files
577
 
        # and report them as unknown
578
 
        trees = (self.source,)
579
 
        if extra_trees is not None:
580
 
            trees = trees + tuple(extra_trees)
581
 
        # target is usually the newer tree:
582
 
        specific_file_ids = self.target.paths2ids(specific_files, trees,
583
 
            require_versioned=require_versioned)
584
 
        if specific_files and not specific_file_ids:
585
 
            # All files are unversioned, so just return an empty delta
586
 
            # _compare_trees would think we want a complete delta
587
 
            result = delta.TreeDelta()
588
 
            fake_entry = InventoryFile('unused', 'unused', 'unused')
589
 
            result.unversioned = [(path, None,
590
 
                self.target._comparison_data(fake_entry, path)[0]) for path in
591
 
                specific_files]
592
 
            return result
593
 
        return delta._compare_trees(self.source, self.target, want_unchanged,
594
 
            specific_files, include_root, extra_trees=extra_trees,
595
 
            want_unversioned=want_unversioned)
596
 
 
597
 
    def _iter_changes(self, include_unchanged=False,
598
 
                      specific_files=None, pb=None, extra_trees=[],
599
 
                      require_versioned=True, want_unversioned=False):
600
 
        """Generate an iterator of changes between trees.
601
 
 
602
 
        A tuple is returned:
603
 
        (file_id, (path_in_source, path_in_target),
604
 
         changed_content, versioned, parent, name, kind,
605
 
         executable)
606
 
 
607
 
        Changed_content is True if the file's content has changed.  This
608
 
        includes changes to its kind, and to a symlink's target.
609
 
 
610
 
        versioned, parent, name, kind, executable are tuples of (from, to).
611
 
        If a file is missing in a tree, its kind is None.
612
 
 
613
 
        Iteration is done in parent-to-child order, relative to the target
614
 
        tree.
615
 
 
616
 
        There is no guarantee that all paths are in sorted order: the
617
 
        requirement to expand the search due to renames may result in children
618
 
        that should be found early being found late in the search, after
619
 
        lexically later results have been returned.
620
 
        :param require_versioned: Raise errors.PathsNotVersionedError if a
621
 
            path in the specific_files list is not versioned in one of
622
 
            source, target or extra_trees.
623
 
        :param want_unversioned: Should unversioned files be returned in the
624
 
            output. An unversioned file is defined as one with (False, False)
625
 
            for the versioned pair.
626
 
        """
627
 
        result = []
628
 
        lookup_trees = [self.source]
629
 
        if extra_trees:
630
 
             lookup_trees.extend(extra_trees)
631
 
        specific_file_ids = self.target.paths2ids(specific_files,
632
 
            lookup_trees, require_versioned=require_versioned)
633
 
        if want_unversioned:
634
 
            all_unversioned = sorted([(p.split('/'), p) for p in self.target.extras()
635
 
                if not specific_files or
636
 
                    osutils.is_inside_any(specific_files, p)])
637
 
            all_unversioned = deque(all_unversioned)
 
236
 
 
237
######################################################################
 
238
# export
 
239
 
 
240
def dir_exporter(tree, dest, root):
 
241
    """Export this tree to a new directory.
 
242
 
 
243
    `dest` should not exist, and will be created holding the
 
244
    contents of this tree.
 
245
 
 
246
    TODO: To handle subdirectories we need to create the
 
247
           directories first.
 
248
 
 
249
    :note: If the export fails, the destination directory will be
 
250
           left in a half-assed state.
 
251
    """
 
252
    import os
 
253
    os.mkdir(dest)
 
254
    mutter('export version %r' % tree)
 
255
    inv = tree.inventory
 
256
    for dp, ie in inv.iter_entries():
 
257
        kind = ie.kind
 
258
        fullpath = appendpath(dest, dp)
 
259
        if kind == 'directory':
 
260
            os.mkdir(fullpath)
 
261
        elif kind == 'file':
 
262
            pumpfile(tree.get_file(ie.file_id), file(fullpath, 'wb'))
638
263
        else:
639
 
            all_unversioned = deque()
640
 
        to_paths = {}
641
 
        from_entries_by_dir = list(self.source.inventory.iter_entries_by_dir(
642
 
            specific_file_ids=specific_file_ids))
643
 
        from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
644
 
        to_entries_by_dir = list(self.target.inventory.iter_entries_by_dir(
645
 
            specific_file_ids=specific_file_ids))
646
 
        num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
647
 
        entry_count = 0
648
 
        # the unversioned path lookup only occurs on real trees - where there 
649
 
        # can be extras. So the fake_entry is solely used to look up
650
 
        # executable it values when execute is not supported.
651
 
        fake_entry = InventoryFile('unused', 'unused', 'unused')
652
 
        for to_path, to_entry in to_entries_by_dir:
653
 
            while all_unversioned and all_unversioned[0][0] < to_path.split('/'):
654
 
                unversioned_path = all_unversioned.popleft()
655
 
                to_kind, to_executable, to_stat = \
656
 
                    self.target._comparison_data(fake_entry, unversioned_path[1])
657
 
                yield (None, (None, unversioned_path[1]), True, (False, False),
658
 
                    (None, None),
659
 
                    (None, unversioned_path[0][-1]),
660
 
                    (None, to_kind),
661
 
                    (None, to_executable))
662
 
            file_id = to_entry.file_id
663
 
            to_paths[file_id] = to_path
664
 
            entry_count += 1
665
 
            changed_content = False
666
 
            from_path, from_entry = from_data.get(file_id, (None, None))
667
 
            from_versioned = (from_entry is not None)
668
 
            if from_entry is not None:
669
 
                from_versioned = True
670
 
                from_name = from_entry.name
671
 
                from_parent = from_entry.parent_id
672
 
                from_kind, from_executable, from_stat = \
673
 
                    self.source._comparison_data(from_entry, from_path)
674
 
                entry_count += 1
675
 
            else:
676
 
                from_versioned = False
677
 
                from_kind = None
678
 
                from_parent = None
679
 
                from_name = None
680
 
                from_executable = None
681
 
            versioned = (from_versioned, True)
682
 
            to_kind, to_executable, to_stat = \
683
 
                self.target._comparison_data(to_entry, to_path)
684
 
            kind = (from_kind, to_kind)
685
 
            if kind[0] != kind[1]:
686
 
                changed_content = True
687
 
            elif from_kind == 'file':
688
 
                from_size = self.source._file_size(from_entry, from_stat)
689
 
                to_size = self.target._file_size(to_entry, to_stat)
690
 
                if from_size != to_size:
691
 
                    changed_content = True
692
 
                elif (self.source.get_file_sha1(file_id, from_path, from_stat) !=
693
 
                    self.target.get_file_sha1(file_id, to_path, to_stat)):
694
 
                    changed_content = True
695
 
            elif from_kind == 'symlink':
696
 
                if (self.source.get_symlink_target(file_id) !=
697
 
                    self.target.get_symlink_target(file_id)):
698
 
                    changed_content = True
699
 
                elif from_kind == 'tree-reference':
700
 
                    if (self.source.get_reference_revision(file_id, from_path)
701
 
                        != self.target.get_reference_revision(file_id, to_path)):
702
 
                        changed_content = True 
703
 
            parent = (from_parent, to_entry.parent_id)
704
 
            name = (from_name, to_entry.name)
705
 
            executable = (from_executable, to_executable)
706
 
            if pb is not None:
707
 
                pb.update('comparing files', entry_count, num_entries)
708
 
            if (changed_content is not False or versioned[0] != versioned[1]
709
 
                or parent[0] != parent[1] or name[0] != name[1] or 
710
 
                executable[0] != executable[1] or include_unchanged):
711
 
                yield (file_id, (from_path, to_path), changed_content,
712
 
                    versioned, parent, name, kind, executable)
713
 
 
714
 
        while all_unversioned:
715
 
            # yield any trailing unversioned paths
716
 
            unversioned_path = all_unversioned.popleft()
717
 
            to_kind, to_executable, to_stat = \
718
 
                self.target._comparison_data(fake_entry, unversioned_path[1])
719
 
            yield (None, (None, unversioned_path[1]), True, (False, False),
720
 
                (None, None),
721
 
                (None, unversioned_path[0][-1]),
722
 
                (None, to_kind),
723
 
                (None, to_executable))
724
 
 
725
 
        def get_to_path(to_entry):
726
 
            if to_entry.parent_id is None:
727
 
                to_path = '' # the root
728
 
            else:
729
 
                if to_entry.parent_id not in to_paths:
730
 
                    # recurse up
731
 
                    return get_to_path(self.target.inventory[to_entry.parent_id])
732
 
                to_path = osutils.pathjoin(to_paths[to_entry.parent_id],
733
 
                                           to_entry.name)
734
 
            to_paths[to_entry.file_id] = to_path
735
 
            return to_path
736
 
 
737
 
        for path, from_entry in from_entries_by_dir:
738
 
            file_id = from_entry.file_id
739
 
            if file_id in to_paths:
740
 
                # already returned
741
 
                continue
742
 
            if not file_id in self.target.inventory:
743
 
                # common case - paths we have not emitted are not present in
744
 
                # target.
745
 
                to_path = None
746
 
            else:
747
 
                to_path = get_to_path(self.target.inventory[file_id])
748
 
            entry_count += 1
749
 
            if pb is not None:
750
 
                pb.update('comparing files', entry_count, num_entries)
751
 
            versioned = (True, False)
752
 
            parent = (from_entry.parent_id, None)
753
 
            name = (from_entry.name, None)
754
 
            from_kind, from_executable, stat_value = \
755
 
                self.source._comparison_data(from_entry, path)
756
 
            kind = (from_kind, None)
757
 
            executable = (from_executable, None)
758
 
            changed_content = True
759
 
            # the parent's path is necessarily known at this point.
760
 
            yield(file_id, (path, to_path), changed_content, versioned, parent,
761
 
                  name, kind, executable)
762
 
 
763
 
 
764
 
# This was deprecated before 0.12, but did not have an official warning
765
 
@symbol_versioning.deprecated_function(symbol_versioning.zero_twelve)
766
 
def RevisionTree(*args, **kwargs):
767
 
    """RevisionTree has moved to bzrlib.revisiontree.RevisionTree()
768
 
 
769
 
    Accessing it as bzrlib.tree.RevisionTree has been deprecated as of
770
 
    bzr 0.12.
771
 
    """
772
 
    from bzrlib.revisiontree import RevisionTree as _RevisionTree
773
 
    return _RevisionTree(*args, **kwargs)
774
 
 
775
 
 
 
264
            raise BzrError("don't know how to export {%s} of kind %r" % (ie.file_id, kind))
 
265
        mutter("  export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
 
266
exporters['dir'] = dir_exporter
 
267
 
 
268
try:
 
269
    import tarfile
 
270
except ImportError:
 
271
    pass
 
272
else:
 
273
    def get_root_name(dest):
 
274
        """Get just the root name for a tarball.
 
275
 
 
276
        >>> get_root_name('mytar.tar')
 
277
        'mytar'
 
278
        >>> get_root_name('mytar.tar.bz2')
 
279
        'mytar'
 
280
        >>> get_root_name('tar.tar.tar.tgz')
 
281
        'tar.tar.tar'
 
282
        >>> get_root_name('bzr-0.0.5.tar.gz')
 
283
        'bzr-0.0.5'
 
284
        >>> get_root_name('a/long/path/mytar.tgz')
 
285
        'mytar'
 
286
        >>> get_root_name('../parent/../dir/other.tbz2')
 
287
        'other'
 
288
        """
 
289
        endings = ['.tar', '.tar.gz', '.tgz', '.tar.bz2', '.tbz2']
 
290
        dest = os.path.basename(dest)
 
291
        for end in endings:
 
292
            if dest.endswith(end):
 
293
                return dest[:-len(end)]
 
294
 
 
295
    def tar_exporter(tree, dest, root, compression=None):
 
296
        """Export this tree to a new tar file.
 
297
 
 
298
        `dest` will be created holding the contents of this tree; if it
 
299
        already exists, it will be clobbered, like with "tar -c".
 
300
        """
 
301
        from time import time
 
302
        now = time()
 
303
        compression = str(compression or '')
 
304
        if root is None:
 
305
            root = get_root_name(dest)
 
306
        try:
 
307
            ball = tarfile.open(dest, 'w:' + compression)
 
308
        except tarfile.CompressionError, e:
 
309
            raise BzrError(str(e))
 
310
        mutter('export version %r' % tree)
 
311
        inv = tree.inventory
 
312
        for dp, ie in inv.iter_entries():
 
313
            mutter("  export {%s} kind %s to %s" % (ie.file_id, ie.kind, dest))
 
314
            item = tarfile.TarInfo(os.path.join(root, dp))
 
315
            # TODO: would be cool to actually set it to the timestamp of the
 
316
            # revision it was last changed
 
317
            item.mtime = now
 
318
            if ie.kind == 'directory':
 
319
                item.type = tarfile.DIRTYPE
 
320
                fileobj = None
 
321
                item.name += '/'
 
322
                item.size = 0
 
323
                item.mode = 0755
 
324
            elif ie.kind == 'file':
 
325
                item.type = tarfile.REGTYPE
 
326
                fileobj = tree.get_file(ie.file_id)
 
327
                item.size = _find_file_size(fileobj)
 
328
                item.mode = 0644
 
329
            else:
 
330
                raise BzrError("don't know how to export {%s} of kind %r" %
 
331
                        (ie.file_id, ie.kind))
 
332
 
 
333
            ball.addfile(item, fileobj)
 
334
        ball.close()
 
335
    exporters['tar'] = tar_exporter
 
336
 
 
337
    def tgz_exporter(tree, dest, root):
 
338
        tar_exporter(tree, dest, root, compression='gz')
 
339
    exporters['tgz'] = tgz_exporter
 
340
 
 
341
    def tbz_exporter(tree, dest, root):
 
342
        tar_exporter(tree, dest, root, compression='bz2')
 
343
    exporters['tbz2'] = tbz_exporter
 
344
 
 
345
 
 
346
def _find_file_size(fileobj):
 
347
    offset = fileobj.tell()
 
348
    try:
 
349
        fileobj.seek(0, 2)
 
350
        size = fileobj.tell()
 
351
    except TypeError:
 
352
        # gzip doesn't accept second argument to seek()
 
353
        fileobj.seek(0)
 
354
        size = 0
 
355
        while True:
 
356
            nread = len(fileobj.read())
 
357
            if nread == 0:
 
358
                break
 
359
            size += nread
 
360
    fileobj.seek(offset)
 
361
    return size