33
40
revision as _mod_revision,
37
45
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
38
ReusingTransform, NotVersionedError, CantMoveRoot,
46
ReusingTransform, CantMoveRoot,
39
47
ExistingLimbo, ImmortalLimbo, NoFinalPath,
40
48
UnableCreateSymlink)
41
49
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
42
from bzrlib.inventory import InventoryEntry
43
50
from bzrlib.osutils import (
51
57
supports_executable,
53
59
from bzrlib.progress import ProgressPhase
54
60
from bzrlib.symbol_versioning import (
58
from bzrlib.trace import mutter, warning
59
from bzrlib import tree
61
import bzrlib.urlutils as urlutils
64
67
ROOT_PARENT = "root-parent"
67
69
def unique_add(map, key, value):
69
71
raise DuplicateKey(key=key)
73
76
class _TransformResults(object):
74
77
def __init__(self, modified_paths, rename_count):
75
78
object.__init__(self)
388
392
changed_kind = set(self._removed_contents)
389
393
changed_kind.intersection_update(self._new_contents)
390
394
changed_kind.difference_update(new_ids)
391
changed_kind = (t for t in changed_kind if self.tree_kind(t) !=
395
changed_kind = (t for t in changed_kind
396
if self.tree_kind(t) != self.final_kind(t))
393
397
new_ids.update(changed_kind)
394
398
return sorted(FinalPaths(self).get_paths(new_ids))
396
400
def final_kind(self, trans_id):
397
401
"""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)
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)
403
407
if trans_id in self._new_contents:
404
408
return self._new_contents[trans_id]
405
409
elif trans_id in self._removed_contents:
406
raise NoSuchFile(None)
408
412
return self.tree_kind(trans_id)
531
537
# ensure that all children are registered with the transaction
532
538
list(self.iter_tree_children(parent_id))
540
@deprecated_method(deprecated_in((2, 3, 0)))
534
541
def has_named_child(self, by_parent, parent_id, name):
536
children = by_parent[parent_id]
539
for child in children:
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:
540
559
if self.final_name(child) == name:
543
path = self._tree_id_paths[parent_id]
561
parent_path = self._tree_id_paths.get(parent_id, None)
562
if parent_path is None:
563
# No parent... no children
546
childpath = joinpath(path, name)
547
child_id = self._tree_path_ids.get(childpath)
565
child_path = joinpath(parent_path, name)
566
child_id = self._tree_path_ids.get(child_path, None)
548
567
if child_id is None:
549
return lexists(self._tree.abspath(childpath))
568
# Not known by the tree transform yet, check the filesystem
569
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?
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))
559
588
def _parent_loops(self):
560
589
"""No entry should be its own ancestor"""
644
666
if (self._new_name, self._new_parent) == ({}, {}):
646
668
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]
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))
652
679
last_trans_id = None
653
680
for name, trans_id in name_ids:
655
kind = self.final_kind(trans_id)
681
kind = self.final_kind(trans_id)
658
682
file_id = self.final_file_id(trans_id)
659
683
if kind is None and file_id is None:
681
705
def _parent_type_conflicts(self, by_parent):
682
"""parents must have directory 'contents'."""
706
"""Children must have a directory parent"""
684
708
for parent_id, children in by_parent.iteritems():
685
709
if parent_id is ROOT_PARENT:
687
if not self._any_contents(children):
712
for child_id in children:
713
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)
718
# There is at least a child, so we need an existing directory to
720
kind = self.final_kind(parent_id)
722
# The directory will be deleted
699
723
conflicts.append(('missing parent', parent_id))
700
724
elif kind != "directory":
725
# Meh, we need a *directory* to put something in it
701
726
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
729
def _set_executability(self, path, trans_id):
715
730
"""Set the executability of versioned files """
716
731
if supports_executable():
780
795
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
783
840
def _affected_ids(self):
784
841
"""Return the set of transform ids affected by the transform"""
785
842
trans_ids = set(self._removed_id)
928
982
return _PreviewTree(self)
930
def commit(self, branch, message, merge_parents=None, strict=False):
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):
931
987
"""Commit the result of this TreeTransform to a branch.
933
989
:param branch: The branch to commit to.
934
990
:param message: The message to attach to the commit.
935
:param merge_parents: Additional parents specified by pending merges.
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.)
936
1005
:return: The revision_id of the revision committed.
938
1007
self._check_malformed()
1173
1248
descendants.update(self._limbo_descendants(descendant))
1174
1249
return descendants
1176
def create_file(self, contents, trans_id, mode_id=None):
1251
def create_file(self, contents, trans_id, mode_id=None, sha1=None):
1177
1252
"""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.
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.
1187
1265
name = self._limbo_name(trans_id)
1188
1266
f = open(name, 'wb')
1274
1358
del self._limbo_children_names[trans_id]
1275
1359
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')
1278
1445
class TreeTransform(DiskTreeTransform):
1279
1446
"""Represent a tree transformation.
1397
1564
def tree_kind(self, trans_id):
1398
1565
"""Determine the file kind in the working tree.
1400
Raises NoSuchFile if the file does not exist
1567
:returns: The file kind or None if the file does not exist
1402
1569
path = self._tree_id_paths.get(trans_id)
1403
1570
if path is None:
1404
raise NoSuchFile(None)
1406
1573
return file_kind(self._tree.abspath(path))
1408
if e.errno != errno.ENOENT:
1411
raise NoSuchFile(path)
1574
except errors.NoSuchFile:
1413
1577
def _set_mode(self, trans_id, mode_id, typefunc):
1414
1578
"""Set the mode of new file contents.
1666
1830
if trans_id in self._needs_rename:
1668
1832
mover.rename(self._limbo_name(trans_id), full_path)
1833
except errors.TransformRenameFailed, e:
1670
1834
# We may be renaming a dangling inventory id
1671
1835
if e.errno != errno.ENOENT:
1674
1838
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.
1675
1842
if (trans_id in self._new_contents or
1676
1843
self.path_changed(trans_id)):
1677
1844
if trans_id in self._new_contents:
1678
1845
modified_paths.append(full_path)
1679
1846
if trans_id in self._new_executability:
1680
1847
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)
1682
1853
child_pb.finished()
1683
1854
self._new_contents.clear()
1684
1855
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)
1687
1881
class TransformPreview(DiskTreeTransform):
1688
1882
"""A TreeTransform for generating preview trees.
1767
1967
yield self._get_repository().revision_tree(revision_id)
1769
1969
def _get_file_revision(self, file_id, vf, tree_revision):
1770
parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
1970
parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
1771
1971
self._iter_parent_trees()]
1772
1972
vf.add_lines((file_id, tree_revision), parent_keys,
1773
self.get_file(file_id).readlines())
1973
self.get_file_lines(file_id))
1774
1974
repo = self._get_repository()
1775
1975
base_vf = repo.texts
1776
1976
if base_vf not in vf.fallback_versionedfiles:
2266
2468
for num, _unused in enumerate(wt.all_file_ids()):
2267
2469
if num > 0: # more than just a root
2268
2470
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
2471
file_trans_id = {}
2273
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2472
top_pb = ui.ui_factory.nested_progress_bar()
2274
2473
pp = ProgressPhase("Build phase", 2, top_pb)
2275
2474
if tree.inventory.root is not None:
2276
2475
# This is kind of a hack: we should be altering the root
2298
2497
precomputed_delta = []
2300
2499
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)
2301
2509
for num, (tree_path, entry) in \
2302
2510
enumerate(tree.inventory.iter_entries_by_dir()):
2303
2511
pb.update("Building tree", num - len(deferred_contents), total)
2384
2592
unchanged = dict(unchanged)
2385
2593
new_desired_files = []
2387
for file_id, (trans_id, tree_path) in desired_files:
2595
for file_id, (trans_id, tree_path, text_sha1) in desired_files:
2388
2596
accelerator_path = unchanged.get(file_id)
2389
2597
if accelerator_path is None:
2390
new_desired_files.append((file_id, (trans_id, tree_path)))
2598
new_desired_files.append((file_id,
2599
(trans_id, tree_path, text_sha1)))
2392
2601
pb.update('Adding file contents', count + offset, total)
2411
2620
offset += count
2412
for count, ((trans_id, tree_path), contents) in enumerate(
2621
for count, ((trans_id, tree_path, text_sha1), contents) in enumerate(
2413
2622
tree.iter_files_bytes(new_desired_files)):
2414
2623
if wt.supports_content_filtering():
2415
2624
filters = wt._content_filter_stack(tree_path)
2416
2625
contents = filtered_output_bytes(contents, filters,
2417
2626
ContentFilterContext(tree_path, tree))
2418
tt.create_file(contents, trans_id)
2627
tt.create_file(contents, trans_id, sha1=text_sha1)
2419
2628
pb.update('Adding file contents', count + offset, total)
2423
2632
for child in tt.iter_tree_children(old_parent):
2424
2633
tt.adjust_path(tt.final_name(child), new_parent, child)
2426
2636
def _reparent_transform_children(tt, old_parent, new_parent):
2427
2637
by_parent = tt.by_parent()
2428
2638
for child in by_parent[old_parent]:
2429
2639
tt.adjust_path(tt.final_name(child), new_parent, child)
2430
2640
return by_parent[old_parent]
2432
2643
def _content_match(tree, entry, file_id, kind, target_path):
2433
2644
if entry.kind != kind:
2435
2646
if entry.kind == "directory":
2437
2648
if entry.kind == "file":
2438
if tree.get_file(file_id).read() == file(target_path, 'rb').read():
2649
f = file(target_path, 'rb')
2651
if tree.get_file_text(file_id) == f.read():
2440
2655
elif entry.kind == "symlink":
2441
2656
if tree.get_symlink_target(file_id) == os.readlink(target_path):
2494
2709
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
2712
def create_from_tree(tt, trans_id, tree, file_id, bytes=None,
2514
2713
filter_tree_path=None):
2515
2714
"""Create new file contents according to tree contents.
2546
2745
tt.set_executability(entry.executable, trans_id)
2748
@deprecated_function(deprecated_in((2, 3, 0)))
2549
2749
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2550
2750
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2753
@deprecated_function(deprecated_in((2, 3, 0)))
2553
2754
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2554
2755
"""Produce a backup-style name that appears to be available"""
2555
2756
def name_gen():
2676
2877
tt.delete_contents(trans_id)
2677
2878
elif kind[1] is not None:
2678
2879
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)
2880
backup_name = tt._available_backup_name(
2881
name[0], parent_trans_id)
2682
2882
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2683
2883
new_trans_id = tt.create_path(name[0], parent_trans_id)
2684
2884
if versioned == (True, True):
2808
3008
elif c_type == 'missing parent':
2809
3009
trans_id = conflict[1]
2811
tt.cancel_deletion(trans_id)
2812
new_conflicts.add(('deleting parent', 'Not deleting',
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',
2817
3036
tt.final_name(trans_id)
2898
3119
self.pending_deletions = []
2900
3121
def rename(self, from_, to):
2901
"""Rename a file from one path to another. Functions like os.rename"""
3122
"""Rename a file from one path to another."""
2903
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
