← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-08-03 07:15:11 UTC
  • mfrom: (4580.1.2 408199-check-2a)
  • Revision ID: pqm@pqm.ubuntu.com-20090803071511-dwb041qzak0vjzdk
(mbp) check blackbox tests now handle the root being included in the
        file-id count

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