/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Jelmer Vernooij
  • Date: 2012-02-17 16:48:41 UTC
  • mto: This revision was merged to the branch mainline in revision 6470.
  • Revision ID: jelmer@samba.org-20120217164841-75by526tq3yagy8d
UseĀ .iter_entries_by_dir.

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
 
23
 
 
24
from bzrlib.lazy_import import lazy_import
 
25
lazy_import(globals(), """
 
26
import collections
 
27
 
24
28
from bzrlib 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
    )
 
40
from bzrlib.i18n import gettext
 
41
""")
 
42
 
33
43
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
44
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
 
45
from bzrlib.symbol_versioning import (
 
46
    deprecated_in,
 
47
    deprecated_method,
 
48
    )
41
49
 
42
50
 
43
51
class Tree(object):
49
57
 
50
58
    * `RevisionTree` is a tree as recorded at some point in the past.
51
59
 
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
60
    Trees can be compared, etc, regardless of whether they are working
60
61
    trees or versioned trees.
61
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
    def changes_from(self, other, want_unchanged=False, specific_files=None,
64
73
        extra_trees=None, require_versioned=False, include_root=False,
65
74
        want_unversioned=False):
127
136
        raise NotImplementedError(self.has_filename)
128
137
 
129
138
    def has_id(self, file_id):
130
 
        return self.inventory.has_id(file_id)
 
139
        raise NotImplementedError(self.has_id)
131
140
 
 
141
    @deprecated_method(deprecated_in((2, 4, 0)))
132
142
    def __contains__(self, file_id):
133
143
        return self.has_id(file_id)
134
144
 
135
145
    def has_or_had_id(self, file_id):
136
 
        return self.inventory.has_id(file_id)
 
146
        raise NotImplementedError(self.has_or_had_id)
137
147
 
138
148
    def is_ignored(self, filename):
139
149
        """Check whether the filename is ignored by this tree.
143
153
        """
144
154
        return False
145
155
 
146
 
    def __iter__(self):
147
 
        return iter(self.inventory)
148
 
 
149
156
    def all_file_ids(self):
150
157
        """Iterate through all file ids, including ids for missing files."""
151
 
        return set(self.inventory)
 
158
        raise NotImplementedError(self.all_file_ids)
152
159
 
153
160
    def id2path(self, file_id):
154
161
        """Return the path for a file id.
155
162
 
156
163
        :raises NoSuchId:
157
164
        """
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
 
165
        raise NotImplementedError(self.id2path)
 
166
 
173
167
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
174
168
        """Walk the tree in 'by_dir' order.
175
169
 
192
186
             g
193
187
 
194
188
        The yield order (ignoring root) would be::
 
189
 
195
190
          a, f, a/b, a/d, a/b/c, a/d/e, f/g
196
191
 
197
192
        :param yield_parents: If True, yield the parents from the root leading
198
193
            down to specific_file_ids that have been requested. This has no
199
194
            impact if specific_file_ids is None.
200
195
        """
201
 
        return self.inventory.iter_entries_by_dir(
202
 
            specific_file_ids=specific_file_ids, yield_parents=yield_parents)
 
196
        raise NotImplementedError(self.iter_entries_by_dir)
 
197
 
 
198
    def list_files(self, include_root=False, from_dir=None, recursive=True):
 
199
        """List all files in this tree.
 
200
 
 
201
        :param include_root: Whether to include the entry for the tree root
 
202
        :param from_dir: Directory under which to list files
 
203
        :param recursive: Whether to list files recursively
 
204
        :return: iterator over tuples of (path, versioned, kind, file_id,
 
205
            inventory entry)
 
206
        """
 
207
        raise NotImplementedError(self.list_files)
203
208
 
204
209
    def iter_references(self):
205
210
        if self.supports_tree_reference():
256
261
    def _file_size(self, entry, stat_value):
257
262
        raise NotImplementedError(self._file_size)
258
263
 
259
 
    def _get_inventory(self):
260
 
        return self._inventory
261
 
 
262
264
    def get_file(self, file_id, path=None):
263
265
        """Return a file object for the file file_id in the tree.
264
266
 
286
288
 
287
289
        :param file_id: The file_id of the file.
288
290
        :param path: The path of the file.
 
291
 
289
292
        If both file_id and path are supplied, an implementation may use
290
293
        either one.
 
294
 
 
295
        :returns: A single byte string for the whole file.
291
296
        """
292
297
        my_file = self.get_file(file_id, path)
293
298
        try:
300
305
 
301
306
        :param file_id: The file_id of the file.
302
307
        :param path: The path of the file.
 
308
 
303
309
        If both file_id and path are supplied, an implementation may use
304
310
        either one.
305
311
        """
306
312
        return osutils.split_lines(self.get_file_text(file_id, path))
307
313
 
 
314
    def get_file_verifier(self, file_id, path=None, stat_value=None):
 
315
        """Return a verifier for a file.
 
316
 
 
317
        The default implementation returns a sha1.
 
318
 
 
319
        :param file_id: The handle for this file.
 
320
        :param path: The path that this file can be found at.
 
321
            These must point to the same object.
 
322
        :param stat_value: Optional stat value for the object
 
323
        :return: Tuple with verifier name and verifier data
 
324
        """
 
325
        return ("SHA1", self.get_file_sha1(file_id, path=path,
 
326
            stat_value=stat_value))
 
327
 
 
328
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
329
        """Return the SHA1 file for a file.
 
330
 
 
331
        :note: callers should use get_file_verifier instead
 
332
            where possible, as the underlying repository implementation may
 
333
            have quicker access to a non-sha1 verifier.
 
334
 
 
335
        :param file_id: The handle for this file.
 
336
        :param path: The path that this file can be found at.
 
337
            These must point to the same object.
 
338
        :param stat_value: Optional stat value for the object
 
339
        """
 
340
        raise NotImplementedError(self.get_file_sha1)
 
341
 
308
342
    def get_file_mtime(self, file_id, path=None):
309
343
        """Return the modification time for a file.
310
344
 
323
357
        """
324
358
        raise NotImplementedError(self.get_file_size)
325
359
 
326
 
    def get_file_by_path(self, path):
327
 
        return self.get_file(self._inventory.path2id(path), path)
 
360
    def is_executable(self, file_id, path=None):
 
361
        """Check if a file is executable.
 
362
 
 
363
        :param file_id: The handle for this file.
 
364
        :param path: The path that this file can be found at.
 
365
            These must point to the same object.
 
366
        """
 
367
        raise NotImplementedError(self.is_executable)
328
368
 
329
369
    def iter_files_bytes(self, desired_files):
330
370
        """Iterate through file contents.
352
392
            cur_file = (self.get_file_text(file_id),)
353
393
            yield identifier, cur_file
354
394
 
355
 
    def get_symlink_target(self, file_id):
 
395
    def get_symlink_target(self, file_id, path=None):
356
396
        """Get the target for a given file_id.
357
397
 
358
398
        It is assumed that the caller already knows that file_id is referencing
359
399
        a symlink.
360
400
        :param file_id: Handle for the symlink entry.
 
401
        :param path: The path of the file.
 
402
        If both file_id and path are supplied, an implementation may use
 
403
        either one.
361
404
        :return: The path the symlink points to.
362
405
        """
363
406
        raise NotImplementedError(self.get_symlink_target)
364
407
 
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
408
    def get_root_id(self):
444
409
        """Return the file_id for the root of this tree."""
445
410
        raise NotImplementedError(self.get_root_id)
503
468
            except errors.NoSuchRevisionInTree:
504
469
                yield self.repository.revision_tree(revision_id)
505
470
 
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
471
    def _get_file_revision(self, file_id, vf, tree_revision):
516
472
        """Ensure that file_id, tree_revision is in vf to plan the merge."""
517
473
 
518
474
        if getattr(self, '_repository', None) is None:
519
475
            last_revision = tree_revision
520
 
            parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
 
476
            parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
521
477
                self._iter_parent_trees()]
522
478
            vf.add_lines((file_id, last_revision), parent_keys,
523
 
                         self.get_file(file_id).readlines())
 
479
                         self.get_file_lines(file_id))
524
480
            repo = self.branch.repository
525
481
            base_vf = repo.texts
526
482
        else:
527
 
            last_revision = self._file_revision(self, file_id)
 
483
            last_revision = self.get_file_revision(file_id)
528
484
            base_vf = self._repository.texts
529
485
        if base_vf not in vf.fallback_versionedfiles:
530
486
            vf.fallback_versionedfiles.append(base_vf)
531
487
        return last_revision
532
488
 
533
 
    inventory = property(_get_inventory,
534
 
                         doc="Inventory of this Tree")
535
 
 
536
489
    def _check_retrieved(self, ie, f):
537
490
        if not __debug__:
538
491
            return
539
 
        fp = fingerprint_file(f)
 
492
        fp = osutils.fingerprint_file(f)
540
493
        f.seek(0)
541
494
 
542
495
        if ie.text_size is not None:
543
496
            if ie.text_size != fp['size']:
544
 
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
 
497
                raise errors.BzrError(
 
498
                        "mismatched size for file %r in %r" %
 
499
                        (ie.file_id, self._store),
545
500
                        ["inventory expects %d bytes" % ie.text_size,
546
501
                         "file is actually %d bytes" % fp['size'],
547
502
                         "store is probably damaged/corrupt"])
548
503
 
549
504
        if ie.text_sha1 != fp['sha1']:
550
 
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
 
505
            raise errors.BzrError("wrong SHA-1 for file %r in %r" %
 
506
                    (ie.file_id, self._store),
551
507
                    ["inventory expects %s" % ie.text_sha1,
552
508
                     "file is actually %s" % fp['sha1'],
553
509
                     "store is probably damaged/corrupt"])
554
510
 
555
 
    @needs_read_lock
556
511
    def path2id(self, path):
557
512
        """Return the id for path in this tree."""
558
 
        return self._inventory.path2id(path)
 
513
        raise NotImplementedError(self.path2id)
559
514
 
560
515
    def paths2ids(self, paths, trees=[], require_versioned=True):
561
516
        """Return all the ids that can be reached by walking from paths.
582
537
            yield child.file_id
583
538
 
584
539
    def lock_read(self):
 
540
        """Lock this tree for multiple read only operations.
 
541
        
 
542
        :return: A bzrlib.lock.LogicalLockResult.
 
543
        """
585
544
        pass
586
545
 
587
546
    def revision_tree(self, revision_id):
614
573
 
615
574
        :return: set of paths.
616
575
        """
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)))
 
576
        raise NotImplementedError(self.filter_unversioned_files)
622
577
 
623
578
    def walkdirs(self, prefix=""):
624
579
        """Walk the contents of this tree from path down.
676
631
        prefs = self.iter_search_rules([path], filter_pref_names).next()
677
632
        stk = filters._get_filter_stack_for(prefs)
678
633
        if 'filters' in debug.debug_flags:
679
 
            note("*** %s content-filter: %s => %r" % (path,prefs,stk))
 
634
            trace.note(gettext("*** {0} content-filter: {1} => {2!r}").format(path,prefs,stk))
680
635
        return stk
681
636
 
682
637
    def _content_filter_stack_provider(self):
721
676
        return searcher
722
677
 
723
678
 
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.
 
679
class InventoryTree(Tree):
 
680
    """A tree that relies on an inventory for its metadata.
 
681
 
 
682
    Trees contain an `Inventory` object, and also know how to retrieve
 
683
    file texts mentioned in the inventory, either from a working
 
684
    directory or from a store.
 
685
 
 
686
    It is possible for trees to contain files that are not described
 
687
    in their inventory or vice versa; for this use `filenames()`.
 
688
 
 
689
    Subclasses should set the _inventory attribute, which is considered
 
690
    private to external API users.
740
691
    """
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)
 
692
 
 
693
    def get_canonical_inventory_paths(self, paths):
 
694
        """Like get_canonical_inventory_path() but works on multiple items.
 
695
 
 
696
        :param paths: A sequence of paths relative to the root of the tree.
 
697
        :return: A list of paths, with each item the corresponding input path
 
698
        adjusted to account for existing elements that match case
 
699
        insensitively.
 
700
        """
 
701
        return list(self._yield_canonical_inventory_paths(paths))
 
702
 
 
703
    def get_canonical_inventory_path(self, path):
 
704
        """Returns the first inventory item that case-insensitively matches path.
 
705
 
 
706
        If a path matches exactly, it is returned. If no path matches exactly
 
707
        but more than one path matches case-insensitively, it is implementation
 
708
        defined which is returned.
 
709
 
 
710
        If no path matches case-insensitively, the input path is returned, but
 
711
        with as many path entries that do exist changed to their canonical
 
712
        form.
 
713
 
 
714
        If you need to resolve many names from the same tree, you should
 
715
        use get_canonical_inventory_paths() to avoid O(N) behaviour.
 
716
 
 
717
        :param path: A paths relative to the root of the tree.
 
718
        :return: The input path adjusted to account for existing elements
 
719
        that match case insensitively.
 
720
        """
 
721
        return self._yield_canonical_inventory_paths([path]).next()
 
722
 
 
723
    def _yield_canonical_inventory_paths(self, paths):
 
724
        for path in paths:
 
725
            # First, if the path as specified exists exactly, just use it.
 
726
            if self.path2id(path) is not None:
 
727
                yield path
 
728
                continue
 
729
            # go walkin...
 
730
            cur_id = self.get_root_id()
 
731
            cur_path = ''
 
732
            bit_iter = iter(path.split("/"))
 
733
            for elt in bit_iter:
 
734
                lelt = elt.lower()
 
735
                new_path = None
 
736
                for child in self.iter_children(cur_id):
 
737
                    try:
 
738
                        # XXX: it seem like if the child is known to be in the
 
739
                        # tree, we shouldn't need to go from its id back to
 
740
                        # its path -- mbp 2010-02-11
 
741
                        #
 
742
                        # XXX: it seems like we could be more efficient
 
743
                        # by just directly looking up the original name and
 
744
                        # only then searching all children; also by not
 
745
                        # chopping paths so much. -- mbp 2010-02-11
 
746
                        child_base = os.path.basename(self.id2path(child))
 
747
                        if (child_base == elt):
 
748
                            # if we found an exact match, we can stop now; if
 
749
                            # we found an approximate match we need to keep
 
750
                            # searching because there might be an exact match
 
751
                            # later.  
 
752
                            cur_id = child
 
753
                            new_path = osutils.pathjoin(cur_path, child_base)
 
754
                            break
 
755
                        elif child_base.lower() == lelt:
 
756
                            cur_id = child
 
757
                            new_path = osutils.pathjoin(cur_path, child_base)
 
758
                    except errors.NoSuchId:
 
759
                        # before a change is committed we can see this error...
 
760
                        continue
 
761
                if new_path:
 
762
                    cur_path = new_path
 
763
                else:
 
764
                    # got to the end of this directory and no entries matched.
 
765
                    # Return what matched so far, plus the rest as specified.
 
766
                    cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
 
767
                    break
 
768
            yield cur_path
 
769
        # all done.
 
770
 
 
771
    @deprecated_method(deprecated_in((2, 5, 0)))
 
772
    def _get_inventory(self):
 
773
        return self._inventory
 
774
 
 
775
    inventory = property(_get_inventory,
 
776
                         doc="Inventory of this Tree")
 
777
 
 
778
    def _get_root_inventory(self):
 
779
        return self._inventory
 
780
 
 
781
    root_inventory = property(_get_root_inventory,
 
782
        doc="Root inventory of this tree")
 
783
 
 
784
    def _unpack_file_id(self, file_id):
 
785
        """Find the inventory and inventory file id for a tree file id.
 
786
 
 
787
        :param file_id: The tree file id, as bytestring or tuple
 
788
        :return: Inventory and inventory file id
 
789
        """
 
790
        if isinstance(file_id, tuple):
 
791
            if len(file_id) != 1:
 
792
                raise ValueError("nested trees not yet supported: %r" % file_id)
 
793
            file_id = file_id[0]
 
794
        return self.root_inventory, file_id
 
795
 
 
796
    @needs_read_lock
 
797
    def path2id(self, path):
 
798
        """Return the id for path in this tree."""
 
799
        return self._path2inv_file_id(path)[1]
 
800
 
 
801
    def _path2inv_file_id(self, path):
 
802
        """Lookup a inventory and inventory file id by path.
 
803
 
 
804
        :param path: Path to look up
 
805
        :return: tuple with inventory and inventory file id
 
806
        """
 
807
        # FIXME: Support nested trees
 
808
        return self.root_inventory, self.root_inventory.path2id(path)
 
809
 
 
810
    def id2path(self, file_id):
 
811
        """Return the path for a file id.
 
812
 
 
813
        :raises NoSuchId:
 
814
        """
 
815
        inventory, file_id = self._unpack_file_id(file_id)
 
816
        return inventory.id2path(file_id)
 
817
 
 
818
    def has_id(self, file_id):
 
819
        inventory, file_id = self._unpack_file_id(file_id)
 
820
        return inventory.has_id(file_id)
 
821
 
 
822
    def has_or_had_id(self, file_id):
 
823
        inventory, file_id = self._unpack_file_id(file_id)
 
824
        return inventory.has_id(file_id)
 
825
 
 
826
    def all_file_ids(self):
 
827
        return set(
 
828
            [entry.file_id for path, entry in self.iter_entries_by_dir()])
 
829
 
 
830
    @deprecated_method(deprecated_in((2, 4, 0)))
 
831
    def __iter__(self):
 
832
        return iter(self.all_file_ids())
 
833
 
 
834
    def filter_unversioned_files(self, paths):
 
835
        """Filter out paths that are versioned.
 
836
 
 
837
        :return: set of paths.
 
838
        """
 
839
        # NB: we specifically *don't* call self.has_filename, because for
 
840
        # WorkingTrees that can indicate files that exist on disk but that
 
841
        # are not versioned.
 
842
        return set((p for p in paths if self.path2id(p) is None))
 
843
 
 
844
    @needs_read_lock
 
845
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
 
846
        """Walk the tree in 'by_dir' order.
 
847
 
 
848
        This will yield each entry in the tree as a (path, entry) tuple.
 
849
        The order that they are yielded is:
 
850
 
 
851
        See Tree.iter_entries_by_dir for details.
 
852
 
 
853
        :param yield_parents: If True, yield the parents from the root leading
 
854
            down to specific_file_ids that have been requested. This has no
 
855
            impact if specific_file_ids is None.
 
856
        """
 
857
        if specific_file_ids is None:
 
858
            inventory_file_ids = None
 
859
        else:
 
860
            inventory_file_ids = []
 
861
            for tree_file_id in specific_file_ids:
 
862
                inventory, inv_file_id = self._unpack_file_id(tree_file_id)
 
863
                if not inventory is self.root_inventory: # for now
 
864
                    raise AssertionError("%r != %r" % (
 
865
                        inventory, self.root_inventory))
 
866
                inventory_file_ids.append(inv_file_id)
 
867
        # FIXME: Handle nested trees
 
868
        return self.root_inventory.iter_entries_by_dir(
 
869
            specific_file_ids=inventory_file_ids, yield_parents=yield_parents)
 
870
 
 
871
    @deprecated_method(deprecated_in((2, 5, 0)))
 
872
    def get_file_by_path(self, path):
 
873
        return self.get_file(self.path2id(path), path)
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:
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:
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."""
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):