33
32
revision as _mod_revision,
37
35
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
38
ReusingTransform, CantMoveRoot,
36
ReusingTransform, NotVersionedError, CantMoveRoot,
39
37
ExistingLimbo, ImmortalLimbo, NoFinalPath,
40
38
UnableCreateSymlink)
41
39
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
80
78
class TreeTransformBase(object):
81
79
"""The base class for TreeTransform and its kin."""
83
def __init__(self, tree, pb=None,
81
def __init__(self, tree, pb=DummyProgress(),
84
82
case_sensitive=True):
87
85
:param tree: The tree that will be transformed, but not necessarily
87
:param pb: A ProgressBar indicating how much progress is being made
90
88
:param case_sensitive: If True, the target of the transform is
91
89
case sensitive, not just case preserving.
164
162
def adjust_path(self, name, parent, trans_id):
165
163
"""Change the path that is assigned to a transaction id."""
167
raise ValueError("Parent trans-id may not be None")
168
164
if trans_id == self._new_root:
169
165
raise CantMoveRoot
170
166
self._new_name[trans_id] = name
171
167
self._new_parent[trans_id] = parent
168
if parent == ROOT_PARENT:
169
if self._new_root is not None:
170
raise ValueError("Cannot have multiple roots.")
171
self._new_root = trans_id
173
173
def adjust_root_path(self, name, parent):
174
174
"""Emulate moving the root by moving all children, instead.
202
202
self.version_file(old_root_file_id, old_root)
203
203
self.unversion_file(self._new_root)
205
def fixup_new_roots(self):
206
"""Reinterpret requests to change the root directory
208
Instead of creating a root directory, or moving an existing directory,
209
all the attributes and children of the new root are applied to the
210
existing root directory.
212
This means that the old root trans-id becomes obsolete, so it is
213
recommended only to invoke this after the root trans-id has become
216
new_roots = [k for k, v in self._new_parent.iteritems() if v is
218
if len(new_roots) < 1:
220
if len(new_roots) != 1:
221
raise ValueError('A tree cannot have two roots!')
222
if self._new_root is None:
223
self._new_root = new_roots[0]
225
old_new_root = new_roots[0]
226
# TODO: What to do if a old_new_root is present, but self._new_root is
227
# not listed as being removed? This code explicitly unversions
228
# the old root and versions it with the new file_id. Though that
229
# seems like an incomplete delta
231
# unversion the new root's directory.
232
file_id = self.final_file_id(old_new_root)
233
if old_new_root in self._new_id:
234
self.cancel_versioning(old_new_root)
236
self.unversion_file(old_new_root)
237
# if, at this stage, root still has an old file_id, zap it so we can
238
# stick a new one in.
239
if (self.tree_file_id(self._new_root) is not None and
240
self._new_root not in self._removed_id):
241
self.unversion_file(self._new_root)
242
self.version_file(file_id, self._new_root)
244
# Now move children of new root into old root directory.
245
# Ensure all children are registered with the transaction, but don't
246
# use directly-- some tree children have new parents
247
list(self.iter_tree_children(old_new_root))
248
# Move all children of new root into old root directory.
249
for child in self.by_parent().get(old_new_root, []):
250
self.adjust_path(self.final_name(child), self._new_root, child)
252
# Ensure old_new_root has no directory.
253
if old_new_root in self._new_contents:
254
self.cancel_creation(old_new_root)
256
self.delete_contents(old_new_root)
258
# prevent deletion of root directory.
259
if self._new_root in self._removed_contents:
260
self.cancel_deletion(self._new_root)
262
# destroy path info for old_new_root.
263
del self._new_parent[old_new_root]
264
del self._new_name[old_new_root]
266
205
def trans_id_tree_file_id(self, inventory_id):
267
206
"""Determine the transaction id of a working tree file.
922
854
def get_preview_tree(self):
923
855
"""Return a tree representing the result of the transform.
925
The tree is a snapshot, and altering the TreeTransform will invalidate
857
This tree only supports the subset of Tree functionality required
858
by show_diff_trees. It must only be compared to tt._tree.
928
860
return _PreviewTree(self)
930
def commit(self, branch, message, merge_parents=None, strict=False):
931
"""Commit the result of this TreeTransform to a branch.
933
:param branch: The branch to commit to.
934
:param message: The message to attach to the commit.
935
:param merge_parents: Additional parents specified by pending merges.
936
:return: The revision_id of the revision committed.
938
self._check_malformed()
940
unversioned = set(self._new_contents).difference(set(self._new_id))
941
for trans_id in unversioned:
942
if self.final_file_id(trans_id) is None:
943
raise errors.StrictCommitFailed()
945
revno, last_rev_id = branch.last_revision_info()
946
if last_rev_id == _mod_revision.NULL_REVISION:
947
if merge_parents is not None:
948
raise ValueError('Cannot supply merge parents for first'
952
parent_ids = [last_rev_id]
953
if merge_parents is not None:
954
parent_ids.extend(merge_parents)
955
if self._tree.get_revision_id() != last_rev_id:
956
raise ValueError('TreeTransform not based on branch basis: %s' %
957
self._tree.get_revision_id())
958
builder = branch.get_commit_builder(parent_ids)
959
preview = self.get_preview_tree()
960
list(builder.record_iter_changes(preview, last_rev_id,
961
self.iter_changes()))
962
builder.finish_inventory()
963
revision_id = builder.commit(message)
964
branch.set_last_revision_info(revno + 1, revision_id)
967
862
def _text_parent(self, trans_id):
968
863
file_id = self.tree_file_id(trans_id)
1063
958
class DiskTreeTransform(TreeTransformBase):
1064
959
"""Tree transform storing its contents on disk."""
1066
def __init__(self, tree, limbodir, pb=None,
961
def __init__(self, tree, limbodir, pb=DummyProgress(),
1067
962
case_sensitive=True):
1069
964
:param tree: The tree that will be transformed, but not necessarily
1070
965
the output tree.
1071
966
:param limbodir: A directory where new files can be stored until
1072
967
they are installed in their proper places
968
:param pb: A ProgressBar indicating how much progress is being made
1074
969
:param case_sensitive: If True, the target of the transform is
1075
970
case sensitive, not just case preserving.
1101
995
self._new_contents.iteritems()]
1102
996
entries.sort(reverse=True)
1103
997
for path, trans_id, kind in entries:
998
if kind == "directory":
1106
delete_any(self._limbodir)
1003
os.rmdir(self._limbodir)
1107
1004
except OSError:
1108
1005
# We don't especially care *why* the dir is immortal.
1109
1006
raise ImmortalLimbo(self._limbodir)
1111
1008
if self._deletiondir is not None:
1112
delete_any(self._deletiondir)
1009
os.rmdir(self._deletiondir)
1113
1010
except OSError:
1114
1011
raise errors.ImmortalPendingDeletion(self._deletiondir)
1118
1015
def _limbo_name(self, trans_id):
1119
1016
"""Generate the limbo name of a file"""
1120
1017
limbo_name = self._limbo_files.get(trans_id)
1121
if limbo_name is None:
1122
limbo_name = self._generate_limbo_path(trans_id)
1123
self._limbo_files[trans_id] = limbo_name
1018
if limbo_name is not None:
1020
parent = self._new_parent.get(trans_id)
1021
# if the parent directory is already in limbo (e.g. when building a
1022
# tree), choose a limbo name inside the parent, to reduce further
1024
use_direct_path = False
1025
if self._new_contents.get(parent) == 'directory':
1026
filename = self._new_name.get(trans_id)
1027
if filename is not None:
1028
if parent not in self._limbo_children:
1029
self._limbo_children[parent] = set()
1030
self._limbo_children_names[parent] = {}
1031
use_direct_path = True
1032
# the direct path can only be used if no other file has
1033
# already taken this pathname, i.e. if the name is unused, or
1034
# if it is already associated with this trans_id.
1035
elif self._case_sensitive_target:
1036
if (self._limbo_children_names[parent].get(filename)
1037
in (trans_id, None)):
1038
use_direct_path = True
1040
for l_filename, l_trans_id in\
1041
self._limbo_children_names[parent].iteritems():
1042
if l_trans_id == trans_id:
1044
if l_filename.lower() == filename.lower():
1047
use_direct_path = True
1050
limbo_name = pathjoin(self._limbo_files[parent], filename)
1051
self._limbo_children[parent].add(trans_id)
1052
self._limbo_children_names[parent][filename] = trans_id
1054
limbo_name = pathjoin(self._limbodir, trans_id)
1055
self._needs_rename.add(trans_id)
1056
self._limbo_files[trans_id] = limbo_name
1124
1057
return limbo_name
1126
def _generate_limbo_path(self, trans_id):
1127
"""Generate a limbo path using the trans_id as the relative path.
1129
This is suitable as a fallback, and when the transform should not be
1130
sensitive to the path encoding of the limbo directory.
1132
self._needs_rename.add(trans_id)
1133
return pathjoin(self._limbodir, trans_id)
1135
1059
def adjust_path(self, name, parent, trans_id):
1136
1060
previous_parent = self._new_parent.get(trans_id)
1137
1061
previous_name = self._new_name.get(trans_id)
1139
1063
if (trans_id in self._limbo_files and
1140
1064
trans_id not in self._needs_rename):
1141
1065
self._rename_in_limbo([trans_id])
1142
if previous_parent != parent:
1143
self._limbo_children[previous_parent].remove(trans_id)
1144
if previous_parent != parent or previous_name != name:
1145
del self._limbo_children_names[previous_parent][previous_name]
1066
self._limbo_children[previous_parent].remove(trans_id)
1067
del self._limbo_children_names[previous_parent][previous_name]
1147
1069
def _rename_in_limbo(self, trans_ids):
1148
1070
"""Fix limbo names so that the right final path is produced.
1160
1082
if trans_id not in self._new_contents:
1162
1084
new_path = self._limbo_name(trans_id)
1163
osutils.rename(old_path, new_path)
1164
for descendant in self._limbo_descendants(trans_id):
1165
desc_path = self._limbo_files[descendant]
1166
desc_path = new_path + desc_path[len(old_path):]
1167
self._limbo_files[descendant] = desc_path
1169
def _limbo_descendants(self, trans_id):
1170
"""Return the set of trans_ids whose limbo paths descend from this."""
1171
descendants = set(self._limbo_children.get(trans_id, []))
1172
for descendant in list(descendants):
1173
descendants.update(self._limbo_descendants(descendant))
1085
os.rename(old_path, new_path)
1176
1087
def create_file(self, contents, trans_id, mode_id=None):
1177
1088
"""Schedule creation of a new file.
1212
1122
def _read_symlink_target(self, trans_id):
1213
1123
return os.readlink(self._limbo_name(trans_id))
1215
def _set_mtime(self, path):
1216
"""All files that are created get the same mtime.
1218
This time is set by the first object to be created.
1220
if self._creation_mtime is None:
1221
self._creation_mtime = time.time()
1222
os.utime(path, (self._creation_mtime, self._creation_mtime))
1224
1125
def create_hardlink(self, path, trans_id):
1225
1126
"""Schedule creation of a hard link"""
1226
1127
name = self._limbo_name(trans_id)
1457
1358
yield self.trans_id_tree_path(childpath)
1459
def _generate_limbo_path(self, trans_id):
1460
"""Generate a limbo path using the final path if possible.
1462
This optimizes the performance of applying the tree transform by
1463
avoiding renames. These renames can be avoided only when the parent
1464
directory is already scheduled for creation.
1466
If the final path cannot be used, falls back to using the trans_id as
1469
parent = self._new_parent.get(trans_id)
1470
# if the parent directory is already in limbo (e.g. when building a
1471
# tree), choose a limbo name inside the parent, to reduce further
1473
use_direct_path = False
1474
if self._new_contents.get(parent) == 'directory':
1475
filename = self._new_name.get(trans_id)
1476
if filename is not None:
1477
if parent not in self._limbo_children:
1478
self._limbo_children[parent] = set()
1479
self._limbo_children_names[parent] = {}
1480
use_direct_path = True
1481
# the direct path can only be used if no other file has
1482
# already taken this pathname, i.e. if the name is unused, or
1483
# if it is already associated with this trans_id.
1484
elif self._case_sensitive_target:
1485
if (self._limbo_children_names[parent].get(filename)
1486
in (trans_id, None)):
1487
use_direct_path = True
1489
for l_filename, l_trans_id in\
1490
self._limbo_children_names[parent].iteritems():
1491
if l_trans_id == trans_id:
1493
if l_filename.lower() == filename.lower():
1496
use_direct_path = True
1498
if not use_direct_path:
1499
return DiskTreeTransform._generate_limbo_path(self, trans_id)
1501
limbo_name = pathjoin(self._limbo_files[parent], filename)
1502
self._limbo_children[parent].add(trans_id)
1503
self._limbo_children_names[parent][filename] = trans_id
1507
1361
def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1508
1362
"""Apply all changes to the inventory and filesystem.
1629
1485
child_pb.update('removing file', num, len(tree_paths))
1630
1486
full_path = self._tree.abspath(path)
1631
1487
if trans_id in self._removed_contents:
1632
delete_path = os.path.join(self._deletiondir, trans_id)
1633
mover.pre_delete(full_path, delete_path)
1634
elif (trans_id in self._new_name
1635
or trans_id in self._new_parent):
1488
mover.pre_delete(full_path, os.path.join(self._deletiondir,
1490
elif trans_id in self._new_name or trans_id in \
1637
1493
mover.rename(full_path, self._limbo_name(trans_id))
1638
1494
except OSError, e:
1692
1548
unversioned files in the input tree.
1695
def __init__(self, tree, pb=None, case_sensitive=True):
1551
def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1696
1552
tree.lock_read()
1697
1553
limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1698
1554
DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
1743
1599
self._all_children_cache = {}
1744
1600
self._path2trans_id_cache = {}
1745
1601
self._final_name_cache = {}
1746
self._iter_changes_cache = dict((c[0], c) for c in
1747
self._transform.iter_changes())
1603
def _changes(self, file_id):
1604
for changes in self._transform.iter_changes():
1605
if changes[0] == file_id:
1749
1608
def _content_change(self, file_id):
1750
1609
"""Return True if the content of this file changed"""
1751
changes = self._iter_changes_cache.get(file_id)
1610
changes = self._changes(file_id)
1752
1611
# changes[2] is true if the file content changed. See
1753
1612
# InterTree.iter_changes.
1754
1613
return (changes is not None and changes[2])
1823
1682
def __iter__(self):
1824
1683
return iter(self.all_file_ids())
1826
def _has_id(self, file_id, fallback_check):
1685
def has_id(self, file_id):
1827
1686
if file_id in self._transform._r_new_id:
1829
1688
elif file_id in set([self._transform.tree_file_id(trans_id) for
1830
1689
trans_id in self._transform._removed_id]):
1833
return fallback_check(file_id)
1835
def has_id(self, file_id):
1836
return self._has_id(file_id, self._transform._tree.has_id)
1838
def has_or_had_id(self, file_id):
1839
return self._has_id(file_id, self._transform._tree.has_or_had_id)
1692
return self._transform._tree.has_id(file_id)
1841
1694
def _path2trans_id(self, path):
1842
1695
# We must not use None here, because that is a valid value to store.
1895
1748
if self._transform.final_file_id(trans_id) is None:
1896
1749
yield self._final_paths._determine_path(trans_id)
1898
def _make_inv_entries(self, ordered_entries, specific_file_ids=None,
1899
yield_parents=False):
1751
def _make_inv_entries(self, ordered_entries, specific_file_ids=None):
1900
1752
for trans_id, parent_file_id in ordered_entries:
1901
1753
file_id = self._transform.final_file_id(trans_id)
1902
1754
if file_id is None:
1928
1780
ordered_ids.append((trans_id, parent_file_id))
1929
1781
return ordered_ids
1931
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
1783
def iter_entries_by_dir(self, specific_file_ids=None):
1932
1784
# This may not be a maximally efficient implementation, but it is
1933
1785
# reasonably straightforward. An implementation that grafts the
1934
1786
# TreeTransform changes onto the tree's iter_entries_by_dir results
1989
1841
def get_file_mtime(self, file_id, path=None):
1990
1842
"""See Tree.get_file_mtime"""
1991
1843
if not self._content_change(file_id):
1992
return self._transform._tree.get_file_mtime(file_id)
1844
return self._transform._tree.get_file_mtime(file_id, path)
1993
1845
return self._stat_limbo_file(file_id).st_mtime
1995
1847
def _file_size(self, entry, stat_value):
2057
1909
executable = None
2058
1910
if kind == 'symlink':
2059
1911
link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
2060
executable = tt._new_executability.get(trans_id, executable)
1912
if supports_executable():
1913
executable = tt._new_executability.get(trans_id, executable)
2061
1914
return kind, size, executable, link_or_sha1
2063
1916
def iter_changes(self, from_tree, include_unchanged=False,
2112
1965
return old_annotation
2113
1966
if not changed_content:
2114
1967
return old_annotation
2115
# TODO: This is doing something similar to what WT.annotate_iter is
2116
# doing, however it fails slightly because it doesn't know what
2117
# the *other* revision_id is, so it doesn't know how to give the
2118
# other as the origin for some lines, they all get
2119
# 'default_revision'
2120
# It would be nice to be able to use the new Annotator based
2121
# approach, as well.
2122
1968
return annotate.reannotate([old_annotation],
2123
1969
self.get_file(file_id).readlines(),
2124
1970
default_revision)
2376
2222
new_desired_files = desired_files
2378
2224
iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2379
unchanged = [(f, p[1]) for (f, p, c, v, d, n, k, e)
2380
in iter if not (c or e[0] != e[1])]
2381
if accelerator_tree.supports_content_filtering():
2382
unchanged = [(f, p) for (f, p) in unchanged
2383
if not accelerator_tree.iter_search_rules([p]).next()]
2384
unchanged = dict(unchanged)
2225
unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
2226
in iter if not (c or e[0] != e[1]))
2385
2227
new_desired_files = []
2387
2229
for file_id, (trans_id, tree_path) in desired_files:
2510
2352
tt.create_directory(trans_id)
2513
def create_from_tree(tt, trans_id, tree, file_id, bytes=None,
2514
filter_tree_path=None):
2515
"""Create new file contents according to tree contents.
2517
:param filter_tree_path: the tree path to use to lookup
2518
content filters to apply to the bytes output in the working tree.
2519
This only applies if the working tree supports content filtering.
2355
def create_from_tree(tt, trans_id, tree, file_id, bytes=None):
2356
"""Create new file contents according to tree contents."""
2521
2357
kind = tree.kind(file_id)
2522
2358
if kind == 'directory':
2523
2359
tt.create_directory(trans_id)
2528
2364
bytes = tree_file.readlines()
2530
2366
tree_file.close()
2532
if wt.supports_content_filtering() and filter_tree_path is not None:
2533
filters = wt._content_filter_stack(filter_tree_path)
2534
bytes = filtered_output_bytes(bytes, filters,
2535
ContentFilterContext(filter_tree_path, tree))
2536
2367
tt.create_file(bytes, trans_id)
2537
2368
elif kind == "symlink":
2538
2369
tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2592
2423
def revert(working_tree, target_tree, filenames, backups=False,
2593
pb=None, change_reporter=None):
2424
pb=DummyProgress(), change_reporter=None):
2594
2425
"""Revert a working tree's contents to those of a target tree."""
2595
2426
target_tree.lock_read()
2596
pb = ui.ui_factory.nested_progress_bar()
2597
2427
tt = TreeTransform(working_tree, pb)
2599
2429
pp = ProgressPhase("Revert phase", 3, pb)
2725
2557
parent_trans = ROOT_PARENT
2727
2559
parent_trans = tt.trans_id_file_id(parent[1])
2728
if parent[0] is None and versioned[0]:
2729
tt.adjust_root_path(name[1], parent_trans)
2731
tt.adjust_path(name[1], parent_trans, trans_id)
2560
tt.adjust_path(name[1], parent_trans, trans_id)
2732
2561
if executable[0] != executable[1] and kind[1] == "file":
2733
2562
tt.set_executability(executable[1], trans_id)
2734
if working_tree.supports_content_filtering():
2735
for index, ((trans_id, mode_id), bytes) in enumerate(
2736
target_tree.iter_files_bytes(deferred_files)):
2737
file_id = deferred_files[index][0]
2738
# We're reverting a tree to the target tree so using the
2739
# target tree to find the file path seems the best choice
2740
# here IMO - Ian C 27/Oct/2009
2741
filter_tree_path = target_tree.id2path(file_id)
2742
filters = working_tree._content_filter_stack(filter_tree_path)
2743
bytes = filtered_output_bytes(bytes, filters,
2744
ContentFilterContext(filter_tree_path, working_tree))
2745
tt.create_file(bytes, trans_id, mode_id)
2747
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
2749
tt.create_file(bytes, trans_id, mode_id)
2750
tt.fixup_new_roots()
2563
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
2565
tt.create_file(bytes, trans_id, mode_id)
2752
2567
if basis_tree is not None:
2753
2568
basis_tree.unlock()
2754
2569
return merge_modified
2757
def resolve_conflicts(tt, pb=None, pass_func=None):
2572
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
2758
2573
"""Make many conflict-resolution attempts, but die if they fail"""
2759
2574
if pass_func is None:
2760
2575
pass_func = conflict_pass
2761
2576
new_conflicts = set()
2762
pb = ui.ui_factory.nested_progress_bar()
2764
2578
for n in range(10):
2765
2579
pb.update('Resolution pass', n+1, 10)
2898
2712
self.pending_deletions = []
2900
2714
def rename(self, from_, to):
2901
"""Rename a file from one path to another."""
2715
"""Rename a file from one path to another. Functions like os.rename"""
2903
osutils.rename(from_, to)
2717
os.rename(from_, to)
2904
2718
except OSError, e:
2905
2719
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
2906
2720
raise errors.FileExists(to, str(e))
added
removed
bzrlib/transform.py
