~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Martin
  • Date: 2011-04-15 21:22:57 UTC
  • mto: This revision was merged to the branch mainline in revision 5797.
  • Revision ID: gzlist@googlemail.com-20110415212257-jgtovwwp4be7egd9
Add release notes

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
18
18
"""
19
19
 
20
20
import os
21
 
from collections import deque
22
 
 
23
 
import bzrlib
 
21
 
 
22
from bzrlib.lazy_import import lazy_import
 
23
lazy_import(globals(), """
 
24
import collections
 
25
 
24
26
from bzrlib import (
25
27
    conflicts as _mod_conflicts,
26
28
    debug,
27
29
    delta,
 
30
    errors,
28
31
    filters,
 
32
    inventory,
29
33
    osutils,
30
34
    revision as _mod_revision,
31
35
    rules,
 
36
    trace,
32
37
    )
 
38
""")
 
39
 
33
40
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
41
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
41
42
 
42
43
 
43
44
class Tree(object):
49
50
 
50
51
    * `RevisionTree` is a tree as recorded at some point in the past.
51
52
 
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
53
    Trees can be compared, etc, regardless of whether they are working
60
54
    trees or versioned trees.
61
55
    """
127
121
        raise NotImplementedError(self.has_filename)
128
122
 
129
123
    def has_id(self, file_id):
130
 
        return self.inventory.has_id(file_id)
 
124
        raise NotImplementedError(self.has_id)
131
125
 
132
126
    def __contains__(self, file_id):
133
127
        return self.has_id(file_id)
134
128
 
135
129
    def has_or_had_id(self, file_id):
136
 
        return self.inventory.has_id(file_id)
 
130
        raise NotImplementedError(self.has_or_had_id)
137
131
 
138
132
    def is_ignored(self, filename):
139
133
        """Check whether the filename is ignored by this tree.
144
138
        return False
145
139
 
146
140
    def __iter__(self):
147
 
        return iter(self.inventory)
 
141
        """Yield all file ids in this tree."""
 
142
        raise NotImplementedError(self.__iter__)
148
143
 
149
144
    def all_file_ids(self):
150
145
        """Iterate through all file ids, including ids for missing files."""
155
150
 
156
151
        :raises NoSuchId:
157
152
        """
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
 
153
        raise NotImplementedError(self.id2path)
 
154
 
173
155
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
174
156
        """Walk the tree in 'by_dir' order.
175
157
 
198
180
            down to specific_file_ids that have been requested. This has no
199
181
            impact if specific_file_ids is None.
200
182
        """
201
 
        return self.inventory.iter_entries_by_dir(
202
 
            specific_file_ids=specific_file_ids, yield_parents=yield_parents)
 
183
        raise NotImplementedError(self.iter_entries_by_dir)
203
184
 
204
185
    def iter_references(self):
205
186
        if self.supports_tree_reference():
256
237
    def _file_size(self, entry, stat_value):
257
238
        raise NotImplementedError(self._file_size)
258
239
 
259
 
    def _get_inventory(self):
260
 
        return self._inventory
261
 
 
262
240
    def get_file(self, file_id, path=None):
263
241
        """Return a file object for the file file_id in the tree.
264
242
 
305
283
        """
306
284
        return osutils.split_lines(self.get_file_text(file_id, path))
307
285
 
 
286
    def get_file_sha1(self, file_id, path=None):
 
287
        """Return the SHA1 file for a file.
 
288
 
 
289
        :param file_id: The handle for this file.
 
290
        :param path: The path that this file can be found at.
 
291
            These must point to the same object.
 
292
        """
 
293
        raise NotImplementedError(self.get_file_sha1)
 
294
 
308
295
    def get_file_mtime(self, file_id, path=None):
309
296
        """Return the modification time for a file.
310
297
 
324
311
        raise NotImplementedError(self.get_file_size)
325
312
 
326
313
    def get_file_by_path(self, path):
327
 
        return self.get_file(self._inventory.path2id(path), path)
 
314
        raise NotImplementedError(self.get_file_by_path)
 
315
 
 
316
    def is_executable(self, file_id, path=None):
 
317
        """Check if a file is executable.
 
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
        """
 
323
        raise NotImplementedError(self.is_executable)
328
324
 
329
325
    def iter_files_bytes(self, desired_files):
330
326
        """Iterate through file contents.
362
358
        """
363
359
        raise NotImplementedError(self.get_symlink_target)
364
360
 
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
361
 
443
362
    def get_root_id(self):
444
363
        """Return the file_id for the root of this tree."""
506
425
    @staticmethod
507
426
    def _file_revision(revision_tree, file_id):
508
427
        """Determine the revision associated with a file in a given tree."""
 
428
        # FIXME: Shouldn't this be a RevisionTree method?
509
429
        revision_tree.lock_read()
510
430
        try:
511
431
            return revision_tree.inventory[file_id].revision
530
450
            vf.fallback_versionedfiles.append(base_vf)
531
451
        return last_revision
532
452
 
533
 
    inventory = property(_get_inventory,
534
 
                         doc="Inventory of this Tree")
535
 
 
536
453
    def _check_retrieved(self, ie, f):
537
454
        if not __debug__:
538
455
            return
539
 
        fp = fingerprint_file(f)
 
456
        fp = osutils.fingerprint_file(f)
540
457
        f.seek(0)
541
458
 
542
459
        if ie.text_size is not None:
543
460
            if ie.text_size != fp['size']:
544
 
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
 
461
                raise errors.BzrError(
 
462
                        "mismatched size for file %r in %r" %
 
463
                        (ie.file_id, self._store),
545
464
                        ["inventory expects %d bytes" % ie.text_size,
546
465
                         "file is actually %d bytes" % fp['size'],
547
466
                         "store is probably damaged/corrupt"])
548
467
 
549
468
        if ie.text_sha1 != fp['sha1']:
550
 
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
 
469
            raise errors.BzrError("wrong SHA-1 for file %r in %r" %
 
470
                    (ie.file_id, self._store),
551
471
                    ["inventory expects %s" % ie.text_sha1,
552
472
                     "file is actually %s" % fp['sha1'],
553
473
                     "store is probably damaged/corrupt"])
554
474
 
555
 
    @needs_read_lock
556
475
    def path2id(self, path):
557
476
        """Return the id for path in this tree."""
558
 
        return self._inventory.path2id(path)
 
477
        raise NotImplementedError(self.path2id)
559
478
 
560
479
    def paths2ids(self, paths, trees=[], require_versioned=True):
561
480
        """Return all the ids that can be reached by walking from paths.
618
537
 
619
538
        :return: set of paths.
620
539
        """
621
 
        # NB: we specifically *don't* call self.has_filename, because for
622
 
        # WorkingTrees that can indicate files that exist on disk but that
623
 
        # are not versioned.
624
 
        pred = self.inventory.has_filename
625
 
        return set((p for p in paths if not pred(p)))
 
540
        raise NotImplementedError(self.filter_unversioned_files)
626
541
 
627
542
    def walkdirs(self, prefix=""):
628
543
        """Walk the contents of this tree from path down.
680
595
        prefs = self.iter_search_rules([path], filter_pref_names).next()
681
596
        stk = filters._get_filter_stack_for(prefs)
682
597
        if 'filters' in debug.debug_flags:
683
 
            note("*** %s content-filter: %s => %r" % (path,prefs,stk))
 
598
            trace.note("*** %s content-filter: %s => %r" % (path,prefs,stk))
684
599
        return stk
685
600
 
686
601
    def _content_filter_stack_provider(self):
725
640
        return searcher
726
641
 
727
642
 
 
643
class InventoryTree(Tree):
 
644
    """A tree that relies on an inventory for its metadata.
 
645
 
 
646
    Trees contain an `Inventory` object, and also know how to retrieve
 
647
    file texts mentioned in the inventory, either from a working
 
648
    directory or from a store.
 
649
 
 
650
    It is possible for trees to contain files that are not described
 
651
    in their inventory or vice versa; for this use `filenames()`.
 
652
 
 
653
    Subclasses should set the _inventory attribute, which is considered
 
654
    private to external API users.
 
655
    """
 
656
 
 
657
    def get_canonical_inventory_paths(self, paths):
 
658
        """Like get_canonical_inventory_path() but works on multiple items.
 
659
 
 
660
        :param paths: A sequence of paths relative to the root of the tree.
 
661
        :return: A list of paths, with each item the corresponding input path
 
662
        adjusted to account for existing elements that match case
 
663
        insensitively.
 
664
        """
 
665
        return list(self._yield_canonical_inventory_paths(paths))
 
666
 
 
667
    def get_canonical_inventory_path(self, path):
 
668
        """Returns the first inventory item that case-insensitively matches path.
 
669
 
 
670
        If a path matches exactly, it is returned. If no path matches exactly
 
671
        but more than one path matches case-insensitively, it is implementation
 
672
        defined which is returned.
 
673
 
 
674
        If no path matches case-insensitively, the input path is returned, but
 
675
        with as many path entries that do exist changed to their canonical
 
676
        form.
 
677
 
 
678
        If you need to resolve many names from the same tree, you should
 
679
        use get_canonical_inventory_paths() to avoid O(N) behaviour.
 
680
 
 
681
        :param path: A paths relative to the root of the tree.
 
682
        :return: The input path adjusted to account for existing elements
 
683
        that match case insensitively.
 
684
        """
 
685
        return self._yield_canonical_inventory_paths([path]).next()
 
686
 
 
687
    def _yield_canonical_inventory_paths(self, paths):
 
688
        for path in paths:
 
689
            # First, if the path as specified exists exactly, just use it.
 
690
            if self.path2id(path) is not None:
 
691
                yield path
 
692
                continue
 
693
            # go walkin...
 
694
            cur_id = self.get_root_id()
 
695
            cur_path = ''
 
696
            bit_iter = iter(path.split("/"))
 
697
            for elt in bit_iter:
 
698
                lelt = elt.lower()
 
699
                new_path = None
 
700
                for child in self.iter_children(cur_id):
 
701
                    try:
 
702
                        # XXX: it seem like if the child is known to be in the
 
703
                        # tree, we shouldn't need to go from its id back to
 
704
                        # its path -- mbp 2010-02-11
 
705
                        #
 
706
                        # XXX: it seems like we could be more efficient
 
707
                        # by just directly looking up the original name and
 
708
                        # only then searching all children; also by not
 
709
                        # chopping paths so much. -- mbp 2010-02-11
 
710
                        child_base = os.path.basename(self.id2path(child))
 
711
                        if (child_base == elt):
 
712
                            # if we found an exact match, we can stop now; if
 
713
                            # we found an approximate match we need to keep
 
714
                            # searching because there might be an exact match
 
715
                            # later.  
 
716
                            cur_id = child
 
717
                            new_path = osutils.pathjoin(cur_path, child_base)
 
718
                            break
 
719
                        elif child_base.lower() == lelt:
 
720
                            cur_id = child
 
721
                            new_path = osutils.pathjoin(cur_path, child_base)
 
722
                    except errors.NoSuchId:
 
723
                        # before a change is committed we can see this error...
 
724
                        continue
 
725
                if new_path:
 
726
                    cur_path = new_path
 
727
                else:
 
728
                    # got to the end of this directory and no entries matched.
 
729
                    # Return what matched so far, plus the rest as specified.
 
730
                    cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
 
731
                    break
 
732
            yield cur_path
 
733
        # all done.
 
734
 
 
735
    def _get_inventory(self):
 
736
        return self._inventory
 
737
 
 
738
    inventory = property(_get_inventory,
 
739
                         doc="Inventory of this Tree")
 
740
 
 
741
    @needs_read_lock
 
742
    def path2id(self, path):
 
743
        """Return the id for path in this tree."""
 
744
        return self._inventory.path2id(path)
 
745
 
 
746
    def id2path(self, file_id):
 
747
        """Return the path for a file id.
 
748
 
 
749
        :raises NoSuchId:
 
750
        """
 
751
        return self.inventory.id2path(file_id)
 
752
 
 
753
    def has_id(self, file_id):
 
754
        return self.inventory.has_id(file_id)
 
755
 
 
756
    def has_or_had_id(self, file_id):
 
757
        return self.inventory.has_id(file_id)
 
758
 
 
759
    def __iter__(self):
 
760
        return iter(self.inventory)
 
761
 
 
762
    def filter_unversioned_files(self, paths):
 
763
        """Filter out paths that are versioned.
 
764
 
 
765
        :return: set of paths.
 
766
        """
 
767
        # NB: we specifically *don't* call self.has_filename, because for
 
768
        # WorkingTrees that can indicate files that exist on disk but that
 
769
        # are not versioned.
 
770
        pred = self.inventory.has_filename
 
771
        return set((p for p in paths if not pred(p)))
 
772
 
 
773
    @needs_read_lock
 
774
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
 
775
        """Walk the tree in 'by_dir' order.
 
776
 
 
777
        This will yield each entry in the tree as a (path, entry) tuple.
 
778
        The order that they are yielded is:
 
779
 
 
780
        See Tree.iter_entries_by_dir for details.
 
781
 
 
782
        :param yield_parents: If True, yield the parents from the root leading
 
783
            down to specific_file_ids that have been requested. This has no
 
784
            impact if specific_file_ids is None.
 
785
        """
 
786
        return self.inventory.iter_entries_by_dir(
 
787
            specific_file_ids=specific_file_ids, yield_parents=yield_parents)
 
788
 
 
789
    def get_file_by_path(self, path):
 
790
        return self.get_file(self._inventory.path2id(path), path)
 
791
 
 
792
 
728
793
######################################################################
729
794
# diff
730
795
 
778
843
    return 'wtf?'
779
844
 
780
845
 
781
 
@deprecated_function(deprecated_in((1, 9, 0)))
782
 
def find_renames(old_inv, new_inv):
783
 
    for file_id in old_inv:
784
 
        if file_id not in new_inv:
785
 
            continue
786
 
        old_name = old_inv.id2path(file_id)
787
 
        new_name = new_inv.id2path(file_id)
788
 
        if old_name != new_name:
789
 
            yield (old_name, new_name)
790
 
 
791
 
 
792
846
def find_ids_across_trees(filenames, trees, require_versioned=True):
793
847
    """Find the ids corresponding to specified filenames.
794
848
 
991
1045
            # All files are unversioned, so just return an empty delta
992
1046
            # _compare_trees would think we want a complete delta
993
1047
            result = delta.TreeDelta()
994
 
            fake_entry = InventoryFile('unused', 'unused', 'unused')
 
1048
            fake_entry = inventory.InventoryFile('unused', 'unused', 'unused')
995
1049
            result.unversioned = [(path, None,
996
1050
                self.target._comparison_data(fake_entry, path)[0]) for path in
997
1051
                specific_files]
1062
1116
                                     self.target.extras()
1063
1117
                if specific_files is None or
1064
1118
                    osutils.is_inside_any(specific_files, p)])
1065
 
            all_unversioned = deque(all_unversioned)
 
1119
            all_unversioned = collections.deque(all_unversioned)
1066
1120
        else:
1067
 
            all_unversioned = deque()
 
1121
            all_unversioned = collections.deque()
1068
1122
        to_paths = {}
1069
1123
        from_entries_by_dir = list(self.source.iter_entries_by_dir(
1070
1124
            specific_file_ids=specific_file_ids))
1076
1130
        # the unversioned path lookup only occurs on real trees - where there
1077
1131
        # can be extras. So the fake_entry is solely used to look up
1078
1132
        # executable it values when execute is not supported.
1079
 
        fake_entry = InventoryFile('unused', 'unused', 'unused')
 
1133
        fake_entry = inventory.InventoryFile('unused', 'unused', 'unused')
1080
1134
        for target_path, target_entry in to_entries_by_dir:
1081
1135
            while (all_unversioned and
1082
1136
                all_unversioned[0][0] < target_path.split('/')):