1
# Copyright (C) 2005, 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
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
20
from tempfile import mkdtemp
23
from bzrlib.branch import Branch
24
from bzrlib.conflicts import ConflictList, Conflict
25
from bzrlib.errors import (BzrCommandError,
35
WorkingTreeNotRevision,
38
from bzrlib.merge3 import Merge3
40
from bzrlib.osutils import rename, pathjoin, rmtree
41
from progress import DummyProgress, ProgressPhase
42
from bzrlib.revision import common_ancestor, is_ancestor, NULL_REVISION
43
from bzrlib.textfile import check_text_lines
44
from bzrlib.trace import mutter, warning, note
45
from bzrlib.transform import (TreeTransform, resolve_conflicts, cook_conflicts,
46
FinalPaths, create_by_entry, unique_add,
48
from bzrlib.versionedfile import WeaveMerge
51
# TODO: Report back as changes are merged in
53
def _get_tree(treespec, local_branch=None):
54
location, revno = treespec
55
branch = Branch.open_containing(location)[0]
59
revision = branch.last_revision()
61
revision = branch.get_rev_id(revno)
63
revision = NULL_REVISION
64
return branch, _get_revid_tree(branch, revision, local_branch)
67
def _get_revid_tree(branch, revision, local_branch):
69
base_tree = branch.bzrdir.open_workingtree()
71
if local_branch is not None:
72
if local_branch.base != branch.base:
73
local_branch.fetch(branch, revision)
74
base_tree = local_branch.repository.revision_tree(revision)
76
base_tree = branch.repository.revision_tree(revision)
80
def transform_tree(from_tree, to_tree, interesting_ids=None):
81
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
82
interesting_ids=interesting_ids, this_tree=from_tree)
86
def __init__(self, this_branch, other_tree=None, base_tree=None,
87
this_tree=None, pb=DummyProgress()):
89
assert this_tree is not None, "this_tree is required"
90
self.this_branch = this_branch
91
self.this_basis = this_branch.last_revision()
92
self.this_rev_id = None
93
self.this_tree = this_tree
94
self.this_revision_tree = None
95
self.this_basis_tree = None
96
self.other_tree = other_tree
97
self.base_tree = base_tree
98
self.ignore_zero = False
99
self.backup_files = False
100
self.interesting_ids = None
101
self.show_base = False
102
self.reprocess = False
107
def revision_tree(self, revision_id):
108
return self.this_branch.repository.revision_tree(revision_id)
110
def ensure_revision_trees(self):
111
if self.this_revision_tree is None:
112
self.this_basis_tree = self.this_branch.repository.revision_tree(
114
if self.this_basis == self.this_rev_id:
115
self.this_revision_tree = self.this_basis_tree
117
if self.other_rev_id is None:
118
other_basis_tree = self.revision_tree(self.other_basis)
119
changes = other_basis_tree.changes_from(self.other_tree)
120
if changes.has_changed():
121
raise WorkingTreeNotRevision(self.this_tree)
122
other_rev_id = self.other_basis
123
self.other_tree = other_basis_tree
125
def file_revisions(self, file_id):
126
self.ensure_revision_trees()
127
def get_id(tree, file_id):
128
revision_id = tree.inventory[file_id].revision
129
assert revision_id is not None
131
if self.this_rev_id is None:
132
if self.this_basis_tree.get_file_sha1(file_id) != \
133
self.this_tree.get_file_sha1(file_id):
134
raise WorkingTreeNotRevision(self.this_tree)
136
trees = (self.this_basis_tree, self.other_tree)
137
return [get_id(tree, file_id) for tree in trees]
139
def check_basis(self, check_clean, require_commits=True):
140
if self.this_basis is None and require_commits is True:
141
raise BzrCommandError("This branch has no commits")
144
if self.this_basis != self.this_rev_id:
145
raise BzrCommandError("Working tree has uncommitted changes.")
147
def compare_basis(self):
148
changes = self.this_tree.changes_from(self.this_tree.basis_tree())
149
if not changes.has_changed():
150
self.this_rev_id = self.this_basis
152
def set_interesting_files(self, file_list):
154
self._set_interesting_files(file_list)
155
except NotVersionedError, e:
156
raise BzrCommandError("%s is not a source file in any"
159
def _set_interesting_files(self, file_list):
160
"""Set the list of interesting ids from a list of files."""
161
if file_list is None:
162
self.interesting_ids = None
165
interesting_ids = set()
166
for path in file_list:
168
for tree in (self.this_tree, self.base_tree, self.other_tree):
169
file_id = tree.inventory.path2id(path)
170
if file_id is not None:
171
interesting_ids.add(file_id)
174
raise NotVersionedError(path=path)
175
self.interesting_ids = interesting_ids
177
def set_pending(self):
178
if not self.base_is_ancestor:
180
if self.other_rev_id is None:
182
ancestry = self.this_branch.repository.get_ancestry(self.this_basis)
183
if self.other_rev_id in ancestry:
185
self.this_tree.add_pending_merge(self.other_rev_id)
187
def set_other(self, other_revision):
188
other_branch, self.other_tree = _get_tree(other_revision,
190
if other_revision[1] == -1:
191
self.other_rev_id = other_branch.last_revision()
192
if self.other_rev_id is None:
193
raise NoCommits(other_branch)
194
self.other_basis = self.other_rev_id
195
elif other_revision[1] is not None:
196
self.other_rev_id = other_branch.get_rev_id(other_revision[1])
197
self.other_basis = self.other_rev_id
199
self.other_rev_id = None
200
self.other_basis = other_branch.last_revision()
201
if self.other_basis is None:
202
raise NoCommits(other_branch)
203
if other_branch.base != self.this_branch.base:
204
self.this_branch.fetch(other_branch, last_revision=self.other_basis)
207
self.set_base([None, None])
209
def set_base(self, base_revision):
210
mutter("doing merge() with no base_revision specified")
211
if base_revision == [None, None]:
213
pb = bzrlib.ui.ui_factory.nested_progress_bar()
215
this_repo = self.this_branch.repository
216
self.base_rev_id = common_ancestor(self.this_basis,
221
except NoCommonAncestor:
222
raise UnrelatedBranches()
223
self.base_tree = _get_revid_tree(self.this_branch, self.base_rev_id,
225
self.base_is_ancestor = True
227
base_branch, self.base_tree = _get_tree(base_revision)
228
if base_revision[1] == -1:
229
self.base_rev_id = base_branch.last_revision()
230
elif base_revision[1] is None:
231
self.base_rev_id = None
233
self.base_rev_id = base_branch.get_rev_id(base_revision[1])
234
if self.this_branch.base != base_branch.base:
235
self.this_branch.fetch(base_branch)
236
self.base_is_ancestor = is_ancestor(self.this_basis,
241
kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
242
'other_tree': self.other_tree,
243
'interesting_ids': self.interesting_ids,
245
if self.merge_type.requires_base:
246
kwargs['base_tree'] = self.base_tree
247
if self.merge_type.supports_reprocess:
248
kwargs['reprocess'] = self.reprocess
250
raise BzrError("Conflict reduction is not supported for merge"
251
" type %s." % self.merge_type)
252
if self.merge_type.supports_show_base:
253
kwargs['show_base'] = self.show_base
255
raise BzrError("Showing base is not supported for this"
256
" merge type. %s" % self.merge_type)
257
merge = self.merge_type(pb=self._pb, **kwargs)
258
if len(merge.cooked_conflicts) == 0:
259
if not self.ignore_zero:
260
note("All changes applied successfully.")
262
note("%d conflicts encountered." % len(merge.cooked_conflicts))
264
return len(merge.cooked_conflicts)
266
def regen_inventory(self, new_entries):
267
old_entries = self.this_tree.read_working_inventory()
271
for path, file_id in new_entries:
274
new_entries_map[file_id] = path
276
def id2path(file_id):
277
path = new_entries_map.get(file_id)
280
entry = old_entries[file_id]
281
if entry.parent_id is None:
283
return pathjoin(id2path(entry.parent_id), entry.name)
285
for file_id in old_entries:
286
entry = old_entries[file_id]
287
path = id2path(file_id)
288
if file_id in self.base_tree.inventory:
289
executable = getattr(self.base_tree.inventory[file_id], 'executable', False)
291
executable = getattr(entry, 'executable', False)
292
new_inventory[file_id] = (path, file_id, entry.parent_id,
293
entry.kind, executable)
295
by_path[path] = file_id
300
for path, file_id in new_entries:
302
del new_inventory[file_id]
305
new_path_list.append((path, file_id))
306
if file_id not in old_entries:
308
# Ensure no file is added before its parent
310
for path, file_id in new_path_list:
314
parent = by_path[os.path.dirname(path)]
315
abspath = pathjoin(self.this_tree.basedir, path)
316
kind = bzrlib.osutils.file_kind(abspath)
317
if file_id in self.base_tree.inventory:
318
executable = getattr(self.base_tree.inventory[file_id], 'executable', False)
321
new_inventory[file_id] = (path, file_id, parent, kind, executable)
322
by_path[path] = file_id
324
# Get a list in insertion order
325
new_inventory_list = new_inventory.values()
326
mutter ("""Inventory regeneration:
327
old length: %i insertions: %i deletions: %i new_length: %i"""\
328
% (len(old_entries), insertions, deletions,
329
len(new_inventory_list)))
330
assert len(new_inventory_list) == len(old_entries) + insertions\
332
new_inventory_list.sort()
333
return new_inventory_list
336
class Merge3Merger(object):
337
"""Three-way merger that uses the merge3 text merger"""
339
supports_reprocess = True
340
supports_show_base = True
341
history_based = False
343
def __init__(self, working_tree, this_tree, base_tree, other_tree,
344
interesting_ids=None, reprocess=False, show_base=False,
345
pb=DummyProgress(), pp=None):
346
"""Initialize the merger object and perform the merge."""
347
object.__init__(self)
348
self.this_tree = working_tree
349
self.base_tree = base_tree
350
self.other_tree = other_tree
351
self._raw_conflicts = []
352
self.cooked_conflicts = []
353
self.reprocess = reprocess
354
self.show_base = show_base
358
self.pp = ProgressPhase("Merge phase", 3, self.pb)
360
if interesting_ids is not None:
361
all_ids = interesting_ids
363
all_ids = set(base_tree)
364
all_ids.update(other_tree)
365
working_tree.lock_write()
366
self.tt = TreeTransform(working_tree, self.pb)
369
child_pb = ui.ui_factory.nested_progress_bar()
371
for num, file_id in enumerate(all_ids):
372
child_pb.update('Preparing file merge', num, len(all_ids))
373
self.merge_names(file_id)
374
file_status = self.merge_contents(file_id)
375
self.merge_executable(file_id, file_status)
380
child_pb = ui.ui_factory.nested_progress_bar()
382
fs_conflicts = resolve_conflicts(self.tt, child_pb)
385
self.cook_conflicts(fs_conflicts)
386
for conflict in self.cooked_conflicts:
389
results = self.tt.apply()
390
self.write_modified(results)
392
working_tree.add_conflicts(self.cooked_conflicts)
393
except UnsupportedOperation:
397
working_tree.unlock()
402
self.tt.final_kind(self.tt.root)
404
self.tt.cancel_deletion(self.tt.root)
405
if self.tt.final_file_id(self.tt.root) is None:
406
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
408
if self.other_tree.inventory.root is None:
410
other_root_file_id = self.other_tree.inventory.root.file_id
411
other_root = self.tt.trans_id_file_id(other_root_file_id)
412
if other_root == self.tt.root:
415
self.tt.final_kind(other_root)
418
self.reparent_children(self.other_tree.inventory.root, self.tt.root)
419
self.tt.cancel_creation(other_root)
420
self.tt.cancel_versioning(other_root)
422
def reparent_children(self, ie, target):
423
for thing, child in ie.children.iteritems():
424
trans_id = self.tt.trans_id_file_id(child.file_id)
425
self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
427
def write_modified(self, results):
429
for path in results.modified_paths:
430
file_id = self.this_tree.path2id(self.this_tree.relpath(path))
433
hash = self.this_tree.get_file_sha1(file_id)
436
modified_hashes[file_id] = hash
437
self.this_tree.set_merge_modified(modified_hashes)
440
def parent(entry, file_id):
441
"""Determine the parent for a file_id (used as a key method)"""
444
return entry.parent_id
447
def name(entry, file_id):
448
"""Determine the name for a file_id (used as a key method)"""
454
def contents_sha1(tree, file_id):
455
"""Determine the sha1 of the file contents (used as a key method)."""
456
if file_id not in tree:
458
return tree.get_file_sha1(file_id)
461
def executable(tree, file_id):
462
"""Determine the executability of a file-id (used as a key method)."""
463
if file_id not in tree:
465
if tree.kind(file_id) != "file":
467
return tree.is_executable(file_id)
470
def kind(tree, file_id):
471
"""Determine the kind of a file-id (used as a key method)."""
472
if file_id not in tree:
474
return tree.kind(file_id)
477
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
478
"""Do a three-way test on a scalar.
479
Return "this", "other" or "conflict", depending whether a value wins.
481
key_base = key(base_tree, file_id)
482
key_other = key(other_tree, file_id)
483
#if base == other, either they all agree, or only THIS has changed.
484
if key_base == key_other:
486
key_this = key(this_tree, file_id)
487
if key_this not in (key_base, key_other):
489
# "Ambiguous clean merge"
490
elif key_this == key_other:
493
assert key_this == key_base
496
def merge_names(self, file_id):
497
"""Perform a merge on file_id names and parents"""
499
if file_id in tree.inventory:
500
return tree.inventory[file_id]
503
this_entry = get_entry(self.this_tree)
504
other_entry = get_entry(self.other_tree)
505
base_entry = get_entry(self.base_tree)
506
name_winner = self.scalar_three_way(this_entry, base_entry,
507
other_entry, file_id, self.name)
508
parent_id_winner = self.scalar_three_way(this_entry, base_entry,
509
other_entry, file_id,
511
if this_entry is None:
512
if name_winner == "this":
513
name_winner = "other"
514
if parent_id_winner == "this":
515
parent_id_winner = "other"
516
if name_winner == "this" and parent_id_winner == "this":
518
if name_winner == "conflict":
519
trans_id = self.tt.trans_id_file_id(file_id)
520
self._raw_conflicts.append(('name conflict', trans_id,
521
self.name(this_entry, file_id),
522
self.name(other_entry, file_id)))
523
if parent_id_winner == "conflict":
524
trans_id = self.tt.trans_id_file_id(file_id)
525
self._raw_conflicts.append(('parent conflict', trans_id,
526
self.parent(this_entry, file_id),
527
self.parent(other_entry, file_id)))
528
if other_entry is None:
529
# it doesn't matter whether the result was 'other' or
530
# 'conflict'-- if there's no 'other', we leave it alone.
532
# if we get here, name_winner and parent_winner are set to safe values.
533
winner_entry = {"this": this_entry, "other": other_entry,
534
"conflict": other_entry}
535
trans_id = self.tt.trans_id_file_id(file_id)
536
parent_id = winner_entry[parent_id_winner].parent_id
537
if parent_id is not None:
538
parent_trans_id = self.tt.trans_id_file_id(parent_id)
539
self.tt.adjust_path(winner_entry[name_winner].name,
540
parent_trans_id, trans_id)
542
def merge_contents(self, file_id):
543
"""Performa a merge on file_id contents."""
544
def contents_pair(tree):
545
if file_id not in tree:
547
kind = tree.kind(file_id)
549
contents = tree.get_file_sha1(file_id)
550
elif kind == "symlink":
551
contents = tree.get_symlink_target(file_id)
554
return kind, contents
556
def contents_conflict():
557
trans_id = self.tt.trans_id_file_id(file_id)
558
name = self.tt.final_name(trans_id)
559
parent_id = self.tt.final_parent(trans_id)
560
if file_id in self.this_tree.inventory:
561
self.tt.unversion_file(trans_id)
562
self.tt.delete_contents(trans_id)
563
file_group = self._dump_conflicts(name, parent_id, file_id,
565
self._raw_conflicts.append(('contents conflict', file_group))
567
# See SPOT run. run, SPOT, run.
568
# So we're not QUITE repeating ourselves; we do tricky things with
570
base_pair = contents_pair(self.base_tree)
571
other_pair = contents_pair(self.other_tree)
572
if base_pair == other_pair:
573
# OTHER introduced no changes
575
this_pair = contents_pair(self.this_tree)
576
if this_pair == other_pair:
577
# THIS and OTHER introduced the same changes
580
trans_id = self.tt.trans_id_file_id(file_id)
581
if this_pair == base_pair:
582
# only OTHER introduced changes
583
if file_id in self.this_tree:
584
# Remove any existing contents
585
self.tt.delete_contents(trans_id)
586
if file_id in self.other_tree:
587
# OTHER changed the file
588
create_by_entry(self.tt,
589
self.other_tree.inventory[file_id],
590
self.other_tree, trans_id)
591
if file_id not in self.this_tree.inventory:
592
self.tt.version_file(file_id, trans_id)
594
elif file_id in self.this_tree.inventory:
595
# OTHER deleted the file
596
self.tt.unversion_file(trans_id)
598
#BOTH THIS and OTHER introduced changes; scalar conflict
599
elif this_pair[0] == "file" and other_pair[0] == "file":
600
# THIS and OTHER are both files, so text merge. Either
601
# BASE is a file, or both converted to files, so at least we
602
# have agreement that output should be a file.
604
self.text_merge(file_id, trans_id)
606
return contents_conflict()
607
if file_id not in self.this_tree.inventory:
608
self.tt.version_file(file_id, trans_id)
610
self.tt.tree_kind(trans_id)
611
self.tt.delete_contents(trans_id)
616
# Scalar conflict, can't text merge. Dump conflicts
617
return contents_conflict()
619
def get_lines(self, tree, file_id):
620
"""Return the lines in a file, or an empty list."""
622
return tree.get_file(file_id).readlines()
626
def text_merge(self, file_id, trans_id):
627
"""Perform a three-way text merge on a file_id"""
628
# it's possible that we got here with base as a different type.
629
# if so, we just want two-way text conflicts.
630
if file_id in self.base_tree and \
631
self.base_tree.kind(file_id) == "file":
632
base_lines = self.get_lines(self.base_tree, file_id)
635
other_lines = self.get_lines(self.other_tree, file_id)
636
this_lines = self.get_lines(self.this_tree, file_id)
637
m3 = Merge3(base_lines, this_lines, other_lines)
638
start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
639
if self.show_base is True:
640
base_marker = '|' * 7
644
def iter_merge3(retval):
645
retval["text_conflicts"] = False
646
for line in m3.merge_lines(name_a = "TREE",
647
name_b = "MERGE-SOURCE",
648
name_base = "BASE-REVISION",
649
start_marker=start_marker,
650
base_marker=base_marker,
651
reprocess=self.reprocess):
652
if line.startswith(start_marker):
653
retval["text_conflicts"] = True
654
yield line.replace(start_marker, '<' * 7)
658
merge3_iterator = iter_merge3(retval)
659
self.tt.create_file(merge3_iterator, trans_id)
660
if retval["text_conflicts"] is True:
661
self._raw_conflicts.append(('text conflict', trans_id))
662
name = self.tt.final_name(trans_id)
663
parent_id = self.tt.final_parent(trans_id)
664
file_group = self._dump_conflicts(name, parent_id, file_id,
665
this_lines, base_lines,
667
file_group.append(trans_id)
669
def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
670
base_lines=None, other_lines=None, set_version=False,
672
"""Emit conflict files.
673
If this_lines, base_lines, or other_lines are omitted, they will be
674
determined automatically. If set_version is true, the .OTHER, .THIS
675
or .BASE (in that order) will be created as versioned files.
677
data = [('OTHER', self.other_tree, other_lines),
678
('THIS', self.this_tree, this_lines)]
680
data.append(('BASE', self.base_tree, base_lines))
683
for suffix, tree, lines in data:
685
trans_id = self._conflict_file(name, parent_id, tree, file_id,
687
file_group.append(trans_id)
688
if set_version and not versioned:
689
self.tt.version_file(file_id, trans_id)
693
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
695
"""Emit a single conflict file."""
696
name = name + '.' + suffix
697
trans_id = self.tt.create_path(name, parent_id)
698
entry = tree.inventory[file_id]
699
create_by_entry(self.tt, entry, tree, trans_id, lines)
702
def merge_executable(self, file_id, file_status):
703
"""Perform a merge on the execute bit."""
704
if file_status == "deleted":
706
trans_id = self.tt.trans_id_file_id(file_id)
708
if self.tt.final_kind(trans_id) != "file":
712
winner = self.scalar_three_way(self.this_tree, self.base_tree,
713
self.other_tree, file_id,
715
if winner == "conflict":
716
# There must be a None in here, if we have a conflict, but we
717
# need executability since file status was not deleted.
718
if self.executable(self.other_tree, file_id) is None:
723
if file_status == "modified":
724
executability = self.this_tree.is_executable(file_id)
725
if executability is not None:
726
trans_id = self.tt.trans_id_file_id(file_id)
727
self.tt.set_executability(executability, trans_id)
729
assert winner == "other"
730
if file_id in self.other_tree:
731
executability = self.other_tree.is_executable(file_id)
732
elif file_id in self.this_tree:
733
executability = self.this_tree.is_executable(file_id)
734
elif file_id in self.base_tree:
735
executability = self.base_tree.is_executable(file_id)
736
if executability is not None:
737
trans_id = self.tt.trans_id_file_id(file_id)
738
self.tt.set_executability(executability, trans_id)
740
def cook_conflicts(self, fs_conflicts):
741
"""Convert all conflicts into a form that doesn't depend on trans_id"""
742
from conflicts import Conflict
744
self.cooked_conflicts.extend(cook_conflicts(fs_conflicts, self.tt))
745
fp = FinalPaths(self.tt)
746
for conflict in self._raw_conflicts:
747
conflict_type = conflict[0]
748
if conflict_type in ('name conflict', 'parent conflict'):
749
trans_id = conflict[1]
750
conflict_args = conflict[2:]
751
if trans_id not in name_conflicts:
752
name_conflicts[trans_id] = {}
753
unique_add(name_conflicts[trans_id], conflict_type,
755
if conflict_type == 'contents conflict':
756
for trans_id in conflict[1]:
757
file_id = self.tt.final_file_id(trans_id)
758
if file_id is not None:
760
path = fp.get_path(trans_id)
761
for suffix in ('.BASE', '.THIS', '.OTHER'):
762
if path.endswith(suffix):
763
path = path[:-len(suffix)]
765
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
766
self.cooked_conflicts.append(c)
767
if conflict_type == 'text conflict':
768
trans_id = conflict[1]
769
path = fp.get_path(trans_id)
770
file_id = self.tt.final_file_id(trans_id)
771
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
772
self.cooked_conflicts.append(c)
774
for trans_id, conflicts in name_conflicts.iteritems():
776
this_parent, other_parent = conflicts['parent conflict']
777
assert this_parent != other_parent
779
this_parent = other_parent = \
780
self.tt.final_file_id(self.tt.final_parent(trans_id))
782
this_name, other_name = conflicts['name conflict']
783
assert this_name != other_name
785
this_name = other_name = self.tt.final_name(trans_id)
786
other_path = fp.get_path(trans_id)
787
if this_parent is not None:
789
fp.get_path(self.tt.trans_id_file_id(this_parent))
790
this_path = pathjoin(this_parent_path, this_name)
792
this_path = "<deleted>"
793
file_id = self.tt.final_file_id(trans_id)
794
c = Conflict.factory('path conflict', path=this_path,
795
conflict_path=other_path, file_id=file_id)
796
self.cooked_conflicts.append(c)
797
self.cooked_conflicts.sort(key=Conflict.sort_key)
800
class WeaveMerger(Merge3Merger):
801
"""Three-way tree merger, text weave merger."""
802
supports_reprocess = True
803
supports_show_base = False
805
def __init__(self, working_tree, this_tree, base_tree, other_tree,
806
interesting_ids=None, pb=DummyProgress(), pp=None,
808
self.this_revision_tree = self._get_revision_tree(this_tree)
809
self.other_revision_tree = self._get_revision_tree(other_tree)
810
super(WeaveMerger, self).__init__(working_tree, this_tree,
811
base_tree, other_tree,
812
interesting_ids=interesting_ids,
813
pb=pb, pp=pp, reprocess=reprocess)
815
def _get_revision_tree(self, tree):
816
"""Return a revision tree related to this tree.
817
If the tree is a WorkingTree, the basis will be returned.
819
if getattr(tree, 'get_weave', False) is False:
820
# If we have a WorkingTree, try using the basis
821
return tree.branch.basis_tree()
825
def _check_file(self, file_id):
826
"""Check that the revision tree's version of the file matches."""
827
for tree, rt in ((self.this_tree, self.this_revision_tree),
828
(self.other_tree, self.other_revision_tree)):
831
if tree.get_file_sha1(file_id) != rt.get_file_sha1(file_id):
832
raise WorkingTreeNotRevision(self.this_tree)
834
def _merged_lines(self, file_id):
835
"""Generate the merged lines.
836
There is no distinction between lines that are meant to contain <<<<<<<
839
weave = self.this_revision_tree.get_weave(file_id)
840
this_revision_id = self.this_revision_tree.inventory[file_id].revision
841
other_revision_id = \
842
self.other_revision_tree.inventory[file_id].revision
843
wm = WeaveMerge(weave, this_revision_id, other_revision_id,
844
'<<<<<<< TREE\n', '>>>>>>> MERGE-SOURCE\n')
845
return wm.merge_lines(self.reprocess)
847
def text_merge(self, file_id, trans_id):
848
"""Perform a (weave) text merge for a given file and file-id.
849
If conflicts are encountered, .THIS and .OTHER files will be emitted,
850
and a conflict will be noted.
852
self._check_file(file_id)
853
lines, conflicts = self._merged_lines(file_id)
855
# Note we're checking whether the OUTPUT is binary in this case,
856
# because we don't want to get into weave merge guts.
857
check_text_lines(lines)
858
self.tt.create_file(lines, trans_id)
860
self._raw_conflicts.append(('text conflict', trans_id))
861
name = self.tt.final_name(trans_id)
862
parent_id = self.tt.final_parent(trans_id)
863
file_group = self._dump_conflicts(name, parent_id, file_id,
865
file_group.append(trans_id)
868
class Diff3Merger(Merge3Merger):
869
"""Three-way merger using external diff3 for text merging"""
871
def dump_file(self, temp_dir, name, tree, file_id):
872
out_path = pathjoin(temp_dir, name)
873
out_file = open(out_path, "wb")
875
in_file = tree.get_file(file_id)
882
def text_merge(self, file_id, trans_id):
883
"""Perform a diff3 merge using a specified file-id and trans-id.
884
If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
885
will be dumped, and a will be conflict noted.
888
temp_dir = mkdtemp(prefix="bzr-")
890
new_file = pathjoin(temp_dir, "new")
891
this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
892
base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
893
other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
894
status = bzrlib.patch.diff3(new_file, this, base, other)
895
if status not in (0, 1):
896
raise BzrError("Unhandled diff3 exit code")
897
f = open(new_file, 'rb')
899
self.tt.create_file(f, trans_id)
903
name = self.tt.final_name(trans_id)
904
parent_id = self.tt.final_parent(trans_id)
905
self._dump_conflicts(name, parent_id, file_id)
906
self._raw_conflicts.append(('text conflict', trans_id))
911
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
913
merge_type=Merge3Merger,
914
interesting_ids=None,
918
interesting_files=None,
921
"""Primary interface for merging.
923
typical use is probably
924
'merge_inner(branch, branch.get_revision_tree(other_revision),
925
branch.get_revision_tree(base_revision))'
927
if this_tree is None:
928
warnings.warn("bzrlib.merge.merge_inner requires a this_tree parameter as of "
929
"bzrlib version 0.8.",
932
this_tree = this_branch.bzrdir.open_workingtree()
933
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
935
merger.backup_files = backup_files
936
merger.merge_type = merge_type
937
merger.interesting_ids = interesting_ids
938
merger.ignore_zero = ignore_zero
939
if interesting_files:
940
assert not interesting_ids, ('Only supply interesting_ids'
941
' or interesting_files')
942
merger._set_interesting_files(interesting_files)
943
merger.show_base = show_base
944
merger.reprocess = reprocess
945
merger.other_rev_id = other_rev_id
946
merger.other_basis = other_rev_id
947
return merger.do_merge()
950
merge_types = { "merge3": (Merge3Merger, "Native diff3-style merge"),
951
"diff3": (Diff3Merger, "Merge using external diff3"),
952
'weave': (WeaveMerger, "Weave-based merge")
956
def merge_type_help():
957
templ = '%s%%7s: %%s' % (' '*12)
958
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
959
return '\n'.join(lines)