/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: Vincent Ladeuil
  • Date: 2007-12-28 15:33:47 UTC
  • mto: (3146.3.1 179368) (3156.2.1 trunk)
  • mto: This revision was merged to the branch mainline in revision 3158.
  • Revision ID: v.ladeuil+lp@free.fr-20071228153347-k84pqeepvol23tj5
Cancel RecordingServer move, that was useless.

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