/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Robert Collins
  • Date: 2007-08-22 22:32:23 UTC
  • mto: This revision was merged to the branch mainline in revision 2744.
  • Revision ID: robertc@robertcollins.net-20070822223223-0heetwybcuonp00g
Fix an off-by-one in check.py that leads to the progress bar showing
complete for a phase but not actually being complete; if the last file id
checked is big this is confusing. (Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005 Canonical Ltd
 
2
#
 
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.
 
7
#
 
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.
 
12
#
 
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
 
16
 
 
17
"""Tree classes, representing directory at point in time.
 
18
"""
 
19
 
 
20
import os
 
21
from collections import deque
 
22
from cStringIO import StringIO
 
23
 
 
24
import bzrlib
 
25
from bzrlib import (
 
26
    delta,
 
27
    osutils,
 
28
    revision as _mod_revision,
 
29
    symbol_versioning,
 
30
    )
 
31
from bzrlib.decorators import needs_read_lock
 
32
from bzrlib.errors import BzrError, BzrCheckError
 
33
from bzrlib import errors
 
34
from bzrlib.inventory import Inventory, InventoryFile
 
35
from bzrlib.inter import InterObject
 
36
from bzrlib.osutils import fingerprint_file
 
37
import bzrlib.revision
 
38
from bzrlib.trace import mutter, note
 
39
 
 
40
 
 
41
class Tree(object):
 
42
    """Abstract file tree.
 
43
 
 
44
    There are several subclasses:
 
45
    
 
46
    * `WorkingTree` exists as files on disk editable by the user.
 
47
 
 
48
    * `RevisionTree` is a tree as recorded at some point in the past.
 
49
 
 
50
    Trees contain an `Inventory` object, and also know how to retrieve
 
51
    file texts mentioned in the inventory, either from a working
 
52
    directory or from a store.
 
53
 
 
54
    It is possible for trees to contain files that are not described
 
55
    in their inventory or vice versa; for this use `filenames()`.
 
56
 
 
57
    Trees can be compared, etc, regardless of whether they are working
 
58
    trees or versioned trees.
 
59
    """
 
60
    
 
61
    def changes_from(self, other, want_unchanged=False, specific_files=None,
 
62
        extra_trees=None, require_versioned=False, include_root=False,
 
63
        want_unversioned=False):
 
64
        """Return a TreeDelta of the changes from other to this tree.
 
65
 
 
66
        :param other: A tree to compare with.
 
67
        :param specific_files: An optional list of file paths to restrict the
 
68
            comparison to. When mapping filenames to ids, all matches in all
 
69
            trees (including optional extra_trees) are used, and all children of
 
70
            matched directories are included.
 
71
        :param want_unchanged: An optional boolean requesting the inclusion of
 
72
            unchanged entries in the result.
 
73
        :param extra_trees: An optional list of additional trees to use when
 
74
            mapping the contents of specific_files (paths) to file_ids.
 
75
        :param require_versioned: An optional boolean (defaults to False). When
 
76
            supplied and True all the 'specific_files' must be versioned, or
 
77
            a PathsNotVersionedError will be thrown.
 
78
        :param want_unversioned: Scan for unversioned paths.
 
79
 
 
80
        The comparison will be performed by an InterTree object looked up on 
 
81
        self and other.
 
82
        """
 
83
        # Martin observes that Tree.changes_from returns a TreeDelta and this
 
84
        # may confuse people, because the class name of the returned object is
 
85
        # a synonym of the object referenced in the method name.
 
86
        return InterTree.get(other, self).compare(
 
87
            want_unchanged=want_unchanged,
 
88
            specific_files=specific_files,
 
89
            extra_trees=extra_trees,
 
90
            require_versioned=require_versioned,
 
91
            include_root=include_root,
 
92
            want_unversioned=want_unversioned,
 
93
            )
 
94
 
 
95
    def _iter_changes(self, from_tree, include_unchanged=False,
 
96
                     specific_files=None, pb=None, extra_trees=None,
 
97
                     require_versioned=True, want_unversioned=False):
 
98
        intertree = InterTree.get(from_tree, self)
 
99
        return intertree._iter_changes(include_unchanged, specific_files, pb,
 
100
            extra_trees, require_versioned, want_unversioned=want_unversioned)
 
101
    
 
102
    def conflicts(self):
 
103
        """Get a list of the conflicts in the tree.
 
104
 
 
105
        Each conflict is an instance of bzrlib.conflicts.Conflict.
 
106
        """
 
107
        return []
 
108
 
 
109
    def extras(self):
 
110
        """For trees that can have unversioned files, return all such paths."""
 
111
        return []
 
112
 
 
113
    def get_parent_ids(self):
 
114
        """Get the parent ids for this tree. 
 
115
 
 
116
        :return: a list of parent ids. [] is returned to indicate
 
117
        a tree with no parents.
 
118
        :raises: BzrError if the parents are not known.
 
119
        """
 
120
        raise NotImplementedError(self.get_parent_ids)
 
121
    
 
122
    def has_filename(self, filename):
 
123
        """True if the tree has given filename."""
 
124
        raise NotImplementedError()
 
125
 
 
126
    def has_id(self, file_id):
 
127
        file_id = osutils.safe_file_id(file_id)
 
128
        return self.inventory.has_id(file_id)
 
129
 
 
130
    __contains__ = has_id
 
131
 
 
132
    def has_or_had_id(self, file_id):
 
133
        file_id = osutils.safe_file_id(file_id)
 
134
        if file_id == self.inventory.root.file_id:
 
135
            return True
 
136
        return self.inventory.has_id(file_id)
 
137
 
 
138
    def is_ignored(self, filename):
 
139
        """Check whether the filename is ignored by this tree.
 
140
 
 
141
        :param filename: The relative filename within the tree.
 
142
        :return: True if the filename is ignored.
 
143
        """
 
144
        return False
 
145
 
 
146
    def __iter__(self):
 
147
        return iter(self.inventory)
 
148
 
 
149
    def id2path(self, file_id):
 
150
        """Return the path for a file id.
 
151
 
 
152
        :raises NoSuchId:
 
153
        """
 
154
        file_id = osutils.safe_file_id(file_id)
 
155
        return self.inventory.id2path(file_id)
 
156
 
 
157
    def is_control_filename(self, filename):
 
158
        """True if filename is the name of a control file in this tree.
 
159
        
 
160
        :param filename: A filename within the tree. This is a relative path
 
161
        from the root of this tree.
 
162
 
 
163
        This is true IF and ONLY IF the filename is part of the meta data
 
164
        that bzr controls in this tree. I.E. a random .bzr directory placed
 
165
        on disk will not be a control file for this tree.
 
166
        """
 
167
        return self.bzrdir.is_control_filename(filename)
 
168
 
 
169
    @needs_read_lock
 
170
    def iter_entries_by_dir(self, specific_file_ids=None):
 
171
        """Walk the tree in 'by_dir' order.
 
172
 
 
173
        This will yield each entry in the tree as a (path, entry) tuple. The
 
174
        order that they are yielded is: the contents of a directory are 
 
175
        preceeded by the parent of a directory, and all the contents of a 
 
176
        directory are grouped together.
 
177
        """
 
178
        return self.inventory.iter_entries_by_dir(
 
179
            specific_file_ids=specific_file_ids)
 
180
 
 
181
    def iter_references(self):
 
182
        for path, entry in self.iter_entries_by_dir():
 
183
            if entry.kind == 'tree-reference':
 
184
                yield path, entry.file_id
 
185
 
 
186
    def kind(self, file_id):
 
187
        raise NotImplementedError("Tree subclass %s must implement kind"
 
188
            % self.__class__.__name__)
 
189
 
 
190
    def get_reference_revision(self, file_id, path=None):
 
191
        raise NotImplementedError("Tree subclass %s must implement "
 
192
                                  "get_reference_revision"
 
193
            % self.__class__.__name__)
 
194
 
 
195
    def _comparison_data(self, entry, path):
 
196
        """Return a tuple of kind, executable, stat_value for a file.
 
197
 
 
198
        entry may be None if there is no inventory entry for the file, but
 
199
        path must always be supplied.
 
200
 
 
201
        kind is None if there is no file present (even if an inventory id is
 
202
        present).  executable is False for non-file entries.
 
203
        """
 
204
        raise NotImplementedError(self._comparison_data)
 
205
 
 
206
    def _file_size(self, entry, stat_value):
 
207
        raise NotImplementedError(self._file_size)
 
208
 
 
209
    def _get_inventory(self):
 
210
        return self._inventory
 
211
    
 
212
    def get_file(self, file_id):
 
213
        """Return a file object for the file file_id in the tree."""
 
214
        raise NotImplementedError(self.get_file)
 
215
 
 
216
    def get_file_mtime(self, file_id, path=None):
 
217
        """Return the modification time for a file.
 
218
 
 
219
        :param file_id: The handle for this file.
 
220
        :param path: The path that this file can be found at.
 
221
            These must point to the same object.
 
222
        """
 
223
        raise NotImplementedError(self.get_file_mtime)
 
224
 
 
225
    def get_file_by_path(self, path):
 
226
        return self.get_file(self._inventory.path2id(path))
 
227
 
 
228
    def iter_files_bytes(self, desired_files):
 
229
        """Iterate through file contents.
 
230
 
 
231
        Files will not necessarily be returned in the order they occur in
 
232
        desired_files.  No specific order is guaranteed.
 
233
 
 
234
        Yields pairs of identifier, bytes_iterator.  identifier is an opaque
 
235
        value supplied by the caller as part of desired_files.  It should
 
236
        uniquely identify the file version in the caller's context.  (Examples:
 
237
        an index number or a TreeTransform trans_id.)
 
238
 
 
239
        bytes_iterator is an iterable of bytestrings for the file.  The
 
240
        kind of iterable and length of the bytestrings are unspecified, but for
 
241
        this implementation, it is a tuple containing a single bytestring with
 
242
        the complete text of the file.
 
243
 
 
244
        :param desired_files: a list of (file_id, identifier) pairs
 
245
        """
 
246
        for file_id, identifier in desired_files:
 
247
            # We wrap the string in a tuple so that we can return an iterable
 
248
            # of bytestrings.  (Technically, a bytestring is also an iterable
 
249
            # of bytestrings, but iterating through each character is not
 
250
            # performant.)
 
251
            cur_file = (self.get_file_text(file_id),)
 
252
            yield identifier, cur_file
 
253
 
 
254
    def get_symlink_target(self, file_id):
 
255
        """Get the target for a given file_id.
 
256
 
 
257
        It is assumed that the caller already knows that file_id is referencing
 
258
        a symlink.
 
259
        :param file_id: Handle for the symlink entry.
 
260
        :return: The path the symlink points to.
 
261
        """
 
262
        raise NotImplementedError(self.get_symlink_target)
 
263
 
 
264
    def annotate_iter(self, file_id):
 
265
        """Return an iterator of revision_id, line tuples
 
266
 
 
267
        For working trees (and mutable trees in general), the special
 
268
        revision_id 'current:' will be used for lines that are new in this
 
269
        tree, e.g. uncommitted changes.
 
270
        :param file_id: The file to produce an annotated version from
 
271
        """
 
272
        raise NotImplementedError(self.annotate_iter)
 
273
 
 
274
    def plan_file_merge(self, file_id, other):
 
275
        """Generate a merge plan based on annotations
 
276
 
 
277
        If the file contains uncommitted changes in this tree, they will be
 
278
        attributed to the 'current:' pseudo-revision.  If the file contains
 
279
        uncommitted changes in the other tree, they will be assigned to the
 
280
        'other:' pseudo-revision.
 
281
        """
 
282
        from bzrlib import merge
 
283
        annotated_a = list(self.annotate_iter(file_id,
 
284
                                              _mod_revision.CURRENT_REVISION))
 
285
        annotated_b = list(other.annotate_iter(file_id, 'other:'))
 
286
        ancestors_a = self._get_ancestors(_mod_revision.CURRENT_REVISION)
 
287
        ancestors_b = other._get_ancestors('other:')
 
288
        return merge._plan_annotate_merge(annotated_a, annotated_b,
 
289
                                          ancestors_a, ancestors_b)
 
290
 
 
291
    inventory = property(_get_inventory,
 
292
                         doc="Inventory of this Tree")
 
293
 
 
294
    def _check_retrieved(self, ie, f):
 
295
        if not __debug__:
 
296
            return  
 
297
        fp = fingerprint_file(f)
 
298
        f.seek(0)
 
299
        
 
300
        if ie.text_size is not None:
 
301
            if ie.text_size != fp['size']:
 
302
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
 
303
                        ["inventory expects %d bytes" % ie.text_size,
 
304
                         "file is actually %d bytes" % fp['size'],
 
305
                         "store is probably damaged/corrupt"])
 
306
 
 
307
        if ie.text_sha1 != fp['sha1']:
 
308
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
 
309
                    ["inventory expects %s" % ie.text_sha1,
 
310
                     "file is actually %s" % fp['sha1'],
 
311
                     "store is probably damaged/corrupt"])
 
312
 
 
313
    @needs_read_lock
 
314
    def path2id(self, path):
 
315
        """Return the id for path in this tree."""
 
316
        return self._inventory.path2id(path)
 
317
 
 
318
    def paths2ids(self, paths, trees=[], require_versioned=True):
 
319
        """Return all the ids that can be reached by walking from paths.
 
320
        
 
321
        Each path is looked up in each this tree and any extras provided in
 
322
        trees, and this is repeated recursively: the children in an extra tree
 
323
        of a directory that has been renamed under a provided path in this tree
 
324
        are all returned, even if none exist until a provided path in this
 
325
        tree, and vice versa.
 
326
 
 
327
        :param paths: An iterable of paths to start converting to ids from.
 
328
            Alternatively, if paths is None, no ids should be calculated and None
 
329
            will be returned. This is offered to make calling the api unconditional
 
330
            for code that *might* take a list of files.
 
331
        :param trees: Additional trees to consider.
 
332
        :param require_versioned: If False, do not raise NotVersionedError if
 
333
            an element of paths is not versioned in this tree and all of trees.
 
334
        """
 
335
        return find_ids_across_trees(paths, [self] + list(trees), require_versioned)
 
336
 
 
337
    def print_file(self, file_id):
 
338
        """Print file with id `file_id` to stdout."""
 
339
        file_id = osutils.safe_file_id(file_id)
 
340
        import sys
 
341
        sys.stdout.write(self.get_file_text(file_id))
 
342
 
 
343
    def lock_read(self):
 
344
        pass
 
345
 
 
346
    def revision_tree(self, revision_id):
 
347
        """Obtain a revision tree for the revision revision_id.
 
348
 
 
349
        The intention of this method is to allow access to possibly cached
 
350
        tree data. Implementors of this method should raise NoSuchRevision if
 
351
        the tree is not locally available, even if they could obtain the 
 
352
        tree via a repository or some other means. Callers are responsible 
 
353
        for finding the ultimate source for a revision tree.
 
354
 
 
355
        :param revision_id: The revision_id of the requested tree.
 
356
        :return: A Tree.
 
357
        :raises: NoSuchRevision if the tree cannot be obtained.
 
358
        """
 
359
        raise errors.NoSuchRevisionInTree(self, revision_id)
 
360
 
 
361
    def unknowns(self):
 
362
        """What files are present in this tree and unknown.
 
363
        
 
364
        :return: an iterator over the unknown files.
 
365
        """
 
366
        return iter([])
 
367
 
 
368
    def unlock(self):
 
369
        pass
 
370
 
 
371
    def filter_unversioned_files(self, paths):
 
372
        """Filter out paths that are versioned.
 
373
 
 
374
        :return: set of paths.
 
375
        """
 
376
        # NB: we specifically *don't* call self.has_filename, because for
 
377
        # WorkingTrees that can indicate files that exist on disk but that 
 
378
        # are not versioned.
 
379
        pred = self.inventory.has_filename
 
380
        return set((p for p in paths if not pred(p)))
 
381
 
 
382
    def walkdirs(self, prefix=""):
 
383
        """Walk the contents of this tree from path down.
 
384
 
 
385
        This yields all the data about the contents of a directory at a time.
 
386
        After each directory has been yielded, if the caller has mutated the
 
387
        list to exclude some directories, they are then not descended into.
 
388
        
 
389
        The data yielded is of the form:
 
390
        ((directory-relpath, directory-path-from-root, directory-fileid),
 
391
        [(relpath, basename, kind, lstat, path_from_tree_root, file_id, 
 
392
          versioned_kind), ...]),
 
393
         - directory-relpath is the containing dirs relpath from prefix
 
394
         - directory-path-from-root is the containing dirs path from /
 
395
         - directory-fileid is the id of the directory if it is versioned.
 
396
         - relpath is the relative path within the subtree being walked.
 
397
         - basename is the basename
 
398
         - kind is the kind of the file now. If unknonwn then the file is not
 
399
           present within the tree - but it may be recorded as versioned. See
 
400
           versioned_kind.
 
401
         - lstat is the stat data *if* the file was statted.
 
402
         - path_from_tree_root is the path from the root of the tree.
 
403
         - file_id is the file_id is the entry is versioned.
 
404
         - versioned_kind is the kind of the file as last recorded in the 
 
405
           versioning system. If 'unknown' the file is not versioned.
 
406
        One of 'kind' and 'versioned_kind' must not be 'unknown'.
 
407
 
 
408
        :param prefix: Start walking from prefix within the tree rather than
 
409
        at the root. This allows one to walk a subtree but get paths that are
 
410
        relative to a tree rooted higher up.
 
411
        :return: an iterator over the directory data.
 
412
        """
 
413
        raise NotImplementedError(self.walkdirs)
 
414
 
 
415
 
 
416
class EmptyTree(Tree):
 
417
 
 
418
    def __init__(self):
 
419
        self._inventory = Inventory(root_id=None)
 
420
        symbol_versioning.warn('EmptyTree is deprecated as of bzr 0.9 please'
 
421
                               ' use repository.revision_tree instead.',
 
422
                               DeprecationWarning, stacklevel=2)
 
423
 
 
424
    def get_parent_ids(self):
 
425
        return []
 
426
 
 
427
    def get_symlink_target(self, file_id):
 
428
        return None
 
429
 
 
430
    def has_filename(self, filename):
 
431
        return False
 
432
 
 
433
    def kind(self, file_id):
 
434
        file_id = osutils.safe_file_id(file_id)
 
435
        assert self._inventory[file_id].kind == "directory"
 
436
        return "directory"
 
437
 
 
438
    def list_files(self, include_root=False):
 
439
        return iter([])
 
440
    
 
441
    def __contains__(self, file_id):
 
442
        file_id = osutils.safe_file_id(file_id)
 
443
        return (file_id in self._inventory)
 
444
 
 
445
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
446
        return None
 
447
 
 
448
 
 
449
######################################################################
 
450
# diff
 
451
 
 
452
# TODO: Merge these two functions into a single one that can operate
 
453
# on either a whole tree or a set of files.
 
454
 
 
455
# TODO: Return the diff in order by filename, not by category or in
 
456
# random order.  Can probably be done by lock-stepping through the
 
457
# filenames from both trees.
 
458
 
 
459
 
 
460
def file_status(filename, old_tree, new_tree):
 
461
    """Return single-letter status, old and new names for a file.
 
462
 
 
463
    The complexity here is in deciding how to represent renames;
 
464
    many complex cases are possible.
 
465
    """
 
466
    old_inv = old_tree.inventory
 
467
    new_inv = new_tree.inventory
 
468
    new_id = new_inv.path2id(filename)
 
469
    old_id = old_inv.path2id(filename)
 
470
 
 
471
    if not new_id and not old_id:
 
472
        # easy: doesn't exist in either; not versioned at all
 
473
        if new_tree.is_ignored(filename):
 
474
            return 'I', None, None
 
475
        else:
 
476
            return '?', None, None
 
477
    elif new_id:
 
478
        # There is now a file of this name, great.
 
479
        pass
 
480
    else:
 
481
        # There is no longer a file of this name, but we can describe
 
482
        # what happened to the file that used to have
 
483
        # this name.  There are two possibilities: either it was
 
484
        # deleted entirely, or renamed.
 
485
        assert old_id
 
486
        if new_inv.has_id(old_id):
 
487
            return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
 
488
        else:
 
489
            return 'D', old_inv.id2path(old_id), None
 
490
 
 
491
    # if the file_id is new in this revision, it is added
 
492
    if new_id and not old_inv.has_id(new_id):
 
493
        return 'A'
 
494
 
 
495
    # if there used to be a file of this name, but that ID has now
 
496
    # disappeared, it is deleted
 
497
    if old_id and not new_inv.has_id(old_id):
 
498
        return 'D'
 
499
 
 
500
    return 'wtf?'
 
501
 
 
502
    
 
503
 
 
504
def find_renames(old_inv, new_inv):
 
505
    for file_id in old_inv:
 
506
        if file_id not in new_inv:
 
507
            continue
 
508
        old_name = old_inv.id2path(file_id)
 
509
        new_name = new_inv.id2path(file_id)
 
510
        if old_name != new_name:
 
511
            yield (old_name, new_name)
 
512
            
 
513
 
 
514
def find_ids_across_trees(filenames, trees, require_versioned=True):
 
515
    """Find the ids corresponding to specified filenames.
 
516
    
 
517
    All matches in all trees will be used, and all children of matched
 
518
    directories will be used.
 
519
 
 
520
    :param filenames: The filenames to find file_ids for (if None, returns
 
521
        None)
 
522
    :param trees: The trees to find file_ids within
 
523
    :param require_versioned: if true, all specified filenames must occur in
 
524
    at least one tree.
 
525
    :return: a set of file ids for the specified filenames and their children.
 
526
    """
 
527
    if not filenames:
 
528
        return None
 
529
    specified_path_ids = _find_ids_across_trees(filenames, trees,
 
530
        require_versioned)
 
531
    return _find_children_across_trees(specified_path_ids, trees)
 
532
 
 
533
 
 
534
def _find_ids_across_trees(filenames, trees, require_versioned):
 
535
    """Find the ids corresponding to specified filenames.
 
536
    
 
537
    All matches in all trees will be used, but subdirectories are not scanned.
 
538
 
 
539
    :param filenames: The filenames to find file_ids for
 
540
    :param trees: The trees to find file_ids within
 
541
    :param require_versioned: if true, all specified filenames must occur in
 
542
        at least one tree.
 
543
    :return: a set of (path, file ids) for the specified filenames
 
544
    """
 
545
    not_versioned = []
 
546
    interesting_ids = set()
 
547
    for tree_path in filenames:
 
548
        not_found = True
 
549
        for tree in trees:
 
550
            file_id = tree.path2id(tree_path)
 
551
            if file_id is not None:
 
552
                interesting_ids.add(file_id)
 
553
                not_found = False
 
554
        if not_found:
 
555
            not_versioned.append(tree_path)
 
556
    if len(not_versioned) > 0 and require_versioned:
 
557
        raise errors.PathsNotVersionedError(not_versioned)
 
558
    return interesting_ids
 
559
 
 
560
 
 
561
def _find_children_across_trees(specified_ids, trees):
 
562
    """Return a set including specified ids and their children
 
563
    
 
564
    All matches in all trees will be used.
 
565
 
 
566
    :param trees: The trees to find file_ids within
 
567
    :return: a set containing all specified ids and their children 
 
568
    """
 
569
    interesting_ids = set(specified_ids)
 
570
    pending = interesting_ids
 
571
    # now handle children of interesting ids
 
572
    # we loop so that we handle all children of each id in both trees
 
573
    while len(pending) > 0:
 
574
        new_pending = set()
 
575
        for file_id in pending:
 
576
            for tree in trees:
 
577
                if not tree.has_id(file_id):
 
578
                    continue
 
579
                entry = tree.inventory[file_id]
 
580
                for child in getattr(entry, 'children', {}).itervalues():
 
581
                    if child.file_id not in interesting_ids:
 
582
                        new_pending.add(child.file_id)
 
583
        interesting_ids.update(new_pending)
 
584
        pending = new_pending
 
585
    return interesting_ids
 
586
 
 
587
 
 
588
class InterTree(InterObject):
 
589
    """This class represents operations taking place between two Trees.
 
590
 
 
591
    Its instances have methods like 'compare' and contain references to the
 
592
    source and target trees these operations are to be carried out on.
 
593
 
 
594
    clients of bzrlib should not need to use InterTree directly, rather they
 
595
    should use the convenience methods on Tree such as 'Tree.compare()' which
 
596
    will pass through to InterTree as appropriate.
 
597
    """
 
598
 
 
599
    _optimisers = []
 
600
 
 
601
    @needs_read_lock
 
602
    def compare(self, want_unchanged=False, specific_files=None,
 
603
        extra_trees=None, require_versioned=False, include_root=False,
 
604
        want_unversioned=False):
 
605
        """Return the changes from source to target.
 
606
 
 
607
        :return: A TreeDelta.
 
608
        :param specific_files: An optional list of file paths to restrict the
 
609
            comparison to. When mapping filenames to ids, all matches in all
 
610
            trees (including optional extra_trees) are used, and all children of
 
611
            matched directories are included.
 
612
        :param want_unchanged: An optional boolean requesting the inclusion of
 
613
            unchanged entries in the result.
 
614
        :param extra_trees: An optional list of additional trees to use when
 
615
            mapping the contents of specific_files (paths) to file_ids.
 
616
        :param require_versioned: An optional boolean (defaults to False). When
 
617
            supplied and True all the 'specific_files' must be versioned, or
 
618
            a PathsNotVersionedError will be thrown.
 
619
        :param want_unversioned: Scan for unversioned paths.
 
620
        """
 
621
        # NB: show_status depends on being able to pass in non-versioned files
 
622
        # and report them as unknown
 
623
        trees = (self.source,)
 
624
        if extra_trees is not None:
 
625
            trees = trees + tuple(extra_trees)
 
626
        # target is usually the newer tree:
 
627
        specific_file_ids = self.target.paths2ids(specific_files, trees,
 
628
            require_versioned=require_versioned)
 
629
        if specific_files and not specific_file_ids:
 
630
            # All files are unversioned, so just return an empty delta
 
631
            # _compare_trees would think we want a complete delta
 
632
            result = delta.TreeDelta()
 
633
            fake_entry = InventoryFile('unused', 'unused', 'unused')
 
634
            result.unversioned = [(path, None,
 
635
                self.target._comparison_data(fake_entry, path)[0]) for path in
 
636
                specific_files]
 
637
            return result
 
638
        return delta._compare_trees(self.source, self.target, want_unchanged,
 
639
            specific_files, include_root, extra_trees=extra_trees,
 
640
            require_versioned=require_versioned,
 
641
            want_unversioned=want_unversioned)
 
642
 
 
643
    def _iter_changes(self, include_unchanged=False,
 
644
                      specific_files=None, pb=None, extra_trees=[],
 
645
                      require_versioned=True, want_unversioned=False):
 
646
        """Generate an iterator of changes between trees.
 
647
 
 
648
        A tuple is returned:
 
649
        (file_id, (path_in_source, path_in_target),
 
650
         changed_content, versioned, parent, name, kind,
 
651
         executable)
 
652
 
 
653
        Changed_content is True if the file's content has changed.  This
 
654
        includes changes to its kind, and to a symlink's target.
 
655
 
 
656
        versioned, parent, name, kind, executable are tuples of (from, to).
 
657
        If a file is missing in a tree, its kind is None.
 
658
 
 
659
        Iteration is done in parent-to-child order, relative to the target
 
660
        tree.
 
661
 
 
662
        There is no guarantee that all paths are in sorted order: the
 
663
        requirement to expand the search due to renames may result in children
 
664
        that should be found early being found late in the search, after
 
665
        lexically later results have been returned.
 
666
        :param require_versioned: Raise errors.PathsNotVersionedError if a
 
667
            path in the specific_files list is not versioned in one of
 
668
            source, target or extra_trees.
 
669
        :param want_unversioned: Should unversioned files be returned in the
 
670
            output. An unversioned file is defined as one with (False, False)
 
671
            for the versioned pair.
 
672
        """
 
673
        result = []
 
674
        lookup_trees = [self.source]
 
675
        if extra_trees:
 
676
             lookup_trees.extend(extra_trees)
 
677
        specific_file_ids = self.target.paths2ids(specific_files,
 
678
            lookup_trees, require_versioned=require_versioned)
 
679
        if want_unversioned:
 
680
            all_unversioned = sorted([(p.split('/'), p) for p in self.target.extras()
 
681
                if not specific_files or
 
682
                    osutils.is_inside_any(specific_files, p)])
 
683
            all_unversioned = deque(all_unversioned)
 
684
        else:
 
685
            all_unversioned = deque()
 
686
        to_paths = {}
 
687
        from_entries_by_dir = list(self.source.inventory.iter_entries_by_dir(
 
688
            specific_file_ids=specific_file_ids))
 
689
        from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
 
690
        to_entries_by_dir = list(self.target.inventory.iter_entries_by_dir(
 
691
            specific_file_ids=specific_file_ids))
 
692
        num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
 
693
        entry_count = 0
 
694
        # the unversioned path lookup only occurs on real trees - where there 
 
695
        # can be extras. So the fake_entry is solely used to look up
 
696
        # executable it values when execute is not supported.
 
697
        fake_entry = InventoryFile('unused', 'unused', 'unused')
 
698
        for to_path, to_entry in to_entries_by_dir:
 
699
            while all_unversioned and all_unversioned[0][0] < to_path.split('/'):
 
700
                unversioned_path = all_unversioned.popleft()
 
701
                to_kind, to_executable, to_stat = \
 
702
                    self.target._comparison_data(fake_entry, unversioned_path[1])
 
703
                yield (None, (None, unversioned_path[1]), True, (False, False),
 
704
                    (None, None),
 
705
                    (None, unversioned_path[0][-1]),
 
706
                    (None, to_kind),
 
707
                    (None, to_executable))
 
708
            file_id = to_entry.file_id
 
709
            to_paths[file_id] = to_path
 
710
            entry_count += 1
 
711
            changed_content = False
 
712
            from_path, from_entry = from_data.get(file_id, (None, None))
 
713
            from_versioned = (from_entry is not None)
 
714
            if from_entry is not None:
 
715
                from_versioned = True
 
716
                from_name = from_entry.name
 
717
                from_parent = from_entry.parent_id
 
718
                from_kind, from_executable, from_stat = \
 
719
                    self.source._comparison_data(from_entry, from_path)
 
720
                entry_count += 1
 
721
            else:
 
722
                from_versioned = False
 
723
                from_kind = None
 
724
                from_parent = None
 
725
                from_name = None
 
726
                from_executable = None
 
727
            versioned = (from_versioned, True)
 
728
            to_kind, to_executable, to_stat = \
 
729
                self.target._comparison_data(to_entry, to_path)
 
730
            kind = (from_kind, to_kind)
 
731
            if kind[0] != kind[1]:
 
732
                changed_content = True
 
733
            elif from_kind == 'file':
 
734
                from_size = self.source._file_size(from_entry, from_stat)
 
735
                to_size = self.target._file_size(to_entry, to_stat)
 
736
                if from_size != to_size:
 
737
                    changed_content = True
 
738
                elif (self.source.get_file_sha1(file_id, from_path, from_stat) !=
 
739
                    self.target.get_file_sha1(file_id, to_path, to_stat)):
 
740
                    changed_content = True
 
741
            elif from_kind == 'symlink':
 
742
                if (self.source.get_symlink_target(file_id) !=
 
743
                    self.target.get_symlink_target(file_id)):
 
744
                    changed_content = True
 
745
                elif from_kind == 'tree-reference':
 
746
                    if (self.source.get_reference_revision(file_id, from_path)
 
747
                        != self.target.get_reference_revision(file_id, to_path)):
 
748
                        changed_content = True 
 
749
            parent = (from_parent, to_entry.parent_id)
 
750
            name = (from_name, to_entry.name)
 
751
            executable = (from_executable, to_executable)
 
752
            if pb is not None:
 
753
                pb.update('comparing files', entry_count, num_entries)
 
754
            if (changed_content is not False or versioned[0] != versioned[1]
 
755
                or parent[0] != parent[1] or name[0] != name[1] or 
 
756
                executable[0] != executable[1] or include_unchanged):
 
757
                yield (file_id, (from_path, to_path), changed_content,
 
758
                    versioned, parent, name, kind, executable)
 
759
 
 
760
        while all_unversioned:
 
761
            # yield any trailing unversioned paths
 
762
            unversioned_path = all_unversioned.popleft()
 
763
            to_kind, to_executable, to_stat = \
 
764
                self.target._comparison_data(fake_entry, unversioned_path[1])
 
765
            yield (None, (None, unversioned_path[1]), True, (False, False),
 
766
                (None, None),
 
767
                (None, unversioned_path[0][-1]),
 
768
                (None, to_kind),
 
769
                (None, to_executable))
 
770
 
 
771
        def get_to_path(to_entry):
 
772
            if to_entry.parent_id is None:
 
773
                to_path = '' # the root
 
774
            else:
 
775
                if to_entry.parent_id not in to_paths:
 
776
                    # recurse up
 
777
                    return get_to_path(self.target.inventory[to_entry.parent_id])
 
778
                to_path = osutils.pathjoin(to_paths[to_entry.parent_id],
 
779
                                           to_entry.name)
 
780
            to_paths[to_entry.file_id] = to_path
 
781
            return to_path
 
782
 
 
783
        for path, from_entry in from_entries_by_dir:
 
784
            file_id = from_entry.file_id
 
785
            if file_id in to_paths:
 
786
                # already returned
 
787
                continue
 
788
            if not file_id in self.target.inventory:
 
789
                # common case - paths we have not emitted are not present in
 
790
                # target.
 
791
                to_path = None
 
792
            else:
 
793
                to_path = get_to_path(self.target.inventory[file_id])
 
794
            entry_count += 1
 
795
            if pb is not None:
 
796
                pb.update('comparing files', entry_count, num_entries)
 
797
            versioned = (True, False)
 
798
            parent = (from_entry.parent_id, None)
 
799
            name = (from_entry.name, None)
 
800
            from_kind, from_executable, stat_value = \
 
801
                self.source._comparison_data(from_entry, path)
 
802
            kind = (from_kind, None)
 
803
            executable = (from_executable, None)
 
804
            changed_content = True
 
805
            # the parent's path is necessarily known at this point.
 
806
            yield(file_id, (path, to_path), changed_content, versioned, parent,
 
807
                  name, kind, executable)
 
808
 
 
809
 
 
810
# This was deprecated before 0.12, but did not have an official warning
 
811
@symbol_versioning.deprecated_function(symbol_versioning.zero_twelve)
 
812
def RevisionTree(*args, **kwargs):
 
813
    """RevisionTree has moved to bzrlib.revisiontree.RevisionTree()
 
814
 
 
815
    Accessing it as bzrlib.tree.RevisionTree has been deprecated as of
 
816
    bzr 0.12.
 
817
    """
 
818
    from bzrlib.revisiontree import RevisionTree as _RevisionTree
 
819
    return _RevisionTree(*args, **kwargs)
 
820
 
 
821