1
from bzrlib.merge_core import merge_flex, ApplyMerge3, BackupBeforeChange
2
from bzrlib.changeset import generate_changeset, ExceptionConflictHandler
3
from bzrlib.changeset import Inventory, Diff3Merge
4
from bzrlib import find_branch
6
from bzrlib.errors import BzrCommandError
7
from bzrlib.delta import compare_trees
8
from trace import mutter, warning
13
from fetch import greedy_fetch
16
# comments from abentley on irc: merge happens in two stages, each
17
# of which generates a changeset object
19
# stage 1: generate OLD->OTHER,
20
# stage 2: use MINE and OLD->OTHER to generate MINE -> RESULT
22
class UnrelatedBranches(BzrCommandError):
24
msg = "Branches have no common ancestor, and no base revision"\
26
BzrCommandError.__init__(self, msg)
29
class MergeConflictHandler(ExceptionConflictHandler):
30
"""Handle conflicts encountered while merging.
32
This subclasses ExceptionConflictHandler, so that any types of
33
conflict that are not explicitly handled cause an exception and
36
def __init__(self, dir, ignore_zero=False):
37
ExceptionConflictHandler.__init__(self, dir)
39
self.ignore_zero = ignore_zero
41
def copy(self, source, dest):
42
"""Copy the text and mode of a file
43
:param source: The path of the file to copy
44
:param dest: The distination file to create
46
s_file = file(source, "rb")
47
d_file = file(dest, "wb")
50
os.chmod(dest, 0777 & os.stat(source).st_mode)
52
def dump(self, lines, dest):
53
"""Copy the text and mode of a file
54
:param source: The path of the file to copy
55
:param dest: The distination file to create
57
d_file = file(dest, "wb")
61
def add_suffix(self, name, suffix, last_new_name=None):
62
"""Rename a file to append a suffix. If the new name exists, the
63
suffix is added repeatedly until a non-existant name is found
65
:param name: The path of the file
66
:param suffix: The suffix to append
67
:param last_new_name: (used for recursive calls) the last name tried
69
if last_new_name is None:
71
new_name = last_new_name+suffix
73
os.rename(name, new_name)
76
if e.errno != errno.EEXIST and e.errno != errno.ENOTEMPTY:
78
return self.add_suffix(name, suffix, last_new_name=new_name)
80
def conflict(self, text):
85
def merge_conflict(self, new_file, this_path, base_lines, other_lines):
87
Handle diff3 conflicts by producing a .THIS, .BASE and .OTHER. The
88
main file will be a version with diff3 conflicts.
89
:param new_file: Path to the output file with diff3 markers
90
:param this_path: Path to the file text for the THIS tree
91
:param base_path: Path to the file text for the BASE tree
92
:param other_path: Path to the file text for the OTHER tree
94
self.add_suffix(this_path, ".THIS")
95
self.dump(base_lines, this_path+".BASE")
96
self.dump(other_lines, this_path+".OTHER")
97
os.rename(new_file, this_path)
98
self.conflict("Diff3 conflict encountered in %s" % this_path)
100
def new_contents_conflict(self, filename, other_contents):
101
"""Conflicting contents for newly added file."""
102
self.copy(other_contents, filename + ".OTHER")
103
self.conflict("Conflict in newly added file %s" % filename)
106
def target_exists(self, entry, target, old_path):
107
"""Handle the case when the target file or dir exists"""
108
moved_path = self.add_suffix(target, ".moved")
109
self.conflict("Moved existing %s to %s" % (target, moved_path))
111
def rmdir_non_empty(self, filename):
112
"""Handle the case where the dir to be removed still has contents"""
113
self.conflict("Directory %s not removed because it is not empty"\
118
if not self.ignore_zero:
119
print "%d conflicts encountered.\n" % self.conflicts
121
def get_tree(treespec, temp_root, label, local_branch=None):
122
location, revno = treespec
123
branch = find_branch(location)
125
base_tree = branch.working_tree()
128
revision = branch.last_patch()
130
revision = branch.lookup_revision(revno)
131
if local_branch is not None:
132
if revision is not None:
133
greedy_fetch(local_branch, branch, revision)
134
base_tree = local_branch.revision_tree(revision)
136
base_tree = branch.revision_tree(revision)
137
temp_path = os.path.join(temp_root, label)
139
return branch, MergeTree(base_tree, temp_path)
142
def file_exists(tree, file_id):
143
return tree.has_filename(tree.id2path(file_id))
146
class MergeTree(object):
147
def __init__(self, tree, tempdir):
148
object.__init__(self)
149
if hasattr(tree, "basedir"):
150
self.root = tree.basedir
154
self.tempdir = tempdir
155
os.mkdir(os.path.join(self.tempdir, "texts"))
159
return self.tree.__iter__()
161
def __contains__(self, file_id):
162
return file_id in self.tree
164
def get_file(self, file_id):
165
return self.tree.get_file(file_id)
167
def get_file_sha1(self, id):
168
return self.tree.get_file_sha1(id)
170
def id2path(self, file_id):
171
return self.tree.id2path(file_id)
173
def has_id(self, file_id):
174
return self.tree.has_id(file_id)
176
def readonly_path(self, id):
177
if id not in self.tree:
179
if self.root is not None:
180
return self.tree.abspath(self.tree.id2path(id))
182
if self.tree.inventory[id].kind in ("directory", "root_directory"):
184
if not self.cached.has_key(id):
185
path = os.path.join(self.tempdir, "texts", id)
186
outfile = file(path, "wb")
187
outfile.write(self.tree.get_file(id).read())
188
assert(os.path.exists(path))
189
self.cached[id] = path
190
return self.cached[id]
194
def merge(other_revision, base_revision,
195
check_clean=True, ignore_zero=False,
196
this_dir=None, backup_files=False, merge_type=ApplyMerge3,
198
"""Merge changes into a tree.
201
Base for three-way merge.
203
Other revision for three-way merge.
205
Directory to merge changes into; '.' by default.
207
If true, this_dir must have no uncommitted changes before the
209
all available ancestors of other_revision and base_revision are
210
automatically pulled into the branch.
212
tempdir = tempfile.mkdtemp(prefix="bzr-")
216
this_branch = find_branch(this_dir)
218
changes = compare_trees(this_branch.working_tree(),
219
this_branch.basis_tree(), False)
220
if changes.has_changed():
221
raise BzrCommandError("Working tree has uncommitted changes.")
222
other_branch, other_tree = get_tree(other_revision, tempdir, "other",
224
if base_revision == [None, None]:
225
if other_revision[1] == -1:
228
o_revno = other_revision[1]
229
base_revno = this_branch.common_ancestor(other_branch,
230
other_revno=o_revno)[0]
231
if base_revno is None:
232
raise UnrelatedBranches()
233
base_revision = ['.', base_revno]
234
base_branch, base_tree = get_tree(base_revision, tempdir, "base",
236
if file_list is None:
237
interesting_ids = None
239
interesting_ids = set()
240
this_tree = this_branch.working_tree()
241
for fname in file_list:
242
path = this_branch.relpath(fname)
244
for tree in (this_tree, base_tree.tree, other_tree.tree):
245
file_id = tree.inventory.path2id(path)
246
if file_id is not None:
247
interesting_ids.add(file_id)
250
raise BzrCommandError("%s is not a source file in any"
252
merge_inner(this_branch, other_tree, base_tree, tempdir,
253
ignore_zero=ignore_zero, backup_files=backup_files,
254
merge_type=merge_type, interesting_ids=interesting_ids)
256
shutil.rmtree(tempdir)
259
def set_interesting(inventory_a, inventory_b, interesting_ids):
260
"""Mark files whose ids are in interesting_ids as interesting
262
for inventory in (inventory_a, inventory_b):
263
for path, source_file in inventory.iteritems():
264
source_file.interesting = source_file.id in interesting_ids
267
def generate_cset_optimized(tree_a, tree_b, interesting_ids=None):
268
"""Generate a changeset. If interesting_ids is supplied, only changes
269
to those files will be shown. Metadata changes are stripped.
271
cset = generate_changeset(tree_a, tree_b, interesting_ids)
272
for entry in cset.entries.itervalues():
273
entry.metadata_change = None
277
def merge_inner(this_branch, other_tree, base_tree, tempdir,
278
ignore_zero=False, merge_type=ApplyMerge3, backup_files=False,
279
interesting_ids=None):
281
def merge_factory(file_id, base, other):
282
contents_change = merge_type(file_id, base, other)
284
contents_change = BackupBeforeChange(contents_change)
285
return contents_change
287
this_tree = get_tree((this_branch.base, None), tempdir, "this")[1]
289
def get_inventory(tree):
290
return tree.tree.inventory
292
inv_changes = merge_flex(this_tree, base_tree, other_tree,
293
generate_cset_optimized, get_inventory,
294
MergeConflictHandler(base_tree.root,
295
ignore_zero=ignore_zero),
296
merge_factory=merge_factory,
297
interesting_ids=interesting_ids)
300
for id, path in inv_changes.iteritems():
305
assert path.startswith('./'), "path is %s" % path
307
adjust_ids.append((path, id))
308
if len(adjust_ids) > 0:
309
this_branch.set_inventory(regen_inventory(this_branch, this_tree.root,
313
def regen_inventory(this_branch, root, new_entries):
314
old_entries = this_branch.read_working_inventory()
318
for path, file_id in new_entries:
321
new_entries_map[file_id] = path
323
def id2path(file_id):
324
path = new_entries_map.get(file_id)
327
entry = old_entries[file_id]
328
if entry.parent_id is None:
330
return os.path.join(id2path(entry.parent_id), entry.name)
332
for file_id in old_entries:
333
entry = old_entries[file_id]
334
path = id2path(file_id)
335
new_inventory[file_id] = (path, file_id, entry.parent_id, entry.kind)
336
by_path[path] = file_id
341
for path, file_id in new_entries:
343
del new_inventory[file_id]
346
new_path_list.append((path, file_id))
347
if file_id not in old_entries:
349
# Ensure no file is added before its parent
351
for path, file_id in new_path_list:
355
parent = by_path[os.path.dirname(path)]
356
kind = bzrlib.osutils.file_kind(os.path.join(root, path))
357
new_inventory[file_id] = (path, file_id, parent, kind)
358
by_path[path] = file_id
360
# Get a list in insertion order
361
new_inventory_list = new_inventory.values()
362
mutter ("""Inventory regeneration:
363
old length: %i insertions: %i deletions: %i new_length: %i"""\
364
% (len(old_entries), insertions, deletions, len(new_inventory_list)))
365
assert len(new_inventory_list) == len(old_entries) + insertions - deletions
366
new_inventory_list.sort()
367
return new_inventory_list
369
merge_types = { "merge3": (ApplyMerge3, "Native diff3-style merge"),
370
"diff3": (Diff3Merge, "Merge using external diff3")