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
18
from bzrlib.merge_core import merge_flex, ApplyMerge3, BackupBeforeChange
19
from bzrlib.changeset import generate_changeset, ExceptionConflictHandler
20
from bzrlib.changeset import Inventory, Diff3Merge
21
from bzrlib.branch import find_branch
23
from bzrlib.errors import BzrCommandError, UnrelatedBranches
24
from bzrlib.delta import compare_trees
25
from trace import mutter, warning
30
from fetch import greedy_fetch
33
# comments from abentley on irc: merge happens in two stages, each
34
# of which generates a changeset object
36
# stage 1: generate OLD->OTHER,
37
# stage 2: use MINE and OLD->OTHER to generate MINE -> RESULT
39
class MergeConflictHandler(ExceptionConflictHandler):
40
"""Handle conflicts encountered while merging.
42
This subclasses ExceptionConflictHandler, so that any types of
43
conflict that are not explicitly handled cause an exception and
46
def __init__(self, dir, ignore_zero=False):
47
ExceptionConflictHandler.__init__(self, dir)
49
self.ignore_zero = ignore_zero
51
def copy(self, source, dest):
52
"""Copy the text and mode of a file
53
:param source: The path of the file to copy
54
:param dest: The distination file to create
56
s_file = file(source, "rb")
57
d_file = file(dest, "wb")
60
os.chmod(dest, 0777 & os.stat(source).st_mode)
62
def dump(self, lines, dest):
63
"""Copy the text and mode of a file
64
:param source: The path of the file to copy
65
:param dest: The distination file to create
67
d_file = file(dest, "wb")
71
def add_suffix(self, name, suffix, last_new_name=None):
72
"""Rename a file to append a suffix. If the new name exists, the
73
suffix is added repeatedly until a non-existant name is found
75
:param name: The path of the file
76
:param suffix: The suffix to append
77
:param last_new_name: (used for recursive calls) the last name tried
79
if last_new_name is None:
81
new_name = last_new_name+suffix
83
os.rename(name, new_name)
86
if e.errno != errno.EEXIST and e.errno != errno.ENOTEMPTY:
88
return self.add_suffix(name, suffix, last_new_name=new_name)
90
def conflict(self, text):
95
def merge_conflict(self, new_file, this_path, base_lines, other_lines):
97
Handle diff3 conflicts by producing a .THIS, .BASE and .OTHER. The
98
main file will be a version with diff3 conflicts.
99
:param new_file: Path to the output file with diff3 markers
100
:param this_path: Path to the file text for the THIS tree
101
:param base_path: Path to the file text for the BASE tree
102
:param other_path: Path to the file text for the OTHER tree
104
self.add_suffix(this_path, ".THIS")
105
self.dump(base_lines, this_path+".BASE")
106
self.dump(other_lines, this_path+".OTHER")
107
os.rename(new_file, this_path)
108
self.conflict("Diff3 conflict encountered in %s" % this_path)
110
def new_contents_conflict(self, filename, other_contents):
111
"""Conflicting contents for newly added file."""
112
self.copy(other_contents, filename + ".OTHER")
113
self.conflict("Conflict in newly added file %s" % filename)
116
def target_exists(self, entry, target, old_path):
117
"""Handle the case when the target file or dir exists"""
118
moved_path = self.add_suffix(target, ".moved")
119
self.conflict("Moved existing %s to %s" % (target, moved_path))
121
def rmdir_non_empty(self, filename):
122
"""Handle the case where the dir to be removed still has contents"""
123
self.conflict("Directory %s not removed because it is not empty"\
128
if not self.ignore_zero:
129
print "%d conflicts encountered.\n" % self.conflicts
131
def get_tree(treespec, temp_root, label, local_branch=None):
132
location, revno = treespec
133
branch = find_branch(location)
137
revision = branch.last_patch()
139
revision = branch.lookup_revision(revno)
140
return branch, get_revid_tree(branch, revision, temp_root, label,
143
def get_revid_tree(branch, revision, temp_root, label, local_branch):
145
base_tree = branch.working_tree()
147
if local_branch is not None:
148
greedy_fetch(local_branch, branch, revision)
149
base_tree = local_branch.revision_tree(revision)
151
base_tree = branch.revision_tree(revision)
152
temp_path = os.path.join(temp_root, label)
154
return MergeTree(base_tree, temp_path)
157
def file_exists(tree, file_id):
158
return tree.has_filename(tree.id2path(file_id))
161
class MergeTree(object):
162
def __init__(self, tree, tempdir):
163
object.__init__(self)
164
if hasattr(tree, "basedir"):
165
self.root = tree.basedir
169
self.tempdir = tempdir
170
os.mkdir(os.path.join(self.tempdir, "texts"))
174
return self.tree.__iter__()
176
def __contains__(self, file_id):
177
return file_id in self.tree
179
def get_file(self, file_id):
180
return self.tree.get_file(file_id)
182
def get_file_sha1(self, id):
183
return self.tree.get_file_sha1(id)
185
def id2path(self, file_id):
186
return self.tree.id2path(file_id)
188
def has_id(self, file_id):
189
return self.tree.has_id(file_id)
191
def has_or_had_id(self, file_id):
192
if file_id == self.tree.inventory.root.file_id:
194
return self.tree.inventory.has_id(file_id)
196
def readonly_path(self, id):
197
if id not in self.tree:
199
if self.root is not None:
200
return self.tree.abspath(self.tree.id2path(id))
202
if self.tree.inventory[id].kind in ("directory", "root_directory"):
204
if not self.cached.has_key(id):
205
path = os.path.join(self.tempdir, "texts", id)
206
outfile = file(path, "wb")
207
outfile.write(self.tree.get_file(id).read())
208
assert(os.path.exists(path))
209
self.cached[id] = path
210
return self.cached[id]
214
def merge(other_revision, base_revision,
215
check_clean=True, ignore_zero=False,
216
this_dir=None, backup_files=False, merge_type=ApplyMerge3,
218
"""Merge changes into a tree.
221
Base for three-way merge.
223
Other revision for three-way merge.
225
Directory to merge changes into; '.' by default.
227
If true, this_dir must have no uncommitted changes before the
229
all available ancestors of other_revision and base_revision are
230
automatically pulled into the branch.
232
from bzrlib.revision import common_ancestor, MultipleRevisionSources
233
from bzrlib.errors import NoSuchRevision
234
tempdir = tempfile.mkdtemp(prefix="bzr-")
238
this_branch = find_branch(this_dir)
239
this_rev_id = this_branch.last_patch()
240
if this_rev_id is None:
241
raise BzrCommandError("This branch has no commits")
243
changes = compare_trees(this_branch.working_tree(),
244
this_branch.basis_tree(), False)
245
if changes.has_changed():
246
raise BzrCommandError("Working tree has uncommitted changes.")
247
other_branch, other_tree = get_tree(other_revision, tempdir, "other",
249
if other_revision[1] == -1:
250
other_rev_id = other_branch.last_patch()
251
other_basis = other_rev_id
252
elif other_revision[1] is not None:
253
other_rev_id = other_branch.lookup_revision(other_revision[1])
254
other_basis = other_rev_id
257
other_basis = other_branch.last_patch()
258
if base_revision == [None, None]:
259
if other_revision[1] == -1:
262
o_revno = other_revision[1]
263
raise UnrelatedBranches()
265
base_revision = this_branch.get_revision(base_rev_id)
266
base_branch = this_branch
267
except NoSuchRevision:
268
base_branch = other_branch
269
base_tree = get_revid_tree(base_branch, base_rev_id, tempdir,
271
base_is_ancestor = True
273
base_branch, base_tree = get_tree(base_revision, tempdir, "base")
274
if base_revision[1] == -1:
275
base_rev_id = base_branch.last_patch()
276
elif base_revision[1] is None:
279
base_rev_id = base_branch.lookup_revision(base_revision[1])
280
if base_rev_id is not None:
281
base_is_ancestor = is_ancestor(this_rev_id, base_rev_id,
282
MultipleRevisionSources(
286
base_is_ancestor = False
287
if file_list is None:
288
interesting_ids = None
290
interesting_ids = set()
291
this_tree = this_branch.working_tree()
292
for fname in file_list:
293
path = this_branch.relpath(fname)
295
for tree in (this_tree, base_tree.tree, other_tree.tree):
296
file_id = tree.inventory.path2id(path)
297
if file_id is not None:
298
interesting_ids.add(file_id)
301
raise BzrCommandError("%s is not a source file in any"
303
merge_inner(this_branch, other_tree, base_tree, tempdir,
304
ignore_zero=ignore_zero, backup_files=backup_files,
305
merge_type=merge_type, interesting_ids=interesting_ids)
306
if base_is_ancestor and other_rev_id is not None:
307
this_branch.add_pending_merge(other_rev_id)
309
shutil.rmtree(tempdir)
312
def set_interesting(inventory_a, inventory_b, interesting_ids):
313
"""Mark files whose ids are in interesting_ids as interesting
315
for inventory in (inventory_a, inventory_b):
316
for path, source_file in inventory.iteritems():
317
source_file.interesting = source_file.id in interesting_ids
320
def generate_cset_optimized(tree_a, tree_b, interesting_ids=None):
321
"""Generate a changeset. If interesting_ids is supplied, only changes
322
to those files will be shown. Metadata changes are stripped.
324
cset = generate_changeset(tree_a, tree_b, interesting_ids)
325
for entry in cset.entries.itervalues():
326
entry.metadata_change = None
330
def merge_inner(this_branch, other_tree, base_tree, tempdir,
331
ignore_zero=False, merge_type=ApplyMerge3, backup_files=False,
332
interesting_ids=None):
334
def merge_factory(file_id, base, other):
335
contents_change = merge_type(file_id, base, other)
337
contents_change = BackupBeforeChange(contents_change)
338
return contents_change
340
this_tree = get_tree((this_branch.base, None), tempdir, "this")[1]
342
def get_inventory(tree):
343
return tree.tree.inventory
345
inv_changes = merge_flex(this_tree, base_tree, other_tree,
346
generate_cset_optimized, get_inventory,
347
MergeConflictHandler(base_tree.root,
348
ignore_zero=ignore_zero),
349
merge_factory=merge_factory,
350
interesting_ids=interesting_ids)
353
for id, path in inv_changes.iteritems():
358
assert path.startswith('./'), "path is %s" % path
360
adjust_ids.append((path, id))
361
if len(adjust_ids) > 0:
362
this_branch.set_inventory(regen_inventory(this_branch, this_tree.root,
366
def regen_inventory(this_branch, root, new_entries):
367
old_entries = this_branch.read_working_inventory()
371
for path, file_id in new_entries:
374
new_entries_map[file_id] = path
376
def id2path(file_id):
377
path = new_entries_map.get(file_id)
380
entry = old_entries[file_id]
381
if entry.parent_id is None:
383
return os.path.join(id2path(entry.parent_id), entry.name)
385
for file_id in old_entries:
386
entry = old_entries[file_id]
387
path = id2path(file_id)
388
new_inventory[file_id] = (path, file_id, entry.parent_id, entry.kind)
389
by_path[path] = file_id
394
for path, file_id in new_entries:
396
del new_inventory[file_id]
399
new_path_list.append((path, file_id))
400
if file_id not in old_entries:
402
# Ensure no file is added before its parent
404
for path, file_id in new_path_list:
408
parent = by_path[os.path.dirname(path)]
409
kind = bzrlib.osutils.file_kind(os.path.join(root, path))
410
new_inventory[file_id] = (path, file_id, parent, kind)
411
by_path[path] = file_id
413
# Get a list in insertion order
414
new_inventory_list = new_inventory.values()
415
mutter ("""Inventory regeneration:
416
old length: %i insertions: %i deletions: %i new_length: %i"""\
417
% (len(old_entries), insertions, deletions, len(new_inventory_list)))
418
assert len(new_inventory_list) == len(old_entries) + insertions - deletions
419
new_inventory_list.sort()
420
return new_inventory_list
422
merge_types = { "merge3": (ApplyMerge3, "Native diff3-style merge"),
423
"diff3": (Diff3Merge, "Merge using external diff3")
added
removed
bzrlib/merge.py
