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()):
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
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, **kwargs)
272
if len(merge.cooked_conflicts) == 0:
273
if not self.ignore_zero:
274
note("All changes applied successfully.")
276
note("%d conflicts encountered." % len(merge.cooked_conflicts))
278
return len(merge.cooked_conflicts)
280
def regen_inventory(self, new_entries):
281
old_entries = self.this_tree.read_working_inventory()
285
for path, file_id in new_entries:
288
new_entries_map[file_id] = path
290
def id2path(file_id):
291
path = new_entries_map.get(file_id)
294
entry = old_entries[file_id]
295
if entry.parent_id is None:
297
return pathjoin(id2path(entry.parent_id), entry.name)
299
for file_id in old_entries:
300
entry = old_entries[file_id]
301
path = id2path(file_id)
302
if file_id in self.base_tree.inventory:
303
executable = getattr(self.base_tree.inventory[file_id], 'executable', False)
305
executable = getattr(entry, 'executable', False)
306
new_inventory[file_id] = (path, file_id, entry.parent_id,
307
entry.kind, executable)
309
by_path[path] = file_id
314
for path, file_id in new_entries:
316
del new_inventory[file_id]
319
new_path_list.append((path, file_id))
320
if file_id not in old_entries:
322
# Ensure no file is added before its parent
324
for path, file_id in new_path_list:
328
parent = by_path[os.path.dirname(path)]
329
abspath = pathjoin(self.this_tree.basedir, path)
330
kind = osutils.file_kind(abspath)
331
if file_id in self.base_tree.inventory:
332
executable = getattr(self.base_tree.inventory[file_id], 'executable', False)
335
new_inventory[file_id] = (path, file_id, parent, kind, executable)
336
by_path[path] = file_id
338
# Get a list in insertion order
339
new_inventory_list = new_inventory.values()
340
mutter ("""Inventory regeneration:
341
old length: %i insertions: %i deletions: %i new_length: %i"""\
342
% (len(old_entries), insertions, deletions,
343
len(new_inventory_list)))
344
assert len(new_inventory_list) == len(old_entries) + insertions\
346
new_inventory_list.sort()
347
return new_inventory_list
350
class Merge3Merger(object):
351
"""Three-way merger that uses the merge3 text merger"""
353
supports_reprocess = True
354
supports_show_base = True
355
history_based = False
357
def __init__(self, working_tree, this_tree, base_tree, other_tree,
358
interesting_ids=None, reprocess=False, show_base=False,
359
pb=DummyProgress(), pp=None):
360
"""Initialize the merger object and perform the merge."""
361
object.__init__(self)
362
self.this_tree = working_tree
363
self.base_tree = base_tree
364
self.other_tree = other_tree
365
self._raw_conflicts = []
366
self.cooked_conflicts = []
367
self.reprocess = reprocess
368
self.show_base = show_base
372
self.pp = ProgressPhase("Merge phase", 3, self.pb)
374
if interesting_ids is not None:
375
all_ids = interesting_ids
377
all_ids = set(base_tree)
378
all_ids.update(other_tree)
379
working_tree.lock_tree_write()
380
self.tt = TreeTransform(working_tree, self.pb)
383
child_pb = ui.ui_factory.nested_progress_bar()
385
for num, file_id in enumerate(all_ids):
386
child_pb.update('Preparing file merge', num, len(all_ids))
387
self.merge_names(file_id)
388
file_status = self.merge_contents(file_id)
389
self.merge_executable(file_id, file_status)
394
child_pb = ui.ui_factory.nested_progress_bar()
396
fs_conflicts = resolve_conflicts(self.tt, child_pb)
399
self.cook_conflicts(fs_conflicts)
400
for conflict in self.cooked_conflicts:
403
results = self.tt.apply()
404
self.write_modified(results)
406
working_tree.add_conflicts(self.cooked_conflicts)
407
except UnsupportedOperation:
411
working_tree.unlock()
416
self.tt.final_kind(self.tt.root)
418
self.tt.cancel_deletion(self.tt.root)
419
if self.tt.final_file_id(self.tt.root) is None:
420
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
422
if self.other_tree.inventory.root is None:
424
other_root_file_id = self.other_tree.inventory.root.file_id
425
other_root = self.tt.trans_id_file_id(other_root_file_id)
426
if other_root == self.tt.root:
429
self.tt.final_kind(other_root)
432
self.reparent_children(self.other_tree.inventory.root, self.tt.root)
433
self.tt.cancel_creation(other_root)
434
self.tt.cancel_versioning(other_root)
436
def reparent_children(self, ie, target):
437
for thing, child in ie.children.iteritems():
438
trans_id = self.tt.trans_id_file_id(child.file_id)
439
self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
441
def write_modified(self, results):
443
for path in results.modified_paths:
444
file_id = self.this_tree.path2id(self.this_tree.relpath(path))
447
hash = self.this_tree.get_file_sha1(file_id)
450
modified_hashes[file_id] = hash
451
self.this_tree.set_merge_modified(modified_hashes)
454
def parent(entry, file_id):
455
"""Determine the parent for a file_id (used as a key method)"""
458
return entry.parent_id
461
def name(entry, file_id):
462
"""Determine the name for a file_id (used as a key method)"""
468
def contents_sha1(tree, file_id):
469
"""Determine the sha1 of the file contents (used as a key method)."""
470
if file_id not in tree:
472
return tree.get_file_sha1(file_id)
475
def executable(tree, file_id):
476
"""Determine the executability of a file-id (used as a key method)."""
477
if file_id not in tree:
479
if tree.kind(file_id) != "file":
481
return tree.is_executable(file_id)
484
def kind(tree, file_id):
485
"""Determine the kind of a file-id (used as a key method)."""
486
if file_id not in tree:
488
return tree.kind(file_id)
491
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
492
"""Do a three-way test on a scalar.
493
Return "this", "other" or "conflict", depending whether a value wins.
495
key_base = key(base_tree, file_id)
496
key_other = key(other_tree, file_id)
497
#if base == other, either they all agree, or only THIS has changed.
498
if key_base == key_other:
500
key_this = key(this_tree, file_id)
501
if key_this not in (key_base, key_other):
503
# "Ambiguous clean merge"
504
elif key_this == key_other:
507
assert key_this == key_base
510
def merge_names(self, file_id):
511
"""Perform a merge on file_id names and parents"""
513
if file_id in tree.inventory:
514
return tree.inventory[file_id]
517
this_entry = get_entry(self.this_tree)
518
other_entry = get_entry(self.other_tree)
519
base_entry = get_entry(self.base_tree)
520
name_winner = self.scalar_three_way(this_entry, base_entry,
521
other_entry, file_id, self.name)
522
parent_id_winner = self.scalar_three_way(this_entry, base_entry,
523
other_entry, file_id,
525
if this_entry is None:
526
if name_winner == "this":
527
name_winner = "other"
528
if parent_id_winner == "this":
529
parent_id_winner = "other"
530
if name_winner == "this" and parent_id_winner == "this":
532
if name_winner == "conflict":
533
trans_id = self.tt.trans_id_file_id(file_id)
534
self._raw_conflicts.append(('name conflict', trans_id,
535
self.name(this_entry, file_id),
536
self.name(other_entry, file_id)))
537
if parent_id_winner == "conflict":
538
trans_id = self.tt.trans_id_file_id(file_id)
539
self._raw_conflicts.append(('parent conflict', trans_id,
540
self.parent(this_entry, file_id),
541
self.parent(other_entry, file_id)))
542
if other_entry is None:
543
# it doesn't matter whether the result was 'other' or
544
# 'conflict'-- if there's no 'other', we leave it alone.
546
# if we get here, name_winner and parent_winner are set to safe values.
547
winner_entry = {"this": this_entry, "other": other_entry,
548
"conflict": other_entry}
549
trans_id = self.tt.trans_id_file_id(file_id)
550
parent_id = winner_entry[parent_id_winner].parent_id
551
if parent_id is not None:
552
parent_trans_id = self.tt.trans_id_file_id(parent_id)
553
self.tt.adjust_path(winner_entry[name_winner].name,
554
parent_trans_id, trans_id)
556
def merge_contents(self, file_id):
557
"""Performa a merge on file_id contents."""
558
def contents_pair(tree):
559
if file_id not in tree:
561
kind = tree.kind(file_id)
563
contents = tree.get_file_sha1(file_id)
564
elif kind == "symlink":
565
contents = tree.get_symlink_target(file_id)
568
return kind, contents
570
def contents_conflict():
571
trans_id = self.tt.trans_id_file_id(file_id)
572
name = self.tt.final_name(trans_id)
573
parent_id = self.tt.final_parent(trans_id)
574
if file_id in self.this_tree.inventory:
575
self.tt.unversion_file(trans_id)
576
if file_id in self.this_tree:
577
self.tt.delete_contents(trans_id)
578
file_group = self._dump_conflicts(name, parent_id, file_id,
580
self._raw_conflicts.append(('contents conflict', file_group))
582
# See SPOT run. run, SPOT, run.
583
# So we're not QUITE repeating ourselves; we do tricky things with
585
base_pair = contents_pair(self.base_tree)
586
other_pair = contents_pair(self.other_tree)
587
if base_pair == other_pair:
588
# OTHER introduced no changes
590
this_pair = contents_pair(self.this_tree)
591
if this_pair == other_pair:
592
# THIS and OTHER introduced the same changes
595
trans_id = self.tt.trans_id_file_id(file_id)
596
if this_pair == base_pair:
597
# only OTHER introduced changes
598
if file_id in self.this_tree:
599
# Remove any existing contents
600
self.tt.delete_contents(trans_id)
601
if file_id in self.other_tree:
602
# OTHER changed the file
603
create_by_entry(self.tt,
604
self.other_tree.inventory[file_id],
605
self.other_tree, trans_id)
606
if file_id not in self.this_tree.inventory:
607
self.tt.version_file(file_id, trans_id)
609
elif file_id in self.this_tree.inventory:
610
# OTHER deleted the file
611
self.tt.unversion_file(trans_id)
613
#BOTH THIS and OTHER introduced changes; scalar conflict
614
elif this_pair[0] == "file" and other_pair[0] == "file":
615
# THIS and OTHER are both files, so text merge. Either
616
# BASE is a file, or both converted to files, so at least we
617
# have agreement that output should be a file.
619
self.text_merge(file_id, trans_id)
621
return contents_conflict()
622
if file_id not in self.this_tree.inventory:
623
self.tt.version_file(file_id, trans_id)
625
self.tt.tree_kind(trans_id)
626
self.tt.delete_contents(trans_id)
631
# Scalar conflict, can't text merge. Dump conflicts
632
return contents_conflict()
634
def get_lines(self, tree, file_id):
635
"""Return the lines in a file, or an empty list."""
637
return tree.get_file(file_id).readlines()
641
def text_merge(self, file_id, trans_id):
642
"""Perform a three-way text merge on a file_id"""
643
# it's possible that we got here with base as a different type.
644
# if so, we just want two-way text conflicts.
645
if file_id in self.base_tree and \
646
self.base_tree.kind(file_id) == "file":
647
base_lines = self.get_lines(self.base_tree, file_id)
650
other_lines = self.get_lines(self.other_tree, file_id)
651
this_lines = self.get_lines(self.this_tree, file_id)
652
m3 = Merge3(base_lines, this_lines, other_lines)
653
start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
654
if self.show_base is True:
655
base_marker = '|' * 7
659
def iter_merge3(retval):
660
retval["text_conflicts"] = False
661
for line in m3.merge_lines(name_a = "TREE",
662
name_b = "MERGE-SOURCE",
663
name_base = "BASE-REVISION",
664
start_marker=start_marker,
665
base_marker=base_marker,
666
reprocess=self.reprocess):
667
if line.startswith(start_marker):
668
retval["text_conflicts"] = True
669
yield line.replace(start_marker, '<' * 7)
673
merge3_iterator = iter_merge3(retval)
674
self.tt.create_file(merge3_iterator, trans_id)
675
if retval["text_conflicts"] is True:
676
self._raw_conflicts.append(('text conflict', trans_id))
677
name = self.tt.final_name(trans_id)
678
parent_id = self.tt.final_parent(trans_id)
679
file_group = self._dump_conflicts(name, parent_id, file_id,
680
this_lines, base_lines,
682
file_group.append(trans_id)
684
def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
685
base_lines=None, other_lines=None, set_version=False,
687
"""Emit conflict files.
688
If this_lines, base_lines, or other_lines are omitted, they will be
689
determined automatically. If set_version is true, the .OTHER, .THIS
690
or .BASE (in that order) will be created as versioned files.
692
data = [('OTHER', self.other_tree, other_lines),
693
('THIS', self.this_tree, this_lines)]
695
data.append(('BASE', self.base_tree, base_lines))
698
for suffix, tree, lines in data:
700
trans_id = self._conflict_file(name, parent_id, tree, file_id,
702
file_group.append(trans_id)
703
if set_version and not versioned:
704
self.tt.version_file(file_id, trans_id)
708
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
710
"""Emit a single conflict file."""
711
name = name + '.' + suffix
712
trans_id = self.tt.create_path(name, parent_id)
713
entry = tree.inventory[file_id]
714
create_by_entry(self.tt, entry, tree, trans_id, lines)
717
def merge_executable(self, file_id, file_status):
718
"""Perform a merge on the execute bit."""
719
if file_status == "deleted":
721
trans_id = self.tt.trans_id_file_id(file_id)
723
if self.tt.final_kind(trans_id) != "file":
727
winner = self.scalar_three_way(self.this_tree, self.base_tree,
728
self.other_tree, file_id,
730
if winner == "conflict":
731
# There must be a None in here, if we have a conflict, but we
732
# need executability since file status was not deleted.
733
if self.executable(self.other_tree, file_id) is None:
738
if file_status == "modified":
739
executability = self.this_tree.is_executable(file_id)
740
if executability is not None:
741
trans_id = self.tt.trans_id_file_id(file_id)
742
self.tt.set_executability(executability, trans_id)
744
assert winner == "other"
745
if file_id in self.other_tree:
746
executability = self.other_tree.is_executable(file_id)
747
elif file_id in self.this_tree:
748
executability = self.this_tree.is_executable(file_id)
749
elif file_id in self.base_tree:
750
executability = self.base_tree.is_executable(file_id)
751
if executability is not None:
752
trans_id = self.tt.trans_id_file_id(file_id)
753
self.tt.set_executability(executability, trans_id)
755
def cook_conflicts(self, fs_conflicts):
756
"""Convert all conflicts into a form that doesn't depend on trans_id"""
757
from conflicts import Conflict
759
self.cooked_conflicts.extend(cook_conflicts(fs_conflicts, self.tt))
760
fp = FinalPaths(self.tt)
761
for conflict in self._raw_conflicts:
762
conflict_type = conflict[0]
763
if conflict_type in ('name conflict', 'parent conflict'):
764
trans_id = conflict[1]
765
conflict_args = conflict[2:]
766
if trans_id not in name_conflicts:
767
name_conflicts[trans_id] = {}
768
unique_add(name_conflicts[trans_id], conflict_type,
770
if conflict_type == 'contents conflict':
771
for trans_id in conflict[1]:
772
file_id = self.tt.final_file_id(trans_id)
214
773
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():
775
path = fp.get_path(trans_id)
776
for suffix in ('.BASE', '.THIS', '.OTHER'):
777
if path.endswith(suffix):
778
path = path[:-len(suffix)]
780
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
781
self.cooked_conflicts.append(c)
782
if conflict_type == 'text conflict':
783
trans_id = conflict[1]
784
path = fp.get_path(trans_id)
785
file_id = self.tt.final_file_id(trans_id)
786
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
787
self.cooked_conflicts.append(c)
789
for trans_id, conflicts in name_conflicts.iteritems():
791
this_parent, other_parent = conflicts['parent conflict']
792
assert this_parent != other_parent
794
this_parent = other_parent = \
795
self.tt.final_file_id(self.tt.final_parent(trans_id))
797
this_name, other_name = conflicts['name conflict']
798
assert this_name != other_name
800
this_name = other_name = self.tt.final_name(trans_id)
801
other_path = fp.get_path(trans_id)
802
if this_parent is not None:
804
fp.get_path(self.tt.trans_id_file_id(this_parent))
805
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")
807
this_path = "<deleted>"
808
file_id = self.tt.final_file_id(trans_id)
809
c = Conflict.factory('path conflict', path=this_path,
810
conflict_path=other_path, file_id=file_id)
811
self.cooked_conflicts.append(c)
812
self.cooked_conflicts.sort(key=Conflict.sort_key)
815
class WeaveMerger(Merge3Merger):
816
"""Three-way tree merger, text weave merger."""
817
supports_reprocess = True
818
supports_show_base = False
820
def __init__(self, working_tree, this_tree, base_tree, other_tree,
821
interesting_ids=None, pb=DummyProgress(), pp=None,
823
self.this_revision_tree = self._get_revision_tree(this_tree)
824
self.other_revision_tree = self._get_revision_tree(other_tree)
825
super(WeaveMerger, self).__init__(working_tree, this_tree,
826
base_tree, other_tree,
827
interesting_ids=interesting_ids,
828
pb=pb, pp=pp, reprocess=reprocess)
830
def _get_revision_tree(self, tree):
831
"""Return a revision tree related to this tree.
832
If the tree is a WorkingTree, the basis will be returned.
834
if getattr(tree, 'get_weave', False) is False:
835
# If we have a WorkingTree, try using the basis
836
return tree.branch.basis_tree()
840
def _check_file(self, file_id):
841
"""Check that the revision tree's version of the file matches."""
842
for tree, rt in ((self.this_tree, self.this_revision_tree),
843
(self.other_tree, self.other_revision_tree)):
846
if tree.get_file_sha1(file_id) != rt.get_file_sha1(file_id):
847
raise WorkingTreeNotRevision(self.this_tree)
849
def _merged_lines(self, file_id):
850
"""Generate the merged lines.
851
There is no distinction between lines that are meant to contain <<<<<<<
854
weave = self.this_revision_tree.get_weave(file_id)
855
this_revision_id = self.this_revision_tree.inventory[file_id].revision
856
other_revision_id = \
857
self.other_revision_tree.inventory[file_id].revision
858
wm = WeaveMerge(weave, this_revision_id, other_revision_id,
859
'<<<<<<< TREE\n', '>>>>>>> MERGE-SOURCE\n')
860
return wm.merge_lines(self.reprocess)
862
def text_merge(self, file_id, trans_id):
863
"""Perform a (weave) text merge for a given file and file-id.
864
If conflicts are encountered, .THIS and .OTHER files will be emitted,
865
and a conflict will be noted.
867
self._check_file(file_id)
868
lines, conflicts = self._merged_lines(file_id)
870
# Note we're checking whether the OUTPUT is binary in this case,
871
# because we don't want to get into weave merge guts.
872
check_text_lines(lines)
873
self.tt.create_file(lines, trans_id)
875
self._raw_conflicts.append(('text conflict', trans_id))
876
name = self.tt.final_name(trans_id)
877
parent_id = self.tt.final_parent(trans_id)
878
file_group = self._dump_conflicts(name, parent_id, file_id,
880
file_group.append(trans_id)
883
class Diff3Merger(Merge3Merger):
884
"""Three-way merger using external diff3 for text merging"""
886
def dump_file(self, temp_dir, name, tree, file_id):
887
out_path = pathjoin(temp_dir, name)
888
out_file = open(out_path, "wb")
890
in_file = tree.get_file(file_id)
897
def text_merge(self, file_id, trans_id):
898
"""Perform a diff3 merge using a specified file-id and trans-id.
899
If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
900
will be dumped, and a will be conflict noted.
903
temp_dir = osutils.mkdtemp(prefix="bzr-")
905
new_file = pathjoin(temp_dir, "new")
906
this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
907
base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
908
other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
909
status = bzrlib.patch.diff3(new_file, this, base, other)
910
if status not in (0, 1):
911
raise BzrError("Unhandled diff3 exit code")
912
f = open(new_file, 'rb')
914
self.tt.create_file(f, trans_id)
918
name = self.tt.final_name(trans_id)
919
parent_id = self.tt.final_parent(trans_id)
920
self._dump_conflicts(name, parent_id, file_id)
921
self._raw_conflicts.append(('text conflict', trans_id))
923
osutils.rmtree(temp_dir)
926
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
928
merge_type=Merge3Merger,
929
interesting_ids=None,
933
interesting_files=None,
936
"""Primary interface for merging.
938
typical use is probably
939
'merge_inner(branch, branch.get_revision_tree(other_revision),
940
branch.get_revision_tree(base_revision))'
942
if this_tree is None:
943
warnings.warn("bzrlib.merge.merge_inner requires a this_tree parameter as of "
944
"bzrlib version 0.8.",
947
this_tree = this_branch.bzrdir.open_workingtree()
948
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
950
merger.backup_files = backup_files
951
merger.merge_type = merge_type
952
merger.interesting_ids = interesting_ids
953
merger.ignore_zero = ignore_zero
954
if interesting_files:
955
assert not interesting_ids, ('Only supply interesting_ids'
956
' or interesting_files')
957
merger._set_interesting_files(interesting_files)
958
merger.show_base = show_base
959
merger.reprocess = reprocess
960
merger.other_rev_id = other_rev_id
961
merger.other_basis = other_rev_id
962
return merger.do_merge()
965
merge_types = { "merge3": (Merge3Merger, "Native diff3-style merge"),
966
"diff3": (Diff3Merger, "Merge using external diff3"),
967
'weave': (WeaveMerger, "Weave-based merge")
971
def merge_type_help():
972
templ = '%s%%7s: %%s' % (' '*12)
973
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
974
return '\n'.join(lines)
added
removed
bzrlib/merge.py
