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
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
36
from bzrlib.osutils import rename
39
# comments from abentley on irc: merge happens in two stages, each
40
# of which generates a changeset object
42
# stage 1: generate OLD->OTHER,
43
# stage 2: use MINE and OLD->OTHER to generate MINE -> RESULT
45
class MergeConflictHandler(ExceptionConflictHandler):
46
"""Handle conflicts encountered while merging.
48
This subclasses ExceptionConflictHandler, so that any types of
49
conflict that are not explicitly handled cause an exception and
52
def __init__(self, ignore_zero=False):
53
ExceptionConflictHandler.__init__(self)
55
self.ignore_zero = ignore_zero
57
def copy(self, source, dest):
58
"""Copy the text and mode of a file
59
:param source: The path of the file to copy
60
:param dest: The distination file to create
62
s_file = file(source, "rb")
63
d_file = file(dest, "wb")
66
os.chmod(dest, 0777 & os.stat(source).st_mode)
68
def dump(self, lines, 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
d_file = file(dest, "wb")
77
def add_suffix(self, name, suffix, last_new_name=None):
78
"""Rename a file to append a suffix. If the new name exists, the
79
suffix is added repeatedly until a non-existant name is found
81
:param name: The path of the file
82
:param suffix: The suffix to append
83
:param last_new_name: (used for recursive calls) the last name tried
85
if last_new_name is None:
87
new_name = last_new_name+suffix
89
rename(name, new_name)
92
if e.errno != errno.EEXIST and e.errno != errno.ENOTEMPTY:
94
return self.add_suffix(name, suffix, last_new_name=new_name)
96
def conflict(self, text):
101
def merge_conflict(self, new_file, this_path, base_lines, other_lines):
103
Handle diff3 conflicts by producing a .THIS, .BASE and .OTHER. The
104
main file will be a version with diff3 conflicts.
105
:param new_file: Path to the output file with diff3 markers
106
:param this_path: Path to the file text for the THIS tree
107
:param base_path: Path to the file text for the BASE tree
108
:param other_path: Path to the file text for the OTHER tree
110
self.add_suffix(this_path, ".THIS")
111
self.dump(base_lines, this_path+".BASE")
112
self.dump(other_lines, this_path+".OTHER")
113
rename(new_file, this_path)
114
self.conflict("Diff3 conflict encountered in %s" % this_path)
116
def new_contents_conflict(self, filename, other_contents):
117
"""Conflicting contents for newly added file."""
118
self.copy(other_contents, filename + ".OTHER")
119
self.conflict("Conflict in newly added file %s" % filename)
122
def target_exists(self, entry, target, old_path):
123
"""Handle the case when the target file or dir exists"""
124
moved_path = self.add_suffix(target, ".moved")
125
self.conflict("Moved existing %s to %s" % (target, moved_path))
127
def rmdir_non_empty(self, filename):
128
"""Handle the case where the dir to be removed still has contents"""
129
self.conflict("Directory %s not removed because it is not empty"\
134
if not self.ignore_zero:
135
print "%d conflicts encountered.\n" % self.conflicts
137
def get_tree(treespec, temp_root, label, local_branch=None):
138
location, revno = treespec
139
branch = Branch.open_containing(location)
143
revision = branch.last_patch()
145
revision = branch.get_rev_id(revno)
146
return branch, get_revid_tree(branch, revision, temp_root, label,
149
def get_revid_tree(branch, revision, temp_root, label, local_branch):
151
base_tree = branch.working_tree()
153
if local_branch is not None:
154
greedy_fetch(local_branch, branch, revision)
155
base_tree = local_branch.revision_tree(revision)
157
base_tree = branch.revision_tree(revision)
158
temp_path = os.path.join(temp_root, label)
160
return MergeTree(base_tree, temp_path)
163
def file_exists(tree, file_id):
164
return tree.has_filename(tree.id2path(file_id))
167
class MergeTree(object):
168
def __init__(self, tree, tempdir):
169
object.__init__(self)
170
if hasattr(tree, "basedir"):
171
self.root = tree.basedir
175
self.tempdir = tempdir
176
os.mkdir(os.path.join(self.tempdir, "texts"))
177
os.mkdir(os.path.join(self.tempdir, "symlinks"))
181
return self.tree.__iter__()
183
def __contains__(self, file_id):
184
return file_id in self.tree
186
def get_file(self, file_id):
187
return self.tree.get_file(file_id)
189
def get_file_sha1(self, id):
190
return self.tree.get_file_sha1(id)
192
def id2path(self, file_id):
193
return self.tree.id2path(file_id)
195
def has_id(self, file_id):
196
return self.tree.has_id(file_id)
198
def has_or_had_id(self, file_id):
199
if file_id == self.tree.inventory.root.file_id:
201
return self.tree.inventory.has_id(file_id)
203
def has_or_had_id(self, file_id):
204
if file_id == self.tree.inventory.root.file_id:
206
return self.tree.inventory.has_id(file_id)
208
def readonly_path(self, id):
209
if id not in self.tree:
211
if self.root is not None:
212
return self.tree.abspath(self.tree.id2path(id))
214
kind = self.tree.inventory[id].kind
215
if kind in ("directory", "root_directory"):
217
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))
224
assert kind == "symlink"
225
path = os.path.join(self.tempdir, "symlinks", id)
226
target = self.tree.get_symlink_target(id)
227
os.symlink(target, path)
228
self.cached[id] = path
229
return self.cached[id]
233
def merge(other_revision, base_revision,
234
check_clean=True, ignore_zero=False,
235
this_dir=None, backup_files=False, merge_type=ApplyMerge3,
237
"""Merge changes into a tree.
240
tuple(path, revision) Base for three-way merge.
242
tuple(path, revision) Other revision for three-way merge.
244
Directory to merge changes into; '.' by default.
246
If true, this_dir must have no uncommitted changes before the
248
all available ancestors of other_revision and base_revision are
249
automatically pulled into the branch.
251
from bzrlib.revision import common_ancestor, MultipleRevisionSources
252
from bzrlib.errors import NoSuchRevision
253
tempdir = tempfile.mkdtemp(prefix="bzr-")
257
this_branch = Branch.open_containing(this_dir)
258
this_rev_id = this_branch.last_patch()
259
if this_rev_id is None:
260
raise BzrCommandError("This branch has no commits")
262
changes = compare_trees(this_branch.working_tree(),
263
this_branch.basis_tree(), False)
264
if changes.has_changed():
265
raise BzrCommandError("Working tree has uncommitted changes.")
266
other_branch, other_tree = get_tree(other_revision, tempdir, "other",
268
if other_revision[1] == -1:
269
other_rev_id = other_branch.last_patch()
270
if other_rev_id is None:
271
raise NoCommits(other_branch)
272
other_basis = other_rev_id
273
elif other_revision[1] is not None:
274
other_rev_id = other_branch.get_rev_id(other_revision[1])
275
other_basis = other_rev_id
278
other_basis = other_branch.last_patch()
279
if other_basis is None:
280
raise NoCommits(other_branch)
281
if base_revision == [None, None]:
283
base_rev_id = common_ancestor(this_rev_id, other_basis,
285
except NoCommonAncestor:
286
raise UnrelatedBranches()
287
base_tree = get_revid_tree(this_branch, base_rev_id, tempdir,
289
base_is_ancestor = True
291
base_branch, base_tree = get_tree(base_revision, tempdir, "base")
292
if base_revision[1] == -1:
293
base_rev_id = base_branch.last_patch()
294
elif base_revision[1] is None:
297
base_rev_id = base_branch.get_rev_id(base_revision[1])
298
multi_source = MultipleRevisionSources(this_branch, base_branch)
299
base_is_ancestor = is_ancestor(this_rev_id, base_rev_id,
301
if file_list is None:
302
interesting_ids = None
304
interesting_ids = set()
305
this_tree = this_branch.working_tree()
306
for fname in file_list:
307
path = this_branch.relpath(fname)
309
for tree in (this_tree, base_tree.tree, other_tree.tree):
310
file_id = tree.inventory.path2id(path)
311
if file_id is not None:
312
interesting_ids.add(file_id)
315
raise BzrCommandError("%s is not a source file in any"
317
merge_inner(this_branch, other_tree, base_tree, tempdir,
318
ignore_zero=ignore_zero, backup_files=backup_files,
319
merge_type=merge_type, interesting_ids=interesting_ids)
320
if base_is_ancestor and other_rev_id is not None\
321
and other_rev_id not in this_branch.revision_history():
322
this_branch.add_pending_merge(other_rev_id)
324
shutil.rmtree(tempdir)
327
def set_interesting(inventory_a, inventory_b, interesting_ids):
328
"""Mark files whose ids are in interesting_ids as interesting
330
for inventory in (inventory_a, inventory_b):
331
for path, source_file in inventory.iteritems():
332
source_file.interesting = source_file.id in interesting_ids
335
def generate_cset_optimized(tree_a, tree_b, interesting_ids=None):
336
"""Generate a changeset. If interesting_ids is supplied, only changes
337
to those files will be shown. Metadata changes are stripped.
339
cset = generate_changeset(tree_a, tree_b, interesting_ids)
340
for entry in cset.entries.itervalues():
341
entry.metadata_change = None
345
def merge_inner(this_branch, other_tree, base_tree, tempdir,
346
ignore_zero=False, merge_type=ApplyMerge3, backup_files=False,
347
interesting_ids=None):
349
def merge_factory(file_id, base, other):
350
contents_change = merge_type(file_id, base, other)
352
contents_change = BackupBeforeChange(contents_change)
353
return contents_change
355
this_tree = get_tree((this_branch.base, None), tempdir, "this")[1]
357
def get_inventory(tree):
358
return tree.tree.inventory
360
inv_changes = merge_flex(this_tree, base_tree, other_tree,
361
generate_cset_optimized, get_inventory,
362
MergeConflictHandler(ignore_zero=ignore_zero),
363
merge_factory=merge_factory,
364
interesting_ids=interesting_ids)
367
for id, path in inv_changes.iteritems():
372
assert path.startswith('.' + os.sep), "path is %s" % path
374
adjust_ids.append((path, id))
375
if len(adjust_ids) > 0:
376
this_branch.set_inventory(regen_inventory(this_branch, this_tree.root,
380
def regen_inventory(this_branch, root, new_entries):
381
old_entries = this_branch.read_working_inventory()
385
for path, file_id in new_entries:
388
new_entries_map[file_id] = path
390
def id2path(file_id):
391
path = new_entries_map.get(file_id)
394
entry = old_entries[file_id]
395
if entry.parent_id is None:
397
return os.path.join(id2path(entry.parent_id), entry.name)
399
for file_id in old_entries:
400
entry = old_entries[file_id]
401
path = id2path(file_id)
402
new_inventory[file_id] = (path, file_id, entry.parent_id, entry.kind)
403
by_path[path] = file_id
408
for path, file_id in new_entries:
410
del new_inventory[file_id]
413
new_path_list.append((path, file_id))
414
if file_id not in old_entries:
416
# Ensure no file is added before its parent
418
for path, file_id in new_path_list:
422
parent = by_path[os.path.dirname(path)]
423
kind = bzrlib.osutils.file_kind(os.path.join(root, path))
424
new_inventory[file_id] = (path, file_id, parent, kind)
425
by_path[path] = file_id
427
# Get a list in insertion order
428
new_inventory_list = new_inventory.values()
429
mutter ("""Inventory regeneration:
430
old length: %i insertions: %i deletions: %i new_length: %i"""\
431
% (len(old_entries), insertions, deletions, len(new_inventory_list)))
432
assert len(new_inventory_list) == len(old_entries) + insertions - deletions
433
new_inventory_list.sort()
434
return new_inventory_list
436
merge_types = { "merge3": (ApplyMerge3, "Native diff3-style merge"),
437
"diff3": (Diff3Merge, "Merge using external diff3")
added
removed
bzrlib/merge.py
