1
# Copyright (C) 2005 Canonical Ltd
 
 
3
# This program is free software; you can redistribute it and/or modify
 
 
4
# it under the terms of the GNU General Public License as published by
 
 
5
# the Free Software Foundation; either version 2 of the License, or
 
 
6
# (at your option) any later version.
 
 
8
# This program is distributed in the hope that it will be useful,
 
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
 
11
# GNU General Public License for more details.
 
 
13
# You should have received a copy of the GNU General Public License
 
 
14
# along with this program; if not, write to the Free Software
 
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 
17
"""Tree classes, representing directory at point in time.
 
 
21
from collections import deque
 
 
22
from cStringIO import StringIO
 
 
28
    revision as _mod_revision,
 
 
29
    conflicts as _mod_conflicts,
 
 
32
from bzrlib.decorators import needs_read_lock
 
 
33
from bzrlib.errors import BzrError, BzrCheckError
 
 
34
from bzrlib import errors
 
 
35
from bzrlib.inventory import Inventory, InventoryFile
 
 
36
from bzrlib.inter import InterObject
 
 
37
from bzrlib.osutils import fingerprint_file
 
 
38
import bzrlib.revision
 
 
39
from bzrlib.trace import mutter, note
 
 
43
    """Abstract file tree.
 
 
45
    There are several subclasses:
 
 
47
    * `WorkingTree` exists as files on disk editable by the user.
 
 
49
    * `RevisionTree` is a tree as recorded at some point in the past.
 
 
51
    Trees contain an `Inventory` object, and also know how to retrieve
 
 
52
    file texts mentioned in the inventory, either from a working
 
 
53
    directory or from a store.
 
 
55
    It is possible for trees to contain files that are not described
 
 
56
    in their inventory or vice versa; for this use `filenames()`.
 
 
58
    Trees can be compared, etc, regardless of whether they are working
 
 
59
    trees or versioned trees.
 
 
62
    def changes_from(self, other, want_unchanged=False, specific_files=None,
 
 
63
        extra_trees=None, require_versioned=False, include_root=False,
 
 
64
        want_unversioned=False):
 
 
65
        """Return a TreeDelta of the changes from other to this tree.
 
 
67
        :param other: A tree to compare with.
 
 
68
        :param specific_files: An optional list of file paths to restrict the
 
 
69
            comparison to. When mapping filenames to ids, all matches in all
 
 
70
            trees (including optional extra_trees) are used, and all children of
 
 
71
            matched directories are included.
 
 
72
        :param want_unchanged: An optional boolean requesting the inclusion of
 
 
73
            unchanged entries in the result.
 
 
74
        :param extra_trees: An optional list of additional trees to use when
 
 
75
            mapping the contents of specific_files (paths) to file_ids.
 
 
76
        :param require_versioned: An optional boolean (defaults to False). When
 
 
77
            supplied and True all the 'specific_files' must be versioned, or
 
 
78
            a PathsNotVersionedError will be thrown.
 
 
79
        :param want_unversioned: Scan for unversioned paths.
 
 
81
        The comparison will be performed by an InterTree object looked up on 
 
 
84
        # Martin observes that Tree.changes_from returns a TreeDelta and this
 
 
85
        # may confuse people, because the class name of the returned object is
 
 
86
        # a synonym of the object referenced in the method name.
 
 
87
        return InterTree.get(other, self).compare(
 
 
88
            want_unchanged=want_unchanged,
 
 
89
            specific_files=specific_files,
 
 
90
            extra_trees=extra_trees,
 
 
91
            require_versioned=require_versioned,
 
 
92
            include_root=include_root,
 
 
93
            want_unversioned=want_unversioned,
 
 
96
    def iter_changes(self, from_tree, include_unchanged=False,
 
 
97
                     specific_files=None, pb=None, extra_trees=None,
 
 
98
                     require_versioned=True, want_unversioned=False):
 
 
99
        intertree = InterTree.get(from_tree, self)
 
 
100
        return intertree.iter_changes(include_unchanged, specific_files, pb,
 
 
101
            extra_trees, require_versioned, want_unversioned=want_unversioned)
 
 
104
        """Get a list of the conflicts in the tree.
 
 
106
        Each conflict is an instance of bzrlib.conflicts.Conflict.
 
 
108
        return _mod_conflicts.ConflictList()
 
 
111
        """For trees that can have unversioned files, return all such paths."""
 
 
114
    def get_parent_ids(self):
 
 
115
        """Get the parent ids for this tree. 
 
 
117
        :return: a list of parent ids. [] is returned to indicate
 
 
118
        a tree with no parents.
 
 
119
        :raises: BzrError if the parents are not known.
 
 
121
        raise NotImplementedError(self.get_parent_ids)
 
 
123
    def has_filename(self, filename):
 
 
124
        """True if the tree has given filename."""
 
 
125
        raise NotImplementedError(self.has_filename)
 
 
127
    def has_id(self, file_id):
 
 
128
        return self.inventory.has_id(file_id)
 
 
130
    __contains__ = has_id
 
 
132
    def has_or_had_id(self, file_id):
 
 
133
        if file_id == self.inventory.root.file_id:
 
 
135
        return self.inventory.has_id(file_id)
 
 
137
    def is_ignored(self, filename):
 
 
138
        """Check whether the filename is ignored by this tree.
 
 
140
        :param filename: The relative filename within the tree.
 
 
141
        :return: True if the filename is ignored.
 
 
146
        return iter(self.inventory)
 
 
148
    def all_file_ids(self):
 
 
149
        """Iterate through all file ids, including ids for missing files."""
 
 
150
        return set(self.inventory)
 
 
152
    def id2path(self, file_id):
 
 
153
        """Return the path for a file id.
 
 
157
        return self.inventory.id2path(file_id)
 
 
159
    def is_control_filename(self, filename):
 
 
160
        """True if filename is the name of a control file in this tree.
 
 
162
        :param filename: A filename within the tree. This is a relative path
 
 
163
        from the root of this tree.
 
 
165
        This is true IF and ONLY IF the filename is part of the meta data
 
 
166
        that bzr controls in this tree. I.E. a random .bzr directory placed
 
 
167
        on disk will not be a control file for this tree.
 
 
169
        return self.bzrdir.is_control_filename(filename)
 
 
172
    def iter_entries_by_dir(self, specific_file_ids=None):
 
 
173
        """Walk the tree in 'by_dir' order.
 
 
175
        This will yield each entry in the tree as a (path, entry) tuple. The
 
 
176
        order that they are yielded is: the contents of a directory are 
 
 
177
        preceeded by the parent of a directory, and all the contents of a 
 
 
178
        directory are grouped together.
 
 
180
        return self.inventory.iter_entries_by_dir(
 
 
181
            specific_file_ids=specific_file_ids)
 
 
183
    def iter_references(self):
 
 
184
        for path, entry in self.iter_entries_by_dir():
 
 
185
            if entry.kind == 'tree-reference':
 
 
186
                yield path, entry.file_id
 
 
188
    def kind(self, file_id):
 
 
189
        raise NotImplementedError("Tree subclass %s must implement kind"
 
 
190
            % self.__class__.__name__)
 
 
192
    def stored_kind(self, file_id):
 
 
193
        """File kind stored for this file_id.
 
 
195
        May not match kind on disk for working trees.  Always available
 
 
196
        for versioned files, even when the file itself is missing.
 
 
198
        return self.kind(file_id)
 
 
200
    def path_content_summary(self, path):
 
 
201
        """Get a summary of the information about path.
 
 
203
        :param path: A relative path within the tree.
 
 
204
        :return: A tuple containing kind, size, exec, sha1-or-link.
 
 
205
            Kind is always present (see tree.kind()).
 
 
206
            size is present if kind is file, None otherwise.
 
 
207
            exec is None unless kind is file and the platform supports the 'x'
 
 
209
            sha1-or-link is the link target if kind is symlink, or the sha1 if
 
 
210
                it can be obtained without reading the file.
 
 
212
        raise NotImplementedError(self.path_content_summary)
 
 
214
    def get_reference_revision(self, file_id, path=None):
 
 
215
        raise NotImplementedError("Tree subclass %s must implement "
 
 
216
                                  "get_reference_revision"
 
 
217
            % self.__class__.__name__)
 
 
219
    def _comparison_data(self, entry, path):
 
 
220
        """Return a tuple of kind, executable, stat_value for a file.
 
 
222
        entry may be None if there is no inventory entry for the file, but
 
 
223
        path must always be supplied.
 
 
225
        kind is None if there is no file present (even if an inventory id is
 
 
226
        present).  executable is False for non-file entries.
 
 
228
        raise NotImplementedError(self._comparison_data)
 
 
230
    def _file_size(self, entry, stat_value):
 
 
231
        raise NotImplementedError(self._file_size)
 
 
233
    def _get_inventory(self):
 
 
234
        return self._inventory
 
 
236
    def get_file(self, file_id, path=None):
 
 
237
        """Return a file object for the file file_id in the tree.
 
 
239
        If both file_id and path are defined, it is implementation defined as
 
 
240
        to which one is used.
 
 
242
        raise NotImplementedError(self.get_file)
 
 
244
    def get_file_mtime(self, file_id, path=None):
 
 
245
        """Return the modification time for a file.
 
 
247
        :param file_id: The handle for this file.
 
 
248
        :param path: The path that this file can be found at.
 
 
249
            These must point to the same object.
 
 
251
        raise NotImplementedError(self.get_file_mtime)
 
 
253
    def get_file_by_path(self, path):
 
 
254
        return self.get_file(self._inventory.path2id(path), path)
 
 
256
    def iter_files_bytes(self, desired_files):
 
 
257
        """Iterate through file contents.
 
 
259
        Files will not necessarily be returned in the order they occur in
 
 
260
        desired_files.  No specific order is guaranteed.
 
 
262
        Yields pairs of identifier, bytes_iterator.  identifier is an opaque
 
 
263
        value supplied by the caller as part of desired_files.  It should
 
 
264
        uniquely identify the file version in the caller's context.  (Examples:
 
 
265
        an index number or a TreeTransform trans_id.)
 
 
267
        bytes_iterator is an iterable of bytestrings for the file.  The
 
 
268
        kind of iterable and length of the bytestrings are unspecified, but for
 
 
269
        this implementation, it is a tuple containing a single bytestring with
 
 
270
        the complete text of the file.
 
 
272
        :param desired_files: a list of (file_id, identifier) pairs
 
 
274
        for file_id, identifier in desired_files:
 
 
275
            # We wrap the string in a tuple so that we can return an iterable
 
 
276
            # of bytestrings.  (Technically, a bytestring is also an iterable
 
 
277
            # of bytestrings, but iterating through each character is not
 
 
279
            cur_file = (self.get_file_text(file_id),)
 
 
280
            yield identifier, cur_file
 
 
282
    def get_symlink_target(self, file_id):
 
 
283
        """Get the target for a given file_id.
 
 
285
        It is assumed that the caller already knows that file_id is referencing
 
 
287
        :param file_id: Handle for the symlink entry.
 
 
288
        :return: The path the symlink points to.
 
 
290
        raise NotImplementedError(self.get_symlink_target)
 
 
292
    def get_root_id(self):
 
 
293
        """Return the file_id for the root of this tree."""
 
 
294
        raise NotImplementedError(self.get_root_id)
 
 
296
    def annotate_iter(self, file_id):
 
 
297
        """Return an iterator of revision_id, line tuples.
 
 
299
        For working trees (and mutable trees in general), the special
 
 
300
        revision_id 'current:' will be used for lines that are new in this
 
 
301
        tree, e.g. uncommitted changes.
 
 
302
        :param file_id: The file to produce an annotated version from
 
 
304
        raise NotImplementedError(self.annotate_iter)
 
 
306
    def _get_plan_merge_data(self, file_id, other, base):
 
 
307
        from bzrlib import merge, versionedfile
 
 
308
        vf = versionedfile._PlanMergeVersionedFile(file_id)
 
 
309
        last_revision_a = self._get_file_revision(file_id, vf, 'this:')
 
 
310
        last_revision_b = other._get_file_revision(file_id, vf, 'other:')
 
 
312
            last_revision_base = None
 
 
314
            last_revision_base = base._get_file_revision(file_id, vf, 'base:')
 
 
315
        return vf, last_revision_a, last_revision_b, last_revision_base
 
 
317
    def plan_file_merge(self, file_id, other, base=None):
 
 
318
        """Generate a merge plan based on annotations.
 
 
320
        If the file contains uncommitted changes in this tree, they will be
 
 
321
        attributed to the 'current:' pseudo-revision.  If the file contains
 
 
322
        uncommitted changes in the other tree, they will be assigned to the
 
 
323
        'other:' pseudo-revision.
 
 
325
        data = self._get_plan_merge_data(file_id, other, base)
 
 
326
        vf, last_revision_a, last_revision_b, last_revision_base = data
 
 
327
        return vf.plan_merge(last_revision_a, last_revision_b,
 
 
330
    def plan_file_lca_merge(self, file_id, other, base=None):
 
 
331
        """Generate a merge plan based lca-newness.
 
 
333
        If the file contains uncommitted changes in this tree, they will be
 
 
334
        attributed to the 'current:' pseudo-revision.  If the file contains
 
 
335
        uncommitted changes in the other tree, they will be assigned to the
 
 
336
        'other:' pseudo-revision.
 
 
338
        data = self._get_plan_merge_data(file_id, other, base)
 
 
339
        vf, last_revision_a, last_revision_b, last_revision_base = data
 
 
340
        return vf.plan_lca_merge(last_revision_a, last_revision_b,
 
 
343
    def _get_file_revision(self, file_id, vf, tree_revision):
 
 
344
        def file_revision(revision_tree):
 
 
345
            revision_tree.lock_read()
 
 
347
                return revision_tree.inventory[file_id].revision
 
 
349
                revision_tree.unlock()
 
 
351
        def iter_parent_trees():
 
 
352
            for revision_id in self.get_parent_ids():
 
 
354
                    yield self.revision_tree(revision_id)
 
 
356
                    yield self.repository.revision_tree(revision_id)
 
 
358
        if getattr(self, '_get_weave', None) is None:
 
 
359
            last_revision = tree_revision
 
 
360
            parent_revisions = [file_revision(t) for t in iter_parent_trees()]
 
 
361
            vf.add_lines(last_revision, parent_revisions,
 
 
362
                         self.get_file(file_id).readlines())
 
 
363
            repo = self.branch.repository
 
 
364
            transaction = repo.get_transaction()
 
 
365
            base_vf = repo.weave_store.get_weave(file_id, transaction)
 
 
367
            last_revision = file_revision(self)
 
 
368
            base_vf = self._get_weave(file_id)
 
 
369
        vf.fallback_versionedfiles.append(base_vf)
 
 
372
    inventory = property(_get_inventory,
 
 
373
                         doc="Inventory of this Tree")
 
 
375
    def _check_retrieved(self, ie, f):
 
 
378
        fp = fingerprint_file(f)
 
 
381
        if ie.text_size is not None:
 
 
382
            if ie.text_size != fp['size']:
 
 
383
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
 
 
384
                        ["inventory expects %d bytes" % ie.text_size,
 
 
385
                         "file is actually %d bytes" % fp['size'],
 
 
386
                         "store is probably damaged/corrupt"])
 
 
388
        if ie.text_sha1 != fp['sha1']:
 
 
389
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
 
 
390
                    ["inventory expects %s" % ie.text_sha1,
 
 
391
                     "file is actually %s" % fp['sha1'],
 
 
392
                     "store is probably damaged/corrupt"])
 
 
395
    def path2id(self, path):
 
 
396
        """Return the id for path in this tree."""
 
 
397
        return self._inventory.path2id(path)
 
 
399
    def paths2ids(self, paths, trees=[], require_versioned=True):
 
 
400
        """Return all the ids that can be reached by walking from paths.
 
 
402
        Each path is looked up in this tree and any extras provided in
 
 
403
        trees, and this is repeated recursively: the children in an extra tree
 
 
404
        of a directory that has been renamed under a provided path in this tree
 
 
405
        are all returned, even if none exist under a provided path in this
 
 
406
        tree, and vice versa.
 
 
408
        :param paths: An iterable of paths to start converting to ids from.
 
 
409
            Alternatively, if paths is None, no ids should be calculated and None
 
 
410
            will be returned. This is offered to make calling the api unconditional
 
 
411
            for code that *might* take a list of files.
 
 
412
        :param trees: Additional trees to consider.
 
 
413
        :param require_versioned: If False, do not raise NotVersionedError if
 
 
414
            an element of paths is not versioned in this tree and all of trees.
 
 
416
        return find_ids_across_trees(paths, [self] + list(trees), require_versioned)
 
 
418
    def print_file(self, file_id):
 
 
419
        """Print file with id `file_id` to stdout."""
 
 
421
        sys.stdout.write(self.get_file_text(file_id))
 
 
426
    def revision_tree(self, revision_id):
 
 
427
        """Obtain a revision tree for the revision revision_id.
 
 
429
        The intention of this method is to allow access to possibly cached
 
 
430
        tree data. Implementors of this method should raise NoSuchRevision if
 
 
431
        the tree is not locally available, even if they could obtain the 
 
 
432
        tree via a repository or some other means. Callers are responsible 
 
 
433
        for finding the ultimate source for a revision tree.
 
 
435
        :param revision_id: The revision_id of the requested tree.
 
 
437
        :raises: NoSuchRevision if the tree cannot be obtained.
 
 
439
        raise errors.NoSuchRevisionInTree(self, revision_id)
 
 
442
        """What files are present in this tree and unknown.
 
 
444
        :return: an iterator over the unknown files.
 
 
451
    def filter_unversioned_files(self, paths):
 
 
452
        """Filter out paths that are versioned.
 
 
454
        :return: set of paths.
 
 
456
        # NB: we specifically *don't* call self.has_filename, because for
 
 
457
        # WorkingTrees that can indicate files that exist on disk but that 
 
 
459
        pred = self.inventory.has_filename
 
 
460
        return set((p for p in paths if not pred(p)))
 
 
462
    def walkdirs(self, prefix=""):
 
 
463
        """Walk the contents of this tree from path down.
 
 
465
        This yields all the data about the contents of a directory at a time.
 
 
466
        After each directory has been yielded, if the caller has mutated the
 
 
467
        list to exclude some directories, they are then not descended into.
 
 
469
        The data yielded is of the form:
 
 
470
        ((directory-relpath, directory-path-from-root, directory-fileid),
 
 
471
        [(relpath, basename, kind, lstat, path_from_tree_root, file_id, 
 
 
472
          versioned_kind), ...]),
 
 
473
         - directory-relpath is the containing dirs relpath from prefix
 
 
474
         - directory-path-from-root is the containing dirs path from /
 
 
475
         - directory-fileid is the id of the directory if it is versioned.
 
 
476
         - relpath is the relative path within the subtree being walked.
 
 
477
         - basename is the basename
 
 
478
         - kind is the kind of the file now. If unknonwn then the file is not
 
 
479
           present within the tree - but it may be recorded as versioned. See
 
 
481
         - lstat is the stat data *if* the file was statted.
 
 
482
         - path_from_tree_root is the path from the root of the tree.
 
 
483
         - file_id is the file_id if the entry is versioned.
 
 
484
         - versioned_kind is the kind of the file as last recorded in the 
 
 
485
           versioning system. If 'unknown' the file is not versioned.
 
 
486
        One of 'kind' and 'versioned_kind' must not be 'unknown'.
 
 
488
        :param prefix: Start walking from prefix within the tree rather than
 
 
489
        at the root. This allows one to walk a subtree but get paths that are
 
 
490
        relative to a tree rooted higher up.
 
 
491
        :return: an iterator over the directory data.
 
 
493
        raise NotImplementedError(self.walkdirs)
 
 
496
class EmptyTree(Tree):
 
 
499
        self._inventory = Inventory(root_id=None)
 
 
500
        symbol_versioning.warn('EmptyTree is deprecated as of bzr 0.9 please'
 
 
501
                               ' use repository.revision_tree instead.',
 
 
502
                               DeprecationWarning, stacklevel=2)
 
 
504
    def get_parent_ids(self):
 
 
507
    def get_symlink_target(self, file_id):
 
 
510
    def has_filename(self, filename):
 
 
513
    def kind(self, file_id):
 
 
514
        assert self._inventory[file_id].kind == "directory"
 
 
517
    def list_files(self, include_root=False):
 
 
520
    def __contains__(self, file_id):
 
 
521
        return (file_id in self._inventory)
 
 
523
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
 
527
######################################################################
 
 
530
# TODO: Merge these two functions into a single one that can operate
 
 
531
# on either a whole tree or a set of files.
 
 
533
# TODO: Return the diff in order by filename, not by category or in
 
 
534
# random order.  Can probably be done by lock-stepping through the
 
 
535
# filenames from both trees.
 
 
538
def file_status(filename, old_tree, new_tree):
 
 
539
    """Return single-letter status, old and new names for a file.
 
 
541
    The complexity here is in deciding how to represent renames;
 
 
542
    many complex cases are possible.
 
 
544
    old_inv = old_tree.inventory
 
 
545
    new_inv = new_tree.inventory
 
 
546
    new_id = new_inv.path2id(filename)
 
 
547
    old_id = old_inv.path2id(filename)
 
 
549
    if not new_id and not old_id:
 
 
550
        # easy: doesn't exist in either; not versioned at all
 
 
551
        if new_tree.is_ignored(filename):
 
 
552
            return 'I', None, None
 
 
554
            return '?', None, None
 
 
556
        # There is now a file of this name, great.
 
 
559
        # There is no longer a file of this name, but we can describe
 
 
560
        # what happened to the file that used to have
 
 
561
        # this name.  There are two possibilities: either it was
 
 
562
        # deleted entirely, or renamed.
 
 
564
        if new_inv.has_id(old_id):
 
 
565
            return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
 
 
567
            return 'D', old_inv.id2path(old_id), None
 
 
569
    # if the file_id is new in this revision, it is added
 
 
570
    if new_id and not old_inv.has_id(new_id):
 
 
573
    # if there used to be a file of this name, but that ID has now
 
 
574
    # disappeared, it is deleted
 
 
575
    if old_id and not new_inv.has_id(old_id):
 
 
582
def find_renames(old_inv, new_inv):
 
 
583
    for file_id in old_inv:
 
 
584
        if file_id not in new_inv:
 
 
586
        old_name = old_inv.id2path(file_id)
 
 
587
        new_name = new_inv.id2path(file_id)
 
 
588
        if old_name != new_name:
 
 
589
            yield (old_name, new_name)
 
 
592
def find_ids_across_trees(filenames, trees, require_versioned=True):
 
 
593
    """Find the ids corresponding to specified filenames.
 
 
595
    All matches in all trees will be used, and all children of matched
 
 
596
    directories will be used.
 
 
598
    :param filenames: The filenames to find file_ids for (if None, returns
 
 
600
    :param trees: The trees to find file_ids within
 
 
601
    :param require_versioned: if true, all specified filenames must occur in
 
 
603
    :return: a set of file ids for the specified filenames and their children.
 
 
607
    specified_path_ids = _find_ids_across_trees(filenames, trees,
 
 
609
    return _find_children_across_trees(specified_path_ids, trees)
 
 
612
def _find_ids_across_trees(filenames, trees, require_versioned):
 
 
613
    """Find the ids corresponding to specified filenames.
 
 
615
    All matches in all trees will be used, but subdirectories are not scanned.
 
 
617
    :param filenames: The filenames to find file_ids for
 
 
618
    :param trees: The trees to find file_ids within
 
 
619
    :param require_versioned: if true, all specified filenames must occur in
 
 
621
    :return: a set of file ids for the specified filenames
 
 
624
    interesting_ids = set()
 
 
625
    for tree_path in filenames:
 
 
628
            file_id = tree.path2id(tree_path)
 
 
629
            if file_id is not None:
 
 
630
                interesting_ids.add(file_id)
 
 
633
            not_versioned.append(tree_path)
 
 
634
    if len(not_versioned) > 0 and require_versioned:
 
 
635
        raise errors.PathsNotVersionedError(not_versioned)
 
 
636
    return interesting_ids
 
 
639
def _find_children_across_trees(specified_ids, trees):
 
 
640
    """Return a set including specified ids and their children.
 
 
642
    All matches in all trees will be used.
 
 
644
    :param trees: The trees to find file_ids within
 
 
645
    :return: a set containing all specified ids and their children 
 
 
647
    interesting_ids = set(specified_ids)
 
 
648
    pending = interesting_ids
 
 
649
    # now handle children of interesting ids
 
 
650
    # we loop so that we handle all children of each id in both trees
 
 
651
    while len(pending) > 0:
 
 
653
        for file_id in pending:
 
 
655
                if not tree.has_id(file_id):
 
 
657
                entry = tree.inventory[file_id]
 
 
658
                for child in getattr(entry, 'children', {}).itervalues():
 
 
659
                    if child.file_id not in interesting_ids:
 
 
660
                        new_pending.add(child.file_id)
 
 
661
        interesting_ids.update(new_pending)
 
 
662
        pending = new_pending
 
 
663
    return interesting_ids
 
 
666
class InterTree(InterObject):
 
 
667
    """This class represents operations taking place between two Trees.
 
 
669
    Its instances have methods like 'compare' and contain references to the
 
 
670
    source and target trees these operations are to be carried out on.
 
 
672
    Clients of bzrlib should not need to use InterTree directly, rather they
 
 
673
    should use the convenience methods on Tree such as 'Tree.compare()' which
 
 
674
    will pass through to InterTree as appropriate.
 
 
680
    def compare(self, want_unchanged=False, specific_files=None,
 
 
681
        extra_trees=None, require_versioned=False, include_root=False,
 
 
682
        want_unversioned=False):
 
 
683
        """Return the changes from source to target.
 
 
685
        :return: A TreeDelta.
 
 
686
        :param specific_files: An optional list of file paths to restrict the
 
 
687
            comparison to. When mapping filenames to ids, all matches in all
 
 
688
            trees (including optional extra_trees) are used, and all children of
 
 
689
            matched directories are included.
 
 
690
        :param want_unchanged: An optional boolean requesting the inclusion of
 
 
691
            unchanged entries in the result.
 
 
692
        :param extra_trees: An optional list of additional trees to use when
 
 
693
            mapping the contents of specific_files (paths) to file_ids.
 
 
694
        :param require_versioned: An optional boolean (defaults to False). When
 
 
695
            supplied and True all the 'specific_files' must be versioned, or
 
 
696
            a PathsNotVersionedError will be thrown.
 
 
697
        :param want_unversioned: Scan for unversioned paths.
 
 
699
        # NB: show_status depends on being able to pass in non-versioned files
 
 
700
        # and report them as unknown
 
 
701
        trees = (self.source,)
 
 
702
        if extra_trees is not None:
 
 
703
            trees = trees + tuple(extra_trees)
 
 
704
        # target is usually the newer tree:
 
 
705
        specific_file_ids = self.target.paths2ids(specific_files, trees,
 
 
706
            require_versioned=require_versioned)
 
 
707
        if specific_files and not specific_file_ids:
 
 
708
            # All files are unversioned, so just return an empty delta
 
 
709
            # _compare_trees would think we want a complete delta
 
 
710
            result = delta.TreeDelta()
 
 
711
            fake_entry = InventoryFile('unused', 'unused', 'unused')
 
 
712
            result.unversioned = [(path, None,
 
 
713
                self.target._comparison_data(fake_entry, path)[0]) for path in
 
 
716
        return delta._compare_trees(self.source, self.target, want_unchanged,
 
 
717
            specific_files, include_root, extra_trees=extra_trees,
 
 
718
            require_versioned=require_versioned,
 
 
719
            want_unversioned=want_unversioned)
 
 
721
    def iter_changes(self, include_unchanged=False,
 
 
722
                      specific_files=None, pb=None, extra_trees=[],
 
 
723
                      require_versioned=True, want_unversioned=False):
 
 
724
        """Generate an iterator of changes between trees.
 
 
727
        (file_id, (path_in_source, path_in_target),
 
 
728
         changed_content, versioned, parent, name, kind,
 
 
731
        Changed_content is True if the file's content has changed.  This
 
 
732
        includes changes to its kind, and to a symlink's target.
 
 
734
        versioned, parent, name, kind, executable are tuples of (from, to).
 
 
735
        If a file is missing in a tree, its kind is None.
 
 
737
        Iteration is done in parent-to-child order, relative to the target
 
 
740
        There is no guarantee that all paths are in sorted order: the
 
 
741
        requirement to expand the search due to renames may result in children
 
 
742
        that should be found early being found late in the search, after
 
 
743
        lexically later results have been returned.
 
 
744
        :param require_versioned: Raise errors.PathsNotVersionedError if a
 
 
745
            path in the specific_files list is not versioned in one of
 
 
746
            source, target or extra_trees.
 
 
747
        :param want_unversioned: Should unversioned files be returned in the
 
 
748
            output. An unversioned file is defined as one with (False, False)
 
 
749
            for the versioned pair.
 
 
752
        lookup_trees = [self.source]
 
 
754
             lookup_trees.extend(extra_trees)
 
 
755
        if specific_files == []:
 
 
756
            specific_file_ids = []
 
 
758
            specific_file_ids = self.target.paths2ids(specific_files,
 
 
759
                lookup_trees, require_versioned=require_versioned)
 
 
761
            all_unversioned = sorted([(p.split('/'), p) for p in
 
 
763
                if specific_files is None or
 
 
764
                    osutils.is_inside_any(specific_files, p)])
 
 
765
            all_unversioned = deque(all_unversioned)
 
 
767
            all_unversioned = deque()
 
 
769
        from_entries_by_dir = list(self.source.inventory.iter_entries_by_dir(
 
 
770
            specific_file_ids=specific_file_ids))
 
 
771
        from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
 
 
772
        to_entries_by_dir = list(self.target.inventory.iter_entries_by_dir(
 
 
773
            specific_file_ids=specific_file_ids))
 
 
774
        num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
 
 
776
        # the unversioned path lookup only occurs on real trees - where there 
 
 
777
        # can be extras. So the fake_entry is solely used to look up
 
 
778
        # executable it values when execute is not supported.
 
 
779
        fake_entry = InventoryFile('unused', 'unused', 'unused')
 
 
780
        for to_path, to_entry in to_entries_by_dir:
 
 
781
            while all_unversioned and all_unversioned[0][0] < to_path.split('/'):
 
 
782
                unversioned_path = all_unversioned.popleft()
 
 
783
                to_kind, to_executable, to_stat = \
 
 
784
                    self.target._comparison_data(fake_entry, unversioned_path[1])
 
 
785
                yield (None, (None, unversioned_path[1]), True, (False, False),
 
 
787
                    (None, unversioned_path[0][-1]),
 
 
789
                    (None, to_executable))
 
 
790
            file_id = to_entry.file_id
 
 
791
            to_paths[file_id] = to_path
 
 
793
            changed_content = False
 
 
794
            from_path, from_entry = from_data.get(file_id, (None, None))
 
 
795
            from_versioned = (from_entry is not None)
 
 
796
            if from_entry is not None:
 
 
797
                from_versioned = True
 
 
798
                from_name = from_entry.name
 
 
799
                from_parent = from_entry.parent_id
 
 
800
                from_kind, from_executable, from_stat = \
 
 
801
                    self.source._comparison_data(from_entry, from_path)
 
 
804
                from_versioned = False
 
 
808
                from_executable = None
 
 
809
            versioned = (from_versioned, True)
 
 
810
            to_kind, to_executable, to_stat = \
 
 
811
                self.target._comparison_data(to_entry, to_path)
 
 
812
            kind = (from_kind, to_kind)
 
 
813
            if kind[0] != kind[1]:
 
 
814
                changed_content = True
 
 
815
            elif from_kind == 'file':
 
 
816
                from_size = self.source._file_size(from_entry, from_stat)
 
 
817
                to_size = self.target._file_size(to_entry, to_stat)
 
 
818
                if from_size != to_size:
 
 
819
                    changed_content = True
 
 
820
                elif (self.source.get_file_sha1(file_id, from_path, from_stat) !=
 
 
821
                    self.target.get_file_sha1(file_id, to_path, to_stat)):
 
 
822
                    changed_content = True
 
 
823
            elif from_kind == 'symlink':
 
 
824
                if (self.source.get_symlink_target(file_id) !=
 
 
825
                    self.target.get_symlink_target(file_id)):
 
 
826
                    changed_content = True
 
 
827
                elif from_kind == 'tree-reference':
 
 
828
                    if (self.source.get_reference_revision(file_id, from_path)
 
 
829
                        != self.target.get_reference_revision(file_id, to_path)):
 
 
830
                        changed_content = True 
 
 
831
            parent = (from_parent, to_entry.parent_id)
 
 
832
            name = (from_name, to_entry.name)
 
 
833
            executable = (from_executable, to_executable)
 
 
835
                pb.update('comparing files', entry_count, num_entries)
 
 
836
            if (changed_content is not False or versioned[0] != versioned[1]
 
 
837
                or parent[0] != parent[1] or name[0] != name[1] or 
 
 
838
                executable[0] != executable[1] or include_unchanged):
 
 
839
                yield (file_id, (from_path, to_path), changed_content,
 
 
840
                    versioned, parent, name, kind, executable)
 
 
842
        while all_unversioned:
 
 
843
            # yield any trailing unversioned paths
 
 
844
            unversioned_path = all_unversioned.popleft()
 
 
845
            to_kind, to_executable, to_stat = \
 
 
846
                self.target._comparison_data(fake_entry, unversioned_path[1])
 
 
847
            yield (None, (None, unversioned_path[1]), True, (False, False),
 
 
849
                (None, unversioned_path[0][-1]),
 
 
851
                (None, to_executable))
 
 
853
        def get_to_path(to_entry):
 
 
854
            if to_entry.parent_id is None:
 
 
855
                to_path = '' # the root
 
 
857
                if to_entry.parent_id not in to_paths:
 
 
859
                    return get_to_path(self.target.inventory[to_entry.parent_id])
 
 
860
                to_path = osutils.pathjoin(to_paths[to_entry.parent_id],
 
 
862
            to_paths[to_entry.file_id] = to_path
 
 
865
        for path, from_entry in from_entries_by_dir:
 
 
866
            file_id = from_entry.file_id
 
 
867
            if file_id in to_paths:
 
 
870
            if not file_id in self.target.inventory:
 
 
871
                # common case - paths we have not emitted are not present in
 
 
875
                to_path = get_to_path(self.target.inventory[file_id])
 
 
878
                pb.update('comparing files', entry_count, num_entries)
 
 
879
            versioned = (True, False)
 
 
880
            parent = (from_entry.parent_id, None)
 
 
881
            name = (from_entry.name, None)
 
 
882
            from_kind, from_executable, stat_value = \
 
 
883
                self.source._comparison_data(from_entry, path)
 
 
884
            kind = (from_kind, None)
 
 
885
            executable = (from_executable, None)
 
 
886
            changed_content = True
 
 
887
            # the parent's path is necessarily known at this point.
 
 
888
            yield(file_id, (path, to_path), changed_content, versioned, parent,
 
 
889
                  name, kind, executable)
 
 
892
# This was deprecated before 0.12, but did not have an official warning
 
 
893
@symbol_versioning.deprecated_function(symbol_versioning.zero_twelve)
 
 
894
def RevisionTree(*args, **kwargs):
 
 
895
    """RevisionTree has moved to bzrlib.revisiontree.RevisionTree()
 
 
897
    Accessing it as bzrlib.tree.RevisionTree has been deprecated as of
 
 
900
    from bzrlib.revisiontree import RevisionTree as _RevisionTree
 
 
901
    return _RevisionTree(*args, **kwargs)