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, ReplaceContents
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, this_tree, base_tree, other_tree, ignore_zero=False):
57
ExceptionConflictHandler.__init__(self)
59
self.ignore_zero = ignore_zero
60
self.this_tree = this_tree
61
self.base_tree = base_tree
62
self.other_tree = other_tree
64
def copy(self, source, 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
s_file = file(source, "rb")
70
d_file = file(dest, "wb")
73
os.chmod(dest, 0777 & os.stat(source).st_mode)
75
def dump(self, lines, dest):
76
"""Copy the text and mode of a file
77
:param source: The path of the file to copy
78
:param dest: The distination file to create
80
d_file = file(dest, "wb")
84
def add_suffix(self, name, suffix, last_new_name=None):
85
"""Rename a file to append a suffix. If the new name exists, the
86
suffix is added repeatedly until a non-existant name is found
88
:param name: The path of the file
89
:param suffix: The suffix to append
90
:param last_new_name: (used for recursive calls) the last name tried
92
if last_new_name is None:
94
new_name = last_new_name+suffix
96
rename(name, new_name)
99
if e.errno != errno.EEXIST and e.errno != errno.ENOTEMPTY:
101
return self.add_suffix(name, suffix, last_new_name=new_name)
103
def conflict(self, text):
108
def merge_conflict(self, new_file, this_path, base_lines, other_lines):
110
Handle diff3 conflicts by producing a .THIS, .BASE and .OTHER. The
111
main file will be a version with diff3 conflicts.
112
:param new_file: Path to the output file with diff3 markers
113
:param this_path: Path to the file text for the THIS tree
114
:param base_path: Path to the file text for the BASE tree
115
:param other_path: Path to the file text for the OTHER tree
117
self.add_suffix(this_path, ".THIS")
118
self.dump(base_lines, this_path+".BASE")
119
self.dump(other_lines, this_path+".OTHER")
120
rename(new_file, this_path)
121
self.conflict("Diff3 conflict encountered in %s" % this_path)
123
def new_contents_conflict(self, filename, other_contents):
124
"""Conflicting contents for newly added file."""
125
self.copy(other_contents, filename + ".OTHER")
126
self.conflict("Conflict in newly added file %s" % filename)
129
def target_exists(self, entry, target, old_path):
130
"""Handle the case when the target file or dir exists"""
131
moved_path = self.add_suffix(target, ".moved")
132
self.conflict("Moved existing %s to %s" % (target, moved_path))
134
def rmdir_non_empty(self, filename):
135
"""Handle the case where the dir to be removed still has contents"""
136
self.conflict("Directory %s not removed because it is not empty"\
140
def rem_contents_conflict(self, filename, this_contents, base_contents):
141
base_contents(filename+".BASE", self, False)
142
this_contents(filename+".THIS", self, False)
143
return ReplaceContents(this_contents, None)
145
def rem_contents_conflict(self, filename, this_contents, base_contents):
146
base_contents(filename+".BASE", self, False)
147
this_contents(filename+".THIS", self, False)
148
self.conflict("Other branch deleted locally modified file %s" %
150
return ReplaceContents(this_contents, None)
152
def abs_this_path(self, file_id):
153
"""Return the absolute path for a file_id in the this tree."""
154
relpath = self.this_tree.id2path(file_id)
155
return self.this_tree.tree.abspath(relpath)
157
def add_missing_parents(self, file_id, tree):
158
"""If some of the parents for file_id are missing, add them."""
159
entry = tree.tree.inventory[file_id]
160
if entry.parent_id not in self.this_tree:
161
return self.create_all_missing(entry.parent_id, tree)
163
return self.abs_this_path(entry.parent_id)
165
def create_all_missing(self, file_id, tree):
166
"""Add contents for a file_id and all its parents to a tree."""
167
entry = tree.tree.inventory[file_id]
168
if entry.parent_id is not None and entry.parent_id not in self.this_tree:
169
abspath = self.create_all_missing(entry.parent_id, tree)
171
abspath = self.abs_this_path(entry.parent_id)
172
entry_path = os.path.join(abspath, entry.name)
173
if not os.path.isdir(entry_path):
174
self.create(file_id, entry_path, tree)
177
def create(self, file_id, path, tree, reverse=False):
178
"""Uses tree data to create a filesystem object for the file_id"""
179
from merge_core import get_id_contents
180
get_id_contents(file_id, tree)(path, self, reverse)
182
def missing_for_merge(self, file_id, other_path):
183
"""The file_id doesn't exist in THIS, but does in OTHER and BASE"""
184
self.conflict("Other branch modified locally deleted file %s" %
186
parent_dir = self.add_missing_parents(file_id, self.other_tree)
187
stem = os.path.join(parent_dir, os.path.basename(other_path))
188
self.create(file_id, stem+".OTHER", self.other_tree)
189
self.create(file_id, stem+".BASE", self.base_tree)
192
if not self.ignore_zero:
193
print "%d conflicts encountered.\n" % self.conflicts
195
def get_tree(treespec, temp_root, label, local_branch=None):
196
location, revno = treespec
197
branch = Branch.open_containing(location)
201
revision = branch.last_revision()
203
revision = branch.get_rev_id(revno)
204
return branch, get_revid_tree(branch, revision, temp_root, label,
207
def get_revid_tree(branch, revision, temp_root, label, local_branch):
209
base_tree = branch.working_tree()
211
if local_branch is not None:
212
greedy_fetch(local_branch, branch, revision)
213
base_tree = local_branch.revision_tree(revision)
215
base_tree = branch.revision_tree(revision)
216
temp_path = os.path.join(temp_root, label)
218
return MergeTree(base_tree, temp_path)
221
def file_exists(tree, file_id):
222
return tree.has_filename(tree.id2path(file_id))
225
class MergeTree(object):
226
def __init__(self, tree, tempdir):
227
object.__init__(self)
228
if hasattr(tree, "basedir"):
229
self.root = tree.basedir
233
self.tempdir = tempdir
234
os.mkdir(os.path.join(self.tempdir, "texts"))
235
os.mkdir(os.path.join(self.tempdir, "symlinks"))
239
return self.tree.__iter__()
241
def __contains__(self, file_id):
242
return file_id in self.tree
244
def get_file(self, file_id):
245
return self.tree.get_file(file_id)
247
def get_file_sha1(self, id):
248
return self.tree.get_file_sha1(id)
250
def is_executable(self, id):
251
return self.tree.is_executable(id)
253
def id2path(self, file_id):
254
return self.tree.id2path(file_id)
256
def has_id(self, file_id):
257
return self.tree.has_id(file_id)
259
def has_or_had_id(self, file_id):
260
if file_id == self.tree.inventory.root.file_id:
262
return self.tree.inventory.has_id(file_id)
264
def has_or_had_id(self, file_id):
265
if file_id == self.tree.inventory.root.file_id:
267
return self.tree.inventory.has_id(file_id)
269
def readonly_path(self, id):
270
if id not in self.tree:
272
if self.root is not None:
273
return self.tree.abspath(self.tree.id2path(id))
275
kind = self.tree.inventory[id].kind
276
if kind in ("directory", "root_directory"):
278
if not self.cached.has_key(id):
280
path = os.path.join(self.tempdir, "texts", id)
281
outfile = file(path, "wb")
282
outfile.write(self.tree.get_file(id).read())
283
assert(bzrlib.osutils.lexists(path))
284
if self.tree.is_executable(id):
287
assert kind == "symlink"
288
path = os.path.join(self.tempdir, "symlinks", id)
289
target = self.tree.get_symlink_target(id)
290
os.symlink(target, path)
291
self.cached[id] = path
292
return self.cached[id]
295
def build_working_dir(to_dir):
296
"""Build a working directory in an empty directory.
298
to_dir is a directory containing branch metadata but no working files,
299
typically constructed by cloning an existing branch.
301
This is split out as a special idiomatic case of merge. It could
302
eventually be done by just building the tree directly calling into
303
lower-level code (e.g. constructing a changeset).
305
merge((to_dir, -1), (to_dir, 0), this_dir=to_dir,
306
check_clean=False, ignore_zero=True)
309
def merge(other_revision, base_revision,
310
check_clean=True, ignore_zero=False,
311
this_dir=None, backup_files=False, merge_type=ApplyMerge3,
313
"""Merge changes into a tree.
316
tuple(path, revision) Base for three-way merge.
318
tuple(path, revision) Other revision for three-way merge.
320
Directory to merge changes into; '.' by default.
322
If true, this_dir must have no uncommitted changes before the
324
ignore_zero - If true, suppress the "zero conflicts" message when
325
there are no conflicts; should be set when doing something we expect
326
to complete perfectly.
328
All available ancestors of other_revision and base_revision are
329
automatically pulled into the branch.
331
tempdir = tempfile.mkdtemp(prefix="bzr-")
335
this_branch = Branch.open_containing(this_dir)
336
this_rev_id = this_branch.last_revision()
337
if this_rev_id is None:
338
raise BzrCommandError("This branch has no commits")
340
changes = compare_trees(this_branch.working_tree(),
341
this_branch.basis_tree(), False)
342
if changes.has_changed():
343
raise BzrCommandError("Working tree has uncommitted changes.")
344
other_branch, other_tree = get_tree(other_revision, tempdir, "other",
346
if other_revision[1] == -1:
347
other_rev_id = other_branch.last_revision()
348
if other_rev_id is None:
349
raise NoCommits(other_branch)
350
other_basis = other_rev_id
351
elif other_revision[1] is not None:
352
other_rev_id = other_branch.get_rev_id(other_revision[1])
353
other_basis = other_rev_id
356
other_basis = other_branch.last_revision()
357
if other_basis is None:
358
raise NoCommits(other_branch)
359
if base_revision == [None, None]:
361
base_rev_id = common_ancestor(this_rev_id, other_basis,
363
except NoCommonAncestor:
364
raise UnrelatedBranches()
365
base_tree = get_revid_tree(this_branch, base_rev_id, tempdir,
367
base_is_ancestor = True
369
base_branch, base_tree = get_tree(base_revision, tempdir, "base")
370
if base_revision[1] == -1:
371
base_rev_id = base_branch.last_revision()
372
elif base_revision[1] is None:
375
base_rev_id = base_branch.get_rev_id(base_revision[1])
376
fetch(from_branch=base_branch, to_branch=this_branch)
377
base_is_ancestor = is_ancestor(this_rev_id, base_rev_id,
379
if file_list is None:
380
interesting_ids = None
382
interesting_ids = set()
383
this_tree = this_branch.working_tree()
384
for fname in file_list:
385
path = this_branch.relpath(fname)
387
for tree in (this_tree, base_tree.tree, other_tree.tree):
388
file_id = tree.inventory.path2id(path)
389
if file_id is not None:
390
interesting_ids.add(file_id)
393
raise BzrCommandError("%s is not a source file in any"
395
merge_inner(this_branch, other_tree, base_tree, tempdir,
396
ignore_zero=ignore_zero, backup_files=backup_files,
397
merge_type=merge_type, interesting_ids=interesting_ids)
398
if base_is_ancestor and other_rev_id is not None\
399
and other_rev_id not in this_branch.revision_history():
400
this_branch.add_pending_merge(other_rev_id)
402
shutil.rmtree(tempdir)
405
def set_interesting(inventory_a, inventory_b, interesting_ids):
406
"""Mark files whose ids are in interesting_ids as interesting
408
for inventory in (inventory_a, inventory_b):
409
for path, source_file in inventory.iteritems():
410
source_file.interesting = source_file.id in interesting_ids
413
def generate_cset_optimized(tree_a, tree_b, interesting_ids=None):
414
"""Generate a changeset. If interesting_ids is supplied, only changes
415
to those files will be shown. Metadata changes are stripped.
417
cset = generate_changeset(tree_a, tree_b, interesting_ids)
418
for entry in cset.entries.itervalues():
419
entry.metadata_change = None
423
def merge_inner(this_branch, other_tree, base_tree, tempdir,
424
ignore_zero=False, merge_type=ApplyMerge3, backup_files=False,
425
interesting_ids=None):
427
def merge_factory(file_id, base, other):
428
contents_change = merge_type(file_id, base, other)
430
contents_change = BackupBeforeChange(contents_change)
431
return contents_change
433
this_tree = get_tree((this_branch.base, None), tempdir, "this")[1]
435
def get_inventory(tree):
436
return tree.tree.inventory
438
inv_changes = merge_flex(this_tree, base_tree, other_tree,
439
generate_cset_optimized, get_inventory,
440
MergeConflictHandler(this_tree, base_tree,
441
other_tree, ignore_zero=ignore_zero),
442
merge_factory=merge_factory,
443
interesting_ids=interesting_ids)
446
for id, path in inv_changes.iteritems():
451
assert path.startswith('.' + os.sep), "path is %s" % path
453
adjust_ids.append((path, id))
454
if len(adjust_ids) > 0:
455
this_branch.set_inventory(regen_inventory(this_branch, this_tree.root,
459
def regen_inventory(this_branch, root, new_entries):
460
old_entries = this_branch.read_working_inventory()
464
for path, file_id in new_entries:
467
new_entries_map[file_id] = path
469
def id2path(file_id):
470
path = new_entries_map.get(file_id)
473
entry = old_entries[file_id]
474
if entry.parent_id is None:
476
return os.path.join(id2path(entry.parent_id), entry.name)
478
for file_id in old_entries:
479
entry = old_entries[file_id]
480
path = id2path(file_id)
481
new_inventory[file_id] = (path, file_id, entry.parent_id, entry.kind)
482
by_path[path] = file_id
487
for path, file_id in new_entries:
489
del new_inventory[file_id]
492
new_path_list.append((path, file_id))
493
if file_id not in old_entries:
495
# Ensure no file is added before its parent
497
for path, file_id in new_path_list:
501
parent = by_path[os.path.dirname(path)]
502
kind = bzrlib.osutils.file_kind(os.path.join(root, path))
503
new_inventory[file_id] = (path, file_id, parent, kind)
504
by_path[path] = file_id
506
# Get a list in insertion order
507
new_inventory_list = new_inventory.values()
508
mutter ("""Inventory regeneration:
509
old length: %i insertions: %i deletions: %i new_length: %i"""\
510
% (len(old_entries), insertions, deletions, len(new_inventory_list)))
511
assert len(new_inventory_list) == len(old_entries) + insertions - deletions
512
new_inventory_list.sort()
513
return new_inventory_list
515
merge_types = { "merge3": (ApplyMerge3, "Native diff3-style merge"),
516
"diff3": (Diff3Merge, "Merge using external diff3")
added
removed
bzrlib/merge.py
