40
from breezy.bzr import (
44
from breezy.i18n import gettext
39
from bzrlib.cleanup import OperationWithCleanups
40
from bzrlib.symbol_versioning import (
55
44
# TODO: Report back as changes are merged in
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)
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)
65
55
class MergeHooks(hooks.Hooks):
67
57
def __init__(self):
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.',
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 "
91
72
class AbstractPerFileMerger(object):
92
"""PerFileMerger objects are used by plugins extending merge for breezy.
94
See ``breezy.plugins.news_merge.news_merge`` for an example concrete class.
73
"""PerFileMerger objects are used by plugins extending merge for bzrlib.
75
See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
96
77
:ivar merger: The Merge3Merger performing the merge.
435
435
revision_id = _mod_revision.ensure_null(revision_id)
436
436
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
438
486
def set_interesting_files(self, file_list):
439
487
self.interesting_files = file_list
441
489
def set_pending(self):
442
490
if (not self.base_is_ancestor or not self.base_is_other_ancestor
443
or self.other_rev_id is None):
491
or self.other_rev_id is None):
445
493
self._add_parent()
447
495
def _add_parent(self):
448
496
new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
449
497
new_parent_trees = []
450
operation = cleanup.OperationWithCleanups(
451
self.this_tree.set_parent_trees)
498
operation = OperationWithCleanups(self.this_tree.set_parent_trees)
452
499
for revision_id in new_parents:
454
501
tree = self.revision_tree(revision_id)
795
839
entries = self._entries_lca()
796
840
resolver = self._lca_multi_way
797
# Prepare merge hooks
798
factories = Merger.hooks['merge_file_content']
799
# One hook for each registered one plus our default merger
800
hooks = [factory(self) for factory in factories] + [self]
801
self.active_hooks = [hook for hook in hooks if hook is not None]
802
with ui.ui_factory.nested_progress_bar() as child_pb:
803
for num, (file_id, changed, paths3, parents3, names3,
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,
804
847
executable3) in enumerate(entries):
805
trans_id = self.tt.trans_id_file_id(file_id)
807
# Try merging each entry
808
child_pb.update(gettext('Preparing file merge'),
810
self._merge_names(trans_id, file_id, paths3, parents3,
811
names3, resolver=resolver)
848
child_pb.update('Preparing file merge', num, len(entries))
849
self._merge_names(file_id, parents3, names3, resolver=resolver)
813
file_status = self._do_merge_contents(paths3, trans_id, file_id)
851
file_status = self._do_merge_contents(file_id)
815
853
file_status = 'unmodified'
816
self._merge_executable(paths3, trans_id, executable3,
817
file_status, resolver=resolver)
818
self.tt.fixup_new_roots()
819
self._finish_computing_transform()
821
def _finish_computing_transform(self):
822
"""Finalize the transform and report the changes.
824
This is the second half of _compute_transform.
826
with ui.ui_factory.nested_progress_bar() as child_pb:
827
fs_conflicts = transform.resolve_conflicts(
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,
829
862
lambda t, c: transform.conflict_pass(t, c, self.other_tree))
830
865
if self.change_reporter is not None:
831
from breezy import delta
866
from bzrlib import delta
832
867
delta.report_changes(
833
868
self.tt.iter_changes(), self.change_reporter)
834
869
self.cook_conflicts(fs_conflicts)
835
870
for conflict in self.cooked_conflicts:
836
trace.warning('%s', conflict.describe())
871
trace.warning(conflict)
838
873
def _entries3(self):
839
874
"""Gather data about files modified between three trees.
848
883
iterator = self.other_tree.iter_changes(self.base_tree,
849
specific_files=self.interesting_files,
850
extra_trees=[self.this_tree])
851
this_interesting_files = self.this_tree.find_related_paths_across_trees(
852
self.interesting_files, trees=[self.other_tree])
853
this_entries = dict(self.this_tree.iter_entries_by_dir(
854
specific_files=this_interesting_files))
855
for change in iterator:
856
if change.path[0] is not None:
857
this_path = _mod_tree.find_previous_path(
858
self.base_tree, self.this_tree, change.path[0])
860
this_path = _mod_tree.find_previous_path(
861
self.other_tree, self.this_tree, change.path[1])
862
this_entry = this_entries.get(this_path)
863
if this_entry is not None:
864
this_name = this_entry.name
865
this_parent = this_entry.parent_id
866
this_executable = this_entry.executable
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
869
901
this_parent = None
870
902
this_executable = None
871
parents3 = change.parent_id + (this_parent,)
872
names3 = change.name + (this_name,)
873
paths3 = change.path + (this_path, )
874
executable3 = change.executable + (this_executable,)
876
(change.file_id, change.changed_content, paths3,
877
parents3, names3, executable3))
903
parents3 = parents + (this_parent,)
904
names3 = names + (this_name,)
905
executable3 = executable + (this_executable,)
906
result.append((file_id, changed, parents3, names3, executable3))
880
909
def _entries_lca(self):
884
913
it then compares with THIS and BASE.
886
915
For the multi-valued entries, the format will be (BASE, [lca1, lca2])
888
:return: [(file_id, changed, paths, parents, names, executable)], where:
890
* file_id: Simple file_id of the entry
891
* changed: Boolean, True if the kind or contents changed else False
892
* paths: ((base, [path, in, lcas]), path_other, path_this)
893
* parents: ((base, [parent_id, in, lcas]), parent_id_other,
895
* names: ((base, [name, in, lcas]), name_in_other, name_in_this)
896
* executable: ((base, [exec, in, lcas]), exec_in_other,
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)
899
925
if self.interesting_files is not None:
900
926
lookup_trees = [self.this_tree, self.base_tree]
901
927
lookup_trees.extend(self._lca_trees)
902
928
# I think we should include the lca trees as well
903
interesting_files = self.other_tree.find_related_paths_across_trees(
904
self.interesting_files, lookup_trees)
929
interesting_ids = self.other_tree.paths2ids(self.interesting_files,
906
interesting_files = None
932
interesting_ids = self.interesting_ids
908
from .multiwalker import MultiWalker
909
walker = MultiWalker(self.other_tree, self._lca_trees)
934
walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
911
for other_path, file_id, other_ie, lca_values in walker.iter_all():
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():
912
939
# Is this modified at all from any of the other trees?
913
940
if other_ie is None:
914
941
other_ie = _none_entry
916
if interesting_files is not None and other_path not in interesting_files:
942
if interesting_ids is not None and file_id not in interesting_ids:
919
945
# If other_revision is found in any of the lcas, that means this
1010
1023
(base_ie.executable, lca_executable),
1011
1024
other_ie.executable, this_ie.executable)
1012
1025
if (parent_id_winner == 'this' and name_winner == 'this'
1013
and sha1_winner == 'this' and exec_winner == 'this'):
1026
and sha1_winner == 'this' and exec_winner == 'this'):
1014
1027
# No kind, parent, name, exec, or content change for
1015
1028
# OTHER, so this node is not considered interesting
1017
1030
if sha1_winner == 'this':
1018
1031
content_changed = False
1019
1032
elif other_ie.kind == 'symlink':
1020
def get_target(ie, tree, path):
1033
def get_target(ie, tree):
1021
1034
if ie.kind != 'symlink':
1023
return tree.get_symlink_target(path)
1024
base_target = get_target(base_ie, self.base_tree, base_path)
1025
lca_targets = [get_target(ie, tree, lca_path) for ie, tree, lca_path
1026
in zip(lca_entries, self._lca_trees, lca_paths)]
1027
this_target = get_target(
1028
this_ie, self.this_tree, this_path)
1029
other_target = get_target(
1030
other_ie, self.other_tree, other_path)
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)
1031
1042
target_winner = self._lca_multi_way(
1032
1043
(base_target, lca_targets),
1033
1044
other_target, this_target)
1034
1045
if (parent_id_winner == 'this' and name_winner == 'this'
1035
and target_winner == 'this'):
1046
and target_winner == 'this'):
1036
1047
# No kind, parent, name, or symlink target change
1037
1048
# not interesting
1052
1063
# If we have gotten this far, that means something has changed
1053
1064
result.append((file_id, content_changed,
1054
((base_path, lca_paths),
1055
other_path, this_path),
1056
1065
((base_ie.parent_id, lca_parent_ids),
1057
1066
other_ie.parent_id, this_ie.parent_id),
1058
1067
((base_ie.name, lca_names),
1059
1068
other_ie.name, this_ie.name),
1060
1069
((base_ie.executable, lca_executable),
1061
1070
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)
1065
1122
def write_modified(self, results):
1066
if not self.working_tree.supports_merge_modified():
1068
1123
modified_hashes = {}
1069
1124
for path in results.modified_paths:
1070
wt_relpath = self.working_tree.relpath(path)
1071
if not self.working_tree.is_versioned(wt_relpath):
1125
file_id = self.this_tree.path2id(self.this_tree.relpath(path))
1073
hash = self.working_tree.get_file_sha1(wt_relpath)
1128
hash = self.this_tree.get_file_sha1(file_id)
1074
1129
if hash is None:
1076
modified_hashes[wt_relpath] = hash
1077
self.working_tree.set_merge_modified(modified_hashes)
1131
modified_hashes[file_id] = hash
1132
self.this_tree.set_merge_modified(modified_hashes)
1135
def parent(entry, file_id):
1081
1136
"""Determine the parent for a file_id (used as a key method)"""
1082
1137
if entry is None:
1084
1139
return entry.parent_id
1142
def name(entry, file_id):
1088
1143
"""Determine the name for a file_id (used as a key method)"""
1089
1144
if entry is None:
1091
1146
return entry.name
1094
def contents_sha1(tree, path):
1149
def contents_sha1(tree, file_id):
1095
1150
"""Determine the sha1 of the file contents (used as a key method)."""
1097
return tree.get_file_sha1(path)
1098
except errors.NoSuchFile:
1151
if file_id not in tree:
1153
return tree.get_file_sha1(file_id)
1102
def executable(tree, path):
1156
def executable(tree, file_id):
1103
1157
"""Determine the executability of a file-id (used as a key method)."""
1105
if tree.kind(path) != "file":
1107
except errors.NoSuchFile:
1158
if not tree.has_id(file_id):
1109
return tree.is_executable(path)
1160
if tree.kind(file_id) != "file":
1162
return tree.is_executable(file_id)
1112
def kind(tree, path):
1165
def kind(tree, file_id):
1113
1166
"""Determine the kind of a file-id (used as a key method)."""
1115
return tree.kind(path)
1116
except errors.NoSuchFile:
1167
if not tree.has_id(file_id):
1169
return tree.kind(file_id)
1120
1172
def _three_way(base, other, this):
1182
1234
# At this point, the lcas disagree, and the tip disagree
1183
1235
return 'conflict'
1185
def _merge_names(self, trans_id, file_id, paths, parents, names, resolver):
1186
"""Perform a merge on file names and parents"""
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):
1280
"""Perform a merge on file_id names and parents"""
1187
1281
base_name, other_name, this_name = names
1188
1282
base_parent, other_parent, this_parent = parents
1189
unused_base_path, other_path, this_path = paths
1191
1284
name_winner = resolver(*names)
1202
1295
# Creating helpers (.OTHER or .THIS) here cause problems down the
1203
1296
# road if a ContentConflict needs to be created so we should not do
1298
trans_id = self.tt.trans_id_file_id(file_id)
1205
1299
self._raw_conflicts.append(('path conflict', trans_id, file_id,
1206
1300
this_parent, this_name,
1207
1301
other_parent, other_name))
1208
if other_path is None:
1302
if other_name is None:
1209
1303
# it doesn't matter whether the result was 'other' or
1210
# 'conflict'-- if it has no file id, we leave it alone.
1304
# 'conflict'-- if there's no 'other', we leave it alone.
1212
1306
parent_id = parents[self.winner_idx[parent_id_winner]]
1213
name = names[self.winner_idx[name_winner]]
1214
if parent_id is not None or name is not None:
1307
if parent_id is not None:
1215
1308
# if we get here, name_winner and parent_winner are set to safe
1217
if parent_id is None and name is not None:
1218
# if parent_id is None and name is non-None, current file is
1220
if names[self.winner_idx[parent_id_winner]] != '':
1221
raise AssertionError(
1222
'File looks like a root, but named %s' %
1223
names[self.winner_idx[parent_id_winner]])
1224
parent_trans_id = transform.ROOT_PARENT
1226
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1227
self.tt.adjust_path(name, parent_trans_id, trans_id)
1310
self.tt.adjust_path(names[self.winner_idx[name_winner]],
1311
self.tt.trans_id_file_id(parent_id),
1312
self.tt.trans_id_file_id(file_id))
1229
def _do_merge_contents(self, paths, trans_id, file_id):
1314
def _do_merge_contents(self, file_id):
1230
1315
"""Performs a merge on file_id contents."""
1231
def contents_pair(tree, path):
1235
kind = tree.kind(path)
1236
except errors.NoSuchFile:
1316
def contents_pair(tree):
1317
if file_id not in tree:
1319
kind = tree.kind(file_id)
1238
1320
if kind == "file":
1239
contents = tree.get_file_sha1(path)
1321
contents = tree.get_file_sha1(file_id)
1240
1322
elif kind == "symlink":
1241
contents = tree.get_symlink_target(path)
1323
contents = tree.get_symlink_target(file_id)
1243
1325
contents = None
1244
1326
return kind, contents
1246
base_path, other_path, this_path = paths
1247
1328
# See SPOT run. run, SPOT, run.
1248
1329
# So we're not QUITE repeating ourselves; we do tricky things with
1250
other_pair = contents_pair(self.other_tree, other_path)
1251
this_pair = contents_pair(self.this_tree, this_path)
1331
base_pair = contents_pair(self.base_tree)
1332
other_pair = contents_pair(self.other_tree)
1252
1333
if self._lca_trees:
1253
(base_path, lca_paths) = base_path
1254
base_pair = contents_pair(self.base_tree, base_path)
1255
lca_pairs = [contents_pair(tree, path)
1256
for tree, path in zip(self._lca_trees, lca_paths)]
1334
this_pair = contents_pair(self.this_tree)
1335
lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
1257
1336
winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
1258
1337
this_pair, allow_overriding_lca=False)
1260
base_pair = contents_pair(self.base_tree, base_path)
1261
1339
if base_pair == other_pair:
1262
1340
winner = 'this'
1264
1342
# We delayed evaluating this_pair as long as we can to avoid
1265
1343
# unnecessary sha1 calculation
1266
this_pair = contents_pair(self.this_tree, this_path)
1344
this_pair = contents_pair(self.this_tree)
1267
1345
winner = self._three_way(base_pair, other_pair, this_pair)
1268
1346
if winner == 'this':
1269
1347
# No interesting changes introduced by OTHER
1270
1348
return "unmodified"
1271
1349
# We have a hypothetical conflict, but if we have files, then we
1272
1350
# can try to merge the content
1273
params = MergeFileHookParams(
1274
self, (base_path, other_path, this_path), trans_id, this_pair[0],
1351
trans_id = self.tt.trans_id_file_id(file_id)
1352
params = MergeHookParams(self, file_id, trans_id, this_pair[0],
1275
1353
other_pair[0], winner)
1276
1354
hooks = self.active_hooks
1277
1355
hook_status = 'not_applicable'
1280
1358
if hook_status != 'not_applicable':
1281
1359
# Don't try any more hooks, this one applies.
1283
# If the merge ends up replacing the content of the file, we get rid of
1284
# it at the end of this method (this variable is used to track the
1285
# exceptions to this rule).
1287
1361
result = "modified"
1288
1362
if hook_status == 'not_applicable':
1289
# No merge hook was able to resolve the situation. Two cases exist:
1290
# a content conflict or a duplicate one.
1363
# This is a contents conflict, because none of the available
1364
# functions could merge it.
1292
1366
name = self.tt.final_name(trans_id)
1293
1367
parent_id = self.tt.final_parent(trans_id)
1294
inhibit_content_conflict = False
1295
if params.this_kind is None: # file_id is not in THIS
1296
# Is the name used for a different file_id ?
1297
if self.this_tree.is_versioned(other_path):
1298
# Two entries for the same path
1300
# versioning the merged file will trigger a duplicate
1302
self.tt.version_file(file_id, trans_id)
1303
transform.create_from_tree(
1304
self.tt, trans_id, self.other_tree,
1306
filter_tree_path=self._get_filter_tree_path(other_path))
1307
inhibit_content_conflict = True
1308
elif params.other_kind is None: # file_id is not in OTHER
1309
# Is the name used for a different file_id ?
1310
if self.other_tree.is_versioned(this_path):
1311
# Two entries for the same path again, but here, the other
1312
# entry will also be merged. We simply inhibit the
1313
# 'content' conflict creation because we know OTHER will
1314
# create (or has already created depending on ordering) an
1315
# entry at the same path. This will trigger a 'duplicate'
1318
inhibit_content_conflict = True
1319
if not inhibit_content_conflict:
1320
if params.this_kind is not None:
1321
self.tt.unversion_file(trans_id)
1322
# This is a contents conflict, because none of the available
1323
# functions could merge it.
1324
file_group = self._dump_conflicts(
1325
name, (base_path, other_path, this_path), parent_id,
1326
file_id, set_version=True)
1327
self._raw_conflicts.append(('contents conflict', file_group))
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))
1328
1373
elif hook_status == 'success':
1329
1374
self.tt.create_file(lines, trans_id)
1330
1375
elif hook_status == 'conflicted':
1347
1391
raise AssertionError('unknown hook_status: %r' % (hook_status,))
1348
if not this_path and result == "modified":
1392
if not self.this_tree.has_id(file_id) and result == "modified":
1349
1393
self.tt.version_file(file_id, trans_id)
1351
# The merge has been performed and produced a new content, so the
1352
# old contents should not be retained.
1394
# The merge has been performed, so the old contents should not be
1353
1397
self.tt.delete_contents(trans_id)
1398
except errors.NoSuchFile:
1356
1402
def _default_other_winner_merge(self, merge_hook_params):
1357
1403
"""Replace this contents with other."""
1404
file_id = merge_hook_params.file_id
1358
1405
trans_id = merge_hook_params.trans_id
1359
if merge_hook_params.other_path is not None:
1406
file_in_this = self.this_tree.has_id(file_id)
1407
if self.other_tree.has_id(file_id):
1360
1408
# OTHER changed the file
1361
transform.create_from_tree(
1362
self.tt, trans_id, self.other_tree,
1363
merge_hook_params.other_path,
1364
filter_tree_path=self._get_filter_tree_path(merge_hook_params.other_path))
1410
if wt.supports_content_filtering():
1411
# We get the path from the working tree if it exists.
1412
# That fails though when OTHER is adding a file, so
1413
# we fall back to the other tree to find the path if
1414
# it doesn't exist locally.
1416
filter_tree_path = wt.id2path(file_id)
1417
except errors.NoSuchId:
1418
filter_tree_path = self.other_tree.id2path(file_id)
1420
# Skip the id2path lookup for older formats
1421
filter_tree_path = None
1422
transform.create_from_tree(self.tt, trans_id,
1423
self.other_tree, file_id,
1424
filter_tree_path=filter_tree_path)
1365
1425
return 'done', None
1366
elif merge_hook_params.this_path is not None:
1367
1427
# OTHER deleted the file
1368
1428
return 'delete', None
1370
1430
raise AssertionError(
1371
'winner is OTHER, but file %r not in THIS or OTHER tree'
1372
% (merge_hook_params.base_path,))
1431
'winner is OTHER, but file_id %r not in THIS or OTHER tree'
1374
1434
def merge_contents(self, merge_hook_params):
1375
1435
"""Fallback merge logic after user installed hooks."""
1376
1436
# This function is used in merge hooks as the fallback instance.
1377
# Perhaps making this function and the functions it calls be a
1437
# Perhaps making this function and the functions it calls be a
1378
1438
# a separate class would be better.
1379
1439
if merge_hook_params.winner == 'other':
1380
1440
# OTHER is a straight winner, so replace this contents with other
1384
1444
# BASE is a file, or both converted to files, so at least we
1385
1445
# have agreement that output should be a file.
1387
self.text_merge(merge_hook_params.trans_id,
1388
merge_hook_params.paths)
1447
self.text_merge(merge_hook_params.file_id,
1448
merge_hook_params.trans_id)
1389
1449
except errors.BinaryFile:
1390
1450
return 'not_applicable', None
1391
1451
return 'done', None
1393
1453
return 'not_applicable', None
1395
def get_lines(self, tree, path):
1455
def get_lines(self, tree, file_id):
1396
1456
"""Return the lines in a file, or an empty list."""
1400
kind = tree.kind(path)
1401
except errors.NoSuchFile:
1457
if tree.has_id(file_id):
1458
return tree.get_file(file_id).readlines()
1406
return tree.get_file_lines(path)
1408
def text_merge(self, trans_id, paths):
1409
"""Perform a three-way text merge on a file"""
1462
def text_merge(self, file_id, trans_id):
1463
"""Perform a three-way text merge on a file_id"""
1410
1464
# it's possible that we got here with base as a different type.
1411
1465
# if so, we just want two-way text conflicts.
1412
base_path, other_path, this_path = paths
1413
base_lines = self.get_lines(self.base_tree, base_path)
1414
other_lines = self.get_lines(self.other_tree, other_path)
1415
this_lines = self.get_lines(self.this_tree, this_path)
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)
1416
1473
m3 = merge3.Merge3(base_lines, this_lines, other_lines,
1417
1474
is_cherrypick=self.cherrypick)
1418
start_marker = b"!START OF MERGE CONFLICT!" + b"I HOPE THIS IS UNIQUE"
1475
start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
1419
1476
if self.show_base is True:
1420
base_marker = b'|' * 7
1477
base_marker = '|' * 7
1422
1479
base_marker = None
1424
1481
def iter_merge3(retval):
1425
1482
retval["text_conflicts"] = False
1426
for line in m3.merge_lines(name_a=b"TREE",
1427
name_b=b"MERGE-SOURCE",
1428
name_base=b"BASE-REVISION",
1483
for line in m3.merge_lines(name_a = "TREE",
1484
name_b = "MERGE-SOURCE",
1485
name_base = "BASE-REVISION",
1429
1486
start_marker=start_marker,
1430
1487
base_marker=base_marker,
1431
1488
reprocess=self.reprocess):
1432
1489
if line.startswith(start_marker):
1433
1490
retval["text_conflicts"] = True
1434
yield line.replace(start_marker, b'<' * 7)
1491
yield line.replace(start_marker, '<' * 7)
1491
1532
versioned = False
1492
1533
file_group = []
1493
for suffix, tree, path, lines in data:
1494
if path is not None:
1495
trans_id = self._conflict_file(
1496
name, parent_id, path, tree, suffix, lines,
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)
1498
1538
file_group.append(trans_id)
1499
1539
if set_version and not versioned:
1500
1540
self.tt.version_file(file_id, trans_id)
1501
1541
versioned = True
1502
1542
return file_group
1504
def _conflict_file(self, name, parent_id, path, tree, suffix,
1544
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1505
1545
lines=None, filter_tree_path=None):
1506
1546
"""Emit a single conflict file."""
1507
1547
name = name + '.' + suffix
1508
1548
trans_id = self.tt.create_path(name, parent_id)
1509
transform.create_from_tree(
1510
self.tt, trans_id, tree, path,
1512
filter_tree_path=filter_tree_path)
1549
transform.create_from_tree(self.tt, trans_id, tree, file_id, lines,
1513
1551
return trans_id
1515
def _merge_executable(self, paths, trans_id, executable, file_status,
1553
def merge_executable(self, file_id, file_status):
1554
"""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,
1558
resolver=self._three_way)
1560
def _merge_executable(self, file_id, executable, file_status,
1517
1562
"""Perform a merge on the execute bit."""
1518
1563
base_executable, other_executable, this_executable = executable
1519
base_path, other_path, this_path = paths
1520
1564
if file_status == "deleted":
1522
1566
winner = resolver(*executable)
1523
1567
if winner == "conflict":
1524
# There must be a None in here, if we have a conflict, but we
1525
# need executability since file status was not deleted.
1526
if other_path is None:
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:
1527
1571
winner = "this"
1529
1573
winner = "other"
1530
1574
if winner == 'this' and file_status != "modified":
1532
if self.tt.final_kind(trans_id) != "file":
1576
trans_id = self.tt.trans_id_file_id(file_id)
1578
if self.tt.final_kind(trans_id) != "file":
1580
except errors.NoSuchFile:
1534
1582
if winner == "this":
1535
1583
executability = this_executable
1537
if other_path is not None:
1585
if self.other_tree.has_id(file_id):
1538
1586
executability = other_executable
1539
elif this_path is not None:
1587
elif self.this_tree.has_id(file_id):
1540
1588
executability = this_executable
1541
elif base_path is not None:
1589
elif self.base_tree_has_id(file_id):
1542
1590
executability = base_executable
1543
1591
if executability is not None:
1592
trans_id = self.tt.trans_id_file_id(file_id)
1544
1593
self.tt.set_executability(executability, trans_id)
1546
1595
def cook_conflicts(self, fs_conflicts):
1547
1596
"""Convert all conflicts into a form that doesn't depend on trans_id"""
1548
content_conflict_file_ids = set()
1549
cooked_conflicts = transform.cook_conflicts(fs_conflicts, self.tt)
1597
self.cooked_conflicts.extend(transform.cook_conflicts(
1598
fs_conflicts, self.tt))
1550
1599
fp = transform.FinalPaths(self.tt)
1551
1600
for conflict in self._raw_conflicts:
1552
1601
conflict_type = conflict[0]
1553
1602
if conflict_type == 'path conflict':
1554
1603
(trans_id, file_id,
1555
this_parent, this_name,
1556
other_parent, other_name) = conflict[1:]
1604
this_parent, this_name,
1605
other_parent, other_name) = conflict[1:]
1557
1606
if this_parent is None or this_name is None:
1558
1607
this_path = '<deleted>'
1560
parent_path = fp.get_path(
1609
parent_path = fp.get_path(
1561
1610
self.tt.trans_id_file_id(this_parent))
1562
1611
this_path = osutils.pathjoin(parent_path, this_name)
1563
1612
if other_parent is None or other_name is None:
1564
1613
other_path = '<deleted>'
1566
if other_parent == self.other_tree.get_root_id():
1567
# The tree transform doesn't know about the other root,
1568
# so we special case here to avoid a NoFinalPath
1572
parent_path = fp.get_path(
1573
self.tt.trans_id_file_id(other_parent))
1615
parent_path = fp.get_path(
1616
self.tt.trans_id_file_id(other_parent))
1574
1617
other_path = osutils.pathjoin(parent_path, other_name)
1575
1618
c = _mod_conflicts.Conflict.factory(
1576
1619
'path conflict', path=this_path,
1678
1704
class LCAMerger(WeaveMerger):
1680
requires_file_merge_plan = True
1682
def _generate_merge_plan(self, this_path, base):
1683
return self.this_tree.plan_file_lca_merge(this_path, self.other_tree,
1706
def _generate_merge_plan(self, file_id, base):
1707
return self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
1687
1710
class Diff3Merger(Merge3Merger):
1688
1711
"""Three-way merger using external diff3 for text merging"""
1690
requires_file_merge_plan = False
1692
def dump_file(self, temp_dir, name, tree, path):
1713
def dump_file(self, temp_dir, name, tree, file_id):
1693
1714
out_path = osutils.pathjoin(temp_dir, name)
1694
with open(out_path, "wb") as out_file:
1695
in_file = tree.get_file(path)
1715
out_file = open(out_path, "wb")
1717
in_file = tree.get_file(file_id)
1696
1718
for line in in_file:
1697
1719
out_file.write(line)
1698
1722
return out_path
1700
def text_merge(self, trans_id, paths):
1724
def text_merge(self, file_id, trans_id):
1701
1725
"""Perform a diff3 merge using a specified file-id and trans-id.
1702
1726
If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
1703
1727
will be dumped, and a will be conflict noted.
1706
base_path, other_path, this_path = paths
1707
1730
temp_dir = osutils.mkdtemp(prefix="bzr-")
1709
1732
new_file = osutils.pathjoin(temp_dir, "new")
1710
this = self.dump_file(
1711
temp_dir, "this", self.this_tree, this_path)
1712
base = self.dump_file(
1713
temp_dir, "base", self.base_tree, base_path)
1714
other = self.dump_file(
1715
temp_dir, "other", self.other_tree, other_path)
1716
status = breezy.patch.diff3(new_file, this, base, other)
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)
1717
1737
if status not in (0, 1):
1718
1738
raise errors.BzrError("Unhandled diff3 exit code")
1719
with open(new_file, 'rb') as f:
1739
f = open(new_file, 'rb')
1720
1741
self.tt.create_file(f, trans_id)
1721
1744
if status == 1:
1722
1745
name = self.tt.final_name(trans_id)
1723
1746
parent_id = self.tt.final_parent(trans_id)
1724
file_id = self.tt.final_file_id(trans_id)
1725
self._dump_conflicts(name, paths, parent_id, file_id)
1747
self._dump_conflicts(name, parent_id, file_id)
1726
1748
self._raw_conflicts.append(('text conflict', trans_id))
1728
1750
osutils.rmtree(temp_dir)
1731
class PathNotInTree(errors.BzrError):
1733
_fmt = """Merge-into failed because %(tree)s does not contain %(path)s."""
1735
def __init__(self, path, tree):
1736
errors.BzrError.__init__(self, path=path, tree=tree)
1739
class MergeIntoMerger(Merger):
1740
"""Merger that understands other_tree will be merged into a subdir.
1742
This also changes the Merger api so that it uses real Branch, revision_id,
1743
and RevisonTree objects, rather than using revision specs.
1746
def __init__(self, this_tree, other_branch, other_tree, target_subdir,
1747
source_subpath, other_rev_id=None):
1748
"""Create a new MergeIntoMerger object.
1750
source_subpath in other_tree will be effectively copied to
1751
target_subdir in this_tree.
1753
:param this_tree: The tree that we will be merging into.
1754
:param other_branch: The Branch we will be merging from.
1755
:param other_tree: The RevisionTree object we want to merge.
1756
:param target_subdir: The relative path where we want to merge
1757
other_tree into this_tree
1758
:param source_subpath: The relative path specifying the subtree of
1759
other_tree to merge into this_tree.
1761
# It is assumed that we are merging a tree that is not in our current
1762
# ancestry, which means we are using the "EmptyTree" as our basis.
1763
null_ancestor_tree = this_tree.branch.repository.revision_tree(
1764
_mod_revision.NULL_REVISION)
1765
super(MergeIntoMerger, self).__init__(
1766
this_branch=this_tree.branch,
1767
this_tree=this_tree,
1768
other_tree=other_tree,
1769
base_tree=null_ancestor_tree,
1771
self._target_subdir = target_subdir
1772
self._source_subpath = source_subpath
1773
self.other_branch = other_branch
1774
if other_rev_id is None:
1775
other_rev_id = other_tree.get_revision_id()
1776
self.other_rev_id = self.other_basis = other_rev_id
1777
self.base_is_ancestor = True
1778
self.backup_files = True
1779
self.merge_type = Merge3Merger
1780
self.show_base = False
1781
self.reprocess = False
1782
self.interesting_files = None
1783
self.merge_type = _MergeTypeParameterizer(MergeIntoMergeType,
1784
target_subdir=self._target_subdir,
1785
source_subpath=self._source_subpath)
1786
if self._source_subpath != '':
1787
# If this isn't a partial merge make sure the revisions will be
1789
self._maybe_fetch(self.other_branch, self.this_branch,
1792
def set_pending(self):
1793
if self._source_subpath != '':
1795
Merger.set_pending(self)
1798
class _MergeTypeParameterizer(object):
1799
"""Wrap a merge-type class to provide extra parameters.
1801
This is hack used by MergeIntoMerger to pass some extra parameters to its
1802
merge_type. Merger.do_merge() sets up its own set of parameters to pass to
1803
the 'merge_type' member. It is difficult override do_merge without
1804
re-writing the whole thing, so instead we create a wrapper which will pass
1805
the extra parameters.
1808
def __init__(self, merge_type, **kwargs):
1809
self._extra_kwargs = kwargs
1810
self._merge_type = merge_type
1812
def __call__(self, *args, **kwargs):
1813
kwargs.update(self._extra_kwargs)
1814
return self._merge_type(*args, **kwargs)
1816
def __getattr__(self, name):
1817
return getattr(self._merge_type, name)
1820
class MergeIntoMergeType(Merge3Merger):
1821
"""Merger that incorporates a tree (or part of a tree) into another."""
1823
def __init__(self, *args, **kwargs):
1824
"""Initialize the merger object.
1826
:param args: See Merge3Merger.__init__'s args.
1827
:param kwargs: See Merge3Merger.__init__'s keyword args, except for
1828
source_subpath and target_subdir.
1829
:keyword source_subpath: The relative path specifying the subtree of
1830
other_tree to merge into this_tree.
1831
:keyword target_subdir: The relative path where we want to merge
1832
other_tree into this_tree
1834
# All of the interesting work happens during Merge3Merger.__init__(),
1835
# so we have have to hack in to get our extra parameters set.
1836
self._source_subpath = kwargs.pop('source_subpath')
1837
self._target_subdir = kwargs.pop('target_subdir')
1838
super(MergeIntoMergeType, self).__init__(*args, **kwargs)
1840
def _compute_transform(self):
1841
with ui.ui_factory.nested_progress_bar() as child_pb:
1842
entries = self._entries_to_incorporate()
1843
entries = list(entries)
1844
for num, (entry, parent_id, relpath) in enumerate(entries):
1845
child_pb.update(gettext('Preparing file merge'),
1847
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1848
path = osutils.pathjoin(self._source_subpath, relpath)
1849
trans_id = transform.new_by_entry(path, self.tt, entry,
1850
parent_trans_id, self.other_tree)
1851
self._finish_computing_transform()
1853
def _entries_to_incorporate(self):
1854
"""Yields pairs of (inventory_entry, new_parent)."""
1855
subdir_id = self.other_tree.path2id(self._source_subpath)
1856
if subdir_id is None:
1857
# XXX: The error would be clearer if it gave the URL of the source
1858
# branch, but we don't have a reference to that here.
1859
raise PathNotInTree(self._source_subpath, "Source tree")
1860
subdir = next(self.other_tree.iter_entries_by_dir(
1861
specific_files=[self._source_subpath]))[1]
1862
parent_in_target = osutils.dirname(self._target_subdir)
1863
target_id = self.this_tree.path2id(parent_in_target)
1864
if target_id is None:
1865
raise PathNotInTree(self._target_subdir, "Target tree")
1866
name_in_target = osutils.basename(self._target_subdir)
1867
merge_into_root = subdir.copy()
1868
merge_into_root.name = name_in_target
1869
if self.this_tree.has_id(merge_into_root.file_id):
1870
# Give the root a new file-id.
1871
# This can happen fairly easily if the directory we are
1872
# incorporating is the root, and both trees have 'TREE_ROOT' as
1873
# their root_id. Users will expect this to Just Work, so we
1874
# change the file-id here.
1875
# Non-root file-ids could potentially conflict too. That's really
1876
# an edge case, so we don't do anything special for those. We let
1877
# them cause conflicts.
1878
merge_into_root.file_id = generate_ids.gen_file_id(name_in_target)
1879
yield (merge_into_root, target_id, '')
1880
if subdir.kind != 'directory':
1881
# No children, so we are done.
1883
for path, entry in self.other_tree.root_inventory.iter_entries_by_dir(subdir_id):
1884
parent_id = entry.parent_id
1885
if parent_id == subdir.file_id:
1886
# The root's parent ID has changed, so make sure children of
1887
# the root refer to the new ID.
1888
parent_id = merge_into_root.file_id
1889
yield (entry, parent_id, path)
1892
1753
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1893
1754
backup_files=False,
1894
1755
merge_type=Merge3Merger,
1756
interesting_ids=None,
1895
1757
show_base=False,
1896
1758
reprocess=False,
1897
1759
other_rev_id=None,
1898
1760
interesting_files=None,
1899
1761
this_tree=None,
1900
1763
change_reporter=None):
1901
1764
"""Primary interface for merging.
1903
Typical use is probably::
1905
merge_inner(branch, branch.get_revision_tree(other_revision),
1906
branch.get_revision_tree(base_revision))
1766
typical use is probably
1767
'merge_inner(branch, branch.get_revision_tree(other_revision),
1768
branch.get_revision_tree(base_revision))'
1908
1770
if this_tree is None:
1909
raise errors.BzrError("breezy.merge.merge_inner requires a this_tree "
1771
raise errors.BzrError("bzrlib.merge.merge_inner requires a this_tree "
1772
"parameter as of bzrlib version 0.8.")
1911
1773
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1912
change_reporter=change_reporter)
1774
pb=pb, change_reporter=change_reporter)
1913
1775
merger.backup_files = backup_files
1914
1776
merger.merge_type = merge_type
1777
merger.interesting_ids = interesting_ids
1915
1778
merger.ignore_zero = ignore_zero
1916
merger.interesting_files = interesting_files
1779
if interesting_files:
1781
raise ValueError('Only supply interesting_ids'
1782
' or interesting_files')
1783
merger.interesting_files = interesting_files
1917
1784
merger.show_base = show_base
1918
1785
merger.reprocess = reprocess
1919
1786
merger.other_rev_id = other_rev_id
added
removed
bzrlib/merge.py
