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 find_branch
29
from bzrlib.errors import BzrCommandError, UnrelatedBranches
30
from bzrlib.delta import compare_trees
31
from bzrlib.trace import mutter, warning
32
from bzrlib.fetch import greedy_fetch
33
from bzrlib.revision import is_ancestor
35
# comments from abentley on irc: merge happens in two stages, each
36
# of which generates a changeset object
38
# stage 1: generate OLD->OTHER,
39
# stage 2: use MINE and OLD->OTHER to generate MINE -> RESULT
41
class MergeConflictHandler(ExceptionConflictHandler):
42
"""Handle conflicts encountered while merging.
44
This subclasses ExceptionConflictHandler, so that any types of
45
conflict that are not explicitly handled cause an exception and
48
def __init__(self, dir, ignore_zero=False):
49
ExceptionConflictHandler.__init__(self, dir)
51
self.ignore_zero = ignore_zero
53
def copy(self, source, dest):
54
"""Copy the text and mode of a file
55
:param source: The path of the file to copy
56
:param dest: The distination file to create
58
s_file = file(source, "rb")
59
d_file = file(dest, "wb")
62
os.chmod(dest, 0777 & os.stat(source).st_mode)
64
def dump(self, lines, dest):
65
"""Copy the text and mode of a file
66
:param source: The path of the file to copy
67
:param dest: The distination file to create
69
d_file = file(dest, "wb")
73
def add_suffix(self, name, suffix, last_new_name=None):
74
"""Rename a file to append a suffix. If the new name exists, the
75
suffix is added repeatedly until a non-existant name is found
77
:param name: The path of the file
78
:param suffix: The suffix to append
79
:param last_new_name: (used for recursive calls) the last name tried
81
if last_new_name is None:
83
new_name = last_new_name+suffix
85
os.rename(name, new_name)
88
if e.errno != errno.EEXIST and e.errno != errno.ENOTEMPTY:
90
return self.add_suffix(name, suffix, last_new_name=new_name)
92
def conflict(self, text):
97
def merge_conflict(self, new_file, this_path, base_lines, other_lines):
99
Handle diff3 conflicts by producing a .THIS, .BASE and .OTHER. The
100
main file will be a version with diff3 conflicts.
101
:param new_file: Path to the output file with diff3 markers
102
:param this_path: Path to the file text for the THIS tree
103
:param base_path: Path to the file text for the BASE tree
104
:param other_path: Path to the file text for the OTHER tree
106
self.add_suffix(this_path, ".THIS")
107
self.dump(base_lines, this_path+".BASE")
108
self.dump(other_lines, this_path+".OTHER")
109
os.rename(new_file, this_path)
110
self.conflict("Diff3 conflict encountered in %s" % this_path)
112
def new_contents_conflict(self, filename, other_contents):
113
"""Conflicting contents for newly added file."""
114
self.copy(other_contents, filename + ".OTHER")
115
self.conflict("Conflict in newly added file %s" % filename)
118
def target_exists(self, entry, target, old_path):
119
"""Handle the case when the target file or dir exists"""
120
moved_path = self.add_suffix(target, ".moved")
121
self.conflict("Moved existing %s to %s" % (target, moved_path))
123
def rmdir_non_empty(self, filename):
124
"""Handle the case where the dir to be removed still has contents"""
125
self.conflict("Directory %s not removed because it is not empty"\
130
if not self.ignore_zero:
131
print "%d conflicts encountered.\n" % self.conflicts
133
def get_tree(treespec, temp_root, label, local_branch=None):
134
location, revno = treespec
135
branch = find_branch(location)
139
revision = branch.last_patch()
141
revision = branch.lookup_revision(revno)
142
return branch, get_revid_tree(branch, revision, temp_root, label,
145
def get_revid_tree(branch, revision, temp_root, label, local_branch):
147
base_tree = branch.working_tree()
149
if local_branch is not None:
150
greedy_fetch(local_branch, branch, revision)
151
base_tree = local_branch.revision_tree(revision)
153
base_tree = branch.revision_tree(revision)
154
temp_path = os.path.join(temp_root, label)
156
return MergeTree(base_tree, temp_path)
159
def file_exists(tree, file_id):
160
return tree.has_filename(tree.id2path(file_id))
163
class MergeTree(object):
164
def __init__(self, tree, tempdir):
165
object.__init__(self)
166
if hasattr(tree, "basedir"):
167
self.root = tree.basedir
171
self.tempdir = tempdir
172
os.mkdir(os.path.join(self.tempdir, "texts"))
176
return self.tree.__iter__()
178
def __contains__(self, file_id):
179
return file_id in self.tree
181
def get_file(self, file_id):
182
return self.tree.get_file(file_id)
184
def get_file_sha1(self, id):
185
return self.tree.get_file_sha1(id)
187
def id2path(self, file_id):
188
return self.tree.id2path(file_id)
190
def has_id(self, file_id):
191
return self.tree.has_id(file_id)
193
def has_or_had_id(self, file_id):
194
if file_id == self.tree.inventory.root.file_id:
196
return self.tree.inventory.has_id(file_id)
198
def readonly_path(self, id):
199
if id not in self.tree:
201
if self.root is not None:
202
return self.tree.abspath(self.tree.id2path(id))
204
if self.tree.inventory[id].kind in ("directory", "root_directory"):
206
if not self.cached.has_key(id):
207
path = os.path.join(self.tempdir, "texts", id)
208
outfile = file(path, "wb")
209
outfile.write(self.tree.get_file(id).read())
210
assert(os.path.exists(path))
211
self.cached[id] = path
212
return self.cached[id]
216
def merge(other_revision, base_revision,
217
check_clean=True, ignore_zero=False,
218
this_dir=None, backup_files=False, merge_type=ApplyMerge3,
220
"""Merge changes into a tree.
223
Base for three-way merge.
225
Other revision for three-way merge.
227
Directory to merge changes into; '.' by default.
229
If true, this_dir must have no uncommitted changes before the
231
all available ancestors of other_revision and base_revision are
232
automatically pulled into the branch.
234
from bzrlib.revision import common_ancestor, MultipleRevisionSources
235
from bzrlib.errors import NoSuchRevision
236
tempdir = tempfile.mkdtemp(prefix="bzr-")
240
this_branch = find_branch(this_dir)
241
this_rev_id = this_branch.last_patch()
242
if this_rev_id is None:
243
raise BzrCommandError("This branch has no commits")
245
changes = compare_trees(this_branch.working_tree(),
246
this_branch.basis_tree(), False)
247
if changes.has_changed():
248
raise BzrCommandError("Working tree has uncommitted changes.")
249
other_branch, other_tree = get_tree(other_revision, tempdir, "other",
251
if other_revision[1] == -1:
252
other_rev_id = other_branch.last_patch()
253
other_basis = other_rev_id
254
elif other_revision[1] is not None:
255
other_rev_id = other_branch.lookup_revision(other_revision[1])
256
other_basis = other_rev_id
259
other_basis = other_branch.last_patch()
260
if base_revision == [None, None]:
261
if other_revision[1] == -1:
264
o_revno = other_revision[1]
265
raise UnrelatedBranches()
267
base_revision = this_branch.get_revision(base_rev_id)
268
base_branch = this_branch
269
except NoSuchRevision:
270
base_branch = other_branch
271
base_tree = get_revid_tree(base_branch, base_rev_id, tempdir,
273
base_is_ancestor = True
275
base_branch, base_tree = get_tree(base_revision, tempdir, "base")
276
if base_revision[1] == -1:
277
base_rev_id = base_branch.last_patch()
278
elif base_revision[1] is None:
281
base_rev_id = base_branch.lookup_revision(base_revision[1])
282
if base_rev_id is not None:
283
base_is_ancestor = is_ancestor(this_rev_id, base_rev_id,
284
MultipleRevisionSources(this_branch,
287
base_is_ancestor = False
288
if file_list is None:
289
interesting_ids = None
291
interesting_ids = set()
292
this_tree = this_branch.working_tree()
293
for fname in file_list:
294
path = this_branch.relpath(fname)
296
for tree in (this_tree, base_tree.tree, other_tree.tree):
297
file_id = tree.inventory.path2id(path)
298
if file_id is not None:
299
interesting_ids.add(file_id)
302
raise BzrCommandError("%s is not a source file in any"
304
merge_inner(this_branch, other_tree, base_tree, tempdir,
305
ignore_zero=ignore_zero, backup_files=backup_files,
306
merge_type=merge_type, interesting_ids=interesting_ids)
307
if base_is_ancestor and other_rev_id is not None:
308
this_branch.add_pending_merge(other_rev_id)
310
shutil.rmtree(tempdir)
313
def set_interesting(inventory_a, inventory_b, interesting_ids):
314
"""Mark files whose ids are in interesting_ids as interesting
316
for inventory in (inventory_a, inventory_b):
317
for path, source_file in inventory.iteritems():
318
source_file.interesting = source_file.id in interesting_ids
321
def generate_cset_optimized(tree_a, tree_b, interesting_ids=None):
322
"""Generate a changeset. If interesting_ids is supplied, only changes
323
to those files will be shown. Metadata changes are stripped.
325
cset = generate_changeset(tree_a, tree_b, interesting_ids)
326
for entry in cset.entries.itervalues():
327
entry.metadata_change = None
331
def merge_inner(this_branch, other_tree, base_tree, tempdir,
332
ignore_zero=False, merge_type=ApplyMerge3, backup_files=False,
333
interesting_ids=None):
335
def merge_factory(file_id, base, other):
336
contents_change = merge_type(file_id, base, other)
338
contents_change = BackupBeforeChange(contents_change)
339
return contents_change
341
this_tree = get_tree((this_branch.base, None), tempdir, "this")[1]
343
def get_inventory(tree):
344
return tree.tree.inventory
346
inv_changes = merge_flex(this_tree, base_tree, other_tree,
347
generate_cset_optimized, get_inventory,
348
MergeConflictHandler(base_tree.root,
349
ignore_zero=ignore_zero),
350
merge_factory=merge_factory,
351
interesting_ids=interesting_ids)
354
for id, path in inv_changes.iteritems():
359
assert path.startswith('./'), "path is %s" % path
361
adjust_ids.append((path, id))
362
if len(adjust_ids) > 0:
363
this_branch.set_inventory(regen_inventory(this_branch, this_tree.root,
367
def regen_inventory(this_branch, root, new_entries):
368
old_entries = this_branch.read_working_inventory()
372
for path, file_id in new_entries:
375
new_entries_map[file_id] = path
377
def id2path(file_id):
378
path = new_entries_map.get(file_id)
381
entry = old_entries[file_id]
382
if entry.parent_id is None:
384
return os.path.join(id2path(entry.parent_id), entry.name)
386
for file_id in old_entries:
387
entry = old_entries[file_id]
388
path = id2path(file_id)
389
new_inventory[file_id] = (path, file_id, entry.parent_id, entry.kind)
390
by_path[path] = file_id
395
for path, file_id in new_entries:
397
del new_inventory[file_id]
400
new_path_list.append((path, file_id))
401
if file_id not in old_entries:
403
# Ensure no file is added before its parent
405
for path, file_id in new_path_list:
409
parent = by_path[os.path.dirname(path)]
410
kind = bzrlib.osutils.file_kind(os.path.join(root, path))
411
new_inventory[file_id] = (path, file_id, parent, kind)
412
by_path[path] = file_id
414
# Get a list in insertion order
415
new_inventory_list = new_inventory.values()
416
mutter ("""Inventory regeneration:
417
old length: %i insertions: %i deletions: %i new_length: %i"""\
418
% (len(old_entries), insertions, deletions, len(new_inventory_list)))
419
assert len(new_inventory_list) == len(old_entries) + insertions - deletions
420
new_inventory_list.sort()
421
return new_inventory_list
423
merge_types = { "merge3": (ApplyMerge3, "Native diff3-style merge"),
424
"diff3": (Diff3Merge, "Merge using external diff3")
added
removed
bzrlib/merge.py
