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, possible_transports=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, possible_transports)[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, possible_transports=None):
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,
217
if other_revision[1] == -1:
218
self.other_rev_id = self.other_branch.last_revision()
219
if self.other_rev_id is None:
220
raise NoCommits(self.other_branch)
221
self.other_basis = self.other_rev_id
222
elif other_revision[1] is not None:
223
self.other_rev_id = self.other_branch.get_rev_id(other_revision[1])
224
self.other_basis = self.other_rev_id
226
self.other_rev_id = None
227
self.other_basis = self.other_branch.last_revision()
228
if self.other_basis is None:
229
raise NoCommits(self.other_branch)
230
if self.other_branch.base != self.this_branch.base:
231
self.this_branch.fetch(self.other_branch,
232
last_revision=self.other_basis)
234
def set_other_revision(self, revision_id, other_branch):
235
"""Set 'other' based on a branch and revision id
237
:param revision_id: The revision to use for a tree
238
:param other_branch: The branch containing this tree
240
self.other_rev_id = revision_id
241
self.other_branch = other_branch
242
self.this_branch.fetch(other_branch, self.other_rev_id)
243
self.other_tree = self.revision_tree(revision_id)
244
self.other_basis = revision_id
247
self.set_base([None, None])
249
def set_base(self, base_revision):
250
"""Set the base revision to use for the merge.
252
:param base_revision: A 2-list containing a path and revision number.
254
mutter("doing merge() with no base_revision specified")
255
if base_revision == [None, None]:
257
pb = ui.ui_factory.nested_progress_bar()
259
this_repo = self.this_branch.repository
260
graph = this_repo.get_graph()
261
revisions = [ensure_null(self.this_basis),
262
ensure_null(self.other_basis)]
263
if NULL_REVISION in revisions:
264
self.base_rev_id = NULL_REVISION
266
self.base_rev_id = graph.find_unique_lca(*revisions)
267
if self.base_rev_id == NULL_REVISION:
268
raise UnrelatedBranches()
271
except NoCommonAncestor:
272
raise UnrelatedBranches()
273
self.base_tree = _get_revid_tree_from_tree(self.this_tree,
276
self.base_is_ancestor = True
278
base_branch, self.base_tree = _get_tree(base_revision)
279
if base_revision[1] == -1:
280
self.base_rev_id = base_branch.last_revision()
281
elif base_revision[1] is None:
282
self.base_rev_id = None
284
self.base_rev_id = base_branch.get_rev_id(base_revision[1])
285
if self.this_branch.base != base_branch.base:
286
self.this_branch.fetch(base_branch)
287
self.base_is_ancestor = is_ancestor(self.this_basis,
292
kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
293
'other_tree': self.other_tree,
294
'interesting_ids': self.interesting_ids,
295
'interesting_files': self.interesting_files,
297
if self.merge_type.requires_base:
298
kwargs['base_tree'] = self.base_tree
299
if self.merge_type.supports_reprocess:
300
kwargs['reprocess'] = self.reprocess
302
raise BzrError("Conflict reduction is not supported for merge"
303
" type %s." % self.merge_type)
304
if self.merge_type.supports_show_base:
305
kwargs['show_base'] = self.show_base
307
raise BzrError("Showing base is not supported for this"
308
" merge type. %s" % self.merge_type)
309
self.this_tree.lock_tree_write()
310
if self.base_tree is not None:
311
self.base_tree.lock_read()
312
if self.other_tree is not None:
313
self.other_tree.lock_read()
315
merge = self.merge_type(pb=self._pb,
316
change_reporter=self.change_reporter,
318
if self.recurse == 'down':
319
for path, file_id in self.this_tree.iter_references():
320
sub_tree = self.this_tree.get_nested_tree(file_id, path)
321
other_revision = self.other_tree.get_reference_revision(
323
if other_revision == sub_tree.last_revision():
325
sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
326
sub_merge.merge_type = self.merge_type
327
relpath = self.this_tree.relpath(path)
328
other_branch = self.other_branch.reference_parent(file_id, relpath)
329
sub_merge.set_other_revision(other_revision, other_branch)
330
base_revision = self.base_tree.get_reference_revision(file_id)
331
sub_merge.base_tree = \
332
sub_tree.branch.repository.revision_tree(base_revision)
336
if self.other_tree is not None:
337
self.other_tree.unlock()
338
if self.base_tree is not None:
339
self.base_tree.unlock()
340
self.this_tree.unlock()
341
if len(merge.cooked_conflicts) == 0:
342
if not self.ignore_zero:
343
note("All changes applied successfully.")
345
note("%d conflicts encountered." % len(merge.cooked_conflicts))
347
return len(merge.cooked_conflicts)
349
def regen_inventory(self, new_entries):
350
old_entries = self.this_tree.read_working_inventory()
354
for path, file_id in new_entries:
357
new_entries_map[file_id] = path
359
def id2path(file_id):
360
path = new_entries_map.get(file_id)
363
entry = old_entries[file_id]
364
if entry.parent_id is None:
366
return pathjoin(id2path(entry.parent_id), entry.name)
368
for file_id in old_entries:
369
entry = old_entries[file_id]
370
path = id2path(file_id)
371
if file_id in self.base_tree.inventory:
372
executable = getattr(self.base_tree.inventory[file_id], 'executable', False)
374
executable = getattr(entry, 'executable', False)
375
new_inventory[file_id] = (path, file_id, entry.parent_id,
376
entry.kind, executable)
378
by_path[path] = file_id
383
for path, file_id in new_entries:
385
del new_inventory[file_id]
388
new_path_list.append((path, file_id))
389
if file_id not in old_entries:
391
# Ensure no file is added before its parent
393
for path, file_id in new_path_list:
397
parent = by_path[os.path.dirname(path)]
398
abspath = pathjoin(self.this_tree.basedir, path)
399
kind = osutils.file_kind(abspath)
400
if file_id in self.base_tree.inventory:
401
executable = getattr(self.base_tree.inventory[file_id], 'executable', False)
404
new_inventory[file_id] = (path, file_id, parent, kind, executable)
405
by_path[path] = file_id
407
# Get a list in insertion order
408
new_inventory_list = new_inventory.values()
409
mutter ("""Inventory regeneration:
410
old length: %i insertions: %i deletions: %i new_length: %i"""\
411
% (len(old_entries), insertions, deletions,
412
len(new_inventory_list)))
413
assert len(new_inventory_list) == len(old_entries) + insertions\
415
new_inventory_list.sort()
416
return new_inventory_list
419
class Merge3Merger(object):
420
"""Three-way merger that uses the merge3 text merger"""
422
supports_reprocess = True
423
supports_show_base = True
424
history_based = False
425
winner_idx = {"this": 2, "other": 1, "conflict": 1}
427
def __init__(self, working_tree, this_tree, base_tree, other_tree,
428
interesting_ids=None, reprocess=False, show_base=False,
429
pb=DummyProgress(), pp=None, change_reporter=None,
430
interesting_files=None):
431
"""Initialize the merger object and perform the merge.
433
:param working_tree: The working tree to apply the merge to
434
:param this_tree: The local tree in the merge operation
435
:param base_tree: The common tree in the merge operation
436
:param other_tree: The other other tree to merge changes from
437
:param interesting_ids: The file_ids of files that should be
438
participate in the merge. May not be combined with
440
:param: reprocess If True, perform conflict-reduction processing.
441
:param show_base: If True, show the base revision in text conflicts.
442
(incompatible with reprocess)
443
:param pb: A Progress bar
444
:param pp: A ProgressPhase object
445
:param change_reporter: An object that should report changes made
446
:param interesting_files: The tree-relative paths of files that should
447
participate in the merge. If these paths refer to directories,
448
the contents of those directories will also be included. May not
449
be combined with interesting_ids. If neither interesting_files nor
450
interesting_ids is specified, all files may participate in the
453
object.__init__(self)
454
if interesting_files is not None:
455
assert interesting_ids is None
456
self.interesting_ids = interesting_ids
457
self.interesting_files = interesting_files
458
self.this_tree = working_tree
459
self.this_tree.lock_tree_write()
460
self.base_tree = base_tree
461
self.base_tree.lock_read()
462
self.other_tree = other_tree
463
self.other_tree.lock_read()
464
self._raw_conflicts = []
465
self.cooked_conflicts = []
466
self.reprocess = reprocess
467
self.show_base = show_base
470
self.change_reporter = change_reporter
472
self.pp = ProgressPhase("Merge phase", 3, self.pb)
474
self.tt = TreeTransform(working_tree, self.pb)
477
entries = self._entries3()
478
child_pb = ui.ui_factory.nested_progress_bar()
480
for num, (file_id, changed, parents3, names3,
481
executable3) in enumerate(entries):
482
child_pb.update('Preparing file merge', num, len(entries))
483
self._merge_names(file_id, parents3, names3)
485
file_status = self.merge_contents(file_id)
487
file_status = 'unmodified'
488
self._merge_executable(file_id,
489
executable3, file_status)
494
child_pb = ui.ui_factory.nested_progress_bar()
496
fs_conflicts = resolve_conflicts(self.tt, child_pb,
497
lambda t, c: conflict_pass(t, c, self.other_tree))
500
if change_reporter is not None:
501
from bzrlib import delta
502
delta.report_changes(self.tt._iter_changes(), change_reporter)
503
self.cook_conflicts(fs_conflicts)
504
for conflict in self.cooked_conflicts:
507
results = self.tt.apply()
508
self.write_modified(results)
510
working_tree.add_conflicts(self.cooked_conflicts)
511
except UnsupportedOperation:
515
self.other_tree.unlock()
516
self.base_tree.unlock()
517
self.this_tree.unlock()
521
"""Gather data about files modified between three trees.
523
Return a list of tuples of file_id, changed, parents3, names3,
524
executable3. changed is a boolean indicating whether the file contents
525
or kind were changed. parents3 is a tuple of parent ids for base,
526
other and this. names3 is a tuple of names for base, other and this.
527
executable3 is a tuple of execute-bit values for base, other and this.
530
iterator = self.other_tree._iter_changes(self.base_tree,
531
include_unchanged=True, specific_files=self.interesting_files,
532
extra_trees=[self.this_tree])
533
for (file_id, paths, changed, versioned, parents, names, kind,
534
executable) in iterator:
535
if (self.interesting_ids is not None and
536
file_id not in self.interesting_ids):
538
if file_id in self.this_tree.inventory:
539
entry = self.this_tree.inventory[file_id]
540
this_name = entry.name
541
this_parent = entry.parent_id
542
this_executable = entry.executable
546
this_executable = None
547
parents3 = parents + (this_parent,)
548
names3 = names + (this_name,)
549
executable3 = executable + (this_executable,)
550
result.append((file_id, changed, parents3, names3, executable3))
555
self.tt.final_kind(self.tt.root)
557
self.tt.cancel_deletion(self.tt.root)
558
if self.tt.final_file_id(self.tt.root) is None:
559
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
561
if self.other_tree.inventory.root is None:
563
other_root_file_id = self.other_tree.inventory.root.file_id
564
other_root = self.tt.trans_id_file_id(other_root_file_id)
565
if other_root == self.tt.root:
568
self.tt.final_kind(other_root)
571
self.reparent_children(self.other_tree.inventory.root, self.tt.root)
572
self.tt.cancel_creation(other_root)
573
self.tt.cancel_versioning(other_root)
575
def reparent_children(self, ie, target):
576
for thing, child in ie.children.iteritems():
577
trans_id = self.tt.trans_id_file_id(child.file_id)
578
self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
580
def write_modified(self, results):
582
for path in results.modified_paths:
583
file_id = self.this_tree.path2id(self.this_tree.relpath(path))
586
hash = self.this_tree.get_file_sha1(file_id)
589
modified_hashes[file_id] = hash
590
self.this_tree.set_merge_modified(modified_hashes)
593
def parent(entry, file_id):
594
"""Determine the parent for a file_id (used as a key method)"""
597
return entry.parent_id
600
def name(entry, file_id):
601
"""Determine the name for a file_id (used as a key method)"""
607
def contents_sha1(tree, file_id):
608
"""Determine the sha1 of the file contents (used as a key method)."""
609
if file_id not in tree:
611
return tree.get_file_sha1(file_id)
614
def executable(tree, file_id):
615
"""Determine the executability of a file-id (used as a key method)."""
616
if file_id not in tree:
618
if tree.kind(file_id) != "file":
620
return tree.is_executable(file_id)
623
def kind(tree, file_id):
624
"""Determine the kind of a file-id (used as a key method)."""
625
if file_id not in tree:
627
return tree.kind(file_id)
630
def _three_way(base, other, this):
631
#if base == other, either they all agree, or only THIS has changed.
634
elif this not in (base, other):
636
# "Ambiguous clean merge" -- both sides have made the same change.
639
# this == base: only other has changed.
644
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
645
"""Do a three-way test on a scalar.
646
Return "this", "other" or "conflict", depending whether a value wins.
648
key_base = key(base_tree, file_id)
649
key_other = key(other_tree, file_id)
650
#if base == other, either they all agree, or only THIS has changed.
651
if key_base == key_other:
653
key_this = key(this_tree, file_id)
654
if key_this not in (key_base, key_other):
656
# "Ambiguous clean merge"
657
elif key_this == key_other:
660
assert key_this == key_base
663
def merge_names(self, file_id):
665
if file_id in tree.inventory:
666
return tree.inventory[file_id]
669
this_entry = get_entry(self.this_tree)
670
other_entry = get_entry(self.other_tree)
671
base_entry = get_entry(self.base_tree)
672
entries = (base_entry, other_entry, this_entry)
675
for entry in entries:
680
names.append(entry.name)
681
parents.append(entry.parent_id)
682
return self._merge_names(file_id, parents, names)
684
def _merge_names(self, file_id, parents, names):
685
"""Perform a merge on file_id names and parents"""
686
base_name, other_name, this_name = names
687
base_parent, other_parent, this_parent = parents
689
name_winner = self._three_way(*names)
691
parent_id_winner = self._three_way(*parents)
692
if this_name is None:
693
if name_winner == "this":
694
name_winner = "other"
695
if parent_id_winner == "this":
696
parent_id_winner = "other"
697
if name_winner == "this" and parent_id_winner == "this":
699
if name_winner == "conflict":
700
trans_id = self.tt.trans_id_file_id(file_id)
701
self._raw_conflicts.append(('name conflict', trans_id,
702
this_name, other_name))
703
if parent_id_winner == "conflict":
704
trans_id = self.tt.trans_id_file_id(file_id)
705
self._raw_conflicts.append(('parent conflict', trans_id,
706
this_parent, other_parent))
707
if other_name is None:
708
# it doesn't matter whether the result was 'other' or
709
# 'conflict'-- if there's no 'other', we leave it alone.
711
# if we get here, name_winner and parent_winner are set to safe values.
712
trans_id = self.tt.trans_id_file_id(file_id)
713
parent_id = parents[self.winner_idx[parent_id_winner]]
714
if parent_id is not None:
715
parent_trans_id = self.tt.trans_id_file_id(parent_id)
716
self.tt.adjust_path(names[self.winner_idx[name_winner]],
717
parent_trans_id, trans_id)
719
def merge_contents(self, file_id):
720
"""Performa a merge on file_id contents."""
721
def contents_pair(tree):
722
if file_id not in tree:
724
kind = tree.kind(file_id)
726
contents = tree.get_file_sha1(file_id)
727
elif kind == "symlink":
728
contents = tree.get_symlink_target(file_id)
731
return kind, contents
733
def contents_conflict():
734
trans_id = self.tt.trans_id_file_id(file_id)
735
name = self.tt.final_name(trans_id)
736
parent_id = self.tt.final_parent(trans_id)
737
if file_id in self.this_tree.inventory:
738
self.tt.unversion_file(trans_id)
739
if file_id in self.this_tree:
740
self.tt.delete_contents(trans_id)
741
file_group = self._dump_conflicts(name, parent_id, file_id,
743
self._raw_conflicts.append(('contents conflict', file_group))
745
# See SPOT run. run, SPOT, run.
746
# So we're not QUITE repeating ourselves; we do tricky things with
748
base_pair = contents_pair(self.base_tree)
749
other_pair = contents_pair(self.other_tree)
750
if base_pair == other_pair:
751
# OTHER introduced no changes
753
this_pair = contents_pair(self.this_tree)
754
if this_pair == other_pair:
755
# THIS and OTHER introduced the same changes
758
trans_id = self.tt.trans_id_file_id(file_id)
759
if this_pair == base_pair:
760
# only OTHER introduced changes
761
if file_id in self.this_tree:
762
# Remove any existing contents
763
self.tt.delete_contents(trans_id)
764
if file_id in self.other_tree:
765
# OTHER changed the file
766
create_by_entry(self.tt,
767
self.other_tree.inventory[file_id],
768
self.other_tree, trans_id)
769
if file_id not in self.this_tree.inventory:
770
self.tt.version_file(file_id, trans_id)
772
elif file_id in self.this_tree.inventory:
773
# OTHER deleted the file
774
self.tt.unversion_file(trans_id)
776
#BOTH THIS and OTHER introduced changes; scalar conflict
777
elif this_pair[0] == "file" and other_pair[0] == "file":
778
# THIS and OTHER are both files, so text merge. Either
779
# BASE is a file, or both converted to files, so at least we
780
# have agreement that output should be a file.
782
self.text_merge(file_id, trans_id)
784
return contents_conflict()
785
if file_id not in self.this_tree.inventory:
786
self.tt.version_file(file_id, trans_id)
788
self.tt.tree_kind(trans_id)
789
self.tt.delete_contents(trans_id)
794
# Scalar conflict, can't text merge. Dump conflicts
795
return contents_conflict()
797
def get_lines(self, tree, file_id):
798
"""Return the lines in a file, or an empty list."""
800
return tree.get_file(file_id).readlines()
804
def text_merge(self, file_id, trans_id):
805
"""Perform a three-way text merge on a file_id"""
806
# it's possible that we got here with base as a different type.
807
# if so, we just want two-way text conflicts.
808
if file_id in self.base_tree and \
809
self.base_tree.kind(file_id) == "file":
810
base_lines = self.get_lines(self.base_tree, file_id)
813
other_lines = self.get_lines(self.other_tree, file_id)
814
this_lines = self.get_lines(self.this_tree, file_id)
815
m3 = Merge3(base_lines, this_lines, other_lines)
816
start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
817
if self.show_base is True:
818
base_marker = '|' * 7
822
def iter_merge3(retval):
823
retval["text_conflicts"] = False
824
for line in m3.merge_lines(name_a = "TREE",
825
name_b = "MERGE-SOURCE",
826
name_base = "BASE-REVISION",
827
start_marker=start_marker,
828
base_marker=base_marker,
829
reprocess=self.reprocess):
830
if line.startswith(start_marker):
831
retval["text_conflicts"] = True
832
yield line.replace(start_marker, '<' * 7)
836
merge3_iterator = iter_merge3(retval)
837
self.tt.create_file(merge3_iterator, trans_id)
838
if retval["text_conflicts"] is True:
839
self._raw_conflicts.append(('text conflict', trans_id))
840
name = self.tt.final_name(trans_id)
841
parent_id = self.tt.final_parent(trans_id)
842
file_group = self._dump_conflicts(name, parent_id, file_id,
843
this_lines, base_lines,
845
file_group.append(trans_id)
847
def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
848
base_lines=None, other_lines=None, set_version=False,
850
"""Emit conflict files.
851
If this_lines, base_lines, or other_lines are omitted, they will be
852
determined automatically. If set_version is true, the .OTHER, .THIS
853
or .BASE (in that order) will be created as versioned files.
855
data = [('OTHER', self.other_tree, other_lines),
856
('THIS', self.this_tree, this_lines)]
858
data.append(('BASE', self.base_tree, base_lines))
861
for suffix, tree, lines in data:
863
trans_id = self._conflict_file(name, parent_id, tree, file_id,
865
file_group.append(trans_id)
866
if set_version and not versioned:
867
self.tt.version_file(file_id, trans_id)
871
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
873
"""Emit a single conflict file."""
874
name = name + '.' + suffix
875
trans_id = self.tt.create_path(name, parent_id)
876
entry = tree.inventory[file_id]
877
create_by_entry(self.tt, entry, tree, trans_id, lines)
880
def merge_executable(self, file_id, file_status):
881
"""Perform a merge on the execute bit."""
882
executable = [self.executable(t, file_id) for t in (self.base_tree,
883
self.other_tree, self.this_tree)]
884
self._merge_executable(file_id, executable, file_status)
886
def _merge_executable(self, file_id, executable, file_status):
887
"""Perform a merge on the execute bit."""
888
base_executable, other_executable, this_executable = executable
889
if file_status == "deleted":
891
trans_id = self.tt.trans_id_file_id(file_id)
893
if self.tt.final_kind(trans_id) != "file":
897
winner = self._three_way(*executable)
898
if winner == "conflict":
899
# There must be a None in here, if we have a conflict, but we
900
# need executability since file status was not deleted.
901
if self.executable(self.other_tree, file_id) is None:
906
if file_status == "modified":
907
executability = this_executable
908
if executability is not None:
909
trans_id = self.tt.trans_id_file_id(file_id)
910
self.tt.set_executability(executability, trans_id)
912
assert winner == "other"
913
if file_id in self.other_tree:
914
executability = other_executable
915
elif file_id in self.this_tree:
916
executability = this_executable
917
elif file_id in self.base_tree:
918
executability = base_executable
919
if executability is not None:
920
trans_id = self.tt.trans_id_file_id(file_id)
921
self.tt.set_executability(executability, trans_id)
923
def cook_conflicts(self, fs_conflicts):
924
"""Convert all conflicts into a form that doesn't depend on trans_id"""
925
from conflicts import Conflict
927
self.cooked_conflicts.extend(cook_conflicts(fs_conflicts, self.tt))
928
fp = FinalPaths(self.tt)
929
for conflict in self._raw_conflicts:
930
conflict_type = conflict[0]
931
if conflict_type in ('name conflict', 'parent conflict'):
932
trans_id = conflict[1]
933
conflict_args = conflict[2:]
934
if trans_id not in name_conflicts:
935
name_conflicts[trans_id] = {}
936
unique_add(name_conflicts[trans_id], conflict_type,
938
if conflict_type == 'contents conflict':
939
for trans_id in conflict[1]:
940
file_id = self.tt.final_file_id(trans_id)
941
if file_id is not None:
943
path = fp.get_path(trans_id)
944
for suffix in ('.BASE', '.THIS', '.OTHER'):
945
if path.endswith(suffix):
946
path = path[:-len(suffix)]
948
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
949
self.cooked_conflicts.append(c)
950
if conflict_type == 'text conflict':
951
trans_id = conflict[1]
952
path = fp.get_path(trans_id)
953
file_id = self.tt.final_file_id(trans_id)
954
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
955
self.cooked_conflicts.append(c)
957
for trans_id, conflicts in name_conflicts.iteritems():
959
this_parent, other_parent = conflicts['parent conflict']
960
assert this_parent != other_parent
962
this_parent = other_parent = \
963
self.tt.final_file_id(self.tt.final_parent(trans_id))
965
this_name, other_name = conflicts['name conflict']
966
assert this_name != other_name
968
this_name = other_name = self.tt.final_name(trans_id)
969
other_path = fp.get_path(trans_id)
970
if this_parent is not None and this_name is not None:
972
fp.get_path(self.tt.trans_id_file_id(this_parent))
973
this_path = pathjoin(this_parent_path, this_name)
975
this_path = "<deleted>"
976
file_id = self.tt.final_file_id(trans_id)
977
c = Conflict.factory('path conflict', path=this_path,
978
conflict_path=other_path, file_id=file_id)
979
self.cooked_conflicts.append(c)
980
self.cooked_conflicts.sort(key=Conflict.sort_key)
983
class WeaveMerger(Merge3Merger):
984
"""Three-way tree merger, text weave merger."""
985
supports_reprocess = True
986
supports_show_base = False
988
def __init__(self, working_tree, this_tree, base_tree, other_tree,
989
interesting_ids=None, pb=DummyProgress(), pp=None,
990
reprocess=False, change_reporter=None,
991
interesting_files=None):
992
self.this_revision_tree = self._get_revision_tree(this_tree)
993
self.other_revision_tree = self._get_revision_tree(other_tree)
994
super(WeaveMerger, self).__init__(working_tree, this_tree,
995
base_tree, other_tree,
996
interesting_ids=interesting_ids,
997
pb=pb, pp=pp, reprocess=reprocess,
998
change_reporter=change_reporter)
1000
def _get_revision_tree(self, tree):
1001
"""Return a revision tree related to this tree.
1002
If the tree is a WorkingTree, the basis will be returned.
1004
if getattr(tree, 'get_weave', False) is False:
1005
# If we have a WorkingTree, try using the basis
1006
return tree.branch.basis_tree()
1010
def _check_file(self, file_id):
1011
"""Check that the revision tree's version of the file matches."""
1012
for tree, rt in ((self.this_tree, self.this_revision_tree),
1013
(self.other_tree, self.other_revision_tree)):
1016
if tree.get_file_sha1(file_id) != rt.get_file_sha1(file_id):
1017
raise WorkingTreeNotRevision(self.this_tree)
1019
def _merged_lines(self, file_id):
1020
"""Generate the merged lines.
1021
There is no distinction between lines that are meant to contain <<<<<<<
1024
weave = self.this_revision_tree.get_weave(file_id)
1025
this_revision_id = self.this_revision_tree.inventory[file_id].revision
1026
other_revision_id = \
1027
self.other_revision_tree.inventory[file_id].revision
1028
wm = WeaveMerge(weave, this_revision_id, other_revision_id,
1029
'<<<<<<< TREE\n', '>>>>>>> MERGE-SOURCE\n')
1030
return wm.merge_lines(self.reprocess)
1032
def text_merge(self, file_id, trans_id):
1033
"""Perform a (weave) text merge for a given file and file-id.
1034
If conflicts are encountered, .THIS and .OTHER files will be emitted,
1035
and a conflict will be noted.
1037
self._check_file(file_id)
1038
lines, conflicts = self._merged_lines(file_id)
1040
# Note we're checking whether the OUTPUT is binary in this case,
1041
# because we don't want to get into weave merge guts.
1042
check_text_lines(lines)
1043
self.tt.create_file(lines, trans_id)
1045
self._raw_conflicts.append(('text conflict', trans_id))
1046
name = self.tt.final_name(trans_id)
1047
parent_id = self.tt.final_parent(trans_id)
1048
file_group = self._dump_conflicts(name, parent_id, file_id,
1050
file_group.append(trans_id)
1053
class Diff3Merger(Merge3Merger):
1054
"""Three-way merger using external diff3 for text merging"""
1056
def dump_file(self, temp_dir, name, tree, file_id):
1057
out_path = pathjoin(temp_dir, name)
1058
out_file = open(out_path, "wb")
1060
in_file = tree.get_file(file_id)
1061
for line in in_file:
1062
out_file.write(line)
1067
def text_merge(self, file_id, trans_id):
1068
"""Perform a diff3 merge using a specified file-id and trans-id.
1069
If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
1070
will be dumped, and a will be conflict noted.
1073
temp_dir = osutils.mkdtemp(prefix="bzr-")
1075
new_file = pathjoin(temp_dir, "new")
1076
this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
1077
base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
1078
other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
1079
status = bzrlib.patch.diff3(new_file, this, base, other)
1080
if status not in (0, 1):
1081
raise BzrError("Unhandled diff3 exit code")
1082
f = open(new_file, 'rb')
1084
self.tt.create_file(f, trans_id)
1088
name = self.tt.final_name(trans_id)
1089
parent_id = self.tt.final_parent(trans_id)
1090
self._dump_conflicts(name, parent_id, file_id)
1091
self._raw_conflicts.append(('text conflict', trans_id))
1093
osutils.rmtree(temp_dir)
1096
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1098
merge_type=Merge3Merger,
1099
interesting_ids=None,
1103
interesting_files=None,
1106
change_reporter=None):
1107
"""Primary interface for merging.
1109
typical use is probably
1110
'merge_inner(branch, branch.get_revision_tree(other_revision),
1111
branch.get_revision_tree(base_revision))'
1113
if this_tree is None:
1114
raise BzrError("bzrlib.merge.merge_inner requires a this_tree "
1115
"parameter as of bzrlib version 0.8.")
1116
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1117
pb=pb, change_reporter=change_reporter)
1118
merger.backup_files = backup_files
1119
merger.merge_type = merge_type
1120
merger.interesting_ids = interesting_ids
1121
merger.ignore_zero = ignore_zero
1122
if interesting_files:
1123
assert not interesting_ids, ('Only supply interesting_ids'
1124
' or interesting_files')
1125
merger.interesting_files = interesting_files
1126
merger.show_base = show_base
1127
merger.reprocess = reprocess
1128
merger.other_rev_id = other_rev_id
1129
merger.other_basis = other_rev_id
1130
return merger.do_merge()
1132
def get_merge_type_registry():
1133
"""Merge type registry is in bzrlib.option to avoid circular imports.
1135
This method provides a sanctioned way to retrieve it.
1137
from bzrlib import option
1138
return option._merge_type_registry
added
removed
bzrlib/merge.py
