~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-10-31 04:39:04 UTC
  • mfrom: (3565.6.16 switch_nick)
  • Revision ID: pqm@pqm.ubuntu.com-20081031043904-52fnbfrloojemvcc
(mbp) branch nickname documentation

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""Tree classes, representing directory at point in time.
18
18
"""
19
19
 
20
 
from __future__ import absolute_import
21
 
 
22
20
import os
23
 
 
24
 
from bzrlib.lazy_import import lazy_import
25
 
lazy_import(globals(), """
26
 
import collections
27
 
 
 
21
from collections import deque
 
22
from cStringIO import StringIO
 
23
 
 
24
import bzrlib
28
25
from bzrlib import (
29
26
    conflicts as _mod_conflicts,
30
 
    debug,
31
27
    delta,
32
 
    errors,
33
 
    filters,
34
 
    inventory,
35
28
    osutils,
36
29
    revision as _mod_revision,
37
30
    rules,
38
 
    trace,
 
31
    symbol_versioning,
39
32
    )
40
 
from bzrlib.i18n import gettext
41
 
""")
42
 
 
43
33
from bzrlib.decorators import needs_read_lock
 
34
from bzrlib.errors import BzrError, BzrCheckError
 
35
from bzrlib import errors
 
36
from bzrlib.inventory import Inventory, InventoryFile
44
37
from bzrlib.inter import InterObject
45
 
from bzrlib.symbol_versioning import (
46
 
    deprecated_in,
47
 
    deprecated_method,
48
 
    )
 
38
from bzrlib.osutils import fingerprint_file
 
39
import bzrlib.revision
 
40
from bzrlib.symbol_versioning import deprecated_function, deprecated_in
 
41
from bzrlib.trace import mutter, note
49
42
 
50
43
 
51
44
class Tree(object):
52
45
    """Abstract file tree.
53
46
 
54
47
    There are several subclasses:
55
 
 
 
48
    
56
49
    * `WorkingTree` exists as files on disk editable by the user.
57
50
 
58
51
    * `RevisionTree` is a tree as recorded at some point in the past.
59
52
 
 
53
    Trees contain an `Inventory` object, and also know how to retrieve
 
54
    file texts mentioned in the inventory, either from a working
 
55
    directory or from a store.
 
56
 
 
57
    It is possible for trees to contain files that are not described
 
58
    in their inventory or vice versa; for this use `filenames()`.
 
59
 
60
60
    Trees can be compared, etc, regardless of whether they are working
61
61
    trees or versioned trees.
62
62
    """
63
 
 
64
 
    def has_versioned_directories(self):
65
 
        """Whether this tree can contain explicitly versioned directories.
66
 
 
67
 
        This defaults to True, but some implementations may want to override
68
 
        it.
69
 
        """
70
 
        return True
71
 
 
 
63
    
72
64
    def changes_from(self, other, want_unchanged=False, specific_files=None,
73
65
        extra_trees=None, require_versioned=False, include_root=False,
74
66
        want_unversioned=False):
88
80
            a PathsNotVersionedError will be thrown.
89
81
        :param want_unversioned: Scan for unversioned paths.
90
82
 
91
 
        The comparison will be performed by an InterTree object looked up on
 
83
        The comparison will be performed by an InterTree object looked up on 
92
84
        self and other.
93
85
        """
94
86
        # Martin observes that Tree.changes_from returns a TreeDelta and this
103
95
            want_unversioned=want_unversioned,
104
96
            )
105
97
 
 
98
    @symbol_versioning.deprecated_method(symbol_versioning.one_three)
 
99
    def _iter_changes(self, *args, **kwargs):
 
100
        return self.iter_changes(*args, **kwargs)
 
101
 
106
102
    def iter_changes(self, from_tree, include_unchanged=False,
107
103
                     specific_files=None, pb=None, extra_trees=None,
108
104
                     require_versioned=True, want_unversioned=False):
109
 
        """See InterTree.iter_changes"""
110
105
        intertree = InterTree.get(from_tree, self)
111
106
        return intertree.iter_changes(include_unchanged, specific_files, pb,
112
107
            extra_trees, require_versioned, want_unversioned=want_unversioned)
113
 
 
 
108
    
114
109
    def conflicts(self):
115
110
        """Get a list of the conflicts in the tree.
116
111
 
123
118
        return []
124
119
 
125
120
    def get_parent_ids(self):
126
 
        """Get the parent ids for this tree.
 
121
        """Get the parent ids for this tree. 
127
122
 
128
123
        :return: a list of parent ids. [] is returned to indicate
129
124
        a tree with no parents.
130
125
        :raises: BzrError if the parents are not known.
131
126
        """
132
127
        raise NotImplementedError(self.get_parent_ids)
133
 
 
 
128
    
134
129
    def has_filename(self, filename):
135
130
        """True if the tree has given filename."""
136
131
        raise NotImplementedError(self.has_filename)
137
132
 
138
133
    def has_id(self, file_id):
139
 
        raise NotImplementedError(self.has_id)
 
134
        return self.inventory.has_id(file_id)
140
135
 
141
 
    @deprecated_method(deprecated_in((2, 4, 0)))
142
136
    def __contains__(self, file_id):
143
137
        return self.has_id(file_id)
144
138
 
145
139
    def has_or_had_id(self, file_id):
146
 
        raise NotImplementedError(self.has_or_had_id)
 
140
        if file_id == self.inventory.root.file_id:
 
141
            return True
 
142
        return self.inventory.has_id(file_id)
147
143
 
148
144
    def is_ignored(self, filename):
149
145
        """Check whether the filename is ignored by this tree.
153
149
        """
154
150
        return False
155
151
 
 
152
    def __iter__(self):
 
153
        return iter(self.inventory)
 
154
 
156
155
    def all_file_ids(self):
157
156
        """Iterate through all file ids, including ids for missing files."""
158
 
        raise NotImplementedError(self.all_file_ids)
 
157
        return set(self.inventory)
159
158
 
160
159
    def id2path(self, file_id):
161
160
        """Return the path for a file id.
162
161
 
163
162
        :raises NoSuchId:
164
163
        """
165
 
        raise NotImplementedError(self.id2path)
166
 
 
167
 
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
 
164
        return self.inventory.id2path(file_id)
 
165
 
 
166
    def is_control_filename(self, filename):
 
167
        """True if filename is the name of a control file in this tree.
 
168
        
 
169
        :param filename: A filename within the tree. This is a relative path
 
170
        from the root of this tree.
 
171
 
 
172
        This is true IF and ONLY IF the filename is part of the meta data
 
173
        that bzr controls in this tree. I.E. a random .bzr directory placed
 
174
        on disk will not be a control file for this tree.
 
175
        """
 
176
        return self.bzrdir.is_control_filename(filename)
 
177
 
 
178
    @needs_read_lock
 
179
    def iter_entries_by_dir(self, specific_file_ids=None):
168
180
        """Walk the tree in 'by_dir' order.
169
181
 
170
182
        This will yield each entry in the tree as a (path, entry) tuple.
186
198
             g
187
199
 
188
200
        The yield order (ignoring root) would be::
189
 
 
190
201
          a, f, a/b, a/d, a/b/c, a/d/e, f/g
191
 
 
192
 
        :param yield_parents: If True, yield the parents from the root leading
193
 
            down to specific_file_ids that have been requested. This has no
194
 
            impact if specific_file_ids is None.
195
 
        """
196
 
        raise NotImplementedError(self.iter_entries_by_dir)
197
 
 
198
 
    def iter_child_entries(self, file_id, path=None):
199
 
        """Iterate over the children of a directory or tree reference.
200
 
 
201
 
        :param file_id: File id of the directory/tree-reference
202
 
        :param path: Optional path of the directory
203
 
        :raise NoSuchId: When the file_id does not exist
204
 
        :return: Iterator over entries in the directory
205
 
        """
206
 
        raise NotImplementedError(self.iter_child_entries)
207
 
 
208
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
209
 
        """List all files in this tree.
210
 
 
211
 
        :param include_root: Whether to include the entry for the tree root
212
 
        :param from_dir: Directory under which to list files
213
 
        :param recursive: Whether to list files recursively
214
 
        :return: iterator over tuples of (path, versioned, kind, file_id,
215
 
            inventory entry)
216
 
        """
217
 
        raise NotImplementedError(self.list_files)
 
202
        """
 
203
        return self.inventory.iter_entries_by_dir(
 
204
            specific_file_ids=specific_file_ids)
218
205
 
219
206
    def iter_references(self):
220
 
        if self.supports_tree_reference():
221
 
            for path, entry in self.iter_entries_by_dir():
222
 
                if entry.kind == 'tree-reference':
223
 
                    yield path, entry.file_id
 
207
        for path, entry in self.iter_entries_by_dir():
 
208
            if entry.kind == 'tree-reference':
 
209
                yield path, entry.file_id
224
210
 
225
211
    def kind(self, file_id):
226
212
        raise NotImplementedError("Tree subclass %s must implement kind"
236
222
 
237
223
    def path_content_summary(self, path):
238
224
        """Get a summary of the information about path.
239
 
 
240
 
        All the attributes returned are for the canonical form, not the
241
 
        convenient form (if content filters are in use.)
242
 
 
 
225
        
243
226
        :param path: A relative path within the tree.
244
227
        :return: A tuple containing kind, size, exec, sha1-or-link.
245
228
            Kind is always present (see tree.kind()).
246
 
            size is present if kind is file and the size of the 
247
 
                canonical form can be cheaply determined, None otherwise.
 
229
            size is present if kind is file, None otherwise.
248
230
            exec is None unless kind is file and the platform supports the 'x'
249
231
                bit.
250
232
            sha1-or-link is the link target if kind is symlink, or the sha1 if
271
253
    def _file_size(self, entry, stat_value):
272
254
        raise NotImplementedError(self._file_size)
273
255
 
 
256
    def _get_inventory(self):
 
257
        return self._inventory
 
258
    
274
259
    def get_file(self, file_id, path=None):
275
260
        """Return a file object for the file file_id in the tree.
276
 
 
 
261
        
277
262
        If both file_id and path are defined, it is implementation defined as
278
263
        to which one is used.
279
264
        """
280
265
        raise NotImplementedError(self.get_file)
281
266
 
282
 
    def get_file_with_stat(self, file_id, path=None):
283
 
        """Get a file handle and stat object for file_id.
284
 
 
285
 
        The default implementation returns (self.get_file, None) for backwards
286
 
        compatibility.
287
 
 
288
 
        :param file_id: The file id to read.
289
 
        :param path: The path of the file, if it is known.
290
 
        :return: A tuple (file_handle, stat_value_or_None). If the tree has
291
 
            no stat facility, or need for a stat cache feedback during commit,
292
 
            it may return None for the second element of the tuple.
293
 
        """
294
 
        return (self.get_file(file_id, path), None)
295
 
 
296
267
    def get_file_text(self, file_id, path=None):
297
268
        """Return the byte content of a file.
298
269
 
299
270
        :param file_id: The file_id of the file.
300
271
        :param path: The path of the file.
301
 
 
302
272
        If both file_id and path are supplied, an implementation may use
303
273
        either one.
304
 
 
305
 
        :returns: A single byte string for the whole file.
306
274
        """
307
275
        my_file = self.get_file(file_id, path)
308
276
        try:
315
283
 
316
284
        :param file_id: The file_id of the file.
317
285
        :param path: The path of the file.
318
 
 
319
286
        If both file_id and path are supplied, an implementation may use
320
287
        either one.
321
288
        """
322
289
        return osutils.split_lines(self.get_file_text(file_id, path))
323
290
 
324
 
    def get_file_verifier(self, file_id, path=None, stat_value=None):
325
 
        """Return a verifier for a file.
326
 
 
327
 
        The default implementation returns a sha1.
328
 
 
329
 
        :param file_id: The handle for this file.
330
 
        :param path: The path that this file can be found at.
331
 
            These must point to the same object.
332
 
        :param stat_value: Optional stat value for the object
333
 
        :return: Tuple with verifier name and verifier data
334
 
        """
335
 
        return ("SHA1", self.get_file_sha1(file_id, path=path,
336
 
            stat_value=stat_value))
337
 
 
338
 
    def get_file_sha1(self, file_id, path=None, stat_value=None):
339
 
        """Return the SHA1 file for a file.
340
 
 
341
 
        :note: callers should use get_file_verifier instead
342
 
            where possible, as the underlying repository implementation may
343
 
            have quicker access to a non-sha1 verifier.
344
 
 
345
 
        :param file_id: The handle for this file.
346
 
        :param path: The path that this file can be found at.
347
 
            These must point to the same object.
348
 
        :param stat_value: Optional stat value for the object
349
 
        """
350
 
        raise NotImplementedError(self.get_file_sha1)
351
 
 
352
291
    def get_file_mtime(self, file_id, path=None):
353
292
        """Return the modification time for a file.
354
293
 
367
306
        """
368
307
        raise NotImplementedError(self.get_file_size)
369
308
 
370
 
    def is_executable(self, file_id, path=None):
371
 
        """Check if a file is executable.
372
 
 
373
 
        :param file_id: The handle for this file.
374
 
        :param path: The path that this file can be found at.
375
 
            These must point to the same object.
376
 
        """
377
 
        raise NotImplementedError(self.is_executable)
 
309
    def get_file_by_path(self, path):
 
310
        return self.get_file(self._inventory.path2id(path), path)
378
311
 
379
312
    def iter_files_bytes(self, desired_files):
380
313
        """Iterate through file contents.
402
335
            cur_file = (self.get_file_text(file_id),)
403
336
            yield identifier, cur_file
404
337
 
405
 
    def get_symlink_target(self, file_id, path=None):
 
338
    def get_symlink_target(self, file_id):
406
339
        """Get the target for a given file_id.
407
340
 
408
341
        It is assumed that the caller already knows that file_id is referencing
409
342
        a symlink.
410
343
        :param file_id: Handle for the symlink entry.
411
 
        :param path: The path of the file.
412
 
        If both file_id and path are supplied, an implementation may use
413
 
        either one.
414
344
        :return: The path the symlink points to.
415
345
        """
416
346
        raise NotImplementedError(self.get_symlink_target)
434
364
        raise NotImplementedError(self.annotate_iter)
435
365
 
436
366
    def _get_plan_merge_data(self, file_id, other, base):
437
 
        from bzrlib import versionedfile
 
367
        from bzrlib import merge, versionedfile
438
368
        vf = versionedfile._PlanMergeVersionedFile(file_id)
439
369
        last_revision_a = self._get_file_revision(file_id, vf, 'this:')
440
370
        last_revision_b = other._get_file_revision(file_id, vf, 'other:')
478
408
            except errors.NoSuchRevisionInTree:
479
409
                yield self.repository.revision_tree(revision_id)
480
410
 
 
411
    @staticmethod
 
412
    def _file_revision(revision_tree, file_id):
 
413
        """Determine the revision associated with a file in a given tree."""
 
414
        revision_tree.lock_read()
 
415
        try:
 
416
            return revision_tree.inventory[file_id].revision
 
417
        finally:
 
418
            revision_tree.unlock()
 
419
 
481
420
    def _get_file_revision(self, file_id, vf, tree_revision):
482
421
        """Ensure that file_id, tree_revision is in vf to plan the merge."""
483
422
 
484
423
        if getattr(self, '_repository', None) is None:
485
424
            last_revision = tree_revision
486
 
            parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
 
425
            parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
487
426
                self._iter_parent_trees()]
488
427
            vf.add_lines((file_id, last_revision), parent_keys,
489
 
                         self.get_file_lines(file_id))
 
428
                         self.get_file(file_id).readlines())
490
429
            repo = self.branch.repository
491
430
            base_vf = repo.texts
492
431
        else:
493
 
            last_revision = self.get_file_revision(file_id)
 
432
            last_revision = self._file_revision(self, file_id)
494
433
            base_vf = self._repository.texts
495
434
        if base_vf not in vf.fallback_versionedfiles:
496
435
            vf.fallback_versionedfiles.append(base_vf)
497
436
        return last_revision
498
437
 
 
438
    inventory = property(_get_inventory,
 
439
                         doc="Inventory of this Tree")
 
440
 
499
441
    def _check_retrieved(self, ie, f):
500
442
        if not __debug__:
501
 
            return
502
 
        fp = osutils.fingerprint_file(f)
 
443
            return  
 
444
        fp = fingerprint_file(f)
503
445
        f.seek(0)
504
 
 
 
446
        
505
447
        if ie.text_size is not None:
506
448
            if ie.text_size != fp['size']:
507
 
                raise errors.BzrError(
508
 
                        "mismatched size for file %r in %r" %
509
 
                        (ie.file_id, self._store),
 
449
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
510
450
                        ["inventory expects %d bytes" % ie.text_size,
511
451
                         "file is actually %d bytes" % fp['size'],
512
452
                         "store is probably damaged/corrupt"])
513
453
 
514
454
        if ie.text_sha1 != fp['sha1']:
515
 
            raise errors.BzrError("wrong SHA-1 for file %r in %r" %
516
 
                    (ie.file_id, self._store),
 
455
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
517
456
                    ["inventory expects %s" % ie.text_sha1,
518
457
                     "file is actually %s" % fp['sha1'],
519
458
                     "store is probably damaged/corrupt"])
520
459
 
 
460
    @needs_read_lock
521
461
    def path2id(self, path):
522
462
        """Return the id for path in this tree."""
523
 
        raise NotImplementedError(self.path2id)
 
463
        return self._inventory.path2id(path)
524
464
 
525
465
    def paths2ids(self, paths, trees=[], require_versioned=True):
526
466
        """Return all the ids that can be reached by walking from paths.
527
 
 
 
467
        
528
468
        Each path is looked up in this tree and any extras provided in
529
469
        trees, and this is repeated recursively: the children in an extra tree
530
470
        of a directory that has been renamed under a provided path in this tree
542
482
        return find_ids_across_trees(paths, [self] + list(trees), require_versioned)
543
483
 
544
484
    def iter_children(self, file_id):
545
 
        """Iterate over the file ids of the children of an entry.
 
485
        entry = self.iter_entries_by_dir([file_id]).next()[1]
 
486
        for child in getattr(entry, 'children', {}).itervalues():
 
487
            yield child.file_id
546
488
 
547
 
        :param file_id: File id of the entry
548
 
        :return: Iterator over child file ids.
549
 
        """
550
 
        raise NotImplementedError(self.iter_children)
 
489
    @symbol_versioning.deprecated_method(symbol_versioning.one_six)
 
490
    def print_file(self, file_id):
 
491
        """Print file with id `file_id` to stdout."""
 
492
        import sys
 
493
        sys.stdout.write(self.get_file_text(file_id))
551
494
 
552
495
    def lock_read(self):
553
 
        """Lock this tree for multiple read only operations.
554
 
 
555
 
        :return: A bzrlib.lock.LogicalLockResult.
556
 
        """
557
496
        pass
558
497
 
559
498
    def revision_tree(self, revision_id):
561
500
 
562
501
        The intention of this method is to allow access to possibly cached
563
502
        tree data. Implementors of this method should raise NoSuchRevision if
564
 
        the tree is not locally available, even if they could obtain the
565
 
        tree via a repository or some other means. Callers are responsible
 
503
        the tree is not locally available, even if they could obtain the 
 
504
        tree via a repository or some other means. Callers are responsible 
566
505
        for finding the ultimate source for a revision tree.
567
506
 
568
507
        :param revision_id: The revision_id of the requested tree.
573
512
 
574
513
    def unknowns(self):
575
514
        """What files are present in this tree and unknown.
576
 
 
 
515
        
577
516
        :return: an iterator over the unknown files.
578
517
        """
579
518
        return iter([])
586
525
 
587
526
        :return: set of paths.
588
527
        """
589
 
        raise NotImplementedError(self.filter_unversioned_files)
 
528
        # NB: we specifically *don't* call self.has_filename, because for
 
529
        # WorkingTrees that can indicate files that exist on disk but that 
 
530
        # are not versioned.
 
531
        pred = self.inventory.has_filename
 
532
        return set((p for p in paths if not pred(p)))
590
533
 
591
534
    def walkdirs(self, prefix=""):
592
535
        """Walk the contents of this tree from path down.
594
537
        This yields all the data about the contents of a directory at a time.
595
538
        After each directory has been yielded, if the caller has mutated the
596
539
        list to exclude some directories, they are then not descended into.
597
 
 
 
540
        
598
541
        The data yielded is of the form:
599
542
        ((directory-relpath, directory-path-from-root, directory-fileid),
600
 
        [(relpath, basename, kind, lstat, path_from_tree_root, file_id,
 
543
        [(relpath, basename, kind, lstat, path_from_tree_root, file_id, 
601
544
          versioned_kind), ...]),
602
545
         - directory-relpath is the containing dirs relpath from prefix
603
546
         - directory-path-from-root is the containing dirs path from /
610
553
         - lstat is the stat data *if* the file was statted.
611
554
         - path_from_tree_root is the path from the root of the tree.
612
555
         - file_id is the file_id if the entry is versioned.
613
 
         - versioned_kind is the kind of the file as last recorded in the
 
556
         - versioned_kind is the kind of the file as last recorded in the 
614
557
           versioning system. If 'unknown' the file is not versioned.
615
558
        One of 'kind' and 'versioned_kind' must not be 'unknown'.
616
559
 
621
564
        """
622
565
        raise NotImplementedError(self.walkdirs)
623
566
 
624
 
    def supports_content_filtering(self):
625
 
        return False
626
 
 
627
 
    def _content_filter_stack(self, path=None, file_id=None):
628
 
        """The stack of content filters for a path if filtering is supported.
629
 
 
630
 
        Readers will be applied in first-to-last order.
631
 
        Writers will be applied in last-to-first order.
632
 
        Either the path or the file-id needs to be provided.
633
 
 
634
 
        :param path: path relative to the root of the tree
635
 
            or None if unknown
636
 
        :param file_id: file_id or None if unknown
637
 
        :return: the list of filters - [] if there are none
638
 
        """
639
 
        filter_pref_names = filters._get_registered_names()
640
 
        if len(filter_pref_names) == 0:
641
 
            return []
642
 
        if path is None:
643
 
            path = self.id2path(file_id)
644
 
        prefs = self.iter_search_rules([path], filter_pref_names).next()
645
 
        stk = filters._get_filter_stack_for(prefs)
646
 
        if 'filters' in debug.debug_flags:
647
 
            trace.note(gettext("*** {0} content-filter: {1} => {2!r}").format(path,prefs,stk))
648
 
        return stk
649
 
 
650
 
    def _content_filter_stack_provider(self):
651
 
        """A function that returns a stack of ContentFilters.
652
 
 
653
 
        The function takes a path (relative to the top of the tree) and a
654
 
        file-id as parameters.
655
 
 
656
 
        :return: None if content filtering is not supported by this tree.
657
 
        """
658
 
        if self.supports_content_filtering():
659
 
            return lambda path, file_id: \
660
 
                    self._content_filter_stack(path, file_id)
661
 
        else:
662
 
            return None
663
 
 
664
567
    def iter_search_rules(self, path_names, pref_names=None,
665
 
        _default_searcher=None):
 
568
        _default_searcher=rules._per_user_searcher):
666
569
        """Find the preferences for filenames in a tree.
667
570
 
668
571
        :param path_names: an iterable of paths to find attributes for.
672
575
        :return: an iterator of tuple sequences, one per path-name.
673
576
          See _RulesSearcher.get_items for details on the tuple sequence.
674
577
        """
675
 
        if _default_searcher is None:
676
 
            _default_searcher = rules._per_user_searcher
677
578
        searcher = self._get_rules_searcher(_default_searcher)
678
579
        if searcher is not None:
679
580
            if pref_names is not None:
683
584
                for path in path_names:
684
585
                    yield searcher.get_items(path)
685
586
 
 
587
    @needs_read_lock
686
588
    def _get_rules_searcher(self, default_searcher):
687
589
        """Get the RulesSearcher for this tree given the default one."""
688
590
        searcher = default_searcher
689
591
        return searcher
690
592
 
691
593
 
692
 
class InventoryTree(Tree):
693
 
    """A tree that relies on an inventory for its metadata.
694
 
 
695
 
    Trees contain an `Inventory` object, and also know how to retrieve
696
 
    file texts mentioned in the inventory, either from a working
697
 
    directory or from a store.
698
 
 
699
 
    It is possible for trees to contain files that are not described
700
 
    in their inventory or vice versa; for this use `filenames()`.
701
 
 
702
 
    Subclasses should set the _inventory attribute, which is considered
703
 
    private to external API users.
 
594
class EmptyTree(Tree):
 
595
 
 
596
    def __init__(self):
 
597
        self._inventory = Inventory(root_id=None)
 
598
        symbol_versioning.warn('EmptyTree is deprecated as of bzr 0.9 please'
 
599
                               ' use repository.revision_tree instead.',
 
600
                               DeprecationWarning, stacklevel=2)
 
601
 
 
602
    def get_parent_ids(self):
 
603
        return []
 
604
 
 
605
    def get_symlink_target(self, file_id):
 
606
        return None
 
607
 
 
608
    def has_filename(self, filename):
 
609
        return False
 
610
 
 
611
    def kind(self, file_id):
 
612
        return "directory"
 
613
 
 
614
    def list_files(self, include_root=False):
 
615
        return iter([])
 
616
    
 
617
    def __contains__(self, file_id):
 
618
        return (file_id in self._inventory)
 
619
 
 
620
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
621
        return None
 
622
 
 
623
 
 
624
######################################################################
 
625
# diff
 
626
 
 
627
# TODO: Merge these two functions into a single one that can operate
 
628
# on either a whole tree or a set of files.
 
629
 
 
630
# TODO: Return the diff in order by filename, not by category or in
 
631
# random order.  Can probably be done by lock-stepping through the
 
632
# filenames from both trees.
 
633
 
 
634
 
 
635
def file_status(filename, old_tree, new_tree):
 
636
    """Return single-letter status, old and new names for a file.
 
637
 
 
638
    The complexity here is in deciding how to represent renames;
 
639
    many complex cases are possible.
704
640
    """
705
 
 
706
 
    def get_canonical_inventory_paths(self, paths):
707
 
        """Like get_canonical_inventory_path() but works on multiple items.
708
 
 
709
 
        :param paths: A sequence of paths relative to the root of the tree.
710
 
        :return: A list of paths, with each item the corresponding input path
711
 
        adjusted to account for existing elements that match case
712
 
        insensitively.
713
 
        """
714
 
        return list(self._yield_canonical_inventory_paths(paths))
715
 
 
716
 
    def get_canonical_inventory_path(self, path):
717
 
        """Returns the first inventory item that case-insensitively matches path.
718
 
 
719
 
        If a path matches exactly, it is returned. If no path matches exactly
720
 
        but more than one path matches case-insensitively, it is implementation
721
 
        defined which is returned.
722
 
 
723
 
        If no path matches case-insensitively, the input path is returned, but
724
 
        with as many path entries that do exist changed to their canonical
725
 
        form.
726
 
 
727
 
        If you need to resolve many names from the same tree, you should
728
 
        use get_canonical_inventory_paths() to avoid O(N) behaviour.
729
 
 
730
 
        :param path: A paths relative to the root of the tree.
731
 
        :return: The input path adjusted to account for existing elements
732
 
        that match case insensitively.
733
 
        """
734
 
        return self._yield_canonical_inventory_paths([path]).next()
735
 
 
736
 
    def _yield_canonical_inventory_paths(self, paths):
737
 
        for path in paths:
738
 
            # First, if the path as specified exists exactly, just use it.
739
 
            if self.path2id(path) is not None:
740
 
                yield path
741
 
                continue
742
 
            # go walkin...
743
 
            cur_id = self.get_root_id()
744
 
            cur_path = ''
745
 
            bit_iter = iter(path.split("/"))
746
 
            for elt in bit_iter:
747
 
                lelt = elt.lower()
748
 
                new_path = None
749
 
                for child in self.iter_children(cur_id):
750
 
                    try:
751
 
                        # XXX: it seem like if the child is known to be in the
752
 
                        # tree, we shouldn't need to go from its id back to
753
 
                        # its path -- mbp 2010-02-11
754
 
                        #
755
 
                        # XXX: it seems like we could be more efficient
756
 
                        # by just directly looking up the original name and
757
 
                        # only then searching all children; also by not
758
 
                        # chopping paths so much. -- mbp 2010-02-11
759
 
                        child_base = os.path.basename(self.id2path(child))
760
 
                        if (child_base == elt):
761
 
                            # if we found an exact match, we can stop now; if
762
 
                            # we found an approximate match we need to keep
763
 
                            # searching because there might be an exact match
764
 
                            # later.  
765
 
                            cur_id = child
766
 
                            new_path = osutils.pathjoin(cur_path, child_base)
767
 
                            break
768
 
                        elif child_base.lower() == lelt:
769
 
                            cur_id = child
770
 
                            new_path = osutils.pathjoin(cur_path, child_base)
771
 
                    except errors.NoSuchId:
772
 
                        # before a change is committed we can see this error...
773
 
                        continue
774
 
                if new_path:
775
 
                    cur_path = new_path
776
 
                else:
777
 
                    # got to the end of this directory and no entries matched.
778
 
                    # Return what matched so far, plus the rest as specified.
779
 
                    cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
780
 
                    break
781
 
            yield cur_path
782
 
        # all done.
783
 
 
784
 
    @deprecated_method(deprecated_in((2, 5, 0)))
785
 
    def _get_inventory(self):
786
 
        return self._inventory
787
 
 
788
 
    inventory = property(_get_inventory,
789
 
                         doc="Inventory of this Tree")
790
 
 
791
 
    def _get_root_inventory(self):
792
 
        return self._inventory
793
 
 
794
 
    root_inventory = property(_get_root_inventory,
795
 
        doc="Root inventory of this tree")
796
 
 
797
 
    def _unpack_file_id(self, file_id):
798
 
        """Find the inventory and inventory file id for a tree file id.
799
 
 
800
 
        :param file_id: The tree file id, as bytestring or tuple
801
 
        :return: Inventory and inventory file id
802
 
        """
803
 
        if isinstance(file_id, tuple):
804
 
            if len(file_id) != 1:
805
 
                raise ValueError("nested trees not yet supported: %r" % file_id)
806
 
            file_id = file_id[0]
807
 
        return self.root_inventory, file_id
808
 
 
809
 
    @needs_read_lock
810
 
    def path2id(self, path):
811
 
        """Return the id for path in this tree."""
812
 
        return self._path2inv_file_id(path)[1]
813
 
 
814
 
    def _path2inv_file_id(self, path):
815
 
        """Lookup a inventory and inventory file id by path.
816
 
 
817
 
        :param path: Path to look up
818
 
        :return: tuple with inventory and inventory file id
819
 
        """
820
 
        # FIXME: Support nested trees
821
 
        return self.root_inventory, self.root_inventory.path2id(path)
822
 
 
823
 
    def id2path(self, file_id):
824
 
        """Return the path for a file id.
825
 
 
826
 
        :raises NoSuchId:
827
 
        """
828
 
        inventory, file_id = self._unpack_file_id(file_id)
829
 
        return inventory.id2path(file_id)
830
 
 
831
 
    def has_id(self, file_id):
832
 
        inventory, file_id = self._unpack_file_id(file_id)
833
 
        return inventory.has_id(file_id)
834
 
 
835
 
    def has_or_had_id(self, file_id):
836
 
        inventory, file_id = self._unpack_file_id(file_id)
837
 
        return inventory.has_id(file_id)
838
 
 
839
 
    def all_file_ids(self):
840
 
        return set(
841
 
            [entry.file_id for path, entry in self.iter_entries_by_dir()])
842
 
 
843
 
    @deprecated_method(deprecated_in((2, 4, 0)))
844
 
    def __iter__(self):
845
 
        return iter(self.all_file_ids())
846
 
 
847
 
    def filter_unversioned_files(self, paths):
848
 
        """Filter out paths that are versioned.
849
 
 
850
 
        :return: set of paths.
851
 
        """
852
 
        # NB: we specifically *don't* call self.has_filename, because for
853
 
        # WorkingTrees that can indicate files that exist on disk but that
854
 
        # are not versioned.
855
 
        return set((p for p in paths if self.path2id(p) is None))
856
 
 
857
 
    @needs_read_lock
858
 
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
859
 
        """Walk the tree in 'by_dir' order.
860
 
 
861
 
        This will yield each entry in the tree as a (path, entry) tuple.
862
 
        The order that they are yielded is:
863
 
 
864
 
        See Tree.iter_entries_by_dir for details.
865
 
 
866
 
        :param yield_parents: If True, yield the parents from the root leading
867
 
            down to specific_file_ids that have been requested. This has no
868
 
            impact if specific_file_ids is None.
869
 
        """
870
 
        if specific_file_ids is None:
871
 
            inventory_file_ids = None
872
 
        else:
873
 
            inventory_file_ids = []
874
 
            for tree_file_id in specific_file_ids:
875
 
                inventory, inv_file_id = self._unpack_file_id(tree_file_id)
876
 
                if not inventory is self.root_inventory: # for now
877
 
                    raise AssertionError("%r != %r" % (
878
 
                        inventory, self.root_inventory))
879
 
                inventory_file_ids.append(inv_file_id)
880
 
        # FIXME: Handle nested trees
881
 
        return self.root_inventory.iter_entries_by_dir(
882
 
            specific_file_ids=inventory_file_ids, yield_parents=yield_parents)
883
 
 
884
 
    @needs_read_lock
885
 
    def iter_child_entries(self, file_id, path=None):
886
 
        inv, inv_file_id = self._unpack_file_id(file_id)
887
 
        return inv[inv_file_id].children.itervalues()
888
 
 
889
 
    @deprecated_method(deprecated_in((2, 5, 0)))
890
 
    def get_file_by_path(self, path):
891
 
        return self.get_file(self.path2id(path), path)
892
 
 
893
 
    def iter_children(self, file_id, path=None):
894
 
        """See Tree.iter_children."""
895
 
        entry = self.iter_entries_by_dir([file_id]).next()[1]
896
 
        for child in getattr(entry, 'children', {}).itervalues():
897
 
            yield child.file_id
 
641
    old_inv = old_tree.inventory
 
642
    new_inv = new_tree.inventory
 
643
    new_id = new_inv.path2id(filename)
 
644
    old_id = old_inv.path2id(filename)
 
645
 
 
646
    if not new_id and not old_id:
 
647
        # easy: doesn't exist in either; not versioned at all
 
648
        if new_tree.is_ignored(filename):
 
649
            return 'I', None, None
 
650
        else:
 
651
            return '?', None, None
 
652
    elif new_id:
 
653
        # There is now a file of this name, great.
 
654
        pass
 
655
    else:
 
656
        # There is no longer a file of this name, but we can describe
 
657
        # what happened to the file that used to have
 
658
        # this name.  There are two possibilities: either it was
 
659
        # deleted entirely, or renamed.
 
660
        if new_inv.has_id(old_id):
 
661
            return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
 
662
        else:
 
663
            return 'D', old_inv.id2path(old_id), None
 
664
 
 
665
    # if the file_id is new in this revision, it is added
 
666
    if new_id and not old_inv.has_id(new_id):
 
667
        return 'A'
 
668
 
 
669
    # if there used to be a file of this name, but that ID has now
 
670
    # disappeared, it is deleted
 
671
    if old_id and not new_inv.has_id(old_id):
 
672
        return 'D'
 
673
 
 
674
    return 'wtf?'
 
675
 
 
676
    
 
677
@deprecated_function(deprecated_in((1, 9, 0)))
 
678
def find_renames(old_inv, new_inv):
 
679
    for file_id in old_inv:
 
680
        if file_id not in new_inv:
 
681
            continue
 
682
        old_name = old_inv.id2path(file_id)
 
683
        new_name = new_inv.id2path(file_id)
 
684
        if old_name != new_name:
 
685
            yield (old_name, new_name)
898
686
 
899
687
 
900
688
def find_ids_across_trees(filenames, trees, require_versioned=True):
901
689
    """Find the ids corresponding to specified filenames.
902
 
 
 
690
    
903
691
    All matches in all trees will be used, and all children of matched
904
692
    directories will be used.
905
693
 
907
695
        None)
908
696
    :param trees: The trees to find file_ids within
909
697
    :param require_versioned: if true, all specified filenames must occur in
910
 
        at least one tree.
 
698
    at least one tree.
911
699
    :return: a set of file ids for the specified filenames and their children.
912
700
    """
913
701
    if not filenames:
919
707
 
920
708
def _find_ids_across_trees(filenames, trees, require_versioned):
921
709
    """Find the ids corresponding to specified filenames.
922
 
 
 
710
    
923
711
    All matches in all trees will be used, but subdirectories are not scanned.
924
712
 
925
713
    :param filenames: The filenames to find file_ids for
946
734
 
947
735
def _find_children_across_trees(specified_ids, trees):
948
736
    """Return a set including specified ids and their children.
949
 
 
 
737
    
950
738
    All matches in all trees will be used.
951
739
 
952
740
    :param trees: The trees to find file_ids within
953
 
    :return: a set containing all specified ids and their children
 
741
    :return: a set containing all specified ids and their children 
954
742
    """
955
743
    interesting_ids = set(specified_ids)
956
744
    pending = interesting_ids
960
748
        new_pending = set()
961
749
        for file_id in pending:
962
750
            for tree in trees:
963
 
                if not tree.has_or_had_id(file_id):
 
751
                if not tree.has_id(file_id):
964
752
                    continue
965
753
                for child_id in tree.iter_children(file_id):
966
754
                    if child_id not in interesting_ids:
981
769
    will pass through to InterTree as appropriate.
982
770
    """
983
771
 
984
 
    # Formats that will be used to test this InterTree. If both are
985
 
    # None, this InterTree will not be tested (e.g. because a complex
986
 
    # setup is required)
987
 
    _matching_from_tree_format = None
988
 
    _matching_to_tree_format = None
989
 
 
990
772
    _optimisers = []
991
773
 
992
 
    @classmethod
993
 
    def is_compatible(kls, source, target):
994
 
        # The default implementation is naive and uses the public API, so
995
 
        # it works for all trees.
996
 
        return True
997
 
 
998
 
    def _changes_from_entries(self, source_entry, target_entry,
999
 
        source_path=None, target_path=None):
1000
 
        """Generate a iter_changes tuple between source_entry and target_entry.
1001
 
 
1002
 
        :param source_entry: An inventory entry from self.source, or None.
1003
 
        :param target_entry: An inventory entry from self.target, or None.
1004
 
        :param source_path: The path of source_entry, if known. If not known
1005
 
            it will be looked up.
1006
 
        :param target_path: The path of target_entry, if known. If not known
1007
 
            it will be looked up.
1008
 
        :return: A tuple, item 0 of which is an iter_changes result tuple, and
1009
 
            item 1 is True if there are any changes in the result tuple.
1010
 
        """
1011
 
        if source_entry is None:
1012
 
            if target_entry is None:
1013
 
                return None
1014
 
            file_id = target_entry.file_id
1015
 
        else:
1016
 
            file_id = source_entry.file_id
1017
 
        if source_entry is not None:
1018
 
            source_versioned = True
1019
 
            source_name = source_entry.name
1020
 
            source_parent = source_entry.parent_id
1021
 
            if source_path is None:
1022
 
                source_path = self.source.id2path(file_id)
1023
 
            source_kind, source_executable, source_stat = \
1024
 
                self.source._comparison_data(source_entry, source_path)
1025
 
        else:
1026
 
            source_versioned = False
1027
 
            source_name = None
1028
 
            source_parent = None
1029
 
            source_kind = None
1030
 
            source_executable = None
1031
 
        if target_entry is not None:
1032
 
            target_versioned = True
1033
 
            target_name = target_entry.name
1034
 
            target_parent = target_entry.parent_id
1035
 
            if target_path is None:
1036
 
                target_path = self.target.id2path(file_id)
1037
 
            target_kind, target_executable, target_stat = \
1038
 
                self.target._comparison_data(target_entry, target_path)
1039
 
        else:
1040
 
            target_versioned = False
1041
 
            target_name = None
1042
 
            target_parent = None
1043
 
            target_kind = None
1044
 
            target_executable = None
1045
 
        versioned = (source_versioned, target_versioned)
1046
 
        kind = (source_kind, target_kind)
1047
 
        changed_content = False
1048
 
        if source_kind != target_kind:
1049
 
            changed_content = True
1050
 
        elif source_kind == 'file':
1051
 
            if not self.file_content_matches(file_id, file_id, source_path,
1052
 
                    target_path, source_stat, target_stat):
1053
 
                changed_content = True
1054
 
        elif source_kind == 'symlink':
1055
 
            if (self.source.get_symlink_target(file_id) !=
1056
 
                self.target.get_symlink_target(file_id)):
1057
 
                changed_content = True
1058
 
        elif source_kind == 'tree-reference':
1059
 
            if (self.source.get_reference_revision(file_id, source_path)
1060
 
                != self.target.get_reference_revision(file_id, target_path)):
1061
 
                    changed_content = True
1062
 
        parent = (source_parent, target_parent)
1063
 
        name = (source_name, target_name)
1064
 
        executable = (source_executable, target_executable)
1065
 
        if (changed_content is not False or versioned[0] != versioned[1]
1066
 
            or parent[0] != parent[1] or name[0] != name[1] or
1067
 
            executable[0] != executable[1]):
1068
 
            changes = True
1069
 
        else:
1070
 
            changes = False
1071
 
        return (file_id, (source_path, target_path), changed_content,
1072
 
                versioned, parent, name, kind, executable), changes
1073
 
 
1074
774
    @needs_read_lock
1075
775
    def compare(self, want_unchanged=False, specific_files=None,
1076
776
        extra_trees=None, require_versioned=False, include_root=False,
1091
791
            a PathsNotVersionedError will be thrown.
1092
792
        :param want_unversioned: Scan for unversioned paths.
1093
793
        """
 
794
        # NB: show_status depends on being able to pass in non-versioned files
 
795
        # and report them as unknown
1094
796
        trees = (self.source,)
1095
797
        if extra_trees is not None:
1096
798
            trees = trees + tuple(extra_trees)
1101
803
            # All files are unversioned, so just return an empty delta
1102
804
            # _compare_trees would think we want a complete delta
1103
805
            result = delta.TreeDelta()
1104
 
            fake_entry = inventory.InventoryFile('unused', 'unused', 'unused')
 
806
            fake_entry = InventoryFile('unused', 'unused', 'unused')
1105
807
            result.unversioned = [(path, None,
1106
808
                self.target._comparison_data(fake_entry, path)[0]) for path in
1107
809
                specific_files]
1137
839
        :param require_versioned: Raise errors.PathsNotVersionedError if a
1138
840
            path in the specific_files list is not versioned in one of
1139
841
            source, target or extra_trees.
1140
 
        :param specific_files: An optional list of file paths to restrict the
1141
 
            comparison to. When mapping filenames to ids, all matches in all
1142
 
            trees (including optional extra_trees) are used, and all children
1143
 
            of matched directories are included. The parents in the target tree
1144
 
            of the specific files up to and including the root of the tree are
1145
 
            always evaluated for changes too.
1146
842
        :param want_unversioned: Should unversioned files be returned in the
1147
843
            output. An unversioned file is defined as one with (False, False)
1148
844
            for the versioned pair.
1149
845
        """
 
846
        result = []
1150
847
        lookup_trees = [self.source]
1151
848
        if extra_trees:
1152
849
             lookup_trees.extend(extra_trees)
1153
 
        # The ids of items we need to examine to insure delta consistency.
1154
 
        precise_file_ids = set()
1155
 
        changed_file_ids = []
1156
850
        if specific_files == []:
1157
851
            specific_file_ids = []
1158
852
        else:
1159
853
            specific_file_ids = self.target.paths2ids(specific_files,
1160
854
                lookup_trees, require_versioned=require_versioned)
1161
 
        if specific_files is not None:
1162
 
            # reparented or added entries must have their parents included
1163
 
            # so that valid deltas can be created. The seen_parents set
1164
 
            # tracks the parents that we need to have.
1165
 
            # The seen_dirs set tracks directory entries we've yielded.
1166
 
            # After outputting version object in to_entries we set difference
1167
 
            # the two seen sets and start checking parents.
1168
 
            seen_parents = set()
1169
 
            seen_dirs = set()
1170
855
        if want_unversioned:
1171
856
            all_unversioned = sorted([(p.split('/'), p) for p in
1172
857
                                     self.target.extras()
1173
858
                if specific_files is None or
1174
859
                    osutils.is_inside_any(specific_files, p)])
1175
 
            all_unversioned = collections.deque(all_unversioned)
 
860
            all_unversioned = deque(all_unversioned)
1176
861
        else:
1177
 
            all_unversioned = collections.deque()
 
862
            all_unversioned = deque()
1178
863
        to_paths = {}
1179
864
        from_entries_by_dir = list(self.source.iter_entries_by_dir(
1180
865
            specific_file_ids=specific_file_ids))
1183
868
            specific_file_ids=specific_file_ids))
1184
869
        num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
1185
870
        entry_count = 0
1186
 
        # the unversioned path lookup only occurs on real trees - where there
 
871
        # the unversioned path lookup only occurs on real trees - where there 
1187
872
        # can be extras. So the fake_entry is solely used to look up
1188
873
        # executable it values when execute is not supported.
1189
 
        fake_entry = inventory.InventoryFile('unused', 'unused', 'unused')
1190
 
        for target_path, target_entry in to_entries_by_dir:
1191
 
            while (all_unversioned and
1192
 
                all_unversioned[0][0] < target_path.split('/')):
 
874
        fake_entry = InventoryFile('unused', 'unused', 'unused')
 
875
        for to_path, to_entry in to_entries_by_dir:
 
876
            while all_unversioned and all_unversioned[0][0] < to_path.split('/'):
1193
877
                unversioned_path = all_unversioned.popleft()
1194
 
                target_kind, target_executable, target_stat = \
 
878
                to_kind, to_executable, to_stat = \
1195
879
                    self.target._comparison_data(fake_entry, unversioned_path[1])
1196
880
                yield (None, (None, unversioned_path[1]), True, (False, False),
1197
881
                    (None, None),
1198
882
                    (None, unversioned_path[0][-1]),
1199
 
                    (None, target_kind),
1200
 
                    (None, target_executable))
1201
 
            source_path, source_entry = from_data.get(target_entry.file_id,
1202
 
                (None, None))
1203
 
            result, changes = self._changes_from_entries(source_entry,
1204
 
                target_entry, source_path=source_path, target_path=target_path)
1205
 
            to_paths[result[0]] = result[1][1]
 
883
                    (None, to_kind),
 
884
                    (None, to_executable))
 
885
            file_id = to_entry.file_id
 
886
            to_paths[file_id] = to_path
1206
887
            entry_count += 1
1207
 
            if result[3][0]:
 
888
            changed_content = False
 
889
            from_path, from_entry = from_data.get(file_id, (None, None))
 
890
            from_versioned = (from_entry is not None)
 
891
            if from_entry is not None:
 
892
                from_versioned = True
 
893
                from_name = from_entry.name
 
894
                from_parent = from_entry.parent_id
 
895
                from_kind, from_executable, from_stat = \
 
896
                    self.source._comparison_data(from_entry, from_path)
1208
897
                entry_count += 1
 
898
            else:
 
899
                from_versioned = False
 
900
                from_kind = None
 
901
                from_parent = None
 
902
                from_name = None
 
903
                from_executable = None
 
904
            versioned = (from_versioned, True)
 
905
            to_kind, to_executable, to_stat = \
 
906
                self.target._comparison_data(to_entry, to_path)
 
907
            kind = (from_kind, to_kind)
 
908
            if kind[0] != kind[1]:
 
909
                changed_content = True
 
910
            elif from_kind == 'file':
 
911
                from_size = self.source._file_size(from_entry, from_stat)
 
912
                to_size = self.target._file_size(to_entry, to_stat)
 
913
                if from_size != to_size:
 
914
                    changed_content = True
 
915
                elif (self.source.get_file_sha1(file_id, from_path, from_stat) !=
 
916
                    self.target.get_file_sha1(file_id, to_path, to_stat)):
 
917
                    changed_content = True
 
918
            elif from_kind == 'symlink':
 
919
                if (self.source.get_symlink_target(file_id) !=
 
920
                    self.target.get_symlink_target(file_id)):
 
921
                    changed_content = True
 
922
                elif from_kind == 'tree-reference':
 
923
                    if (self.source.get_reference_revision(file_id, from_path)
 
924
                        != self.target.get_reference_revision(file_id, to_path)):
 
925
                        changed_content = True 
 
926
            parent = (from_parent, to_entry.parent_id)
 
927
            name = (from_name, to_entry.name)
 
928
            executable = (from_executable, to_executable)
1209
929
            if pb is not None:
1210
930
                pb.update('comparing files', entry_count, num_entries)
1211
 
            if changes or include_unchanged:
1212
 
                if specific_file_ids is not None:
1213
 
                    new_parent_id = result[4][1]
1214
 
                    precise_file_ids.add(new_parent_id)
1215
 
                    changed_file_ids.append(result[0])
1216
 
                yield result
1217
 
            # Ensure correct behaviour for reparented/added specific files.
1218
 
            if specific_files is not None:
1219
 
                # Record output dirs
1220
 
                if result[6][1] == 'directory':
1221
 
                    seen_dirs.add(result[0])
1222
 
                # Record parents of reparented/added entries.
1223
 
                versioned = result[3]
1224
 
                parents = result[4]
1225
 
                if not versioned[0] or parents[0] != parents[1]:
1226
 
                    seen_parents.add(parents[1])
 
931
            if (changed_content is not False or versioned[0] != versioned[1]
 
932
                or parent[0] != parent[1] or name[0] != name[1] or 
 
933
                executable[0] != executable[1] or include_unchanged):
 
934
                yield (file_id, (from_path, to_path), changed_content,
 
935
                    versioned, parent, name, kind, executable)
 
936
 
1227
937
        while all_unversioned:
1228
938
            # yield any trailing unversioned paths
1229
939
            unversioned_path = all_unversioned.popleft()
1234
944
                (None, unversioned_path[0][-1]),
1235
945
                (None, to_kind),
1236
946
                (None, to_executable))
1237
 
        # Yield all remaining source paths
 
947
 
 
948
        def get_to_path(to_entry):
 
949
            if to_entry.parent_id is None:
 
950
                to_path = '' # the root
 
951
            else:
 
952
                if to_entry.parent_id not in to_paths:
 
953
                    # recurse up
 
954
                    return get_to_path(self.target.inventory[to_entry.parent_id])
 
955
                to_path = osutils.pathjoin(to_paths[to_entry.parent_id],
 
956
                                           to_entry.name)
 
957
            to_paths[to_entry.file_id] = to_path
 
958
            return to_path
 
959
 
1238
960
        for path, from_entry in from_entries_by_dir:
1239
961
            file_id = from_entry.file_id
1240
962
            if file_id in to_paths:
1241
963
                # already returned
1242
964
                continue
1243
 
            if not self.target.has_id(file_id):
 
965
            if not file_id in self.target.all_file_ids():
1244
966
                # common case - paths we have not emitted are not present in
1245
967
                # target.
1246
968
                to_path = None
1247
969
            else:
1248
 
                to_path = self.target.id2path(file_id)
 
970
                to_path = get_to_path(self.target.inventory[file_id])
1249
971
            entry_count += 1
1250
972
            if pb is not None:
1251
973
                pb.update('comparing files', entry_count, num_entries)
1258
980
            executable = (from_executable, None)
1259
981
            changed_content = from_kind is not None
1260
982
            # the parent's path is necessarily known at this point.
1261
 
            changed_file_ids.append(file_id)
1262
983
            yield(file_id, (path, to_path), changed_content, versioned, parent,
1263
984
                  name, kind, executable)
1264
 
        changed_file_ids = set(changed_file_ids)
1265
 
        if specific_file_ids is not None:
1266
 
            for result in self._handle_precise_ids(precise_file_ids,
1267
 
                changed_file_ids):
1268
 
                yield result
1269
 
 
1270
 
    def _get_entry(self, tree, file_id):
1271
 
        """Get an inventory entry from a tree, with missing entries as None.
1272
 
 
1273
 
        If the tree raises NotImplementedError on accessing .inventory, then
1274
 
        this is worked around using iter_entries_by_dir on just the file id
1275
 
        desired.
1276
 
 
1277
 
        :param tree: The tree to lookup the entry in.
1278
 
        :param file_id: The file_id to lookup.
1279
 
        """
1280
 
        try:
1281
 
            inventory = tree.root_inventory
1282
 
        except NotImplementedError:
1283
 
            # No inventory available.
1284
 
            try:
1285
 
                iterator = tree.iter_entries_by_dir(specific_file_ids=[file_id])
1286
 
                return iterator.next()[1]
1287
 
            except StopIteration:
1288
 
                return None
1289
 
        else:
1290
 
            try:
1291
 
                return inventory[file_id]
1292
 
            except errors.NoSuchId:
1293
 
                return None
1294
 
 
1295
 
    def _handle_precise_ids(self, precise_file_ids, changed_file_ids,
1296
 
        discarded_changes=None):
1297
 
        """Fill out a partial iter_changes to be consistent.
1298
 
 
1299
 
        :param precise_file_ids: The file ids of parents that were seen during
1300
 
            the iter_changes.
1301
 
        :param changed_file_ids: The file ids of already emitted items.
1302
 
        :param discarded_changes: An optional dict of precalculated
1303
 
            iter_changes items which the partial iter_changes had not output
1304
 
            but had calculated.
1305
 
        :return: A generator of iter_changes items to output.
1306
 
        """
1307
 
        # process parents of things that had changed under the users
1308
 
        # requested paths to prevent incorrect paths or parent ids which
1309
 
        # aren't in the tree.
1310
 
        while precise_file_ids:
1311
 
            precise_file_ids.discard(None)
1312
 
            # Don't emit file_ids twice
1313
 
            precise_file_ids.difference_update(changed_file_ids)
1314
 
            if not precise_file_ids:
1315
 
                break
1316
 
            # If the there was something at a given output path in source, we
1317
 
            # have to include the entry from source in the delta, or we would
1318
 
            # be putting this entry into a used path.
1319
 
            paths = []
1320
 
            for parent_id in precise_file_ids:
1321
 
                try:
1322
 
                    paths.append(self.target.id2path(parent_id))
1323
 
                except errors.NoSuchId:
1324
 
                    # This id has been dragged in from the source by delta
1325
 
                    # expansion and isn't present in target at all: we don't
1326
 
                    # need to check for path collisions on it.
1327
 
                    pass
1328
 
            for path in paths:
1329
 
                old_id = self.source.path2id(path)
1330
 
                precise_file_ids.add(old_id)
1331
 
            precise_file_ids.discard(None)
1332
 
            current_ids = precise_file_ids
1333
 
            precise_file_ids = set()
1334
 
            # We have to emit all of precise_file_ids that have been altered.
1335
 
            # We may have to output the children of some of those ids if any
1336
 
            # directories have stopped being directories.
1337
 
            for file_id in current_ids:
1338
 
                # Examine file_id
1339
 
                if discarded_changes:
1340
 
                    result = discarded_changes.get(file_id)
1341
 
                    old_entry = None
1342
 
                else:
1343
 
                    result = None
1344
 
                if result is None:
1345
 
                    old_entry = self._get_entry(self.source, file_id)
1346
 
                    new_entry = self._get_entry(self.target, file_id)
1347
 
                    result, changes = self._changes_from_entries(
1348
 
                        old_entry, new_entry)
1349
 
                else:
1350
 
                    changes = True
1351
 
                # Get this parents parent to examine.
1352
 
                new_parent_id = result[4][1]
1353
 
                precise_file_ids.add(new_parent_id)
1354
 
                if changes:
1355
 
                    if (result[6][0] == 'directory' and
1356
 
                        result[6][1] != 'directory'):
1357
 
                        # This stopped being a directory, the old children have
1358
 
                        # to be included.
1359
 
                        if old_entry is None:
1360
 
                            # Reusing a discarded change.
1361
 
                            old_entry = self._get_entry(self.source, file_id)
1362
 
                        precise_file_ids.update(
1363
 
                                self.source.iter_children(file_id))
1364
 
                    changed_file_ids.add(result[0])
1365
 
                    yield result
1366
 
 
1367
 
    @needs_read_lock
1368
 
    def file_content_matches(self, source_file_id, target_file_id,
1369
 
            source_path=None, target_path=None, source_stat=None, target_stat=None):
1370
 
        """Check if two files are the same in the source and target trees.
1371
 
 
1372
 
        This only checks that the contents of the files are the same,
1373
 
        it does not touch anything else.
1374
 
 
1375
 
        :param source_file_id: File id of the file in the source tree
1376
 
        :param target_file_id: File id of the file in the target tree
1377
 
        :param source_path: Path of the file in the source tree
1378
 
        :param target_path: Path of the file in the target tree
1379
 
        :param source_stat: Optional stat value of the file in the source tree
1380
 
        :param target_stat: Optional stat value of the file in the target tree
1381
 
        :return: Boolean indicating whether the files have the same contents
1382
 
        """
1383
 
        source_verifier_kind, source_verifier_data = self.source.get_file_verifier(
1384
 
            source_file_id, source_path, source_stat)
1385
 
        target_verifier_kind, target_verifier_data = self.target.get_file_verifier(
1386
 
            target_file_id, target_path, target_stat)
1387
 
        if source_verifier_kind == target_verifier_kind:
1388
 
            return (source_verifier_data == target_verifier_data)
1389
 
        # Fall back to SHA1 for now
1390
 
        if source_verifier_kind != "SHA1":
1391
 
            source_sha1 = self.source.get_file_sha1(source_file_id,
1392
 
                    source_path, source_stat)
1393
 
        else:
1394
 
            source_sha1 = source_verifier_data
1395
 
        if target_verifier_kind != "SHA1":
1396
 
            target_sha1 = self.target.get_file_sha1(target_file_id,
1397
 
                    target_path, target_stat)
1398
 
        else:
1399
 
            target_sha1 = target_verifier_data
1400
 
        return (source_sha1 == target_sha1)
1401
 
 
1402
 
InterTree.register_optimiser(InterTree)
1403
985
 
1404
986
 
1405
987
class MultiWalker(object):
1509
1091
            return (None, None)
1510
1092
        else:
1511
1093
            self._out_of_order_processed.add(file_id)
1512
 
            cur_ie = other_tree.root_inventory[file_id]
 
1094
            cur_ie = other_tree.inventory[file_id]
1513
1095
            return (cur_path, cur_ie)
1514
1096
 
1515
1097
    def iter_all(self):
1522
1104
 
1523
1105
    def _walk_master_tree(self):
1524
1106
        """First pass, walk all trees in lock-step.
1525
 
 
 
1107
        
1526
1108
        When we are done, all nodes in the master_tree will have been
1527
1109
        processed. _other_walkers, _other_entries, and _others_extra will be
1528
1110
        set on 'self' for future processing.