51
58
supports_executable,
53
60
from bzrlib.progress import ProgressPhase
54
61
from bzrlib.symbol_versioning import (
58
from bzrlib.trace import mutter, warning
59
from bzrlib import tree
61
import bzrlib.urlutils as urlutils
66
from bzrlib.trace import warning
64
69
ROOT_PARENT = "root-parent"
67
71
def unique_add(map, key, value):
69
73
raise DuplicateKey(key=key)
73
78
class _TransformResults(object):
74
79
def __init__(self, modified_paths, rename_count):
75
80
object.__init__(self)
388
394
changed_kind = set(self._removed_contents)
389
395
changed_kind.intersection_update(self._new_contents)
390
396
changed_kind.difference_update(new_ids)
391
changed_kind = (t for t in changed_kind if self.tree_kind(t) !=
397
changed_kind = (t for t in changed_kind
398
if self.tree_kind(t) != self.final_kind(t))
393
399
new_ids.update(changed_kind)
394
400
return sorted(FinalPaths(self).get_paths(new_ids))
396
402
def final_kind(self, trans_id):
397
403
"""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)
405
:return: None if the file does not exist/has no contents. (It is
406
conceivable that a path would be created without the corresponding
407
contents insertion command)
403
409
if trans_id in self._new_contents:
404
410
return self._new_contents[trans_id]
405
411
elif trans_id in self._removed_contents:
406
raise NoSuchFile(None)
408
414
return self.tree_kind(trans_id)
531
539
# ensure that all children are registered with the transaction
532
540
list(self.iter_tree_children(parent_id))
542
@deprecated_method(deprecated_in((2, 3, 0)))
534
543
def has_named_child(self, by_parent, parent_id, name):
536
children = by_parent[parent_id]
539
for child in children:
544
return self._has_named_child(
545
name, parent_id, known_children=by_parent.get(parent_id, []))
547
def _has_named_child(self, name, parent_id, known_children):
548
"""Does a parent already have a name child.
550
:param name: The searched for name.
552
:param parent_id: The parent for which the check is made.
554
:param known_children: The already known children. This should have
555
been recently obtained from `self.by_parent.get(parent_id)`
556
(or will be if None is passed).
558
if known_children is None:
559
known_children = self.by_parent().get(parent_id, [])
560
for child in known_children:
540
561
if self.final_name(child) == name:
543
path = self._tree_id_paths[parent_id]
563
parent_path = self._tree_id_paths.get(parent_id, None)
564
if parent_path is None:
565
# No parent... no children
546
childpath = joinpath(path, name)
547
child_id = self._tree_path_ids.get(childpath)
567
child_path = joinpath(parent_path, name)
568
child_id = self._tree_path_ids.get(child_path, None)
548
569
if child_id is None:
549
return lexists(self._tree.abspath(childpath))
570
# Not known by the tree transform yet, check the filesystem
571
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?
573
raise AssertionError('child_id is missing: %s, %s, %s'
574
% (name, parent_id, child_id))
576
def _available_backup_name(self, name, target_id):
577
"""Find an available backup name.
579
:param name: The basename of the file.
581
:param target_id: The directory trans_id where the backup should
584
known_children = self.by_parent().get(target_id, [])
585
return osutils.available_backup_name(
587
lambda base: self._has_named_child(
588
base, target_id, known_children))
559
590
def _parent_loops(self):
560
591
"""No entry should be its own ancestor"""
644
668
if (self._new_name, self._new_parent) == ({}, {}):
646
670
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]
672
for child_tid in children:
673
name = self.final_name(child_tid)
675
# Keep children only if they still exist in the end
676
if not self._case_sensitive_target:
678
name_ids.append((name, child_tid))
652
681
last_trans_id = None
653
682
for name, trans_id in name_ids:
655
kind = self.final_kind(trans_id)
683
kind = self.final_kind(trans_id)
658
684
file_id = self.final_file_id(trans_id)
659
685
if kind is None and file_id is None:
681
707
def _parent_type_conflicts(self, by_parent):
682
"""parents must have directory 'contents'."""
708
"""Children must have a directory parent"""
684
710
for parent_id, children in by_parent.iteritems():
685
711
if parent_id is ROOT_PARENT:
687
if not self._any_contents(children):
714
for child_id in children:
715
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)
720
# There is at least a child, so we need an existing directory to
722
kind = self.final_kind(parent_id)
724
# The directory will be deleted
699
725
conflicts.append(('missing parent', parent_id))
700
726
elif kind != "directory":
727
# Meh, we need a *directory* to put something in it
701
728
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
731
def _set_executability(self, path, trans_id):
715
732
"""Set the executability of versioned files """
716
733
if supports_executable():
780
797
self.create_symlink(target, trans_id)
800
def new_orphan(self, trans_id, parent_id):
801
"""Schedule an item to be orphaned.
803
When a directory is about to be removed, its children, if they are not
804
versioned are moved out of the way: they don't have a parent anymore.
806
:param trans_id: The trans_id of the existing item.
807
:param parent_id: The parent trans_id of the item.
809
raise NotImplementedError(self.new_orphan)
811
def _get_potential_orphans(self, dir_id):
812
"""Find the potential orphans in a directory.
814
A directory can't be safely deleted if there are versioned files in it.
815
If all the contained files are unversioned then they can be orphaned.
817
The 'None' return value means that the directory contains at least one
818
versioned file and should not be deleted.
820
:param dir_id: The directory trans id.
822
:return: A list of the orphan trans ids or None if at least one
823
versioned file is present.
826
# Find the potential orphans, stop if one item should be kept
827
for child_tid in self.by_parent()[dir_id]:
828
if child_tid in self._removed_contents:
829
# The child is removed as part of the transform. Since it was
830
# versioned before, it's not an orphan
832
elif self.final_file_id(child_tid) is None:
833
# The child is not versioned
834
orphans.append(child_tid)
836
# We have a versioned file here, searching for orphans is
783
842
def _affected_ids(self):
784
843
"""Return the set of transform ids affected by the transform"""
785
844
trans_ids = set(self._removed_id)
928
984
return _PreviewTree(self)
930
def commit(self, branch, message, merge_parents=None, strict=False):
986
def commit(self, branch, message, merge_parents=None, strict=False,
987
timestamp=None, timezone=None, committer=None, authors=None,
988
revprops=None, revision_id=None):
931
989
"""Commit the result of this TreeTransform to a branch.
933
991
:param branch: The branch to commit to.
934
992
:param message: The message to attach to the commit.
935
:param merge_parents: Additional parents specified by pending merges.
993
:param merge_parents: Additional parent revision-ids specified by
995
:param strict: If True, abort the commit if there are unversioned
997
:param timestamp: if not None, seconds-since-epoch for the time and
998
date. (May be a float.)
999
:param timezone: Optional timezone for timestamp, as an offset in
1001
:param committer: Optional committer in email-id format.
1002
(e.g. "J Random Hacker <jrandom@example.com>")
1003
:param authors: Optional list of authors in email-id format.
1004
:param revprops: Optional dictionary of revision properties.
1005
:param revision_id: Optional revision id. (Specifying a revision-id
1006
may reduce performance for some non-native formats.)
936
1007
:return: The revision_id of the revision committed.
938
1009
self._check_malformed()
1173
1250
descendants.update(self._limbo_descendants(descendant))
1174
1251
return descendants
1176
def create_file(self, contents, trans_id, mode_id=None):
1253
def create_file(self, contents, trans_id, mode_id=None, sha1=None):
1177
1254
"""Schedule creation of a new file.
1181
Contents is an iterator of strings, all of which will be written
1182
to the target destination.
1184
New file takes the permissions of any existing file with that id,
1185
unless mode_id is specified.
1258
:param contents: an iterator of strings, all of which will be written
1259
to the target destination.
1260
:param trans_id: TreeTransform handle
1261
:param mode_id: If not None, force the mode of the target file to match
1262
the mode of the object referenced by mode_id.
1263
Otherwise, we will try to preserve mode bits of an existing file.
1264
:param sha1: If the sha1 of this content is already known, pass it in.
1265
We can use it to prevent future sha1 computations.
1187
1267
name = self._limbo_name(trans_id)
1188
1268
f = open(name, 'wb')
1274
1360
del self._limbo_children_names[trans_id]
1275
1361
delete_any(self._limbo_name(trans_id))
1363
def new_orphan(self, trans_id, parent_id):
1364
# FIXME: There is no tree config, so we use the branch one (it's weird
1365
# to define it this way as orphaning can only occur in a working tree,
1366
# but that's all we have (for now). It will find the option in
1367
# locations.conf or bazaar.conf though) -- vila 20100916
1368
conf = self._tree.branch.get_config()
1369
conf_var_name = 'bzr.transform.orphan_policy'
1370
orphan_policy = conf.get_user_option(conf_var_name)
1371
default_policy = orphaning_registry.default_key
1372
if orphan_policy is None:
1373
orphan_policy = default_policy
1374
if orphan_policy not in orphaning_registry:
1375
trace.warning('%s (from %s) is not a known policy, defaulting to %s'
1376
% (orphan_policy, conf_var_name, default_policy))
1377
orphan_policy = default_policy
1378
handle_orphan = orphaning_registry.get(orphan_policy)
1379
handle_orphan(self, trans_id, parent_id)
1382
class OrphaningError(errors.BzrError):
1384
# Only bugs could lead to such exception being seen by the user
1385
internal_error = True
1386
_fmt = "Error while orphaning %s in %s directory"
1388
def __init__(self, orphan, parent):
1389
errors.BzrError.__init__(self)
1390
self.orphan = orphan
1391
self.parent = parent
1394
class OrphaningForbidden(OrphaningError):
1396
_fmt = "Policy: %s doesn't allow creating orphans."
1398
def __init__(self, policy):
1399
errors.BzrError.__init__(self)
1400
self.policy = policy
1403
def move_orphan(tt, orphan_id, parent_id):
1404
"""See TreeTransformBase.new_orphan.
1406
This creates a new orphan in the `bzr-orphans` dir at the root of the
1409
:param tt: The TreeTransform orphaning `trans_id`.
1411
:param orphan_id: The trans id that should be orphaned.
1413
:param parent_id: The orphan parent trans id.
1415
# Add the orphan dir if it doesn't exist
1416
orphan_dir_basename = 'bzr-orphans'
1417
od_id = tt.trans_id_tree_path(orphan_dir_basename)
1418
if tt.final_kind(od_id) is None:
1419
tt.create_directory(od_id)
1420
parent_path = tt._tree_id_paths[parent_id]
1421
# Find a name that doesn't exist yet in the orphan dir
1422
actual_name = tt.final_name(orphan_id)
1423
new_name = tt._available_backup_name(actual_name, od_id)
1424
tt.adjust_path(new_name, od_id, orphan_id)
1425
trace.warning('%s has been orphaned in %s'
1426
% (joinpath(parent_path, actual_name), orphan_dir_basename))
1429
def refuse_orphan(tt, orphan_id, parent_id):
1430
"""See TreeTransformBase.new_orphan.
1432
This refuses to create orphan, letting the caller handle the conflict.
1434
raise OrphaningForbidden('never')
1437
orphaning_registry = registry.Registry()
1438
orphaning_registry.register(
1439
'conflict', refuse_orphan,
1440
'Leave orphans in place and create a conflict on the directory.')
1441
orphaning_registry.register(
1442
'move', move_orphan,
1443
'Move orphans into the bzr-orphans directory.')
1444
orphaning_registry._set_default_key('conflict')
1278
1447
class TreeTransform(DiskTreeTransform):
1279
1448
"""Represent a tree transformation.
1397
1566
def tree_kind(self, trans_id):
1398
1567
"""Determine the file kind in the working tree.
1400
Raises NoSuchFile if the file does not exist
1569
:returns: The file kind or None if the file does not exist
1402
1571
path = self._tree_id_paths.get(trans_id)
1403
1572
if path is None:
1404
raise NoSuchFile(None)
1406
1575
return file_kind(self._tree.abspath(path))
1408
if e.errno != errno.ENOENT:
1411
raise NoSuchFile(path)
1576
except errors.NoSuchFile:
1413
1579
def _set_mode(self, trans_id, mode_id, typefunc):
1414
1580
"""Set the mode of new file contents.
1666
1832
if trans_id in self._needs_rename:
1668
1834
mover.rename(self._limbo_name(trans_id), full_path)
1835
except errors.TransformRenameFailed, e:
1670
1836
# We may be renaming a dangling inventory id
1671
1837
if e.errno != errno.ENOENT:
1674
1840
self.rename_count += 1
1841
# TODO: if trans_id in self._observed_sha1s, we should
1842
# re-stat the final target, since ctime will be
1843
# updated by the change.
1675
1844
if (trans_id in self._new_contents or
1676
1845
self.path_changed(trans_id)):
1677
1846
if trans_id in self._new_contents:
1678
1847
modified_paths.append(full_path)
1679
1848
if trans_id in self._new_executability:
1680
1849
self._set_executability(path, trans_id)
1850
if trans_id in self._observed_sha1s:
1851
o_sha1, o_st_val = self._observed_sha1s[trans_id]
1852
st = osutils.lstat(full_path)
1853
self._observed_sha1s[trans_id] = (o_sha1, st)
1682
1855
child_pb.finished()
1683
1856
self._new_contents.clear()
1684
1857
return modified_paths
1859
def _apply_observed_sha1s(self):
1860
"""After we have finished renaming everything, update observed sha1s
1862
This has to be done after self._tree.apply_inventory_delta, otherwise
1863
it doesn't know anything about the files we are updating. Also, we want
1864
to do this as late as possible, so that most entries end up cached.
1866
# TODO: this doesn't update the stat information for directories. So
1867
# the first 'bzr status' will still need to rewrite
1868
# .bzr/checkout/dirstate. However, we at least don't need to
1869
# re-read all of the files.
1870
# TODO: If the operation took a while, we could do a time.sleep(3) here
1871
# to allow the clock to tick over and ensure we won't have any
1872
# problems. (we could observe start time, and finish time, and if
1873
# it is less than eg 10% overhead, add a sleep call.)
1874
paths = FinalPaths(self)
1875
for trans_id, observed in self._observed_sha1s.iteritems():
1876
path = paths.get_path(trans_id)
1877
# We could get the file_id, but dirstate prefers to use the path
1878
# anyway, and it is 'cheaper' to determine.
1879
# file_id = self._new_id[trans_id]
1880
self._tree._observed_sha1(None, path, observed)
1687
1883
class TransformPreview(DiskTreeTransform):
1688
1884
"""A TreeTransform for generating preview trees.
2266
2470
for num, _unused in enumerate(wt.all_file_ids()):
2267
2471
if num > 0: # more than just a root
2268
2472
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
2473
file_trans_id = {}
2273
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2474
top_pb = ui.ui_factory.nested_progress_bar()
2274
2475
pp = ProgressPhase("Build phase", 2, top_pb)
2275
2476
if tree.inventory.root is not None:
2276
2477
# This is kind of a hack: we should be altering the root
2298
2499
precomputed_delta = []
2300
2501
precomputed_delta = None
2502
# Check if tree inventory has content. If so, we populate
2503
# existing_files with the directory content. If there are no
2504
# entries we skip populating existing_files as its not used.
2505
# This improves performance and unncessary work on large
2506
# directory trees. (#501307)
2508
existing_files = set()
2509
for dir, files in wt.walkdirs():
2510
existing_files.update(f[0] for f in files)
2301
2511
for num, (tree_path, entry) in \
2302
2512
enumerate(tree.inventory.iter_entries_by_dir()):
2303
2513
pb.update("Building tree", num - len(deferred_contents), total)
2423
2633
for child in tt.iter_tree_children(old_parent):
2424
2634
tt.adjust_path(tt.final_name(child), new_parent, child)
2426
2637
def _reparent_transform_children(tt, old_parent, new_parent):
2427
2638
by_parent = tt.by_parent()
2428
2639
for child in by_parent[old_parent]:
2429
2640
tt.adjust_path(tt.final_name(child), new_parent, child)
2430
2641
return by_parent[old_parent]
2432
2644
def _content_match(tree, entry, file_id, kind, target_path):
2433
2645
if entry.kind != kind:
2435
2647
if entry.kind == "directory":
2437
2649
if entry.kind == "file":
2438
if tree.get_file(file_id).read() == file(target_path, 'rb').read():
2650
f = file(target_path, 'rb')
2652
if tree.get_file_text(file_id) == f.read():
2440
2656
elif entry.kind == "symlink":
2441
2657
if tree.get_symlink_target(file_id) == os.readlink(target_path):
2494
2710
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
2713
def create_from_tree(tt, trans_id, tree, file_id, bytes=None,
2514
2714
filter_tree_path=None):
2515
2715
"""Create new file contents according to tree contents.
2546
2746
tt.set_executability(entry.executable, trans_id)
2749
@deprecated_function(deprecated_in((2, 3, 0)))
2549
2750
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2550
2751
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2754
@deprecated_function(deprecated_in((2, 3, 0)))
2553
2755
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2554
2756
"""Produce a backup-style name that appears to be available"""
2555
2757
def name_gen():
2676
2878
tt.delete_contents(trans_id)
2677
2879
elif kind[1] is not None:
2678
2880
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)
2881
backup_name = tt._available_backup_name(
2882
name[0], parent_trans_id)
2682
2883
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2683
2884
new_trans_id = tt.create_path(name[0], parent_trans_id)
2684
2885
if versioned == (True, True):
2808
3009
elif c_type == 'missing parent':
2809
3010
trans_id = conflict[1]
2811
tt.cancel_deletion(trans_id)
2812
new_conflicts.add(('deleting parent', 'Not deleting',
3011
if trans_id in tt._removed_contents:
3012
cancel_deletion = True
3013
orphans = tt._get_potential_orphans(trans_id)
3015
cancel_deletion = False
3016
# All children are orphans
3019
tt.new_orphan(o, trans_id)
3020
except OrphaningError:
3021
# Something bad happened so we cancel the directory
3022
# deletion which will leave it in place with a
3023
# conflict. The user can deal with it from there.
3024
# Note that this also catch the case where we don't
3025
# want to create orphans and leave the directory in
3027
cancel_deletion = True
3030
# Cancel the directory deletion
3031
tt.cancel_deletion(trans_id)
3032
new_conflicts.add(('deleting parent', 'Not deleting',
2817
3037
tt.final_name(trans_id)
2900
3121
def rename(self, from_, to):
2901
3122
"""Rename a file from one path to another."""
2903
osutils.rename(from_, to)
3124
os.rename(from_, to)
2904
3125
except OSError, e:
2905
3126
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
2906
3127
raise errors.FileExists(to, str(e))
3128
# normal OSError doesn't include filenames so it's hard to see where
3129
# the problem is, see https://bugs.launchpad.net/bzr/+bug/491763
3130
raise errors.TransformRenameFailed(from_, to, str(e), e.errno)
2908
3131
self.past_renames.append((from_, to))
2910
3133
def pre_delete(self, from_, to):
added
removed
bzrlib/transform.py
