/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: Canonical.com Patch Queue Manager
  • Date: 2007-10-08 05:09:59 UTC
  • mfrom: (2872.3.3 shafile)
  • Revision ID: pqm@pqm.ubuntu.com-20071008050959-i785alc2ome5c1k5
add -Dhashcache, sha_file_by_name using raw os files rather than file objects (mbp)

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