51
59
supports_executable,
53
61
from bzrlib.progress import ProgressPhase
54
62
from bzrlib.symbol_versioning import (
58
from bzrlib.trace import mutter, warning
59
from bzrlib import tree
61
import bzrlib.urlutils as urlutils
67
from bzrlib.trace import warning
64
70
ROOT_PARENT = "root-parent"
67
72
def unique_add(map, key, value):
69
74
raise DuplicateKey(key=key)
73
79
class _TransformResults(object):
74
80
def __init__(self, modified_paths, rename_count):
75
81
object.__init__(self)
388
393
changed_kind = set(self._removed_contents)
389
394
changed_kind.intersection_update(self._new_contents)
390
395
changed_kind.difference_update(new_ids)
391
changed_kind = (t for t in changed_kind if self.tree_kind(t) !=
396
changed_kind = (t for t in changed_kind
397
if self.tree_kind(t) != self.final_kind(t))
393
398
new_ids.update(changed_kind)
394
399
return sorted(FinalPaths(self).get_paths(new_ids))
396
401
def final_kind(self, trans_id):
397
402
"""Determine the final file kind, after any changes applied.
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)
404
:return: None if the file does not exist/has no contents. (It is
405
conceivable that a path would be created without the corresponding
406
contents insertion command)
403
408
if trans_id in self._new_contents:
404
409
return self._new_contents[trans_id]
405
410
elif trans_id in self._removed_contents:
406
raise NoSuchFile(None)
408
413
return self.tree_kind(trans_id)
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"""
644
667
if (self._new_name, self._new_parent) == ({}, {}):
646
669
for children in by_parent.itervalues():
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]
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))
652
680
last_trans_id = None
653
681
for name, trans_id in name_ids:
655
kind = self.final_kind(trans_id)
682
kind = self.final_kind(trans_id)
658
683
file_id = self.final_file_id(trans_id)
659
684
if kind is None and file_id is None:
681
706
def _parent_type_conflicts(self, by_parent):
682
"""parents must have directory 'contents'."""
707
"""Children must have a directory parent"""
684
709
for parent_id, children in by_parent.iteritems():
685
710
if parent_id is ROOT_PARENT:
687
if not self._any_contents(children):
713
for child_id in children:
714
if self.final_kind(child_id) is not None:
689
for child in children:
691
self.final_kind(child)
695
kind = self.final_kind(parent_id)
719
# There is at least a child, so we need an existing directory to
721
kind = self.final_kind(parent_id)
723
# The directory will be deleted
699
724
conflicts.append(('missing parent', parent_id))
700
725
elif kind != "directory":
726
# Meh, we need a *directory* to put something in it
701
727
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)
714
730
def _set_executability(self, path, trans_id):
715
731
"""Set the executability of versioned files """
716
732
if supports_executable():
780
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
783
841
def _affected_ids(self):
784
842
"""Return the set of transform ids affected by the transform"""
785
843
trans_ids = set(self._removed_id)
928
983
return _PreviewTree(self)
930
def commit(self, branch, message, merge_parents=None, strict=False):
985
def commit(self, branch, message, merge_parents=None, strict=False,
986
timestamp=None, timezone=None, committer=None, authors=None,
987
revprops=None, revision_id=None):
931
988
"""Commit the result of this TreeTransform to a branch.
933
990
:param branch: The branch to commit to.
934
991
:param message: The message to attach to the commit.
935
:param merge_parents: Additional parents specified by pending merges.
992
:param merge_parents: Additional parent revision-ids specified by
994
:param strict: If True, abort the commit if there are unversioned
996
:param timestamp: if not None, seconds-since-epoch for the time and
997
date. (May be a float.)
998
:param timezone: Optional timezone for timestamp, as an offset in
1000
:param committer: Optional committer in email-id format.
1001
(e.g. "J Random Hacker <jrandom@example.com>")
1002
:param authors: Optional list of authors in email-id format.
1003
:param revprops: Optional dictionary of revision properties.
1004
:param revision_id: Optional revision id. (Specifying a revision-id
1005
may reduce performance for some non-native formats.)
936
1006
:return: The revision_id of the revision committed.
938
1008
self._check_malformed()
1274
1350
del self._limbo_children_names[trans_id]
1275
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')
1278
1437
class TreeTransform(DiskTreeTransform):
1279
1438
"""Represent a tree transformation.
1397
1556
def tree_kind(self, trans_id):
1398
1557
"""Determine the file kind in the working tree.
1400
Raises NoSuchFile if the file does not exist
1559
:returns: The file kind or None if the file does not exist
1402
1561
path = self._tree_id_paths.get(trans_id)
1403
1562
if path is None:
1404
raise NoSuchFile(None)
1406
1565
return file_kind(self._tree.abspath(path))
1408
if e.errno != errno.ENOENT:
1411
raise NoSuchFile(path)
1566
except errors.NoSuchFile:
1413
1569
def _set_mode(self, trans_id, mode_id, typefunc):
1414
1570
"""Set the mode of new file contents.
2266
2429
for num, _unused in enumerate(wt.all_file_ids()):
2267
2430
if num > 0: # more than just a root
2268
2431
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)
2272
2432
file_trans_id = {}
2273
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2433
top_pb = ui.ui_factory.nested_progress_bar()
2274
2434
pp = ProgressPhase("Build phase", 2, top_pb)
2275
2435
if tree.inventory.root is not None:
2276
2436
# This is kind of a hack: we should be altering the root
2298
2458
precomputed_delta = []
2300
2460
precomputed_delta = None
2461
# Check if tree inventory has content. If so, we populate
2462
# existing_files with the directory content. If there are no
2463
# entries we skip populating existing_files as its not used.
2464
# This improves performance and unncessary work on large
2465
# directory trees. (#501307)
2467
existing_files = set()
2468
for dir, files in wt.walkdirs():
2469
existing_files.update(f[0] for f in files)
2301
2470
for num, (tree_path, entry) in \
2302
2471
enumerate(tree.inventory.iter_entries_by_dir()):
2303
2472
pb.update("Building tree", num - len(deferred_contents), total)
2423
2592
for child in tt.iter_tree_children(old_parent):
2424
2593
tt.adjust_path(tt.final_name(child), new_parent, child)
2426
2596
def _reparent_transform_children(tt, old_parent, new_parent):
2427
2597
by_parent = tt.by_parent()
2428
2598
for child in by_parent[old_parent]:
2429
2599
tt.adjust_path(tt.final_name(child), new_parent, child)
2430
2600
return by_parent[old_parent]
2432
2603
def _content_match(tree, entry, file_id, kind, target_path):
2433
2604
if entry.kind != kind:
2435
2606
if entry.kind == "directory":
2437
2608
if entry.kind == "file":
2438
if tree.get_file(file_id).read() == file(target_path, 'rb').read():
2609
f = file(target_path, 'rb')
2611
if tree.get_file_text(file_id) == f.read():
2440
2615
elif entry.kind == "symlink":
2441
2616
if tree.get_symlink_target(file_id) == os.readlink(target_path):
2494
2669
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)
2513
2672
def create_from_tree(tt, trans_id, tree, file_id, bytes=None,
2514
2673
filter_tree_path=None):
2515
2674
"""Create new file contents according to tree contents.
2546
2705
tt.set_executability(entry.executable, trans_id)
2708
@deprecated_function(deprecated_in((2, 3, 0)))
2549
2709
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2550
2710
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2713
@deprecated_function(deprecated_in((2, 3, 0)))
2553
2714
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2554
2715
"""Produce a backup-style name that appears to be available"""
2555
2716
def name_gen():
2676
2837
tt.delete_contents(trans_id)
2677
2838
elif kind[1] is not None:
2678
2839
parent_trans_id = tt.trans_id_file_id(parent[0])
2679
by_parent = tt.by_parent()
2680
backup_name = _get_backup_name(name[0], by_parent,
2681
parent_trans_id, tt)
2840
backup_name = tt._available_backup_name(
2841
name[0], parent_trans_id)
2682
2842
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2683
2843
new_trans_id = tt.create_path(name[0], parent_trans_id)
2684
2844
if versioned == (True, True):
2808
2968
elif c_type == 'missing parent':
2809
2969
trans_id = conflict[1]
2811
tt.cancel_deletion(trans_id)
2812
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',
2817
2996
tt.final_name(trans_id)
2900
3080
def rename(self, from_, to):
2901
3081
"""Rename a file from one path to another."""
2903
osutils.rename(from_, to)
3083
os.rename(from_, to)
2904
3084
except OSError, e:
2905
3085
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
2906
3086
raise errors.FileExists(to, str(e))
3087
# normal OSError doesn't include filenames so it's hard to see where
3088
# the problem is, see https://bugs.launchpad.net/bzr/+bug/491763
3089
raise errors.TransformRenameFailed(from_, to, str(e), e.errno)
2908
3090
self.past_renames.append((from_, to))
2910
3092
def pre_delete(self, from_, to):