40
47
ExistingLimbo, ImmortalLimbo, NoFinalPath,
41
48
UnableCreateSymlink)
42
49
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
43
from bzrlib.inventory import InventoryEntry
44
50
from bzrlib.osutils import (
52
57
supports_executable,
54
59
from bzrlib.progress import ProgressPhase
55
60
from bzrlib.symbol_versioning import (
59
from bzrlib.trace import mutter, warning
60
from bzrlib import tree
62
import bzrlib.urlutils as urlutils
65
67
ROOT_PARENT = "root-parent"
68
69
def unique_add(map, key, value):
70
71
raise DuplicateKey(key=key)
74
76
class _TransformResults(object):
75
77
def __init__(self, modified_paths, rename_count):
76
78
object.__init__(self)
389
392
changed_kind = set(self._removed_contents)
390
393
changed_kind.intersection_update(self._new_contents)
391
394
changed_kind.difference_update(new_ids)
392
changed_kind = (t for t in changed_kind if self.tree_kind(t) !=
395
changed_kind = (t for t in changed_kind
396
if self.tree_kind(t) != self.final_kind(t))
394
397
new_ids.update(changed_kind)
395
398
return sorted(FinalPaths(self).get_paths(new_ids))
397
400
def final_kind(self, trans_id):
398
401
"""Determine the final file kind, after any changes applied.
400
Raises NoSuchFile if the file does not exist/has no contents.
401
(It is conceivable that a path would be created without the
402
corresponding contents insertion command)
403
:return: None if the file does not exist/has no contents. (It is
404
conceivable that a path would be created without the corresponding
405
contents insertion command)
404
407
if trans_id in self._new_contents:
405
408
return self._new_contents[trans_id]
406
409
elif trans_id in self._removed_contents:
407
raise NoSuchFile(None)
409
412
return self.tree_kind(trans_id)
532
537
# ensure that all children are registered with the transaction
533
538
list(self.iter_tree_children(parent_id))
540
@deprecated_method(deprecated_in((2, 3, 0)))
535
541
def has_named_child(self, by_parent, parent_id, name):
537
children = by_parent[parent_id]
540
for child in children:
542
return self._has_named_child(
543
name, parent_id, known_children=by_parent.get(parent_id, []))
545
def _has_named_child(self, name, parent_id, known_children):
546
"""Does a parent already have a name child.
548
:param name: The searched for name.
550
:param parent_id: The parent for which the check is made.
552
:param known_children: The already known children. This should have
553
been recently obtained from `self.by_parent.get(parent_id)`
554
(or will be if None is passed).
556
if known_children is None:
557
known_children = self.by_parent().get(parent_id, [])
558
for child in known_children:
541
559
if self.final_name(child) == name:
544
path = self._tree_id_paths[parent_id]
561
parent_path = self._tree_id_paths.get(parent_id, None)
562
if parent_path is None:
563
# No parent... no children
547
childpath = joinpath(path, name)
548
child_id = self._tree_path_ids.get(childpath)
565
child_path = joinpath(parent_path, name)
566
child_id = self._tree_path_ids.get(child_path, None)
549
567
if child_id is None:
550
return lexists(self._tree.abspath(childpath))
568
# Not known by the tree transform yet, check the filesystem
569
return osutils.lexists(self._tree.abspath(child_path))
552
if self.final_parent(child_id) != parent_id:
554
if child_id in self._removed_contents:
555
# XXX What about dangling file-ids?
571
raise AssertionError('child_id is missing: %s, %s, %s'
572
% (name, parent_id, child_id))
574
def _available_backup_name(self, name, target_id):
575
"""Find an available backup name.
577
:param name: The basename of the file.
579
:param target_id: The directory trans_id where the backup should
582
known_children = self.by_parent().get(target_id, [])
583
return osutils.available_backup_name(
585
lambda base: self._has_named_child(
586
base, target_id, known_children))
560
588
def _parent_loops(self):
561
589
"""No entry should be its own ancestor"""
645
666
if (self._new_name, self._new_parent) == ({}, {}):
647
668
for children in by_parent.itervalues():
648
name_ids = [(self.final_name(t), t) for t in children]
649
if not self._case_sensitive_target:
650
name_ids = [(n.lower(), t) for n, t in name_ids]
670
for child_tid in children:
671
name = self.final_name(child_tid)
673
# Keep children only if they still exist in the end
674
if not self._case_sensitive_target:
676
name_ids.append((name, child_tid))
653
679
last_trans_id = None
654
680
for name, trans_id in name_ids:
656
kind = self.final_kind(trans_id)
681
kind = self.final_kind(trans_id)
659
682
file_id = self.final_file_id(trans_id)
660
683
if kind is None and file_id is None:
682
705
def _parent_type_conflicts(self, by_parent):
683
"""parents must have directory 'contents'."""
706
"""Children must have a directory parent"""
685
708
for parent_id, children in by_parent.iteritems():
686
709
if parent_id is ROOT_PARENT:
688
if not self._any_contents(children):
712
for child_id in children:
713
if self.final_kind(child_id) is not None:
690
for child in children:
692
self.final_kind(child)
696
kind = self.final_kind(parent_id)
718
# There is at least a child, so we need an existing directory to
720
kind = self.final_kind(parent_id)
722
# The directory will be deleted
700
723
conflicts.append(('missing parent', parent_id))
701
724
elif kind != "directory":
725
# Meh, we need a *directory* to put something in it
702
726
conflicts.append(('non-directory parent', parent_id))
705
def _any_contents(self, trans_ids):
706
"""Return true if any of the trans_ids, will have contents."""
707
for trans_id in trans_ids:
709
kind = self.final_kind(trans_id)
715
729
def _set_executability(self, path, trans_id):
716
730
"""Set the executability of versioned files """
717
731
if supports_executable():
781
795
self.create_symlink(target, trans_id)
798
def new_orphan(self, trans_id, parent_id):
799
"""Schedule an item to be orphaned.
801
When a directory is about to be removed, its children, if they are not
802
versioned are moved out of the way: they don't have a parent anymore.
804
:param trans_id: The trans_id of the existing item.
805
:param parent_id: The parent trans_id of the item.
807
raise NotImplementedError(self.new_orphan)
809
def _get_potential_orphans(self, dir_id):
810
"""Find the potential orphans in a directory.
812
A directory can't be safely deleted if there are versioned files in it.
813
If all the contained files are unversioned then they can be orphaned.
815
The 'None' return value means that the directory contains at least one
816
versioned file and should not be deleted.
818
:param dir_id: The directory trans id.
820
:return: A list of the orphan trans ids or None if at least one
821
versioned file is present.
824
# Find the potential orphans, stop if one item should be kept
825
for child_tid in self.by_parent()[dir_id]:
826
if child_tid in self._removed_contents:
827
# The child is removed as part of the transform. Since it was
828
# versioned before, it's not an orphan
830
elif self.final_file_id(child_tid) is None:
831
# The child is not versioned
832
orphans.append(child_tid)
834
# We have a versioned file here, searching for orphans is
784
840
def _affected_ids(self):
785
841
"""Return the set of transform ids affected by the transform"""
786
842
trans_ids = set(self._removed_id)
1195
1248
descendants.update(self._limbo_descendants(descendant))
1196
1249
return descendants
1198
def create_file(self, contents, trans_id, mode_id=None):
1251
def create_file(self, contents, trans_id, mode_id=None, sha1=None):
1199
1252
"""Schedule creation of a new file.
1203
Contents is an iterator of strings, all of which will be written
1204
to the target destination.
1206
New file takes the permissions of any existing file with that id,
1207
unless mode_id is specified.
1256
:param contents: an iterator of strings, all of which will be written
1257
to the target destination.
1258
:param trans_id: TreeTransform handle
1259
:param mode_id: If not None, force the mode of the target file to match
1260
the mode of the object referenced by mode_id.
1261
Otherwise, we will try to preserve mode bits of an existing file.
1262
:param sha1: If the sha1 of this content is already known, pass it in.
1263
We can use it to prevent future sha1 computations.
1209
1265
name = self._limbo_name(trans_id)
1210
1266
f = open(name, 'wb')
1296
1358
del self._limbo_children_names[trans_id]
1297
1359
delete_any(self._limbo_name(trans_id))
1361
def new_orphan(self, trans_id, parent_id):
1362
# FIXME: There is no tree config, so we use the branch one (it's weird
1363
# to define it this way as orphaning can only occur in a working tree,
1364
# but that's all we have (for now). It will find the option in
1365
# locations.conf or bazaar.conf though) -- vila 20100916
1366
conf = self._tree.branch.get_config()
1367
conf_var_name = 'bzr.transform.orphan_policy'
1368
orphan_policy = conf.get_user_option(conf_var_name)
1369
default_policy = orphaning_registry.default_key
1370
if orphan_policy is None:
1371
orphan_policy = default_policy
1372
if orphan_policy not in orphaning_registry:
1373
trace.warning('%s (from %s) is not a known policy, defaulting '
1374
'to %s' % (orphan_policy, conf_var_name, default_policy))
1375
orphan_policy = default_policy
1376
handle_orphan = orphaning_registry.get(orphan_policy)
1377
handle_orphan(self, trans_id, parent_id)
1380
class OrphaningError(errors.BzrError):
1382
# Only bugs could lead to such exception being seen by the user
1383
internal_error = True
1384
_fmt = "Error while orphaning %s in %s directory"
1386
def __init__(self, orphan, parent):
1387
errors.BzrError.__init__(self)
1388
self.orphan = orphan
1389
self.parent = parent
1392
class OrphaningForbidden(OrphaningError):
1394
_fmt = "Policy: %s doesn't allow creating orphans."
1396
def __init__(self, policy):
1397
errors.BzrError.__init__(self)
1398
self.policy = policy
1401
def move_orphan(tt, orphan_id, parent_id):
1402
"""See TreeTransformBase.new_orphan.
1404
This creates a new orphan in the `bzr-orphans` dir at the root of the
1407
:param tt: The TreeTransform orphaning `trans_id`.
1409
:param orphan_id: The trans id that should be orphaned.
1411
:param parent_id: The orphan parent trans id.
1413
# Add the orphan dir if it doesn't exist
1414
orphan_dir_basename = 'bzr-orphans'
1415
od_id = tt.trans_id_tree_path(orphan_dir_basename)
1416
if tt.final_kind(od_id) is None:
1417
tt.create_directory(od_id)
1418
parent_path = tt._tree_id_paths[parent_id]
1419
# Find a name that doesn't exist yet in the orphan dir
1420
actual_name = tt.final_name(orphan_id)
1421
new_name = tt._available_backup_name(actual_name, od_id)
1422
tt.adjust_path(new_name, od_id, orphan_id)
1423
trace.warning('%s has been orphaned in %s'
1424
% (joinpath(parent_path, actual_name), orphan_dir_basename))
1427
def refuse_orphan(tt, orphan_id, parent_id):
1428
"""See TreeTransformBase.new_orphan.
1430
This refuses to create orphan, letting the caller handle the conflict.
1432
raise OrphaningForbidden('never')
1435
orphaning_registry = registry.Registry()
1436
orphaning_registry.register(
1437
'conflict', refuse_orphan,
1438
'Leave orphans in place and create a conflict on the directory.')
1439
orphaning_registry.register(
1440
'move', move_orphan,
1441
'Move orphans into the bzr-orphans directory.')
1442
orphaning_registry._set_default_key('conflict')
1300
1445
class TreeTransform(DiskTreeTransform):
1301
1446
"""Represent a tree transformation.
1419
1564
def tree_kind(self, trans_id):
1420
1565
"""Determine the file kind in the working tree.
1422
Raises NoSuchFile if the file does not exist
1567
:returns: The file kind or None if the file does not exist
1424
1569
path = self._tree_id_paths.get(trans_id)
1425
1570
if path is None:
1426
raise NoSuchFile(None)
1428
1573
return file_kind(self._tree.abspath(path))
1430
if e.errno != errno.ENOENT:
1433
raise NoSuchFile(path)
1574
except errors.NoSuchFile:
1435
1577
def _set_mode(self, trans_id, mode_id, typefunc):
1436
1578
"""Set the mode of new file contents.
1696
1838
self.rename_count += 1
1839
# TODO: if trans_id in self._observed_sha1s, we should
1840
# re-stat the final target, since ctime will be
1841
# updated by the change.
1697
1842
if (trans_id in self._new_contents or
1698
1843
self.path_changed(trans_id)):
1699
1844
if trans_id in self._new_contents:
1700
1845
modified_paths.append(full_path)
1701
1846
if trans_id in self._new_executability:
1702
1847
self._set_executability(path, trans_id)
1848
if trans_id in self._observed_sha1s:
1849
o_sha1, o_st_val = self._observed_sha1s[trans_id]
1850
st = osutils.lstat(full_path)
1851
self._observed_sha1s[trans_id] = (o_sha1, st)
1704
1853
child_pb.finished()
1705
1854
self._new_contents.clear()
1706
1855
return modified_paths
1857
def _apply_observed_sha1s(self):
1858
"""After we have finished renaming everything, update observed sha1s
1860
This has to be done after self._tree.apply_inventory_delta, otherwise
1861
it doesn't know anything about the files we are updating. Also, we want
1862
to do this as late as possible, so that most entries end up cached.
1864
# TODO: this doesn't update the stat information for directories. So
1865
# the first 'bzr status' will still need to rewrite
1866
# .bzr/checkout/dirstate. However, we at least don't need to
1867
# re-read all of the files.
1868
# TODO: If the operation took a while, we could do a time.sleep(3) here
1869
# to allow the clock to tick over and ensure we won't have any
1870
# problems. (we could observe start time, and finish time, and if
1871
# it is less than eg 10% overhead, add a sleep call.)
1872
paths = FinalPaths(self)
1873
for trans_id, observed in self._observed_sha1s.iteritems():
1874
path = paths.get_path(trans_id)
1875
# We could get the file_id, but dirstate prefers to use the path
1876
# anyway, and it is 'cheaper' to determine.
1877
# file_id = self._new_id[trans_id]
1878
self._tree._observed_sha1(None, path, observed)
1709
1881
class TransformPreview(DiskTreeTransform):
1710
1882
"""A TreeTransform for generating preview trees.
1789
1966
yield self._get_repository().revision_tree(revision_id)
1791
1968
def _get_file_revision(self, file_id, vf, tree_revision):
1792
parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
1969
parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
1793
1970
self._iter_parent_trees()]
1794
1971
vf.add_lines((file_id, tree_revision), parent_keys,
1795
1972
self.get_file_lines(file_id))
2415
2607
unchanged = dict(unchanged)
2416
2608
new_desired_files = []
2418
for file_id, (trans_id, tree_path) in desired_files:
2610
for file_id, (trans_id, tree_path, text_sha1) in desired_files:
2419
2611
accelerator_path = unchanged.get(file_id)
2420
2612
if accelerator_path is None:
2421
new_desired_files.append((file_id, (trans_id, tree_path)))
2613
new_desired_files.append((file_id,
2614
(trans_id, tree_path, text_sha1)))
2423
2616
pb.update('Adding file contents', count + offset, total)
2442
2635
offset += count
2443
for count, ((trans_id, tree_path), contents) in enumerate(
2636
for count, ((trans_id, tree_path, text_sha1), contents) in enumerate(
2444
2637
tree.iter_files_bytes(new_desired_files)):
2445
2638
if wt.supports_content_filtering():
2446
2639
filters = wt._content_filter_stack(tree_path)
2447
2640
contents = filtered_output_bytes(contents, filters,
2448
2641
ContentFilterContext(tree_path, tree))
2449
tt.create_file(contents, trans_id)
2642
tt.create_file(contents, trans_id, sha1=text_sha1)
2450
2643
pb.update('Adding file contents', count + offset, total)
2454
2647
for child in tt.iter_tree_children(old_parent):
2455
2648
tt.adjust_path(tt.final_name(child), new_parent, child)
2457
2651
def _reparent_transform_children(tt, old_parent, new_parent):
2458
2652
by_parent = tt.by_parent()
2459
2653
for child in by_parent[old_parent]:
2460
2654
tt.adjust_path(tt.final_name(child), new_parent, child)
2461
2655
return by_parent[old_parent]
2463
2658
def _content_match(tree, entry, file_id, kind, target_path):
2464
2659
if entry.kind != kind:
2565
2760
tt.set_executability(entry.executable, trans_id)
2763
@deprecated_function(deprecated_in((2, 3, 0)))
2568
2764
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2569
2765
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2768
@deprecated_function(deprecated_in((2, 3, 0)))
2572
2769
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2573
2770
"""Produce a backup-style name that appears to be available"""
2574
2771
def name_gen():
2660
2857
backups, merge_modified, basis_tree=None):
2661
2858
if basis_tree is not None:
2662
2859
basis_tree.lock_read()
2663
change_list = target_tree.iter_changes(working_tree,
2860
# We ask the working_tree for its changes relative to the target, rather
2861
# than the target changes relative to the working tree. Because WT4 has an
2862
# optimizer to compare itself to a target, but no optimizer for the
2864
change_list = working_tree.iter_changes(target_tree,
2664
2865
specific_files=specific_files, pb=pb)
2665
2866
if target_tree.get_root_id() is None:
2666
2867
skip_root = True
2670
2871
deferred_files = []
2671
2872
for id_num, (file_id, path, changed_content, versioned, parent, name,
2672
2873
kind, executable) in enumerate(change_list):
2673
if skip_root and file_id[0] is not None and parent[0] is None:
2874
target_path, wt_path = path
2875
target_versioned, wt_versioned = versioned
2876
target_parent, wt_parent = parent
2877
target_name, wt_name = name
2878
target_kind, wt_kind = kind
2879
target_executable, wt_executable = executable
2880
if skip_root and wt_parent is None:
2675
2882
trans_id = tt.trans_id_file_id(file_id)
2677
2884
if changed_content:
2678
2885
keep_content = False
2679
if kind[0] == 'file' and (backups or kind[1] is None):
2886
if wt_kind == 'file' and (backups or target_kind is None):
2680
2887
wt_sha1 = working_tree.get_file_sha1(file_id)
2681
2888
if merge_modified.get(file_id) != wt_sha1:
2682
2889
# acquire the basis tree lazily to prevent the
2688
2895
if file_id in basis_tree:
2689
2896
if wt_sha1 != basis_tree.get_file_sha1(file_id):
2690
2897
keep_content = True
2691
elif kind[1] is None and not versioned[1]:
2898
elif target_kind is None and not target_versioned:
2692
2899
keep_content = True
2693
if kind[0] is not None:
2900
if wt_kind is not None:
2694
2901
if not keep_content:
2695
2902
tt.delete_contents(trans_id)
2696
elif kind[1] is not None:
2697
parent_trans_id = tt.trans_id_file_id(parent[0])
2698
by_parent = tt.by_parent()
2699
backup_name = _get_backup_name(name[0], by_parent,
2700
parent_trans_id, tt)
2903
elif target_kind is not None:
2904
parent_trans_id = tt.trans_id_file_id(wt_parent)
2905
backup_name = tt._available_backup_name(
2906
wt_name, parent_trans_id)
2701
2907
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2702
new_trans_id = tt.create_path(name[0], parent_trans_id)
2703
if versioned == (True, True):
2908
new_trans_id = tt.create_path(wt_name, parent_trans_id)
2909
if wt_versioned and target_versioned:
2704
2910
tt.unversion_file(trans_id)
2705
2911
tt.version_file(file_id, new_trans_id)
2706
2912
# New contents should have the same unix perms as old
2708
2914
mode_id = trans_id
2709
2915
trans_id = new_trans_id
2710
if kind[1] in ('directory', 'tree-reference'):
2916
if target_kind in ('directory', 'tree-reference'):
2711
2917
tt.create_directory(trans_id)
2712
if kind[1] == 'tree-reference':
2918
if target_kind == 'tree-reference':
2713
2919
revision = target_tree.get_reference_revision(file_id,
2715
2921
tt.set_tree_reference(revision, trans_id)
2716
elif kind[1] == 'symlink':
2922
elif target_kind == 'symlink':
2717
2923
tt.create_symlink(target_tree.get_symlink_target(file_id),
2719
elif kind[1] == 'file':
2925
elif target_kind == 'file':
2720
2926
deferred_files.append((file_id, (trans_id, mode_id)))
2721
2927
if basis_tree is None:
2722
2928
basis_tree = working_tree.basis_tree()
2730
2936
merge_modified[file_id] = new_sha1
2732
2938
# preserve the execute bit when backing up
2733
if keep_content and executable[0] == executable[1]:
2734
tt.set_executability(executable[1], trans_id)
2735
elif kind[1] is not None:
2736
raise AssertionError(kind[1])
2737
if versioned == (False, True):
2939
if keep_content and wt_executable == target_executable:
2940
tt.set_executability(target_executable, trans_id)
2941
elif target_kind is not None:
2942
raise AssertionError(target_kind)
2943
if not wt_versioned and target_versioned:
2738
2944
tt.version_file(file_id, trans_id)
2739
if versioned == (True, False):
2945
if wt_versioned and not target_versioned:
2740
2946
tt.unversion_file(trans_id)
2741
if (name[1] is not None and
2742
(name[0] != name[1] or parent[0] != parent[1])):
2743
if name[1] == '' and parent[1] is None:
2947
if (target_name is not None and
2948
(wt_name != target_name or wt_parent != target_parent)):
2949
if target_name == '' and target_parent is None:
2744
2950
parent_trans = ROOT_PARENT
2746
parent_trans = tt.trans_id_file_id(parent[1])
2747
if parent[0] is None and versioned[0]:
2748
tt.adjust_root_path(name[1], parent_trans)
2952
parent_trans = tt.trans_id_file_id(target_parent)
2953
if wt_parent is None and wt_versioned:
2954
tt.adjust_root_path(target_name, parent_trans)
2750
tt.adjust_path(name[1], parent_trans, trans_id)
2751
if executable[0] != executable[1] and kind[1] == "file":
2752
tt.set_executability(executable[1], trans_id)
2956
tt.adjust_path(target_name, parent_trans, trans_id)
2957
if wt_executable != target_executable and target_kind == "file":
2958
tt.set_executability(target_executable, trans_id)
2753
2959
if working_tree.supports_content_filtering():
2754
2960
for index, ((trans_id, mode_id), bytes) in enumerate(
2755
2961
target_tree.iter_files_bytes(deferred_files)):
2827
3033
elif c_type == 'missing parent':
2828
3034
trans_id = conflict[1]
2830
tt.cancel_deletion(trans_id)
2831
new_conflicts.add(('deleting parent', 'Not deleting',
3035
if trans_id in tt._removed_contents:
3036
cancel_deletion = True
3037
orphans = tt._get_potential_orphans(trans_id)
3039
cancel_deletion = False
3040
# All children are orphans
3043
tt.new_orphan(o, trans_id)
3044
except OrphaningError:
3045
# Something bad happened so we cancel the directory
3046
# deletion which will leave it in place with a
3047
# conflict. The user can deal with it from there.
3048
# Note that this also catch the case where we don't
3049
# want to create orphans and leave the directory in
3051
cancel_deletion = True
3054
# Cancel the directory deletion
3055
tt.cancel_deletion(trans_id)
3056
new_conflicts.add(('deleting parent', 'Not deleting',
2836
3061
tt.final_name(trans_id)
added
removed
bzrlib/transform.py
