1076
918
(from_executable, to_executable)))
1077
919
return iter(sorted(results, key=lambda x:x[1]))
921
def get_preview_tree(self):
922
"""Return a tree representing the result of the transform.
924
The tree is a snapshot, and altering the TreeTransform will invalidate
927
return _PreviewTree(self)
929
def commit(self, branch, message, merge_parents=None, strict=False):
930
"""Commit the result of this TreeTransform to a branch.
932
:param branch: The branch to commit to.
933
:param message: The message to attach to the commit.
934
:param merge_parents: Additional parents specified by pending merges.
935
:return: The revision_id of the revision committed.
937
self._check_malformed()
939
unversioned = set(self._new_contents).difference(set(self._new_id))
940
for trans_id in unversioned:
941
if self.final_file_id(trans_id) is None:
942
raise errors.StrictCommitFailed()
944
revno, last_rev_id = branch.last_revision_info()
945
if last_rev_id == _mod_revision.NULL_REVISION:
946
if merge_parents is not None:
947
raise ValueError('Cannot supply merge parents for first'
951
parent_ids = [last_rev_id]
952
if merge_parents is not None:
953
parent_ids.extend(merge_parents)
954
if self._tree.get_revision_id() != last_rev_id:
955
raise ValueError('TreeTransform not based on branch basis: %s' %
956
self._tree.get_revision_id())
957
builder = branch.get_commit_builder(parent_ids)
958
preview = self.get_preview_tree()
959
list(builder.record_iter_changes(preview, last_rev_id,
960
self.iter_changes()))
961
builder.finish_inventory()
962
revision_id = builder.commit(message)
963
branch.set_last_revision_info(revno + 1, revision_id)
966
def _text_parent(self, trans_id):
967
file_id = self.tree_file_id(trans_id)
969
if file_id is None or self._tree.kind(file_id) != 'file':
971
except errors.NoSuchFile:
975
def _get_parents_texts(self, trans_id):
976
"""Get texts for compression parents of this file."""
977
file_id = self._text_parent(trans_id)
980
return (self._tree.get_file_text(file_id),)
982
def _get_parents_lines(self, trans_id):
983
"""Get lines for compression parents of this file."""
984
file_id = self._text_parent(trans_id)
987
return (self._tree.get_file_lines(file_id),)
989
def serialize(self, serializer):
990
"""Serialize this TreeTransform.
992
:param serializer: A Serialiser like pack.ContainerSerializer.
994
new_name = dict((k, v.encode('utf-8')) for k, v in
995
self._new_name.items())
996
new_executability = dict((k, int(v)) for k, v in
997
self._new_executability.items())
998
tree_path_ids = dict((k.encode('utf-8'), v)
999
for k, v in self._tree_path_ids.items())
1001
'_id_number': self._id_number,
1002
'_new_name': new_name,
1003
'_new_parent': self._new_parent,
1004
'_new_executability': new_executability,
1005
'_new_id': self._new_id,
1006
'_tree_path_ids': tree_path_ids,
1007
'_removed_id': list(self._removed_id),
1008
'_removed_contents': list(self._removed_contents),
1009
'_non_present_ids': self._non_present_ids,
1011
yield serializer.bytes_record(bencode.bencode(attribs),
1013
for trans_id, kind in self._new_contents.items():
1015
lines = osutils.chunks_to_lines(
1016
self._read_file_chunks(trans_id))
1017
parents = self._get_parents_lines(trans_id)
1018
mpdiff = multiparent.MultiParent.from_lines(lines, parents)
1019
content = ''.join(mpdiff.to_patch())
1020
if kind == 'directory':
1022
if kind == 'symlink':
1023
content = self._read_symlink_target(trans_id)
1024
yield serializer.bytes_record(content, ((trans_id, kind),))
1026
def deserialize(self, records):
1027
"""Deserialize a stored TreeTransform.
1029
:param records: An iterable of (names, content) tuples, as per
1030
pack.ContainerPushParser.
1032
names, content = records.next()
1033
attribs = bencode.bdecode(content)
1034
self._id_number = attribs['_id_number']
1035
self._new_name = dict((k, v.decode('utf-8'))
1036
for k, v in attribs['_new_name'].items())
1037
self._new_parent = attribs['_new_parent']
1038
self._new_executability = dict((k, bool(v)) for k, v in
1039
attribs['_new_executability'].items())
1040
self._new_id = attribs['_new_id']
1041
self._r_new_id = dict((v, k) for k, v in self._new_id.items())
1042
self._tree_path_ids = {}
1043
self._tree_id_paths = {}
1044
for bytepath, trans_id in attribs['_tree_path_ids'].items():
1045
path = bytepath.decode('utf-8')
1046
self._tree_path_ids[path] = trans_id
1047
self._tree_id_paths[trans_id] = path
1048
self._removed_id = set(attribs['_removed_id'])
1049
self._removed_contents = set(attribs['_removed_contents'])
1050
self._non_present_ids = attribs['_non_present_ids']
1051
for ((trans_id, kind),), content in records:
1053
mpdiff = multiparent.MultiParent.from_patch(content)
1054
lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
1055
self.create_file(lines, trans_id)
1056
if kind == 'directory':
1057
self.create_directory(trans_id)
1058
if kind == 'symlink':
1059
self.create_symlink(content.decode('utf-8'), trans_id)
1062
class DiskTreeTransform(TreeTransformBase):
1063
"""Tree transform storing its contents on disk."""
1065
def __init__(self, tree, limbodir, pb=DummyProgress(),
1066
case_sensitive=True):
1068
:param tree: The tree that will be transformed, but not necessarily
1070
:param limbodir: A directory where new files can be stored until
1071
they are installed in their proper places
1072
:param pb: A ProgressBar indicating how much progress is being made
1073
:param case_sensitive: If True, the target of the transform is
1074
case sensitive, not just case preserving.
1076
TreeTransformBase.__init__(self, tree, pb, case_sensitive)
1077
self._limbodir = limbodir
1078
self._deletiondir = None
1079
# A mapping of transform ids to their limbo filename
1080
self._limbo_files = {}
1081
# A mapping of transform ids to a set of the transform ids of children
1082
# that their limbo directory has
1083
self._limbo_children = {}
1084
# Map transform ids to maps of child filename to child transform id
1085
self._limbo_children_names = {}
1086
# List of transform ids that need to be renamed from limbo into place
1087
self._needs_rename = set()
1088
self._creation_mtime = None
1091
"""Release the working tree lock, if held, clean up limbo dir.
1093
This is required if apply has not been invoked, but can be invoked
1096
if self._tree is None:
1099
entries = [(self._limbo_name(t), t, k) for t, k in
1100
self._new_contents.iteritems()]
1101
entries.sort(reverse=True)
1102
for path, trans_id, kind in entries:
1105
delete_any(self._limbodir)
1107
# We don't especially care *why* the dir is immortal.
1108
raise ImmortalLimbo(self._limbodir)
1110
if self._deletiondir is not None:
1111
delete_any(self._deletiondir)
1113
raise errors.ImmortalPendingDeletion(self._deletiondir)
1115
TreeTransformBase.finalize(self)
1117
def _limbo_name(self, trans_id):
1118
"""Generate the limbo name of a file"""
1119
limbo_name = self._limbo_files.get(trans_id)
1120
if limbo_name is None:
1121
limbo_name = self._generate_limbo_path(trans_id)
1122
self._limbo_files[trans_id] = limbo_name
1125
def _generate_limbo_path(self, trans_id):
1126
"""Generate a limbo path using the trans_id as the relative path.
1128
This is suitable as a fallback, and when the transform should not be
1129
sensitive to the path encoding of the limbo directory.
1131
self._needs_rename.add(trans_id)
1132
return pathjoin(self._limbodir, trans_id)
1134
def adjust_path(self, name, parent, trans_id):
1135
previous_parent = self._new_parent.get(trans_id)
1136
previous_name = self._new_name.get(trans_id)
1137
TreeTransformBase.adjust_path(self, name, parent, trans_id)
1138
if (trans_id in self._limbo_files and
1139
trans_id not in self._needs_rename):
1140
self._rename_in_limbo([trans_id])
1141
if previous_parent != parent:
1142
self._limbo_children[previous_parent].remove(trans_id)
1143
if previous_parent != parent or previous_name != name:
1144
del self._limbo_children_names[previous_parent][previous_name]
1146
def _rename_in_limbo(self, trans_ids):
1147
"""Fix limbo names so that the right final path is produced.
1149
This means we outsmarted ourselves-- we tried to avoid renaming
1150
these files later by creating them with their final names in their
1151
final parents. But now the previous name or parent is no longer
1152
suitable, so we have to rename them.
1154
Even for trans_ids that have no new contents, we must remove their
1155
entries from _limbo_files, because they are now stale.
1157
for trans_id in trans_ids:
1158
old_path = self._limbo_files.pop(trans_id)
1159
if trans_id not in self._new_contents:
1161
new_path = self._limbo_name(trans_id)
1162
os.rename(old_path, new_path)
1163
for descendant in self._limbo_descendants(trans_id):
1164
desc_path = self._limbo_files[descendant]
1165
desc_path = new_path + desc_path[len(old_path):]
1166
self._limbo_files[descendant] = desc_path
1168
def _limbo_descendants(self, trans_id):
1169
"""Return the set of trans_ids whose limbo paths descend from this."""
1170
descendants = set(self._limbo_children.get(trans_id, []))
1171
for descendant in list(descendants):
1172
descendants.update(self._limbo_descendants(descendant))
1175
def create_file(self, contents, trans_id, mode_id=None):
1176
"""Schedule creation of a new file.
1180
Contents is an iterator of strings, all of which will be written
1181
to the target destination.
1183
New file takes the permissions of any existing file with that id,
1184
unless mode_id is specified.
1186
name = self._limbo_name(trans_id)
1187
f = open(name, 'wb')
1190
unique_add(self._new_contents, trans_id, 'file')
1192
# Clean up the file, it never got registered so
1193
# TreeTransform.finalize() won't clean it up.
1198
f.writelines(contents)
1201
self._set_mtime(name)
1202
self._set_mode(trans_id, mode_id, S_ISREG)
1204
def _read_file_chunks(self, trans_id):
1205
cur_file = open(self._limbo_name(trans_id), 'rb')
1207
return cur_file.readlines()
1211
def _read_symlink_target(self, trans_id):
1212
return os.readlink(self._limbo_name(trans_id))
1214
def _set_mtime(self, path):
1215
"""All files that are created get the same mtime.
1217
This time is set by the first object to be created.
1219
if self._creation_mtime is None:
1220
self._creation_mtime = time.time()
1221
os.utime(path, (self._creation_mtime, self._creation_mtime))
1223
def create_hardlink(self, path, trans_id):
1224
"""Schedule creation of a hard link"""
1225
name = self._limbo_name(trans_id)
1229
if e.errno != errno.EPERM:
1231
raise errors.HardLinkNotSupported(path)
1233
unique_add(self._new_contents, trans_id, 'file')
1235
# Clean up the file, it never got registered so
1236
# TreeTransform.finalize() won't clean it up.
1240
def create_directory(self, trans_id):
1241
"""Schedule creation of a new directory.
1243
See also new_directory.
1245
os.mkdir(self._limbo_name(trans_id))
1246
unique_add(self._new_contents, trans_id, 'directory')
1248
def create_symlink(self, target, trans_id):
1249
"""Schedule creation of a new symbolic link.
1251
target is a bytestring.
1252
See also new_symlink.
1255
os.symlink(target, self._limbo_name(trans_id))
1256
unique_add(self._new_contents, trans_id, 'symlink')
1259
path = FinalPaths(self).get_path(trans_id)
1262
raise UnableCreateSymlink(path=path)
1264
def cancel_creation(self, trans_id):
1265
"""Cancel the creation of new file contents."""
1266
del self._new_contents[trans_id]
1267
children = self._limbo_children.get(trans_id)
1268
# if this is a limbo directory with children, move them before removing
1270
if children is not None:
1271
self._rename_in_limbo(children)
1272
del self._limbo_children[trans_id]
1273
del self._limbo_children_names[trans_id]
1274
delete_any(self._limbo_name(trans_id))
1277
class TreeTransform(DiskTreeTransform):
1278
"""Represent a tree transformation.
1280
This object is designed to support incremental generation of the transform,
1283
However, it gives optimum performance when parent directories are created
1284
before their contents. The transform is then able to put child files
1285
directly in their parent directory, avoiding later renames.
1287
It is easy to produce malformed transforms, but they are generally
1288
harmless. Attempting to apply a malformed transform will cause an
1289
exception to be raised before any modifications are made to the tree.
1291
Many kinds of malformed transforms can be corrected with the
1292
resolve_conflicts function. The remaining ones indicate programming error,
1293
such as trying to create a file with no path.
1295
Two sets of file creation methods are supplied. Convenience methods are:
1300
These are composed of the low-level methods:
1302
* create_file or create_directory or create_symlink
1306
Transform/Transaction ids
1307
-------------------------
1308
trans_ids are temporary ids assigned to all files involved in a transform.
1309
It's possible, even common, that not all files in the Tree have trans_ids.
1311
trans_ids are used because filenames and file_ids are not good enough
1312
identifiers; filenames change, and not all files have file_ids. File-ids
1313
are also associated with trans-ids, so that moving a file moves its
1316
trans_ids are only valid for the TreeTransform that generated them.
1320
Limbo is a temporary directory use to hold new versions of files.
1321
Files are added to limbo by create_file, create_directory, create_symlink,
1322
and their convenience variants (new_*). Files may be removed from limbo
1323
using cancel_creation. Files are renamed from limbo into their final
1324
location as part of TreeTransform.apply
1326
Limbo must be cleaned up, by either calling TreeTransform.apply or
1327
calling TreeTransform.finalize.
1329
Files are placed into limbo inside their parent directories, where
1330
possible. This reduces subsequent renames, and makes operations involving
1331
lots of files faster. This optimization is only possible if the parent
1332
directory is created *before* creating any of its children, so avoid
1333
creating children before parents, where possible.
1337
This temporary directory is used by _FileMover for storing files that are
1338
about to be deleted. In case of rollback, the files will be restored.
1339
FileMover does not delete files until it is sure that a rollback will not
1342
def __init__(self, tree, pb=DummyProgress()):
1343
"""Note: a tree_write lock is taken on the tree.
1345
Use TreeTransform.finalize() to release the lock (can be omitted if
1346
TreeTransform.apply() called).
1348
tree.lock_tree_write()
1351
limbodir = urlutils.local_path_from_url(
1352
tree._transport.abspath('limbo'))
1356
if e.errno == errno.EEXIST:
1357
raise ExistingLimbo(limbodir)
1358
deletiondir = urlutils.local_path_from_url(
1359
tree._transport.abspath('pending-deletion'))
1361
os.mkdir(deletiondir)
1363
if e.errno == errno.EEXIST:
1364
raise errors.ExistingPendingDeletion(deletiondir)
1369
# Cache of realpath results, to speed up canonical_path
1370
self._realpaths = {}
1371
# Cache of relpath results, to speed up canonical_path
1373
DiskTreeTransform.__init__(self, tree, limbodir, pb,
1374
tree.case_sensitive)
1375
self._deletiondir = deletiondir
1377
def canonical_path(self, path):
1378
"""Get the canonical tree-relative path"""
1379
# don't follow final symlinks
1380
abs = self._tree.abspath(path)
1381
if abs in self._relpaths:
1382
return self._relpaths[abs]
1383
dirname, basename = os.path.split(abs)
1384
if dirname not in self._realpaths:
1385
self._realpaths[dirname] = os.path.realpath(dirname)
1386
dirname = self._realpaths[dirname]
1387
abs = pathjoin(dirname, basename)
1388
if dirname in self._relpaths:
1389
relpath = pathjoin(self._relpaths[dirname], basename)
1390
relpath = relpath.rstrip('/\\')
1392
relpath = self._tree.relpath(abs)
1393
self._relpaths[abs] = relpath
1396
def tree_kind(self, trans_id):
1397
"""Determine the file kind in the working tree.
1399
Raises NoSuchFile if the file does not exist
1401
path = self._tree_id_paths.get(trans_id)
1403
raise NoSuchFile(None)
1405
return file_kind(self._tree.abspath(path))
1407
if e.errno != errno.ENOENT:
1410
raise NoSuchFile(path)
1412
def _set_mode(self, trans_id, mode_id, typefunc):
1413
"""Set the mode of new file contents.
1414
The mode_id is the existing file to get the mode from (often the same
1415
as trans_id). The operation is only performed if there's a mode match
1416
according to typefunc.
1421
old_path = self._tree_id_paths[mode_id]
1425
mode = os.stat(self._tree.abspath(old_path)).st_mode
1427
if e.errno in (errno.ENOENT, errno.ENOTDIR):
1428
# Either old_path doesn't exist, or the parent of the
1429
# target is not a directory (but will be one eventually)
1430
# Either way, we know it doesn't exist *right now*
1431
# See also bug #248448
1436
os.chmod(self._limbo_name(trans_id), mode)
1438
def iter_tree_children(self, parent_id):
1439
"""Iterate through the entry's tree children, if any"""
1441
path = self._tree_id_paths[parent_id]
1445
children = os.listdir(self._tree.abspath(path))
1447
if not (osutils._is_error_enotdir(e)
1448
or e.errno in (errno.ENOENT, errno.ESRCH)):
1452
for child in children:
1453
childpath = joinpath(path, child)
1454
if self._tree.is_control_filename(childpath):
1456
yield self.trans_id_tree_path(childpath)
1458
def _generate_limbo_path(self, trans_id):
1459
"""Generate a limbo path using the final path if possible.
1461
This optimizes the performance of applying the tree transform by
1462
avoiding renames. These renames can be avoided only when the parent
1463
directory is already scheduled for creation.
1465
If the final path cannot be used, falls back to using the trans_id as
1468
parent = self._new_parent.get(trans_id)
1469
# if the parent directory is already in limbo (e.g. when building a
1470
# tree), choose a limbo name inside the parent, to reduce further
1472
use_direct_path = False
1473
if self._new_contents.get(parent) == 'directory':
1474
filename = self._new_name.get(trans_id)
1475
if filename is not None:
1476
if parent not in self._limbo_children:
1477
self._limbo_children[parent] = set()
1478
self._limbo_children_names[parent] = {}
1479
use_direct_path = True
1480
# the direct path can only be used if no other file has
1481
# already taken this pathname, i.e. if the name is unused, or
1482
# if it is already associated with this trans_id.
1483
elif self._case_sensitive_target:
1484
if (self._limbo_children_names[parent].get(filename)
1485
in (trans_id, None)):
1486
use_direct_path = True
1488
for l_filename, l_trans_id in\
1489
self._limbo_children_names[parent].iteritems():
1490
if l_trans_id == trans_id:
1492
if l_filename.lower() == filename.lower():
1495
use_direct_path = True
1497
if not use_direct_path:
1498
return DiskTreeTransform._generate_limbo_path(self, trans_id)
1500
limbo_name = pathjoin(self._limbo_files[parent], filename)
1501
self._limbo_children[parent].add(trans_id)
1502
self._limbo_children_names[parent][filename] = trans_id
1506
def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1507
"""Apply all changes to the inventory and filesystem.
1509
If filesystem or inventory conflicts are present, MalformedTransform
1512
If apply succeeds, finalize is not necessary.
1514
:param no_conflicts: if True, the caller guarantees there are no
1515
conflicts, so no check is made.
1516
:param precomputed_delta: An inventory delta to use instead of
1518
:param _mover: Supply an alternate FileMover, for testing
1520
if not no_conflicts:
1521
self._check_malformed()
1522
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1524
if precomputed_delta is None:
1525
child_pb.update('Apply phase', 0, 2)
1526
inventory_delta = self._generate_inventory_delta()
1529
inventory_delta = precomputed_delta
1532
mover = _FileMover()
1536
child_pb.update('Apply phase', 0 + offset, 2 + offset)
1537
self._apply_removals(mover)
1538
child_pb.update('Apply phase', 1 + offset, 2 + offset)
1539
modified_paths = self._apply_insertions(mover)
1544
mover.apply_deletions()
1547
self._tree.apply_inventory_delta(inventory_delta)
1550
return _TransformResults(modified_paths, self.rename_count)
1552
def _generate_inventory_delta(self):
1553
"""Generate an inventory delta for the current transform."""
1554
inventory_delta = []
1555
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1556
new_paths = self._inventory_altered()
1557
total_entries = len(new_paths) + len(self._removed_id)
1559
for num, trans_id in enumerate(self._removed_id):
1561
child_pb.update('removing file', num, total_entries)
1562
if trans_id == self._new_root:
1563
file_id = self._tree.get_root_id()
1565
file_id = self.tree_file_id(trans_id)
1566
# File-id isn't really being deleted, just moved
1567
if file_id in self._r_new_id:
1569
path = self._tree_id_paths[trans_id]
1570
inventory_delta.append((path, None, file_id, None))
1571
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1573
entries = self._tree.iter_entries_by_dir(
1574
new_path_file_ids.values())
1575
old_paths = dict((e.file_id, p) for p, e in entries)
1577
for num, (path, trans_id) in enumerate(new_paths):
1579
child_pb.update('adding file',
1580
num + len(self._removed_id), total_entries)
1581
file_id = new_path_file_ids[trans_id]
1586
kind = self.final_kind(trans_id)
1588
kind = self._tree.stored_kind(file_id)
1589
parent_trans_id = self.final_parent(trans_id)
1590
parent_file_id = new_path_file_ids.get(parent_trans_id)
1591
if parent_file_id is None:
1592
parent_file_id = self.final_file_id(parent_trans_id)
1593
if trans_id in self._new_reference_revision:
1594
new_entry = inventory.TreeReference(
1596
self._new_name[trans_id],
1597
self.final_file_id(self._new_parent[trans_id]),
1598
None, self._new_reference_revision[trans_id])
1600
new_entry = inventory.make_entry(kind,
1601
self.final_name(trans_id),
1602
parent_file_id, file_id)
1603
old_path = old_paths.get(new_entry.file_id)
1604
new_executability = self._new_executability.get(trans_id)
1605
if new_executability is not None:
1606
new_entry.executable = new_executability
1607
inventory_delta.append(
1608
(old_path, path, new_entry.file_id, new_entry))
1611
return inventory_delta
1613
def _apply_removals(self, mover):
1614
"""Perform tree operations that remove directory/inventory names.
1616
That is, delete files that are to be deleted, and put any files that
1617
need renaming into limbo. This must be done in strict child-to-parent
1620
If inventory_delta is None, no inventory delta generation is performed.
1622
tree_paths = list(self._tree_path_ids.iteritems())
1623
tree_paths.sort(reverse=True)
1624
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1626
for num, data in enumerate(tree_paths):
1627
path, trans_id = data
1628
child_pb.update('removing file', num, len(tree_paths))
1629
full_path = self._tree.abspath(path)
1630
if trans_id in self._removed_contents:
1631
delete_path = os.path.join(self._deletiondir, trans_id)
1632
mover.pre_delete(full_path, delete_path)
1633
elif (trans_id in self._new_name
1634
or trans_id in self._new_parent):
1636
mover.rename(full_path, self._limbo_name(trans_id))
1638
if e.errno != errno.ENOENT:
1641
self.rename_count += 1
1645
def _apply_insertions(self, mover):
1646
"""Perform tree operations that insert directory/inventory names.
1648
That is, create any files that need to be created, and restore from
1649
limbo any files that needed renaming. This must be done in strict
1650
parent-to-child order.
1652
If inventory_delta is None, no inventory delta is calculated, and
1653
no list of modified paths is returned.
1655
new_paths = self.new_paths(filesystem_only=True)
1657
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1659
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1661
for num, (path, trans_id) in enumerate(new_paths):
1663
child_pb.update('adding file', num, len(new_paths))
1664
full_path = self._tree.abspath(path)
1665
if trans_id in self._needs_rename:
1667
mover.rename(self._limbo_name(trans_id), full_path)
1669
# We may be renaming a dangling inventory id
1670
if e.errno != errno.ENOENT:
1673
self.rename_count += 1
1674
if (trans_id in self._new_contents or
1675
self.path_changed(trans_id)):
1676
if trans_id in self._new_contents:
1677
modified_paths.append(full_path)
1678
if trans_id in self._new_executability:
1679
self._set_executability(path, trans_id)
1682
self._new_contents.clear()
1683
return modified_paths
1686
class TransformPreview(DiskTreeTransform):
1687
"""A TreeTransform for generating preview trees.
1689
Unlike TreeTransform, this version works when the input tree is a
1690
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1691
unversioned files in the input tree.
1694
def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1696
limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1697
DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
1699
def canonical_path(self, path):
1702
def tree_kind(self, trans_id):
1703
path = self._tree_id_paths.get(trans_id)
1705
raise NoSuchFile(None)
1706
file_id = self._tree.path2id(path)
1707
return self._tree.kind(file_id)
1709
def _set_mode(self, trans_id, mode_id, typefunc):
1710
"""Set the mode of new file contents.
1711
The mode_id is the existing file to get the mode from (often the same
1712
as trans_id). The operation is only performed if there's a mode match
1713
according to typefunc.
1715
# is it ok to ignore this? probably
1718
def iter_tree_children(self, parent_id):
1719
"""Iterate through the entry's tree children, if any"""
1721
path = self._tree_id_paths[parent_id]
1724
file_id = self.tree_file_id(parent_id)
1727
entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1728
children = getattr(entry, 'children', {})
1729
for child in children:
1730
childpath = joinpath(path, child)
1731
yield self.trans_id_tree_path(childpath)
1734
class _PreviewTree(tree.Tree):
1735
"""Partial implementation of Tree to support show_diff_trees"""
1737
def __init__(self, transform):
1738
self._transform = transform
1739
self._final_paths = FinalPaths(transform)
1740
self.__by_parent = None
1741
self._parent_ids = []
1742
self._all_children_cache = {}
1743
self._path2trans_id_cache = {}
1744
self._final_name_cache = {}
1745
self._iter_changes_cache = dict((c[0], c) for c in
1746
self._transform.iter_changes())
1748
def _content_change(self, file_id):
1749
"""Return True if the content of this file changed"""
1750
changes = self._iter_changes_cache.get(file_id)
1751
# changes[2] is true if the file content changed. See
1752
# InterTree.iter_changes.
1753
return (changes is not None and changes[2])
1755
def _get_repository(self):
1756
repo = getattr(self._transform._tree, '_repository', None)
1758
repo = self._transform._tree.branch.repository
1761
def _iter_parent_trees(self):
1762
for revision_id in self.get_parent_ids():
1764
yield self.revision_tree(revision_id)
1765
except errors.NoSuchRevisionInTree:
1766
yield self._get_repository().revision_tree(revision_id)
1768
def _get_file_revision(self, file_id, vf, tree_revision):
1769
parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
1770
self._iter_parent_trees()]
1771
vf.add_lines((file_id, tree_revision), parent_keys,
1772
self.get_file(file_id).readlines())
1773
repo = self._get_repository()
1774
base_vf = repo.texts
1775
if base_vf not in vf.fallback_versionedfiles:
1776
vf.fallback_versionedfiles.append(base_vf)
1777
return tree_revision
1779
def _stat_limbo_file(self, file_id):
1780
trans_id = self._transform.trans_id_file_id(file_id)
1781
name = self._transform._limbo_name(trans_id)
1782
return os.lstat(name)
1785
def _by_parent(self):
1786
if self.__by_parent is None:
1787
self.__by_parent = self._transform.by_parent()
1788
return self.__by_parent
1790
def _comparison_data(self, entry, path):
1791
kind, size, executable, link_or_sha1 = self.path_content_summary(path)
1792
if kind == 'missing':
1796
file_id = self._transform.final_file_id(self._path2trans_id(path))
1797
executable = self.is_executable(file_id, path)
1798
return kind, executable, None
1800
def lock_read(self):
1801
# Perhaps in theory, this should lock the TreeTransform?
1808
def inventory(self):
1809
"""This Tree does not use inventory as its backing data."""
1810
raise NotImplementedError(_PreviewTree.inventory)
1812
def get_root_id(self):
1813
return self._transform.final_file_id(self._transform.root)
1815
def all_file_ids(self):
1816
tree_ids = set(self._transform._tree.all_file_ids())
1817
tree_ids.difference_update(self._transform.tree_file_id(t)
1818
for t in self._transform._removed_id)
1819
tree_ids.update(self._transform._new_id.values())
1823
return iter(self.all_file_ids())
1825
def _has_id(self, file_id, fallback_check):
1826
if file_id in self._transform._r_new_id:
1828
elif file_id in set([self._transform.tree_file_id(trans_id) for
1829
trans_id in self._transform._removed_id]):
1832
return fallback_check(file_id)
1834
def has_id(self, file_id):
1835
return self._has_id(file_id, self._transform._tree.has_id)
1837
def has_or_had_id(self, file_id):
1838
return self._has_id(file_id, self._transform._tree.has_or_had_id)
1840
def _path2trans_id(self, path):
1841
# We must not use None here, because that is a valid value to store.
1842
trans_id = self._path2trans_id_cache.get(path, object)
1843
if trans_id is not object:
1845
segments = splitpath(path)
1846
cur_parent = self._transform.root
1847
for cur_segment in segments:
1848
for child in self._all_children(cur_parent):
1849
final_name = self._final_name_cache.get(child)
1850
if final_name is None:
1851
final_name = self._transform.final_name(child)
1852
self._final_name_cache[child] = final_name
1853
if final_name == cur_segment:
1857
self._path2trans_id_cache[path] = None
1859
self._path2trans_id_cache[path] = cur_parent
1862
def path2id(self, path):
1863
return self._transform.final_file_id(self._path2trans_id(path))
1865
def id2path(self, file_id):
1866
trans_id = self._transform.trans_id_file_id(file_id)
1868
return self._final_paths._determine_path(trans_id)
1870
raise errors.NoSuchId(self, file_id)
1872
def _all_children(self, trans_id):
1873
children = self._all_children_cache.get(trans_id)
1874
if children is not None:
1876
children = set(self._transform.iter_tree_children(trans_id))
1877
# children in the _new_parent set are provided by _by_parent.
1878
children.difference_update(self._transform._new_parent.keys())
1879
children.update(self._by_parent.get(trans_id, []))
1880
self._all_children_cache[trans_id] = children
1883
def iter_children(self, file_id):
1884
trans_id = self._transform.trans_id_file_id(file_id)
1885
for child_trans_id in self._all_children(trans_id):
1886
yield self._transform.final_file_id(child_trans_id)
1889
possible_extras = set(self._transform.trans_id_tree_path(p) for p
1890
in self._transform._tree.extras())
1891
possible_extras.update(self._transform._new_contents)
1892
possible_extras.update(self._transform._removed_id)
1893
for trans_id in possible_extras:
1894
if self._transform.final_file_id(trans_id) is None:
1895
yield self._final_paths._determine_path(trans_id)
1897
def _make_inv_entries(self, ordered_entries, specific_file_ids=None,
1898
yield_parents=False):
1899
for trans_id, parent_file_id in ordered_entries:
1900
file_id = self._transform.final_file_id(trans_id)
1903
if (specific_file_ids is not None
1904
and file_id not in specific_file_ids):
1907
kind = self._transform.final_kind(trans_id)
1909
kind = self._transform._tree.stored_kind(file_id)
1910
new_entry = inventory.make_entry(
1912
self._transform.final_name(trans_id),
1913
parent_file_id, file_id)
1914
yield new_entry, trans_id
1916
def _list_files_by_dir(self):
1917
todo = [ROOT_PARENT]
1919
while len(todo) > 0:
1921
parent_file_id = self._transform.final_file_id(parent)
1922
children = list(self._all_children(parent))
1923
paths = dict(zip(children, self._final_paths.get_paths(children)))
1924
children.sort(key=paths.get)
1925
todo.extend(reversed(children))
1926
for trans_id in children:
1927
ordered_ids.append((trans_id, parent_file_id))
1930
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
1931
# This may not be a maximally efficient implementation, but it is
1932
# reasonably straightforward. An implementation that grafts the
1933
# TreeTransform changes onto the tree's iter_entries_by_dir results
1934
# might be more efficient, but requires tricky inferences about stack
1936
ordered_ids = self._list_files_by_dir()
1937
for entry, trans_id in self._make_inv_entries(ordered_ids,
1938
specific_file_ids, yield_parents=yield_parents):
1939
yield unicode(self._final_paths.get_path(trans_id)), entry
1941
def _iter_entries_for_dir(self, dir_path):
1942
"""Return path, entry for items in a directory without recursing down."""
1943
dir_file_id = self.path2id(dir_path)
1945
for file_id in self.iter_children(dir_file_id):
1946
trans_id = self._transform.trans_id_file_id(file_id)
1947
ordered_ids.append((trans_id, file_id))
1948
for entry, trans_id in self._make_inv_entries(ordered_ids):
1949
yield unicode(self._final_paths.get_path(trans_id)), entry
1951
def list_files(self, include_root=False, from_dir=None, recursive=True):
1952
"""See WorkingTree.list_files."""
1953
# XXX This should behave like WorkingTree.list_files, but is really
1954
# more like RevisionTree.list_files.
1958
prefix = from_dir + '/'
1959
entries = self.iter_entries_by_dir()
1960
for path, entry in entries:
1961
if entry.name == '' and not include_root:
1964
if not path.startswith(prefix):
1966
path = path[len(prefix):]
1967
yield path, 'V', entry.kind, entry.file_id, entry
1969
if from_dir is None and include_root is True:
1970
root_entry = inventory.make_entry('directory', '',
1971
ROOT_PARENT, self.get_root_id())
1972
yield '', 'V', 'directory', root_entry.file_id, root_entry
1973
entries = self._iter_entries_for_dir(from_dir or '')
1974
for path, entry in entries:
1975
yield path, 'V', entry.kind, entry.file_id, entry
1977
def kind(self, file_id):
1978
trans_id = self._transform.trans_id_file_id(file_id)
1979
return self._transform.final_kind(trans_id)
1981
def stored_kind(self, file_id):
1982
trans_id = self._transform.trans_id_file_id(file_id)
1984
return self._transform._new_contents[trans_id]
1986
return self._transform._tree.stored_kind(file_id)
1988
def get_file_mtime(self, file_id, path=None):
1989
"""See Tree.get_file_mtime"""
1990
if not self._content_change(file_id):
1991
return self._transform._tree.get_file_mtime(file_id)
1992
return self._stat_limbo_file(file_id).st_mtime
1994
def _file_size(self, entry, stat_value):
1995
return self.get_file_size(entry.file_id)
1997
def get_file_size(self, file_id):
1998
"""See Tree.get_file_size"""
1999
if self.kind(file_id) == 'file':
2000
return self._transform._tree.get_file_size(file_id)
2004
def get_file_sha1(self, file_id, path=None, stat_value=None):
2005
trans_id = self._transform.trans_id_file_id(file_id)
2006
kind = self._transform._new_contents.get(trans_id)
2008
return self._transform._tree.get_file_sha1(file_id)
2010
fileobj = self.get_file(file_id)
2012
return sha_file(fileobj)
2016
def is_executable(self, file_id, path=None):
2019
trans_id = self._transform.trans_id_file_id(file_id)
2021
return self._transform._new_executability[trans_id]
2024
return self._transform._tree.is_executable(file_id, path)
2026
if e.errno == errno.ENOENT:
2029
except errors.NoSuchId:
2032
def path_content_summary(self, path):
2033
trans_id = self._path2trans_id(path)
2034
tt = self._transform
2035
tree_path = tt._tree_id_paths.get(trans_id)
2036
kind = tt._new_contents.get(trans_id)
2038
if tree_path is None or trans_id in tt._removed_contents:
2039
return 'missing', None, None, None
2040
summary = tt._tree.path_content_summary(tree_path)
2041
kind, size, executable, link_or_sha1 = summary
2044
limbo_name = tt._limbo_name(trans_id)
2045
if trans_id in tt._new_reference_revision:
2046
kind = 'tree-reference'
2048
statval = os.lstat(limbo_name)
2049
size = statval.st_size
2050
if not supports_executable():
2053
executable = statval.st_mode & S_IEXEC
2057
if kind == 'symlink':
2058
link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
2059
executable = tt._new_executability.get(trans_id, executable)
2060
return kind, size, executable, link_or_sha1
2062
def iter_changes(self, from_tree, include_unchanged=False,
2063
specific_files=None, pb=None, extra_trees=None,
2064
require_versioned=True, want_unversioned=False):
2065
"""See InterTree.iter_changes.
2067
This has a fast path that is only used when the from_tree matches
2068
the transform tree, and no fancy options are supplied.
2070
if (from_tree is not self._transform._tree or include_unchanged or
2071
specific_files or want_unversioned):
2072
return tree.InterTree(from_tree, self).iter_changes(
2073
include_unchanged=include_unchanged,
2074
specific_files=specific_files,
2076
extra_trees=extra_trees,
2077
require_versioned=require_versioned,
2078
want_unversioned=want_unversioned)
2079
if want_unversioned:
2080
raise ValueError('want_unversioned is not supported')
2081
return self._transform.iter_changes()
2083
def get_file(self, file_id, path=None):
2084
"""See Tree.get_file"""
2085
if not self._content_change(file_id):
2086
return self._transform._tree.get_file(file_id, path)
2087
trans_id = self._transform.trans_id_file_id(file_id)
2088
name = self._transform._limbo_name(trans_id)
2089
return open(name, 'rb')
2091
def get_file_with_stat(self, file_id, path=None):
2092
return self.get_file(file_id, path), None
2094
def annotate_iter(self, file_id,
2095
default_revision=_mod_revision.CURRENT_REVISION):
2096
changes = self._iter_changes_cache.get(file_id)
2100
changed_content, versioned, kind = (changes[2], changes[3],
2104
get_old = (kind[0] == 'file' and versioned[0])
2106
old_annotation = self._transform._tree.annotate_iter(file_id,
2107
default_revision=default_revision)
2111
return old_annotation
2112
if not changed_content:
2113
return old_annotation
2114
# TODO: This is doing something similar to what WT.annotate_iter is
2115
# doing, however it fails slightly because it doesn't know what
2116
# the *other* revision_id is, so it doesn't know how to give the
2117
# other as the origin for some lines, they all get
2118
# 'default_revision'
2119
# It would be nice to be able to use the new Annotator based
2120
# approach, as well.
2121
return annotate.reannotate([old_annotation],
2122
self.get_file(file_id).readlines(),
2125
def get_symlink_target(self, file_id):
2126
"""See Tree.get_symlink_target"""
2127
if not self._content_change(file_id):
2128
return self._transform._tree.get_symlink_target(file_id)
2129
trans_id = self._transform.trans_id_file_id(file_id)
2130
name = self._transform._limbo_name(trans_id)
2131
return osutils.readlink(name)
2133
def walkdirs(self, prefix=''):
2134
pending = [self._transform.root]
2135
while len(pending) > 0:
2136
parent_id = pending.pop()
2139
prefix = prefix.rstrip('/')
2140
parent_path = self._final_paths.get_path(parent_id)
2141
parent_file_id = self._transform.final_file_id(parent_id)
2142
for child_id in self._all_children(parent_id):
2143
path_from_root = self._final_paths.get_path(child_id)
2144
basename = self._transform.final_name(child_id)
2145
file_id = self._transform.final_file_id(child_id)
2147
kind = self._transform.final_kind(child_id)
2148
versioned_kind = kind
2151
versioned_kind = self._transform._tree.stored_kind(file_id)
2152
if versioned_kind == 'directory':
2153
subdirs.append(child_id)
2154
children.append((path_from_root, basename, kind, None,
2155
file_id, versioned_kind))
2157
if parent_path.startswith(prefix):
2158
yield (parent_path, parent_file_id), children
2159
pending.extend(sorted(subdirs, key=self._final_paths.get_path,
2162
def get_parent_ids(self):
2163
return self._parent_ids
2165
def set_parent_ids(self, parent_ids):
2166
self._parent_ids = parent_ids
2168
def get_revision_tree(self, revision_id):
2169
return self._transform._tree.get_revision_tree(revision_id)
1080
2172
def joinpath(parent, child):
1081
2173
"""Join tree-relative paths, handling the tree root specially"""