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
FinalPaths, create_by_entry, unique_add,
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):
173
self.interesting_files = file_list
174
except NotVersionedError, e:
175
raise BzrCommandError("%s is not a source file in any"
178
def _set_interesting_files(self, file_list):
179
"""Set the list of interesting ids from a list of files."""
180
if file_list is None:
181
self.interesting_ids = None
184
interesting_ids = set()
185
for path in file_list:
187
# TODO: jam 20070226 The trees are not locked at this time,
188
# wouldn't it make merge faster if it locks everything in the
189
# beginning? It locks at do_merge time, but this happens
191
for tree in (self.this_tree, self.base_tree, self.other_tree):
192
file_id = tree.path2id(path)
193
if file_id is not None:
194
interesting_ids.add(file_id)
197
raise NotVersionedError(path=path)
198
self.interesting_ids = interesting_ids
200
def set_pending(self):
201
if not self.base_is_ancestor:
203
if self.other_rev_id is None:
205
ancestry = set(self.this_branch.repository.get_ancestry(
206
self.this_basis, topo_sorted=False))
207
if self.other_rev_id in ancestry:
209
self.this_tree.add_parent_tree((self.other_rev_id, self.other_tree))
211
def set_other(self, other_revision):
212
"""Set the revision and tree to merge from.
214
This sets the other_tree, other_rev_id, other_basis attributes.
216
:param other_revision: The [path, revision] list to merge from.
218
self.other_branch, self.other_tree = _get_tree(other_revision,
220
if other_revision[1] == -1:
221
self.other_rev_id = self.other_branch.last_revision()
222
if self.other_rev_id is None:
223
raise NoCommits(self.other_branch)
224
self.other_basis = self.other_rev_id
225
elif other_revision[1] is not None:
226
self.other_rev_id = self.other_branch.get_rev_id(other_revision[1])
227
self.other_basis = self.other_rev_id
229
self.other_rev_id = None
230
self.other_basis = self.other_branch.last_revision()
231
if self.other_basis is None:
232
raise NoCommits(self.other_branch)
233
if self.other_branch.base != self.this_branch.base:
234
self.this_branch.fetch(self.other_branch,
235
last_revision=self.other_basis)
237
def set_other_revision(self, revision_id, other_branch):
238
"""Set 'other' based on a branch and revision id
240
:param revision_id: The revision to use for a tree
241
:param other_branch: The branch containing this tree
243
self.other_rev_id = revision_id
244
self.other_branch = other_branch
245
self.this_branch.fetch(other_branch, self.other_rev_id)
246
self.other_tree = self.revision_tree(revision_id)
247
self.other_basis = revision_id
250
self.set_base([None, None])
252
def set_base(self, base_revision):
253
"""Set the base revision to use for the merge.
255
:param base_revision: A 2-list containing a path and revision number.
257
mutter("doing merge() with no base_revision specified")
258
if base_revision == [None, None]:
260
pb = ui.ui_factory.nested_progress_bar()
262
this_repo = self.this_branch.repository
263
graph = this_repo.get_graph()
264
revisions = [ensure_null(self.this_basis),
265
ensure_null(self.other_basis)]
266
if NULL_REVISION in revisions:
267
self.base_rev_id = NULL_REVISION
269
self.base_rev_id = graph.find_unique_lca(*revisions)
270
if self.base_rev_id == NULL_REVISION:
271
raise UnrelatedBranches()
274
except NoCommonAncestor:
275
raise UnrelatedBranches()
276
self.base_tree = _get_revid_tree_from_tree(self.this_tree,
279
self.base_is_ancestor = True
281
base_branch, self.base_tree = _get_tree(base_revision)
282
if base_revision[1] == -1:
283
self.base_rev_id = base_branch.last_revision()
284
elif base_revision[1] is None:
285
self.base_rev_id = None
287
self.base_rev_id = base_branch.get_rev_id(base_revision[1])
288
if self.this_branch.base != base_branch.base:
289
self.this_branch.fetch(base_branch)
290
self.base_is_ancestor = is_ancestor(self.this_basis,
295
kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
296
'other_tree': self.other_tree,
297
'interesting_ids': self.interesting_ids,
298
'interesting_files': self.interesting_files,
300
if self.merge_type.requires_base:
301
kwargs['base_tree'] = self.base_tree
302
if self.merge_type.supports_reprocess:
303
kwargs['reprocess'] = self.reprocess
305
raise BzrError("Conflict reduction is not supported for merge"
306
" type %s." % self.merge_type)
307
if self.merge_type.supports_show_base:
308
kwargs['show_base'] = self.show_base
310
raise BzrError("Showing base is not supported for this"
311
" merge type. %s" % self.merge_type)
312
self.this_tree.lock_tree_write()
313
if self.base_tree is not None:
314
self.base_tree.lock_read()
315
if self.other_tree is not None:
316
self.other_tree.lock_read()
318
merge = self.merge_type(pb=self._pb,
319
change_reporter=self.change_reporter,
321
if self.recurse == 'down':
322
for path, file_id in self.this_tree.iter_references():
323
sub_tree = self.this_tree.get_nested_tree(file_id, path)
324
other_revision = self.other_tree.get_reference_revision(
326
if other_revision == sub_tree.last_revision():
328
sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
329
sub_merge.merge_type = self.merge_type
330
relpath = self.this_tree.relpath(path)
331
other_branch = self.other_branch.reference_parent(file_id, relpath)
332
sub_merge.set_other_revision(other_revision, other_branch)
333
base_revision = self.base_tree.get_reference_revision(file_id)
334
sub_merge.base_tree = \
335
sub_tree.branch.repository.revision_tree(base_revision)
339
if self.other_tree is not None:
340
self.other_tree.unlock()
341
if self.base_tree is not None:
342
self.base_tree.unlock()
343
self.this_tree.unlock()
344
if len(merge.cooked_conflicts) == 0:
345
if not self.ignore_zero:
346
note("All changes applied successfully.")
348
note("%d conflicts encountered." % len(merge.cooked_conflicts))
350
return len(merge.cooked_conflicts)
352
def regen_inventory(self, new_entries):
353
old_entries = self.this_tree.read_working_inventory()
357
for path, file_id in new_entries:
360
new_entries_map[file_id] = path
362
def id2path(file_id):
363
path = new_entries_map.get(file_id)
366
entry = old_entries[file_id]
367
if entry.parent_id is None:
369
return pathjoin(id2path(entry.parent_id), entry.name)
371
for file_id in old_entries:
372
entry = old_entries[file_id]
373
path = id2path(file_id)
374
if file_id in self.base_tree.inventory:
375
executable = getattr(self.base_tree.inventory[file_id], 'executable', False)
377
executable = getattr(entry, 'executable', False)
378
new_inventory[file_id] = (path, file_id, entry.parent_id,
379
entry.kind, executable)
381
by_path[path] = file_id
386
for path, file_id in new_entries:
388
del new_inventory[file_id]
391
new_path_list.append((path, file_id))
392
if file_id not in old_entries:
394
# Ensure no file is added before its parent
396
for path, file_id in new_path_list:
400
parent = by_path[os.path.dirname(path)]
401
abspath = pathjoin(self.this_tree.basedir, path)
402
kind = osutils.file_kind(abspath)
403
if file_id in self.base_tree.inventory:
404
executable = getattr(self.base_tree.inventory[file_id], 'executable', False)
407
new_inventory[file_id] = (path, file_id, parent, kind, executable)
408
by_path[path] = file_id
410
# Get a list in insertion order
411
new_inventory_list = new_inventory.values()
412
mutter ("""Inventory regeneration:
413
old length: %i insertions: %i deletions: %i new_length: %i"""\
414
% (len(old_entries), insertions, deletions,
415
len(new_inventory_list)))
416
assert len(new_inventory_list) == len(old_entries) + insertions\
418
new_inventory_list.sort()
419
return new_inventory_list
422
class Merge3Merger(object):
423
"""Three-way merger that uses the merge3 text merger"""
425
supports_reprocess = True
426
supports_show_base = True
427
history_based = False
429
def __init__(self, working_tree, this_tree, base_tree, other_tree,
430
interesting_ids=None, reprocess=False, show_base=False,
431
pb=DummyProgress(), pp=None, change_reporter=None,
432
interesting_files=None):
433
"""Initialize the merger object and perform the merge."""
434
object.__init__(self)
435
if interesting_files is not None:
436
assert interesting_ids is None
437
self.interesting_ids = interesting_ids
438
self.interesting_files = interesting_files
439
self.this_tree = working_tree
440
self.this_tree.lock_tree_write()
441
self.base_tree = base_tree
442
self.base_tree.lock_read()
443
self.other_tree = other_tree
444
self.other_tree.lock_read()
445
self._raw_conflicts = []
446
self.cooked_conflicts = []
447
self.reprocess = reprocess
448
self.show_base = show_base
451
self.change_reporter = change_reporter
453
self.pp = ProgressPhase("Merge phase", 3, self.pb)
455
self.tt = TreeTransform(working_tree, self.pb)
458
entries = self._entries3()
459
child_pb = ui.ui_factory.nested_progress_bar()
461
for num, (file_id, changed, parents3, names3,
462
executable3) in enumerate(entries):
463
child_pb.update('Preparing file merge', num, len(entries))
464
self._merge_names(file_id, parents3, names3)
466
file_status = self.merge_contents(file_id)
468
file_status = 'unmodified'
469
self._merge_executable(file_id,
470
executable3, file_status)
475
child_pb = ui.ui_factory.nested_progress_bar()
477
fs_conflicts = resolve_conflicts(self.tt, child_pb)
480
if change_reporter is not None:
481
from bzrlib import delta
482
delta.report_changes(self.tt._iter_changes(), change_reporter)
483
self.cook_conflicts(fs_conflicts)
484
for conflict in self.cooked_conflicts:
487
results = self.tt.apply()
488
self.write_modified(results)
490
working_tree.add_conflicts(self.cooked_conflicts)
491
except UnsupportedOperation:
495
self.other_tree.unlock()
496
self.base_tree.unlock()
497
self.this_tree.unlock()
502
iterator = self.other_tree._iter_changes(self.base_tree,
503
include_unchanged=True, specific_files=self.interesting_files,
504
extra_trees=[self.this_tree])
505
for (file_id, paths, changed, versioned, parents, names, kind,
506
executable) in iterator:
507
if (self.interesting_ids is not None and
508
file_id not in self.interesting_ids):
510
if file_id in self.this_tree.inventory:
511
entry = self.this_tree.inventory[file_id]
512
this_name = entry.name
513
this_parent = entry.parent_id
514
this_executable = entry.executable
518
this_executable = None
519
parents3 = parents + (this_parent,)
520
names3 = names + (this_name,)
521
executable3 = executable + (this_executable,)
522
result.append((file_id, changed, parents3, names3, executable3))
527
self.tt.final_kind(self.tt.root)
529
self.tt.cancel_deletion(self.tt.root)
530
if self.tt.final_file_id(self.tt.root) is None:
531
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
533
if self.other_tree.inventory.root is None:
535
other_root_file_id = self.other_tree.inventory.root.file_id
536
other_root = self.tt.trans_id_file_id(other_root_file_id)
537
if other_root == self.tt.root:
540
self.tt.final_kind(other_root)
543
self.reparent_children(self.other_tree.inventory.root, self.tt.root)
544
self.tt.cancel_creation(other_root)
545
self.tt.cancel_versioning(other_root)
547
def reparent_children(self, ie, target):
548
for thing, child in ie.children.iteritems():
549
trans_id = self.tt.trans_id_file_id(child.file_id)
550
self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
552
def write_modified(self, results):
554
for path in results.modified_paths:
555
file_id = self.this_tree.path2id(self.this_tree.relpath(path))
558
hash = self.this_tree.get_file_sha1(file_id)
561
modified_hashes[file_id] = hash
562
self.this_tree.set_merge_modified(modified_hashes)
565
def parent(entry, file_id):
566
"""Determine the parent for a file_id (used as a key method)"""
569
return entry.parent_id
572
def name(entry, file_id):
573
"""Determine the name for a file_id (used as a key method)"""
579
def contents_sha1(tree, file_id):
580
"""Determine the sha1 of the file contents (used as a key method)."""
581
if file_id not in tree:
583
return tree.get_file_sha1(file_id)
586
def executable(tree, file_id):
587
"""Determine the executability of a file-id (used as a key method)."""
588
if file_id not in tree:
590
if tree.kind(file_id) != "file":
592
return tree.is_executable(file_id)
595
def kind(tree, file_id):
596
"""Determine the kind of a file-id (used as a key method)."""
597
if file_id not in tree:
599
return tree.kind(file_id)
602
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
603
"""Do a three-way test on a scalar.
604
Return "this", "other" or "conflict", depending whether a value wins.
606
key_base = key(base_tree, file_id)
607
key_other = key(other_tree, file_id)
608
#if base == other, either they all agree, or only THIS has changed.
609
if key_base == key_other:
611
key_this = key(this_tree, file_id)
612
if key_this not in (key_base, key_other):
614
# "Ambiguous clean merge"
615
elif key_this == key_other:
618
assert key_this == key_base
621
def merge_names(self, file_id):
622
"""Perform a merge on file_id names and parents"""
624
if file_id in tree.inventory:
625
return tree.inventory[file_id]
628
this_entry = get_entry(self.this_tree)
629
other_entry = get_entry(self.other_tree)
630
base_entry = get_entry(self.base_tree)
631
entries = (base_entry, other_entry, this_entry)
634
for entry in entries:
639
names.append(entry.name)
640
parents.append(entry.parent_id)
641
return self._merge_names(file_id, parents, names)
644
def _three_way(base, other, this):
647
if this not in (base, other):
656
def _merge_names(self, file_id, parents, names):
657
base_name, other_name, this_name = names
658
base_parent, other_parent, this_parent = parents
660
name_winner = self._three_way(*names)
662
parent_id_winner = self._three_way(*parents)
663
if this_name is None:
664
if name_winner == "this":
665
name_winner = "other"
666
if parent_id_winner == "this":
667
parent_id_winner = "other"
668
if name_winner == "this" and parent_id_winner == "this":
670
if name_winner == "conflict":
671
trans_id = self.tt.trans_id_file_id(file_id)
672
self._raw_conflicts.append(('name conflict', trans_id,
673
this_name, other_name))
674
if parent_id_winner == "conflict":
675
trans_id = self.tt.trans_id_file_id(file_id)
676
self._raw_conflicts.append(('parent conflict', trans_id,
677
this_parent, other_parent))
678
if other_name is None:
679
# it doesn't matter whether the result was 'other' or
680
# 'conflict'-- if there's no 'other', we leave it alone.
682
# if we get here, name_winner and parent_winner are set to safe values.
683
winner_idx = {"this": 2, "other": 1, "conflict": 1}
684
trans_id = self.tt.trans_id_file_id(file_id)
685
parent_id = parents[winner_idx[parent_id_winner]]
686
if parent_id is not None:
687
parent_trans_id = self.tt.trans_id_file_id(parent_id)
688
self.tt.adjust_path(names[winner_idx[name_winner]],
689
parent_trans_id, trans_id)
691
def merge_contents(self, file_id):
692
"""Performa a merge on file_id contents."""
693
def contents_pair(tree):
694
if file_id not in tree:
696
kind = tree.kind(file_id)
698
contents = tree.get_file_sha1(file_id)
699
elif kind == "symlink":
700
contents = tree.get_symlink_target(file_id)
703
return kind, contents
705
def contents_conflict():
706
trans_id = self.tt.trans_id_file_id(file_id)
707
name = self.tt.final_name(trans_id)
708
parent_id = self.tt.final_parent(trans_id)
709
if file_id in self.this_tree.inventory:
710
self.tt.unversion_file(trans_id)
711
if file_id in self.this_tree:
712
self.tt.delete_contents(trans_id)
713
file_group = self._dump_conflicts(name, parent_id, file_id,
715
self._raw_conflicts.append(('contents conflict', file_group))
717
# See SPOT run. run, SPOT, run.
718
# So we're not QUITE repeating ourselves; we do tricky things with
720
base_pair = contents_pair(self.base_tree)
721
other_pair = contents_pair(self.other_tree)
722
if base_pair == other_pair:
723
# OTHER introduced no changes
725
this_pair = contents_pair(self.this_tree)
726
if this_pair == other_pair:
727
# THIS and OTHER introduced the same changes
730
trans_id = self.tt.trans_id_file_id(file_id)
731
if this_pair == base_pair:
732
# only OTHER introduced changes
733
if file_id in self.this_tree:
734
# Remove any existing contents
735
self.tt.delete_contents(trans_id)
736
if file_id in self.other_tree:
737
# OTHER changed the file
738
create_by_entry(self.tt,
739
self.other_tree.inventory[file_id],
740
self.other_tree, trans_id)
741
if file_id not in self.this_tree.inventory:
742
self.tt.version_file(file_id, trans_id)
744
elif file_id in self.this_tree.inventory:
745
# OTHER deleted the file
746
self.tt.unversion_file(trans_id)
748
#BOTH THIS and OTHER introduced changes; scalar conflict
749
elif this_pair[0] == "file" and other_pair[0] == "file":
750
# THIS and OTHER are both files, so text merge. Either
751
# BASE is a file, or both converted to files, so at least we
752
# have agreement that output should be a file.
754
self.text_merge(file_id, trans_id)
756
return contents_conflict()
757
if file_id not in self.this_tree.inventory:
758
self.tt.version_file(file_id, trans_id)
760
self.tt.tree_kind(trans_id)
761
self.tt.delete_contents(trans_id)
766
# Scalar conflict, can't text merge. Dump conflicts
767
return contents_conflict()
769
def get_lines(self, tree, file_id):
770
"""Return the lines in a file, or an empty list."""
772
return tree.get_file(file_id).readlines()
776
def text_merge(self, file_id, trans_id):
777
"""Perform a three-way text merge on a file_id"""
778
# it's possible that we got here with base as a different type.
779
# if so, we just want two-way text conflicts.
780
if file_id in self.base_tree and \
781
self.base_tree.kind(file_id) == "file":
782
base_lines = self.get_lines(self.base_tree, file_id)
785
other_lines = self.get_lines(self.other_tree, file_id)
786
this_lines = self.get_lines(self.this_tree, file_id)
787
m3 = Merge3(base_lines, this_lines, other_lines)
788
start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
789
if self.show_base is True:
790
base_marker = '|' * 7
794
def iter_merge3(retval):
795
retval["text_conflicts"] = False
796
for line in m3.merge_lines(name_a = "TREE",
797
name_b = "MERGE-SOURCE",
798
name_base = "BASE-REVISION",
799
start_marker=start_marker,
800
base_marker=base_marker,
801
reprocess=self.reprocess):
802
if line.startswith(start_marker):
803
retval["text_conflicts"] = True
804
yield line.replace(start_marker, '<' * 7)
808
merge3_iterator = iter_merge3(retval)
809
self.tt.create_file(merge3_iterator, trans_id)
810
if retval["text_conflicts"] is True:
811
self._raw_conflicts.append(('text conflict', trans_id))
812
name = self.tt.final_name(trans_id)
813
parent_id = self.tt.final_parent(trans_id)
814
file_group = self._dump_conflicts(name, parent_id, file_id,
815
this_lines, base_lines,
817
file_group.append(trans_id)
819
def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
820
base_lines=None, other_lines=None, set_version=False,
822
"""Emit conflict files.
823
If this_lines, base_lines, or other_lines are omitted, they will be
824
determined automatically. If set_version is true, the .OTHER, .THIS
825
or .BASE (in that order) will be created as versioned files.
827
data = [('OTHER', self.other_tree, other_lines),
828
('THIS', self.this_tree, this_lines)]
830
data.append(('BASE', self.base_tree, base_lines))
833
for suffix, tree, lines in data:
835
trans_id = self._conflict_file(name, parent_id, tree, file_id,
837
file_group.append(trans_id)
838
if set_version and not versioned:
839
self.tt.version_file(file_id, trans_id)
843
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
845
"""Emit a single conflict file."""
846
name = name + '.' + suffix
847
trans_id = self.tt.create_path(name, parent_id)
848
entry = tree.inventory[file_id]
849
create_by_entry(self.tt, entry, tree, trans_id, lines)
852
def merge_executable(self, file_id, file_status):
853
"""Perform a merge on the execute bit."""
854
executable = [self.executable(t, file_id) for t in (self.base_tree,
855
self.other_tree, self.this_tree)]
856
self._merge_executable(file_id, executable, file_status)
858
def _merge_executable(self, file_id, executable, file_status):
859
"""Perform a merge on the execute bit."""
860
base_executable, other_executable, this_executable = executable
861
if file_status == "deleted":
863
trans_id = self.tt.trans_id_file_id(file_id)
865
if self.tt.final_kind(trans_id) != "file":
869
winner = self._three_way(*executable)
870
if winner == "conflict":
871
# There must be a None in here, if we have a conflict, but we
872
# need executability since file status was not deleted.
873
if self.executable(self.other_tree, file_id) is None:
878
if file_status == "modified":
879
executability = this_executable
880
if executability is not None:
881
trans_id = self.tt.trans_id_file_id(file_id)
882
self.tt.set_executability(executability, trans_id)
884
assert winner == "other"
885
if file_id in self.other_tree:
886
executability = other_executable
887
elif file_id in self.this_tree:
888
executability = this_executable
889
elif file_id in self.base_tree:
890
executability = base_executable
891
if executability is not None:
892
trans_id = self.tt.trans_id_file_id(file_id)
893
self.tt.set_executability(executability, trans_id)
895
def cook_conflicts(self, fs_conflicts):
896
"""Convert all conflicts into a form that doesn't depend on trans_id"""
897
from conflicts import Conflict
899
self.cooked_conflicts.extend(cook_conflicts(fs_conflicts, self.tt))
900
fp = FinalPaths(self.tt)
901
for conflict in self._raw_conflicts:
902
conflict_type = conflict[0]
903
if conflict_type in ('name conflict', 'parent conflict'):
904
trans_id = conflict[1]
905
conflict_args = conflict[2:]
906
if trans_id not in name_conflicts:
907
name_conflicts[trans_id] = {}
908
unique_add(name_conflicts[trans_id], conflict_type,
910
if conflict_type == 'contents conflict':
911
for trans_id in conflict[1]:
912
file_id = self.tt.final_file_id(trans_id)
913
if file_id is not None:
915
path = fp.get_path(trans_id)
916
for suffix in ('.BASE', '.THIS', '.OTHER'):
917
if path.endswith(suffix):
918
path = path[:-len(suffix)]
920
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
921
self.cooked_conflicts.append(c)
922
if conflict_type == 'text conflict':
923
trans_id = conflict[1]
924
path = fp.get_path(trans_id)
925
file_id = self.tt.final_file_id(trans_id)
926
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
927
self.cooked_conflicts.append(c)
929
for trans_id, conflicts in name_conflicts.iteritems():
931
this_parent, other_parent = conflicts['parent conflict']
932
assert this_parent != other_parent
934
this_parent = other_parent = \
935
self.tt.final_file_id(self.tt.final_parent(trans_id))
937
this_name, other_name = conflicts['name conflict']
938
assert this_name != other_name
940
this_name = other_name = self.tt.final_name(trans_id)
941
other_path = fp.get_path(trans_id)
942
if this_parent is not None and this_name is not None:
944
fp.get_path(self.tt.trans_id_file_id(this_parent))
945
this_path = pathjoin(this_parent_path, this_name)
947
this_path = "<deleted>"
948
file_id = self.tt.final_file_id(trans_id)
949
c = Conflict.factory('path conflict', path=this_path,
950
conflict_path=other_path, file_id=file_id)
951
self.cooked_conflicts.append(c)
952
self.cooked_conflicts.sort(key=Conflict.sort_key)
955
class WeaveMerger(Merge3Merger):
956
"""Three-way tree merger, text weave merger."""
957
supports_reprocess = True
958
supports_show_base = False
960
def __init__(self, working_tree, this_tree, base_tree, other_tree,
961
interesting_ids=None, pb=DummyProgress(), pp=None,
962
reprocess=False, change_reporter=None,
963
interesting_files=None):
964
self.this_revision_tree = self._get_revision_tree(this_tree)
965
self.other_revision_tree = self._get_revision_tree(other_tree)
966
super(WeaveMerger, self).__init__(working_tree, this_tree,
967
base_tree, other_tree,
968
interesting_ids=interesting_ids,
969
pb=pb, pp=pp, reprocess=reprocess,
970
change_reporter=change_reporter)
972
def _get_revision_tree(self, tree):
973
"""Return a revision tree related to this tree.
974
If the tree is a WorkingTree, the basis will be returned.
976
if getattr(tree, 'get_weave', False) is False:
977
# If we have a WorkingTree, try using the basis
978
return tree.branch.basis_tree()
982
def _check_file(self, file_id):
983
"""Check that the revision tree's version of the file matches."""
984
for tree, rt in ((self.this_tree, self.this_revision_tree),
985
(self.other_tree, self.other_revision_tree)):
988
if tree.get_file_sha1(file_id) != rt.get_file_sha1(file_id):
989
raise WorkingTreeNotRevision(self.this_tree)
991
def _merged_lines(self, file_id):
992
"""Generate the merged lines.
993
There is no distinction between lines that are meant to contain <<<<<<<
996
weave = self.this_revision_tree.get_weave(file_id)
997
this_revision_id = self.this_revision_tree.inventory[file_id].revision
998
other_revision_id = \
999
self.other_revision_tree.inventory[file_id].revision
1000
wm = WeaveMerge(weave, this_revision_id, other_revision_id,
1001
'<<<<<<< TREE\n', '>>>>>>> MERGE-SOURCE\n')
1002
return wm.merge_lines(self.reprocess)
1004
def text_merge(self, file_id, trans_id):
1005
"""Perform a (weave) text merge for a given file and file-id.
1006
If conflicts are encountered, .THIS and .OTHER files will be emitted,
1007
and a conflict will be noted.
1009
self._check_file(file_id)
1010
lines, conflicts = self._merged_lines(file_id)
1012
# Note we're checking whether the OUTPUT is binary in this case,
1013
# because we don't want to get into weave merge guts.
1014
check_text_lines(lines)
1015
self.tt.create_file(lines, trans_id)
1017
self._raw_conflicts.append(('text conflict', trans_id))
1018
name = self.tt.final_name(trans_id)
1019
parent_id = self.tt.final_parent(trans_id)
1020
file_group = self._dump_conflicts(name, parent_id, file_id,
1022
file_group.append(trans_id)
1025
class Diff3Merger(Merge3Merger):
1026
"""Three-way merger using external diff3 for text merging"""
1028
def dump_file(self, temp_dir, name, tree, file_id):
1029
out_path = pathjoin(temp_dir, name)
1030
out_file = open(out_path, "wb")
1032
in_file = tree.get_file(file_id)
1033
for line in in_file:
1034
out_file.write(line)
1039
def text_merge(self, file_id, trans_id):
1040
"""Perform a diff3 merge using a specified file-id and trans-id.
1041
If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
1042
will be dumped, and a will be conflict noted.
1045
temp_dir = osutils.mkdtemp(prefix="bzr-")
1047
new_file = pathjoin(temp_dir, "new")
1048
this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
1049
base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
1050
other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
1051
status = bzrlib.patch.diff3(new_file, this, base, other)
1052
if status not in (0, 1):
1053
raise BzrError("Unhandled diff3 exit code")
1054
f = open(new_file, 'rb')
1056
self.tt.create_file(f, trans_id)
1060
name = self.tt.final_name(trans_id)
1061
parent_id = self.tt.final_parent(trans_id)
1062
self._dump_conflicts(name, parent_id, file_id)
1063
self._raw_conflicts.append(('text conflict', trans_id))
1065
osutils.rmtree(temp_dir)
1068
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1070
merge_type=Merge3Merger,
1071
interesting_ids=None,
1075
interesting_files=None,
1078
change_reporter=None):
1079
"""Primary interface for merging.
1081
typical use is probably
1082
'merge_inner(branch, branch.get_revision_tree(other_revision),
1083
branch.get_revision_tree(base_revision))'
1085
if this_tree is None:
1086
raise BzrError("bzrlib.merge.merge_inner requires a this_tree "
1087
"parameter as of bzrlib version 0.8.")
1088
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1089
pb=pb, change_reporter=change_reporter)
1090
merger.backup_files = backup_files
1091
merger.merge_type = merge_type
1092
merger.interesting_ids = interesting_ids
1093
merger.ignore_zero = ignore_zero
1094
if interesting_files:
1095
assert not interesting_ids, ('Only supply interesting_ids'
1096
' or interesting_files')
1097
merger.interesting_files = interesting_files
1098
merger.show_base = show_base
1099
merger.reprocess = reprocess
1100
merger.other_rev_id = other_rev_id
1101
merger.other_basis = other_rev_id
1102
return merger.do_merge()
1104
def get_merge_type_registry():
1105
"""Merge type registry is in bzrlib.option to avoid circular imports.
1107
This method provides a sanctioned way to retrieve it.
1109
from bzrlib import option
1110
return option._merge_type_registry
added
removed
bzrlib/merge.py
