62
63
self.rename_count = rename_count
65
class TreeTransform(object):
66
"""Represent a tree transformation.
68
This object is designed to support incremental generation of the transform,
71
However, it gives optimum performance when parent directories are created
72
before their contents. The transform is then able to put child files
73
directly in their parent directory, avoiding later renames.
75
It is easy to produce malformed transforms, but they are generally
76
harmless. Attempting to apply a malformed transform will cause an
77
exception to be raised before any modifications are made to the tree.
79
Many kinds of malformed transforms can be corrected with the
80
resolve_conflicts function. The remaining ones indicate programming error,
81
such as trying to create a file with no path.
83
Two sets of file creation methods are supplied. Convenience methods are:
88
These are composed of the low-level methods:
90
* create_file or create_directory or create_symlink
94
Transform/Transaction ids
95
-------------------------
96
trans_ids are temporary ids assigned to all files involved in a transform.
97
It's possible, even common, that not all files in the Tree have trans_ids.
99
trans_ids are used because filenames and file_ids are not good enough
100
identifiers; filenames change, and not all files have file_ids. File-ids
101
are also associated with trans-ids, so that moving a file moves its
104
trans_ids are only valid for the TreeTransform that generated them.
108
Limbo is a temporary directory use to hold new versions of files.
109
Files are added to limbo by create_file, create_directory, create_symlink,
110
and their convenience variants (new_*). Files may be removed from limbo
111
using cancel_creation. Files are renamed from limbo into their final
112
location as part of TreeTransform.apply
114
Limbo must be cleaned up, by either calling TreeTransform.apply or
115
calling TreeTransform.finalize.
117
Files are placed into limbo inside their parent directories, where
118
possible. This reduces subsequent renames, and makes operations involving
119
lots of files faster. This optimization is only possible if the parent
120
directory is created *before* creating any of its children, so avoid
121
creating children before parents, where possible.
125
This temporary directory is used by _FileMover for storing files that are
126
about to be deleted. In case of rollback, the files will be restored.
127
FileMover does not delete files until it is sure that a rollback will not
130
def __init__(self, tree, pb=DummyProgress()):
131
"""Note: a tree_write lock is taken on the tree.
133
Use TreeTransform.finalize() to release the lock (can be omitted if
134
TreeTransform.apply() called).
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.
136
81
object.__init__(self)
138
self._tree.lock_tree_write()
140
control_files = self._tree._control_files
141
self._limbodir = urlutils.local_path_from_url(
142
control_files.controlfilename('limbo'))
144
os.mkdir(self._limbodir)
146
if e.errno == errno.EEXIST:
147
raise ExistingLimbo(self._limbodir)
148
self._deletiondir = urlutils.local_path_from_url(
149
control_files.controlfilename('pending-deletion'))
151
os.mkdir(self._deletiondir)
153
if e.errno == errno.EEXIST:
154
raise errors.ExistingPendingDeletion(self._deletiondir)
160
# counter used to generate trans-ids (which are locally unique)
83
self._limbodir = limbodir
84
self._deletiondir = None
161
85
self._id_number = 0
162
86
# mapping of trans_id -> new basename
163
87
self._new_name = {}
953
855
self._limbo_files[trans_id] = limbo_name
954
856
return limbo_name
956
def _apply_removals(self, inv, inventory_delta, mover):
957
"""Perform tree operations that remove directory/inventory names.
959
That is, delete files that are to be deleted, and put any files that
960
need renaming into limbo. This must be done in strict child-to-parent
963
tree_paths = list(self._tree_path_ids.iteritems())
964
tree_paths.sort(reverse=True)
965
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
967
for num, data in enumerate(tree_paths):
968
path, trans_id = data
969
child_pb.update('removing file', num, len(tree_paths))
970
full_path = self._tree.abspath(path)
971
if trans_id in self._removed_contents:
972
mover.pre_delete(full_path, os.path.join(self._deletiondir,
974
elif trans_id in self._new_name or trans_id in \
977
mover.rename(full_path, self._limbo_name(trans_id))
979
if e.errno != errno.ENOENT:
982
self.rename_count += 1
983
if trans_id in self._removed_id:
984
if trans_id == self._new_root:
985
file_id = self._tree.get_root_id()
987
file_id = self.tree_file_id(trans_id)
988
if file_id is not None:
989
inventory_delta.append((path, None, file_id, None))
993
def _apply_insertions(self, inv, inventory_delta, mover):
994
"""Perform tree operations that insert directory/inventory names.
996
That is, create any files that need to be created, and restore from
997
limbo any files that needed renaming. This must be done in strict
998
parent-to-child order.
1000
new_paths = self.new_paths()
1002
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1005
for num, (path, trans_id) in enumerate(new_paths):
1007
child_pb.update('adding file', num, len(new_paths))
1009
kind = self._new_contents[trans_id]
1011
kind = contents = None
1012
if trans_id in self._new_contents or \
1013
self.path_changed(trans_id):
1014
full_path = self._tree.abspath(path)
1015
if trans_id in self._needs_rename:
1017
mover.rename(self._limbo_name(trans_id), full_path)
1019
# We may be renaming a dangling inventory id
1020
if e.errno != errno.ENOENT:
1023
self.rename_count += 1
1024
if trans_id in self._new_contents:
1025
modified_paths.append(full_path)
1026
completed_new.append(trans_id)
1028
if trans_id in self._new_id:
1030
kind = file_kind(self._tree.abspath(path))
1031
if trans_id in self._new_reference_revision:
1032
new_entry = inventory.TreeReference(
1033
self._new_id[trans_id],
1034
self._new_name[trans_id],
1035
self.final_file_id(self._new_parent[trans_id]),
1036
None, self._new_reference_revision[trans_id])
1038
new_entry = inventory.make_entry(kind,
1039
self.final_name(trans_id),
1040
self.final_file_id(self.final_parent(trans_id)),
1041
self._new_id[trans_id])
1043
if trans_id in self._new_name or trans_id in\
1044
self._new_parent or\
1045
trans_id in self._new_executability:
1046
file_id = self.final_file_id(trans_id)
1047
if file_id is not None:
1048
entry = inv[file_id]
1049
new_entry = entry.copy()
1051
if trans_id in self._new_name or trans_id in\
1053
if new_entry is not None:
1054
new_entry.name = self.final_name(trans_id)
1055
parent = self.final_parent(trans_id)
1056
parent_id = self.final_file_id(parent)
1057
new_entry.parent_id = parent_id
1059
if trans_id in self._new_executability:
1060
self._set_executability(path, new_entry, trans_id)
1061
if new_entry is not None:
1062
if new_entry.file_id in inv:
1063
old_path = inv.id2path(new_entry.file_id)
1066
inventory_delta.append((old_path, path,
1071
for trans_id in completed_new:
1072
del self._new_contents[trans_id]
1073
return modified_paths
1075
858
def _set_executability(self, path, entry, trans_id):
1076
859
"""Set the executability of versioned files """
1077
860
new_executability = self._new_executability[trans_id]
1281
1064
(from_executable, to_executable)))
1282
1065
return iter(sorted(results, key=lambda x:x[1]))
1067
def get_preview_tree(self):
1068
"""Return a tree representing the result of the transform.
1070
This tree only supports the subset of Tree functionality required
1071
by show_diff_trees. It must only be compared to tt._tree.
1073
return _PreviewTree(self)
1076
class TreeTransform(TreeTransformBase):
1077
"""Represent a tree transformation.
1079
This object is designed to support incremental generation of the transform,
1082
However, it gives optimum performance when parent directories are created
1083
before their contents. The transform is then able to put child files
1084
directly in their parent directory, avoiding later renames.
1086
It is easy to produce malformed transforms, but they are generally
1087
harmless. Attempting to apply a malformed transform will cause an
1088
exception to be raised before any modifications are made to the tree.
1090
Many kinds of malformed transforms can be corrected with the
1091
resolve_conflicts function. The remaining ones indicate programming error,
1092
such as trying to create a file with no path.
1094
Two sets of file creation methods are supplied. Convenience methods are:
1099
These are composed of the low-level methods:
1101
* create_file or create_directory or create_symlink
1105
Transform/Transaction ids
1106
-------------------------
1107
trans_ids are temporary ids assigned to all files involved in a transform.
1108
It's possible, even common, that not all files in the Tree have trans_ids.
1110
trans_ids are used because filenames and file_ids are not good enough
1111
identifiers; filenames change, and not all files have file_ids. File-ids
1112
are also associated with trans-ids, so that moving a file moves its
1115
trans_ids are only valid for the TreeTransform that generated them.
1119
Limbo is a temporary directory use to hold new versions of files.
1120
Files are added to limbo by create_file, create_directory, create_symlink,
1121
and their convenience variants (new_*). Files may be removed from limbo
1122
using cancel_creation. Files are renamed from limbo into their final
1123
location as part of TreeTransform.apply
1125
Limbo must be cleaned up, by either calling TreeTransform.apply or
1126
calling TreeTransform.finalize.
1128
Files are placed into limbo inside their parent directories, where
1129
possible. This reduces subsequent renames, and makes operations involving
1130
lots of files faster. This optimization is only possible if the parent
1131
directory is created *before* creating any of its children, so avoid
1132
creating children before parents, where possible.
1136
This temporary directory is used by _FileMover for storing files that are
1137
about to be deleted. In case of rollback, the files will be restored.
1138
FileMover does not delete files until it is sure that a rollback will not
1141
def __init__(self, tree, pb=DummyProgress()):
1142
"""Note: a tree_write lock is taken on the tree.
1144
Use TreeTransform.finalize() to release the lock (can be omitted if
1145
TreeTransform.apply() called).
1147
tree.lock_tree_write()
1150
control_files = tree._control_files
1151
limbodir = urlutils.local_path_from_url(
1152
control_files.controlfilename('limbo'))
1156
if e.errno == errno.EEXIST:
1157
raise ExistingLimbo(limbodir)
1158
deletiondir = urlutils.local_path_from_url(
1159
control_files.controlfilename('pending-deletion'))
1161
os.mkdir(deletiondir)
1163
if e.errno == errno.EEXIST:
1164
raise errors.ExistingPendingDeletion(deletiondir)
1169
TreeTransformBase.__init__(self, tree, limbodir, pb,
1170
tree.case_sensitive)
1171
self._deletiondir = deletiondir
1173
def apply(self, no_conflicts=False, _mover=None):
1174
"""Apply all changes to the inventory and filesystem.
1176
If filesystem or inventory conflicts are present, MalformedTransform
1179
If apply succeeds, finalize is not necessary.
1181
:param no_conflicts: if True, the caller guarantees there are no
1182
conflicts, so no check is made.
1183
:param _mover: Supply an alternate FileMover, for testing
1185
if not no_conflicts:
1186
conflicts = self.find_conflicts()
1187
if len(conflicts) != 0:
1188
raise MalformedTransform(conflicts=conflicts)
1189
inventory_delta = []
1190
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1193
mover = _FileMover()
1197
child_pb.update('Apply phase', 0, 2)
1198
self._apply_removals(inventory_delta, mover)
1199
child_pb.update('Apply phase', 1, 2)
1200
modified_paths = self._apply_insertions(inventory_delta, mover)
1205
mover.apply_deletions()
1208
self._tree.apply_inventory_delta(inventory_delta)
1211
return _TransformResults(modified_paths, self.rename_count)
1213
def _apply_removals(self, inventory_delta, mover):
1214
"""Perform tree operations that remove directory/inventory names.
1216
That is, delete files that are to be deleted, and put any files that
1217
need renaming into limbo. This must be done in strict child-to-parent
1220
tree_paths = list(self._tree_path_ids.iteritems())
1221
tree_paths.sort(reverse=True)
1222
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1224
for num, data in enumerate(tree_paths):
1225
path, trans_id = data
1226
child_pb.update('removing file', num, len(tree_paths))
1227
full_path = self._tree.abspath(path)
1228
if trans_id in self._removed_contents:
1229
mover.pre_delete(full_path, os.path.join(self._deletiondir,
1231
elif trans_id in self._new_name or trans_id in \
1234
mover.rename(full_path, self._limbo_name(trans_id))
1236
if e.errno != errno.ENOENT:
1239
self.rename_count += 1
1240
if trans_id in self._removed_id:
1241
if trans_id == self._new_root:
1242
file_id = self._tree.get_root_id()
1244
file_id = self.tree_file_id(trans_id)
1245
assert file_id is not None
1246
# File-id isn't really being deleted, just moved
1247
if file_id in self._r_new_id:
1249
inventory_delta.append((path, None, file_id, None))
1253
def _apply_insertions(self, inventory_delta, mover):
1254
"""Perform tree operations that insert directory/inventory names.
1256
That is, create any files that need to be created, and restore from
1257
limbo any files that needed renaming. This must be done in strict
1258
parent-to-child order.
1260
new_paths = self.new_paths()
1262
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1265
for num, (path, trans_id) in enumerate(new_paths):
1267
child_pb.update('adding file', num, len(new_paths))
1268
if trans_id in self._new_contents or \
1269
self.path_changed(trans_id):
1270
full_path = self._tree.abspath(path)
1271
if trans_id in self._needs_rename:
1273
mover.rename(self._limbo_name(trans_id), full_path)
1275
# We may be renaming a dangling inventory id
1276
if e.errno != errno.ENOENT:
1279
self.rename_count += 1
1280
if trans_id in self._new_contents:
1281
modified_paths.append(full_path)
1282
completed_new.append(trans_id)
1283
file_id = self.final_file_id(trans_id)
1284
if file_id is not None and (trans_id in self._new_id or
1285
trans_id in self._new_name or trans_id in self._new_parent
1286
or trans_id in self._new_executability):
1288
kind = self.final_kind(trans_id)
1290
kind = self._tree.stored_kind(file_id)
1291
if trans_id in self._new_reference_revision:
1292
new_entry = inventory.TreeReference(
1293
self.final_file_id(trans_id),
1294
self._new_name[trans_id],
1295
self.final_file_id(self._new_parent[trans_id]),
1296
None, self._new_reference_revision[trans_id])
1298
new_entry = inventory.make_entry(kind,
1299
self.final_name(trans_id),
1300
self.final_file_id(self.final_parent(trans_id)),
1301
self.final_file_id(trans_id))
1303
old_path = self._tree.id2path(new_entry.file_id)
1304
except errors.NoSuchId:
1306
inventory_delta.append((old_path, path, new_entry.file_id,
1309
if trans_id in self._new_executability:
1310
self._set_executability(path, new_entry, trans_id)
1313
for trans_id in completed_new:
1314
del self._new_contents[trans_id]
1315
return modified_paths
1318
class TransformPreview(TreeTransformBase):
1319
"""A TreeTransform for generating preview trees.
1321
Unlike TreeTransform, this version works when the input tree is a
1322
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1323
unversioned files in the input tree.
1326
def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1328
limbodir = tempfile.mkdtemp(prefix='bzr-limbo-')
1329
TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
1331
def canonical_path(self, path):
1334
def tree_kind(self, trans_id):
1335
path = self._tree_id_paths.get(trans_id)
1337
raise NoSuchFile(None)
1338
file_id = self._tree.path2id(path)
1339
return self._tree.kind(file_id)
1341
def _set_mode(self, trans_id, mode_id, typefunc):
1342
"""Set the mode of new file contents.
1343
The mode_id is the existing file to get the mode from (often the same
1344
as trans_id). The operation is only performed if there's a mode match
1345
according to typefunc.
1347
# is it ok to ignore this? probably
1350
def iter_tree_children(self, parent_id):
1351
"""Iterate through the entry's tree children, if any"""
1353
path = self._tree_id_paths[parent_id]
1356
file_id = self.tree_file_id(parent_id)
1357
for child in self._tree.inventory[file_id].children.iterkeys():
1358
childpath = joinpath(path, child)
1359
yield self.trans_id_tree_path(childpath)
1362
class _PreviewTree(object):
1363
"""Partial implementation of Tree to support show_diff_trees"""
1365
def __init__(self, transform):
1366
self._transform = transform
1368
def lock_read(self):
1369
# Perhaps in theory, this should lock the TreeTransform?
1375
def iter_changes(self, from_tree, include_unchanged=False,
1376
specific_files=None, pb=None, extra_trees=None,
1377
require_versioned=True, want_unversioned=False):
1378
"""See InterTree.iter_changes.
1380
This implementation does not support include_unchanged, specific_files,
1381
or want_unversioned. extra_trees, require_versioned, and pb are
1384
if from_tree is not self._transform._tree:
1385
raise ValueError('from_tree must be transform source tree.')
1386
if include_unchanged:
1387
raise ValueError('include_unchanged is not supported')
1388
if specific_files is not None:
1389
raise ValueError('specific_files is not supported')
1390
if want_unversioned:
1391
raise ValueError('want_unversioned is not supported')
1392
return self._transform.iter_changes()
1394
def kind(self, file_id):
1395
trans_id = self._transform.trans_id_file_id(file_id)
1396
return self._transform.final_kind(trans_id)
1398
def get_file_mtime(self, file_id, path=None):
1399
"""See Tree.get_file_mtime"""
1400
trans_id = self._transform.trans_id_file_id(file_id)
1401
name = self._transform._limbo_name(trans_id)
1402
return os.stat(name).st_mtime
1404
def get_file(self, file_id):
1405
"""See Tree.get_file"""
1406
trans_id = self._transform.trans_id_file_id(file_id)
1407
name = self._transform._limbo_name(trans_id)
1408
return open(name, 'rb')
1410
def get_symlink_target(self, file_id):
1411
"""See Tree.get_symlink_target"""
1412
trans_id = self._transform.trans_id_file_id(file_id)
1413
name = self._transform._limbo_name(trans_id)
1414
return os.readlink(name)
1416
def paths2ids(self, specific_files, trees=None, require_versioned=False):
1417
"""See Tree.paths2ids"""
1285
1421
def joinpath(parent, child):
1286
1422
"""Join tree-relative paths, handling the tree root specially"""
added
removed
bzrlib/transform.py
