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
26
from bzrlib.branch import Branch
27
from bzrlib.conflicts import ConflictList, Conflict
28
from bzrlib.errors import (BzrCommandError,
38
WorkingTreeNotRevision,
41
from bzrlib.merge3 import Merge3
42
from bzrlib.osutils import rename, pathjoin
43
from progress import DummyProgress, ProgressPhase
44
from bzrlib.revision import (is_ancestor, NULL_REVISION, ensure_null)
45
from bzrlib.textfile import check_text_lines
46
from bzrlib.trace import mutter, warning, note
47
from bzrlib.transform import (TreeTransform, resolve_conflicts, cook_conflicts,
48
conflict_pass, FinalPaths, create_by_entry,
49
unique_add, ROOT_PARENT)
50
from bzrlib.versionedfile import WeaveMerge
53
# TODO: Report back as changes are merged in
55
def _get_tree(treespec, local_branch=None):
56
from bzrlib import workingtree
57
location, revno = treespec
59
tree = workingtree.WorkingTree.open_containing(location)[0]
60
return tree.branch, tree
61
branch = Branch.open_containing(location)[0]
63
revision_id = branch.last_revision()
65
revision_id = branch.get_rev_id(revno)
66
if revision_id is None:
67
revision_id = NULL_REVISION
68
return branch, _get_revid_tree(branch, revision_id, local_branch)
71
def _get_revid_tree(branch, revision_id, local_branch):
72
if revision_id is None:
73
base_tree = branch.bzrdir.open_workingtree()
75
if local_branch is not None:
76
if local_branch.base != branch.base:
77
local_branch.fetch(branch, revision_id)
78
base_tree = local_branch.repository.revision_tree(revision_id)
80
base_tree = branch.repository.revision_tree(revision_id)
84
def _get_revid_tree_from_tree(tree, revision_id, local_branch):
85
if revision_id is None:
87
if local_branch is not None:
88
if local_branch.base != tree.branch.base:
89
local_branch.fetch(tree.branch, revision_id)
90
return local_branch.repository.revision_tree(revision_id)
91
return tree.branch.repository.revision_tree(revision_id)
94
def transform_tree(from_tree, to_tree, interesting_ids=None):
95
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
96
interesting_ids=interesting_ids, this_tree=from_tree)
100
def __init__(self, this_branch, other_tree=None, base_tree=None,
101
this_tree=None, pb=DummyProgress(), change_reporter=None,
103
object.__init__(self)
104
assert this_tree is not None, "this_tree is required"
105
self.this_branch = this_branch
106
self.this_basis = this_branch.last_revision()
107
self.this_rev_id = None
108
self.this_tree = this_tree
109
self.this_revision_tree = None
110
self.this_basis_tree = None
111
self.other_tree = other_tree
112
self.other_branch = None
113
self.base_tree = base_tree
114
self.ignore_zero = False
115
self.backup_files = False
116
self.interesting_ids = None
117
self.interesting_files = None
118
self.show_base = False
119
self.reprocess = False
122
self.recurse = recurse
123
self.change_reporter = change_reporter
125
def revision_tree(self, revision_id):
126
return self.this_branch.repository.revision_tree(revision_id)
128
def ensure_revision_trees(self):
129
if self.this_revision_tree is None:
130
self.this_basis_tree = self.this_branch.repository.revision_tree(
132
if self.this_basis == self.this_rev_id:
133
self.this_revision_tree = self.this_basis_tree
135
if self.other_rev_id is None:
136
other_basis_tree = self.revision_tree(self.other_basis)
137
changes = other_basis_tree.changes_from(self.other_tree)
138
if changes.has_changed():
139
raise WorkingTreeNotRevision(self.this_tree)
140
other_rev_id = self.other_basis
141
self.other_tree = other_basis_tree
143
def file_revisions(self, file_id):
144
self.ensure_revision_trees()
145
def get_id(tree, file_id):
146
revision_id = tree.inventory[file_id].revision
147
assert revision_id is not None
149
if self.this_rev_id is None:
150
if self.this_basis_tree.get_file_sha1(file_id) != \
151
self.this_tree.get_file_sha1(file_id):
152
raise WorkingTreeNotRevision(self.this_tree)
154
trees = (self.this_basis_tree, self.other_tree)
155
return [get_id(tree, file_id) for tree in trees]
157
def check_basis(self, check_clean, require_commits=True):
158
if self.this_basis is None and require_commits is True:
159
raise BzrCommandError("This branch has no commits."
160
" (perhaps you would prefer 'bzr pull')")
163
if self.this_basis != self.this_rev_id:
164
raise BzrCommandError("Working tree has uncommitted changes.")
166
def compare_basis(self):
167
changes = self.this_tree.changes_from(self.this_tree.basis_tree())
168
if not changes.has_changed():
169
self.this_rev_id = self.this_basis
171
def set_interesting_files(self, file_list):
172
self.interesting_files = file_list
174
def _set_interesting_files(self, file_list):
175
"""Set the list of interesting ids from a list of files."""
176
if file_list is None:
177
self.interesting_ids = None
180
interesting_ids = set()
181
for path in file_list:
183
# TODO: jam 20070226 The trees are not locked at this time,
184
# wouldn't it make merge faster if it locks everything in the
185
# beginning? It locks at do_merge time, but this happens
187
for tree in (self.this_tree, self.base_tree, self.other_tree):
188
file_id = tree.path2id(path)
189
if file_id is not None:
190
interesting_ids.add(file_id)
193
raise NotVersionedError(path=path)
194
self.interesting_ids = interesting_ids
196
def set_pending(self):
197
if not self.base_is_ancestor:
199
if self.other_rev_id is None:
201
ancestry = set(self.this_branch.repository.get_ancestry(
202
self.this_basis, topo_sorted=False))
203
if self.other_rev_id in ancestry:
205
self.this_tree.add_parent_tree((self.other_rev_id, self.other_tree))
207
def set_other(self, other_revision):
208
"""Set the revision and tree to merge from.
210
This sets the other_tree, other_rev_id, other_basis attributes.
212
:param other_revision: The [path, revision] list to merge from.
214
self.other_branch, self.other_tree = _get_tree(other_revision,
216
if other_revision[1] == -1:
217
self.other_rev_id = self.other_branch.last_revision()
218
if self.other_rev_id is None:
219
raise NoCommits(self.other_branch)
220
self.other_basis = self.other_rev_id
221
elif other_revision[1] is not None:
222
self.other_rev_id = self.other_branch.get_rev_id(other_revision[1])
223
self.other_basis = self.other_rev_id
225
self.other_rev_id = None
226
self.other_basis = self.other_branch.last_revision()
227
if self.other_basis is None:
228
raise NoCommits(self.other_branch)
229
if self.other_branch.base != self.this_branch.base:
230
self.this_branch.fetch(self.other_branch,
231
last_revision=self.other_basis)
233
def set_other_revision(self, revision_id, other_branch):
234
"""Set 'other' based on a branch and revision id
236
:param revision_id: The revision to use for a tree
237
:param other_branch: The branch containing this tree
239
self.other_rev_id = revision_id
240
self.other_branch = other_branch
241
self.this_branch.fetch(other_branch, self.other_rev_id)
242
self.other_tree = self.revision_tree(revision_id)
243
self.other_basis = revision_id
246
self.set_base([None, None])
248
def set_base(self, base_revision):
249
"""Set the base revision to use for the merge.
251
:param base_revision: A 2-list containing a path and revision number.
253
mutter("doing merge() with no base_revision specified")
254
if base_revision == [None, None]:
256
pb = ui.ui_factory.nested_progress_bar()
258
this_repo = self.this_branch.repository
259
graph = this_repo.get_graph()
260
revisions = [ensure_null(self.this_basis),
261
ensure_null(self.other_basis)]
262
if NULL_REVISION in revisions:
263
self.base_rev_id = NULL_REVISION
265
self.base_rev_id = graph.find_unique_lca(*revisions)
266
if self.base_rev_id == NULL_REVISION:
267
raise UnrelatedBranches()
270
except NoCommonAncestor:
271
raise UnrelatedBranches()
272
self.base_tree = _get_revid_tree_from_tree(self.this_tree,
275
self.base_is_ancestor = True
277
base_branch, self.base_tree = _get_tree(base_revision)
278
if base_revision[1] == -1:
279
self.base_rev_id = base_branch.last_revision()
280
elif base_revision[1] is None:
281
self.base_rev_id = None
283
self.base_rev_id = base_branch.get_rev_id(base_revision[1])
284
if self.this_branch.base != base_branch.base:
285
self.this_branch.fetch(base_branch)
286
self.base_is_ancestor = is_ancestor(self.this_basis,
291
kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
292
'other_tree': self.other_tree,
293
'interesting_ids': self.interesting_ids,
294
'interesting_files': self.interesting_files,
296
if self.merge_type.requires_base:
297
kwargs['base_tree'] = self.base_tree
298
if self.merge_type.supports_reprocess:
299
kwargs['reprocess'] = self.reprocess
301
raise BzrError("Conflict reduction is not supported for merge"
302
" type %s." % self.merge_type)
303
if self.merge_type.supports_show_base:
304
kwargs['show_base'] = self.show_base
306
raise BzrError("Showing base is not supported for this"
307
" merge type. %s" % self.merge_type)
308
self.this_tree.lock_tree_write()
309
if self.base_tree is not None:
310
self.base_tree.lock_read()
311
if self.other_tree is not None:
312
self.other_tree.lock_read()
314
merge = self.merge_type(pb=self._pb,
315
change_reporter=self.change_reporter,
317
if self.recurse == 'down':
318
for path, file_id in self.this_tree.iter_references():
319
sub_tree = self.this_tree.get_nested_tree(file_id, path)
320
other_revision = self.other_tree.get_reference_revision(
322
if other_revision == sub_tree.last_revision():
324
sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
325
sub_merge.merge_type = self.merge_type
326
relpath = self.this_tree.relpath(path)
327
other_branch = self.other_branch.reference_parent(file_id, relpath)
328
sub_merge.set_other_revision(other_revision, other_branch)
329
base_revision = self.base_tree.get_reference_revision(file_id)
330
sub_merge.base_tree = \
331
sub_tree.branch.repository.revision_tree(base_revision)
335
if self.other_tree is not None:
336
self.other_tree.unlock()
337
if self.base_tree is not None:
338
self.base_tree.unlock()
339
self.this_tree.unlock()
340
if len(merge.cooked_conflicts) == 0:
341
if not self.ignore_zero:
342
note("All changes applied successfully.")
344
note("%d conflicts encountered." % len(merge.cooked_conflicts))
346
return len(merge.cooked_conflicts)
348
def regen_inventory(self, new_entries):
349
old_entries = self.this_tree.read_working_inventory()
353
for path, file_id in new_entries:
356
new_entries_map[file_id] = path
358
def id2path(file_id):
359
path = new_entries_map.get(file_id)
362
entry = old_entries[file_id]
363
if entry.parent_id is None:
365
return pathjoin(id2path(entry.parent_id), entry.name)
367
for file_id in old_entries:
368
entry = old_entries[file_id]
369
path = id2path(file_id)
370
if file_id in self.base_tree.inventory:
371
executable = getattr(self.base_tree.inventory[file_id], 'executable', False)
373
executable = getattr(entry, 'executable', False)
374
new_inventory[file_id] = (path, file_id, entry.parent_id,
375
entry.kind, executable)
377
by_path[path] = file_id
382
for path, file_id in new_entries:
384
del new_inventory[file_id]
387
new_path_list.append((path, file_id))
388
if file_id not in old_entries:
390
# Ensure no file is added before its parent
392
for path, file_id in new_path_list:
396
parent = by_path[os.path.dirname(path)]
397
abspath = pathjoin(self.this_tree.basedir, path)
398
kind = osutils.file_kind(abspath)
399
if file_id in self.base_tree.inventory:
400
executable = getattr(self.base_tree.inventory[file_id], 'executable', False)
403
new_inventory[file_id] = (path, file_id, parent, kind, executable)
404
by_path[path] = file_id
406
# Get a list in insertion order
407
new_inventory_list = new_inventory.values()
408
mutter ("""Inventory regeneration:
409
old length: %i insertions: %i deletions: %i new_length: %i"""\
410
% (len(old_entries), insertions, deletions,
411
len(new_inventory_list)))
412
assert len(new_inventory_list) == len(old_entries) + insertions\
414
new_inventory_list.sort()
415
return new_inventory_list
418
class Merge3Merger(object):
419
"""Three-way merger that uses the merge3 text merger"""
421
supports_reprocess = True
422
supports_show_base = True
423
history_based = False
424
winner_idx = {"this": 2, "other": 1, "conflict": 1}
426
def __init__(self, working_tree, this_tree, base_tree, other_tree,
427
interesting_ids=None, reprocess=False, show_base=False,
428
pb=DummyProgress(), pp=None, change_reporter=None,
429
interesting_files=None):
430
"""Initialize the merger object and perform the merge."""
431
object.__init__(self)
432
if interesting_files is not None:
433
assert interesting_ids is None
434
self.interesting_ids = interesting_ids
435
self.interesting_files = interesting_files
436
self.this_tree = working_tree
437
self.this_tree.lock_tree_write()
438
self.base_tree = base_tree
439
self.base_tree.lock_read()
440
self.other_tree = other_tree
441
self.other_tree.lock_read()
442
self._raw_conflicts = []
443
self.cooked_conflicts = []
444
self.reprocess = reprocess
445
self.show_base = show_base
448
self.change_reporter = change_reporter
450
self.pp = ProgressPhase("Merge phase", 3, self.pb)
452
self.tt = TreeTransform(working_tree, self.pb)
455
entries = self._entries3()
456
child_pb = ui.ui_factory.nested_progress_bar()
458
for num, (file_id, changed, parents3, names3,
459
executable3) in enumerate(entries):
460
child_pb.update('Preparing file merge', num, len(entries))
461
self._merge_names(file_id, parents3, names3)
463
file_status = self.merge_contents(file_id)
465
file_status = 'unmodified'
466
self._merge_executable(file_id,
467
executable3, file_status)
472
child_pb = ui.ui_factory.nested_progress_bar()
474
fs_conflicts = resolve_conflicts(self.tt, child_pb,
475
lambda t, c: conflict_pass(t, c, self.other_tree))
478
if change_reporter is not None:
479
from bzrlib import delta
480
delta.report_changes(self.tt._iter_changes(), change_reporter)
481
self.cook_conflicts(fs_conflicts)
482
for conflict in self.cooked_conflicts:
485
results = self.tt.apply()
486
self.write_modified(results)
488
working_tree.add_conflicts(self.cooked_conflicts)
489
except UnsupportedOperation:
493
self.other_tree.unlock()
494
self.base_tree.unlock()
495
self.this_tree.unlock()
499
"""Gather data about files modified between three trees.
501
Return a list of tuples of file_id, changed, parents3, names3,
502
executable3. changed is a boolean indicating whether the file contents
503
or kind were changed. parents3 is a tuple of parent ids for base,
504
other and this. names3 is a tuple of names for base, other and this.
505
executable3 is a tuple of execute-bit values for base, other and this.
508
iterator = self.other_tree._iter_changes(self.base_tree,
509
include_unchanged=True, specific_files=self.interesting_files,
510
extra_trees=[self.this_tree])
511
for (file_id, paths, changed, versioned, parents, names, kind,
512
executable) in iterator:
513
if (self.interesting_ids is not None and
514
file_id not in self.interesting_ids):
516
if file_id in self.this_tree.inventory:
517
entry = self.this_tree.inventory[file_id]
518
this_name = entry.name
519
this_parent = entry.parent_id
520
this_executable = entry.executable
524
this_executable = None
525
parents3 = parents + (this_parent,)
526
names3 = names + (this_name,)
527
executable3 = executable + (this_executable,)
528
result.append((file_id, changed, parents3, names3, executable3))
533
self.tt.final_kind(self.tt.root)
535
self.tt.cancel_deletion(self.tt.root)
536
if self.tt.final_file_id(self.tt.root) is None:
537
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
539
if self.other_tree.inventory.root is None:
541
other_root_file_id = self.other_tree.inventory.root.file_id
542
other_root = self.tt.trans_id_file_id(other_root_file_id)
543
if other_root == self.tt.root:
546
self.tt.final_kind(other_root)
549
self.reparent_children(self.other_tree.inventory.root, self.tt.root)
550
self.tt.cancel_creation(other_root)
551
self.tt.cancel_versioning(other_root)
553
def reparent_children(self, ie, target):
554
for thing, child in ie.children.iteritems():
555
trans_id = self.tt.trans_id_file_id(child.file_id)
556
self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
558
def write_modified(self, results):
560
for path in results.modified_paths:
561
file_id = self.this_tree.path2id(self.this_tree.relpath(path))
564
hash = self.this_tree.get_file_sha1(file_id)
567
modified_hashes[file_id] = hash
568
self.this_tree.set_merge_modified(modified_hashes)
571
def parent(entry, file_id):
572
"""Determine the parent for a file_id (used as a key method)"""
575
return entry.parent_id
578
def name(entry, file_id):
579
"""Determine the name for a file_id (used as a key method)"""
585
def contents_sha1(tree, file_id):
586
"""Determine the sha1 of the file contents (used as a key method)."""
587
if file_id not in tree:
589
return tree.get_file_sha1(file_id)
592
def executable(tree, file_id):
593
"""Determine the executability of a file-id (used as a key method)."""
594
if file_id not in tree:
596
if tree.kind(file_id) != "file":
598
return tree.is_executable(file_id)
601
def kind(tree, file_id):
602
"""Determine the kind of a file-id (used as a key method)."""
603
if file_id not in tree:
605
return tree.kind(file_id)
608
def _three_way(base, other, this):
609
#if base == other, either they all agree, or only THIS has changed.
612
if this not in (base, other):
614
# "Ambiguous clean merge"
622
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
623
"""Do a three-way test on a scalar.
624
Return "this", "other" or "conflict", depending whether a value wins.
626
key_base = key(base_tree, file_id)
627
key_other = key(other_tree, file_id)
628
#if base == other, either they all agree, or only THIS has changed.
629
if key_base == key_other:
631
key_this = key(this_tree, file_id)
632
if key_this not in (key_base, key_other):
634
# "Ambiguous clean merge"
635
elif key_this == key_other:
638
assert key_this == key_base
641
def merge_names(self, file_id):
643
if file_id in tree.inventory:
644
return tree.inventory[file_id]
647
this_entry = get_entry(self.this_tree)
648
other_entry = get_entry(self.other_tree)
649
base_entry = get_entry(self.base_tree)
650
entries = (base_entry, other_entry, this_entry)
653
for entry in entries:
658
names.append(entry.name)
659
parents.append(entry.parent_id)
660
return self._merge_names(file_id, parents, names)
662
def _merge_names(self, file_id, parents, names):
663
"""Perform a merge on file_id names and parents"""
664
base_name, other_name, this_name = names
665
base_parent, other_parent, this_parent = parents
667
name_winner = self._three_way(*names)
669
parent_id_winner = self._three_way(*parents)
670
if this_name is None:
671
if name_winner == "this":
672
name_winner = "other"
673
if parent_id_winner == "this":
674
parent_id_winner = "other"
675
if name_winner == "this" and parent_id_winner == "this":
677
if name_winner == "conflict":
678
trans_id = self.tt.trans_id_file_id(file_id)
679
self._raw_conflicts.append(('name conflict', trans_id,
680
this_name, other_name))
681
if parent_id_winner == "conflict":
682
trans_id = self.tt.trans_id_file_id(file_id)
683
self._raw_conflicts.append(('parent conflict', trans_id,
684
this_parent, other_parent))
685
if other_name is None:
686
# it doesn't matter whether the result was 'other' or
687
# 'conflict'-- if there's no 'other', we leave it alone.
689
# if we get here, name_winner and parent_winner are set to safe values.
690
trans_id = self.tt.trans_id_file_id(file_id)
691
parent_id = parents[self.winner_idx[parent_id_winner]]
692
if parent_id is not None:
693
parent_trans_id = self.tt.trans_id_file_id(parent_id)
694
self.tt.adjust_path(names[self.winner_idx[name_winner]],
695
parent_trans_id, trans_id)
697
def merge_contents(self, file_id):
698
"""Performa a merge on file_id contents."""
699
def contents_pair(tree):
700
if file_id not in tree:
702
kind = tree.kind(file_id)
704
contents = tree.get_file_sha1(file_id)
705
elif kind == "symlink":
706
contents = tree.get_symlink_target(file_id)
709
return kind, contents
711
def contents_conflict():
712
trans_id = self.tt.trans_id_file_id(file_id)
713
name = self.tt.final_name(trans_id)
714
parent_id = self.tt.final_parent(trans_id)
715
if file_id in self.this_tree.inventory:
716
self.tt.unversion_file(trans_id)
717
if file_id in self.this_tree:
718
self.tt.delete_contents(trans_id)
719
file_group = self._dump_conflicts(name, parent_id, file_id,
721
self._raw_conflicts.append(('contents conflict', file_group))
723
# See SPOT run. run, SPOT, run.
724
# So we're not QUITE repeating ourselves; we do tricky things with
726
base_pair = contents_pair(self.base_tree)
727
other_pair = contents_pair(self.other_tree)
728
if base_pair == other_pair:
729
# OTHER introduced no changes
731
this_pair = contents_pair(self.this_tree)
732
if this_pair == other_pair:
733
# THIS and OTHER introduced the same changes
736
trans_id = self.tt.trans_id_file_id(file_id)
737
if this_pair == base_pair:
738
# only OTHER introduced changes
739
if file_id in self.this_tree:
740
# Remove any existing contents
741
self.tt.delete_contents(trans_id)
742
if file_id in self.other_tree:
743
# OTHER changed the file
744
create_by_entry(self.tt,
745
self.other_tree.inventory[file_id],
746
self.other_tree, trans_id)
747
if file_id not in self.this_tree.inventory:
748
self.tt.version_file(file_id, trans_id)
750
elif file_id in self.this_tree.inventory:
751
# OTHER deleted the file
752
self.tt.unversion_file(trans_id)
754
#BOTH THIS and OTHER introduced changes; scalar conflict
755
elif this_pair[0] == "file" and other_pair[0] == "file":
756
# THIS and OTHER are both files, so text merge. Either
757
# BASE is a file, or both converted to files, so at least we
758
# have agreement that output should be a file.
760
self.text_merge(file_id, trans_id)
762
return contents_conflict()
763
if file_id not in self.this_tree.inventory:
764
self.tt.version_file(file_id, trans_id)
766
self.tt.tree_kind(trans_id)
767
self.tt.delete_contents(trans_id)
772
# Scalar conflict, can't text merge. Dump conflicts
773
return contents_conflict()
775
def get_lines(self, tree, file_id):
776
"""Return the lines in a file, or an empty list."""
778
return tree.get_file(file_id).readlines()
782
def text_merge(self, file_id, trans_id):
783
"""Perform a three-way text merge on a file_id"""
784
# it's possible that we got here with base as a different type.
785
# if so, we just want two-way text conflicts.
786
if file_id in self.base_tree and \
787
self.base_tree.kind(file_id) == "file":
788
base_lines = self.get_lines(self.base_tree, file_id)
791
other_lines = self.get_lines(self.other_tree, file_id)
792
this_lines = self.get_lines(self.this_tree, file_id)
793
m3 = Merge3(base_lines, this_lines, other_lines)
794
start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
795
if self.show_base is True:
796
base_marker = '|' * 7
800
def iter_merge3(retval):
801
retval["text_conflicts"] = False
802
for line in m3.merge_lines(name_a = "TREE",
803
name_b = "MERGE-SOURCE",
804
name_base = "BASE-REVISION",
805
start_marker=start_marker,
806
base_marker=base_marker,
807
reprocess=self.reprocess):
808
if line.startswith(start_marker):
809
retval["text_conflicts"] = True
810
yield line.replace(start_marker, '<' * 7)
814
merge3_iterator = iter_merge3(retval)
815
self.tt.create_file(merge3_iterator, trans_id)
816
if retval["text_conflicts"] is True:
817
self._raw_conflicts.append(('text conflict', trans_id))
818
name = self.tt.final_name(trans_id)
819
parent_id = self.tt.final_parent(trans_id)
820
file_group = self._dump_conflicts(name, parent_id, file_id,
821
this_lines, base_lines,
823
file_group.append(trans_id)
825
def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
826
base_lines=None, other_lines=None, set_version=False,
828
"""Emit conflict files.
829
If this_lines, base_lines, or other_lines are omitted, they will be
830
determined automatically. If set_version is true, the .OTHER, .THIS
831
or .BASE (in that order) will be created as versioned files.
833
data = [('OTHER', self.other_tree, other_lines),
834
('THIS', self.this_tree, this_lines)]
836
data.append(('BASE', self.base_tree, base_lines))
839
for suffix, tree, lines in data:
841
trans_id = self._conflict_file(name, parent_id, tree, file_id,
843
file_group.append(trans_id)
844
if set_version and not versioned:
845
self.tt.version_file(file_id, trans_id)
849
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
851
"""Emit a single conflict file."""
852
name = name + '.' + suffix
853
trans_id = self.tt.create_path(name, parent_id)
854
entry = tree.inventory[file_id]
855
create_by_entry(self.tt, entry, tree, trans_id, lines)
858
def merge_executable(self, file_id, file_status):
859
"""Perform a merge on the execute bit."""
860
executable = [self.executable(t, file_id) for t in (self.base_tree,
861
self.other_tree, self.this_tree)]
862
self._merge_executable(file_id, executable, file_status)
864
def _merge_executable(self, file_id, executable, file_status):
865
"""Perform a merge on the execute bit."""
866
base_executable, other_executable, this_executable = executable
867
if file_status == "deleted":
869
trans_id = self.tt.trans_id_file_id(file_id)
871
if self.tt.final_kind(trans_id) != "file":
875
winner = self._three_way(*executable)
876
if winner == "conflict":
877
# There must be a None in here, if we have a conflict, but we
878
# need executability since file status was not deleted.
879
if self.executable(self.other_tree, file_id) is None:
884
if file_status == "modified":
885
executability = this_executable
886
if executability is not None:
887
trans_id = self.tt.trans_id_file_id(file_id)
888
self.tt.set_executability(executability, trans_id)
890
assert winner == "other"
891
if file_id in self.other_tree:
892
executability = other_executable
893
elif file_id in self.this_tree:
894
executability = this_executable
895
elif file_id in self.base_tree:
896
executability = base_executable
897
if executability is not None:
898
trans_id = self.tt.trans_id_file_id(file_id)
899
self.tt.set_executability(executability, trans_id)
901
def cook_conflicts(self, fs_conflicts):
902
"""Convert all conflicts into a form that doesn't depend on trans_id"""
903
from conflicts import Conflict
905
self.cooked_conflicts.extend(cook_conflicts(fs_conflicts, self.tt))
906
fp = FinalPaths(self.tt)
907
for conflict in self._raw_conflicts:
908
conflict_type = conflict[0]
909
if conflict_type in ('name conflict', 'parent conflict'):
910
trans_id = conflict[1]
911
conflict_args = conflict[2:]
912
if trans_id not in name_conflicts:
913
name_conflicts[trans_id] = {}
914
unique_add(name_conflicts[trans_id], conflict_type,
916
if conflict_type == 'contents conflict':
917
for trans_id in conflict[1]:
918
file_id = self.tt.final_file_id(trans_id)
919
if file_id is not None:
921
path = fp.get_path(trans_id)
922
for suffix in ('.BASE', '.THIS', '.OTHER'):
923
if path.endswith(suffix):
924
path = path[:-len(suffix)]
926
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
927
self.cooked_conflicts.append(c)
928
if conflict_type == 'text conflict':
929
trans_id = conflict[1]
930
path = fp.get_path(trans_id)
931
file_id = self.tt.final_file_id(trans_id)
932
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
933
self.cooked_conflicts.append(c)
935
for trans_id, conflicts in name_conflicts.iteritems():
937
this_parent, other_parent = conflicts['parent conflict']
938
assert this_parent != other_parent
940
this_parent = other_parent = \
941
self.tt.final_file_id(self.tt.final_parent(trans_id))
943
this_name, other_name = conflicts['name conflict']
944
assert this_name != other_name
946
this_name = other_name = self.tt.final_name(trans_id)
947
other_path = fp.get_path(trans_id)
948
if this_parent is not None and this_name is not None:
950
fp.get_path(self.tt.trans_id_file_id(this_parent))
951
this_path = pathjoin(this_parent_path, this_name)
953
this_path = "<deleted>"
954
file_id = self.tt.final_file_id(trans_id)
955
c = Conflict.factory('path conflict', path=this_path,
956
conflict_path=other_path, file_id=file_id)
957
self.cooked_conflicts.append(c)
958
self.cooked_conflicts.sort(key=Conflict.sort_key)
961
class WeaveMerger(Merge3Merger):
962
"""Three-way tree merger, text weave merger."""
963
supports_reprocess = True
964
supports_show_base = False
966
def __init__(self, working_tree, this_tree, base_tree, other_tree,
967
interesting_ids=None, pb=DummyProgress(), pp=None,
968
reprocess=False, change_reporter=None,
969
interesting_files=None):
970
self.this_revision_tree = self._get_revision_tree(this_tree)
971
self.other_revision_tree = self._get_revision_tree(other_tree)
972
super(WeaveMerger, self).__init__(working_tree, this_tree,
973
base_tree, other_tree,
974
interesting_ids=interesting_ids,
975
pb=pb, pp=pp, reprocess=reprocess,
976
change_reporter=change_reporter)
978
def _get_revision_tree(self, tree):
979
"""Return a revision tree related to this tree.
980
If the tree is a WorkingTree, the basis will be returned.
982
if getattr(tree, 'get_weave', False) is False:
983
# If we have a WorkingTree, try using the basis
984
return tree.branch.basis_tree()
988
def _check_file(self, file_id):
989
"""Check that the revision tree's version of the file matches."""
990
for tree, rt in ((self.this_tree, self.this_revision_tree),
991
(self.other_tree, self.other_revision_tree)):
994
if tree.get_file_sha1(file_id) != rt.get_file_sha1(file_id):
995
raise WorkingTreeNotRevision(self.this_tree)
997
def _merged_lines(self, file_id):
998
"""Generate the merged lines.
999
There is no distinction between lines that are meant to contain <<<<<<<
1002
weave = self.this_revision_tree.get_weave(file_id)
1003
this_revision_id = self.this_revision_tree.inventory[file_id].revision
1004
other_revision_id = \
1005
self.other_revision_tree.inventory[file_id].revision
1006
wm = WeaveMerge(weave, this_revision_id, other_revision_id,
1007
'<<<<<<< TREE\n', '>>>>>>> MERGE-SOURCE\n')
1008
return wm.merge_lines(self.reprocess)
1010
def text_merge(self, file_id, trans_id):
1011
"""Perform a (weave) text merge for a given file and file-id.
1012
If conflicts are encountered, .THIS and .OTHER files will be emitted,
1013
and a conflict will be noted.
1015
self._check_file(file_id)
1016
lines, conflicts = self._merged_lines(file_id)
1018
# Note we're checking whether the OUTPUT is binary in this case,
1019
# because we don't want to get into weave merge guts.
1020
check_text_lines(lines)
1021
self.tt.create_file(lines, trans_id)
1023
self._raw_conflicts.append(('text conflict', trans_id))
1024
name = self.tt.final_name(trans_id)
1025
parent_id = self.tt.final_parent(trans_id)
1026
file_group = self._dump_conflicts(name, parent_id, file_id,
1028
file_group.append(trans_id)
1031
class Diff3Merger(Merge3Merger):
1032
"""Three-way merger using external diff3 for text merging"""
1034
def dump_file(self, temp_dir, name, tree, file_id):
1035
out_path = pathjoin(temp_dir, name)
1036
out_file = open(out_path, "wb")
1038
in_file = tree.get_file(file_id)
1039
for line in in_file:
1040
out_file.write(line)
1045
def text_merge(self, file_id, trans_id):
1046
"""Perform a diff3 merge using a specified file-id and trans-id.
1047
If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
1048
will be dumped, and a will be conflict noted.
1051
temp_dir = osutils.mkdtemp(prefix="bzr-")
1053
new_file = pathjoin(temp_dir, "new")
1054
this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
1055
base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
1056
other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
1057
status = bzrlib.patch.diff3(new_file, this, base, other)
1058
if status not in (0, 1):
1059
raise BzrError("Unhandled diff3 exit code")
1060
f = open(new_file, 'rb')
1062
self.tt.create_file(f, trans_id)
1066
name = self.tt.final_name(trans_id)
1067
parent_id = self.tt.final_parent(trans_id)
1068
self._dump_conflicts(name, parent_id, file_id)
1069
self._raw_conflicts.append(('text conflict', trans_id))
1071
osutils.rmtree(temp_dir)
1074
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1076
merge_type=Merge3Merger,
1077
interesting_ids=None,
1081
interesting_files=None,
1084
change_reporter=None):
1085
"""Primary interface for merging.
1087
typical use is probably
1088
'merge_inner(branch, branch.get_revision_tree(other_revision),
1089
branch.get_revision_tree(base_revision))'
1091
if this_tree is None:
1092
raise BzrError("bzrlib.merge.merge_inner requires a this_tree "
1093
"parameter as of bzrlib version 0.8.")
1094
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1095
pb=pb, change_reporter=change_reporter)
1096
merger.backup_files = backup_files
1097
merger.merge_type = merge_type
1098
merger.interesting_ids = interesting_ids
1099
merger.ignore_zero = ignore_zero
1100
if interesting_files:
1101
assert not interesting_ids, ('Only supply interesting_ids'
1102
' or interesting_files')
1103
merger.interesting_files = interesting_files
1104
merger.show_base = show_base
1105
merger.reprocess = reprocess
1106
merger.other_rev_id = other_rev_id
1107
merger.other_basis = other_rev_id
1108
return merger.do_merge()
1110
def get_merge_type_registry():
1111
"""Merge type registry is in bzrlib.option to avoid circular imports.
1113
This method provides a sanctioned way to retrieve it.
1115
from bzrlib import option
1116
return option._merge_type_registry