41
59
class _TransformResults(object):
42
def __init__(self, modified_paths):
60
def __init__(self, modified_paths, rename_count):
43
61
object.__init__(self)
44
62
self.modified_paths = modified_paths
47
class TreeTransform(object):
48
"""Represent a tree transformation.
50
This object is designed to support incremental generation of the transform,
53
It is easy to produce malformed transforms, but they are generally
54
harmless. Attempting to apply a malformed transform will cause an
55
exception to be raised before any modifications are made to the tree.
57
Many kinds of malformed transforms can be corrected with the
58
resolve_conflicts function. The remaining ones indicate programming error,
59
such as trying to create a file with no path.
61
Two sets of file creation methods are supplied. Convenience methods are:
66
These are composed of the low-level methods:
68
* create_file or create_directory or create_symlink
72
def __init__(self, tree, pb=DummyProgress()):
73
"""Note: a write lock is taken on the tree.
75
Use TreeTransform.finalize() to release the lock
63
self.rename_count = rename_count
66
class TreeTransformBase(object):
67
"""The base class for TreeTransform and TreeTransformBase"""
69
def __init__(self, tree, limbodir, pb=DummyProgress(),
73
:param tree: The tree that will be transformed, but not necessarily
75
:param limbodir: A directory where new files can be stored until
76
they are installed in their proper places
77
:param pb: A ProgressBar indicating how much progress is being made
78
:param case_sensitive: If True, the target of the transform is
79
case sensitive, not just case preserving.
77
81
object.__init__(self)
79
self._tree.lock_write()
81
control_files = self._tree._control_files
82
self._limbodir = control_files.controlfilename('limbo')
84
os.mkdir(self._limbodir)
86
if e.errno == errno.EEXIST:
87
raise ExistingLimbo(self._limbodir)
83
self._limbodir = limbodir
92
84
self._id_number = 0
85
# mapping of trans_id -> new basename
93
86
self._new_name = {}
87
# mapping of trans_id -> new parent trans_id
94
88
self._new_parent = {}
89
# mapping of trans_id with new contents -> new file_kind
95
90
self._new_contents = {}
91
# A mapping of transform ids to their limbo filename
92
self._limbo_files = {}
93
# A mapping of transform ids to a set of the transform ids of children
94
# that their limbo directory has
95
self._limbo_children = {}
96
# Map transform ids to maps of child filename to child transform id
97
self._limbo_children_names = {}
98
# List of transform ids that need to be renamed from limbo into place
99
self._needs_rename = set()
100
# Set of trans_ids whose contents will be removed
96
101
self._removed_contents = set()
102
# Mapping of trans_id -> new execute-bit value
97
103
self._new_executability = {}
104
# Mapping of trans_id -> new tree-reference value
105
self._new_reference_revision = {}
106
# Mapping of trans_id -> new file_id
108
# Mapping of old file-id -> trans_id
99
109
self._non_present_ids = {}
110
# Mapping of new file_id -> trans_id
100
111
self._r_new_id = {}
112
# Set of file_ids that will be removed
101
113
self._removed_id = set()
114
# Mapping of path in old tree -> trans_id
102
115
self._tree_path_ids = {}
116
# Mapping trans_id -> path in old tree
103
117
self._tree_id_paths = {}
118
# Cache of realpath results, to speed up canonical_path
120
# Cache of relpath results, to speed up canonical_path
122
# The trans_id that will be used as the tree root
104
123
self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
124
# Indictor of whether the transform has been applied
128
# Whether the target is case sensitive
129
self._case_sensitive_target = case_sensitive
130
# A counter of how many files have been renamed
131
self.rename_count = 0
108
133
def __get_root(self):
109
134
return self._new_root
680
"""Apply all changes to the inventory and filesystem.
682
If filesystem or inventory conflicts are present, MalformedTransform
685
conflicts = self.find_conflicts()
686
if len(conflicts) != 0:
687
raise MalformedTransform(conflicts=conflicts)
689
inv = self._tree.inventory
690
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
692
child_pb.update('Apply phase', 0, 2)
693
self._apply_removals(inv, limbo_inv)
694
child_pb.update('Apply phase', 1, 2)
695
modified_paths = self._apply_insertions(inv, limbo_inv)
698
self._tree._write_inventory(inv)
701
return _TransformResults(modified_paths)
703
795
def _limbo_name(self, trans_id):
704
796
"""Generate the limbo name of a file"""
705
return pathjoin(self._limbodir, trans_id)
707
def _apply_removals(self, inv, limbo_inv):
708
"""Perform tree operations that remove directory/inventory names.
710
That is, delete files that are to be deleted, and put any files that
711
need renaming into limbo. This must be done in strict child-to-parent
714
tree_paths = list(self._tree_path_ids.iteritems())
715
tree_paths.sort(reverse=True)
716
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
718
for num, data in enumerate(tree_paths):
719
path, trans_id = data
720
child_pb.update('removing file', num, len(tree_paths))
721
full_path = self._tree.abspath(path)
722
if trans_id in self._removed_contents:
723
delete_any(full_path)
724
elif trans_id in self._new_name or trans_id in \
727
os.rename(full_path, self._limbo_name(trans_id))
729
if e.errno != errno.ENOENT:
731
if trans_id in self._removed_id:
732
if trans_id == self._new_root:
733
file_id = self._tree.inventory.root.file_id
797
limbo_name = self._limbo_files.get(trans_id)
798
if limbo_name is not None:
800
parent = self._new_parent.get(trans_id)
801
# if the parent directory is already in limbo (e.g. when building a
802
# tree), choose a limbo name inside the parent, to reduce further
804
use_direct_path = False
805
if self._new_contents.get(parent) == 'directory':
806
filename = self._new_name.get(trans_id)
807
if filename is not None:
808
if parent not in self._limbo_children:
809
self._limbo_children[parent] = set()
810
self._limbo_children_names[parent] = {}
811
use_direct_path = True
812
# the direct path can only be used if no other file has
813
# already taken this pathname, i.e. if the name is unused, or
814
# if it is already associated with this trans_id.
815
elif self._case_sensitive_target:
816
if (self._limbo_children_names[parent].get(filename)
817
in (trans_id, None)):
818
use_direct_path = True
820
for l_filename, l_trans_id in\
821
self._limbo_children_names[parent].iteritems():
822
if l_trans_id == trans_id:
824
if l_filename.lower() == filename.lower():
735
file_id = self.tree_file_id(trans_id)
737
elif trans_id in self._new_name or trans_id in self._new_parent:
738
file_id = self.tree_file_id(trans_id)
739
if file_id is not None:
740
limbo_inv[trans_id] = inv[file_id]
745
def _apply_insertions(self, inv, limbo_inv):
746
"""Perform tree operations that insert directory/inventory names.
748
That is, create any files that need to be created, and restore from
749
limbo any files that needed renaming. This must be done in strict
750
parent-to-child order.
752
new_paths = self.new_paths()
754
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
756
for num, (path, trans_id) in enumerate(new_paths):
757
child_pb.update('adding file', num, len(new_paths))
759
kind = self._new_contents[trans_id]
761
kind = contents = None
762
if trans_id in self._new_contents or \
763
self.path_changed(trans_id):
764
full_path = self._tree.abspath(path)
766
os.rename(self._limbo_name(trans_id), full_path)
768
# We may be renaming a dangling inventory id
769
if e.errno != errno.ENOENT:
771
if trans_id in self._new_contents:
772
modified_paths.append(full_path)
773
del self._new_contents[trans_id]
775
if trans_id in self._new_id:
777
kind = file_kind(self._tree.abspath(path))
778
inv.add_path(path, kind, self._new_id[trans_id])
779
elif trans_id in self._new_name or trans_id in\
781
entry = limbo_inv.get(trans_id)
782
if entry is not None:
783
entry.name = self.final_name(trans_id)
784
parent_path = os.path.dirname(path)
786
self._tree.inventory.path2id(parent_path)
789
# requires files and inventory entries to be in place
790
if trans_id in self._new_executability:
791
self._set_executability(path, inv, trans_id)
794
return modified_paths
796
def _set_executability(self, path, inv, trans_id):
827
use_direct_path = True
830
limbo_name = pathjoin(self._limbo_files[parent], filename)
831
self._limbo_children[parent].add(trans_id)
832
self._limbo_children_names[parent][filename] = trans_id
834
limbo_name = pathjoin(self._limbodir, trans_id)
835
self._needs_rename.add(trans_id)
836
self._limbo_files[trans_id] = limbo_name
839
def _set_executability(self, path, entry, trans_id):
797
840
"""Set the executability of versioned files """
798
file_id = inv.path2id(path)
799
841
new_executability = self._new_executability[trans_id]
800
inv[file_id].executable = new_executability
842
entry.executable = new_executability
801
843
if supports_executable():
802
844
abspath = self._tree.abspath(path)
803
845
current_mode = os.stat(abspath).st_mode
861
906
self.create_symlink(target, trans_id)
909
def _affected_ids(self):
910
"""Return the set of transform ids affected by the transform"""
911
trans_ids = set(self._removed_id)
912
trans_ids.update(self._new_id.keys())
913
trans_ids.update(self._removed_contents)
914
trans_ids.update(self._new_contents.keys())
915
trans_ids.update(self._new_executability.keys())
916
trans_ids.update(self._new_name.keys())
917
trans_ids.update(self._new_parent.keys())
920
def _get_file_id_maps(self):
921
"""Return mapping of file_ids to trans_ids in the to and from states"""
922
trans_ids = self._affected_ids()
925
# Build up two dicts: trans_ids associated with file ids in the
926
# FROM state, vs the TO state.
927
for trans_id in trans_ids:
928
from_file_id = self.tree_file_id(trans_id)
929
if from_file_id is not None:
930
from_trans_ids[from_file_id] = trans_id
931
to_file_id = self.final_file_id(trans_id)
932
if to_file_id is not None:
933
to_trans_ids[to_file_id] = trans_id
934
return from_trans_ids, to_trans_ids
936
def _from_file_data(self, from_trans_id, from_versioned, file_id):
937
"""Get data about a file in the from (tree) state
939
Return a (name, parent, kind, executable) tuple
941
from_path = self._tree_id_paths.get(from_trans_id)
943
# get data from working tree if versioned
944
from_entry = self._tree.inventory[file_id]
945
from_name = from_entry.name
946
from_parent = from_entry.parent_id
949
if from_path is None:
950
# File does not exist in FROM state
954
# File exists, but is not versioned. Have to use path-
956
from_name = os.path.basename(from_path)
957
tree_parent = self.get_tree_parent(from_trans_id)
958
from_parent = self.tree_file_id(tree_parent)
959
if from_path is not None:
960
from_kind, from_executable, from_stats = \
961
self._tree._comparison_data(from_entry, from_path)
964
from_executable = False
965
return from_name, from_parent, from_kind, from_executable
967
def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
968
"""Get data about a file in the to (target) state
970
Return a (name, parent, kind, executable) tuple
972
to_name = self.final_name(to_trans_id)
974
to_kind = self.final_kind(to_trans_id)
977
to_parent = self.final_file_id(self.final_parent(to_trans_id))
978
if to_trans_id in self._new_executability:
979
to_executable = self._new_executability[to_trans_id]
980
elif to_trans_id == from_trans_id:
981
to_executable = from_executable
983
to_executable = False
984
return to_name, to_parent, to_kind, to_executable
986
def _iter_changes(self):
987
"""Produce output in the same format as Tree._iter_changes.
989
Will produce nonsensical results if invoked while inventory/filesystem
990
conflicts (as reported by TreeTransform.find_conflicts()) are present.
992
This reads the Transform, but only reproduces changes involving a
993
file_id. Files that are not versioned in either of the FROM or TO
994
states are not reflected.
996
final_paths = FinalPaths(self)
997
from_trans_ids, to_trans_ids = self._get_file_id_maps()
999
# Now iterate through all active file_ids
1000
for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
1002
from_trans_id = from_trans_ids.get(file_id)
1003
# find file ids, and determine versioning state
1004
if from_trans_id is None:
1005
from_versioned = False
1006
from_trans_id = to_trans_ids[file_id]
1008
from_versioned = True
1009
to_trans_id = to_trans_ids.get(file_id)
1010
if to_trans_id is None:
1011
to_versioned = False
1012
to_trans_id = from_trans_id
1016
from_name, from_parent, from_kind, from_executable = \
1017
self._from_file_data(from_trans_id, from_versioned, file_id)
1019
to_name, to_parent, to_kind, to_executable = \
1020
self._to_file_data(to_trans_id, from_trans_id, from_executable)
1022
if not from_versioned:
1025
from_path = self._tree_id_paths.get(from_trans_id)
1026
if not to_versioned:
1029
to_path = final_paths.get_path(to_trans_id)
1030
if from_kind != to_kind:
1032
elif to_kind in ('file', 'symlink') and (
1033
to_trans_id != from_trans_id or
1034
to_trans_id in self._new_contents):
1036
if (not modified and from_versioned == to_versioned and
1037
from_parent==to_parent and from_name == to_name and
1038
from_executable == to_executable):
1040
results.append((file_id, (from_path, to_path), modified,
1041
(from_versioned, to_versioned),
1042
(from_parent, to_parent),
1043
(from_name, to_name),
1044
(from_kind, to_kind),
1045
(from_executable, to_executable)))
1046
return iter(sorted(results, key=lambda x:x[1]))
1048
def get_preview_tree(self):
1049
"""Return a tree representing the result of the transform.
1051
This tree only supports the subset of Tree functionality required
1052
by show_diff_trees. It must only be compared to tt._tree.
1054
return _PreviewTree(self)
1057
class TreeTransform(TreeTransformBase):
1058
"""Represent a tree transformation.
1060
This object is designed to support incremental generation of the transform,
1063
However, it gives optimum performance when parent directories are created
1064
before their contents. The transform is then able to put child files
1065
directly in their parent directory, avoiding later renames.
1067
It is easy to produce malformed transforms, but they are generally
1068
harmless. Attempting to apply a malformed transform will cause an
1069
exception to be raised before any modifications are made to the tree.
1071
Many kinds of malformed transforms can be corrected with the
1072
resolve_conflicts function. The remaining ones indicate programming error,
1073
such as trying to create a file with no path.
1075
Two sets of file creation methods are supplied. Convenience methods are:
1080
These are composed of the low-level methods:
1082
* create_file or create_directory or create_symlink
1086
Transform/Transaction ids
1087
-------------------------
1088
trans_ids are temporary ids assigned to all files involved in a transform.
1089
It's possible, even common, that not all files in the Tree have trans_ids.
1091
trans_ids are used because filenames and file_ids are not good enough
1092
identifiers; filenames change, and not all files have file_ids. File-ids
1093
are also associated with trans-ids, so that moving a file moves its
1096
trans_ids are only valid for the TreeTransform that generated them.
1100
Limbo is a temporary directory use to hold new versions of files.
1101
Files are added to limbo by create_file, create_directory, create_symlink,
1102
and their convenience variants (new_*). Files may be removed from limbo
1103
using cancel_creation. Files are renamed from limbo into their final
1104
location as part of TreeTransform.apply
1106
Limbo must be cleaned up, by either calling TreeTransform.apply or
1107
calling TreeTransform.finalize.
1109
Files are placed into limbo inside their parent directories, where
1110
possible. This reduces subsequent renames, and makes operations involving
1111
lots of files faster. This optimization is only possible if the parent
1112
directory is created *before* creating any of its children, so avoid
1113
creating children before parents, where possible.
1117
This temporary directory is used by _FileMover for storing files that are
1118
about to be deleted. In case of rollback, the files will be restored.
1119
FileMover does not delete files until it is sure that a rollback will not
1122
def __init__(self, tree, pb=DummyProgress()):
1123
"""Note: a tree_write lock is taken on the tree.
1125
Use TreeTransform.finalize() to release the lock (can be omitted if
1126
TreeTransform.apply() called).
1128
tree.lock_tree_write()
1131
control_files = tree._control_files
1132
limbodir = urlutils.local_path_from_url(
1133
control_files.controlfilename('limbo'))
1137
if e.errno == errno.EEXIST:
1138
raise ExistingLimbo(limbodir)
1139
self._deletiondir = urlutils.local_path_from_url(
1140
control_files.controlfilename('pending-deletion'))
1142
os.mkdir(self._deletiondir)
1144
if e.errno == errno.EEXIST:
1145
raise errors.ExistingPendingDeletion(self._deletiondir)
1150
TreeTransformBase.__init__(self, tree, limbodir, pb,
1151
tree.case_sensitive)
1153
def apply(self, no_conflicts=False, _mover=None):
1154
"""Apply all changes to the inventory and filesystem.
1156
If filesystem or inventory conflicts are present, MalformedTransform
1159
If apply succeeds, finalize is not necessary.
1161
:param no_conflicts: if True, the caller guarantees there are no
1162
conflicts, so no check is made.
1163
:param _mover: Supply an alternate FileMover, for testing
1165
if not no_conflicts:
1166
conflicts = self.find_conflicts()
1167
if len(conflicts) != 0:
1168
raise MalformedTransform(conflicts=conflicts)
1169
inv = self._tree.inventory
1170
inventory_delta = []
1171
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1174
mover = _FileMover()
1178
child_pb.update('Apply phase', 0, 2)
1179
self._apply_removals(inv, inventory_delta, mover)
1180
child_pb.update('Apply phase', 1, 2)
1181
modified_paths = self._apply_insertions(inv, inventory_delta,
1187
mover.apply_deletions()
1190
self._tree.apply_inventory_delta(inventory_delta)
1193
return _TransformResults(modified_paths, self.rename_count)
1195
def _apply_removals(self, inv, inventory_delta, mover):
1196
"""Perform tree operations that remove directory/inventory names.
1198
That is, delete files that are to be deleted, and put any files that
1199
need renaming into limbo. This must be done in strict child-to-parent
1202
tree_paths = list(self._tree_path_ids.iteritems())
1203
tree_paths.sort(reverse=True)
1204
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1206
for num, data in enumerate(tree_paths):
1207
path, trans_id = data
1208
child_pb.update('removing file', num, len(tree_paths))
1209
full_path = self._tree.abspath(path)
1210
if trans_id in self._removed_contents:
1211
mover.pre_delete(full_path, os.path.join(self._deletiondir,
1213
elif trans_id in self._new_name or trans_id in \
1216
mover.rename(full_path, self._limbo_name(trans_id))
1218
if e.errno != errno.ENOENT:
1221
self.rename_count += 1
1222
if trans_id in self._removed_id:
1223
if trans_id == self._new_root:
1224
file_id = self._tree.get_root_id()
1226
file_id = self.tree_file_id(trans_id)
1227
if file_id is not None:
1228
inventory_delta.append((path, None, file_id, None))
1232
def _apply_insertions(self, inv, inventory_delta, mover):
1233
"""Perform tree operations that insert directory/inventory names.
1235
That is, create any files that need to be created, and restore from
1236
limbo any files that needed renaming. This must be done in strict
1237
parent-to-child order.
1239
new_paths = self.new_paths()
1241
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1244
for num, (path, trans_id) in enumerate(new_paths):
1246
child_pb.update('adding file', num, len(new_paths))
1248
kind = self._new_contents[trans_id]
1250
kind = contents = None
1251
if trans_id in self._new_contents or \
1252
self.path_changed(trans_id):
1253
full_path = self._tree.abspath(path)
1254
if trans_id in self._needs_rename:
1256
mover.rename(self._limbo_name(trans_id), full_path)
1258
# We may be renaming a dangling inventory id
1259
if e.errno != errno.ENOENT:
1262
self.rename_count += 1
1263
if trans_id in self._new_contents:
1264
modified_paths.append(full_path)
1265
completed_new.append(trans_id)
1267
if trans_id in self._new_id:
1269
kind = file_kind(self._tree.abspath(path))
1270
if trans_id in self._new_reference_revision:
1271
new_entry = inventory.TreeReference(
1272
self._new_id[trans_id],
1273
self._new_name[trans_id],
1274
self.final_file_id(self._new_parent[trans_id]),
1275
None, self._new_reference_revision[trans_id])
1277
new_entry = inventory.make_entry(kind,
1278
self.final_name(trans_id),
1279
self.final_file_id(self.final_parent(trans_id)),
1280
self._new_id[trans_id])
1282
if trans_id in self._new_name or trans_id in\
1283
self._new_parent or\
1284
trans_id in self._new_executability:
1285
file_id = self.final_file_id(trans_id)
1286
if file_id is not None:
1287
entry = inv[file_id]
1288
new_entry = entry.copy()
1290
if trans_id in self._new_name or trans_id in\
1292
if new_entry is not None:
1293
new_entry.name = self.final_name(trans_id)
1294
parent = self.final_parent(trans_id)
1295
parent_id = self.final_file_id(parent)
1296
new_entry.parent_id = parent_id
1298
if trans_id in self._new_executability:
1299
self._set_executability(path, new_entry, trans_id)
1300
if new_entry is not None:
1301
if new_entry.file_id in inv:
1302
old_path = inv.id2path(new_entry.file_id)
1305
inventory_delta.append((old_path, path,
1310
for trans_id in completed_new:
1311
del self._new_contents[trans_id]
1312
return modified_paths
1315
class TransformPreview(TreeTransformBase):
1316
"""A TreeTransform for generating preview trees.
1318
Unlike TreeTransform, this version works when the input tree is a
1319
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1320
unversioned files in the input tree.
1323
def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1324
limbodir = tempfile.mkdtemp()
1325
TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
1327
def canonical_path(self, path):
1330
def tree_kind(self, trans_id):
1331
path = self._tree_id_paths.get(trans_id)
1333
raise NoSuchFile(None)
1334
file_id = self._tree.path2id(path)
1335
return self._tree.kind(file_id)
1337
def _set_mode(self, trans_id, mode_id, typefunc):
1338
"""Set the mode of new file contents.
1339
The mode_id is the existing file to get the mode from (often the same
1340
as trans_id). The operation is only performed if there's a mode match
1341
according to typefunc.
1343
# is it ok to ignore this? probably
1346
def iter_tree_children(self, parent_id):
1347
"""Iterate through the entry's tree children, if any"""
1349
path = self._tree_id_paths[parent_id]
1352
file_id = self.tree_file_id(parent_id)
1353
for child in self._tree.inventory[file_id].children.iterkeys():
1354
childpath = joinpath(path, child)
1355
yield self.trans_id_tree_path(childpath)
1358
class _PreviewTree(object):
1359
"""Partial implementation of Tree to support show_diff_trees"""
1361
def __init__(self, transform):
1362
self._transform = transform
1364
def lock_read(self):
1365
# Perhaps in theory, this should lock the TreeTransform?
1371
def _iter_changes(self, from_tree, include_unchanged=False,
1372
specific_files=None, pb=None, extra_trees=None,
1373
require_versioned=True, want_unversioned=False):
1374
"""See InterTree._iter_changes.
1376
This implementation does not support include_unchanged, specific_files,
1377
or want_unversioned. extra_trees, require_versioned, and pb are
1380
if from_tree is not self._transform._tree:
1381
raise ValueError('from_tree must be transform source tree.')
1382
if include_unchanged:
1383
raise ValueError('include_unchanged is not supported')
1384
if specific_files is not None:
1385
raise ValueError('specific_files is not supported')
1386
if want_unversioned:
1387
raise ValueError('want_unversioned is not supported')
1388
return self._transform._iter_changes()
1390
def kind(self, file_id):
1391
trans_id = self._transform.trans_id_file_id(file_id)
1392
return self._transform.final_kind(trans_id)
1394
def get_file_mtime(self, file_id, path=None):
1395
"""See Tree.get_file_mtime"""
1396
trans_id = self._transform.trans_id_file_id(file_id)
1397
name = self._transform._limbo_name(trans_id)
1398
return os.stat(name).st_mtime
1400
def get_file(self, file_id):
1401
"""See Tree.get_file"""
1402
trans_id = self._transform.trans_id_file_id(file_id)
1403
name = self._transform._limbo_name(trans_id)
1404
return open(name, 'rb')
1406
def paths2ids(self, specific_files, trees=None, require_versioned=False):
1407
"""See Tree.paths2ids"""
864
1411
def joinpath(parent, child):
865
1412
"""Join tree-relative paths, handling the tree root specially"""
866
1413
if parent is None or parent == "":
896
1443
self._known_paths[trans_id] = self._determine_path(trans_id)
897
1444
return self._known_paths[trans_id]
899
1447
def topology_sorted_ids(tree):
900
1448
"""Determine the topological order of the ids in a tree"""
901
1449
file_ids = list(tree)
902
1450
file_ids.sort(key=tree.id2path)
905
def build_tree(tree, wt):
906
"""Create working tree for a branch, using a Transaction."""
1454
def build_tree(tree, wt, accelerator_tree=None):
1455
"""Create working tree for a branch, using a TreeTransform.
1457
This function should be used on empty trees, having a tree root at most.
1458
(see merge and revert functionality for working with existing trees)
1460
Existing files are handled like so:
1462
- Existing bzrdirs take precedence over creating new items. They are
1463
created as '%s.diverted' % name.
1464
- Otherwise, if the content on disk matches the content we are building,
1465
it is silently replaced.
1466
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
1468
:param tree: The tree to convert wt into a copy of
1469
:param wt: The working tree that files will be placed into
1470
:param accelerator_tree: A tree which can be used for retrieving file
1471
contents more quickly than tree itself, i.e. a workingtree. tree
1472
will be used for cases where accelerator_tree's content is different.
1474
wt.lock_tree_write()
1478
if accelerator_tree is not None:
1479
accelerator_tree.lock_read()
1481
return _build_tree(tree, wt, accelerator_tree)
1483
if accelerator_tree is not None:
1484
accelerator_tree.unlock()
1491
def _build_tree(tree, wt, accelerator_tree):
1492
"""See build_tree."""
1493
if len(wt.inventory) > 1: # more than just a root
1494
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
907
1495
file_trans_id = {}
908
1496
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
909
1497
pp = ProgressPhase("Build phase", 2, top_pb)
1498
if tree.inventory.root is not None:
1499
# This is kind of a hack: we should be altering the root
1500
# as part of the regular tree shape diff logic.
1501
# The conditional test here is to avoid doing an
1502
# expensive operation (flush) every time the root id
1503
# is set within the tree, nor setting the root and thus
1504
# marking the tree as dirty, because we use two different
1505
# idioms here: tree interfaces and inventory interfaces.
1506
if wt.get_root_id() != tree.get_root_id():
1507
wt.set_root_id(tree.get_root_id())
910
1509
tt = TreeTransform(wt)
913
file_trans_id[wt.get_root_id()] = tt.trans_id_tree_file_id(wt.get_root_id())
914
file_ids = topology_sorted_ids(tree)
1513
file_trans_id[wt.get_root_id()] = \
1514
tt.trans_id_tree_file_id(wt.get_root_id())
915
1515
pb = bzrlib.ui.ui_factory.nested_progress_bar()
917
for num, file_id in enumerate(file_ids):
918
pb.update("Building tree", num, len(file_ids))
919
entry = tree.inventory[file_id]
1517
deferred_contents = []
1518
for num, (tree_path, entry) in \
1519
enumerate(tree.inventory.iter_entries_by_dir()):
1520
pb.update("Building tree", num - len(deferred_contents),
1521
len(tree.inventory))
920
1522
if entry.parent_id is None:
1525
file_id = entry.file_id
1526
target_path = wt.abspath(tree_path)
1528
kind = file_kind(target_path)
1532
if kind == "directory":
1534
bzrdir.BzrDir.open(target_path)
1535
except errors.NotBranchError:
1539
if (file_id not in divert and
1540
_content_match(tree, entry, file_id, kind,
1542
tt.delete_contents(tt.trans_id_tree_path(tree_path))
1543
if kind == 'directory':
922
1545
if entry.parent_id not in file_trans_id:
923
raise repr(entry.parent_id)
1546
raise AssertionError(
1547
'entry %s parent id %r is not in file_trans_id %r'
1548
% (entry, entry.parent_id, file_trans_id))
924
1549
parent_id = file_trans_id[entry.parent_id]
925
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
1550
if entry.kind == 'file':
1551
# We *almost* replicate new_by_entry, so that we can defer
1552
# getting the file text, and get them all at once.
1553
trans_id = tt.create_path(entry.name, parent_id)
1554
file_trans_id[file_id] = trans_id
1555
tt.version_file(entry.file_id, trans_id)
1556
executable = tree.is_executable(entry.file_id, tree_path)
1557
if executable is not None:
1558
tt.set_executability(executable, trans_id)
1559
deferred_contents.append((entry.file_id, trans_id))
1561
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
1564
new_trans_id = file_trans_id[file_id]
1565
old_parent = tt.trans_id_tree_path(tree_path)
1566
_reparent_children(tt, old_parent, new_trans_id)
1567
for num, (trans_id, bytes) in enumerate(
1568
_iter_files_bytes_accelerated(tree, accelerator_tree,
1569
deferred_contents)):
1570
tt.create_file(bytes, trans_id)
1571
pb.update('Adding file contents',
1572
(num + len(tree.inventory) - len(deferred_contents)),
1573
len(tree.inventory))
1577
divert_trans = set(file_trans_id[f] for f in divert)
1578
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
1579
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
1580
conflicts = cook_conflicts(raw_conflicts, tt)
1581
for conflict in conflicts:
1584
wt.add_conflicts(conflicts)
1585
except errors.UnsupportedOperation:
1587
result = tt.apply(no_conflicts=True)
933
1590
top_pb.finished()
1594
def _iter_files_bytes_accelerated(tree, accelerator_tree, desired_files):
1595
if accelerator_tree is None:
1596
new_desired_files = desired_files
1598
iter = accelerator_tree._iter_changes(tree, include_unchanged=True)
1599
unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
1601
new_desired_files = []
1602
for file_id, identifier in desired_files:
1603
accelerator_path = unchanged.get(file_id)
1604
if accelerator_path is None:
1605
new_desired_files.append((file_id, identifier))
1607
contents = accelerator_tree.get_file(file_id, accelerator_path)
1610
contents_bytes = (contents.read(),)
1613
yield identifier, contents_bytes
1614
for result in tree.iter_files_bytes(new_desired_files):
1618
def _reparent_children(tt, old_parent, new_parent):
1619
for child in tt.iter_tree_children(old_parent):
1620
tt.adjust_path(tt.final_name(child), new_parent, child)
1622
def _reparent_transform_children(tt, old_parent, new_parent):
1623
by_parent = tt.by_parent()
1624
for child in by_parent[old_parent]:
1625
tt.adjust_path(tt.final_name(child), new_parent, child)
1627
def _content_match(tree, entry, file_id, kind, target_path):
1628
if entry.kind != kind:
1630
if entry.kind == "directory":
1632
if entry.kind == "file":
1633
if tree.get_file(file_id).read() == file(target_path, 'rb').read():
1635
elif entry.kind == "symlink":
1636
if tree.get_symlink_target(file_id) == os.readlink(target_path):
1641
def resolve_checkout(tt, conflicts, divert):
1642
new_conflicts = set()
1643
for c_type, conflict in ((c[0], c) for c in conflicts):
1644
# Anything but a 'duplicate' would indicate programmer error
1645
assert c_type == 'duplicate', c_type
1646
# Now figure out which is new and which is old
1647
if tt.new_contents(conflict[1]):
1648
new_file = conflict[1]
1649
old_file = conflict[2]
1651
new_file = conflict[2]
1652
old_file = conflict[1]
1654
# We should only get here if the conflict wasn't completely
1656
final_parent = tt.final_parent(old_file)
1657
if new_file in divert:
1658
new_name = tt.final_name(old_file)+'.diverted'
1659
tt.adjust_path(new_name, final_parent, new_file)
1660
new_conflicts.add((c_type, 'Diverted to',
1661
new_file, old_file))
1663
new_name = tt.final_name(old_file)+'.moved'
1664
tt.adjust_path(new_name, final_parent, old_file)
1665
new_conflicts.add((c_type, 'Moved existing file to',
1666
old_file, new_file))
1667
return new_conflicts
935
1670
def new_by_entry(tt, entry, parent_id, tree):
936
1671
"""Create a new file according to its inventory entry"""
1065
1810
return has_contents, contents_mod, meta_mod
1068
def revert(working_tree, target_tree, filenames, backups=False,
1069
pb=DummyProgress()):
1813
def revert(working_tree, target_tree, filenames, backups=False,
1814
pb=DummyProgress(), change_reporter=None):
1070
1815
"""Revert a working tree's contents to those of a target tree."""
1071
interesting_ids = find_interesting(working_tree, target_tree, filenames)
1072
def interesting(file_id):
1073
return interesting_ids is None or file_id in interesting_ids
1816
target_tree.lock_read()
1075
1817
tt = TreeTransform(working_tree, pb)
1077
merge_modified = working_tree.merge_modified()
1079
def trans_id_file_id(file_id):
1081
return trans_id[file_id]
1083
return tt.trans_id_tree_file_id(file_id)
1085
pp = ProgressPhase("Revert phase", 4, pb)
1087
sorted_interesting = [i for i in topology_sorted_ids(target_tree) if
1089
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1091
by_parent = tt.by_parent()
1092
for id_num, file_id in enumerate(sorted_interesting):
1093
child_pb.update("Reverting file", id_num+1,
1094
len(sorted_interesting))
1095
if file_id not in working_tree.inventory:
1096
entry = target_tree.inventory[file_id]
1097
parent_id = trans_id_file_id(entry.parent_id)
1098
e_trans_id = new_by_entry(tt, entry, parent_id, target_tree)
1099
trans_id[file_id] = e_trans_id
1101
backup_this = backups
1102
if file_id in merge_modified:
1104
del merge_modified[file_id]
1105
change_entry(tt, file_id, working_tree, target_tree,
1106
trans_id_file_id, backup_this, trans_id,
1111
wt_interesting = [i for i in working_tree.inventory if interesting(i)]
1112
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1114
for id_num, file_id in enumerate(wt_interesting):
1115
child_pb.update("New file check", id_num+1,
1116
len(sorted_interesting))
1117
if file_id not in target_tree:
1118
trans_id = tt.trans_id_tree_file_id(file_id)
1119
tt.unversion_file(trans_id)
1120
if file_id in merge_modified:
1819
pp = ProgressPhase("Revert phase", 3, pb)
1821
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1823
merge_modified = _alter_files(working_tree, target_tree, tt,
1824
child_pb, filenames, backups)
1828
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1830
raw_conflicts = resolve_conflicts(tt, child_pb,
1831
lambda t, c: conflict_pass(t, c, target_tree))
1834
conflicts = cook_conflicts(raw_conflicts, tt)
1836
change_reporter = delta._ChangeReporter(
1837
unversioned_filter=working_tree.is_ignored)
1838
delta.report_changes(tt._iter_changes(), change_reporter)
1839
for conflict in conflicts:
1843
working_tree.set_merge_modified(merge_modified)
1845
target_tree.unlock()
1851
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
1853
merge_modified = working_tree.merge_modified()
1854
change_list = target_tree._iter_changes(working_tree,
1855
specific_files=specific_files, pb=pb)
1856
if target_tree.inventory.root is None:
1863
for id_num, (file_id, path, changed_content, versioned, parent, name,
1864
kind, executable) in enumerate(change_list):
1865
if skip_root and file_id[0] is not None and parent[0] is None:
1867
trans_id = tt.trans_id_file_id(file_id)
1870
keep_content = False
1871
if kind[0] == 'file' and (backups or kind[1] is None):
1872
wt_sha1 = working_tree.get_file_sha1(file_id)
1873
if merge_modified.get(file_id) != wt_sha1:
1874
# acquire the basis tree lazily to prevent the
1875
# expense of accessing it when it's not needed ?
1876
# (Guessing, RBC, 200702)
1877
if basis_tree is None:
1878
basis_tree = working_tree.basis_tree()
1879
basis_tree.lock_read()
1880
if file_id in basis_tree:
1881
if wt_sha1 != basis_tree.get_file_sha1(file_id):
1883
elif kind[1] is None and not versioned[1]:
1885
if kind[0] is not None:
1886
if not keep_content:
1121
1887
tt.delete_contents(trans_id)
1122
del merge_modified[file_id]
1126
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1128
raw_conflicts = resolve_conflicts(tt, child_pb)
1131
conflicts = cook_conflicts(raw_conflicts, tt)
1132
for conflict in conflicts:
1136
working_tree.set_merge_modified({})
1888
elif kind[1] is not None:
1889
parent_trans_id = tt.trans_id_file_id(parent[0])
1890
by_parent = tt.by_parent()
1891
backup_name = _get_backup_name(name[0], by_parent,
1892
parent_trans_id, tt)
1893
tt.adjust_path(backup_name, parent_trans_id, trans_id)
1894
new_trans_id = tt.create_path(name[0], parent_trans_id)
1895
if versioned == (True, True):
1896
tt.unversion_file(trans_id)
1897
tt.version_file(file_id, new_trans_id)
1898
# New contents should have the same unix perms as old
1901
trans_id = new_trans_id
1902
if kind[1] == 'directory':
1903
tt.create_directory(trans_id)
1904
elif kind[1] == 'symlink':
1905
tt.create_symlink(target_tree.get_symlink_target(file_id),
1907
elif kind[1] == 'file':
1908
deferred_files.append((file_id, (trans_id, mode_id)))
1909
if basis_tree is None:
1910
basis_tree = working_tree.basis_tree()
1911
basis_tree.lock_read()
1912
new_sha1 = target_tree.get_file_sha1(file_id)
1913
if (file_id in basis_tree and new_sha1 ==
1914
basis_tree.get_file_sha1(file_id)):
1915
if file_id in merge_modified:
1916
del merge_modified[file_id]
1918
merge_modified[file_id] = new_sha1
1920
# preserve the execute bit when backing up
1921
if keep_content and executable[0] == executable[1]:
1922
tt.set_executability(executable[1], trans_id)
1924
assert kind[1] is None
1925
if versioned == (False, True):
1926
tt.version_file(file_id, trans_id)
1927
if versioned == (True, False):
1928
tt.unversion_file(trans_id)
1929
if (name[1] is not None and
1930
(name[0] != name[1] or parent[0] != parent[1])):
1932
name[1], tt.trans_id_file_id(parent[1]), trans_id)
1933
if executable[0] != executable[1] and kind[1] == "file":
1934
tt.set_executability(executable[1], trans_id)
1935
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
1937
tt.create_file(bytes, trans_id, mode_id)
1143
def resolve_conflicts(tt, pb=DummyProgress()):
1939
if basis_tree is not None:
1941
return merge_modified
1944
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
1144
1945
"""Make many conflict-resolution attempts, but die if they fail"""
1946
if pass_func is None:
1947
pass_func = conflict_pass
1145
1948
new_conflicts = set()
1147
1950
for n in range(10):