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,
47
from bzrlib.versionedfile import WeaveMerge
50
# TODO: Report back as changes are merged in
52
def _get_tree(treespec, local_branch=None):
105
53
location, revno = treespec
106
branch = find_branch(location)
54
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):
58
revision = branch.last_revision()
60
revision = branch.get_rev_id(revno)
62
revision = NULL_REVISION
63
return branch, _get_revid_tree(branch, revision, local_branch)
66
def _get_revid_tree(branch, revision, local_branch):
68
base_tree = branch.bzrdir.open_workingtree()
70
if local_branch is not None:
71
if local_branch.base != branch.base:
72
local_branch.fetch(branch, revision)
73
base_tree = local_branch.repository.revision_tree(revision)
75
base_tree = branch.repository.revision_tree(revision)
79
def transform_tree(from_tree, to_tree, interesting_ids=None):
80
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
81
interesting_ids=interesting_ids, this_tree=from_tree)
85
def __init__(self, this_branch, other_tree=None, base_tree=None,
86
this_tree=None, pb=DummyProgress()):
137
87
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)
88
assert this_tree is not None, "this_tree is required"
89
self.this_branch = this_branch
90
self.this_basis = this_branch.last_revision()
91
self.this_rev_id = None
92
self.this_tree = this_tree
93
self.this_revision_tree = None
94
self.this_basis_tree = None
95
self.other_tree = other_tree
96
self.base_tree = base_tree
97
self.ignore_zero = False
98
self.backup_files = False
99
self.interesting_ids = None
100
self.show_base = False
101
self.reprocess = False
106
def revision_tree(self, revision_id):
107
return self.this_branch.repository.revision_tree(revision_id)
109
def ensure_revision_trees(self):
110
if self.this_revision_tree is None:
111
self.this_basis_tree = self.this_branch.repository.revision_tree(
113
if self.this_basis == self.this_rev_id:
114
self.this_revision_tree = self.this_basis_tree
116
if self.other_rev_id is None:
117
other_basis_tree = self.revision_tree(self.other_basis)
118
changes = compare_trees(self.other_tree, other_basis_tree)
119
if changes.has_changed():
120
raise WorkingTreeNotRevision(self.this_tree)
121
other_rev_id = other_basis
122
self.other_tree = other_basis_tree
124
def file_revisions(self, file_id):
125
self.ensure_revision_trees()
126
def get_id(tree, file_id):
127
revision_id = tree.inventory[file_id].revision
128
assert revision_id is not None
130
if self.this_rev_id is None:
131
if self.this_basis_tree.get_file_sha1(file_id) != \
132
self.this_tree.get_file_sha1(file_id):
133
raise WorkingTreeNotRevision(self.this_tree)
135
trees = (self.this_basis_tree, self.other_tree)
136
return [get_id(tree, file_id) for tree in trees]
138
def check_basis(self, check_clean):
139
if self.this_basis is None:
140
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():
143
if self.this_basis != self.this_rev_id:
191
144
raise BzrCommandError("Working tree has uncommitted changes.")
192
other_branch, other_tree = get_tree(other_revision, tempdir, "other")
146
def compare_basis(self):
147
changes = compare_trees(self.this_tree,
148
self.this_tree.basis_tree(), False)
149
if not changes.has_changed():
150
self.this_rev_id = self.this_basis
152
def set_interesting_files(self, file_list):
154
self._set_interesting_files(file_list)
155
except NotVersionedError, e:
156
raise BzrCommandError("%s is not a source file in any"
159
def _set_interesting_files(self, file_list):
160
"""Set the list of interesting ids from a list of files."""
161
if file_list is None:
162
self.interesting_ids = None
165
interesting_ids = set()
166
for path in file_list:
168
for tree in (self.this_tree, self.base_tree, self.other_tree):
169
file_id = tree.inventory.path2id(path)
170
if file_id is not None:
171
interesting_ids.add(file_id)
174
raise NotVersionedError(path=path)
175
self.interesting_ids = interesting_ids
177
def set_pending(self):
178
if not self.base_is_ancestor:
180
if self.other_rev_id is None:
182
ancestry = self.this_branch.repository.get_ancestry(self.this_basis)
183
if self.other_rev_id in ancestry:
185
self.this_tree.add_pending_merge(self.other_rev_id)
187
def set_other(self, other_revision):
188
other_branch, self.other_tree = _get_tree(other_revision,
190
if other_revision[1] == -1:
191
self.other_rev_id = other_branch.last_revision()
192
if self.other_rev_id is None:
193
raise NoCommits(other_branch)
194
self.other_basis = self.other_rev_id
195
elif other_revision[1] is not None:
196
self.other_rev_id = other_branch.get_rev_id(other_revision[1])
197
self.other_basis = self.other_rev_id
199
self.other_rev_id = None
200
self.other_basis = other_branch.last_revision()
201
if self.other_basis is None:
202
raise NoCommits(other_branch)
203
if other_branch.base != self.this_branch.base:
204
self.this_branch.fetch(other_branch, last_revision=self.other_basis)
206
def set_base(self, base_revision):
207
mutter("doing merge() with no base_revision specified")
193
208
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:
210
pb = bzrlib.ui.ui_factory.nested_progress_bar()
212
this_repo = self.this_branch.repository
213
self.base_rev_id = common_ancestor(self.this_basis,
218
except NoCommonAncestor:
201
219
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)
220
self.base_tree = _get_revid_tree(self.this_branch, self.base_rev_id,
222
self.base_is_ancestor = True
224
base_branch, self.base_tree = _get_tree(base_revision)
225
if base_revision[1] == -1:
226
self.base_rev_id = base_branch.last_revision()
227
elif base_revision[1] is None:
228
self.base_rev_id = None
230
self.base_rev_id = base_branch.get_rev_id(base_revision[1])
231
if self.this_branch.base != base_branch.base:
232
self.this_branch.fetch(base_branch)
233
self.base_is_ancestor = is_ancestor(self.this_basis,
238
kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
239
'other_tree': self.other_tree,
240
'interesting_ids': self.interesting_ids,
242
if self.merge_type.requires_base:
243
kwargs['base_tree'] = self.base_tree
244
if self.merge_type.supports_reprocess:
245
kwargs['reprocess'] = self.reprocess
247
raise BzrError("Conflict reduction is not supported for merge"
248
" type %s." % self.merge_type)
249
if self.merge_type.supports_show_base:
250
kwargs['show_base'] = self.show_base
252
raise BzrError("Showing base is not supported for this"
253
" merge type. %s" % self.merge_type)
254
merge = self.merge_type(pb=self._pb, **kwargs)
255
if len(merge.cooked_conflicts) == 0:
256
if not self.ignore_zero:
257
note("All changes applied successfully.")
259
note("%d conflicts encountered." % len(merge.cooked_conflicts))
261
return len(merge.cooked_conflicts)
263
def regen_inventory(self, new_entries):
264
old_entries = self.this_tree.read_working_inventory()
268
for path, file_id in new_entries:
271
new_entries_map[file_id] = path
273
def id2path(file_id):
274
path = new_entries_map.get(file_id)
277
entry = old_entries[file_id]
278
if entry.parent_id is None:
280
return pathjoin(id2path(entry.parent_id), entry.name)
282
for file_id in old_entries:
283
entry = old_entries[file_id]
284
path = id2path(file_id)
285
new_inventory[file_id] = (path, file_id, entry.parent_id,
287
by_path[path] = file_id
292
for path, file_id in new_entries:
294
del new_inventory[file_id]
297
new_path_list.append((path, file_id))
298
if file_id not in old_entries:
300
# Ensure no file is added before its parent
302
for path, file_id in new_path_list:
306
parent = by_path[os.path.dirname(path)]
307
abspath = pathjoin(self.this_tree.basedir, path)
308
kind = bzrlib.osutils.file_kind(abspath)
309
new_inventory[file_id] = (path, file_id, parent, kind)
310
by_path[path] = file_id
312
# Get a list in insertion order
313
new_inventory_list = new_inventory.values()
314
mutter ("""Inventory regeneration:
315
old length: %i insertions: %i deletions: %i new_length: %i"""\
316
% (len(old_entries), insertions, deletions,
317
len(new_inventory_list)))
318
assert len(new_inventory_list) == len(old_entries) + insertions\
320
new_inventory_list.sort()
321
return new_inventory_list
324
class Merge3Merger(object):
325
"""Three-way merger that uses the merge3 text merger"""
327
supports_reprocess = True
328
supports_show_base = True
329
history_based = False
331
def __init__(self, working_tree, this_tree, base_tree, other_tree,
332
interesting_ids=None, reprocess=False, show_base=False,
333
pb=DummyProgress(), pp=None):
334
"""Initialize the merger object and perform the merge."""
335
object.__init__(self)
336
self.this_tree = working_tree
337
self.base_tree = base_tree
338
self.other_tree = other_tree
339
self._raw_conflicts = []
340
self.cooked_conflicts = []
341
self.reprocess = reprocess
342
self.show_base = show_base
346
self.pp = ProgressPhase("Merge phase", 3, self.pb)
348
if interesting_ids is not None:
349
all_ids = interesting_ids
351
all_ids = set(base_tree)
352
all_ids.update(other_tree)
353
working_tree.lock_write()
354
self.tt = TreeTransform(working_tree, self.pb)
357
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
359
for num, file_id in enumerate(all_ids):
360
child_pb.update('Preparing file merge', num, len(all_ids))
361
self.merge_names(file_id)
362
file_status = self.merge_contents(file_id)
363
self.merge_executable(file_id, file_status)
368
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
370
fs_conflicts = resolve_conflicts(self.tt, child_pb)
373
self.cook_conflicts(fs_conflicts)
374
for line in conflicts_strings(self.cooked_conflicts):
377
results = self.tt.apply()
378
self.write_modified(results)
384
working_tree.unlock()
387
def write_modified(self, results):
389
for path in results.modified_paths:
390
file_id = self.this_tree.path2id(self.this_tree.relpath(path))
393
hash = self.this_tree.get_file_sha1(file_id)
396
modified_hashes[file_id] = hash
397
self.this_tree.set_merge_modified(modified_hashes)
400
def parent(entry, file_id):
401
"""Determine the parent for a file_id (used as a key method)"""
404
return entry.parent_id
407
def name(entry, file_id):
408
"""Determine the name for a file_id (used as a key method)"""
414
def contents_sha1(tree, file_id):
415
"""Determine the sha1 of the file contents (used as a key method)."""
416
if file_id not in tree:
418
return tree.get_file_sha1(file_id)
421
def executable(tree, file_id):
422
"""Determine the executability of a file-id (used as a key method)."""
423
if file_id not in tree:
425
if tree.kind(file_id) != "file":
427
return tree.is_executable(file_id)
430
def kind(tree, file_id):
431
"""Determine the kind of a file-id (used as a key method)."""
432
if file_id not in tree:
434
return tree.kind(file_id)
437
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
438
"""Do a three-way test on a scalar.
439
Return "this", "other" or "conflict", depending whether a value wins.
441
key_base = key(base_tree, file_id)
442
key_other = key(other_tree, file_id)
443
#if base == other, either they all agree, or only THIS has changed.
444
if key_base == key_other:
446
key_this = key(this_tree, file_id)
447
if key_this not in (key_base, key_other):
449
# "Ambiguous clean merge"
450
elif key_this == key_other:
453
assert key_this == key_base
456
def merge_names(self, file_id):
457
"""Perform a merge on file_id names and parents"""
459
if file_id in tree.inventory:
460
return tree.inventory[file_id]
463
this_entry = get_entry(self.this_tree)
464
other_entry = get_entry(self.other_tree)
465
base_entry = get_entry(self.base_tree)
466
name_winner = self.scalar_three_way(this_entry, base_entry,
467
other_entry, file_id, self.name)
468
parent_id_winner = self.scalar_three_way(this_entry, base_entry,
469
other_entry, file_id,
471
if this_entry is None:
472
if name_winner == "this":
473
name_winner = "other"
474
if parent_id_winner == "this":
475
parent_id_winner = "other"
476
if name_winner == "this" and parent_id_winner == "this":
478
if name_winner == "conflict":
479
trans_id = self.tt.trans_id_file_id(file_id)
480
self._raw_conflicts.append(('name conflict', trans_id,
481
self.name(this_entry, file_id),
482
self.name(other_entry, file_id)))
483
if parent_id_winner == "conflict":
484
trans_id = self.tt.trans_id_file_id(file_id)
485
self._raw_conflicts.append(('parent conflict', trans_id,
486
self.parent(this_entry, file_id),
487
self.parent(other_entry, file_id)))
488
if other_entry is None:
489
# it doesn't matter whether the result was 'other' or
490
# 'conflict'-- if there's no 'other', we leave it alone.
492
# if we get here, name_winner and parent_winner are set to safe values.
493
winner_entry = {"this": this_entry, "other": other_entry,
494
"conflict": other_entry}
495
trans_id = self.tt.trans_id_file_id(file_id)
496
parent_id = winner_entry[parent_id_winner].parent_id
497
parent_trans_id = self.tt.trans_id_file_id(parent_id)
498
self.tt.adjust_path(winner_entry[name_winner].name, parent_trans_id,
501
def merge_contents(self, file_id):
502
"""Performa a merge on file_id contents."""
503
def contents_pair(tree):
504
if file_id not in tree:
506
kind = tree.kind(file_id)
507
if kind == "root_directory":
510
contents = tree.get_file_sha1(file_id)
511
elif kind == "symlink":
512
contents = tree.get_symlink_target(file_id)
515
return kind, contents
516
# See SPOT run. run, SPOT, run.
517
# So we're not QUITE repeating ourselves; we do tricky things with
519
base_pair = contents_pair(self.base_tree)
520
other_pair = contents_pair(self.other_tree)
521
if base_pair == other_pair:
522
# OTHER introduced no changes
524
this_pair = contents_pair(self.this_tree)
525
if this_pair == other_pair:
526
# THIS and OTHER introduced the same changes
529
trans_id = self.tt.trans_id_file_id(file_id)
530
if this_pair == base_pair:
531
# only OTHER introduced changes
532
if file_id in self.this_tree:
533
# Remove any existing contents
534
self.tt.delete_contents(trans_id)
535
if file_id in self.other_tree:
536
# OTHER changed the file
537
create_by_entry(self.tt,
538
self.other_tree.inventory[file_id],
539
self.other_tree, trans_id)
540
if file_id not in self.this_tree.inventory:
541
self.tt.version_file(file_id, trans_id)
543
elif file_id in self.this_tree.inventory:
544
# OTHER deleted the file
545
self.tt.unversion_file(trans_id)
547
#BOTH THIS and OTHER introduced changes; scalar conflict
548
elif this_pair[0] == "file" and other_pair[0] == "file":
549
# THIS and OTHER are both files, so text merge. Either
550
# BASE is a file, or both converted to files, so at least we
551
# have agreement that output should be a file.
552
if file_id not in self.this_tree.inventory:
553
self.tt.version_file(file_id, trans_id)
554
self.text_merge(file_id, trans_id)
556
self.tt.tree_kind(trans_id)
557
self.tt.delete_contents(trans_id)
562
# Scalar conflict, can't text merge. Dump conflicts
563
trans_id = self.tt.trans_id_file_id(file_id)
564
name = self.tt.final_name(trans_id)
565
parent_id = self.tt.final_parent(trans_id)
566
if file_id in self.this_tree.inventory:
567
self.tt.unversion_file(trans_id)
568
self.tt.delete_contents(trans_id)
569
file_group = self._dump_conflicts(name, parent_id, file_id,
571
self._raw_conflicts.append(('contents conflict', file_group))
573
def get_lines(self, tree, file_id):
574
"""Return the lines in a file, or an empty list."""
576
return tree.get_file(file_id).readlines()
580
def text_merge(self, file_id, trans_id):
581
"""Perform a three-way text merge on a file_id"""
582
# it's possible that we got here with base as a different type.
583
# if so, we just want two-way text conflicts.
584
if file_id in self.base_tree and \
585
self.base_tree.kind(file_id) == "file":
586
base_lines = self.get_lines(self.base_tree, file_id)
589
other_lines = self.get_lines(self.other_tree, file_id)
590
this_lines = self.get_lines(self.this_tree, file_id)
591
m3 = Merge3(base_lines, this_lines, other_lines)
592
start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
593
if self.show_base is True:
594
base_marker = '|' * 7
598
def iter_merge3(retval):
599
retval["text_conflicts"] = False
600
for line in m3.merge_lines(name_a = "TREE",
601
name_b = "MERGE-SOURCE",
602
name_base = "BASE-REVISION",
603
start_marker=start_marker,
604
base_marker=base_marker,
605
reprocess=self.reprocess):
606
if line.startswith(start_marker):
607
retval["text_conflicts"] = True
608
yield line.replace(start_marker, '<' * 7)
612
merge3_iterator = iter_merge3(retval)
613
self.tt.create_file(merge3_iterator, trans_id)
614
if retval["text_conflicts"] is True:
615
self._raw_conflicts.append(('text conflict', trans_id))
616
name = self.tt.final_name(trans_id)
617
parent_id = self.tt.final_parent(trans_id)
618
file_group = self._dump_conflicts(name, parent_id, file_id,
619
this_lines, base_lines,
621
file_group.append(trans_id)
623
def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
624
base_lines=None, other_lines=None, set_version=False,
626
"""Emit conflict files.
627
If this_lines, base_lines, or other_lines are omitted, they will be
628
determined automatically. If set_version is true, the .OTHER, .THIS
629
or .BASE (in that order) will be created as versioned files.
631
data = [('OTHER', self.other_tree, other_lines),
632
('THIS', self.this_tree, this_lines)]
634
data.append(('BASE', self.base_tree, base_lines))
637
for suffix, tree, lines in data:
639
trans_id = self._conflict_file(name, parent_id, tree, file_id,
641
file_group.append(trans_id)
642
if set_version and not versioned:
643
self.tt.version_file(file_id, trans_id)
647
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
649
"""Emit a single conflict file."""
650
name = name + '.' + suffix
651
trans_id = self.tt.create_path(name, parent_id)
652
entry = tree.inventory[file_id]
653
create_by_entry(self.tt, entry, tree, trans_id, lines)
656
def merge_executable(self, file_id, file_status):
657
"""Perform a merge on the execute bit."""
658
if file_status == "deleted":
660
trans_id = self.tt.trans_id_file_id(file_id)
662
if self.tt.final_kind(trans_id) != "file":
666
winner = self.scalar_three_way(self.this_tree, self.base_tree,
667
self.other_tree, file_id,
669
if winner == "conflict":
670
# There must be a None in here, if we have a conflict, but we
671
# need executability since file status was not deleted.
672
if self.other_tree.is_executable(file_id) is None:
677
if file_status == "modified":
678
executability = self.this_tree.is_executable(file_id)
679
if executability is not None:
680
trans_id = self.tt.trans_id_file_id(file_id)
681
self.tt.set_executability(executability, trans_id)
683
assert winner == "other"
684
if file_id in self.other_tree:
685
executability = self.other_tree.is_executable(file_id)
686
elif file_id in self.this_tree:
687
executability = self.this_tree.is_executable(file_id)
688
elif file_id in self.base_tree:
689
executability = self.base_tree.is_executable(file_id)
690
if executability is not None:
691
trans_id = self.tt.trans_id_file_id(file_id)
692
self.tt.set_executability(executability, trans_id)
694
def cook_conflicts(self, fs_conflicts):
695
"""Convert all conflicts into a form that doesn't depend on trans_id"""
697
self.cooked_conflicts.extend(cook_conflicts(fs_conflicts, self.tt))
698
fp = FinalPaths(self.tt)
699
for conflict in self._raw_conflicts:
700
conflict_type = conflict[0]
701
if conflict_type in ('name conflict', 'parent conflict'):
702
trans_id = conflict[1]
703
conflict_args = conflict[2:]
704
if trans_id not in name_conflicts:
705
name_conflicts[trans_id] = {}
706
unique_add(name_conflicts[trans_id], conflict_type,
708
if conflict_type == 'contents conflict':
709
for trans_id in conflict[1]:
710
file_id = self.tt.final_file_id(trans_id)
214
711
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():
713
path = fp.get_path(trans_id)
714
for suffix in ('.BASE', '.THIS', '.OTHER'):
715
if path.endswith(suffix):
716
path = path[:-len(suffix)]
718
self.cooked_conflicts.append((conflict_type, file_id, path))
719
if conflict_type == 'text conflict':
720
trans_id = conflict[1]
721
path = fp.get_path(trans_id)
722
file_id = self.tt.final_file_id(trans_id)
723
self.cooked_conflicts.append((conflict_type, file_id, path))
725
for trans_id, conflicts in name_conflicts.iteritems():
727
this_parent, other_parent = conflicts['parent conflict']
728
assert this_parent != other_parent
730
this_parent = other_parent = \
731
self.tt.final_file_id(self.tt.final_parent(trans_id))
733
this_name, other_name = conflicts['name conflict']
734
assert this_name != other_name
736
this_name = other_name = self.tt.final_name(trans_id)
737
other_path = fp.get_path(trans_id)
738
if this_parent is not None:
740
fp.get_path(self.tt.trans_id_file_id(this_parent))
741
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")
743
this_path = "<deleted>"
744
file_id = self.tt.final_file_id(trans_id)
745
self.cooked_conflicts.append(('path conflict', file_id, this_path,
749
class WeaveMerger(Merge3Merger):
750
"""Three-way tree merger, text weave merger."""
751
supports_reprocess = True
752
supports_show_base = False
754
def __init__(self, working_tree, this_tree, base_tree, other_tree,
755
interesting_ids=None, pb=DummyProgress(), pp=None,
757
self.this_revision_tree = self._get_revision_tree(this_tree)
758
self.other_revision_tree = self._get_revision_tree(other_tree)
759
super(WeaveMerger, self).__init__(working_tree, this_tree,
760
base_tree, other_tree,
761
interesting_ids=interesting_ids,
762
pb=pb, pp=pp, reprocess=reprocess)
764
def _get_revision_tree(self, tree):
765
"""Return a revision tree releated to this tree.
766
If the tree is a WorkingTree, the basis will be returned.
768
if getattr(tree, 'get_weave', False) is False:
769
# If we have a WorkingTree, try using the basis
770
return tree.branch.basis_tree()
774
def _check_file(self, file_id):
775
"""Check that the revision tree's version of the file matches."""
776
for tree, rt in ((self.this_tree, self.this_revision_tree),
777
(self.other_tree, self.other_revision_tree)):
780
if tree.get_file_sha1(file_id) != rt.get_file_sha1(file_id):
781
raise WorkingTreeNotRevision(self.this_tree)
783
def _merged_lines(self, file_id):
784
"""Generate the merged lines.
785
There is no distinction between lines that are meant to contain <<<<<<<
788
weave = self.this_revision_tree.get_weave(file_id)
789
this_revision_id = self.this_revision_tree.inventory[file_id].revision
790
other_revision_id = \
791
self.other_revision_tree.inventory[file_id].revision
792
wm = WeaveMerge(weave, this_revision_id, other_revision_id,
793
'<<<<<<< TREE\n', '>>>>>>> MERGE-SOURCE\n')
794
return wm.merge_lines(self.reprocess)
796
def text_merge(self, file_id, trans_id):
797
"""Perform a (weave) text merge for a given file and file-id.
798
If conflicts are encountered, .THIS and .OTHER files will be emitted,
799
and a conflict will be noted.
801
self._check_file(file_id)
802
lines, conflicts = self._merged_lines(file_id)
803
self.tt.create_file(lines, trans_id)
805
self._raw_conflicts.append(('text conflict', trans_id))
806
name = self.tt.final_name(trans_id)
807
parent_id = self.tt.final_parent(trans_id)
808
file_group = self._dump_conflicts(name, parent_id, file_id,
810
file_group.append(trans_id)
813
class Diff3Merger(Merge3Merger):
814
"""Three-way merger using external diff3 for text merging"""
815
def dump_file(self, temp_dir, name, tree, file_id):
816
out_path = pathjoin(temp_dir, name)
817
out_file = file(out_path, "wb")
818
in_file = tree.get_file(file_id)
823
def text_merge(self, file_id, trans_id):
824
"""Perform a diff3 merge using a specified file-id and trans-id.
825
If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
826
will be dumped, and a will be conflict noted.
829
temp_dir = mkdtemp(prefix="bzr-")
831
new_file = pathjoin(temp_dir, "new")
832
this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
833
base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
834
other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
835
status = bzrlib.patch.diff3(new_file, this, base, other)
836
if status not in (0, 1):
837
raise BzrError("Unhandled diff3 exit code")
838
self.tt.create_file(file(new_file, "rb"), trans_id)
840
name = self.tt.final_name(trans_id)
841
parent_id = self.tt.final_parent(trans_id)
842
self._dump_conflicts(name, parent_id, file_id)
843
self._raw_conflicts.append(('text conflict', trans_id))
848
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
850
merge_type=Merge3Merger,
851
interesting_ids=None,
855
interesting_files=None,
858
"""Primary interface for merging.
860
typical use is probably
861
'merge_inner(branch, branch.get_revision_tree(other_revision),
862
branch.get_revision_tree(base_revision))'
864
if this_tree is None:
865
warn("bzrlib.merge.merge_inner requires a this_tree parameter as of "
866
"bzrlib version 0.8.",
869
this_tree = this_branch.bzrdir.open_workingtree()
870
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
872
merger.backup_files = backup_files
873
merger.merge_type = merge_type
874
merger.interesting_ids = interesting_ids
875
merger.ignore_zero = ignore_zero
876
if interesting_files:
877
assert not interesting_ids, ('Only supply interesting_ids'
878
' or interesting_files')
879
merger._set_interesting_files(interesting_files)
880
merger.show_base = show_base
881
merger.reprocess = reprocess
882
merger.other_rev_id = other_rev_id
883
merger.other_basis = other_rev_id
884
return merger.do_merge()
887
merge_types = { "merge3": (Merge3Merger, "Native diff3-style merge"),
888
"diff3": (Diff3Merger, "Merge using external diff3"),
889
'weave': (WeaveMerger, "Weave-based merge")
added
removed
bzrlib/merge.py
