← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Ian Clatworthy
  • Date: 2009-07-02 08:26:00 UTC
  • mto: (4527.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4529.
  • Revision ID: ian.clatworthy@canonical.com-20090702082600-qwb1evvvfa8ctnye
first draft of a 2.0 Upgrade Guide

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tree.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2009 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
19
19
 
20
20
import os
21
21
from collections import deque
 
22
from cStringIO import StringIO
22
23
 
23
24
import bzrlib
24
25
from bzrlib import (
29
30
    osutils,
30
31
    revision as _mod_revision,
31
32
    rules,
 
33
    symbol_versioning,
32
34
    )
33
35
from bzrlib.decorators import needs_read_lock
34
 
from bzrlib.errors import BzrError, NoSuchId
 
36
from bzrlib.errors import BzrError, BzrCheckError, NoSuchId
35
37
from bzrlib import errors
36
 
from bzrlib.inventory import InventoryFile
 
38
from bzrlib.inventory import Inventory, InventoryFile
37
39
from bzrlib.inter import InterObject
38
40
from bzrlib.osutils import fingerprint_file
39
41
import bzrlib.revision
40
42
from bzrlib.symbol_versioning import deprecated_function, deprecated_in
41
 
from bzrlib.trace import note
 
43
from bzrlib.trace import mutter, note
42
44
 
43
45
 
44
46
class Tree(object):
98
100
    def iter_changes(self, from_tree, include_unchanged=False,
99
101
                     specific_files=None, pb=None, extra_trees=None,
100
102
                     require_versioned=True, want_unversioned=False):
101
 
        """See InterTree.iter_changes"""
102
103
        intertree = InterTree.get(from_tree, self)
103
104
        return intertree.iter_changes(include_unchanged, specific_files, pb,
104
105
            extra_trees, require_versioned, want_unversioned=want_unversioned)
134
135
        return self.has_id(file_id)
135
136
 
136
137
    def has_or_had_id(self, file_id):
 
138
        if file_id == self.inventory.root.file_id:
 
139
            return True
137
140
        return self.inventory.has_id(file_id)
138
141
 
139
142
    def is_ignored(self, filename):
171
174
        return self.bzrdir.is_control_filename(filename)
172
175
 
173
176
    @needs_read_lock
174
 
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
 
177
    def iter_entries_by_dir(self, specific_file_ids=None):
175
178
        """Walk the tree in 'by_dir' order.
176
179
 
177
180
        This will yield each entry in the tree as a (path, entry) tuple.
194
197
 
195
198
        The yield order (ignoring root) would be::
196
199
          a, f, a/b, a/d, a/b/c, a/d/e, f/g
197
 
 
198
 
        :param yield_parents: If True, yield the parents from the root leading
199
 
            down to specific_file_ids that have been requested. This has no
200
 
            impact if specific_file_ids is None.
201
200
        """
202
201
        return self.inventory.iter_entries_by_dir(
203
 
            specific_file_ids=specific_file_ids, yield_parents=yield_parents)
 
202
            specific_file_ids=specific_file_ids)
204
203
 
205
204
    def iter_references(self):
206
205
        if self.supports_tree_reference():
223
222
    def path_content_summary(self, path):
224
223
        """Get a summary of the information about path.
225
224
 
226
 
        All the attributes returned are for the canonical form, not the
227
 
        convenient form (if content filters are in use.)
228
 
 
229
225
        :param path: A relative path within the tree.
230
226
        :return: A tuple containing kind, size, exec, sha1-or-link.
231
227
            Kind is always present (see tree.kind()).
232
 
            size is present if kind is file and the size of the 
233
 
                canonical form can be cheaply determined, None otherwise.
 
228
            size is present if kind is file, None otherwise.
234
229
            exec is None unless kind is file and the platform supports the 'x'
235
230
                bit.
236
231
            sha1-or-link is the link target if kind is symlink, or the sha1 if
405
400
            bit_iter = iter(path.split("/"))
406
401
            for elt in bit_iter:
407
402
                lelt = elt.lower()
408
 
                new_path = None
409
403
                for child in self.iter_children(cur_id):
410
404
                    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
405
                        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.  
 
406
                        if child_base.lower() == lelt:
425
407
                            cur_id = child
426
 
                            new_path = osutils.pathjoin(cur_path, child_base)
 
408
                            cur_path = osutils.pathjoin(cur_path, child_base)
427
409
                            break
428
 
                        elif child_base.lower() == lelt:
429
 
                            cur_id = child
430
 
                            new_path = osutils.pathjoin(cur_path, child_base)
431
410
                    except NoSuchId:
432
411
                        # before a change is committed we can see this error...
433
412
                        continue
434
 
                if new_path:
435
 
                    cur_path = new_path
436
413
                else:
437
414
                    # got to the end of this directory and no entries matched.
438
415
                    # Return what matched so far, plus the rest as specified.
460
437
        raise NotImplementedError(self.annotate_iter)
461
438
 
462
439
    def _get_plan_merge_data(self, file_id, other, base):
463
 
        from bzrlib import versionedfile
 
440
        from bzrlib import merge, versionedfile
464
441
        vf = versionedfile._PlanMergeVersionedFile(file_id)
465
442
        last_revision_a = self._get_file_revision(file_id, vf, 'this:')
466
443
        last_revision_b = other._get_file_revision(file_id, vf, 'other:')
716
693
                for path in path_names:
717
694
                    yield searcher.get_items(path)
718
695
 
 
696
    @needs_read_lock
719
697
    def _get_rules_searcher(self, default_searcher):
720
698
        """Get the RulesSearcher for this tree given the default one."""
721
699
        searcher = default_searcher
849
827
        new_pending = set()
850
828
        for file_id in pending:
851
829
            for tree in trees:
852
 
                if not tree.has_or_had_id(file_id):
 
830
                if not tree.has_id(file_id):
853
831
                    continue
854
832
                for child_id in tree.iter_children(file_id):
855
833
                    if child_id not in interesting_ids:
870
848
    will pass through to InterTree as appropriate.
871
849
    """
872
850
 
873
 
    # Formats that will be used to test this InterTree. If both are
874
 
    # None, this InterTree will not be tested (e.g. because a complex
875
 
    # setup is required)
876
 
    _matching_from_tree_format = None
877
 
    _matching_to_tree_format = None
878
 
 
879
851
    _optimisers = []
880
852
 
881
 
    def _changes_from_entries(self, source_entry, target_entry,
882
 
        source_path=None, target_path=None):
883
 
        """Generate a iter_changes tuple between source_entry and target_entry.
884
 
 
885
 
        :param source_entry: An inventory entry from self.source, or None.
886
 
        :param target_entry: An inventory entry from self.target, or None.
887
 
        :param source_path: The path of source_entry, if known. If not known
888
 
            it will be looked up.
889
 
        :param target_path: The path of target_entry, if known. If not known
890
 
            it will be looked up.
891
 
        :return: A tuple, item 0 of which is an iter_changes result tuple, and
892
 
            item 1 is True if there are any changes in the result tuple.
893
 
        """
894
 
        if source_entry is None:
895
 
            if target_entry is None:
896
 
                return None
897
 
            file_id = target_entry.file_id
898
 
        else:
899
 
            file_id = source_entry.file_id
900
 
        if source_entry is not None:
901
 
            source_versioned = True
902
 
            source_name = source_entry.name
903
 
            source_parent = source_entry.parent_id
904
 
            if source_path is None:
905
 
                source_path = self.source.id2path(file_id)
906
 
            source_kind, source_executable, source_stat = \
907
 
                self.source._comparison_data(source_entry, source_path)
908
 
        else:
909
 
            source_versioned = False
910
 
            source_name = None
911
 
            source_parent = None
912
 
            source_kind = None
913
 
            source_executable = None
914
 
        if target_entry is not None:
915
 
            target_versioned = True
916
 
            target_name = target_entry.name
917
 
            target_parent = target_entry.parent_id
918
 
            if target_path is None:
919
 
                target_path = self.target.id2path(file_id)
920
 
            target_kind, target_executable, target_stat = \
921
 
                self.target._comparison_data(target_entry, target_path)
922
 
        else:
923
 
            target_versioned = False
924
 
            target_name = None
925
 
            target_parent = None
926
 
            target_kind = None
927
 
            target_executable = None
928
 
        versioned = (source_versioned, target_versioned)
929
 
        kind = (source_kind, target_kind)
930
 
        changed_content = False
931
 
        if source_kind != target_kind:
932
 
            changed_content = True
933
 
        elif source_kind == 'file':
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)):
936
 
                changed_content = True
937
 
        elif source_kind == 'symlink':
938
 
            if (self.source.get_symlink_target(file_id) !=
939
 
                self.target.get_symlink_target(file_id)):
940
 
                changed_content = True
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)):
948
 
                    changed_content = True
949
 
        parent = (source_parent, target_parent)
950
 
        name = (source_name, target_name)
951
 
        executable = (source_executable, target_executable)
952
 
        if (changed_content is not False or versioned[0] != versioned[1]
953
 
            or parent[0] != parent[1] or name[0] != name[1] or
954
 
            executable[0] != executable[1]):
955
 
            changes = True
956
 
        else:
957
 
            changes = False
958
 
        return (file_id, (source_path, target_path), changed_content,
959
 
                versioned, parent, name, kind, executable), changes
960
 
 
961
853
    @needs_read_lock
962
854
    def compare(self, want_unchanged=False, specific_files=None,
963
855
        extra_trees=None, require_versioned=False, include_root=False,
978
870
            a PathsNotVersionedError will be thrown.
979
871
        :param want_unversioned: Scan for unversioned paths.
980
872
        """
 
873
        # NB: show_status depends on being able to pass in non-versioned files
 
874
        # and report them as unknown
981
875
        trees = (self.source,)
982
876
        if extra_trees is not None:
983
877
            trees = trees + tuple(extra_trees)
1024
918
        :param require_versioned: Raise errors.PathsNotVersionedError if a
1025
919
            path in the specific_files list is not versioned in one of
1026
920
            source, target or extra_trees.
1027
 
        :param specific_files: An optional list of file paths to restrict the
1028
 
            comparison to. When mapping filenames to ids, all matches in all
1029
 
            trees (including optional extra_trees) are used, and all children
1030
 
            of matched directories are included. The parents in the target tree
1031
 
            of the specific files up to and including the root of the tree are
1032
 
            always evaluated for changes too.
1033
921
        :param want_unversioned: Should unversioned files be returned in the
1034
922
            output. An unversioned file is defined as one with (False, False)
1035
923
            for the versioned pair.
1037
925
        lookup_trees = [self.source]
1038
926
        if extra_trees:
1039
927
             lookup_trees.extend(extra_trees)
1040
 
        # The ids of items we need to examine to insure delta consistency.
1041
 
        precise_file_ids = set()
1042
 
        changed_file_ids = []
1043
928
        if specific_files == []:
1044
929
            specific_file_ids = []
1045
930
        else:
1046
931
            specific_file_ids = self.target.paths2ids(specific_files,
1047
932
                lookup_trees, require_versioned=require_versioned)
1048
 
        if specific_files is not None:
1049
 
            # reparented or added entries must have their parents included
1050
 
            # so that valid deltas can be created. The seen_parents set
1051
 
            # tracks the parents that we need to have.
1052
 
            # The seen_dirs set tracks directory entries we've yielded.
1053
 
            # After outputting version object in to_entries we set difference
1054
 
            # the two seen sets and start checking parents.
1055
 
            seen_parents = set()
1056
 
            seen_dirs = set()
1057
933
        if want_unversioned:
1058
934
            all_unversioned = sorted([(p.split('/'), p) for p in
1059
935
                                     self.target.extras()
1074
950
        # can be extras. So the fake_entry is solely used to look up
1075
951
        # executable it values when execute is not supported.
1076
952
        fake_entry = InventoryFile('unused', 'unused', 'unused')
1077
 
        for target_path, target_entry in to_entries_by_dir:
1078
 
            while (all_unversioned and
1079
 
                all_unversioned[0][0] < target_path.split('/')):
 
953
        for to_path, to_entry in to_entries_by_dir:
 
954
            while all_unversioned and all_unversioned[0][0] < to_path.split('/'):
1080
955
                unversioned_path = all_unversioned.popleft()
1081
 
                target_kind, target_executable, target_stat = \
 
956
                to_kind, to_executable, to_stat = \
1082
957
                    self.target._comparison_data(fake_entry, unversioned_path[1])
1083
958
                yield (None, (None, unversioned_path[1]), True, (False, False),
1084
959
                    (None, None),
1085
960
                    (None, unversioned_path[0][-1]),
1086
 
                    (None, target_kind),
1087
 
                    (None, target_executable))
1088
 
            source_path, source_entry = from_data.get(target_entry.file_id,
1089
 
                (None, None))
1090
 
            result, changes = self._changes_from_entries(source_entry,
1091
 
                target_entry, source_path=source_path, target_path=target_path)
1092
 
            to_paths[result[0]] = result[1][1]
 
961
                    (None, to_kind),
 
962
                    (None, to_executable))
 
963
            file_id = to_entry.file_id
 
964
            to_paths[file_id] = to_path
1093
965
            entry_count += 1
1094
 
            if result[3][0]:
 
966
            changed_content = False
 
967
            from_path, from_entry = from_data.get(file_id, (None, None))
 
968
            from_versioned = (from_entry is not None)
 
969
            if from_entry is not None:
 
970
                from_versioned = True
 
971
                from_name = from_entry.name
 
972
                from_parent = from_entry.parent_id
 
973
                from_kind, from_executable, from_stat = \
 
974
                    self.source._comparison_data(from_entry, from_path)
1095
975
                entry_count += 1
 
976
            else:
 
977
                from_versioned = False
 
978
                from_kind = None
 
979
                from_parent = None
 
980
                from_name = None
 
981
                from_executable = None
 
982
            versioned = (from_versioned, True)
 
983
            to_kind, to_executable, to_stat = \
 
984
                self.target._comparison_data(to_entry, to_path)
 
985
            kind = (from_kind, to_kind)
 
986
            if kind[0] != kind[1]:
 
987
                changed_content = True
 
988
            elif from_kind == 'file':
 
989
                if (self.source.get_file_sha1(file_id, from_path, from_stat) !=
 
990
                    self.target.get_file_sha1(file_id, to_path, to_stat)):
 
991
                    changed_content = True
 
992
            elif from_kind == 'symlink':
 
993
                if (self.source.get_symlink_target(file_id) !=
 
994
                    self.target.get_symlink_target(file_id)):
 
995
                    changed_content = True
 
996
                # XXX: Yes, the indentation below is wrong. But fixing it broke
 
997
                # test_merge.TestMergerEntriesLCAOnDisk.
 
998
                # test_nested_tree_subtree_renamed_and_modified. We'll wait for
 
999
                # the fix from bzr.dev -- vila 2009026
 
1000
                elif from_kind == 'tree-reference':
 
1001
                    if (self.source.get_reference_revision(file_id, from_path)
 
1002
                        != self.target.get_reference_revision(file_id, to_path)):
 
1003
                        changed_content = True
 
1004
            parent = (from_parent, to_entry.parent_id)
 
1005
            name = (from_name, to_entry.name)
 
1006
            executable = (from_executable, to_executable)
1096
1007
            if pb is not None:
1097
1008
                pb.update('comparing files', entry_count, num_entries)
1098
 
            if changes or include_unchanged:
1099
 
                if specific_file_ids is not None:
1100
 
                    new_parent_id = result[4][1]
1101
 
                    precise_file_ids.add(new_parent_id)
1102
 
                    changed_file_ids.append(result[0])
1103
 
                yield result
1104
 
            # Ensure correct behaviour for reparented/added specific files.
1105
 
            if specific_files is not None:
1106
 
                # Record output dirs
1107
 
                if result[6][1] == 'directory':
1108
 
                    seen_dirs.add(result[0])
1109
 
                # Record parents of reparented/added entries.
1110
 
                versioned = result[3]
1111
 
                parents = result[4]
1112
 
                if not versioned[0] or parents[0] != parents[1]:
1113
 
                    seen_parents.add(parents[1])
 
1009
            if (changed_content is not False or versioned[0] != versioned[1]
 
1010
                or parent[0] != parent[1] or name[0] != name[1] or
 
1011
                executable[0] != executable[1] or include_unchanged):
 
1012
                yield (file_id, (from_path, to_path), changed_content,
 
1013
                    versioned, parent, name, kind, executable)
 
1014
 
1114
1015
        while all_unversioned:
1115
1016
            # yield any trailing unversioned paths
1116
1017
            unversioned_path = all_unversioned.popleft()
1121
1022
                (None, unversioned_path[0][-1]),
1122
1023
                (None, to_kind),
1123
1024
                (None, to_executable))
1124
 
        # Yield all remaining source paths
 
1025
 
 
1026
        def get_to_path(to_entry):
 
1027
            if to_entry.parent_id is None:
 
1028
                to_path = '' # the root
 
1029
            else:
 
1030
                if to_entry.parent_id not in to_paths:
 
1031
                    # recurse up
 
1032
                    return get_to_path(self.target.inventory[to_entry.parent_id])
 
1033
                to_path = osutils.pathjoin(to_paths[to_entry.parent_id],
 
1034
                                           to_entry.name)
 
1035
            to_paths[to_entry.file_id] = to_path
 
1036
            return to_path
 
1037
 
1125
1038
        for path, from_entry in from_entries_by_dir:
1126
1039
            file_id = from_entry.file_id
1127
1040
            if file_id in to_paths:
1128
1041
                # already returned
1129
1042
                continue
1130
 
            if file_id not in self.target.all_file_ids():
 
1043
            if not file_id in self.target.all_file_ids():
1131
1044
                # common case - paths we have not emitted are not present in
1132
1045
                # target.
1133
1046
                to_path = None
1134
1047
            else:
1135
 
                to_path = self.target.id2path(file_id)
 
1048
                to_path = get_to_path(self.target.inventory[file_id])
1136
1049
            entry_count += 1
1137
1050
            if pb is not None:
1138
1051
                pb.update('comparing files', entry_count, num_entries)
1145
1058
            executable = (from_executable, None)
1146
1059
            changed_content = from_kind is not None
1147
1060
            # the parent's path is necessarily known at this point.
1148
 
            changed_file_ids.append(file_id)
1149
1061
            yield(file_id, (path, to_path), changed_content, versioned, parent,
1150
1062
                  name, kind, executable)
1151
 
        changed_file_ids = set(changed_file_ids)
1152
 
        if specific_file_ids is not None:
1153
 
            for result in self._handle_precise_ids(precise_file_ids,
1154
 
                changed_file_ids):
1155
 
                yield result
1156
 
 
1157
 
    def _get_entry(self, tree, file_id):
1158
 
        """Get an inventory entry from a tree, with missing entries as None.
1159
 
 
1160
 
        If the tree raises NotImplementedError on accessing .inventory, then
1161
 
        this is worked around using iter_entries_by_dir on just the file id
1162
 
        desired.
1163
 
 
1164
 
        :param tree: The tree to lookup the entry in.
1165
 
        :param file_id: The file_id to lookup.
1166
 
        """
1167
 
        try:
1168
 
            inventory = tree.inventory
1169
 
        except NotImplementedError:
1170
 
            # No inventory available.
1171
 
            try:
1172
 
                iterator = tree.iter_entries_by_dir(specific_file_ids=[file_id])
1173
 
                return iterator.next()[1]
1174
 
            except StopIteration:
1175
 
                return None
1176
 
        else:
1177
 
            try:
1178
 
                return inventory[file_id]
1179
 
            except errors.NoSuchId:
1180
 
                return None
1181
 
 
1182
 
    def _handle_precise_ids(self, precise_file_ids, changed_file_ids,
1183
 
        discarded_changes=None):
1184
 
        """Fill out a partial iter_changes to be consistent.
1185
 
 
1186
 
        :param precise_file_ids: The file ids of parents that were seen during
1187
 
            the iter_changes.
1188
 
        :param changed_file_ids: The file ids of already emitted items.
1189
 
        :param discarded_changes: An optional dict of precalculated
1190
 
            iter_changes items which the partial iter_changes had not output
1191
 
            but had calculated.
1192
 
        :return: A generator of iter_changes items to output.
1193
 
        """
1194
 
        # process parents of things that had changed under the users
1195
 
        # requested paths to prevent incorrect paths or parent ids which
1196
 
        # aren't in the tree.
1197
 
        while precise_file_ids:
1198
 
            precise_file_ids.discard(None)
1199
 
            # Don't emit file_ids twice
1200
 
            precise_file_ids.difference_update(changed_file_ids)
1201
 
            if not precise_file_ids:
1202
 
                break
1203
 
            # If the there was something at a given output path in source, we
1204
 
            # have to include the entry from source in the delta, or we would
1205
 
            # be putting this entry into a used path.
1206
 
            paths = []
1207
 
            for parent_id in precise_file_ids:
1208
 
                try:
1209
 
                    paths.append(self.target.id2path(parent_id))
1210
 
                except errors.NoSuchId:
1211
 
                    # This id has been dragged in from the source by delta
1212
 
                    # expansion and isn't present in target at all: we don't
1213
 
                    # need to check for path collisions on it.
1214
 
                    pass
1215
 
            for path in paths:
1216
 
                old_id = self.source.path2id(path)
1217
 
                precise_file_ids.add(old_id)
1218
 
            precise_file_ids.discard(None)
1219
 
            current_ids = precise_file_ids
1220
 
            precise_file_ids = set()
1221
 
            # We have to emit all of precise_file_ids that have been altered.
1222
 
            # We may have to output the children of some of those ids if any
1223
 
            # directories have stopped being directories.
1224
 
            for file_id in current_ids:
1225
 
                # Examine file_id
1226
 
                if discarded_changes:
1227
 
                    result = discarded_changes.get(file_id)
1228
 
                    old_entry = None
1229
 
                else:
1230
 
                    result = None
1231
 
                if result is None:
1232
 
                    old_entry = self._get_entry(self.source, file_id)
1233
 
                    new_entry = self._get_entry(self.target, file_id)
1234
 
                    result, changes = self._changes_from_entries(
1235
 
                        old_entry, new_entry)
1236
 
                else:
1237
 
                    changes = True
1238
 
                # Get this parents parent to examine.
1239
 
                new_parent_id = result[4][1]
1240
 
                precise_file_ids.add(new_parent_id)
1241
 
                if changes:
1242
 
                    if (result[6][0] == 'directory' and
1243
 
                        result[6][1] != 'directory'):
1244
 
                        # This stopped being a directory, the old children have
1245
 
                        # to be included.
1246
 
                        if old_entry is None:
1247
 
                            # Reusing a discarded change.
1248
 
                            old_entry = self._get_entry(self.source, file_id)
1249
 
                        for child in old_entry.children.values():
1250
 
                            precise_file_ids.add(child.file_id)
1251
 
                    changed_file_ids.add(result[0])
1252
 
                    yield result
1253
1063
 
1254
1064
 
1255
1065
class MultiWalker(object):