14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
from itertools import chain
19
23
from bzrlib import (
20
branch as _mod_branch,
21
conflicts as _mod_conflicts,
25
26
graph as _mod_graph,
30
30
revision as _mod_revision,
39
from bzrlib.cleanup import OperationWithCleanups
40
from bzrlib.symbol_versioning import (
34
from bzrlib.branch import Branch
35
from bzrlib.conflicts import ConflictList, Conflict
36
from bzrlib.errors import (BzrCommandError,
46
WorkingTreeNotRevision,
49
from bzrlib.graph import Graph
50
from bzrlib.merge3 import Merge3
51
from bzrlib.osutils import rename, pathjoin
52
from progress import DummyProgress, ProgressPhase
53
from bzrlib.revision import (NULL_REVISION, ensure_null)
54
from bzrlib.textfile import check_text_lines
55
from bzrlib.trace import mutter, warning, note, is_quiet
56
from bzrlib.transform import (TransformPreview, TreeTransform,
57
resolve_conflicts, cook_conflicts,
58
conflict_pass, FinalPaths, create_from_tree,
59
unique_add, ROOT_PARENT)
60
from bzrlib.versionedfile import PlanWeaveMerge
44
63
# TODO: Report back as changes are merged in
47
66
def transform_tree(from_tree, to_tree, interesting_ids=None):
48
67
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)
55
class MergeHooks(hooks.Hooks):
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 "
72
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.
77
:ivar merger: The Merge3Merger performing the merge.
80
def __init__(self, merger):
81
"""Create a PerFileMerger for use with merger."""
84
def merge_contents(self, merge_params):
85
"""Attempt to merge the contents of a single file.
87
:param merge_params: A bzrlib.merge.MergeHookParams
88
:return : A tuple of (status, chunks), where status is one of
89
'not_applicable', 'success', 'conflicted', or 'delete'. If status
90
is 'success' or 'conflicted', then chunks should be an iterable of
91
strings for the new file contents.
93
return ('not applicable', None)
96
class PerFileMerger(AbstractPerFileMerger):
97
"""Merge individual files when self.file_matches returns True.
99
This class is intended to be subclassed. The file_matches and
100
merge_matching methods should be overridden with concrete implementations.
103
def file_matches(self, params):
104
"""Return True if merge_matching should be called on this file.
106
Only called with merges of plain files with no clear winner.
108
Subclasses must override this.
110
raise NotImplementedError(self.file_matches)
112
def get_filename(self, params, tree):
113
"""Lookup the filename (i.e. basename, not path), given a Tree (e.g.
114
self.merger.this_tree) and a MergeHookParams.
116
return osutils.basename(tree.id2path(params.file_id))
118
def get_filepath(self, params, tree):
119
"""Calculate the path to the file in a tree.
121
:param params: A MergeHookParams describing the file to merge
122
:param tree: a Tree, e.g. self.merger.this_tree.
124
return tree.id2path(params.file_id)
126
def merge_contents(self, params):
127
"""Merge the contents of a single file."""
128
# Check whether this custom merge logic should be used.
130
# OTHER is a straight winner, rely on default merge.
131
params.winner == 'other' or
132
# THIS and OTHER aren't both files.
133
not params.is_file_merge() or
134
# The filename doesn't match *.xml
135
not self.file_matches(params)):
136
return 'not_applicable', None
137
return self.merge_matching(params)
139
def merge_matching(self, params):
140
"""Merge the contents of a single file that has matched the criteria
141
in PerFileMerger.merge_contents (is a conflict, is a file,
142
self.file_matches is True).
144
Subclasses must override this.
146
raise NotImplementedError(self.merge_matching)
149
class ConfigurableFileMerger(PerFileMerger):
150
"""Merge individual files when configured via a .conf file.
152
This is a base class for concrete custom file merging logic. Concrete
153
classes should implement ``merge_text``.
155
See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
157
:ivar affected_files: The configured file paths to merge.
159
:cvar name_prefix: The prefix to use when looking up configuration
160
details. <name_prefix>_merge_files describes the files targeted by the
163
:cvar default_files: The default file paths to merge when no configuration
170
def __init__(self, merger):
171
super(ConfigurableFileMerger, self).__init__(merger)
172
self.affected_files = None
173
self.default_files = self.__class__.default_files or []
174
self.name_prefix = self.__class__.name_prefix
175
if self.name_prefix is None:
176
raise ValueError("name_prefix must be set.")
178
def file_matches(self, params):
179
"""Check whether the file should call the merge hook.
181
<name_prefix>_merge_files configuration variable is a list of files
182
that should use the hook.
184
affected_files = self.affected_files
185
if affected_files is None:
186
config = self.merger.this_branch.get_config()
187
# Until bzr provides a better policy for caching the config, we
188
# just add the part we're interested in to the params to avoid
189
# reading the config files repeatedly (bazaar.conf, location.conf,
191
config_key = self.name_prefix + '_merge_files'
192
affected_files = config.get_user_option_as_list(config_key)
193
if affected_files is None:
194
# If nothing was specified in the config, use the default.
195
affected_files = self.default_files
196
self.affected_files = affected_files
198
filepath = self.get_filepath(params, self.merger.this_tree)
199
if filepath in affected_files:
203
def merge_matching(self, params):
204
return self.merge_text(params)
206
def merge_text(self, params):
207
"""Merge the byte contents of a single file.
209
This is called after checking that the merge should be performed in
210
merge_contents, and it should behave as per
211
``bzrlib.merge.AbstractPerFileMerger.merge_contents``.
213
raise NotImplementedError(self.merge_text)
216
class MergeHookParams(object):
217
"""Object holding parameters passed to merge_file_content hooks.
219
There are some fields hooks can access:
221
:ivar file_id: the file ID of the file being merged
222
:ivar trans_id: the transform ID for the merge of this file
223
:ivar this_kind: kind of file_id in 'this' tree
224
:ivar other_kind: kind of file_id in 'other' tree
225
:ivar winner: one of 'this', 'other', 'conflict'
228
def __init__(self, merger, file_id, trans_id, this_kind, other_kind,
230
self._merger = merger
231
self.file_id = file_id
232
self.trans_id = trans_id
233
self.this_kind = this_kind
234
self.other_kind = other_kind
237
def is_file_merge(self):
238
"""True if this_kind and other_kind are both 'file'."""
239
return self.this_kind == 'file' and self.other_kind == 'file'
241
@decorators.cachedproperty
242
def base_lines(self):
243
"""The lines of the 'base' version of the file."""
244
return self._merger.get_lines(self._merger.base_tree, self.file_id)
246
@decorators.cachedproperty
247
def this_lines(self):
248
"""The lines of the 'this' version of the file."""
249
return self._merger.get_lines(self._merger.this_tree, self.file_id)
251
@decorators.cachedproperty
252
def other_lines(self):
253
"""The lines of the 'other' version of the file."""
254
return self._merger.get_lines(self._merger.other_tree, self.file_id)
69
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
70
interesting_ids=interesting_ids, this_tree=from_tree)
257
75
class Merger(object):
261
76
def __init__(self, this_branch, other_tree=None, base_tree=None,
262
77
this_tree=None, pb=None, change_reporter=None,
263
78
recurse='down', revision_graph=None):
788
600
# making sure we haven't missed any corner cases.
789
601
# if lca_trees is None:
790
602
# self._lca_trees = [self.base_tree]
791
605
self.change_reporter = change_reporter
792
606
self.cherrypick = cherrypick
608
self.pp = ProgressPhase("Merge phase", 3, self.pb)
796
warnings.warn("pp argument to Merge3Merger is deprecated")
798
warnings.warn("pb argument to Merge3Merger is deprecated")
800
612
def do_merge(self):
801
operation = OperationWithCleanups(self._do_merge)
802
613
self.this_tree.lock_tree_write()
803
operation.add_cleanup(self.this_tree.unlock)
804
614
self.base_tree.lock_read()
805
operation.add_cleanup(self.base_tree.unlock)
806
615
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:
617
self.tt = TreeTransform(self.this_tree, self.pb)
620
self._compute_transform()
622
results = self.tt.apply(no_conflicts=True)
623
self.write_modified(results)
625
self.this_tree.add_conflicts(self.cooked_conflicts)
626
except UnsupportedOperation:
631
self.other_tree.unlock()
632
self.base_tree.unlock()
633
self.this_tree.unlock()
821
636
def make_preview_transform(self):
822
operation = OperationWithCleanups(self._make_preview_transform)
823
637
self.base_tree.lock_read()
824
operation.add_cleanup(self.base_tree.unlock)
825
638
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()
639
self.tt = TransformPreview(self.this_tree)
642
self._compute_transform()
645
self.other_tree.unlock()
646
self.base_tree.unlock()
834
650
def _compute_transform(self):
1291
1103
parent_id_winner = "other"
1292
1104
if name_winner == "this" and parent_id_winner == "this":
1294
if name_winner == 'conflict' or parent_id_winner == 'conflict':
1295
# Creating helpers (.OTHER or .THIS) here cause problems down the
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)
1299
self._raw_conflicts.append(('path conflict', trans_id, file_id,
1300
this_parent, this_name,
1301
other_parent, other_name))
1106
if name_winner == "conflict":
1107
trans_id = self.tt.trans_id_file_id(file_id)
1108
self._raw_conflicts.append(('name conflict', trans_id,
1109
this_name, other_name))
1110
if parent_id_winner == "conflict":
1111
trans_id = self.tt.trans_id_file_id(file_id)
1112
self._raw_conflicts.append(('parent conflict', trans_id,
1113
this_parent, other_parent))
1302
1114
if other_name is None:
1303
1115
# it doesn't matter whether the result was 'other' or
1304
1116
# 'conflict'-- if there's no 'other', we leave it alone.
1118
# if we get here, name_winner and parent_winner are set to safe values.
1119
trans_id = self.tt.trans_id_file_id(file_id)
1306
1120
parent_id = parents[self.winner_idx[parent_id_winner]]
1307
1121
if parent_id is not None:
1308
# if we get here, name_winner and parent_winner are set to safe
1122
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1310
1123
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))
1124
parent_trans_id, trans_id)
1314
def _do_merge_contents(self, file_id):
1126
def merge_contents(self, file_id):
1315
1127
"""Performs a merge on file_id contents."""
1316
1128
def contents_pair(tree):
1317
1129
if file_id not in tree:
1346
1170
if winner == 'this':
1347
1171
# No interesting changes introduced by OTHER
1348
1172
return "unmodified"
1349
# We have a hypothetical conflict, but if we have files, then we
1350
# can try to merge the content
1351
1173
trans_id = self.tt.trans_id_file_id(file_id)
1352
params = MergeHookParams(self, file_id, trans_id, this_pair[0],
1353
other_pair[0], winner)
1354
hooks = self.active_hooks
1355
hook_status = 'not_applicable'
1357
hook_status, lines = hook.merge_contents(params)
1358
if hook_status != 'not_applicable':
1359
# Don't try any more hooks, this one applies.
1362
if hook_status == 'not_applicable':
1363
# This is a contents conflict, because none of the available
1364
# functions could merge it.
1366
name = self.tt.final_name(trans_id)
1367
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))
1373
elif hook_status == 'success':
1374
self.tt.create_file(lines, trans_id)
1375
elif hook_status == 'conflicted':
1376
# XXX: perhaps the hook should be able to provide
1377
# the BASE/THIS/OTHER files?
1378
self.tt.create_file(lines, trans_id)
1379
self._raw_conflicts.append(('text conflict', trans_id))
1380
name = self.tt.final_name(trans_id)
1381
parent_id = self.tt.final_parent(trans_id)
1382
self._dump_conflicts(name, parent_id, file_id)
1383
elif hook_status == 'delete':
1384
self.tt.unversion_file(trans_id)
1386
elif hook_status == 'done':
1387
# The hook function did whatever it needs to do directly, no
1388
# further action needed here.
1391
raise AssertionError('unknown hook_status: %r' % (hook_status,))
1392
if not self.this_tree.has_id(file_id) and result == "modified":
1393
self.tt.version_file(file_id, trans_id)
1394
# The merge has been performed, so the old contents should not be
1397
self.tt.delete_contents(trans_id)
1398
except errors.NoSuchFile:
1402
def _default_other_winner_merge(self, merge_hook_params):
1403
"""Replace this contents with other."""
1404
file_id = merge_hook_params.file_id
1405
trans_id = merge_hook_params.trans_id
1406
file_in_this = self.this_tree.has_id(file_id)
1407
if self.other_tree.has_id(file_id):
1408
# OTHER changed the file
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)
1427
# OTHER deleted the file
1428
return 'delete', None
1430
raise AssertionError(
1431
'winner is OTHER, but file_id %r not in THIS or OTHER tree'
1434
def merge_contents(self, merge_hook_params):
1435
"""Fallback merge logic after user installed hooks."""
1436
# This function is used in merge hooks as the fallback instance.
1437
# Perhaps making this function and the functions it calls be a
1438
# a separate class would be better.
1439
if merge_hook_params.winner == 'other':
1174
if winner == 'other':
1440
1175
# OTHER is a straight winner, so replace this contents with other
1441
return self._default_other_winner_merge(merge_hook_params)
1442
elif merge_hook_params.is_file_merge():
1443
# THIS and OTHER are both files, so text merge. Either
1444
# BASE is a file, or both converted to files, so at least we
1445
# have agreement that output should be a file.
1447
self.text_merge(merge_hook_params.file_id,
1448
merge_hook_params.trans_id)
1449
except errors.BinaryFile:
1450
return 'not_applicable', None
1176
file_in_this = file_id in self.this_tree
1178
# Remove any existing contents
1179
self.tt.delete_contents(trans_id)
1180
if file_id in self.other_tree:
1181
# OTHER changed the file
1183
if wt.supports_content_filtering():
1184
# We get the path from the working tree if it exists.
1185
# That fails though when OTHER is adding a file, so
1186
# we fall back to the other tree to find the path if
1187
# it doesn't exist locally.
1189
filter_tree_path = wt.id2path(file_id)
1190
except errors.NoSuchId:
1191
filter_tree_path = self.other_tree.id2path(file_id)
1193
# Skip the id2path lookup for older formats
1194
filter_tree_path = None
1195
create_from_tree(self.tt, trans_id,
1196
self.other_tree, file_id,
1197
filter_tree_path=filter_tree_path)
1198
if not file_in_this:
1199
self.tt.version_file(file_id, trans_id)
1202
# OTHER deleted the file
1203
self.tt.unversion_file(trans_id)
1453
return 'not_applicable', None
1206
# We have a hypothetical conflict, but if we have files, then we
1207
# can try to merge the content
1208
if this_pair[0] == 'file' and other_pair[0] == 'file':
1209
# THIS and OTHER are both files, so text merge. Either
1210
# BASE is a file, or both converted to files, so at least we
1211
# have agreement that output should be a file.
1213
self.text_merge(file_id, trans_id)
1215
return contents_conflict()
1216
if file_id not in self.this_tree:
1217
self.tt.version_file(file_id, trans_id)
1219
self.tt.tree_kind(trans_id)
1220
self.tt.delete_contents(trans_id)
1225
return contents_conflict()
1455
1227
def get_lines(self, tree, file_id):
1456
1228
"""Return the lines in a file, or an empty list."""
1457
if tree.has_id(file_id):
1458
1230
return tree.get_file(file_id).readlines()
1629
1389
if path.endswith(suffix):
1630
1390
path = path[:-len(suffix)]
1632
c = _mod_conflicts.Conflict.factory(conflict_type,
1633
path=path, file_id=file_id)
1634
elif conflict_type == 'text conflict':
1392
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
1393
self.cooked_conflicts.append(c)
1394
if conflict_type == 'text conflict':
1635
1395
trans_id = conflict[1]
1636
1396
path = fp.get_path(trans_id)
1637
1397
file_id = self.tt.final_file_id(trans_id)
1638
c = _mod_conflicts.Conflict.factory(conflict_type,
1639
path=path, file_id=file_id)
1398
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
1399
self.cooked_conflicts.append(c)
1401
for trans_id, conflicts in name_conflicts.iteritems():
1403
this_parent, other_parent = conflicts['parent conflict']
1404
if this_parent == other_parent:
1405
raise AssertionError()
1407
this_parent = other_parent = \
1408
self.tt.final_file_id(self.tt.final_parent(trans_id))
1410
this_name, other_name = conflicts['name conflict']
1411
if this_name == other_name:
1412
raise AssertionError()
1414
this_name = other_name = self.tt.final_name(trans_id)
1415
other_path = fp.get_path(trans_id)
1416
if this_parent is not None and this_name is not None:
1417
this_parent_path = \
1418
fp.get_path(self.tt.trans_id_file_id(this_parent))
1419
this_path = pathjoin(this_parent_path, this_name)
1641
raise AssertionError('bad conflict type: %r' % (conflict,))
1421
this_path = "<deleted>"
1422
file_id = self.tt.final_file_id(trans_id)
1423
c = Conflict.factory('path conflict', path=this_path,
1424
conflict_path=other_path, file_id=file_id)
1642
1425
self.cooked_conflicts.append(c)
1643
self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
1426
self.cooked_conflicts.sort(key=Conflict.sort_key)
1646
1429
class WeaveMerger(Merge3Merger):
1650
1433
supports_reverse_cherrypick = False
1651
1434
history_based = True
1653
def _generate_merge_plan(self, file_id, base):
1654
return self.this_tree.plan_file_merge(file_id, self.other_tree,
1436
def _merged_lines(self, file_id):
1437
"""Generate the merged lines.
1438
There is no distinction between lines that are meant to contain <<<<<<<
1442
base = self.base_tree
1445
plan = self.this_tree.plan_file_merge(file_id, self.other_tree,
1657
def _merged_lines(self, file_id):
1658
"""Generate the merged lines.
1659
There is no distinction between lines that are meant to contain <<<<<<<
1663
base = self.base_tree
1666
plan = self._generate_merge_plan(file_id, base)
1667
1447
if 'merge' in debug.debug_flags:
1668
1448
plan = list(plan)
1669
1449
trans_id = self.tt.trans_id_file_id(file_id)
1670
1450
name = self.tt.final_name(trans_id) + '.plan'
1671
contents = ('%11s|%s' % l for l in plan)
1451
contents = ('%10s|%s' % l for l in plan)
1672
1452
self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1673
textmerge = versionedfile.PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1674
'>>>>>>> MERGE-SOURCE\n')
1675
lines, conflicts = textmerge.merge_lines(self.reprocess)
1677
base_lines = textmerge.base_from_plan()
1680
return lines, base_lines
1453
textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1454
'>>>>>>> MERGE-SOURCE\n')
1455
return textmerge.merge_lines(self.reprocess)
1682
1457
def text_merge(self, file_id, trans_id):
1683
1458
"""Perform a (weave) text merge for a given file and file-id.
1684
1459
If conflicts are encountered, .THIS and .OTHER files will be emitted,
1685
1460
and a conflict will be noted.
1687
lines, base_lines = self._merged_lines(file_id)
1462
lines, conflicts = self._merged_lines(file_id)
1688
1463
lines = list(lines)
1689
1464
# Note we're checking whether the OUTPUT is binary in this case,
1690
1465
# because we don't want to get into weave merge guts.
1691
textfile.check_text_lines(lines)
1466
check_text_lines(lines)
1692
1467
self.tt.create_file(lines, trans_id)
1693
if base_lines is not None:
1695
1469
self._raw_conflicts.append(('text conflict', trans_id))
1696
1470
name = self.tt.final_name(trans_id)
1697
1471
parent_id = self.tt.final_parent(trans_id)
1698
1472
file_group = self._dump_conflicts(name, parent_id, file_id,
1700
base_lines=base_lines)
1701
1474
file_group.append(trans_id)
1704
1477
class LCAMerger(WeaveMerger):
1706
def _generate_merge_plan(self, file_id, base):
1707
return self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
1479
def _merged_lines(self, file_id):
1480
"""Generate the merged lines.
1481
There is no distinction between lines that are meant to contain <<<<<<<
1485
base = self.base_tree
1488
plan = self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
1490
if 'merge' in debug.debug_flags:
1492
trans_id = self.tt.trans_id_file_id(file_id)
1493
name = self.tt.final_name(trans_id) + '.plan'
1494
contents = ('%10s|%s' % l for l in plan)
1495
self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1496
textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1497
'>>>>>>> MERGE-SOURCE\n')
1498
return textmerge.merge_lines(self.reprocess)
1710
1501
class Diff3Merger(Merge3Merger):
1711
1502
"""Three-way merger using external diff3 for text merging"""
1713
1504
def dump_file(self, temp_dir, name, tree, file_id):
1714
out_path = osutils.pathjoin(temp_dir, name)
1505
out_path = pathjoin(temp_dir, name)
1715
1506
out_file = open(out_path, "wb")
1717
1508
in_file = tree.get_file(file_id)
added
removed
bzrlib/merge.py
