1
from merge_core import merge_flex, ApplyMerge3, BackupBeforeChange
2
from changeset import generate_changeset, ExceptionConflictHandler
3
from changeset import Inventory, Diff3Merge
4
from bzrlib import find_branch
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.delta 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):
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):
105
52
location, revno = treespec
106
branch = find_branch(location)
53
branch = Branch.open_containing(location)[0]
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):
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()):
137
86
object.__init__(self)
138
if hasattr(tree, "basedir"):
139
self.root = tree.basedir
142
self.inventory = inventory_map(tree)
144
self.tempdir = tempdir
145
os.mkdir(os.path.join(self.tempdir, "texts"))
148
def readonly_path(self, id):
149
if id not in self.tree:
151
if self.root is not None:
152
return self.tree.abspath(self.tree.id2path(id))
154
if self.tree.inventory[id].kind in ("directory", "root_directory"):
156
if not self.cached.has_key(id):
157
path = os.path.join(self.tempdir, "texts", id)
158
outfile = file(path, "wb")
159
outfile.write(self.tree.get_file(id).read())
160
assert(os.path.exists(path))
161
self.cached[id] = path
162
return self.cached[id]
166
def merge(other_revision, base_revision,
167
check_clean=True, ignore_zero=False,
168
this_dir=None, backup_files=False, merge_type=ApplyMerge3,
170
"""Merge changes into a tree.
173
Base for three-way merge.
175
Other revision for three-way merge.
177
Directory to merge changes into; '.' by default.
179
If true, this_dir must have no uncommitted changes before the
182
tempdir = tempfile.mkdtemp(prefix="bzr-")
186
this_branch = find_branch(this_dir)
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")
188
changes = compare_trees(this_branch.working_tree(),
189
this_branch.basis_tree(), False)
190
if changes.has_changed():
142
if self.this_basis != self.this_rev_id:
191
143
raise BzrCommandError("Working tree has uncommitted changes.")
192
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")
193
207
if base_revision == [None, None]:
194
if other_revision[1] == -1:
197
o_revno = other_revision[1]
198
base_revno = this_branch.common_ancestor(other_branch,
199
other_revno=o_revno)[0]
200
if base_revno is None:
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:
201
218
raise UnrelatedBranches()
202
base_revision = ['.', base_revno]
203
base_branch, base_tree = get_tree(base_revision, tempdir, "base")
204
if file_list is None:
205
interesting_ids = None
207
interesting_ids = set()
208
this_tree = this_branch.working_tree()
209
for fname in file_list:
210
path = this_branch.relpath(fname)
212
for tree in (this_tree, base_tree.tree, other_tree.tree):
213
file_id = tree.inventory.path2id(path)
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
self.this_branch.fetch(base_branch)
231
self.base_is_ancestor = is_ancestor(self.this_basis,
236
kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
237
'other_tree': self.other_tree,
238
'interesting_ids': self.interesting_ids,
240
if self.merge_type.requires_base:
241
kwargs['base_tree'] = self.base_tree
242
if self.merge_type.supports_reprocess:
243
kwargs['reprocess'] = self.reprocess
245
raise BzrError("Reprocess is not supported for this merge"
246
" type. %s" % merge_type)
247
if self.merge_type.supports_show_base:
248
kwargs['show_base'] = self.show_base
250
raise BzrError("Showing base is not supported for this"
251
" merge type. %s" % self.merge_type)
252
merge = self.merge_type(pb=self._pb, **kwargs)
253
if len(merge.cooked_conflicts) == 0:
254
if not self.ignore_zero:
255
note("All changes applied successfully.")
257
note("%d conflicts encountered." % len(merge.cooked_conflicts))
259
return len(merge.cooked_conflicts)
261
def regen_inventory(self, new_entries):
262
old_entries = self.this_tree.read_working_inventory()
266
for path, file_id in new_entries:
269
new_entries_map[file_id] = path
271
def id2path(file_id):
272
path = new_entries_map.get(file_id)
275
entry = old_entries[file_id]
276
if entry.parent_id is None:
278
return pathjoin(id2path(entry.parent_id), entry.name)
280
for file_id in old_entries:
281
entry = old_entries[file_id]
282
path = id2path(file_id)
283
new_inventory[file_id] = (path, file_id, entry.parent_id,
285
by_path[path] = file_id
290
for path, file_id in new_entries:
292
del new_inventory[file_id]
295
new_path_list.append((path, file_id))
296
if file_id not in old_entries:
298
# Ensure no file is added before its parent
300
for path, file_id in new_path_list:
304
parent = by_path[os.path.dirname(path)]
305
abspath = pathjoin(self.this_tree.basedir, path)
306
kind = bzrlib.osutils.file_kind(abspath)
307
new_inventory[file_id] = (path, file_id, parent, kind)
308
by_path[path] = file_id
310
# Get a list in insertion order
311
new_inventory_list = new_inventory.values()
312
mutter ("""Inventory regeneration:
313
old length: %i insertions: %i deletions: %i new_length: %i"""\
314
% (len(old_entries), insertions, deletions,
315
len(new_inventory_list)))
316
assert len(new_inventory_list) == len(old_entries) + insertions\
318
new_inventory_list.sort()
319
return new_inventory_list
322
class Merge3Merger(object):
323
"""Three-way merger that uses the merge3 text merger"""
325
supports_reprocess = True
326
supports_show_base = True
327
history_based = False
329
def __init__(self, working_tree, this_tree, base_tree, other_tree,
330
interesting_ids=None, reprocess=False, show_base=False,
331
pb=DummyProgress(), pp=None):
332
"""Initialize the merger object and perform the merge."""
333
object.__init__(self)
334
self.this_tree = working_tree
335
self.base_tree = base_tree
336
self.other_tree = other_tree
337
self._raw_conflicts = []
338
self.cooked_conflicts = []
339
self.reprocess = reprocess
340
self.show_base = show_base
344
self.pp = ProgressPhase("Merge phase", 3, self.pb)
346
if interesting_ids is not None:
347
all_ids = interesting_ids
349
all_ids = set(base_tree)
350
all_ids.update(other_tree)
351
working_tree.lock_write()
352
self.tt = TreeTransform(working_tree, self.pb)
355
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
357
for num, file_id in enumerate(all_ids):
358
child_pb.update('Preparing file merge', num, len(all_ids))
359
self.merge_names(file_id)
360
file_status = self.merge_contents(file_id)
361
self.merge_executable(file_id, file_status)
366
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
368
fs_conflicts = resolve_conflicts(self.tt, child_pb)
371
self.cook_conflicts(fs_conflicts)
372
for line in conflicts_strings(self.cooked_conflicts):
375
results = self.tt.apply()
376
self.write_modified(results)
382
working_tree.unlock()
385
def write_modified(self, results):
387
for path in results.modified_paths:
388
file_id = self.this_tree.path2id(self.this_tree.relpath(path))
391
hash = self.this_tree.get_file_sha1(file_id)
394
modified_hashes[file_id] = hash
395
self.this_tree.set_merge_modified(modified_hashes)
398
def parent(entry, file_id):
399
"""Determine the parent for a file_id (used as a key method)"""
402
return entry.parent_id
405
def name(entry, file_id):
406
"""Determine the name for a file_id (used as a key method)"""
412
def contents_sha1(tree, file_id):
413
"""Determine the sha1 of the file contents (used as a key method)."""
414
if file_id not in tree:
416
return tree.get_file_sha1(file_id)
419
def executable(tree, file_id):
420
"""Determine the executability of a file-id (used as a key method)."""
421
if file_id not in tree:
423
if tree.kind(file_id) != "file":
425
return tree.is_executable(file_id)
428
def kind(tree, file_id):
429
"""Determine the kind of a file-id (used as a key method)."""
430
if file_id not in tree:
432
return tree.kind(file_id)
435
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
436
"""Do a three-way test on a scalar.
437
Return "this", "other" or "conflict", depending whether a value wins.
439
key_base = key(base_tree, file_id)
440
key_other = key(other_tree, file_id)
441
#if base == other, either they all agree, or only THIS has changed.
442
if key_base == key_other:
444
key_this = key(this_tree, file_id)
445
if key_this not in (key_base, key_other):
447
# "Ambiguous clean merge"
448
elif key_this == key_other:
451
assert key_this == key_base
454
def merge_names(self, file_id):
455
"""Perform a merge on file_id names and parents"""
457
if file_id in tree.inventory:
458
return tree.inventory[file_id]
461
this_entry = get_entry(self.this_tree)
462
other_entry = get_entry(self.other_tree)
463
base_entry = get_entry(self.base_tree)
464
name_winner = self.scalar_three_way(this_entry, base_entry,
465
other_entry, file_id, self.name)
466
parent_id_winner = self.scalar_three_way(this_entry, base_entry,
467
other_entry, file_id,
469
if this_entry is None:
470
if name_winner == "this":
471
name_winner = "other"
472
if parent_id_winner == "this":
473
parent_id_winner = "other"
474
if name_winner == "this" and parent_id_winner == "this":
476
if name_winner == "conflict":
477
trans_id = self.tt.trans_id_file_id(file_id)
478
self._raw_conflicts.append(('name conflict', trans_id,
479
self.name(this_entry, file_id),
480
self.name(other_entry, file_id)))
481
if parent_id_winner == "conflict":
482
trans_id = self.tt.trans_id_file_id(file_id)
483
self._raw_conflicts.append(('parent conflict', trans_id,
484
self.parent(this_entry, file_id),
485
self.parent(other_entry, file_id)))
486
if other_entry is None:
487
# it doesn't matter whether the result was 'other' or
488
# 'conflict'-- if there's no 'other', we leave it alone.
490
# if we get here, name_winner and parent_winner are set to safe values.
491
winner_entry = {"this": this_entry, "other": other_entry,
492
"conflict": other_entry}
493
trans_id = self.tt.trans_id_file_id(file_id)
494
parent_id = winner_entry[parent_id_winner].parent_id
495
parent_trans_id = self.tt.trans_id_file_id(parent_id)
496
self.tt.adjust_path(winner_entry[name_winner].name, parent_trans_id,
499
def merge_contents(self, file_id):
500
"""Performa a merge on file_id contents."""
501
def contents_pair(tree):
502
if file_id not in tree:
504
kind = tree.kind(file_id)
505
if kind == "root_directory":
508
contents = tree.get_file_sha1(file_id)
509
elif kind == "symlink":
510
contents = tree.get_symlink_target(file_id)
513
return kind, contents
514
# See SPOT run. run, SPOT, run.
515
# So we're not QUITE repeating ourselves; we do tricky things with
517
base_pair = contents_pair(self.base_tree)
518
other_pair = contents_pair(self.other_tree)
519
if base_pair == other_pair:
520
# OTHER introduced no changes
522
this_pair = contents_pair(self.this_tree)
523
if this_pair == other_pair:
524
# THIS and OTHER introduced the same changes
527
trans_id = self.tt.trans_id_file_id(file_id)
528
if this_pair == base_pair:
529
# only OTHER introduced changes
530
if file_id in self.this_tree:
531
# Remove any existing contents
532
self.tt.delete_contents(trans_id)
533
if file_id in self.other_tree:
534
# OTHER changed the file
535
create_by_entry(self.tt,
536
self.other_tree.inventory[file_id],
537
self.other_tree, trans_id)
538
if file_id not in self.this_tree.inventory:
539
self.tt.version_file(file_id, trans_id)
541
elif file_id in self.this_tree.inventory:
542
# OTHER deleted the file
543
self.tt.unversion_file(trans_id)
545
#BOTH THIS and OTHER introduced changes; scalar conflict
546
elif this_pair[0] == "file" and other_pair[0] == "file":
547
# THIS and OTHER are both files, so text merge. Either
548
# BASE is a file, or both converted to files, so at least we
549
# have agreement that output should be a file.
550
if file_id not in self.this_tree.inventory:
551
self.tt.version_file(file_id, trans_id)
552
self.text_merge(file_id, trans_id)
554
self.tt.tree_kind(trans_id)
555
self.tt.delete_contents(trans_id)
560
# Scalar conflict, can't text merge. Dump conflicts
561
trans_id = self.tt.trans_id_file_id(file_id)
562
name = self.tt.final_name(trans_id)
563
parent_id = self.tt.final_parent(trans_id)
564
if file_id in self.this_tree.inventory:
565
self.tt.unversion_file(trans_id)
566
self.tt.delete_contents(trans_id)
567
file_group = self._dump_conflicts(name, parent_id, file_id,
569
self._raw_conflicts.append(('contents conflict', file_group))
571
def get_lines(self, tree, file_id):
572
"""Return the lines in a file, or an empty list."""
574
return tree.get_file(file_id).readlines()
578
def text_merge(self, file_id, trans_id):
579
"""Perform a three-way text merge on a file_id"""
580
# it's possible that we got here with base as a different type.
581
# if so, we just want two-way text conflicts.
582
if file_id in self.base_tree and \
583
self.base_tree.kind(file_id) == "file":
584
base_lines = self.get_lines(self.base_tree, file_id)
587
other_lines = self.get_lines(self.other_tree, file_id)
588
this_lines = self.get_lines(self.this_tree, file_id)
589
m3 = Merge3(base_lines, this_lines, other_lines)
590
start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
591
if self.show_base is True:
592
base_marker = '|' * 7
596
def iter_merge3(retval):
597
retval["text_conflicts"] = False
598
for line in m3.merge_lines(name_a = "TREE",
599
name_b = "MERGE-SOURCE",
600
name_base = "BASE-REVISION",
601
start_marker=start_marker,
602
base_marker=base_marker,
603
reprocess=self.reprocess):
604
if line.startswith(start_marker):
605
retval["text_conflicts"] = True
606
yield line.replace(start_marker, '<' * 7)
610
merge3_iterator = iter_merge3(retval)
611
self.tt.create_file(merge3_iterator, trans_id)
612
if retval["text_conflicts"] is True:
613
self._raw_conflicts.append(('text conflict', trans_id))
614
name = self.tt.final_name(trans_id)
615
parent_id = self.tt.final_parent(trans_id)
616
file_group = self._dump_conflicts(name, parent_id, file_id,
617
this_lines, base_lines,
619
file_group.append(trans_id)
621
def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
622
base_lines=None, other_lines=None, set_version=False,
624
"""Emit conflict files.
625
If this_lines, base_lines, or other_lines are omitted, they will be
626
determined automatically. If set_version is true, the .OTHER, .THIS
627
or .BASE (in that order) will be created as versioned files.
629
data = [('OTHER', self.other_tree, other_lines),
630
('THIS', self.this_tree, this_lines)]
632
data.append(('BASE', self.base_tree, base_lines))
635
for suffix, tree, lines in data:
637
trans_id = self._conflict_file(name, parent_id, tree, file_id,
639
file_group.append(trans_id)
640
if set_version and not versioned:
641
self.tt.version_file(file_id, trans_id)
645
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
647
"""Emit a single conflict file."""
648
name = name + '.' + suffix
649
trans_id = self.tt.create_path(name, parent_id)
650
entry = tree.inventory[file_id]
651
create_by_entry(self.tt, entry, tree, trans_id, lines)
654
def merge_executable(self, file_id, file_status):
655
"""Perform a merge on the execute bit."""
656
if file_status == "deleted":
658
trans_id = self.tt.trans_id_file_id(file_id)
660
if self.tt.final_kind(trans_id) != "file":
664
winner = self.scalar_three_way(self.this_tree, self.base_tree,
665
self.other_tree, file_id,
667
if winner == "conflict":
668
# There must be a None in here, if we have a conflict, but we
669
# need executability since file status was not deleted.
670
if self.other_tree.is_executable(file_id) is None:
675
if file_status == "modified":
676
executability = self.this_tree.is_executable(file_id)
677
if executability is not None:
678
trans_id = self.tt.trans_id_file_id(file_id)
679
self.tt.set_executability(executability, trans_id)
681
assert winner == "other"
682
if file_id in self.other_tree:
683
executability = self.other_tree.is_executable(file_id)
684
elif file_id in self.this_tree:
685
executability = self.this_tree.is_executable(file_id)
686
elif file_id in self.base_tree:
687
executability = self.base_tree.is_executable(file_id)
688
if executability is not None:
689
trans_id = self.tt.trans_id_file_id(file_id)
690
self.tt.set_executability(executability, trans_id)
692
def cook_conflicts(self, fs_conflicts):
693
"""Convert all conflicts into a form that doesn't depend on trans_id"""
695
self.cooked_conflicts.extend(cook_conflicts(fs_conflicts, self.tt))
696
fp = FinalPaths(self.tt)
697
for conflict in self._raw_conflicts:
698
conflict_type = conflict[0]
699
if conflict_type in ('name conflict', 'parent conflict'):
700
trans_id = conflict[1]
701
conflict_args = conflict[2:]
702
if trans_id not in name_conflicts:
703
name_conflicts[trans_id] = {}
704
unique_add(name_conflicts[trans_id], conflict_type,
706
if conflict_type == 'contents conflict':
707
for trans_id in conflict[1]:
708
file_id = self.tt.final_file_id(trans_id)
214
709
if file_id is not None:
215
interesting_ids.add(file_id)
218
raise BzrCommandError("%s is not a source file in any"
220
merge_inner(this_branch, other_tree, base_tree, tempdir,
221
ignore_zero=ignore_zero, backup_files=backup_files,
222
merge_type=merge_type, interesting_ids=interesting_ids)
224
shutil.rmtree(tempdir)
227
def set_interesting(inventory_a, inventory_b, interesting_ids):
228
"""Mark files whose ids are in interesting_ids as interesting
230
for inventory in (inventory_a, inventory_b):
231
for path, source_file in inventory.iteritems():
232
source_file.interesting = source_file.id in interesting_ids
235
def set_optimized(tree_a, tree_b, inventory_a, inventory_b):
236
"""Mark files that have changed texts as interesting
238
for file_id in tree_a.tree.inventory:
239
if file_id not in tree_b.tree.inventory:
241
entry_a = tree_a.tree.inventory[file_id]
242
entry_b = tree_b.tree.inventory[file_id]
243
if (entry_a.kind, entry_b.kind) != ("file", "file"):
245
if None in (entry_a.text_id, entry_b.text_id):
247
if entry_a.text_id != entry_b.text_id:
249
inventory_a[abspath(tree_a.tree, file_id)].interesting = False
250
inventory_b[abspath(tree_b.tree, file_id)].interesting = False
253
def generate_cset_optimized(tree_a, tree_b, inventory_a, inventory_b,
254
interesting_ids=None):
255
"""Generate a changeset, with preprocessing to select interesting files.
256
using the text_id to mark really-changed files.
257
This permits blazing comparisons when text_ids are present. It also
258
disables metadata comparison for files with identical texts.
260
if interesting_ids is None:
261
set_optimized(tree_a, tree_b, inventory_a, inventory_b)
263
set_interesting(inventory_a, inventory_b, interesting_ids)
264
cset = generate_changeset(tree_a, tree_b, inventory_a, inventory_b)
265
for entry in cset.entries.itervalues():
266
entry.metadata_change = None
270
def merge_inner(this_branch, other_tree, base_tree, tempdir,
271
ignore_zero=False, merge_type=ApplyMerge3, backup_files=False,
272
interesting_ids=None):
274
def merge_factory(base_file, other_file):
275
contents_change = merge_type(base_file, other_file)
277
contents_change = BackupBeforeChange(contents_change)
278
return contents_change
280
def generate_cset(tree_a, tree_b, inventory_a, inventory_b):
281
return generate_cset_optimized(tree_a, tree_b, inventory_a, inventory_b,
284
this_tree = get_tree((this_branch.base, None), tempdir, "this")[1]
286
def get_inventory(tree):
287
return tree.inventory
289
inv_changes = merge_flex(this_tree, base_tree, other_tree,
290
generate_cset, get_inventory,
291
MergeConflictHandler(base_tree.root,
292
ignore_zero=ignore_zero),
293
merge_factory=merge_factory)
296
for id, path in inv_changes.iteritems():
711
path = fp.get_path(trans_id)
712
for suffix in ('.BASE', '.THIS', '.OTHER'):
713
if path.endswith(suffix):
714
path = path[:-len(suffix)]
716
self.cooked_conflicts.append((conflict_type, file_id, path))
717
if conflict_type == 'text conflict':
718
trans_id = conflict[1]
719
path = fp.get_path(trans_id)
720
file_id = self.tt.final_file_id(trans_id)
721
self.cooked_conflicts.append((conflict_type, file_id, path))
723
for trans_id, conflicts in name_conflicts.iteritems():
725
this_parent, other_parent = conflicts['parent conflict']
726
assert this_parent != other_parent
728
this_parent = other_parent = \
729
self.tt.final_file_id(self.tt.final_parent(trans_id))
731
this_name, other_name = conflicts['name conflict']
732
assert this_name != other_name
734
this_name = other_name = self.tt.final_name(trans_id)
735
other_path = fp.get_path(trans_id)
736
if this_parent is not None:
738
fp.get_path(self.tt.trans_id_file_id(this_parent))
739
this_path = pathjoin(this_parent_path, this_name)
301
assert path.startswith('./')
303
adjust_ids.append((path, id))
304
this_branch.set_inventory(regen_inventory(this_branch, this_tree.root, adjust_ids))
307
def regen_inventory(this_branch, root, new_entries):
308
old_entries = this_branch.read_working_inventory()
311
for file_id in old_entries:
312
entry = old_entries[file_id]
313
path = old_entries.id2path(file_id)
314
new_inventory[file_id] = (path, file_id, entry.parent_id, entry.kind)
315
by_path[path] = file_id
320
for path, file_id in new_entries:
322
del new_inventory[file_id]
325
new_path_list.append((path, file_id))
326
if file_id not in old_entries:
328
# Ensure no file is added before its parent
330
for path, file_id in new_path_list:
334
parent = by_path[os.path.dirname(path)]
335
kind = bzrlib.osutils.file_kind(os.path.join(root, path))
336
new_inventory[file_id] = (path, file_id, parent, kind)
337
by_path[path] = file_id
339
# Get a list in insertion order
340
new_inventory_list = new_inventory.values()
341
mutter ("""Inventory regeneration:
342
old length: %i insertions: %i deletions: %i new_length: %i"""\
343
% (len(old_entries), insertions, deletions, len(new_inventory_list)))
344
assert len(new_inventory_list) == len(old_entries) + insertions - deletions
345
new_inventory_list.sort()
346
return new_inventory_list
348
merge_types = { "merge3": (ApplyMerge3, "Native diff3-style merge"),
349
"diff3": (Diff3Merge, "Merge using external diff3")
741
this_path = "<deleted>"
742
file_id = self.tt.final_file_id(trans_id)
743
self.cooked_conflicts.append(('path conflict', file_id, this_path,
747
class WeaveMerger(Merge3Merger):
748
"""Three-way tree merger, text weave merger."""
749
supports_reprocess = False
750
supports_show_base = False
752
def __init__(self, working_tree, this_tree, base_tree, other_tree,
753
interesting_ids=None, pb=DummyProgress(), pp=None):
754
self.this_revision_tree = self._get_revision_tree(this_tree)
755
self.other_revision_tree = self._get_revision_tree(other_tree)
756
super(WeaveMerger, self).__init__(working_tree, this_tree,
757
base_tree, other_tree,
758
interesting_ids=interesting_ids,
761
def _get_revision_tree(self, tree):
762
"""Return a revision tree releated to this tree.
763
If the tree is a WorkingTree, the basis will be returned.
765
if getattr(tree, 'get_weave', False) is False:
766
# If we have a WorkingTree, try using the basis
767
return tree.branch.basis_tree()
771
def _check_file(self, file_id):
772
"""Check that the revision tree's version of the file matches."""
773
for tree, rt in ((self.this_tree, self.this_revision_tree),
774
(self.other_tree, self.other_revision_tree)):
777
if tree.get_file_sha1(file_id) != rt.get_file_sha1(file_id):
778
raise WorkingTreeNotRevision(self.this_tree)
780
def _merged_lines(self, file_id):
781
"""Generate the merged lines.
782
There is no distinction between lines that are meant to contain <<<<<<<
785
weave = self.this_revision_tree.get_weave(file_id)
786
this_revision_id = self.this_revision_tree.inventory[file_id].revision
787
other_revision_id = \
788
self.other_revision_tree.inventory[file_id].revision
789
plan = weave.plan_merge(this_revision_id, other_revision_id)
790
return weave.weave_merge(plan, '<<<<<<< TREE\n',
791
'>>>>>>> MERGE-SOURCE\n')
793
def text_merge(self, file_id, trans_id):
794
"""Perform a (weave) text merge for a given file and file-id.
795
If conflicts are encountered, .THIS and .OTHER files will be emitted,
796
and a conflict will be noted.
798
self._check_file(file_id)
799
lines = self._merged_lines(file_id)
800
conflicts = '<<<<<<< TREE\n' in lines
801
self.tt.create_file(lines, trans_id)
803
self._raw_conflicts.append(('text conflict', trans_id))
804
name = self.tt.final_name(trans_id)
805
parent_id = self.tt.final_parent(trans_id)
806
file_group = self._dump_conflicts(name, parent_id, file_id,
808
file_group.append(trans_id)
811
class Diff3Merger(Merge3Merger):
812
"""Three-way merger using external diff3 for text merging"""
813
def dump_file(self, temp_dir, name, tree, file_id):
814
out_path = pathjoin(temp_dir, name)
815
out_file = file(out_path, "wb")
816
in_file = tree.get_file(file_id)
821
def text_merge(self, file_id, trans_id):
822
"""Perform a diff3 merge using a specified file-id and trans-id.
823
If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
824
will be dumped, and a will be conflict noted.
827
temp_dir = mkdtemp(prefix="bzr-")
829
new_file = pathjoin(temp_dir, "new")
830
this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
831
base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
832
other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
833
status = bzrlib.patch.diff3(new_file, this, base, other)
834
if status not in (0, 1):
835
raise BzrError("Unhandled diff3 exit code")
836
self.tt.create_file(file(new_file, "rb"), trans_id)
838
name = self.tt.final_name(trans_id)
839
parent_id = self.tt.final_parent(trans_id)
840
self._dump_conflicts(name, parent_id, file_id)
841
self._raw_conflicts.append(('text conflict', trans_id))
846
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
848
merge_type=Merge3Merger,
849
interesting_ids=None,
853
interesting_files=None,
856
"""Primary interface for merging.
858
typical use is probably
859
'merge_inner(branch, branch.get_revision_tree(other_revision),
860
branch.get_revision_tree(base_revision))'
862
if this_tree is None:
863
warn("bzrlib.merge.merge_inner requires a this_tree parameter as of "
864
"bzrlib version 0.8.",
867
this_tree = this_branch.bzrdir.open_workingtree()
868
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
870
merger.backup_files = backup_files
871
merger.merge_type = merge_type
872
merger.interesting_ids = interesting_ids
873
merger.ignore_zero = ignore_zero
874
if interesting_files:
875
assert not interesting_ids, ('Only supply interesting_ids'
876
' or interesting_files')
877
merger._set_interesting_files(interesting_files)
878
merger.show_base = show_base
879
merger.reprocess = reprocess
880
merger.other_rev_id = other_rev_id
881
merger.other_basis = other_rev_id
882
return merger.do_merge()
885
merge_types = { "merge3": (Merge3Merger, "Native diff3-style merge"),
886
"diff3": (Diff3Merger, "Merge using external diff3"),
887
'weave': (WeaveMerger, "Weave-based merge")
added
removed
bzrlib/merge.py
