47
40
ExistingLimbo, ImmortalLimbo, NoFinalPath,
48
41
UnableCreateSymlink)
49
42
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
43
from bzrlib.inventory import InventoryEntry
50
44
from bzrlib.osutils import (
57
52
supports_executable,
59
54
from bzrlib.progress import ProgressPhase
60
55
from bzrlib.symbol_versioning import (
59
from bzrlib.trace import mutter, warning
60
from bzrlib import tree
62
import bzrlib.urlutils as urlutils
67
65
ROOT_PARENT = "root-parent"
69
68
def unique_add(map, key, value):
71
70
raise DuplicateKey(key=key)
76
74
class _TransformResults(object):
77
75
def __init__(self, modified_paths, rename_count):
78
76
object.__init__(self)
537
531
# ensure that all children are registered with the transaction
538
532
list(self.iter_tree_children(parent_id))
540
@deprecated_method(deprecated_in((2, 3, 0)))
541
534
def has_named_child(self, by_parent, parent_id, name):
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:
536
children = by_parent[parent_id]
539
for child in children:
559
540
if self.final_name(child) == name:
561
parent_path = self._tree_id_paths.get(parent_id, None)
562
if parent_path is None:
563
# No parent... no children
543
path = self._tree_id_paths[parent_id]
565
child_path = joinpath(parent_path, name)
566
child_id = self._tree_path_ids.get(child_path, None)
546
childpath = joinpath(path, name)
547
child_id = self._tree_path_ids.get(childpath)
567
548
if child_id is None:
568
# Not known by the tree transform yet, check the filesystem
569
return osutils.lexists(self._tree.abspath(child_path))
549
return lexists(self._tree.abspath(childpath))
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))
551
if self.final_parent(child_id) != parent_id:
553
if child_id in self._removed_contents:
554
# XXX What about dangling file-ids?
588
559
def _parent_loops(self):
589
560
"""No entry should be its own ancestor"""
666
637
if (self._new_name, self._new_parent) == ({}, {}):
668
639
for children in by_parent.itervalues():
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))
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]
679
645
last_trans_id = None
705
671
def _parent_type_conflicts(self, by_parent):
706
"""Children must have a directory parent"""
672
"""parents must have directory 'contents'."""
708
674
for parent_id, children in by_parent.iteritems():
709
675
if parent_id is ROOT_PARENT:
712
for child_id in children:
713
if self.final_kind(child_id) is not None:
677
if not self._any_contents(children):
718
# There is at least a child, so we need an existing directory to
720
679
kind = self.final_kind(parent_id)
722
# The directory will be deleted
723
681
conflicts.append(('missing parent', parent_id))
724
682
elif kind != "directory":
725
# Meh, we need a *directory* to put something in it
726
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:
729
693
def _set_executability(self, path, trans_id):
730
694
"""Set the executability of versioned files """
731
695
if supports_executable():
795
759
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
840
762
def _affected_ids(self):
841
763
"""Return the set of transform ids affected by the transform"""
842
764
trans_ids = set(self._removed_id)
1248
1170
descendants.update(self._limbo_descendants(descendant))
1249
1171
return descendants
1251
def create_file(self, contents, trans_id, mode_id=None, sha1=None):
1173
def create_file(self, contents, trans_id, mode_id=None):
1252
1174
"""Schedule creation of a new file.
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.
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.
1265
1184
name = self._limbo_name(trans_id)
1266
1185
f = open(name, 'wb')
1358
1271
del self._limbo_children_names[trans_id]
1359
1272
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')
1445
1275
class TreeTransform(DiskTreeTransform):
1446
1276
"""Represent a tree transformation.
1838
1667
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.
1842
1668
if (trans_id in self._new_contents or
1843
1669
self.path_changed(trans_id)):
1844
1670
if trans_id in self._new_contents:
1845
1671
modified_paths.append(full_path)
1846
1672
if trans_id in self._new_executability:
1847
1673
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)
1853
1675
child_pb.finished()
1854
1676
self._new_contents.clear()
1855
1677
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)
1881
1680
class TransformPreview(DiskTreeTransform):
1882
1681
"""A TreeTransform for generating preview trees.
1967
1763
yield self._get_repository().revision_tree(revision_id)
1969
1765
def _get_file_revision(self, file_id, vf, tree_revision):
1970
parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
1766
parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
1971
1767
self._iter_parent_trees()]
1972
1768
vf.add_lines((file_id, tree_revision), parent_keys,
1973
1769
self.get_file_lines(file_id))
2592
2388
unchanged = dict(unchanged)
2593
2389
new_desired_files = []
2595
for file_id, (trans_id, tree_path, text_sha1) in desired_files:
2391
for file_id, (trans_id, tree_path) in desired_files:
2596
2392
accelerator_path = unchanged.get(file_id)
2597
2393
if accelerator_path is None:
2598
new_desired_files.append((file_id,
2599
(trans_id, tree_path, text_sha1)))
2394
new_desired_files.append((file_id, (trans_id, tree_path)))
2601
2396
pb.update('Adding file contents', count + offset, total)
2620
2415
offset += count
2621
for count, ((trans_id, tree_path, text_sha1), contents) in enumerate(
2416
for count, ((trans_id, tree_path), contents) in enumerate(
2622
2417
tree.iter_files_bytes(new_desired_files)):
2623
2418
if wt.supports_content_filtering():
2624
2419
filters = wt._content_filter_stack(tree_path)
2625
2420
contents = filtered_output_bytes(contents, filters,
2626
2421
ContentFilterContext(tree_path, tree))
2627
tt.create_file(contents, trans_id, sha1=text_sha1)
2422
tt.create_file(contents, trans_id)
2628
2423
pb.update('Adding file contents', count + offset, total)
2632
2427
for child in tt.iter_tree_children(old_parent):
2633
2428
tt.adjust_path(tt.final_name(child), new_parent, child)
2636
2430
def _reparent_transform_children(tt, old_parent, new_parent):
2637
2431
by_parent = tt.by_parent()
2638
2432
for child in by_parent[old_parent]:
2639
2433
tt.adjust_path(tt.final_name(child), new_parent, child)
2640
2434
return by_parent[old_parent]
2643
2436
def _content_match(tree, entry, file_id, kind, target_path):
2644
2437
if entry.kind != kind:
2745
2538
tt.set_executability(entry.executable, trans_id)
2748
@deprecated_function(deprecated_in((2, 3, 0)))
2749
2541
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2750
2542
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2753
@deprecated_function(deprecated_in((2, 3, 0)))
2754
2545
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2755
2546
"""Produce a backup-style name that appears to be available"""
2756
2547
def name_gen():
2877
2668
tt.delete_contents(trans_id)
2878
2669
elif kind[1] is not None:
2879
2670
parent_trans_id = tt.trans_id_file_id(parent[0])
2880
backup_name = tt._available_backup_name(
2881
name[0], parent_trans_id)
2671
by_parent = tt.by_parent()
2672
backup_name = _get_backup_name(name[0], by_parent,
2673
parent_trans_id, tt)
2882
2674
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2883
2675
new_trans_id = tt.create_path(name[0], parent_trans_id)
2884
2676
if versioned == (True, True):
3008
2800
elif c_type == 'missing parent':
3009
2801
trans_id = conflict[1]
3010
if trans_id in tt._removed_contents:
3011
cancel_deletion = True
3012
orphans = tt._get_potential_orphans(trans_id)
3014
cancel_deletion = False
3015
# All children are orphans
3018
tt.new_orphan(o, trans_id)
3019
except OrphaningError:
3020
# Something bad happened so we cancel the directory
3021
# deletion which will leave it in place with a
3022
# conflict. The user can deal with it from there.
3023
# Note that this also catch the case where we don't
3024
# want to create orphans and leave the directory in
3026
cancel_deletion = True
3029
# Cancel the directory deletion
3030
tt.cancel_deletion(trans_id)
3031
new_conflicts.add(('deleting parent', 'Not deleting',
2803
tt.cancel_deletion(trans_id)
2804
new_conflicts.add(('deleting parent', 'Not deleting',
3036
2809
tt.final_name(trans_id)
added
removed
bzrlib/transform.py
