48
40
ExistingLimbo, ImmortalLimbo, NoFinalPath,
49
41
UnableCreateSymlink)
50
42
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
43
from bzrlib.inventory import InventoryEntry
51
44
from bzrlib.osutils import (
58
52
supports_executable,
60
54
from bzrlib.progress import ProgressPhase
61
55
from bzrlib.symbol_versioning import (
59
from bzrlib.trace import mutter, warning
60
from bzrlib import tree
62
import bzrlib.urlutils as urlutils
68
65
ROOT_PARENT = "root-parent"
70
68
def unique_add(map, key, value):
72
70
raise DuplicateKey(key=key)
77
74
class _TransformResults(object):
78
75
def __init__(self, modified_paths, rename_count):
79
76
object.__init__(self)
400
380
return sorted(FinalPaths(self).get_paths(new_ids))
402
382
def _inventory_altered(self):
403
"""Determine which trans_ids need new Inventory entries.
405
An new entry is needed when anything that would be reflected by an
406
inventory entry changes, including file name, file_id, parent file_id,
407
file kind, and the execute bit.
409
Some care is taken to return entries with real changes, not cases
410
where the value is deleted and then restored to its original value,
411
but some actually unchanged values may be returned.
413
:returns: A list of (path, trans_id) for all items requiring an
414
inventory change. Ordered by path.
417
# Find entries whose file_ids are new (or changed).
418
new_file_id = set(t for t in self._new_id
419
if self._new_id[t] != self.tree_file_id(t))
420
for id_set in [self._new_name, self._new_parent, new_file_id,
383
"""Get the trans_ids and paths of files needing new inv entries."""
385
for id_set in [self._new_name, self._new_parent, self._new_id,
421
386
self._new_executability]:
422
changed_ids.update(id_set)
423
# removing implies a kind change
387
new_ids.update(id_set)
424
388
changed_kind = set(self._removed_contents)
426
389
changed_kind.intersection_update(self._new_contents)
427
# Ignore entries that are already known to have changed.
428
changed_kind.difference_update(changed_ids)
429
# to keep only the truly changed ones
390
changed_kind.difference_update(new_ids)
430
391
changed_kind = (t for t in changed_kind
431
392
if self.tree_kind(t) != self.final_kind(t))
432
# all kind changes will alter the inventory
433
changed_ids.update(changed_kind)
434
# To find entries with changed parent_ids, find parents which existed,
435
# but changed file_id.
436
changed_file_id = set(t for t in new_file_id if t in self._removed_id)
437
# Now add all their children to the set.
438
for parent_trans_id in new_file_id:
439
changed_ids.update(self.iter_tree_children(parent_trans_id))
440
return sorted(FinalPaths(self).get_paths(changed_ids))
393
new_ids.update(changed_kind)
394
return sorted(FinalPaths(self).get_paths(new_ids))
442
396
def final_kind(self, trans_id):
443
397
"""Determine the final file kind, after any changes applied.
579
531
# ensure that all children are registered with the transaction
580
532
list(self.iter_tree_children(parent_id))
582
@deprecated_method(deprecated_in((2, 3, 0)))
583
534
def has_named_child(self, by_parent, parent_id, name):
584
return self._has_named_child(
585
name, parent_id, known_children=by_parent.get(parent_id, []))
587
def _has_named_child(self, name, parent_id, known_children):
588
"""Does a parent already have a name child.
590
:param name: The searched for name.
592
:param parent_id: The parent for which the check is made.
594
:param known_children: The already known children. This should have
595
been recently obtained from `self.by_parent.get(parent_id)`
596
(or will be if None is passed).
598
if known_children is None:
599
known_children = self.by_parent().get(parent_id, [])
600
for child in known_children:
536
children = by_parent[parent_id]
539
for child in children:
601
540
if self.final_name(child) == name:
603
parent_path = self._tree_id_paths.get(parent_id, None)
604
if parent_path is None:
605
# No parent... no children
543
path = self._tree_id_paths[parent_id]
607
child_path = joinpath(parent_path, name)
608
child_id = self._tree_path_ids.get(child_path, None)
546
childpath = joinpath(path, name)
547
child_id = self._tree_path_ids.get(childpath)
609
548
if child_id is None:
610
# Not known by the tree transform yet, check the filesystem
611
return osutils.lexists(self._tree.abspath(child_path))
549
return lexists(self._tree.abspath(childpath))
613
raise AssertionError('child_id is missing: %s, %s, %s'
614
% (name, parent_id, child_id))
616
def _available_backup_name(self, name, target_id):
617
"""Find an available backup name.
619
:param name: The basename of the file.
621
:param target_id: The directory trans_id where the backup should
624
known_children = self.by_parent().get(target_id, [])
625
return osutils.available_backup_name(
627
lambda base: self._has_named_child(
628
base, target_id, known_children))
551
if self.final_parent(child_id) != parent_id:
553
if child_id in self._removed_contents:
554
# XXX What about dangling file-ids?
630
559
def _parent_loops(self):
631
560
"""No entry should be its own ancestor"""
747
671
def _parent_type_conflicts(self, by_parent):
748
"""Children must have a directory parent"""
672
"""parents must have directory 'contents'."""
750
674
for parent_id, children in by_parent.iteritems():
751
675
if parent_id is ROOT_PARENT:
754
for child_id in children:
755
if self.final_kind(child_id) is not None:
677
if not self._any_contents(children):
760
# There is at least a child, so we need an existing directory to
762
679
kind = self.final_kind(parent_id)
764
# The directory will be deleted
765
681
conflicts.append(('missing parent', parent_id))
766
682
elif kind != "directory":
767
# Meh, we need a *directory* to put something in it
768
683
conflicts.append(('non-directory parent', parent_id))
686
def _any_contents(self, trans_ids):
687
"""Return true if any of the trans_ids, will have contents."""
688
for trans_id in trans_ids:
689
if self.final_kind(trans_id) is not None:
771
693
def _set_executability(self, path, trans_id):
772
694
"""Set the executability of versioned files """
773
695
if supports_executable():
837
759
self.create_symlink(target, trans_id)
840
def new_orphan(self, trans_id, parent_id):
841
"""Schedule an item to be orphaned.
843
When a directory is about to be removed, its children, if they are not
844
versioned are moved out of the way: they don't have a parent anymore.
846
:param trans_id: The trans_id of the existing item.
847
:param parent_id: The parent trans_id of the item.
849
raise NotImplementedError(self.new_orphan)
851
def _get_potential_orphans(self, dir_id):
852
"""Find the potential orphans in a directory.
854
A directory can't be safely deleted if there are versioned files in it.
855
If all the contained files are unversioned then they can be orphaned.
857
The 'None' return value means that the directory contains at least one
858
versioned file and should not be deleted.
860
:param dir_id: The directory trans id.
862
:return: A list of the orphan trans ids or None if at least one
863
versioned file is present.
866
# Find the potential orphans, stop if one item should be kept
867
for child_tid in self.by_parent()[dir_id]:
868
if child_tid in self._removed_contents:
869
# The child is removed as part of the transform. Since it was
870
# versioned before, it's not an orphan
872
elif self.final_file_id(child_tid) is None:
873
# The child is not versioned
874
orphans.append(child_tid)
876
# We have a versioned file here, searching for orphans is
882
762
def _affected_ids(self):
883
763
"""Return the set of transform ids affected by the transform"""
884
764
trans_ids = set(self._removed_id)
1301
1170
descendants.update(self._limbo_descendants(descendant))
1302
1171
return descendants
1304
def create_file(self, contents, trans_id, mode_id=None, sha1=None):
1173
def create_file(self, contents, trans_id, mode_id=None):
1305
1174
"""Schedule creation of a new file.
1309
:param contents: an iterator of strings, all of which will be written
1310
to the target destination.
1311
:param trans_id: TreeTransform handle
1312
:param mode_id: If not None, force the mode of the target file to match
1313
the mode of the object referenced by mode_id.
1314
Otherwise, we will try to preserve mode bits of an existing file.
1315
:param sha1: If the sha1 of this content is already known, pass it in.
1316
We can use it to prevent future sha1 computations.
1178
Contents is an iterator of strings, all of which will be written
1179
to the target destination.
1181
New file takes the permissions of any existing file with that id,
1182
unless mode_id is specified.
1318
1184
name = self._limbo_name(trans_id)
1319
1185
f = open(name, 'wb')
1321
unique_add(self._new_contents, trans_id, 'file')
1188
unique_add(self._new_contents, trans_id, 'file')
1190
# Clean up the file, it never got registered so
1191
# TreeTransform.finalize() won't clean it up.
1322
1196
f.writelines(contents)
1325
1199
self._set_mtime(name)
1326
1200
self._set_mode(trans_id, mode_id, S_ISREG)
1327
# It is unfortunate we have to use lstat instead of fstat, but we just
1328
# used utime and chmod on the file, so we need the accurate final
1330
if sha1 is not None:
1331
self._observed_sha1s[trans_id] = (sha1, osutils.lstat(name))
1333
1202
def _read_file_chunks(self, trans_id):
1334
1203
cur_file = open(self._limbo_name(trans_id), 'rb')
1404
1271
del self._limbo_children_names[trans_id]
1405
1272
delete_any(self._limbo_name(trans_id))
1407
def new_orphan(self, trans_id, parent_id):
1408
# FIXME: There is no tree config, so we use the branch one (it's weird
1409
# to define it this way as orphaning can only occur in a working tree,
1410
# but that's all we have (for now). It will find the option in
1411
# locations.conf or bazaar.conf though) -- vila 20100916
1412
conf = self._tree.branch.get_config()
1413
conf_var_name = 'bzr.transform.orphan_policy'
1414
orphan_policy = conf.get_user_option(conf_var_name)
1415
default_policy = orphaning_registry.default_key
1416
if orphan_policy is None:
1417
orphan_policy = default_policy
1418
if orphan_policy not in orphaning_registry:
1419
trace.warning('%s (from %s) is not a known policy, defaulting '
1420
'to %s' % (orphan_policy, conf_var_name, default_policy))
1421
orphan_policy = default_policy
1422
handle_orphan = orphaning_registry.get(orphan_policy)
1423
handle_orphan(self, trans_id, parent_id)
1426
class OrphaningError(errors.BzrError):
1428
# Only bugs could lead to such exception being seen by the user
1429
internal_error = True
1430
_fmt = "Error while orphaning %s in %s directory"
1432
def __init__(self, orphan, parent):
1433
errors.BzrError.__init__(self)
1434
self.orphan = orphan
1435
self.parent = parent
1438
class OrphaningForbidden(OrphaningError):
1440
_fmt = "Policy: %s doesn't allow creating orphans."
1442
def __init__(self, policy):
1443
errors.BzrError.__init__(self)
1444
self.policy = policy
1447
def move_orphan(tt, orphan_id, parent_id):
1448
"""See TreeTransformBase.new_orphan.
1450
This creates a new orphan in the `bzr-orphans` dir at the root of the
1453
:param tt: The TreeTransform orphaning `trans_id`.
1455
:param orphan_id: The trans id that should be orphaned.
1457
:param parent_id: The orphan parent trans id.
1459
# Add the orphan dir if it doesn't exist
1460
orphan_dir_basename = 'bzr-orphans'
1461
od_id = tt.trans_id_tree_path(orphan_dir_basename)
1462
if tt.final_kind(od_id) is None:
1463
tt.create_directory(od_id)
1464
parent_path = tt._tree_id_paths[parent_id]
1465
# Find a name that doesn't exist yet in the orphan dir
1466
actual_name = tt.final_name(orphan_id)
1467
new_name = tt._available_backup_name(actual_name, od_id)
1468
tt.adjust_path(new_name, od_id, orphan_id)
1469
trace.warning('%s has been orphaned in %s'
1470
% (joinpath(parent_path, actual_name), orphan_dir_basename))
1473
def refuse_orphan(tt, orphan_id, parent_id):
1474
"""See TreeTransformBase.new_orphan.
1476
This refuses to create orphan, letting the caller handle the conflict.
1478
raise OrphaningForbidden('never')
1481
orphaning_registry = registry.Registry()
1482
orphaning_registry.register(
1483
'conflict', refuse_orphan,
1484
'Leave orphans in place and create a conflict on the directory.')
1485
orphaning_registry.register(
1486
'move', move_orphan,
1487
'Move orphans into the bzr-orphans directory.')
1488
orphaning_registry._set_default_key('conflict')
1491
1275
class TreeTransform(DiskTreeTransform):
1492
1276
"""Represent a tree transformation.
1886
1667
self.rename_count += 1
1887
# TODO: if trans_id in self._observed_sha1s, we should
1888
# re-stat the final target, since ctime will be
1889
# updated by the change.
1890
1668
if (trans_id in self._new_contents or
1891
1669
self.path_changed(trans_id)):
1892
1670
if trans_id in self._new_contents:
1893
1671
modified_paths.append(full_path)
1894
1672
if trans_id in self._new_executability:
1895
1673
self._set_executability(path, trans_id)
1896
if trans_id in self._observed_sha1s:
1897
o_sha1, o_st_val = self._observed_sha1s[trans_id]
1898
st = osutils.lstat(full_path)
1899
self._observed_sha1s[trans_id] = (o_sha1, st)
1901
1675
child_pb.finished()
1902
for path, trans_id in new_paths:
1903
# new_paths includes stuff like workingtree conflicts. Only the
1904
# stuff in new_contents actually comes from limbo.
1905
if trans_id in self._limbo_files:
1906
del self._limbo_files[trans_id]
1907
1676
self._new_contents.clear()
1908
1677
return modified_paths
1910
def _apply_observed_sha1s(self):
1911
"""After we have finished renaming everything, update observed sha1s
1913
This has to be done after self._tree.apply_inventory_delta, otherwise
1914
it doesn't know anything about the files we are updating. Also, we want
1915
to do this as late as possible, so that most entries end up cached.
1917
# TODO: this doesn't update the stat information for directories. So
1918
# the first 'bzr status' will still need to rewrite
1919
# .bzr/checkout/dirstate. However, we at least don't need to
1920
# re-read all of the files.
1921
# TODO: If the operation took a while, we could do a time.sleep(3) here
1922
# to allow the clock to tick over and ensure we won't have any
1923
# problems. (we could observe start time, and finish time, and if
1924
# it is less than eg 10% overhead, add a sleep call.)
1925
paths = FinalPaths(self)
1926
for trans_id, observed in self._observed_sha1s.iteritems():
1927
path = paths.get_path(trans_id)
1928
# We could get the file_id, but dirstate prefers to use the path
1929
# anyway, and it is 'cheaper' to determine.
1930
# file_id = self._new_id[trans_id]
1931
self._tree._observed_sha1(None, path, observed)
1934
1680
class TransformPreview(DiskTreeTransform):
1935
1681
"""A TreeTransform for generating preview trees.
2688
2415
offset += count
2689
for count, ((trans_id, tree_path, text_sha1), contents) in enumerate(
2416
for count, ((trans_id, tree_path), contents) in enumerate(
2690
2417
tree.iter_files_bytes(new_desired_files)):
2691
2418
if wt.supports_content_filtering():
2692
2419
filters = wt._content_filter_stack(tree_path)
2693
2420
contents = filtered_output_bytes(contents, filters,
2694
2421
ContentFilterContext(tree_path, tree))
2695
tt.create_file(contents, trans_id, sha1=text_sha1)
2422
tt.create_file(contents, trans_id)
2696
2423
pb.update('Adding file contents', count + offset, total)
2924
2643
deferred_files = []
2925
2644
for id_num, (file_id, path, changed_content, versioned, parent, name,
2926
2645
kind, executable) in enumerate(change_list):
2927
target_path, wt_path = path
2928
target_versioned, wt_versioned = versioned
2929
target_parent, wt_parent = parent
2930
target_name, wt_name = name
2931
target_kind, wt_kind = kind
2932
target_executable, wt_executable = executable
2933
if skip_root and wt_parent is None:
2646
if skip_root and file_id[0] is not None and parent[0] is None:
2935
2648
trans_id = tt.trans_id_file_id(file_id)
2937
2650
if changed_content:
2938
2651
keep_content = False
2939
if wt_kind == 'file' and (backups or target_kind is None):
2652
if kind[0] == 'file' and (backups or kind[1] is None):
2940
2653
wt_sha1 = working_tree.get_file_sha1(file_id)
2941
2654
if merge_modified.get(file_id) != wt_sha1:
2942
2655
# acquire the basis tree lazily to prevent the
2945
2658
if basis_tree is None:
2946
2659
basis_tree = working_tree.basis_tree()
2947
2660
basis_tree.lock_read()
2948
if basis_tree.has_id(file_id):
2661
if file_id in basis_tree:
2949
2662
if wt_sha1 != basis_tree.get_file_sha1(file_id):
2950
2663
keep_content = True
2951
elif target_kind is None and not target_versioned:
2664
elif kind[1] is None and not versioned[1]:
2952
2665
keep_content = True
2953
if wt_kind is not None:
2666
if kind[0] is not None:
2954
2667
if not keep_content:
2955
2668
tt.delete_contents(trans_id)
2956
elif target_kind is not None:
2957
parent_trans_id = tt.trans_id_file_id(wt_parent)
2958
backup_name = tt._available_backup_name(
2959
wt_name, parent_trans_id)
2669
elif kind[1] is not None:
2670
parent_trans_id = tt.trans_id_file_id(parent[0])
2671
by_parent = tt.by_parent()
2672
backup_name = _get_backup_name(name[0], by_parent,
2673
parent_trans_id, tt)
2960
2674
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2961
new_trans_id = tt.create_path(wt_name, parent_trans_id)
2962
if wt_versioned and target_versioned:
2675
new_trans_id = tt.create_path(name[0], parent_trans_id)
2676
if versioned == (True, True):
2963
2677
tt.unversion_file(trans_id)
2964
2678
tt.version_file(file_id, new_trans_id)
2965
2679
# New contents should have the same unix perms as old
2967
2681
mode_id = trans_id
2968
2682
trans_id = new_trans_id
2969
if target_kind in ('directory', 'tree-reference'):
2683
if kind[1] in ('directory', 'tree-reference'):
2970
2684
tt.create_directory(trans_id)
2971
if target_kind == 'tree-reference':
2685
if kind[1] == 'tree-reference':
2972
2686
revision = target_tree.get_reference_revision(file_id,
2974
2688
tt.set_tree_reference(revision, trans_id)
2975
elif target_kind == 'symlink':
2689
elif kind[1] == 'symlink':
2976
2690
tt.create_symlink(target_tree.get_symlink_target(file_id),
2978
elif target_kind == 'file':
2692
elif kind[1] == 'file':
2979
2693
deferred_files.append((file_id, (trans_id, mode_id)))
2980
2694
if basis_tree is None:
2981
2695
basis_tree = working_tree.basis_tree()
2982
2696
basis_tree.lock_read()
2983
2697
new_sha1 = target_tree.get_file_sha1(file_id)
2984
if (basis_tree.has_id(file_id) and
2985
new_sha1 == basis_tree.get_file_sha1(file_id)):
2698
if (file_id in basis_tree and new_sha1 ==
2699
basis_tree.get_file_sha1(file_id)):
2986
2700
if file_id in merge_modified:
2987
2701
del merge_modified[file_id]
2989
2703
merge_modified[file_id] = new_sha1
2991
2705
# preserve the execute bit when backing up
2992
if keep_content and wt_executable == target_executable:
2993
tt.set_executability(target_executable, trans_id)
2994
elif target_kind is not None:
2995
raise AssertionError(target_kind)
2996
if not wt_versioned and target_versioned:
2706
if keep_content and executable[0] == executable[1]:
2707
tt.set_executability(executable[1], trans_id)
2708
elif kind[1] is not None:
2709
raise AssertionError(kind[1])
2710
if versioned == (False, True):
2997
2711
tt.version_file(file_id, trans_id)
2998
if wt_versioned and not target_versioned:
2712
if versioned == (True, False):
2999
2713
tt.unversion_file(trans_id)
3000
if (target_name is not None and
3001
(wt_name != target_name or wt_parent != target_parent)):
3002
if target_name == '' and target_parent is None:
2714
if (name[1] is not None and
2715
(name[0] != name[1] or parent[0] != parent[1])):
2716
if name[1] == '' and parent[1] is None:
3003
2717
parent_trans = ROOT_PARENT
3005
parent_trans = tt.trans_id_file_id(target_parent)
3006
if wt_parent is None and wt_versioned:
3007
tt.adjust_root_path(target_name, parent_trans)
2719
parent_trans = tt.trans_id_file_id(parent[1])
2720
if parent[0] is None and versioned[0]:
2721
tt.adjust_root_path(name[1], parent_trans)
3009
tt.adjust_path(target_name, parent_trans, trans_id)
3010
if wt_executable != target_executable and target_kind == "file":
3011
tt.set_executability(target_executable, trans_id)
2723
tt.adjust_path(name[1], parent_trans, trans_id)
2724
if executable[0] != executable[1] and kind[1] == "file":
2725
tt.set_executability(executable[1], trans_id)
3012
2726
if working_tree.supports_content_filtering():
3013
2727
for index, ((trans_id, mode_id), bytes) in enumerate(
3014
2728
target_tree.iter_files_bytes(deferred_files)):
3086
2800
elif c_type == 'missing parent':
3087
2801
trans_id = conflict[1]
3088
if trans_id in tt._removed_contents:
3089
cancel_deletion = True
3090
orphans = tt._get_potential_orphans(trans_id)
3092
cancel_deletion = False
3093
# All children are orphans
3096
tt.new_orphan(o, trans_id)
3097
except OrphaningError:
3098
# Something bad happened so we cancel the directory
3099
# deletion which will leave it in place with a
3100
# conflict. The user can deal with it from there.
3101
# Note that this also catch the case where we don't
3102
# want to create orphans and leave the directory in
3104
cancel_deletion = True
3107
# Cancel the directory deletion
3108
tt.cancel_deletion(trans_id)
3109
new_conflicts.add(('deleting parent', 'Not deleting',
2803
tt.cancel_deletion(trans_id)
2804
new_conflicts.add(('deleting parent', 'Not deleting',
3114
2809
tt.final_name(trans_id)
3175
2870
modified_path = fp.get_path(conflict[2])
3176
2871
modified_id = tt.final_file_id(conflict[2])
3177
2872
if len(conflict) == 3:
3178
yield conflicts.Conflict.factory(
3179
c_type, action=action, path=modified_path, file_id=modified_id)
2873
yield Conflict.factory(c_type, action=action, path=modified_path,
2874
file_id=modified_id)
3182
2877
conflicting_path = fp.get_path(conflict[3])
3183
2878
conflicting_id = tt.final_file_id(conflict[3])
3184
yield conflicts.Conflict.factory(
3185
c_type, action=action, path=modified_path,
3186
file_id=modified_id,
3187
conflict_path=conflicting_path,
3188
conflict_file_id=conflicting_id)
2879
yield Conflict.factory(c_type, action=action, path=modified_path,
2880
file_id=modified_id,
2881
conflict_path=conflicting_path,
2882
conflict_file_id=conflicting_id)
3191
2885
class _FileMover(object):
added
removed
bzrlib/transform.py
