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
6
from bzrlib.errors import BzrCommandError
7
from bzrlib.delta import compare_trees
8
from trace import mutter, warning
1
# Copyright (C) 2005, 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
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):
26
from bzrlib.branch import Branch
27
from bzrlib.conflicts import ConflictList, Conflict
28
from bzrlib.errors import (BzrCommandError,
38
WorkingTreeNotRevision,
41
from bzrlib.merge3 import Merge3
42
from bzrlib.osutils import rename, pathjoin
43
from progress import DummyProgress, ProgressPhase
44
from bzrlib.revision import common_ancestor, is_ancestor, NULL_REVISION
45
from bzrlib.textfile import check_text_lines
46
from bzrlib.trace import mutter, warning, note
47
from bzrlib.transform import (TreeTransform, resolve_conflicts, cook_conflicts,
48
FinalPaths, create_by_entry, unique_add,
50
from bzrlib.versionedfile import WeaveMerge
53
# TODO: Report back as changes are merged in
55
def _get_tree(treespec, local_branch=None):
56
from bzrlib import workingtree
105
57
location, revno = treespec
106
branch = find_branch(location)
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):
59
tree = workingtree.WorkingTree.open_containing(location)[0]
60
return tree.branch, tree
61
branch = Branch.open_containing(location)[0]
63
revision = branch.last_revision()
65
revision = branch.get_rev_id(revno)
67
revision = NULL_REVISION
68
return branch, _get_revid_tree(branch, revision, local_branch)
71
def _get_revid_tree(branch, revision, local_branch):
73
base_tree = branch.bzrdir.open_workingtree()
75
if local_branch is not None:
76
if local_branch.base != branch.base:
77
local_branch.fetch(branch, revision)
78
base_tree = local_branch.repository.revision_tree(revision)
80
base_tree = branch.repository.revision_tree(revision)
84
def transform_tree(from_tree, to_tree, interesting_ids=None):
85
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
86
interesting_ids=interesting_ids, this_tree=from_tree)
90
def __init__(self, this_branch, other_tree=None, base_tree=None,
91
this_tree=None, pb=DummyProgress()):
137
92
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)
93
assert this_tree is not None, "this_tree is required"
94
self.this_branch = this_branch
95
self.this_basis = this_branch.last_revision()
96
self.this_rev_id = None
97
self.this_tree = this_tree
98
self.this_revision_tree = None
99
self.this_basis_tree = None
100
self.other_tree = other_tree
101
self.base_tree = base_tree
102
self.ignore_zero = False
103
self.backup_files = False
104
self.interesting_ids = None
105
self.show_base = False
106
self.reprocess = False
111
def revision_tree(self, revision_id):
112
return self.this_branch.repository.revision_tree(revision_id)
114
def ensure_revision_trees(self):
115
if self.this_revision_tree is None:
116
self.this_basis_tree = self.this_branch.repository.revision_tree(
118
if self.this_basis == self.this_rev_id:
119
self.this_revision_tree = self.this_basis_tree
121
if self.other_rev_id is None:
122
other_basis_tree = self.revision_tree(self.other_basis)
123
changes = other_basis_tree.changes_from(self.other_tree)
124
if changes.has_changed():
125
raise WorkingTreeNotRevision(self.this_tree)
126
other_rev_id = self.other_basis
127
self.other_tree = other_basis_tree
129
def file_revisions(self, file_id):
130
self.ensure_revision_trees()
131
def get_id(tree, file_id):
132
revision_id = tree.inventory[file_id].revision
133
assert revision_id is not None
135
if self.this_rev_id is None:
136
if self.this_basis_tree.get_file_sha1(file_id) != \
137
self.this_tree.get_file_sha1(file_id):
138
raise WorkingTreeNotRevision(self.this_tree)
140
trees = (self.this_basis_tree, self.other_tree)
141
return [get_id(tree, file_id) for tree in trees]
143
def check_basis(self, check_clean, require_commits=True):
144
if self.this_basis is None and require_commits is True:
145
raise BzrCommandError("This branch has no commits."
146
" (perhaps you would prefer 'bzr pull')")
188
changes = compare_trees(this_branch.working_tree(),
189
this_branch.basis_tree(), False)
190
if changes.has_changed():
149
if self.this_basis != self.this_rev_id:
191
150
raise BzrCommandError("Working tree has uncommitted changes.")
192
other_branch, other_tree = get_tree(other_revision, tempdir, "other")
152
def compare_basis(self):
153
changes = self.this_tree.changes_from(self.this_tree.basis_tree())
154
if not changes.has_changed():
155
self.this_rev_id = self.this_basis
157
def set_interesting_files(self, file_list):
159
self._set_interesting_files(file_list)
160
except NotVersionedError, e:
161
raise BzrCommandError("%s is not a source file in any"
164
def _set_interesting_files(self, file_list):
165
"""Set the list of interesting ids from a list of files."""
166
if file_list is None:
167
self.interesting_ids = None
170
interesting_ids = set()
171
for path in file_list:
173
for tree in (self.this_tree, self.base_tree, self.other_tree):
174
file_id = tree.inventory.path2id(path)
175
if file_id is not None:
176
interesting_ids.add(file_id)
179
raise NotVersionedError(path=path)
180
self.interesting_ids = interesting_ids
182
def set_pending(self):
183
if not self.base_is_ancestor:
185
if self.other_rev_id is None:
187
ancestry = self.this_branch.repository.get_ancestry(self.this_basis)
188
if self.other_rev_id in ancestry:
190
self.this_tree.add_parent_tree((self.other_rev_id, self.other_tree))
192
def set_other(self, other_revision):
193
"""Set the revision and tree to merge from.
195
This sets the other_tree, other_rev_id, other_basis attributes.
197
:param other_revision: The [path, revision] list to merge from.
199
other_branch, self.other_tree = _get_tree(other_revision,
201
if other_revision[1] == -1:
202
self.other_rev_id = other_branch.last_revision()
203
if self.other_rev_id is None:
204
raise NoCommits(other_branch)
205
self.other_basis = self.other_rev_id
206
elif other_revision[1] is not None:
207
self.other_rev_id = other_branch.get_rev_id(other_revision[1])
208
self.other_basis = self.other_rev_id
210
self.other_rev_id = None
211
self.other_basis = other_branch.last_revision()
212
if self.other_basis is None:
213
raise NoCommits(other_branch)
214
if other_branch.base != self.this_branch.base:
215
self.this_branch.fetch(other_branch, last_revision=self.other_basis)
218
self.set_base([None, None])
220
def set_base(self, base_revision):
221
"""Set the base revision to use for the merge.
223
:param base_revision: A 2-list containing a path and revision number.
225
mutter("doing merge() with no base_revision specified")
193
226
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:
228
pb = ui.ui_factory.nested_progress_bar()
230
this_repo = self.this_branch.repository
231
self.base_rev_id = common_ancestor(self.this_basis,
236
except NoCommonAncestor:
201
237
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)
238
self.base_tree = _get_revid_tree(self.this_branch, self.base_rev_id,
240
self.base_is_ancestor = True
242
base_branch, self.base_tree = _get_tree(base_revision)
243
if base_revision[1] == -1:
244
self.base_rev_id = base_branch.last_revision()
245
elif base_revision[1] is None:
246
self.base_rev_id = None
248
self.base_rev_id = base_branch.get_rev_id(base_revision[1])
249
if self.this_branch.base != base_branch.base:
250
self.this_branch.fetch(base_branch)
251
self.base_is_ancestor = is_ancestor(self.this_basis,
256
kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
257
'other_tree': self.other_tree,
258
'interesting_ids': self.interesting_ids,
260
if self.merge_type.requires_base:
261
kwargs['base_tree'] = self.base_tree
262
if self.merge_type.supports_reprocess:
263
kwargs['reprocess'] = self.reprocess
265
raise BzrError("Conflict reduction is not supported for merge"
266
" type %s." % self.merge_type)
267
if self.merge_type.supports_show_base:
268
kwargs['show_base'] = self.show_base
270
raise BzrError("Showing base is not supported for this"
271
" merge type. %s" % self.merge_type)
272
merge = self.merge_type(pb=self._pb, **kwargs)
273
if len(merge.cooked_conflicts) == 0:
274
if not self.ignore_zero:
275
note("All changes applied successfully.")
277
note("%d conflicts encountered." % len(merge.cooked_conflicts))
279
return len(merge.cooked_conflicts)
281
def regen_inventory(self, new_entries):
282
old_entries = self.this_tree.read_working_inventory()
286
for path, file_id in new_entries:
289
new_entries_map[file_id] = path
291
def id2path(file_id):
292
path = new_entries_map.get(file_id)
295
entry = old_entries[file_id]
296
if entry.parent_id is None:
298
return pathjoin(id2path(entry.parent_id), entry.name)
300
for file_id in old_entries:
301
entry = old_entries[file_id]
302
path = id2path(file_id)
303
if file_id in self.base_tree.inventory:
304
executable = getattr(self.base_tree.inventory[file_id], 'executable', False)
306
executable = getattr(entry, 'executable', False)
307
new_inventory[file_id] = (path, file_id, entry.parent_id,
308
entry.kind, executable)
310
by_path[path] = file_id
315
for path, file_id in new_entries:
317
del new_inventory[file_id]
320
new_path_list.append((path, file_id))
321
if file_id not in old_entries:
323
# Ensure no file is added before its parent
325
for path, file_id in new_path_list:
329
parent = by_path[os.path.dirname(path)]
330
abspath = pathjoin(self.this_tree.basedir, path)
331
kind = osutils.file_kind(abspath)
332
if file_id in self.base_tree.inventory:
333
executable = getattr(self.base_tree.inventory[file_id], 'executable', False)
336
new_inventory[file_id] = (path, file_id, parent, kind, executable)
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,
344
len(new_inventory_list)))
345
assert len(new_inventory_list) == len(old_entries) + insertions\
347
new_inventory_list.sort()
348
return new_inventory_list
351
class Merge3Merger(object):
352
"""Three-way merger that uses the merge3 text merger"""
354
supports_reprocess = True
355
supports_show_base = True
356
history_based = False
358
def __init__(self, working_tree, this_tree, base_tree, other_tree,
359
interesting_ids=None, reprocess=False, show_base=False,
360
pb=DummyProgress(), pp=None):
361
"""Initialize the merger object and perform the merge."""
362
object.__init__(self)
363
self.this_tree = working_tree
364
self.base_tree = base_tree
365
self.other_tree = other_tree
366
self._raw_conflicts = []
367
self.cooked_conflicts = []
368
self.reprocess = reprocess
369
self.show_base = show_base
373
self.pp = ProgressPhase("Merge phase", 3, self.pb)
375
if interesting_ids is not None:
376
all_ids = interesting_ids
378
all_ids = set(base_tree)
379
all_ids.update(other_tree)
380
working_tree.lock_tree_write()
381
self.tt = TreeTransform(working_tree, self.pb)
384
child_pb = ui.ui_factory.nested_progress_bar()
386
for num, file_id in enumerate(all_ids):
387
child_pb.update('Preparing file merge', num, len(all_ids))
388
self.merge_names(file_id)
389
file_status = self.merge_contents(file_id)
390
self.merge_executable(file_id, file_status)
395
child_pb = ui.ui_factory.nested_progress_bar()
397
fs_conflicts = resolve_conflicts(self.tt, child_pb)
400
self.cook_conflicts(fs_conflicts)
401
for conflict in self.cooked_conflicts:
404
results = self.tt.apply()
405
self.write_modified(results)
407
working_tree.add_conflicts(self.cooked_conflicts)
408
except UnsupportedOperation:
412
working_tree.unlock()
417
self.tt.final_kind(self.tt.root)
419
self.tt.cancel_deletion(self.tt.root)
420
if self.tt.final_file_id(self.tt.root) is None:
421
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
423
if self.other_tree.inventory.root is None:
425
other_root_file_id = self.other_tree.inventory.root.file_id
426
other_root = self.tt.trans_id_file_id(other_root_file_id)
427
if other_root == self.tt.root:
430
self.tt.final_kind(other_root)
433
self.reparent_children(self.other_tree.inventory.root, self.tt.root)
434
self.tt.cancel_creation(other_root)
435
self.tt.cancel_versioning(other_root)
437
def reparent_children(self, ie, target):
438
for thing, child in ie.children.iteritems():
439
trans_id = self.tt.trans_id_file_id(child.file_id)
440
self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
442
def write_modified(self, results):
444
for path in results.modified_paths:
445
file_id = self.this_tree.path2id(self.this_tree.relpath(path))
448
hash = self.this_tree.get_file_sha1(file_id)
451
modified_hashes[file_id] = hash
452
self.this_tree.set_merge_modified(modified_hashes)
455
def parent(entry, file_id):
456
"""Determine the parent for a file_id (used as a key method)"""
459
return entry.parent_id
462
def name(entry, file_id):
463
"""Determine the name for a file_id (used as a key method)"""
469
def contents_sha1(tree, file_id):
470
"""Determine the sha1 of the file contents (used as a key method)."""
471
if file_id not in tree:
473
return tree.get_file_sha1(file_id)
476
def executable(tree, file_id):
477
"""Determine the executability of a file-id (used as a key method)."""
478
if file_id not in tree:
480
if tree.kind(file_id) != "file":
482
return tree.is_executable(file_id)
485
def kind(tree, file_id):
486
"""Determine the kind of a file-id (used as a key method)."""
487
if file_id not in tree:
489
return tree.kind(file_id)
492
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
493
"""Do a three-way test on a scalar.
494
Return "this", "other" or "conflict", depending whether a value wins.
496
key_base = key(base_tree, file_id)
497
key_other = key(other_tree, file_id)
498
#if base == other, either they all agree, or only THIS has changed.
499
if key_base == key_other:
501
key_this = key(this_tree, file_id)
502
if key_this not in (key_base, key_other):
504
# "Ambiguous clean merge"
505
elif key_this == key_other:
508
assert key_this == key_base
511
def merge_names(self, file_id):
512
"""Perform a merge on file_id names and parents"""
514
if file_id in tree.inventory:
515
return tree.inventory[file_id]
518
this_entry = get_entry(self.this_tree)
519
other_entry = get_entry(self.other_tree)
520
base_entry = get_entry(self.base_tree)
521
name_winner = self.scalar_three_way(this_entry, base_entry,
522
other_entry, file_id, self.name)
523
parent_id_winner = self.scalar_three_way(this_entry, base_entry,
524
other_entry, file_id,
526
if this_entry is None:
527
if name_winner == "this":
528
name_winner = "other"
529
if parent_id_winner == "this":
530
parent_id_winner = "other"
531
if name_winner == "this" and parent_id_winner == "this":
533
if name_winner == "conflict":
534
trans_id = self.tt.trans_id_file_id(file_id)
535
self._raw_conflicts.append(('name conflict', trans_id,
536
self.name(this_entry, file_id),
537
self.name(other_entry, file_id)))
538
if parent_id_winner == "conflict":
539
trans_id = self.tt.trans_id_file_id(file_id)
540
self._raw_conflicts.append(('parent conflict', trans_id,
541
self.parent(this_entry, file_id),
542
self.parent(other_entry, file_id)))
543
if other_entry is None:
544
# it doesn't matter whether the result was 'other' or
545
# 'conflict'-- if there's no 'other', we leave it alone.
547
# if we get here, name_winner and parent_winner are set to safe values.
548
winner_entry = {"this": this_entry, "other": other_entry,
549
"conflict": other_entry}
550
trans_id = self.tt.trans_id_file_id(file_id)
551
parent_id = winner_entry[parent_id_winner].parent_id
552
if parent_id is not None:
553
parent_trans_id = self.tt.trans_id_file_id(parent_id)
554
self.tt.adjust_path(winner_entry[name_winner].name,
555
parent_trans_id, trans_id)
557
def merge_contents(self, file_id):
558
"""Performa a merge on file_id contents."""
559
def contents_pair(tree):
560
if file_id not in tree:
562
kind = tree.kind(file_id)
564
contents = tree.get_file_sha1(file_id)
565
elif kind == "symlink":
566
contents = tree.get_symlink_target(file_id)
569
return kind, contents
571
def contents_conflict():
572
trans_id = self.tt.trans_id_file_id(file_id)
573
name = self.tt.final_name(trans_id)
574
parent_id = self.tt.final_parent(trans_id)
575
if file_id in self.this_tree.inventory:
576
self.tt.unversion_file(trans_id)
577
if file_id in self.this_tree:
578
self.tt.delete_contents(trans_id)
579
file_group = self._dump_conflicts(name, parent_id, file_id,
581
self._raw_conflicts.append(('contents conflict', file_group))
583
# See SPOT run. run, SPOT, run.
584
# So we're not QUITE repeating ourselves; we do tricky things with
586
base_pair = contents_pair(self.base_tree)
587
other_pair = contents_pair(self.other_tree)
588
if base_pair == other_pair:
589
# OTHER introduced no changes
591
this_pair = contents_pair(self.this_tree)
592
if this_pair == other_pair:
593
# THIS and OTHER introduced the same changes
596
trans_id = self.tt.trans_id_file_id(file_id)
597
if this_pair == base_pair:
598
# only OTHER introduced changes
599
if file_id in self.this_tree:
600
# Remove any existing contents
601
self.tt.delete_contents(trans_id)
602
if file_id in self.other_tree:
603
# OTHER changed the file
604
create_by_entry(self.tt,
605
self.other_tree.inventory[file_id],
606
self.other_tree, trans_id)
607
if file_id not in self.this_tree.inventory:
608
self.tt.version_file(file_id, trans_id)
610
elif file_id in self.this_tree.inventory:
611
# OTHER deleted the file
612
self.tt.unversion_file(trans_id)
614
#BOTH THIS and OTHER introduced changes; scalar conflict
615
elif this_pair[0] == "file" and other_pair[0] == "file":
616
# THIS and OTHER are both files, so text merge. Either
617
# BASE is a file, or both converted to files, so at least we
618
# have agreement that output should be a file.
620
self.text_merge(file_id, trans_id)
622
return contents_conflict()
623
if file_id not in self.this_tree.inventory:
624
self.tt.version_file(file_id, trans_id)
626
self.tt.tree_kind(trans_id)
627
self.tt.delete_contents(trans_id)
632
# Scalar conflict, can't text merge. Dump conflicts
633
return contents_conflict()
635
def get_lines(self, tree, file_id):
636
"""Return the lines in a file, or an empty list."""
638
return tree.get_file(file_id).readlines()
642
def text_merge(self, file_id, trans_id):
643
"""Perform a three-way text merge on a file_id"""
644
# it's possible that we got here with base as a different type.
645
# if so, we just want two-way text conflicts.
646
if file_id in self.base_tree and \
647
self.base_tree.kind(file_id) == "file":
648
base_lines = self.get_lines(self.base_tree, file_id)
651
other_lines = self.get_lines(self.other_tree, file_id)
652
this_lines = self.get_lines(self.this_tree, file_id)
653
m3 = Merge3(base_lines, this_lines, other_lines)
654
start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
655
if self.show_base is True:
656
base_marker = '|' * 7
660
def iter_merge3(retval):
661
retval["text_conflicts"] = False
662
for line in m3.merge_lines(name_a = "TREE",
663
name_b = "MERGE-SOURCE",
664
name_base = "BASE-REVISION",
665
start_marker=start_marker,
666
base_marker=base_marker,
667
reprocess=self.reprocess):
668
if line.startswith(start_marker):
669
retval["text_conflicts"] = True
670
yield line.replace(start_marker, '<' * 7)
674
merge3_iterator = iter_merge3(retval)
675
self.tt.create_file(merge3_iterator, trans_id)
676
if retval["text_conflicts"] is True:
677
self._raw_conflicts.append(('text conflict', trans_id))
678
name = self.tt.final_name(trans_id)
679
parent_id = self.tt.final_parent(trans_id)
680
file_group = self._dump_conflicts(name, parent_id, file_id,
681
this_lines, base_lines,
683
file_group.append(trans_id)
685
def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
686
base_lines=None, other_lines=None, set_version=False,
688
"""Emit conflict files.
689
If this_lines, base_lines, or other_lines are omitted, they will be
690
determined automatically. If set_version is true, the .OTHER, .THIS
691
or .BASE (in that order) will be created as versioned files.
693
data = [('OTHER', self.other_tree, other_lines),
694
('THIS', self.this_tree, this_lines)]
696
data.append(('BASE', self.base_tree, base_lines))
699
for suffix, tree, lines in data:
701
trans_id = self._conflict_file(name, parent_id, tree, file_id,
703
file_group.append(trans_id)
704
if set_version and not versioned:
705
self.tt.version_file(file_id, trans_id)
709
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
711
"""Emit a single conflict file."""
712
name = name + '.' + suffix
713
trans_id = self.tt.create_path(name, parent_id)
714
entry = tree.inventory[file_id]
715
create_by_entry(self.tt, entry, tree, trans_id, lines)
718
def merge_executable(self, file_id, file_status):
719
"""Perform a merge on the execute bit."""
720
if file_status == "deleted":
722
trans_id = self.tt.trans_id_file_id(file_id)
724
if self.tt.final_kind(trans_id) != "file":
728
winner = self.scalar_three_way(self.this_tree, self.base_tree,
729
self.other_tree, file_id,
731
if winner == "conflict":
732
# There must be a None in here, if we have a conflict, but we
733
# need executability since file status was not deleted.
734
if self.executable(self.other_tree, file_id) is None:
739
if file_status == "modified":
740
executability = self.this_tree.is_executable(file_id)
741
if executability is not None:
742
trans_id = self.tt.trans_id_file_id(file_id)
743
self.tt.set_executability(executability, trans_id)
745
assert winner == "other"
746
if file_id in self.other_tree:
747
executability = self.other_tree.is_executable(file_id)
748
elif file_id in self.this_tree:
749
executability = self.this_tree.is_executable(file_id)
750
elif file_id in self.base_tree:
751
executability = self.base_tree.is_executable(file_id)
752
if executability is not None:
753
trans_id = self.tt.trans_id_file_id(file_id)
754
self.tt.set_executability(executability, trans_id)
756
def cook_conflicts(self, fs_conflicts):
757
"""Convert all conflicts into a form that doesn't depend on trans_id"""
758
from conflicts import Conflict
760
self.cooked_conflicts.extend(cook_conflicts(fs_conflicts, self.tt))
761
fp = FinalPaths(self.tt)
762
for conflict in self._raw_conflicts:
763
conflict_type = conflict[0]
764
if conflict_type in ('name conflict', 'parent conflict'):
765
trans_id = conflict[1]
766
conflict_args = conflict[2:]
767
if trans_id not in name_conflicts:
768
name_conflicts[trans_id] = {}
769
unique_add(name_conflicts[trans_id], conflict_type,
771
if conflict_type == 'contents conflict':
772
for trans_id in conflict[1]:
773
file_id = self.tt.final_file_id(trans_id)
214
774
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():
776
path = fp.get_path(trans_id)
777
for suffix in ('.BASE', '.THIS', '.OTHER'):
778
if path.endswith(suffix):
779
path = path[:-len(suffix)]
781
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
782
self.cooked_conflicts.append(c)
783
if conflict_type == 'text conflict':
784
trans_id = conflict[1]
785
path = fp.get_path(trans_id)
786
file_id = self.tt.final_file_id(trans_id)
787
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
788
self.cooked_conflicts.append(c)
790
for trans_id, conflicts in name_conflicts.iteritems():
792
this_parent, other_parent = conflicts['parent conflict']
793
assert this_parent != other_parent
795
this_parent = other_parent = \
796
self.tt.final_file_id(self.tt.final_parent(trans_id))
798
this_name, other_name = conflicts['name conflict']
799
assert this_name != other_name
801
this_name = other_name = self.tt.final_name(trans_id)
802
other_path = fp.get_path(trans_id)
803
if this_parent is not None:
805
fp.get_path(self.tt.trans_id_file_id(this_parent))
806
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")
808
this_path = "<deleted>"
809
file_id = self.tt.final_file_id(trans_id)
810
c = Conflict.factory('path conflict', path=this_path,
811
conflict_path=other_path, file_id=file_id)
812
self.cooked_conflicts.append(c)
813
self.cooked_conflicts.sort(key=Conflict.sort_key)
816
class WeaveMerger(Merge3Merger):
817
"""Three-way tree merger, text weave merger."""
818
supports_reprocess = True
819
supports_show_base = False
821
def __init__(self, working_tree, this_tree, base_tree, other_tree,
822
interesting_ids=None, pb=DummyProgress(), pp=None,
824
self.this_revision_tree = self._get_revision_tree(this_tree)
825
self.other_revision_tree = self._get_revision_tree(other_tree)
826
super(WeaveMerger, self).__init__(working_tree, this_tree,
827
base_tree, other_tree,
828
interesting_ids=interesting_ids,
829
pb=pb, pp=pp, reprocess=reprocess)
831
def _get_revision_tree(self, tree):
832
"""Return a revision tree related to this tree.
833
If the tree is a WorkingTree, the basis will be returned.
835
if getattr(tree, 'get_weave', False) is False:
836
# If we have a WorkingTree, try using the basis
837
return tree.branch.basis_tree()
841
def _check_file(self, file_id):
842
"""Check that the revision tree's version of the file matches."""
843
for tree, rt in ((self.this_tree, self.this_revision_tree),
844
(self.other_tree, self.other_revision_tree)):
847
if tree.get_file_sha1(file_id) != rt.get_file_sha1(file_id):
848
raise WorkingTreeNotRevision(self.this_tree)
850
def _merged_lines(self, file_id):
851
"""Generate the merged lines.
852
There is no distinction between lines that are meant to contain <<<<<<<
855
weave = self.this_revision_tree.get_weave(file_id)
856
this_revision_id = self.this_revision_tree.inventory[file_id].revision
857
other_revision_id = \
858
self.other_revision_tree.inventory[file_id].revision
859
wm = WeaveMerge(weave, this_revision_id, other_revision_id,
860
'<<<<<<< TREE\n', '>>>>>>> MERGE-SOURCE\n')
861
return wm.merge_lines(self.reprocess)
863
def text_merge(self, file_id, trans_id):
864
"""Perform a (weave) text merge for a given file and file-id.
865
If conflicts are encountered, .THIS and .OTHER files will be emitted,
866
and a conflict will be noted.
868
self._check_file(file_id)
869
lines, conflicts = self._merged_lines(file_id)
871
# Note we're checking whether the OUTPUT is binary in this case,
872
# because we don't want to get into weave merge guts.
873
check_text_lines(lines)
874
self.tt.create_file(lines, trans_id)
876
self._raw_conflicts.append(('text conflict', trans_id))
877
name = self.tt.final_name(trans_id)
878
parent_id = self.tt.final_parent(trans_id)
879
file_group = self._dump_conflicts(name, parent_id, file_id,
881
file_group.append(trans_id)
884
class Diff3Merger(Merge3Merger):
885
"""Three-way merger using external diff3 for text merging"""
887
def dump_file(self, temp_dir, name, tree, file_id):
888
out_path = pathjoin(temp_dir, name)
889
out_file = open(out_path, "wb")
891
in_file = tree.get_file(file_id)
898
def text_merge(self, file_id, trans_id):
899
"""Perform a diff3 merge using a specified file-id and trans-id.
900
If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
901
will be dumped, and a will be conflict noted.
904
temp_dir = osutils.mkdtemp(prefix="bzr-")
906
new_file = pathjoin(temp_dir, "new")
907
this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
908
base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
909
other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
910
status = bzrlib.patch.diff3(new_file, this, base, other)
911
if status not in (0, 1):
912
raise BzrError("Unhandled diff3 exit code")
913
f = open(new_file, 'rb')
915
self.tt.create_file(f, trans_id)
919
name = self.tt.final_name(trans_id)
920
parent_id = self.tt.final_parent(trans_id)
921
self._dump_conflicts(name, parent_id, file_id)
922
self._raw_conflicts.append(('text conflict', trans_id))
924
osutils.rmtree(temp_dir)
927
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
929
merge_type=Merge3Merger,
930
interesting_ids=None,
934
interesting_files=None,
937
"""Primary interface for merging.
939
typical use is probably
940
'merge_inner(branch, branch.get_revision_tree(other_revision),
941
branch.get_revision_tree(base_revision))'
943
if this_tree is None:
944
warnings.warn("bzrlib.merge.merge_inner requires a this_tree parameter as of "
945
"bzrlib version 0.8.",
948
this_tree = this_branch.bzrdir.open_workingtree()
949
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
951
merger.backup_files = backup_files
952
merger.merge_type = merge_type
953
merger.interesting_ids = interesting_ids
954
merger.ignore_zero = ignore_zero
955
if interesting_files:
956
assert not interesting_ids, ('Only supply interesting_ids'
957
' or interesting_files')
958
merger._set_interesting_files(interesting_files)
959
merger.show_base = show_base
960
merger.reprocess = reprocess
961
merger.other_rev_id = other_rev_id
962
merger.other_basis = other_rev_id
963
return merger.do_merge()
965
def get_merge_type_registry():
966
"""Merge type registry is in bzrlib.option to avoid circular imports.
968
This method provides a sanctioned way to retrieve it.
970
from bzrlib import option
971
return option._merge_type_registry
added
removed
bzrlib/merge.py
