39
from bzrlib.cleanup import OperationWithCleanups
40
from bzrlib.symbol_versioning import (
40
from breezy.bzr import (
44
from breezy.i18n import gettext
44
55
# TODO: Report back as changes are merged in
47
def transform_tree(from_tree, to_tree, interesting_ids=None):
48
from_tree.lock_tree_write()
49
operation = OperationWithCleanups(merge_inner)
50
operation.add_cleanup(from_tree.unlock)
51
operation.run_simple(from_tree.branch, to_tree, from_tree,
52
ignore_zero=True, interesting_ids=interesting_ids, this_tree=from_tree)
58
def transform_tree(from_tree, to_tree, interesting_files=None):
59
with from_tree.lock_tree_write():
60
merge_inner(from_tree.branch, to_tree, from_tree,
61
ignore_zero=True, this_tree=from_tree,
62
interesting_files=interesting_files)
55
65
class MergeHooks(hooks.Hooks):
57
67
def __init__(self):
58
hooks.Hooks.__init__(self)
59
self.create_hook(hooks.HookPoint('merge_file_content',
60
"Called with a bzrlib.merge.Merger object to create a per file "
61
"merge object when starting a merge. "
62
"Should return either None or a subclass of "
63
"``bzrlib.merge.AbstractPerFileMerger``. "
64
"Such objects will then be called per file "
65
"that needs to be merged (including when one "
66
"side has deleted the file and the other has changed it). "
67
"See the AbstractPerFileMerger API docs for details on how it is "
68
hooks.Hooks.__init__(self, "breezy.merge", "Merger.hooks")
69
self.add_hook('merge_file_content',
70
"Called with a breezy.merge.Merger object to create a per file "
71
"merge object when starting a merge. "
72
"Should return either None or a subclass of "
73
"``breezy.merge.AbstractPerFileMerger``. "
74
"Such objects will then be called per file "
75
"that needs to be merged (including when one "
76
"side has deleted the file and the other has changed it). "
77
"See the AbstractPerFileMerger API docs for details on how it is "
80
self.add_hook('pre_merge',
81
'Called before a merge. '
82
'Receives a Merger object as the single argument.',
84
self.add_hook('post_merge',
85
'Called after a merge. '
86
'Receives a Merger object as the single argument. '
87
'The return value is ignored.',
72
91
class AbstractPerFileMerger(object):
73
"""PerFileMerger objects are used by plugins extending merge for bzrlib.
75
See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
92
"""PerFileMerger objects are used by plugins extending merge for breezy.
94
See ``breezy.plugins.news_merge.news_merge`` for an example concrete class.
77
96
:ivar merger: The Merge3Merger performing the merge.
435
437
revision_id = _mod_revision.ensure_null(revision_id)
436
438
return branch, self.revision_tree(revision_id, branch)
438
@deprecated_method(deprecated_in((2, 1, 0)))
439
def ensure_revision_trees(self):
440
if self.this_revision_tree is None:
441
self.this_basis_tree = self.revision_tree(self.this_basis)
442
if self.this_basis == self.this_rev_id:
443
self.this_revision_tree = self.this_basis_tree
445
if self.other_rev_id is None:
446
other_basis_tree = self.revision_tree(self.other_basis)
447
if other_basis_tree.has_changes(self.other_tree):
448
raise errors.WorkingTreeNotRevision(self.this_tree)
449
other_rev_id = self.other_basis
450
self.other_tree = other_basis_tree
452
@deprecated_method(deprecated_in((2, 1, 0)))
453
def file_revisions(self, file_id):
454
self.ensure_revision_trees()
455
def get_id(tree, file_id):
456
revision_id = tree.inventory[file_id].revision
458
if self.this_rev_id is None:
459
if self.this_basis_tree.get_file_sha1(file_id) != \
460
self.this_tree.get_file_sha1(file_id):
461
raise errors.WorkingTreeNotRevision(self.this_tree)
463
trees = (self.this_basis_tree, self.other_tree)
464
return [get_id(tree, file_id) for tree in trees]
466
@deprecated_method(deprecated_in((2, 1, 0)))
467
def check_basis(self, check_clean, require_commits=True):
468
if self.this_basis is None and require_commits is True:
469
raise errors.BzrCommandError(
470
"This branch has no commits."
471
" (perhaps you would prefer 'bzr pull')")
474
if self.this_basis != self.this_rev_id:
475
raise errors.UncommittedChanges(self.this_tree)
477
@deprecated_method(deprecated_in((2, 1, 0)))
478
def compare_basis(self):
480
basis_tree = self.revision_tree(self.this_tree.last_revision())
481
except errors.NoSuchRevision:
482
basis_tree = self.this_tree.basis_tree()
483
if not self.this_tree.has_changes(basis_tree):
484
self.this_rev_id = self.this_basis
486
440
def set_interesting_files(self, file_list):
487
441
self.interesting_files = file_list
489
443
def set_pending(self):
490
444
if (not self.base_is_ancestor or not self.base_is_other_ancestor
491
or self.other_rev_id is None):
445
or self.other_rev_id is None):
493
447
self._add_parent()
495
449
def _add_parent(self):
496
450
new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
497
451
new_parent_trees = []
498
operation = OperationWithCleanups(self.this_tree.set_parent_trees)
499
for revision_id in new_parents:
501
tree = self.revision_tree(revision_id)
502
except errors.NoSuchRevision:
506
operation.add_cleanup(tree.unlock)
507
new_parent_trees.append((revision_id, tree))
508
operation.run_simple(new_parent_trees, allow_leftmost_as_ghost=True)
452
with cleanup.ExitStack() as stack:
453
for revision_id in new_parents:
455
tree = self.revision_tree(revision_id)
456
except errors.NoSuchRevision:
459
stack.enter_context(tree.lock_read())
460
new_parent_trees.append((revision_id, tree))
461
self.this_tree.set_parent_trees(new_parent_trees, allow_leftmost_as_ghost=True)
510
463
def set_other(self, other_revision, possible_transports=None):
511
464
"""Set the revision and tree to merge from.
792
754
self.cherrypick = cherrypick
796
warnings.warn("pp argument to Merge3Merger is deprecated")
798
warnings.warn("pb argument to Merge3Merger is deprecated")
800
758
def do_merge(self):
801
operation = OperationWithCleanups(self._do_merge)
802
self.this_tree.lock_tree_write()
803
operation.add_cleanup(self.this_tree.unlock)
804
self.base_tree.lock_read()
805
operation.add_cleanup(self.base_tree.unlock)
806
self.other_tree.lock_read()
807
operation.add_cleanup(self.other_tree.unlock)
810
def _do_merge(self, operation):
811
self.tt = transform.TreeTransform(self.this_tree, None)
812
operation.add_cleanup(self.tt.finalize)
813
self._compute_transform()
814
results = self.tt.apply(no_conflicts=True)
815
self.write_modified(results)
817
self.this_tree.add_conflicts(self.cooked_conflicts)
818
except errors.UnsupportedOperation:
759
with cleanup.ExitStack() as stack:
760
stack.enter_context(self.working_tree.lock_tree_write())
761
stack.enter_context(self.this_tree.lock_read())
762
stack.enter_context(self.base_tree.lock_read())
763
stack.enter_context(self.other_tree.lock_read())
764
self.tt = self.working_tree.get_transform()
765
stack.enter_context(self.tt)
766
self._compute_transform()
767
results = self.tt.apply(no_conflicts=True)
768
self.write_modified(results)
770
self.working_tree.add_conflicts(self.cooked_conflicts)
771
except errors.UnsupportedOperation:
821
774
def make_preview_transform(self):
822
operation = OperationWithCleanups(self._make_preview_transform)
823
self.base_tree.lock_read()
824
operation.add_cleanup(self.base_tree.unlock)
825
self.other_tree.lock_read()
826
operation.add_cleanup(self.other_tree.unlock)
827
return operation.run_simple()
829
def _make_preview_transform(self):
830
self.tt = transform.TransformPreview(self.this_tree)
831
self._compute_transform()
775
with self.base_tree.lock_read(), self.other_tree.lock_read():
776
self.tt = transform.TransformPreview(self.working_tree)
777
self._compute_transform()
834
780
def _compute_transform(self):
835
781
if self._lca_trees is None:
839
785
entries = self._entries_lca()
840
786
resolver = self._lca_multi_way
841
child_pb = ui.ui_factory.nested_progress_bar()
843
factories = Merger.hooks['merge_file_content']
844
hooks = [factory(self) for factory in factories] + [self]
845
self.active_hooks = [hook for hook in hooks if hook is not None]
846
for num, (file_id, changed, parents3, names3,
787
# Prepare merge hooks
788
factories = Merger.hooks['merge_file_content']
789
# One hook for each registered one plus our default merger
790
hooks = [factory(self) for factory in factories] + [self]
791
self.active_hooks = [hook for hook in hooks if hook is not None]
792
with ui.ui_factory.nested_progress_bar() as child_pb:
793
for num, (file_id, changed, paths3, parents3, names3,
847
794
executable3) in enumerate(entries):
848
child_pb.update('Preparing file merge', num, len(entries))
849
self._merge_names(file_id, parents3, names3, resolver=resolver)
795
# Try merging each entry
796
child_pb.update(gettext('Preparing file merge'),
798
self._merge_names(file_id, paths3, parents3,
799
names3, resolver=resolver)
851
file_status = self._do_merge_contents(file_id)
801
file_status = self._do_merge_contents(paths3, file_id)
853
803
file_status = 'unmodified'
854
self._merge_executable(file_id,
855
executable3, file_status, resolver=resolver)
859
child_pb = ui.ui_factory.nested_progress_bar()
861
fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
804
self._merge_executable(paths3, file_id, executable3,
805
file_status, resolver=resolver)
806
self.tt.fixup_new_roots()
807
self._finish_computing_transform()
809
def _finish_computing_transform(self):
810
"""Finalize the transform and report the changes.
812
This is the second half of _compute_transform.
814
with ui.ui_factory.nested_progress_bar() as child_pb:
815
fs_conflicts = transform.resolve_conflicts(
862
817
lambda t, c: transform.conflict_pass(t, c, self.other_tree))
865
818
if self.change_reporter is not None:
866
from bzrlib import delta
819
from breezy import delta
867
820
delta.report_changes(
868
821
self.tt.iter_changes(), self.change_reporter)
869
822
self.cook_conflicts(fs_conflicts)
870
823
for conflict in self.cooked_conflicts:
871
trace.warning(conflict)
824
trace.warning('%s', conflict.describe())
873
826
def _entries3(self):
874
827
"""Gather data about files modified between three trees.
883
836
iterator = self.other_tree.iter_changes(self.base_tree,
884
include_unchanged=True, specific_files=self.interesting_files,
885
extra_trees=[self.this_tree])
886
this_entries = dict((e.file_id, e) for p, e in
887
self.this_tree.iter_entries_by_dir(
888
self.interesting_ids))
889
for (file_id, paths, changed, versioned, parents, names, kind,
890
executable) in iterator:
891
if (self.interesting_ids is not None and
892
file_id not in self.interesting_ids):
894
entry = this_entries.get(file_id)
895
if entry is not None:
896
this_name = entry.name
897
this_parent = entry.parent_id
898
this_executable = entry.executable
837
specific_files=self.interesting_files,
838
extra_trees=[self.this_tree])
839
this_interesting_files = self.this_tree.find_related_paths_across_trees(
840
self.interesting_files, trees=[self.other_tree])
841
this_entries = dict(self.this_tree.iter_entries_by_dir(
842
specific_files=this_interesting_files))
843
for change in iterator:
844
if change.path[0] is not None:
845
this_path = _mod_tree.find_previous_path(
846
self.base_tree, self.this_tree, change.path[0])
848
this_path = _mod_tree.find_previous_path(
849
self.other_tree, self.this_tree, change.path[1])
850
this_entry = this_entries.get(this_path)
851
if this_entry is not None:
852
this_name = this_entry.name
853
this_parent = this_entry.parent_id
854
this_executable = this_entry.executable
901
857
this_parent = None
902
858
this_executable = None
903
parents3 = parents + (this_parent,)
904
names3 = names + (this_name,)
905
executable3 = executable + (this_executable,)
906
result.append((file_id, changed, parents3, names3, executable3))
859
parents3 = change.parent_id + (this_parent,)
860
names3 = change.name + (this_name,)
861
paths3 = change.path + (this_path, )
862
executable3 = change.executable + (this_executable,)
864
(change.file_id, change.changed_content, paths3,
865
parents3, names3, executable3))
909
868
def _entries_lca(self):
913
872
it then compares with THIS and BASE.
915
874
For the multi-valued entries, the format will be (BASE, [lca1, lca2])
916
:return: [(file_id, changed, parents, names, executable)]
917
file_id Simple file_id of the entry
918
changed Boolean, True if the kind or contents changed
920
parents ((base, [parent_id, in, lcas]), parent_id_other,
922
names ((base, [name, in, lcas]), name_in_other, name_in_this)
923
executable ((base, [exec, in, lcas]), exec_in_other, exec_in_this)
876
:return: [(file_id, changed, paths, parents, names, executable)], where:
878
* file_id: Simple file_id of the entry
879
* changed: Boolean, True if the kind or contents changed else False
880
* paths: ((base, [path, in, lcas]), path_other, path_this)
881
* parents: ((base, [parent_id, in, lcas]), parent_id_other,
883
* names: ((base, [name, in, lcas]), name_in_other, name_in_this)
884
* executable: ((base, [exec, in, lcas]), exec_in_other,
925
887
if self.interesting_files is not None:
926
888
lookup_trees = [self.this_tree, self.base_tree]
927
889
lookup_trees.extend(self._lca_trees)
928
890
# I think we should include the lca trees as well
929
interesting_ids = self.other_tree.paths2ids(self.interesting_files,
891
interesting_files = self.other_tree.find_related_paths_across_trees(
892
self.interesting_files, lookup_trees)
932
interesting_ids = self.interesting_ids
894
interesting_files = None
934
walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
896
from .multiwalker import MultiWalker
897
walker = MultiWalker(self.other_tree, self._lca_trees)
936
base_inventory = self.base_tree.inventory
937
this_inventory = self.this_tree.inventory
938
for path, file_id, other_ie, lca_values in walker.iter_all():
899
for other_path, file_id, other_ie, lca_values in walker.iter_all():
939
900
# Is this modified at all from any of the other trees?
940
901
if other_ie is None:
941
902
other_ie = _none_entry
942
if interesting_ids is not None and file_id not in interesting_ids:
904
if interesting_files is not None and other_path not in interesting_files:
945
907
# If other_revision is found in any of the lcas, that means this
1023
998
(base_ie.executable, lca_executable),
1024
999
other_ie.executable, this_ie.executable)
1025
1000
if (parent_id_winner == 'this' and name_winner == 'this'
1026
and sha1_winner == 'this' and exec_winner == 'this'):
1001
and sha1_winner == 'this' and exec_winner == 'this'):
1027
1002
# No kind, parent, name, exec, or content change for
1028
1003
# OTHER, so this node is not considered interesting
1030
1005
if sha1_winner == 'this':
1031
1006
content_changed = False
1032
1007
elif other_ie.kind == 'symlink':
1033
def get_target(ie, tree):
1008
def get_target(ie, tree, path):
1034
1009
if ie.kind != 'symlink':
1036
return tree.get_symlink_target(file_id)
1037
base_target = get_target(base_ie, self.base_tree)
1038
lca_targets = [get_target(ie, tree) for ie, tree
1039
in zip(lca_entries, self._lca_trees)]
1040
this_target = get_target(this_ie, self.this_tree)
1041
other_target = get_target(other_ie, self.other_tree)
1011
return tree.get_symlink_target(path)
1012
base_target = get_target(base_ie, self.base_tree, base_path)
1013
lca_targets = [get_target(ie, tree, lca_path) for ie, tree, lca_path
1014
in zip(lca_entries, self._lca_trees, lca_paths)]
1015
this_target = get_target(
1016
this_ie, self.this_tree, this_path)
1017
other_target = get_target(
1018
other_ie, self.other_tree, other_path)
1042
1019
target_winner = self._lca_multi_way(
1043
1020
(base_target, lca_targets),
1044
1021
other_target, this_target)
1045
1022
if (parent_id_winner == 'this' and name_winner == 'this'
1046
and target_winner == 'this'):
1023
and target_winner == 'this'):
1047
1024
# No kind, parent, name, or symlink target change
1048
1025
# not interesting
1063
1040
# If we have gotten this far, that means something has changed
1064
1041
result.append((file_id, content_changed,
1042
((base_path, lca_paths),
1043
other_path, this_path),
1065
1044
((base_ie.parent_id, lca_parent_ids),
1066
1045
other_ie.parent_id, this_ie.parent_id),
1067
1046
((base_ie.name, lca_names),
1068
1047
other_ie.name, this_ie.name),
1069
1048
((base_ie.executable, lca_executable),
1070
1049
other_ie.executable, this_ie.executable)
1077
self.tt.final_kind(self.tt.root)
1078
except errors.NoSuchFile:
1079
self.tt.cancel_deletion(self.tt.root)
1080
if self.tt.final_file_id(self.tt.root) is None:
1081
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
1083
other_root_file_id = self.other_tree.get_root_id()
1084
if other_root_file_id is None:
1086
other_root = self.tt.trans_id_file_id(other_root_file_id)
1087
if other_root == self.tt.root:
1089
if self.other_tree.inventory.root.file_id in self.this_tree.inventory:
1090
# the other tree's root is a non-root in the current tree (as when
1091
# a previously unrelated branch is merged into another)
1094
self.tt.final_kind(other_root)
1095
other_root_is_present = True
1096
except errors.NoSuchFile:
1097
# other_root doesn't have a physical representation. We still need
1098
# to move any references to the actual root of the tree.
1099
other_root_is_present = False
1100
# 'other_tree.inventory.root' is not present in this tree. We are
1101
# calling adjust_path for children which *want* to be present with a
1102
# correct place to go.
1103
for thing, child in self.other_tree.inventory.root.children.iteritems():
1104
trans_id = self.tt.trans_id_file_id(child.file_id)
1105
if not other_root_is_present:
1106
# FIXME: Make final_kind returns None instead of raising
1107
# NoSuchFile to avoid the ugly construct below -- vila 20100402
1109
self.tt.final_kind(trans_id)
1110
# The item exist in the final tree and has a defined place
1113
except errors.NoSuchFile, e:
1115
# Move the item into the root
1116
self.tt.adjust_path(self.tt.final_name(trans_id),
1117
self.tt.root, trans_id)
1118
if other_root_is_present:
1119
self.tt.cancel_creation(other_root)
1120
self.tt.cancel_versioning(other_root)
1122
1053
def write_modified(self, results):
1054
if not self.working_tree.supports_merge_modified():
1123
1056
modified_hashes = {}
1124
1057
for path in results.modified_paths:
1125
file_id = self.this_tree.path2id(self.this_tree.relpath(path))
1058
wt_relpath = self.working_tree.relpath(path)
1059
if not self.working_tree.is_versioned(wt_relpath):
1128
hash = self.this_tree.get_file_sha1(file_id)
1061
hash = self.working_tree.get_file_sha1(wt_relpath)
1129
1062
if hash is None:
1131
modified_hashes[file_id] = hash
1132
self.this_tree.set_merge_modified(modified_hashes)
1064
modified_hashes[wt_relpath] = hash
1065
self.working_tree.set_merge_modified(modified_hashes)
1135
def parent(entry, file_id):
1136
1069
"""Determine the parent for a file_id (used as a key method)"""
1137
1070
if entry is None:
1139
1072
return entry.parent_id
1142
def name(entry, file_id):
1143
1076
"""Determine the name for a file_id (used as a key method)"""
1144
1077
if entry is None:
1146
1079
return entry.name
1149
def contents_sha1(tree, file_id):
1082
def contents_sha1(tree, path):
1150
1083
"""Determine the sha1 of the file contents (used as a key method)."""
1151
if file_id not in tree:
1085
return tree.get_file_sha1(path)
1086
except errors.NoSuchFile:
1153
return tree.get_file_sha1(file_id)
1156
def executable(tree, file_id):
1090
def executable(tree, path):
1157
1091
"""Determine the executability of a file-id (used as a key method)."""
1158
if not tree.has_id(file_id):
1093
if tree.kind(path) != "file":
1095
except errors.NoSuchFile:
1160
if tree.kind(file_id) != "file":
1162
return tree.is_executable(file_id)
1097
return tree.is_executable(path)
1165
def kind(tree, file_id):
1100
def kind(tree, path):
1166
1101
"""Determine the kind of a file-id (used as a key method)."""
1167
if not tree.has_id(file_id):
1103
return tree.kind(path)
1104
except errors.NoSuchFile:
1169
return tree.kind(file_id)
1172
1108
def _three_way(base, other, this):
1234
1170
# At this point, the lcas disagree, and the tip disagree
1235
1171
return 'conflict'
1238
@deprecated_method(deprecated_in((2, 2, 0)))
1239
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
1240
"""Do a three-way test on a scalar.
1241
Return "this", "other" or "conflict", depending whether a value wins.
1243
key_base = key(base_tree, file_id)
1244
key_other = key(other_tree, file_id)
1245
#if base == other, either they all agree, or only THIS has changed.
1246
if key_base == key_other:
1248
key_this = key(this_tree, file_id)
1249
# "Ambiguous clean merge"
1250
if key_this == key_other:
1252
elif key_this == key_base:
1257
def merge_names(self, file_id):
1258
def get_entry(tree):
1259
if tree.has_id(file_id):
1260
return tree.inventory[file_id]
1263
this_entry = get_entry(self.this_tree)
1264
other_entry = get_entry(self.other_tree)
1265
base_entry = get_entry(self.base_tree)
1266
entries = (base_entry, other_entry, this_entry)
1269
for entry in entries:
1272
parents.append(None)
1274
names.append(entry.name)
1275
parents.append(entry.parent_id)
1276
return self._merge_names(file_id, parents, names,
1277
resolver=self._three_way)
1279
def _merge_names(self, file_id, parents, names, resolver):
1173
def _merge_names(self, file_id, paths, parents, names, resolver):
1280
1174
"""Perform a merge on file_id names and parents"""
1281
1175
base_name, other_name, this_name = names
1282
1176
base_parent, other_parent, this_parent = parents
1177
unused_base_path, other_path, this_path = paths
1284
1179
name_winner = resolver(*names)
1299
1194
self._raw_conflicts.append(('path conflict', trans_id, file_id,
1300
1195
this_parent, this_name,
1301
1196
other_parent, other_name))
1302
if other_name is None:
1197
if other_path is None:
1303
1198
# it doesn't matter whether the result was 'other' or
1304
# 'conflict'-- if there's no 'other', we leave it alone.
1199
# 'conflict'-- if it has no file id, we leave it alone.
1306
1201
parent_id = parents[self.winner_idx[parent_id_winner]]
1307
if parent_id is not None:
1202
name = names[self.winner_idx[name_winner]]
1203
if parent_id is not None or name is not None:
1308
1204
# if we get here, name_winner and parent_winner are set to safe
1310
self.tt.adjust_path(names[self.winner_idx[name_winner]],
1311
self.tt.trans_id_file_id(parent_id),
1206
if parent_id is None and name is not None:
1207
# if parent_id is None and name is non-None, current file is
1209
if names[self.winner_idx[parent_id_winner]] != '':
1210
raise AssertionError(
1211
'File looks like a root, but named %s' %
1212
names[self.winner_idx[parent_id_winner]])
1213
parent_trans_id = transform.ROOT_PARENT
1215
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1216
self.tt.adjust_path(name, parent_trans_id,
1312
1217
self.tt.trans_id_file_id(file_id))
1314
def _do_merge_contents(self, file_id):
1219
def _do_merge_contents(self, paths, file_id):
1315
1220
"""Performs a merge on file_id contents."""
1316
def contents_pair(tree):
1317
if file_id not in tree:
1319
kind = tree.kind(file_id)
1221
def contents_pair(tree, path):
1225
kind = tree.kind(path)
1226
except errors.NoSuchFile:
1320
1228
if kind == "file":
1321
contents = tree.get_file_sha1(file_id)
1229
contents = tree.get_file_sha1(path)
1322
1230
elif kind == "symlink":
1323
contents = tree.get_symlink_target(file_id)
1231
contents = tree.get_symlink_target(path)
1325
1233
contents = None
1326
1234
return kind, contents
1236
base_path, other_path, this_path = paths
1328
1237
# See SPOT run. run, SPOT, run.
1329
1238
# So we're not QUITE repeating ourselves; we do tricky things with
1331
base_pair = contents_pair(self.base_tree)
1332
other_pair = contents_pair(self.other_tree)
1240
other_pair = contents_pair(self.other_tree, other_path)
1241
this_pair = contents_pair(self.this_tree, this_path)
1333
1242
if self._lca_trees:
1334
this_pair = contents_pair(self.this_tree)
1335
lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
1243
(base_path, lca_paths) = base_path
1244
base_pair = contents_pair(self.base_tree, base_path)
1245
lca_pairs = [contents_pair(tree, path)
1246
for tree, path in zip(self._lca_trees, lca_paths)]
1336
1247
winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
1337
1248
this_pair, allow_overriding_lca=False)
1250
base_pair = contents_pair(self.base_tree, base_path)
1339
1251
if base_pair == other_pair:
1340
1252
winner = 'this'
1342
1254
# We delayed evaluating this_pair as long as we can to avoid
1343
1255
# unnecessary sha1 calculation
1344
this_pair = contents_pair(self.this_tree)
1256
this_pair = contents_pair(self.this_tree, this_path)
1345
1257
winner = self._three_way(base_pair, other_pair, this_pair)
1346
1258
if winner == 'this':
1347
1259
# No interesting changes introduced by OTHER
1358
1272
if hook_status != 'not_applicable':
1359
1273
# Don't try any more hooks, this one applies.
1275
# If the merge ends up replacing the content of the file, we get rid of
1276
# it at the end of this method (this variable is used to track the
1277
# exceptions to this rule).
1361
1279
result = "modified"
1362
1280
if hook_status == 'not_applicable':
1363
# This is a contents conflict, because none of the available
1364
# functions could merge it.
1281
# No merge hook was able to resolve the situation. Two cases exist:
1282
# a content conflict or a duplicate one.
1366
1284
name = self.tt.final_name(trans_id)
1367
1285
parent_id = self.tt.final_parent(trans_id)
1368
if self.this_tree.has_id(file_id):
1369
self.tt.unversion_file(trans_id)
1370
file_group = self._dump_conflicts(name, parent_id, file_id,
1372
self._raw_conflicts.append(('contents conflict', file_group))
1286
inhibit_content_conflict = False
1287
if params.this_kind is None: # file_id is not in THIS
1288
# Is the name used for a different file_id ?
1289
if self.this_tree.is_versioned(other_path):
1290
# Two entries for the same path
1292
# versioning the merged file will trigger a duplicate
1294
self.tt.version_file(file_id, trans_id)
1295
transform.create_from_tree(
1296
self.tt, trans_id, self.other_tree,
1298
filter_tree_path=self._get_filter_tree_path(other_path))
1299
inhibit_content_conflict = True
1300
elif params.other_kind is None: # file_id is not in OTHER
1301
# Is the name used for a different file_id ?
1302
if self.other_tree.is_versioned(this_path):
1303
# Two entries for the same path again, but here, the other
1304
# entry will also be merged. We simply inhibit the
1305
# 'content' conflict creation because we know OTHER will
1306
# create (or has already created depending on ordering) an
1307
# entry at the same path. This will trigger a 'duplicate'
1310
inhibit_content_conflict = True
1311
if not inhibit_content_conflict:
1312
if params.this_kind is not None:
1313
self.tt.unversion_file(trans_id)
1314
# This is a contents conflict, because none of the available
1315
# functions could merge it.
1316
file_group = self._dump_conflicts(
1317
name, (base_path, other_path, this_path), parent_id,
1318
file_id, set_version=True)
1319
self._raw_conflicts.append(('contents conflict', file_group))
1373
1320
elif hook_status == 'success':
1374
1321
self.tt.create_file(lines, trans_id)
1375
1322
elif hook_status == 'conflicted':
1444
1376
# BASE is a file, or both converted to files, so at least we
1445
1377
# have agreement that output should be a file.
1447
self.text_merge(merge_hook_params.file_id,
1448
merge_hook_params.trans_id)
1379
self.text_merge(merge_hook_params.trans_id,
1380
merge_hook_params.paths, merge_hook_params.file_id)
1449
1381
except errors.BinaryFile:
1450
1382
return 'not_applicable', None
1451
1383
return 'done', None
1453
1385
return 'not_applicable', None
1455
def get_lines(self, tree, file_id):
1387
def get_lines(self, tree, path):
1456
1388
"""Return the lines in a file, or an empty list."""
1457
if tree.has_id(file_id):
1458
return tree.get_file(file_id).readlines()
1392
kind = tree.kind(path)
1393
except errors.NoSuchFile:
1398
return tree.get_file_lines(path)
1462
def text_merge(self, file_id, trans_id):
1400
def text_merge(self, trans_id, paths, file_id):
1463
1401
"""Perform a three-way text merge on a file_id"""
1464
1402
# it's possible that we got here with base as a different type.
1465
1403
# if so, we just want two-way text conflicts.
1466
if self.base_tree.has_id(file_id) and \
1467
self.base_tree.kind(file_id) == "file":
1468
base_lines = self.get_lines(self.base_tree, file_id)
1471
other_lines = self.get_lines(self.other_tree, file_id)
1472
this_lines = self.get_lines(self.this_tree, file_id)
1404
base_path, other_path, this_path = paths
1405
base_lines = self.get_lines(self.base_tree, base_path)
1406
other_lines = self.get_lines(self.other_tree, other_path)
1407
this_lines = self.get_lines(self.this_tree, this_path)
1473
1408
m3 = merge3.Merge3(base_lines, this_lines, other_lines,
1474
1409
is_cherrypick=self.cherrypick)
1475
start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
1410
start_marker = b"!START OF MERGE CONFLICT!" + b"I HOPE THIS IS UNIQUE"
1476
1411
if self.show_base is True:
1477
base_marker = '|' * 7
1412
base_marker = b'|' * 7
1479
1414
base_marker = None
1481
1416
def iter_merge3(retval):
1482
1417
retval["text_conflicts"] = False
1483
for line in m3.merge_lines(name_a = "TREE",
1484
name_b = "MERGE-SOURCE",
1485
name_base = "BASE-REVISION",
1418
for line in m3.merge_lines(name_a=b"TREE",
1419
name_b=b"MERGE-SOURCE",
1420
name_base=b"BASE-REVISION",
1486
1421
start_marker=start_marker,
1487
1422
base_marker=base_marker,
1488
1423
reprocess=self.reprocess):
1489
1424
if line.startswith(start_marker):
1490
1425
retval["text_conflicts"] = True
1491
yield line.replace(start_marker, '<' * 7)
1426
yield line.replace(start_marker, b'<' * 7)
1532
1482
versioned = False
1533
1483
file_group = []
1534
for suffix, tree, lines in data:
1535
if tree.has_id(file_id):
1536
trans_id = self._conflict_file(name, parent_id, tree, file_id,
1537
suffix, lines, filter_tree_path)
1484
for suffix, tree, path, lines in data:
1485
if path is not None:
1486
trans_id = self._conflict_file(
1487
name, parent_id, path, tree, suffix, lines,
1538
1489
file_group.append(trans_id)
1539
1490
if set_version and not versioned:
1540
1491
self.tt.version_file(file_id, trans_id)
1541
1492
versioned = True
1542
1493
return file_group
1544
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1495
def _conflict_file(self, name, parent_id, path, tree, suffix,
1545
1496
lines=None, filter_tree_path=None):
1546
1497
"""Emit a single conflict file."""
1547
1498
name = name + '.' + suffix
1548
1499
trans_id = self.tt.create_path(name, parent_id)
1549
transform.create_from_tree(self.tt, trans_id, tree, file_id, lines,
1500
transform.create_from_tree(
1501
self.tt, trans_id, tree, path,
1503
filter_tree_path=filter_tree_path)
1551
1504
return trans_id
1553
def merge_executable(self, file_id, file_status):
1506
def merge_executable(self, paths, file_id, file_status):
1554
1507
"""Perform a merge on the execute bit."""
1555
executable = [self.executable(t, file_id) for t in (self.base_tree,
1556
self.other_tree, self.this_tree)]
1557
self._merge_executable(file_id, executable, file_status,
1508
executable = [self.executable(t, p, file_id)
1509
for t, p in zip([self.base_tree, self.other_tree, self.this_tree], paths)]
1510
self._merge_executable(paths, file_id, executable, file_status,
1558
1511
resolver=self._three_way)
1560
def _merge_executable(self, file_id, executable, file_status,
1513
def _merge_executable(self, paths, file_id, executable, file_status,
1562
1515
"""Perform a merge on the execute bit."""
1563
1516
base_executable, other_executable, this_executable = executable
1517
base_path, other_path, this_path = paths
1564
1518
if file_status == "deleted":
1566
1520
winner = resolver(*executable)
1567
1521
if winner == "conflict":
1568
# There must be a None in here, if we have a conflict, but we
1569
# need executability since file status was not deleted.
1570
if self.executable(self.other_tree, file_id) is None:
1522
# There must be a None in here, if we have a conflict, but we
1523
# need executability since file status was not deleted.
1524
if other_path is None:
1571
1525
winner = "this"
1573
1527
winner = "other"
1574
1528
if winner == 'this' and file_status != "modified":
1576
1530
trans_id = self.tt.trans_id_file_id(file_id)
1578
if self.tt.final_kind(trans_id) != "file":
1580
except errors.NoSuchFile:
1531
if self.tt.final_kind(trans_id) != "file":
1582
1533
if winner == "this":
1583
1534
executability = this_executable
1585
if self.other_tree.has_id(file_id):
1536
if other_path is not None:
1586
1537
executability = other_executable
1587
elif self.this_tree.has_id(file_id):
1538
elif this_path is not None:
1588
1539
executability = this_executable
1589
elif self.base_tree_has_id(file_id):
1540
elif base_path is not None:
1590
1541
executability = base_executable
1591
1542
if executability is not None:
1592
1543
trans_id = self.tt.trans_id_file_id(file_id)
1704
1677
class LCAMerger(WeaveMerger):
1679
requires_file_merge_plan = True
1706
1681
def _generate_merge_plan(self, file_id, base):
1707
1682
return self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
1710
1686
class Diff3Merger(Merge3Merger):
1711
1687
"""Three-way merger using external diff3 for text merging"""
1713
def dump_file(self, temp_dir, name, tree, file_id):
1689
requires_file_merge_plan = False
1691
def dump_file(self, temp_dir, name, tree, path):
1714
1692
out_path = osutils.pathjoin(temp_dir, name)
1715
out_file = open(out_path, "wb")
1717
in_file = tree.get_file(file_id)
1693
with open(out_path, "wb") as out_file:
1694
in_file = tree.get_file(path)
1718
1695
for line in in_file:
1719
1696
out_file.write(line)
1722
1697
return out_path
1724
def text_merge(self, file_id, trans_id):
1699
def text_merge(self, trans_id, paths, file_id):
1725
1700
"""Perform a diff3 merge using a specified file-id and trans-id.
1726
1701
If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
1727
1702
will be dumped, and a will be conflict noted.
1705
base_path, other_path, this_path = paths
1730
1706
temp_dir = osutils.mkdtemp(prefix="bzr-")
1732
1708
new_file = osutils.pathjoin(temp_dir, "new")
1733
this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
1734
base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
1735
other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
1736
status = bzrlib.patch.diff3(new_file, this, base, other)
1709
this = self.dump_file(
1710
temp_dir, "this", self.this_tree, this_path)
1711
base = self.dump_file(
1712
temp_dir, "base", self.base_tree, base_path)
1713
other = self.dump_file(
1714
temp_dir, "other", self.other_tree, other_path)
1715
status = breezy.patch.diff3(new_file, this, base, other)
1737
1716
if status not in (0, 1):
1738
1717
raise errors.BzrError("Unhandled diff3 exit code")
1739
f = open(new_file, 'rb')
1718
with open(new_file, 'rb') as f:
1741
1719
self.tt.create_file(f, trans_id)
1744
1720
if status == 1:
1745
1721
name = self.tt.final_name(trans_id)
1746
1722
parent_id = self.tt.final_parent(trans_id)
1747
self._dump_conflicts(name, parent_id, file_id)
1723
self._dump_conflicts(name, paths, parent_id, file_id)
1748
1724
self._raw_conflicts.append(('text conflict', trans_id))
1750
1726
osutils.rmtree(temp_dir)
1729
class PathNotInTree(errors.BzrError):
1731
_fmt = """Merge-into failed because %(tree)s does not contain %(path)s."""
1733
def __init__(self, path, tree):
1734
errors.BzrError.__init__(self, path=path, tree=tree)
1737
class MergeIntoMerger(Merger):
1738
"""Merger that understands other_tree will be merged into a subdir.
1740
This also changes the Merger api so that it uses real Branch, revision_id,
1741
and RevisonTree objects, rather than using revision specs.
1744
def __init__(self, this_tree, other_branch, other_tree, target_subdir,
1745
source_subpath, other_rev_id=None):
1746
"""Create a new MergeIntoMerger object.
1748
source_subpath in other_tree will be effectively copied to
1749
target_subdir in this_tree.
1751
:param this_tree: The tree that we will be merging into.
1752
:param other_branch: The Branch we will be merging from.
1753
:param other_tree: The RevisionTree object we want to merge.
1754
:param target_subdir: The relative path where we want to merge
1755
other_tree into this_tree
1756
:param source_subpath: The relative path specifying the subtree of
1757
other_tree to merge into this_tree.
1759
# It is assumed that we are merging a tree that is not in our current
1760
# ancestry, which means we are using the "EmptyTree" as our basis.
1761
null_ancestor_tree = this_tree.branch.repository.revision_tree(
1762
_mod_revision.NULL_REVISION)
1763
super(MergeIntoMerger, self).__init__(
1764
this_branch=this_tree.branch,
1765
this_tree=this_tree,
1766
other_tree=other_tree,
1767
base_tree=null_ancestor_tree,
1769
self._target_subdir = target_subdir
1770
self._source_subpath = source_subpath
1771
self.other_branch = other_branch
1772
if other_rev_id is None:
1773
other_rev_id = other_tree.get_revision_id()
1774
self.other_rev_id = self.other_basis = other_rev_id
1775
self.base_is_ancestor = True
1776
self.backup_files = True
1777
self.merge_type = Merge3Merger
1778
self.show_base = False
1779
self.reprocess = False
1780
self.interesting_files = None
1781
self.merge_type = _MergeTypeParameterizer(MergeIntoMergeType,
1782
target_subdir=self._target_subdir,
1783
source_subpath=self._source_subpath)
1784
if self._source_subpath != '':
1785
# If this isn't a partial merge make sure the revisions will be
1787
self._maybe_fetch(self.other_branch, self.this_branch,
1790
def set_pending(self):
1791
if self._source_subpath != '':
1793
Merger.set_pending(self)
1796
class _MergeTypeParameterizer(object):
1797
"""Wrap a merge-type class to provide extra parameters.
1799
This is hack used by MergeIntoMerger to pass some extra parameters to its
1800
merge_type. Merger.do_merge() sets up its own set of parameters to pass to
1801
the 'merge_type' member. It is difficult override do_merge without
1802
re-writing the whole thing, so instead we create a wrapper which will pass
1803
the extra parameters.
1806
def __init__(self, merge_type, **kwargs):
1807
self._extra_kwargs = kwargs
1808
self._merge_type = merge_type
1810
def __call__(self, *args, **kwargs):
1811
kwargs.update(self._extra_kwargs)
1812
return self._merge_type(*args, **kwargs)
1814
def __getattr__(self, name):
1815
return getattr(self._merge_type, name)
1818
class MergeIntoMergeType(Merge3Merger):
1819
"""Merger that incorporates a tree (or part of a tree) into another."""
1821
def __init__(self, *args, **kwargs):
1822
"""Initialize the merger object.
1824
:param args: See Merge3Merger.__init__'s args.
1825
:param kwargs: See Merge3Merger.__init__'s keyword args, except for
1826
source_subpath and target_subdir.
1827
:keyword source_subpath: The relative path specifying the subtree of
1828
other_tree to merge into this_tree.
1829
:keyword target_subdir: The relative path where we want to merge
1830
other_tree into this_tree
1832
# All of the interesting work happens during Merge3Merger.__init__(),
1833
# so we have have to hack in to get our extra parameters set.
1834
self._source_subpath = kwargs.pop('source_subpath')
1835
self._target_subdir = kwargs.pop('target_subdir')
1836
super(MergeIntoMergeType, self).__init__(*args, **kwargs)
1838
def _compute_transform(self):
1839
with ui.ui_factory.nested_progress_bar() as child_pb:
1840
entries = self._entries_to_incorporate()
1841
entries = list(entries)
1842
for num, (entry, parent_id, relpath) in enumerate(entries):
1843
child_pb.update(gettext('Preparing file merge'),
1845
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1846
path = osutils.pathjoin(self._source_subpath, relpath)
1847
trans_id = transform.new_by_entry(path, self.tt, entry,
1848
parent_trans_id, self.other_tree)
1849
self._finish_computing_transform()
1851
def _entries_to_incorporate(self):
1852
"""Yields pairs of (inventory_entry, new_parent)."""
1853
subdir_id = self.other_tree.path2id(self._source_subpath)
1854
if subdir_id is None:
1855
# XXX: The error would be clearer if it gave the URL of the source
1856
# branch, but we don't have a reference to that here.
1857
raise PathNotInTree(self._source_subpath, "Source tree")
1858
subdir = next(self.other_tree.iter_entries_by_dir(
1859
specific_files=[self._source_subpath]))[1]
1860
parent_in_target = osutils.dirname(self._target_subdir)
1861
target_id = self.this_tree.path2id(parent_in_target)
1862
if target_id is None:
1863
raise PathNotInTree(self._target_subdir, "Target tree")
1864
name_in_target = osutils.basename(self._target_subdir)
1865
merge_into_root = subdir.copy()
1866
merge_into_root.name = name_in_target
1867
if self.this_tree.has_id(merge_into_root.file_id):
1868
# Give the root a new file-id.
1869
# This can happen fairly easily if the directory we are
1870
# incorporating is the root, and both trees have 'TREE_ROOT' as
1871
# their root_id. Users will expect this to Just Work, so we
1872
# change the file-id here.
1873
# Non-root file-ids could potentially conflict too. That's really
1874
# an edge case, so we don't do anything special for those. We let
1875
# them cause conflicts.
1876
merge_into_root.file_id = generate_ids.gen_file_id(name_in_target)
1877
yield (merge_into_root, target_id, '')
1878
if subdir.kind != 'directory':
1879
# No children, so we are done.
1881
for path, entry in self.other_tree.root_inventory.iter_entries_by_dir(subdir_id):
1882
parent_id = entry.parent_id
1883
if parent_id == subdir.file_id:
1884
# The root's parent ID has changed, so make sure children of
1885
# the root refer to the new ID.
1886
parent_id = merge_into_root.file_id
1887
yield (entry, parent_id, path)
1753
1890
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1754
1891
backup_files=False,
1755
1892
merge_type=Merge3Merger,
1756
interesting_ids=None,
1757
1893
show_base=False,
1758
1894
reprocess=False,
1759
1895
other_rev_id=None,
1760
1896
interesting_files=None,
1761
1897
this_tree=None,
1763
1898
change_reporter=None):
1764
1899
"""Primary interface for merging.
1766
typical use is probably
1767
'merge_inner(branch, branch.get_revision_tree(other_revision),
1768
branch.get_revision_tree(base_revision))'
1901
Typical use is probably::
1903
merge_inner(branch, branch.get_revision_tree(other_revision),
1904
branch.get_revision_tree(base_revision))
1770
1906
if this_tree is None:
1771
raise errors.BzrError("bzrlib.merge.merge_inner requires a this_tree "
1772
"parameter as of bzrlib version 0.8.")
1907
raise errors.BzrError("breezy.merge.merge_inner requires a this_tree "
1773
1909
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1774
pb=pb, change_reporter=change_reporter)
1910
change_reporter=change_reporter)
1775
1911
merger.backup_files = backup_files
1776
1912
merger.merge_type = merge_type
1777
merger.interesting_ids = interesting_ids
1778
1913
merger.ignore_zero = ignore_zero
1779
if interesting_files:
1781
raise ValueError('Only supply interesting_ids'
1782
' or interesting_files')
1783
merger.interesting_files = interesting_files
1914
merger.interesting_files = interesting_files
1784
1915
merger.show_base = show_base
1785
1916
merger.reprocess = reprocess
1786
1917
merger.other_rev_id = other_rev_id
added
removed
breezy/merge.py
