/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: John Arbash Meinel
  • Date: 2008-02-18 22:19:41 UTC
  • mto: This revision was merged to the branch mainline in revision 3280.
  • Revision ID: john@arbash-meinel.com-20080218221941-emdy2iq5crf93w4i
Add a *failing* test to expose why we need better handling when a line is introduced on two sides of a merge.

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