1
from merge_core import merge_flex
2
from changeset import generate_changeset, ExceptionConflictHandler
3
from changeset import Inventory
4
from bzrlib import Branch
6
from trace import mutter
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
12
class MergeConflictHandler(ExceptionConflictHandler):
13
"""Handle conflicts encountered while merging"""
14
def copy(self, source, dest):
15
"""Copy the text and mode of a file
16
:param source: The path of the file to copy
17
:param dest: The distination file to create
19
s_file = file(source, "rb")
20
d_file = file(dest, "wb")
23
os.chmod(dest, 0777 & os.stat(source).st_mode)
25
def add_suffix(self, name, suffix, last_new_name=None):
26
"""Rename a file to append a suffix. If the new name exists, the
27
suffix is added repeatedly until a non-existant name is found
29
:param name: The path of the file
30
:param suffix: The suffix to append
31
:param last_new_name: (used for recursive calls) the last name tried
33
if last_new_name is None:
35
new_name = last_new_name+suffix
37
os.rename(name, new_name)
39
if e.errno != errno.EEXIST and e.errno != errno.ENOTEMPTY:
41
self.add_suffix(name, suffix, last_new_name=new_name)
43
def merge_conflict(self, new_file, this_path, base_path, other_path):
45
Handle diff3 conflicts by producing a .THIS, .BASE and .OTHER. The
46
main file will be a version with diff3 conflicts.
47
:param new_file: Path to the output file with diff3 markers
48
:param this_path: Path to the file text for the THIS tree
49
:param base_path: Path to the file text for the BASE tree
50
:param other_path: Path to the file text for the OTHER tree
52
self.add_suffix(this_path, ".THIS")
53
self.copy(base_path, this_path+".BASE")
54
self.copy(other_path, this_path+".OTHER")
55
os.rename(new_file, this_path)
57
def target_exists(self, entry, target, old_path):
58
"""Handle the case when the target file or dir exists"""
59
self.add_suffix(target, ".moved")
26
from bzrlib.branch import Branch
27
from bzrlib.conflicts import ConflictList, Conflict
28
from bzrlib.errors import (BzrCommandError,
38
WorkingTreeNotRevision,
41
from bzrlib.merge3 import Merge3
42
from bzrlib.osutils import rename, pathjoin
43
from progress import DummyProgress, ProgressPhase
44
from bzrlib.revision import common_ancestor, is_ancestor, NULL_REVISION
45
from bzrlib.textfile import check_text_lines
46
from bzrlib.trace import mutter, warning, note
47
from bzrlib.transform import (TreeTransform, resolve_conflicts, cook_conflicts,
48
FinalPaths, create_by_entry, unique_add,
50
from bzrlib.versionedfile import WeaveMerge
53
# TODO: Report back as changes are merged in
55
def _get_tree(treespec, local_branch=None):
56
from bzrlib import workingtree
57
location, revno = treespec
59
tree = workingtree.WorkingTree.open_containing(location)[0]
60
return tree.branch, tree
61
branch = Branch.open_containing(location)[0]
63
revision = branch.last_revision()
65
revision = branch.get_rev_id(revno)
67
revision = NULL_REVISION
68
return branch, _get_revid_tree(branch, revision, local_branch)
71
def _get_revid_tree(branch, revision, local_branch):
73
base_tree = branch.bzrdir.open_workingtree()
75
if local_branch is not None:
76
if local_branch.base != branch.base:
77
local_branch.fetch(branch, revision)
78
base_tree = local_branch.repository.revision_tree(revision)
80
base_tree = branch.repository.revision_tree(revision)
84
def transform_tree(from_tree, to_tree, interesting_ids=None):
85
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
86
interesting_ids=interesting_ids, this_tree=from_tree)
90
def __init__(self, this_branch, other_tree=None, base_tree=None,
91
this_tree=None, pb=DummyProgress(), change_reporter=None):
93
assert this_tree is not None, "this_tree is required"
94
self.this_branch = this_branch
95
self.this_basis = this_branch.last_revision()
96
self.this_rev_id = None
97
self.this_tree = this_tree
98
self.this_revision_tree = None
99
self.this_basis_tree = None
100
self.other_tree = other_tree
101
self.base_tree = base_tree
102
self.ignore_zero = False
103
self.backup_files = False
104
self.interesting_ids = None
105
self.show_base = False
106
self.reprocess = False
109
self.change_reporter = change_reporter
111
def revision_tree(self, revision_id):
112
return self.this_branch.repository.revision_tree(revision_id)
114
def ensure_revision_trees(self):
115
if self.this_revision_tree is None:
116
self.this_basis_tree = self.this_branch.repository.revision_tree(
118
if self.this_basis == self.this_rev_id:
119
self.this_revision_tree = self.this_basis_tree
121
if self.other_rev_id is None:
122
other_basis_tree = self.revision_tree(self.other_basis)
123
changes = other_basis_tree.changes_from(self.other_tree)
124
if changes.has_changed():
125
raise WorkingTreeNotRevision(self.this_tree)
126
other_rev_id = self.other_basis
127
self.other_tree = other_basis_tree
129
def file_revisions(self, file_id):
130
self.ensure_revision_trees()
131
def get_id(tree, file_id):
132
revision_id = tree.inventory[file_id].revision
133
assert revision_id is not None
135
if self.this_rev_id is None:
136
if self.this_basis_tree.get_file_sha1(file_id) != \
137
self.this_tree.get_file_sha1(file_id):
138
raise WorkingTreeNotRevision(self.this_tree)
140
trees = (self.this_basis_tree, self.other_tree)
141
return [get_id(tree, file_id) for tree in trees]
143
def check_basis(self, check_clean, require_commits=True):
144
if self.this_basis is None and require_commits is True:
145
raise BzrCommandError("This branch has no commits."
146
" (perhaps you would prefer 'bzr pull')")
149
if self.this_basis != self.this_rev_id:
150
raise BzrCommandError("Working tree has uncommitted changes.")
152
def compare_basis(self):
153
changes = self.this_tree.changes_from(self.this_tree.basis_tree())
154
if not changes.has_changed():
155
self.this_rev_id = self.this_basis
157
def set_interesting_files(self, file_list):
159
self._set_interesting_files(file_list)
160
except NotVersionedError, e:
161
raise BzrCommandError("%s is not a source file in any"
164
def _set_interesting_files(self, file_list):
165
"""Set the list of interesting ids from a list of files."""
166
if file_list is None:
167
self.interesting_ids = None
170
interesting_ids = set()
171
for path in file_list:
173
# TODO: jam 20070226 The trees are not locked at this time,
174
# wouldn't it make merge faster if it locks everything in the
175
# beginning? It locks at do_merge time, but this happens
177
for tree in (self.this_tree, self.base_tree, self.other_tree):
178
file_id = tree.path2id(path)
179
if file_id is not None:
180
interesting_ids.add(file_id)
183
raise NotVersionedError(path=path)
184
self.interesting_ids = interesting_ids
186
def set_pending(self):
187
if not self.base_is_ancestor:
189
if self.other_rev_id is None:
191
ancestry = self.this_branch.repository.get_ancestry(self.this_basis)
192
if self.other_rev_id in ancestry:
194
self.this_tree.add_parent_tree((self.other_rev_id, self.other_tree))
196
def set_other(self, other_revision):
197
"""Set the revision and tree to merge from.
199
This sets the other_tree, other_rev_id, other_basis attributes.
201
:param other_revision: The [path, revision] list to merge from.
203
other_branch, self.other_tree = _get_tree(other_revision,
205
if other_revision[1] == -1:
206
self.other_rev_id = other_branch.last_revision()
207
if self.other_rev_id is None:
208
raise NoCommits(other_branch)
209
self.other_basis = self.other_rev_id
210
elif other_revision[1] is not None:
211
self.other_rev_id = other_branch.get_rev_id(other_revision[1])
212
self.other_basis = self.other_rev_id
214
self.other_rev_id = None
215
self.other_basis = other_branch.last_revision()
216
if self.other_basis is None:
217
raise NoCommits(other_branch)
218
if other_branch.base != self.this_branch.base:
219
self.this_branch.fetch(other_branch, last_revision=self.other_basis)
222
self.set_base([None, None])
224
def set_base(self, base_revision):
225
"""Set the base revision to use for the merge.
227
:param base_revision: A 2-list containing a path and revision number.
229
mutter("doing merge() with no base_revision specified")
230
if base_revision == [None, None]:
232
pb = ui.ui_factory.nested_progress_bar()
234
this_repo = self.this_branch.repository
235
self.base_rev_id = common_ancestor(self.this_basis,
240
except NoCommonAncestor:
241
raise UnrelatedBranches()
242
self.base_tree = _get_revid_tree(self.this_branch, self.base_rev_id,
244
self.base_is_ancestor = True
246
base_branch, self.base_tree = _get_tree(base_revision)
247
if base_revision[1] == -1:
248
self.base_rev_id = base_branch.last_revision()
249
elif base_revision[1] is None:
250
self.base_rev_id = None
252
self.base_rev_id = base_branch.get_rev_id(base_revision[1])
253
if self.this_branch.base != base_branch.base:
254
self.this_branch.fetch(base_branch)
255
self.base_is_ancestor = is_ancestor(self.this_basis,
260
kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
261
'other_tree': self.other_tree,
262
'interesting_ids': self.interesting_ids,
264
if self.merge_type.requires_base:
265
kwargs['base_tree'] = self.base_tree
266
if self.merge_type.supports_reprocess:
267
kwargs['reprocess'] = self.reprocess
269
raise BzrError("Conflict reduction is not supported for merge"
270
" type %s." % self.merge_type)
271
if self.merge_type.supports_show_base:
272
kwargs['show_base'] = self.show_base
274
raise BzrError("Showing base is not supported for this"
275
" merge type. %s" % self.merge_type)
276
self.this_tree.lock_tree_write()
277
if self.base_tree is not None:
278
self.base_tree.lock_read()
279
if self.other_tree is not None:
280
self.other_tree.lock_read()
282
merge = self.merge_type(pb=self._pb,
283
change_reporter=self.change_reporter,
286
if self.other_tree is not None:
287
self.other_tree.unlock()
288
if self.base_tree is not None:
289
self.base_tree.unlock()
290
self.this_tree.unlock()
291
if len(merge.cooked_conflicts) == 0:
292
if not self.ignore_zero:
293
note("All changes applied successfully.")
295
note("%d conflicts encountered." % len(merge.cooked_conflicts))
297
return len(merge.cooked_conflicts)
299
def regen_inventory(self, new_entries):
300
old_entries = self.this_tree.read_working_inventory()
304
for path, file_id in new_entries:
307
new_entries_map[file_id] = path
309
def id2path(file_id):
310
path = new_entries_map.get(file_id)
313
entry = old_entries[file_id]
314
if entry.parent_id is None:
316
return pathjoin(id2path(entry.parent_id), entry.name)
61
class SourceFile(object):
62
def __init__(self, path, id, present=None, isdir=None):
65
self.present = present
67
self.interesting = True
70
return "SourceFile(%s, %s)" % (self.path, self.id)
72
def get_tree(treespec, temp_root, label):
76
base_tree = branch.working_tree()
78
base_tree = branch.basis_tree()
80
base_tree = branch.revision_tree(branch.lookup_revision(revno))
81
temp_path = os.path.join(temp_root, label)
83
return MergeTree(base_tree, temp_path)
86
def abspath(tree, file_id):
87
path = tree.inventory.id2path(file_id)
92
def file_exists(tree, file_id):
93
return tree.has_filename(tree.id2path(file_id))
95
def inventory_map(tree):
97
for file_id in tree.inventory:
98
if not file_exists(tree, file_id):
100
path = abspath(tree, file_id)
101
inventory[path] = SourceFile(path, file_id)
105
class MergeTree(object):
106
def __init__(self, tree, tempdir):
318
for file_id in old_entries:
319
entry = old_entries[file_id]
320
path = id2path(file_id)
321
if file_id in self.base_tree.inventory:
322
executable = getattr(self.base_tree.inventory[file_id], 'executable', False)
324
executable = getattr(entry, 'executable', False)
325
new_inventory[file_id] = (path, file_id, entry.parent_id,
326
entry.kind, executable)
328
by_path[path] = file_id
333
for path, file_id in new_entries:
335
del new_inventory[file_id]
338
new_path_list.append((path, file_id))
339
if file_id not in old_entries:
341
# Ensure no file is added before its parent
343
for path, file_id in new_path_list:
347
parent = by_path[os.path.dirname(path)]
348
abspath = pathjoin(self.this_tree.basedir, path)
349
kind = osutils.file_kind(abspath)
350
if file_id in self.base_tree.inventory:
351
executable = getattr(self.base_tree.inventory[file_id], 'executable', False)
354
new_inventory[file_id] = (path, file_id, parent, kind, executable)
355
by_path[path] = file_id
357
# Get a list in insertion order
358
new_inventory_list = new_inventory.values()
359
mutter ("""Inventory regeneration:
360
old length: %i insertions: %i deletions: %i new_length: %i"""\
361
% (len(old_entries), insertions, deletions,
362
len(new_inventory_list)))
363
assert len(new_inventory_list) == len(old_entries) + insertions\
365
new_inventory_list.sort()
366
return new_inventory_list
369
class Merge3Merger(object):
370
"""Three-way merger that uses the merge3 text merger"""
372
supports_reprocess = True
373
supports_show_base = True
374
history_based = False
376
def __init__(self, working_tree, this_tree, base_tree, other_tree,
377
interesting_ids=None, reprocess=False, show_base=False,
378
pb=DummyProgress(), pp=None, change_reporter=None):
379
"""Initialize the merger object and perform the merge."""
107
380
object.__init__(self)
108
if hasattr(tree, "basedir"):
109
self.root = tree.basedir
112
self.inventory = inventory_map(tree)
114
self.tempdir = tempdir
115
os.mkdir(os.path.join(self.tempdir, "texts"))
118
def readonly_path(self, id):
119
if self.root is not None:
120
return self.tree.abspath(self.tree.id2path(id))
122
if self.tree.inventory[id].kind in ("directory", "root_directory"):
124
if not self.cached.has_key(id):
125
path = os.path.join(self.tempdir, "texts", id)
126
outfile = file(path, "wb")
127
outfile.write(self.tree.get_file(id).read())
128
assert(os.path.exists(path))
129
self.cached[id] = path
130
return self.cached[id]
132
def merge(other_revision, base_revision):
133
tempdir = tempfile.mkdtemp(prefix="bzr-")
135
this_branch = Branch('.')
136
other_tree = get_tree(other_revision, tempdir, "other")
137
base_tree = get_tree(base_revision, tempdir, "base")
138
merge_inner(this_branch, other_tree, base_tree, tempdir)
140
shutil.rmtree(tempdir)
143
def generate_cset_optimized(tree_a, tree_b, inventory_a, inventory_b):
144
"""Generate a changeset, using the text_id to mark really-changed files.
145
This permits blazing comparisons when text_ids are present. It also
146
disables metadata comparison for files with identical texts.
148
for file_id in tree_a.tree.inventory:
149
if file_id not in tree_b.tree.inventory:
151
entry_a = tree_a.tree.inventory[file_id]
152
entry_b = tree_b.tree.inventory[file_id]
153
if (entry_a.kind, entry_b.kind) != ("file", "file"):
155
if None in (entry_a.text_id, entry_b.text_id):
157
if entry_a.text_id != entry_b.text_id:
159
inventory_a[abspath(tree_a.tree, file_id)].interesting = False
160
inventory_b[abspath(tree_b.tree, file_id)].interesting = False
161
cset = generate_changeset(tree_a, tree_b, inventory_a, inventory_b)
162
for entry in cset.entries.itervalues():
163
entry.metadata_change = None
167
def merge_inner(this_branch, other_tree, base_tree, tempdir):
168
this_tree = get_tree(('.', None), tempdir, "this")
170
def get_inventory(tree):
171
return tree.inventory
173
inv_changes = merge_flex(this_tree, base_tree, other_tree,
174
generate_cset_optimized, get_inventory,
175
MergeConflictHandler(base_tree.root))
178
for id, path in inv_changes.iteritems():
183
assert path.startswith('./')
185
adjust_ids.append((path, id))
186
this_branch.set_inventory(regen_inventory(this_branch, this_tree.root, adjust_ids))
189
def regen_inventory(this_branch, root, new_entries):
190
old_entries = this_branch.read_working_inventory()
193
for file_id in old_entries:
194
entry = old_entries[file_id]
195
path = old_entries.id2path(file_id)
196
new_inventory[file_id] = (path, file_id, entry.parent_id, entry.kind)
197
by_path[path] = file_id
381
self.this_tree = working_tree
382
self.base_tree = base_tree
383
self.other_tree = other_tree
384
self._raw_conflicts = []
385
self.cooked_conflicts = []
386
self.reprocess = reprocess
387
self.show_base = show_base
390
self.change_reporter = change_reporter
392
self.pp = ProgressPhase("Merge phase", 3, self.pb)
394
if interesting_ids is not None:
395
all_ids = interesting_ids
397
all_ids = set(base_tree)
398
all_ids.update(other_tree)
399
working_tree.lock_tree_write()
400
self.tt = TreeTransform(working_tree, self.pb)
403
child_pb = ui.ui_factory.nested_progress_bar()
405
for num, file_id in enumerate(all_ids):
406
child_pb.update('Preparing file merge', num, len(all_ids))
407
self.merge_names(file_id)
408
file_status = self.merge_contents(file_id)
409
self.merge_executable(file_id, file_status)
414
child_pb = ui.ui_factory.nested_progress_bar()
416
fs_conflicts = resolve_conflicts(self.tt, child_pb)
419
if change_reporter is not None:
420
from bzrlib import delta
421
delta.report_changes(self.tt._iter_changes(), change_reporter)
422
self.cook_conflicts(fs_conflicts)
423
for conflict in self.cooked_conflicts:
426
results = self.tt.apply()
427
self.write_modified(results)
429
working_tree.add_conflicts(self.cooked_conflicts)
430
except UnsupportedOperation:
434
working_tree.unlock()
439
self.tt.final_kind(self.tt.root)
441
self.tt.cancel_deletion(self.tt.root)
442
if self.tt.final_file_id(self.tt.root) is None:
443
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
445
if self.other_tree.inventory.root is None:
447
other_root_file_id = self.other_tree.inventory.root.file_id
448
other_root = self.tt.trans_id_file_id(other_root_file_id)
449
if other_root == self.tt.root:
452
self.tt.final_kind(other_root)
455
self.reparent_children(self.other_tree.inventory.root, self.tt.root)
456
self.tt.cancel_creation(other_root)
457
self.tt.cancel_versioning(other_root)
459
def reparent_children(self, ie, target):
460
for thing, child in ie.children.iteritems():
461
trans_id = self.tt.trans_id_file_id(child.file_id)
462
self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
464
def write_modified(self, results):
466
for path in results.modified_paths:
467
file_id = self.this_tree.path2id(self.this_tree.relpath(path))
470
hash = self.this_tree.get_file_sha1(file_id)
473
modified_hashes[file_id] = hash
474
self.this_tree.set_merge_modified(modified_hashes)
477
def parent(entry, file_id):
478
"""Determine the parent for a file_id (used as a key method)"""
481
return entry.parent_id
484
def name(entry, file_id):
485
"""Determine the name for a file_id (used as a key method)"""
202
for path, file_id in new_entries:
204
del new_inventory[file_id]
207
new_path_list.append((path, file_id))
208
if file_id not in old_entries:
210
# Ensure no file is added before its parent
212
for path, file_id in new_path_list:
216
parent = by_path[os.path.dirname(path)]
217
kind = bzrlib.osutils.file_kind(os.path.join(root, path))
218
new_inventory[file_id] = (path, file_id, parent, kind)
219
by_path[path] = file_id
221
# Get a list in insertion order
222
new_inventory_list = new_inventory.values()
223
mutter ("""Inventory regeneration:
224
old length: %i insertions: %i deletions: %i new_length: %i"""\
225
% (len(old_entries), insertions, deletions, len(new_inventory_list)))
226
assert len(new_inventory_list) == len(old_entries) + insertions - deletions
227
new_inventory_list.sort()
228
return new_inventory_list
491
def contents_sha1(tree, file_id):
492
"""Determine the sha1 of the file contents (used as a key method)."""
493
if file_id not in tree:
495
return tree.get_file_sha1(file_id)
498
def executable(tree, file_id):
499
"""Determine the executability of a file-id (used as a key method)."""
500
if file_id not in tree:
502
if tree.kind(file_id) != "file":
504
return tree.is_executable(file_id)
507
def kind(tree, file_id):
508
"""Determine the kind of a file-id (used as a key method)."""
509
if file_id not in tree:
511
return tree.kind(file_id)
514
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
515
"""Do a three-way test on a scalar.
516
Return "this", "other" or "conflict", depending whether a value wins.
518
key_base = key(base_tree, file_id)
519
key_other = key(other_tree, file_id)
520
#if base == other, either they all agree, or only THIS has changed.
521
if key_base == key_other:
523
key_this = key(this_tree, file_id)
524
if key_this not in (key_base, key_other):
526
# "Ambiguous clean merge"
527
elif key_this == key_other:
530
assert key_this == key_base
533
def merge_names(self, file_id):
534
"""Perform a merge on file_id names and parents"""
536
if file_id in tree.inventory:
537
return tree.inventory[file_id]
540
this_entry = get_entry(self.this_tree)
541
other_entry = get_entry(self.other_tree)
542
base_entry = get_entry(self.base_tree)
543
name_winner = self.scalar_three_way(this_entry, base_entry,
544
other_entry, file_id, self.name)
545
parent_id_winner = self.scalar_three_way(this_entry, base_entry,
546
other_entry, file_id,
548
if this_entry is None:
549
if name_winner == "this":
550
name_winner = "other"
551
if parent_id_winner == "this":
552
parent_id_winner = "other"
553
if name_winner == "this" and parent_id_winner == "this":
555
if name_winner == "conflict":
556
trans_id = self.tt.trans_id_file_id(file_id)
557
self._raw_conflicts.append(('name conflict', trans_id,
558
self.name(this_entry, file_id),
559
self.name(other_entry, file_id)))
560
if parent_id_winner == "conflict":
561
trans_id = self.tt.trans_id_file_id(file_id)
562
self._raw_conflicts.append(('parent conflict', trans_id,
563
self.parent(this_entry, file_id),
564
self.parent(other_entry, file_id)))
565
if other_entry is None:
566
# it doesn't matter whether the result was 'other' or
567
# 'conflict'-- if there's no 'other', we leave it alone.
569
# if we get here, name_winner and parent_winner are set to safe values.
570
winner_entry = {"this": this_entry, "other": other_entry,
571
"conflict": other_entry}
572
trans_id = self.tt.trans_id_file_id(file_id)
573
parent_id = winner_entry[parent_id_winner].parent_id
574
if parent_id is not None:
575
parent_trans_id = self.tt.trans_id_file_id(parent_id)
576
self.tt.adjust_path(winner_entry[name_winner].name,
577
parent_trans_id, trans_id)
579
def merge_contents(self, file_id):
580
"""Performa a merge on file_id contents."""
581
def contents_pair(tree):
582
if file_id not in tree:
584
kind = tree.kind(file_id)
586
contents = tree.get_file_sha1(file_id)
587
elif kind == "symlink":
588
contents = tree.get_symlink_target(file_id)
591
return kind, contents
593
def contents_conflict():
594
trans_id = self.tt.trans_id_file_id(file_id)
595
name = self.tt.final_name(trans_id)
596
parent_id = self.tt.final_parent(trans_id)
597
if file_id in self.this_tree.inventory:
598
self.tt.unversion_file(trans_id)
599
if file_id in self.this_tree:
600
self.tt.delete_contents(trans_id)
601
file_group = self._dump_conflicts(name, parent_id, file_id,
603
self._raw_conflicts.append(('contents conflict', file_group))
605
# See SPOT run. run, SPOT, run.
606
# So we're not QUITE repeating ourselves; we do tricky things with
608
base_pair = contents_pair(self.base_tree)
609
other_pair = contents_pair(self.other_tree)
610
if base_pair == other_pair:
611
# OTHER introduced no changes
613
this_pair = contents_pair(self.this_tree)
614
if this_pair == other_pair:
615
# THIS and OTHER introduced the same changes
618
trans_id = self.tt.trans_id_file_id(file_id)
619
if this_pair == base_pair:
620
# only OTHER introduced changes
621
if file_id in self.this_tree:
622
# Remove any existing contents
623
self.tt.delete_contents(trans_id)
624
if file_id in self.other_tree:
625
# OTHER changed the file
626
create_by_entry(self.tt,
627
self.other_tree.inventory[file_id],
628
self.other_tree, trans_id)
629
if file_id not in self.this_tree.inventory:
630
self.tt.version_file(file_id, trans_id)
632
elif file_id in self.this_tree.inventory:
633
# OTHER deleted the file
634
self.tt.unversion_file(trans_id)
636
#BOTH THIS and OTHER introduced changes; scalar conflict
637
elif this_pair[0] == "file" and other_pair[0] == "file":
638
# THIS and OTHER are both files, so text merge. Either
639
# BASE is a file, or both converted to files, so at least we
640
# have agreement that output should be a file.
642
self.text_merge(file_id, trans_id)
644
return contents_conflict()
645
if file_id not in self.this_tree.inventory:
646
self.tt.version_file(file_id, trans_id)
648
self.tt.tree_kind(trans_id)
649
self.tt.delete_contents(trans_id)
654
# Scalar conflict, can't text merge. Dump conflicts
655
return contents_conflict()
657
def get_lines(self, tree, file_id):
658
"""Return the lines in a file, or an empty list."""
660
return tree.get_file(file_id).readlines()
664
def text_merge(self, file_id, trans_id):
665
"""Perform a three-way text merge on a file_id"""
666
# it's possible that we got here with base as a different type.
667
# if so, we just want two-way text conflicts.
668
if file_id in self.base_tree and \
669
self.base_tree.kind(file_id) == "file":
670
base_lines = self.get_lines(self.base_tree, file_id)
673
other_lines = self.get_lines(self.other_tree, file_id)
674
this_lines = self.get_lines(self.this_tree, file_id)
675
m3 = Merge3(base_lines, this_lines, other_lines)
676
start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
677
if self.show_base is True:
678
base_marker = '|' * 7
682
def iter_merge3(retval):
683
retval["text_conflicts"] = False
684
for line in m3.merge_lines(name_a = "TREE",
685
name_b = "MERGE-SOURCE",
686
name_base = "BASE-REVISION",
687
start_marker=start_marker,
688
base_marker=base_marker,
689
reprocess=self.reprocess):
690
if line.startswith(start_marker):
691
retval["text_conflicts"] = True
692
yield line.replace(start_marker, '<' * 7)
696
merge3_iterator = iter_merge3(retval)
697
self.tt.create_file(merge3_iterator, trans_id)
698
if retval["text_conflicts"] is True:
699
self._raw_conflicts.append(('text conflict', trans_id))
700
name = self.tt.final_name(trans_id)
701
parent_id = self.tt.final_parent(trans_id)
702
file_group = self._dump_conflicts(name, parent_id, file_id,
703
this_lines, base_lines,
705
file_group.append(trans_id)
707
def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
708
base_lines=None, other_lines=None, set_version=False,
710
"""Emit conflict files.
711
If this_lines, base_lines, or other_lines are omitted, they will be
712
determined automatically. If set_version is true, the .OTHER, .THIS
713
or .BASE (in that order) will be created as versioned files.
715
data = [('OTHER', self.other_tree, other_lines),
716
('THIS', self.this_tree, this_lines)]
718
data.append(('BASE', self.base_tree, base_lines))
721
for suffix, tree, lines in data:
723
trans_id = self._conflict_file(name, parent_id, tree, file_id,
725
file_group.append(trans_id)
726
if set_version and not versioned:
727
self.tt.version_file(file_id, trans_id)
731
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
733
"""Emit a single conflict file."""
734
name = name + '.' + suffix
735
trans_id = self.tt.create_path(name, parent_id)
736
entry = tree.inventory[file_id]
737
create_by_entry(self.tt, entry, tree, trans_id, lines)
740
def merge_executable(self, file_id, file_status):
741
"""Perform a merge on the execute bit."""
742
if file_status == "deleted":
744
trans_id = self.tt.trans_id_file_id(file_id)
746
if self.tt.final_kind(trans_id) != "file":
750
winner = self.scalar_three_way(self.this_tree, self.base_tree,
751
self.other_tree, file_id,
753
if winner == "conflict":
754
# There must be a None in here, if we have a conflict, but we
755
# need executability since file status was not deleted.
756
if self.executable(self.other_tree, file_id) is None:
761
if file_status == "modified":
762
executability = self.this_tree.is_executable(file_id)
763
if executability is not None:
764
trans_id = self.tt.trans_id_file_id(file_id)
765
self.tt.set_executability(executability, trans_id)
767
assert winner == "other"
768
if file_id in self.other_tree:
769
executability = self.other_tree.is_executable(file_id)
770
elif file_id in self.this_tree:
771
executability = self.this_tree.is_executable(file_id)
772
elif file_id in self.base_tree:
773
executability = self.base_tree.is_executable(file_id)
774
if executability is not None:
775
trans_id = self.tt.trans_id_file_id(file_id)
776
self.tt.set_executability(executability, trans_id)
778
def cook_conflicts(self, fs_conflicts):
779
"""Convert all conflicts into a form that doesn't depend on trans_id"""
780
from conflicts import Conflict
782
self.cooked_conflicts.extend(cook_conflicts(fs_conflicts, self.tt))
783
fp = FinalPaths(self.tt)
784
for conflict in self._raw_conflicts:
785
conflict_type = conflict[0]
786
if conflict_type in ('name conflict', 'parent conflict'):
787
trans_id = conflict[1]
788
conflict_args = conflict[2:]
789
if trans_id not in name_conflicts:
790
name_conflicts[trans_id] = {}
791
unique_add(name_conflicts[trans_id], conflict_type,
793
if conflict_type == 'contents conflict':
794
for trans_id in conflict[1]:
795
file_id = self.tt.final_file_id(trans_id)
796
if file_id is not None:
798
path = fp.get_path(trans_id)
799
for suffix in ('.BASE', '.THIS', '.OTHER'):
800
if path.endswith(suffix):
801
path = path[:-len(suffix)]
803
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
804
self.cooked_conflicts.append(c)
805
if conflict_type == 'text conflict':
806
trans_id = conflict[1]
807
path = fp.get_path(trans_id)
808
file_id = self.tt.final_file_id(trans_id)
809
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
810
self.cooked_conflicts.append(c)
812
for trans_id, conflicts in name_conflicts.iteritems():
814
this_parent, other_parent = conflicts['parent conflict']
815
assert this_parent != other_parent
817
this_parent = other_parent = \
818
self.tt.final_file_id(self.tt.final_parent(trans_id))
820
this_name, other_name = conflicts['name conflict']
821
assert this_name != other_name
823
this_name = other_name = self.tt.final_name(trans_id)
824
other_path = fp.get_path(trans_id)
825
if this_parent is not None:
827
fp.get_path(self.tt.trans_id_file_id(this_parent))
828
this_path = pathjoin(this_parent_path, this_name)
830
this_path = "<deleted>"
831
file_id = self.tt.final_file_id(trans_id)
832
c = Conflict.factory('path conflict', path=this_path,
833
conflict_path=other_path, file_id=file_id)
834
self.cooked_conflicts.append(c)
835
self.cooked_conflicts.sort(key=Conflict.sort_key)
838
class WeaveMerger(Merge3Merger):
839
"""Three-way tree merger, text weave merger."""
840
supports_reprocess = True
841
supports_show_base = False
843
def __init__(self, working_tree, this_tree, base_tree, other_tree,
844
interesting_ids=None, pb=DummyProgress(), pp=None,
845
reprocess=False, change_reporter=None):
846
self.this_revision_tree = self._get_revision_tree(this_tree)
847
self.other_revision_tree = self._get_revision_tree(other_tree)
848
super(WeaveMerger, self).__init__(working_tree, this_tree,
849
base_tree, other_tree,
850
interesting_ids=interesting_ids,
851
pb=pb, pp=pp, reprocess=reprocess,
852
change_reporter=change_reporter)
854
def _get_revision_tree(self, tree):
855
"""Return a revision tree related to this tree.
856
If the tree is a WorkingTree, the basis will be returned.
858
if getattr(tree, 'get_weave', False) is False:
859
# If we have a WorkingTree, try using the basis
860
return tree.branch.basis_tree()
864
def _check_file(self, file_id):
865
"""Check that the revision tree's version of the file matches."""
866
for tree, rt in ((self.this_tree, self.this_revision_tree),
867
(self.other_tree, self.other_revision_tree)):
870
if tree.get_file_sha1(file_id) != rt.get_file_sha1(file_id):
871
raise WorkingTreeNotRevision(self.this_tree)
873
def _merged_lines(self, file_id):
874
"""Generate the merged lines.
875
There is no distinction between lines that are meant to contain <<<<<<<
878
weave = self.this_revision_tree.get_weave(file_id)
879
this_revision_id = self.this_revision_tree.inventory[file_id].revision
880
other_revision_id = \
881
self.other_revision_tree.inventory[file_id].revision
882
wm = WeaveMerge(weave, this_revision_id, other_revision_id,
883
'<<<<<<< TREE\n', '>>>>>>> MERGE-SOURCE\n')
884
return wm.merge_lines(self.reprocess)
886
def text_merge(self, file_id, trans_id):
887
"""Perform a (weave) text merge for a given file and file-id.
888
If conflicts are encountered, .THIS and .OTHER files will be emitted,
889
and a conflict will be noted.
891
self._check_file(file_id)
892
lines, conflicts = self._merged_lines(file_id)
894
# Note we're checking whether the OUTPUT is binary in this case,
895
# because we don't want to get into weave merge guts.
896
check_text_lines(lines)
897
self.tt.create_file(lines, trans_id)
899
self._raw_conflicts.append(('text conflict', trans_id))
900
name = self.tt.final_name(trans_id)
901
parent_id = self.tt.final_parent(trans_id)
902
file_group = self._dump_conflicts(name, parent_id, file_id,
904
file_group.append(trans_id)
907
class Diff3Merger(Merge3Merger):
908
"""Three-way merger using external diff3 for text merging"""
910
def dump_file(self, temp_dir, name, tree, file_id):
911
out_path = pathjoin(temp_dir, name)
912
out_file = open(out_path, "wb")
914
in_file = tree.get_file(file_id)
921
def text_merge(self, file_id, trans_id):
922
"""Perform a diff3 merge using a specified file-id and trans-id.
923
If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
924
will be dumped, and a will be conflict noted.
927
temp_dir = osutils.mkdtemp(prefix="bzr-")
929
new_file = pathjoin(temp_dir, "new")
930
this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
931
base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
932
other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
933
status = bzrlib.patch.diff3(new_file, this, base, other)
934
if status not in (0, 1):
935
raise BzrError("Unhandled diff3 exit code")
936
f = open(new_file, 'rb')
938
self.tt.create_file(f, trans_id)
942
name = self.tt.final_name(trans_id)
943
parent_id = self.tt.final_parent(trans_id)
944
self._dump_conflicts(name, parent_id, file_id)
945
self._raw_conflicts.append(('text conflict', trans_id))
947
osutils.rmtree(temp_dir)
950
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
952
merge_type=Merge3Merger,
953
interesting_ids=None,
957
interesting_files=None,
960
change_reporter=None):
961
"""Primary interface for merging.
963
typical use is probably
964
'merge_inner(branch, branch.get_revision_tree(other_revision),
965
branch.get_revision_tree(base_revision))'
967
if this_tree is None:
968
warnings.warn("bzrlib.merge.merge_inner requires a this_tree parameter as of "
969
"bzrlib version 0.8.",
972
this_tree = this_branch.bzrdir.open_workingtree()
973
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
974
pb=pb, change_reporter=change_reporter)
975
merger.backup_files = backup_files
976
merger.merge_type = merge_type
977
merger.interesting_ids = interesting_ids
978
merger.ignore_zero = ignore_zero
979
if interesting_files:
980
assert not interesting_ids, ('Only supply interesting_ids'
981
' or interesting_files')
982
merger._set_interesting_files(interesting_files)
983
merger.show_base = show_base
984
merger.reprocess = reprocess
985
merger.other_rev_id = other_rev_id
986
merger.other_basis = other_rev_id
987
return merger.do_merge()
989
def get_merge_type_registry():
990
"""Merge type registry is in bzrlib.option to avoid circular imports.
992
This method provides a sanctioned way to retrieve it.
994
from bzrlib import option
995
return option._merge_type_registry
added
removed
bzrlib/merge.py
