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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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_by_entry,
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
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)
67
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
68
interesting_ids=interesting_ids, this_tree=from_tree)
257
71
class Merger(object):
261
72
def __init__(self, this_branch, other_tree=None, base_tree=None,
262
this_tree=None, pb=None, change_reporter=None,
73
this_tree=None, pb=DummyProgress(), change_reporter=None,
263
74
recurse='down', revision_graph=None):
264
75
object.__init__(self)
265
76
self.this_branch = this_branch
458
247
if self.this_rev_id is None:
459
248
if self.this_basis_tree.get_file_sha1(file_id) != \
460
249
self.this_tree.get_file_sha1(file_id):
461
raise errors.WorkingTreeNotRevision(self.this_tree)
250
raise WorkingTreeNotRevision(self.this_tree)
463
252
trees = (self.this_basis_tree, self.other_tree)
464
253
return [get_id(tree, file_id) for tree in trees]
466
@deprecated_method(deprecated_in((2, 1, 0)))
467
255
def check_basis(self, check_clean, require_commits=True):
468
256
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')")
257
raise BzrCommandError("This branch has no commits."
258
" (perhaps you would prefer 'bzr pull')")
473
260
self.compare_basis()
474
261
if self.this_basis != self.this_rev_id:
475
262
raise errors.UncommittedChanges(self.this_tree)
477
@deprecated_method(deprecated_in((2, 1, 0)))
478
264
def compare_basis(self):
480
266
basis_tree = self.revision_tree(self.this_tree.last_revision())
481
267
except errors.NoSuchRevision:
482
268
basis_tree = self.this_tree.basis_tree()
483
if not self.this_tree.has_changes(basis_tree):
269
changes = self.this_tree.changes_from(basis_tree)
270
if not changes.has_changed():
484
271
self.this_rev_id = self.this_basis
486
273
def set_interesting_files(self, file_list):
487
274
self.interesting_files = file_list
489
276
def set_pending(self):
490
if (not self.base_is_ancestor or not self.base_is_other_ancestor
491
or self.other_rev_id is None):
277
if not self.base_is_ancestor or not self.base_is_other_ancestor or self.other_rev_id is None:
493
279
self._add_parent()
495
281
def _add_parent(self):
496
282
new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
497
283
new_parent_trees = []
498
operation = OperationWithCleanups(self.this_tree.set_parent_trees)
499
284
for revision_id in new_parents:
501
286
tree = self.revision_tree(revision_id)
658
445
if self._is_criss_cross and getattr(self.merge_type,
659
446
'supports_lca_trees', False):
660
447
kwargs['lca_trees'] = self._lca_trees
661
return self.merge_type(pb=None,
448
return self.merge_type(pb=self._pb,
662
449
change_reporter=self.change_reporter,
665
def _do_merge_to(self):
666
merge = self.make_merger()
667
if self.other_branch is not None:
668
self.other_branch.update_references(self.this_branch)
670
if self.recurse == 'down':
671
for relpath, file_id in self.this_tree.iter_references():
672
sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
673
other_revision = self.other_tree.get_reference_revision(
675
if other_revision == sub_tree.last_revision():
677
sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
678
sub_merge.merge_type = self.merge_type
679
other_branch = self.other_branch.reference_parent(file_id, relpath)
680
sub_merge.set_other_revision(other_revision, other_branch)
681
base_revision = self.base_tree.get_reference_revision(file_id)
682
sub_merge.base_tree = \
683
sub_tree.branch.repository.revision_tree(base_revision)
684
sub_merge.base_rev_id = base_revision
688
452
def do_merge(self):
689
operation = OperationWithCleanups(self._do_merge_to)
690
453
self.this_tree.lock_tree_write()
691
operation.add_cleanup(self.this_tree.unlock)
692
454
if self.base_tree is not None:
693
455
self.base_tree.lock_read()
694
operation.add_cleanup(self.base_tree.unlock)
695
456
if self.other_tree is not None:
696
457
self.other_tree.lock_read()
697
operation.add_cleanup(self.other_tree.unlock)
698
merge = operation.run_simple()
459
merge = self.make_merger()
461
if self.recurse == 'down':
462
for relpath, file_id in self.this_tree.iter_references():
463
sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
464
other_revision = self.other_tree.get_reference_revision(
466
if other_revision == sub_tree.last_revision():
468
sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
469
sub_merge.merge_type = self.merge_type
470
other_branch = self.other_branch.reference_parent(file_id, relpath)
471
sub_merge.set_other_revision(other_revision, other_branch)
472
base_revision = self.base_tree.get_reference_revision(file_id)
473
sub_merge.base_tree = \
474
sub_tree.branch.repository.revision_tree(base_revision)
475
sub_merge.base_rev_id = base_revision
479
if self.other_tree is not None:
480
self.other_tree.unlock()
481
if self.base_tree is not None:
482
self.base_tree.unlock()
483
self.this_tree.unlock()
699
484
if len(merge.cooked_conflicts) == 0:
700
if not self.ignore_zero and not trace.is_quiet():
701
trace.note("All changes applied successfully.")
485
if not self.ignore_zero and not is_quiet():
486
note("All changes applied successfully.")
703
trace.note("%d conflicts encountered."
704
% len(merge.cooked_conflicts))
488
note("%d conflicts encountered." % len(merge.cooked_conflicts))
706
490
return len(merge.cooked_conflicts)
734
518
winner_idx = {"this": 2, "other": 1, "conflict": 1}
735
519
supports_lca_trees = True
737
def __init__(self, working_tree, this_tree, base_tree, other_tree,
521
def __init__(self, working_tree, this_tree, base_tree, other_tree,
738
522
interesting_ids=None, reprocess=False, show_base=False,
739
pb=None, pp=None, change_reporter=None,
523
pb=DummyProgress(), pp=None, change_reporter=None,
740
524
interesting_files=None, do_merge=True,
741
cherrypick=False, lca_trees=None, this_branch=None):
525
cherrypick=False, lca_trees=None):
742
526
"""Initialize the merger object and perform the merge.
744
528
:param working_tree: The working tree to apply the merge to
745
529
:param this_tree: The local tree in the merge operation
746
530
:param base_tree: The common tree in the merge operation
747
:param other_tree: The other tree to merge changes from
748
:param this_branch: The branch associated with this_tree. Defaults to
749
this_tree.branch if not supplied.
531
:param other_tree: The other other tree to merge changes from
750
532
:param interesting_ids: The file_ids of files that should be
751
533
participate in the merge. May not be combined with
752
534
interesting_files.
753
535
:param: reprocess If True, perform conflict-reduction processing.
754
536
:param show_base: If True, show the base revision in text conflicts.
755
537
(incompatible with reprocess)
538
:param pb: A Progress bar
757
539
:param pp: A ProgressPhase object
758
540
:param change_reporter: An object that should report changes made
759
541
:param interesting_files: The tree-relative paths of files that should
788
567
# making sure we haven't missed any corner cases.
789
568
# if lca_trees is None:
790
569
# self._lca_trees = [self.base_tree]
791
572
self.change_reporter = change_reporter
792
573
self.cherrypick = cherrypick
575
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
579
def do_merge(self):
801
operation = OperationWithCleanups(self._do_merge)
802
580
self.this_tree.lock_tree_write()
803
operation.add_cleanup(self.this_tree.unlock)
804
581
self.base_tree.lock_read()
805
operation.add_cleanup(self.base_tree.unlock)
806
582
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)
583
self.tt = TreeTransform(self.this_tree, self.pb)
817
self.this_tree.add_conflicts(self.cooked_conflicts)
818
except errors.UnsupportedOperation:
586
self._compute_transform()
588
results = self.tt.apply(no_conflicts=True)
589
self.write_modified(results)
591
self.this_tree.add_conflicts(self.cooked_conflicts)
592
except UnsupportedOperation:
596
self.other_tree.unlock()
597
self.base_tree.unlock()
598
self.this_tree.unlock()
821
601
def make_preview_transform(self):
822
operation = OperationWithCleanups(self._make_preview_transform)
823
602
self.base_tree.lock_read()
824
operation.add_cleanup(self.base_tree.unlock)
825
603
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()
604
self.tt = TransformPreview(self.this_tree)
607
self._compute_transform()
610
self.other_tree.unlock()
611
self.base_tree.unlock()
834
615
def _compute_transform(self):
1075
856
def fix_root(self):
1077
858
self.tt.final_kind(self.tt.root)
1078
except errors.NoSuchFile:
1079
860
self.tt.cancel_deletion(self.tt.root)
1080
861
if self.tt.final_file_id(self.tt.root) is None:
1081
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
862
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
864
if self.other_tree.inventory.root is None:
1083
866
other_root_file_id = self.other_tree.get_root_id()
1084
if other_root_file_id is None:
1086
867
other_root = self.tt.trans_id_file_id(other_root_file_id)
1087
868
if other_root == self.tt.root:
871
self.tt.final_kind(other_root)
1089
874
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)
875
# the other tree's root is a non-root in the current tree
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():
877
self.reparent_children(self.other_tree.inventory.root, self.tt.root)
878
self.tt.cancel_creation(other_root)
879
self.tt.cancel_versioning(other_root)
881
def reparent_children(self, ie, target):
882
for thing, child in ie.children.iteritems():
1104
883
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)
884
self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
1122
886
def write_modified(self, results):
1123
887
modified_hashes = {}
1291
1052
parent_id_winner = "other"
1292
1053
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))
1055
if name_winner == "conflict":
1056
trans_id = self.tt.trans_id_file_id(file_id)
1057
self._raw_conflicts.append(('name conflict', trans_id,
1058
this_name, other_name))
1059
if parent_id_winner == "conflict":
1060
trans_id = self.tt.trans_id_file_id(file_id)
1061
self._raw_conflicts.append(('parent conflict', trans_id,
1062
this_parent, other_parent))
1302
1063
if other_name is None:
1303
# it doesn't matter whether the result was 'other' or
1064
# it doesn't matter whether the result was 'other' or
1304
1065
# 'conflict'-- if there's no 'other', we leave it alone.
1067
# if we get here, name_winner and parent_winner are set to safe values.
1068
trans_id = self.tt.trans_id_file_id(file_id)
1306
1069
parent_id = parents[self.winner_idx[parent_id_winner]]
1307
1070
if parent_id is not None:
1308
# if we get here, name_winner and parent_winner are set to safe
1071
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1310
1072
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))
1073
parent_trans_id, trans_id)
1314
def _do_merge_contents(self, file_id):
1315
"""Performs a merge on file_id contents."""
1075
def merge_contents(self, file_id):
1076
"""Performa a merge on file_id contents."""
1316
1077
def contents_pair(tree):
1317
1078
if file_id not in tree:
1318
1079
return (None, None)
1325
1086
contents = None
1326
1087
return kind, contents
1089
def contents_conflict():
1090
trans_id = self.tt.trans_id_file_id(file_id)
1091
name = self.tt.final_name(trans_id)
1092
parent_id = self.tt.final_parent(trans_id)
1093
if file_id in self.this_tree.inventory:
1094
self.tt.unversion_file(trans_id)
1095
if file_id in self.this_tree:
1096
self.tt.delete_contents(trans_id)
1097
file_group = self._dump_conflicts(name, parent_id, file_id,
1099
self._raw_conflicts.append(('contents conflict', file_group))
1328
1101
# See SPOT run. run, SPOT, run.
1329
1102
# So we're not QUITE repeating ourselves; we do tricky things with
1331
1104
base_pair = contents_pair(self.base_tree)
1332
1105
other_pair = contents_pair(self.other_tree)
1334
this_pair = contents_pair(self.this_tree)
1335
lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
1336
winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
1337
this_pair, allow_overriding_lca=False)
1339
if base_pair == other_pair:
1342
# We delayed evaluating this_pair as long as we can to avoid
1343
# unnecessary sha1 calculation
1344
this_pair = contents_pair(self.this_tree)
1345
winner = self._three_way(base_pair, other_pair, this_pair)
1346
if winner == 'this':
1347
# No interesting changes introduced by OTHER
1349
# We have a hypothetical conflict, but if we have files, then we
1350
# can try to merge the content
1351
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':
1440
# 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
1453
return 'not_applicable', None
1106
if base_pair == other_pair:
1107
# OTHER introduced no changes
1109
this_pair = contents_pair(self.this_tree)
1110
if this_pair == other_pair:
1111
# THIS and OTHER introduced the same changes
1114
trans_id = self.tt.trans_id_file_id(file_id)
1115
if this_pair == base_pair:
1116
# only OTHER introduced changes
1117
if file_id in self.this_tree:
1118
# Remove any existing contents
1119
self.tt.delete_contents(trans_id)
1120
if file_id in self.other_tree:
1121
# OTHER changed the file
1122
create_by_entry(self.tt,
1123
self.other_tree.inventory[file_id],
1124
self.other_tree, trans_id)
1125
if file_id not in self.this_tree.inventory:
1126
self.tt.version_file(file_id, trans_id)
1128
elif file_id in self.this_tree.inventory:
1129
# OTHER deleted the file
1130
self.tt.unversion_file(trans_id)
1132
#BOTH THIS and OTHER introduced changes; scalar conflict
1133
elif this_pair[0] == "file" and other_pair[0] == "file":
1134
# THIS and OTHER are both files, so text merge. Either
1135
# BASE is a file, or both converted to files, so at least we
1136
# have agreement that output should be a file.
1138
self.text_merge(file_id, trans_id)
1140
return contents_conflict()
1141
if file_id not in self.this_tree.inventory:
1142
self.tt.version_file(file_id, trans_id)
1144
self.tt.tree_kind(trans_id)
1145
self.tt.delete_contents(trans_id)
1150
# Scalar conflict, can't text merge. Dump conflicts
1151
return contents_conflict()
1455
1153
def get_lines(self, tree, file_id):
1456
1154
"""Return the lines in a file, or an empty list."""
1457
if tree.has_id(file_id):
1458
1156
return tree.get_file(file_id).readlines()
1511
1209
determined automatically. If set_version is true, the .OTHER, .THIS
1512
1210
or .BASE (in that order) will be created as versioned files.
1514
data = [('OTHER', self.other_tree, other_lines),
1212
data = [('OTHER', self.other_tree, other_lines),
1515
1213
('THIS', self.this_tree, this_lines)]
1516
1214
if not no_base:
1517
1215
data.append(('BASE', self.base_tree, base_lines))
1519
# We need to use the actual path in the working tree of the file here,
1520
# ignoring the conflict suffixes
1522
if wt.supports_content_filtering():
1524
filter_tree_path = wt.id2path(file_id)
1525
except errors.NoSuchId:
1526
# file has been deleted
1527
filter_tree_path = None
1529
# Skip the id2path lookup for older formats
1530
filter_tree_path = None
1532
1216
versioned = False
1533
1217
file_group = []
1534
1218
for suffix, tree, lines in data:
1535
if tree.has_id(file_id):
1536
1220
trans_id = self._conflict_file(name, parent_id, tree, file_id,
1537
suffix, lines, filter_tree_path)
1538
1222
file_group.append(trans_id)
1539
1223
if set_version and not versioned:
1540
1224
self.tt.version_file(file_id, trans_id)
1541
1225
versioned = True
1542
1226
return file_group
1544
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1545
lines=None, filter_tree_path=None):
1228
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1546
1230
"""Emit a single conflict file."""
1547
1231
name = name + '.' + suffix
1548
1232
trans_id = self.tt.create_path(name, parent_id)
1549
transform.create_from_tree(self.tt, trans_id, tree, file_id, lines,
1233
entry = tree.inventory[file_id]
1234
create_by_entry(self.tt, entry, tree, trans_id, lines)
1551
1235
return trans_id
1553
1237
def merge_executable(self, file_id, file_status):
1629
1301
if path.endswith(suffix):
1630
1302
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':
1304
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
1305
self.cooked_conflicts.append(c)
1306
if conflict_type == 'text conflict':
1635
1307
trans_id = conflict[1]
1636
1308
path = fp.get_path(trans_id)
1637
1309
file_id = self.tt.final_file_id(trans_id)
1638
c = _mod_conflicts.Conflict.factory(conflict_type,
1639
path=path, file_id=file_id)
1310
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
1311
self.cooked_conflicts.append(c)
1313
for trans_id, conflicts in name_conflicts.iteritems():
1315
this_parent, other_parent = conflicts['parent conflict']
1316
if this_parent == other_parent:
1317
raise AssertionError()
1319
this_parent = other_parent = \
1320
self.tt.final_file_id(self.tt.final_parent(trans_id))
1322
this_name, other_name = conflicts['name conflict']
1323
if this_name == other_name:
1324
raise AssertionError()
1326
this_name = other_name = self.tt.final_name(trans_id)
1327
other_path = fp.get_path(trans_id)
1328
if this_parent is not None and this_name is not None:
1329
this_parent_path = \
1330
fp.get_path(self.tt.trans_id_file_id(this_parent))
1331
this_path = pathjoin(this_parent_path, this_name)
1641
raise AssertionError('bad conflict type: %r' % (conflict,))
1333
this_path = "<deleted>"
1334
file_id = self.tt.final_file_id(trans_id)
1335
c = Conflict.factory('path conflict', path=this_path,
1336
conflict_path=other_path, file_id=file_id)
1642
1337
self.cooked_conflicts.append(c)
1643
self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
1338
self.cooked_conflicts.sort(key=Conflict.sort_key)
1646
1341
class WeaveMerger(Merge3Merger):
1650
1345
supports_reverse_cherrypick = False
1651
1346
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,
1348
def _merged_lines(self, file_id):
1349
"""Generate the merged lines.
1350
There is no distinction between lines that are meant to contain <<<<<<<
1354
base = self.base_tree
1357
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
1359
if 'merge' in debug.debug_flags:
1668
1360
plan = list(plan)
1669
1361
trans_id = self.tt.trans_id_file_id(file_id)
1670
1362
name = self.tt.final_name(trans_id) + '.plan'
1671
contents = ('%11s|%s' % l for l in plan)
1363
contents = ('%10s|%s' % l for l in plan)
1672
1364
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
1365
textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1366
'>>>>>>> MERGE-SOURCE\n')
1367
return textmerge.merge_lines(self.reprocess)
1682
1369
def text_merge(self, file_id, trans_id):
1683
1370
"""Perform a (weave) text merge for a given file and file-id.
1684
1371
If conflicts are encountered, .THIS and .OTHER files will be emitted,
1685
1372
and a conflict will be noted.
1687
lines, base_lines = self._merged_lines(file_id)
1374
lines, conflicts = self._merged_lines(file_id)
1688
1375
lines = list(lines)
1689
# Note we're checking whether the OUTPUT is binary in this case,
1376
# Note we're checking whether the OUTPUT is binary in this case,
1690
1377
# because we don't want to get into weave merge guts.
1691
textfile.check_text_lines(lines)
1378
check_text_lines(lines)
1692
1379
self.tt.create_file(lines, trans_id)
1693
if base_lines is not None:
1695
1381
self._raw_conflicts.append(('text conflict', trans_id))
1696
1382
name = self.tt.final_name(trans_id)
1697
1383
parent_id = self.tt.final_parent(trans_id)
1698
file_group = self._dump_conflicts(name, parent_id, file_id,
1700
base_lines=base_lines)
1384
file_group = self._dump_conflicts(name, parent_id, file_id,
1701
1386
file_group.append(trans_id)
1704
1389
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,
1391
def _merged_lines(self, file_id):
1392
"""Generate the merged lines.
1393
There is no distinction between lines that are meant to contain <<<<<<<
1397
base = self.base_tree
1400
plan = self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
1402
if 'merge' in debug.debug_flags:
1404
trans_id = self.tt.trans_id_file_id(file_id)
1405
name = self.tt.final_name(trans_id) + '.plan'
1406
contents = ('%10s|%s' % l for l in plan)
1407
self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1408
textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1409
'>>>>>>> MERGE-SOURCE\n')
1410
return textmerge.merge_lines(self.reprocess)
1710
1413
class Diff3Merger(Merge3Merger):
1711
1414
"""Three-way merger using external diff3 for text merging"""
1713
1416
def dump_file(self, temp_dir, name, tree, file_id):
1714
out_path = osutils.pathjoin(temp_dir, name)
1417
out_path = pathjoin(temp_dir, name)
1715
1418
out_file = open(out_path, "wb")
1717
1420
in_file = tree.get_file(file_id)
added
removed
bzrlib/merge.py
