52
59
supports_executable,
54
61
from bzrlib.progress import ProgressPhase
55
62
from bzrlib.symbol_versioning import (
59
from bzrlib.trace import mutter, warning
60
from bzrlib import tree
62
import bzrlib.urlutils as urlutils
67
from bzrlib.trace import warning
65
70
ROOT_PARENT = "root-parent"
68
72
def unique_add(map, key, value):
70
74
raise DuplicateKey(key=key)
74
79
class _TransformResults(object):
75
80
def __init__(self, modified_paths, rename_count):
76
81
object.__init__(self)
531
538
# ensure that all children are registered with the transaction
532
539
list(self.iter_tree_children(parent_id))
541
@deprecated_method(deprecated_in((2, 3, 0)))
534
542
def has_named_child(self, by_parent, parent_id, name):
536
children = by_parent[parent_id]
539
for child in children:
543
return self._has_named_child(
544
name, parent_id, known_children=by_parent.get(parent_id, []))
546
def _has_named_child(self, name, parent_id, known_children):
547
"""Does a parent already have a name child.
549
:param name: The searched for name.
551
:param parent_id: The parent for which the check is made.
553
:param known_children: The already known children. This should have
554
been recently obtained from `self.by_parent.get(parent_id)`
555
(or will be if None is passed).
557
if known_children is None:
558
known_children = self.by_parent().get(parent_id, [])
559
for child in known_children:
540
560
if self.final_name(child) == name:
543
path = self._tree_id_paths[parent_id]
562
parent_path = self._tree_id_paths.get(parent_id, None)
563
if parent_path is None:
564
# No parent... no children
546
childpath = joinpath(path, name)
547
child_id = self._tree_path_ids.get(childpath)
566
child_path = joinpath(parent_path, name)
567
child_id = self._tree_path_ids.get(child_path, None)
548
568
if child_id is None:
549
return lexists(self._tree.abspath(childpath))
569
# Not known by the tree transform yet, check the filesystem
570
return osutils.lexists(self._tree.abspath(child_path))
551
if self.final_parent(child_id) != parent_id:
553
if child_id in self._removed_contents:
554
# XXX What about dangling file-ids?
572
raise AssertionError('child_id is missing: %s, %s, %s'
573
% (name, parent_id, child_id))
575
def _available_backup_name(self, name, target_id):
576
"""Find an available backup name.
578
:param name: The basename of the file.
580
:param target_id: The directory trans_id where the backup should
583
known_children = self.by_parent().get(target_id, [])
584
return osutils.available_backup_name(
586
lambda base: self._has_named_child(
587
base, target_id, known_children))
559
589
def _parent_loops(self):
560
590
"""No entry should be its own ancestor"""
637
667
if (self._new_name, self._new_parent) == ({}, {}):
639
669
for children in by_parent.itervalues():
640
name_ids = [(self.final_name(t), t) for t in children]
641
if not self._case_sensitive_target:
642
name_ids = [(n.lower(), t) for n, t in name_ids]
671
for child_tid in children:
672
name = self.final_name(child_tid)
674
# Keep children only if they still exist in the end
675
if not self._case_sensitive_target:
677
name_ids.append((name, child_tid))
645
680
last_trans_id = None
671
706
def _parent_type_conflicts(self, by_parent):
672
"""parents must have directory 'contents'."""
707
"""Children must have a directory parent"""
674
709
for parent_id, children in by_parent.iteritems():
675
710
if parent_id is ROOT_PARENT:
677
if not self._any_contents(children):
713
for child_id in children:
714
if self.final_kind(child_id) is not None:
719
# There is at least a child, so we need an existing directory to
679
721
kind = self.final_kind(parent_id)
723
# The directory will be deleted
681
724
conflicts.append(('missing parent', parent_id))
682
725
elif kind != "directory":
726
# Meh, we need a *directory* to put something in it
683
727
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:
693
730
def _set_executability(self, path, trans_id):
694
731
"""Set the executability of versioned files """
695
732
if supports_executable():
759
796
self.create_symlink(target, trans_id)
799
def new_orphan(self, trans_id, parent_id):
800
"""Schedule an item to be orphaned.
802
When a directory is about to be removed, its children, if they are not
803
versioned are moved out of the way: they don't have a parent anymore.
805
:param trans_id: The trans_id of the existing item.
806
:param parent_id: The parent trans_id of the item.
808
raise NotImplementedError(self.new_orphan)
810
def _get_potential_orphans(self, dir_id):
811
"""Find the potential orphans in a directory.
813
A directory can't be safely deleted if there are versioned files in it.
814
If all the contained files are unversioned then they can be orphaned.
816
The 'None' return value means that the directory contains at least one
817
versioned file and should not be deleted.
819
:param dir_id: The directory trans id.
821
:return: A list of the orphan trans ids or None if at least one
822
versioned file is present.
825
# Find the potential orphans, stop if one item should be kept
826
for child_tid in self.by_parent()[dir_id]:
827
if child_tid in self._removed_contents:
828
# The child is removed as part of the transform. Since it was
829
# versioned before, it's not an orphan
831
elif self.final_file_id(child_tid) is None:
832
# The child is not versioned
833
orphans.append(child_tid)
835
# We have a versioned file here, searching for orphans is
762
841
def _affected_ids(self):
763
842
"""Return the set of transform ids affected by the transform"""
764
843
trans_ids = set(self._removed_id)
1271
1350
del self._limbo_children_names[trans_id]
1272
1351
delete_any(self._limbo_name(trans_id))
1353
def new_orphan(self, trans_id, parent_id):
1354
# FIXME: There is no tree config, so we use the branch one (it's weird
1355
# to define it this way as orphaning can only occur in a working tree,
1356
# but that's all we have (for now). It will find the option in
1357
# locations.conf or bazaar.conf though) -- vila 20100916
1358
conf = self._tree.branch.get_config()
1359
conf_var_name = 'bzr.transform.orphan_policy'
1360
orphan_policy = conf.get_user_option(conf_var_name)
1361
default_policy = orphaning_registry.default_key
1362
if orphan_policy is None:
1363
orphan_policy = default_policy
1364
if orphan_policy not in orphaning_registry:
1365
trace.warning('%s (from %s) is not a known policy, defaulting to %s'
1366
% (orphan_policy, conf_var_name, default_policy))
1367
orphan_policy = default_policy
1368
handle_orphan = orphaning_registry.get(orphan_policy)
1369
handle_orphan(self, trans_id, parent_id)
1372
class OrphaningError(errors.BzrError):
1374
# Only bugs could lead to such exception being seen by the user
1375
internal_error = True
1376
_fmt = "Error while orphaning %s in %s directory"
1378
def __init__(self, orphan, parent):
1379
errors.BzrError.__init__(self)
1380
self.orphan = orphan
1381
self.parent = parent
1384
class OrphaningForbidden(OrphaningError):
1386
_fmt = "Policy: %s doesn't allow creating orphans."
1388
def __init__(self, policy):
1389
errors.BzrError.__init__(self)
1390
self.policy = policy
1393
def move_orphan(tt, orphan_id, parent_id):
1394
"""See TreeTransformBase.new_orphan.
1396
This creates a new orphan in the `bzr-orphans` dir at the root of the
1399
:param tt: The TreeTransform orphaning `trans_id`.
1401
:param orphan_id: The trans id that should be orphaned.
1403
:param parent_id: The orphan parent trans id.
1405
# Add the orphan dir if it doesn't exist
1406
orphan_dir_basename = 'bzr-orphans'
1407
od_id = tt.trans_id_tree_path(orphan_dir_basename)
1408
if tt.final_kind(od_id) is None:
1409
tt.create_directory(od_id)
1410
parent_path = tt._tree_id_paths[parent_id]
1411
# Find a name that doesn't exist yet in the orphan dir
1412
actual_name = tt.final_name(orphan_id)
1413
new_name = tt._available_backup_name(actual_name, od_id)
1414
tt.adjust_path(new_name, od_id, orphan_id)
1415
trace.warning('%s has been orphaned in %s'
1416
% (joinpath(parent_path, actual_name), orphan_dir_basename))
1419
def refuse_orphan(tt, orphan_id, parent_id):
1420
"""See TreeTransformBase.new_orphan.
1422
This refuses to create orphan, letting the caller handle the conflict.
1424
raise OrphaningForbidden('never')
1427
orphaning_registry = registry.Registry()
1428
orphaning_registry.register(
1429
'conflict', refuse_orphan,
1430
'Leave orphans in place and create a conflict on the directory.')
1431
orphaning_registry.register(
1432
'move', move_orphan,
1433
'Move orphans into the bzr-orphans directory.')
1434
orphaning_registry._set_default_key('conflict')
1275
1437
class TreeTransform(DiskTreeTransform):
1276
1438
"""Represent a tree transformation.
2427
2592
for child in tt.iter_tree_children(old_parent):
2428
2593
tt.adjust_path(tt.final_name(child), new_parent, child)
2430
2596
def _reparent_transform_children(tt, old_parent, new_parent):
2431
2597
by_parent = tt.by_parent()
2432
2598
for child in by_parent[old_parent]:
2433
2599
tt.adjust_path(tt.final_name(child), new_parent, child)
2434
2600
return by_parent[old_parent]
2436
2603
def _content_match(tree, entry, file_id, kind, target_path):
2437
2604
if entry.kind != kind:
2538
2705
tt.set_executability(entry.executable, trans_id)
2708
@deprecated_function(deprecated_in((2, 3, 0)))
2541
2709
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2542
2710
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2713
@deprecated_function(deprecated_in((2, 3, 0)))
2545
2714
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2546
2715
"""Produce a backup-style name that appears to be available"""
2547
2716
def name_gen():
2668
2837
tt.delete_contents(trans_id)
2669
2838
elif kind[1] is not None:
2670
2839
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)
2840
backup_name = tt._available_backup_name(
2841
name[0], parent_trans_id)
2674
2842
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2675
2843
new_trans_id = tt.create_path(name[0], parent_trans_id)
2676
2844
if versioned == (True, True):
2800
2968
elif c_type == 'missing parent':
2801
2969
trans_id = conflict[1]
2803
tt.cancel_deletion(trans_id)
2804
new_conflicts.add(('deleting parent', 'Not deleting',
2970
if trans_id in tt._removed_contents:
2971
cancel_deletion = True
2972
orphans = tt._get_potential_orphans(trans_id)
2974
cancel_deletion = False
2975
# All children are orphans
2978
tt.new_orphan(o, trans_id)
2979
except OrphaningError:
2980
# Something bad happened so we cancel the directory
2981
# deletion which will leave it in place with a
2982
# conflict. The user can deal with it from there.
2983
# Note that this also catch the case where we don't
2984
# want to create orphans and leave the directory in
2986
cancel_deletion = True
2989
# Cancel the directory deletion
2990
tt.cancel_deletion(trans_id)
2991
new_conflicts.add(('deleting parent', 'Not deleting',
2809
2996
tt.final_name(trans_id)