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
    @symbol_versioning.deprecated_method(symbol_versioning.one_three)
 
 
97
    def _iter_changes(self, *args, **kwargs):
 
 
98
        return self.iter_changes(*args, **kwargs)
 
 
100
    def iter_changes(self, from_tree, include_unchanged=False,
 
 
101
                     specific_files=None, pb=None, extra_trees=None,
 
 
102
                     require_versioned=True, want_unversioned=False):
 
 
103
        intertree = InterTree.get(from_tree, self)
 
 
104
        return intertree.iter_changes(include_unchanged, specific_files, pb,
 
 
105
            extra_trees, require_versioned, want_unversioned=want_unversioned)
 
 
108
        """Get a list of the conflicts in the tree.
 
 
110
        Each conflict is an instance of bzrlib.conflicts.Conflict.
 
 
112
        return _mod_conflicts.ConflictList()
 
 
115
        """For trees that can have unversioned files, return all such paths."""
 
 
118
    def get_parent_ids(self):
 
 
119
        """Get the parent ids for this tree. 
 
 
121
        :return: a list of parent ids. [] is returned to indicate
 
 
122
        a tree with no parents.
 
 
123
        :raises: BzrError if the parents are not known.
 
 
125
        raise NotImplementedError(self.get_parent_ids)
 
 
127
    def has_filename(self, filename):
 
 
128
        """True if the tree has given filename."""
 
 
129
        raise NotImplementedError(self.has_filename)
 
 
131
    def has_id(self, file_id):
 
 
132
        return self.inventory.has_id(file_id)
 
 
134
    __contains__ = has_id
 
 
136
    def has_or_had_id(self, file_id):
 
 
137
        if file_id == self.inventory.root.file_id:
 
 
139
        return self.inventory.has_id(file_id)
 
 
141
    def is_ignored(self, filename):
 
 
142
        """Check whether the filename is ignored by this tree.
 
 
144
        :param filename: The relative filename within the tree.
 
 
145
        :return: True if the filename is ignored.
 
 
150
        return iter(self.inventory)
 
 
152
    def all_file_ids(self):
 
 
153
        """Iterate through all file ids, including ids for missing files."""
 
 
154
        return set(self.inventory)
 
 
156
    def id2path(self, file_id):
 
 
157
        """Return the path for a file id.
 
 
161
        return self.inventory.id2path(file_id)
 
 
163
    def is_control_filename(self, filename):
 
 
164
        """True if filename is the name of a control file in this tree.
 
 
166
        :param filename: A filename within the tree. This is a relative path
 
 
167
        from the root of this tree.
 
 
169
        This is true IF and ONLY IF the filename is part of the meta data
 
 
170
        that bzr controls in this tree. I.E. a random .bzr directory placed
 
 
171
        on disk will not be a control file for this tree.
 
 
173
        return self.bzrdir.is_control_filename(filename)
 
 
176
    def iter_entries_by_dir(self, specific_file_ids=None):
 
 
177
        """Walk the tree in 'by_dir' order.
 
 
179
        This will yield each entry in the tree as a (path, entry) tuple. The
 
 
180
        order that they are yielded is: the contents of a directory are 
 
 
181
        preceeded by the parent of a directory, and all the contents of a 
 
 
182
        directory are grouped together.
 
 
184
        return self.inventory.iter_entries_by_dir(
 
 
185
            specific_file_ids=specific_file_ids)
 
 
187
    def iter_references(self):
 
 
188
        for path, entry in self.iter_entries_by_dir():
 
 
189
            if entry.kind == 'tree-reference':
 
 
190
                yield path, entry.file_id
 
 
192
    def kind(self, file_id):
 
 
193
        raise NotImplementedError("Tree subclass %s must implement kind"
 
 
194
            % self.__class__.__name__)
 
 
196
    def stored_kind(self, file_id):
 
 
197
        """File kind stored for this file_id.
 
 
199
        May not match kind on disk for working trees.  Always available
 
 
200
        for versioned files, even when the file itself is missing.
 
 
202
        return self.kind(file_id)
 
 
204
    def path_content_summary(self, path):
 
 
205
        """Get a summary of the information about path.
 
 
207
        :param path: A relative path within the tree.
 
 
208
        :return: A tuple containing kind, size, exec, sha1-or-link.
 
 
209
            Kind is always present (see tree.kind()).
 
 
210
            size is present if kind is file, None otherwise.
 
 
211
            exec is None unless kind is file and the platform supports the 'x'
 
 
213
            sha1-or-link is the link target if kind is symlink, or the sha1 if
 
 
214
                it can be obtained without reading the file.
 
 
216
        raise NotImplementedError(self.path_content_summary)
 
 
218
    def get_reference_revision(self, file_id, path=None):
 
 
219
        raise NotImplementedError("Tree subclass %s must implement "
 
 
220
                                  "get_reference_revision"
 
 
221
            % self.__class__.__name__)
 
 
223
    def _comparison_data(self, entry, path):
 
 
224
        """Return a tuple of kind, executable, stat_value for a file.
 
 
226
        entry may be None if there is no inventory entry for the file, but
 
 
227
        path must always be supplied.
 
 
229
        kind is None if there is no file present (even if an inventory id is
 
 
230
        present).  executable is False for non-file entries.
 
 
232
        raise NotImplementedError(self._comparison_data)
 
 
234
    def _file_size(self, entry, stat_value):
 
 
235
        raise NotImplementedError(self._file_size)
 
 
237
    def _get_inventory(self):
 
 
238
        return self._inventory
 
 
240
    def get_file(self, file_id, path=None):
 
 
241
        """Return a file object for the file file_id in the tree.
 
 
243
        If both file_id and path are defined, it is implementation defined as
 
 
244
        to which one is used.
 
 
246
        raise NotImplementedError(self.get_file)
 
 
248
    def get_file_mtime(self, file_id, path=None):
 
 
249
        """Return the modification time for a file.
 
 
251
        :param file_id: The handle for this file.
 
 
252
        :param path: The path that this file can be found at.
 
 
253
            These must point to the same object.
 
 
255
        raise NotImplementedError(self.get_file_mtime)
 
 
257
    def get_file_by_path(self, path):
 
 
258
        return self.get_file(self._inventory.path2id(path), path)
 
 
260
    def iter_files_bytes(self, desired_files):
 
 
261
        """Iterate through file contents.
 
 
263
        Files will not necessarily be returned in the order they occur in
 
 
264
        desired_files.  No specific order is guaranteed.
 
 
266
        Yields pairs of identifier, bytes_iterator.  identifier is an opaque
 
 
267
        value supplied by the caller as part of desired_files.  It should
 
 
268
        uniquely identify the file version in the caller's context.  (Examples:
 
 
269
        an index number or a TreeTransform trans_id.)
 
 
271
        bytes_iterator is an iterable of bytestrings for the file.  The
 
 
272
        kind of iterable and length of the bytestrings are unspecified, but for
 
 
273
        this implementation, it is a tuple containing a single bytestring with
 
 
274
        the complete text of the file.
 
 
276
        :param desired_files: a list of (file_id, identifier) pairs
 
 
278
        for file_id, identifier in desired_files:
 
 
279
            # We wrap the string in a tuple so that we can return an iterable
 
 
280
            # of bytestrings.  (Technically, a bytestring is also an iterable
 
 
281
            # of bytestrings, but iterating through each character is not
 
 
283
            cur_file = (self.get_file_text(file_id),)
 
 
284
            yield identifier, cur_file
 
 
286
    def get_symlink_target(self, file_id):
 
 
287
        """Get the target for a given file_id.
 
 
289
        It is assumed that the caller already knows that file_id is referencing
 
 
291
        :param file_id: Handle for the symlink entry.
 
 
292
        :return: The path the symlink points to.
 
 
294
        raise NotImplementedError(self.get_symlink_target)
 
 
296
    def get_root_id(self):
 
 
297
        """Return the file_id for the root of this tree."""
 
 
298
        raise NotImplementedError(self.get_root_id)
 
 
300
    def annotate_iter(self, file_id):
 
 
301
        """Return an iterator of revision_id, line tuples.
 
 
303
        For working trees (and mutable trees in general), the special
 
 
304
        revision_id 'current:' will be used for lines that are new in this
 
 
305
        tree, e.g. uncommitted changes.
 
 
306
        :param file_id: The file to produce an annotated version from
 
 
308
        raise NotImplementedError(self.annotate_iter)
 
 
310
    def _get_plan_merge_data(self, file_id, other, base):
 
 
311
        from bzrlib import merge, versionedfile
 
 
312
        vf = versionedfile._PlanMergeVersionedFile(file_id)
 
 
313
        last_revision_a = self._get_file_revision(file_id, vf, 'this:')
 
 
314
        last_revision_b = other._get_file_revision(file_id, vf, 'other:')
 
 
316
            last_revision_base = None
 
 
318
            last_revision_base = base._get_file_revision(file_id, vf, 'base:')
 
 
319
        return vf, last_revision_a, last_revision_b, last_revision_base
 
 
321
    def plan_file_merge(self, file_id, other, base=None):
 
 
322
        """Generate a merge plan based on annotations.
 
 
324
        If the file contains uncommitted changes in this tree, they will be
 
 
325
        attributed to the 'current:' pseudo-revision.  If the file contains
 
 
326
        uncommitted changes in the other tree, they will be assigned to the
 
 
327
        'other:' pseudo-revision.
 
 
329
        data = self._get_plan_merge_data(file_id, other, base)
 
 
330
        vf, last_revision_a, last_revision_b, last_revision_base = data
 
 
331
        return vf.plan_merge(last_revision_a, last_revision_b,
 
 
334
    def plan_file_lca_merge(self, file_id, other, base=None):
 
 
335
        """Generate a merge plan based lca-newness.
 
 
337
        If the file contains uncommitted changes in this tree, they will be
 
 
338
        attributed to the 'current:' pseudo-revision.  If the file contains
 
 
339
        uncommitted changes in the other tree, they will be assigned to the
 
 
340
        'other:' pseudo-revision.
 
 
342
        data = self._get_plan_merge_data(file_id, other, base)
 
 
343
        vf, last_revision_a, last_revision_b, last_revision_base = data
 
 
344
        return vf.plan_lca_merge(last_revision_a, last_revision_b,
 
 
347
    def _get_file_revision(self, file_id, vf, tree_revision):
 
 
348
        def file_revision(revision_tree):
 
 
349
            revision_tree.lock_read()
 
 
351
                return revision_tree.inventory[file_id].revision
 
 
353
                revision_tree.unlock()
 
 
355
        def iter_parent_trees():
 
 
356
            for revision_id in self.get_parent_ids():
 
 
358
                    yield self.revision_tree(revision_id)
 
 
360
                    yield self.repository.revision_tree(revision_id)
 
 
362
        if getattr(self, '_get_weave', None) is None:
 
 
363
            last_revision = tree_revision
 
 
364
            parent_revisions = [file_revision(t) for t in iter_parent_trees()]
 
 
365
            vf.add_lines(last_revision, parent_revisions,
 
 
366
                         self.get_file(file_id).readlines())
 
 
367
            repo = self.branch.repository
 
 
368
            transaction = repo.get_transaction()
 
 
369
            base_vf = repo.weave_store.get_weave(file_id, transaction)
 
 
371
            last_revision = file_revision(self)
 
 
372
            base_vf = self._get_weave(file_id)
 
 
373
        vf.fallback_versionedfiles.append(base_vf)
 
 
376
    inventory = property(_get_inventory,
 
 
377
                         doc="Inventory of this Tree")
 
 
379
    def _check_retrieved(self, ie, f):
 
 
382
        fp = fingerprint_file(f)
 
 
385
        if ie.text_size is not None:
 
 
386
            if ie.text_size != fp['size']:
 
 
387
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
 
 
388
                        ["inventory expects %d bytes" % ie.text_size,
 
 
389
                         "file is actually %d bytes" % fp['size'],
 
 
390
                         "store is probably damaged/corrupt"])
 
 
392
        if ie.text_sha1 != fp['sha1']:
 
 
393
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
 
 
394
                    ["inventory expects %s" % ie.text_sha1,
 
 
395
                     "file is actually %s" % fp['sha1'],
 
 
396
                     "store is probably damaged/corrupt"])
 
 
399
    def path2id(self, path):
 
 
400
        """Return the id for path in this tree."""
 
 
401
        return self._inventory.path2id(path)
 
 
403
    def paths2ids(self, paths, trees=[], require_versioned=True):
 
 
404
        """Return all the ids that can be reached by walking from paths.
 
 
406
        Each path is looked up in this tree and any extras provided in
 
 
407
        trees, and this is repeated recursively: the children in an extra tree
 
 
408
        of a directory that has been renamed under a provided path in this tree
 
 
409
        are all returned, even if none exist under a provided path in this
 
 
410
        tree, and vice versa.
 
 
412
        :param paths: An iterable of paths to start converting to ids from.
 
 
413
            Alternatively, if paths is None, no ids should be calculated and None
 
 
414
            will be returned. This is offered to make calling the api unconditional
 
 
415
            for code that *might* take a list of files.
 
 
416
        :param trees: Additional trees to consider.
 
 
417
        :param require_versioned: If False, do not raise NotVersionedError if
 
 
418
            an element of paths is not versioned in this tree and all of trees.
 
 
420
        return find_ids_across_trees(paths, [self] + list(trees), require_versioned)
 
 
422
    def print_file(self, file_id):
 
 
423
        """Print file with id `file_id` to stdout."""
 
 
425
        sys.stdout.write(self.get_file_text(file_id))
 
 
430
    def revision_tree(self, revision_id):
 
 
431
        """Obtain a revision tree for the revision revision_id.
 
 
433
        The intention of this method is to allow access to possibly cached
 
 
434
        tree data. Implementors of this method should raise NoSuchRevision if
 
 
435
        the tree is not locally available, even if they could obtain the 
 
 
436
        tree via a repository or some other means. Callers are responsible 
 
 
437
        for finding the ultimate source for a revision tree.
 
 
439
        :param revision_id: The revision_id of the requested tree.
 
 
441
        :raises: NoSuchRevision if the tree cannot be obtained.
 
 
443
        raise errors.NoSuchRevisionInTree(self, revision_id)
 
 
446
        """What files are present in this tree and unknown.
 
 
448
        :return: an iterator over the unknown files.
 
 
455
    def filter_unversioned_files(self, paths):
 
 
456
        """Filter out paths that are versioned.
 
 
458
        :return: set of paths.
 
 
460
        # NB: we specifically *don't* call self.has_filename, because for
 
 
461
        # WorkingTrees that can indicate files that exist on disk but that 
 
 
463
        pred = self.inventory.has_filename
 
 
464
        return set((p for p in paths if not pred(p)))
 
 
466
    def walkdirs(self, prefix=""):
 
 
467
        """Walk the contents of this tree from path down.
 
 
469
        This yields all the data about the contents of a directory at a time.
 
 
470
        After each directory has been yielded, if the caller has mutated the
 
 
471
        list to exclude some directories, they are then not descended into.
 
 
473
        The data yielded is of the form:
 
 
474
        ((directory-relpath, directory-path-from-root, directory-fileid),
 
 
475
        [(relpath, basename, kind, lstat, path_from_tree_root, file_id, 
 
 
476
          versioned_kind), ...]),
 
 
477
         - directory-relpath is the containing dirs relpath from prefix
 
 
478
         - directory-path-from-root is the containing dirs path from /
 
 
479
         - directory-fileid is the id of the directory if it is versioned.
 
 
480
         - relpath is the relative path within the subtree being walked.
 
 
481
         - basename is the basename
 
 
482
         - kind is the kind of the file now. If unknonwn then the file is not
 
 
483
           present within the tree - but it may be recorded as versioned. See
 
 
485
         - lstat is the stat data *if* the file was statted.
 
 
486
         - path_from_tree_root is the path from the root of the tree.
 
 
487
         - file_id is the file_id if the entry is versioned.
 
 
488
         - versioned_kind is the kind of the file as last recorded in the 
 
 
489
           versioning system. If 'unknown' the file is not versioned.
 
 
490
        One of 'kind' and 'versioned_kind' must not be 'unknown'.
 
 
492
        :param prefix: Start walking from prefix within the tree rather than
 
 
493
        at the root. This allows one to walk a subtree but get paths that are
 
 
494
        relative to a tree rooted higher up.
 
 
495
        :return: an iterator over the directory data.
 
 
497
        raise NotImplementedError(self.walkdirs)
 
 
500
class EmptyTree(Tree):
 
 
503
        self._inventory = Inventory(root_id=None)
 
 
504
        symbol_versioning.warn('EmptyTree is deprecated as of bzr 0.9 please'
 
 
505
                               ' use repository.revision_tree instead.',
 
 
506
                               DeprecationWarning, stacklevel=2)
 
 
508
    def get_parent_ids(self):
 
 
511
    def get_symlink_target(self, file_id):
 
 
514
    def has_filename(self, filename):
 
 
517
    def kind(self, file_id):
 
 
518
        assert self._inventory[file_id].kind == "directory"
 
 
521
    def list_files(self, include_root=False):
 
 
524
    def __contains__(self, file_id):
 
 
525
        return (file_id in self._inventory)
 
 
527
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
 
531
######################################################################
 
 
534
# TODO: Merge these two functions into a single one that can operate
 
 
535
# on either a whole tree or a set of files.
 
 
537
# TODO: Return the diff in order by filename, not by category or in
 
 
538
# random order.  Can probably be done by lock-stepping through the
 
 
539
# filenames from both trees.
 
 
542
def file_status(filename, old_tree, new_tree):
 
 
543
    """Return single-letter status, old and new names for a file.
 
 
545
    The complexity here is in deciding how to represent renames;
 
 
546
    many complex cases are possible.
 
 
548
    old_inv = old_tree.inventory
 
 
549
    new_inv = new_tree.inventory
 
 
550
    new_id = new_inv.path2id(filename)
 
 
551
    old_id = old_inv.path2id(filename)
 
 
553
    if not new_id and not old_id:
 
 
554
        # easy: doesn't exist in either; not versioned at all
 
 
555
        if new_tree.is_ignored(filename):
 
 
556
            return 'I', None, None
 
 
558
            return '?', None, None
 
 
560
        # There is now a file of this name, great.
 
 
563
        # There is no longer a file of this name, but we can describe
 
 
564
        # what happened to the file that used to have
 
 
565
        # this name.  There are two possibilities: either it was
 
 
566
        # deleted entirely, or renamed.
 
 
568
        if new_inv.has_id(old_id):
 
 
569
            return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
 
 
571
            return 'D', old_inv.id2path(old_id), None
 
 
573
    # if the file_id is new in this revision, it is added
 
 
574
    if new_id and not old_inv.has_id(new_id):
 
 
577
    # if there used to be a file of this name, but that ID has now
 
 
578
    # disappeared, it is deleted
 
 
579
    if old_id and not new_inv.has_id(old_id):
 
 
586
def find_renames(old_inv, new_inv):
 
 
587
    for file_id in old_inv:
 
 
588
        if file_id not in new_inv:
 
 
590
        old_name = old_inv.id2path(file_id)
 
 
591
        new_name = new_inv.id2path(file_id)
 
 
592
        if old_name != new_name:
 
 
593
            yield (old_name, new_name)
 
 
596
def find_ids_across_trees(filenames, trees, require_versioned=True):
 
 
597
    """Find the ids corresponding to specified filenames.
 
 
599
    All matches in all trees will be used, and all children of matched
 
 
600
    directories will be used.
 
 
602
    :param filenames: The filenames to find file_ids for (if None, returns
 
 
604
    :param trees: The trees to find file_ids within
 
 
605
    :param require_versioned: if true, all specified filenames must occur in
 
 
607
    :return: a set of file ids for the specified filenames and their children.
 
 
611
    specified_path_ids = _find_ids_across_trees(filenames, trees,
 
 
613
    return _find_children_across_trees(specified_path_ids, trees)
 
 
616
def _find_ids_across_trees(filenames, trees, require_versioned):
 
 
617
    """Find the ids corresponding to specified filenames.
 
 
619
    All matches in all trees will be used, but subdirectories are not scanned.
 
 
621
    :param filenames: The filenames to find file_ids for
 
 
622
    :param trees: The trees to find file_ids within
 
 
623
    :param require_versioned: if true, all specified filenames must occur in
 
 
625
    :return: a set of file ids for the specified filenames
 
 
628
    interesting_ids = set()
 
 
629
    for tree_path in filenames:
 
 
632
            file_id = tree.path2id(tree_path)
 
 
633
            if file_id is not None:
 
 
634
                interesting_ids.add(file_id)
 
 
637
            not_versioned.append(tree_path)
 
 
638
    if len(not_versioned) > 0 and require_versioned:
 
 
639
        raise errors.PathsNotVersionedError(not_versioned)
 
 
640
    return interesting_ids
 
 
643
def _find_children_across_trees(specified_ids, trees):
 
 
644
    """Return a set including specified ids and their children.
 
 
646
    All matches in all trees will be used.
 
 
648
    :param trees: The trees to find file_ids within
 
 
649
    :return: a set containing all specified ids and their children 
 
 
651
    interesting_ids = set(specified_ids)
 
 
652
    pending = interesting_ids
 
 
653
    # now handle children of interesting ids
 
 
654
    # we loop so that we handle all children of each id in both trees
 
 
655
    while len(pending) > 0:
 
 
657
        for file_id in pending:
 
 
659
                if not tree.has_id(file_id):
 
 
661
                entry = tree.inventory[file_id]
 
 
662
                for child in getattr(entry, 'children', {}).itervalues():
 
 
663
                    if child.file_id not in interesting_ids:
 
 
664
                        new_pending.add(child.file_id)
 
 
665
        interesting_ids.update(new_pending)
 
 
666
        pending = new_pending
 
 
667
    return interesting_ids
 
 
670
class InterTree(InterObject):
 
 
671
    """This class represents operations taking place between two Trees.
 
 
673
    Its instances have methods like 'compare' and contain references to the
 
 
674
    source and target trees these operations are to be carried out on.
 
 
676
    Clients of bzrlib should not need to use InterTree directly, rather they
 
 
677
    should use the convenience methods on Tree such as 'Tree.compare()' which
 
 
678
    will pass through to InterTree as appropriate.
 
 
684
    def compare(self, want_unchanged=False, specific_files=None,
 
 
685
        extra_trees=None, require_versioned=False, include_root=False,
 
 
686
        want_unversioned=False):
 
 
687
        """Return the changes from source to target.
 
 
689
        :return: A TreeDelta.
 
 
690
        :param specific_files: An optional list of file paths to restrict the
 
 
691
            comparison to. When mapping filenames to ids, all matches in all
 
 
692
            trees (including optional extra_trees) are used, and all children of
 
 
693
            matched directories are included.
 
 
694
        :param want_unchanged: An optional boolean requesting the inclusion of
 
 
695
            unchanged entries in the result.
 
 
696
        :param extra_trees: An optional list of additional trees to use when
 
 
697
            mapping the contents of specific_files (paths) to file_ids.
 
 
698
        :param require_versioned: An optional boolean (defaults to False). When
 
 
699
            supplied and True all the 'specific_files' must be versioned, or
 
 
700
            a PathsNotVersionedError will be thrown.
 
 
701
        :param want_unversioned: Scan for unversioned paths.
 
 
703
        # NB: show_status depends on being able to pass in non-versioned files
 
 
704
        # and report them as unknown
 
 
705
        trees = (self.source,)
 
 
706
        if extra_trees is not None:
 
 
707
            trees = trees + tuple(extra_trees)
 
 
708
        # target is usually the newer tree:
 
 
709
        specific_file_ids = self.target.paths2ids(specific_files, trees,
 
 
710
            require_versioned=require_versioned)
 
 
711
        if specific_files and not specific_file_ids:
 
 
712
            # All files are unversioned, so just return an empty delta
 
 
713
            # _compare_trees would think we want a complete delta
 
 
714
            result = delta.TreeDelta()
 
 
715
            fake_entry = InventoryFile('unused', 'unused', 'unused')
 
 
716
            result.unversioned = [(path, None,
 
 
717
                self.target._comparison_data(fake_entry, path)[0]) for path in
 
 
720
        return delta._compare_trees(self.source, self.target, want_unchanged,
 
 
721
            specific_files, include_root, extra_trees=extra_trees,
 
 
722
            require_versioned=require_versioned,
 
 
723
            want_unversioned=want_unversioned)
 
 
725
    def iter_changes(self, include_unchanged=False,
 
 
726
                      specific_files=None, pb=None, extra_trees=[],
 
 
727
                      require_versioned=True, want_unversioned=False):
 
 
728
        """Generate an iterator of changes between trees.
 
 
731
        (file_id, (path_in_source, path_in_target),
 
 
732
         changed_content, versioned, parent, name, kind,
 
 
735
        Changed_content is True if the file's content has changed.  This
 
 
736
        includes changes to its kind, and to a symlink's target.
 
 
738
        versioned, parent, name, kind, executable are tuples of (from, to).
 
 
739
        If a file is missing in a tree, its kind is None.
 
 
741
        Iteration is done in parent-to-child order, relative to the target
 
 
744
        There is no guarantee that all paths are in sorted order: the
 
 
745
        requirement to expand the search due to renames may result in children
 
 
746
        that should be found early being found late in the search, after
 
 
747
        lexically later results have been returned.
 
 
748
        :param require_versioned: Raise errors.PathsNotVersionedError if a
 
 
749
            path in the specific_files list is not versioned in one of
 
 
750
            source, target or extra_trees.
 
 
751
        :param want_unversioned: Should unversioned files be returned in the
 
 
752
            output. An unversioned file is defined as one with (False, False)
 
 
753
            for the versioned pair.
 
 
756
        lookup_trees = [self.source]
 
 
758
             lookup_trees.extend(extra_trees)
 
 
759
        if specific_files == []:
 
 
760
            specific_file_ids = []
 
 
762
            specific_file_ids = self.target.paths2ids(specific_files,
 
 
763
                lookup_trees, require_versioned=require_versioned)
 
 
765
            all_unversioned = sorted([(p.split('/'), p) for p in
 
 
767
                if specific_files is None or
 
 
768
                    osutils.is_inside_any(specific_files, p)])
 
 
769
            all_unversioned = deque(all_unversioned)
 
 
771
            all_unversioned = deque()
 
 
773
        from_entries_by_dir = list(self.source.inventory.iter_entries_by_dir(
 
 
774
            specific_file_ids=specific_file_ids))
 
 
775
        from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
 
 
776
        to_entries_by_dir = list(self.target.inventory.iter_entries_by_dir(
 
 
777
            specific_file_ids=specific_file_ids))
 
 
778
        num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
 
 
780
        # the unversioned path lookup only occurs on real trees - where there 
 
 
781
        # can be extras. So the fake_entry is solely used to look up
 
 
782
        # executable it values when execute is not supported.
 
 
783
        fake_entry = InventoryFile('unused', 'unused', 'unused')
 
 
784
        for to_path, to_entry in to_entries_by_dir:
 
 
785
            while all_unversioned and all_unversioned[0][0] < to_path.split('/'):
 
 
786
                unversioned_path = all_unversioned.popleft()
 
 
787
                to_kind, to_executable, to_stat = \
 
 
788
                    self.target._comparison_data(fake_entry, unversioned_path[1])
 
 
789
                yield (None, (None, unversioned_path[1]), True, (False, False),
 
 
791
                    (None, unversioned_path[0][-1]),
 
 
793
                    (None, to_executable))
 
 
794
            file_id = to_entry.file_id
 
 
795
            to_paths[file_id] = to_path
 
 
797
            changed_content = False
 
 
798
            from_path, from_entry = from_data.get(file_id, (None, None))
 
 
799
            from_versioned = (from_entry is not None)
 
 
800
            if from_entry is not None:
 
 
801
                from_versioned = True
 
 
802
                from_name = from_entry.name
 
 
803
                from_parent = from_entry.parent_id
 
 
804
                from_kind, from_executable, from_stat = \
 
 
805
                    self.source._comparison_data(from_entry, from_path)
 
 
808
                from_versioned = False
 
 
812
                from_executable = None
 
 
813
            versioned = (from_versioned, True)
 
 
814
            to_kind, to_executable, to_stat = \
 
 
815
                self.target._comparison_data(to_entry, to_path)
 
 
816
            kind = (from_kind, to_kind)
 
 
817
            if kind[0] != kind[1]:
 
 
818
                changed_content = True
 
 
819
            elif from_kind == 'file':
 
 
820
                from_size = self.source._file_size(from_entry, from_stat)
 
 
821
                to_size = self.target._file_size(to_entry, to_stat)
 
 
822
                if from_size != to_size:
 
 
823
                    changed_content = True
 
 
824
                elif (self.source.get_file_sha1(file_id, from_path, from_stat) !=
 
 
825
                    self.target.get_file_sha1(file_id, to_path, to_stat)):
 
 
826
                    changed_content = True
 
 
827
            elif from_kind == 'symlink':
 
 
828
                if (self.source.get_symlink_target(file_id) !=
 
 
829
                    self.target.get_symlink_target(file_id)):
 
 
830
                    changed_content = True
 
 
831
                elif from_kind == 'tree-reference':
 
 
832
                    if (self.source.get_reference_revision(file_id, from_path)
 
 
833
                        != self.target.get_reference_revision(file_id, to_path)):
 
 
834
                        changed_content = True 
 
 
835
            parent = (from_parent, to_entry.parent_id)
 
 
836
            name = (from_name, to_entry.name)
 
 
837
            executable = (from_executable, to_executable)
 
 
839
                pb.update('comparing files', entry_count, num_entries)
 
 
840
            if (changed_content is not False or versioned[0] != versioned[1]
 
 
841
                or parent[0] != parent[1] or name[0] != name[1] or 
 
 
842
                executable[0] != executable[1] or include_unchanged):
 
 
843
                yield (file_id, (from_path, to_path), changed_content,
 
 
844
                    versioned, parent, name, kind, executable)
 
 
846
        while all_unversioned:
 
 
847
            # yield any trailing unversioned paths
 
 
848
            unversioned_path = all_unversioned.popleft()
 
 
849
            to_kind, to_executable, to_stat = \
 
 
850
                self.target._comparison_data(fake_entry, unversioned_path[1])
 
 
851
            yield (None, (None, unversioned_path[1]), True, (False, False),
 
 
853
                (None, unversioned_path[0][-1]),
 
 
855
                (None, to_executable))
 
 
857
        def get_to_path(to_entry):
 
 
858
            if to_entry.parent_id is None:
 
 
859
                to_path = '' # the root
 
 
861
                if to_entry.parent_id not in to_paths:
 
 
863
                    return get_to_path(self.target.inventory[to_entry.parent_id])
 
 
864
                to_path = osutils.pathjoin(to_paths[to_entry.parent_id],
 
 
866
            to_paths[to_entry.file_id] = to_path
 
 
869
        for path, from_entry in from_entries_by_dir:
 
 
870
            file_id = from_entry.file_id
 
 
871
            if file_id in to_paths:
 
 
874
            if not file_id in self.target.inventory:
 
 
875
                # common case - paths we have not emitted are not present in
 
 
879
                to_path = get_to_path(self.target.inventory[file_id])
 
 
882
                pb.update('comparing files', entry_count, num_entries)
 
 
883
            versioned = (True, False)
 
 
884
            parent = (from_entry.parent_id, None)
 
 
885
            name = (from_entry.name, None)
 
 
886
            from_kind, from_executable, stat_value = \
 
 
887
                self.source._comparison_data(from_entry, path)
 
 
888
            kind = (from_kind, None)
 
 
889
            executable = (from_executable, None)
 
 
890
            changed_content = True
 
 
891
            # the parent's path is necessarily known at this point.
 
 
892
            yield(file_id, (path, to_path), changed_content, versioned, parent,
 
 
893
                  name, kind, executable)
 
 
896
# This was deprecated before 0.12, but did not have an official warning
 
 
897
@symbol_versioning.deprecated_function(symbol_versioning.zero_twelve)
 
 
898
def RevisionTree(*args, **kwargs):
 
 
899
    """RevisionTree has moved to bzrlib.revisiontree.RevisionTree()
 
 
901
    Accessing it as bzrlib.tree.RevisionTree has been deprecated as of
 
 
904
    from bzrlib.revisiontree import RevisionTree as _RevisionTree
 
 
905
    return _RevisionTree(*args, **kwargs)