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
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
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
43
# comments from abentley on irc: merge happens in two stages, each
44
# of which generates a changeset object
46
# stage 1: generate OLD->OTHER,
47
# stage 2: use MINE and OLD->OTHER to generate MINE -> RESULT
49
class MergeConflictHandler(ExceptionConflictHandler):
50
"""Handle conflicts encountered while merging.
52
This subclasses ExceptionConflictHandler, so that any types of
53
conflict that are not explicitly handled cause an exception and
56
def __init__(self, ignore_zero=False):
57
ExceptionConflictHandler.__init__(self)
59
self.ignore_zero = ignore_zero
61
def copy(self, source, dest):
62
"""Copy the text and mode of a file
63
:param source: The path of the file to copy
64
:param dest: The distination file to create
66
s_file = file(source, "rb")
67
d_file = file(dest, "wb")
70
os.chmod(dest, 0777 & os.stat(source).st_mode)
72
def dump(self, lines, dest):
73
"""Copy the text and mode of a file
74
:param source: The path of the file to copy
75
:param dest: The distination file to create
77
d_file = file(dest, "wb")
81
def add_suffix(self, name, suffix, last_new_name=None):
82
"""Rename a file to append a suffix. If the new name exists, the
83
suffix is added repeatedly until a non-existant name is found
85
:param name: The path of the file
86
:param suffix: The suffix to append
87
:param last_new_name: (used for recursive calls) the last name tried
89
if last_new_name is None:
91
new_name = last_new_name+suffix
93
rename(name, new_name)
96
if e.errno != errno.EEXIST and e.errno != errno.ENOTEMPTY:
98
return self.add_suffix(name, suffix, last_new_name=new_name)
100
def conflict(self, text):
105
def merge_conflict(self, new_file, this_path, base_lines, other_lines):
107
Handle diff3 conflicts by producing a .THIS, .BASE and .OTHER. The
108
main file will be a version with diff3 conflicts.
109
:param new_file: Path to the output file with diff3 markers
110
:param this_path: Path to the file text for the THIS tree
111
:param base_path: Path to the file text for the BASE tree
112
:param other_path: Path to the file text for the OTHER tree
114
self.add_suffix(this_path, ".THIS")
115
self.dump(base_lines, this_path+".BASE")
116
self.dump(other_lines, this_path+".OTHER")
117
rename(new_file, this_path)
118
self.conflict("Diff3 conflict encountered in %s" % this_path)
120
def new_contents_conflict(self, filename, other_contents):
121
"""Conflicting contents for newly added file."""
122
self.copy(other_contents, filename + ".OTHER")
123
self.conflict("Conflict in newly added file %s" % filename)
126
def target_exists(self, entry, target, old_path):
127
"""Handle the case when the target file or dir exists"""
128
moved_path = self.add_suffix(target, ".moved")
129
self.conflict("Moved existing %s to %s" % (target, moved_path))
131
def rmdir_non_empty(self, filename):
132
"""Handle the case where the dir to be removed still has contents"""
133
self.conflict("Directory %s not removed because it is not empty"\
138
if not self.ignore_zero:
139
print "%d conflicts encountered.\n" % self.conflicts
141
def get_tree(treespec, temp_root, label, local_branch=None):
142
location, revno = treespec
143
branch = Branch.open_containing(location)
147
revision = branch.last_revision()
149
revision = branch.get_rev_id(revno)
150
return branch, get_revid_tree(branch, revision, temp_root, label,
153
def get_revid_tree(branch, revision, temp_root, label, local_branch):
155
base_tree = branch.working_tree()
157
if local_branch is not None:
158
greedy_fetch(local_branch, branch, revision)
159
base_tree = local_branch.revision_tree(revision)
161
base_tree = branch.revision_tree(revision)
162
temp_path = os.path.join(temp_root, label)
164
return MergeTree(base_tree, temp_path)
167
def file_exists(tree, file_id):
168
return tree.has_filename(tree.id2path(file_id))
171
class MergeTree(object):
172
def __init__(self, tree, tempdir):
173
object.__init__(self)
174
if hasattr(tree, "basedir"):
175
self.root = tree.basedir
179
self.tempdir = tempdir
180
os.mkdir(os.path.join(self.tempdir, "texts"))
184
return self.tree.__iter__()
186
def __contains__(self, file_id):
187
return file_id in self.tree
189
def get_file(self, file_id):
190
return self.tree.get_file(file_id)
192
def get_file_sha1(self, id):
193
return self.tree.get_file_sha1(id)
195
def id2path(self, file_id):
196
return self.tree.id2path(file_id)
198
def has_id(self, file_id):
199
return self.tree.has_id(file_id)
201
def has_or_had_id(self, file_id):
202
if file_id == self.tree.inventory.root.file_id:
204
return self.tree.inventory.has_id(file_id)
206
def has_or_had_id(self, file_id):
207
if file_id == self.tree.inventory.root.file_id:
209
return self.tree.inventory.has_id(file_id)
211
def readonly_path(self, id):
212
if id not in self.tree:
214
if self.root is not None:
215
return self.tree.abspath(self.tree.id2path(id))
217
if self.tree.inventory[id].kind in ("directory", "root_directory"):
219
if not self.cached.has_key(id):
220
path = os.path.join(self.tempdir, "texts", id)
221
outfile = file(path, "wb")
222
outfile.write(self.tree.get_file(id).read())
223
assert(os.path.exists(path))
224
self.cached[id] = path
225
return self.cached[id]
228
def build_working_dir(to_dir):
229
"""Build a working directory in an empty directory.
231
to_dir is a directory containing branch metadata but no working files,
232
typically constructed by cloning an existing branch.
234
This is split out as a special idiomatic case of merge. It could
235
eventually be done by just building the tree directly calling into
236
lower-level code (e.g. constructing a changeset).
238
merge((to_dir, -1), (to_dir, 0), this_dir=to_dir,
239
check_clean=False, ignore_zero=True)
242
def merge(other_revision, base_revision,
243
check_clean=True, ignore_zero=False,
244
this_dir=None, backup_files=False, merge_type=ApplyMerge3,
246
"""Merge changes into a tree.
249
tuple(path, revision) Base for three-way merge.
251
tuple(path, revision) Other revision for three-way merge.
253
Directory to merge changes into; '.' by default.
255
If true, this_dir must have no uncommitted changes before the
257
ignore_zero - If true, suppress the "zero conflicts" message when
258
there are no conflicts; should be set when doing something we expect
259
to complete perfectly.
261
All available ancestors of other_revision and base_revision are
262
automatically pulled into the branch.
264
tempdir = tempfile.mkdtemp(prefix="bzr-")
268
this_branch = Branch.open_containing(this_dir)
269
this_rev_id = this_branch.last_revision()
270
if this_rev_id is None:
271
raise BzrCommandError("This branch has no commits")
273
changes = compare_trees(this_branch.working_tree(),
274
this_branch.basis_tree(), False)
275
if changes.has_changed():
276
raise BzrCommandError("Working tree has uncommitted changes.")
277
other_branch, other_tree = get_tree(other_revision, tempdir, "other",
279
if other_revision[1] == -1:
280
other_rev_id = other_branch.last_revision()
281
if other_rev_id is None:
282
raise NoCommits(other_branch)
283
other_basis = other_rev_id
284
elif other_revision[1] is not None:
285
other_rev_id = other_branch.get_rev_id(other_revision[1])
286
other_basis = other_rev_id
289
other_basis = other_branch.last_revision()
290
if other_basis is None:
291
raise NoCommits(other_branch)
292
if base_revision == [None, None]:
294
base_rev_id = common_ancestor(this_rev_id, other_basis,
296
except NoCommonAncestor:
297
raise UnrelatedBranches()
298
base_tree = get_revid_tree(this_branch, base_rev_id, tempdir,
300
base_is_ancestor = True
302
base_branch, base_tree = get_tree(base_revision, tempdir, "base")
303
if base_revision[1] == -1:
304
base_rev_id = base_branch.last_revision()
305
elif base_revision[1] is None:
308
base_rev_id = base_branch.get_rev_id(base_revision[1])
309
fetch(from_branch=base_branch, to_branch=this_branch)
310
base_is_ancestor = is_ancestor(this_rev_id, base_rev_id,
312
if file_list is None:
313
interesting_ids = None
315
interesting_ids = set()
316
this_tree = this_branch.working_tree()
317
for fname in file_list:
318
path = this_branch.relpath(fname)
320
for tree in (this_tree, base_tree.tree, other_tree.tree):
321
file_id = tree.inventory.path2id(path)
322
if file_id is not None:
323
interesting_ids.add(file_id)
326
raise BzrCommandError("%s is not a source file in any"
328
merge_inner(this_branch, other_tree, base_tree, tempdir,
329
ignore_zero=ignore_zero, backup_files=backup_files,
330
merge_type=merge_type, interesting_ids=interesting_ids)
331
if base_is_ancestor and other_rev_id is not None\
332
and other_rev_id not in this_branch.revision_history():
333
this_branch.add_pending_merge(other_rev_id)
335
shutil.rmtree(tempdir)
338
def set_interesting(inventory_a, inventory_b, interesting_ids):
339
"""Mark files whose ids are in interesting_ids as interesting
341
for inventory in (inventory_a, inventory_b):
342
for path, source_file in inventory.iteritems():
343
source_file.interesting = source_file.id in interesting_ids
346
def generate_cset_optimized(tree_a, tree_b, interesting_ids=None):
347
"""Generate a changeset. If interesting_ids is supplied, only changes
348
to those files will be shown. Metadata changes are stripped.
350
cset = generate_changeset(tree_a, tree_b, interesting_ids)
351
for entry in cset.entries.itervalues():
352
entry.metadata_change = None
356
def merge_inner(this_branch, other_tree, base_tree, tempdir,
357
ignore_zero=False, merge_type=ApplyMerge3, backup_files=False,
358
interesting_ids=None):
360
def merge_factory(file_id, base, other):
361
contents_change = merge_type(file_id, base, other)
363
contents_change = BackupBeforeChange(contents_change)
364
return contents_change
366
this_tree = get_tree((this_branch.base, None), tempdir, "this")[1]
368
def get_inventory(tree):
369
return tree.tree.inventory
371
inv_changes = merge_flex(this_tree, base_tree, other_tree,
372
generate_cset_optimized, get_inventory,
373
MergeConflictHandler(ignore_zero=ignore_zero),
374
merge_factory=merge_factory,
375
interesting_ids=interesting_ids)
378
for id, path in inv_changes.iteritems():
383
assert path.startswith('.' + os.sep), "path is %s" % path
385
adjust_ids.append((path, id))
386
if len(adjust_ids) > 0:
387
this_branch.set_inventory(regen_inventory(this_branch, this_tree.root,
391
def regen_inventory(this_branch, root, new_entries):
392
old_entries = this_branch.read_working_inventory()
396
for path, file_id in new_entries:
399
new_entries_map[file_id] = path
401
def id2path(file_id):
402
path = new_entries_map.get(file_id)
405
entry = old_entries[file_id]
406
if entry.parent_id is None:
408
return os.path.join(id2path(entry.parent_id), entry.name)
410
for file_id in old_entries:
411
entry = old_entries[file_id]
412
path = id2path(file_id)
413
new_inventory[file_id] = (path, file_id, entry.parent_id, entry.kind)
414
by_path[path] = file_id
419
for path, file_id in new_entries:
421
del new_inventory[file_id]
424
new_path_list.append((path, file_id))
425
if file_id not in old_entries:
427
# Ensure no file is added before its parent
429
for path, file_id in new_path_list:
433
parent = by_path[os.path.dirname(path)]
434
kind = bzrlib.osutils.file_kind(os.path.join(root, path))
435
new_inventory[file_id] = (path, file_id, parent, kind)
436
by_path[path] = file_id
438
# Get a list in insertion order
439
new_inventory_list = new_inventory.values()
440
mutter ("""Inventory regeneration:
441
old length: %i insertions: %i deletions: %i new_length: %i"""\
442
% (len(old_entries), insertions, deletions, len(new_inventory_list)))
443
assert len(new_inventory_list) == len(old_entries) + insertions - deletions
444
new_inventory_list.sort()
445
return new_inventory_list
447
merge_types = { "merge3": (ApplyMerge3, "Native diff3-style merge"),
448
"diff3": (Diff3Merge, "Merge using external diff3")
added
removed
bzrlib/merge.py
