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
25
revision as _mod_revision,
27
from bzrlib.branch import Branch
28
from bzrlib.conflicts import ConflictList, Conflict
29
from bzrlib.errors import (BzrCommandError,
39
WorkingTreeNotRevision,
42
from bzrlib.merge3 import Merge3
43
from bzrlib.osutils import rename, pathjoin
44
from progress import DummyProgress, ProgressPhase
45
from bzrlib.revision import (is_ancestor, NULL_REVISION, ensure_null)
46
from bzrlib.textfile import check_text_lines
47
from bzrlib.trace import mutter, warning, note
48
from bzrlib.transform import (TreeTransform, resolve_conflicts, cook_conflicts,
49
conflict_pass, FinalPaths, create_by_entry,
50
unique_add, ROOT_PARENT)
51
from bzrlib.versionedfile import WeaveMerge
54
# TODO: Report back as changes are merged in
56
def _get_tree(treespec, local_branch=None):
57
from bzrlib import workingtree
58
location, revno = treespec
60
tree = workingtree.WorkingTree.open_containing(location)[0]
61
return tree.branch, tree
62
branch = Branch.open_containing(location)[0]
64
revision_id = branch.last_revision()
66
revision_id = branch.get_rev_id(revno)
67
if revision_id is None:
68
revision_id = NULL_REVISION
69
return branch, _get_revid_tree(branch, revision_id, local_branch)
72
def _get_revid_tree(branch, revision_id, local_branch):
73
if revision_id is None:
74
base_tree = branch.bzrdir.open_workingtree()
76
if local_branch is not None:
77
if local_branch.base != branch.base:
78
local_branch.fetch(branch, revision_id)
79
base_tree = local_branch.repository.revision_tree(revision_id)
81
base_tree = branch.repository.revision_tree(revision_id)
85
def _get_revid_tree_from_tree(tree, revision_id, local_branch):
86
if revision_id is None:
88
if local_branch is not None:
89
if local_branch.base != tree.branch.base:
90
local_branch.fetch(tree.branch, revision_id)
91
return local_branch.repository.revision_tree(revision_id)
92
return tree.branch.repository.revision_tree(revision_id)
95
def transform_tree(from_tree, to_tree, interesting_ids=None):
96
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
97
interesting_ids=interesting_ids, this_tree=from_tree)
100
class Merger(object):
101
def __init__(self, this_branch, other_tree=None, base_tree=None,
102
this_tree=None, pb=DummyProgress(), change_reporter=None,
104
object.__init__(self)
105
assert this_tree is not None, "this_tree is required"
106
self.this_branch = this_branch
107
self.this_basis = _mod_revision.ensure_null(
108
this_branch.last_revision())
109
self.this_rev_id = None
110
self.this_tree = this_tree
111
self.this_revision_tree = None
112
self.this_basis_tree = None
113
self.other_tree = other_tree
114
self.other_branch = None
115
self.base_tree = base_tree
116
self.ignore_zero = False
117
self.backup_files = False
118
self.interesting_ids = None
119
self.interesting_files = None
120
self.show_base = False
121
self.reprocess = False
124
self.recurse = recurse
125
self.change_reporter = change_reporter
127
def revision_tree(self, revision_id):
128
return self.this_branch.repository.revision_tree(revision_id)
130
def ensure_revision_trees(self):
131
if self.this_revision_tree is None:
132
self.this_basis_tree = self.this_branch.repository.revision_tree(
134
if self.this_basis == self.this_rev_id:
135
self.this_revision_tree = self.this_basis_tree
137
if self.other_rev_id is None:
138
other_basis_tree = self.revision_tree(self.other_basis)
139
changes = other_basis_tree.changes_from(self.other_tree)
140
if changes.has_changed():
141
raise WorkingTreeNotRevision(self.this_tree)
142
other_rev_id = self.other_basis
143
self.other_tree = other_basis_tree
145
def file_revisions(self, file_id):
146
self.ensure_revision_trees()
147
def get_id(tree, file_id):
148
revision_id = tree.inventory[file_id].revision
149
assert revision_id is not None
151
if self.this_rev_id is None:
152
if self.this_basis_tree.get_file_sha1(file_id) != \
153
self.this_tree.get_file_sha1(file_id):
154
raise WorkingTreeNotRevision(self.this_tree)
156
trees = (self.this_basis_tree, self.other_tree)
157
return [get_id(tree, file_id) for tree in trees]
159
def check_basis(self, check_clean, require_commits=True):
160
if self.this_basis is None and require_commits is True:
161
raise BzrCommandError("This branch has no commits."
162
" (perhaps you would prefer 'bzr pull')")
165
if self.this_basis != self.this_rev_id:
166
raise BzrCommandError("Working tree has uncommitted changes.")
168
def compare_basis(self):
169
changes = self.this_tree.changes_from(self.this_tree.basis_tree())
170
if not changes.has_changed():
171
self.this_rev_id = self.this_basis
173
def set_interesting_files(self, file_list):
174
self.interesting_files = file_list
176
def _set_interesting_files(self, file_list):
177
"""Set the list of interesting ids from a list of files."""
178
if file_list is None:
179
self.interesting_ids = None
182
interesting_ids = set()
183
for path in file_list:
185
# TODO: jam 20070226 The trees are not locked at this time,
186
# wouldn't it make merge faster if it locks everything in the
187
# beginning? It locks at do_merge time, but this happens
189
for tree in (self.this_tree, self.base_tree, self.other_tree):
190
file_id = tree.path2id(path)
191
if file_id is not None:
192
interesting_ids.add(file_id)
195
raise NotVersionedError(path=path)
196
self.interesting_ids = interesting_ids
198
def set_pending(self):
199
if not self.base_is_ancestor:
201
if self.other_rev_id is None:
203
ancestry = set(self.this_branch.repository.get_ancestry(
204
self.this_basis, topo_sorted=False))
205
if self.other_rev_id in ancestry:
207
self.this_tree.add_parent_tree((self.other_rev_id, self.other_tree))
209
def set_other(self, other_revision):
210
"""Set the revision and tree to merge from.
212
This sets the other_tree, other_rev_id, other_basis attributes.
214
:param other_revision: The [path, revision] list to merge from.
216
self.other_branch, self.other_tree = _get_tree(other_revision,
218
if other_revision[1] == -1:
219
self.other_rev_id = _mod_revision.ensure_null(
220
self.other_branch.last_revision())
221
if _mod_revision.is_null(self.other_rev_id):
222
raise NoCommits(self.other_branch)
223
self.other_basis = self.other_rev_id
224
elif other_revision[1] is not None:
225
self.other_rev_id = self.other_branch.get_rev_id(other_revision[1])
226
self.other_basis = self.other_rev_id
228
self.other_rev_id = None
229
self.other_basis = self.other_branch.last_revision()
230
if self.other_basis is None:
231
raise NoCommits(self.other_branch)
232
if self.other_branch.base != self.this_branch.base:
233
self.this_branch.fetch(self.other_branch,
234
last_revision=self.other_basis)
236
def set_other_revision(self, revision_id, other_branch):
237
"""Set 'other' based on a branch and revision id
239
:param revision_id: The revision to use for a tree
240
:param other_branch: The branch containing this tree
242
self.other_rev_id = revision_id
243
self.other_branch = other_branch
244
self.this_branch.fetch(other_branch, self.other_rev_id)
245
self.other_tree = self.revision_tree(revision_id)
246
self.other_basis = revision_id
249
self.set_base([None, None])
251
def set_base(self, base_revision):
252
"""Set the base revision to use for the merge.
254
:param base_revision: A 2-list containing a path and revision number.
256
mutter("doing merge() with no base_revision specified")
257
if base_revision == [None, None]:
259
pb = ui.ui_factory.nested_progress_bar()
261
this_repo = self.this_branch.repository
262
graph = this_repo.get_graph()
263
revisions = [ensure_null(self.this_basis),
264
ensure_null(self.other_basis)]
265
if NULL_REVISION in revisions:
266
self.base_rev_id = NULL_REVISION
268
self.base_rev_id = graph.find_unique_lca(*revisions)
269
if self.base_rev_id == NULL_REVISION:
270
raise UnrelatedBranches()
273
except NoCommonAncestor:
274
raise UnrelatedBranches()
275
self.base_tree = _get_revid_tree_from_tree(self.this_tree,
278
self.base_is_ancestor = True
280
base_branch, self.base_tree = _get_tree(base_revision)
281
if base_revision[1] == -1:
282
self.base_rev_id = base_branch.last_revision()
283
elif base_revision[1] is None:
284
self.base_rev_id = _mod_revision.NULL_REVISION
286
self.base_rev_id = _mod_revision.ensure_null(
287
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
428
winner_idx = {"this": 2, "other": 1, "conflict": 1}
430
def __init__(self, working_tree, this_tree, base_tree, other_tree,
431
interesting_ids=None, reprocess=False, show_base=False,
432
pb=DummyProgress(), pp=None, change_reporter=None,
433
interesting_files=None):
434
"""Initialize the merger object and perform the merge.
436
:param working_tree: The working tree to apply the merge to
437
:param this_tree: The local tree in the merge operation
438
:param base_tree: The common tree in the merge operation
439
:param other_tree: The other other tree to merge changes from
440
:param interesting_ids: The file_ids of files that should be
441
participate in the merge. May not be combined with
443
:param: reprocess If True, perform conflict-reduction processing.
444
:param show_base: If True, show the base revision in text conflicts.
445
(incompatible with reprocess)
446
:param pb: A Progress bar
447
:param pp: A ProgressPhase object
448
:param change_reporter: An object that should report changes made
449
:param interesting_files: The tree-relative paths of files that should
450
participate in the merge. If these paths refer to directories,
451
the contents of those directories will also be included. May not
452
be combined with interesting_ids. If neither interesting_files nor
453
interesting_ids is specified, all files may participate in the
456
object.__init__(self)
457
if interesting_files is not None:
458
assert interesting_ids is None
459
self.interesting_ids = interesting_ids
460
self.interesting_files = interesting_files
461
self.this_tree = working_tree
462
self.this_tree.lock_tree_write()
463
self.base_tree = base_tree
464
self.base_tree.lock_read()
465
self.other_tree = other_tree
466
self.other_tree.lock_read()
467
self._raw_conflicts = []
468
self.cooked_conflicts = []
469
self.reprocess = reprocess
470
self.show_base = show_base
473
self.change_reporter = change_reporter
475
self.pp = ProgressPhase("Merge phase", 3, self.pb)
477
self.tt = TreeTransform(working_tree, self.pb)
480
entries = self._entries3()
481
child_pb = ui.ui_factory.nested_progress_bar()
483
for num, (file_id, changed, parents3, names3,
484
executable3) in enumerate(entries):
485
child_pb.update('Preparing file merge', num, len(entries))
486
self._merge_names(file_id, parents3, names3)
488
file_status = self.merge_contents(file_id)
490
file_status = 'unmodified'
491
self._merge_executable(file_id,
492
executable3, file_status)
497
child_pb = ui.ui_factory.nested_progress_bar()
499
fs_conflicts = resolve_conflicts(self.tt, child_pb,
500
lambda t, c: conflict_pass(t, c, self.other_tree))
503
if change_reporter is not None:
504
from bzrlib import delta
505
delta.report_changes(self.tt._iter_changes(), change_reporter)
506
self.cook_conflicts(fs_conflicts)
507
for conflict in self.cooked_conflicts:
510
results = self.tt.apply()
511
self.write_modified(results)
513
working_tree.add_conflicts(self.cooked_conflicts)
514
except UnsupportedOperation:
518
self.other_tree.unlock()
519
self.base_tree.unlock()
520
self.this_tree.unlock()
524
"""Gather data about files modified between three trees.
526
Return a list of tuples of file_id, changed, parents3, names3,
527
executable3. changed is a boolean indicating whether the file contents
528
or kind were changed. parents3 is a tuple of parent ids for base,
529
other and this. names3 is a tuple of names for base, other and this.
530
executable3 is a tuple of execute-bit values for base, other and this.
533
iterator = self.other_tree._iter_changes(self.base_tree,
534
include_unchanged=True, specific_files=self.interesting_files,
535
extra_trees=[self.this_tree])
536
for (file_id, paths, changed, versioned, parents, names, kind,
537
executable) in iterator:
538
if (self.interesting_ids is not None and
539
file_id not in self.interesting_ids):
541
if file_id in self.this_tree.inventory:
542
entry = self.this_tree.inventory[file_id]
543
this_name = entry.name
544
this_parent = entry.parent_id
545
this_executable = entry.executable
549
this_executable = None
550
parents3 = parents + (this_parent,)
551
names3 = names + (this_name,)
552
executable3 = executable + (this_executable,)
553
result.append((file_id, changed, parents3, names3, executable3))
558
self.tt.final_kind(self.tt.root)
560
self.tt.cancel_deletion(self.tt.root)
561
if self.tt.final_file_id(self.tt.root) is None:
562
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
564
if self.other_tree.inventory.root is None:
566
other_root_file_id = self.other_tree.inventory.root.file_id
567
other_root = self.tt.trans_id_file_id(other_root_file_id)
568
if other_root == self.tt.root:
571
self.tt.final_kind(other_root)
574
self.reparent_children(self.other_tree.inventory.root, self.tt.root)
575
self.tt.cancel_creation(other_root)
576
self.tt.cancel_versioning(other_root)
578
def reparent_children(self, ie, target):
579
for thing, child in ie.children.iteritems():
580
trans_id = self.tt.trans_id_file_id(child.file_id)
581
self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
583
def write_modified(self, results):
585
for path in results.modified_paths:
586
file_id = self.this_tree.path2id(self.this_tree.relpath(path))
589
hash = self.this_tree.get_file_sha1(file_id)
592
modified_hashes[file_id] = hash
593
self.this_tree.set_merge_modified(modified_hashes)
596
def parent(entry, file_id):
597
"""Determine the parent for a file_id (used as a key method)"""
600
return entry.parent_id
603
def name(entry, file_id):
604
"""Determine the name for a file_id (used as a key method)"""
610
def contents_sha1(tree, file_id):
611
"""Determine the sha1 of the file contents (used as a key method)."""
612
if file_id not in tree:
614
return tree.get_file_sha1(file_id)
617
def executable(tree, file_id):
618
"""Determine the executability of a file-id (used as a key method)."""
619
if file_id not in tree:
621
if tree.kind(file_id) != "file":
623
return tree.is_executable(file_id)
626
def kind(tree, file_id):
627
"""Determine the kind of a file-id (used as a key method)."""
628
if file_id not in tree:
630
return tree.kind(file_id)
633
def _three_way(base, other, this):
634
#if base == other, either they all agree, or only THIS has changed.
637
elif this not in (base, other):
639
# "Ambiguous clean merge" -- both sides have made the same change.
642
# this == base: only other has changed.
647
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
648
"""Do a three-way test on a scalar.
649
Return "this", "other" or "conflict", depending whether a value wins.
651
key_base = key(base_tree, file_id)
652
key_other = key(other_tree, file_id)
653
#if base == other, either they all agree, or only THIS has changed.
654
if key_base == key_other:
656
key_this = key(this_tree, file_id)
657
if key_this not in (key_base, key_other):
659
# "Ambiguous clean merge"
660
elif key_this == key_other:
663
assert key_this == key_base
666
def merge_names(self, file_id):
668
if file_id in tree.inventory:
669
return tree.inventory[file_id]
672
this_entry = get_entry(self.this_tree)
673
other_entry = get_entry(self.other_tree)
674
base_entry = get_entry(self.base_tree)
675
entries = (base_entry, other_entry, this_entry)
678
for entry in entries:
683
names.append(entry.name)
684
parents.append(entry.parent_id)
685
return self._merge_names(file_id, parents, names)
687
def _merge_names(self, file_id, parents, names):
688
"""Perform a merge on file_id names and parents"""
689
base_name, other_name, this_name = names
690
base_parent, other_parent, this_parent = parents
692
name_winner = self._three_way(*names)
694
parent_id_winner = self._three_way(*parents)
695
if this_name is None:
696
if name_winner == "this":
697
name_winner = "other"
698
if parent_id_winner == "this":
699
parent_id_winner = "other"
700
if name_winner == "this" and parent_id_winner == "this":
702
if name_winner == "conflict":
703
trans_id = self.tt.trans_id_file_id(file_id)
704
self._raw_conflicts.append(('name conflict', trans_id,
705
this_name, other_name))
706
if parent_id_winner == "conflict":
707
trans_id = self.tt.trans_id_file_id(file_id)
708
self._raw_conflicts.append(('parent conflict', trans_id,
709
this_parent, other_parent))
710
if other_name is None:
711
# it doesn't matter whether the result was 'other' or
712
# 'conflict'-- if there's no 'other', we leave it alone.
714
# if we get here, name_winner and parent_winner are set to safe values.
715
trans_id = self.tt.trans_id_file_id(file_id)
716
parent_id = parents[self.winner_idx[parent_id_winner]]
717
if parent_id is not None:
718
parent_trans_id = self.tt.trans_id_file_id(parent_id)
719
self.tt.adjust_path(names[self.winner_idx[name_winner]],
720
parent_trans_id, trans_id)
722
def merge_contents(self, file_id):
723
"""Performa a merge on file_id contents."""
724
def contents_pair(tree):
725
if file_id not in tree:
727
kind = tree.kind(file_id)
729
contents = tree.get_file_sha1(file_id)
730
elif kind == "symlink":
731
contents = tree.get_symlink_target(file_id)
734
return kind, contents
736
def contents_conflict():
737
trans_id = self.tt.trans_id_file_id(file_id)
738
name = self.tt.final_name(trans_id)
739
parent_id = self.tt.final_parent(trans_id)
740
if file_id in self.this_tree.inventory:
741
self.tt.unversion_file(trans_id)
742
if file_id in self.this_tree:
743
self.tt.delete_contents(trans_id)
744
file_group = self._dump_conflicts(name, parent_id, file_id,
746
self._raw_conflicts.append(('contents conflict', file_group))
748
# See SPOT run. run, SPOT, run.
749
# So we're not QUITE repeating ourselves; we do tricky things with
751
base_pair = contents_pair(self.base_tree)
752
other_pair = contents_pair(self.other_tree)
753
if base_pair == other_pair:
754
# OTHER introduced no changes
756
this_pair = contents_pair(self.this_tree)
757
if this_pair == other_pair:
758
# THIS and OTHER introduced the same changes
761
trans_id = self.tt.trans_id_file_id(file_id)
762
if this_pair == base_pair:
763
# only OTHER introduced changes
764
if file_id in self.this_tree:
765
# Remove any existing contents
766
self.tt.delete_contents(trans_id)
767
if file_id in self.other_tree:
768
# OTHER changed the file
769
create_by_entry(self.tt,
770
self.other_tree.inventory[file_id],
771
self.other_tree, trans_id)
772
if file_id not in self.this_tree.inventory:
773
self.tt.version_file(file_id, trans_id)
775
elif file_id in self.this_tree.inventory:
776
# OTHER deleted the file
777
self.tt.unversion_file(trans_id)
779
#BOTH THIS and OTHER introduced changes; scalar conflict
780
elif this_pair[0] == "file" and other_pair[0] == "file":
781
# THIS and OTHER are both files, so text merge. Either
782
# BASE is a file, or both converted to files, so at least we
783
# have agreement that output should be a file.
785
self.text_merge(file_id, trans_id)
787
return contents_conflict()
788
if file_id not in self.this_tree.inventory:
789
self.tt.version_file(file_id, trans_id)
791
self.tt.tree_kind(trans_id)
792
self.tt.delete_contents(trans_id)
797
# Scalar conflict, can't text merge. Dump conflicts
798
return contents_conflict()
800
def get_lines(self, tree, file_id):
801
"""Return the lines in a file, or an empty list."""
803
return tree.get_file(file_id).readlines()
807
def text_merge(self, file_id, trans_id):
808
"""Perform a three-way text merge on a file_id"""
809
# it's possible that we got here with base as a different type.
810
# if so, we just want two-way text conflicts.
811
if file_id in self.base_tree and \
812
self.base_tree.kind(file_id) == "file":
813
base_lines = self.get_lines(self.base_tree, file_id)
816
other_lines = self.get_lines(self.other_tree, file_id)
817
this_lines = self.get_lines(self.this_tree, file_id)
818
m3 = Merge3(base_lines, this_lines, other_lines)
819
start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
820
if self.show_base is True:
821
base_marker = '|' * 7
825
def iter_merge3(retval):
826
retval["text_conflicts"] = False
827
for line in m3.merge_lines(name_a = "TREE",
828
name_b = "MERGE-SOURCE",
829
name_base = "BASE-REVISION",
830
start_marker=start_marker,
831
base_marker=base_marker,
832
reprocess=self.reprocess):
833
if line.startswith(start_marker):
834
retval["text_conflicts"] = True
835
yield line.replace(start_marker, '<' * 7)
839
merge3_iterator = iter_merge3(retval)
840
self.tt.create_file(merge3_iterator, trans_id)
841
if retval["text_conflicts"] is True:
842
self._raw_conflicts.append(('text conflict', trans_id))
843
name = self.tt.final_name(trans_id)
844
parent_id = self.tt.final_parent(trans_id)
845
file_group = self._dump_conflicts(name, parent_id, file_id,
846
this_lines, base_lines,
848
file_group.append(trans_id)
850
def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
851
base_lines=None, other_lines=None, set_version=False,
853
"""Emit conflict files.
854
If this_lines, base_lines, or other_lines are omitted, they will be
855
determined automatically. If set_version is true, the .OTHER, .THIS
856
or .BASE (in that order) will be created as versioned files.
858
data = [('OTHER', self.other_tree, other_lines),
859
('THIS', self.this_tree, this_lines)]
861
data.append(('BASE', self.base_tree, base_lines))
864
for suffix, tree, lines in data:
866
trans_id = self._conflict_file(name, parent_id, tree, file_id,
868
file_group.append(trans_id)
869
if set_version and not versioned:
870
self.tt.version_file(file_id, trans_id)
874
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
876
"""Emit a single conflict file."""
877
name = name + '.' + suffix
878
trans_id = self.tt.create_path(name, parent_id)
879
entry = tree.inventory[file_id]
880
create_by_entry(self.tt, entry, tree, trans_id, lines)
883
def merge_executable(self, file_id, file_status):
884
"""Perform a merge on the execute bit."""
885
executable = [self.executable(t, file_id) for t in (self.base_tree,
886
self.other_tree, self.this_tree)]
887
self._merge_executable(file_id, executable, file_status)
889
def _merge_executable(self, file_id, executable, file_status):
890
"""Perform a merge on the execute bit."""
891
base_executable, other_executable, this_executable = executable
892
if file_status == "deleted":
894
trans_id = self.tt.trans_id_file_id(file_id)
896
if self.tt.final_kind(trans_id) != "file":
900
winner = self._three_way(*executable)
901
if winner == "conflict":
902
# There must be a None in here, if we have a conflict, but we
903
# need executability since file status was not deleted.
904
if self.executable(self.other_tree, file_id) is None:
909
if file_status == "modified":
910
executability = this_executable
911
if executability is not None:
912
trans_id = self.tt.trans_id_file_id(file_id)
913
self.tt.set_executability(executability, trans_id)
915
assert winner == "other"
916
if file_id in self.other_tree:
917
executability = other_executable
918
elif file_id in self.this_tree:
919
executability = this_executable
920
elif file_id in self.base_tree:
921
executability = base_executable
922
if executability is not None:
923
trans_id = self.tt.trans_id_file_id(file_id)
924
self.tt.set_executability(executability, trans_id)
926
def cook_conflicts(self, fs_conflicts):
927
"""Convert all conflicts into a form that doesn't depend on trans_id"""
928
from conflicts import Conflict
930
self.cooked_conflicts.extend(cook_conflicts(fs_conflicts, self.tt))
931
fp = FinalPaths(self.tt)
932
for conflict in self._raw_conflicts:
933
conflict_type = conflict[0]
934
if conflict_type in ('name conflict', 'parent conflict'):
935
trans_id = conflict[1]
936
conflict_args = conflict[2:]
937
if trans_id not in name_conflicts:
938
name_conflicts[trans_id] = {}
939
unique_add(name_conflicts[trans_id], conflict_type,
941
if conflict_type == 'contents conflict':
942
for trans_id in conflict[1]:
943
file_id = self.tt.final_file_id(trans_id)
944
if file_id is not None:
946
path = fp.get_path(trans_id)
947
for suffix in ('.BASE', '.THIS', '.OTHER'):
948
if path.endswith(suffix):
949
path = path[:-len(suffix)]
951
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
952
self.cooked_conflicts.append(c)
953
if conflict_type == 'text conflict':
954
trans_id = conflict[1]
955
path = fp.get_path(trans_id)
956
file_id = self.tt.final_file_id(trans_id)
957
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
958
self.cooked_conflicts.append(c)
960
for trans_id, conflicts in name_conflicts.iteritems():
962
this_parent, other_parent = conflicts['parent conflict']
963
assert this_parent != other_parent
965
this_parent = other_parent = \
966
self.tt.final_file_id(self.tt.final_parent(trans_id))
968
this_name, other_name = conflicts['name conflict']
969
assert this_name != other_name
971
this_name = other_name = self.tt.final_name(trans_id)
972
other_path = fp.get_path(trans_id)
973
if this_parent is not None and this_name is not None:
975
fp.get_path(self.tt.trans_id_file_id(this_parent))
976
this_path = pathjoin(this_parent_path, this_name)
978
this_path = "<deleted>"
979
file_id = self.tt.final_file_id(trans_id)
980
c = Conflict.factory('path conflict', path=this_path,
981
conflict_path=other_path, file_id=file_id)
982
self.cooked_conflicts.append(c)
983
self.cooked_conflicts.sort(key=Conflict.sort_key)
986
class WeaveMerger(Merge3Merger):
987
"""Three-way tree merger, text weave merger."""
988
supports_reprocess = True
989
supports_show_base = False
991
def __init__(self, working_tree, this_tree, base_tree, other_tree,
992
interesting_ids=None, pb=DummyProgress(), pp=None,
993
reprocess=False, change_reporter=None,
994
interesting_files=None):
995
self.this_revision_tree = self._get_revision_tree(this_tree)
996
self.other_revision_tree = self._get_revision_tree(other_tree)
997
super(WeaveMerger, self).__init__(working_tree, this_tree,
998
base_tree, other_tree,
999
interesting_ids=interesting_ids,
1000
pb=pb, pp=pp, reprocess=reprocess,
1001
change_reporter=change_reporter)
1003
def _get_revision_tree(self, tree):
1004
"""Return a revision tree related to this tree.
1005
If the tree is a WorkingTree, the basis will be returned.
1007
if getattr(tree, 'get_weave', False) is False:
1008
# If we have a WorkingTree, try using the basis
1009
return tree.branch.basis_tree()
1013
def _check_file(self, file_id):
1014
"""Check that the revision tree's version of the file matches."""
1015
for tree, rt in ((self.this_tree, self.this_revision_tree),
1016
(self.other_tree, self.other_revision_tree)):
1019
if tree.get_file_sha1(file_id) != rt.get_file_sha1(file_id):
1020
raise WorkingTreeNotRevision(self.this_tree)
1022
def _merged_lines(self, file_id):
1023
"""Generate the merged lines.
1024
There is no distinction between lines that are meant to contain <<<<<<<
1027
weave = self.this_revision_tree.get_weave(file_id)
1028
this_revision_id = self.this_revision_tree.inventory[file_id].revision
1029
other_revision_id = \
1030
self.other_revision_tree.inventory[file_id].revision
1031
wm = WeaveMerge(weave, this_revision_id, other_revision_id,
1032
'<<<<<<< TREE\n', '>>>>>>> MERGE-SOURCE\n')
1033
return wm.merge_lines(self.reprocess)
1035
def text_merge(self, file_id, trans_id):
1036
"""Perform a (weave) text merge for a given file and file-id.
1037
If conflicts are encountered, .THIS and .OTHER files will be emitted,
1038
and a conflict will be noted.
1040
self._check_file(file_id)
1041
lines, conflicts = self._merged_lines(file_id)
1043
# Note we're checking whether the OUTPUT is binary in this case,
1044
# because we don't want to get into weave merge guts.
1045
check_text_lines(lines)
1046
self.tt.create_file(lines, trans_id)
1048
self._raw_conflicts.append(('text conflict', trans_id))
1049
name = self.tt.final_name(trans_id)
1050
parent_id = self.tt.final_parent(trans_id)
1051
file_group = self._dump_conflicts(name, parent_id, file_id,
1053
file_group.append(trans_id)
1056
class Diff3Merger(Merge3Merger):
1057
"""Three-way merger using external diff3 for text merging"""
1059
def dump_file(self, temp_dir, name, tree, file_id):
1060
out_path = pathjoin(temp_dir, name)
1061
out_file = open(out_path, "wb")
1063
in_file = tree.get_file(file_id)
1064
for line in in_file:
1065
out_file.write(line)
1070
def text_merge(self, file_id, trans_id):
1071
"""Perform a diff3 merge using a specified file-id and trans-id.
1072
If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
1073
will be dumped, and a will be conflict noted.
1076
temp_dir = osutils.mkdtemp(prefix="bzr-")
1078
new_file = pathjoin(temp_dir, "new")
1079
this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
1080
base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
1081
other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
1082
status = bzrlib.patch.diff3(new_file, this, base, other)
1083
if status not in (0, 1):
1084
raise BzrError("Unhandled diff3 exit code")
1085
f = open(new_file, 'rb')
1087
self.tt.create_file(f, trans_id)
1091
name = self.tt.final_name(trans_id)
1092
parent_id = self.tt.final_parent(trans_id)
1093
self._dump_conflicts(name, parent_id, file_id)
1094
self._raw_conflicts.append(('text conflict', trans_id))
1096
osutils.rmtree(temp_dir)
1099
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1101
merge_type=Merge3Merger,
1102
interesting_ids=None,
1106
interesting_files=None,
1109
change_reporter=None):
1110
"""Primary interface for merging.
1112
typical use is probably
1113
'merge_inner(branch, branch.get_revision_tree(other_revision),
1114
branch.get_revision_tree(base_revision))'
1116
if this_tree is None:
1117
raise BzrError("bzrlib.merge.merge_inner requires a this_tree "
1118
"parameter as of bzrlib version 0.8.")
1119
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1120
pb=pb, change_reporter=change_reporter)
1121
merger.backup_files = backup_files
1122
merger.merge_type = merge_type
1123
merger.interesting_ids = interesting_ids
1124
merger.ignore_zero = ignore_zero
1125
if interesting_files:
1126
assert not interesting_ids, ('Only supply interesting_ids'
1127
' or interesting_files')
1128
merger.interesting_files = interesting_files
1129
merger.show_base = show_base
1130
merger.reprocess = reprocess
1131
merger.other_rev_id = other_rev_id
1132
merger.other_basis = other_rev_id
1133
return merger.do_merge()
1135
def get_merge_type_registry():
1136
"""Merge type registry is in bzrlib.option to avoid circular imports.
1138
This method provides a sanctioned way to retrieve it.
1140
from bzrlib import option
1141
return option._merge_type_registry
added
removed
bzrlib/merge.py
