395
426
def find_conflicts(self):
396
427
"""Find any violations of inventory or filesystem invariants"""
397
raise NotImplementedError(self.find_conflicts)
428
if self._done is True:
429
raise ReusingTransform()
431
# ensure all children of all existent parents are known
432
# all children of non-existent parents are known, by definition.
433
self._add_tree_children()
434
by_parent = self.by_parent()
435
conflicts.extend(self._unversioned_parents(by_parent))
436
conflicts.extend(self._parent_loops())
437
conflicts.extend(self._duplicate_entries(by_parent))
438
conflicts.extend(self._duplicate_ids())
439
conflicts.extend(self._parent_type_conflicts(by_parent))
440
conflicts.extend(self._improper_versioning())
441
conflicts.extend(self._executability_conflicts())
442
conflicts.extend(self._overwrite_conflicts())
445
def _check_malformed(self):
446
conflicts = self.find_conflicts()
447
if len(conflicts) != 0:
448
raise MalformedTransform(conflicts=conflicts)
450
def _add_tree_children(self):
451
"""Add all the children of all active parents to the known paths.
453
Active parents are those which gain children, and those which are
454
removed. This is a necessary first step in detecting conflicts.
456
parents = self.by_parent().keys()
457
parents.extend([t for t in self._removed_contents if
458
self.tree_kind(t) == 'directory'])
459
for trans_id in self._removed_id:
460
file_id = self.tree_file_id(trans_id)
461
if file_id is not None:
462
if self._tree.inventory[file_id].kind == 'directory':
463
parents.append(trans_id)
464
elif self.tree_kind(trans_id) == 'directory':
465
parents.append(trans_id)
467
for parent_id in parents:
468
# ensure that all children are registered with the transaction
469
list(self.iter_tree_children(parent_id))
471
def has_named_child(self, by_parent, parent_id, name):
473
children = by_parent[parent_id]
476
for child in children:
477
if self.final_name(child) == name:
480
path = self._tree_id_paths[parent_id]
483
childpath = joinpath(path, name)
484
child_id = self._tree_path_ids.get(childpath)
486
return lexists(self._tree.abspath(childpath))
488
if self.final_parent(child_id) != parent_id:
490
if child_id in self._removed_contents:
491
# XXX What about dangling file-ids?
496
def _parent_loops(self):
497
"""No entry should be its own ancestor"""
499
for trans_id in self._new_parent:
502
while parent_id is not ROOT_PARENT:
505
parent_id = self.final_parent(parent_id)
508
if parent_id == trans_id:
509
conflicts.append(('parent loop', trans_id))
510
if parent_id in seen:
514
def _unversioned_parents(self, by_parent):
515
"""If parent directories are versioned, children must be versioned."""
517
for parent_id, children in by_parent.iteritems():
518
if parent_id is ROOT_PARENT:
520
if self.final_file_id(parent_id) is not None:
522
for child_id in children:
523
if self.final_file_id(child_id) is not None:
524
conflicts.append(('unversioned parent', parent_id))
528
def _improper_versioning(self):
529
"""Cannot version a file with no contents, or a bad type.
531
However, existing entries with no contents are okay.
534
for trans_id in self._new_id.iterkeys():
536
kind = self.final_kind(trans_id)
538
conflicts.append(('versioning no contents', trans_id))
540
if not InventoryEntry.versionable_kind(kind):
541
conflicts.append(('versioning bad kind', trans_id, kind))
544
def _executability_conflicts(self):
545
"""Check for bad executability changes.
547
Only versioned files may have their executability set, because
548
1. only versioned entries can have executability under windows
549
2. only files can be executable. (The execute bit on a directory
550
does not indicate searchability)
553
for trans_id in self._new_executability:
554
if self.final_file_id(trans_id) is None:
555
conflicts.append(('unversioned executability', trans_id))
558
non_file = self.final_kind(trans_id) != "file"
562
conflicts.append(('non-file executability', trans_id))
565
def _overwrite_conflicts(self):
566
"""Check for overwrites (not permitted on Win32)"""
568
for trans_id in self._new_contents:
570
self.tree_kind(trans_id)
573
if trans_id not in self._removed_contents:
574
conflicts.append(('overwrite', trans_id,
575
self.final_name(trans_id)))
578
def _duplicate_entries(self, by_parent):
579
"""No directory may have two entries with the same name."""
581
if (self._new_name, self._new_parent) == ({}, {}):
583
for children in by_parent.itervalues():
584
name_ids = [(self.final_name(t), t) for t in children]
585
if not self._case_sensitive_target:
586
name_ids = [(n.lower(), t) for n, t in name_ids]
590
for name, trans_id in name_ids:
592
kind = self.final_kind(trans_id)
595
file_id = self.final_file_id(trans_id)
596
if kind is None and file_id is None:
598
if name == last_name:
599
conflicts.append(('duplicate', last_trans_id, trans_id,
602
last_trans_id = trans_id
605
def _duplicate_ids(self):
606
"""Each inventory id may only be used once"""
608
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
610
all_ids = self._tree.all_file_ids()
611
active_tree_ids = all_ids.difference(removed_tree_ids)
612
for trans_id, file_id in self._new_id.iteritems():
613
if file_id in active_tree_ids:
614
old_trans_id = self.trans_id_tree_file_id(file_id)
615
conflicts.append(('duplicate id', old_trans_id, trans_id))
618
def _parent_type_conflicts(self, by_parent):
619
"""parents must have directory 'contents'."""
621
for parent_id, children in by_parent.iteritems():
622
if parent_id is ROOT_PARENT:
624
if not self._any_contents(children):
626
for child in children:
628
self.final_kind(child)
632
kind = self.final_kind(parent_id)
636
conflicts.append(('missing parent', parent_id))
637
elif kind != "directory":
638
conflicts.append(('non-directory parent', parent_id))
641
def _any_contents(self, trans_ids):
642
"""Return true if any of the trans_ids, will have contents."""
643
for trans_id in trans_ids:
645
kind = self.final_kind(trans_id)
651
def _set_executability(self, path, trans_id):
652
"""Set the executability of versioned files """
653
if supports_executable():
654
new_executability = self._new_executability[trans_id]
655
abspath = self._tree.abspath(path)
656
current_mode = os.stat(abspath).st_mode
657
if new_executability:
660
to_mode = current_mode | (0100 & ~umask)
661
# Enable x-bit for others only if they can read it.
662
if current_mode & 0004:
663
to_mode |= 0001 & ~umask
664
if current_mode & 0040:
665
to_mode |= 0010 & ~umask
667
to_mode = current_mode & ~0111
668
os.chmod(abspath, to_mode)
670
def _new_entry(self, name, parent_id, file_id):
671
"""Helper function to create a new filesystem entry."""
672
trans_id = self.create_path(name, parent_id)
673
if file_id is not None:
674
self.version_file(file_id, trans_id)
399
677
def new_file(self, name, parent_id, contents, file_id=None,
400
executable=None, sha1=None):
401
679
"""Convenience method to create files.
403
681
name is the name of the file to create.
450
804
file_id. Files that are not versioned in either of the FROM or TO
451
805
states are not reflected.
453
raise NotImplementedError(self.iter_changes)
807
final_paths = FinalPaths(self)
808
from_trans_ids, to_trans_ids = self._get_file_id_maps()
810
# Now iterate through all active file_ids
811
for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
813
from_trans_id = from_trans_ids.get(file_id)
814
# find file ids, and determine versioning state
815
if from_trans_id is None:
816
from_versioned = False
817
from_trans_id = to_trans_ids[file_id]
819
from_versioned = True
820
to_trans_id = to_trans_ids.get(file_id)
821
if to_trans_id is None:
823
to_trans_id = from_trans_id
827
from_name, from_parent, from_kind, from_executable = \
828
self._from_file_data(from_trans_id, from_versioned, file_id)
830
to_name, to_parent, to_kind, to_executable = \
831
self._to_file_data(to_trans_id, from_trans_id, from_executable)
833
if not from_versioned:
836
from_path = self._tree_id_paths.get(from_trans_id)
840
to_path = final_paths.get_path(to_trans_id)
841
if from_kind != to_kind:
843
elif to_kind in ('file', 'symlink') and (
844
to_trans_id != from_trans_id or
845
to_trans_id in self._new_contents):
847
if (not modified and from_versioned == to_versioned and
848
from_parent==to_parent and from_name == to_name and
849
from_executable == to_executable):
851
results.append((file_id, (from_path, to_path), modified,
852
(from_versioned, to_versioned),
853
(from_parent, to_parent),
854
(from_name, to_name),
855
(from_kind, to_kind),
856
(from_executable, to_executable)))
857
return iter(sorted(results, key=lambda x:x[1]))
455
859
def get_preview_tree(self):
456
860
"""Return a tree representing the result of the transform.
458
The tree is a snapshot, and altering the TreeTransform will invalidate
862
This tree only supports the subset of Tree functionality required
863
by show_diff_trees. It must only be compared to tt._tree.
461
raise NotImplementedError(self.get_preview_tree)
865
return _PreviewTree(self)
463
def commit(self, branch, message, merge_parents=None, strict=False,
464
timestamp=None, timezone=None, committer=None, authors=None,
465
revprops=None, revision_id=None):
867
def commit(self, branch, message, merge_parents=None, strict=False):
466
868
"""Commit the result of this TreeTransform to a branch.
468
870
:param branch: The branch to commit to.
469
871
:param message: The message to attach to the commit.
470
:param merge_parents: Additional parent revision-ids specified by
472
:param strict: If True, abort the commit if there are unversioned
474
:param timestamp: if not None, seconds-since-epoch for the time and
475
date. (May be a float.)
476
:param timezone: Optional timezone for timestamp, as an offset in
478
:param committer: Optional committer in email-id format.
479
(e.g. "J Random Hacker <jrandom@example.com>")
480
:param authors: Optional list of authors in email-id format.
481
:param revprops: Optional dictionary of revision properties.
482
:param revision_id: Optional revision id. (Specifying a revision-id
483
may reduce performance for some non-native formats.)
872
:param merge_parents: Additional parents specified by pending merges.
484
873
:return: The revision_id of the revision committed.
486
raise NotImplementedError(self.commit)
488
def create_file(self, contents, trans_id, mode_id=None, sha1=None):
875
self._check_malformed()
877
unversioned = set(self._new_contents).difference(set(self._new_id))
878
for trans_id in unversioned:
879
if self.final_file_id(trans_id) is None:
880
raise errors.StrictCommitFailed()
882
revno, last_rev_id = branch.last_revision_info()
883
if last_rev_id == _mod_revision.NULL_REVISION:
884
if merge_parents is not None:
885
raise ValueError('Cannot supply merge parents for first'
889
parent_ids = [last_rev_id]
890
if merge_parents is not None:
891
parent_ids.extend(merge_parents)
892
if self._tree.get_revision_id() != last_rev_id:
893
raise ValueError('TreeTransform not based on branch basis: %s' %
894
self._tree.get_revision_id())
895
builder = branch.get_commit_builder(parent_ids)
896
preview = self.get_preview_tree()
897
list(builder.record_iter_changes(preview, last_rev_id,
898
self.iter_changes()))
899
builder.finish_inventory()
900
revision_id = builder.commit(message)
901
branch.set_last_revision_info(revno + 1, revision_id)
904
def _text_parent(self, trans_id):
905
file_id = self.tree_file_id(trans_id)
907
if file_id is None or self._tree.kind(file_id) != 'file':
909
except errors.NoSuchFile:
913
def _get_parents_texts(self, trans_id):
914
"""Get texts for compression parents of this file."""
915
file_id = self._text_parent(trans_id)
918
return (self._tree.get_file_text(file_id),)
920
def _get_parents_lines(self, trans_id):
921
"""Get lines for compression parents of this file."""
922
file_id = self._text_parent(trans_id)
925
return (self._tree.get_file_lines(file_id),)
927
def serialize(self, serializer):
928
"""Serialize this TreeTransform.
930
:param serializer: A Serialiser like pack.ContainerSerializer.
932
new_name = dict((k, v.encode('utf-8')) for k, v in
933
self._new_name.items())
934
new_executability = dict((k, int(v)) for k, v in
935
self._new_executability.items())
936
tree_path_ids = dict((k.encode('utf-8'), v)
937
for k, v in self._tree_path_ids.items())
939
'_id_number': self._id_number,
940
'_new_name': new_name,
941
'_new_parent': self._new_parent,
942
'_new_executability': new_executability,
943
'_new_id': self._new_id,
944
'_tree_path_ids': tree_path_ids,
945
'_removed_id': list(self._removed_id),
946
'_removed_contents': list(self._removed_contents),
947
'_non_present_ids': self._non_present_ids,
949
yield serializer.bytes_record(bencode.bencode(attribs),
951
for trans_id, kind in self._new_contents.items():
953
lines = osutils.chunks_to_lines(
954
self._read_file_chunks(trans_id))
955
parents = self._get_parents_lines(trans_id)
956
mpdiff = multiparent.MultiParent.from_lines(lines, parents)
957
content = ''.join(mpdiff.to_patch())
958
if kind == 'directory':
960
if kind == 'symlink':
961
content = self._read_symlink_target(trans_id)
962
yield serializer.bytes_record(content, ((trans_id, kind),))
964
def deserialize(self, records):
965
"""Deserialize a stored TreeTransform.
967
:param records: An iterable of (names, content) tuples, as per
968
pack.ContainerPushParser.
970
names, content = records.next()
971
attribs = bencode.bdecode(content)
972
self._id_number = attribs['_id_number']
973
self._new_name = dict((k, v.decode('utf-8'))
974
for k, v in attribs['_new_name'].items())
975
self._new_parent = attribs['_new_parent']
976
self._new_executability = dict((k, bool(v)) for k, v in
977
attribs['_new_executability'].items())
978
self._new_id = attribs['_new_id']
979
self._r_new_id = dict((v, k) for k, v in self._new_id.items())
980
self._tree_path_ids = {}
981
self._tree_id_paths = {}
982
for bytepath, trans_id in attribs['_tree_path_ids'].items():
983
path = bytepath.decode('utf-8')
984
self._tree_path_ids[path] = trans_id
985
self._tree_id_paths[trans_id] = path
986
self._removed_id = set(attribs['_removed_id'])
987
self._removed_contents = set(attribs['_removed_contents'])
988
self._non_present_ids = attribs['_non_present_ids']
989
for ((trans_id, kind),), content in records:
991
mpdiff = multiparent.MultiParent.from_patch(content)
992
lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
993
self.create_file(lines, trans_id)
994
if kind == 'directory':
995
self.create_directory(trans_id)
996
if kind == 'symlink':
997
self.create_symlink(content.decode('utf-8'), trans_id)
1000
class DiskTreeTransform(TreeTransformBase):
1001
"""Tree transform storing its contents on disk."""
1003
def __init__(self, tree, limbodir, pb=DummyProgress(),
1004
case_sensitive=True):
1006
:param tree: The tree that will be transformed, but not necessarily
1008
:param limbodir: A directory where new files can be stored until
1009
they are installed in their proper places
1010
:param pb: A ProgressBar indicating how much progress is being made
1011
:param case_sensitive: If True, the target of the transform is
1012
case sensitive, not just case preserving.
1014
TreeTransformBase.__init__(self, tree, pb, case_sensitive)
1015
self._limbodir = limbodir
1016
self._deletiondir = None
1017
# A mapping of transform ids to their limbo filename
1018
self._limbo_files = {}
1019
# A mapping of transform ids to a set of the transform ids of children
1020
# that their limbo directory has
1021
self._limbo_children = {}
1022
# Map transform ids to maps of child filename to child transform id
1023
self._limbo_children_names = {}
1024
# List of transform ids that need to be renamed from limbo into place
1025
self._needs_rename = set()
1028
"""Release the working tree lock, if held, clean up limbo dir.
1030
This is required if apply has not been invoked, but can be invoked
1033
if self._tree is None:
1036
entries = [(self._limbo_name(t), t, k) for t, k in
1037
self._new_contents.iteritems()]
1038
entries.sort(reverse=True)
1039
for path, trans_id, kind in entries:
1042
delete_any(self._limbodir)
1044
# We don't especially care *why* the dir is immortal.
1045
raise ImmortalLimbo(self._limbodir)
1047
if self._deletiondir is not None:
1048
delete_any(self._deletiondir)
1050
raise errors.ImmortalPendingDeletion(self._deletiondir)
1052
TreeTransformBase.finalize(self)
1054
def _limbo_name(self, trans_id):
1055
"""Generate the limbo name of a file"""
1056
limbo_name = self._limbo_files.get(trans_id)
1057
if limbo_name is not None:
1059
parent = self._new_parent.get(trans_id)
1060
# if the parent directory is already in limbo (e.g. when building a
1061
# tree), choose a limbo name inside the parent, to reduce further
1063
use_direct_path = False
1064
if self._new_contents.get(parent) == 'directory':
1065
filename = self._new_name.get(trans_id)
1066
if filename is not None:
1067
if parent not in self._limbo_children:
1068
self._limbo_children[parent] = set()
1069
self._limbo_children_names[parent] = {}
1070
use_direct_path = True
1071
# the direct path can only be used if no other file has
1072
# already taken this pathname, i.e. if the name is unused, or
1073
# if it is already associated with this trans_id.
1074
elif self._case_sensitive_target:
1075
if (self._limbo_children_names[parent].get(filename)
1076
in (trans_id, None)):
1077
use_direct_path = True
1079
for l_filename, l_trans_id in\
1080
self._limbo_children_names[parent].iteritems():
1081
if l_trans_id == trans_id:
1083
if l_filename.lower() == filename.lower():
1086
use_direct_path = True
1089
limbo_name = pathjoin(self._limbo_files[parent], filename)
1090
self._limbo_children[parent].add(trans_id)
1091
self._limbo_children_names[parent][filename] = trans_id
1093
limbo_name = pathjoin(self._limbodir, trans_id)
1094
self._needs_rename.add(trans_id)
1095
self._limbo_files[trans_id] = limbo_name
1098
def adjust_path(self, name, parent, trans_id):
1099
previous_parent = self._new_parent.get(trans_id)
1100
previous_name = self._new_name.get(trans_id)
1101
TreeTransformBase.adjust_path(self, name, parent, trans_id)
1102
if (trans_id in self._limbo_files and
1103
trans_id not in self._needs_rename):
1104
self._rename_in_limbo([trans_id])
1105
self._limbo_children[previous_parent].remove(trans_id)
1106
del self._limbo_children_names[previous_parent][previous_name]
1108
def _rename_in_limbo(self, trans_ids):
1109
"""Fix limbo names so that the right final path is produced.
1111
This means we outsmarted ourselves-- we tried to avoid renaming
1112
these files later by creating them with their final names in their
1113
final parents. But now the previous name or parent is no longer
1114
suitable, so we have to rename them.
1116
Even for trans_ids that have no new contents, we must remove their
1117
entries from _limbo_files, because they are now stale.
1119
for trans_id in trans_ids:
1120
old_path = self._limbo_files.pop(trans_id)
1121
if trans_id not in self._new_contents:
1123
new_path = self._limbo_name(trans_id)
1124
os.rename(old_path, new_path)
1126
def create_file(self, contents, trans_id, mode_id=None):
489
1127
"""Schedule creation of a new file.
493
:param contents: an iterator of strings, all of which will be written
494
to the target destination.
495
:param trans_id: TreeTransform handle
496
:param mode_id: If not None, force the mode of the target file to match
497
the mode of the object referenced by mode_id.
498
Otherwise, we will try to preserve mode bits of an existing file.
499
:param sha1: If the sha1 of this content is already known, pass it in.
500
We can use it to prevent future sha1 computations.
1131
Contents is an iterator of strings, all of which will be written
1132
to the target destination.
1134
New file takes the permissions of any existing file with that id,
1135
unless mode_id is specified.
502
raise NotImplementedError(self.create_file)
1137
name = self._limbo_name(trans_id)
1138
f = open(name, 'wb')
1141
unique_add(self._new_contents, trans_id, 'file')
1143
# Clean up the file, it never got registered so
1144
# TreeTransform.finalize() won't clean it up.
1149
f.writelines(contents)
1152
self._set_mode(trans_id, mode_id, S_ISREG)
1154
def _read_file_chunks(self, trans_id):
1155
cur_file = open(self._limbo_name(trans_id), 'rb')
1157
return cur_file.readlines()
1161
def _read_symlink_target(self, trans_id):
1162
return os.readlink(self._limbo_name(trans_id))
1164
def create_hardlink(self, path, trans_id):
1165
"""Schedule creation of a hard link"""
1166
name = self._limbo_name(trans_id)
1170
if e.errno != errno.EPERM:
1172
raise errors.HardLinkNotSupported(path)
1174
unique_add(self._new_contents, trans_id, 'file')
1176
# Clean up the file, it never got registered so
1177
# TreeTransform.finalize() won't clean it up.
504
1181
def create_directory(self, trans_id):
505
1182
"""Schedule creation of a new directory.
507
1184
See also new_directory.
509
raise NotImplementedError(self.create_directory)
1186
os.mkdir(self._limbo_name(trans_id))
1187
unique_add(self._new_contents, trans_id, 'directory')
511
1189
def create_symlink(self, target, trans_id):
512
1190
"""Schedule creation of a new symbolic link.
514
1192
target is a bytestring.
515
1193
See also new_symlink.
517
raise NotImplementedError(self.create_symlink)
519
def create_hardlink(self, path, trans_id):
520
"""Schedule creation of a hard link"""
521
raise NotImplementedError(self.create_hardlink)
1196
os.symlink(target, self._limbo_name(trans_id))
1197
unique_add(self._new_contents, trans_id, 'symlink')
1200
path = FinalPaths(self).get_path(trans_id)
1203
raise UnableCreateSymlink(path=path)
523
1205
def cancel_creation(self, trans_id):
524
1206
"""Cancel the creation of new file contents."""
525
raise NotImplementedError(self.cancel_creation)
528
class OrphaningError(errors.BzrError):
530
# Only bugs could lead to such exception being seen by the user
531
internal_error = True
532
_fmt = "Error while orphaning %s in %s directory"
534
def __init__(self, orphan, parent):
535
errors.BzrError.__init__(self)
540
class OrphaningForbidden(OrphaningError):
542
_fmt = "Policy: %s doesn't allow creating orphans."
544
def __init__(self, policy):
545
errors.BzrError.__init__(self)
549
def move_orphan(tt, orphan_id, parent_id):
550
"""See TreeTransformBase.new_orphan.
552
This creates a new orphan in the `brz-orphans` dir at the root of the
555
:param tt: The TreeTransform orphaning `trans_id`.
557
:param orphan_id: The trans id that should be orphaned.
559
:param parent_id: The orphan parent trans id.
561
# Add the orphan dir if it doesn't exist
562
orphan_dir_basename = 'brz-orphans'
563
od_id = tt.trans_id_tree_path(orphan_dir_basename)
564
if tt.final_kind(od_id) is None:
565
tt.create_directory(od_id)
566
parent_path = tt._tree_id_paths[parent_id]
567
# Find a name that doesn't exist yet in the orphan dir
568
actual_name = tt.final_name(orphan_id)
569
new_name = tt._available_backup_name(actual_name, od_id)
570
tt.adjust_path(new_name, od_id, orphan_id)
571
trace.warning('%s has been orphaned in %s'
572
% (joinpath(parent_path, actual_name), orphan_dir_basename))
575
def refuse_orphan(tt, orphan_id, parent_id):
576
"""See TreeTransformBase.new_orphan.
578
This refuses to create orphan, letting the caller handle the conflict.
580
raise OrphaningForbidden('never')
583
orphaning_registry = registry.Registry()
584
orphaning_registry.register(
585
u'conflict', refuse_orphan,
586
'Leave orphans in place and create a conflict on the directory.')
587
orphaning_registry.register(
588
u'move', move_orphan,
589
'Move orphans into the brz-orphans directory.')
590
orphaning_registry._set_default_key(u'conflict')
593
opt_transform_orphan = _mod_config.RegistryOption(
594
'transform.orphan_policy', orphaning_registry,
595
help='Policy for orphaned files during transform operations.',
1207
del self._new_contents[trans_id]
1208
children = self._limbo_children.get(trans_id)
1209
# if this is a limbo directory with children, move them before removing
1211
if children is not None:
1212
self._rename_in_limbo(children)
1213
del self._limbo_children[trans_id]
1214
del self._limbo_children_names[trans_id]
1215
delete_any(self._limbo_name(trans_id))
1218
class TreeTransform(DiskTreeTransform):
1219
"""Represent a tree transformation.
1221
This object is designed to support incremental generation of the transform,
1224
However, it gives optimum performance when parent directories are created
1225
before their contents. The transform is then able to put child files
1226
directly in their parent directory, avoiding later renames.
1228
It is easy to produce malformed transforms, but they are generally
1229
harmless. Attempting to apply a malformed transform will cause an
1230
exception to be raised before any modifications are made to the tree.
1232
Many kinds of malformed transforms can be corrected with the
1233
resolve_conflicts function. The remaining ones indicate programming error,
1234
such as trying to create a file with no path.
1236
Two sets of file creation methods are supplied. Convenience methods are:
1241
These are composed of the low-level methods:
1243
* create_file or create_directory or create_symlink
1247
Transform/Transaction ids
1248
-------------------------
1249
trans_ids are temporary ids assigned to all files involved in a transform.
1250
It's possible, even common, that not all files in the Tree have trans_ids.
1252
trans_ids are used because filenames and file_ids are not good enough
1253
identifiers; filenames change, and not all files have file_ids. File-ids
1254
are also associated with trans-ids, so that moving a file moves its
1257
trans_ids are only valid for the TreeTransform that generated them.
1261
Limbo is a temporary directory use to hold new versions of files.
1262
Files are added to limbo by create_file, create_directory, create_symlink,
1263
and their convenience variants (new_*). Files may be removed from limbo
1264
using cancel_creation. Files are renamed from limbo into their final
1265
location as part of TreeTransform.apply
1267
Limbo must be cleaned up, by either calling TreeTransform.apply or
1268
calling TreeTransform.finalize.
1270
Files are placed into limbo inside their parent directories, where
1271
possible. This reduces subsequent renames, and makes operations involving
1272
lots of files faster. This optimization is only possible if the parent
1273
directory is created *before* creating any of its children, so avoid
1274
creating children before parents, where possible.
1278
This temporary directory is used by _FileMover for storing files that are
1279
about to be deleted. In case of rollback, the files will be restored.
1280
FileMover does not delete files until it is sure that a rollback will not
1283
def __init__(self, tree, pb=DummyProgress()):
1284
"""Note: a tree_write lock is taken on the tree.
1286
Use TreeTransform.finalize() to release the lock (can be omitted if
1287
TreeTransform.apply() called).
1289
tree.lock_tree_write()
1292
limbodir = urlutils.local_path_from_url(
1293
tree._transport.abspath('limbo'))
1297
if e.errno == errno.EEXIST:
1298
raise ExistingLimbo(limbodir)
1299
deletiondir = urlutils.local_path_from_url(
1300
tree._transport.abspath('pending-deletion'))
1302
os.mkdir(deletiondir)
1304
if e.errno == errno.EEXIST:
1305
raise errors.ExistingPendingDeletion(deletiondir)
1310
# Cache of realpath results, to speed up canonical_path
1311
self._realpaths = {}
1312
# Cache of relpath results, to speed up canonical_path
1314
DiskTreeTransform.__init__(self, tree, limbodir, pb,
1315
tree.case_sensitive)
1316
self._deletiondir = deletiondir
1318
def canonical_path(self, path):
1319
"""Get the canonical tree-relative path"""
1320
# don't follow final symlinks
1321
abs = self._tree.abspath(path)
1322
if abs in self._relpaths:
1323
return self._relpaths[abs]
1324
dirname, basename = os.path.split(abs)
1325
if dirname not in self._realpaths:
1326
self._realpaths[dirname] = os.path.realpath(dirname)
1327
dirname = self._realpaths[dirname]
1328
abs = pathjoin(dirname, basename)
1329
if dirname in self._relpaths:
1330
relpath = pathjoin(self._relpaths[dirname], basename)
1331
relpath = relpath.rstrip('/\\')
1333
relpath = self._tree.relpath(abs)
1334
self._relpaths[abs] = relpath
1337
def tree_kind(self, trans_id):
1338
"""Determine the file kind in the working tree.
1340
Raises NoSuchFile if the file does not exist
1342
path = self._tree_id_paths.get(trans_id)
1344
raise NoSuchFile(None)
1346
return file_kind(self._tree.abspath(path))
1348
if e.errno != errno.ENOENT:
1351
raise NoSuchFile(path)
1353
def _set_mode(self, trans_id, mode_id, typefunc):
1354
"""Set the mode of new file contents.
1355
The mode_id is the existing file to get the mode from (often the same
1356
as trans_id). The operation is only performed if there's a mode match
1357
according to typefunc.
1362
old_path = self._tree_id_paths[mode_id]
1366
mode = os.stat(self._tree.abspath(old_path)).st_mode
1368
if e.errno in (errno.ENOENT, errno.ENOTDIR):
1369
# Either old_path doesn't exist, or the parent of the
1370
# target is not a directory (but will be one eventually)
1371
# Either way, we know it doesn't exist *right now*
1372
# See also bug #248448
1377
os.chmod(self._limbo_name(trans_id), mode)
1379
def iter_tree_children(self, parent_id):
1380
"""Iterate through the entry's tree children, if any"""
1382
path = self._tree_id_paths[parent_id]
1386
children = os.listdir(self._tree.abspath(path))
1388
if not (osutils._is_error_enotdir(e)
1389
or e.errno in (errno.ENOENT, errno.ESRCH)):
1393
for child in children:
1394
childpath = joinpath(path, child)
1395
if self._tree.is_control_filename(childpath):
1397
yield self.trans_id_tree_path(childpath)
1399
def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1400
"""Apply all changes to the inventory and filesystem.
1402
If filesystem or inventory conflicts are present, MalformedTransform
1405
If apply succeeds, finalize is not necessary.
1407
:param no_conflicts: if True, the caller guarantees there are no
1408
conflicts, so no check is made.
1409
:param precomputed_delta: An inventory delta to use instead of
1411
:param _mover: Supply an alternate FileMover, for testing
1413
if not no_conflicts:
1414
self._check_malformed()
1415
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1417
if precomputed_delta is None:
1418
child_pb.update('Apply phase', 0, 2)
1419
inventory_delta = self._generate_inventory_delta()
1422
inventory_delta = precomputed_delta
1425
mover = _FileMover()
1429
child_pb.update('Apply phase', 0 + offset, 2 + offset)
1430
self._apply_removals(mover)
1431
child_pb.update('Apply phase', 1 + offset, 2 + offset)
1432
modified_paths = self._apply_insertions(mover)
1437
mover.apply_deletions()
1440
self._tree.apply_inventory_delta(inventory_delta)
1443
return _TransformResults(modified_paths, self.rename_count)
1445
def _generate_inventory_delta(self):
1446
"""Generate an inventory delta for the current transform."""
1447
inventory_delta = []
1448
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1449
new_paths = self._inventory_altered()
1450
total_entries = len(new_paths) + len(self._removed_id)
1452
for num, trans_id in enumerate(self._removed_id):
1454
child_pb.update('removing file', num, total_entries)
1455
if trans_id == self._new_root:
1456
file_id = self._tree.get_root_id()
1458
file_id = self.tree_file_id(trans_id)
1459
# File-id isn't really being deleted, just moved
1460
if file_id in self._r_new_id:
1462
path = self._tree_id_paths[trans_id]
1463
inventory_delta.append((path, None, file_id, None))
1464
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1466
entries = self._tree.iter_entries_by_dir(
1467
new_path_file_ids.values())
1468
old_paths = dict((e.file_id, p) for p, e in entries)
1470
for num, (path, trans_id) in enumerate(new_paths):
1472
child_pb.update('adding file',
1473
num + len(self._removed_id), total_entries)
1474
file_id = new_path_file_ids[trans_id]
1479
kind = self.final_kind(trans_id)
1481
kind = self._tree.stored_kind(file_id)
1482
parent_trans_id = self.final_parent(trans_id)
1483
parent_file_id = new_path_file_ids.get(parent_trans_id)
1484
if parent_file_id is None:
1485
parent_file_id = self.final_file_id(parent_trans_id)
1486
if trans_id in self._new_reference_revision:
1487
new_entry = inventory.TreeReference(
1489
self._new_name[trans_id],
1490
self.final_file_id(self._new_parent[trans_id]),
1491
None, self._new_reference_revision[trans_id])
1493
new_entry = inventory.make_entry(kind,
1494
self.final_name(trans_id),
1495
parent_file_id, file_id)
1496
old_path = old_paths.get(new_entry.file_id)
1497
new_executability = self._new_executability.get(trans_id)
1498
if new_executability is not None:
1499
new_entry.executable = new_executability
1500
inventory_delta.append(
1501
(old_path, path, new_entry.file_id, new_entry))
1504
return inventory_delta
1506
def _apply_removals(self, mover):
1507
"""Perform tree operations that remove directory/inventory names.
1509
That is, delete files that are to be deleted, and put any files that
1510
need renaming into limbo. This must be done in strict child-to-parent
1513
If inventory_delta is None, no inventory delta generation is performed.
1515
tree_paths = list(self._tree_path_ids.iteritems())
1516
tree_paths.sort(reverse=True)
1517
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1519
for num, data in enumerate(tree_paths):
1520
path, trans_id = data
1521
child_pb.update('removing file', num, len(tree_paths))
1522
full_path = self._tree.abspath(path)
1523
if trans_id in self._removed_contents:
1524
mover.pre_delete(full_path, os.path.join(self._deletiondir,
1526
elif trans_id in self._new_name or trans_id in \
1529
mover.rename(full_path, self._limbo_name(trans_id))
1531
if e.errno != errno.ENOENT:
1534
self.rename_count += 1
1538
def _apply_insertions(self, mover):
1539
"""Perform tree operations that insert directory/inventory names.
1541
That is, create any files that need to be created, and restore from
1542
limbo any files that needed renaming. This must be done in strict
1543
parent-to-child order.
1545
If inventory_delta is None, no inventory delta is calculated, and
1546
no list of modified paths is returned.
1548
new_paths = self.new_paths(filesystem_only=True)
1550
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1552
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1554
for num, (path, trans_id) in enumerate(new_paths):
1556
child_pb.update('adding file', num, len(new_paths))
1557
full_path = self._tree.abspath(path)
1558
if trans_id in self._needs_rename:
1560
mover.rename(self._limbo_name(trans_id), full_path)
1562
# We may be renaming a dangling inventory id
1563
if e.errno != errno.ENOENT:
1566
self.rename_count += 1
1567
if (trans_id in self._new_contents or
1568
self.path_changed(trans_id)):
1569
if trans_id in self._new_contents:
1570
modified_paths.append(full_path)
1571
if trans_id in self._new_executability:
1572
self._set_executability(path, trans_id)
1575
self._new_contents.clear()
1576
return modified_paths
1579
class TransformPreview(DiskTreeTransform):
1580
"""A TreeTransform for generating preview trees.
1582
Unlike TreeTransform, this version works when the input tree is a
1583
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1584
unversioned files in the input tree.
1587
def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1589
limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1590
DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
1592
def canonical_path(self, path):
1595
def tree_kind(self, trans_id):
1596
path = self._tree_id_paths.get(trans_id)
1598
raise NoSuchFile(None)
1599
file_id = self._tree.path2id(path)
1600
return self._tree.kind(file_id)
1602
def _set_mode(self, trans_id, mode_id, typefunc):
1603
"""Set the mode of new file contents.
1604
The mode_id is the existing file to get the mode from (often the same
1605
as trans_id). The operation is only performed if there's a mode match
1606
according to typefunc.
1608
# is it ok to ignore this? probably
1611
def iter_tree_children(self, parent_id):
1612
"""Iterate through the entry's tree children, if any"""
1614
path = self._tree_id_paths[parent_id]
1617
file_id = self.tree_file_id(parent_id)
1620
entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1621
children = getattr(entry, 'children', {})
1622
for child in children:
1623
childpath = joinpath(path, child)
1624
yield self.trans_id_tree_path(childpath)
1627
class _PreviewTree(tree.Tree):
1628
"""Partial implementation of Tree to support show_diff_trees"""
1630
def __init__(self, transform):
1631
self._transform = transform
1632
self._final_paths = FinalPaths(transform)
1633
self.__by_parent = None
1634
self._parent_ids = []
1635
self._all_children_cache = {}
1636
self._path2trans_id_cache = {}
1637
self._final_name_cache = {}
1639
def _changes(self, file_id):
1640
for changes in self._transform.iter_changes():
1641
if changes[0] == file_id:
1644
def _content_change(self, file_id):
1645
"""Return True if the content of this file changed"""
1646
changes = self._changes(file_id)
1647
# changes[2] is true if the file content changed. See
1648
# InterTree.iter_changes.
1649
return (changes is not None and changes[2])
1651
def _get_repository(self):
1652
repo = getattr(self._transform._tree, '_repository', None)
1654
repo = self._transform._tree.branch.repository
1657
def _iter_parent_trees(self):
1658
for revision_id in self.get_parent_ids():
1660
yield self.revision_tree(revision_id)
1661
except errors.NoSuchRevisionInTree:
1662
yield self._get_repository().revision_tree(revision_id)
1664
def _get_file_revision(self, file_id, vf, tree_revision):
1665
parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
1666
self._iter_parent_trees()]
1667
vf.add_lines((file_id, tree_revision), parent_keys,
1668
self.get_file(file_id).readlines())
1669
repo = self._get_repository()
1670
base_vf = repo.texts
1671
if base_vf not in vf.fallback_versionedfiles:
1672
vf.fallback_versionedfiles.append(base_vf)
1673
return tree_revision
1675
def _stat_limbo_file(self, file_id):
1676
trans_id = self._transform.trans_id_file_id(file_id)
1677
name = self._transform._limbo_name(trans_id)
1678
return os.lstat(name)
1681
def _by_parent(self):
1682
if self.__by_parent is None:
1683
self.__by_parent = self._transform.by_parent()
1684
return self.__by_parent
1686
def _comparison_data(self, entry, path):
1687
kind, size, executable, link_or_sha1 = self.path_content_summary(path)
1688
if kind == 'missing':
1692
file_id = self._transform.final_file_id(self._path2trans_id(path))
1693
executable = self.is_executable(file_id, path)
1694
return kind, executable, None
1696
def lock_read(self):
1697
# Perhaps in theory, this should lock the TreeTransform?
1704
def inventory(self):
1705
"""This Tree does not use inventory as its backing data."""
1706
raise NotImplementedError(_PreviewTree.inventory)
1708
def get_root_id(self):
1709
return self._transform.final_file_id(self._transform.root)
1711
def all_file_ids(self):
1712
tree_ids = set(self._transform._tree.all_file_ids())
1713
tree_ids.difference_update(self._transform.tree_file_id(t)
1714
for t in self._transform._removed_id)
1715
tree_ids.update(self._transform._new_id.values())
1719
return iter(self.all_file_ids())
1721
def _has_id(self, file_id, fallback_check):
1722
if file_id in self._transform._r_new_id:
1724
elif file_id in set([self._transform.tree_file_id(trans_id) for
1725
trans_id in self._transform._removed_id]):
1728
return fallback_check(file_id)
1730
def has_id(self, file_id):
1731
return self._has_id(file_id, self._transform._tree.has_id)
1733
def has_or_had_id(self, file_id):
1734
return self._has_id(file_id, self._transform._tree.has_or_had_id)
1736
def _path2trans_id(self, path):
1737
# We must not use None here, because that is a valid value to store.
1738
trans_id = self._path2trans_id_cache.get(path, object)
1739
if trans_id is not object:
1741
segments = splitpath(path)
1742
cur_parent = self._transform.root
1743
for cur_segment in segments:
1744
for child in self._all_children(cur_parent):
1745
final_name = self._final_name_cache.get(child)
1746
if final_name is None:
1747
final_name = self._transform.final_name(child)
1748
self._final_name_cache[child] = final_name
1749
if final_name == cur_segment:
1753
self._path2trans_id_cache[path] = None
1755
self._path2trans_id_cache[path] = cur_parent
1758
def path2id(self, path):
1759
return self._transform.final_file_id(self._path2trans_id(path))
1761
def id2path(self, file_id):
1762
trans_id = self._transform.trans_id_file_id(file_id)
1764
return self._final_paths._determine_path(trans_id)
1766
raise errors.NoSuchId(self, file_id)
1768
def _all_children(self, trans_id):
1769
children = self._all_children_cache.get(trans_id)
1770
if children is not None:
1772
children = set(self._transform.iter_tree_children(trans_id))
1773
# children in the _new_parent set are provided by _by_parent.
1774
children.difference_update(self._transform._new_parent.keys())
1775
children.update(self._by_parent.get(trans_id, []))
1776
self._all_children_cache[trans_id] = children
1779
def iter_children(self, file_id):
1780
trans_id = self._transform.trans_id_file_id(file_id)
1781
for child_trans_id in self._all_children(trans_id):
1782
yield self._transform.final_file_id(child_trans_id)
1785
possible_extras = set(self._transform.trans_id_tree_path(p) for p
1786
in self._transform._tree.extras())
1787
possible_extras.update(self._transform._new_contents)
1788
possible_extras.update(self._transform._removed_id)
1789
for trans_id in possible_extras:
1790
if self._transform.final_file_id(trans_id) is None:
1791
yield self._final_paths._determine_path(trans_id)
1793
def _make_inv_entries(self, ordered_entries, specific_file_ids=None,
1794
yield_parents=False):
1795
for trans_id, parent_file_id in ordered_entries:
1796
file_id = self._transform.final_file_id(trans_id)
1799
if (specific_file_ids is not None
1800
and file_id not in specific_file_ids):
1803
kind = self._transform.final_kind(trans_id)
1805
kind = self._transform._tree.stored_kind(file_id)
1806
new_entry = inventory.make_entry(
1808
self._transform.final_name(trans_id),
1809
parent_file_id, file_id)
1810
yield new_entry, trans_id
1812
def _list_files_by_dir(self):
1813
todo = [ROOT_PARENT]
1815
while len(todo) > 0:
1817
parent_file_id = self._transform.final_file_id(parent)
1818
children = list(self._all_children(parent))
1819
paths = dict(zip(children, self._final_paths.get_paths(children)))
1820
children.sort(key=paths.get)
1821
todo.extend(reversed(children))
1822
for trans_id in children:
1823
ordered_ids.append((trans_id, parent_file_id))
1826
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
1827
# This may not be a maximally efficient implementation, but it is
1828
# reasonably straightforward. An implementation that grafts the
1829
# TreeTransform changes onto the tree's iter_entries_by_dir results
1830
# might be more efficient, but requires tricky inferences about stack
1832
ordered_ids = self._list_files_by_dir()
1833
for entry, trans_id in self._make_inv_entries(ordered_ids,
1834
specific_file_ids, yield_parents=yield_parents):
1835
yield unicode(self._final_paths.get_path(trans_id)), entry
1837
def _iter_entries_for_dir(self, dir_path):
1838
"""Return path, entry for items in a directory without recursing down."""
1839
dir_file_id = self.path2id(dir_path)
1841
for file_id in self.iter_children(dir_file_id):
1842
trans_id = self._transform.trans_id_file_id(file_id)
1843
ordered_ids.append((trans_id, file_id))
1844
for entry, trans_id in self._make_inv_entries(ordered_ids):
1845
yield unicode(self._final_paths.get_path(trans_id)), entry
1847
def list_files(self, include_root=False, from_dir=None, recursive=True):
1848
"""See WorkingTree.list_files."""
1849
# XXX This should behave like WorkingTree.list_files, but is really
1850
# more like RevisionTree.list_files.
1854
prefix = from_dir + '/'
1855
entries = self.iter_entries_by_dir()
1856
for path, entry in entries:
1857
if entry.name == '' and not include_root:
1860
if not path.startswith(prefix):
1862
path = path[len(prefix):]
1863
yield path, 'V', entry.kind, entry.file_id, entry
1865
if from_dir is None and include_root is True:
1866
root_entry = inventory.make_entry('directory', '',
1867
ROOT_PARENT, self.get_root_id())
1868
yield '', 'V', 'directory', root_entry.file_id, root_entry
1869
entries = self._iter_entries_for_dir(from_dir or '')
1870
for path, entry in entries:
1871
yield path, 'V', entry.kind, entry.file_id, entry
1873
def kind(self, file_id):
1874
trans_id = self._transform.trans_id_file_id(file_id)
1875
return self._transform.final_kind(trans_id)
1877
def stored_kind(self, file_id):
1878
trans_id = self._transform.trans_id_file_id(file_id)
1880
return self._transform._new_contents[trans_id]
1882
return self._transform._tree.stored_kind(file_id)
1884
def get_file_mtime(self, file_id, path=None):
1885
"""See Tree.get_file_mtime"""
1886
if not self._content_change(file_id):
1887
return self._transform._tree.get_file_mtime(file_id, path)
1888
return self._stat_limbo_file(file_id).st_mtime
1890
def _file_size(self, entry, stat_value):
1891
return self.get_file_size(entry.file_id)
1893
def get_file_size(self, file_id):
1894
"""See Tree.get_file_size"""
1895
if self.kind(file_id) == 'file':
1896
return self._transform._tree.get_file_size(file_id)
1900
def get_file_sha1(self, file_id, path=None, stat_value=None):
1901
trans_id = self._transform.trans_id_file_id(file_id)
1902
kind = self._transform._new_contents.get(trans_id)
1904
return self._transform._tree.get_file_sha1(file_id)
1906
fileobj = self.get_file(file_id)
1908
return sha_file(fileobj)
1912
def is_executable(self, file_id, path=None):
1915
trans_id = self._transform.trans_id_file_id(file_id)
1917
return self._transform._new_executability[trans_id]
1920
return self._transform._tree.is_executable(file_id, path)
1922
if e.errno == errno.ENOENT:
1925
except errors.NoSuchId:
1928
def path_content_summary(self, path):
1929
trans_id = self._path2trans_id(path)
1930
tt = self._transform
1931
tree_path = tt._tree_id_paths.get(trans_id)
1932
kind = tt._new_contents.get(trans_id)
1934
if tree_path is None or trans_id in tt._removed_contents:
1935
return 'missing', None, None, None
1936
summary = tt._tree.path_content_summary(tree_path)
1937
kind, size, executable, link_or_sha1 = summary
1940
limbo_name = tt._limbo_name(trans_id)
1941
if trans_id in tt._new_reference_revision:
1942
kind = 'tree-reference'
1944
statval = os.lstat(limbo_name)
1945
size = statval.st_size
1946
if not supports_executable():
1949
executable = statval.st_mode & S_IEXEC
1953
if kind == 'symlink':
1954
link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
1955
if supports_executable():
1956
executable = tt._new_executability.get(trans_id, executable)
1957
return kind, size, executable, link_or_sha1
1959
def iter_changes(self, from_tree, include_unchanged=False,
1960
specific_files=None, pb=None, extra_trees=None,
1961
require_versioned=True, want_unversioned=False):
1962
"""See InterTree.iter_changes.
1964
This has a fast path that is only used when the from_tree matches
1965
the transform tree, and no fancy options are supplied.
1967
if (from_tree is not self._transform._tree or include_unchanged or
1968
specific_files or want_unversioned):
1969
return tree.InterTree(from_tree, self).iter_changes(
1970
include_unchanged=include_unchanged,
1971
specific_files=specific_files,
1973
extra_trees=extra_trees,
1974
require_versioned=require_versioned,
1975
want_unversioned=want_unversioned)
1976
if want_unversioned:
1977
raise ValueError('want_unversioned is not supported')
1978
return self._transform.iter_changes()
1980
def get_file(self, file_id, path=None):
1981
"""See Tree.get_file"""
1982
if not self._content_change(file_id):
1983
return self._transform._tree.get_file(file_id, path)
1984
trans_id = self._transform.trans_id_file_id(file_id)
1985
name = self._transform._limbo_name(trans_id)
1986
return open(name, 'rb')
1988
def get_file_with_stat(self, file_id, path=None):
1989
return self.get_file(file_id, path), None
1991
def annotate_iter(self, file_id,
1992
default_revision=_mod_revision.CURRENT_REVISION):
1993
changes = self._changes(file_id)
1997
changed_content, versioned, kind = (changes[2], changes[3],
2001
get_old = (kind[0] == 'file' and versioned[0])
2003
old_annotation = self._transform._tree.annotate_iter(file_id,
2004
default_revision=default_revision)
2008
return old_annotation
2009
if not changed_content:
2010
return old_annotation
2011
# TODO: This is doing something similar to what WT.annotate_iter is
2012
# doing, however it fails slightly because it doesn't know what
2013
# the *other* revision_id is, so it doesn't know how to give the
2014
# other as the origin for some lines, they all get
2015
# 'default_revision'
2016
# It would be nice to be able to use the new Annotator based
2017
# approach, as well.
2018
return annotate.reannotate([old_annotation],
2019
self.get_file(file_id).readlines(),
2022
def get_symlink_target(self, file_id):
2023
"""See Tree.get_symlink_target"""
2024
if not self._content_change(file_id):
2025
return self._transform._tree.get_symlink_target(file_id)
2026
trans_id = self._transform.trans_id_file_id(file_id)
2027
name = self._transform._limbo_name(trans_id)
2028
return osutils.readlink(name)
2030
def walkdirs(self, prefix=''):
2031
pending = [self._transform.root]
2032
while len(pending) > 0:
2033
parent_id = pending.pop()
2036
prefix = prefix.rstrip('/')
2037
parent_path = self._final_paths.get_path(parent_id)
2038
parent_file_id = self._transform.final_file_id(parent_id)
2039
for child_id in self._all_children(parent_id):
2040
path_from_root = self._final_paths.get_path(child_id)
2041
basename = self._transform.final_name(child_id)
2042
file_id = self._transform.final_file_id(child_id)
2044
kind = self._transform.final_kind(child_id)
2045
versioned_kind = kind
2048
versioned_kind = self._transform._tree.stored_kind(file_id)
2049
if versioned_kind == 'directory':
2050
subdirs.append(child_id)
2051
children.append((path_from_root, basename, kind, None,
2052
file_id, versioned_kind))
2054
if parent_path.startswith(prefix):
2055
yield (parent_path, parent_file_id), children
2056
pending.extend(sorted(subdirs, key=self._final_paths.get_path,
2059
def get_parent_ids(self):
2060
return self._parent_ids
2062
def set_parent_ids(self, parent_ids):
2063
self._parent_ids = parent_ids
2065
def get_revision_tree(self, revision_id):
2066
return self._transform._tree.get_revision_tree(revision_id)
599
2069
def joinpath(parent, child):
995
2523
backups, merge_modified, basis_tree=None):
996
2524
if basis_tree is not None:
997
2525
basis_tree.lock_read()
998
# We ask the working_tree for its changes relative to the target, rather
999
# than the target changes relative to the working tree. Because WT4 has an
1000
# optimizer to compare itself to a target, but no optimizer for the
1002
change_list = working_tree.iter_changes(
1003
target_tree, specific_files=specific_files, pb=pb)
1004
if not target_tree.is_versioned(u''):
2526
change_list = target_tree.iter_changes(working_tree,
2527
specific_files=specific_files, pb=pb)
2528
if target_tree.get_root_id() is None:
1005
2529
skip_root = True
1007
2531
skip_root = False
1009
2533
deferred_files = []
1010
for id_num, change in enumerate(change_list):
1011
file_id = change.file_id
1012
target_path, wt_path = change.path
1013
target_versioned, wt_versioned = change.versioned
1014
target_parent, wt_parent = change.parent_id
1015
target_name, wt_name = change.name
1016
target_kind, wt_kind = change.kind
1017
target_executable, wt_executable = change.executable
1018
if skip_root and wt_parent is None:
2534
for id_num, (file_id, path, changed_content, versioned, parent, name,
2535
kind, executable) in enumerate(change_list):
2536
if skip_root and file_id[0] is not None and parent[0] is None:
1020
2538
trans_id = tt.trans_id_file_id(file_id)
1022
if change.changed_content:
1023
2541
keep_content = False
1024
if wt_kind == 'file' and (backups or target_kind is None):
1025
wt_sha1 = working_tree.get_file_sha1(wt_path)
1026
if merge_modified.get(wt_path) != wt_sha1:
2542
if kind[0] == 'file' and (backups or kind[1] is None):
2543
wt_sha1 = working_tree.get_file_sha1(file_id)
2544
if merge_modified.get(file_id) != wt_sha1:
1027
2545
# acquire the basis tree lazily to prevent the
1028
2546
# expense of accessing it when it's not needed ?
1029
2547
# (Guessing, RBC, 200702)
1030
2548
if basis_tree is None:
1031
2549
basis_tree = working_tree.basis_tree()
1032
2550
basis_tree.lock_read()
1033
basis_inter = InterTree.get(basis_tree, working_tree)
1034
basis_path = basis_inter.find_source_path(wt_path)
1035
if basis_path is None:
1036
if target_kind is None and not target_versioned:
1039
if wt_sha1 != basis_tree.get_file_sha1(basis_path):
1041
if wt_kind is not None:
2551
if file_id in basis_tree:
2552
if wt_sha1 != basis_tree.get_file_sha1(file_id):
2554
elif kind[1] is None and not versioned[1]:
2556
if kind[0] is not None:
1042
2557
if not keep_content:
1043
2558
tt.delete_contents(trans_id)
1044
elif target_kind is not None:
1045
parent_trans_id = tt.trans_id_file_id(wt_parent)
1046
backup_name = tt._available_backup_name(
1047
wt_name, parent_trans_id)
2559
elif kind[1] is not None:
2560
parent_trans_id = tt.trans_id_file_id(parent[0])
2561
by_parent = tt.by_parent()
2562
backup_name = _get_backup_name(name[0], by_parent,
2563
parent_trans_id, tt)
1048
2564
tt.adjust_path(backup_name, parent_trans_id, trans_id)
1049
new_trans_id = tt.create_path(wt_name, parent_trans_id)
1050
if wt_versioned and target_versioned:
2565
new_trans_id = tt.create_path(name[0], parent_trans_id)
2566
if versioned == (True, True):
1051
2567
tt.unversion_file(trans_id)
1052
tt.version_file(new_trans_id, file_id=file_id)
2568
tt.version_file(file_id, new_trans_id)
1053
2569
# New contents should have the same unix perms as old
1055
2571
mode_id = trans_id
1056
2572
trans_id = new_trans_id
1057
if target_kind in ('directory', 'tree-reference'):
2573
if kind[1] in ('directory', 'tree-reference'):
1058
2574
tt.create_directory(trans_id)
1059
if target_kind == 'tree-reference':
1060
revision = target_tree.get_reference_revision(
2575
if kind[1] == 'tree-reference':
2576
revision = target_tree.get_reference_revision(file_id,
1062
2578
tt.set_tree_reference(revision, trans_id)
1063
elif target_kind == 'symlink':
1064
tt.create_symlink(target_tree.get_symlink_target(
1065
target_path), trans_id)
1066
elif target_kind == 'file':
1067
deferred_files.append(
1068
(target_path, (trans_id, mode_id, file_id)))
2579
elif kind[1] == 'symlink':
2580
tt.create_symlink(target_tree.get_symlink_target(file_id),
2582
elif kind[1] == 'file':
2583
deferred_files.append((file_id, (trans_id, mode_id)))
1069
2584
if basis_tree is None:
1070
2585
basis_tree = working_tree.basis_tree()
1071
2586
basis_tree.lock_read()
1072
new_sha1 = target_tree.get_file_sha1(target_path)
1073
basis_inter = InterTree.get(basis_tree, target_tree)
1074
basis_path = basis_inter.find_source_path(target_path)
1075
if (basis_path is not None and
1076
new_sha1 == basis_tree.get_file_sha1(basis_path)):
1077
# If the new contents of the file match what is in basis,
1078
# then there is no need to store in merge_modified.
1079
if basis_path in merge_modified:
1080
del merge_modified[basis_path]
2587
new_sha1 = target_tree.get_file_sha1(file_id)
2588
if (file_id in basis_tree and new_sha1 ==
2589
basis_tree.get_file_sha1(file_id)):
2590
if file_id in merge_modified:
2591
del merge_modified[file_id]
1082
merge_modified[target_path] = new_sha1
2593
merge_modified[file_id] = new_sha1
1084
2595
# preserve the execute bit when backing up
1085
if keep_content and wt_executable == target_executable:
1086
tt.set_executability(target_executable, trans_id)
1087
elif target_kind is not None:
1088
raise AssertionError(target_kind)
1089
if not wt_versioned and target_versioned:
1090
tt.version_file(trans_id, file_id=file_id)
1091
if wt_versioned and not target_versioned:
2596
if keep_content and executable[0] == executable[1]:
2597
tt.set_executability(executable[1], trans_id)
2598
elif kind[1] is not None:
2599
raise AssertionError(kind[1])
2600
if versioned == (False, True):
2601
tt.version_file(file_id, trans_id)
2602
if versioned == (True, False):
1092
2603
tt.unversion_file(trans_id)
1093
if (target_name is not None
1094
and (wt_name != target_name or wt_parent != target_parent)):
1095
if target_name == '' and target_parent is None:
2604
if (name[1] is not None and
2605
(name[0] != name[1] or parent[0] != parent[1])):
2606
if name[1] == '' and parent[1] is None:
1096
2607
parent_trans = ROOT_PARENT
1098
parent_trans = tt.trans_id_file_id(target_parent)
1099
if wt_parent is None and wt_versioned:
1100
tt.adjust_root_path(target_name, parent_trans)
1102
tt.adjust_path(target_name, parent_trans, trans_id)
1103
if wt_executable != target_executable and target_kind == "file":
1104
tt.set_executability(target_executable, trans_id)
1105
if working_tree.supports_content_filtering():
1106
for (trans_id, mode_id, file_id), bytes in (
1107
target_tree.iter_files_bytes(deferred_files)):
1108
# We're reverting a tree to the target tree so using the
1109
# target tree to find the file path seems the best choice
1110
# here IMO - Ian C 27/Oct/2009
1111
filter_tree_path = target_tree.id2path(file_id)
1112
filters = working_tree._content_filter_stack(filter_tree_path)
1113
bytes = filtered_output_bytes(
1115
ContentFilterContext(filter_tree_path, working_tree))
1116
tt.create_file(bytes, trans_id, mode_id)
1118
for (trans_id, mode_id, file_id), bytes in target_tree.iter_files_bytes(
1120
tt.create_file(bytes, trans_id, mode_id)
1121
tt.fixup_new_roots()
2609
parent_trans = tt.trans_id_file_id(parent[1])
2610
tt.adjust_path(name[1], parent_trans, trans_id)
2611
if executable[0] != executable[1] and kind[1] == "file":
2612
tt.set_executability(executable[1], trans_id)
2613
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
2615
tt.create_file(bytes, trans_id, mode_id)
1123
2617
if basis_tree is not None:
1124
2618
basis_tree.unlock()
1125
2619
return merge_modified
1128
def resolve_conflicts(tt, pb=None, pass_func=None):
2622
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
1129
2623
"""Make many conflict-resolution attempts, but die if they fail"""
1130
2624
if pass_func is None:
1131
2625
pass_func = conflict_pass
1132
2626
new_conflicts = set()
1133
with ui.ui_factory.nested_progress_bar() as pb:
1134
2628
for n in range(10):
1135
pb.update(gettext('Resolution pass'), n + 1, 10)
2629
pb.update('Resolution pass', n+1, 10)
1136
2630
conflicts = tt.find_conflicts()
1137
2631
if len(conflicts) == 0:
1138
2632
return new_conflicts
1139
2633
new_conflicts.update(pass_func(tt, conflicts))
1140
2634
raise MalformedTransform(conflicts=conflicts)
1143
2639
def conflict_pass(tt, conflicts, path_tree=None):
1309
2784
def rollback(self):
1310
2785
"""Reverse all renames that have been performed"""
1311
2786
for from_, to in reversed(self.past_renames):
1313
os.rename(to, from_)
1314
except OSError as e:
1315
raise TransformRenameFailed(to, from_, str(e), e.errno)
2787
os.rename(to, from_)
1316
2788
# after rollback, don't reuse _FileMover
1317
self.past_renames = None
1318
self.pending_deletions = None
2790
pending_deletions = None
1320
2792
def apply_deletions(self):
1321
2793
"""Apply all marked deletions"""
1322
2794
for path in self.pending_deletions:
1323
2795
delete_any(path)
1324
2796
# after apply_deletions, don't reuse _FileMover
1325
self.past_renames = None
1326
self.pending_deletions = None
1329
def link_tree(target_tree, source_tree):
1330
"""Where possible, hard-link files in a tree to those in another tree.
1332
:param target_tree: Tree to change
1333
:param source_tree: Tree to hard-link from
1335
with target_tree.transform() as tt:
1336
for change in target_tree.iter_changes(source_tree, include_unchanged=True):
1337
if change.changed_content:
1339
if change.kind != ('file', 'file'):
1341
if change.executable[0] != change.executable[1]:
1343
trans_id = tt.trans_id_tree_path(change.path[1])
1344
tt.delete_contents(trans_id)
1345
tt.create_hardlink(source_tree.abspath(change.path[0]), trans_id)
1349
class PreviewTree(object):
1352
def __init__(self, transform):
1353
self._transform = transform
1354
self._parent_ids = []
1355
self.__by_parent = None
1356
self._path2trans_id_cache = {}
1357
self._all_children_cache = {}
1358
self._final_name_cache = {}
1361
def _by_parent(self):
1362
if self.__by_parent is None:
1363
self.__by_parent = self._transform.by_parent()
1364
return self.__by_parent
1366
def get_parent_ids(self):
1367
return self._parent_ids
1369
def set_parent_ids(self, parent_ids):
1370
self._parent_ids = parent_ids
1372
def get_revision_tree(self, revision_id):
1373
return self._transform._tree.get_revision_tree(revision_id)
1375
def is_locked(self):
1378
def lock_read(self):
1379
# Perhaps in theory, this should lock the TreeTransform?
1380
return lock.LogicalLockResult(self.unlock)
1385
def _path2trans_id(self, path):
1386
# We must not use None here, because that is a valid value to store.
1387
trans_id = self._path2trans_id_cache.get(path, object)
1388
if trans_id is not object:
1390
segments = osutils.splitpath(path)
1391
cur_parent = self._transform.root
1392
for cur_segment in segments:
1393
for child in self._all_children(cur_parent):
1394
final_name = self._final_name_cache.get(child)
1395
if final_name is None:
1396
final_name = self._transform.final_name(child)
1397
self._final_name_cache[child] = final_name
1398
if final_name == cur_segment:
1402
self._path2trans_id_cache[path] = None
1404
self._path2trans_id_cache[path] = cur_parent
1407
def _all_children(self, trans_id):
1408
children = self._all_children_cache.get(trans_id)
1409
if children is not None:
1411
children = set(self._transform.iter_tree_children(trans_id))
1412
# children in the _new_parent set are provided by _by_parent.
1413
children.difference_update(self._transform._new_parent)
1414
children.update(self._by_parent.get(trans_id, []))
1415
self._all_children_cache[trans_id] = children
1418
def get_file_with_stat(self, path):
1419
return self.get_file(path), None
1421
def is_executable(self, path):
1422
trans_id = self._path2trans_id(path)
1423
if trans_id is None:
1426
return self._transform._new_executability[trans_id]
1429
return self._transform._tree.is_executable(path)
1430
except OSError as e:
1431
if e.errno == errno.ENOENT:
1434
except errors.NoSuchFile:
1437
def has_filename(self, path):
1438
trans_id = self._path2trans_id(path)
1439
if trans_id in self._transform._new_contents:
1441
elif trans_id in self._transform._removed_contents:
1444
return self._transform._tree.has_filename(path)
1446
def get_file_sha1(self, path, stat_value=None):
1447
trans_id = self._path2trans_id(path)
1448
if trans_id is None:
1449
raise errors.NoSuchFile(path)
1450
kind = self._transform._new_contents.get(trans_id)
1452
return self._transform._tree.get_file_sha1(path)
1454
with self.get_file(path) as fileobj:
1455
return osutils.sha_file(fileobj)
1457
def get_file_verifier(self, path, stat_value=None):
1458
trans_id = self._path2trans_id(path)
1459
if trans_id is None:
1460
raise errors.NoSuchFile(path)
1461
kind = self._transform._new_contents.get(trans_id)
1463
return self._transform._tree.get_file_verifier(path)
1465
with self.get_file(path) as fileobj:
1466
return ("SHA1", osutils.sha_file(fileobj))
1468
def kind(self, path):
1469
trans_id = self._path2trans_id(path)
1470
if trans_id is None:
1471
raise errors.NoSuchFile(path)
1472
return self._transform.final_kind(trans_id)
1474
def stored_kind(self, path):
1475
trans_id = self._path2trans_id(path)
1476
if trans_id is None:
1477
raise errors.NoSuchFile(path)
1479
return self._transform._new_contents[trans_id]
1481
return self._transform._tree.stored_kind(path)
1483
def _get_repository(self):
1484
repo = getattr(self._transform._tree, '_repository', None)
1486
repo = self._transform._tree.branch.repository
1489
def _iter_parent_trees(self):
1490
for revision_id in self.get_parent_ids():
1492
yield self.revision_tree(revision_id)
1493
except errors.NoSuchRevisionInTree:
1494
yield self._get_repository().revision_tree(revision_id)
1496
def get_file_size(self, path):
1497
"""See Tree.get_file_size"""
1498
trans_id = self._path2trans_id(path)
1499
if trans_id is None:
1500
raise errors.NoSuchFile(path)
1501
kind = self._transform.final_kind(trans_id)
1504
if trans_id in self._transform._new_contents:
1505
return self._stat_limbo_file(trans_id).st_size
1506
if self.kind(path) == 'file':
1507
return self._transform._tree.get_file_size(path)
1511
def get_reference_revision(self, path):
1512
trans_id = self._path2trans_id(path)
1513
if trans_id is None:
1514
raise errors.NoSuchFile(path)
1515
reference_revision = self._transform._new_reference_revision.get(trans_id)
1516
if reference_revision is None:
1517
return self._transform._tree.get_reference_revision(path)
1518
return reference_revision
1520
def tree_kind(self, trans_id):
1521
path = self._tree_id_paths.get(trans_id)
1524
kind = self._tree.path_content_summary(path)[0]
1525
if kind == 'missing':
2798
pending_deletions = None
added
removed
bzrlib/transform.py
