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 id2path(self, file_id):
 
 
149
        """Return the path for a file id.
 
 
153
        return self.inventory.id2path(file_id)
 
 
155
    def is_control_filename(self, filename):
 
 
156
        """True if filename is the name of a control file in this tree.
 
 
158
        :param filename: A filename within the tree. This is a relative path
 
 
159
        from the root of this tree.
 
 
161
        This is true IF and ONLY IF the filename is part of the meta data
 
 
162
        that bzr controls in this tree. I.E. a random .bzr directory placed
 
 
163
        on disk will not be a control file for this tree.
 
 
165
        return self.bzrdir.is_control_filename(filename)
 
 
168
    def iter_entries_by_dir(self, specific_file_ids=None):
 
 
169
        """Walk the tree in 'by_dir' order.
 
 
171
        This will yield each entry in the tree as a (path, entry) tuple. The
 
 
172
        order that they are yielded is: the contents of a directory are 
 
 
173
        preceeded by the parent of a directory, and all the contents of a 
 
 
174
        directory are grouped together.
 
 
176
        return self.inventory.iter_entries_by_dir(
 
 
177
            specific_file_ids=specific_file_ids)
 
 
179
    def iter_references(self):
 
 
180
        for path, entry in self.iter_entries_by_dir():
 
 
181
            if entry.kind == 'tree-reference':
 
 
182
                yield path, entry.file_id
 
 
184
    def kind(self, file_id):
 
 
185
        raise NotImplementedError("Tree subclass %s must implement kind"
 
 
186
            % self.__class__.__name__)
 
 
188
    def path_content_summary(self, path):
 
 
189
        """Get a summary of the information about path.
 
 
191
        :param path: A relative path within the tree.
 
 
192
        :return: A tuple containing kind, size, exec, sha1-or-link.
 
 
193
            Kind is always present (see tree.kind()).
 
 
194
            size is present if kind is file, None otherwise.
 
 
195
            exec is None unless kind is file and the platform supports the 'x'
 
 
197
            sha1-or-link is the link target if kind is symlink, or the sha1 if
 
 
198
                it can be obtained without reading the file.
 
 
200
        raise NotImplementedError(self.path_content_summary)
 
 
202
    def get_reference_revision(self, file_id, path=None):
 
 
203
        raise NotImplementedError("Tree subclass %s must implement "
 
 
204
                                  "get_reference_revision"
 
 
205
            % self.__class__.__name__)
 
 
207
    def _comparison_data(self, entry, path):
 
 
208
        """Return a tuple of kind, executable, stat_value for a file.
 
 
210
        entry may be None if there is no inventory entry for the file, but
 
 
211
        path must always be supplied.
 
 
213
        kind is None if there is no file present (even if an inventory id is
 
 
214
        present).  executable is False for non-file entries.
 
 
216
        raise NotImplementedError(self._comparison_data)
 
 
218
    def _file_size(self, entry, stat_value):
 
 
219
        raise NotImplementedError(self._file_size)
 
 
221
    def _get_inventory(self):
 
 
222
        return self._inventory
 
 
224
    def get_file(self, file_id, path=None):
 
 
225
        """Return a file object for the file file_id in the tree.
 
 
227
        If both file_id and path are defined, it is implementation defined as
 
 
228
        to which one is used.
 
 
230
        raise NotImplementedError(self.get_file)
 
 
232
    def get_file_mtime(self, file_id, path=None):
 
 
233
        """Return the modification time for a file.
 
 
235
        :param file_id: The handle for this file.
 
 
236
        :param path: The path that this file can be found at.
 
 
237
            These must point to the same object.
 
 
239
        raise NotImplementedError(self.get_file_mtime)
 
 
241
    def get_file_by_path(self, path):
 
 
242
        return self.get_file(self._inventory.path2id(path), path)
 
 
244
    def iter_files_bytes(self, desired_files):
 
 
245
        """Iterate through file contents.
 
 
247
        Files will not necessarily be returned in the order they occur in
 
 
248
        desired_files.  No specific order is guaranteed.
 
 
250
        Yields pairs of identifier, bytes_iterator.  identifier is an opaque
 
 
251
        value supplied by the caller as part of desired_files.  It should
 
 
252
        uniquely identify the file version in the caller's context.  (Examples:
 
 
253
        an index number or a TreeTransform trans_id.)
 
 
255
        bytes_iterator is an iterable of bytestrings for the file.  The
 
 
256
        kind of iterable and length of the bytestrings are unspecified, but for
 
 
257
        this implementation, it is a tuple containing a single bytestring with
 
 
258
        the complete text of the file.
 
 
260
        :param desired_files: a list of (file_id, identifier) pairs
 
 
262
        for file_id, identifier in desired_files:
 
 
263
            # We wrap the string in a tuple so that we can return an iterable
 
 
264
            # of bytestrings.  (Technically, a bytestring is also an iterable
 
 
265
            # of bytestrings, but iterating through each character is not
 
 
267
            cur_file = (self.get_file_text(file_id),)
 
 
268
            yield identifier, cur_file
 
 
270
    def get_symlink_target(self, file_id):
 
 
271
        """Get the target for a given file_id.
 
 
273
        It is assumed that the caller already knows that file_id is referencing
 
 
275
        :param file_id: Handle for the symlink entry.
 
 
276
        :return: The path the symlink points to.
 
 
278
        raise NotImplementedError(self.get_symlink_target)
 
 
280
    def get_root_id(self):
 
 
281
        """Return the file_id for the root of this tree."""
 
 
282
        raise NotImplementedError(self.get_root_id)
 
 
284
    def annotate_iter(self, file_id):
 
 
285
        """Return an iterator of revision_id, line tuples.
 
 
287
        For working trees (and mutable trees in general), the special
 
 
288
        revision_id 'current:' will be used for lines that are new in this
 
 
289
        tree, e.g. uncommitted changes.
 
 
290
        :param file_id: The file to produce an annotated version from
 
 
292
        raise NotImplementedError(self.annotate_iter)
 
 
294
    def plan_file_merge(self, file_id, other):
 
 
295
        """Generate a merge plan based on annotations.
 
 
297
        If the file contains uncommitted changes in this tree, they will be
 
 
298
        attributed to the 'current:' pseudo-revision.  If the file contains
 
 
299
        uncommitted changes in the other tree, they will be assigned to the
 
 
300
        'other:' pseudo-revision.
 
 
302
        from bzrlib import merge, versionedfile
 
 
303
        vf = versionedfile._PlanMergeVersionedFile(file_id)
 
 
304
        last_revision_a = self._get_file_revision(file_id, vf, 'this:')
 
 
305
        last_revision_b = other._get_file_revision(file_id, vf, 'other:')
 
 
306
        return vf.plan_merge(last_revision_a, last_revision_b)
 
 
308
    def _get_file_revision(self, file_id, vf, tree_revision):
 
 
309
        def file_revision(revision_tree):
 
 
310
            revision_tree.lock_read()
 
 
312
                return revision_tree.inventory[file_id].revision
 
 
314
                revision_tree.unlock()
 
 
316
        def iter_parent_trees():
 
 
317
            for revision_id in self.get_parent_ids():
 
 
319
                    yield self.revision_tree(revision_id)
 
 
321
                    yield self.repository.revision_tree(revision_id)
 
 
323
        if getattr(self, '_get_weave', None) is None:
 
 
324
            last_revision = tree_revision
 
 
325
            parent_revisions = [file_revision(t) for t in iter_parent_trees()]
 
 
326
            vf.add_lines(last_revision, parent_revisions,
 
 
327
                         self.get_file(file_id).readlines())
 
 
328
            repo = self.branch.repository
 
 
329
            transaction = repo.get_transaction()
 
 
330
            base_vf = repo.weave_store.get_weave(file_id, transaction)
 
 
332
            last_revision = file_revision(self)
 
 
333
            base_vf = self._get_weave(file_id)
 
 
334
        vf.fallback_versionedfiles.append(base_vf)
 
 
337
    inventory = property(_get_inventory,
 
 
338
                         doc="Inventory of this Tree")
 
 
340
    def _check_retrieved(self, ie, f):
 
 
343
        fp = fingerprint_file(f)
 
 
346
        if ie.text_size is not None:
 
 
347
            if ie.text_size != fp['size']:
 
 
348
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
 
 
349
                        ["inventory expects %d bytes" % ie.text_size,
 
 
350
                         "file is actually %d bytes" % fp['size'],
 
 
351
                         "store is probably damaged/corrupt"])
 
 
353
        if ie.text_sha1 != fp['sha1']:
 
 
354
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
 
 
355
                    ["inventory expects %s" % ie.text_sha1,
 
 
356
                     "file is actually %s" % fp['sha1'],
 
 
357
                     "store is probably damaged/corrupt"])
 
 
360
    def path2id(self, path):
 
 
361
        """Return the id for path in this tree."""
 
 
362
        return self._inventory.path2id(path)
 
 
364
    def paths2ids(self, paths, trees=[], require_versioned=True):
 
 
365
        """Return all the ids that can be reached by walking from paths.
 
 
367
        Each path is looked up in this tree and any extras provided in
 
 
368
        trees, and this is repeated recursively: the children in an extra tree
 
 
369
        of a directory that has been renamed under a provided path in this tree
 
 
370
        are all returned, even if none exist under a provided path in this
 
 
371
        tree, and vice versa.
 
 
373
        :param paths: An iterable of paths to start converting to ids from.
 
 
374
            Alternatively, if paths is None, no ids should be calculated and None
 
 
375
            will be returned. This is offered to make calling the api unconditional
 
 
376
            for code that *might* take a list of files.
 
 
377
        :param trees: Additional trees to consider.
 
 
378
        :param require_versioned: If False, do not raise NotVersionedError if
 
 
379
            an element of paths is not versioned in this tree and all of trees.
 
 
381
        return find_ids_across_trees(paths, [self] + list(trees), require_versioned)
 
 
383
    def print_file(self, file_id):
 
 
384
        """Print file with id `file_id` to stdout."""
 
 
386
        sys.stdout.write(self.get_file_text(file_id))
 
 
391
    def revision_tree(self, revision_id):
 
 
392
        """Obtain a revision tree for the revision revision_id.
 
 
394
        The intention of this method is to allow access to possibly cached
 
 
395
        tree data. Implementors of this method should raise NoSuchRevision if
 
 
396
        the tree is not locally available, even if they could obtain the 
 
 
397
        tree via a repository or some other means. Callers are responsible 
 
 
398
        for finding the ultimate source for a revision tree.
 
 
400
        :param revision_id: The revision_id of the requested tree.
 
 
402
        :raises: NoSuchRevision if the tree cannot be obtained.
 
 
404
        raise errors.NoSuchRevisionInTree(self, revision_id)
 
 
407
        """What files are present in this tree and unknown.
 
 
409
        :return: an iterator over the unknown files.
 
 
416
    def filter_unversioned_files(self, paths):
 
 
417
        """Filter out paths that are versioned.
 
 
419
        :return: set of paths.
 
 
421
        # NB: we specifically *don't* call self.has_filename, because for
 
 
422
        # WorkingTrees that can indicate files that exist on disk but that 
 
 
424
        pred = self.inventory.has_filename
 
 
425
        return set((p for p in paths if not pred(p)))
 
 
427
    def walkdirs(self, prefix=""):
 
 
428
        """Walk the contents of this tree from path down.
 
 
430
        This yields all the data about the contents of a directory at a time.
 
 
431
        After each directory has been yielded, if the caller has mutated the
 
 
432
        list to exclude some directories, they are then not descended into.
 
 
434
        The data yielded is of the form:
 
 
435
        ((directory-relpath, directory-path-from-root, directory-fileid),
 
 
436
        [(relpath, basename, kind, lstat, path_from_tree_root, file_id, 
 
 
437
          versioned_kind), ...]),
 
 
438
         - directory-relpath is the containing dirs relpath from prefix
 
 
439
         - directory-path-from-root is the containing dirs path from /
 
 
440
         - directory-fileid is the id of the directory if it is versioned.
 
 
441
         - relpath is the relative path within the subtree being walked.
 
 
442
         - basename is the basename
 
 
443
         - kind is the kind of the file now. If unknonwn then the file is not
 
 
444
           present within the tree - but it may be recorded as versioned. See
 
 
446
         - lstat is the stat data *if* the file was statted.
 
 
447
         - path_from_tree_root is the path from the root of the tree.
 
 
448
         - file_id is the file_id if the entry is versioned.
 
 
449
         - versioned_kind is the kind of the file as last recorded in the 
 
 
450
           versioning system. If 'unknown' the file is not versioned.
 
 
451
        One of 'kind' and 'versioned_kind' must not be 'unknown'.
 
 
453
        :param prefix: Start walking from prefix within the tree rather than
 
 
454
        at the root. This allows one to walk a subtree but get paths that are
 
 
455
        relative to a tree rooted higher up.
 
 
456
        :return: an iterator over the directory data.
 
 
458
        raise NotImplementedError(self.walkdirs)
 
 
461
class EmptyTree(Tree):
 
 
464
        self._inventory = Inventory(root_id=None)
 
 
465
        symbol_versioning.warn('EmptyTree is deprecated as of bzr 0.9 please'
 
 
466
                               ' use repository.revision_tree instead.',
 
 
467
                               DeprecationWarning, stacklevel=2)
 
 
469
    def get_parent_ids(self):
 
 
472
    def get_symlink_target(self, file_id):
 
 
475
    def has_filename(self, filename):
 
 
478
    def kind(self, file_id):
 
 
479
        assert self._inventory[file_id].kind == "directory"
 
 
482
    def list_files(self, include_root=False):
 
 
485
    def __contains__(self, file_id):
 
 
486
        return (file_id in self._inventory)
 
 
488
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
 
492
######################################################################
 
 
495
# TODO: Merge these two functions into a single one that can operate
 
 
496
# on either a whole tree or a set of files.
 
 
498
# TODO: Return the diff in order by filename, not by category or in
 
 
499
# random order.  Can probably be done by lock-stepping through the
 
 
500
# filenames from both trees.
 
 
503
def file_status(filename, old_tree, new_tree):
 
 
504
    """Return single-letter status, old and new names for a file.
 
 
506
    The complexity here is in deciding how to represent renames;
 
 
507
    many complex cases are possible.
 
 
509
    old_inv = old_tree.inventory
 
 
510
    new_inv = new_tree.inventory
 
 
511
    new_id = new_inv.path2id(filename)
 
 
512
    old_id = old_inv.path2id(filename)
 
 
514
    if not new_id and not old_id:
 
 
515
        # easy: doesn't exist in either; not versioned at all
 
 
516
        if new_tree.is_ignored(filename):
 
 
517
            return 'I', None, None
 
 
519
            return '?', None, None
 
 
521
        # There is now a file of this name, great.
 
 
524
        # There is no longer a file of this name, but we can describe
 
 
525
        # what happened to the file that used to have
 
 
526
        # this name.  There are two possibilities: either it was
 
 
527
        # deleted entirely, or renamed.
 
 
529
        if new_inv.has_id(old_id):
 
 
530
            return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
 
 
532
            return 'D', old_inv.id2path(old_id), None
 
 
534
    # if the file_id is new in this revision, it is added
 
 
535
    if new_id and not old_inv.has_id(new_id):
 
 
538
    # if there used to be a file of this name, but that ID has now
 
 
539
    # disappeared, it is deleted
 
 
540
    if old_id and not new_inv.has_id(old_id):
 
 
547
def find_renames(old_inv, new_inv):
 
 
548
    for file_id in old_inv:
 
 
549
        if file_id not in new_inv:
 
 
551
        old_name = old_inv.id2path(file_id)
 
 
552
        new_name = new_inv.id2path(file_id)
 
 
553
        if old_name != new_name:
 
 
554
            yield (old_name, new_name)
 
 
557
def find_ids_across_trees(filenames, trees, require_versioned=True):
 
 
558
    """Find the ids corresponding to specified filenames.
 
 
560
    All matches in all trees will be used, and all children of matched
 
 
561
    directories will be used.
 
 
563
    :param filenames: The filenames to find file_ids for (if None, returns
 
 
565
    :param trees: The trees to find file_ids within
 
 
566
    :param require_versioned: if true, all specified filenames must occur in
 
 
568
    :return: a set of file ids for the specified filenames and their children.
 
 
572
    specified_path_ids = _find_ids_across_trees(filenames, trees,
 
 
574
    return _find_children_across_trees(specified_path_ids, trees)
 
 
577
def _find_ids_across_trees(filenames, trees, require_versioned):
 
 
578
    """Find the ids corresponding to specified filenames.
 
 
580
    All matches in all trees will be used, but subdirectories are not scanned.
 
 
582
    :param filenames: The filenames to find file_ids for
 
 
583
    :param trees: The trees to find file_ids within
 
 
584
    :param require_versioned: if true, all specified filenames must occur in
 
 
586
    :return: a set of file ids for the specified filenames
 
 
589
    interesting_ids = set()
 
 
590
    for tree_path in filenames:
 
 
593
            file_id = tree.path2id(tree_path)
 
 
594
            if file_id is not None:
 
 
595
                interesting_ids.add(file_id)
 
 
598
            not_versioned.append(tree_path)
 
 
599
    if len(not_versioned) > 0 and require_versioned:
 
 
600
        raise errors.PathsNotVersionedError(not_versioned)
 
 
601
    return interesting_ids
 
 
604
def _find_children_across_trees(specified_ids, trees):
 
 
605
    """Return a set including specified ids and their children.
 
 
607
    All matches in all trees will be used.
 
 
609
    :param trees: The trees to find file_ids within
 
 
610
    :return: a set containing all specified ids and their children 
 
 
612
    interesting_ids = set(specified_ids)
 
 
613
    pending = interesting_ids
 
 
614
    # now handle children of interesting ids
 
 
615
    # we loop so that we handle all children of each id in both trees
 
 
616
    while len(pending) > 0:
 
 
618
        for file_id in pending:
 
 
620
                if not tree.has_id(file_id):
 
 
622
                entry = tree.inventory[file_id]
 
 
623
                for child in getattr(entry, 'children', {}).itervalues():
 
 
624
                    if child.file_id not in interesting_ids:
 
 
625
                        new_pending.add(child.file_id)
 
 
626
        interesting_ids.update(new_pending)
 
 
627
        pending = new_pending
 
 
628
    return interesting_ids
 
 
631
class InterTree(InterObject):
 
 
632
    """This class represents operations taking place between two Trees.
 
 
634
    Its instances have methods like 'compare' and contain references to the
 
 
635
    source and target trees these operations are to be carried out on.
 
 
637
    Clients of bzrlib should not need to use InterTree directly, rather they
 
 
638
    should use the convenience methods on Tree such as 'Tree.compare()' which
 
 
639
    will pass through to InterTree as appropriate.
 
 
645
    def compare(self, want_unchanged=False, specific_files=None,
 
 
646
        extra_trees=None, require_versioned=False, include_root=False,
 
 
647
        want_unversioned=False):
 
 
648
        """Return the changes from source to target.
 
 
650
        :return: A TreeDelta.
 
 
651
        :param specific_files: An optional list of file paths to restrict the
 
 
652
            comparison to. When mapping filenames to ids, all matches in all
 
 
653
            trees (including optional extra_trees) are used, and all children of
 
 
654
            matched directories are included.
 
 
655
        :param want_unchanged: An optional boolean requesting the inclusion of
 
 
656
            unchanged entries in the result.
 
 
657
        :param extra_trees: An optional list of additional trees to use when
 
 
658
            mapping the contents of specific_files (paths) to file_ids.
 
 
659
        :param require_versioned: An optional boolean (defaults to False). When
 
 
660
            supplied and True all the 'specific_files' must be versioned, or
 
 
661
            a PathsNotVersionedError will be thrown.
 
 
662
        :param want_unversioned: Scan for unversioned paths.
 
 
664
        # NB: show_status depends on being able to pass in non-versioned files
 
 
665
        # and report them as unknown
 
 
666
        trees = (self.source,)
 
 
667
        if extra_trees is not None:
 
 
668
            trees = trees + tuple(extra_trees)
 
 
669
        # target is usually the newer tree:
 
 
670
        specific_file_ids = self.target.paths2ids(specific_files, trees,
 
 
671
            require_versioned=require_versioned)
 
 
672
        if specific_files and not specific_file_ids:
 
 
673
            # All files are unversioned, so just return an empty delta
 
 
674
            # _compare_trees would think we want a complete delta
 
 
675
            result = delta.TreeDelta()
 
 
676
            fake_entry = InventoryFile('unused', 'unused', 'unused')
 
 
677
            result.unversioned = [(path, None,
 
 
678
                self.target._comparison_data(fake_entry, path)[0]) for path in
 
 
681
        return delta._compare_trees(self.source, self.target, want_unchanged,
 
 
682
            specific_files, include_root, extra_trees=extra_trees,
 
 
683
            require_versioned=require_versioned,
 
 
684
            want_unversioned=want_unversioned)
 
 
686
    def _iter_changes(self, include_unchanged=False,
 
 
687
                      specific_files=None, pb=None, extra_trees=[],
 
 
688
                      require_versioned=True, want_unversioned=False):
 
 
689
        """Generate an iterator of changes between trees.
 
 
692
        (file_id, (path_in_source, path_in_target),
 
 
693
         changed_content, versioned, parent, name, kind,
 
 
696
        Changed_content is True if the file's content has changed.  This
 
 
697
        includes changes to its kind, and to a symlink's target.
 
 
699
        versioned, parent, name, kind, executable are tuples of (from, to).
 
 
700
        If a file is missing in a tree, its kind is None.
 
 
702
        Iteration is done in parent-to-child order, relative to the target
 
 
705
        There is no guarantee that all paths are in sorted order: the
 
 
706
        requirement to expand the search due to renames may result in children
 
 
707
        that should be found early being found late in the search, after
 
 
708
        lexically later results have been returned.
 
 
709
        :param require_versioned: Raise errors.PathsNotVersionedError if a
 
 
710
            path in the specific_files list is not versioned in one of
 
 
711
            source, target or extra_trees.
 
 
712
        :param want_unversioned: Should unversioned files be returned in the
 
 
713
            output. An unversioned file is defined as one with (False, False)
 
 
714
            for the versioned pair.
 
 
717
        lookup_trees = [self.source]
 
 
719
             lookup_trees.extend(extra_trees)
 
 
720
        if specific_files == []:
 
 
721
            specific_file_ids = []
 
 
723
            specific_file_ids = self.target.paths2ids(specific_files,
 
 
724
                lookup_trees, require_versioned=require_versioned)
 
 
726
            all_unversioned = sorted([(p.split('/'), p) for p in
 
 
728
                if specific_files is None or
 
 
729
                    osutils.is_inside_any(specific_files, p)])
 
 
730
            all_unversioned = deque(all_unversioned)
 
 
732
            all_unversioned = deque()
 
 
734
        from_entries_by_dir = list(self.source.inventory.iter_entries_by_dir(
 
 
735
            specific_file_ids=specific_file_ids))
 
 
736
        from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
 
 
737
        to_entries_by_dir = list(self.target.inventory.iter_entries_by_dir(
 
 
738
            specific_file_ids=specific_file_ids))
 
 
739
        num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
 
 
741
        # the unversioned path lookup only occurs on real trees - where there 
 
 
742
        # can be extras. So the fake_entry is solely used to look up
 
 
743
        # executable it values when execute is not supported.
 
 
744
        fake_entry = InventoryFile('unused', 'unused', 'unused')
 
 
745
        for to_path, to_entry in to_entries_by_dir:
 
 
746
            while all_unversioned and all_unversioned[0][0] < to_path.split('/'):
 
 
747
                unversioned_path = all_unversioned.popleft()
 
 
748
                to_kind, to_executable, to_stat = \
 
 
749
                    self.target._comparison_data(fake_entry, unversioned_path[1])
 
 
750
                yield (None, (None, unversioned_path[1]), True, (False, False),
 
 
752
                    (None, unversioned_path[0][-1]),
 
 
754
                    (None, to_executable))
 
 
755
            file_id = to_entry.file_id
 
 
756
            to_paths[file_id] = to_path
 
 
758
            changed_content = False
 
 
759
            from_path, from_entry = from_data.get(file_id, (None, None))
 
 
760
            from_versioned = (from_entry is not None)
 
 
761
            if from_entry is not None:
 
 
762
                from_versioned = True
 
 
763
                from_name = from_entry.name
 
 
764
                from_parent = from_entry.parent_id
 
 
765
                from_kind, from_executable, from_stat = \
 
 
766
                    self.source._comparison_data(from_entry, from_path)
 
 
769
                from_versioned = False
 
 
773
                from_executable = None
 
 
774
            versioned = (from_versioned, True)
 
 
775
            to_kind, to_executable, to_stat = \
 
 
776
                self.target._comparison_data(to_entry, to_path)
 
 
777
            kind = (from_kind, to_kind)
 
 
778
            if kind[0] != kind[1]:
 
 
779
                changed_content = True
 
 
780
            elif from_kind == 'file':
 
 
781
                from_size = self.source._file_size(from_entry, from_stat)
 
 
782
                to_size = self.target._file_size(to_entry, to_stat)
 
 
783
                if from_size != to_size:
 
 
784
                    changed_content = True
 
 
785
                elif (self.source.get_file_sha1(file_id, from_path, from_stat) !=
 
 
786
                    self.target.get_file_sha1(file_id, to_path, to_stat)):
 
 
787
                    changed_content = True
 
 
788
            elif from_kind == 'symlink':
 
 
789
                if (self.source.get_symlink_target(file_id) !=
 
 
790
                    self.target.get_symlink_target(file_id)):
 
 
791
                    changed_content = True
 
 
792
                elif from_kind == 'tree-reference':
 
 
793
                    if (self.source.get_reference_revision(file_id, from_path)
 
 
794
                        != self.target.get_reference_revision(file_id, to_path)):
 
 
795
                        changed_content = True 
 
 
796
            parent = (from_parent, to_entry.parent_id)
 
 
797
            name = (from_name, to_entry.name)
 
 
798
            executable = (from_executable, to_executable)
 
 
800
                pb.update('comparing files', entry_count, num_entries)
 
 
801
            if (changed_content is not False or versioned[0] != versioned[1]
 
 
802
                or parent[0] != parent[1] or name[0] != name[1] or 
 
 
803
                executable[0] != executable[1] or include_unchanged):
 
 
804
                yield (file_id, (from_path, to_path), changed_content,
 
 
805
                    versioned, parent, name, kind, executable)
 
 
807
        while all_unversioned:
 
 
808
            # yield any trailing unversioned paths
 
 
809
            unversioned_path = all_unversioned.popleft()
 
 
810
            to_kind, to_executable, to_stat = \
 
 
811
                self.target._comparison_data(fake_entry, unversioned_path[1])
 
 
812
            yield (None, (None, unversioned_path[1]), True, (False, False),
 
 
814
                (None, unversioned_path[0][-1]),
 
 
816
                (None, to_executable))
 
 
818
        def get_to_path(to_entry):
 
 
819
            if to_entry.parent_id is None:
 
 
820
                to_path = '' # the root
 
 
822
                if to_entry.parent_id not in to_paths:
 
 
824
                    return get_to_path(self.target.inventory[to_entry.parent_id])
 
 
825
                to_path = osutils.pathjoin(to_paths[to_entry.parent_id],
 
 
827
            to_paths[to_entry.file_id] = to_path
 
 
830
        for path, from_entry in from_entries_by_dir:
 
 
831
            file_id = from_entry.file_id
 
 
832
            if file_id in to_paths:
 
 
835
            if not file_id in self.target.inventory:
 
 
836
                # common case - paths we have not emitted are not present in
 
 
840
                to_path = get_to_path(self.target.inventory[file_id])
 
 
843
                pb.update('comparing files', entry_count, num_entries)
 
 
844
            versioned = (True, False)
 
 
845
            parent = (from_entry.parent_id, None)
 
 
846
            name = (from_entry.name, None)
 
 
847
            from_kind, from_executable, stat_value = \
 
 
848
                self.source._comparison_data(from_entry, path)
 
 
849
            kind = (from_kind, None)
 
 
850
            executable = (from_executable, None)
 
 
851
            changed_content = True
 
 
852
            # the parent's path is necessarily known at this point.
 
 
853
            yield(file_id, (path, to_path), changed_content, versioned, parent,
 
 
854
                  name, kind, executable)
 
 
857
# This was deprecated before 0.12, but did not have an official warning
 
 
858
@symbol_versioning.deprecated_function(symbol_versioning.zero_twelve)
 
 
859
def RevisionTree(*args, **kwargs):
 
 
860
    """RevisionTree has moved to bzrlib.revisiontree.RevisionTree()
 
 
862
    Accessing it as bzrlib.tree.RevisionTree has been deprecated as of
 
 
865
    from bzrlib.revisiontree import RevisionTree as _RevisionTree
 
 
866
    return _RevisionTree(*args, **kwargs)