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(), change_reporter=None,
137
93
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)
94
assert this_tree is not None, "this_tree is required"
95
self.this_branch = this_branch
96
self.this_basis = this_branch.last_revision()
97
self.this_rev_id = None
98
self.this_tree = this_tree
99
self.this_revision_tree = None
100
self.this_basis_tree = None
101
self.other_tree = other_tree
102
self.other_branch = None
103
self.base_tree = base_tree
104
self.ignore_zero = False
105
self.backup_files = False
106
self.interesting_ids = None
107
self.show_base = False
108
self.reprocess = False
111
self.recurse = recurse
112
self.change_reporter = change_reporter
114
def revision_tree(self, revision_id):
115
return self.this_branch.repository.revision_tree(revision_id)
117
def ensure_revision_trees(self):
118
if self.this_revision_tree is None:
119
self.this_basis_tree = self.this_branch.repository.revision_tree(
121
if self.this_basis == self.this_rev_id:
122
self.this_revision_tree = self.this_basis_tree
124
if self.other_rev_id is None:
125
other_basis_tree = self.revision_tree(self.other_basis)
126
changes = other_basis_tree.changes_from(self.other_tree)
127
if changes.has_changed():
128
raise WorkingTreeNotRevision(self.this_tree)
129
other_rev_id = self.other_basis
130
self.other_tree = other_basis_tree
132
def file_revisions(self, file_id):
133
self.ensure_revision_trees()
134
def get_id(tree, file_id):
135
revision_id = tree.inventory[file_id].revision
136
assert revision_id is not None
138
if self.this_rev_id is None:
139
if self.this_basis_tree.get_file_sha1(file_id) != \
140
self.this_tree.get_file_sha1(file_id):
141
raise WorkingTreeNotRevision(self.this_tree)
143
trees = (self.this_basis_tree, self.other_tree)
144
return [get_id(tree, file_id) for tree in trees]
146
def check_basis(self, check_clean, require_commits=True):
147
if self.this_basis is None and require_commits is True:
148
raise BzrCommandError("This branch has no commits."
149
" (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():
152
if self.this_basis != self.this_rev_id:
191
153
raise BzrCommandError("Working tree has uncommitted changes.")
192
other_branch, other_tree = get_tree(other_revision, tempdir, "other")
155
def compare_basis(self):
156
changes = self.this_tree.changes_from(self.this_tree.basis_tree())
157
if not changes.has_changed():
158
self.this_rev_id = self.this_basis
160
def set_interesting_files(self, file_list):
162
self._set_interesting_files(file_list)
163
except NotVersionedError, e:
164
raise BzrCommandError("%s is not a source file in any"
167
def _set_interesting_files(self, file_list):
168
"""Set the list of interesting ids from a list of files."""
169
if file_list is None:
170
self.interesting_ids = None
173
interesting_ids = set()
174
for path in file_list:
176
for tree in (self.this_tree, self.base_tree, self.other_tree):
177
file_id = tree.inventory.path2id(path)
178
if file_id is not None:
179
interesting_ids.add(file_id)
182
raise NotVersionedError(path=path)
183
self.interesting_ids = interesting_ids
185
def set_pending(self):
186
if not self.base_is_ancestor:
188
if self.other_rev_id is None:
190
ancestry = self.this_branch.repository.get_ancestry(self.this_basis)
191
if self.other_rev_id in ancestry:
193
self.this_tree.add_parent_tree((self.other_rev_id, self.other_tree))
195
def set_other(self, other_revision):
196
"""Set the revision and tree to merge from.
198
This sets the other_tree, other_rev_id, other_basis attributes.
200
:param other_revision: The [path, revision] list to merge from.
202
self.other_branch, self.other_tree = _get_tree(other_revision,
204
if other_revision[1] == -1:
205
self.other_rev_id = self.other_branch.last_revision()
206
if self.other_rev_id is None:
207
raise NoCommits(self.other_branch)
208
self.other_basis = self.other_rev_id
209
elif other_revision[1] is not None:
210
self.other_rev_id = self.other_branch.get_rev_id(other_revision[1])
211
self.other_basis = self.other_rev_id
213
self.other_rev_id = None
214
self.other_basis = self.other_branch.last_revision()
215
if self.other_basis is None:
216
raise NoCommits(self.other_branch)
217
if self.other_branch.base != self.this_branch.base:
218
self.this_branch.fetch(self.other_branch,
219
last_revision=self.other_basis)
221
def set_other_revision(self, revision_id, other_branch):
222
"""Set 'other' based on a branch and revision id
224
:param revision_id: The revision to use for a tree
225
:param other_branch: The branch containing this tree
227
self.other_rev_id = revision_id
228
self.other_branch = other_branch
229
self.this_branch.fetch(other_branch, self.other_rev_id)
230
self.other_tree = self.revision_tree(revision_id)
231
self.other_basis = revision_id
234
self.set_base([None, None])
236
def set_base(self, base_revision):
237
"""Set the base revision to use for the merge.
239
:param base_revision: A 2-list containing a path and revision number.
241
mutter("doing merge() with no base_revision specified")
193
242
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:
244
pb = ui.ui_factory.nested_progress_bar()
246
this_repo = self.this_branch.repository
247
self.base_rev_id = common_ancestor(self.this_basis,
252
except NoCommonAncestor:
201
253
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)
254
self.base_tree = _get_revid_tree(self.this_branch, self.base_rev_id,
256
self.base_is_ancestor = True
258
base_branch, self.base_tree = _get_tree(base_revision)
259
if base_revision[1] == -1:
260
self.base_rev_id = base_branch.last_revision()
261
elif base_revision[1] is None:
262
self.base_rev_id = None
264
self.base_rev_id = base_branch.get_rev_id(base_revision[1])
265
if self.this_branch.base != base_branch.base:
266
self.this_branch.fetch(base_branch)
267
self.base_is_ancestor = is_ancestor(self.this_basis,
272
kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
273
'other_tree': self.other_tree,
274
'interesting_ids': self.interesting_ids,
276
if self.merge_type.requires_base:
277
kwargs['base_tree'] = self.base_tree
278
if self.merge_type.supports_reprocess:
279
kwargs['reprocess'] = self.reprocess
281
raise BzrError("Conflict reduction is not supported for merge"
282
" type %s." % self.merge_type)
283
if self.merge_type.supports_show_base:
284
kwargs['show_base'] = self.show_base
286
raise BzrError("Showing base is not supported for this"
287
" merge type. %s" % self.merge_type)
288
self.this_tree.lock_tree_write()
289
if self.base_tree is not None:
290
self.base_tree.lock_read()
291
if self.other_tree is not None:
292
self.other_tree.lock_read()
294
merge = self.merge_type(pb=self._pb,
295
change_reporter=self.change_reporter,
298
if self.other_tree is not None:
299
self.other_tree.unlock()
300
if self.base_tree is not None:
301
self.base_tree.unlock()
302
self.this_tree.unlock()
303
if len(merge.cooked_conflicts) == 0:
304
if not self.ignore_zero:
305
note("All changes applied successfully.")
307
note("%d conflicts encountered." % len(merge.cooked_conflicts))
309
if self.recurse == 'down':
310
for path, entry in self.this_tree.iter_reference_entries():
311
sub_tree = self.this_tree.get_nested_tree(entry, path)
312
other_entry = self.other_tree.inventory[entry.file_id]
313
other_revision = self.other_tree.get_reference_revision(
315
if other_revision == sub_tree.last_revision():
317
sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
318
sub_merge.merge_type = self.merge_type
319
other_branch = self.other_branch.reference_parent(
321
sub_merge.set_other_revision(other_revision, other_branch)
322
base_entry = self.base_tree.inventory[entry.file_id]
324
self.base_tree.get_reference_revision(base_entry)
325
sub_merge.base_tree = \
326
sub_tree.branch.repository.revision_tree(base_revision)
329
return len(merge.cooked_conflicts)
331
def regen_inventory(self, new_entries):
332
old_entries = self.this_tree.read_working_inventory()
336
for path, file_id in new_entries:
339
new_entries_map[file_id] = path
341
def id2path(file_id):
342
path = new_entries_map.get(file_id)
345
entry = old_entries[file_id]
346
if entry.parent_id is None:
348
return pathjoin(id2path(entry.parent_id), entry.name)
350
for file_id in old_entries:
351
entry = old_entries[file_id]
352
path = id2path(file_id)
353
if file_id in self.base_tree.inventory:
354
executable = getattr(self.base_tree.inventory[file_id], 'executable', False)
356
executable = getattr(entry, 'executable', False)
357
new_inventory[file_id] = (path, file_id, entry.parent_id,
358
entry.kind, executable)
360
by_path[path] = file_id
365
for path, file_id in new_entries:
367
del new_inventory[file_id]
370
new_path_list.append((path, file_id))
371
if file_id not in old_entries:
373
# Ensure no file is added before its parent
375
for path, file_id in new_path_list:
379
parent = by_path[os.path.dirname(path)]
380
abspath = pathjoin(self.this_tree.basedir, path)
381
kind = osutils.file_kind(abspath)
382
if file_id in self.base_tree.inventory:
383
executable = getattr(self.base_tree.inventory[file_id], 'executable', False)
386
new_inventory[file_id] = (path, file_id, parent, kind, executable)
387
by_path[path] = file_id
389
# Get a list in insertion order
390
new_inventory_list = new_inventory.values()
391
mutter ("""Inventory regeneration:
392
old length: %i insertions: %i deletions: %i new_length: %i"""\
393
% (len(old_entries), insertions, deletions,
394
len(new_inventory_list)))
395
assert len(new_inventory_list) == len(old_entries) + insertions\
397
new_inventory_list.sort()
398
return new_inventory_list
401
class Merge3Merger(object):
402
"""Three-way merger that uses the merge3 text merger"""
404
supports_reprocess = True
405
supports_show_base = True
406
history_based = False
408
def __init__(self, working_tree, this_tree, base_tree, other_tree,
409
interesting_ids=None, reprocess=False, show_base=False,
410
pb=DummyProgress(), pp=None, change_reporter=None):
411
"""Initialize the merger object and perform the merge."""
412
object.__init__(self)
413
self.this_tree = working_tree
414
self.base_tree = base_tree
415
self.other_tree = other_tree
416
self._raw_conflicts = []
417
self.cooked_conflicts = []
418
self.reprocess = reprocess
419
self.show_base = show_base
422
self.change_reporter = change_reporter
424
self.pp = ProgressPhase("Merge phase", 3, self.pb)
426
if interesting_ids is not None:
427
all_ids = interesting_ids
429
all_ids = set(base_tree)
430
all_ids.update(other_tree)
431
working_tree.lock_tree_write()
432
self.tt = TreeTransform(working_tree, self.pb)
435
child_pb = ui.ui_factory.nested_progress_bar()
437
for num, file_id in enumerate(all_ids):
438
child_pb.update('Preparing file merge', num, len(all_ids))
439
self.merge_names(file_id)
440
file_status = self.merge_contents(file_id)
441
self.merge_executable(file_id, file_status)
446
child_pb = ui.ui_factory.nested_progress_bar()
448
fs_conflicts = resolve_conflicts(self.tt, child_pb)
451
if change_reporter is not None:
452
from bzrlib import delta
453
delta.report_changes(self.tt._iter_changes(), change_reporter)
454
self.cook_conflicts(fs_conflicts)
455
for conflict in self.cooked_conflicts:
458
results = self.tt.apply()
459
self.write_modified(results)
461
working_tree.add_conflicts(self.cooked_conflicts)
462
except UnsupportedOperation:
466
working_tree.unlock()
471
self.tt.final_kind(self.tt.root)
473
self.tt.cancel_deletion(self.tt.root)
474
if self.tt.final_file_id(self.tt.root) is None:
475
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
477
if self.other_tree.inventory.root is None:
479
other_root_file_id = self.other_tree.inventory.root.file_id
480
other_root = self.tt.trans_id_file_id(other_root_file_id)
481
if other_root == self.tt.root:
484
self.tt.final_kind(other_root)
487
self.reparent_children(self.other_tree.inventory.root, self.tt.root)
488
self.tt.cancel_creation(other_root)
489
self.tt.cancel_versioning(other_root)
491
def reparent_children(self, ie, target):
492
for thing, child in ie.children.iteritems():
493
trans_id = self.tt.trans_id_file_id(child.file_id)
494
self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
496
def write_modified(self, results):
498
for path in results.modified_paths:
499
file_id = self.this_tree.path2id(self.this_tree.relpath(path))
502
hash = self.this_tree.get_file_sha1(file_id)
505
modified_hashes[file_id] = hash
506
self.this_tree.set_merge_modified(modified_hashes)
509
def parent(entry, file_id):
510
"""Determine the parent for a file_id (used as a key method)"""
513
return entry.parent_id
516
def name(entry, file_id):
517
"""Determine the name for a file_id (used as a key method)"""
523
def contents_sha1(tree, file_id):
524
"""Determine the sha1 of the file contents (used as a key method)."""
525
if file_id not in tree:
527
return tree.get_file_sha1(file_id)
530
def executable(tree, file_id):
531
"""Determine the executability of a file-id (used as a key method)."""
532
if file_id not in tree:
534
if tree.kind(file_id) != "file":
536
return tree.is_executable(file_id)
539
def kind(tree, file_id):
540
"""Determine the kind of a file-id (used as a key method)."""
541
if file_id not in tree:
543
return tree.kind(file_id)
546
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
547
"""Do a three-way test on a scalar.
548
Return "this", "other" or "conflict", depending whether a value wins.
550
key_base = key(base_tree, file_id)
551
key_other = key(other_tree, file_id)
552
#if base == other, either they all agree, or only THIS has changed.
553
if key_base == key_other:
555
key_this = key(this_tree, file_id)
556
if key_this not in (key_base, key_other):
558
# "Ambiguous clean merge"
559
elif key_this == key_other:
562
assert key_this == key_base
565
def merge_names(self, file_id):
566
"""Perform a merge on file_id names and parents"""
568
if file_id in tree.inventory:
569
return tree.inventory[file_id]
572
this_entry = get_entry(self.this_tree)
573
other_entry = get_entry(self.other_tree)
574
base_entry = get_entry(self.base_tree)
575
name_winner = self.scalar_three_way(this_entry, base_entry,
576
other_entry, file_id, self.name)
577
parent_id_winner = self.scalar_three_way(this_entry, base_entry,
578
other_entry, file_id,
580
if this_entry is None:
581
if name_winner == "this":
582
name_winner = "other"
583
if parent_id_winner == "this":
584
parent_id_winner = "other"
585
if name_winner == "this" and parent_id_winner == "this":
587
if name_winner == "conflict":
588
trans_id = self.tt.trans_id_file_id(file_id)
589
self._raw_conflicts.append(('name conflict', trans_id,
590
self.name(this_entry, file_id),
591
self.name(other_entry, file_id)))
592
if parent_id_winner == "conflict":
593
trans_id = self.tt.trans_id_file_id(file_id)
594
self._raw_conflicts.append(('parent conflict', trans_id,
595
self.parent(this_entry, file_id),
596
self.parent(other_entry, file_id)))
597
if other_entry is None:
598
# it doesn't matter whether the result was 'other' or
599
# 'conflict'-- if there's no 'other', we leave it alone.
601
# if we get here, name_winner and parent_winner are set to safe values.
602
winner_entry = {"this": this_entry, "other": other_entry,
603
"conflict": other_entry}
604
trans_id = self.tt.trans_id_file_id(file_id)
605
parent_id = winner_entry[parent_id_winner].parent_id
606
if parent_id is not None:
607
parent_trans_id = self.tt.trans_id_file_id(parent_id)
608
self.tt.adjust_path(winner_entry[name_winner].name,
609
parent_trans_id, trans_id)
611
def merge_contents(self, file_id):
612
"""Performa a merge on file_id contents."""
613
def contents_pair(tree):
614
if file_id not in tree:
616
kind = tree.kind(file_id)
618
contents = tree.get_file_sha1(file_id)
619
elif kind == "symlink":
620
contents = tree.get_symlink_target(file_id)
623
return kind, contents
625
def contents_conflict():
626
trans_id = self.tt.trans_id_file_id(file_id)
627
name = self.tt.final_name(trans_id)
628
parent_id = self.tt.final_parent(trans_id)
629
if file_id in self.this_tree.inventory:
630
self.tt.unversion_file(trans_id)
631
if file_id in self.this_tree:
632
self.tt.delete_contents(trans_id)
633
file_group = self._dump_conflicts(name, parent_id, file_id,
635
self._raw_conflicts.append(('contents conflict', file_group))
637
# See SPOT run. run, SPOT, run.
638
# So we're not QUITE repeating ourselves; we do tricky things with
640
base_pair = contents_pair(self.base_tree)
641
other_pair = contents_pair(self.other_tree)
642
if base_pair == other_pair:
643
# OTHER introduced no changes
645
this_pair = contents_pair(self.this_tree)
646
if this_pair == other_pair:
647
# THIS and OTHER introduced the same changes
650
trans_id = self.tt.trans_id_file_id(file_id)
651
if this_pair == base_pair:
652
# only OTHER introduced changes
653
if file_id in self.this_tree:
654
# Remove any existing contents
655
self.tt.delete_contents(trans_id)
656
if file_id in self.other_tree:
657
# OTHER changed the file
658
create_by_entry(self.tt,
659
self.other_tree.inventory[file_id],
660
self.other_tree, trans_id)
661
if file_id not in self.this_tree.inventory:
662
self.tt.version_file(file_id, trans_id)
664
elif file_id in self.this_tree.inventory:
665
# OTHER deleted the file
666
self.tt.unversion_file(trans_id)
668
#BOTH THIS and OTHER introduced changes; scalar conflict
669
elif this_pair[0] == "file" and other_pair[0] == "file":
670
# THIS and OTHER are both files, so text merge. Either
671
# BASE is a file, or both converted to files, so at least we
672
# have agreement that output should be a file.
674
self.text_merge(file_id, trans_id)
676
return contents_conflict()
677
if file_id not in self.this_tree.inventory:
678
self.tt.version_file(file_id, trans_id)
680
self.tt.tree_kind(trans_id)
681
self.tt.delete_contents(trans_id)
686
# Scalar conflict, can't text merge. Dump conflicts
687
return contents_conflict()
689
def get_lines(self, tree, file_id):
690
"""Return the lines in a file, or an empty list."""
692
return tree.get_file(file_id).readlines()
696
def text_merge(self, file_id, trans_id):
697
"""Perform a three-way text merge on a file_id"""
698
# it's possible that we got here with base as a different type.
699
# if so, we just want two-way text conflicts.
700
if file_id in self.base_tree and \
701
self.base_tree.kind(file_id) == "file":
702
base_lines = self.get_lines(self.base_tree, file_id)
705
other_lines = self.get_lines(self.other_tree, file_id)
706
this_lines = self.get_lines(self.this_tree, file_id)
707
m3 = Merge3(base_lines, this_lines, other_lines)
708
start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
709
if self.show_base is True:
710
base_marker = '|' * 7
714
def iter_merge3(retval):
715
retval["text_conflicts"] = False
716
for line in m3.merge_lines(name_a = "TREE",
717
name_b = "MERGE-SOURCE",
718
name_base = "BASE-REVISION",
719
start_marker=start_marker,
720
base_marker=base_marker,
721
reprocess=self.reprocess):
722
if line.startswith(start_marker):
723
retval["text_conflicts"] = True
724
yield line.replace(start_marker, '<' * 7)
728
merge3_iterator = iter_merge3(retval)
729
self.tt.create_file(merge3_iterator, trans_id)
730
if retval["text_conflicts"] is True:
731
self._raw_conflicts.append(('text conflict', trans_id))
732
name = self.tt.final_name(trans_id)
733
parent_id = self.tt.final_parent(trans_id)
734
file_group = self._dump_conflicts(name, parent_id, file_id,
735
this_lines, base_lines,
737
file_group.append(trans_id)
739
def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
740
base_lines=None, other_lines=None, set_version=False,
742
"""Emit conflict files.
743
If this_lines, base_lines, or other_lines are omitted, they will be
744
determined automatically. If set_version is true, the .OTHER, .THIS
745
or .BASE (in that order) will be created as versioned files.
747
data = [('OTHER', self.other_tree, other_lines),
748
('THIS', self.this_tree, this_lines)]
750
data.append(('BASE', self.base_tree, base_lines))
753
for suffix, tree, lines in data:
755
trans_id = self._conflict_file(name, parent_id, tree, file_id,
757
file_group.append(trans_id)
758
if set_version and not versioned:
759
self.tt.version_file(file_id, trans_id)
763
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
765
"""Emit a single conflict file."""
766
name = name + '.' + suffix
767
trans_id = self.tt.create_path(name, parent_id)
768
entry = tree.inventory[file_id]
769
create_by_entry(self.tt, entry, tree, trans_id, lines)
772
def merge_executable(self, file_id, file_status):
773
"""Perform a merge on the execute bit."""
774
if file_status == "deleted":
776
trans_id = self.tt.trans_id_file_id(file_id)
778
if self.tt.final_kind(trans_id) != "file":
782
winner = self.scalar_three_way(self.this_tree, self.base_tree,
783
self.other_tree, file_id,
785
if winner == "conflict":
786
# There must be a None in here, if we have a conflict, but we
787
# need executability since file status was not deleted.
788
if self.executable(self.other_tree, file_id) is None:
793
if file_status == "modified":
794
executability = self.this_tree.is_executable(file_id)
795
if executability is not None:
796
trans_id = self.tt.trans_id_file_id(file_id)
797
self.tt.set_executability(executability, trans_id)
799
assert winner == "other"
800
if file_id in self.other_tree:
801
executability = self.other_tree.is_executable(file_id)
802
elif file_id in self.this_tree:
803
executability = self.this_tree.is_executable(file_id)
804
elif file_id in self.base_tree:
805
executability = self.base_tree.is_executable(file_id)
806
if executability is not None:
807
trans_id = self.tt.trans_id_file_id(file_id)
808
self.tt.set_executability(executability, trans_id)
810
def cook_conflicts(self, fs_conflicts):
811
"""Convert all conflicts into a form that doesn't depend on trans_id"""
812
from conflicts import Conflict
814
self.cooked_conflicts.extend(cook_conflicts(fs_conflicts, self.tt))
815
fp = FinalPaths(self.tt)
816
for conflict in self._raw_conflicts:
817
conflict_type = conflict[0]
818
if conflict_type in ('name conflict', 'parent conflict'):
819
trans_id = conflict[1]
820
conflict_args = conflict[2:]
821
if trans_id not in name_conflicts:
822
name_conflicts[trans_id] = {}
823
unique_add(name_conflicts[trans_id], conflict_type,
825
if conflict_type == 'contents conflict':
826
for trans_id in conflict[1]:
827
file_id = self.tt.final_file_id(trans_id)
214
828
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():
830
path = fp.get_path(trans_id)
831
for suffix in ('.BASE', '.THIS', '.OTHER'):
832
if path.endswith(suffix):
833
path = path[:-len(suffix)]
835
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
836
self.cooked_conflicts.append(c)
837
if conflict_type == 'text conflict':
838
trans_id = conflict[1]
839
path = fp.get_path(trans_id)
840
file_id = self.tt.final_file_id(trans_id)
841
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
842
self.cooked_conflicts.append(c)
844
for trans_id, conflicts in name_conflicts.iteritems():
846
this_parent, other_parent = conflicts['parent conflict']
847
assert this_parent != other_parent
849
this_parent = other_parent = \
850
self.tt.final_file_id(self.tt.final_parent(trans_id))
852
this_name, other_name = conflicts['name conflict']
853
assert this_name != other_name
855
this_name = other_name = self.tt.final_name(trans_id)
856
other_path = fp.get_path(trans_id)
857
if this_parent is not None:
859
fp.get_path(self.tt.trans_id_file_id(this_parent))
860
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")
862
this_path = "<deleted>"
863
file_id = self.tt.final_file_id(trans_id)
864
c = Conflict.factory('path conflict', path=this_path,
865
conflict_path=other_path, file_id=file_id)
866
self.cooked_conflicts.append(c)
867
self.cooked_conflicts.sort(key=Conflict.sort_key)
870
class WeaveMerger(Merge3Merger):
871
"""Three-way tree merger, text weave merger."""
872
supports_reprocess = True
873
supports_show_base = False
875
def __init__(self, working_tree, this_tree, base_tree, other_tree,
876
interesting_ids=None, pb=DummyProgress(), pp=None,
877
reprocess=False, change_reporter=None):
878
self.this_revision_tree = self._get_revision_tree(this_tree)
879
self.other_revision_tree = self._get_revision_tree(other_tree)
880
super(WeaveMerger, self).__init__(working_tree, this_tree,
881
base_tree, other_tree,
882
interesting_ids=interesting_ids,
883
pb=pb, pp=pp, reprocess=reprocess,
884
change_reporter=change_reporter)
886
def _get_revision_tree(self, tree):
887
"""Return a revision tree related to this tree.
888
If the tree is a WorkingTree, the basis will be returned.
890
if getattr(tree, 'get_weave', False) is False:
891
# If we have a WorkingTree, try using the basis
892
return tree.branch.basis_tree()
896
def _check_file(self, file_id):
897
"""Check that the revision tree's version of the file matches."""
898
for tree, rt in ((self.this_tree, self.this_revision_tree),
899
(self.other_tree, self.other_revision_tree)):
902
if tree.get_file_sha1(file_id) != rt.get_file_sha1(file_id):
903
raise WorkingTreeNotRevision(self.this_tree)
905
def _merged_lines(self, file_id):
906
"""Generate the merged lines.
907
There is no distinction between lines that are meant to contain <<<<<<<
910
weave = self.this_revision_tree.get_weave(file_id)
911
this_revision_id = self.this_revision_tree.inventory[file_id].revision
912
other_revision_id = \
913
self.other_revision_tree.inventory[file_id].revision
914
wm = WeaveMerge(weave, this_revision_id, other_revision_id,
915
'<<<<<<< TREE\n', '>>>>>>> MERGE-SOURCE\n')
916
return wm.merge_lines(self.reprocess)
918
def text_merge(self, file_id, trans_id):
919
"""Perform a (weave) text merge for a given file and file-id.
920
If conflicts are encountered, .THIS and .OTHER files will be emitted,
921
and a conflict will be noted.
923
self._check_file(file_id)
924
lines, conflicts = self._merged_lines(file_id)
926
# Note we're checking whether the OUTPUT is binary in this case,
927
# because we don't want to get into weave merge guts.
928
check_text_lines(lines)
929
self.tt.create_file(lines, trans_id)
931
self._raw_conflicts.append(('text conflict', trans_id))
932
name = self.tt.final_name(trans_id)
933
parent_id = self.tt.final_parent(trans_id)
934
file_group = self._dump_conflicts(name, parent_id, file_id,
936
file_group.append(trans_id)
939
class Diff3Merger(Merge3Merger):
940
"""Three-way merger using external diff3 for text merging"""
942
def dump_file(self, temp_dir, name, tree, file_id):
943
out_path = pathjoin(temp_dir, name)
944
out_file = open(out_path, "wb")
946
in_file = tree.get_file(file_id)
953
def text_merge(self, file_id, trans_id):
954
"""Perform a diff3 merge using a specified file-id and trans-id.
955
If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
956
will be dumped, and a will be conflict noted.
959
temp_dir = osutils.mkdtemp(prefix="bzr-")
961
new_file = pathjoin(temp_dir, "new")
962
this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
963
base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
964
other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
965
status = bzrlib.patch.diff3(new_file, this, base, other)
966
if status not in (0, 1):
967
raise BzrError("Unhandled diff3 exit code")
968
f = open(new_file, 'rb')
970
self.tt.create_file(f, trans_id)
974
name = self.tt.final_name(trans_id)
975
parent_id = self.tt.final_parent(trans_id)
976
self._dump_conflicts(name, parent_id, file_id)
977
self._raw_conflicts.append(('text conflict', trans_id))
979
osutils.rmtree(temp_dir)
982
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
984
merge_type=Merge3Merger,
985
interesting_ids=None,
989
interesting_files=None,
992
change_reporter=None):
993
"""Primary interface for merging.
995
typical use is probably
996
'merge_inner(branch, branch.get_revision_tree(other_revision),
997
branch.get_revision_tree(base_revision))'
999
if this_tree is None:
1000
warnings.warn("bzrlib.merge.merge_inner requires a this_tree parameter as of "
1001
"bzrlib version 0.8.",
1004
this_tree = this_branch.bzrdir.open_workingtree()
1005
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1006
pb=pb, change_reporter=change_reporter)
1007
merger.backup_files = backup_files
1008
merger.merge_type = merge_type
1009
merger.interesting_ids = interesting_ids
1010
merger.ignore_zero = ignore_zero
1011
if interesting_files:
1012
assert not interesting_ids, ('Only supply interesting_ids'
1013
' or interesting_files')
1014
merger._set_interesting_files(interesting_files)
1015
merger.show_base = show_base
1016
merger.reprocess = reprocess
1017
merger.other_rev_id = other_rev_id
1018
merger.other_basis = other_rev_id
1019
return merger.do_merge()
1021
def get_merge_type_registry():
1022
"""Merge type registry is in bzrlib.option to avoid circular imports.
1024
This method provides a sanctioned way to retrieve it.
1026
from bzrlib import option
1027
return option._merge_type_registry