13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
from itertools import chain
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
23
23
from bzrlib import (
24
branch as _mod_branch,
26
conflicts as _mod_conflicts,
26
29
graph as _mod_graph,
30
33
revision as _mod_revision,
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
43
from bzrlib.i18n import gettext
51
from bzrlib.symbol_versioning import (
63
55
# TODO: Report back as changes are merged in
66
58
def transform_tree(from_tree, to_tree, interesting_ids=None):
67
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
68
interesting_ids=interesting_ids, this_tree=from_tree)
59
from_tree.lock_tree_write()
60
operation = cleanup.OperationWithCleanups(merge_inner)
61
operation.add_cleanup(from_tree.unlock)
62
operation.run_simple(from_tree.branch, to_tree, from_tree,
63
ignore_zero=True, interesting_ids=interesting_ids, this_tree=from_tree)
66
class MergeHooks(hooks.Hooks):
69
hooks.Hooks.__init__(self, "bzrlib.merge", "Merger.hooks")
70
self.add_hook('merge_file_content',
71
"Called with a bzrlib.merge.Merger object to create a per file "
72
"merge object when starting a merge. "
73
"Should return either None or a subclass of "
74
"``bzrlib.merge.AbstractPerFileMerger``. "
75
"Such objects will then be called per file "
76
"that needs to be merged (including when one "
77
"side has deleted the file and the other has changed it). "
78
"See the AbstractPerFileMerger API docs for details on how it is "
81
self.add_hook('pre_merge',
82
'Called before a merge. '
83
'Receives a Merger object as the single argument.',
85
self.add_hook('post_merge',
86
'Called after a merge. '
87
'Receives a Merger object as the single argument. '
88
'The return value is ignored.',
92
class AbstractPerFileMerger(object):
93
"""PerFileMerger objects are used by plugins extending merge for bzrlib.
95
See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
97
:ivar merger: The Merge3Merger performing the merge.
100
def __init__(self, merger):
101
"""Create a PerFileMerger for use with merger."""
104
def merge_contents(self, merge_params):
105
"""Attempt to merge the contents of a single file.
107
:param merge_params: A bzrlib.merge.MergeFileHookParams
108
:return: A tuple of (status, chunks), where status is one of
109
'not_applicable', 'success', 'conflicted', or 'delete'. If status
110
is 'success' or 'conflicted', then chunks should be an iterable of
111
strings for the new file contents.
113
return ('not applicable', None)
116
class PerFileMerger(AbstractPerFileMerger):
117
"""Merge individual files when self.file_matches returns True.
119
This class is intended to be subclassed. The file_matches and
120
merge_matching methods should be overridden with concrete implementations.
123
def file_matches(self, params):
124
"""Return True if merge_matching should be called on this file.
126
Only called with merges of plain files with no clear winner.
128
Subclasses must override this.
130
raise NotImplementedError(self.file_matches)
132
def get_filename(self, params, tree):
133
"""Lookup the filename (i.e. basename, not path), given a Tree (e.g.
134
self.merger.this_tree) and a MergeFileHookParams.
136
return osutils.basename(tree.id2path(params.file_id))
138
def get_filepath(self, params, tree):
139
"""Calculate the path to the file in a tree.
141
:param params: A MergeFileHookParams describing the file to merge
142
:param tree: a Tree, e.g. self.merger.this_tree.
144
return tree.id2path(params.file_id)
146
def merge_contents(self, params):
147
"""Merge the contents of a single file."""
148
# Check whether this custom merge logic should be used.
150
# OTHER is a straight winner, rely on default merge.
151
params.winner == 'other' or
152
# THIS and OTHER aren't both files.
153
not params.is_file_merge() or
154
# The filename doesn't match
155
not self.file_matches(params)):
156
return 'not_applicable', None
157
return self.merge_matching(params)
159
def merge_matching(self, params):
160
"""Merge the contents of a single file that has matched the criteria
161
in PerFileMerger.merge_contents (is a conflict, is a file,
162
self.file_matches is True).
164
Subclasses must override this.
166
raise NotImplementedError(self.merge_matching)
169
class ConfigurableFileMerger(PerFileMerger):
170
"""Merge individual files when configured via a .conf file.
172
This is a base class for concrete custom file merging logic. Concrete
173
classes should implement ``merge_text``.
175
See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
177
:ivar affected_files: The configured file paths to merge.
179
:cvar name_prefix: The prefix to use when looking up configuration
180
details. <name_prefix>_merge_files describes the files targeted by the
183
:cvar default_files: The default file paths to merge when no configuration
190
def __init__(self, merger):
191
super(ConfigurableFileMerger, self).__init__(merger)
192
self.affected_files = None
193
self.default_files = self.__class__.default_files or []
194
self.name_prefix = self.__class__.name_prefix
195
if self.name_prefix is None:
196
raise ValueError("name_prefix must be set.")
198
def file_matches(self, params):
199
"""Check whether the file should call the merge hook.
201
<name_prefix>_merge_files configuration variable is a list of files
202
that should use the hook.
204
affected_files = self.affected_files
205
if affected_files is None:
206
config = self.merger.this_branch.get_config()
207
# Until bzr provides a better policy for caching the config, we
208
# just add the part we're interested in to the params to avoid
209
# reading the config files repeatedly (bazaar.conf, location.conf,
211
config_key = self.name_prefix + '_merge_files'
212
affected_files = config.get_user_option_as_list(config_key)
213
if affected_files is None:
214
# If nothing was specified in the config, use the default.
215
affected_files = self.default_files
216
self.affected_files = affected_files
218
filepath = self.get_filepath(params, self.merger.this_tree)
219
if filepath in affected_files:
223
def merge_matching(self, params):
224
return self.merge_text(params)
226
def merge_text(self, params):
227
"""Merge the byte contents of a single file.
229
This is called after checking that the merge should be performed in
230
merge_contents, and it should behave as per
231
``bzrlib.merge.AbstractPerFileMerger.merge_contents``.
233
raise NotImplementedError(self.merge_text)
236
class MergeFileHookParams(object):
237
"""Object holding parameters passed to merge_file_content hooks.
239
There are some fields hooks can access:
241
:ivar file_id: the file ID of the file being merged
242
:ivar trans_id: the transform ID for the merge of this file
243
:ivar this_kind: kind of file_id in 'this' tree
244
:ivar other_kind: kind of file_id in 'other' tree
245
:ivar winner: one of 'this', 'other', 'conflict'
248
def __init__(self, merger, file_id, trans_id, this_kind, other_kind,
250
self._merger = merger
251
self.file_id = file_id
252
self.trans_id = trans_id
253
self.this_kind = this_kind
254
self.other_kind = other_kind
257
def is_file_merge(self):
258
"""True if this_kind and other_kind are both 'file'."""
259
return self.this_kind == 'file' and self.other_kind == 'file'
261
@decorators.cachedproperty
262
def base_lines(self):
263
"""The lines of the 'base' version of the file."""
264
return self._merger.get_lines(self._merger.base_tree, self.file_id)
266
@decorators.cachedproperty
267
def this_lines(self):
268
"""The lines of the 'this' version of the file."""
269
return self._merger.get_lines(self._merger.this_tree, self.file_id)
271
@decorators.cachedproperty
272
def other_lines(self):
273
"""The lines of the 'other' version of the file."""
274
return self._merger.get_lines(self._merger.other_tree, self.file_id)
71
277
class Merger(object):
72
281
def __init__(self, this_branch, other_tree=None, base_tree=None,
73
this_tree=None, pb=DummyProgress(), change_reporter=None,
282
this_tree=None, pb=None, change_reporter=None,
74
283
recurse='down', revision_graph=None):
75
284
object.__init__(self)
76
285
self.this_branch = this_branch
220
441
return self._cached_trees[revision_id]
222
443
def _get_tree(self, treespec, possible_transports=None):
223
from bzrlib import workingtree
224
444
location, revno = treespec
225
445
if revno is None:
226
446
tree = workingtree.WorkingTree.open_containing(location)[0]
227
447
return tree.branch, tree
228
branch = Branch.open_containing(location, possible_transports)[0]
448
branch = _mod_branch.Branch.open_containing(
449
location, possible_transports)[0]
230
451
revision_id = branch.last_revision()
232
453
revision_id = branch.get_rev_id(revno)
233
revision_id = ensure_null(revision_id)
454
revision_id = _mod_revision.ensure_null(revision_id)
234
455
return branch, self.revision_tree(revision_id, branch)
236
def ensure_revision_trees(self):
237
if self.this_revision_tree is None:
238
self.this_basis_tree = self.revision_tree(self.this_basis)
239
if self.this_basis == self.this_rev_id:
240
self.this_revision_tree = self.this_basis_tree
242
if self.other_rev_id is None:
243
other_basis_tree = self.revision_tree(self.other_basis)
244
changes = other_basis_tree.changes_from(self.other_tree)
245
if changes.has_changed():
246
raise WorkingTreeNotRevision(self.this_tree)
247
other_rev_id = self.other_basis
248
self.other_tree = other_basis_tree
250
def file_revisions(self, file_id):
251
self.ensure_revision_trees()
252
def get_id(tree, file_id):
253
revision_id = tree.inventory[file_id].revision
255
if self.this_rev_id is None:
256
if self.this_basis_tree.get_file_sha1(file_id) != \
257
self.this_tree.get_file_sha1(file_id):
258
raise WorkingTreeNotRevision(self.this_tree)
260
trees = (self.this_basis_tree, self.other_tree)
261
return [get_id(tree, file_id) for tree in trees]
263
def check_basis(self, check_clean, require_commits=True):
264
if self.this_basis is None and require_commits is True:
265
raise BzrCommandError("This branch has no commits."
266
" (perhaps you would prefer 'bzr pull')")
269
if self.this_basis != self.this_rev_id:
270
raise errors.UncommittedChanges(self.this_tree)
272
def compare_basis(self):
274
basis_tree = self.revision_tree(self.this_tree.last_revision())
275
except errors.NoSuchRevision:
276
basis_tree = self.this_tree.basis_tree()
277
changes = self.this_tree.changes_from(basis_tree)
278
if not changes.has_changed():
279
self.this_rev_id = self.this_basis
281
457
def set_interesting_files(self, file_list):
282
458
self.interesting_files = file_list
284
460
def set_pending(self):
285
if not self.base_is_ancestor or not self.base_is_other_ancestor or self.other_rev_id is None:
461
if (not self.base_is_ancestor or not self.base_is_other_ancestor
462
or self.other_rev_id is None):
287
464
self._add_parent()
289
466
def _add_parent(self):
290
467
new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
291
468
new_parent_trees = []
469
operation = cleanup.OperationWithCleanups(
470
self.this_tree.set_parent_trees)
292
471
for revision_id in new_parents:
294
473
tree = self.revision_tree(revision_id)
385
560
self.base_rev_id = self.revision_graph.find_unique_lca(
387
self._is_criss_cross = True
388
if self.base_rev_id == NULL_REVISION:
389
raise UnrelatedBranches()
562
sorted_lca_keys = self.revision_graph.find_merge_order(
564
if self.base_rev_id == _mod_revision.NULL_REVISION:
565
self.base_rev_id = sorted_lca_keys[0]
567
if self.base_rev_id == _mod_revision.NULL_REVISION:
568
raise errors.UnrelatedBranches()
390
569
if self._is_criss_cross:
391
warning('Warning: criss-cross merge encountered. See bzr'
392
' help criss-cross.')
393
interesting_revision_ids = [self.base_rev_id]
394
interesting_revision_ids.extend(lcas)
570
trace.warning('Warning: criss-cross merge encountered. See bzr'
571
' help criss-cross.')
572
trace.mutter('Criss-cross lcas: %r' % lcas)
573
if self.base_rev_id in lcas:
574
trace.mutter('Unable to find unique lca. '
575
'Fallback %r as best option.'
577
interesting_revision_ids = set(lcas)
578
interesting_revision_ids.add(self.base_rev_id)
395
579
interesting_trees = dict((t.get_revision_id(), t)
396
580
for t in self.this_branch.repository.revision_trees(
397
581
interesting_revision_ids))
398
582
self._cached_trees.update(interesting_trees)
399
self.base_tree = interesting_trees.pop(self.base_rev_id)
400
sorted_lca_keys = self.revision_graph.find_merge_order(
583
if self.base_rev_id in lcas:
584
self.base_tree = interesting_trees[self.base_rev_id]
586
self.base_tree = interesting_trees.pop(self.base_rev_id)
402
587
self._lca_trees = [interesting_trees[key]
403
588
for key in sorted_lca_keys]
405
590
self.base_tree = self.revision_tree(self.base_rev_id)
406
591
self.base_is_ancestor = True
407
592
self.base_is_other_ancestor = True
593
trace.mutter('Base revid: %r' % self.base_rev_id)
409
595
def set_base(self, base_revision):
410
596
"""Set the base revision to use for the merge.
412
598
:param base_revision: A 2-list containing a path and revision number.
414
mutter("doing merge() with no base_revision specified")
600
trace.mutter("doing merge() with no base_revision specified")
415
601
if base_revision == [None, None]:
532
722
winner_idx = {"this": 2, "other": 1, "conflict": 1}
533
723
supports_lca_trees = True
535
def __init__(self, working_tree, this_tree, base_tree, other_tree,
725
def __init__(self, working_tree, this_tree, base_tree, other_tree,
536
726
interesting_ids=None, reprocess=False, show_base=False,
537
pb=DummyProgress(), pp=None, change_reporter=None,
727
pb=None, pp=None, change_reporter=None,
538
728
interesting_files=None, do_merge=True,
539
cherrypick=False, lca_trees=None):
729
cherrypick=False, lca_trees=None, this_branch=None,
540
731
"""Initialize the merger object and perform the merge.
542
733
:param working_tree: The working tree to apply the merge to
543
734
:param this_tree: The local tree in the merge operation
544
735
:param base_tree: The common tree in the merge operation
545
:param other_tree: The other other tree to merge changes from
736
:param other_tree: The other tree to merge changes from
737
:param this_branch: The branch associated with this_tree. Defaults to
738
this_tree.branch if not supplied.
739
:param other_branch: The branch associated with other_tree, if any.
546
740
:param interesting_ids: The file_ids of files that should be
547
741
participate in the merge. May not be combined with
548
742
interesting_files.
549
743
:param: reprocess If True, perform conflict-reduction processing.
550
744
:param show_base: If True, show the base revision in text conflicts.
551
745
(incompatible with reprocess)
552
:param pb: A Progress bar
553
747
:param pp: A ProgressPhase object
554
748
:param change_reporter: An object that should report changes made
555
749
:param interesting_files: The tree-relative paths of files that should
581
780
# making sure we haven't missed any corner cases.
582
781
# if lca_trees is None:
583
782
# self._lca_trees = [self.base_tree]
586
783
self.change_reporter = change_reporter
587
784
self.cherrypick = cherrypick
589
self.pp = ProgressPhase("Merge phase", 3, self.pb)
788
warnings.warn("pp argument to Merge3Merger is deprecated")
790
warnings.warn("pb argument to Merge3Merger is deprecated")
593
792
def do_merge(self):
594
self.this_tree.lock_tree_write()
793
operation = cleanup.OperationWithCleanups(self._do_merge)
794
self.working_tree.lock_tree_write()
795
operation.add_cleanup(self.working_tree.unlock)
796
self.this_tree.lock_read()
797
operation.add_cleanup(self.this_tree.unlock)
595
798
self.base_tree.lock_read()
799
operation.add_cleanup(self.base_tree.unlock)
596
800
self.other_tree.lock_read()
597
self.tt = TreeTransform(self.this_tree, self.pb)
801
operation.add_cleanup(self.other_tree.unlock)
804
def _do_merge(self, operation):
805
self.tt = transform.TreeTransform(self.working_tree, None)
806
operation.add_cleanup(self.tt.finalize)
807
self._compute_transform()
808
results = self.tt.apply(no_conflicts=True)
809
self.write_modified(results)
600
self._compute_transform()
602
results = self.tt.apply(no_conflicts=True)
603
self.write_modified(results)
605
self.this_tree.add_conflicts(self.cooked_conflicts)
606
except UnsupportedOperation:
610
self.other_tree.unlock()
611
self.base_tree.unlock()
612
self.this_tree.unlock()
811
self.working_tree.add_conflicts(self.cooked_conflicts)
812
except errors.UnsupportedOperation:
615
815
def make_preview_transform(self):
816
operation = cleanup.OperationWithCleanups(self._make_preview_transform)
616
817
self.base_tree.lock_read()
818
operation.add_cleanup(self.base_tree.unlock)
617
819
self.other_tree.lock_read()
618
self.tt = TransformPreview(self.this_tree)
621
self._compute_transform()
624
self.other_tree.unlock()
625
self.base_tree.unlock()
820
operation.add_cleanup(self.other_tree.unlock)
821
return operation.run_simple()
823
def _make_preview_transform(self):
824
self.tt = transform.TransformPreview(self.working_tree)
825
self._compute_transform()
629
828
def _compute_transform(self):
1069
1230
parent_id_winner = "other"
1070
1231
if name_winner == "this" and parent_id_winner == "this":
1072
if name_winner == "conflict":
1073
trans_id = self.tt.trans_id_file_id(file_id)
1074
self._raw_conflicts.append(('name conflict', trans_id,
1075
this_name, other_name))
1076
if parent_id_winner == "conflict":
1077
trans_id = self.tt.trans_id_file_id(file_id)
1078
self._raw_conflicts.append(('parent conflict', trans_id,
1079
this_parent, other_parent))
1080
if other_name is None:
1081
# it doesn't matter whether the result was 'other' or
1082
# 'conflict'-- if there's no 'other', we leave it alone.
1233
if name_winner == 'conflict' or parent_id_winner == 'conflict':
1234
# Creating helpers (.OTHER or .THIS) here cause problems down the
1235
# road if a ContentConflict needs to be created so we should not do
1237
trans_id = self.tt.trans_id_file_id(file_id)
1238
self._raw_conflicts.append(('path conflict', trans_id, file_id,
1239
this_parent, this_name,
1240
other_parent, other_name))
1241
if not self.other_tree.has_id(file_id):
1242
# it doesn't matter whether the result was 'other' or
1243
# 'conflict'-- if it has no file id, we leave it alone.
1084
# if we get here, name_winner and parent_winner are set to safe values.
1085
trans_id = self.tt.trans_id_file_id(file_id)
1086
1245
parent_id = parents[self.winner_idx[parent_id_winner]]
1087
if parent_id is not None:
1088
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1089
self.tt.adjust_path(names[self.winner_idx[name_winner]],
1090
parent_trans_id, trans_id)
1246
name = names[self.winner_idx[name_winner]]
1247
if parent_id is not None or name is not None:
1248
# if we get here, name_winner and parent_winner are set to safe
1250
if parent_id is None and name is not None:
1251
# if parent_id is None and name is non-None, current file is
1253
if names[self.winner_idx[parent_id_winner]] != '':
1254
raise AssertionError(
1255
'File looks like a root, but named %s' %
1256
names[self.winner_idx[parent_id_winner]])
1257
parent_trans_id = transform.ROOT_PARENT
1259
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1260
self.tt.adjust_path(name, parent_trans_id,
1261
self.tt.trans_id_file_id(file_id))
1092
def merge_contents(self, file_id):
1093
"""Performa a merge on file_id contents."""
1263
def _do_merge_contents(self, file_id):
1264
"""Performs a merge on file_id contents."""
1094
1265
def contents_pair(tree):
1095
if file_id not in tree:
1266
if not tree.has_id(file_id):
1096
1267
return (None, None)
1097
1268
kind = tree.kind(file_id)
1098
1269
if kind == "file":
1103
1274
contents = None
1104
1275
return kind, contents
1106
def contents_conflict():
1107
trans_id = self.tt.trans_id_file_id(file_id)
1108
name = self.tt.final_name(trans_id)
1109
parent_id = self.tt.final_parent(trans_id)
1110
if file_id in self.this_tree.inventory:
1111
self.tt.unversion_file(trans_id)
1112
if file_id in self.this_tree:
1113
self.tt.delete_contents(trans_id)
1114
file_group = self._dump_conflicts(name, parent_id, file_id,
1116
self._raw_conflicts.append(('contents conflict', file_group))
1118
1277
# See SPOT run. run, SPOT, run.
1119
1278
# So we're not QUITE repeating ourselves; we do tricky things with
1121
1280
base_pair = contents_pair(self.base_tree)
1122
1281
other_pair = contents_pair(self.other_tree)
1123
if base_pair == other_pair:
1124
# OTHER introduced no changes
1126
this_pair = contents_pair(self.this_tree)
1127
if this_pair == other_pair:
1128
# THIS and OTHER introduced the same changes
1283
this_pair = contents_pair(self.this_tree)
1284
lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
1285
winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
1286
this_pair, allow_overriding_lca=False)
1131
trans_id = self.tt.trans_id_file_id(file_id)
1132
if this_pair == base_pair:
1133
# only OTHER introduced changes
1134
if file_id in self.this_tree:
1135
# Remove any existing contents
1136
self.tt.delete_contents(trans_id)
1137
if file_id in self.other_tree:
1138
# OTHER changed the file
1139
create_from_tree(self.tt, trans_id,
1140
self.other_tree, file_id)
1141
if file_id not in self.this_tree:
1142
self.tt.version_file(file_id, trans_id)
1144
elif file_id in self.this_tree.inventory:
1145
# OTHER deleted the file
1288
if base_pair == other_pair:
1291
# We delayed evaluating this_pair as long as we can to avoid
1292
# unnecessary sha1 calculation
1293
this_pair = contents_pair(self.this_tree)
1294
winner = self._three_way(base_pair, other_pair, this_pair)
1295
if winner == 'this':
1296
# No interesting changes introduced by OTHER
1298
# We have a hypothetical conflict, but if we have files, then we
1299
# can try to merge the content
1300
trans_id = self.tt.trans_id_file_id(file_id)
1301
params = MergeFileHookParams(self, file_id, trans_id, this_pair[0],
1302
other_pair[0], winner)
1303
hooks = self.active_hooks
1304
hook_status = 'not_applicable'
1306
hook_status, lines = hook.merge_contents(params)
1307
if hook_status != 'not_applicable':
1308
# Don't try any more hooks, this one applies.
1310
# If the merge ends up replacing the content of the file, we get rid of
1311
# it at the end of this method (this variable is used to track the
1312
# exceptions to this rule).
1315
if hook_status == 'not_applicable':
1316
# No merge hook was able to resolve the situation. Two cases exist:
1317
# a content conflict or a duplicate one.
1319
name = self.tt.final_name(trans_id)
1320
parent_id = self.tt.final_parent(trans_id)
1322
inhibit_content_conflict = False
1323
if params.this_kind is None: # file_id is not in THIS
1324
# Is the name used for a different file_id ?
1325
dupe_path = self.other_tree.id2path(file_id)
1326
this_id = self.this_tree.path2id(dupe_path)
1327
if this_id is not None:
1328
# Two entries for the same path
1330
# versioning the merged file will trigger a duplicate
1332
self.tt.version_file(file_id, trans_id)
1333
transform.create_from_tree(
1334
self.tt, trans_id, self.other_tree, file_id,
1335
filter_tree_path=self._get_filter_tree_path(file_id))
1336
inhibit_content_conflict = True
1337
elif params.other_kind is None: # file_id is not in OTHER
1338
# Is the name used for a different file_id ?
1339
dupe_path = self.this_tree.id2path(file_id)
1340
other_id = self.other_tree.path2id(dupe_path)
1341
if other_id is not None:
1342
# Two entries for the same path again, but here, the other
1343
# entry will also be merged. We simply inhibit the
1344
# 'content' conflict creation because we know OTHER will
1345
# create (or has already created depending on ordering) an
1346
# entry at the same path. This will trigger a 'duplicate'
1349
inhibit_content_conflict = True
1350
if not inhibit_content_conflict:
1351
if params.this_kind is not None:
1146
1352
self.tt.unversion_file(trans_id)
1148
#BOTH THIS and OTHER introduced changes; scalar conflict
1149
elif this_pair[0] == "file" and other_pair[0] == "file":
1150
# THIS and OTHER are both files, so text merge. Either
1151
# BASE is a file, or both converted to files, so at least we
1152
# have agreement that output should be a file.
1154
self.text_merge(file_id, trans_id)
1156
return contents_conflict()
1157
if file_id not in self.this_tree:
1158
self.tt.version_file(file_id, trans_id)
1160
self.tt.tree_kind(trans_id)
1161
self.tt.delete_contents(trans_id)
1166
# Scalar conflict, can't text merge. Dump conflicts
1167
return contents_conflict()
1353
# This is a contents conflict, because none of the available
1354
# functions could merge it.
1355
file_group = self._dump_conflicts(name, parent_id, file_id,
1357
self._raw_conflicts.append(('contents conflict', file_group))
1358
elif hook_status == 'success':
1359
self.tt.create_file(lines, trans_id)
1360
elif hook_status == 'conflicted':
1361
# XXX: perhaps the hook should be able to provide
1362
# the BASE/THIS/OTHER files?
1363
self.tt.create_file(lines, trans_id)
1364
self._raw_conflicts.append(('text conflict', trans_id))
1365
name = self.tt.final_name(trans_id)
1366
parent_id = self.tt.final_parent(trans_id)
1367
self._dump_conflicts(name, parent_id, file_id)
1368
elif hook_status == 'delete':
1369
self.tt.unversion_file(trans_id)
1371
elif hook_status == 'done':
1372
# The hook function did whatever it needs to do directly, no
1373
# further action needed here.
1376
raise AssertionError('unknown hook_status: %r' % (hook_status,))
1377
if not self.this_tree.has_id(file_id) and result == "modified":
1378
self.tt.version_file(file_id, trans_id)
1380
# The merge has been performed and produced a new content, so the
1381
# old contents should not be retained.
1382
self.tt.delete_contents(trans_id)
1385
def _default_other_winner_merge(self, merge_hook_params):
1386
"""Replace this contents with other."""
1387
file_id = merge_hook_params.file_id
1388
trans_id = merge_hook_params.trans_id
1389
if self.other_tree.has_id(file_id):
1390
# OTHER changed the file
1391
transform.create_from_tree(
1392
self.tt, trans_id, self.other_tree, file_id,
1393
filter_tree_path=self._get_filter_tree_path(file_id))
1395
elif self.this_tree.has_id(file_id):
1396
# OTHER deleted the file
1397
return 'delete', None
1399
raise AssertionError(
1400
'winner is OTHER, but file_id %r not in THIS or OTHER tree'
1403
def merge_contents(self, merge_hook_params):
1404
"""Fallback merge logic after user installed hooks."""
1405
# This function is used in merge hooks as the fallback instance.
1406
# Perhaps making this function and the functions it calls be a
1407
# a separate class would be better.
1408
if merge_hook_params.winner == 'other':
1409
# OTHER is a straight winner, so replace this contents with other
1410
return self._default_other_winner_merge(merge_hook_params)
1411
elif merge_hook_params.is_file_merge():
1412
# THIS and OTHER are both files, so text merge. Either
1413
# BASE is a file, or both converted to files, so at least we
1414
# have agreement that output should be a file.
1416
self.text_merge(merge_hook_params.file_id,
1417
merge_hook_params.trans_id)
1418
except errors.BinaryFile:
1419
return 'not_applicable', None
1422
return 'not_applicable', None
1169
1424
def get_lines(self, tree, file_id):
1170
1425
"""Return the lines in a file, or an empty list."""
1172
return tree.get_file(file_id).readlines()
1426
if tree.has_id(file_id):
1427
return tree.get_file_lines(file_id)
1225
1494
determined automatically. If set_version is true, the .OTHER, .THIS
1226
1495
or .BASE (in that order) will be created as versioned files.
1228
data = [('OTHER', self.other_tree, other_lines),
1497
data = [('OTHER', self.other_tree, other_lines),
1229
1498
('THIS', self.this_tree, this_lines)]
1230
1499
if not no_base:
1231
1500
data.append(('BASE', self.base_tree, base_lines))
1502
# We need to use the actual path in the working tree of the file here,
1503
# ignoring the conflict suffixes
1505
if wt.supports_content_filtering():
1507
filter_tree_path = wt.id2path(file_id)
1508
except errors.NoSuchId:
1509
# file has been deleted
1510
filter_tree_path = None
1512
# Skip the id2path lookup for older formats
1513
filter_tree_path = None
1232
1515
versioned = False
1233
1516
file_group = []
1234
1517
for suffix, tree, lines in data:
1518
if tree.has_id(file_id):
1236
1519
trans_id = self._conflict_file(name, parent_id, tree, file_id,
1520
suffix, lines, filter_tree_path)
1238
1521
file_group.append(trans_id)
1239
1522
if set_version and not versioned:
1240
1523
self.tt.version_file(file_id, trans_id)
1241
1524
versioned = True
1242
1525
return file_group
1244
1527
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1528
lines=None, filter_tree_path=None):
1246
1529
"""Emit a single conflict file."""
1247
1530
name = name + '.' + suffix
1248
1531
trans_id = self.tt.create_path(name, parent_id)
1249
create_from_tree(self.tt, trans_id, tree, file_id, lines)
1532
transform.create_from_tree(self.tt, trans_id, tree, file_id, lines,
1250
1534
return trans_id
1252
1536
def merge_executable(self, file_id, file_status):
1294
1575
def cook_conflicts(self, fs_conflicts):
1295
1576
"""Convert all conflicts into a form that doesn't depend on trans_id"""
1296
from conflicts import Conflict
1298
self.cooked_conflicts.extend(cook_conflicts(fs_conflicts, self.tt))
1299
fp = FinalPaths(self.tt)
1577
content_conflict_file_ids = set()
1578
cooked_conflicts = transform.cook_conflicts(fs_conflicts, self.tt)
1579
fp = transform.FinalPaths(self.tt)
1300
1580
for conflict in self._raw_conflicts:
1301
1581
conflict_type = conflict[0]
1302
if conflict_type in ('name conflict', 'parent conflict'):
1303
trans_id = conflict[1]
1304
conflict_args = conflict[2:]
1305
if trans_id not in name_conflicts:
1306
name_conflicts[trans_id] = {}
1307
unique_add(name_conflicts[trans_id], conflict_type,
1309
if conflict_type == 'contents conflict':
1582
if conflict_type == 'path conflict':
1584
this_parent, this_name,
1585
other_parent, other_name) = conflict[1:]
1586
if this_parent is None or this_name is None:
1587
this_path = '<deleted>'
1589
parent_path = fp.get_path(
1590
self.tt.trans_id_file_id(this_parent))
1591
this_path = osutils.pathjoin(parent_path, this_name)
1592
if other_parent is None or other_name is None:
1593
other_path = '<deleted>'
1595
if other_parent == self.other_tree.get_root_id():
1596
# The tree transform doesn't know about the other root,
1597
# so we special case here to avoid a NoFinalPath
1601
parent_path = fp.get_path(
1602
self.tt.trans_id_file_id(other_parent))
1603
other_path = osutils.pathjoin(parent_path, other_name)
1604
c = _mod_conflicts.Conflict.factory(
1605
'path conflict', path=this_path,
1606
conflict_path=other_path,
1608
elif conflict_type == 'contents conflict':
1310
1609
for trans_id in conflict[1]:
1311
1610
file_id = self.tt.final_file_id(trans_id)
1312
1611
if file_id is not None:
1612
# Ok we found the relevant file-id
1314
1614
path = fp.get_path(trans_id)
1315
1615
for suffix in ('.BASE', '.THIS', '.OTHER'):
1316
1616
if path.endswith(suffix):
1617
# Here is the raw path
1317
1618
path = path[:-len(suffix)]
1319
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
1320
self.cooked_conflicts.append(c)
1321
if conflict_type == 'text conflict':
1620
c = _mod_conflicts.Conflict.factory(conflict_type,
1621
path=path, file_id=file_id)
1622
content_conflict_file_ids.add(file_id)
1623
elif conflict_type == 'text conflict':
1322
1624
trans_id = conflict[1]
1323
1625
path = fp.get_path(trans_id)
1324
1626
file_id = self.tt.final_file_id(trans_id)
1325
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
1326
self.cooked_conflicts.append(c)
1627
c = _mod_conflicts.Conflict.factory(conflict_type,
1628
path=path, file_id=file_id)
1630
raise AssertionError('bad conflict type: %r' % (conflict,))
1631
cooked_conflicts.append(c)
1328
for trans_id, conflicts in name_conflicts.iteritems():
1330
this_parent, other_parent = conflicts['parent conflict']
1331
if this_parent == other_parent:
1332
raise AssertionError()
1334
this_parent = other_parent = \
1335
self.tt.final_file_id(self.tt.final_parent(trans_id))
1337
this_name, other_name = conflicts['name conflict']
1338
if this_name == other_name:
1339
raise AssertionError()
1341
this_name = other_name = self.tt.final_name(trans_id)
1342
other_path = fp.get_path(trans_id)
1343
if this_parent is not None and this_name is not None:
1344
this_parent_path = \
1345
fp.get_path(self.tt.trans_id_file_id(this_parent))
1346
this_path = pathjoin(this_parent_path, this_name)
1348
this_path = "<deleted>"
1349
file_id = self.tt.final_file_id(trans_id)
1350
c = Conflict.factory('path conflict', path=this_path,
1351
conflict_path=other_path, file_id=file_id)
1633
self.cooked_conflicts = []
1634
# We want to get rid of path conflicts when a corresponding contents
1635
# conflict exists. This can occur when one branch deletes a file while
1636
# the other renames *and* modifies it. In this case, the content
1637
# conflict is enough.
1638
for c in cooked_conflicts:
1639
if (c.typestring == 'path conflict'
1640
and c.file_id in content_conflict_file_ids):
1352
1642
self.cooked_conflicts.append(c)
1353
self.cooked_conflicts.sort(key=Conflict.sort_key)
1643
self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
1356
1646
class WeaveMerger(Merge3Merger):
1360
1650
supports_reverse_cherrypick = False
1361
1651
history_based = True
1363
def _merged_lines(self, file_id):
1364
"""Generate the merged lines.
1365
There is no distinction between lines that are meant to contain <<<<<<<
1369
base = self.base_tree
1372
plan = self.this_tree.plan_file_merge(file_id, self.other_tree,
1653
def _generate_merge_plan(self, file_id, base):
1654
return 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)
1374
1667
if 'merge' in debug.debug_flags:
1375
1668
plan = list(plan)
1376
1669
trans_id = self.tt.trans_id_file_id(file_id)
1377
1670
name = self.tt.final_name(trans_id) + '.plan'
1378
contents = ('%10s|%s' % l for l in plan)
1671
contents = ('%11s|%s' % l for l in plan)
1379
1672
self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1380
textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1381
'>>>>>>> MERGE-SOURCE\n')
1382
return textmerge.merge_lines(self.reprocess)
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
1384
1682
def text_merge(self, file_id, trans_id):
1385
1683
"""Perform a (weave) text merge for a given file and file-id.
1386
1684
If conflicts are encountered, .THIS and .OTHER files will be emitted,
1387
1685
and a conflict will be noted.
1389
lines, conflicts = self._merged_lines(file_id)
1687
lines, base_lines = self._merged_lines(file_id)
1390
1688
lines = list(lines)
1391
# Note we're checking whether the OUTPUT is binary in this case,
1689
# Note we're checking whether the OUTPUT is binary in this case,
1392
1690
# because we don't want to get into weave merge guts.
1393
check_text_lines(lines)
1691
textfile.check_text_lines(lines)
1394
1692
self.tt.create_file(lines, trans_id)
1693
if base_lines is not None:
1396
1695
self._raw_conflicts.append(('text conflict', trans_id))
1397
1696
name = self.tt.final_name(trans_id)
1398
1697
parent_id = self.tt.final_parent(trans_id)
1399
file_group = self._dump_conflicts(name, parent_id, file_id,
1698
file_group = self._dump_conflicts(name, parent_id, file_id,
1700
base_lines=base_lines)
1401
1701
file_group.append(trans_id)
1404
1704
class LCAMerger(WeaveMerger):
1406
def _merged_lines(self, file_id):
1407
"""Generate the merged lines.
1408
There is no distinction between lines that are meant to contain <<<<<<<
1412
base = self.base_tree
1415
plan = self.this_tree.plan_file_lca_merge(file_id, 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,
1417
if 'merge' in debug.debug_flags:
1419
trans_id = self.tt.trans_id_file_id(file_id)
1420
name = self.tt.final_name(trans_id) + '.plan'
1421
contents = ('%10s|%s' % l for l in plan)
1422
self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1423
textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1424
'>>>>>>> MERGE-SOURCE\n')
1425
return textmerge.merge_lines(self.reprocess)
1428
1710
class Diff3Merger(Merge3Merger):
1429
1711
"""Three-way merger using external diff3 for text merging"""
1431
1713
def dump_file(self, temp_dir, name, tree, file_id):
1432
out_path = pathjoin(temp_dir, name)
1714
out_path = osutils.pathjoin(temp_dir, name)
1433
1715
out_file = open(out_path, "wb")
1435
1717
in_file = tree.get_file(file_id)
1468
1750
osutils.rmtree(temp_dir)
1753
class PathNotInTree(errors.BzrError):
1755
_fmt = """Merge-into failed because %(tree)s does not contain %(path)s."""
1757
def __init__(self, path, tree):
1758
errors.BzrError.__init__(self, path=path, tree=tree)
1761
class MergeIntoMerger(Merger):
1762
"""Merger that understands other_tree will be merged into a subdir.
1764
This also changes the Merger api so that it uses real Branch, revision_id,
1765
and RevisonTree objects, rather than using revision specs.
1768
def __init__(self, this_tree, other_branch, other_tree, target_subdir,
1769
source_subpath, other_rev_id=None):
1770
"""Create a new MergeIntoMerger object.
1772
source_subpath in other_tree will be effectively copied to
1773
target_subdir in this_tree.
1775
:param this_tree: The tree that we will be merging into.
1776
:param other_branch: The Branch we will be merging from.
1777
:param other_tree: The RevisionTree object we want to merge.
1778
:param target_subdir: The relative path where we want to merge
1779
other_tree into this_tree
1780
:param source_subpath: The relative path specifying the subtree of
1781
other_tree to merge into this_tree.
1783
# It is assumed that we are merging a tree that is not in our current
1784
# ancestry, which means we are using the "EmptyTree" as our basis.
1785
null_ancestor_tree = this_tree.branch.repository.revision_tree(
1786
_mod_revision.NULL_REVISION)
1787
super(MergeIntoMerger, self).__init__(
1788
this_branch=this_tree.branch,
1789
this_tree=this_tree,
1790
other_tree=other_tree,
1791
base_tree=null_ancestor_tree,
1793
self._target_subdir = target_subdir
1794
self._source_subpath = source_subpath
1795
self.other_branch = other_branch
1796
if other_rev_id is None:
1797
other_rev_id = other_tree.get_revision_id()
1798
self.other_rev_id = self.other_basis = other_rev_id
1799
self.base_is_ancestor = True
1800
self.backup_files = True
1801
self.merge_type = Merge3Merger
1802
self.show_base = False
1803
self.reprocess = False
1804
self.interesting_ids = None
1805
self.merge_type = _MergeTypeParameterizer(MergeIntoMergeType,
1806
target_subdir=self._target_subdir,
1807
source_subpath=self._source_subpath)
1808
if self._source_subpath != '':
1809
# If this isn't a partial merge make sure the revisions will be
1811
self._maybe_fetch(self.other_branch, self.this_branch,
1814
def set_pending(self):
1815
if self._source_subpath != '':
1817
Merger.set_pending(self)
1820
class _MergeTypeParameterizer(object):
1821
"""Wrap a merge-type class to provide extra parameters.
1823
This is hack used by MergeIntoMerger to pass some extra parameters to its
1824
merge_type. Merger.do_merge() sets up its own set of parameters to pass to
1825
the 'merge_type' member. It is difficult override do_merge without
1826
re-writing the whole thing, so instead we create a wrapper which will pass
1827
the extra parameters.
1830
def __init__(self, merge_type, **kwargs):
1831
self._extra_kwargs = kwargs
1832
self._merge_type = merge_type
1834
def __call__(self, *args, **kwargs):
1835
kwargs.update(self._extra_kwargs)
1836
return self._merge_type(*args, **kwargs)
1838
def __getattr__(self, name):
1839
return getattr(self._merge_type, name)
1842
class MergeIntoMergeType(Merge3Merger):
1843
"""Merger that incorporates a tree (or part of a tree) into another."""
1845
def __init__(self, *args, **kwargs):
1846
"""Initialize the merger object.
1848
:param args: See Merge3Merger.__init__'s args.
1849
:param kwargs: See Merge3Merger.__init__'s keyword args, except for
1850
source_subpath and target_subdir.
1851
:keyword source_subpath: The relative path specifying the subtree of
1852
other_tree to merge into this_tree.
1853
:keyword target_subdir: The relative path where we want to merge
1854
other_tree into this_tree
1856
# All of the interesting work happens during Merge3Merger.__init__(),
1857
# so we have have to hack in to get our extra parameters set.
1858
self._source_subpath = kwargs.pop('source_subpath')
1859
self._target_subdir = kwargs.pop('target_subdir')
1860
super(MergeIntoMergeType, self).__init__(*args, **kwargs)
1862
def _compute_transform(self):
1863
child_pb = ui.ui_factory.nested_progress_bar()
1865
entries = self._entries_to_incorporate()
1866
entries = list(entries)
1867
for num, (entry, parent_id) in enumerate(entries):
1868
child_pb.update(gettext('Preparing file merge'), num, len(entries))
1869
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1870
trans_id = transform.new_by_entry(self.tt, entry,
1871
parent_trans_id, self.other_tree)
1874
self._finish_computing_transform()
1876
def _entries_to_incorporate(self):
1877
"""Yields pairs of (inventory_entry, new_parent)."""
1878
other_inv = self.other_tree.root_inventory
1879
subdir_id = other_inv.path2id(self._source_subpath)
1880
if subdir_id is None:
1881
# XXX: The error would be clearer if it gave the URL of the source
1882
# branch, but we don't have a reference to that here.
1883
raise PathNotInTree(self._source_subpath, "Source tree")
1884
subdir = other_inv[subdir_id]
1885
parent_in_target = osutils.dirname(self._target_subdir)
1886
target_id = self.this_tree.path2id(parent_in_target)
1887
if target_id is None:
1888
raise PathNotInTree(self._target_subdir, "Target tree")
1889
name_in_target = osutils.basename(self._target_subdir)
1890
merge_into_root = subdir.copy()
1891
merge_into_root.name = name_in_target
1892
if self.this_tree.has_id(merge_into_root.file_id):
1893
# Give the root a new file-id.
1894
# This can happen fairly easily if the directory we are
1895
# incorporating is the root, and both trees have 'TREE_ROOT' as
1896
# their root_id. Users will expect this to Just Work, so we
1897
# change the file-id here.
1898
# Non-root file-ids could potentially conflict too. That's really
1899
# an edge case, so we don't do anything special for those. We let
1900
# them cause conflicts.
1901
merge_into_root.file_id = generate_ids.gen_file_id(name_in_target)
1902
yield (merge_into_root, target_id)
1903
if subdir.kind != 'directory':
1904
# No children, so we are done.
1906
for ignored_path, entry in other_inv.iter_entries_by_dir(subdir_id):
1907
parent_id = entry.parent_id
1908
if parent_id == subdir.file_id:
1909
# The root's parent ID has changed, so make sure children of
1910
# the root refer to the new ID.
1911
parent_id = merge_into_root.file_id
1912
yield (entry, parent_id)
1471
1915
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1472
1916
backup_files=False,
1473
1917
merge_type=Merge3Merger,
added
removed
bzrlib/merge.py
