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
22
from fetch import greedy_fetch
25
import bzrlib.revision
26
from bzrlib.merge_core import merge_flex, ApplyMerge3, BackupBeforeChange
27
from bzrlib.changeset import generate_changeset, ExceptionConflictHandler
28
from bzrlib.changeset import Inventory, Diff3Merge, ReplaceContents
29
from bzrlib.branch import Branch
30
from bzrlib.errors import BzrCommandError, UnrelatedBranches, NoCommonAncestor
31
from bzrlib.errors import NoCommits
32
from bzrlib.delta import compare_trees
33
from bzrlib.trace import mutter, warning
34
from bzrlib.fetch import greedy_fetch
35
from bzrlib.revision import is_ancestor
37
# comments from abentley on irc: merge happens in two stages, each
38
# of which generates a changeset object
40
# stage 1: generate OLD->OTHER,
41
# stage 2: use MINE and OLD->OTHER to generate MINE -> RESULT
43
class MergeConflictHandler(ExceptionConflictHandler):
44
"""Handle conflicts encountered while merging.
46
This subclasses ExceptionConflictHandler, so that any types of
47
conflict that are not explicitly handled cause an exception and
50
def __init__(self, ignore_zero=False):
51
ExceptionConflictHandler.__init__(self)
53
self.ignore_zero = ignore_zero
55
def copy(self, source, dest):
56
"""Copy the text and mode of a file
57
:param source: The path of the file to copy
58
:param dest: The distination file to create
60
s_file = file(source, "rb")
61
d_file = file(dest, "wb")
64
os.chmod(dest, 0777 & os.stat(source).st_mode)
66
def dump(self, lines, 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
d_file = file(dest, "wb")
75
def add_suffix(self, name, suffix, last_new_name=None):
76
"""Rename a file to append a suffix. If the new name exists, the
77
suffix is added repeatedly until a non-existant name is found
79
:param name: The path of the file
80
:param suffix: The suffix to append
81
:param last_new_name: (used for recursive calls) the last name tried
83
if last_new_name is None:
85
new_name = last_new_name+suffix
87
os.rename(name, new_name)
90
if e.errno != errno.EEXIST and e.errno != errno.ENOTEMPTY:
92
return self.add_suffix(name, suffix, last_new_name=new_name)
94
def conflict(self, text):
99
def merge_conflict(self, new_file, this_path, base_lines, other_lines):
101
Handle diff3 conflicts by producing a .THIS, .BASE and .OTHER. The
102
main file will be a version with diff3 conflicts.
103
:param new_file: Path to the output file with diff3 markers
104
:param this_path: Path to the file text for the THIS tree
105
:param base_path: Path to the file text for the BASE tree
106
:param other_path: Path to the file text for the OTHER tree
108
self.add_suffix(this_path, ".THIS")
109
self.dump(base_lines, this_path+".BASE")
110
self.dump(other_lines, this_path+".OTHER")
111
os.rename(new_file, this_path)
112
self.conflict("Diff3 conflict encountered in %s" % this_path)
114
def new_contents_conflict(self, filename, other_contents):
115
"""Conflicting contents for newly added file."""
116
self.copy(other_contents, filename + ".OTHER")
117
self.conflict("Conflict in newly added file %s" % filename)
120
def target_exists(self, entry, target, old_path):
121
"""Handle the case when the target file or dir exists"""
122
moved_path = self.add_suffix(target, ".moved")
123
self.conflict("Moved existing %s to %s" % (target, moved_path))
125
def rmdir_non_empty(self, filename):
126
"""Handle the case where the dir to be removed still has contents"""
127
self.conflict("Directory %s not removed because it is not empty"\
131
def rem_contents_conflict(self, filename, this_contents, base_contents):
132
base_contents(filename+".BASE", self, False)
133
this_contents(filename+".THIS", self, False)
134
return ReplaceContents(this_contents, None)
137
if not self.ignore_zero:
138
print "%d conflicts encountered.\n" % self.conflicts
140
def get_tree(treespec, temp_root, label, local_branch=None):
141
location, revno = treespec
142
branch = Branch.open_containing(location)
146
revision = branch.last_patch()
148
revision = branch.get_rev_id(revno)
149
return branch, get_revid_tree(branch, revision, temp_root, label,
152
def get_revid_tree(branch, revision, temp_root, label, local_branch):
154
base_tree = branch.working_tree()
156
if local_branch is not None:
157
greedy_fetch(local_branch, branch, revision)
158
base_tree = local_branch.revision_tree(revision)
160
base_tree = branch.revision_tree(revision)
161
temp_path = os.path.join(temp_root, label)
163
return MergeTree(base_tree, temp_path)
166
def file_exists(tree, file_id):
167
return tree.has_filename(tree.id2path(file_id))
170
class MergeTree(object):
171
def __init__(self, tree, tempdir):
172
object.__init__(self)
173
if hasattr(tree, "basedir"):
174
self.root = tree.basedir
178
self.tempdir = tempdir
179
os.mkdir(os.path.join(self.tempdir, "texts"))
183
return self.tree.__iter__()
185
def __contains__(self, file_id):
186
return file_id in self.tree
188
def get_file(self, file_id):
189
return self.tree.get_file(file_id)
191
def get_file_sha1(self, id):
192
return self.tree.get_file_sha1(id)
194
def id2path(self, file_id):
195
return self.tree.id2path(file_id)
197
def has_id(self, file_id):
198
return self.tree.has_id(file_id)
200
def has_or_had_id(self, file_id):
201
if file_id == self.tree.inventory.root.file_id:
203
return self.tree.inventory.has_id(file_id)
205
def has_or_had_id(self, file_id):
206
if file_id == self.tree.inventory.root.file_id:
208
return self.tree.inventory.has_id(file_id)
210
def readonly_path(self, id):
211
if id not in self.tree:
213
if self.root is not None:
214
return self.tree.abspath(self.tree.id2path(id))
216
if self.tree.inventory[id].kind in ("directory", "root_directory"):
218
if not self.cached.has_key(id):
219
path = os.path.join(self.tempdir, "texts", id)
220
outfile = file(path, "wb")
221
outfile.write(self.tree.get_file(id).read())
222
assert(os.path.exists(path))
223
self.cached[id] = path
224
return self.cached[id]
228
def merge(other_revision, base_revision,
229
check_clean=True, ignore_zero=False,
230
this_dir=None, backup_files=False, merge_type=ApplyMerge3,
232
"""Merge changes into a tree.
235
tuple(path, revision) Base for three-way merge.
237
tuple(path, revision) Other revision for three-way merge.
239
Directory to merge changes into; '.' by default.
241
If true, this_dir must have no uncommitted changes before the
243
all available ancestors of other_revision and base_revision are
244
automatically pulled into the branch.
246
from bzrlib.revision import common_ancestor, MultipleRevisionSources
247
from bzrlib.errors import NoSuchRevision
248
tempdir = tempfile.mkdtemp(prefix="bzr-")
252
this_branch = Branch.open_containing(this_dir)
253
this_rev_id = this_branch.last_patch()
254
if this_rev_id is None:
255
raise BzrCommandError("This branch has no commits")
257
changes = compare_trees(this_branch.working_tree(),
258
this_branch.basis_tree(), False)
259
if changes.has_changed():
260
raise BzrCommandError("Working tree has uncommitted changes.")
261
other_branch, other_tree = get_tree(other_revision, tempdir, "other",
263
if other_revision[1] == -1:
264
other_rev_id = other_branch.last_patch()
265
if other_rev_id is None:
266
raise NoCommits(other_branch)
267
other_basis = other_rev_id
268
elif other_revision[1] is not None:
269
other_rev_id = other_branch.get_rev_id(other_revision[1])
270
other_basis = other_rev_id
273
other_basis = other_branch.last_patch()
274
if other_basis is None:
275
raise NoCommits(other_branch)
276
if base_revision == [None, None]:
278
base_rev_id = common_ancestor(this_rev_id, other_basis,
280
except NoCommonAncestor:
281
raise UnrelatedBranches()
282
base_tree = get_revid_tree(this_branch, base_rev_id, tempdir,
284
base_is_ancestor = True
286
base_branch, base_tree = get_tree(base_revision, tempdir, "base")
287
if base_revision[1] == -1:
288
base_rev_id = base_branch.last_patch()
289
elif base_revision[1] is None:
292
base_rev_id = base_branch.get_rev_id(base_revision[1])
293
multi_source = MultipleRevisionSources(this_branch, base_branch)
294
base_is_ancestor = is_ancestor(this_rev_id, base_rev_id,
296
if file_list is None:
297
interesting_ids = None
299
interesting_ids = set()
300
this_tree = this_branch.working_tree()
301
for fname in file_list:
302
path = this_branch.relpath(fname)
304
for tree in (this_tree, base_tree.tree, other_tree.tree):
305
file_id = tree.inventory.path2id(path)
306
if file_id is not None:
307
interesting_ids.add(file_id)
310
raise BzrCommandError("%s is not a source file in any"
312
merge_inner(this_branch, other_tree, base_tree, tempdir,
313
ignore_zero=ignore_zero, backup_files=backup_files,
314
merge_type=merge_type, interesting_ids=interesting_ids)
315
if base_is_ancestor and other_rev_id is not None\
316
and other_rev_id not in this_branch.revision_history():
317
this_branch.add_pending_merge(other_rev_id)
319
shutil.rmtree(tempdir)
322
def set_interesting(inventory_a, inventory_b, interesting_ids):
323
"""Mark files whose ids are in interesting_ids as interesting
325
for inventory in (inventory_a, inventory_b):
326
for path, source_file in inventory.iteritems():
327
source_file.interesting = source_file.id in interesting_ids
330
def generate_cset_optimized(tree_a, tree_b, interesting_ids=None):
331
"""Generate a changeset. If interesting_ids is supplied, only changes
332
to those files will be shown. Metadata changes are stripped.
334
cset = generate_changeset(tree_a, tree_b, interesting_ids)
335
for entry in cset.entries.itervalues():
336
entry.metadata_change = None
340
def merge_inner(this_branch, other_tree, base_tree, tempdir,
341
ignore_zero=False, merge_type=ApplyMerge3, backup_files=False,
342
interesting_ids=None):
344
def merge_factory(file_id, base, other):
345
contents_change = merge_type(file_id, base, other)
347
contents_change = BackupBeforeChange(contents_change)
348
return contents_change
350
this_tree = get_tree((this_branch.base, None), tempdir, "this")[1]
352
def get_inventory(tree):
353
return tree.tree.inventory
355
inv_changes = merge_flex(this_tree, base_tree, other_tree,
356
generate_cset_optimized, get_inventory,
357
MergeConflictHandler(ignore_zero=ignore_zero),
358
merge_factory=merge_factory,
359
interesting_ids=interesting_ids)
362
for id, path in inv_changes.iteritems():
367
assert path.startswith('.' + os.sep), "path is %s" % path
369
adjust_ids.append((path, id))
370
if len(adjust_ids) > 0:
371
this_branch.set_inventory(regen_inventory(this_branch, this_tree.root,
375
def regen_inventory(this_branch, root, new_entries):
376
old_entries = this_branch.read_working_inventory()
380
for path, file_id in new_entries:
383
new_entries_map[file_id] = path
385
def id2path(file_id):
386
path = new_entries_map.get(file_id)
389
entry = old_entries[file_id]
390
if entry.parent_id is None:
392
return os.path.join(id2path(entry.parent_id), entry.name)
394
for file_id in old_entries:
395
entry = old_entries[file_id]
396
path = id2path(file_id)
397
new_inventory[file_id] = (path, file_id, entry.parent_id, entry.kind)
398
by_path[path] = file_id
403
for path, file_id in new_entries:
405
del new_inventory[file_id]
408
new_path_list.append((path, file_id))
409
if file_id not in old_entries:
411
# Ensure no file is added before its parent
413
for path, file_id in new_path_list:
417
parent = by_path[os.path.dirname(path)]
418
kind = bzrlib.osutils.file_kind(os.path.join(root, path))
419
new_inventory[file_id] = (path, file_id, parent, kind)
420
by_path[path] = file_id
422
# Get a list in insertion order
423
new_inventory_list = new_inventory.values()
424
mutter ("""Inventory regeneration:
425
old length: %i insertions: %i deletions: %i new_length: %i"""\
426
% (len(old_entries), insertions, deletions, len(new_inventory_list)))
427
assert len(new_inventory_list) == len(old_entries) + insertions - deletions
428
new_inventory_list.sort()
429
return new_inventory_list
431
merge_types = { "merge3": (ApplyMerge3, "Native diff3-style merge"),
432
"diff3": (Diff3Merge, "Merge using external diff3")
added
removed
bzrlib/merge.py
