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)
392
388
changed_kind = set(self._removed_contents)
393
389
changed_kind.intersection_update(self._new_contents)
394
390
changed_kind.difference_update(new_ids)
395
changed_kind = (t for t in changed_kind
396
if self.tree_kind(t) != self.final_kind(t))
391
changed_kind = (t for t in changed_kind if self.tree_kind(t) !=
397
393
new_ids.update(changed_kind)
398
394
return sorted(FinalPaths(self).get_paths(new_ids))
400
396
def final_kind(self, trans_id):
401
397
"""Determine the final file kind, after any changes applied.
403
:return: None if the file does not exist/has no contents. (It is
404
conceivable that a path would be created without the corresponding
405
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)
407
403
if trans_id in self._new_contents:
408
404
return self._new_contents[trans_id]
409
405
elif trans_id in self._removed_contents:
406
raise NoSuchFile(None)
412
408
return self.tree_kind(trans_id)
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
644
if (self._new_name, self._new_parent) == ({}, {}):
668
646
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))
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]
679
652
last_trans_id = None
680
653
for name, trans_id in name_ids:
681
kind = self.final_kind(trans_id)
655
kind = self.final_kind(trans_id)
682
658
file_id = self.final_file_id(trans_id)
683
659
if kind is None and file_id is None:
705
681
def _parent_type_conflicts(self, by_parent):
706
"""Children must have a directory parent"""
682
"""parents must have directory 'contents'."""
708
684
for parent_id, children in by_parent.iteritems():
709
685
if parent_id is ROOT_PARENT:
712
for child_id in children:
713
if self.final_kind(child_id) is not None:
687
if not self._any_contents(children):
718
# There is at least a child, so we need an existing directory to
720
kind = self.final_kind(parent_id)
689
for child in children:
691
self.final_kind(child)
695
kind = self.final_kind(parent_id)
722
# The directory will be deleted
723
699
conflicts.append(('missing parent', parent_id))
724
700
elif kind != "directory":
725
# Meh, we need a *directory* to put something in it
726
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)
729
714
def _set_executability(self, path, trans_id):
730
715
"""Set the executability of versioned files """
731
716
if supports_executable():
795
780
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
783
def _affected_ids(self):
841
784
"""Return the set of transform ids affected by the transform"""
842
785
trans_ids = set(self._removed_id)
982
928
return _PreviewTree(self)
984
def commit(self, branch, message, merge_parents=None, strict=False,
985
timestamp=None, timezone=None, committer=None, authors=None,
986
revprops=None, revision_id=None):
930
def commit(self, branch, message, merge_parents=None, strict=False):
987
931
"""Commit the result of this TreeTransform to a branch.
989
933
:param branch: The branch to commit to.
990
934
:param message: The message to attach to the commit.
991
:param merge_parents: Additional parent revision-ids specified by
993
:param strict: If True, abort the commit if there are unversioned
995
:param timestamp: if not None, seconds-since-epoch for the time and
996
date. (May be a float.)
997
:param timezone: Optional timezone for timestamp, as an offset in
999
:param committer: Optional committer in email-id format.
1000
(e.g. "J Random Hacker <jrandom@example.com>")
1001
:param authors: Optional list of authors in email-id format.
1002
:param revprops: Optional dictionary of revision properties.
1003
:param revision_id: Optional revision id. (Specifying a revision-id
1004
may reduce performance for some non-native formats.)
935
:param merge_parents: Additional parents specified by pending merges.
1005
936
:return: The revision_id of the revision committed.
1007
938
self._check_malformed()
1248
1173
descendants.update(self._limbo_descendants(descendant))
1249
1174
return descendants
1251
def create_file(self, contents, trans_id, mode_id=None, sha1=None):
1176
def create_file(self, contents, trans_id, mode_id=None):
1252
1177
"""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.
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.
1265
1187
name = self._limbo_name(trans_id)
1266
1188
f = open(name, 'wb')
1358
1274
del self._limbo_children_names[trans_id]
1359
1275
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
1278
class TreeTransform(DiskTreeTransform):
1446
1279
"""Represent a tree transformation.
1564
1397
def tree_kind(self, trans_id):
1565
1398
"""Determine the file kind in the working tree.
1567
:returns: The file kind or None if the file does not exist
1400
Raises NoSuchFile if the file does not exist
1569
1402
path = self._tree_id_paths.get(trans_id)
1570
1403
if path is None:
1404
raise NoSuchFile(None)
1573
1406
return file_kind(self._tree.abspath(path))
1574
except errors.NoSuchFile:
1408
if e.errno != errno.ENOENT:
1411
raise NoSuchFile(path)
1577
1413
def _set_mode(self, trans_id, mode_id, typefunc):
1578
1414
"""Set the mode of new file contents.
1830
1666
if trans_id in self._needs_rename:
1832
1668
mover.rename(self._limbo_name(trans_id), full_path)
1833
except errors.TransformRenameFailed, e:
1834
1670
# We may be renaming a dangling inventory id
1835
1671
if e.errno != errno.ENOENT:
1838
1674
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
1675
if (trans_id in self._new_contents or
1843
1676
self.path_changed(trans_id)):
1844
1677
if trans_id in self._new_contents:
1845
1678
modified_paths.append(full_path)
1846
1679
if trans_id in self._new_executability:
1847
1680
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
1682
child_pb.finished()
1854
1683
self._new_contents.clear()
1855
1684
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
1687
class TransformPreview(DiskTreeTransform):
1882
1688
"""A TreeTransform for generating preview trees.
1967
1767
yield self._get_repository().revision_tree(revision_id)
1969
1769
def _get_file_revision(self, file_id, vf, tree_revision):
1970
parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
1770
parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
1971
1771
self._iter_parent_trees()]
1972
1772
vf.add_lines((file_id, tree_revision), parent_keys,
1973
self.get_file_lines(file_id))
1773
self.get_file(file_id).readlines())
1974
1774
repo = self._get_repository()
1975
1775
base_vf = repo.texts
1976
1776
if base_vf not in vf.fallback_versionedfiles:
2468
2266
for num, _unused in enumerate(wt.all_file_ids()):
2469
2267
if num > 0: # more than just a root
2470
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)
2471
2272
file_trans_id = {}
2472
top_pb = ui.ui_factory.nested_progress_bar()
2273
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2473
2274
pp = ProgressPhase("Build phase", 2, top_pb)
2474
2275
if tree.inventory.root is not None:
2475
2276
# This is kind of a hack: we should be altering the root
2497
2298
precomputed_delta = []
2499
2300
precomputed_delta = None
2500
# Check if tree inventory has content. If so, we populate
2501
# existing_files with the directory content. If there are no
2502
# entries we skip populating existing_files as its not used.
2503
# This improves performance and unncessary work on large
2504
# directory trees. (#501307)
2506
existing_files = set()
2507
for dir, files in wt.walkdirs():
2508
existing_files.update(f[0] for f in files)
2509
2301
for num, (tree_path, entry) in \
2510
2302
enumerate(tree.inventory.iter_entries_by_dir()):
2511
2303
pb.update("Building tree", num - len(deferred_contents), total)
2592
2384
unchanged = dict(unchanged)
2593
2385
new_desired_files = []
2595
for file_id, (trans_id, tree_path, text_sha1) in desired_files:
2387
for file_id, (trans_id, tree_path) in desired_files:
2596
2388
accelerator_path = unchanged.get(file_id)
2597
2389
if accelerator_path is None:
2598
new_desired_files.append((file_id,
2599
(trans_id, tree_path, text_sha1)))
2390
new_desired_files.append((file_id, (trans_id, tree_path)))
2601
2392
pb.update('Adding file contents', count + offset, total)
2620
2411
offset += count
2621
for count, ((trans_id, tree_path, text_sha1), contents) in enumerate(
2412
for count, ((trans_id, tree_path), contents) in enumerate(
2622
2413
tree.iter_files_bytes(new_desired_files)):
2623
2414
if wt.supports_content_filtering():
2624
2415
filters = wt._content_filter_stack(tree_path)
2625
2416
contents = filtered_output_bytes(contents, filters,
2626
2417
ContentFilterContext(tree_path, tree))
2627
tt.create_file(contents, trans_id, sha1=text_sha1)
2418
tt.create_file(contents, trans_id)
2628
2419
pb.update('Adding file contents', count + offset, total)
2632
2423
for child in tt.iter_tree_children(old_parent):
2633
2424
tt.adjust_path(tt.final_name(child), new_parent, child)
2636
2426
def _reparent_transform_children(tt, old_parent, new_parent):
2637
2427
by_parent = tt.by_parent()
2638
2428
for child in by_parent[old_parent]:
2639
2429
tt.adjust_path(tt.final_name(child), new_parent, child)
2640
2430
return by_parent[old_parent]
2643
2432
def _content_match(tree, entry, file_id, kind, target_path):
2644
2433
if entry.kind != kind:
2646
2435
if entry.kind == "directory":
2648
2437
if entry.kind == "file":
2649
f = file(target_path, 'rb')
2651
if tree.get_file_text(file_id) == f.read():
2438
if tree.get_file(file_id).read() == file(target_path, 'rb').read():
2655
2440
elif entry.kind == "symlink":
2656
2441
if tree.get_symlink_target(file_id) == os.readlink(target_path):
2709
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)
2712
2513
def create_from_tree(tt, trans_id, tree, file_id, bytes=None,
2713
2514
filter_tree_path=None):
2714
2515
"""Create new file contents according to tree contents.
2745
2546
tt.set_executability(entry.executable, trans_id)
2748
@deprecated_function(deprecated_in((2, 3, 0)))
2749
2549
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2750
2550
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2753
@deprecated_function(deprecated_in((2, 3, 0)))
2754
2553
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2755
2554
"""Produce a backup-style name that appears to be available"""
2756
2555
def name_gen():
2877
2676
tt.delete_contents(trans_id)
2878
2677
elif kind[1] is not None:
2879
2678
parent_trans_id = tt.trans_id_file_id(parent[0])
2880
backup_name = tt._available_backup_name(
2881
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)
2882
2682
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2883
2683
new_trans_id = tt.create_path(name[0], parent_trans_id)
2884
2684
if versioned == (True, True):
3008
2808
elif c_type == 'missing parent':
3009
2809
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',
2811
tt.cancel_deletion(trans_id)
2812
new_conflicts.add(('deleting parent', 'Not deleting',
3036
2817
tt.final_name(trans_id)
3121
2900
def rename(self, from_, to):
3122
2901
"""Rename a file from one path to another."""
3124
os.rename(from_, to)
2903
osutils.rename(from_, to)
3125
2904
except OSError, e:
3126
2905
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
3127
2906
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)
3131
2908
self.past_renames.append((from_, to))
3133
2910
def pre_delete(self, from_, to):
added
removed
bzrlib/transform.py
