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()
 
 
127
    def has_id(self, file_id):
 
 
128
        file_id = osutils.safe_file_id(file_id)
 
 
129
        return self.inventory.has_id(file_id)
 
 
131
    __contains__ = has_id
 
 
133
    def has_or_had_id(self, file_id):
 
 
134
        file_id = osutils.safe_file_id(file_id)
 
 
135
        if file_id == self.inventory.root.file_id:
 
 
137
        return self.inventory.has_id(file_id)
 
 
139
    def is_ignored(self, filename):
 
 
140
        """Check whether the filename is ignored by this tree.
 
 
142
        :param filename: The relative filename within the tree.
 
 
143
        :return: True if the filename is ignored.
 
 
148
        return iter(self.inventory)
 
 
150
    def id2path(self, file_id):
 
 
151
        """Return the path for a file id.
 
 
155
        file_id = osutils.safe_file_id(file_id)
 
 
156
        return self.inventory.id2path(file_id)
 
 
158
    def is_control_filename(self, filename):
 
 
159
        """True if filename is the name of a control file in this tree.
 
 
161
        :param filename: A filename within the tree. This is a relative path
 
 
162
        from the root of this tree.
 
 
164
        This is true IF and ONLY IF the filename is part of the meta data
 
 
165
        that bzr controls in this tree. I.E. a random .bzr directory placed
 
 
166
        on disk will not be a control file for this tree.
 
 
168
        return self.bzrdir.is_control_filename(filename)
 
 
171
    def iter_entries_by_dir(self, specific_file_ids=None):
 
 
172
        """Walk the tree in 'by_dir' order.
 
 
174
        This will yield each entry in the tree as a (path, entry) tuple. The
 
 
175
        order that they are yielded is: the contents of a directory are 
 
 
176
        preceeded by the parent of a directory, and all the contents of a 
 
 
177
        directory are grouped together.
 
 
179
        return self.inventory.iter_entries_by_dir(
 
 
180
            specific_file_ids=specific_file_ids)
 
 
182
    def iter_references(self):
 
 
183
        for path, entry in self.iter_entries_by_dir():
 
 
184
            if entry.kind == 'tree-reference':
 
 
185
                yield path, entry.file_id
 
 
187
    def kind(self, file_id):
 
 
188
        raise NotImplementedError("Tree subclass %s must implement kind"
 
 
189
            % self.__class__.__name__)
 
 
191
    def get_reference_revision(self, file_id, path=None):
 
 
192
        raise NotImplementedError("Tree subclass %s must implement "
 
 
193
                                  "get_reference_revision"
 
 
194
            % self.__class__.__name__)
 
 
196
    def _comparison_data(self, entry, path):
 
 
197
        """Return a tuple of kind, executable, stat_value for a file.
 
 
199
        entry may be None if there is no inventory entry for the file, but
 
 
200
        path must always be supplied.
 
 
202
        kind is None if there is no file present (even if an inventory id is
 
 
203
        present).  executable is False for non-file entries.
 
 
205
        raise NotImplementedError(self._comparison_data)
 
 
207
    def _file_size(self, entry, stat_value):
 
 
208
        raise NotImplementedError(self._file_size)
 
 
210
    def _get_inventory(self):
 
 
211
        return self._inventory
 
 
213
    def get_file(self, file_id, path=None):
 
 
214
        """Return a file object for the file file_id in the tree.
 
 
216
        If both file_id and path are defined, it is implementation defined as
 
 
217
        to which one is used.
 
 
219
        raise NotImplementedError(self.get_file)
 
 
221
    def get_file_mtime(self, file_id, path=None):
 
 
222
        """Return the modification time for a file.
 
 
224
        :param file_id: The handle for this file.
 
 
225
        :param path: The path that this file can be found at.
 
 
226
            These must point to the same object.
 
 
228
        raise NotImplementedError(self.get_file_mtime)
 
 
230
    def get_file_by_path(self, path):
 
 
231
        return self.get_file(self._inventory.path2id(path))
 
 
233
    def iter_files_bytes(self, desired_files):
 
 
234
        """Iterate through file contents.
 
 
236
        Files will not necessarily be returned in the order they occur in
 
 
237
        desired_files.  No specific order is guaranteed.
 
 
239
        Yields pairs of identifier, bytes_iterator.  identifier is an opaque
 
 
240
        value supplied by the caller as part of desired_files.  It should
 
 
241
        uniquely identify the file version in the caller's context.  (Examples:
 
 
242
        an index number or a TreeTransform trans_id.)
 
 
244
        bytes_iterator is an iterable of bytestrings for the file.  The
 
 
245
        kind of iterable and length of the bytestrings are unspecified, but for
 
 
246
        this implementation, it is a tuple containing a single bytestring with
 
 
247
        the complete text of the file.
 
 
249
        :param desired_files: a list of (file_id, identifier) pairs
 
 
251
        for file_id, identifier in desired_files:
 
 
252
            # We wrap the string in a tuple so that we can return an iterable
 
 
253
            # of bytestrings.  (Technically, a bytestring is also an iterable
 
 
254
            # of bytestrings, but iterating through each character is not
 
 
256
            cur_file = (self.get_file_text(file_id),)
 
 
257
            yield identifier, cur_file
 
 
259
    def get_symlink_target(self, file_id):
 
 
260
        """Get the target for a given file_id.
 
 
262
        It is assumed that the caller already knows that file_id is referencing
 
 
264
        :param file_id: Handle for the symlink entry.
 
 
265
        :return: The path the symlink points to.
 
 
267
        raise NotImplementedError(self.get_symlink_target)
 
 
269
    def annotate_iter(self, file_id):
 
 
270
        """Return an iterator of revision_id, line tuples
 
 
272
        For working trees (and mutable trees in general), the special
 
 
273
        revision_id 'current:' will be used for lines that are new in this
 
 
274
        tree, e.g. uncommitted changes.
 
 
275
        :param file_id: The file to produce an annotated version from
 
 
277
        raise NotImplementedError(self.annotate_iter)
 
 
279
    def plan_file_merge(self, file_id, other):
 
 
280
        """Generate a merge plan based on annotations
 
 
282
        If the file contains uncommitted changes in this tree, they will be
 
 
283
        attributed to the 'current:' pseudo-revision.  If the file contains
 
 
284
        uncommitted changes in the other tree, they will be assigned to the
 
 
285
        'other:' pseudo-revision.
 
 
287
        from bzrlib import merge
 
 
288
        annotated_a = list(self.annotate_iter(file_id,
 
 
289
                                              _mod_revision.CURRENT_REVISION))
 
 
290
        annotated_b = list(other.annotate_iter(file_id, 'other:'))
 
 
291
        ancestors_a = self._get_ancestors(_mod_revision.CURRENT_REVISION)
 
 
292
        ancestors_b = other._get_ancestors('other:')
 
 
293
        return merge._plan_annotate_merge(annotated_a, annotated_b,
 
 
294
                                          ancestors_a, ancestors_b)
 
 
296
    inventory = property(_get_inventory,
 
 
297
                         doc="Inventory of this Tree")
 
 
299
    def _check_retrieved(self, ie, f):
 
 
302
        fp = fingerprint_file(f)
 
 
305
        if ie.text_size is not None:
 
 
306
            if ie.text_size != fp['size']:
 
 
307
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
 
 
308
                        ["inventory expects %d bytes" % ie.text_size,
 
 
309
                         "file is actually %d bytes" % fp['size'],
 
 
310
                         "store is probably damaged/corrupt"])
 
 
312
        if ie.text_sha1 != fp['sha1']:
 
 
313
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
 
 
314
                    ["inventory expects %s" % ie.text_sha1,
 
 
315
                     "file is actually %s" % fp['sha1'],
 
 
316
                     "store is probably damaged/corrupt"])
 
 
319
    def path2id(self, path):
 
 
320
        """Return the id for path in this tree."""
 
 
321
        return self._inventory.path2id(path)
 
 
323
    def paths2ids(self, paths, trees=[], require_versioned=True):
 
 
324
        """Return all the ids that can be reached by walking from paths.
 
 
326
        Each path is looked up in each this tree and any extras provided in
 
 
327
        trees, and this is repeated recursively: the children in an extra tree
 
 
328
        of a directory that has been renamed under a provided path in this tree
 
 
329
        are all returned, even if none exist until a provided path in this
 
 
330
        tree, and vice versa.
 
 
332
        :param paths: An iterable of paths to start converting to ids from.
 
 
333
            Alternatively, if paths is None, no ids should be calculated and None
 
 
334
            will be returned. This is offered to make calling the api unconditional
 
 
335
            for code that *might* take a list of files.
 
 
336
        :param trees: Additional trees to consider.
 
 
337
        :param require_versioned: If False, do not raise NotVersionedError if
 
 
338
            an element of paths is not versioned in this tree and all of trees.
 
 
340
        return find_ids_across_trees(paths, [self] + list(trees), require_versioned)
 
 
342
    def print_file(self, file_id):
 
 
343
        """Print file with id `file_id` to stdout."""
 
 
344
        file_id = osutils.safe_file_id(file_id)
 
 
346
        sys.stdout.write(self.get_file_text(file_id))
 
 
351
    def revision_tree(self, revision_id):
 
 
352
        """Obtain a revision tree for the revision revision_id.
 
 
354
        The intention of this method is to allow access to possibly cached
 
 
355
        tree data. Implementors of this method should raise NoSuchRevision if
 
 
356
        the tree is not locally available, even if they could obtain the 
 
 
357
        tree via a repository or some other means. Callers are responsible 
 
 
358
        for finding the ultimate source for a revision tree.
 
 
360
        :param revision_id: The revision_id of the requested tree.
 
 
362
        :raises: NoSuchRevision if the tree cannot be obtained.
 
 
364
        raise errors.NoSuchRevisionInTree(self, revision_id)
 
 
367
        """What files are present in this tree and unknown.
 
 
369
        :return: an iterator over the unknown files.
 
 
376
    def filter_unversioned_files(self, paths):
 
 
377
        """Filter out paths that are versioned.
 
 
379
        :return: set of paths.
 
 
381
        # NB: we specifically *don't* call self.has_filename, because for
 
 
382
        # WorkingTrees that can indicate files that exist on disk but that 
 
 
384
        pred = self.inventory.has_filename
 
 
385
        return set((p for p in paths if not pred(p)))
 
 
387
    def walkdirs(self, prefix=""):
 
 
388
        """Walk the contents of this tree from path down.
 
 
390
        This yields all the data about the contents of a directory at a time.
 
 
391
        After each directory has been yielded, if the caller has mutated the
 
 
392
        list to exclude some directories, they are then not descended into.
 
 
394
        The data yielded is of the form:
 
 
395
        ((directory-relpath, directory-path-from-root, directory-fileid),
 
 
396
        [(relpath, basename, kind, lstat, path_from_tree_root, file_id, 
 
 
397
          versioned_kind), ...]),
 
 
398
         - directory-relpath is the containing dirs relpath from prefix
 
 
399
         - directory-path-from-root is the containing dirs path from /
 
 
400
         - directory-fileid is the id of the directory if it is versioned.
 
 
401
         - relpath is the relative path within the subtree being walked.
 
 
402
         - basename is the basename
 
 
403
         - kind is the kind of the file now. If unknonwn then the file is not
 
 
404
           present within the tree - but it may be recorded as versioned. See
 
 
406
         - lstat is the stat data *if* the file was statted.
 
 
407
         - path_from_tree_root is the path from the root of the tree.
 
 
408
         - file_id is the file_id is the entry is versioned.
 
 
409
         - versioned_kind is the kind of the file as last recorded in the 
 
 
410
           versioning system. If 'unknown' the file is not versioned.
 
 
411
        One of 'kind' and 'versioned_kind' must not be 'unknown'.
 
 
413
        :param prefix: Start walking from prefix within the tree rather than
 
 
414
        at the root. This allows one to walk a subtree but get paths that are
 
 
415
        relative to a tree rooted higher up.
 
 
416
        :return: an iterator over the directory data.
 
 
418
        raise NotImplementedError(self.walkdirs)
 
 
421
class EmptyTree(Tree):
 
 
424
        self._inventory = Inventory(root_id=None)
 
 
425
        symbol_versioning.warn('EmptyTree is deprecated as of bzr 0.9 please'
 
 
426
                               ' use repository.revision_tree instead.',
 
 
427
                               DeprecationWarning, stacklevel=2)
 
 
429
    def get_parent_ids(self):
 
 
432
    def get_symlink_target(self, file_id):
 
 
435
    def has_filename(self, filename):
 
 
438
    def kind(self, file_id):
 
 
439
        file_id = osutils.safe_file_id(file_id)
 
 
440
        assert self._inventory[file_id].kind == "directory"
 
 
443
    def list_files(self, include_root=False):
 
 
446
    def __contains__(self, file_id):
 
 
447
        file_id = osutils.safe_file_id(file_id)
 
 
448
        return (file_id in self._inventory)
 
 
450
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
 
454
######################################################################
 
 
457
# TODO: Merge these two functions into a single one that can operate
 
 
458
# on either a whole tree or a set of files.
 
 
460
# TODO: Return the diff in order by filename, not by category or in
 
 
461
# random order.  Can probably be done by lock-stepping through the
 
 
462
# filenames from both trees.
 
 
465
def file_status(filename, old_tree, new_tree):
 
 
466
    """Return single-letter status, old and new names for a file.
 
 
468
    The complexity here is in deciding how to represent renames;
 
 
469
    many complex cases are possible.
 
 
471
    old_inv = old_tree.inventory
 
 
472
    new_inv = new_tree.inventory
 
 
473
    new_id = new_inv.path2id(filename)
 
 
474
    old_id = old_inv.path2id(filename)
 
 
476
    if not new_id and not old_id:
 
 
477
        # easy: doesn't exist in either; not versioned at all
 
 
478
        if new_tree.is_ignored(filename):
 
 
479
            return 'I', None, None
 
 
481
            return '?', None, None
 
 
483
        # There is now a file of this name, great.
 
 
486
        # There is no longer a file of this name, but we can describe
 
 
487
        # what happened to the file that used to have
 
 
488
        # this name.  There are two possibilities: either it was
 
 
489
        # deleted entirely, or renamed.
 
 
491
        if new_inv.has_id(old_id):
 
 
492
            return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
 
 
494
            return 'D', old_inv.id2path(old_id), None
 
 
496
    # if the file_id is new in this revision, it is added
 
 
497
    if new_id and not old_inv.has_id(new_id):
 
 
500
    # if there used to be a file of this name, but that ID has now
 
 
501
    # disappeared, it is deleted
 
 
502
    if old_id and not new_inv.has_id(old_id):
 
 
509
def find_renames(old_inv, new_inv):
 
 
510
    for file_id in old_inv:
 
 
511
        if file_id not in new_inv:
 
 
513
        old_name = old_inv.id2path(file_id)
 
 
514
        new_name = new_inv.id2path(file_id)
 
 
515
        if old_name != new_name:
 
 
516
            yield (old_name, new_name)
 
 
519
def find_ids_across_trees(filenames, trees, require_versioned=True):
 
 
520
    """Find the ids corresponding to specified filenames.
 
 
522
    All matches in all trees will be used, and all children of matched
 
 
523
    directories will be used.
 
 
525
    :param filenames: The filenames to find file_ids for (if None, returns
 
 
527
    :param trees: The trees to find file_ids within
 
 
528
    :param require_versioned: if true, all specified filenames must occur in
 
 
530
    :return: a set of file ids for the specified filenames and their children.
 
 
534
    specified_path_ids = _find_ids_across_trees(filenames, trees,
 
 
536
    return _find_children_across_trees(specified_path_ids, trees)
 
 
539
def _find_ids_across_trees(filenames, trees, require_versioned):
 
 
540
    """Find the ids corresponding to specified filenames.
 
 
542
    All matches in all trees will be used, but subdirectories are not scanned.
 
 
544
    :param filenames: The filenames to find file_ids for
 
 
545
    :param trees: The trees to find file_ids within
 
 
546
    :param require_versioned: if true, all specified filenames must occur in
 
 
548
    :return: a set of (path, file ids) for the specified filenames
 
 
551
    interesting_ids = set()
 
 
552
    for tree_path in filenames:
 
 
555
            file_id = tree.path2id(tree_path)
 
 
556
            if file_id is not None:
 
 
557
                interesting_ids.add(file_id)
 
 
560
            not_versioned.append(tree_path)
 
 
561
    if len(not_versioned) > 0 and require_versioned:
 
 
562
        raise errors.PathsNotVersionedError(not_versioned)
 
 
563
    return interesting_ids
 
 
566
def _find_children_across_trees(specified_ids, trees):
 
 
567
    """Return a set including specified ids and their children
 
 
569
    All matches in all trees will be used.
 
 
571
    :param trees: The trees to find file_ids within
 
 
572
    :return: a set containing all specified ids and their children 
 
 
574
    interesting_ids = set(specified_ids)
 
 
575
    pending = interesting_ids
 
 
576
    # now handle children of interesting ids
 
 
577
    # we loop so that we handle all children of each id in both trees
 
 
578
    while len(pending) > 0:
 
 
580
        for file_id in pending:
 
 
582
                if not tree.has_id(file_id):
 
 
584
                entry = tree.inventory[file_id]
 
 
585
                for child in getattr(entry, 'children', {}).itervalues():
 
 
586
                    if child.file_id not in interesting_ids:
 
 
587
                        new_pending.add(child.file_id)
 
 
588
        interesting_ids.update(new_pending)
 
 
589
        pending = new_pending
 
 
590
    return interesting_ids
 
 
593
class InterTree(InterObject):
 
 
594
    """This class represents operations taking place between two Trees.
 
 
596
    Its instances have methods like 'compare' and contain references to the
 
 
597
    source and target trees these operations are to be carried out on.
 
 
599
    clients of bzrlib should not need to use InterTree directly, rather they
 
 
600
    should use the convenience methods on Tree such as 'Tree.compare()' which
 
 
601
    will pass through to InterTree as appropriate.
 
 
607
    def compare(self, want_unchanged=False, specific_files=None,
 
 
608
        extra_trees=None, require_versioned=False, include_root=False,
 
 
609
        want_unversioned=False):
 
 
610
        """Return the changes from source to target.
 
 
612
        :return: A TreeDelta.
 
 
613
        :param specific_files: An optional list of file paths to restrict the
 
 
614
            comparison to. When mapping filenames to ids, all matches in all
 
 
615
            trees (including optional extra_trees) are used, and all children of
 
 
616
            matched directories are included.
 
 
617
        :param want_unchanged: An optional boolean requesting the inclusion of
 
 
618
            unchanged entries in the result.
 
 
619
        :param extra_trees: An optional list of additional trees to use when
 
 
620
            mapping the contents of specific_files (paths) to file_ids.
 
 
621
        :param require_versioned: An optional boolean (defaults to False). When
 
 
622
            supplied and True all the 'specific_files' must be versioned, or
 
 
623
            a PathsNotVersionedError will be thrown.
 
 
624
        :param want_unversioned: Scan for unversioned paths.
 
 
626
        # NB: show_status depends on being able to pass in non-versioned files
 
 
627
        # and report them as unknown
 
 
628
        trees = (self.source,)
 
 
629
        if extra_trees is not None:
 
 
630
            trees = trees + tuple(extra_trees)
 
 
631
        # target is usually the newer tree:
 
 
632
        specific_file_ids = self.target.paths2ids(specific_files, trees,
 
 
633
            require_versioned=require_versioned)
 
 
634
        if specific_files and not specific_file_ids:
 
 
635
            # All files are unversioned, so just return an empty delta
 
 
636
            # _compare_trees would think we want a complete delta
 
 
637
            result = delta.TreeDelta()
 
 
638
            fake_entry = InventoryFile('unused', 'unused', 'unused')
 
 
639
            result.unversioned = [(path, None,
 
 
640
                self.target._comparison_data(fake_entry, path)[0]) for path in
 
 
643
        return delta._compare_trees(self.source, self.target, want_unchanged,
 
 
644
            specific_files, include_root, extra_trees=extra_trees,
 
 
645
            require_versioned=require_versioned,
 
 
646
            want_unversioned=want_unversioned)
 
 
648
    def _iter_changes(self, include_unchanged=False,
 
 
649
                      specific_files=None, pb=None, extra_trees=[],
 
 
650
                      require_versioned=True, want_unversioned=False):
 
 
651
        """Generate an iterator of changes between trees.
 
 
654
        (file_id, (path_in_source, path_in_target),
 
 
655
         changed_content, versioned, parent, name, kind,
 
 
658
        Changed_content is True if the file's content has changed.  This
 
 
659
        includes changes to its kind, and to a symlink's target.
 
 
661
        versioned, parent, name, kind, executable are tuples of (from, to).
 
 
662
        If a file is missing in a tree, its kind is None.
 
 
664
        Iteration is done in parent-to-child order, relative to the target
 
 
667
        There is no guarantee that all paths are in sorted order: the
 
 
668
        requirement to expand the search due to renames may result in children
 
 
669
        that should be found early being found late in the search, after
 
 
670
        lexically later results have been returned.
 
 
671
        :param require_versioned: Raise errors.PathsNotVersionedError if a
 
 
672
            path in the specific_files list is not versioned in one of
 
 
673
            source, target or extra_trees.
 
 
674
        :param want_unversioned: Should unversioned files be returned in the
 
 
675
            output. An unversioned file is defined as one with (False, False)
 
 
676
            for the versioned pair.
 
 
679
        lookup_trees = [self.source]
 
 
681
             lookup_trees.extend(extra_trees)
 
 
682
        specific_file_ids = self.target.paths2ids(specific_files,
 
 
683
            lookup_trees, require_versioned=require_versioned)
 
 
685
            all_unversioned = sorted([(p.split('/'), p) for p in self.target.extras()
 
 
686
                if not specific_files or
 
 
687
                    osutils.is_inside_any(specific_files, p)])
 
 
688
            all_unversioned = deque(all_unversioned)
 
 
690
            all_unversioned = deque()
 
 
692
        from_entries_by_dir = list(self.source.inventory.iter_entries_by_dir(
 
 
693
            specific_file_ids=specific_file_ids))
 
 
694
        from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
 
 
695
        to_entries_by_dir = list(self.target.inventory.iter_entries_by_dir(
 
 
696
            specific_file_ids=specific_file_ids))
 
 
697
        num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
 
 
699
        # the unversioned path lookup only occurs on real trees - where there 
 
 
700
        # can be extras. So the fake_entry is solely used to look up
 
 
701
        # executable it values when execute is not supported.
 
 
702
        fake_entry = InventoryFile('unused', 'unused', 'unused')
 
 
703
        for to_path, to_entry in to_entries_by_dir:
 
 
704
            while all_unversioned and all_unversioned[0][0] < to_path.split('/'):
 
 
705
                unversioned_path = all_unversioned.popleft()
 
 
706
                to_kind, to_executable, to_stat = \
 
 
707
                    self.target._comparison_data(fake_entry, unversioned_path[1])
 
 
708
                yield (None, (None, unversioned_path[1]), True, (False, False),
 
 
710
                    (None, unversioned_path[0][-1]),
 
 
712
                    (None, to_executable))
 
 
713
            file_id = to_entry.file_id
 
 
714
            to_paths[file_id] = to_path
 
 
716
            changed_content = False
 
 
717
            from_path, from_entry = from_data.get(file_id, (None, None))
 
 
718
            from_versioned = (from_entry is not None)
 
 
719
            if from_entry is not None:
 
 
720
                from_versioned = True
 
 
721
                from_name = from_entry.name
 
 
722
                from_parent = from_entry.parent_id
 
 
723
                from_kind, from_executable, from_stat = \
 
 
724
                    self.source._comparison_data(from_entry, from_path)
 
 
727
                from_versioned = False
 
 
731
                from_executable = None
 
 
732
            versioned = (from_versioned, True)
 
 
733
            to_kind, to_executable, to_stat = \
 
 
734
                self.target._comparison_data(to_entry, to_path)
 
 
735
            kind = (from_kind, to_kind)
 
 
736
            if kind[0] != kind[1]:
 
 
737
                changed_content = True
 
 
738
            elif from_kind == 'file':
 
 
739
                from_size = self.source._file_size(from_entry, from_stat)
 
 
740
                to_size = self.target._file_size(to_entry, to_stat)
 
 
741
                if from_size != to_size:
 
 
742
                    changed_content = True
 
 
743
                elif (self.source.get_file_sha1(file_id, from_path, from_stat) !=
 
 
744
                    self.target.get_file_sha1(file_id, to_path, to_stat)):
 
 
745
                    changed_content = True
 
 
746
            elif from_kind == 'symlink':
 
 
747
                if (self.source.get_symlink_target(file_id) !=
 
 
748
                    self.target.get_symlink_target(file_id)):
 
 
749
                    changed_content = True
 
 
750
                elif from_kind == 'tree-reference':
 
 
751
                    if (self.source.get_reference_revision(file_id, from_path)
 
 
752
                        != self.target.get_reference_revision(file_id, to_path)):
 
 
753
                        changed_content = True 
 
 
754
            parent = (from_parent, to_entry.parent_id)
 
 
755
            name = (from_name, to_entry.name)
 
 
756
            executable = (from_executable, to_executable)
 
 
758
                pb.update('comparing files', entry_count, num_entries)
 
 
759
            if (changed_content is not False or versioned[0] != versioned[1]
 
 
760
                or parent[0] != parent[1] or name[0] != name[1] or 
 
 
761
                executable[0] != executable[1] or include_unchanged):
 
 
762
                yield (file_id, (from_path, to_path), changed_content,
 
 
763
                    versioned, parent, name, kind, executable)
 
 
765
        while all_unversioned:
 
 
766
            # yield any trailing unversioned paths
 
 
767
            unversioned_path = all_unversioned.popleft()
 
 
768
            to_kind, to_executable, to_stat = \
 
 
769
                self.target._comparison_data(fake_entry, unversioned_path[1])
 
 
770
            yield (None, (None, unversioned_path[1]), True, (False, False),
 
 
772
                (None, unversioned_path[0][-1]),
 
 
774
                (None, to_executable))
 
 
776
        def get_to_path(to_entry):
 
 
777
            if to_entry.parent_id is None:
 
 
778
                to_path = '' # the root
 
 
780
                if to_entry.parent_id not in to_paths:
 
 
782
                    return get_to_path(self.target.inventory[to_entry.parent_id])
 
 
783
                to_path = osutils.pathjoin(to_paths[to_entry.parent_id],
 
 
785
            to_paths[to_entry.file_id] = to_path
 
 
788
        for path, from_entry in from_entries_by_dir:
 
 
789
            file_id = from_entry.file_id
 
 
790
            if file_id in to_paths:
 
 
793
            if not file_id in self.target.inventory:
 
 
794
                # common case - paths we have not emitted are not present in
 
 
798
                to_path = get_to_path(self.target.inventory[file_id])
 
 
801
                pb.update('comparing files', entry_count, num_entries)
 
 
802
            versioned = (True, False)
 
 
803
            parent = (from_entry.parent_id, None)
 
 
804
            name = (from_entry.name, None)
 
 
805
            from_kind, from_executable, stat_value = \
 
 
806
                self.source._comparison_data(from_entry, path)
 
 
807
            kind = (from_kind, None)
 
 
808
            executable = (from_executable, None)
 
 
809
            changed_content = True
 
 
810
            # the parent's path is necessarily known at this point.
 
 
811
            yield(file_id, (path, to_path), changed_content, versioned, parent,
 
 
812
                  name, kind, executable)
 
 
815
# This was deprecated before 0.12, but did not have an official warning
 
 
816
@symbol_versioning.deprecated_function(symbol_versioning.zero_twelve)
 
 
817
def RevisionTree(*args, **kwargs):
 
 
818
    """RevisionTree has moved to bzrlib.revisiontree.RevisionTree()
 
 
820
    Accessing it as bzrlib.tree.RevisionTree has been deprecated as of
 
 
823
    from bzrlib.revisiontree import RevisionTree as _RevisionTree
 
 
824
    return _RevisionTree(*args, **kwargs)