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.conflicts import ConflictList
26
from bzrlib.delta import compare_trees
27
from bzrlib.errors import (BzrCommandError,
37
WorkingTreeNotRevision,
40
from bzrlib.merge3 import Merge3
5
41
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):
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.symbol_versioning import *
46
from bzrlib.textfile import check_text_lines
47
from bzrlib.trace import mutter, warning, note
48
from bzrlib.transform import (TreeTransform, resolve_conflicts, cook_conflicts,
49
FinalPaths, create_by_entry, unique_add)
52
# TODO: Report back as changes are merged in
54
def _get_tree(treespec, local_branch=None):
105
55
location, revno = treespec
106
branch = find_branch(location)
56
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):
60
revision = branch.last_revision()
62
revision = branch.get_rev_id(revno)
64
revision = NULL_REVISION
65
return branch, _get_revid_tree(branch, revision, local_branch)
68
def _get_revid_tree(branch, revision, local_branch):
70
base_tree = branch.bzrdir.open_workingtree()
72
if local_branch is not None:
73
if local_branch.base != branch.base:
74
local_branch.fetch(branch, revision)
75
base_tree = local_branch.repository.revision_tree(revision)
77
base_tree = branch.repository.revision_tree(revision)
81
def transform_tree(from_tree, to_tree, interesting_ids=None):
82
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
83
interesting_ids=interesting_ids, this_tree=from_tree)
87
def __init__(self, this_branch, other_tree=None, base_tree=None,
88
this_tree=None, pb=DummyProgress()):
137
89
object.__init__(self)
138
if hasattr(tree, "basedir"):
139
self.root = tree.basedir
142
self.inventory = inventory_map(tree)
144
self.tempdir = tempdir
145
os.mkdir(os.path.join(self.tempdir, "texts"))
148
def readonly_path(self, id):
149
if id not in self.tree:
151
if self.root is not None:
152
return self.tree.abspath(self.tree.id2path(id))
154
if self.tree.inventory[id].kind in ("directory", "root_directory"):
156
if not self.cached.has_key(id):
157
path = os.path.join(self.tempdir, "texts", id)
158
outfile = file(path, "wb")
159
outfile.write(self.tree.get_file(id).read())
160
assert(os.path.exists(path))
161
self.cached[id] = path
162
return self.cached[id]
166
def merge(other_revision, base_revision,
167
check_clean=True, ignore_zero=False,
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)
90
assert this_tree is not None, "this_tree is required"
91
self.this_branch = this_branch
92
self.this_basis = this_branch.last_revision()
93
self.this_rev_id = None
94
self.this_tree = this_tree
95
self.this_revision_tree = None
96
self.this_basis_tree = None
97
self.other_tree = other_tree
98
self.base_tree = base_tree
99
self.ignore_zero = False
100
self.backup_files = False
101
self.interesting_ids = None
102
self.show_base = False
103
self.reprocess = False
108
def revision_tree(self, revision_id):
109
return self.this_branch.repository.revision_tree(revision_id)
111
def ensure_revision_trees(self):
112
if self.this_revision_tree is None:
113
self.this_basis_tree = self.this_branch.repository.revision_tree(
115
if self.this_basis == self.this_rev_id:
116
self.this_revision_tree = self.this_basis_tree
118
if self.other_rev_id is None:
119
other_basis_tree = self.revision_tree(self.other_basis)
120
changes = compare_trees(self.other_tree, other_basis_tree)
121
if changes.has_changed():
122
raise WorkingTreeNotRevision(self.this_tree)
123
other_rev_id = other_basis
124
self.other_tree = other_basis_tree
126
def file_revisions(self, file_id):
127
self.ensure_revision_trees()
128
def get_id(tree, file_id):
129
revision_id = tree.inventory[file_id].revision
130
assert revision_id is not None
132
if self.this_rev_id is None:
133
if self.this_basis_tree.get_file_sha1(file_id) != \
134
self.this_tree.get_file_sha1(file_id):
135
raise WorkingTreeNotRevision(self.this_tree)
137
trees = (self.this_basis_tree, self.other_tree)
138
return [get_id(tree, file_id) for tree in trees]
140
def check_basis(self, check_clean):
141
if self.this_basis is None:
142
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():
145
if self.this_basis != self.this_rev_id:
191
146
raise BzrCommandError("Working tree has uncommitted changes.")
192
other_branch, other_tree = get_tree(other_revision, tempdir, "other")
148
def compare_basis(self):
149
changes = compare_trees(self.this_tree,
150
self.this_tree.basis_tree(), False)
151
if not changes.has_changed():
152
self.this_rev_id = self.this_basis
154
def set_interesting_files(self, file_list):
156
self._set_interesting_files(file_list)
157
except NotVersionedError, e:
158
raise BzrCommandError("%s is not a source file in any"
161
def _set_interesting_files(self, file_list):
162
"""Set the list of interesting ids from a list of files."""
163
if file_list is None:
164
self.interesting_ids = None
167
interesting_ids = set()
168
for path in file_list:
170
for tree in (self.this_tree, self.base_tree, self.other_tree):
171
file_id = tree.inventory.path2id(path)
172
if file_id is not None:
173
interesting_ids.add(file_id)
176
raise NotVersionedError(path=path)
177
self.interesting_ids = interesting_ids
179
def set_pending(self):
180
if not self.base_is_ancestor:
182
if self.other_rev_id is None:
184
ancestry = self.this_branch.repository.get_ancestry(self.this_basis)
185
if self.other_rev_id in ancestry:
187
self.this_tree.add_pending_merge(self.other_rev_id)
189
def set_other(self, other_revision):
190
other_branch, self.other_tree = _get_tree(other_revision,
192
if other_revision[1] == -1:
193
self.other_rev_id = other_branch.last_revision()
194
if self.other_rev_id is None:
195
raise NoCommits(other_branch)
196
self.other_basis = self.other_rev_id
197
elif other_revision[1] is not None:
198
self.other_rev_id = other_branch.get_rev_id(other_revision[1])
199
self.other_basis = self.other_rev_id
201
self.other_rev_id = None
202
self.other_basis = other_branch.last_revision()
203
if self.other_basis is None:
204
raise NoCommits(other_branch)
205
if other_branch.base != self.this_branch.base:
206
self.this_branch.fetch(other_branch, last_revision=self.other_basis)
208
def set_base(self, base_revision):
209
mutter("doing merge() with no base_revision specified")
193
210
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:
212
pb = bzrlib.ui.ui_factory.nested_progress_bar()
214
this_repo = self.this_branch.repository
215
self.base_rev_id = common_ancestor(self.this_basis,
220
except NoCommonAncestor:
201
221
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)
222
self.base_tree = _get_revid_tree(self.this_branch, self.base_rev_id,
224
self.base_is_ancestor = True
226
base_branch, self.base_tree = _get_tree(base_revision)
227
if base_revision[1] == -1:
228
self.base_rev_id = base_branch.last_revision()
229
elif base_revision[1] is None:
230
self.base_rev_id = None
232
self.base_rev_id = base_branch.get_rev_id(base_revision[1])
233
if self.this_branch.base != base_branch.base:
234
self.this_branch.fetch(base_branch)
235
self.base_is_ancestor = is_ancestor(self.this_basis,
240
kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
241
'other_tree': self.other_tree,
242
'interesting_ids': self.interesting_ids,
244
if self.merge_type.requires_base:
245
kwargs['base_tree'] = self.base_tree
246
if self.merge_type.supports_reprocess:
247
kwargs['reprocess'] = self.reprocess
249
raise BzrError("Reprocess is not supported for this merge"
250
" type. %s" % merge_type)
251
if self.merge_type.supports_show_base:
252
kwargs['show_base'] = self.show_base
254
raise BzrError("Showing base is not supported for this"
255
" merge type. %s" % self.merge_type)
256
merge = self.merge_type(pb=self._pb, **kwargs)
257
if len(merge.cooked_conflicts) == 0:
258
if not self.ignore_zero:
259
note("All changes applied successfully.")
261
note("%d conflicts encountered." % len(merge.cooked_conflicts))
263
return len(merge.cooked_conflicts)
265
def regen_inventory(self, new_entries):
266
old_entries = self.this_tree.read_working_inventory()
270
for path, file_id in new_entries:
273
new_entries_map[file_id] = path
275
def id2path(file_id):
276
path = new_entries_map.get(file_id)
279
entry = old_entries[file_id]
280
if entry.parent_id is None:
282
return pathjoin(id2path(entry.parent_id), entry.name)
284
for file_id in old_entries:
285
entry = old_entries[file_id]
286
path = id2path(file_id)
287
new_inventory[file_id] = (path, file_id, entry.parent_id,
289
by_path[path] = file_id
294
for path, file_id in new_entries:
296
del new_inventory[file_id]
299
new_path_list.append((path, file_id))
300
if file_id not in old_entries:
302
# Ensure no file is added before its parent
304
for path, file_id in new_path_list:
308
parent = by_path[os.path.dirname(path)]
309
abspath = pathjoin(self.this_tree.basedir, path)
310
kind = bzrlib.osutils.file_kind(abspath)
311
new_inventory[file_id] = (path, file_id, parent, kind)
312
by_path[path] = file_id
314
# Get a list in insertion order
315
new_inventory_list = new_inventory.values()
316
mutter ("""Inventory regeneration:
317
old length: %i insertions: %i deletions: %i new_length: %i"""\
318
% (len(old_entries), insertions, deletions,
319
len(new_inventory_list)))
320
assert len(new_inventory_list) == len(old_entries) + insertions\
322
new_inventory_list.sort()
323
return new_inventory_list
326
class Merge3Merger(object):
327
"""Three-way merger that uses the merge3 text merger"""
329
supports_reprocess = True
330
supports_show_base = True
331
history_based = False
333
def __init__(self, working_tree, this_tree, base_tree, other_tree,
334
interesting_ids=None, reprocess=False, show_base=False,
335
pb=DummyProgress(), pp=None):
336
"""Initialize the merger object and perform the merge."""
337
object.__init__(self)
338
self.this_tree = working_tree
339
self.base_tree = base_tree
340
self.other_tree = other_tree
341
self._raw_conflicts = []
342
self.cooked_conflicts = []
343
self.reprocess = reprocess
344
self.show_base = show_base
348
self.pp = ProgressPhase("Merge phase", 3, self.pb)
350
if interesting_ids is not None:
351
all_ids = interesting_ids
353
all_ids = set(base_tree)
354
all_ids.update(other_tree)
355
working_tree.lock_write()
356
self.tt = TreeTransform(working_tree, self.pb)
359
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
361
for num, file_id in enumerate(all_ids):
362
child_pb.update('Preparing file merge', num, len(all_ids))
363
self.merge_names(file_id)
364
file_status = self.merge_contents(file_id)
365
self.merge_executable(file_id, file_status)
370
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
372
fs_conflicts = resolve_conflicts(self.tt, child_pb)
375
self.cook_conflicts(fs_conflicts)
376
for conflict in self.cooked_conflicts:
379
results = self.tt.apply()
380
self.write_modified(results)
382
working_tree.set_conflicts(ConflictList(self.cooked_conflicts))
383
except UnsupportedOperation:
390
working_tree.unlock()
393
def write_modified(self, results):
395
for path in results.modified_paths:
396
file_id = self.this_tree.path2id(self.this_tree.relpath(path))
399
hash = self.this_tree.get_file_sha1(file_id)
402
modified_hashes[file_id] = hash
403
self.this_tree.set_merge_modified(modified_hashes)
406
def parent(entry, file_id):
407
"""Determine the parent for a file_id (used as a key method)"""
410
return entry.parent_id
413
def name(entry, file_id):
414
"""Determine the name for a file_id (used as a key method)"""
420
def contents_sha1(tree, file_id):
421
"""Determine the sha1 of the file contents (used as a key method)."""
422
if file_id not in tree:
424
return tree.get_file_sha1(file_id)
427
def executable(tree, file_id):
428
"""Determine the executability of a file-id (used as a key method)."""
429
if file_id not in tree:
431
if tree.kind(file_id) != "file":
433
return tree.is_executable(file_id)
436
def kind(tree, file_id):
437
"""Determine the kind of a file-id (used as a key method)."""
438
if file_id not in tree:
440
return tree.kind(file_id)
443
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
444
"""Do a three-way test on a scalar.
445
Return "this", "other" or "conflict", depending whether a value wins.
447
key_base = key(base_tree, file_id)
448
key_other = key(other_tree, file_id)
449
#if base == other, either they all agree, or only THIS has changed.
450
if key_base == key_other:
452
key_this = key(this_tree, file_id)
453
if key_this not in (key_base, key_other):
455
# "Ambiguous clean merge"
456
elif key_this == key_other:
459
assert key_this == key_base
462
def merge_names(self, file_id):
463
"""Perform a merge on file_id names and parents"""
465
if file_id in tree.inventory:
466
return tree.inventory[file_id]
469
this_entry = get_entry(self.this_tree)
470
other_entry = get_entry(self.other_tree)
471
base_entry = get_entry(self.base_tree)
472
name_winner = self.scalar_three_way(this_entry, base_entry,
473
other_entry, file_id, self.name)
474
parent_id_winner = self.scalar_three_way(this_entry, base_entry,
475
other_entry, file_id,
477
if this_entry is None:
478
if name_winner == "this":
479
name_winner = "other"
480
if parent_id_winner == "this":
481
parent_id_winner = "other"
482
if name_winner == "this" and parent_id_winner == "this":
484
if name_winner == "conflict":
485
trans_id = self.tt.trans_id_file_id(file_id)
486
self._raw_conflicts.append(('name conflict', trans_id,
487
self.name(this_entry, file_id),
488
self.name(other_entry, file_id)))
489
if parent_id_winner == "conflict":
490
trans_id = self.tt.trans_id_file_id(file_id)
491
self._raw_conflicts.append(('parent conflict', trans_id,
492
self.parent(this_entry, file_id),
493
self.parent(other_entry, file_id)))
494
if other_entry is None:
495
# it doesn't matter whether the result was 'other' or
496
# 'conflict'-- if there's no 'other', we leave it alone.
498
# if we get here, name_winner and parent_winner are set to safe values.
499
winner_entry = {"this": this_entry, "other": other_entry,
500
"conflict": other_entry}
501
trans_id = self.tt.trans_id_file_id(file_id)
502
parent_id = winner_entry[parent_id_winner].parent_id
503
parent_trans_id = self.tt.trans_id_file_id(parent_id)
504
self.tt.adjust_path(winner_entry[name_winner].name, parent_trans_id,
507
def merge_contents(self, file_id):
508
"""Performa a merge on file_id contents."""
509
def contents_pair(tree):
510
if file_id not in tree:
512
kind = tree.kind(file_id)
513
if kind == "root_directory":
516
contents = tree.get_file_sha1(file_id)
517
elif kind == "symlink":
518
contents = tree.get_symlink_target(file_id)
521
return kind, contents
523
def contents_conflict():
524
trans_id = self.tt.trans_id_file_id(file_id)
525
name = self.tt.final_name(trans_id)
526
parent_id = self.tt.final_parent(trans_id)
527
if file_id in self.this_tree.inventory:
528
self.tt.unversion_file(trans_id)
529
self.tt.delete_contents(trans_id)
530
file_group = self._dump_conflicts(name, parent_id, file_id,
532
self._raw_conflicts.append(('contents conflict', file_group))
534
# See SPOT run. run, SPOT, run.
535
# So we're not QUITE repeating ourselves; we do tricky things with
537
base_pair = contents_pair(self.base_tree)
538
other_pair = contents_pair(self.other_tree)
539
if base_pair == other_pair:
540
# OTHER introduced no changes
542
this_pair = contents_pair(self.this_tree)
543
if this_pair == other_pair:
544
# THIS and OTHER introduced the same changes
547
trans_id = self.tt.trans_id_file_id(file_id)
548
if this_pair == base_pair:
549
# only OTHER introduced changes
550
if file_id in self.this_tree:
551
# Remove any existing contents
552
self.tt.delete_contents(trans_id)
553
if file_id in self.other_tree:
554
# OTHER changed the file
555
create_by_entry(self.tt,
556
self.other_tree.inventory[file_id],
557
self.other_tree, trans_id)
558
if file_id not in self.this_tree.inventory:
559
self.tt.version_file(file_id, trans_id)
561
elif file_id in self.this_tree.inventory:
562
# OTHER deleted the file
563
self.tt.unversion_file(trans_id)
565
#BOTH THIS and OTHER introduced changes; scalar conflict
566
elif this_pair[0] == "file" and other_pair[0] == "file":
567
# THIS and OTHER are both files, so text merge. Either
568
# BASE is a file, or both converted to files, so at least we
569
# have agreement that output should be a file.
571
self.text_merge(file_id, trans_id)
573
return contents_conflict()
574
if file_id not in self.this_tree.inventory:
575
self.tt.version_file(file_id, trans_id)
577
self.tt.tree_kind(trans_id)
578
self.tt.delete_contents(trans_id)
583
# Scalar conflict, can't text merge. Dump conflicts
584
return contents_conflict()
586
def get_lines(self, tree, file_id):
587
"""Return the lines in a file, or an empty list."""
589
return tree.get_file(file_id).readlines()
593
def text_merge(self, file_id, trans_id):
594
"""Perform a three-way text merge on a file_id"""
595
# it's possible that we got here with base as a different type.
596
# if so, we just want two-way text conflicts.
597
if file_id in self.base_tree and \
598
self.base_tree.kind(file_id) == "file":
599
base_lines = self.get_lines(self.base_tree, file_id)
602
other_lines = self.get_lines(self.other_tree, file_id)
603
this_lines = self.get_lines(self.this_tree, file_id)
604
m3 = Merge3(base_lines, this_lines, other_lines)
605
start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
606
if self.show_base is True:
607
base_marker = '|' * 7
611
def iter_merge3(retval):
612
retval["text_conflicts"] = False
613
for line in m3.merge_lines(name_a = "TREE",
614
name_b = "MERGE-SOURCE",
615
name_base = "BASE-REVISION",
616
start_marker=start_marker,
617
base_marker=base_marker,
618
reprocess=self.reprocess):
619
if line.startswith(start_marker):
620
retval["text_conflicts"] = True
621
yield line.replace(start_marker, '<' * 7)
625
merge3_iterator = iter_merge3(retval)
626
self.tt.create_file(merge3_iterator, trans_id)
627
if retval["text_conflicts"] is True:
628
self._raw_conflicts.append(('text conflict', trans_id))
629
name = self.tt.final_name(trans_id)
630
parent_id = self.tt.final_parent(trans_id)
631
file_group = self._dump_conflicts(name, parent_id, file_id,
632
this_lines, base_lines,
634
file_group.append(trans_id)
636
def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
637
base_lines=None, other_lines=None, set_version=False,
639
"""Emit conflict files.
640
If this_lines, base_lines, or other_lines are omitted, they will be
641
determined automatically. If set_version is true, the .OTHER, .THIS
642
or .BASE (in that order) will be created as versioned files.
644
data = [('OTHER', self.other_tree, other_lines),
645
('THIS', self.this_tree, this_lines)]
647
data.append(('BASE', self.base_tree, base_lines))
650
for suffix, tree, lines in data:
652
trans_id = self._conflict_file(name, parent_id, tree, file_id,
654
file_group.append(trans_id)
655
if set_version and not versioned:
656
self.tt.version_file(file_id, trans_id)
660
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
662
"""Emit a single conflict file."""
663
name = name + '.' + suffix
664
trans_id = self.tt.create_path(name, parent_id)
665
entry = tree.inventory[file_id]
666
create_by_entry(self.tt, entry, tree, trans_id, lines)
669
def merge_executable(self, file_id, file_status):
670
"""Perform a merge on the execute bit."""
671
if file_status == "deleted":
673
trans_id = self.tt.trans_id_file_id(file_id)
675
if self.tt.final_kind(trans_id) != "file":
679
winner = self.scalar_three_way(self.this_tree, self.base_tree,
680
self.other_tree, file_id,
682
if winner == "conflict":
683
# There must be a None in here, if we have a conflict, but we
684
# need executability since file status was not deleted.
685
if self.other_tree.is_executable(file_id) is None:
690
if file_status == "modified":
691
executability = self.this_tree.is_executable(file_id)
692
if executability is not None:
693
trans_id = self.tt.trans_id_file_id(file_id)
694
self.tt.set_executability(executability, trans_id)
696
assert winner == "other"
697
if file_id in self.other_tree:
698
executability = self.other_tree.is_executable(file_id)
699
elif file_id in self.this_tree:
700
executability = self.this_tree.is_executable(file_id)
701
elif file_id in self.base_tree:
702
executability = self.base_tree.is_executable(file_id)
703
if executability is not None:
704
trans_id = self.tt.trans_id_file_id(file_id)
705
self.tt.set_executability(executability, trans_id)
707
def cook_conflicts(self, fs_conflicts):
708
"""Convert all conflicts into a form that doesn't depend on trans_id"""
709
from conflicts import Conflict
711
self.cooked_conflicts.extend(cook_conflicts(fs_conflicts, self.tt))
712
fp = FinalPaths(self.tt)
713
for conflict in self._raw_conflicts:
714
conflict_type = conflict[0]
715
if conflict_type in ('name conflict', 'parent conflict'):
716
trans_id = conflict[1]
717
conflict_args = conflict[2:]
718
if trans_id not in name_conflicts:
719
name_conflicts[trans_id] = {}
720
unique_add(name_conflicts[trans_id], conflict_type,
722
if conflict_type == 'contents conflict':
723
for trans_id in conflict[1]:
724
file_id = self.tt.final_file_id(trans_id)
214
725
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():
727
path = fp.get_path(trans_id)
728
for suffix in ('.BASE', '.THIS', '.OTHER'):
729
if path.endswith(suffix):
730
path = path[:-len(suffix)]
732
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
733
self.cooked_conflicts.append(c)
734
if conflict_type == 'text conflict':
735
trans_id = conflict[1]
736
path = fp.get_path(trans_id)
737
file_id = self.tt.final_file_id(trans_id)
738
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
739
self.cooked_conflicts.append(c)
741
for trans_id, conflicts in name_conflicts.iteritems():
743
this_parent, other_parent = conflicts['parent conflict']
744
assert this_parent != other_parent
746
this_parent = other_parent = \
747
self.tt.final_file_id(self.tt.final_parent(trans_id))
749
this_name, other_name = conflicts['name conflict']
750
assert this_name != other_name
752
this_name = other_name = self.tt.final_name(trans_id)
753
other_path = fp.get_path(trans_id)
754
if this_parent is not None:
756
fp.get_path(self.tt.trans_id_file_id(this_parent))
757
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")
759
this_path = "<deleted>"
760
file_id = self.tt.final_file_id(trans_id)
761
c = Conflict.factory('path conflict', path=this_path,
762
conflict_path=other_path, file_id=file_id)
763
self.cooked_conflicts.append(c)
766
class WeaveMerger(Merge3Merger):
767
"""Three-way tree merger, text weave merger."""
768
supports_reprocess = False
769
supports_show_base = False
771
def __init__(self, working_tree, this_tree, base_tree, other_tree,
772
interesting_ids=None, pb=DummyProgress(), pp=None):
773
self.this_revision_tree = self._get_revision_tree(this_tree)
774
self.other_revision_tree = self._get_revision_tree(other_tree)
775
super(WeaveMerger, self).__init__(working_tree, this_tree,
776
base_tree, other_tree,
777
interesting_ids=interesting_ids,
780
def _get_revision_tree(self, tree):
781
"""Return a revision tree releated to this tree.
782
If the tree is a WorkingTree, the basis will be returned.
784
if getattr(tree, 'get_weave', False) is False:
785
# If we have a WorkingTree, try using the basis
786
return tree.branch.basis_tree()
790
def _check_file(self, file_id):
791
"""Check that the revision tree's version of the file matches."""
792
for tree, rt in ((self.this_tree, self.this_revision_tree),
793
(self.other_tree, self.other_revision_tree)):
796
if tree.get_file_sha1(file_id) != rt.get_file_sha1(file_id):
797
raise WorkingTreeNotRevision(self.this_tree)
799
def _merged_lines(self, file_id):
800
"""Generate the merged lines.
801
There is no distinction between lines that are meant to contain <<<<<<<
804
weave = self.this_revision_tree.get_weave(file_id)
805
this_revision_id = self.this_revision_tree.inventory[file_id].revision
806
other_revision_id = \
807
self.other_revision_tree.inventory[file_id].revision
808
plan = weave.plan_merge(this_revision_id, other_revision_id)
809
return weave.weave_merge(plan, '<<<<<<< TREE\n',
810
'>>>>>>> MERGE-SOURCE\n')
812
def text_merge(self, file_id, trans_id):
813
"""Perform a (weave) text merge for a given file and file-id.
814
If conflicts are encountered, .THIS and .OTHER files will be emitted,
815
and a conflict will be noted.
817
self._check_file(file_id)
818
lines = list(self._merged_lines(file_id))
819
conflicts = '<<<<<<< TREE\n' in lines
820
# Note we're checking whether the OUTPUT is binary in this case,
821
# because we don't want to get into weave merge guts.
822
check_text_lines(lines)
823
self.tt.create_file(lines, trans_id)
825
self._raw_conflicts.append(('text conflict', trans_id))
826
name = self.tt.final_name(trans_id)
827
parent_id = self.tt.final_parent(trans_id)
828
file_group = self._dump_conflicts(name, parent_id, file_id,
830
file_group.append(trans_id)
833
class Diff3Merger(Merge3Merger):
834
"""Three-way merger using external diff3 for text merging"""
835
def dump_file(self, temp_dir, name, tree, file_id):
836
out_path = pathjoin(temp_dir, name)
837
out_file = file(out_path, "wb")
838
in_file = tree.get_file(file_id)
843
def text_merge(self, file_id, trans_id):
844
"""Perform a diff3 merge using a specified file-id and trans-id.
845
If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
846
will be dumped, and a will be conflict noted.
849
temp_dir = mkdtemp(prefix="bzr-")
851
new_file = pathjoin(temp_dir, "new")
852
this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
853
base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
854
other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
855
status = bzrlib.patch.diff3(new_file, this, base, other)
856
if status not in (0, 1):
857
raise BzrError("Unhandled diff3 exit code")
858
self.tt.create_file(file(new_file, "rb"), trans_id)
860
name = self.tt.final_name(trans_id)
861
parent_id = self.tt.final_parent(trans_id)
862
self._dump_conflicts(name, parent_id, file_id)
863
self._raw_conflicts.append(('text conflict', trans_id))
868
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
870
merge_type=Merge3Merger,
871
interesting_ids=None,
875
interesting_files=None,
878
"""Primary interface for merging.
880
typical use is probably
881
'merge_inner(branch, branch.get_revision_tree(other_revision),
882
branch.get_revision_tree(base_revision))'
884
if this_tree is None:
885
warn("bzrlib.merge.merge_inner requires a this_tree parameter as of "
886
"bzrlib version 0.8.",
889
this_tree = this_branch.bzrdir.open_workingtree()
890
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
892
merger.backup_files = backup_files
893
merger.merge_type = merge_type
894
merger.interesting_ids = interesting_ids
895
merger.ignore_zero = ignore_zero
896
if interesting_files:
897
assert not interesting_ids, ('Only supply interesting_ids'
898
' or interesting_files')
899
merger._set_interesting_files(interesting_files)
900
merger.show_base = show_base
901
merger.reprocess = reprocess
902
merger.other_rev_id = other_rev_id
903
merger.other_basis = other_rev_id
904
return merger.do_merge()
907
merge_types = { "merge3": (Merge3Merger, "Native diff3-style merge"),
908
"diff3": (Diff3Merger, "Merge using external diff3"),
909
'weave': (WeaveMerger, "Weave-based merge")
added
removed
bzrlib/merge.py
