/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

Merge bzr.dev

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