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
84
self._deletiondir = None
92
85
self._id_number = 0
86
# mapping of trans_id -> new basename
93
87
self._new_name = {}
88
# mapping of trans_id -> new parent trans_id
94
89
self._new_parent = {}
90
# mapping of trans_id with new contents -> new file_kind
95
91
self._new_contents = {}
92
# A mapping of transform ids to their limbo filename
93
self._limbo_files = {}
94
# A mapping of transform ids to a set of the transform ids of children
95
# that their limbo directory has
96
self._limbo_children = {}
97
# Map transform ids to maps of child filename to child transform id
98
self._limbo_children_names = {}
99
# List of transform ids that need to be renamed from limbo into place
100
self._needs_rename = set()
101
# Set of trans_ids whose contents will be removed
96
102
self._removed_contents = set()
103
# Mapping of trans_id -> new execute-bit value
97
104
self._new_executability = {}
105
# Mapping of trans_id -> new tree-reference value
106
self._new_reference_revision = {}
107
# Mapping of trans_id -> new file_id
109
# Mapping of old file-id -> trans_id
99
110
self._non_present_ids = {}
111
# Mapping of new file_id -> trans_id
100
112
self._r_new_id = {}
113
# Set of file_ids that will be removed
101
114
self._removed_id = set()
115
# Mapping of path in old tree -> trans_id
102
116
self._tree_path_ids = {}
117
# Mapping trans_id -> path in old tree
103
118
self._tree_id_paths = {}
119
# Cache of realpath results, to speed up canonical_path
121
# Cache of relpath results, to speed up canonical_path
123
# The trans_id that will be used as the tree root
104
124
self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
125
# Indictor of whether the transform has been applied
129
# Whether the target is case sensitive
130
self._case_sensitive_target = case_sensitive
131
# A counter of how many files have been renamed
132
self.rename_count = 0
108
134
def __get_root(self):
109
135
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
814
def _limbo_name(self, trans_id):
704
815
"""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
816
limbo_name = self._limbo_files.get(trans_id)
817
if limbo_name is not None:
819
parent = self._new_parent.get(trans_id)
820
# if the parent directory is already in limbo (e.g. when building a
821
# tree), choose a limbo name inside the parent, to reduce further
823
use_direct_path = False
824
if self._new_contents.get(parent) == 'directory':
825
filename = self._new_name.get(trans_id)
826
if filename is not None:
827
if parent not in self._limbo_children:
828
self._limbo_children[parent] = set()
829
self._limbo_children_names[parent] = {}
830
use_direct_path = True
831
# the direct path can only be used if no other file has
832
# already taken this pathname, i.e. if the name is unused, or
833
# if it is already associated with this trans_id.
834
elif self._case_sensitive_target:
835
if (self._limbo_children_names[parent].get(filename)
836
in (trans_id, None)):
837
use_direct_path = True
839
for l_filename, l_trans_id in\
840
self._limbo_children_names[parent].iteritems():
841
if l_trans_id == trans_id:
843
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):
846
use_direct_path = True
849
limbo_name = pathjoin(self._limbo_files[parent], filename)
850
self._limbo_children[parent].add(trans_id)
851
self._limbo_children_names[parent][filename] = trans_id
853
limbo_name = pathjoin(self._limbodir, trans_id)
854
self._needs_rename.add(trans_id)
855
self._limbo_files[trans_id] = limbo_name
858
def _set_executability(self, path, entry, trans_id):
797
859
"""Set the executability of versioned files """
798
file_id = inv.path2id(path)
799
860
new_executability = self._new_executability[trans_id]
800
inv[file_id].executable = new_executability
861
entry.executable = new_executability
801
862
if supports_executable():
802
863
abspath = self._tree.abspath(path)
803
864
current_mode = os.stat(abspath).st_mode
861
925
self.create_symlink(target, trans_id)
928
def _affected_ids(self):
929
"""Return the set of transform ids affected by the transform"""
930
trans_ids = set(self._removed_id)
931
trans_ids.update(self._new_id.keys())
932
trans_ids.update(self._removed_contents)
933
trans_ids.update(self._new_contents.keys())
934
trans_ids.update(self._new_executability.keys())
935
trans_ids.update(self._new_name.keys())
936
trans_ids.update(self._new_parent.keys())
939
def _get_file_id_maps(self):
940
"""Return mapping of file_ids to trans_ids in the to and from states"""
941
trans_ids = self._affected_ids()
944
# Build up two dicts: trans_ids associated with file ids in the
945
# FROM state, vs the TO state.
946
for trans_id in trans_ids:
947
from_file_id = self.tree_file_id(trans_id)
948
if from_file_id is not None:
949
from_trans_ids[from_file_id] = trans_id
950
to_file_id = self.final_file_id(trans_id)
951
if to_file_id is not None:
952
to_trans_ids[to_file_id] = trans_id
953
return from_trans_ids, to_trans_ids
955
def _from_file_data(self, from_trans_id, from_versioned, file_id):
956
"""Get data about a file in the from (tree) state
958
Return a (name, parent, kind, executable) tuple
960
from_path = self._tree_id_paths.get(from_trans_id)
962
# get data from working tree if versioned
963
from_entry = self._tree.inventory[file_id]
964
from_name = from_entry.name
965
from_parent = from_entry.parent_id
968
if from_path is None:
969
# File does not exist in FROM state
973
# File exists, but is not versioned. Have to use path-
975
from_name = os.path.basename(from_path)
976
tree_parent = self.get_tree_parent(from_trans_id)
977
from_parent = self.tree_file_id(tree_parent)
978
if from_path is not None:
979
from_kind, from_executable, from_stats = \
980
self._tree._comparison_data(from_entry, from_path)
983
from_executable = False
984
return from_name, from_parent, from_kind, from_executable
986
def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
987
"""Get data about a file in the to (target) state
989
Return a (name, parent, kind, executable) tuple
991
to_name = self.final_name(to_trans_id)
993
to_kind = self.final_kind(to_trans_id)
996
to_parent = self.final_file_id(self.final_parent(to_trans_id))
997
if to_trans_id in self._new_executability:
998
to_executable = self._new_executability[to_trans_id]
999
elif to_trans_id == from_trans_id:
1000
to_executable = from_executable
1002
to_executable = False
1003
return to_name, to_parent, to_kind, to_executable
1005
def iter_changes(self):
1006
"""Produce output in the same format as Tree.iter_changes.
1008
Will produce nonsensical results if invoked while inventory/filesystem
1009
conflicts (as reported by TreeTransform.find_conflicts()) are present.
1011
This reads the Transform, but only reproduces changes involving a
1012
file_id. Files that are not versioned in either of the FROM or TO
1013
states are not reflected.
1015
final_paths = FinalPaths(self)
1016
from_trans_ids, to_trans_ids = self._get_file_id_maps()
1018
# Now iterate through all active file_ids
1019
for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
1021
from_trans_id = from_trans_ids.get(file_id)
1022
# find file ids, and determine versioning state
1023
if from_trans_id is None:
1024
from_versioned = False
1025
from_trans_id = to_trans_ids[file_id]
1027
from_versioned = True
1028
to_trans_id = to_trans_ids.get(file_id)
1029
if to_trans_id is None:
1030
to_versioned = False
1031
to_trans_id = from_trans_id
1035
from_name, from_parent, from_kind, from_executable = \
1036
self._from_file_data(from_trans_id, from_versioned, file_id)
1038
to_name, to_parent, to_kind, to_executable = \
1039
self._to_file_data(to_trans_id, from_trans_id, from_executable)
1041
if not from_versioned:
1044
from_path = self._tree_id_paths.get(from_trans_id)
1045
if not to_versioned:
1048
to_path = final_paths.get_path(to_trans_id)
1049
if from_kind != to_kind:
1051
elif to_kind in ('file', 'symlink') and (
1052
to_trans_id != from_trans_id or
1053
to_trans_id in self._new_contents):
1055
if (not modified and from_versioned == to_versioned and
1056
from_parent==to_parent and from_name == to_name and
1057
from_executable == to_executable):
1059
results.append((file_id, (from_path, to_path), modified,
1060
(from_versioned, to_versioned),
1061
(from_parent, to_parent),
1062
(from_name, to_name),
1063
(from_kind, to_kind),
1064
(from_executable, to_executable)))
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"""
864
1421
def joinpath(parent, child):
865
1422
"""Join tree-relative paths, handling the tree root specially"""
866
1423
if parent is None or parent == "":
896
1453
self._known_paths[trans_id] = self._determine_path(trans_id)
897
1454
return self._known_paths[trans_id]
899
1457
def topology_sorted_ids(tree):
900
1458
"""Determine the topological order of the ids in a tree"""
901
1459
file_ids = list(tree)
902
1460
file_ids.sort(key=tree.id2path)
905
def build_tree(tree, wt):
906
"""Create working tree for a branch, using a Transaction."""
1464
def build_tree(tree, wt, accelerator_tree=None, hardlink=False):
1465
"""Create working tree for a branch, using a TreeTransform.
1467
This function should be used on empty trees, having a tree root at most.
1468
(see merge and revert functionality for working with existing trees)
1470
Existing files are handled like so:
1472
- Existing bzrdirs take precedence over creating new items. They are
1473
created as '%s.diverted' % name.
1474
- Otherwise, if the content on disk matches the content we are building,
1475
it is silently replaced.
1476
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
1478
:param tree: The tree to convert wt into a copy of
1479
:param wt: The working tree that files will be placed into
1480
:param accelerator_tree: A tree which can be used for retrieving file
1481
contents more quickly than tree itself, i.e. a workingtree. tree
1482
will be used for cases where accelerator_tree's content is different.
1483
:param hardlink: If true, hard-link files to accelerator_tree, where
1484
possible. accelerator_tree must implement abspath, i.e. be a
1487
wt.lock_tree_write()
1491
if accelerator_tree is not None:
1492
accelerator_tree.lock_read()
1494
return _build_tree(tree, wt, accelerator_tree, hardlink)
1496
if accelerator_tree is not None:
1497
accelerator_tree.unlock()
1504
def _build_tree(tree, wt, accelerator_tree, hardlink):
1505
"""See build_tree."""
1506
for num, _unused in enumerate(wt.all_file_ids()):
1507
if num > 0: # more than just a root
1508
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
907
1509
file_trans_id = {}
908
1510
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
909
1511
pp = ProgressPhase("Build phase", 2, top_pb)
1512
if tree.inventory.root is not None:
1513
# This is kind of a hack: we should be altering the root
1514
# as part of the regular tree shape diff logic.
1515
# The conditional test here is to avoid doing an
1516
# expensive operation (flush) every time the root id
1517
# is set within the tree, nor setting the root and thus
1518
# marking the tree as dirty, because we use two different
1519
# idioms here: tree interfaces and inventory interfaces.
1520
if wt.get_root_id() != tree.get_root_id():
1521
wt.set_root_id(tree.get_root_id())
910
1523
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)
1527
file_trans_id[wt.get_root_id()] = \
1528
tt.trans_id_tree_file_id(wt.get_root_id())
915
1529
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]
1531
deferred_contents = []
1533
for num, (tree_path, entry) in \
1534
enumerate(tree.inventory.iter_entries_by_dir()):
1535
pb.update("Building tree", num - len(deferred_contents),
1536
len(tree.inventory))
920
1537
if entry.parent_id is None:
1540
file_id = entry.file_id
1541
target_path = wt.abspath(tree_path)
1543
kind = file_kind(target_path)
1547
if kind == "directory":
1549
bzrdir.BzrDir.open(target_path)
1550
except errors.NotBranchError:
1554
if (file_id not in divert and
1555
_content_match(tree, entry, file_id, kind,
1557
tt.delete_contents(tt.trans_id_tree_path(tree_path))
1558
if kind == 'directory':
922
1560
if entry.parent_id not in file_trans_id:
923
raise repr(entry.parent_id)
1561
raise AssertionError(
1562
'entry %s parent id %r is not in file_trans_id %r'
1563
% (entry, entry.parent_id, file_trans_id))
924
1564
parent_id = file_trans_id[entry.parent_id]
925
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
1565
if entry.kind == 'file':
1566
# We *almost* replicate new_by_entry, so that we can defer
1567
# getting the file text, and get them all at once.
1568
trans_id = tt.create_path(entry.name, parent_id)
1569
file_trans_id[file_id] = trans_id
1570
tt.version_file(entry.file_id, trans_id)
1571
executable = tree.is_executable(entry.file_id, tree_path)
1572
if executable is not None:
1573
tt.set_executability(executable, trans_id)
1574
deferred_contents.append((entry.file_id, trans_id))
1576
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
1579
new_trans_id = file_trans_id[file_id]
1580
old_parent = tt.trans_id_tree_path(tree_path)
1581
_reparent_children(tt, old_parent, new_trans_id)
1582
offset = num + 1 - len(deferred_contents)
1583
_create_files(tt, tree, deferred_contents, pb, offset,
1584
accelerator_tree, hardlink)
1588
divert_trans = set(file_trans_id[f] for f in divert)
1589
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
1590
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
1591
conflicts = cook_conflicts(raw_conflicts, tt)
1592
for conflict in conflicts:
1595
wt.add_conflicts(conflicts)
1596
except errors.UnsupportedOperation:
1598
result = tt.apply(no_conflicts=True)
933
1601
top_pb.finished()
1605
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
1607
total = len(desired_files) + offset
1608
if accelerator_tree is None:
1609
new_desired_files = desired_files
1611
iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
1612
unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
1613
in iter if not (c or e[0] != e[1]))
1614
new_desired_files = []
1616
for file_id, trans_id in desired_files:
1617
accelerator_path = unchanged.get(file_id)
1618
if accelerator_path is None:
1619
new_desired_files.append((file_id, trans_id))
1621
pb.update('Adding file contents', count + offset, total)
1623
tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
1626
contents = accelerator_tree.get_file(file_id, accelerator_path)
1628
tt.create_file(contents, trans_id)
1633
for count, (trans_id, contents) in enumerate(tree.iter_files_bytes(
1634
new_desired_files)):
1635
tt.create_file(contents, trans_id)
1636
pb.update('Adding file contents', count + offset, total)
1639
def _reparent_children(tt, old_parent, new_parent):
1640
for child in tt.iter_tree_children(old_parent):
1641
tt.adjust_path(tt.final_name(child), new_parent, child)
1643
def _reparent_transform_children(tt, old_parent, new_parent):
1644
by_parent = tt.by_parent()
1645
for child in by_parent[old_parent]:
1646
tt.adjust_path(tt.final_name(child), new_parent, child)
1648
def _content_match(tree, entry, file_id, kind, target_path):
1649
if entry.kind != kind:
1651
if entry.kind == "directory":
1653
if entry.kind == "file":
1654
if tree.get_file(file_id).read() == file(target_path, 'rb').read():
1656
elif entry.kind == "symlink":
1657
if tree.get_symlink_target(file_id) == os.readlink(target_path):
1662
def resolve_checkout(tt, conflicts, divert):
1663
new_conflicts = set()
1664
for c_type, conflict in ((c[0], c) for c in conflicts):
1665
# Anything but a 'duplicate' would indicate programmer error
1666
assert c_type == 'duplicate', c_type
1667
# Now figure out which is new and which is old
1668
if tt.new_contents(conflict[1]):
1669
new_file = conflict[1]
1670
old_file = conflict[2]
1672
new_file = conflict[2]
1673
old_file = conflict[1]
1675
# We should only get here if the conflict wasn't completely
1677
final_parent = tt.final_parent(old_file)
1678
if new_file in divert:
1679
new_name = tt.final_name(old_file)+'.diverted'
1680
tt.adjust_path(new_name, final_parent, new_file)
1681
new_conflicts.add((c_type, 'Diverted to',
1682
new_file, old_file))
1684
new_name = tt.final_name(old_file)+'.moved'
1685
tt.adjust_path(new_name, final_parent, old_file)
1686
new_conflicts.add((c_type, 'Moved existing file to',
1687
old_file, new_file))
1688
return new_conflicts
935
1691
def new_by_entry(tt, entry, parent_id, tree):
936
1692
"""Create a new file according to its inventory entry"""
1065
1831
return has_contents, contents_mod, meta_mod
1068
def revert(working_tree, target_tree, filenames, backups=False,
1069
pb=DummyProgress()):
1834
def revert(working_tree, target_tree, filenames, backups=False,
1835
pb=DummyProgress(), change_reporter=None):
1070
1836
"""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
1837
target_tree.lock_read()
1075
1838
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:
1840
pp = ProgressPhase("Revert phase", 3, pb)
1842
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1844
merge_modified = _alter_files(working_tree, target_tree, tt,
1845
child_pb, filenames, backups)
1849
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1851
raw_conflicts = resolve_conflicts(tt, child_pb,
1852
lambda t, c: conflict_pass(t, c, target_tree))
1855
conflicts = cook_conflicts(raw_conflicts, tt)
1857
change_reporter = delta._ChangeReporter(
1858
unversioned_filter=working_tree.is_ignored)
1859
delta.report_changes(tt.iter_changes(), change_reporter)
1860
for conflict in conflicts:
1864
working_tree.set_merge_modified(merge_modified)
1866
target_tree.unlock()
1872
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
1874
merge_modified = working_tree.merge_modified()
1875
change_list = target_tree.iter_changes(working_tree,
1876
specific_files=specific_files, pb=pb)
1877
if target_tree.inventory.root is None:
1884
for id_num, (file_id, path, changed_content, versioned, parent, name,
1885
kind, executable) in enumerate(change_list):
1886
if skip_root and file_id[0] is not None and parent[0] is None:
1888
trans_id = tt.trans_id_file_id(file_id)
1891
keep_content = False
1892
if kind[0] == 'file' and (backups or kind[1] is None):
1893
wt_sha1 = working_tree.get_file_sha1(file_id)
1894
if merge_modified.get(file_id) != wt_sha1:
1895
# acquire the basis tree lazily to prevent the
1896
# expense of accessing it when it's not needed ?
1897
# (Guessing, RBC, 200702)
1898
if basis_tree is None:
1899
basis_tree = working_tree.basis_tree()
1900
basis_tree.lock_read()
1901
if file_id in basis_tree:
1902
if wt_sha1 != basis_tree.get_file_sha1(file_id):
1904
elif kind[1] is None and not versioned[1]:
1906
if kind[0] is not None:
1907
if not keep_content:
1121
1908
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({})
1909
elif kind[1] is not None:
1910
parent_trans_id = tt.trans_id_file_id(parent[0])
1911
by_parent = tt.by_parent()
1912
backup_name = _get_backup_name(name[0], by_parent,
1913
parent_trans_id, tt)
1914
tt.adjust_path(backup_name, parent_trans_id, trans_id)
1915
new_trans_id = tt.create_path(name[0], parent_trans_id)
1916
if versioned == (True, True):
1917
tt.unversion_file(trans_id)
1918
tt.version_file(file_id, new_trans_id)
1919
# New contents should have the same unix perms as old
1922
trans_id = new_trans_id
1923
if kind[1] == 'directory':
1924
tt.create_directory(trans_id)
1925
elif kind[1] == 'symlink':
1926
tt.create_symlink(target_tree.get_symlink_target(file_id),
1928
elif kind[1] == 'file':
1929
deferred_files.append((file_id, (trans_id, mode_id)))
1930
if basis_tree is None:
1931
basis_tree = working_tree.basis_tree()
1932
basis_tree.lock_read()
1933
new_sha1 = target_tree.get_file_sha1(file_id)
1934
if (file_id in basis_tree and new_sha1 ==
1935
basis_tree.get_file_sha1(file_id)):
1936
if file_id in merge_modified:
1937
del merge_modified[file_id]
1939
merge_modified[file_id] = new_sha1
1941
# preserve the execute bit when backing up
1942
if keep_content and executable[0] == executable[1]:
1943
tt.set_executability(executable[1], trans_id)
1945
assert kind[1] is None
1946
if versioned == (False, True):
1947
tt.version_file(file_id, trans_id)
1948
if versioned == (True, False):
1949
tt.unversion_file(trans_id)
1950
if (name[1] is not None and
1951
(name[0] != name[1] or parent[0] != parent[1])):
1953
name[1], tt.trans_id_file_id(parent[1]), trans_id)
1954
if executable[0] != executable[1] and kind[1] == "file":
1955
tt.set_executability(executable[1], trans_id)
1956
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
1958
tt.create_file(bytes, trans_id, mode_id)
1143
def resolve_conflicts(tt, pb=DummyProgress()):
1960
if basis_tree is not None:
1962
return merge_modified
1965
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
1144
1966
"""Make many conflict-resolution attempts, but die if they fail"""
1967
if pass_func is None:
1968
pass_func = conflict_pass
1145
1969
new_conflicts = set()
1147
1971
for n in range(10):