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
24
import bzrlib.revision
25
from bzrlib.merge_core import merge_flex, ApplyMerge3, BackupBeforeChange
26
from bzrlib.changeset import generate_changeset, ExceptionConflictHandler
27
from bzrlib.changeset import Inventory, Diff3Merge, ReplaceContents
28
from bzrlib.branch import Branch
29
from bzrlib.errors import BzrCommandError, UnrelatedBranches, NoCommonAncestor
30
from bzrlib.errors import NoCommits
31
from bzrlib.delta import compare_trees
32
from bzrlib.trace import mutter, warning, note
33
from bzrlib.fetch import greedy_fetch, fetch
34
from bzrlib.revision import is_ancestor
35
from bzrlib.osutils import rename
36
from bzrlib.revision import common_ancestor, MultipleRevisionSources
37
from bzrlib.errors import NoSuchRevision
39
# TODO: build_working_dir can be built on something simpler than merge()
41
# FIXME: merge() parameters seem oriented towards the command line
42
# NOTABUG: merge is a helper for commandline functions. merge_inner is the
43
# the core functionality.
45
# comments from abentley on irc: merge happens in two stages, each
46
# of which generates a changeset object
48
# stage 1: generate OLD->OTHER,
49
# stage 2: use MINE and OLD->OTHER to generate MINE -> RESULT
51
class MergeConflictHandler(ExceptionConflictHandler):
52
"""Handle conflicts encountered while merging.
54
This subclasses ExceptionConflictHandler, so that any types of
55
conflict that are not explicitly handled cause an exception and
58
def __init__(self, this_tree, base_tree, other_tree, ignore_zero=False):
59
ExceptionConflictHandler.__init__(self)
61
self.ignore_zero = ignore_zero
62
self.this_tree = this_tree
63
self.base_tree = base_tree
64
self.other_tree = other_tree
66
def copy(self, source, dest):
67
"""Copy the text and mode of a file
68
:param source: The path of the file to copy
69
:param dest: The distination file to create
71
s_file = file(source, "rb")
72
d_file = file(dest, "wb")
75
os.chmod(dest, 0777 & os.stat(source).st_mode)
77
def dump(self, lines, dest):
78
"""Copy the text and mode of a file
79
:param source: The path of the file to copy
80
:param dest: The distination file to create
82
d_file = file(dest, "wb")
86
def add_suffix(self, name, suffix, last_new_name=None):
87
"""Rename a file to append a suffix. If the new name exists, the
88
suffix is added repeatedly until a non-existant name is found
90
:param name: The path of the file
91
:param suffix: The suffix to append
92
:param last_new_name: (used for recursive calls) the last name tried
94
if last_new_name is None:
96
new_name = last_new_name+suffix
98
rename(name, new_name)
101
if e.errno != errno.EEXIST and e.errno != errno.ENOTEMPTY:
103
return self.add_suffix(name, suffix, last_new_name=new_name)
105
def conflict(self, text):
110
def merge_conflict(self, new_file, this_path, base_lines, other_lines):
112
Handle diff3 conflicts by producing a .THIS, .BASE and .OTHER. The
113
main file will be a version with diff3 conflicts.
114
:param new_file: Path to the output file with diff3 markers
115
:param this_path: Path to the file text for the THIS tree
116
:param base_path: Path to the file text for the BASE tree
117
:param other_path: Path to the file text for the OTHER tree
119
self.add_suffix(this_path, ".THIS")
120
self.dump(base_lines, this_path+".BASE")
121
self.dump(other_lines, this_path+".OTHER")
122
rename(new_file, this_path)
123
self.conflict("Diff3 conflict encountered in %s" % this_path)
125
def new_contents_conflict(self, filename, other_contents):
126
"""Conflicting contents for newly added file."""
127
other_contents(filename + ".OTHER", self, False)
128
self.conflict("Conflict in newly added file %s" % filename)
131
def target_exists(self, entry, target, old_path):
132
"""Handle the case when the target file or dir exists"""
133
moved_path = self.add_suffix(target, ".moved")
134
self.conflict("Moved existing %s to %s" % (target, moved_path))
136
def rmdir_non_empty(self, filename):
137
"""Handle the case where the dir to be removed still has contents"""
138
self.conflict("Directory %s not removed because it is not empty"\
142
def rem_contents_conflict(self, filename, this_contents, base_contents):
143
base_contents(filename+".BASE", self, False)
144
this_contents(filename+".THIS", self, False)
145
return ReplaceContents(this_contents, None)
147
def rem_contents_conflict(self, filename, this_contents, base_contents):
148
base_contents(filename+".BASE", self, False)
149
this_contents(filename+".THIS", self, False)
150
self.conflict("Other branch deleted locally modified file %s" %
152
return ReplaceContents(this_contents, None)
154
def abs_this_path(self, file_id):
155
"""Return the absolute path for a file_id in the this tree."""
156
return self.this_tree.id2abspath(file_id)
158
def add_missing_parents(self, file_id, tree):
159
"""If some of the parents for file_id are missing, add them."""
160
entry = tree.inventory[file_id]
161
if entry.parent_id not in self.this_tree:
162
return self.create_all_missing(entry.parent_id, tree)
164
return self.abs_this_path(entry.parent_id)
166
def create_all_missing(self, file_id, tree):
167
"""Add contents for a file_id and all its parents to a tree."""
168
entry = tree.inventory[file_id]
169
if entry.parent_id is not None and entry.parent_id not in self.this_tree:
170
abspath = self.create_all_missing(entry.parent_id, tree)
172
abspath = self.abs_this_path(entry.parent_id)
173
entry_path = os.path.join(abspath, entry.name)
174
if not os.path.isdir(entry_path):
175
self.create(file_id, entry_path, tree)
178
def create(self, file_id, path, tree, reverse=False):
179
"""Uses tree data to create a filesystem object for the file_id"""
180
from changeset import get_contents
181
get_contents(tree, file_id)(path, self, reverse)
183
def missing_for_merge(self, file_id, other_path):
184
"""The file_id doesn't exist in THIS, but does in OTHER and BASE"""
185
self.conflict("Other branch modified locally deleted file %s" %
187
parent_dir = self.add_missing_parents(file_id, self.other_tree)
188
stem = os.path.join(parent_dir, os.path.basename(other_path))
189
self.create(file_id, stem+".OTHER", self.other_tree)
190
self.create(file_id, stem+".BASE", self.base_tree)
192
def threeway_contents_conflict(filename, this_contents, base_contents,
194
self.conflict("Three-way conflict merging %s" % filename)
197
if not self.ignore_zero:
198
note("%d conflicts encountered.\n" % self.conflicts)
200
def get_tree(treespec, local_branch=None):
201
location, revno = treespec
202
branch = Branch.open_containing(location)[0]
206
revision = branch.last_revision()
208
revision = branch.get_rev_id(revno)
209
return branch, get_revid_tree(branch, revision, local_branch)
211
def get_revid_tree(branch, revision, local_branch):
213
base_tree = branch.working_tree()
215
if local_branch is not None:
216
greedy_fetch(local_branch, branch, revision)
217
base_tree = local_branch.revision_tree(revision)
219
base_tree = branch.revision_tree(revision)
223
def file_exists(tree, file_id):
224
return tree.has_filename(tree.id2path(file_id))
227
def build_working_dir(to_dir):
228
"""Build a working directory in an empty directory.
230
to_dir is a directory containing branch metadata but no working files,
231
typically constructed by cloning an existing branch.
233
This is split out as a special idiomatic case of merge. It could
234
eventually be done by just building the tree directly calling into
235
lower-level code (e.g. constructing a changeset).
237
# RBC 20051019 is this not just 'export' ?
238
# Well, export doesn't take care of inventory...
239
this_branch = Branch.open_containing(to_dir)[0]
240
transform_tree(this_branch.working_tree(), this_branch.basis_tree())
242
def transform_tree(from_tree, to_tree):
243
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True)
245
def merge(other_revision, base_revision,
246
check_clean=True, ignore_zero=False,
247
this_dir=None, backup_files=False, merge_type=ApplyMerge3,
248
file_list=None, show_base=False):
249
"""Merge changes into a tree.
252
tuple(path, revision) Base for three-way merge.
254
tuple(path, revision) Other revision for three-way merge.
256
Directory to merge changes into; '.' by default.
258
If true, this_dir must have no uncommitted changes before the
260
ignore_zero - If true, suppress the "zero conflicts" message when
261
there are no conflicts; should be set when doing something we expect
262
to complete perfectly.
264
All available ancestors of other_revision and base_revision are
265
automatically pulled into the branch.
269
this_branch = Branch.open_containing(this_dir)[0]
271
merger = Merger(this_branch)
272
merger.check_basis(check_clean)
273
merger.set_other(other_revision)
274
merger.set_base(base_revision)
275
merger.backup_files = backup_files
276
merger.merge_type = ApplyMerge3
277
merger.set_interesting_files(file_list)
278
merger.show_base = show_base
279
merger.conflict_handler = MergeConflictHandler(merger.this_tree,
282
ignore_zero=ignore_zero)
283
conflicts = merger.do_merge()
287
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
288
backup_files=False, merge_type=ApplyMerge3,
289
interesting_ids=None, show_base=False):
290
"""Primary interface for merging.
292
typical use is probably
293
'merge_inner(branch, branch.get_revision_tree(other_revision),
294
branch.get_revision_tree(base_revision))'
296
merger = Merger(this_branch, other_tree, base_tree)
297
merger.backup_files = False
298
merger.merge_type = ApplyMerge3
299
merger.interesting_ids = interesting_ids
300
merger.show_base = show_base
301
merger.conflict_handler = MergeConflictHandler(merger.this_tree, base_tree,
303
ignore_zero=ignore_zero)
304
return merger.do_merge()
307
class Merger(object):
308
def __init__(self, this_branch, other_tree=None, base_tree=None):
309
object.__init__(self)
310
self.this_branch = this_branch
311
self.this_basis = this_branch.last_revision()
312
self.this_rev_id = None
313
self.this_tree = this_branch.working_tree()
314
self.other_tree = other_tree
315
self.base_tree = base_tree
316
self.ignore_zero = False
317
self.backup_files = False
318
self.interesting_ids = None
319
self.show_base = False
320
self.conflict_handler = MergeConflictHandler(self.this_tree, base_tree,
323
def merge_factory(self, file_id, base, other):
324
if self.show_base is True:
325
contents_change = self.merge_type(file_id, base, other,
328
contents_change = self.merge_type(file_id, base, other)
329
if self.backup_files:
330
contents_change = BackupBeforeChange(contents_change)
331
return contents_change
333
def check_basis(self, check_clean):
334
if self.this_basis is None:
335
raise BzrCommandError("This branch has no commits")
338
if self.this_basis != self.this_rev_id:
339
raise BzrCommandError("Working tree has uncommitted changes.")
341
def compare_basis(self):
342
changes = compare_trees(self.this_branch.working_tree(),
343
self.this_branch.basis_tree(), False)
344
if not changes.has_changed():
345
self.this_rev_id = self.this_basis
347
def set_interesting_files(self, file_list):
348
if file_list is None:
349
self.interesting_ids = None
352
interesting_ids = set()
353
for fname in file_list:
354
path = self.this_tree.relpath(fname)
356
for tree in (self.this_tree, self.base_tree, self.other_tree):
357
file_id = tree.inventory.path2id(path)
358
if file_id is not None:
359
interesting_ids.add(file_id)
362
raise BzrCommandError("%s is not a source file in any"
364
self.interesting_ids = interesting_ids
366
def set_pending(self):
367
if not self.base_is_ancestor:
369
if self.other_rev_id is None:
371
if self.other_rev_id in self.this_branch.get_ancestry(self.this_basis):
373
self.this_branch.add_pending_merge(self.other_rev_id)
375
def set_other(self, other_revision):
376
other_branch, self.other_tree = get_tree(other_revision,
378
if other_revision[1] == -1:
379
self.other_rev_id = other_branch.last_revision()
380
if self.other_rev_id is None:
381
raise NoCommits(other_branch)
382
self.other_basis = self.other_rev_id
383
elif other_revision[1] is not None:
384
self.other_rev_id = other_branch.get_rev_id(other_revision[1])
385
self.other_basis = self.other_rev_id
387
self.other_rev_id = None
388
self.other_basis = other_branch.last_revision()
389
if self.other_basis is None:
390
raise NoCommits(other_branch)
392
def set_base(self, base_revision):
393
if base_revision == [None, None]:
395
self.base_rev_id = common_ancestor(self.this_basis,
398
except NoCommonAncestor:
399
raise UnrelatedBranches()
400
self.base_tree = get_revid_tree(self.this_branch, self.base_rev_id,
402
self.base_is_ancestor = True
404
base_branch, self.base_tree = get_tree(base_revision)
405
if base_revision[1] == -1:
406
self.base_rev_id = base_branch.last_revision()
407
elif base_revision[1] is None:
408
self.base_rev_id = None
410
self.base_rev_id = base_branch.get_rev_id(base_revision[1])
411
fetch(from_branch=base_branch, to_branch=self.this_branch)
412
self.base_is_ancestor = is_ancestor(self.this_basis,
417
def get_inventory(tree):
418
return tree.inventory
420
inv_changes = merge_flex(self.this_tree, self.base_tree,
422
generate_changeset, get_inventory,
423
self.conflict_handler,
424
merge_factory=self.merge_factory,
425
interesting_ids=self.interesting_ids)
428
for id, path in inv_changes.iteritems():
433
assert path.startswith('.' + os.sep), "path is %s" % path
435
adjust_ids.append((path, id))
436
if len(adjust_ids) > 0:
437
self.this_branch.set_inventory(self.regen_inventory(adjust_ids))
438
conflicts = self.conflict_handler.conflicts
439
self.conflict_handler.finalize()
442
def regen_inventory(self, new_entries):
443
old_entries = self.this_branch.read_working_inventory()
447
for path, file_id in new_entries:
450
new_entries_map[file_id] = path
452
def id2path(file_id):
453
path = new_entries_map.get(file_id)
456
entry = old_entries[file_id]
457
if entry.parent_id is None:
459
return os.path.join(id2path(entry.parent_id), entry.name)
461
for file_id in old_entries:
462
entry = old_entries[file_id]
463
path = id2path(file_id)
464
new_inventory[file_id] = (path, file_id, entry.parent_id,
466
by_path[path] = file_id
471
for path, file_id in new_entries:
473
del new_inventory[file_id]
476
new_path_list.append((path, file_id))
477
if file_id not in old_entries:
479
# Ensure no file is added before its parent
481
for path, file_id in new_path_list:
485
parent = by_path[os.path.dirname(path)]
486
abspath = os.path.join(self.this_tree.basedir, path)
487
kind = bzrlib.osutils.file_kind(abspath)
488
new_inventory[file_id] = (path, file_id, parent, kind)
489
by_path[path] = file_id
491
# Get a list in insertion order
492
new_inventory_list = new_inventory.values()
493
mutter ("""Inventory regeneration:
494
old length: %i insertions: %i deletions: %i new_length: %i"""\
495
% (len(old_entries), insertions, deletions,
496
len(new_inventory_list)))
497
assert len(new_inventory_list) == len(old_entries) + insertions\
499
new_inventory_list.sort()
500
return new_inventory_list
502
merge_types = { "merge3": (ApplyMerge3, "Native diff3-style merge"),
503
"diff3": (Diff3Merge, "Merge using external diff3")
added
removed
bzrlib/merge.py
