← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Jonathan Lange
  • Date: 2009-07-20 11:27:05 UTC
  • mfrom: (4526.2.6 1.17)
  • mto: This revision was merged to the branch mainline in revision 4554.
  • Revision ID: jml@canonical.com-20090720112705-ss4o5s3zw3dbxsek
Merge 1.17, resolving conflicts.

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