1
from merge_core import merge_flex
2
from changeset import generate_changeset, ExceptionConflictHandler
3
from changeset import Inventory
4
from bzrlib import find_branch
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
20
from tempfile import mkdtemp
23
from bzrlib.branch import Branch
24
from bzrlib.conflicts import ConflictList, Conflict
25
from bzrlib.errors import (BzrCommandError,
35
WorkingTreeNotRevision,
38
from bzrlib.merge3 import Merge3
5
39
import bzrlib.osutils
6
from bzrlib.errors import BzrCommandError
7
from bzrlib.diff import compare_trees
8
from trace import mutter, warning
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):
40
from bzrlib.osutils import rename, pathjoin, rmtree
41
from progress import DummyProgress, ProgressPhase
42
from bzrlib.revision import common_ancestor, is_ancestor, NULL_REVISION
43
from bzrlib.textfile import check_text_lines
44
from bzrlib.trace import mutter, warning, note
45
from bzrlib.transform import (TreeTransform, resolve_conflicts, cook_conflicts,
46
FinalPaths, create_by_entry, unique_add)
47
from bzrlib.versionedfile import WeaveMerge
50
# TODO: Report back as changes are merged in
52
def _get_tree(treespec, local_branch=None):
53
from bzrlib import workingtree
105
54
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):
56
tree = workingtree.WorkingTree.open_containing(location)[0]
57
return tree.branch, tree
58
branch = Branch.open_containing(location)[0]
60
revision = branch.last_revision()
62
revision = branch.get_rev_id(revno)
64
revision = NULL_REVISION
65
return branch, _get_revid_tree(branch, revision, local_branch)
68
def _get_revid_tree(branch, revision, local_branch):
70
base_tree = branch.bzrdir.open_workingtree()
72
if local_branch is not None:
73
if local_branch.base != branch.base:
74
local_branch.fetch(branch, revision)
75
base_tree = local_branch.repository.revision_tree(revision)
77
base_tree = branch.repository.revision_tree(revision)
81
def transform_tree(from_tree, to_tree, interesting_ids=None):
82
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
83
interesting_ids=interesting_ids, this_tree=from_tree)
87
def __init__(self, this_branch, other_tree=None, base_tree=None,
88
this_tree=None, pb=DummyProgress()):
137
89
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,
169
"""Merge changes into a tree.
172
Base for three-way merge.
174
Other revision for three-way merge.
176
Directory to merge changes into; '.' by default.
178
If true, this_dir must have no uncommitted changes before the
181
tempdir = tempfile.mkdtemp(prefix="bzr-")
185
this_branch = find_branch(this_dir)
90
assert this_tree is not None, "this_tree is required"
91
self.this_branch = this_branch
92
self.this_basis = this_branch.last_revision()
93
self.this_rev_id = None
94
self.this_tree = this_tree
95
self.this_revision_tree = None
96
self.this_basis_tree = None
97
self.other_tree = other_tree
98
self.base_tree = base_tree
99
self.ignore_zero = False
100
self.backup_files = False
101
self.interesting_ids = None
102
self.show_base = False
103
self.reprocess = False
108
def revision_tree(self, revision_id):
109
return self.this_branch.repository.revision_tree(revision_id)
111
def ensure_revision_trees(self):
112
if self.this_revision_tree is None:
113
self.this_basis_tree = self.this_branch.repository.revision_tree(
115
if self.this_basis == self.this_rev_id:
116
self.this_revision_tree = self.this_basis_tree
118
if self.other_rev_id is None:
119
other_basis_tree = self.revision_tree(self.other_basis)
120
changes = other_basis_tree.changes_from(self.other_tree)
121
if changes.has_changed():
122
raise WorkingTreeNotRevision(self.this_tree)
123
other_rev_id = self.other_basis
124
self.other_tree = other_basis_tree
126
def file_revisions(self, file_id):
127
self.ensure_revision_trees()
128
def get_id(tree, file_id):
129
revision_id = tree.inventory[file_id].revision
130
assert revision_id is not None
132
if self.this_rev_id is None:
133
if self.this_basis_tree.get_file_sha1(file_id) != \
134
self.this_tree.get_file_sha1(file_id):
135
raise WorkingTreeNotRevision(self.this_tree)
137
trees = (self.this_basis_tree, self.other_tree)
138
return [get_id(tree, file_id) for tree in trees]
140
def check_basis(self, check_clean, require_commits=True):
141
if self.this_basis is None and require_commits is True:
142
raise BzrCommandError("This branch has no commits")
187
changes = compare_trees(this_branch.working_tree(),
188
this_branch.basis_tree(), False)
189
if changes.has_changed():
145
if self.this_basis != self.this_rev_id:
190
146
raise BzrCommandError("Working tree has uncommitted changes.")
191
other_branch, other_tree = get_tree(other_revision, tempdir, "other")
148
def compare_basis(self):
149
changes = self.this_tree.changes_from(self.this_tree.basis_tree())
150
if not changes.has_changed():
151
self.this_rev_id = self.this_basis
153
def set_interesting_files(self, file_list):
155
self._set_interesting_files(file_list)
156
except NotVersionedError, e:
157
raise BzrCommandError("%s is not a source file in any"
160
def _set_interesting_files(self, file_list):
161
"""Set the list of interesting ids from a list of files."""
162
if file_list is None:
163
self.interesting_ids = None
166
interesting_ids = set()
167
for path in file_list:
169
for tree in (self.this_tree, self.base_tree, self.other_tree):
170
file_id = tree.inventory.path2id(path)
171
if file_id is not None:
172
interesting_ids.add(file_id)
175
raise NotVersionedError(path=path)
176
self.interesting_ids = interesting_ids
178
def set_pending(self):
179
if not self.base_is_ancestor:
181
if self.other_rev_id is None:
183
ancestry = self.this_branch.repository.get_ancestry(self.this_basis)
184
if self.other_rev_id in ancestry:
186
self.this_tree.add_pending_merge(self.other_rev_id)
188
def set_other(self, other_revision):
189
other_branch, self.other_tree = _get_tree(other_revision,
191
if other_revision[1] == -1:
192
self.other_rev_id = other_branch.last_revision()
193
if self.other_rev_id is None:
194
raise NoCommits(other_branch)
195
self.other_basis = self.other_rev_id
196
elif other_revision[1] is not None:
197
self.other_rev_id = other_branch.get_rev_id(other_revision[1])
198
self.other_basis = self.other_rev_id
200
self.other_rev_id = None
201
self.other_basis = other_branch.last_revision()
202
if self.other_basis is None:
203
raise NoCommits(other_branch)
204
if other_branch.base != self.this_branch.base:
205
self.this_branch.fetch(other_branch, last_revision=self.other_basis)
208
self.set_base([None, None])
210
def set_base(self, base_revision):
211
mutter("doing merge() with no base_revision specified")
192
212
if base_revision == [None, None]:
193
if other_revision[1] == -1:
196
o_revno = other_revision[1]
197
base_revno = this_branch.common_ancestor(other_branch,
198
other_revno=o_revno)[0]
199
if base_revno is None:
214
pb = bzrlib.ui.ui_factory.nested_progress_bar()
216
this_repo = self.this_branch.repository
217
self.base_rev_id = common_ancestor(self.this_basis,
222
except NoCommonAncestor:
200
223
raise UnrelatedBranches()
201
base_revision = ['.', base_revno]
202
base_branch, base_tree = get_tree(base_revision, tempdir, "base")
203
merge_inner(this_branch, other_tree, base_tree, tempdir,
204
ignore_zero=ignore_zero)
206
shutil.rmtree(tempdir)
209
def generate_cset_optimized(tree_a, tree_b, inventory_a, inventory_b):
210
"""Generate a changeset, using the text_id to mark really-changed files.
211
This permits blazing comparisons when text_ids are present. It also
212
disables metadata comparison for files with identical texts.
214
for file_id in tree_a.tree.inventory:
215
if file_id not in tree_b.tree.inventory:
217
entry_a = tree_a.tree.inventory[file_id]
218
entry_b = tree_b.tree.inventory[file_id]
219
if (entry_a.kind, entry_b.kind) != ("file", "file"):
221
if None in (entry_a.text_id, entry_b.text_id):
223
if entry_a.text_id != entry_b.text_id:
225
inventory_a[abspath(tree_a.tree, file_id)].interesting = False
226
inventory_b[abspath(tree_b.tree, file_id)].interesting = False
227
cset = generate_changeset(tree_a, tree_b, inventory_a, inventory_b)
228
for entry in cset.entries.itervalues():
229
entry.metadata_change = None
233
def merge_inner(this_branch, other_tree, base_tree, tempdir,
235
this_tree = get_tree((this_branch.base, None), tempdir, "this")[1]
237
def get_inventory(tree):
238
return tree.inventory
240
inv_changes = merge_flex(this_tree, base_tree, other_tree,
241
generate_cset_optimized, get_inventory,
242
MergeConflictHandler(base_tree.root,
243
ignore_zero=ignore_zero))
246
for id, path in inv_changes.iteritems():
251
assert path.startswith('./')
253
adjust_ids.append((path, id))
254
this_branch.set_inventory(regen_inventory(this_branch, this_tree.root, adjust_ids))
257
def regen_inventory(this_branch, root, new_entries):
258
old_entries = this_branch.read_working_inventory()
261
for file_id in old_entries:
262
entry = old_entries[file_id]
263
path = old_entries.id2path(file_id)
264
new_inventory[file_id] = (path, file_id, entry.parent_id, entry.kind)
265
by_path[path] = file_id
224
self.base_tree = _get_revid_tree(self.this_branch, self.base_rev_id,
226
self.base_is_ancestor = True
228
base_branch, self.base_tree = _get_tree(base_revision)
229
if base_revision[1] == -1:
230
self.base_rev_id = base_branch.last_revision()
231
elif base_revision[1] is None:
232
self.base_rev_id = None
234
self.base_rev_id = base_branch.get_rev_id(base_revision[1])
235
if self.this_branch.base != base_branch.base:
236
self.this_branch.fetch(base_branch)
237
self.base_is_ancestor = is_ancestor(self.this_basis,
242
kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
243
'other_tree': self.other_tree,
244
'interesting_ids': self.interesting_ids,
246
if self.merge_type.requires_base:
247
kwargs['base_tree'] = self.base_tree
248
if self.merge_type.supports_reprocess:
249
kwargs['reprocess'] = self.reprocess
251
raise BzrError("Conflict reduction is not supported for merge"
252
" type %s." % self.merge_type)
253
if self.merge_type.supports_show_base:
254
kwargs['show_base'] = self.show_base
256
raise BzrError("Showing base is not supported for this"
257
" merge type. %s" % self.merge_type)
258
merge = self.merge_type(pb=self._pb, **kwargs)
259
if len(merge.cooked_conflicts) == 0:
260
if not self.ignore_zero:
261
note("All changes applied successfully.")
263
note("%d conflicts encountered." % len(merge.cooked_conflicts))
265
return len(merge.cooked_conflicts)
267
def regen_inventory(self, new_entries):
268
old_entries = self.this_tree.read_working_inventory()
272
for path, file_id in new_entries:
275
new_entries_map[file_id] = path
277
def id2path(file_id):
278
path = new_entries_map.get(file_id)
281
entry = old_entries[file_id]
282
if entry.parent_id is None:
284
return pathjoin(id2path(entry.parent_id), entry.name)
286
for file_id in old_entries:
287
entry = old_entries[file_id]
288
path = id2path(file_id)
289
if file_id in self.base_tree.inventory:
290
executable = getattr(self.base_tree.inventory[file_id], 'executable', False)
292
executable = getattr(entry, 'executable', False)
293
new_inventory[file_id] = (path, file_id, entry.parent_id,
294
entry.kind, executable)
296
by_path[path] = file_id
301
for path, file_id in new_entries:
303
del new_inventory[file_id]
306
new_path_list.append((path, file_id))
307
if file_id not in old_entries:
309
# Ensure no file is added before its parent
311
for path, file_id in new_path_list:
315
parent = by_path[os.path.dirname(path)]
316
abspath = pathjoin(self.this_tree.basedir, path)
317
kind = bzrlib.osutils.file_kind(abspath)
318
if file_id in self.base_tree.inventory:
319
executable = getattr(self.base_tree.inventory[file_id], 'executable', False)
322
new_inventory[file_id] = (path, file_id, parent, kind, executable)
323
by_path[path] = file_id
325
# Get a list in insertion order
326
new_inventory_list = new_inventory.values()
327
mutter ("""Inventory regeneration:
328
old length: %i insertions: %i deletions: %i new_length: %i"""\
329
% (len(old_entries), insertions, deletions,
330
len(new_inventory_list)))
331
assert len(new_inventory_list) == len(old_entries) + insertions\
333
new_inventory_list.sort()
334
return new_inventory_list
337
class Merge3Merger(object):
338
"""Three-way merger that uses the merge3 text merger"""
340
supports_reprocess = True
341
supports_show_base = True
342
history_based = False
344
def __init__(self, working_tree, this_tree, base_tree, other_tree,
345
interesting_ids=None, reprocess=False, show_base=False,
346
pb=DummyProgress(), pp=None):
347
"""Initialize the merger object and perform the merge."""
348
object.__init__(self)
349
self.this_tree = working_tree
350
self.base_tree = base_tree
351
self.other_tree = other_tree
352
self._raw_conflicts = []
353
self.cooked_conflicts = []
354
self.reprocess = reprocess
355
self.show_base = show_base
359
self.pp = ProgressPhase("Merge phase", 3, self.pb)
361
if interesting_ids is not None:
362
all_ids = interesting_ids
364
all_ids = set(base_tree)
365
all_ids.update(other_tree)
366
working_tree.lock_write()
367
self.tt = TreeTransform(working_tree, self.pb)
370
child_pb = ui.ui_factory.nested_progress_bar()
372
for num, file_id in enumerate(all_ids):
373
child_pb.update('Preparing file merge', num, len(all_ids))
374
self.merge_names(file_id)
375
file_status = self.merge_contents(file_id)
376
self.merge_executable(file_id, file_status)
381
child_pb = ui.ui_factory.nested_progress_bar()
383
fs_conflicts = resolve_conflicts(self.tt, child_pb)
386
self.cook_conflicts(fs_conflicts)
387
for conflict in self.cooked_conflicts:
390
results = self.tt.apply()
391
self.write_modified(results)
393
working_tree.add_conflicts(self.cooked_conflicts)
394
except UnsupportedOperation:
398
working_tree.unlock()
401
def write_modified(self, results):
403
for path in results.modified_paths:
404
file_id = self.this_tree.path2id(self.this_tree.relpath(path))
407
hash = self.this_tree.get_file_sha1(file_id)
410
modified_hashes[file_id] = hash
411
self.this_tree.set_merge_modified(modified_hashes)
414
def parent(entry, file_id):
415
"""Determine the parent for a file_id (used as a key method)"""
418
return entry.parent_id
421
def name(entry, file_id):
422
"""Determine the name for a file_id (used as a key method)"""
270
for path, file_id in new_entries:
272
del new_inventory[file_id]
275
new_path_list.append((path, file_id))
276
if file_id not in old_entries:
278
# Ensure no file is added before its parent
280
for path, file_id in new_path_list:
284
parent = by_path[os.path.dirname(path)]
285
kind = bzrlib.osutils.file_kind(os.path.join(root, path))
286
new_inventory[file_id] = (path, file_id, parent, kind)
287
by_path[path] = file_id
289
# Get a list in insertion order
290
new_inventory_list = new_inventory.values()
291
mutter ("""Inventory regeneration:
292
old length: %i insertions: %i deletions: %i new_length: %i"""\
293
% (len(old_entries), insertions, deletions, len(new_inventory_list)))
294
assert len(new_inventory_list) == len(old_entries) + insertions - deletions
295
new_inventory_list.sort()
296
return new_inventory_list
428
def contents_sha1(tree, file_id):
429
"""Determine the sha1 of the file contents (used as a key method)."""
430
if file_id not in tree:
432
return tree.get_file_sha1(file_id)
435
def executable(tree, file_id):
436
"""Determine the executability of a file-id (used as a key method)."""
437
if file_id not in tree:
439
if tree.kind(file_id) != "file":
441
return tree.is_executable(file_id)
444
def kind(tree, file_id):
445
"""Determine the kind of a file-id (used as a key method)."""
446
if file_id not in tree:
448
return tree.kind(file_id)
451
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
452
"""Do a three-way test on a scalar.
453
Return "this", "other" or "conflict", depending whether a value wins.
455
key_base = key(base_tree, file_id)
456
key_other = key(other_tree, file_id)
457
#if base == other, either they all agree, or only THIS has changed.
458
if key_base == key_other:
460
key_this = key(this_tree, file_id)
461
if key_this not in (key_base, key_other):
463
# "Ambiguous clean merge"
464
elif key_this == key_other:
467
assert key_this == key_base
470
def merge_names(self, file_id):
471
"""Perform a merge on file_id names and parents"""
473
if file_id in tree.inventory:
474
return tree.inventory[file_id]
477
this_entry = get_entry(self.this_tree)
478
other_entry = get_entry(self.other_tree)
479
base_entry = get_entry(self.base_tree)
480
name_winner = self.scalar_three_way(this_entry, base_entry,
481
other_entry, file_id, self.name)
482
parent_id_winner = self.scalar_three_way(this_entry, base_entry,
483
other_entry, file_id,
485
if this_entry is None:
486
if name_winner == "this":
487
name_winner = "other"
488
if parent_id_winner == "this":
489
parent_id_winner = "other"
490
if name_winner == "this" and parent_id_winner == "this":
492
if name_winner == "conflict":
493
trans_id = self.tt.trans_id_file_id(file_id)
494
self._raw_conflicts.append(('name conflict', trans_id,
495
self.name(this_entry, file_id),
496
self.name(other_entry, file_id)))
497
if parent_id_winner == "conflict":
498
trans_id = self.tt.trans_id_file_id(file_id)
499
self._raw_conflicts.append(('parent conflict', trans_id,
500
self.parent(this_entry, file_id),
501
self.parent(other_entry, file_id)))
502
if other_entry is None:
503
# it doesn't matter whether the result was 'other' or
504
# 'conflict'-- if there's no 'other', we leave it alone.
506
# if we get here, name_winner and parent_winner are set to safe values.
507
winner_entry = {"this": this_entry, "other": other_entry,
508
"conflict": other_entry}
509
trans_id = self.tt.trans_id_file_id(file_id)
510
parent_id = winner_entry[parent_id_winner].parent_id
511
parent_trans_id = self.tt.trans_id_file_id(parent_id)
512
self.tt.adjust_path(winner_entry[name_winner].name, parent_trans_id,
515
def merge_contents(self, file_id):
516
"""Performa a merge on file_id contents."""
517
def contents_pair(tree):
518
if file_id not in tree:
520
kind = tree.kind(file_id)
522
contents = tree.get_file_sha1(file_id)
523
elif kind == "symlink":
524
contents = tree.get_symlink_target(file_id)
527
return kind, contents
529
def contents_conflict():
530
trans_id = self.tt.trans_id_file_id(file_id)
531
name = self.tt.final_name(trans_id)
532
parent_id = self.tt.final_parent(trans_id)
533
if file_id in self.this_tree.inventory:
534
self.tt.unversion_file(trans_id)
535
self.tt.delete_contents(trans_id)
536
file_group = self._dump_conflicts(name, parent_id, file_id,
538
self._raw_conflicts.append(('contents conflict', file_group))
540
# See SPOT run. run, SPOT, run.
541
# So we're not QUITE repeating ourselves; we do tricky things with
543
base_pair = contents_pair(self.base_tree)
544
other_pair = contents_pair(self.other_tree)
545
if base_pair == other_pair:
546
# OTHER introduced no changes
548
this_pair = contents_pair(self.this_tree)
549
if this_pair == other_pair:
550
# THIS and OTHER introduced the same changes
553
trans_id = self.tt.trans_id_file_id(file_id)
554
if this_pair == base_pair:
555
# only OTHER introduced changes
556
if file_id in self.this_tree:
557
# Remove any existing contents
558
self.tt.delete_contents(trans_id)
559
if file_id in self.other_tree:
560
# OTHER changed the file
561
create_by_entry(self.tt,
562
self.other_tree.inventory[file_id],
563
self.other_tree, trans_id)
564
if file_id not in self.this_tree.inventory:
565
self.tt.version_file(file_id, trans_id)
567
elif file_id in self.this_tree.inventory:
568
# OTHER deleted the file
569
self.tt.unversion_file(trans_id)
571
#BOTH THIS and OTHER introduced changes; scalar conflict
572
elif this_pair[0] == "file" and other_pair[0] == "file":
573
# THIS and OTHER are both files, so text merge. Either
574
# BASE is a file, or both converted to files, so at least we
575
# have agreement that output should be a file.
577
self.text_merge(file_id, trans_id)
579
return contents_conflict()
580
if file_id not in self.this_tree.inventory:
581
self.tt.version_file(file_id, trans_id)
583
self.tt.tree_kind(trans_id)
584
self.tt.delete_contents(trans_id)
589
# Scalar conflict, can't text merge. Dump conflicts
590
return contents_conflict()
592
def get_lines(self, tree, file_id):
593
"""Return the lines in a file, or an empty list."""
595
return tree.get_file(file_id).readlines()
599
def text_merge(self, file_id, trans_id):
600
"""Perform a three-way text merge on a file_id"""
601
# it's possible that we got here with base as a different type.
602
# if so, we just want two-way text conflicts.
603
if file_id in self.base_tree and \
604
self.base_tree.kind(file_id) == "file":
605
base_lines = self.get_lines(self.base_tree, file_id)
608
other_lines = self.get_lines(self.other_tree, file_id)
609
this_lines = self.get_lines(self.this_tree, file_id)
610
m3 = Merge3(base_lines, this_lines, other_lines)
611
start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
612
if self.show_base is True:
613
base_marker = '|' * 7
617
def iter_merge3(retval):
618
retval["text_conflicts"] = False
619
for line in m3.merge_lines(name_a = "TREE",
620
name_b = "MERGE-SOURCE",
621
name_base = "BASE-REVISION",
622
start_marker=start_marker,
623
base_marker=base_marker,
624
reprocess=self.reprocess):
625
if line.startswith(start_marker):
626
retval["text_conflicts"] = True
627
yield line.replace(start_marker, '<' * 7)
631
merge3_iterator = iter_merge3(retval)
632
self.tt.create_file(merge3_iterator, trans_id)
633
if retval["text_conflicts"] is True:
634
self._raw_conflicts.append(('text conflict', trans_id))
635
name = self.tt.final_name(trans_id)
636
parent_id = self.tt.final_parent(trans_id)
637
file_group = self._dump_conflicts(name, parent_id, file_id,
638
this_lines, base_lines,
640
file_group.append(trans_id)
642
def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
643
base_lines=None, other_lines=None, set_version=False,
645
"""Emit conflict files.
646
If this_lines, base_lines, or other_lines are omitted, they will be
647
determined automatically. If set_version is true, the .OTHER, .THIS
648
or .BASE (in that order) will be created as versioned files.
650
data = [('OTHER', self.other_tree, other_lines),
651
('THIS', self.this_tree, this_lines)]
653
data.append(('BASE', self.base_tree, base_lines))
656
for suffix, tree, lines in data:
658
trans_id = self._conflict_file(name, parent_id, tree, file_id,
660
file_group.append(trans_id)
661
if set_version and not versioned:
662
self.tt.version_file(file_id, trans_id)
666
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
668
"""Emit a single conflict file."""
669
name = name + '.' + suffix
670
trans_id = self.tt.create_path(name, parent_id)
671
entry = tree.inventory[file_id]
672
create_by_entry(self.tt, entry, tree, trans_id, lines)
675
def merge_executable(self, file_id, file_status):
676
"""Perform a merge on the execute bit."""
677
if file_status == "deleted":
679
trans_id = self.tt.trans_id_file_id(file_id)
681
if self.tt.final_kind(trans_id) != "file":
685
winner = self.scalar_three_way(self.this_tree, self.base_tree,
686
self.other_tree, file_id,
688
if winner == "conflict":
689
# There must be a None in here, if we have a conflict, but we
690
# need executability since file status was not deleted.
691
if self.executable(self.other_tree, file_id) is None:
696
if file_status == "modified":
697
executability = self.this_tree.is_executable(file_id)
698
if executability is not None:
699
trans_id = self.tt.trans_id_file_id(file_id)
700
self.tt.set_executability(executability, trans_id)
702
assert winner == "other"
703
if file_id in self.other_tree:
704
executability = self.other_tree.is_executable(file_id)
705
elif file_id in self.this_tree:
706
executability = self.this_tree.is_executable(file_id)
707
elif file_id in self.base_tree:
708
executability = self.base_tree.is_executable(file_id)
709
if executability is not None:
710
trans_id = self.tt.trans_id_file_id(file_id)
711
self.tt.set_executability(executability, trans_id)
713
def cook_conflicts(self, fs_conflicts):
714
"""Convert all conflicts into a form that doesn't depend on trans_id"""
715
from conflicts import Conflict
717
self.cooked_conflicts.extend(cook_conflicts(fs_conflicts, self.tt))
718
fp = FinalPaths(self.tt)
719
for conflict in self._raw_conflicts:
720
conflict_type = conflict[0]
721
if conflict_type in ('name conflict', 'parent conflict'):
722
trans_id = conflict[1]
723
conflict_args = conflict[2:]
724
if trans_id not in name_conflicts:
725
name_conflicts[trans_id] = {}
726
unique_add(name_conflicts[trans_id], conflict_type,
728
if conflict_type == 'contents conflict':
729
for trans_id in conflict[1]:
730
file_id = self.tt.final_file_id(trans_id)
731
if file_id is not None:
733
path = fp.get_path(trans_id)
734
for suffix in ('.BASE', '.THIS', '.OTHER'):
735
if path.endswith(suffix):
736
path = path[:-len(suffix)]
738
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
739
self.cooked_conflicts.append(c)
740
if conflict_type == 'text conflict':
741
trans_id = conflict[1]
742
path = fp.get_path(trans_id)
743
file_id = self.tt.final_file_id(trans_id)
744
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
745
self.cooked_conflicts.append(c)
747
for trans_id, conflicts in name_conflicts.iteritems():
749
this_parent, other_parent = conflicts['parent conflict']
750
assert this_parent != other_parent
752
this_parent = other_parent = \
753
self.tt.final_file_id(self.tt.final_parent(trans_id))
755
this_name, other_name = conflicts['name conflict']
756
assert this_name != other_name
758
this_name = other_name = self.tt.final_name(trans_id)
759
other_path = fp.get_path(trans_id)
760
if this_parent is not None:
762
fp.get_path(self.tt.trans_id_file_id(this_parent))
763
this_path = pathjoin(this_parent_path, this_name)
765
this_path = "<deleted>"
766
file_id = self.tt.final_file_id(trans_id)
767
c = Conflict.factory('path conflict', path=this_path,
768
conflict_path=other_path, file_id=file_id)
769
self.cooked_conflicts.append(c)
770
self.cooked_conflicts.sort(key=Conflict.sort_key)
773
class WeaveMerger(Merge3Merger):
774
"""Three-way tree merger, text weave merger."""
775
supports_reprocess = True
776
supports_show_base = False
778
def __init__(self, working_tree, this_tree, base_tree, other_tree,
779
interesting_ids=None, pb=DummyProgress(), pp=None,
781
self.this_revision_tree = self._get_revision_tree(this_tree)
782
self.other_revision_tree = self._get_revision_tree(other_tree)
783
super(WeaveMerger, self).__init__(working_tree, this_tree,
784
base_tree, other_tree,
785
interesting_ids=interesting_ids,
786
pb=pb, pp=pp, reprocess=reprocess)
788
def _get_revision_tree(self, tree):
789
"""Return a revision tree related to this tree.
790
If the tree is a WorkingTree, the basis will be returned.
792
if getattr(tree, 'get_weave', False) is False:
793
# If we have a WorkingTree, try using the basis
794
return tree.branch.basis_tree()
798
def _check_file(self, file_id):
799
"""Check that the revision tree's version of the file matches."""
800
for tree, rt in ((self.this_tree, self.this_revision_tree),
801
(self.other_tree, self.other_revision_tree)):
804
if tree.get_file_sha1(file_id) != rt.get_file_sha1(file_id):
805
raise WorkingTreeNotRevision(self.this_tree)
807
def _merged_lines(self, file_id):
808
"""Generate the merged lines.
809
There is no distinction between lines that are meant to contain <<<<<<<
812
weave = self.this_revision_tree.get_weave(file_id)
813
this_revision_id = self.this_revision_tree.inventory[file_id].revision
814
other_revision_id = \
815
self.other_revision_tree.inventory[file_id].revision
816
wm = WeaveMerge(weave, this_revision_id, other_revision_id,
817
'<<<<<<< TREE\n', '>>>>>>> MERGE-SOURCE\n')
818
return wm.merge_lines(self.reprocess)
820
def text_merge(self, file_id, trans_id):
821
"""Perform a (weave) text merge for a given file and file-id.
822
If conflicts are encountered, .THIS and .OTHER files will be emitted,
823
and a conflict will be noted.
825
self._check_file(file_id)
826
lines, conflicts = self._merged_lines(file_id)
828
# Note we're checking whether the OUTPUT is binary in this case,
829
# because we don't want to get into weave merge guts.
830
check_text_lines(lines)
831
self.tt.create_file(lines, trans_id)
833
self._raw_conflicts.append(('text conflict', trans_id))
834
name = self.tt.final_name(trans_id)
835
parent_id = self.tt.final_parent(trans_id)
836
file_group = self._dump_conflicts(name, parent_id, file_id,
838
file_group.append(trans_id)
841
class Diff3Merger(Merge3Merger):
842
"""Three-way merger using external diff3 for text merging"""
844
def dump_file(self, temp_dir, name, tree, file_id):
845
out_path = pathjoin(temp_dir, name)
846
out_file = open(out_path, "wb")
848
in_file = tree.get_file(file_id)
855
def text_merge(self, file_id, trans_id):
856
"""Perform a diff3 merge using a specified file-id and trans-id.
857
If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
858
will be dumped, and a will be conflict noted.
861
temp_dir = mkdtemp(prefix="bzr-")
863
new_file = pathjoin(temp_dir, "new")
864
this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
865
base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
866
other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
867
status = bzrlib.patch.diff3(new_file, this, base, other)
868
if status not in (0, 1):
869
raise BzrError("Unhandled diff3 exit code")
870
f = open(new_file, 'rb')
872
self.tt.create_file(f, trans_id)
876
name = self.tt.final_name(trans_id)
877
parent_id = self.tt.final_parent(trans_id)
878
self._dump_conflicts(name, parent_id, file_id)
879
self._raw_conflicts.append(('text conflict', trans_id))
884
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
886
merge_type=Merge3Merger,
887
interesting_ids=None,
891
interesting_files=None,
894
"""Primary interface for merging.
896
typical use is probably
897
'merge_inner(branch, branch.get_revision_tree(other_revision),
898
branch.get_revision_tree(base_revision))'
900
if this_tree is None:
901
warnings.warn("bzrlib.merge.merge_inner requires a this_tree parameter as of "
902
"bzrlib version 0.8.",
905
this_tree = this_branch.bzrdir.open_workingtree()
906
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
908
merger.backup_files = backup_files
909
merger.merge_type = merge_type
910
merger.interesting_ids = interesting_ids
911
merger.ignore_zero = ignore_zero
912
if interesting_files:
913
assert not interesting_ids, ('Only supply interesting_ids'
914
' or interesting_files')
915
merger._set_interesting_files(interesting_files)
916
merger.show_base = show_base
917
merger.reprocess = reprocess
918
merger.other_rev_id = other_rev_id
919
merger.other_basis = other_rev_id
920
return merger.do_merge()
923
merge_types = { "merge3": (Merge3Merger, "Native diff3-style merge"),
924
"diff3": (Diff3Merger, "Merge using external diff3"),
925
'weave': (WeaveMerger, "Weave-based merge")
929
def merge_type_help():
930
templ = '%s%%7s: %%s' % (' '*12)
931
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
932
return '\n'.join(lines)
added
removed
bzrlib/merge.py
