52
45
def transform_tree(from_tree, to_tree, interesting_ids=None):
53
46
from_tree.lock_tree_write()
54
operation = OperationWithCleanups(merge_inner)
55
operation.add_cleanup(from_tree.unlock)
56
operation.run_simple(from_tree.branch, to_tree, from_tree,
57
ignore_zero=True, interesting_ids=interesting_ids, this_tree=from_tree)
60
class MergeHooks(hooks.Hooks):
63
hooks.Hooks.__init__(self)
64
self.create_hook(hooks.HookPoint('merge_file_content',
65
"Called with a bzrlib.merge.Merger object to create a per file "
66
"merge object when starting a merge. "
67
"Should return either None or a subclass of "
68
"``bzrlib.merge.AbstractPerFileMerger``. "
69
"Such objects will then be called per file "
70
"that needs to be merged (including when one "
71
"side has deleted the file and the other has changed it). "
72
"See the AbstractPerFileMerger API docs for details on how it is "
77
class AbstractPerFileMerger(object):
78
"""PerFileMerger objects are used by plugins extending merge for bzrlib.
80
See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
82
:ivar merger: The Merge3Merger performing the merge.
85
def __init__(self, merger):
86
"""Create a PerFileMerger for use with merger."""
89
def merge_contents(self, merge_params):
90
"""Attempt to merge the contents of a single file.
92
:param merge_params: A bzrlib.merge.MergeHookParams
93
:return : A tuple of (status, chunks), where status is one of
94
'not_applicable', 'success', 'conflicted', or 'delete'. If status
95
is 'success' or 'conflicted', then chunks should be an iterable of
96
strings for the new file contents.
98
return ('not applicable', None)
101
class PerFileMerger(AbstractPerFileMerger):
102
"""Merge individual files when self.file_matches returns True.
104
This class is intended to be subclassed. The file_matches and
105
merge_matching methods should be overridden with concrete implementations.
108
def file_matches(self, params):
109
"""Return True if merge_matching should be called on this file.
111
Only called with merges of plain files with no clear winner.
113
Subclasses must override this.
115
raise NotImplementedError(self.file_matches)
117
def get_filename(self, params, tree):
118
"""Lookup the filename (i.e. basename, not path), given a Tree (e.g.
119
self.merger.this_tree) and a MergeHookParams.
121
return osutils.basename(tree.id2path(params.file_id))
123
def get_filepath(self, params, tree):
124
"""Calculate the path to the file in a tree.
126
:param params: A MergeHookParams describing the file to merge
127
:param tree: a Tree, e.g. self.merger.this_tree.
129
return tree.id2path(params.file_id)
131
def merge_contents(self, params):
132
"""Merge the contents of a single file."""
133
# Check whether this custom merge logic should be used.
135
# OTHER is a straight winner, rely on default merge.
136
params.winner == 'other' or
137
# THIS and OTHER aren't both files.
138
not params.is_file_merge() or
139
# The filename doesn't match *.xml
140
not self.file_matches(params)):
141
return 'not_applicable', None
142
return self.merge_matching(params)
144
def merge_matching(self, params):
145
"""Merge the contents of a single file that has matched the criteria
146
in PerFileMerger.merge_contents (is a conflict, is a file,
147
self.file_matches is True).
149
Subclasses must override this.
151
raise NotImplementedError(self.merge_matching)
154
class ConfigurableFileMerger(PerFileMerger):
155
"""Merge individual files when configured via a .conf file.
157
This is a base class for concrete custom file merging logic. Concrete
158
classes should implement ``merge_text``.
160
See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
162
:ivar affected_files: The configured file paths to merge.
164
:cvar name_prefix: The prefix to use when looking up configuration
165
details. <name_prefix>_merge_files describes the files targeted by the
168
:cvar default_files: The default file paths to merge when no configuration
175
def __init__(self, merger):
176
super(ConfigurableFileMerger, self).__init__(merger)
177
self.affected_files = None
178
self.default_files = self.__class__.default_files or []
179
self.name_prefix = self.__class__.name_prefix
180
if self.name_prefix is None:
181
raise ValueError("name_prefix must be set.")
183
def file_matches(self, params):
184
"""Check whether the file should call the merge hook.
186
<name_prefix>_merge_files configuration variable is a list of files
187
that should use the hook.
189
affected_files = self.affected_files
190
if affected_files is None:
191
config = self.merger.this_branch.get_config()
192
# Until bzr provides a better policy for caching the config, we
193
# just add the part we're interested in to the params to avoid
194
# reading the config files repeatedly (bazaar.conf, location.conf,
196
config_key = self.name_prefix + '_merge_files'
197
affected_files = config.get_user_option_as_list(config_key)
198
if affected_files is None:
199
# If nothing was specified in the config, use the default.
200
affected_files = self.default_files
201
self.affected_files = affected_files
203
filepath = self.get_filepath(params, self.merger.this_tree)
204
if filepath in affected_files:
208
def merge_matching(self, params):
209
return self.merge_text(params)
211
def merge_text(self, params):
212
"""Merge the byte contents of a single file.
214
This is called after checking that the merge should be performed in
215
merge_contents, and it should behave as per
216
``bzrlib.merge.AbstractPerFileMerger.merge_contents``.
218
raise NotImplementedError(self.merge_text)
221
class MergeHookParams(object):
222
"""Object holding parameters passed to merge_file_content hooks.
224
There are some fields hooks can access:
226
:ivar file_id: the file ID of the file being merged
227
:ivar trans_id: the transform ID for the merge of this file
228
:ivar this_kind: kind of file_id in 'this' tree
229
:ivar other_kind: kind of file_id in 'other' tree
230
:ivar winner: one of 'this', 'other', 'conflict'
233
def __init__(self, merger, file_id, trans_id, this_kind, other_kind,
235
self._merger = merger
236
self.file_id = file_id
237
self.trans_id = trans_id
238
self.this_kind = this_kind
239
self.other_kind = other_kind
242
def is_file_merge(self):
243
"""True if this_kind and other_kind are both 'file'."""
244
return self.this_kind == 'file' and self.other_kind == 'file'
246
@decorators.cachedproperty
247
def base_lines(self):
248
"""The lines of the 'base' version of the file."""
249
return self._merger.get_lines(self._merger.base_tree, self.file_id)
251
@decorators.cachedproperty
252
def this_lines(self):
253
"""The lines of the 'this' version of the file."""
254
return self._merger.get_lines(self._merger.this_tree, self.file_id)
256
@decorators.cachedproperty
257
def other_lines(self):
258
"""The lines of the 'other' version of the file."""
259
return self._merger.get_lines(self._merger.other_tree, self.file_id)
48
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
49
interesting_ids=interesting_ids, this_tree=from_tree)
262
54
class Merger(object):
266
55
def __init__(self, this_branch, other_tree=None, base_tree=None,
267
56
this_tree=None, pb=None, change_reporter=None,
268
57
recurse='down', revision_graph=None):
742
542
def __init__(self, working_tree, this_tree, base_tree, other_tree,
743
543
interesting_ids=None, reprocess=False, show_base=False,
744
pb=None, pp=None, change_reporter=None,
544
pb=progress.DummyProgress(), pp=None, change_reporter=None,
745
545
interesting_files=None, do_merge=True,
746
cherrypick=False, lca_trees=None, this_branch=None):
546
cherrypick=False, lca_trees=None):
747
547
"""Initialize the merger object and perform the merge.
749
549
:param working_tree: The working tree to apply the merge to
750
550
:param this_tree: The local tree in the merge operation
751
551
:param base_tree: The common tree in the merge operation
752
552
:param other_tree: The other tree to merge changes from
753
:param this_branch: The branch associated with this_tree. Defaults to
754
this_tree.branch if not supplied.
755
553
:param interesting_ids: The file_ids of files that should be
756
554
participate in the merge. May not be combined with
757
555
interesting_files.
758
556
:param: reprocess If True, perform conflict-reduction processing.
759
557
:param show_base: If True, show the base revision in text conflicts.
760
558
(incompatible with reprocess)
559
:param pb: A Progress bar
762
560
:param pp: A ProgressPhase object
763
561
:param change_reporter: An object that should report changes made
764
562
:param interesting_files: The tree-relative paths of files that should
793
588
# making sure we haven't missed any corner cases.
794
589
# if lca_trees is None:
795
590
# self._lca_trees = [self.base_tree]
796
593
self.change_reporter = change_reporter
797
594
self.cherrypick = cherrypick
596
self.pp = progress.ProgressPhase("Merge phase", 3, self.pb)
801
warnings.warn("pp argument to Merge3Merger is deprecated")
803
warnings.warn("pb argument to Merge3Merger is deprecated")
805
600
def do_merge(self):
806
operation = OperationWithCleanups(self._do_merge)
807
601
self.this_tree.lock_tree_write()
808
operation.add_cleanup(self.this_tree.unlock)
809
602
self.base_tree.lock_read()
810
operation.add_cleanup(self.base_tree.unlock)
811
603
self.other_tree.lock_read()
812
operation.add_cleanup(self.other_tree.unlock)
815
def _do_merge(self, operation):
816
self.tt = transform.TreeTransform(self.this_tree, None)
817
operation.add_cleanup(self.tt.finalize)
818
self._compute_transform()
819
results = self.tt.apply(no_conflicts=True)
820
self.write_modified(results)
822
self.this_tree.add_conflicts(self.cooked_conflicts)
823
except errors.UnsupportedOperation:
605
self.tt = transform.TreeTransform(self.this_tree, self.pb)
608
self._compute_transform()
610
results = self.tt.apply(no_conflicts=True)
611
self.write_modified(results)
613
self.this_tree.add_conflicts(self.cooked_conflicts)
614
except errors.UnsupportedOperation:
619
self.other_tree.unlock()
620
self.base_tree.unlock()
621
self.this_tree.unlock()
826
624
def make_preview_transform(self):
827
operation = OperationWithCleanups(self._make_preview_transform)
828
625
self.base_tree.lock_read()
829
operation.add_cleanup(self.base_tree.unlock)
830
626
self.other_tree.lock_read()
831
operation.add_cleanup(self.other_tree.unlock)
832
return operation.run_simple()
834
def _make_preview_transform(self):
835
627
self.tt = transform.TransformPreview(self.this_tree)
836
self._compute_transform()
630
self._compute_transform()
633
self.other_tree.unlock()
634
self.base_tree.unlock()
839
638
def _compute_transform(self):
1091
889
other_root = self.tt.trans_id_file_id(other_root_file_id)
1092
890
if other_root == self.tt.root:
893
self.tt.final_kind(other_root)
894
except errors.NoSuchFile:
1094
896
if self.other_tree.inventory.root.file_id in self.this_tree.inventory:
1095
# the other tree's root is a non-root in the current tree (as when
1096
# a previously unrelated branch is merged into another)
897
# the other tree's root is a non-root in the current tree
1099
self.tt.final_kind(other_root)
1100
other_root_is_present = True
1101
except errors.NoSuchFile:
1102
# other_root doesn't have a physical representation. We still need
1103
# to move any references to the actual root of the tree.
1104
other_root_is_present = False
1105
# 'other_tree.inventory.root' is not present in this tree. We are
1106
# calling adjust_path for children which *want* to be present with a
1107
# correct place to go.
1108
for thing, child in self.other_tree.inventory.root.children.iteritems():
899
self.reparent_children(self.other_tree.inventory.root, self.tt.root)
900
self.tt.cancel_creation(other_root)
901
self.tt.cancel_versioning(other_root)
903
def reparent_children(self, ie, target):
904
for thing, child in ie.children.iteritems():
1109
905
trans_id = self.tt.trans_id_file_id(child.file_id)
1110
if not other_root_is_present:
1111
# FIXME: Make final_kind returns None instead of raising
1112
# NoSuchFile to avoid the ugly construct below -- vila 20100402
1114
self.tt.final_kind(trans_id)
1115
# The item exist in the final tree and has a defined place
1118
except errors.NoSuchFile, e:
1120
# Move the item into the root
1121
self.tt.adjust_path(self.tt.final_name(trans_id),
1122
self.tt.root, trans_id)
1123
if other_root_is_present:
1124
self.tt.cancel_creation(other_root)
1125
self.tt.cancel_versioning(other_root)
906
self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
1127
908
def write_modified(self, results):
1128
909
modified_hashes = {}
1296
1074
parent_id_winner = "other"
1297
1075
if name_winner == "this" and parent_id_winner == "this":
1299
if name_winner == 'conflict' or parent_id_winner == 'conflict':
1300
# Creating helpers (.OTHER or .THIS) here cause problems down the
1301
# road if a ContentConflict needs to be created so we should not do
1303
trans_id = self.tt.trans_id_file_id(file_id)
1304
self._raw_conflicts.append(('path conflict', trans_id, file_id,
1305
this_parent, this_name,
1306
other_parent, other_name))
1077
if name_winner == "conflict":
1078
trans_id = self.tt.trans_id_file_id(file_id)
1079
self._raw_conflicts.append(('name conflict', trans_id,
1080
this_name, other_name))
1081
if parent_id_winner == "conflict":
1082
trans_id = self.tt.trans_id_file_id(file_id)
1083
self._raw_conflicts.append(('parent conflict', trans_id,
1084
this_parent, other_parent))
1307
1085
if other_name is None:
1308
1086
# it doesn't matter whether the result was 'other' or
1309
1087
# 'conflict'-- if there's no 'other', we leave it alone.
1089
# if we get here, name_winner and parent_winner are set to safe values.
1090
trans_id = self.tt.trans_id_file_id(file_id)
1311
1091
parent_id = parents[self.winner_idx[parent_id_winner]]
1312
1092
if parent_id is not None:
1313
# if we get here, name_winner and parent_winner are set to safe
1093
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1315
1094
self.tt.adjust_path(names[self.winner_idx[name_winner]],
1316
self.tt.trans_id_file_id(parent_id),
1317
self.tt.trans_id_file_id(file_id))
1095
parent_trans_id, trans_id)
1319
def _do_merge_contents(self, file_id):
1097
def merge_contents(self, file_id):
1320
1098
"""Performs a merge on file_id contents."""
1321
1099
def contents_pair(tree):
1322
1100
if file_id not in tree:
1351
1141
if winner == 'this':
1352
1142
# No interesting changes introduced by OTHER
1353
1143
return "unmodified"
1354
# We have a hypothetical conflict, but if we have files, then we
1355
# can try to merge the content
1356
1144
trans_id = self.tt.trans_id_file_id(file_id)
1357
params = MergeHookParams(self, file_id, trans_id, this_pair[0],
1358
other_pair[0], winner)
1359
hooks = self.active_hooks
1360
hook_status = 'not_applicable'
1362
hook_status, lines = hook.merge_contents(params)
1363
if hook_status != 'not_applicable':
1364
# Don't try any more hooks, this one applies.
1367
if hook_status == 'not_applicable':
1368
# This is a contents conflict, because none of the available
1369
# functions could merge it.
1371
name = self.tt.final_name(trans_id)
1372
parent_id = self.tt.final_parent(trans_id)
1373
if self.this_tree.has_id(file_id):
1374
self.tt.unversion_file(trans_id)
1375
file_group = self._dump_conflicts(name, parent_id, file_id,
1377
self._raw_conflicts.append(('contents conflict', file_group))
1378
elif hook_status == 'success':
1379
self.tt.create_file(lines, trans_id)
1380
elif hook_status == 'conflicted':
1381
# XXX: perhaps the hook should be able to provide
1382
# the BASE/THIS/OTHER files?
1383
self.tt.create_file(lines, trans_id)
1384
self._raw_conflicts.append(('text conflict', trans_id))
1385
name = self.tt.final_name(trans_id)
1386
parent_id = self.tt.final_parent(trans_id)
1387
self._dump_conflicts(name, parent_id, file_id)
1388
elif hook_status == 'delete':
1389
self.tt.unversion_file(trans_id)
1391
elif hook_status == 'done':
1392
# The hook function did whatever it needs to do directly, no
1393
# further action needed here.
1396
raise AssertionError('unknown hook_status: %r' % (hook_status,))
1397
if not self.this_tree.has_id(file_id) and result == "modified":
1398
self.tt.version_file(file_id, trans_id)
1399
# The merge has been performed, so the old contents should not be
1402
self.tt.delete_contents(trans_id)
1403
except errors.NoSuchFile:
1407
def _default_other_winner_merge(self, merge_hook_params):
1408
"""Replace this contents with other."""
1409
file_id = merge_hook_params.file_id
1410
trans_id = merge_hook_params.trans_id
1411
file_in_this = self.this_tree.has_id(file_id)
1412
if self.other_tree.has_id(file_id):
1413
# OTHER changed the file
1415
if wt.supports_content_filtering():
1416
# We get the path from the working tree if it exists.
1417
# That fails though when OTHER is adding a file, so
1418
# we fall back to the other tree to find the path if
1419
# it doesn't exist locally.
1421
filter_tree_path = wt.id2path(file_id)
1422
except errors.NoSuchId:
1423
filter_tree_path = self.other_tree.id2path(file_id)
1425
# Skip the id2path lookup for older formats
1426
filter_tree_path = None
1427
transform.create_from_tree(self.tt, trans_id,
1428
self.other_tree, file_id,
1429
filter_tree_path=filter_tree_path)
1432
# OTHER deleted the file
1433
return 'delete', None
1435
raise AssertionError(
1436
'winner is OTHER, but file_id %r not in THIS or OTHER tree'
1439
def merge_contents(self, merge_hook_params):
1440
"""Fallback merge logic after user installed hooks."""
1441
# This function is used in merge hooks as the fallback instance.
1442
# Perhaps making this function and the functions it calls be a
1443
# a separate class would be better.
1444
if merge_hook_params.winner == 'other':
1145
if winner == 'other':
1445
1146
# OTHER is a straight winner, so replace this contents with other
1446
return self._default_other_winner_merge(merge_hook_params)
1447
elif merge_hook_params.is_file_merge():
1448
# THIS and OTHER are both files, so text merge. Either
1449
# BASE is a file, or both converted to files, so at least we
1450
# have agreement that output should be a file.
1452
self.text_merge(merge_hook_params.file_id,
1453
merge_hook_params.trans_id)
1454
except errors.BinaryFile:
1455
return 'not_applicable', None
1147
file_in_this = file_id in self.this_tree
1149
# Remove any existing contents
1150
self.tt.delete_contents(trans_id)
1151
if file_id in self.other_tree:
1152
# OTHER changed the file
1154
if wt.supports_content_filtering():
1155
# We get the path from the working tree if it exists.
1156
# That fails though when OTHER is adding a file, so
1157
# we fall back to the other tree to find the path if
1158
# it doesn't exist locally.
1160
filter_tree_path = wt.id2path(file_id)
1161
except errors.NoSuchId:
1162
filter_tree_path = self.other_tree.id2path(file_id)
1164
# Skip the id2path lookup for older formats
1165
filter_tree_path = None
1166
transform.create_from_tree(self.tt, trans_id,
1167
self.other_tree, file_id,
1168
filter_tree_path=filter_tree_path)
1169
if not file_in_this:
1170
self.tt.version_file(file_id, trans_id)
1173
# OTHER deleted the file
1174
self.tt.unversion_file(trans_id)
1458
return 'not_applicable', None
1177
# We have a hypothetical conflict, but if we have files, then we
1178
# can try to merge the content
1179
if this_pair[0] == 'file' and other_pair[0] == 'file':
1180
# THIS and OTHER are both files, so text merge. Either
1181
# BASE is a file, or both converted to files, so at least we
1182
# have agreement that output should be a file.
1184
self.text_merge(file_id, trans_id)
1185
except errors.BinaryFile:
1186
return contents_conflict()
1187
if file_id not in self.this_tree:
1188
self.tt.version_file(file_id, trans_id)
1190
self.tt.tree_kind(trans_id)
1191
self.tt.delete_contents(trans_id)
1192
except errors.NoSuchFile:
1196
return contents_conflict()
1460
1198
def get_lines(self, tree, file_id):
1461
1199
"""Return the lines in a file, or an empty list."""
1462
if tree.has_id(file_id):
1463
return tree.get_file_lines(file_id)
1201
return tree.get_file(file_id).readlines()
1600
1338
def cook_conflicts(self, fs_conflicts):
1601
1339
"""Convert all conflicts into a form that doesn't depend on trans_id"""
1602
1341
self.cooked_conflicts.extend(transform.cook_conflicts(
1603
1342
fs_conflicts, self.tt))
1604
1343
fp = transform.FinalPaths(self.tt)
1605
1344
for conflict in self._raw_conflicts:
1606
1345
conflict_type = conflict[0]
1607
if conflict_type == 'path conflict':
1609
this_parent, this_name,
1610
other_parent, other_name) = conflict[1:]
1611
if this_parent is None or this_name is None:
1612
this_path = '<deleted>'
1614
parent_path = fp.get_path(
1615
self.tt.trans_id_file_id(this_parent))
1616
this_path = osutils.pathjoin(parent_path, this_name)
1617
if other_parent is None or other_name is None:
1618
other_path = '<deleted>'
1620
parent_path = fp.get_path(
1621
self.tt.trans_id_file_id(other_parent))
1622
other_path = osutils.pathjoin(parent_path, other_name)
1623
c = _mod_conflicts.Conflict.factory(
1624
'path conflict', path=this_path,
1625
conflict_path=other_path,
1627
elif conflict_type == 'contents conflict':
1346
if conflict_type in ('name conflict', 'parent conflict'):
1347
trans_id = conflict[1]
1348
conflict_args = conflict[2:]
1349
if trans_id not in name_conflicts:
1350
name_conflicts[trans_id] = {}
1351
transform.unique_add(name_conflicts[trans_id], conflict_type,
1353
if conflict_type == 'contents conflict':
1628
1354
for trans_id in conflict[1]:
1629
1355
file_id = self.tt.final_file_id(trans_id)
1630
1356
if file_id is not None:
1637
1363
c = _mod_conflicts.Conflict.factory(conflict_type,
1638
1364
path=path, file_id=file_id)
1639
elif conflict_type == 'text conflict':
1365
self.cooked_conflicts.append(c)
1366
if conflict_type == 'text conflict':
1640
1367
trans_id = conflict[1]
1641
1368
path = fp.get_path(trans_id)
1642
1369
file_id = self.tt.final_file_id(trans_id)
1643
1370
c = _mod_conflicts.Conflict.factory(conflict_type,
1644
1371
path=path, file_id=file_id)
1372
self.cooked_conflicts.append(c)
1374
for trans_id, conflicts in name_conflicts.iteritems():
1376
this_parent, other_parent = conflicts['parent conflict']
1377
if this_parent == other_parent:
1378
raise AssertionError()
1380
this_parent = other_parent = \
1381
self.tt.final_file_id(self.tt.final_parent(trans_id))
1383
this_name, other_name = conflicts['name conflict']
1384
if this_name == other_name:
1385
raise AssertionError()
1387
this_name = other_name = self.tt.final_name(trans_id)
1388
other_path = fp.get_path(trans_id)
1389
if this_parent is not None and this_name is not None:
1390
this_parent_path = \
1391
fp.get_path(self.tt.trans_id_file_id(this_parent))
1392
this_path = osutils.pathjoin(this_parent_path, this_name)
1646
raise AssertionError('bad conflict type: %r' % (conflict,))
1394
this_path = "<deleted>"
1395
file_id = self.tt.final_file_id(trans_id)
1396
c = _mod_conflicts.Conflict.factory('path conflict', path=this_path,
1397
conflict_path=other_path,
1647
1399
self.cooked_conflicts.append(c)
1648
1400
self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
added
removed
bzrlib/merge.py
