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 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 shutil import rmtree
21
from tempfile import mkdtemp
24
from bzrlib.branch import Branch
25
from bzrlib.delta import compare_trees
26
from bzrlib.errors import (BzrCommandError,
35
WorkingTreeNotRevision,
37
from bzrlib.merge3 import Merge3
5
38
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))
84
if not self.ignore_zero:
85
print "%d conflicts encountered.\n" % self.conflicts
87
class SourceFile(object):
88
def __init__(self, path, id, present=None, isdir=None):
91
self.present = present
93
self.interesting = True
96
return "SourceFile(%s, %s)" % (self.path, self.id)
98
def get_tree(treespec, temp_root, label):
39
from bzrlib.osutils import rename, pathjoin
40
from progress import DummyProgress, ProgressPhase
41
from bzrlib.revision import common_ancestor, is_ancestor, NULL_REVISION
42
from bzrlib.symbol_versioning import *
43
from bzrlib.trace import mutter, warning, note
44
from bzrlib.transform import (TreeTransform, resolve_conflicts, cook_conflicts,
45
conflicts_strings, FinalPaths, create_by_entry,
49
# TODO: Report back as changes are merged in
51
def _get_tree(treespec, local_branch=None):
99
52
location, revno = treespec
100
branch = find_branch(location)
53
branch = Branch.open_containing(location)[0]
102
base_tree = branch.working_tree()
104
base_tree = branch.basis_tree()
106
base_tree = branch.revision_tree(branch.lookup_revision(revno))
107
temp_path = os.path.join(temp_root, label)
109
return branch, MergeTree(base_tree, temp_path)
112
def abspath(tree, file_id):
113
path = tree.inventory.id2path(file_id)
118
def file_exists(tree, file_id):
119
return tree.has_filename(tree.id2path(file_id))
121
def inventory_map(tree):
123
for file_id in tree.inventory:
124
if not file_exists(tree, file_id):
126
path = abspath(tree, file_id)
127
inventory[path] = SourceFile(path, file_id)
131
class MergeTree(object):
132
def __init__(self, tree, tempdir):
57
revision = branch.last_revision()
59
revision = branch.get_rev_id(revno)
61
revision = NULL_REVISION
62
return branch, _get_revid_tree(branch, revision, local_branch)
65
def _get_revid_tree(branch, revision, local_branch):
67
base_tree = branch.bzrdir.open_workingtree()
69
if local_branch is not None:
70
if local_branch.base != branch.base:
71
local_branch.fetch(branch, revision)
72
base_tree = local_branch.repository.revision_tree(revision)
74
base_tree = branch.repository.revision_tree(revision)
78
def transform_tree(from_tree, to_tree, interesting_ids=None):
79
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
80
interesting_ids=interesting_ids, this_tree=from_tree)
84
def __init__(self, this_branch, other_tree=None, base_tree=None,
85
this_tree=None, pb=DummyProgress()):
133
86
object.__init__(self)
134
if hasattr(tree, "basedir"):
135
self.root = tree.basedir
138
self.inventory = inventory_map(tree)
140
self.tempdir = tempdir
141
os.mkdir(os.path.join(self.tempdir, "texts"))
144
def readonly_path(self, id):
145
if self.root is not None:
146
return self.tree.abspath(self.tree.id2path(id))
148
if self.tree.inventory[id].kind in ("directory", "root_directory"):
150
if not self.cached.has_key(id):
151
path = os.path.join(self.tempdir, "texts", id)
152
outfile = file(path, "wb")
153
outfile.write(self.tree.get_file(id).read())
154
assert(os.path.exists(path))
155
self.cached[id] = path
156
return self.cached[id]
160
def merge(other_revision, base_revision,
161
check_clean=True, ignore_zero=False,
163
"""Merge changes into a tree.
166
Base for three-way merge.
168
Other revision for three-way merge.
170
Directory to merge changes into; '.' by default.
172
If true, this_dir must have no uncommitted changes before the
175
tempdir = tempfile.mkdtemp(prefix="bzr-")
179
this_branch = find_branch(this_dir)
87
assert this_tree is not None, "this_tree is required"
88
self.this_branch = this_branch
89
self.this_basis = this_branch.last_revision()
90
self.this_rev_id = None
91
self.this_tree = this_tree
92
self.this_revision_tree = None
93
self.this_basis_tree = None
94
self.other_tree = other_tree
95
self.base_tree = base_tree
96
self.ignore_zero = False
97
self.backup_files = False
98
self.interesting_ids = None
99
self.show_base = False
100
self.reprocess = False
105
def revision_tree(self, revision_id):
106
return self.this_branch.repository.revision_tree(revision_id)
108
def ensure_revision_trees(self):
109
if self.this_revision_tree is None:
110
self.this_basis_tree = self.this_branch.repository.revision_tree(
112
if self.this_basis == self.this_rev_id:
113
self.this_revision_tree = self.this_basis_tree
115
if self.other_rev_id is None:
116
other_basis_tree = self.revision_tree(self.other_basis)
117
changes = compare_trees(self.other_tree, other_basis_tree)
118
if changes.has_changed():
119
raise WorkingTreeNotRevision(self.this_tree)
120
other_rev_id = other_basis
121
self.other_tree = other_basis_tree
123
def file_revisions(self, file_id):
124
self.ensure_revision_trees()
125
def get_id(tree, file_id):
126
revision_id = tree.inventory[file_id].revision
127
assert revision_id is not None
129
if self.this_rev_id is None:
130
if self.this_basis_tree.get_file_sha1(file_id) != \
131
self.this_tree.get_file_sha1(file_id):
132
raise WorkingTreeNotRevision(self.this_tree)
134
trees = (self.this_basis_tree, self.other_tree)
135
return [get_id(tree, file_id) for tree in trees]
137
def check_basis(self, check_clean):
138
if self.this_basis is None:
139
raise BzrCommandError("This branch has no commits")
181
changes = compare_trees(this_branch.working_tree(),
182
this_branch.basis_tree(), False)
183
if changes.has_changed():
142
if self.this_basis != self.this_rev_id:
184
143
raise BzrCommandError("Working tree has uncommitted changes.")
185
other_branch, other_tree = get_tree(other_revision, tempdir, "other")
145
def compare_basis(self):
146
changes = compare_trees(self.this_tree,
147
self.this_tree.basis_tree(), False)
148
if not changes.has_changed():
149
self.this_rev_id = self.this_basis
151
def set_interesting_files(self, file_list):
153
self._set_interesting_files(file_list)
154
except NotVersionedError, e:
155
raise BzrCommandError("%s is not a source file in any"
158
def _set_interesting_files(self, file_list):
159
"""Set the list of interesting ids from a list of files."""
160
if file_list is None:
161
self.interesting_ids = None
164
interesting_ids = set()
165
for path in file_list:
167
for tree in (self.this_tree, self.base_tree, self.other_tree):
168
file_id = tree.inventory.path2id(path)
169
if file_id is not None:
170
interesting_ids.add(file_id)
173
raise NotVersionedError(path=path)
174
self.interesting_ids = interesting_ids
176
def set_pending(self):
177
if not self.base_is_ancestor:
179
if self.other_rev_id is None:
181
ancestry = self.this_branch.repository.get_ancestry(self.this_basis)
182
if self.other_rev_id in ancestry:
184
self.this_tree.add_pending_merge(self.other_rev_id)
186
def set_other(self, other_revision):
187
other_branch, self.other_tree = _get_tree(other_revision,
189
if other_revision[1] == -1:
190
self.other_rev_id = other_branch.last_revision()
191
if self.other_rev_id is None:
192
raise NoCommits(other_branch)
193
self.other_basis = self.other_rev_id
194
elif other_revision[1] is not None:
195
self.other_rev_id = other_branch.get_rev_id(other_revision[1])
196
self.other_basis = self.other_rev_id
198
self.other_rev_id = None
199
self.other_basis = other_branch.last_revision()
200
if self.other_basis is None:
201
raise NoCommits(other_branch)
202
if other_branch.base != self.this_branch.base:
203
self.this_branch.fetch(other_branch, last_revision=self.other_basis)
205
def set_base(self, base_revision):
206
mutter("doing merge() with no base_revision specified")
186
207
if base_revision == [None, None]:
187
if other_revision[1] == -1:
190
o_revno = other_revision[1]
191
base_revno = this_branch.common_ancestor(other_branch,
192
other_revno=o_revno)[0]
193
if base_revno is None:
209
pb = bzrlib.ui.ui_factory.nested_progress_bar()
211
this_repo = self.this_branch.repository
212
self.base_rev_id = common_ancestor(self.this_basis,
217
except NoCommonAncestor:
194
218
raise UnrelatedBranches()
195
base_revision = ['.', base_revno]
196
base_branch, base_tree = get_tree(base_revision, tempdir, "base")
197
merge_inner(this_branch, other_tree, base_tree, tempdir,
198
ignore_zero=ignore_zero)
200
shutil.rmtree(tempdir)
203
def generate_cset_optimized(tree_a, tree_b, inventory_a, inventory_b):
204
"""Generate a changeset, using the text_id to mark really-changed files.
205
This permits blazing comparisons when text_ids are present. It also
206
disables metadata comparison for files with identical texts.
208
for file_id in tree_a.tree.inventory:
209
if file_id not in tree_b.tree.inventory:
211
entry_a = tree_a.tree.inventory[file_id]
212
entry_b = tree_b.tree.inventory[file_id]
213
if (entry_a.kind, entry_b.kind) != ("file", "file"):
215
if None in (entry_a.text_id, entry_b.text_id):
217
if entry_a.text_id != entry_b.text_id:
219
inventory_a[abspath(tree_a.tree, file_id)].interesting = False
220
inventory_b[abspath(tree_b.tree, file_id)].interesting = False
221
cset = generate_changeset(tree_a, tree_b, inventory_a, inventory_b)
222
for entry in cset.entries.itervalues():
223
entry.metadata_change = None
227
def merge_inner(this_branch, other_tree, base_tree, tempdir,
229
this_tree = get_tree((this_branch.base, None), tempdir, "this")[1]
231
def get_inventory(tree):
232
return tree.inventory
234
inv_changes = merge_flex(this_tree, base_tree, other_tree,
235
generate_cset_optimized, get_inventory,
236
MergeConflictHandler(base_tree.root,
237
ignore_zero=ignore_zero))
240
for id, path in inv_changes.iteritems():
245
assert path.startswith('./')
247
adjust_ids.append((path, id))
248
this_branch.set_inventory(regen_inventory(this_branch, this_tree.root, adjust_ids))
251
def regen_inventory(this_branch, root, new_entries):
252
old_entries = this_branch.read_working_inventory()
255
for file_id in old_entries:
256
entry = old_entries[file_id]
257
path = old_entries.id2path(file_id)
258
new_inventory[file_id] = (path, file_id, entry.parent_id, entry.kind)
259
by_path[path] = file_id
219
self.base_tree = _get_revid_tree(self.this_branch, self.base_rev_id,
221
self.base_is_ancestor = True
223
base_branch, self.base_tree = _get_tree(base_revision)
224
if base_revision[1] == -1:
225
self.base_rev_id = base_branch.last_revision()
226
elif base_revision[1] is None:
227
self.base_rev_id = None
229
self.base_rev_id = base_branch.get_rev_id(base_revision[1])
230
if self.this_branch.base != base_branch.base:
231
self.this_branch.fetch(base_branch)
232
self.base_is_ancestor = is_ancestor(self.this_basis,
237
kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
238
'other_tree': self.other_tree,
239
'interesting_ids': self.interesting_ids,
241
if self.merge_type.requires_base:
242
kwargs['base_tree'] = self.base_tree
243
if self.merge_type.supports_reprocess:
244
kwargs['reprocess'] = self.reprocess
246
raise BzrError("Reprocess is not supported for this merge"
247
" type. %s" % merge_type)
248
if self.merge_type.supports_show_base:
249
kwargs['show_base'] = self.show_base
251
raise BzrError("Showing base is not supported for this"
252
" merge type. %s" % self.merge_type)
253
merge = self.merge_type(pb=self._pb, **kwargs)
254
if len(merge.cooked_conflicts) == 0:
255
if not self.ignore_zero:
256
note("All changes applied successfully.")
258
note("%d conflicts encountered." % len(merge.cooked_conflicts))
260
return len(merge.cooked_conflicts)
262
def regen_inventory(self, new_entries):
263
old_entries = self.this_tree.read_working_inventory()
267
for path, file_id in new_entries:
270
new_entries_map[file_id] = path
272
def id2path(file_id):
273
path = new_entries_map.get(file_id)
276
entry = old_entries[file_id]
277
if entry.parent_id is None:
279
return pathjoin(id2path(entry.parent_id), entry.name)
281
for file_id in old_entries:
282
entry = old_entries[file_id]
283
path = id2path(file_id)
284
new_inventory[file_id] = (path, file_id, entry.parent_id,
286
by_path[path] = file_id
291
for path, file_id in new_entries:
293
del new_inventory[file_id]
296
new_path_list.append((path, file_id))
297
if file_id not in old_entries:
299
# Ensure no file is added before its parent
301
for path, file_id in new_path_list:
305
parent = by_path[os.path.dirname(path)]
306
abspath = pathjoin(self.this_tree.basedir, path)
307
kind = bzrlib.osutils.file_kind(abspath)
308
new_inventory[file_id] = (path, file_id, parent, kind)
309
by_path[path] = file_id
311
# Get a list in insertion order
312
new_inventory_list = new_inventory.values()
313
mutter ("""Inventory regeneration:
314
old length: %i insertions: %i deletions: %i new_length: %i"""\
315
% (len(old_entries), insertions, deletions,
316
len(new_inventory_list)))
317
assert len(new_inventory_list) == len(old_entries) + insertions\
319
new_inventory_list.sort()
320
return new_inventory_list
323
class Merge3Merger(object):
324
"""Three-way merger that uses the merge3 text merger"""
326
supports_reprocess = True
327
supports_show_base = True
328
history_based = False
330
def __init__(self, working_tree, this_tree, base_tree, other_tree,
331
interesting_ids=None, reprocess=False, show_base=False,
332
pb=DummyProgress(), pp=None):
333
"""Initialize the merger object and perform the merge."""
334
object.__init__(self)
335
self.this_tree = working_tree
336
self.base_tree = base_tree
337
self.other_tree = other_tree
338
self._raw_conflicts = []
339
self.cooked_conflicts = []
340
self.reprocess = reprocess
341
self.show_base = show_base
345
self.pp = ProgressPhase("Merge phase", 3, self.pb)
347
if interesting_ids is not None:
348
all_ids = interesting_ids
350
all_ids = set(base_tree)
351
all_ids.update(other_tree)
352
working_tree.lock_write()
353
self.tt = TreeTransform(working_tree, self.pb)
356
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
358
for num, file_id in enumerate(all_ids):
359
child_pb.update('Preparing file merge', num, len(all_ids))
360
self.merge_names(file_id)
361
file_status = self.merge_contents(file_id)
362
self.merge_executable(file_id, file_status)
367
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
369
fs_conflicts = resolve_conflicts(self.tt, child_pb)
372
self.cook_conflicts(fs_conflicts)
373
for line in conflicts_strings(self.cooked_conflicts):
376
results = self.tt.apply()
377
self.write_modified(results)
383
working_tree.unlock()
386
def write_modified(self, results):
388
for path in results.modified_paths:
389
file_id = self.this_tree.path2id(self.this_tree.relpath(path))
392
hash = self.this_tree.get_file_sha1(file_id)
395
modified_hashes[file_id] = hash
396
self.this_tree.set_merge_modified(modified_hashes)
399
def parent(entry, file_id):
400
"""Determine the parent for a file_id (used as a key method)"""
403
return entry.parent_id
406
def name(entry, file_id):
407
"""Determine the name for a file_id (used as a key method)"""
264
for path, file_id in new_entries:
266
del new_inventory[file_id]
269
new_path_list.append((path, file_id))
270
if file_id not in old_entries:
272
# Ensure no file is added before its parent
274
for path, file_id in new_path_list:
278
parent = by_path[os.path.dirname(path)]
279
kind = bzrlib.osutils.file_kind(os.path.join(root, path))
280
new_inventory[file_id] = (path, file_id, parent, kind)
281
by_path[path] = file_id
283
# Get a list in insertion order
284
new_inventory_list = new_inventory.values()
285
mutter ("""Inventory regeneration:
286
old length: %i insertions: %i deletions: %i new_length: %i"""\
287
% (len(old_entries), insertions, deletions, len(new_inventory_list)))
288
assert len(new_inventory_list) == len(old_entries) + insertions - deletions
289
new_inventory_list.sort()
290
return new_inventory_list
413
def contents_sha1(tree, file_id):
414
"""Determine the sha1 of the file contents (used as a key method)."""
415
if file_id not in tree:
417
return tree.get_file_sha1(file_id)
420
def executable(tree, file_id):
421
"""Determine the executability of a file-id (used as a key method)."""
422
if file_id not in tree:
424
if tree.kind(file_id) != "file":
426
return tree.is_executable(file_id)
429
def kind(tree, file_id):
430
"""Determine the kind of a file-id (used as a key method)."""
431
if file_id not in tree:
433
return tree.kind(file_id)
436
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
437
"""Do a three-way test on a scalar.
438
Return "this", "other" or "conflict", depending whether a value wins.
440
key_base = key(base_tree, file_id)
441
key_other = key(other_tree, file_id)
442
#if base == other, either they all agree, or only THIS has changed.
443
if key_base == key_other:
445
key_this = key(this_tree, file_id)
446
if key_this not in (key_base, key_other):
448
# "Ambiguous clean merge"
449
elif key_this == key_other:
452
assert key_this == key_base
455
def merge_names(self, file_id):
456
"""Perform a merge on file_id names and parents"""
458
if file_id in tree.inventory:
459
return tree.inventory[file_id]
462
this_entry = get_entry(self.this_tree)
463
other_entry = get_entry(self.other_tree)
464
base_entry = get_entry(self.base_tree)
465
name_winner = self.scalar_three_way(this_entry, base_entry,
466
other_entry, file_id, self.name)
467
parent_id_winner = self.scalar_three_way(this_entry, base_entry,
468
other_entry, file_id,
470
if this_entry is None:
471
if name_winner == "this":
472
name_winner = "other"
473
if parent_id_winner == "this":
474
parent_id_winner = "other"
475
if name_winner == "this" and parent_id_winner == "this":
477
if name_winner == "conflict":
478
trans_id = self.tt.trans_id_file_id(file_id)
479
self._raw_conflicts.append(('name conflict', trans_id,
480
self.name(this_entry, file_id),
481
self.name(other_entry, file_id)))
482
if parent_id_winner == "conflict":
483
trans_id = self.tt.trans_id_file_id(file_id)
484
self._raw_conflicts.append(('parent conflict', trans_id,
485
self.parent(this_entry, file_id),
486
self.parent(other_entry, file_id)))
487
if other_entry is None:
488
# it doesn't matter whether the result was 'other' or
489
# 'conflict'-- if there's no 'other', we leave it alone.
491
# if we get here, name_winner and parent_winner are set to safe values.
492
winner_entry = {"this": this_entry, "other": other_entry,
493
"conflict": other_entry}
494
trans_id = self.tt.trans_id_file_id(file_id)
495
parent_id = winner_entry[parent_id_winner].parent_id
496
parent_trans_id = self.tt.trans_id_file_id(parent_id)
497
self.tt.adjust_path(winner_entry[name_winner].name, parent_trans_id,
500
def merge_contents(self, file_id):
501
"""Performa a merge on file_id contents."""
502
def contents_pair(tree):
503
if file_id not in tree:
505
kind = tree.kind(file_id)
506
if kind == "root_directory":
509
contents = tree.get_file_sha1(file_id)
510
elif kind == "symlink":
511
contents = tree.get_symlink_target(file_id)
514
return kind, contents
515
# See SPOT run. run, SPOT, run.
516
# So we're not QUITE repeating ourselves; we do tricky things with
518
base_pair = contents_pair(self.base_tree)
519
other_pair = contents_pair(self.other_tree)
520
if base_pair == other_pair:
521
# OTHER introduced no changes
523
this_pair = contents_pair(self.this_tree)
524
if this_pair == other_pair:
525
# THIS and OTHER introduced the same changes
528
trans_id = self.tt.trans_id_file_id(file_id)
529
if this_pair == base_pair:
530
# only OTHER introduced changes
531
if file_id in self.this_tree:
532
# Remove any existing contents
533
self.tt.delete_contents(trans_id)
534
if file_id in self.other_tree:
535
# OTHER changed the file
536
create_by_entry(self.tt,
537
self.other_tree.inventory[file_id],
538
self.other_tree, trans_id)
539
if file_id not in self.this_tree.inventory:
540
self.tt.version_file(file_id, trans_id)
542
elif file_id in self.this_tree.inventory:
543
# OTHER deleted the file
544
self.tt.unversion_file(trans_id)
546
#BOTH THIS and OTHER introduced changes; scalar conflict
547
elif this_pair[0] == "file" and other_pair[0] == "file":
548
# THIS and OTHER are both files, so text merge. Either
549
# BASE is a file, or both converted to files, so at least we
550
# have agreement that output should be a file.
551
if file_id not in self.this_tree.inventory:
552
self.tt.version_file(file_id, trans_id)
553
self.text_merge(file_id, trans_id)
555
self.tt.tree_kind(trans_id)
556
self.tt.delete_contents(trans_id)
561
# Scalar conflict, can't text merge. Dump conflicts
562
trans_id = self.tt.trans_id_file_id(file_id)
563
name = self.tt.final_name(trans_id)
564
parent_id = self.tt.final_parent(trans_id)
565
if file_id in self.this_tree.inventory:
566
self.tt.unversion_file(trans_id)
567
self.tt.delete_contents(trans_id)
568
file_group = self._dump_conflicts(name, parent_id, file_id,
570
self._raw_conflicts.append(('contents conflict', file_group))
572
def get_lines(self, tree, file_id):
573
"""Return the lines in a file, or an empty list."""
575
return tree.get_file(file_id).readlines()
579
def text_merge(self, file_id, trans_id):
580
"""Perform a three-way text merge on a file_id"""
581
# it's possible that we got here with base as a different type.
582
# if so, we just want two-way text conflicts.
583
if file_id in self.base_tree and \
584
self.base_tree.kind(file_id) == "file":
585
base_lines = self.get_lines(self.base_tree, file_id)
588
other_lines = self.get_lines(self.other_tree, file_id)
589
this_lines = self.get_lines(self.this_tree, file_id)
590
m3 = Merge3(base_lines, this_lines, other_lines)
591
start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
592
if self.show_base is True:
593
base_marker = '|' * 7
597
def iter_merge3(retval):
598
retval["text_conflicts"] = False
599
for line in m3.merge_lines(name_a = "TREE",
600
name_b = "MERGE-SOURCE",
601
name_base = "BASE-REVISION",
602
start_marker=start_marker,
603
base_marker=base_marker,
604
reprocess=self.reprocess):
605
if line.startswith(start_marker):
606
retval["text_conflicts"] = True
607
yield line.replace(start_marker, '<' * 7)
611
merge3_iterator = iter_merge3(retval)
612
self.tt.create_file(merge3_iterator, trans_id)
613
if retval["text_conflicts"] is True:
614
self._raw_conflicts.append(('text conflict', trans_id))
615
name = self.tt.final_name(trans_id)
616
parent_id = self.tt.final_parent(trans_id)
617
file_group = self._dump_conflicts(name, parent_id, file_id,
618
this_lines, base_lines,
620
file_group.append(trans_id)
622
def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
623
base_lines=None, other_lines=None, set_version=False,
625
"""Emit conflict files.
626
If this_lines, base_lines, or other_lines are omitted, they will be
627
determined automatically. If set_version is true, the .OTHER, .THIS
628
or .BASE (in that order) will be created as versioned files.
630
data = [('OTHER', self.other_tree, other_lines),
631
('THIS', self.this_tree, this_lines)]
633
data.append(('BASE', self.base_tree, base_lines))
636
for suffix, tree, lines in data:
638
trans_id = self._conflict_file(name, parent_id, tree, file_id,
640
file_group.append(trans_id)
641
if set_version and not versioned:
642
self.tt.version_file(file_id, trans_id)
646
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
648
"""Emit a single conflict file."""
649
name = name + '.' + suffix
650
trans_id = self.tt.create_path(name, parent_id)
651
entry = tree.inventory[file_id]
652
create_by_entry(self.tt, entry, tree, trans_id, lines)
655
def merge_executable(self, file_id, file_status):
656
"""Perform a merge on the execute bit."""
657
if file_status == "deleted":
659
trans_id = self.tt.trans_id_file_id(file_id)
661
if self.tt.final_kind(trans_id) != "file":
665
winner = self.scalar_three_way(self.this_tree, self.base_tree,
666
self.other_tree, file_id,
668
if winner == "conflict":
669
# There must be a None in here, if we have a conflict, but we
670
# need executability since file status was not deleted.
671
if self.other_tree.is_executable(file_id) is None:
676
if file_status == "modified":
677
executability = self.this_tree.is_executable(file_id)
678
if executability is not None:
679
trans_id = self.tt.trans_id_file_id(file_id)
680
self.tt.set_executability(executability, trans_id)
682
assert winner == "other"
683
if file_id in self.other_tree:
684
executability = self.other_tree.is_executable(file_id)
685
elif file_id in self.this_tree:
686
executability = self.this_tree.is_executable(file_id)
687
elif file_id in self.base_tree:
688
executability = self.base_tree.is_executable(file_id)
689
if executability is not None:
690
trans_id = self.tt.trans_id_file_id(file_id)
691
self.tt.set_executability(executability, trans_id)
693
def cook_conflicts(self, fs_conflicts):
694
"""Convert all conflicts into a form that doesn't depend on trans_id"""
696
self.cooked_conflicts.extend(cook_conflicts(fs_conflicts, self.tt))
697
fp = FinalPaths(self.tt)
698
for conflict in self._raw_conflicts:
699
conflict_type = conflict[0]
700
if conflict_type in ('name conflict', 'parent conflict'):
701
trans_id = conflict[1]
702
conflict_args = conflict[2:]
703
if trans_id not in name_conflicts:
704
name_conflicts[trans_id] = {}
705
unique_add(name_conflicts[trans_id], conflict_type,
707
if conflict_type == 'contents conflict':
708
for trans_id in conflict[1]:
709
file_id = self.tt.final_file_id(trans_id)
710
if file_id is not None:
712
path = fp.get_path(trans_id)
713
for suffix in ('.BASE', '.THIS', '.OTHER'):
714
if path.endswith(suffix):
715
path = path[:-len(suffix)]
717
self.cooked_conflicts.append((conflict_type, file_id, path))
718
if conflict_type == 'text conflict':
719
trans_id = conflict[1]
720
path = fp.get_path(trans_id)
721
file_id = self.tt.final_file_id(trans_id)
722
self.cooked_conflicts.append((conflict_type, file_id, path))
724
for trans_id, conflicts in name_conflicts.iteritems():
726
this_parent, other_parent = conflicts['parent conflict']
727
assert this_parent != other_parent
729
this_parent = other_parent = \
730
self.tt.final_file_id(self.tt.final_parent(trans_id))
732
this_name, other_name = conflicts['name conflict']
733
assert this_name != other_name
735
this_name = other_name = self.tt.final_name(trans_id)
736
other_path = fp.get_path(trans_id)
737
if this_parent is not None:
739
fp.get_path(self.tt.trans_id_file_id(this_parent))
740
this_path = pathjoin(this_parent_path, this_name)
742
this_path = "<deleted>"
743
file_id = self.tt.final_file_id(trans_id)
744
self.cooked_conflicts.append(('path conflict', file_id, this_path,
748
class WeaveMerger(Merge3Merger):
749
"""Three-way tree merger, text weave merger."""
750
supports_reprocess = False
751
supports_show_base = False
753
def __init__(self, working_tree, this_tree, base_tree, other_tree,
754
interesting_ids=None, pb=DummyProgress(), pp=None):
755
self.this_revision_tree = self._get_revision_tree(this_tree)
756
self.other_revision_tree = self._get_revision_tree(other_tree)
757
super(WeaveMerger, self).__init__(working_tree, this_tree,
758
base_tree, other_tree,
759
interesting_ids=interesting_ids,
762
def _get_revision_tree(self, tree):
763
"""Return a revision tree releated to this tree.
764
If the tree is a WorkingTree, the basis will be returned.
766
if getattr(tree, 'get_weave', False) is False:
767
# If we have a WorkingTree, try using the basis
768
return tree.branch.basis_tree()
772
def _check_file(self, file_id):
773
"""Check that the revision tree's version of the file matches."""
774
for tree, rt in ((self.this_tree, self.this_revision_tree),
775
(self.other_tree, self.other_revision_tree)):
778
if tree.get_file_sha1(file_id) != rt.get_file_sha1(file_id):
779
raise WorkingTreeNotRevision(self.this_tree)
781
def _merged_lines(self, file_id):
782
"""Generate the merged lines.
783
There is no distinction between lines that are meant to contain <<<<<<<
786
weave = self.this_revision_tree.get_weave(file_id)
787
this_revision_id = self.this_revision_tree.inventory[file_id].revision
788
other_revision_id = \
789
self.other_revision_tree.inventory[file_id].revision
790
plan = weave.plan_merge(this_revision_id, other_revision_id)
791
return weave.weave_merge(plan, '<<<<<<< TREE\n',
792
'>>>>>>> MERGE-SOURCE\n')
794
def text_merge(self, file_id, trans_id):
795
"""Perform a (weave) text merge for a given file and file-id.
796
If conflicts are encountered, .THIS and .OTHER files will be emitted,
797
and a conflict will be noted.
799
self._check_file(file_id)
800
lines = list(self._merged_lines(file_id))
801
conflicts = '<<<<<<< TREE\n' in lines
802
self.tt.create_file(lines, trans_id)
804
self._raw_conflicts.append(('text conflict', trans_id))
805
name = self.tt.final_name(trans_id)
806
parent_id = self.tt.final_parent(trans_id)
807
file_group = self._dump_conflicts(name, parent_id, file_id,
809
file_group.append(trans_id)
812
class Diff3Merger(Merge3Merger):
813
"""Three-way merger using external diff3 for text merging"""
814
def dump_file(self, temp_dir, name, tree, file_id):
815
out_path = pathjoin(temp_dir, name)
816
out_file = file(out_path, "wb")
817
in_file = tree.get_file(file_id)
822
def text_merge(self, file_id, trans_id):
823
"""Perform a diff3 merge using a specified file-id and trans-id.
824
If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
825
will be dumped, and a will be conflict noted.
828
temp_dir = mkdtemp(prefix="bzr-")
830
new_file = pathjoin(temp_dir, "new")
831
this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
832
base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
833
other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
834
status = bzrlib.patch.diff3(new_file, this, base, other)
835
if status not in (0, 1):
836
raise BzrError("Unhandled diff3 exit code")
837
self.tt.create_file(file(new_file, "rb"), trans_id)
839
name = self.tt.final_name(trans_id)
840
parent_id = self.tt.final_parent(trans_id)
841
self._dump_conflicts(name, parent_id, file_id)
842
self._raw_conflicts.append(('text conflict', trans_id))
847
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
849
merge_type=Merge3Merger,
850
interesting_ids=None,
854
interesting_files=None,
857
"""Primary interface for merging.
859
typical use is probably
860
'merge_inner(branch, branch.get_revision_tree(other_revision),
861
branch.get_revision_tree(base_revision))'
863
if this_tree is None:
864
warn("bzrlib.merge.merge_inner requires a this_tree parameter as of "
865
"bzrlib version 0.8.",
868
this_tree = this_branch.bzrdir.open_workingtree()
869
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
871
merger.backup_files = backup_files
872
merger.merge_type = merge_type
873
merger.interesting_ids = interesting_ids
874
merger.ignore_zero = ignore_zero
875
if interesting_files:
876
assert not interesting_ids, ('Only supply interesting_ids'
877
' or interesting_files')
878
merger._set_interesting_files(interesting_files)
879
merger.show_base = show_base
880
merger.reprocess = reprocess
881
merger.other_rev_id = other_rev_id
882
merger.other_basis = other_rev_id
883
return merger.do_merge()
886
merge_types = { "merge3": (Merge3Merger, "Native diff3-style merge"),
887
"diff3": (Diff3Merger, "Merge using external diff3"),
888
'weave': (WeaveMerger, "Weave-based merge")
added
removed
bzrlib/merge.py
