/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 breezy/tree.py

  • Committer: Jelmer Vernooij
  • Author(s): Richard Wilbur
  • Date: 2017-05-30 23:37:11 UTC
  • mto: This revision was merged to the branch mainline in revision 6645.
  • Revision ID: jelmer@jelmer.uk-20170530233711-r0m0qp8hpkqzpopw
Fix order in which files are processed.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 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
17
17
"""Tree classes, representing directory at point in time.
18
18
"""
19
19
 
 
20
from __future__ import absolute_import
 
21
 
20
22
import os
21
 
from collections import deque
22
 
 
23
 
import bzrlib
24
 
from bzrlib import (
 
23
 
 
24
from .lazy_import import lazy_import
 
25
lazy_import(globals(), """
 
26
import collections
 
27
 
 
28
from breezy import (
25
29
    conflicts as _mod_conflicts,
26
30
    debug,
27
31
    delta,
 
32
    errors,
28
33
    filters,
 
34
    inventory,
29
35
    osutils,
30
36
    revision as _mod_revision,
31
37
    rules,
 
38
    trace,
32
39
    )
33
 
from bzrlib.decorators import needs_read_lock
34
 
from bzrlib.errors import BzrError, NoSuchId
35
 
from bzrlib import errors
36
 
from bzrlib.inventory import InventoryFile
37
 
from bzrlib.inter import InterObject
38
 
from bzrlib.osutils import fingerprint_file
39
 
from bzrlib.symbol_versioning import deprecated_function, deprecated_in
40
 
from bzrlib.trace import note
 
40
from breezy.i18n import gettext
 
41
""")
 
42
 
 
43
from .decorators import needs_read_lock
 
44
from .inter import InterObject
41
45
 
42
46
 
43
47
class Tree(object):
49
53
 
50
54
    * `RevisionTree` is a tree as recorded at some point in the past.
51
55
 
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
56
    Trees can be compared, etc, regardless of whether they are working
60
57
    trees or versioned trees.
61
58
    """
62
59
 
 
60
    def has_versioned_directories(self):
 
61
        """Whether this tree can contain explicitly versioned directories.
 
62
 
 
63
        This defaults to True, but some implementations may want to override
 
64
        it.
 
65
        """
 
66
        return True
 
67
 
63
68
    def changes_from(self, other, want_unchanged=False, specific_files=None,
64
69
        extra_trees=None, require_versioned=False, include_root=False,
65
70
        want_unversioned=False):
105
110
    def conflicts(self):
106
111
        """Get a list of the conflicts in the tree.
107
112
 
108
 
        Each conflict is an instance of bzrlib.conflicts.Conflict.
 
113
        Each conflict is an instance of breezy.conflicts.Conflict.
109
114
        """
110
115
        return _mod_conflicts.ConflictList()
111
116
 
127
132
        raise NotImplementedError(self.has_filename)
128
133
 
129
134
    def has_id(self, file_id):
130
 
        return self.inventory.has_id(file_id)
131
 
 
132
 
    def __contains__(self, file_id):
133
 
        return self.has_id(file_id)
 
135
        raise NotImplementedError(self.has_id)
134
136
 
135
137
    def has_or_had_id(self, file_id):
136
 
        return self.inventory.has_id(file_id)
 
138
        raise NotImplementedError(self.has_or_had_id)
137
139
 
138
140
    def is_ignored(self, filename):
139
141
        """Check whether the filename is ignored by this tree.
143
145
        """
144
146
        return False
145
147
 
146
 
    def __iter__(self):
147
 
        return iter(self.inventory)
148
 
 
149
148
    def all_file_ids(self):
150
149
        """Iterate through all file ids, including ids for missing files."""
151
 
        return set(self.inventory)
 
150
        raise NotImplementedError(self.all_file_ids)
152
151
 
153
152
    def id2path(self, file_id):
154
153
        """Return the path for a file id.
155
154
 
156
155
        :raises NoSuchId:
157
156
        """
158
 
        return self.inventory.id2path(file_id)
159
 
 
160
 
    def is_control_filename(self, filename):
161
 
        """True if filename is the name of a control file in this tree.
162
 
 
163
 
        :param filename: A filename within the tree. This is a relative path
164
 
        from the root of this tree.
165
 
 
166
 
        This is true IF and ONLY IF the filename is part of the meta data
167
 
        that bzr controls in this tree. I.E. a random .bzr directory placed
168
 
        on disk will not be a control file for this tree.
169
 
        """
170
 
        return self.bzrdir.is_control_filename(filename)
171
 
 
172
 
    @needs_read_lock
 
157
        raise NotImplementedError(self.id2path)
 
158
 
173
159
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
174
160
        """Walk the tree in 'by_dir' order.
175
161
 
192
178
             g
193
179
 
194
180
        The yield order (ignoring root) would be::
 
181
 
195
182
          a, f, a/b, a/d, a/b/c, a/d/e, f/g
196
183
 
197
184
        :param yield_parents: If True, yield the parents from the root leading
198
185
            down to specific_file_ids that have been requested. This has no
199
186
            impact if specific_file_ids is None.
200
187
        """
201
 
        return self.inventory.iter_entries_by_dir(
202
 
            specific_file_ids=specific_file_ids, yield_parents=yield_parents)
 
188
        raise NotImplementedError(self.iter_entries_by_dir)
 
189
 
 
190
    def iter_child_entries(self, file_id, path=None):
 
191
        """Iterate over the children of a directory or tree reference.
 
192
 
 
193
        :param file_id: File id of the directory/tree-reference
 
194
        :param path: Optional path of the directory
 
195
        :raise NoSuchId: When the file_id does not exist
 
196
        :return: Iterator over entries in the directory
 
197
        """
 
198
        raise NotImplementedError(self.iter_child_entries)
 
199
 
 
200
    def list_files(self, include_root=False, from_dir=None, recursive=True):
 
201
        """List all files in this tree.
 
202
 
 
203
        :param include_root: Whether to include the entry for the tree root
 
204
        :param from_dir: Directory under which to list files
 
205
        :param recursive: Whether to list files recursively
 
206
        :return: iterator over tuples of (path, versioned, kind, file_id,
 
207
            inventory entry)
 
208
        """
 
209
        raise NotImplementedError(self.list_files)
203
210
 
204
211
    def iter_references(self):
205
212
        if self.supports_tree_reference():
256
263
    def _file_size(self, entry, stat_value):
257
264
        raise NotImplementedError(self._file_size)
258
265
 
259
 
    def _get_inventory(self):
260
 
        return self._inventory
261
 
 
262
266
    def get_file(self, file_id, path=None):
263
267
        """Return a file object for the file file_id in the tree.
264
268
 
286
290
 
287
291
        :param file_id: The file_id of the file.
288
292
        :param path: The path of the file.
 
293
 
289
294
        If both file_id and path are supplied, an implementation may use
290
295
        either one.
 
296
 
 
297
        :returns: A single byte string for the whole file.
291
298
        """
292
299
        my_file = self.get_file(file_id, path)
293
300
        try:
300
307
 
301
308
        :param file_id: The file_id of the file.
302
309
        :param path: The path of the file.
 
310
 
303
311
        If both file_id and path are supplied, an implementation may use
304
312
        either one.
305
313
        """
306
314
        return osutils.split_lines(self.get_file_text(file_id, path))
307
315
 
 
316
    def get_file_verifier(self, file_id, path=None, stat_value=None):
 
317
        """Return a verifier for a file.
 
318
 
 
319
        The default implementation returns a sha1.
 
320
 
 
321
        :param file_id: The handle for this file.
 
322
        :param path: The path that this file can be found at.
 
323
            These must point to the same object.
 
324
        :param stat_value: Optional stat value for the object
 
325
        :return: Tuple with verifier name and verifier data
 
326
        """
 
327
        return ("SHA1", self.get_file_sha1(file_id, path=path,
 
328
            stat_value=stat_value))
 
329
 
 
330
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
331
        """Return the SHA1 file for a file.
 
332
 
 
333
        :note: callers should use get_file_verifier instead
 
334
            where possible, as the underlying repository implementation may
 
335
            have quicker access to a non-sha1 verifier.
 
336
 
 
337
        :param file_id: The handle for this file.
 
338
        :param path: The path that this file can be found at.
 
339
            These must point to the same object.
 
340
        :param stat_value: Optional stat value for the object
 
341
        """
 
342
        raise NotImplementedError(self.get_file_sha1)
 
343
 
308
344
    def get_file_mtime(self, file_id, path=None):
309
345
        """Return the modification time for a file.
310
346
 
323
359
        """
324
360
        raise NotImplementedError(self.get_file_size)
325
361
 
326
 
    def get_file_by_path(self, path):
327
 
        return self.get_file(self._inventory.path2id(path), path)
 
362
    def is_executable(self, file_id, path=None):
 
363
        """Check if a file is executable.
 
364
 
 
365
        :param file_id: The handle for this file.
 
366
        :param path: The path that this file can be found at.
 
367
            These must point to the same object.
 
368
        """
 
369
        raise NotImplementedError(self.is_executable)
328
370
 
329
371
    def iter_files_bytes(self, desired_files):
330
372
        """Iterate through file contents.
352
394
            cur_file = (self.get_file_text(file_id),)
353
395
            yield identifier, cur_file
354
396
 
355
 
    def get_symlink_target(self, file_id):
 
397
    def get_symlink_target(self, file_id, path=None):
356
398
        """Get the target for a given file_id.
357
399
 
358
400
        It is assumed that the caller already knows that file_id is referencing
359
401
        a symlink.
360
402
        :param file_id: Handle for the symlink entry.
 
403
        :param path: The path of the file.
 
404
        If both file_id and path are supplied, an implementation may use
 
405
        either one.
361
406
        :return: The path the symlink points to.
362
407
        """
363
408
        raise NotImplementedError(self.get_symlink_target)
364
409
 
365
 
    def get_canonical_inventory_paths(self, paths):
366
 
        """Like get_canonical_inventory_path() but works on multiple items.
367
 
 
368
 
        :param paths: A sequence of paths relative to the root of the tree.
369
 
        :return: A list of paths, with each item the corresponding input path
370
 
        adjusted to account for existing elements that match case
371
 
        insensitively.
372
 
        """
373
 
        return list(self._yield_canonical_inventory_paths(paths))
374
 
 
375
 
    def get_canonical_inventory_path(self, path):
376
 
        """Returns the first inventory item that case-insensitively matches path.
377
 
 
378
 
        If a path matches exactly, it is returned. If no path matches exactly
379
 
        but more than one path matches case-insensitively, it is implementation
380
 
        defined which is returned.
381
 
 
382
 
        If no path matches case-insensitively, the input path is returned, but
383
 
        with as many path entries that do exist changed to their canonical
384
 
        form.
385
 
 
386
 
        If you need to resolve many names from the same tree, you should
387
 
        use get_canonical_inventory_paths() to avoid O(N) behaviour.
388
 
 
389
 
        :param path: A paths relative to the root of the tree.
390
 
        :return: The input path adjusted to account for existing elements
391
 
        that match case insensitively.
392
 
        """
393
 
        return self._yield_canonical_inventory_paths([path]).next()
394
 
 
395
 
    def _yield_canonical_inventory_paths(self, paths):
396
 
        for path in paths:
397
 
            # First, if the path as specified exists exactly, just use it.
398
 
            if self.path2id(path) is not None:
399
 
                yield path
400
 
                continue
401
 
            # go walkin...
402
 
            cur_id = self.get_root_id()
403
 
            cur_path = ''
404
 
            bit_iter = iter(path.split("/"))
405
 
            for elt in bit_iter:
406
 
                lelt = elt.lower()
407
 
                new_path = None
408
 
                for child in self.iter_children(cur_id):
409
 
                    try:
410
 
                        # XXX: it seem like if the child is known to be in the
411
 
                        # tree, we shouldn't need to go from its id back to
412
 
                        # its path -- mbp 2010-02-11
413
 
                        #
414
 
                        # XXX: it seems like we could be more efficient
415
 
                        # by just directly looking up the original name and
416
 
                        # only then searching all children; also by not
417
 
                        # chopping paths so much. -- mbp 2010-02-11
418
 
                        child_base = os.path.basename(self.id2path(child))
419
 
                        if (child_base == elt):
420
 
                            # if we found an exact match, we can stop now; if
421
 
                            # we found an approximate match we need to keep
422
 
                            # searching because there might be an exact match
423
 
                            # later.  
424
 
                            cur_id = child
425
 
                            new_path = osutils.pathjoin(cur_path, child_base)
426
 
                            break
427
 
                        elif child_base.lower() == lelt:
428
 
                            cur_id = child
429
 
                            new_path = osutils.pathjoin(cur_path, child_base)
430
 
                    except NoSuchId:
431
 
                        # before a change is committed we can see this error...
432
 
                        continue
433
 
                if new_path:
434
 
                    cur_path = new_path
435
 
                else:
436
 
                    # got to the end of this directory and no entries matched.
437
 
                    # Return what matched so far, plus the rest as specified.
438
 
                    cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
439
 
                    break
440
 
            yield cur_path
441
 
        # all done.
442
 
 
443
410
    def get_root_id(self):
444
411
        """Return the file_id for the root of this tree."""
445
412
        raise NotImplementedError(self.get_root_id)
459
426
        raise NotImplementedError(self.annotate_iter)
460
427
 
461
428
    def _get_plan_merge_data(self, file_id, other, base):
462
 
        from bzrlib import versionedfile
 
429
        from breezy import versionedfile
463
430
        vf = versionedfile._PlanMergeVersionedFile(file_id)
464
431
        last_revision_a = self._get_file_revision(file_id, vf, 'this:')
465
432
        last_revision_b = other._get_file_revision(file_id, vf, 'other:')
503
470
            except errors.NoSuchRevisionInTree:
504
471
                yield self.repository.revision_tree(revision_id)
505
472
 
506
 
    @staticmethod
507
 
    def _file_revision(revision_tree, file_id):
508
 
        """Determine the revision associated with a file in a given tree."""
509
 
        revision_tree.lock_read()
510
 
        try:
511
 
            return revision_tree.inventory[file_id].revision
512
 
        finally:
513
 
            revision_tree.unlock()
514
 
 
515
473
    def _get_file_revision(self, file_id, vf, tree_revision):
516
474
        """Ensure that file_id, tree_revision is in vf to plan the merge."""
517
475
 
518
476
        if getattr(self, '_repository', None) is None:
519
477
            last_revision = tree_revision
520
 
            parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
 
478
            parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
521
479
                self._iter_parent_trees()]
522
480
            vf.add_lines((file_id, last_revision), parent_keys,
523
 
                         self.get_file(file_id).readlines())
 
481
                         self.get_file_lines(file_id))
524
482
            repo = self.branch.repository
525
483
            base_vf = repo.texts
526
484
        else:
527
 
            last_revision = self._file_revision(self, file_id)
 
485
            last_revision = self.get_file_revision(file_id)
528
486
            base_vf = self._repository.texts
529
487
        if base_vf not in vf.fallback_versionedfiles:
530
488
            vf.fallback_versionedfiles.append(base_vf)
531
489
        return last_revision
532
490
 
533
 
    inventory = property(_get_inventory,
534
 
                         doc="Inventory of this Tree")
535
 
 
536
491
    def _check_retrieved(self, ie, f):
537
492
        if not __debug__:
538
493
            return
539
 
        fp = fingerprint_file(f)
 
494
        fp = osutils.fingerprint_file(f)
540
495
        f.seek(0)
541
496
 
542
497
        if ie.text_size is not None:
543
498
            if ie.text_size != fp['size']:
544
 
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
 
499
                raise errors.BzrError(
 
500
                        "mismatched size for file %r in %r" %
 
501
                        (ie.file_id, self._store),
545
502
                        ["inventory expects %d bytes" % ie.text_size,
546
503
                         "file is actually %d bytes" % fp['size'],
547
504
                         "store is probably damaged/corrupt"])
548
505
 
549
506
        if ie.text_sha1 != fp['sha1']:
550
 
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
 
507
            raise errors.BzrError("wrong SHA-1 for file %r in %r" %
 
508
                    (ie.file_id, self._store),
551
509
                    ["inventory expects %s" % ie.text_sha1,
552
510
                     "file is actually %s" % fp['sha1'],
553
511
                     "store is probably damaged/corrupt"])
554
512
 
555
 
    @needs_read_lock
556
513
    def path2id(self, path):
557
514
        """Return the id for path in this tree."""
558
 
        return self._inventory.path2id(path)
 
515
        raise NotImplementedError(self.path2id)
559
516
 
560
517
    def paths2ids(self, paths, trees=[], require_versioned=True):
561
518
        """Return all the ids that can be reached by walking from paths.
577
534
        return find_ids_across_trees(paths, [self] + list(trees), require_versioned)
578
535
 
579
536
    def iter_children(self, file_id):
580
 
        entry = self.iter_entries_by_dir([file_id]).next()[1]
581
 
        for child in getattr(entry, 'children', {}).itervalues():
582
 
            yield child.file_id
 
537
        """Iterate over the file ids of the children of an entry.
 
538
 
 
539
        :param file_id: File id of the entry
 
540
        :return: Iterator over child file ids.
 
541
        """
 
542
        raise NotImplementedError(self.iter_children)
583
543
 
584
544
    def lock_read(self):
 
545
        """Lock this tree for multiple read only operations.
 
546
 
 
547
        :return: A breezy.lock.LogicalLockResult.
 
548
        """
585
549
        pass
586
550
 
587
551
    def revision_tree(self, revision_id):
614
578
 
615
579
        :return: set of paths.
616
580
        """
617
 
        # NB: we specifically *don't* call self.has_filename, because for
618
 
        # WorkingTrees that can indicate files that exist on disk but that
619
 
        # are not versioned.
620
 
        pred = self.inventory.has_filename
621
 
        return set((p for p in paths if not pred(p)))
 
581
        raise NotImplementedError(self.filter_unversioned_files)
622
582
 
623
583
    def walkdirs(self, prefix=""):
624
584
        """Walk the contents of this tree from path down.
673
633
            return []
674
634
        if path is None:
675
635
            path = self.id2path(file_id)
676
 
        prefs = self.iter_search_rules([path], filter_pref_names).next()
 
636
        prefs = next(self.iter_search_rules([path], filter_pref_names))
677
637
        stk = filters._get_filter_stack_for(prefs)
678
638
        if 'filters' in debug.debug_flags:
679
 
            note("*** %s content-filter: %s => %r" % (path,prefs,stk))
 
639
            trace.note(gettext("*** {0} content-filter: {1} => {2!r}").format(path,prefs,stk))
680
640
        return stk
681
641
 
682
642
    def _content_filter_stack_provider(self):
721
681
        return searcher
722
682
 
723
683
 
724
 
######################################################################
725
 
# diff
726
 
 
727
 
# TODO: Merge these two functions into a single one that can operate
728
 
# on either a whole tree or a set of files.
729
 
 
730
 
# TODO: Return the diff in order by filename, not by category or in
731
 
# random order.  Can probably be done by lock-stepping through the
732
 
# filenames from both trees.
733
 
 
734
 
 
735
 
def file_status(filename, old_tree, new_tree):
736
 
    """Return single-letter status, old and new names for a file.
737
 
 
738
 
    The complexity here is in deciding how to represent renames;
739
 
    many complex cases are possible.
 
684
class InventoryTree(Tree):
 
685
    """A tree that relies on an inventory for its metadata.
 
686
 
 
687
    Trees contain an `Inventory` object, and also know how to retrieve
 
688
    file texts mentioned in the inventory, either from a working
 
689
    directory or from a store.
 
690
 
 
691
    It is possible for trees to contain files that are not described
 
692
    in their inventory or vice versa; for this use `filenames()`.
 
693
 
 
694
    Subclasses should set the _inventory attribute, which is considered
 
695
    private to external API users.
740
696
    """
741
 
    old_inv = old_tree.inventory
742
 
    new_inv = new_tree.inventory
743
 
    new_id = new_inv.path2id(filename)
744
 
    old_id = old_inv.path2id(filename)
745
 
 
746
 
    if not new_id and not old_id:
747
 
        # easy: doesn't exist in either; not versioned at all
748
 
        if new_tree.is_ignored(filename):
749
 
            return 'I', None, None
750
 
        else:
751
 
            return '?', None, None
752
 
    elif new_id:
753
 
        # There is now a file of this name, great.
754
 
        pass
755
 
    else:
756
 
        # There is no longer a file of this name, but we can describe
757
 
        # what happened to the file that used to have
758
 
        # this name.  There are two possibilities: either it was
759
 
        # deleted entirely, or renamed.
760
 
        if new_inv.has_id(old_id):
761
 
            return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
762
 
        else:
763
 
            return 'D', old_inv.id2path(old_id), None
764
 
 
765
 
    # if the file_id is new in this revision, it is added
766
 
    if new_id and not old_inv.has_id(new_id):
767
 
        return 'A'
768
 
 
769
 
    # if there used to be a file of this name, but that ID has now
770
 
    # disappeared, it is deleted
771
 
    if old_id and not new_inv.has_id(old_id):
772
 
        return 'D'
773
 
 
774
 
    return 'wtf?'
775
 
 
776
 
 
777
 
@deprecated_function(deprecated_in((1, 9, 0)))
778
 
def find_renames(old_inv, new_inv):
779
 
    for file_id in old_inv:
780
 
        if file_id not in new_inv:
781
 
            continue
782
 
        old_name = old_inv.id2path(file_id)
783
 
        new_name = new_inv.id2path(file_id)
784
 
        if old_name != new_name:
785
 
            yield (old_name, new_name)
 
697
 
 
698
    def get_canonical_inventory_paths(self, paths):
 
699
        """Like get_canonical_inventory_path() but works on multiple items.
 
700
 
 
701
        :param paths: A sequence of paths relative to the root of the tree.
 
702
        :return: A list of paths, with each item the corresponding input path
 
703
        adjusted to account for existing elements that match case
 
704
        insensitively.
 
705
        """
 
706
        return list(self._yield_canonical_inventory_paths(paths))
 
707
 
 
708
    def get_canonical_inventory_path(self, path):
 
709
        """Returns the first inventory item that case-insensitively matches path.
 
710
 
 
711
        If a path matches exactly, it is returned. If no path matches exactly
 
712
        but more than one path matches case-insensitively, it is implementation
 
713
        defined which is returned.
 
714
 
 
715
        If no path matches case-insensitively, the input path is returned, but
 
716
        with as many path entries that do exist changed to their canonical
 
717
        form.
 
718
 
 
719
        If you need to resolve many names from the same tree, you should
 
720
        use get_canonical_inventory_paths() to avoid O(N) behaviour.
 
721
 
 
722
        :param path: A paths relative to the root of the tree.
 
723
        :return: The input path adjusted to account for existing elements
 
724
        that match case insensitively.
 
725
        """
 
726
        return next(self._yield_canonical_inventory_paths([path]))
 
727
 
 
728
    def _yield_canonical_inventory_paths(self, paths):
 
729
        for path in paths:
 
730
            # First, if the path as specified exists exactly, just use it.
 
731
            if self.path2id(path) is not None:
 
732
                yield path
 
733
                continue
 
734
            # go walkin...
 
735
            cur_id = self.get_root_id()
 
736
            cur_path = ''
 
737
            bit_iter = iter(path.split("/"))
 
738
            for elt in bit_iter:
 
739
                lelt = elt.lower()
 
740
                new_path = None
 
741
                for child in self.iter_children(cur_id):
 
742
                    try:
 
743
                        # XXX: it seem like if the child is known to be in the
 
744
                        # tree, we shouldn't need to go from its id back to
 
745
                        # its path -- mbp 2010-02-11
 
746
                        #
 
747
                        # XXX: it seems like we could be more efficient
 
748
                        # by just directly looking up the original name and
 
749
                        # only then searching all children; also by not
 
750
                        # chopping paths so much. -- mbp 2010-02-11
 
751
                        child_base = os.path.basename(self.id2path(child))
 
752
                        if (child_base == elt):
 
753
                            # if we found an exact match, we can stop now; if
 
754
                            # we found an approximate match we need to keep
 
755
                            # searching because there might be an exact match
 
756
                            # later.  
 
757
                            cur_id = child
 
758
                            new_path = osutils.pathjoin(cur_path, child_base)
 
759
                            break
 
760
                        elif child_base.lower() == lelt:
 
761
                            cur_id = child
 
762
                            new_path = osutils.pathjoin(cur_path, child_base)
 
763
                    except errors.NoSuchId:
 
764
                        # before a change is committed we can see this error...
 
765
                        continue
 
766
                if new_path:
 
767
                    cur_path = new_path
 
768
                else:
 
769
                    # got to the end of this directory and no entries matched.
 
770
                    # Return what matched so far, plus the rest as specified.
 
771
                    cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
 
772
                    break
 
773
            yield cur_path
 
774
        # all done.
 
775
 
 
776
    def _get_root_inventory(self):
 
777
        return self._inventory
 
778
 
 
779
    root_inventory = property(_get_root_inventory,
 
780
        doc="Root inventory of this tree")
 
781
 
 
782
    def _unpack_file_id(self, file_id):
 
783
        """Find the inventory and inventory file id for a tree file id.
 
784
 
 
785
        :param file_id: The tree file id, as bytestring or tuple
 
786
        :return: Inventory and inventory file id
 
787
        """
 
788
        if isinstance(file_id, tuple):
 
789
            if len(file_id) != 1:
 
790
                raise ValueError("nested trees not yet supported: %r" % file_id)
 
791
            file_id = file_id[0]
 
792
        return self.root_inventory, file_id
 
793
 
 
794
    @needs_read_lock
 
795
    def path2id(self, path):
 
796
        """Return the id for path in this tree."""
 
797
        return self._path2inv_file_id(path)[1]
 
798
 
 
799
    def _path2inv_file_id(self, path):
 
800
        """Lookup a inventory and inventory file id by path.
 
801
 
 
802
        :param path: Path to look up
 
803
        :return: tuple with inventory and inventory file id
 
804
        """
 
805
        # FIXME: Support nested trees
 
806
        return self.root_inventory, self.root_inventory.path2id(path)
 
807
 
 
808
    def id2path(self, file_id):
 
809
        """Return the path for a file id.
 
810
 
 
811
        :raises NoSuchId:
 
812
        """
 
813
        inventory, file_id = self._unpack_file_id(file_id)
 
814
        return inventory.id2path(file_id)
 
815
 
 
816
    def has_id(self, file_id):
 
817
        inventory, file_id = self._unpack_file_id(file_id)
 
818
        return inventory.has_id(file_id)
 
819
 
 
820
    def has_or_had_id(self, file_id):
 
821
        inventory, file_id = self._unpack_file_id(file_id)
 
822
        return inventory.has_id(file_id)
 
823
 
 
824
    def all_file_ids(self):
 
825
        return {entry.file_id for path, entry in self.iter_entries_by_dir()}
 
826
 
 
827
    def filter_unversioned_files(self, paths):
 
828
        """Filter out paths that are versioned.
 
829
 
 
830
        :return: set of paths.
 
831
        """
 
832
        # NB: we specifically *don't* call self.has_filename, because for
 
833
        # WorkingTrees that can indicate files that exist on disk but that
 
834
        # are not versioned.
 
835
        return set((p for p in paths if self.path2id(p) is None))
 
836
 
 
837
    @needs_read_lock
 
838
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
 
839
        """Walk the tree in 'by_dir' order.
 
840
 
 
841
        This will yield each entry in the tree as a (path, entry) tuple.
 
842
        The order that they are yielded is:
 
843
 
 
844
        See Tree.iter_entries_by_dir for details.
 
845
 
 
846
        :param yield_parents: If True, yield the parents from the root leading
 
847
            down to specific_file_ids that have been requested. This has no
 
848
            impact if specific_file_ids is None.
 
849
        """
 
850
        if specific_file_ids is None:
 
851
            inventory_file_ids = None
 
852
        else:
 
853
            inventory_file_ids = []
 
854
            for tree_file_id in specific_file_ids:
 
855
                inventory, inv_file_id = self._unpack_file_id(tree_file_id)
 
856
                if not inventory is self.root_inventory: # for now
 
857
                    raise AssertionError("%r != %r" % (
 
858
                        inventory, self.root_inventory))
 
859
                inventory_file_ids.append(inv_file_id)
 
860
        # FIXME: Handle nested trees
 
861
        return self.root_inventory.iter_entries_by_dir(
 
862
            specific_file_ids=inventory_file_ids, yield_parents=yield_parents)
 
863
 
 
864
    @needs_read_lock
 
865
    def iter_child_entries(self, file_id, path=None):
 
866
        inv, inv_file_id = self._unpack_file_id(file_id)
 
867
        return inv[inv_file_id].children.itervalues()
 
868
 
 
869
    def iter_children(self, file_id, path=None):
 
870
        """See Tree.iter_children."""
 
871
        entry = self.iter_entries_by_dir([file_id]).next()[1]
 
872
        for child in getattr(entry, 'children', {}).itervalues():
 
873
            yield child.file_id
786
874
 
787
875
 
788
876
def find_ids_across_trees(filenames, trees, require_versioned=True):
795
883
        None)
796
884
    :param trees: The trees to find file_ids within
797
885
    :param require_versioned: if true, all specified filenames must occur in
798
 
    at least one tree.
 
886
        at least one tree.
799
887
    :return: a set of file ids for the specified filenames and their children.
800
888
    """
801
889
    if not filenames:
864
952
    Its instances have methods like 'compare' and contain references to the
865
953
    source and target trees these operations are to be carried out on.
866
954
 
867
 
    Clients of bzrlib should not need to use InterTree directly, rather they
 
955
    Clients of breezy should not need to use InterTree directly, rather they
868
956
    should use the convenience methods on Tree such as 'Tree.compare()' which
869
957
    will pass through to InterTree as appropriate.
870
958
    """
877
965
 
878
966
    _optimisers = []
879
967
 
 
968
    @classmethod
 
969
    def is_compatible(kls, source, target):
 
970
        # The default implementation is naive and uses the public API, so
 
971
        # it works for all trees.
 
972
        return True
 
973
 
880
974
    def _changes_from_entries(self, source_entry, target_entry,
881
975
        source_path=None, target_path=None):
882
976
        """Generate a iter_changes tuple between source_entry and target_entry.
930
1024
        if source_kind != target_kind:
931
1025
            changed_content = True
932
1026
        elif source_kind == 'file':
933
 
            if (self.source.get_file_sha1(file_id, source_path, source_stat) !=
934
 
                self.target.get_file_sha1(file_id, target_path, target_stat)):
 
1027
            if not self.file_content_matches(file_id, file_id, source_path,
 
1028
                    target_path, source_stat, target_stat):
935
1029
                changed_content = True
936
1030
        elif source_kind == 'symlink':
937
1031
            if (self.source.get_symlink_target(file_id) !=
938
1032
                self.target.get_symlink_target(file_id)):
939
1033
                changed_content = True
940
 
            # XXX: Yes, the indentation below is wrong. But fixing it broke
941
 
            # test_merge.TestMergerEntriesLCAOnDisk.
942
 
            # test_nested_tree_subtree_renamed_and_modified. We'll wait for
943
 
            # the fix from bzr.dev -- vila 2009026
944
 
            elif source_kind == 'tree-reference':
945
 
                if (self.source.get_reference_revision(file_id, source_path)
946
 
                    != self.target.get_reference_revision(file_id, target_path)):
 
1034
        elif source_kind == 'tree-reference':
 
1035
            if (self.source.get_reference_revision(file_id, source_path)
 
1036
                != self.target.get_reference_revision(file_id, target_path)):
947
1037
                    changed_content = True
948
1038
        parent = (source_parent, target_parent)
949
1039
        name = (source_name, target_name)
987
1077
            # All files are unversioned, so just return an empty delta
988
1078
            # _compare_trees would think we want a complete delta
989
1079
            result = delta.TreeDelta()
990
 
            fake_entry = InventoryFile('unused', 'unused', 'unused')
 
1080
            fake_entry = inventory.InventoryFile('unused', 'unused', 'unused')
991
1081
            result.unversioned = [(path, None,
992
1082
                self.target._comparison_data(fake_entry, path)[0]) for path in
993
1083
                specific_files]
1058
1148
                                     self.target.extras()
1059
1149
                if specific_files is None or
1060
1150
                    osutils.is_inside_any(specific_files, p)])
1061
 
            all_unversioned = deque(all_unversioned)
 
1151
            all_unversioned = collections.deque(all_unversioned)
1062
1152
        else:
1063
 
            all_unversioned = deque()
 
1153
            all_unversioned = collections.deque()
1064
1154
        to_paths = {}
1065
1155
        from_entries_by_dir = list(self.source.iter_entries_by_dir(
1066
1156
            specific_file_ids=specific_file_ids))
1072
1162
        # the unversioned path lookup only occurs on real trees - where there
1073
1163
        # can be extras. So the fake_entry is solely used to look up
1074
1164
        # executable it values when execute is not supported.
1075
 
        fake_entry = InventoryFile('unused', 'unused', 'unused')
 
1165
        fake_entry = inventory.InventoryFile('unused', 'unused', 'unused')
1076
1166
        for target_path, target_entry in to_entries_by_dir:
1077
1167
            while (all_unversioned and
1078
1168
                all_unversioned[0][0] < target_path.split('/')):
1126
1216
            if file_id in to_paths:
1127
1217
                # already returned
1128
1218
                continue
1129
 
            if file_id not in self.target.all_file_ids():
 
1219
            if not self.target.has_id(file_id):
1130
1220
                # common case - paths we have not emitted are not present in
1131
1221
                # target.
1132
1222
                to_path = None
1164
1254
        :param file_id: The file_id to lookup.
1165
1255
        """
1166
1256
        try:
1167
 
            inventory = tree.inventory
 
1257
            inventory = tree.root_inventory
1168
1258
        except NotImplementedError:
1169
1259
            # No inventory available.
1170
1260
            try:
1245
1335
                        if old_entry is None:
1246
1336
                            # Reusing a discarded change.
1247
1337
                            old_entry = self._get_entry(self.source, file_id)
1248
 
                        for child in old_entry.children.values():
1249
 
                            precise_file_ids.add(child.file_id)
 
1338
                        precise_file_ids.update(
 
1339
                                self.source.iter_children(file_id))
1250
1340
                    changed_file_ids.add(result[0])
1251
1341
                    yield result
1252
1342
 
 
1343
    @needs_read_lock
 
1344
    def file_content_matches(self, source_file_id, target_file_id,
 
1345
            source_path=None, target_path=None, source_stat=None, target_stat=None):
 
1346
        """Check if two files are the same in the source and target trees.
 
1347
 
 
1348
        This only checks that the contents of the files are the same,
 
1349
        it does not touch anything else.
 
1350
 
 
1351
        :param source_file_id: File id of the file in the source tree
 
1352
        :param target_file_id: File id of the file in the target tree
 
1353
        :param source_path: Path of the file in the source tree
 
1354
        :param target_path: Path of the file in the target tree
 
1355
        :param source_stat: Optional stat value of the file in the source tree
 
1356
        :param target_stat: Optional stat value of the file in the target tree
 
1357
        :return: Boolean indicating whether the files have the same contents
 
1358
        """
 
1359
        source_verifier_kind, source_verifier_data = self.source.get_file_verifier(
 
1360
            source_file_id, source_path, source_stat)
 
1361
        target_verifier_kind, target_verifier_data = self.target.get_file_verifier(
 
1362
            target_file_id, target_path, target_stat)
 
1363
        if source_verifier_kind == target_verifier_kind:
 
1364
            return (source_verifier_data == target_verifier_data)
 
1365
        # Fall back to SHA1 for now
 
1366
        if source_verifier_kind != "SHA1":
 
1367
            source_sha1 = self.source.get_file_sha1(source_file_id,
 
1368
                    source_path, source_stat)
 
1369
        else:
 
1370
            source_sha1 = source_verifier_data
 
1371
        if target_verifier_kind != "SHA1":
 
1372
            target_sha1 = self.target.get_file_sha1(target_file_id,
 
1373
                    target_path, target_stat)
 
1374
        else:
 
1375
            target_sha1 = target_verifier_data
 
1376
        return (source_sha1 == target_sha1)
 
1377
 
 
1378
InterTree.register_optimiser(InterTree)
 
1379
 
1253
1380
 
1254
1381
class MultiWalker(object):
1255
1382
    """Walk multiple trees simultaneously, getting combined results."""
1289
1416
            If has_more is False, path and ie will be None.
1290
1417
        """
1291
1418
        try:
1292
 
            path, ie = iterator.next()
 
1419
            path, ie = next(iterator)
1293
1420
        except StopIteration:
1294
1421
            return False, None, None
1295
1422
        else:
1358
1485
            return (None, None)
1359
1486
        else:
1360
1487
            self._out_of_order_processed.add(file_id)
1361
 
            cur_ie = other_tree.inventory[file_id]
 
1488
            cur_ie = other_tree.root_inventory[file_id]
1362
1489
            return (cur_path, cur_ie)
1363
1490
 
1364
1491
    def iter_all(self):