47
39
ExistingLimbo, ImmortalLimbo, NoFinalPath,
48
40
UnableCreateSymlink)
49
41
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
42
from bzrlib.inventory import InventoryEntry
50
43
from bzrlib.osutils import (
57
51
supports_executable,
59
53
from bzrlib.progress import ProgressPhase
60
54
from bzrlib.symbol_versioning import (
58
from bzrlib.trace import mutter, warning
59
from bzrlib import tree
61
import bzrlib.urlutils as urlutils
67
64
ROOT_PARENT = "root-parent"
69
67
def unique_add(map, key, value):
71
69
raise DuplicateKey(key=key)
76
73
class _TransformResults(object):
77
74
def __init__(self, modified_paths, rename_count):
78
75
object.__init__(self)
390
388
changed_kind = set(self._removed_contents)
391
389
changed_kind.intersection_update(self._new_contents)
392
390
changed_kind.difference_update(new_ids)
393
changed_kind = (t for t in changed_kind
394
if self.tree_kind(t) != self.final_kind(t))
391
changed_kind = (t for t in changed_kind if self.tree_kind(t) !=
395
393
new_ids.update(changed_kind)
396
394
return sorted(FinalPaths(self).get_paths(new_ids))
398
396
def final_kind(self, trans_id):
399
397
"""Determine the final file kind, after any changes applied.
401
:return: None if the file does not exist/has no contents. (It is
402
conceivable that a path would be created without the corresponding
403
contents insertion command)
399
Raises NoSuchFile if the file does not exist/has no contents.
400
(It is conceivable that a path would be created without the
401
corresponding contents insertion command)
405
403
if trans_id in self._new_contents:
406
404
return self._new_contents[trans_id]
407
405
elif trans_id in self._removed_contents:
406
raise NoSuchFile(None)
410
408
return self.tree_kind(trans_id)
535
531
# ensure that all children are registered with the transaction
536
532
list(self.iter_tree_children(parent_id))
538
@deprecated_method(deprecated_in((2, 3, 0)))
539
534
def has_named_child(self, by_parent, parent_id, name):
540
return self._has_named_child(
541
name, parent_id, known_children=by_parent.get(parent_id, []))
543
def _has_named_child(self, name, parent_id, known_children):
544
"""Does a parent already have a name child.
546
:param name: The searched for name.
548
:param parent_id: The parent for which the check is made.
550
:param known_children: The already known children. This should have
551
been recently obtained from `self.by_parent.get(parent_id)`
552
(or will be if None is passed).
554
if known_children is None:
555
known_children = self.by_parent().get(parent_id, [])
556
for child in known_children:
536
children = by_parent[parent_id]
539
for child in children:
557
540
if self.final_name(child) == name:
559
parent_path = self._tree_id_paths.get(parent_id, None)
560
if parent_path is None:
561
# No parent... no children
543
path = self._tree_id_paths[parent_id]
563
child_path = joinpath(parent_path, name)
564
child_id = self._tree_path_ids.get(child_path, None)
546
childpath = joinpath(path, name)
547
child_id = self._tree_path_ids.get(childpath)
565
548
if child_id is None:
566
# Not known by the tree transform yet, check the filesystem
567
return osutils.lexists(self._tree.abspath(child_path))
549
return lexists(self._tree.abspath(childpath))
569
raise AssertionError('child_id is missing: %s, %s, %s'
570
% (name, parent_id, child_id))
572
def _available_backup_name(self, name, target_id):
573
"""Find an available backup name.
575
:param name: The basename of the file.
577
:param target_id: The directory trans_id where the backup should
580
known_children = self.by_parent().get(target_id, [])
581
return osutils.available_backup_name(
583
lambda base: self._has_named_child(
584
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?
586
559
def _parent_loops(self):
587
560
"""No entry should be its own ancestor"""
664
644
if (self._new_name, self._new_parent) == ({}, {}):
666
646
for children in by_parent.itervalues():
668
for child_tid in children:
669
name = self.final_name(child_tid)
671
# Keep children only if they still exist in the end
672
if not self._case_sensitive_target:
674
name_ids.append((name, child_tid))
647
name_ids = [(self.final_name(t), t) for t in children]
648
if not self._case_sensitive_target:
649
name_ids = [(n.lower(), t) for n, t in name_ids]
677
652
last_trans_id = None
678
653
for name, trans_id in name_ids:
679
kind = self.final_kind(trans_id)
655
kind = self.final_kind(trans_id)
680
658
file_id = self.final_file_id(trans_id)
681
659
if kind is None and file_id is None:
703
681
def _parent_type_conflicts(self, by_parent):
704
"""Children must have a directory parent"""
682
"""parents must have directory 'contents'."""
706
684
for parent_id, children in by_parent.iteritems():
707
685
if parent_id is ROOT_PARENT:
710
for child_id in children:
711
if self.final_kind(child_id) is not None:
687
if not self._any_contents(children):
716
# There is at least a child, so we need an existing directory to
718
kind = self.final_kind(parent_id)
689
for child in children:
691
self.final_kind(child)
695
kind = self.final_kind(parent_id)
720
# The directory will be deleted
721
699
conflicts.append(('missing parent', parent_id))
722
700
elif kind != "directory":
723
# Meh, we need a *directory* to put something in it
724
701
conflicts.append(('non-directory parent', parent_id))
704
def _any_contents(self, trans_ids):
705
"""Return true if any of the trans_ids, will have contents."""
706
for trans_id in trans_ids:
708
kind = self.final_kind(trans_id)
727
714
def _set_executability(self, path, trans_id):
728
715
"""Set the executability of versioned files """
729
716
if supports_executable():
793
780
self.create_symlink(target, trans_id)
796
def new_orphan(self, trans_id, parent_id):
797
"""Schedule an item to be orphaned.
799
When a directory is about to be removed, its children, if they are not
800
versioned are moved out of the way: they don't have a parent anymore.
802
:param trans_id: The trans_id of the existing item.
803
:param parent_id: The parent trans_id of the item.
805
raise NotImplementedError(self.new_orphan)
807
def _get_potential_orphans(self, dir_id):
808
"""Find the potential orphans in a directory.
810
A directory can't be safely deleted if there are versioned files in it.
811
If all the contained files are unversioned then they can be orphaned.
813
The 'None' return value means that the directory contains at least one
814
versioned file and should not be deleted.
816
:param dir_id: The directory trans id.
818
:return: A list of the orphan trans ids or None if at least one
819
versioned file is present.
822
# Find the potential orphans, stop if one item should be kept
823
for child_tid in self.by_parent()[dir_id]:
824
if child_tid in self._removed_contents:
825
# The child is removed as part of the transform. Since it was
826
# versioned before, it's not an orphan
828
elif self.final_file_id(child_tid) is None:
829
# The child is not versioned
830
orphans.append(child_tid)
832
# We have a versioned file here, searching for orphans is
838
783
def _affected_ids(self):
839
784
"""Return the set of transform ids affected by the transform"""
840
785
trans_ids = set(self._removed_id)
980
928
return _PreviewTree(self)
982
def commit(self, branch, message, merge_parents=None, strict=False,
983
timestamp=None, timezone=None, committer=None, authors=None,
984
revprops=None, revision_id=None):
930
def commit(self, branch, message, merge_parents=None, strict=False):
985
931
"""Commit the result of this TreeTransform to a branch.
987
933
:param branch: The branch to commit to.
988
934
:param message: The message to attach to the commit.
989
:param merge_parents: Additional parent revision-ids specified by
991
:param strict: If True, abort the commit if there are unversioned
993
:param timestamp: if not None, seconds-since-epoch for the time and
994
date. (May be a float.)
995
:param timezone: Optional timezone for timestamp, as an offset in
997
:param committer: Optional committer in email-id format.
998
(e.g. "J Random Hacker <jrandom@example.com>")
999
:param authors: Optional list of authors in email-id format.
1000
:param revprops: Optional dictionary of revision properties.
1001
:param revision_id: Optional revision id. (Specifying a revision-id
1002
may reduce performance for some non-native formats.)
935
:param merge_parents: Additional parents specified by pending merges.
1003
936
:return: The revision_id of the revision committed.
1005
938
self._check_malformed()
1347
1274
del self._limbo_children_names[trans_id]
1348
1275
delete_any(self._limbo_name(trans_id))
1350
def new_orphan(self, trans_id, parent_id):
1351
# FIXME: There is no tree config, so we use the branch one (it's weird
1352
# to define it this way as orphaning can only occur in a working tree,
1353
# but that's all we have (for now). It will find the option in
1354
# locations.conf or bazaar.conf though) -- vila 20100916
1355
conf = self._tree.branch.get_config()
1356
conf_var_name = 'bzr.transform.orphan_policy'
1357
orphan_policy = conf.get_user_option(conf_var_name)
1358
default_policy = orphaning_registry.default_key
1359
if orphan_policy is None:
1360
orphan_policy = default_policy
1361
if orphan_policy not in orphaning_registry:
1362
trace.warning('%s (from %s) is not a known policy, defaulting '
1363
'to %s' % (orphan_policy, conf_var_name, default_policy))
1364
orphan_policy = default_policy
1365
handle_orphan = orphaning_registry.get(orphan_policy)
1366
handle_orphan(self, trans_id, parent_id)
1369
class OrphaningError(errors.BzrError):
1371
# Only bugs could lead to such exception being seen by the user
1372
internal_error = True
1373
_fmt = "Error while orphaning %s in %s directory"
1375
def __init__(self, orphan, parent):
1376
errors.BzrError.__init__(self)
1377
self.orphan = orphan
1378
self.parent = parent
1381
class OrphaningForbidden(OrphaningError):
1383
_fmt = "Policy: %s doesn't allow creating orphans."
1385
def __init__(self, policy):
1386
errors.BzrError.__init__(self)
1387
self.policy = policy
1390
def move_orphan(tt, orphan_id, parent_id):
1391
"""See TreeTransformBase.new_orphan.
1393
This creates a new orphan in the `bzr-orphans` dir at the root of the
1396
:param tt: The TreeTransform orphaning `trans_id`.
1398
:param orphan_id: The trans id that should be orphaned.
1400
:param parent_id: The orphan parent trans id.
1402
# Add the orphan dir if it doesn't exist
1403
orphan_dir_basename = 'bzr-orphans'
1404
od_id = tt.trans_id_tree_path(orphan_dir_basename)
1405
if tt.final_kind(od_id) is None:
1406
tt.create_directory(od_id)
1407
parent_path = tt._tree_id_paths[parent_id]
1408
# Find a name that doesn't exist yet in the orphan dir
1409
actual_name = tt.final_name(orphan_id)
1410
new_name = tt._available_backup_name(actual_name, od_id)
1411
tt.adjust_path(new_name, od_id, orphan_id)
1412
trace.warning('%s has been orphaned in %s'
1413
% (joinpath(parent_path, actual_name), orphan_dir_basename))
1416
def refuse_orphan(tt, orphan_id, parent_id):
1417
"""See TreeTransformBase.new_orphan.
1419
This refuses to create orphan, letting the caller handle the conflict.
1421
raise OrphaningForbidden('never')
1424
orphaning_registry = registry.Registry()
1425
orphaning_registry.register(
1426
'conflict', refuse_orphan,
1427
'Leave orphans in place and create a conflict on the directory.')
1428
orphaning_registry.register(
1429
'move', move_orphan,
1430
'Move orphans into the bzr-orphans directory.')
1431
orphaning_registry._set_default_key('conflict')
1434
1278
class TreeTransform(DiskTreeTransform):
1435
1279
"""Represent a tree transformation.
1553
1397
def tree_kind(self, trans_id):
1554
1398
"""Determine the file kind in the working tree.
1556
:returns: The file kind or None if the file does not exist
1400
Raises NoSuchFile if the file does not exist
1558
1402
path = self._tree_id_paths.get(trans_id)
1559
1403
if path is None:
1404
raise NoSuchFile(None)
1562
1406
return file_kind(self._tree.abspath(path))
1563
except errors.NoSuchFile:
1408
if e.errno != errno.ENOENT:
1411
raise NoSuchFile(path)
1566
1413
def _set_mode(self, trans_id, mode_id, typefunc):
1567
1414
"""Set the mode of new file contents.
2426
2266
for num, _unused in enumerate(wt.all_file_ids()):
2427
2267
if num > 0: # more than just a root
2428
2268
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2269
existing_files = set()
2270
for dir, files in wt.walkdirs():
2271
existing_files.update(f[0] for f in files)
2429
2272
file_trans_id = {}
2430
top_pb = ui.ui_factory.nested_progress_bar()
2273
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2431
2274
pp = ProgressPhase("Build phase", 2, top_pb)
2432
2275
if tree.inventory.root is not None:
2433
2276
# This is kind of a hack: we should be altering the root
2455
2298
precomputed_delta = []
2457
2300
precomputed_delta = None
2458
# Check if tree inventory has content. If so, we populate
2459
# existing_files with the directory content. If there are no
2460
# entries we skip populating existing_files as its not used.
2461
# This improves performance and unncessary work on large
2462
# directory trees. (#501307)
2464
existing_files = set()
2465
for dir, files in wt.walkdirs():
2466
existing_files.update(f[0] for f in files)
2467
2301
for num, (tree_path, entry) in \
2468
2302
enumerate(tree.inventory.iter_entries_by_dir()):
2469
2303
pb.update("Building tree", num - len(deferred_contents), total)
2589
2423
for child in tt.iter_tree_children(old_parent):
2590
2424
tt.adjust_path(tt.final_name(child), new_parent, child)
2593
2426
def _reparent_transform_children(tt, old_parent, new_parent):
2594
2427
by_parent = tt.by_parent()
2595
2428
for child in by_parent[old_parent]:
2596
2429
tt.adjust_path(tt.final_name(child), new_parent, child)
2597
2430
return by_parent[old_parent]
2600
2432
def _content_match(tree, entry, file_id, kind, target_path):
2601
2433
if entry.kind != kind:
2603
2435
if entry.kind == "directory":
2605
2437
if entry.kind == "file":
2606
f = file(target_path, 'rb')
2608
if tree.get_file_text(file_id) == f.read():
2438
if tree.get_file(file_id).read() == file(target_path, 'rb').read():
2612
2440
elif entry.kind == "symlink":
2613
2441
if tree.get_symlink_target(file_id) == os.readlink(target_path):
2666
2494
raise errors.BadFileKindError(name, kind)
2497
@deprecated_function(deprecated_in((1, 9, 0)))
2498
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
2499
"""Create new file contents according to an inventory entry.
2501
DEPRECATED. Use create_from_tree instead.
2503
if entry.kind == "file":
2505
lines = tree.get_file(entry.file_id).readlines()
2506
tt.create_file(lines, trans_id, mode_id=mode_id)
2507
elif entry.kind == "symlink":
2508
tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
2509
elif entry.kind == "directory":
2510
tt.create_directory(trans_id)
2669
2513
def create_from_tree(tt, trans_id, tree, file_id, bytes=None,
2670
2514
filter_tree_path=None):
2671
2515
"""Create new file contents according to tree contents.
2702
2546
tt.set_executability(entry.executable, trans_id)
2705
@deprecated_function(deprecated_in((2, 3, 0)))
2706
2549
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2707
2550
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2710
@deprecated_function(deprecated_in((2, 3, 0)))
2711
2553
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2712
2554
"""Produce a backup-style name that appears to be available"""
2713
2555
def name_gen():
2834
2676
tt.delete_contents(trans_id)
2835
2677
elif kind[1] is not None:
2836
2678
parent_trans_id = tt.trans_id_file_id(parent[0])
2837
backup_name = tt._available_backup_name(
2838
name[0], parent_trans_id)
2679
by_parent = tt.by_parent()
2680
backup_name = _get_backup_name(name[0], by_parent,
2681
parent_trans_id, tt)
2839
2682
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2840
2683
new_trans_id = tt.create_path(name[0], parent_trans_id)
2841
2684
if versioned == (True, True):
2965
2808
elif c_type == 'missing parent':
2966
2809
trans_id = conflict[1]
2967
if trans_id in tt._removed_contents:
2968
cancel_deletion = True
2969
orphans = tt._get_potential_orphans(trans_id)
2971
cancel_deletion = False
2972
# All children are orphans
2975
tt.new_orphan(o, trans_id)
2976
except OrphaningError:
2977
# Something bad happened so we cancel the directory
2978
# deletion which will leave it in place with a
2979
# conflict. The user can deal with it from there.
2980
# Note that this also catch the case where we don't
2981
# want to create orphans and leave the directory in
2983
cancel_deletion = True
2986
# Cancel the directory deletion
2987
tt.cancel_deletion(trans_id)
2988
new_conflicts.add(('deleting parent', 'Not deleting',
2811
tt.cancel_deletion(trans_id)
2812
new_conflicts.add(('deleting parent', 'Not deleting',
2993
2817
tt.final_name(trans_id)
3077
2900
def rename(self, from_, to):
3078
2901
"""Rename a file from one path to another."""
3080
os.rename(from_, to)
2903
osutils.rename(from_, to)
3081
2904
except OSError, e:
3082
2905
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
3083
2906
raise errors.FileExists(to, str(e))
3084
# normal OSError doesn't include filenames so it's hard to see where
3085
# the problem is, see https://bugs.launchpad.net/bzr/+bug/491763
3086
raise errors.TransformRenameFailed(from_, to, str(e), e.errno)
3087
2908
self.past_renames.append((from_, to))
3089
2910
def pre_delete(self, from_, to):