~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Jelmer Vernooij
  • Date: 2011-05-08 13:46:49 UTC
  • mto: This revision was merged to the branch mainline in revision 5842.
  • Revision ID: jelmer@samba.org-20110508134649-26xas3otdjlw9jpa
Translate local set_rh calls to remote set_rh calls.

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)
 
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)
203
195
 
204
196
    def iter_references(self):
205
197
        if self.supports_tree_reference():
256
248
    def _file_size(self, entry, stat_value):
257
249
        raise NotImplementedError(self._file_size)
258
250
 
259
 
    def _get_inventory(self):
260
 
        return self._inventory
261
 
 
262
251
    def get_file(self, file_id, path=None):
263
252
        """Return a file object for the file file_id in the tree.
264
253
 
305
294
        """
306
295
        return osutils.split_lines(self.get_file_text(file_id, path))
307
296
 
 
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
 
308
306
    def get_file_mtime(self, file_id, path=None):
309
307
        """Return the modification time for a file.
310
308
 
324
322
        raise NotImplementedError(self.get_file_size)
325
323
 
326
324
    def get_file_by_path(self, path):
327
 
        return self.get_file(self._inventory.path2id(path), 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
335
 
329
336
    def iter_files_bytes(self, desired_files):
330
337
        """Iterate through file contents.
362
369
        """
363
370
        raise NotImplementedError(self.get_symlink_target)
364
371
 
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
372
 
443
373
    def get_root_id(self):
444
374
        """Return the file_id for the root of this tree."""
503
433
            except errors.NoSuchRevisionInTree:
504
434
                yield self.repository.revision_tree(revision_id)
505
435
 
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
436
    def _get_file_revision(self, file_id, vf, tree_revision):
516
437
        """Ensure that file_id, tree_revision is in vf to plan the merge."""
517
438
 
518
439
        if getattr(self, '_repository', None) is None:
519
440
            last_revision = tree_revision
520
 
            parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
 
441
            parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
521
442
                self._iter_parent_trees()]
522
443
            vf.add_lines((file_id, last_revision), parent_keys,
523
 
                         self.get_file(file_id).readlines())
 
444
                         self.get_file_lines(file_id))
524
445
            repo = self.branch.repository
525
446
            base_vf = repo.texts
526
447
        else:
527
 
            last_revision = self._file_revision(self, file_id)
 
448
            last_revision = self.get_file_revision(file_id)
528
449
            base_vf = self._repository.texts
529
450
        if base_vf not in vf.fallback_versionedfiles:
530
451
            vf.fallback_versionedfiles.append(base_vf)
531
452
        return last_revision
532
453
 
533
 
    inventory = property(_get_inventory,
534
 
                         doc="Inventory of this Tree")
535
 
 
536
454
    def _check_retrieved(self, ie, f):
537
455
        if not __debug__:
538
456
            return
539
 
        fp = fingerprint_file(f)
 
457
        fp = osutils.fingerprint_file(f)
540
458
        f.seek(0)
541
459
 
542
460
        if ie.text_size is not None:
543
461
            if ie.text_size != fp['size']:
544
 
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
 
462
                raise errors.BzrError(
 
463
                        "mismatched size for file %r in %r" %
 
464
                        (ie.file_id, self._store),
545
465
                        ["inventory expects %d bytes" % ie.text_size,
546
466
                         "file is actually %d bytes" % fp['size'],
547
467
                         "store is probably damaged/corrupt"])
548
468
 
549
469
        if ie.text_sha1 != fp['sha1']:
550
 
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
 
470
            raise errors.BzrError("wrong SHA-1 for file %r in %r" %
 
471
                    (ie.file_id, self._store),
551
472
                    ["inventory expects %s" % ie.text_sha1,
552
473
                     "file is actually %s" % fp['sha1'],
553
474
                     "store is probably damaged/corrupt"])
554
475
 
555
 
    @needs_read_lock
556
476
    def path2id(self, path):
557
477
        """Return the id for path in this tree."""
558
 
        return self._inventory.path2id(path)
 
478
        raise NotImplementedError(self.path2id)
559
479
 
560
480
    def paths2ids(self, paths, trees=[], require_versioned=True):
561
481
        """Return all the ids that can be reached by walking from paths.
582
502
            yield child.file_id
583
503
 
584
504
    def lock_read(self):
 
505
        """Lock this tree for multiple read only operations.
 
506
        
 
507
        :return: A bzrlib.lock.LogicalLockResult.
 
508
        """
585
509
        pass
586
510
 
587
511
    def revision_tree(self, revision_id):
614
538
 
615
539
        :return: set of paths.
616
540
        """
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)))
 
541
        raise NotImplementedError(self.filter_unversioned_files)
622
542
 
623
543
    def walkdirs(self, prefix=""):
624
544
        """Walk the contents of this tree from path down.
676
596
        prefs = self.iter_search_rules([path], filter_pref_names).next()
677
597
        stk = filters._get_filter_stack_for(prefs)
678
598
        if 'filters' in debug.debug_flags:
679
 
            note("*** %s content-filter: %s => %r" % (path,prefs,stk))
 
599
            trace.note("*** %s content-filter: %s => %r" % (path,prefs,stk))
680
600
        return stk
681
601
 
682
602
    def _content_filter_stack_provider(self):
721
641
        return searcher
722
642
 
723
643
 
 
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
 
724
794
######################################################################
725
795
# diff
726
796
 
774
844
    return 'wtf?'
775
845
 
776
846
 
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)
786
 
 
787
 
 
788
847
def find_ids_across_trees(filenames, trees, require_versioned=True):
789
848
    """Find the ids corresponding to specified filenames.
790
849
 
987
1046
            # All files are unversioned, so just return an empty delta
988
1047
            # _compare_trees would think we want a complete delta
989
1048
            result = delta.TreeDelta()
990
 
            fake_entry = InventoryFile('unused', 'unused', 'unused')
 
1049
            fake_entry = inventory.InventoryFile('unused', 'unused', 'unused')
991
1050
            result.unversioned = [(path, None,
992
1051
                self.target._comparison_data(fake_entry, path)[0]) for path in
993
1052
                specific_files]
1058
1117
                                     self.target.extras()
1059
1118
                if specific_files is None or
1060
1119
                    osutils.is_inside_any(specific_files, p)])
1061
 
            all_unversioned = deque(all_unversioned)
 
1120
            all_unversioned = collections.deque(all_unversioned)
1062
1121
        else:
1063
 
            all_unversioned = deque()
 
1122
            all_unversioned = collections.deque()
1064
1123
        to_paths = {}
1065
1124
        from_entries_by_dir = list(self.source.iter_entries_by_dir(
1066
1125
            specific_file_ids=specific_file_ids))
1072
1131
        # the unversioned path lookup only occurs on real trees - where there
1073
1132
        # can be extras. So the fake_entry is solely used to look up
1074
1133
        # executable it values when execute is not supported.
1075
 
        fake_entry = InventoryFile('unused', 'unused', 'unused')
 
1134
        fake_entry = inventory.InventoryFile('unused', 'unused', 'unused')
1076
1135
        for target_path, target_entry in to_entries_by_dir:
1077
1136
            while (all_unversioned and
1078
1137
                all_unversioned[0][0] < target_path.split('/')):
1126
1185
            if file_id in to_paths:
1127
1186
                # already returned
1128
1187
                continue
1129
 
            if file_id not in self.target.all_file_ids():
 
1188
            if not self.target.has_id(file_id):
1130
1189
                # common case - paths we have not emitted are not present in
1131
1190
                # target.
1132
1191
                to_path = None