~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: 2010-03-25 00:02:51 UTC
  • mfrom: (5106.1.1 version-bump)
  • Revision ID: pqm@pqm.ubuntu.com-20100325000251-bwsv5c5d3l9x3lnn
(Jelmer) Bump API version for 2.2.0.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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
 
 
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
 
 
23
import bzrlib
28
24
from bzrlib import (
29
25
    conflicts as _mod_conflicts,
30
26
    debug,
31
27
    delta,
32
 
    errors,
33
28
    filters,
34
 
    inventory,
35
29
    osutils,
36
30
    revision as _mod_revision,
37
31
    rules,
38
 
    trace,
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, NoSuchId
 
35
from bzrlib import errors
 
36
from bzrlib.inventory import 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 note
49
42
 
50
43
 
51
44
class Tree(object):
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
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
 
 
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):
136
128
        raise NotImplementedError(self.has_filename)
137
129
 
138
130
    def has_id(self, file_id):
139
 
        raise NotImplementedError(self.has_id)
 
131
        return self.inventory.has_id(file_id)
140
132
 
141
 
    @deprecated_method(deprecated_in((2, 4, 0)))
142
133
    def __contains__(self, file_id):
143
134
        return self.has_id(file_id)
144
135
 
145
136
    def has_or_had_id(self, file_id):
146
 
        raise NotImplementedError(self.has_or_had_id)
 
137
        return self.inventory.has_id(file_id)
147
138
 
148
139
    def is_ignored(self, filename):
149
140
        """Check whether the filename is ignored by this tree.
153
144
        """
154
145
        return False
155
146
 
 
147
    def __iter__(self):
 
148
        return iter(self.inventory)
 
149
 
156
150
    def all_file_ids(self):
157
151
        """Iterate through all file ids, including ids for missing files."""
158
 
        raise NotImplementedError(self.all_file_ids)
 
152
        return set(self.inventory)
159
153
 
160
154
    def id2path(self, file_id):
161
155
        """Return the path for a file id.
162
156
 
163
157
        :raises NoSuchId:
164
158
        """
165
 
        raise NotImplementedError(self.id2path)
166
 
 
 
159
        return self.inventory.id2path(file_id)
 
160
 
 
161
    def is_control_filename(self, filename):
 
162
        """True if filename is the name of a control file in this tree.
 
163
 
 
164
        :param filename: A filename within the tree. This is a relative path
 
165
        from the root of this tree.
 
166
 
 
167
        This is true IF and ONLY IF the filename is part of the meta data
 
168
        that bzr controls in this tree. I.E. a random .bzr directory placed
 
169
        on disk will not be a control file for this tree.
 
170
        """
 
171
        return self.bzrdir.is_control_filename(filename)
 
172
 
 
173
    @needs_read_lock
167
174
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
168
175
        """Walk the tree in 'by_dir' order.
169
176
 
186
193
             g
187
194
 
188
195
        The yield order (ignoring root) would be::
189
 
 
190
196
          a, f, a/b, a/d, a/b/c, a/d/e, f/g
191
197
 
192
198
        :param yield_parents: If True, yield the parents from the root leading
193
199
            down to specific_file_ids that have been requested. This has no
194
200
            impact if specific_file_ids is None.
195
201
        """
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
        return self.inventory.iter_entries_by_dir(
 
203
            specific_file_ids=specific_file_ids, yield_parents=yield_parents)
218
204
 
219
205
    def iter_references(self):
220
206
        if self.supports_tree_reference():
271
257
    def _file_size(self, entry, stat_value):
272
258
        raise NotImplementedError(self._file_size)
273
259
 
 
260
    def _get_inventory(self):
 
261
        return self._inventory
 
262
 
274
263
    def get_file(self, file_id, path=None):
275
264
        """Return a file object for the file file_id in the tree.
276
265
 
298
287
 
299
288
        :param file_id: The file_id of the file.
300
289
        :param path: The path of the file.
301
 
 
302
290
        If both file_id and path are supplied, an implementation may use
303
291
        either one.
304
 
 
305
 
        :returns: A single byte string for the whole file.
306
292
        """
307
293
        my_file = self.get_file(file_id, path)
308
294
        try:
315
301
 
316
302
        :param file_id: The file_id of the file.
317
303
        :param path: The path of the file.
318
 
 
319
304
        If both file_id and path are supplied, an implementation may use
320
305
        either one.
321
306
        """
322
307
        return osutils.split_lines(self.get_file_text(file_id, path))
323
308
 
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
309
    def get_file_mtime(self, file_id, path=None):
353
310
        """Return the modification time for a file.
354
311
 
367
324
        """
368
325
        raise NotImplementedError(self.get_file_size)
369
326
 
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)
 
327
    def get_file_by_path(self, path):
 
328
        return self.get_file(self._inventory.path2id(path), path)
378
329
 
379
330
    def iter_files_bytes(self, desired_files):
380
331
        """Iterate through file contents.
402
353
            cur_file = (self.get_file_text(file_id),)
403
354
            yield identifier, cur_file
404
355
 
405
 
    def get_symlink_target(self, file_id, path=None):
 
356
    def get_symlink_target(self, file_id):
406
357
        """Get the target for a given file_id.
407
358
 
408
359
        It is assumed that the caller already knows that file_id is referencing
409
360
        a symlink.
410
361
        :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
362
        :return: The path the symlink points to.
415
363
        """
416
364
        raise NotImplementedError(self.get_symlink_target)
417
365
 
 
366
    def get_canonical_inventory_paths(self, paths):
 
367
        """Like get_canonical_inventory_path() but works on multiple items.
 
368
 
 
369
        :param paths: A sequence of paths relative to the root of the tree.
 
370
        :return: A list of paths, with each item the corresponding input path
 
371
        adjusted to account for existing elements that match case
 
372
        insensitively.
 
373
        """
 
374
        return list(self._yield_canonical_inventory_paths(paths))
 
375
 
 
376
    def get_canonical_inventory_path(self, path):
 
377
        """Returns the first inventory item that case-insensitively matches path.
 
378
 
 
379
        If a path matches exactly, it is returned. If no path matches exactly
 
380
        but more than one path matches case-insensitively, it is implementation
 
381
        defined which is returned.
 
382
 
 
383
        If no path matches case-insensitively, the input path is returned, but
 
384
        with as many path entries that do exist changed to their canonical
 
385
        form.
 
386
 
 
387
        If you need to resolve many names from the same tree, you should
 
388
        use get_canonical_inventory_paths() to avoid O(N) behaviour.
 
389
 
 
390
        :param path: A paths relative to the root of the tree.
 
391
        :return: The input path adjusted to account for existing elements
 
392
        that match case insensitively.
 
393
        """
 
394
        return self._yield_canonical_inventory_paths([path]).next()
 
395
 
 
396
    def _yield_canonical_inventory_paths(self, paths):
 
397
        for path in paths:
 
398
            # First, if the path as specified exists exactly, just use it.
 
399
            if self.path2id(path) is not None:
 
400
                yield path
 
401
                continue
 
402
            # go walkin...
 
403
            cur_id = self.get_root_id()
 
404
            cur_path = ''
 
405
            bit_iter = iter(path.split("/"))
 
406
            for elt in bit_iter:
 
407
                lelt = elt.lower()
 
408
                new_path = None
 
409
                for child in self.iter_children(cur_id):
 
410
                    try:
 
411
                        # XXX: it seem like if the child is known to be in the
 
412
                        # tree, we shouldn't need to go from its id back to
 
413
                        # its path -- mbp 2010-02-11
 
414
                        #
 
415
                        # XXX: it seems like we could be more efficient
 
416
                        # by just directly looking up the original name and
 
417
                        # only then searching all children; also by not
 
418
                        # chopping paths so much. -- mbp 2010-02-11
 
419
                        child_base = os.path.basename(self.id2path(child))
 
420
                        if (child_base == elt):
 
421
                            # if we found an exact match, we can stop now; if
 
422
                            # we found an approximate match we need to keep
 
423
                            # searching because there might be an exact match
 
424
                            # later.  
 
425
                            cur_id = child
 
426
                            new_path = osutils.pathjoin(cur_path, child_base)
 
427
                            break
 
428
                        elif child_base.lower() == lelt:
 
429
                            cur_id = child
 
430
                            new_path = osutils.pathjoin(cur_path, child_base)
 
431
                    except NoSuchId:
 
432
                        # before a change is committed we can see this error...
 
433
                        continue
 
434
                if new_path:
 
435
                    cur_path = new_path
 
436
                else:
 
437
                    # got to the end of this directory and no entries matched.
 
438
                    # Return what matched so far, plus the rest as specified.
 
439
                    cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
 
440
                    break
 
441
            yield cur_path
 
442
        # all done.
 
443
 
418
444
    def get_root_id(self):
419
445
        """Return the file_id for the root of this tree."""
420
446
        raise NotImplementedError(self.get_root_id)
478
504
            except errors.NoSuchRevisionInTree:
479
505
                yield self.repository.revision_tree(revision_id)
480
506
 
 
507
    @staticmethod
 
508
    def _file_revision(revision_tree, file_id):
 
509
        """Determine the revision associated with a file in a given tree."""
 
510
        revision_tree.lock_read()
 
511
        try:
 
512
            return revision_tree.inventory[file_id].revision
 
513
        finally:
 
514
            revision_tree.unlock()
 
515
 
481
516
    def _get_file_revision(self, file_id, vf, tree_revision):
482
517
        """Ensure that file_id, tree_revision is in vf to plan the merge."""
483
518
 
484
519
        if getattr(self, '_repository', None) is None:
485
520
            last_revision = tree_revision
486
 
            parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
 
521
            parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
487
522
                self._iter_parent_trees()]
488
523
            vf.add_lines((file_id, last_revision), parent_keys,
489
 
                         self.get_file_lines(file_id))
 
524
                         self.get_file(file_id).readlines())
490
525
            repo = self.branch.repository
491
526
            base_vf = repo.texts
492
527
        else:
493
 
            last_revision = self.get_file_revision(file_id)
 
528
            last_revision = self._file_revision(self, file_id)
494
529
            base_vf = self._repository.texts
495
530
        if base_vf not in vf.fallback_versionedfiles:
496
531
            vf.fallback_versionedfiles.append(base_vf)
497
532
        return last_revision
498
533
 
 
534
    inventory = property(_get_inventory,
 
535
                         doc="Inventory of this Tree")
 
536
 
499
537
    def _check_retrieved(self, ie, f):
500
538
        if not __debug__:
501
539
            return
502
 
        fp = osutils.fingerprint_file(f)
 
540
        fp = fingerprint_file(f)
503
541
        f.seek(0)
504
542
 
505
543
        if ie.text_size is not None:
506
544
            if ie.text_size != fp['size']:
507
 
                raise errors.BzrError(
508
 
                        "mismatched size for file %r in %r" %
509
 
                        (ie.file_id, self._store),
 
545
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
510
546
                        ["inventory expects %d bytes" % ie.text_size,
511
547
                         "file is actually %d bytes" % fp['size'],
512
548
                         "store is probably damaged/corrupt"])
513
549
 
514
550
        if ie.text_sha1 != fp['sha1']:
515
 
            raise errors.BzrError("wrong SHA-1 for file %r in %r" %
516
 
                    (ie.file_id, self._store),
 
551
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
517
552
                    ["inventory expects %s" % ie.text_sha1,
518
553
                     "file is actually %s" % fp['sha1'],
519
554
                     "store is probably damaged/corrupt"])
520
555
 
 
556
    @needs_read_lock
521
557
    def path2id(self, path):
522
558
        """Return the id for path in this tree."""
523
 
        raise NotImplementedError(self.path2id)
 
559
        return self._inventory.path2id(path)
524
560
 
525
561
    def paths2ids(self, paths, trees=[], require_versioned=True):
526
562
        """Return all the ids that can be reached by walking from paths.
542
578
        return find_ids_across_trees(paths, [self] + list(trees), require_versioned)
543
579
 
544
580
    def iter_children(self, file_id):
545
 
        """Iterate over the file ids of the children of an entry.
546
 
 
547
 
        :param file_id: File id of the entry
548
 
        :return: Iterator over child file ids.
549
 
        """
550
 
        raise NotImplementedError(self.iter_children)
 
581
        entry = self.iter_entries_by_dir([file_id]).next()[1]
 
582
        for child in getattr(entry, 'children', {}).itervalues():
 
583
            yield child.file_id
551
584
 
552
585
    def lock_read(self):
553
 
        """Lock this tree for multiple read only operations.
554
 
 
555
 
        :return: A bzrlib.lock.LogicalLockResult.
556
 
        """
557
586
        pass
558
587
 
559
588
    def revision_tree(self, revision_id):
586
615
 
587
616
        :return: set of paths.
588
617
        """
589
 
        raise NotImplementedError(self.filter_unversioned_files)
 
618
        # NB: we specifically *don't* call self.has_filename, because for
 
619
        # WorkingTrees that can indicate files that exist on disk but that
 
620
        # are not versioned.
 
621
        pred = self.inventory.has_filename
 
622
        return set((p for p in paths if not pred(p)))
590
623
 
591
624
    def walkdirs(self, prefix=""):
592
625
        """Walk the contents of this tree from path down.
644
677
        prefs = self.iter_search_rules([path], filter_pref_names).next()
645
678
        stk = filters._get_filter_stack_for(prefs)
646
679
        if 'filters' in debug.debug_flags:
647
 
            trace.note(gettext("*** {0} content-filter: {1} => {2!r}").format(path,prefs,stk))
 
680
            note("*** %s content-filter: %s => %r" % (path,prefs,stk))
648
681
        return stk
649
682
 
650
683
    def _content_filter_stack_provider(self):
689
722
        return searcher
690
723
 
691
724
 
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.
 
725
######################################################################
 
726
# diff
 
727
 
 
728
# TODO: Merge these two functions into a single one that can operate
 
729
# on either a whole tree or a set of files.
 
730
 
 
731
# TODO: Return the diff in order by filename, not by category or in
 
732
# random order.  Can probably be done by lock-stepping through the
 
733
# filenames from both trees.
 
734
 
 
735
 
 
736
def file_status(filename, old_tree, new_tree):
 
737
    """Return single-letter status, old and new names for a file.
 
738
 
 
739
    The complexity here is in deciding how to represent renames;
 
740
    many complex cases are possible.
704
741
    """
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
 
742
    old_inv = old_tree.inventory
 
743
    new_inv = new_tree.inventory
 
744
    new_id = new_inv.path2id(filename)
 
745
    old_id = old_inv.path2id(filename)
 
746
 
 
747
    if not new_id and not old_id:
 
748
        # easy: doesn't exist in either; not versioned at all
 
749
        if new_tree.is_ignored(filename):
 
750
            return 'I', None, None
 
751
        else:
 
752
            return '?', None, None
 
753
    elif new_id:
 
754
        # There is now a file of this name, great.
 
755
        pass
 
756
    else:
 
757
        # There is no longer a file of this name, but we can describe
 
758
        # what happened to the file that used to have
 
759
        # this name.  There are two possibilities: either it was
 
760
        # deleted entirely, or renamed.
 
761
        if new_inv.has_id(old_id):
 
762
            return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
 
763
        else:
 
764
            return 'D', old_inv.id2path(old_id), None
 
765
 
 
766
    # if the file_id is new in this revision, it is added
 
767
    if new_id and not old_inv.has_id(new_id):
 
768
        return 'A'
 
769
 
 
770
    # if there used to be a file of this name, but that ID has now
 
771
    # disappeared, it is deleted
 
772
    if old_id and not new_inv.has_id(old_id):
 
773
        return 'D'
 
774
 
 
775
    return 'wtf?'
 
776
 
 
777
 
 
778
@deprecated_function(deprecated_in((1, 9, 0)))
 
779
def find_renames(old_inv, new_inv):
 
780
    for file_id in old_inv:
 
781
        if file_id not in new_inv:
 
782
            continue
 
783
        old_name = old_inv.id2path(file_id)
 
784
        new_name = new_inv.id2path(file_id)
 
785
        if old_name != new_name:
 
786
            yield (old_name, new_name)
898
787
 
899
788
 
900
789
def find_ids_across_trees(filenames, trees, require_versioned=True):
907
796
        None)
908
797
    :param trees: The trees to find file_ids within
909
798
    :param require_versioned: if true, all specified filenames must occur in
910
 
        at least one tree.
 
799
    at least one tree.
911
800
    :return: a set of file ids for the specified filenames and their children.
912
801
    """
913
802
    if not filenames:
989
878
 
990
879
    _optimisers = []
991
880
 
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
881
    def _changes_from_entries(self, source_entry, target_entry,
999
882
        source_path=None, target_path=None):
1000
883
        """Generate a iter_changes tuple between source_entry and target_entry.
1048
931
        if source_kind != target_kind:
1049
932
            changed_content = True
1050
933
        elif source_kind == 'file':
1051
 
            if not self.file_content_matches(file_id, file_id, source_path,
1052
 
                    target_path, source_stat, target_stat):
 
934
            if (self.source.get_file_sha1(file_id, source_path, source_stat) !=
 
935
                self.target.get_file_sha1(file_id, target_path, target_stat)):
1053
936
                changed_content = True
1054
937
        elif source_kind == 'symlink':
1055
938
            if (self.source.get_symlink_target(file_id) !=
1056
939
                self.target.get_symlink_target(file_id)):
1057
940
                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)):
 
941
            # XXX: Yes, the indentation below is wrong. But fixing it broke
 
942
            # test_merge.TestMergerEntriesLCAOnDisk.
 
943
            # test_nested_tree_subtree_renamed_and_modified. We'll wait for
 
944
            # the fix from bzr.dev -- vila 2009026
 
945
            elif source_kind == 'tree-reference':
 
946
                if (self.source.get_reference_revision(file_id, source_path)
 
947
                    != self.target.get_reference_revision(file_id, target_path)):
1061
948
                    changed_content = True
1062
949
        parent = (source_parent, target_parent)
1063
950
        name = (source_name, target_name)
1101
988
            # All files are unversioned, so just return an empty delta
1102
989
            # _compare_trees would think we want a complete delta
1103
990
            result = delta.TreeDelta()
1104
 
            fake_entry = inventory.InventoryFile('unused', 'unused', 'unused')
 
991
            fake_entry = InventoryFile('unused', 'unused', 'unused')
1105
992
            result.unversioned = [(path, None,
1106
993
                self.target._comparison_data(fake_entry, path)[0]) for path in
1107
994
                specific_files]
1172
1059
                                     self.target.extras()
1173
1060
                if specific_files is None or
1174
1061
                    osutils.is_inside_any(specific_files, p)])
1175
 
            all_unversioned = collections.deque(all_unversioned)
 
1062
            all_unversioned = deque(all_unversioned)
1176
1063
        else:
1177
 
            all_unversioned = collections.deque()
 
1064
            all_unversioned = deque()
1178
1065
        to_paths = {}
1179
1066
        from_entries_by_dir = list(self.source.iter_entries_by_dir(
1180
1067
            specific_file_ids=specific_file_ids))
1186
1073
        # the unversioned path lookup only occurs on real trees - where there
1187
1074
        # can be extras. So the fake_entry is solely used to look up
1188
1075
        # executable it values when execute is not supported.
1189
 
        fake_entry = inventory.InventoryFile('unused', 'unused', 'unused')
 
1076
        fake_entry = InventoryFile('unused', 'unused', 'unused')
1190
1077
        for target_path, target_entry in to_entries_by_dir:
1191
1078
            while (all_unversioned and
1192
1079
                all_unversioned[0][0] < target_path.split('/')):
1240
1127
            if file_id in to_paths:
1241
1128
                # already returned
1242
1129
                continue
1243
 
            if not self.target.has_id(file_id):
 
1130
            if file_id not in self.target.all_file_ids():
1244
1131
                # common case - paths we have not emitted are not present in
1245
1132
                # target.
1246
1133
                to_path = None
1278
1165
        :param file_id: The file_id to lookup.
1279
1166
        """
1280
1167
        try:
1281
 
            inventory = tree.root_inventory
 
1168
            inventory = tree.inventory
1282
1169
        except NotImplementedError:
1283
1170
            # No inventory available.
1284
1171
            try:
1359
1246
                        if old_entry is None:
1360
1247
                            # Reusing a discarded change.
1361
1248
                            old_entry = self._get_entry(self.source, file_id)
1362
 
                        precise_file_ids.update(
1363
 
                                self.source.iter_children(file_id))
 
1249
                        for child in old_entry.children.values():
 
1250
                            precise_file_ids.add(child.file_id)
1364
1251
                    changed_file_ids.add(result[0])
1365
1252
                    yield result
1366
1253
 
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
 
 
1404
1254
 
1405
1255
class MultiWalker(object):
1406
1256
    """Walk multiple trees simultaneously, getting combined results."""
1509
1359
            return (None, None)
1510
1360
        else:
1511
1361
            self._out_of_order_processed.add(file_id)
1512
 
            cur_ie = other_tree.root_inventory[file_id]
 
1362
            cur_ie = other_tree.inventory[file_id]
1513
1363
            return (cur_path, cur_ie)
1514
1364
 
1515
1365
    def iter_all(self):