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)
393
380
return sorted(FinalPaths(self).get_paths(new_ids))
395
382
def _inventory_altered(self):
396
"""Determine which trans_ids need new Inventory entries.
398
An new entry is needed when anything that would be reflected by an
399
inventory entry changes, including file name, file_id, parent file_id,
400
file kind, and the execute bit.
402
Some care is taken to return entries with real changes, not cases
403
where the value is deleted and then restored to its original value,
404
but some actually unchanged values may be returned.
406
:returns: A list of (path, trans_id) for all items requiring an
407
inventory change. Ordered by path.
410
# Find entries whose file_ids are new (or changed).
411
new_file_id = set(t for t in self._new_id
412
if self._new_id[t] != self.tree_file_id(t))
413
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,
414
386
self._new_executability]:
415
changed_ids.update(id_set)
416
# removing implies a kind change
387
new_ids.update(id_set)
417
388
changed_kind = set(self._removed_contents)
419
389
changed_kind.intersection_update(self._new_contents)
420
# Ignore entries that are already known to have changed.
421
changed_kind.difference_update(changed_ids)
422
# to keep only the truly changed ones
390
changed_kind.difference_update(new_ids)
423
391
changed_kind = (t for t in changed_kind
424
392
if self.tree_kind(t) != self.final_kind(t))
425
# all kind changes will alter the inventory
426
changed_ids.update(changed_kind)
427
# To find entries with changed parent_ids, find parents which existed,
428
# but changed file_id.
429
changed_file_id = set(t for t in new_file_id if t in self._removed_id)
430
# Now add all their children to the set.
431
for parent_trans_id in new_file_id:
432
changed_ids.update(self.iter_tree_children(parent_trans_id))
433
return sorted(FinalPaths(self).get_paths(changed_ids))
393
new_ids.update(changed_kind)
394
return sorted(FinalPaths(self).get_paths(new_ids))
435
396
def final_kind(self, trans_id):
436
397
"""Determine the final file kind, after any changes applied.
572
531
# ensure that all children are registered with the transaction
573
532
list(self.iter_tree_children(parent_id))
575
@deprecated_method(deprecated_in((2, 3, 0)))
576
534
def has_named_child(self, by_parent, parent_id, name):
577
return self._has_named_child(
578
name, parent_id, known_children=by_parent.get(parent_id, []))
580
def _has_named_child(self, name, parent_id, known_children):
581
"""Does a parent already have a name child.
583
:param name: The searched for name.
585
:param parent_id: The parent for which the check is made.
587
:param known_children: The already known children. This should have
588
been recently obtained from `self.by_parent.get(parent_id)`
589
(or will be if None is passed).
591
if known_children is None:
592
known_children = self.by_parent().get(parent_id, [])
593
for child in known_children:
536
children = by_parent[parent_id]
539
for child in children:
594
540
if self.final_name(child) == name:
596
parent_path = self._tree_id_paths.get(parent_id, None)
597
if parent_path is None:
598
# No parent... no children
543
path = self._tree_id_paths[parent_id]
600
child_path = joinpath(parent_path, name)
601
child_id = self._tree_path_ids.get(child_path, None)
546
childpath = joinpath(path, name)
547
child_id = self._tree_path_ids.get(childpath)
602
548
if child_id is None:
603
# Not known by the tree transform yet, check the filesystem
604
return osutils.lexists(self._tree.abspath(child_path))
549
return lexists(self._tree.abspath(childpath))
606
raise AssertionError('child_id is missing: %s, %s, %s'
607
% (name, parent_id, child_id))
609
def _available_backup_name(self, name, target_id):
610
"""Find an available backup name.
612
:param name: The basename of the file.
614
:param target_id: The directory trans_id where the backup should
617
known_children = self.by_parent().get(target_id, [])
618
return osutils.available_backup_name(
620
lambda base: self._has_named_child(
621
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?
623
559
def _parent_loops(self):
624
560
"""No entry should be its own ancestor"""
740
671
def _parent_type_conflicts(self, by_parent):
741
"""Children must have a directory parent"""
672
"""parents must have directory 'contents'."""
743
674
for parent_id, children in by_parent.iteritems():
744
675
if parent_id is ROOT_PARENT:
747
for child_id in children:
748
if self.final_kind(child_id) is not None:
677
if not self._any_contents(children):
753
# There is at least a child, so we need an existing directory to
755
679
kind = self.final_kind(parent_id)
757
# The directory will be deleted
758
681
conflicts.append(('missing parent', parent_id))
759
682
elif kind != "directory":
760
# Meh, we need a *directory* to put something in it
761
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:
764
693
def _set_executability(self, path, trans_id):
765
694
"""Set the executability of versioned files """
766
695
if supports_executable():
830
759
self.create_symlink(target, trans_id)
833
def new_orphan(self, trans_id, parent_id):
834
"""Schedule an item to be orphaned.
836
When a directory is about to be removed, its children, if they are not
837
versioned are moved out of the way: they don't have a parent anymore.
839
:param trans_id: The trans_id of the existing item.
840
:param parent_id: The parent trans_id of the item.
842
raise NotImplementedError(self.new_orphan)
844
def _get_potential_orphans(self, dir_id):
845
"""Find the potential orphans in a directory.
847
A directory can't be safely deleted if there are versioned files in it.
848
If all the contained files are unversioned then they can be orphaned.
850
The 'None' return value means that the directory contains at least one
851
versioned file and should not be deleted.
853
:param dir_id: The directory trans id.
855
:return: A list of the orphan trans ids or None if at least one
856
versioned file is present.
859
# Find the potential orphans, stop if one item should be kept
860
for child_tid in self.by_parent()[dir_id]:
861
if child_tid in self._removed_contents:
862
# The child is removed as part of the transform. Since it was
863
# versioned before, it's not an orphan
865
elif self.final_file_id(child_tid) is None:
866
# The child is not versioned
867
orphans.append(child_tid)
869
# We have a versioned file here, searching for orphans is
875
762
def _affected_ids(self):
876
763
"""Return the set of transform ids affected by the transform"""
877
764
trans_ids = set(self._removed_id)
1294
1170
descendants.update(self._limbo_descendants(descendant))
1295
1171
return descendants
1297
def create_file(self, contents, trans_id, mode_id=None, sha1=None):
1173
def create_file(self, contents, trans_id, mode_id=None):
1298
1174
"""Schedule creation of a new file.
1302
:param contents: an iterator of strings, all of which will be written
1303
to the target destination.
1304
:param trans_id: TreeTransform handle
1305
:param mode_id: If not None, force the mode of the target file to match
1306
the mode of the object referenced by mode_id.
1307
Otherwise, we will try to preserve mode bits of an existing file.
1308
:param sha1: If the sha1 of this content is already known, pass it in.
1309
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.
1311
1184
name = self._limbo_name(trans_id)
1312
1185
f = open(name, 'wb')
1314
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.
1315
1196
f.writelines(contents)
1318
1199
self._set_mtime(name)
1319
1200
self._set_mode(trans_id, mode_id, S_ISREG)
1320
# It is unfortunate we have to use lstat instead of fstat, but we just
1321
# used utime and chmod on the file, so we need the accurate final
1323
if sha1 is not None:
1324
self._observed_sha1s[trans_id] = (sha1, osutils.lstat(name))
1326
1202
def _read_file_chunks(self, trans_id):
1327
1203
cur_file = open(self._limbo_name(trans_id), 'rb')
1397
1271
del self._limbo_children_names[trans_id]
1398
1272
delete_any(self._limbo_name(trans_id))
1400
def new_orphan(self, trans_id, parent_id):
1401
# FIXME: There is no tree config, so we use the branch one (it's weird
1402
# to define it this way as orphaning can only occur in a working tree,
1403
# but that's all we have (for now). It will find the option in
1404
# locations.conf or bazaar.conf though) -- vila 20100916
1405
conf = self._tree.branch.get_config()
1406
conf_var_name = 'bzr.transform.orphan_policy'
1407
orphan_policy = conf.get_user_option(conf_var_name)
1408
default_policy = orphaning_registry.default_key
1409
if orphan_policy is None:
1410
orphan_policy = default_policy
1411
if orphan_policy not in orphaning_registry:
1412
trace.warning('%s (from %s) is not a known policy, defaulting '
1413
'to %s' % (orphan_policy, conf_var_name, default_policy))
1414
orphan_policy = default_policy
1415
handle_orphan = orphaning_registry.get(orphan_policy)
1416
handle_orphan(self, trans_id, parent_id)
1419
class OrphaningError(errors.BzrError):
1421
# Only bugs could lead to such exception being seen by the user
1422
internal_error = True
1423
_fmt = "Error while orphaning %s in %s directory"
1425
def __init__(self, orphan, parent):
1426
errors.BzrError.__init__(self)
1427
self.orphan = orphan
1428
self.parent = parent
1431
class OrphaningForbidden(OrphaningError):
1433
_fmt = "Policy: %s doesn't allow creating orphans."
1435
def __init__(self, policy):
1436
errors.BzrError.__init__(self)
1437
self.policy = policy
1440
def move_orphan(tt, orphan_id, parent_id):
1441
"""See TreeTransformBase.new_orphan.
1443
This creates a new orphan in the `bzr-orphans` dir at the root of the
1446
:param tt: The TreeTransform orphaning `trans_id`.
1448
:param orphan_id: The trans id that should be orphaned.
1450
:param parent_id: The orphan parent trans id.
1452
# Add the orphan dir if it doesn't exist
1453
orphan_dir_basename = 'bzr-orphans'
1454
od_id = tt.trans_id_tree_path(orphan_dir_basename)
1455
if tt.final_kind(od_id) is None:
1456
tt.create_directory(od_id)
1457
parent_path = tt._tree_id_paths[parent_id]
1458
# Find a name that doesn't exist yet in the orphan dir
1459
actual_name = tt.final_name(orphan_id)
1460
new_name = tt._available_backup_name(actual_name, od_id)
1461
tt.adjust_path(new_name, od_id, orphan_id)
1462
trace.warning('%s has been orphaned in %s'
1463
% (joinpath(parent_path, actual_name), orphan_dir_basename))
1466
def refuse_orphan(tt, orphan_id, parent_id):
1467
"""See TreeTransformBase.new_orphan.
1469
This refuses to create orphan, letting the caller handle the conflict.
1471
raise OrphaningForbidden('never')
1474
orphaning_registry = registry.Registry()
1475
orphaning_registry.register(
1476
'conflict', refuse_orphan,
1477
'Leave orphans in place and create a conflict on the directory.')
1478
orphaning_registry.register(
1479
'move', move_orphan,
1480
'Move orphans into the bzr-orphans directory.')
1481
orphaning_registry._set_default_key('conflict')
1484
1275
class TreeTransform(DiskTreeTransform):
1485
1276
"""Represent a tree transformation.
1881
1667
self.rename_count += 1
1882
# TODO: if trans_id in self._observed_sha1s, we should
1883
# re-stat the final target, since ctime will be
1884
# updated by the change.
1885
1668
if (trans_id in self._new_contents or
1886
1669
self.path_changed(trans_id)):
1887
1670
if trans_id in self._new_contents:
1888
1671
modified_paths.append(full_path)
1889
1672
if trans_id in self._new_executability:
1890
1673
self._set_executability(path, trans_id)
1891
if trans_id in self._observed_sha1s:
1892
o_sha1, o_st_val = self._observed_sha1s[trans_id]
1893
st = osutils.lstat(full_path)
1894
self._observed_sha1s[trans_id] = (o_sha1, st)
1896
1675
child_pb.finished()
1897
for path, trans_id in new_paths:
1898
# new_paths includes stuff like workingtree conflicts. Only the
1899
# stuff in new_contents actually comes from limbo.
1900
if trans_id in self._limbo_files:
1901
del self._limbo_files[trans_id]
1902
1676
self._new_contents.clear()
1903
1677
return modified_paths
1905
def _apply_observed_sha1s(self):
1906
"""After we have finished renaming everything, update observed sha1s
1908
This has to be done after self._tree.apply_inventory_delta, otherwise
1909
it doesn't know anything about the files we are updating. Also, we want
1910
to do this as late as possible, so that most entries end up cached.
1912
# TODO: this doesn't update the stat information for directories. So
1913
# the first 'bzr status' will still need to rewrite
1914
# .bzr/checkout/dirstate. However, we at least don't need to
1915
# re-read all of the files.
1916
# TODO: If the operation took a while, we could do a time.sleep(3) here
1917
# to allow the clock to tick over and ensure we won't have any
1918
# problems. (we could observe start time, and finish time, and if
1919
# it is less than eg 10% overhead, add a sleep call.)
1920
paths = FinalPaths(self)
1921
for trans_id, observed in self._observed_sha1s.iteritems():
1922
path = paths.get_path(trans_id)
1923
# We could get the file_id, but dirstate prefers to use the path
1924
# anyway, and it is 'cheaper' to determine.
1925
# file_id = self._new_id[trans_id]
1926
self._tree._observed_sha1(None, path, observed)
1929
1680
class TransformPreview(DiskTreeTransform):
1930
1681
"""A TreeTransform for generating preview trees.
2248
1996
def get_file_size(self, file_id):
2249
1997
"""See Tree.get_file_size"""
2250
trans_id = self._transform.trans_id_file_id(file_id)
2251
kind = self._transform.final_kind(trans_id)
2254
if trans_id in self._transform._new_contents:
2255
return self._stat_limbo_file(trans_id=trans_id).st_size
2256
1998
if self.kind(file_id) == 'file':
2257
1999
return self._transform._tree.get_file_size(file_id)
2261
def get_file_verifier(self, file_id, path=None, stat_value=None):
2262
trans_id = self._transform.trans_id_file_id(file_id)
2263
kind = self._transform._new_contents.get(trans_id)
2265
return self._transform._tree.get_file_verifier(file_id)
2267
fileobj = self.get_file(file_id)
2269
return ("SHA1", sha_file(fileobj))
2273
2003
def get_file_sha1(self, file_id, path=None, stat_value=None):
2274
2004
trans_id = self._transform.trans_id_file_id(file_id)
2275
2005
kind = self._transform._new_contents.get(trans_id)
2695
2415
offset += count
2696
for count, ((trans_id, tree_path, text_sha1), contents) in enumerate(
2416
for count, ((trans_id, tree_path), contents) in enumerate(
2697
2417
tree.iter_files_bytes(new_desired_files)):
2698
2418
if wt.supports_content_filtering():
2699
2419
filters = wt._content_filter_stack(tree_path)
2700
2420
contents = filtered_output_bytes(contents, filters,
2701
2421
ContentFilterContext(tree_path, tree))
2702
tt.create_file(contents, trans_id, sha1=text_sha1)
2422
tt.create_file(contents, trans_id)
2703
2423
pb.update('Adding file contents', count + offset, total)
2931
2643
deferred_files = []
2932
2644
for id_num, (file_id, path, changed_content, versioned, parent, name,
2933
2645
kind, executable) in enumerate(change_list):
2934
target_path, wt_path = path
2935
target_versioned, wt_versioned = versioned
2936
target_parent, wt_parent = parent
2937
target_name, wt_name = name
2938
target_kind, wt_kind = kind
2939
target_executable, wt_executable = executable
2940
if skip_root and wt_parent is None:
2646
if skip_root and file_id[0] is not None and parent[0] is None:
2942
2648
trans_id = tt.trans_id_file_id(file_id)
2944
2650
if changed_content:
2945
2651
keep_content = False
2946
if wt_kind == 'file' and (backups or target_kind is None):
2652
if kind[0] == 'file' and (backups or kind[1] is None):
2947
2653
wt_sha1 = working_tree.get_file_sha1(file_id)
2948
2654
if merge_modified.get(file_id) != wt_sha1:
2949
2655
# acquire the basis tree lazily to prevent the
2952
2658
if basis_tree is None:
2953
2659
basis_tree = working_tree.basis_tree()
2954
2660
basis_tree.lock_read()
2955
if basis_tree.has_id(file_id):
2661
if file_id in basis_tree:
2956
2662
if wt_sha1 != basis_tree.get_file_sha1(file_id):
2957
2663
keep_content = True
2958
elif target_kind is None and not target_versioned:
2664
elif kind[1] is None and not versioned[1]:
2959
2665
keep_content = True
2960
if wt_kind is not None:
2666
if kind[0] is not None:
2961
2667
if not keep_content:
2962
2668
tt.delete_contents(trans_id)
2963
elif target_kind is not None:
2964
parent_trans_id = tt.trans_id_file_id(wt_parent)
2965
backup_name = tt._available_backup_name(
2966
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)
2967
2674
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2968
new_trans_id = tt.create_path(wt_name, parent_trans_id)
2969
if wt_versioned and target_versioned:
2675
new_trans_id = tt.create_path(name[0], parent_trans_id)
2676
if versioned == (True, True):
2970
2677
tt.unversion_file(trans_id)
2971
2678
tt.version_file(file_id, new_trans_id)
2972
2679
# New contents should have the same unix perms as old
2974
2681
mode_id = trans_id
2975
2682
trans_id = new_trans_id
2976
if target_kind in ('directory', 'tree-reference'):
2683
if kind[1] in ('directory', 'tree-reference'):
2977
2684
tt.create_directory(trans_id)
2978
if target_kind == 'tree-reference':
2685
if kind[1] == 'tree-reference':
2979
2686
revision = target_tree.get_reference_revision(file_id,
2981
2688
tt.set_tree_reference(revision, trans_id)
2982
elif target_kind == 'symlink':
2689
elif kind[1] == 'symlink':
2983
2690
tt.create_symlink(target_tree.get_symlink_target(file_id),
2985
elif target_kind == 'file':
2692
elif kind[1] == 'file':
2986
2693
deferred_files.append((file_id, (trans_id, mode_id)))
2987
2694
if basis_tree is None:
2988
2695
basis_tree = working_tree.basis_tree()
2989
2696
basis_tree.lock_read()
2990
2697
new_sha1 = target_tree.get_file_sha1(file_id)
2991
if (basis_tree.has_id(file_id) and
2992
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)):
2993
2700
if file_id in merge_modified:
2994
2701
del merge_modified[file_id]
2996
2703
merge_modified[file_id] = new_sha1
2998
2705
# preserve the execute bit when backing up
2999
if keep_content and wt_executable == target_executable:
3000
tt.set_executability(target_executable, trans_id)
3001
elif target_kind is not None:
3002
raise AssertionError(target_kind)
3003
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):
3004
2711
tt.version_file(file_id, trans_id)
3005
if wt_versioned and not target_versioned:
2712
if versioned == (True, False):
3006
2713
tt.unversion_file(trans_id)
3007
if (target_name is not None and
3008
(wt_name != target_name or wt_parent != target_parent)):
3009
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:
3010
2717
parent_trans = ROOT_PARENT
3012
parent_trans = tt.trans_id_file_id(target_parent)
3013
if wt_parent is None and wt_versioned:
3014
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)
3016
tt.adjust_path(target_name, parent_trans, trans_id)
3017
if wt_executable != target_executable and target_kind == "file":
3018
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)
3019
2726
if working_tree.supports_content_filtering():
3020
2727
for index, ((trans_id, mode_id), bytes) in enumerate(
3021
2728
target_tree.iter_files_bytes(deferred_files)):
3093
2800
elif c_type == 'missing parent':
3094
2801
trans_id = conflict[1]
3095
if trans_id in tt._removed_contents:
3096
cancel_deletion = True
3097
orphans = tt._get_potential_orphans(trans_id)
3099
cancel_deletion = False
3100
# All children are orphans
3103
tt.new_orphan(o, trans_id)
3104
except OrphaningError:
3105
# Something bad happened so we cancel the directory
3106
# deletion which will leave it in place with a
3107
# conflict. The user can deal with it from there.
3108
# Note that this also catch the case where we don't
3109
# want to create orphans and leave the directory in
3111
cancel_deletion = True
3114
# Cancel the directory deletion
3115
tt.cancel_deletion(trans_id)
3116
new_conflicts.add(('deleting parent', 'Not deleting',
2803
tt.cancel_deletion(trans_id)
2804
new_conflicts.add(('deleting parent', 'Not deleting',
3121
2809
tt.final_name(trans_id)
3182
2870
modified_path = fp.get_path(conflict[2])
3183
2871
modified_id = tt.final_file_id(conflict[2])
3184
2872
if len(conflict) == 3:
3185
yield conflicts.Conflict.factory(
3186
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)
3189
2877
conflicting_path = fp.get_path(conflict[3])
3190
2878
conflicting_id = tt.final_file_id(conflict[3])
3191
yield conflicts.Conflict.factory(
3192
c_type, action=action, path=modified_path,
3193
file_id=modified_id,
3194
conflict_path=conflicting_path,
3195
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)
3198
2885
class _FileMover(object):
added
removed
bzrlib/transform.py
