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: Report back as changes are merged in
41
# TODO: build_working_dir can be built on something simpler than merge()
43
# FIXME: merge() parameters seem oriented towards the command line
44
# NOTABUG: merge is a helper for commandline functions. merge_inner is the
45
# the core functionality.
47
# comments from abentley on irc: merge happens in two stages, each
48
# of which generates a changeset object
50
# stage 1: generate OLD->OTHER,
51
# stage 2: use MINE and OLD->OTHER to generate MINE -> RESULT
53
class MergeConflictHandler(ExceptionConflictHandler):
54
"""Handle conflicts encountered while merging.
56
This subclasses ExceptionConflictHandler, so that any types of
57
conflict that are not explicitly handled cause an exception and
60
def __init__(self, this_tree, base_tree, other_tree, ignore_zero=False):
61
ExceptionConflictHandler.__init__(self)
63
self.ignore_zero = ignore_zero
64
self.this_tree = this_tree
65
self.base_tree = base_tree
66
self.other_tree = other_tree
68
def copy(self, source, dest):
69
"""Copy the text and mode of a file
70
:param source: The path of the file to copy
71
:param dest: The distination file to create
73
s_file = file(source, "rb")
74
d_file = file(dest, "wb")
77
os.chmod(dest, 0777 & os.stat(source).st_mode)
79
def dump(self, lines, dest):
80
"""Copy the text and mode of a file
81
:param source: The path of the file to copy
82
:param dest: The distination file to create
84
d_file = file(dest, "wb")
88
def add_suffix(self, name, suffix, last_new_name=None):
89
"""Rename a file to append a suffix. If the new name exists, the
90
suffix is added repeatedly until a non-existant name is found
92
:param name: The path of the file
93
:param suffix: The suffix to append
94
:param last_new_name: (used for recursive calls) the last name tried
96
if last_new_name is None:
98
new_name = last_new_name+suffix
100
rename(name, new_name)
103
if e.errno != errno.EEXIST and e.errno != errno.ENOTEMPTY:
105
return self.add_suffix(name, suffix, last_new_name=new_name)
107
def conflict(self, text):
112
def merge_conflict(self, new_file, this_path, base_lines, other_lines):
114
Handle diff3 conflicts by producing a .THIS, .BASE and .OTHER. The
115
main file will be a version with diff3 conflicts.
116
:param new_file: Path to the output file with diff3 markers
117
:param this_path: Path to the file text for the THIS tree
118
:param base_path: Path to the file text for the BASE tree
119
:param other_path: Path to the file text for the OTHER tree
121
self.add_suffix(this_path, ".THIS")
122
self.dump(base_lines, this_path+".BASE")
123
self.dump(other_lines, this_path+".OTHER")
124
rename(new_file, this_path)
125
self.conflict("Diff3 conflict encountered in %s" % this_path)
127
def new_contents_conflict(self, filename, other_contents):
128
"""Conflicting contents for newly added file."""
129
other_contents(filename + ".OTHER", self, False)
130
self.conflict("Conflict in newly added file %s" % filename)
133
def target_exists(self, entry, target, old_path):
134
"""Handle the case when the target file or dir exists"""
135
moved_path = self.add_suffix(target, ".moved")
136
self.conflict("Moved existing %s to %s" % (target, moved_path))
138
def rmdir_non_empty(self, filename):
139
"""Handle the case where the dir to be removed still has contents"""
140
self.conflict("Directory %s not removed because it is not empty"\
144
def rem_contents_conflict(self, filename, this_contents, base_contents):
145
base_contents(filename+".BASE", self, False)
146
this_contents(filename+".THIS", self, False)
147
return ReplaceContents(this_contents, None)
149
def rem_contents_conflict(self, filename, this_contents, base_contents):
150
base_contents(filename+".BASE", self, False)
151
this_contents(filename+".THIS", self, False)
152
self.conflict("Other branch deleted locally modified file %s" %
154
return ReplaceContents(this_contents, None)
156
def abs_this_path(self, file_id):
157
"""Return the absolute path for a file_id in the this tree."""
158
return self.this_tree.id2abspath(file_id)
160
def add_missing_parents(self, file_id, tree):
161
"""If some of the parents for file_id are missing, add them."""
162
entry = tree.inventory[file_id]
163
if entry.parent_id not in self.this_tree:
164
return self.create_all_missing(entry.parent_id, tree)
166
return self.abs_this_path(entry.parent_id)
168
def create_all_missing(self, file_id, tree):
169
"""Add contents for a file_id and all its parents to a tree."""
170
entry = tree.inventory[file_id]
171
if entry.parent_id is not None and entry.parent_id not in self.this_tree:
172
abspath = self.create_all_missing(entry.parent_id, tree)
174
abspath = self.abs_this_path(entry.parent_id)
175
entry_path = os.path.join(abspath, entry.name)
176
if not os.path.isdir(entry_path):
177
self.create(file_id, entry_path, tree)
180
def create(self, file_id, path, tree, reverse=False):
181
"""Uses tree data to create a filesystem object for the file_id"""
182
from changeset import get_contents
183
get_contents(tree, file_id)(path, self, reverse)
185
def missing_for_merge(self, file_id, other_path):
186
"""The file_id doesn't exist in THIS, but does in OTHER and BASE"""
187
self.conflict("Other branch modified locally deleted file %s" %
189
parent_dir = self.add_missing_parents(file_id, self.other_tree)
190
stem = os.path.join(parent_dir, os.path.basename(other_path))
191
self.create(file_id, stem+".OTHER", self.other_tree)
192
self.create(file_id, stem+".BASE", self.base_tree)
194
def threeway_contents_conflict(filename, this_contents, base_contents,
196
self.conflict("Three-way conflict merging %s" % filename)
199
if not self.ignore_zero:
200
note("%d conflicts encountered.\n" % self.conflicts)
202
def get_tree(treespec, local_branch=None):
203
location, revno = treespec
204
branch = Branch.open_containing(location)[0]
208
revision = branch.last_revision()
210
revision = branch.get_rev_id(revno)
211
return branch, get_revid_tree(branch, revision, local_branch)
213
def get_revid_tree(branch, revision, local_branch):
215
base_tree = branch.working_tree()
217
if local_branch is not None:
218
greedy_fetch(local_branch, branch, revision)
219
base_tree = local_branch.revision_tree(revision)
221
base_tree = branch.revision_tree(revision)
225
def file_exists(tree, file_id):
226
return tree.has_filename(tree.id2path(file_id))
229
def build_working_dir(to_dir):
230
"""Build a working directory in an empty directory.
232
to_dir is a directory containing branch metadata but no working files,
233
typically constructed by cloning an existing branch.
235
This is split out as a special idiomatic case of merge. It could
236
eventually be done by just building the tree directly calling into
237
lower-level code (e.g. constructing a changeset).
239
# RBC 20051019 is this not just 'export' ?
240
merge((to_dir, -1), (to_dir, 0), this_dir=to_dir,
241
check_clean=False, ignore_zero=True)
244
def merge(other_revision, base_revision,
245
check_clean=True, ignore_zero=False,
246
this_dir=None, backup_files=False, merge_type=ApplyMerge3,
247
file_list=None, show_base=False):
248
"""Merge changes into a tree.
251
tuple(path, revno) Base for three-way merge.
252
If (None, None) then a base will be automatically determined.
254
tuple(path, revno) 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.
263
file_list - If true, merge only changes to selected files.
265
All available ancestors of other_revision and base_revision are
266
automatically pulled into the branch.
268
The revno may be -1 to indicate the last revision on the branch, which is the
271
This function is intended for use from the command line; programmatic clients
272
might prefer to call merge_inner(), which has less magic behavior.
274
# TODO: please check this docstring is true and accurate - mbp 20051024
277
this_branch = Branch.open_containing(this_dir)[0]
278
this_rev_id = this_branch.last_revision()
279
if this_rev_id is None:
280
raise BzrCommandError("This branch has no commits")
282
changes = compare_trees(this_branch.working_tree(),
283
this_branch.basis_tree(), False)
284
if changes.has_changed():
285
raise BzrCommandError("Working tree has uncommitted changes.")
286
other_branch, other_tree = get_tree(other_revision, this_branch)
287
if other_revision[1] == -1:
288
other_rev_id = other_branch.last_revision()
289
if other_rev_id is None:
290
raise NoCommits(other_branch)
291
other_basis = other_rev_id
292
elif other_revision[1] is not None:
293
other_rev_id = other_branch.get_rev_id(other_revision[1])
294
other_basis = other_rev_id
297
other_basis = other_branch.last_revision()
298
if other_basis is None:
299
raise NoCommits(other_branch)
300
fetch(from_branch=other_branch, to_branch=this_branch)
301
if base_revision == [None, None]:
302
mutter("doing merge() with no base_revision specified")
304
base_rev_id = common_ancestor(this_rev_id, other_basis,
306
except NoCommonAncestor:
307
raise UnrelatedBranches()
308
# fetch() is probably unnecessary in this case, because
309
# get_revid_tree() does it anyway if base_rev_id is not None and the
310
# local_branch is None -- but we do it above just to be sure -- mbp 20051024
311
base_tree = get_revid_tree(this_branch, base_rev_id, None)
312
base_is_ancestor = True
314
mutter('doing merge() with base %r' % (base_revision,))
315
base_branch, base_tree = get_tree(base_revision)
316
if base_revision[1] == -1:
317
base_rev_id = base_branch.last_revision()
318
elif base_revision[1] is None:
321
base_rev_id = base_branch.get_rev_id(base_revision[1])
322
fetch(from_branch=base_branch, to_branch=this_branch)
323
base_is_ancestor = is_ancestor(this_rev_id, base_rev_id,
325
if file_list is None:
326
interesting_ids = None
328
interesting_ids = set()
329
this_tree = this_branch.working_tree()
330
for fname in file_list:
331
path = this_tree.relpath(fname)
333
for tree in (this_tree, base_tree, other_tree):
334
file_id = tree.inventory.path2id(path)
335
if file_id is not None:
336
interesting_ids.add(file_id)
339
raise BzrCommandError("%s is not a source file in any"
341
conflicts = merge_inner(this_branch, other_tree, base_tree, tempdir=None,
342
ignore_zero=ignore_zero,
343
backup_files=backup_files,
344
merge_type=merge_type,
345
interesting_ids=interesting_ids,
347
if base_is_ancestor and other_rev_id is not None\
348
and other_rev_id not in this_branch.revision_history():
349
this_branch.add_pending_merge(other_rev_id)
353
def set_interesting(inventory_a, inventory_b, interesting_ids):
354
"""Mark files whose ids are in interesting_ids as interesting
356
for inventory in (inventory_a, inventory_b):
357
for path, source_file in inventory.iteritems():
358
source_file.interesting = source_file.id in interesting_ids
361
def merge_inner(this_branch, other_tree, base_tree, tempdir=None,
362
ignore_zero=False, merge_type=ApplyMerge3, backup_files=False,
363
interesting_ids=None, show_base=False):
364
"""Primary interface for merging.
366
typical use is probably
367
'merge_inner(branch, branch.get_revision_tree(other_revision),
368
branch.get_revision_tree(base_revision))'
371
_tempdir = tempfile.mkdtemp(prefix="bzr-")
375
return _merge_inner(this_branch, other_tree, base_tree, _tempdir,
376
ignore_zero, merge_type, backup_files,
381
shutil.rmtree(_tempdir)
384
def _merge_inner(this_branch, other_tree, base_tree, user_tempdir,
385
ignore_zero=False, merge_type=ApplyMerge3, backup_files=False,
386
interesting_ids=None, show_base=False):
387
def merge_factory(file_id, base, other):
388
if show_base is True:
389
contents_change = merge_type(file_id, base, other, show_base=True)
391
contents_change = merge_type(file_id, base, other)
393
contents_change = BackupBeforeChange(contents_change)
394
return contents_change
396
this_tree = get_tree((this_branch.base, None))[1]
398
def get_inventory(tree):
399
return tree.inventory
401
conflict_handler = MergeConflictHandler(this_tree, base_tree, other_tree,
402
ignore_zero=ignore_zero)
403
inv_changes = merge_flex(this_tree, base_tree, other_tree,
404
generate_changeset, get_inventory,
406
merge_factory=merge_factory,
407
interesting_ids=interesting_ids)
410
for id, path in inv_changes.iteritems():
415
assert path.startswith('.' + os.sep), "path is %s" % path
417
adjust_ids.append((path, id))
418
if len(adjust_ids) > 0:
419
this_branch.set_inventory(regen_inventory(this_branch,
422
conflicts = conflict_handler.conflicts
423
conflict_handler.finalize()
427
def regen_inventory(this_branch, root, new_entries):
428
old_entries = this_branch.read_working_inventory()
432
for path, file_id in new_entries:
435
new_entries_map[file_id] = path
437
def id2path(file_id):
438
path = new_entries_map.get(file_id)
441
entry = old_entries[file_id]
442
if entry.parent_id is None:
444
return os.path.join(id2path(entry.parent_id), entry.name)
446
for file_id in old_entries:
447
entry = old_entries[file_id]
448
path = id2path(file_id)
449
new_inventory[file_id] = (path, file_id, entry.parent_id, entry.kind)
450
by_path[path] = file_id
455
for path, file_id in new_entries:
457
del new_inventory[file_id]
460
new_path_list.append((path, file_id))
461
if file_id not in old_entries:
463
# Ensure no file is added before its parent
465
for path, file_id in new_path_list:
469
parent = by_path[os.path.dirname(path)]
470
kind = bzrlib.osutils.file_kind(os.path.join(root, path))
471
new_inventory[file_id] = (path, file_id, parent, kind)
472
by_path[path] = file_id
474
# Get a list in insertion order
475
new_inventory_list = new_inventory.values()
476
mutter ("""Inventory regeneration:
477
old length: %i insertions: %i deletions: %i new_length: %i"""\
478
% (len(old_entries), insertions, deletions, len(new_inventory_list)))
479
assert len(new_inventory_list) == len(old_entries) + insertions - deletions
480
new_inventory_list.sort()
481
return new_inventory_list
483
merge_types = { "merge3": (ApplyMerge3, "Native diff3-style merge"),
484
"diff3": (Diff3Merge, "Merge using external diff3")
added
removed
bzrlib/merge.py
