~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Martin Pool
  • Date: 2010-02-25 06:17:27 UTC
  • mfrom: (5055 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5057.
  • Revision ID: mbp@sourcefrog.net-20100225061727-4sd9lt0qmdc6087t
merge news

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
18
18
"""
19
19
 
20
20
import os
21
 
 
22
 
from bzrlib.lazy_import import lazy_import
23
 
lazy_import(globals(), """
24
 
import collections
25
 
 
 
21
from collections import deque
 
22
 
 
23
import bzrlib
26
24
from bzrlib import (
27
25
    conflicts as _mod_conflicts,
28
26
    debug,
29
27
    delta,
30
 
    errors,
31
28
    filters,
32
 
    inventory,
33
29
    osutils,
34
30
    revision as _mod_revision,
35
31
    rules,
36
 
    trace,
37
32
    )
38
 
""")
39
 
 
40
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
41
37
from bzrlib.inter import InterObject
 
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
42
42
 
43
43
 
44
44
class Tree(object):
50
50
 
51
51
    * `RevisionTree` is a tree as recorded at some point in the past.
52
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
 
53
60
    Trees can be compared, etc, regardless of whether they are working
54
61
    trees or versioned trees.
55
62
    """
121
128
        raise NotImplementedError(self.has_filename)
122
129
 
123
130
    def has_id(self, file_id):
124
 
        raise NotImplementedError(self.has_id)
 
131
        return self.inventory.has_id(file_id)
125
132
 
126
133
    def __contains__(self, file_id):
127
134
        return self.has_id(file_id)
128
135
 
129
136
    def has_or_had_id(self, file_id):
130
 
        raise NotImplementedError(self.has_or_had_id)
 
137
        return self.inventory.has_id(file_id)
131
138
 
132
139
    def is_ignored(self, filename):
133
140
        """Check whether the filename is ignored by this tree.
138
145
        return False
139
146
 
140
147
    def __iter__(self):
141
 
        """Yield all file ids in this tree."""
142
 
        raise NotImplementedError(self.__iter__)
 
148
        return iter(self.inventory)
143
149
 
144
150
    def all_file_ids(self):
145
151
        """Iterate through all file ids, including ids for missing files."""
150
156
 
151
157
        :raises NoSuchId:
152
158
        """
153
 
        raise NotImplementedError(self.id2path)
154
 
 
 
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
155
174
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
156
175
        """Walk the tree in 'by_dir' order.
157
176
 
180
199
            down to specific_file_ids that have been requested. This has no
181
200
            impact if specific_file_ids is None.
182
201
        """
183
 
        raise NotImplementedError(self.iter_entries_by_dir)
184
 
 
185
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
186
 
        """List all files in this tree.
187
 
 
188
 
        :param include_root: Whether to include the entry for the tree root
189
 
        :param from_dir: Directory under which to list files
190
 
        :param recursive: Whether to list files recursively
191
 
        :return: iterator over tuples of (path, versioned, kind, file_id,
192
 
            inventory entry)
193
 
        """
194
 
        raise NotImplementedError(self.list_files)
 
202
        return self.inventory.iter_entries_by_dir(
 
203
            specific_file_ids=specific_file_ids, yield_parents=yield_parents)
195
204
 
196
205
    def iter_references(self):
197
206
        if self.supports_tree_reference():
248
257
    def _file_size(self, entry, stat_value):
249
258
        raise NotImplementedError(self._file_size)
250
259
 
 
260
    def _get_inventory(self):
 
261
        return self._inventory
 
262
 
251
263
    def get_file(self, file_id, path=None):
252
264
        """Return a file object for the file file_id in the tree.
253
265
 
294
306
        """
295
307
        return osutils.split_lines(self.get_file_text(file_id, path))
296
308
 
297
 
    def get_file_sha1(self, file_id, path=None):
298
 
        """Return the SHA1 file for a file.
299
 
 
300
 
        :param file_id: The handle for this file.
301
 
        :param path: The path that this file can be found at.
302
 
            These must point to the same object.
303
 
        """
304
 
        raise NotImplementedError(self.get_file_sha1)
305
 
 
306
309
    def get_file_mtime(self, file_id, path=None):
307
310
        """Return the modification time for a file.
308
311
 
322
325
        raise NotImplementedError(self.get_file_size)
323
326
 
324
327
    def get_file_by_path(self, path):
325
 
        raise NotImplementedError(self.get_file_by_path)
326
 
 
327
 
    def is_executable(self, file_id, path=None):
328
 
        """Check if a file is executable.
329
 
 
330
 
        :param file_id: The handle for this file.
331
 
        :param path: The path that this file can be found at.
332
 
            These must point to the same object.
333
 
        """
334
 
        raise NotImplementedError(self.is_executable)
 
328
        return self.get_file(self._inventory.path2id(path), path)
335
329
 
336
330
    def iter_files_bytes(self, desired_files):
337
331
        """Iterate through file contents.
369
363
        """
370
364
        raise NotImplementedError(self.get_symlink_target)
371
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.
372
443
 
373
444
    def get_root_id(self):
374
445
        """Return the file_id for the root of this tree."""
433
504
            except errors.NoSuchRevisionInTree:
434
505
                yield self.repository.revision_tree(revision_id)
435
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
 
436
516
    def _get_file_revision(self, file_id, vf, tree_revision):
437
517
        """Ensure that file_id, tree_revision is in vf to plan the merge."""
438
518
 
439
519
        if getattr(self, '_repository', None) is None:
440
520
            last_revision = tree_revision
441
 
            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
442
522
                self._iter_parent_trees()]
443
523
            vf.add_lines((file_id, last_revision), parent_keys,
444
 
                         self.get_file_lines(file_id))
 
524
                         self.get_file(file_id).readlines())
445
525
            repo = self.branch.repository
446
526
            base_vf = repo.texts
447
527
        else:
448
 
            last_revision = self.get_file_revision(file_id)
 
528
            last_revision = self._file_revision(self, file_id)
449
529
            base_vf = self._repository.texts
450
530
        if base_vf not in vf.fallback_versionedfiles:
451
531
            vf.fallback_versionedfiles.append(base_vf)
452
532
        return last_revision
453
533
 
 
534
    inventory = property(_get_inventory,
 
535
                         doc="Inventory of this Tree")
 
536
 
454
537
    def _check_retrieved(self, ie, f):
455
538
        if not __debug__:
456
539
            return
457
 
        fp = osutils.fingerprint_file(f)
 
540
        fp = fingerprint_file(f)
458
541
        f.seek(0)
459
542
 
460
543
        if ie.text_size is not None:
461
544
            if ie.text_size != fp['size']:
462
 
                raise errors.BzrError(
463
 
                        "mismatched size for file %r in %r" %
464
 
                        (ie.file_id, self._store),
 
545
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
465
546
                        ["inventory expects %d bytes" % ie.text_size,
466
547
                         "file is actually %d bytes" % fp['size'],
467
548
                         "store is probably damaged/corrupt"])
468
549
 
469
550
        if ie.text_sha1 != fp['sha1']:
470
 
            raise errors.BzrError("wrong SHA-1 for file %r in %r" %
471
 
                    (ie.file_id, self._store),
 
551
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
472
552
                    ["inventory expects %s" % ie.text_sha1,
473
553
                     "file is actually %s" % fp['sha1'],
474
554
                     "store is probably damaged/corrupt"])
475
555
 
 
556
    @needs_read_lock
476
557
    def path2id(self, path):
477
558
        """Return the id for path in this tree."""
478
 
        raise NotImplementedError(self.path2id)
 
559
        return self._inventory.path2id(path)
479
560
 
480
561
    def paths2ids(self, paths, trees=[], require_versioned=True):
481
562
        """Return all the ids that can be reached by walking from paths.
502
583
            yield child.file_id
503
584
 
504
585
    def lock_read(self):
505
 
        """Lock this tree for multiple read only operations.
506
 
        
507
 
        :return: A bzrlib.lock.LogicalLockResult.
508
 
        """
509
586
        pass
510
587
 
511
588
    def revision_tree(self, revision_id):
538
615
 
539
616
        :return: set of paths.
540
617
        """
541
 
        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)))
542
623
 
543
624
    def walkdirs(self, prefix=""):
544
625
        """Walk the contents of this tree from path down.
596
677
        prefs = self.iter_search_rules([path], filter_pref_names).next()
597
678
        stk = filters._get_filter_stack_for(prefs)
598
679
        if 'filters' in debug.debug_flags:
599
 
            trace.note("*** %s content-filter: %s => %r" % (path,prefs,stk))
 
680
            note("*** %s content-filter: %s => %r" % (path,prefs,stk))
600
681
        return stk
601
682
 
602
683
    def _content_filter_stack_provider(self):
641
722
        return searcher
642
723
 
643
724
 
644
 
class InventoryTree(Tree):
645
 
    """A tree that relies on an inventory for its metadata.
646
 
 
647
 
    Trees contain an `Inventory` object, and also know how to retrieve
648
 
    file texts mentioned in the inventory, either from a working
649
 
    directory or from a store.
650
 
 
651
 
    It is possible for trees to contain files that are not described
652
 
    in their inventory or vice versa; for this use `filenames()`.
653
 
 
654
 
    Subclasses should set the _inventory attribute, which is considered
655
 
    private to external API users.
656
 
    """
657
 
 
658
 
    def get_canonical_inventory_paths(self, paths):
659
 
        """Like get_canonical_inventory_path() but works on multiple items.
660
 
 
661
 
        :param paths: A sequence of paths relative to the root of the tree.
662
 
        :return: A list of paths, with each item the corresponding input path
663
 
        adjusted to account for existing elements that match case
664
 
        insensitively.
665
 
        """
666
 
        return list(self._yield_canonical_inventory_paths(paths))
667
 
 
668
 
    def get_canonical_inventory_path(self, path):
669
 
        """Returns the first inventory item that case-insensitively matches path.
670
 
 
671
 
        If a path matches exactly, it is returned. If no path matches exactly
672
 
        but more than one path matches case-insensitively, it is implementation
673
 
        defined which is returned.
674
 
 
675
 
        If no path matches case-insensitively, the input path is returned, but
676
 
        with as many path entries that do exist changed to their canonical
677
 
        form.
678
 
 
679
 
        If you need to resolve many names from the same tree, you should
680
 
        use get_canonical_inventory_paths() to avoid O(N) behaviour.
681
 
 
682
 
        :param path: A paths relative to the root of the tree.
683
 
        :return: The input path adjusted to account for existing elements
684
 
        that match case insensitively.
685
 
        """
686
 
        return self._yield_canonical_inventory_paths([path]).next()
687
 
 
688
 
    def _yield_canonical_inventory_paths(self, paths):
689
 
        for path in paths:
690
 
            # First, if the path as specified exists exactly, just use it.
691
 
            if self.path2id(path) is not None:
692
 
                yield path
693
 
                continue
694
 
            # go walkin...
695
 
            cur_id = self.get_root_id()
696
 
            cur_path = ''
697
 
            bit_iter = iter(path.split("/"))
698
 
            for elt in bit_iter:
699
 
                lelt = elt.lower()
700
 
                new_path = None
701
 
                for child in self.iter_children(cur_id):
702
 
                    try:
703
 
                        # XXX: it seem like if the child is known to be in the
704
 
                        # tree, we shouldn't need to go from its id back to
705
 
                        # its path -- mbp 2010-02-11
706
 
                        #
707
 
                        # XXX: it seems like we could be more efficient
708
 
                        # by just directly looking up the original name and
709
 
                        # only then searching all children; also by not
710
 
                        # chopping paths so much. -- mbp 2010-02-11
711
 
                        child_base = os.path.basename(self.id2path(child))
712
 
                        if (child_base == elt):
713
 
                            # if we found an exact match, we can stop now; if
714
 
                            # we found an approximate match we need to keep
715
 
                            # searching because there might be an exact match
716
 
                            # later.  
717
 
                            cur_id = child
718
 
                            new_path = osutils.pathjoin(cur_path, child_base)
719
 
                            break
720
 
                        elif child_base.lower() == lelt:
721
 
                            cur_id = child
722
 
                            new_path = osutils.pathjoin(cur_path, child_base)
723
 
                    except errors.NoSuchId:
724
 
                        # before a change is committed we can see this error...
725
 
                        continue
726
 
                if new_path:
727
 
                    cur_path = new_path
728
 
                else:
729
 
                    # got to the end of this directory and no entries matched.
730
 
                    # Return what matched so far, plus the rest as specified.
731
 
                    cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
732
 
                    break
733
 
            yield cur_path
734
 
        # all done.
735
 
 
736
 
    def _get_inventory(self):
737
 
        return self._inventory
738
 
 
739
 
    inventory = property(_get_inventory,
740
 
                         doc="Inventory of this Tree")
741
 
 
742
 
    @needs_read_lock
743
 
    def path2id(self, path):
744
 
        """Return the id for path in this tree."""
745
 
        return self._inventory.path2id(path)
746
 
 
747
 
    def id2path(self, file_id):
748
 
        """Return the path for a file id.
749
 
 
750
 
        :raises NoSuchId:
751
 
        """
752
 
        return self.inventory.id2path(file_id)
753
 
 
754
 
    def has_id(self, file_id):
755
 
        return self.inventory.has_id(file_id)
756
 
 
757
 
    def has_or_had_id(self, file_id):
758
 
        return self.inventory.has_id(file_id)
759
 
 
760
 
    def __iter__(self):
761
 
        return iter(self.inventory)
762
 
 
763
 
    def filter_unversioned_files(self, paths):
764
 
        """Filter out paths that are versioned.
765
 
 
766
 
        :return: set of paths.
767
 
        """
768
 
        # NB: we specifically *don't* call self.has_filename, because for
769
 
        # WorkingTrees that can indicate files that exist on disk but that
770
 
        # are not versioned.
771
 
        pred = self.inventory.has_filename
772
 
        return set((p for p in paths if not pred(p)))
773
 
 
774
 
    @needs_read_lock
775
 
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
776
 
        """Walk the tree in 'by_dir' order.
777
 
 
778
 
        This will yield each entry in the tree as a (path, entry) tuple.
779
 
        The order that they are yielded is:
780
 
 
781
 
        See Tree.iter_entries_by_dir for details.
782
 
 
783
 
        :param yield_parents: If True, yield the parents from the root leading
784
 
            down to specific_file_ids that have been requested. This has no
785
 
            impact if specific_file_ids is None.
786
 
        """
787
 
        return self.inventory.iter_entries_by_dir(
788
 
            specific_file_ids=specific_file_ids, yield_parents=yield_parents)
789
 
 
790
 
    def get_file_by_path(self, path):
791
 
        return self.get_file(self._inventory.path2id(path), path)
792
 
 
793
 
 
794
725
######################################################################
795
726
# diff
796
727
 
844
775
    return 'wtf?'
845
776
 
846
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)
 
787
 
 
788
 
847
789
def find_ids_across_trees(filenames, trees, require_versioned=True):
848
790
    """Find the ids corresponding to specified filenames.
849
791
 
1046
988
            # All files are unversioned, so just return an empty delta
1047
989
            # _compare_trees would think we want a complete delta
1048
990
            result = delta.TreeDelta()
1049
 
            fake_entry = inventory.InventoryFile('unused', 'unused', 'unused')
 
991
            fake_entry = InventoryFile('unused', 'unused', 'unused')
1050
992
            result.unversioned = [(path, None,
1051
993
                self.target._comparison_data(fake_entry, path)[0]) for path in
1052
994
                specific_files]
1117
1059
                                     self.target.extras()
1118
1060
                if specific_files is None or
1119
1061
                    osutils.is_inside_any(specific_files, p)])
1120
 
            all_unversioned = collections.deque(all_unversioned)
 
1062
            all_unversioned = deque(all_unversioned)
1121
1063
        else:
1122
 
            all_unversioned = collections.deque()
 
1064
            all_unversioned = deque()
1123
1065
        to_paths = {}
1124
1066
        from_entries_by_dir = list(self.source.iter_entries_by_dir(
1125
1067
            specific_file_ids=specific_file_ids))
1131
1073
        # the unversioned path lookup only occurs on real trees - where there
1132
1074
        # can be extras. So the fake_entry is solely used to look up
1133
1075
        # executable it values when execute is not supported.
1134
 
        fake_entry = inventory.InventoryFile('unused', 'unused', 'unused')
 
1076
        fake_entry = InventoryFile('unused', 'unused', 'unused')
1135
1077
        for target_path, target_entry in to_entries_by_dir:
1136
1078
            while (all_unversioned and
1137
1079
                all_unversioned[0][0] < target_path.split('/')):
1185
1127
            if file_id in to_paths:
1186
1128
                # already returned
1187
1129
                continue
1188
 
            if not self.target.has_id(file_id):
 
1130
            if file_id not in self.target.all_file_ids():
1189
1131
                # common case - paths we have not emitted are not present in
1190
1132
                # target.
1191
1133
                to_path = None