1
from merge_core import merge_flex, ApplyMerge3, BackupBeforeChange
2
from changeset import generate_changeset, ExceptionConflictHandler
3
from changeset import Inventory, Diff3Merge
4
from bzrlib import find_branch
6
from bzrlib.errors import BzrCommandError
7
from bzrlib.delta import compare_trees
8
from trace import mutter, warning
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
14
class UnrelatedBranches(BzrCommandError):
16
msg = "Branches have no common ancestor, and no base revision"\
18
BzrCommandError.__init__(self, msg)
21
class MergeConflictHandler(ExceptionConflictHandler):
22
"""Handle conflicts encountered while merging"""
23
def __init__(self, dir, ignore_zero=False):
24
ExceptionConflictHandler.__init__(self, dir)
26
self.ignore_zero = ignore_zero
28
def copy(self, source, dest):
29
"""Copy the text and mode of a file
30
:param source: The path of the file to copy
31
:param dest: The distination file to create
33
s_file = file(source, "rb")
34
d_file = file(dest, "wb")
37
os.chmod(dest, 0777 & os.stat(source).st_mode)
39
def add_suffix(self, name, suffix, last_new_name=None):
40
"""Rename a file to append a suffix. If the new name exists, the
41
suffix is added repeatedly until a non-existant name is found
43
:param name: The path of the file
44
:param suffix: The suffix to append
45
:param last_new_name: (used for recursive calls) the last name tried
47
if last_new_name is None:
49
new_name = last_new_name+suffix
51
os.rename(name, new_name)
54
if e.errno != errno.EEXIST and e.errno != errno.ENOTEMPTY:
56
return self.add_suffix(name, suffix, last_new_name=new_name)
58
def conflict(self, text):
63
def merge_conflict(self, new_file, this_path, base_path, other_path):
65
Handle diff3 conflicts by producing a .THIS, .BASE and .OTHER. The
66
main file will be a version with diff3 conflicts.
67
:param new_file: Path to the output file with diff3 markers
68
:param this_path: Path to the file text for the THIS tree
69
:param base_path: Path to the file text for the BASE tree
70
:param other_path: Path to the file text for the OTHER tree
72
self.add_suffix(this_path, ".THIS")
73
self.copy(base_path, this_path+".BASE")
74
self.copy(other_path, this_path+".OTHER")
75
os.rename(new_file, this_path)
76
self.conflict("Diff3 conflict encountered in %s" % this_path)
78
def target_exists(self, entry, target, old_path):
79
"""Handle the case when the target file or dir exists"""
80
moved_path = self.add_suffix(target, ".moved")
81
self.conflict("Moved existing %s to %s" % (target, moved_path))
83
def rmdir_non_empty(self, filename):
84
"""Handle the case where the dir to be removed still has contents"""
85
self.conflict("Directory %s not removed because it is not empty"\
90
if not self.ignore_zero:
91
print "%d conflicts encountered.\n" % self.conflicts
93
class SourceFile(object):
94
def __init__(self, path, id, present=None, isdir=None):
97
self.present = present
99
self.interesting = True
102
return "SourceFile(%s, %s)" % (self.path, self.id)
104
def get_tree(treespec, temp_root, label):
25
from bzrlib.branch import Branch
26
from bzrlib.conflicts import ConflictList, Conflict
27
from bzrlib.errors import (BzrCommandError,
37
WorkingTreeNotRevision,
40
from bzrlib.merge3 import Merge3
41
from bzrlib.osutils import rename, pathjoin
42
from progress import DummyProgress, ProgressPhase
43
from bzrlib.revision import common_ancestor, is_ancestor, NULL_REVISION
44
from bzrlib.textfile import check_text_lines
45
from bzrlib.trace import mutter, warning, note
46
from bzrlib.transform import (TreeTransform, resolve_conflicts, cook_conflicts,
47
FinalPaths, create_by_entry, unique_add,
49
from bzrlib.versionedfile import WeaveMerge
52
# TODO: Report back as changes are merged in
54
def _get_tree(treespec, local_branch=None):
55
from bzrlib import workingtree
105
56
location, revno = treespec
106
branch = find_branch(location)
108
base_tree = branch.working_tree()
110
base_tree = branch.basis_tree()
112
base_tree = branch.revision_tree(branch.lookup_revision(revno))
113
temp_path = os.path.join(temp_root, label)
115
return branch, MergeTree(base_tree, temp_path)
118
def abspath(tree, file_id):
119
path = tree.inventory.id2path(file_id)
124
def file_exists(tree, file_id):
125
return tree.has_filename(tree.id2path(file_id))
127
def inventory_map(tree):
129
for file_id in tree.inventory:
130
path = abspath(tree, file_id)
131
inventory[path] = SourceFile(path, file_id)
135
class MergeTree(object):
136
def __init__(self, tree, tempdir):
58
tree = workingtree.WorkingTree.open_containing(location)[0]
59
return tree.branch, tree
60
branch = Branch.open_containing(location)[0]
62
revision = branch.last_revision()
64
revision = branch.get_rev_id(revno)
66
revision = NULL_REVISION
67
return branch, _get_revid_tree(branch, revision, local_branch)
70
def _get_revid_tree(branch, revision, local_branch):
72
base_tree = branch.bzrdir.open_workingtree()
74
if local_branch is not None:
75
if local_branch.base != branch.base:
76
local_branch.fetch(branch, revision)
77
base_tree = local_branch.repository.revision_tree(revision)
79
base_tree = branch.repository.revision_tree(revision)
83
def transform_tree(from_tree, to_tree, interesting_ids=None):
84
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
85
interesting_ids=interesting_ids, this_tree=from_tree)
89
def __init__(self, this_branch, other_tree=None, base_tree=None,
90
this_tree=None, pb=DummyProgress(), change_reporter=None):
137
91
object.__init__(self)
138
if hasattr(tree, "basedir"):
139
self.root = tree.basedir
142
self.inventory = inventory_map(tree)
144
self.tempdir = tempdir
145
os.mkdir(os.path.join(self.tempdir, "texts"))
148
def readonly_path(self, id):
149
if id not in self.tree:
151
if self.root is not None:
152
return self.tree.abspath(self.tree.id2path(id))
154
if self.tree.inventory[id].kind in ("directory", "root_directory"):
156
if not self.cached.has_key(id):
157
path = os.path.join(self.tempdir, "texts", id)
158
outfile = file(path, "wb")
159
outfile.write(self.tree.get_file(id).read())
160
assert(os.path.exists(path))
161
self.cached[id] = path
162
return self.cached[id]
166
def merge(other_revision, base_revision,
167
check_clean=True, ignore_zero=False,
168
this_dir=None, backup_files=False, merge_type=ApplyMerge3,
170
"""Merge changes into a tree.
173
Base for three-way merge.
175
Other revision for three-way merge.
177
Directory to merge changes into; '.' by default.
179
If true, this_dir must have no uncommitted changes before the
182
tempdir = tempfile.mkdtemp(prefix="bzr-")
186
this_branch = find_branch(this_dir)
92
assert this_tree is not None, "this_tree is required"
93
self.this_branch = this_branch
94
self.this_basis = this_branch.last_revision()
95
self.this_rev_id = None
96
self.this_tree = this_tree
97
self.this_revision_tree = None
98
self.this_basis_tree = None
99
self.other_tree = other_tree
100
self.base_tree = base_tree
101
self.ignore_zero = False
102
self.backup_files = False
103
self.interesting_ids = None
104
self.show_base = False
105
self.reprocess = False
108
self.change_reporter = change_reporter
110
def revision_tree(self, revision_id):
111
return self.this_branch.repository.revision_tree(revision_id)
113
def ensure_revision_trees(self):
114
if self.this_revision_tree is None:
115
self.this_basis_tree = self.this_branch.repository.revision_tree(
117
if self.this_basis == self.this_rev_id:
118
self.this_revision_tree = self.this_basis_tree
120
if self.other_rev_id is None:
121
other_basis_tree = self.revision_tree(self.other_basis)
122
changes = other_basis_tree.changes_from(self.other_tree)
123
if changes.has_changed():
124
raise WorkingTreeNotRevision(self.this_tree)
125
other_rev_id = self.other_basis
126
self.other_tree = other_basis_tree
128
def file_revisions(self, file_id):
129
self.ensure_revision_trees()
130
def get_id(tree, file_id):
131
revision_id = tree.inventory[file_id].revision
132
assert revision_id is not None
134
if self.this_rev_id is None:
135
if self.this_basis_tree.get_file_sha1(file_id) != \
136
self.this_tree.get_file_sha1(file_id):
137
raise WorkingTreeNotRevision(self.this_tree)
139
trees = (self.this_basis_tree, self.other_tree)
140
return [get_id(tree, file_id) for tree in trees]
142
def check_basis(self, check_clean, require_commits=True):
143
if self.this_basis is None and require_commits is True:
144
raise BzrCommandError("This branch has no commits."
145
" (perhaps you would prefer 'bzr pull')")
188
changes = compare_trees(this_branch.working_tree(),
189
this_branch.basis_tree(), False)
190
if changes.has_changed():
148
if self.this_basis != self.this_rev_id:
191
149
raise BzrCommandError("Working tree has uncommitted changes.")
192
other_branch, other_tree = get_tree(other_revision, tempdir, "other")
151
def compare_basis(self):
152
changes = self.this_tree.changes_from(self.this_tree.basis_tree())
153
if not changes.has_changed():
154
self.this_rev_id = self.this_basis
156
def set_interesting_files(self, file_list):
158
self._set_interesting_files(file_list)
159
except NotVersionedError, e:
160
raise BzrCommandError("%s is not a source file in any"
163
def _set_interesting_files(self, file_list):
164
"""Set the list of interesting ids from a list of files."""
165
if file_list is None:
166
self.interesting_ids = None
169
interesting_ids = set()
170
for path in file_list:
172
for tree in (self.this_tree, self.base_tree, self.other_tree):
173
file_id = tree.inventory.path2id(path)
174
if file_id is not None:
175
interesting_ids.add(file_id)
178
raise NotVersionedError(path=path)
179
self.interesting_ids = interesting_ids
181
def set_pending(self):
182
if not self.base_is_ancestor:
184
if self.other_rev_id is None:
186
ancestry = self.this_branch.repository.get_ancestry(self.this_basis)
187
if self.other_rev_id in ancestry:
189
self.this_tree.add_parent_tree((self.other_rev_id, self.other_tree))
191
def set_other(self, other_revision):
192
"""Set the revision and tree to merge from.
194
This sets the other_tree, other_rev_id, other_basis attributes.
196
:param other_revision: The [path, revision] list to merge from.
198
other_branch, self.other_tree = _get_tree(other_revision,
200
if other_revision[1] == -1:
201
self.other_rev_id = other_branch.last_revision()
202
if self.other_rev_id is None:
203
raise NoCommits(other_branch)
204
self.other_basis = self.other_rev_id
205
elif other_revision[1] is not None:
206
self.other_rev_id = other_branch.get_rev_id(other_revision[1])
207
self.other_basis = self.other_rev_id
209
self.other_rev_id = None
210
self.other_basis = other_branch.last_revision()
211
if self.other_basis is None:
212
raise NoCommits(other_branch)
213
if other_branch.base != self.this_branch.base:
214
self.this_branch.fetch(other_branch, last_revision=self.other_basis)
217
self.set_base([None, None])
219
def set_base(self, base_revision):
220
"""Set the base revision to use for the merge.
222
:param base_revision: A 2-list containing a path and revision number.
224
mutter("doing merge() with no base_revision specified")
193
225
if base_revision == [None, None]:
194
if other_revision[1] == -1:
197
o_revno = other_revision[1]
198
base_revno = this_branch.common_ancestor(other_branch,
199
other_revno=o_revno)[0]
200
if base_revno is None:
227
pb = ui.ui_factory.nested_progress_bar()
229
this_repo = self.this_branch.repository
230
self.base_rev_id = common_ancestor(self.this_basis,
235
except NoCommonAncestor:
201
236
raise UnrelatedBranches()
202
base_revision = ['.', base_revno]
203
base_branch, base_tree = get_tree(base_revision, tempdir, "base")
204
if file_list is None:
205
interesting_ids = None
207
interesting_ids = set()
208
this_tree = this_branch.working_tree()
209
for fname in file_list:
210
path = this_branch.relpath(fname)
212
for tree in (this_tree, base_tree.tree, other_tree.tree):
213
file_id = tree.inventory.path2id(path)
237
self.base_tree = _get_revid_tree(self.this_branch, self.base_rev_id,
239
self.base_is_ancestor = True
241
base_branch, self.base_tree = _get_tree(base_revision)
242
if base_revision[1] == -1:
243
self.base_rev_id = base_branch.last_revision()
244
elif base_revision[1] is None:
245
self.base_rev_id = None
247
self.base_rev_id = base_branch.get_rev_id(base_revision[1])
248
if self.this_branch.base != base_branch.base:
249
self.this_branch.fetch(base_branch)
250
self.base_is_ancestor = is_ancestor(self.this_basis,
255
kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
256
'other_tree': self.other_tree,
257
'interesting_ids': self.interesting_ids,
259
if self.merge_type.requires_base:
260
kwargs['base_tree'] = self.base_tree
261
if self.merge_type.supports_reprocess:
262
kwargs['reprocess'] = self.reprocess
264
raise BzrError("Conflict reduction is not supported for merge"
265
" type %s." % self.merge_type)
266
if self.merge_type.supports_show_base:
267
kwargs['show_base'] = self.show_base
269
raise BzrError("Showing base is not supported for this"
270
" merge type. %s" % self.merge_type)
271
merge = self.merge_type(pb=self._pb,
272
change_reporter=self.change_reporter,
274
if len(merge.cooked_conflicts) == 0:
275
if not self.ignore_zero:
276
note("All changes applied successfully.")
278
note("%d conflicts encountered." % len(merge.cooked_conflicts))
280
return len(merge.cooked_conflicts)
282
def regen_inventory(self, new_entries):
283
old_entries = self.this_tree.read_working_inventory()
287
for path, file_id in new_entries:
290
new_entries_map[file_id] = path
292
def id2path(file_id):
293
path = new_entries_map.get(file_id)
296
entry = old_entries[file_id]
297
if entry.parent_id is None:
299
return pathjoin(id2path(entry.parent_id), entry.name)
301
for file_id in old_entries:
302
entry = old_entries[file_id]
303
path = id2path(file_id)
304
if file_id in self.base_tree.inventory:
305
executable = getattr(self.base_tree.inventory[file_id], 'executable', False)
307
executable = getattr(entry, 'executable', False)
308
new_inventory[file_id] = (path, file_id, entry.parent_id,
309
entry.kind, executable)
311
by_path[path] = file_id
316
for path, file_id in new_entries:
318
del new_inventory[file_id]
321
new_path_list.append((path, file_id))
322
if file_id not in old_entries:
324
# Ensure no file is added before its parent
326
for path, file_id in new_path_list:
330
parent = by_path[os.path.dirname(path)]
331
abspath = pathjoin(self.this_tree.basedir, path)
332
kind = osutils.file_kind(abspath)
333
if file_id in self.base_tree.inventory:
334
executable = getattr(self.base_tree.inventory[file_id], 'executable', False)
337
new_inventory[file_id] = (path, file_id, parent, kind, executable)
338
by_path[path] = file_id
340
# Get a list in insertion order
341
new_inventory_list = new_inventory.values()
342
mutter ("""Inventory regeneration:
343
old length: %i insertions: %i deletions: %i new_length: %i"""\
344
% (len(old_entries), insertions, deletions,
345
len(new_inventory_list)))
346
assert len(new_inventory_list) == len(old_entries) + insertions\
348
new_inventory_list.sort()
349
return new_inventory_list
352
class Merge3Merger(object):
353
"""Three-way merger that uses the merge3 text merger"""
355
supports_reprocess = True
356
supports_show_base = True
357
history_based = False
359
def __init__(self, working_tree, this_tree, base_tree, other_tree,
360
interesting_ids=None, reprocess=False, show_base=False,
361
pb=DummyProgress(), pp=None, change_reporter=None):
362
"""Initialize the merger object and perform the merge."""
363
object.__init__(self)
364
self.this_tree = working_tree
365
self.base_tree = base_tree
366
self.other_tree = other_tree
367
self._raw_conflicts = []
368
self.cooked_conflicts = []
369
self.reprocess = reprocess
370
self.show_base = show_base
373
self.change_reporter = change_reporter
375
self.pp = ProgressPhase("Merge phase", 3, self.pb)
377
if interesting_ids is not None:
378
all_ids = interesting_ids
380
all_ids = set(base_tree)
381
all_ids.update(other_tree)
382
working_tree.lock_tree_write()
383
self.tt = TreeTransform(working_tree, self.pb)
386
child_pb = ui.ui_factory.nested_progress_bar()
388
for num, file_id in enumerate(all_ids):
389
child_pb.update('Preparing file merge', num, len(all_ids))
390
self.merge_names(file_id)
391
file_status = self.merge_contents(file_id)
392
self.merge_executable(file_id, file_status)
397
child_pb = ui.ui_factory.nested_progress_bar()
399
fs_conflicts = resolve_conflicts(self.tt, child_pb)
402
if change_reporter is not None:
404
delta.report_changes(self.tt._iter_changes(), change_reporter)
405
self.cook_conflicts(fs_conflicts)
406
for conflict in self.cooked_conflicts:
409
results = self.tt.apply()
410
self.write_modified(results)
412
working_tree.add_conflicts(self.cooked_conflicts)
413
except UnsupportedOperation:
417
working_tree.unlock()
422
self.tt.final_kind(self.tt.root)
424
self.tt.cancel_deletion(self.tt.root)
425
if self.tt.final_file_id(self.tt.root) is None:
426
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
428
if self.other_tree.inventory.root is None:
430
other_root_file_id = self.other_tree.inventory.root.file_id
431
other_root = self.tt.trans_id_file_id(other_root_file_id)
432
if other_root == self.tt.root:
435
self.tt.final_kind(other_root)
438
self.reparent_children(self.other_tree.inventory.root, self.tt.root)
439
self.tt.cancel_creation(other_root)
440
self.tt.cancel_versioning(other_root)
442
def reparent_children(self, ie, target):
443
for thing, child in ie.children.iteritems():
444
trans_id = self.tt.trans_id_file_id(child.file_id)
445
self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
447
def write_modified(self, results):
449
for path in results.modified_paths:
450
file_id = self.this_tree.path2id(self.this_tree.relpath(path))
453
hash = self.this_tree.get_file_sha1(file_id)
456
modified_hashes[file_id] = hash
457
self.this_tree.set_merge_modified(modified_hashes)
460
def parent(entry, file_id):
461
"""Determine the parent for a file_id (used as a key method)"""
464
return entry.parent_id
467
def name(entry, file_id):
468
"""Determine the name for a file_id (used as a key method)"""
474
def contents_sha1(tree, file_id):
475
"""Determine the sha1 of the file contents (used as a key method)."""
476
if file_id not in tree:
478
return tree.get_file_sha1(file_id)
481
def executable(tree, file_id):
482
"""Determine the executability of a file-id (used as a key method)."""
483
if file_id not in tree:
485
if tree.kind(file_id) != "file":
487
return tree.is_executable(file_id)
490
def kind(tree, file_id):
491
"""Determine the kind of a file-id (used as a key method)."""
492
if file_id not in tree:
494
return tree.kind(file_id)
497
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
498
"""Do a three-way test on a scalar.
499
Return "this", "other" or "conflict", depending whether a value wins.
501
key_base = key(base_tree, file_id)
502
key_other = key(other_tree, file_id)
503
#if base == other, either they all agree, or only THIS has changed.
504
if key_base == key_other:
506
key_this = key(this_tree, file_id)
507
if key_this not in (key_base, key_other):
509
# "Ambiguous clean merge"
510
elif key_this == key_other:
513
assert key_this == key_base
516
def merge_names(self, file_id):
517
"""Perform a merge on file_id names and parents"""
519
if file_id in tree.inventory:
520
return tree.inventory[file_id]
523
this_entry = get_entry(self.this_tree)
524
other_entry = get_entry(self.other_tree)
525
base_entry = get_entry(self.base_tree)
526
name_winner = self.scalar_three_way(this_entry, base_entry,
527
other_entry, file_id, self.name)
528
parent_id_winner = self.scalar_three_way(this_entry, base_entry,
529
other_entry, file_id,
531
if this_entry is None:
532
if name_winner == "this":
533
name_winner = "other"
534
if parent_id_winner == "this":
535
parent_id_winner = "other"
536
if name_winner == "this" and parent_id_winner == "this":
538
if name_winner == "conflict":
539
trans_id = self.tt.trans_id_file_id(file_id)
540
self._raw_conflicts.append(('name conflict', trans_id,
541
self.name(this_entry, file_id),
542
self.name(other_entry, file_id)))
543
if parent_id_winner == "conflict":
544
trans_id = self.tt.trans_id_file_id(file_id)
545
self._raw_conflicts.append(('parent conflict', trans_id,
546
self.parent(this_entry, file_id),
547
self.parent(other_entry, file_id)))
548
if other_entry is None:
549
# it doesn't matter whether the result was 'other' or
550
# 'conflict'-- if there's no 'other', we leave it alone.
552
# if we get here, name_winner and parent_winner are set to safe values.
553
winner_entry = {"this": this_entry, "other": other_entry,
554
"conflict": other_entry}
555
trans_id = self.tt.trans_id_file_id(file_id)
556
parent_id = winner_entry[parent_id_winner].parent_id
557
if parent_id is not None:
558
parent_trans_id = self.tt.trans_id_file_id(parent_id)
559
self.tt.adjust_path(winner_entry[name_winner].name,
560
parent_trans_id, trans_id)
562
def merge_contents(self, file_id):
563
"""Performa a merge on file_id contents."""
564
def contents_pair(tree):
565
if file_id not in tree:
567
kind = tree.kind(file_id)
569
contents = tree.get_file_sha1(file_id)
570
elif kind == "symlink":
571
contents = tree.get_symlink_target(file_id)
574
return kind, contents
576
def contents_conflict():
577
trans_id = self.tt.trans_id_file_id(file_id)
578
name = self.tt.final_name(trans_id)
579
parent_id = self.tt.final_parent(trans_id)
580
if file_id in self.this_tree.inventory:
581
self.tt.unversion_file(trans_id)
582
if file_id in self.this_tree:
583
self.tt.delete_contents(trans_id)
584
file_group = self._dump_conflicts(name, parent_id, file_id,
586
self._raw_conflicts.append(('contents conflict', file_group))
588
# See SPOT run. run, SPOT, run.
589
# So we're not QUITE repeating ourselves; we do tricky things with
591
base_pair = contents_pair(self.base_tree)
592
other_pair = contents_pair(self.other_tree)
593
if base_pair == other_pair:
594
# OTHER introduced no changes
596
this_pair = contents_pair(self.this_tree)
597
if this_pair == other_pair:
598
# THIS and OTHER introduced the same changes
601
trans_id = self.tt.trans_id_file_id(file_id)
602
if this_pair == base_pair:
603
# only OTHER introduced changes
604
if file_id in self.this_tree:
605
# Remove any existing contents
606
self.tt.delete_contents(trans_id)
607
if file_id in self.other_tree:
608
# OTHER changed the file
609
create_by_entry(self.tt,
610
self.other_tree.inventory[file_id],
611
self.other_tree, trans_id)
612
if file_id not in self.this_tree.inventory:
613
self.tt.version_file(file_id, trans_id)
615
elif file_id in self.this_tree.inventory:
616
# OTHER deleted the file
617
self.tt.unversion_file(trans_id)
619
#BOTH THIS and OTHER introduced changes; scalar conflict
620
elif this_pair[0] == "file" and other_pair[0] == "file":
621
# THIS and OTHER are both files, so text merge. Either
622
# BASE is a file, or both converted to files, so at least we
623
# have agreement that output should be a file.
625
self.text_merge(file_id, trans_id)
627
return contents_conflict()
628
if file_id not in self.this_tree.inventory:
629
self.tt.version_file(file_id, trans_id)
631
self.tt.tree_kind(trans_id)
632
self.tt.delete_contents(trans_id)
637
# Scalar conflict, can't text merge. Dump conflicts
638
return contents_conflict()
640
def get_lines(self, tree, file_id):
641
"""Return the lines in a file, or an empty list."""
643
return tree.get_file(file_id).readlines()
647
def text_merge(self, file_id, trans_id):
648
"""Perform a three-way text merge on a file_id"""
649
# it's possible that we got here with base as a different type.
650
# if so, we just want two-way text conflicts.
651
if file_id in self.base_tree and \
652
self.base_tree.kind(file_id) == "file":
653
base_lines = self.get_lines(self.base_tree, file_id)
656
other_lines = self.get_lines(self.other_tree, file_id)
657
this_lines = self.get_lines(self.this_tree, file_id)
658
m3 = Merge3(base_lines, this_lines, other_lines)
659
start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
660
if self.show_base is True:
661
base_marker = '|' * 7
665
def iter_merge3(retval):
666
retval["text_conflicts"] = False
667
for line in m3.merge_lines(name_a = "TREE",
668
name_b = "MERGE-SOURCE",
669
name_base = "BASE-REVISION",
670
start_marker=start_marker,
671
base_marker=base_marker,
672
reprocess=self.reprocess):
673
if line.startswith(start_marker):
674
retval["text_conflicts"] = True
675
yield line.replace(start_marker, '<' * 7)
679
merge3_iterator = iter_merge3(retval)
680
self.tt.create_file(merge3_iterator, trans_id)
681
if retval["text_conflicts"] is True:
682
self._raw_conflicts.append(('text conflict', trans_id))
683
name = self.tt.final_name(trans_id)
684
parent_id = self.tt.final_parent(trans_id)
685
file_group = self._dump_conflicts(name, parent_id, file_id,
686
this_lines, base_lines,
688
file_group.append(trans_id)
690
def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
691
base_lines=None, other_lines=None, set_version=False,
693
"""Emit conflict files.
694
If this_lines, base_lines, or other_lines are omitted, they will be
695
determined automatically. If set_version is true, the .OTHER, .THIS
696
or .BASE (in that order) will be created as versioned files.
698
data = [('OTHER', self.other_tree, other_lines),
699
('THIS', self.this_tree, this_lines)]
701
data.append(('BASE', self.base_tree, base_lines))
704
for suffix, tree, lines in data:
706
trans_id = self._conflict_file(name, parent_id, tree, file_id,
708
file_group.append(trans_id)
709
if set_version and not versioned:
710
self.tt.version_file(file_id, trans_id)
714
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
716
"""Emit a single conflict file."""
717
name = name + '.' + suffix
718
trans_id = self.tt.create_path(name, parent_id)
719
entry = tree.inventory[file_id]
720
create_by_entry(self.tt, entry, tree, trans_id, lines)
723
def merge_executable(self, file_id, file_status):
724
"""Perform a merge on the execute bit."""
725
if file_status == "deleted":
727
trans_id = self.tt.trans_id_file_id(file_id)
729
if self.tt.final_kind(trans_id) != "file":
733
winner = self.scalar_three_way(self.this_tree, self.base_tree,
734
self.other_tree, file_id,
736
if winner == "conflict":
737
# There must be a None in here, if we have a conflict, but we
738
# need executability since file status was not deleted.
739
if self.executable(self.other_tree, file_id) is None:
744
if file_status == "modified":
745
executability = self.this_tree.is_executable(file_id)
746
if executability is not None:
747
trans_id = self.tt.trans_id_file_id(file_id)
748
self.tt.set_executability(executability, trans_id)
750
assert winner == "other"
751
if file_id in self.other_tree:
752
executability = self.other_tree.is_executable(file_id)
753
elif file_id in self.this_tree:
754
executability = self.this_tree.is_executable(file_id)
755
elif file_id in self.base_tree:
756
executability = self.base_tree.is_executable(file_id)
757
if executability is not None:
758
trans_id = self.tt.trans_id_file_id(file_id)
759
self.tt.set_executability(executability, trans_id)
761
def cook_conflicts(self, fs_conflicts):
762
"""Convert all conflicts into a form that doesn't depend on trans_id"""
763
from conflicts import Conflict
765
self.cooked_conflicts.extend(cook_conflicts(fs_conflicts, self.tt))
766
fp = FinalPaths(self.tt)
767
for conflict in self._raw_conflicts:
768
conflict_type = conflict[0]
769
if conflict_type in ('name conflict', 'parent conflict'):
770
trans_id = conflict[1]
771
conflict_args = conflict[2:]
772
if trans_id not in name_conflicts:
773
name_conflicts[trans_id] = {}
774
unique_add(name_conflicts[trans_id], conflict_type,
776
if conflict_type == 'contents conflict':
777
for trans_id in conflict[1]:
778
file_id = self.tt.final_file_id(trans_id)
214
779
if file_id is not None:
215
interesting_ids.add(file_id)
218
raise BzrCommandError("%s is not a source file in any"
220
merge_inner(this_branch, other_tree, base_tree, tempdir,
221
ignore_zero=ignore_zero, backup_files=backup_files,
222
merge_type=merge_type, interesting_ids=interesting_ids)
224
shutil.rmtree(tempdir)
227
def set_interesting(inventory_a, inventory_b, interesting_ids):
228
"""Mark files whose ids are in interesting_ids as interesting
230
for inventory in (inventory_a, inventory_b):
231
for path, source_file in inventory.iteritems():
232
source_file.interesting = source_file.id in interesting_ids
235
def set_optimized(tree_a, tree_b, inventory_a, inventory_b):
236
"""Mark files that have changed texts as interesting
238
for file_id in tree_a.tree.inventory:
239
if file_id not in tree_b.tree.inventory:
241
entry_a = tree_a.tree.inventory[file_id]
242
entry_b = tree_b.tree.inventory[file_id]
243
if (entry_a.kind, entry_b.kind) != ("file", "file"):
245
if None in (entry_a.text_id, entry_b.text_id):
247
if entry_a.text_id != entry_b.text_id:
249
inventory_a[abspath(tree_a.tree, file_id)].interesting = False
250
inventory_b[abspath(tree_b.tree, file_id)].interesting = False
253
def generate_cset_optimized(tree_a, tree_b, inventory_a, inventory_b,
254
interesting_ids=None):
255
"""Generate a changeset, with preprocessing to select interesting files.
256
using the text_id to mark really-changed files.
257
This permits blazing comparisons when text_ids are present. It also
258
disables metadata comparison for files with identical texts.
260
if interesting_ids is None:
261
set_optimized(tree_a, tree_b, inventory_a, inventory_b)
263
set_interesting(inventory_a, inventory_b, interesting_ids)
264
cset = generate_changeset(tree_a, tree_b, inventory_a, inventory_b)
265
for entry in cset.entries.itervalues():
266
entry.metadata_change = None
270
def merge_inner(this_branch, other_tree, base_tree, tempdir,
271
ignore_zero=False, merge_type=ApplyMerge3, backup_files=False,
272
interesting_ids=None):
274
def merge_factory(base_file, other_file):
275
contents_change = merge_type(base_file, other_file)
277
contents_change = BackupBeforeChange(contents_change)
278
return contents_change
280
def generate_cset(tree_a, tree_b, inventory_a, inventory_b):
281
return generate_cset_optimized(tree_a, tree_b, inventory_a, inventory_b,
284
this_tree = get_tree((this_branch.base, None), tempdir, "this")[1]
286
def get_inventory(tree):
287
return tree.inventory
289
inv_changes = merge_flex(this_tree, base_tree, other_tree,
290
generate_cset, get_inventory,
291
MergeConflictHandler(base_tree.root,
292
ignore_zero=ignore_zero),
293
merge_factory=merge_factory)
296
for id, path in inv_changes.iteritems():
781
path = fp.get_path(trans_id)
782
for suffix in ('.BASE', '.THIS', '.OTHER'):
783
if path.endswith(suffix):
784
path = path[:-len(suffix)]
786
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
787
self.cooked_conflicts.append(c)
788
if conflict_type == 'text conflict':
789
trans_id = conflict[1]
790
path = fp.get_path(trans_id)
791
file_id = self.tt.final_file_id(trans_id)
792
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
793
self.cooked_conflicts.append(c)
795
for trans_id, conflicts in name_conflicts.iteritems():
797
this_parent, other_parent = conflicts['parent conflict']
798
assert this_parent != other_parent
800
this_parent = other_parent = \
801
self.tt.final_file_id(self.tt.final_parent(trans_id))
803
this_name, other_name = conflicts['name conflict']
804
assert this_name != other_name
806
this_name = other_name = self.tt.final_name(trans_id)
807
other_path = fp.get_path(trans_id)
808
if this_parent is not None:
810
fp.get_path(self.tt.trans_id_file_id(this_parent))
811
this_path = pathjoin(this_parent_path, this_name)
301
assert path.startswith('./')
303
adjust_ids.append((path, id))
304
this_branch.set_inventory(regen_inventory(this_branch, this_tree.root, adjust_ids))
307
def regen_inventory(this_branch, root, new_entries):
308
old_entries = this_branch.read_working_inventory()
311
for file_id in old_entries:
312
entry = old_entries[file_id]
313
path = old_entries.id2path(file_id)
314
new_inventory[file_id] = (path, file_id, entry.parent_id, entry.kind)
315
by_path[path] = file_id
320
for path, file_id in new_entries:
322
del new_inventory[file_id]
325
new_path_list.append((path, file_id))
326
if file_id not in old_entries:
328
# Ensure no file is added before its parent
330
for path, file_id in new_path_list:
334
parent = by_path[os.path.dirname(path)]
335
kind = bzrlib.osutils.file_kind(os.path.join(root, path))
336
new_inventory[file_id] = (path, file_id, parent, kind)
337
by_path[path] = file_id
339
# Get a list in insertion order
340
new_inventory_list = new_inventory.values()
341
mutter ("""Inventory regeneration:
342
old length: %i insertions: %i deletions: %i new_length: %i"""\
343
% (len(old_entries), insertions, deletions, len(new_inventory_list)))
344
assert len(new_inventory_list) == len(old_entries) + insertions - deletions
345
new_inventory_list.sort()
346
return new_inventory_list
348
merge_types = { "merge3": (ApplyMerge3, "Native diff3-style merge"),
349
"diff3": (Diff3Merge, "Merge using external diff3")
813
this_path = "<deleted>"
814
file_id = self.tt.final_file_id(trans_id)
815
c = Conflict.factory('path conflict', path=this_path,
816
conflict_path=other_path, file_id=file_id)
817
self.cooked_conflicts.append(c)
818
self.cooked_conflicts.sort(key=Conflict.sort_key)
821
class WeaveMerger(Merge3Merger):
822
"""Three-way tree merger, text weave merger."""
823
supports_reprocess = True
824
supports_show_base = False
826
def __init__(self, working_tree, this_tree, base_tree, other_tree,
827
interesting_ids=None, pb=DummyProgress(), pp=None,
829
self.this_revision_tree = self._get_revision_tree(this_tree)
830
self.other_revision_tree = self._get_revision_tree(other_tree)
831
super(WeaveMerger, self).__init__(working_tree, this_tree,
832
base_tree, other_tree,
833
interesting_ids=interesting_ids,
834
pb=pb, pp=pp, reprocess=reprocess)
836
def _get_revision_tree(self, tree):
837
"""Return a revision tree related to this tree.
838
If the tree is a WorkingTree, the basis will be returned.
840
if getattr(tree, 'get_weave', False) is False:
841
# If we have a WorkingTree, try using the basis
842
return tree.branch.basis_tree()
846
def _check_file(self, file_id):
847
"""Check that the revision tree's version of the file matches."""
848
for tree, rt in ((self.this_tree, self.this_revision_tree),
849
(self.other_tree, self.other_revision_tree)):
852
if tree.get_file_sha1(file_id) != rt.get_file_sha1(file_id):
853
raise WorkingTreeNotRevision(self.this_tree)
855
def _merged_lines(self, file_id):
856
"""Generate the merged lines.
857
There is no distinction between lines that are meant to contain <<<<<<<
860
weave = self.this_revision_tree.get_weave(file_id)
861
this_revision_id = self.this_revision_tree.inventory[file_id].revision
862
other_revision_id = \
863
self.other_revision_tree.inventory[file_id].revision
864
wm = WeaveMerge(weave, this_revision_id, other_revision_id,
865
'<<<<<<< TREE\n', '>>>>>>> MERGE-SOURCE\n')
866
return wm.merge_lines(self.reprocess)
868
def text_merge(self, file_id, trans_id):
869
"""Perform a (weave) text merge for a given file and file-id.
870
If conflicts are encountered, .THIS and .OTHER files will be emitted,
871
and a conflict will be noted.
873
self._check_file(file_id)
874
lines, conflicts = self._merged_lines(file_id)
876
# Note we're checking whether the OUTPUT is binary in this case,
877
# because we don't want to get into weave merge guts.
878
check_text_lines(lines)
879
self.tt.create_file(lines, trans_id)
881
self._raw_conflicts.append(('text conflict', trans_id))
882
name = self.tt.final_name(trans_id)
883
parent_id = self.tt.final_parent(trans_id)
884
file_group = self._dump_conflicts(name, parent_id, file_id,
886
file_group.append(trans_id)
889
class Diff3Merger(Merge3Merger):
890
"""Three-way merger using external diff3 for text merging"""
892
def dump_file(self, temp_dir, name, tree, file_id):
893
out_path = pathjoin(temp_dir, name)
894
out_file = open(out_path, "wb")
896
in_file = tree.get_file(file_id)
903
def text_merge(self, file_id, trans_id):
904
"""Perform a diff3 merge using a specified file-id and trans-id.
905
If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
906
will be dumped, and a will be conflict noted.
909
temp_dir = osutils.mkdtemp(prefix="bzr-")
911
new_file = pathjoin(temp_dir, "new")
912
this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
913
base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
914
other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
915
status = bzrlib.patch.diff3(new_file, this, base, other)
916
if status not in (0, 1):
917
raise BzrError("Unhandled diff3 exit code")
918
f = open(new_file, 'rb')
920
self.tt.create_file(f, trans_id)
924
name = self.tt.final_name(trans_id)
925
parent_id = self.tt.final_parent(trans_id)
926
self._dump_conflicts(name, parent_id, file_id)
927
self._raw_conflicts.append(('text conflict', trans_id))
929
osutils.rmtree(temp_dir)
932
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
934
merge_type=Merge3Merger,
935
interesting_ids=None,
939
interesting_files=None,
942
"""Primary interface for merging.
944
typical use is probably
945
'merge_inner(branch, branch.get_revision_tree(other_revision),
946
branch.get_revision_tree(base_revision))'
948
if this_tree is None:
949
warnings.warn("bzrlib.merge.merge_inner requires a this_tree parameter as of "
950
"bzrlib version 0.8.",
953
this_tree = this_branch.bzrdir.open_workingtree()
954
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
956
merger.backup_files = backup_files
957
merger.merge_type = merge_type
958
merger.interesting_ids = interesting_ids
959
merger.ignore_zero = ignore_zero
960
if interesting_files:
961
assert not interesting_ids, ('Only supply interesting_ids'
962
' or interesting_files')
963
merger._set_interesting_files(interesting_files)
964
merger.show_base = show_base
965
merger.reprocess = reprocess
966
merger.other_rev_id = other_rev_id
967
merger.other_basis = other_rev_id
968
return merger.do_merge()
971
merge_types = { "merge3": (Merge3Merger, "Native diff3-style merge"),
972
"diff3": (Diff3Merger, "Merge using external diff3"),
973
'weave': (WeaveMerger, "Weave-based merge")
977
def merge_type_help():
978
templ = '%s%%7s: %%s' % (' '*12)
979
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
980
return '\n'.join(lines)
added
removed
bzrlib/merge.py
