/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: Ian Clatworthy
  • Date: 2008-04-17 08:21:14 UTC
  • mto: (4171.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 4173.
  • Revision ID: ian.clatworthy@canonical.com-20080417082114-76imbiarcbj16ov3
first cut at working tree content filtering

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