20
from shutil import rmtree
21
from tempfile import mkdtemp
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
24
from bzrlib.branch import Branch
29
from bzrlib.errors import BzrCommandError, UnrelatedBranches, NoCommonAncestor
30
from bzrlib.errors import NoCommits
31
25
from bzrlib.delta import compare_trees
26
from bzrlib.errors import (BzrCommandError,
35
WorkingTreeNotRevision,
37
from bzrlib.merge3 import Merge3
39
from bzrlib.osutils import rename, pathjoin
40
from progress import DummyProgress
41
from bzrlib.revision import common_ancestor, is_ancestor, NULL_REVISION
42
from bzrlib.symbol_versioning import *
32
43
from bzrlib.trace import mutter, warning, note
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
42
# NOTABUG: merge is a helper for commandline functions. merge_inner is the
43
# the core functionality.
45
# comments from abentley on irc: merge happens in two stages, each
46
# of which generates a changeset object
48
# stage 1: generate OLD->OTHER,
49
# stage 2: use MINE and OLD->OTHER to generate MINE -> RESULT
51
class MergeConflictHandler(ExceptionConflictHandler):
52
"""Handle conflicts encountered while merging.
54
This subclasses ExceptionConflictHandler, so that any types of
55
conflict that are not explicitly handled cause an exception and
58
def __init__(self, this_tree, base_tree, other_tree, ignore_zero=False):
59
ExceptionConflictHandler.__init__(self)
61
self.ignore_zero = ignore_zero
62
self.this_tree = this_tree
63
self.base_tree = base_tree
64
self.other_tree = other_tree
66
def copy(self, source, 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
s_file = file(source, "rb")
72
d_file = file(dest, "wb")
75
os.chmod(dest, 0777 & os.stat(source).st_mode)
77
def dump(self, lines, dest):
78
"""Copy the text and mode of a file
79
:param source: The path of the file to copy
80
:param dest: The distination file to create
82
d_file = file(dest, "wb")
86
def add_suffix(self, name, suffix, last_new_name=None):
87
"""Rename a file to append a suffix. If the new name exists, the
88
suffix is added repeatedly until a non-existant name is found
90
:param name: The path of the file
91
:param suffix: The suffix to append
92
:param last_new_name: (used for recursive calls) the last name tried
94
if last_new_name is None:
96
new_name = last_new_name+suffix
98
rename(name, new_name)
101
if e.errno != errno.EEXIST and e.errno != errno.ENOTEMPTY:
103
return self.add_suffix(name, suffix, last_new_name=new_name)
105
def conflict(self, text):
110
def merge_conflict(self, new_file, this_path, base_lines, other_lines):
112
Handle diff3 conflicts by producing a .THIS, .BASE and .OTHER. The
113
main file will be a version with diff3 conflicts.
114
:param new_file: Path to the output file with diff3 markers
115
:param this_path: Path to the file text for the THIS tree
116
:param base_path: Path to the file text for the BASE tree
117
:param other_path: Path to the file text for the OTHER tree
119
self.add_suffix(this_path, ".THIS")
120
self.dump(base_lines, this_path+".BASE")
121
self.dump(other_lines, this_path+".OTHER")
122
rename(new_file, this_path)
123
self.conflict("Diff3 conflict encountered in %s" % this_path)
125
def new_contents_conflict(self, filename, other_contents):
126
"""Conflicting contents for newly added file."""
127
self.copy(other_contents, filename + ".OTHER")
128
self.conflict("Conflict in newly added file %s" % filename)
131
def target_exists(self, entry, target, old_path):
132
"""Handle the case when the target file or dir exists"""
133
moved_path = self.add_suffix(target, ".moved")
134
self.conflict("Moved existing %s to %s" % (target, moved_path))
136
def rmdir_non_empty(self, filename):
137
"""Handle the case where the dir to be removed still has contents"""
138
self.conflict("Directory %s not removed because it is not empty"\
142
def rem_contents_conflict(self, filename, this_contents, base_contents):
143
base_contents(filename+".BASE", self, False)
144
this_contents(filename+".THIS", self, False)
145
return ReplaceContents(this_contents, None)
147
def rem_contents_conflict(self, filename, this_contents, base_contents):
148
base_contents(filename+".BASE", self, False)
149
this_contents(filename+".THIS", self, False)
150
self.conflict("Other branch deleted locally modified file %s" %
152
return ReplaceContents(this_contents, None)
154
def abs_this_path(self, file_id):
155
"""Return the absolute path for a file_id in the this tree."""
156
relpath = self.this_tree.id2path(file_id)
157
return self.this_tree.tree.abspath(relpath)
159
def add_missing_parents(self, file_id, tree):
160
"""If some of the parents for file_id are missing, add them."""
161
entry = tree.tree.inventory[file_id]
162
if entry.parent_id not in self.this_tree:
163
return self.create_all_missing(entry.parent_id, tree)
165
return self.abs_this_path(entry.parent_id)
167
def create_all_missing(self, file_id, tree):
168
"""Add contents for a file_id and all its parents to a tree."""
169
entry = tree.tree.inventory[file_id]
170
if entry.parent_id is not None and entry.parent_id not in self.this_tree:
171
abspath = self.create_all_missing(entry.parent_id, tree)
173
abspath = self.abs_this_path(entry.parent_id)
174
entry_path = os.path.join(abspath, entry.name)
175
if not os.path.isdir(entry_path):
176
self.create(file_id, entry_path, tree)
179
def create(self, file_id, path, tree, reverse=False):
180
"""Uses tree data to create a filesystem object for the file_id"""
181
from merge_core import get_id_contents
182
get_id_contents(file_id, tree)(path, self, reverse)
184
def missing_for_merge(self, file_id, other_path):
185
"""The file_id doesn't exist in THIS, but does in OTHER and BASE"""
186
self.conflict("Other branch modified locally deleted file %s" %
188
parent_dir = self.add_missing_parents(file_id, self.other_tree)
189
stem = os.path.join(parent_dir, os.path.basename(other_path))
190
self.create(file_id, stem+".OTHER", self.other_tree)
191
self.create(file_id, stem+".BASE", self.base_tree)
194
if not self.ignore_zero:
195
note("%d conflicts encountered.\n" % self.conflicts)
197
def get_tree(treespec, temp_root, label, local_branch=None):
44
from bzrlib.transform import (TreeTransform, resolve_conflicts, cook_conflicts,
45
conflicts_strings, FinalPaths, create_by_entry,
48
# TODO: Report back as changes are merged in
50
def _get_tree(treespec, local_branch=None):
198
51
location, revno = treespec
199
branch = Branch.open_containing(location)
52
branch = Branch.open_containing(location)[0]
203
56
revision = branch.last_revision()
205
58
revision = branch.get_rev_id(revno)
206
return branch, get_revid_tree(branch, revision, temp_root, label,
209
def get_revid_tree(branch, revision, temp_root, label, local_branch):
60
revision = NULL_REVISION
61
return branch, _get_revid_tree(branch, revision, local_branch)
64
def _get_revid_tree(branch, revision, local_branch):
210
65
if revision is None:
211
base_tree = branch.working_tree()
66
base_tree = branch.bzrdir.open_workingtree()
213
68
if local_branch is not None:
214
greedy_fetch(local_branch, branch, revision)
215
base_tree = local_branch.revision_tree(revision)
69
if local_branch.base != branch.base:
70
local_branch.fetch(branch, revision)
71
base_tree = local_branch.repository.revision_tree(revision)
217
base_tree = branch.revision_tree(revision)
218
temp_path = os.path.join(temp_root, label)
220
return MergeTree(base_tree, temp_path)
223
def file_exists(tree, file_id):
224
return tree.has_filename(tree.id2path(file_id))
227
class MergeTree(object):
228
def __init__(self, tree, tempdir):
73
base_tree = branch.repository.revision_tree(revision)
77
def transform_tree(from_tree, to_tree, interesting_ids=None):
78
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
79
interesting_ids=interesting_ids, this_tree=from_tree)
83
def __init__(self, this_branch, other_tree=None, base_tree=None,
84
this_tree=None, pb=DummyProgress()):
229
85
object.__init__(self)
230
if hasattr(tree, "basedir"):
231
self.root = tree.basedir
235
self.tempdir = tempdir
236
os.mkdir(os.path.join(self.tempdir, "texts"))
237
os.mkdir(os.path.join(self.tempdir, "symlinks"))
241
return self.tree.__iter__()
243
def __contains__(self, file_id):
244
return file_id in self.tree
246
def get_file(self, file_id):
247
return self.tree.get_file(file_id)
249
def get_file_sha1(self, id):
250
return self.tree.get_file_sha1(id)
252
def is_executable(self, id):
253
return self.tree.is_executable(id)
255
def id2path(self, file_id):
256
return self.tree.id2path(file_id)
258
def has_id(self, file_id):
259
return self.tree.has_id(file_id)
261
def has_or_had_id(self, file_id):
262
if file_id == self.tree.inventory.root.file_id:
264
return self.tree.inventory.has_id(file_id)
266
def has_or_had_id(self, file_id):
267
if file_id == self.tree.inventory.root.file_id:
269
return self.tree.inventory.has_id(file_id)
271
def readonly_path(self, id):
272
if id not in self.tree:
274
if self.root is not None:
275
return self.tree.abspath(self.tree.id2path(id))
277
kind = self.tree.inventory[id].kind
278
if kind in ("directory", "root_directory"):
280
if not self.cached.has_key(id):
282
path = os.path.join(self.tempdir, "texts", id)
283
outfile = file(path, "wb")
284
outfile.write(self.tree.get_file(id).read())
285
assert(bzrlib.osutils.lexists(path))
286
if self.tree.is_executable(id):
289
assert kind == "symlink"
290
path = os.path.join(self.tempdir, "symlinks", id)
291
target = self.tree.get_symlink_target(id)
292
os.symlink(target, path)
293
self.cached[id] = path
294
return self.cached[id]
297
def build_working_dir(to_dir):
298
"""Build a working directory in an empty directory.
300
to_dir is a directory containing branch metadata but no working files,
301
typically constructed by cloning an existing branch.
303
This is split out as a special idiomatic case of merge. It could
304
eventually be done by just building the tree directly calling into
305
lower-level code (e.g. constructing a changeset).
307
merge((to_dir, -1), (to_dir, 0), this_dir=to_dir,
308
check_clean=False, ignore_zero=True)
311
def merge(other_revision, base_revision,
312
check_clean=True, ignore_zero=False,
313
this_dir=None, backup_files=False, merge_type=ApplyMerge3,
315
"""Merge changes into a tree.
318
tuple(path, revision) Base for three-way merge.
320
tuple(path, revision) Other revision for three-way merge.
322
Directory to merge changes into; '.' by default.
324
If true, this_dir must have no uncommitted changes before the
326
ignore_zero - If true, suppress the "zero conflicts" message when
327
there are no conflicts; should be set when doing something we expect
328
to complete perfectly.
330
All available ancestors of other_revision and base_revision are
331
automatically pulled into the branch.
333
tempdir = tempfile.mkdtemp(prefix="bzr-")
337
this_branch = Branch.open_containing(this_dir)
338
this_rev_id = this_branch.last_revision()
339
if this_rev_id is None:
86
assert this_tree is not None, "this_tree is required"
87
self.this_branch = this_branch
88
self.this_basis = this_branch.last_revision()
89
self.this_rev_id = None
90
self.this_tree = this_tree
91
self.this_revision_tree = None
92
self.this_basis_tree = None
93
self.other_tree = other_tree
94
self.base_tree = base_tree
95
self.ignore_zero = False
96
self.backup_files = False
97
self.interesting_ids = None
98
self.show_base = False
99
self.reprocess = False
102
def revision_tree(self, revision_id):
103
return self.this_branch.repository.revision_tree(revision_id)
105
def ensure_revision_trees(self):
106
if self.this_revision_tree is None:
107
self.this_basis_tree = self.this_branch.repository.revision_tree(
109
if self.this_basis == self.this_rev_id:
110
self.this_revision_tree = self.this_basis_tree
112
if self.other_rev_id is None:
113
other_basis_tree = self.revision_tree(self.other_basis)
114
changes = compare_trees(self.other_tree, other_basis_tree)
115
if changes.has_changed():
116
raise WorkingTreeNotRevision(self.this_tree)
117
other_rev_id = other_basis
118
self.other_tree = other_basis_tree
120
def file_revisions(self, file_id):
121
self.ensure_revision_trees()
122
def get_id(tree, file_id):
123
revision_id = tree.inventory[file_id].revision
124
assert revision_id is not None
126
if self.this_rev_id is None:
127
if self.this_basis_tree.get_file_sha1(file_id) != \
128
self.this_tree.get_file_sha1(file_id):
129
raise WorkingTreeNotRevision(self.this_tree)
131
trees = (self.this_basis_tree, self.other_tree)
132
return [get_id(tree, file_id) for tree in trees]
134
def check_basis(self, check_clean):
135
if self.this_basis is None:
340
136
raise BzrCommandError("This branch has no commits")
342
changes = compare_trees(this_branch.working_tree(),
343
this_branch.basis_tree(), False)
344
if changes.has_changed():
139
if self.this_basis != self.this_rev_id:
345
140
raise BzrCommandError("Working tree has uncommitted changes.")
346
other_branch, other_tree = get_tree(other_revision, tempdir, "other",
142
def compare_basis(self):
143
changes = compare_trees(self.this_tree,
144
self.this_tree.basis_tree(), False)
145
if not changes.has_changed():
146
self.this_rev_id = self.this_basis
148
def set_interesting_files(self, file_list):
150
self._set_interesting_files(file_list)
151
except NotVersionedError, e:
152
raise BzrCommandError("%s is not a source file in any"
155
def _set_interesting_files(self, file_list):
156
"""Set the list of interesting ids from a list of files."""
157
if file_list is None:
158
self.interesting_ids = None
161
interesting_ids = set()
162
for path in file_list:
164
for tree in (self.this_tree, self.base_tree, self.other_tree):
165
file_id = tree.inventory.path2id(path)
166
if file_id is not None:
167
interesting_ids.add(file_id)
170
raise NotVersionedError(path=path)
171
self.interesting_ids = interesting_ids
173
def set_pending(self):
174
if not self.base_is_ancestor:
176
if self.other_rev_id is None:
178
ancestry = self.this_branch.repository.get_ancestry(self.this_basis)
179
if self.other_rev_id in ancestry:
181
self.this_tree.add_pending_merge(self.other_rev_id)
183
def set_other(self, other_revision):
184
other_branch, self.other_tree = _get_tree(other_revision,
348
186
if other_revision[1] == -1:
349
other_rev_id = other_branch.last_revision()
350
if other_rev_id is None:
187
self.other_rev_id = other_branch.last_revision()
188
if self.other_rev_id is None:
351
189
raise NoCommits(other_branch)
352
other_basis = other_rev_id
190
self.other_basis = self.other_rev_id
353
191
elif other_revision[1] is not None:
354
other_rev_id = other_branch.get_rev_id(other_revision[1])
355
other_basis = other_rev_id
192
self.other_rev_id = other_branch.get_rev_id(other_revision[1])
193
self.other_basis = self.other_rev_id
358
other_basis = other_branch.last_revision()
359
if other_basis is None:
195
self.other_rev_id = None
196
self.other_basis = other_branch.last_revision()
197
if self.other_basis is None:
360
198
raise NoCommits(other_branch)
199
if other_branch.base != self.this_branch.base:
200
self.this_branch.fetch(other_branch, last_revision=self.other_basis)
202
def set_base(self, base_revision):
203
mutter("doing merge() with no base_revision specified")
361
204
if base_revision == [None, None]:
363
base_rev_id = common_ancestor(this_rev_id, other_basis,
206
self.base_rev_id = common_ancestor(self.this_basis,
208
self.this_branch.repository,
365
210
except NoCommonAncestor:
366
211
raise UnrelatedBranches()
367
base_tree = get_revid_tree(this_branch, base_rev_id, tempdir,
369
base_is_ancestor = True
212
self.base_tree = _get_revid_tree(self.this_branch, self.base_rev_id,
214
self.base_is_ancestor = True
371
base_branch, base_tree = get_tree(base_revision, tempdir, "base")
216
base_branch, self.base_tree = _get_tree(base_revision)
372
217
if base_revision[1] == -1:
373
base_rev_id = base_branch.last_revision()
218
self.base_rev_id = base_branch.last_revision()
374
219
elif base_revision[1] is None:
377
base_rev_id = base_branch.get_rev_id(base_revision[1])
378
fetch(from_branch=base_branch, to_branch=this_branch)
379
base_is_ancestor = is_ancestor(this_rev_id, base_rev_id,
381
if file_list is None:
382
interesting_ids = None
384
interesting_ids = set()
385
this_tree = this_branch.working_tree()
386
for fname in file_list:
387
path = this_branch.relpath(fname)
389
for tree in (this_tree, base_tree.tree, other_tree.tree):
390
file_id = tree.inventory.path2id(path)
220
self.base_rev_id = None
222
self.base_rev_id = base_branch.get_rev_id(base_revision[1])
223
self.this_branch.fetch(base_branch)
224
self.base_is_ancestor = is_ancestor(self.this_basis,
229
kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
230
'other_tree': self.other_tree}
231
if self.merge_type.requires_base:
232
kwargs['base_tree'] = self.base_tree
233
if self.merge_type.supports_reprocess:
234
kwargs['reprocess'] = self.reprocess
236
raise BzrError("Reprocess is not supported for this merge"
237
" type. %s" % merge_type)
238
if self.merge_type.supports_show_base:
239
kwargs['show_base'] = self.show_base
241
raise BzrError("Showing base is not supported for this"
242
" merge type. %s" % self.merge_type)
243
merge = self.merge_type(pb=self._pb, **kwargs)
244
if len(merge.cooked_conflicts) == 0:
245
if not self.ignore_zero:
246
note("All changes applied successfully.")
248
note("%d conflicts encountered." % len(merge.cooked_conflicts))
250
return len(merge.cooked_conflicts)
252
def regen_inventory(self, new_entries):
253
old_entries = self.this_tree.read_working_inventory()
257
for path, file_id in new_entries:
260
new_entries_map[file_id] = path
262
def id2path(file_id):
263
path = new_entries_map.get(file_id)
266
entry = old_entries[file_id]
267
if entry.parent_id is None:
269
return pathjoin(id2path(entry.parent_id), entry.name)
271
for file_id in old_entries:
272
entry = old_entries[file_id]
273
path = id2path(file_id)
274
new_inventory[file_id] = (path, file_id, entry.parent_id,
276
by_path[path] = file_id
281
for path, file_id in new_entries:
283
del new_inventory[file_id]
286
new_path_list.append((path, file_id))
287
if file_id not in old_entries:
289
# Ensure no file is added before its parent
291
for path, file_id in new_path_list:
295
parent = by_path[os.path.dirname(path)]
296
abspath = pathjoin(self.this_tree.basedir, path)
297
kind = bzrlib.osutils.file_kind(abspath)
298
new_inventory[file_id] = (path, file_id, parent, kind)
299
by_path[path] = file_id
301
# Get a list in insertion order
302
new_inventory_list = new_inventory.values()
303
mutter ("""Inventory regeneration:
304
old length: %i insertions: %i deletions: %i new_length: %i"""\
305
% (len(old_entries), insertions, deletions,
306
len(new_inventory_list)))
307
assert len(new_inventory_list) == len(old_entries) + insertions\
309
new_inventory_list.sort()
310
return new_inventory_list
313
class Merge3Merger(object):
314
"""Three-way merger that uses the merge3 text merger"""
316
supports_reprocess = True
317
supports_show_base = True
318
history_based = False
320
def __init__(self, working_tree, this_tree, base_tree, other_tree,
321
reprocess=False, show_base=False, pb=DummyProgress()):
322
"""Initialize the merger object and perform the merge."""
323
object.__init__(self)
324
self.this_tree = working_tree
325
self.base_tree = base_tree
326
self.other_tree = other_tree
327
self._raw_conflicts = []
328
self.cooked_conflicts = []
329
self.reprocess = reprocess
330
self.show_base = show_base
333
all_ids = set(base_tree)
334
all_ids.update(other_tree)
335
self.tt = TreeTransform(working_tree, self.pb)
337
for num, file_id in enumerate(all_ids):
338
self.pb.update('Preparing file merge', num+1, len(all_ids))
339
self.merge_names(file_id)
340
file_status = self.merge_contents(file_id)
341
self.merge_executable(file_id, file_status)
344
fs_conflicts = resolve_conflicts(self.tt, self.pb)
345
self.cook_conflicts(fs_conflicts)
346
for line in conflicts_strings(self.cooked_conflicts):
356
def parent(entry, file_id):
357
"""Determine the parent for a file_id (used as a key method)"""
360
return entry.parent_id
363
def name(entry, file_id):
364
"""Determine the name for a file_id (used as a key method)"""
370
def contents_sha1(tree, file_id):
371
"""Determine the sha1 of the file contents (used as a key method)."""
372
if file_id not in tree:
374
return tree.get_file_sha1(file_id)
377
def executable(tree, file_id):
378
"""Determine the executability of a file-id (used as a key method)."""
379
if file_id not in tree:
381
if tree.kind(file_id) != "file":
383
return tree.is_executable(file_id)
386
def kind(tree, file_id):
387
"""Determine the kind of a file-id (used as a key method)."""
388
if file_id not in tree:
390
return tree.kind(file_id)
393
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
394
"""Do a three-way test on a scalar.
395
Return "this", "other" or "conflict", depending whether a value wins.
397
key_base = key(base_tree, file_id)
398
key_other = key(other_tree, file_id)
399
#if base == other, either they all agree, or only THIS has changed.
400
if key_base == key_other:
402
key_this = key(this_tree, file_id)
403
if key_this not in (key_base, key_other):
405
# "Ambiguous clean merge"
406
elif key_this == key_other:
409
assert key_this == key_base
412
def merge_names(self, file_id):
413
"""Perform a merge on file_id names and parents"""
415
if file_id in tree.inventory:
416
return tree.inventory[file_id]
419
this_entry = get_entry(self.this_tree)
420
other_entry = get_entry(self.other_tree)
421
base_entry = get_entry(self.base_tree)
422
name_winner = self.scalar_three_way(this_entry, base_entry,
423
other_entry, file_id, self.name)
424
parent_id_winner = self.scalar_three_way(this_entry, base_entry,
425
other_entry, file_id,
427
if this_entry is None:
428
if name_winner == "this":
429
name_winner = "other"
430
if parent_id_winner == "this":
431
parent_id_winner = "other"
432
if name_winner == "this" and parent_id_winner == "this":
434
if name_winner == "conflict":
435
trans_id = self.tt.trans_id_file_id(file_id)
436
self._raw_conflicts.append(('name conflict', trans_id,
437
self.name(this_entry, file_id),
438
self.name(other_entry, file_id)))
439
if parent_id_winner == "conflict":
440
trans_id = self.tt.trans_id_file_id(file_id)
441
self._raw_conflicts.append(('parent conflict', trans_id,
442
self.parent(this_entry, file_id),
443
self.parent(other_entry, file_id)))
444
if other_entry is None:
445
# it doesn't matter whether the result was 'other' or
446
# 'conflict'-- if there's no 'other', we leave it alone.
448
# if we get here, name_winner and parent_winner are set to safe values.
449
winner_entry = {"this": this_entry, "other": other_entry,
450
"conflict": other_entry}
451
trans_id = self.tt.trans_id_file_id(file_id)
452
parent_id = winner_entry[parent_id_winner].parent_id
453
parent_trans_id = self.tt.trans_id_file_id(parent_id)
454
self.tt.adjust_path(winner_entry[name_winner].name, parent_trans_id,
457
def merge_contents(self, file_id):
458
"""Performa a merge on file_id contents."""
459
def contents_pair(tree):
460
if file_id not in tree:
462
kind = tree.kind(file_id)
463
if kind == "root_directory":
466
contents = tree.get_file_sha1(file_id)
467
elif kind == "symlink":
468
contents = tree.get_symlink_target(file_id)
471
return kind, contents
472
# See SPOT run. run, SPOT, run.
473
# So we're not QUITE repeating ourselves; we do tricky things with
475
base_pair = contents_pair(self.base_tree)
476
other_pair = contents_pair(self.other_tree)
477
if base_pair == other_pair:
478
# OTHER introduced no changes
480
this_pair = contents_pair(self.this_tree)
481
if this_pair == other_pair:
482
# THIS and OTHER introduced the same changes
485
trans_id = self.tt.trans_id_file_id(file_id)
486
if this_pair == base_pair:
487
# only OTHER introduced changes
488
if file_id in self.this_tree:
489
# Remove any existing contents
490
self.tt.delete_contents(trans_id)
491
if file_id in self.other_tree:
492
# OTHER changed the file
493
create_by_entry(self.tt,
494
self.other_tree.inventory[file_id],
495
self.other_tree, trans_id)
496
if file_id not in self.this_tree.inventory:
497
self.tt.version_file(file_id, trans_id)
499
elif file_id in self.this_tree.inventory:
500
# OTHER deleted the file
501
self.tt.unversion_file(trans_id)
503
#BOTH THIS and OTHER introduced changes; scalar conflict
504
elif this_pair[0] == "file" and other_pair[0] == "file":
505
# THIS and OTHER are both files, so text merge. Either
506
# BASE is a file, or both converted to files, so at least we
507
# have agreement that output should be a file.
508
if file_id not in self.this_tree.inventory:
509
self.tt.version_file(file_id, trans_id)
510
self.text_merge(file_id, trans_id)
512
self.tt.tree_kind(trans_id)
513
self.tt.delete_contents(trans_id)
518
# Scalar conflict, can't text merge. Dump conflicts
519
trans_id = self.tt.trans_id_file_id(file_id)
520
name = self.tt.final_name(trans_id)
521
parent_id = self.tt.final_parent(trans_id)
522
if file_id in self.this_tree.inventory:
523
self.tt.unversion_file(trans_id)
524
self.tt.delete_contents(trans_id)
525
file_group = self._dump_conflicts(name, parent_id, file_id,
527
self._raw_conflicts.append(('contents conflict', file_group))
529
def get_lines(self, tree, file_id):
530
"""Return the lines in a file, or an empty list."""
532
return tree.get_file(file_id).readlines()
536
def text_merge(self, file_id, trans_id):
537
"""Perform a three-way text merge on a file_id"""
538
# it's possible that we got here with base as a different type.
539
# if so, we just want two-way text conflicts.
540
if file_id in self.base_tree and \
541
self.base_tree.kind(file_id) == "file":
542
base_lines = self.get_lines(self.base_tree, file_id)
545
other_lines = self.get_lines(self.other_tree, file_id)
546
this_lines = self.get_lines(self.this_tree, file_id)
547
m3 = Merge3(base_lines, this_lines, other_lines)
548
start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
549
if self.show_base is True:
550
base_marker = '|' * 7
554
def iter_merge3(retval):
555
retval["text_conflicts"] = False
556
for line in m3.merge_lines(name_a = "TREE",
557
name_b = "MERGE-SOURCE",
558
name_base = "BASE-REVISION",
559
start_marker=start_marker,
560
base_marker=base_marker,
561
reprocess=self.reprocess):
562
if line.startswith(start_marker):
563
retval["text_conflicts"] = True
564
yield line.replace(start_marker, '<' * 7)
568
merge3_iterator = iter_merge3(retval)
569
self.tt.create_file(merge3_iterator, trans_id)
570
if retval["text_conflicts"] is True:
571
self._raw_conflicts.append(('text conflict', trans_id))
572
name = self.tt.final_name(trans_id)
573
parent_id = self.tt.final_parent(trans_id)
574
file_group = self._dump_conflicts(name, parent_id, file_id,
575
this_lines, base_lines,
577
file_group.append(trans_id)
579
def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
580
base_lines=None, other_lines=None, set_version=False,
582
"""Emit conflict files.
583
If this_lines, base_lines, or other_lines are omitted, they will be
584
determined automatically. If set_version is true, the .OTHER, .THIS
585
or .BASE (in that order) will be created as versioned files.
587
data = [('OTHER', self.other_tree, other_lines),
588
('THIS', self.this_tree, this_lines)]
590
data.append(('BASE', self.base_tree, base_lines))
593
for suffix, tree, lines in data:
595
trans_id = self._conflict_file(name, parent_id, tree, file_id,
597
file_group.append(trans_id)
598
if set_version and not versioned:
599
self.tt.version_file(file_id, trans_id)
603
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
605
"""Emit a single conflict file."""
606
name = name + '.' + suffix
607
trans_id = self.tt.create_path(name, parent_id)
608
entry = tree.inventory[file_id]
609
create_by_entry(self.tt, entry, tree, trans_id, lines)
612
def merge_executable(self, file_id, file_status):
613
"""Perform a merge on the execute bit."""
614
if file_status == "deleted":
616
trans_id = self.tt.trans_id_file_id(file_id)
618
if self.tt.final_kind(trans_id) != "file":
622
winner = self.scalar_three_way(self.this_tree, self.base_tree,
623
self.other_tree, file_id,
625
if winner == "conflict":
626
# There must be a None in here, if we have a conflict, but we
627
# need executability since file status was not deleted.
628
if self.other_tree.is_executable(file_id) is None:
633
if file_status == "modified":
634
executability = self.this_tree.is_executable(file_id)
635
if executability is not None:
636
trans_id = self.tt.trans_id_file_id(file_id)
637
self.tt.set_executability(executability, trans_id)
639
assert winner == "other"
640
if file_id in self.other_tree:
641
executability = self.other_tree.is_executable(file_id)
642
elif file_id in self.this_tree:
643
executability = self.this_tree.is_executable(file_id)
644
elif file_id in self.base_tree:
645
executability = self.base_tree.is_executable(file_id)
646
if executability is not None:
647
trans_id = self.tt.trans_id_file_id(file_id)
648
self.tt.set_executability(executability, trans_id)
650
def cook_conflicts(self, fs_conflicts):
651
"""Convert all conflicts into a form that doesn't depend on trans_id"""
653
self.cooked_conflicts.extend(cook_conflicts(fs_conflicts, self.tt))
654
fp = FinalPaths(self.tt)
655
for conflict in self._raw_conflicts:
656
conflict_type = conflict[0]
657
if conflict_type in ('name conflict', 'parent conflict'):
658
trans_id = conflict[1]
659
conflict_args = conflict[2:]
660
if trans_id not in name_conflicts:
661
name_conflicts[trans_id] = {}
662
unique_add(name_conflicts[trans_id], conflict_type,
664
if conflict_type == 'contents conflict':
665
for trans_id in conflict[1]:
666
file_id = self.tt.final_file_id(trans_id)
391
667
if file_id is not None:
392
interesting_ids.add(file_id)
395
raise BzrCommandError("%s is not a source file in any"
397
merge_inner(this_branch, other_tree, base_tree, tempdir,
398
ignore_zero=ignore_zero, backup_files=backup_files,
399
merge_type=merge_type, interesting_ids=interesting_ids)
400
if base_is_ancestor and other_rev_id is not None\
401
and other_rev_id not in this_branch.revision_history():
402
this_branch.add_pending_merge(other_rev_id)
404
shutil.rmtree(tempdir)
407
def set_interesting(inventory_a, inventory_b, interesting_ids):
408
"""Mark files whose ids are in interesting_ids as interesting
410
for inventory in (inventory_a, inventory_b):
411
for path, source_file in inventory.iteritems():
412
source_file.interesting = source_file.id in interesting_ids
415
def merge_inner(this_branch, other_tree, base_tree, tempdir,
416
ignore_zero=False, merge_type=ApplyMerge3, backup_files=False,
417
interesting_ids=None):
419
def merge_factory(file_id, base, other):
420
contents_change = merge_type(file_id, base, other)
422
contents_change = BackupBeforeChange(contents_change)
423
return contents_change
425
this_tree = get_tree((this_branch.base, None), tempdir, "this")[1]
427
def get_inventory(tree):
428
return tree.tree.inventory
430
inv_changes = merge_flex(this_tree, base_tree, other_tree,
431
generate_changeset, get_inventory,
432
MergeConflictHandler(this_tree, base_tree,
433
other_tree, ignore_zero=ignore_zero),
434
merge_factory=merge_factory,
435
interesting_ids=interesting_ids)
438
for id, path in inv_changes.iteritems():
669
path = fp.get_path(trans_id)
670
for suffix in ('.BASE', '.THIS', '.OTHER'):
671
if path.endswith(suffix):
672
path = path[:-len(suffix)]
674
self.cooked_conflicts.append((conflict_type, file_id, path))
675
if conflict_type == 'text conflict':
676
trans_id = conflict[1]
677
path = fp.get_path(trans_id)
678
file_id = self.tt.final_file_id(trans_id)
679
self.cooked_conflicts.append((conflict_type, file_id, path))
681
for trans_id, conflicts in name_conflicts.iteritems():
683
this_parent, other_parent = conflicts['parent conflict']
684
assert this_parent != other_parent
686
this_parent = other_parent = \
687
self.tt.final_file_id(self.tt.final_parent(trans_id))
689
this_name, other_name = conflicts['name conflict']
690
assert this_name != other_name
692
this_name = other_name = self.tt.final_name(trans_id)
693
other_path = fp.get_path(trans_id)
694
if this_parent is not None:
696
fp.get_path(self.tt.trans_id_file_id(this_parent))
697
this_path = pathjoin(this_parent_path, this_name)
443
assert path.startswith('.' + os.sep), "path is %s" % path
445
adjust_ids.append((path, id))
446
if len(adjust_ids) > 0:
447
this_branch.set_inventory(regen_inventory(this_branch, this_tree.root,
451
def regen_inventory(this_branch, root, new_entries):
452
old_entries = this_branch.read_working_inventory()
456
for path, file_id in new_entries:
459
new_entries_map[file_id] = path
461
def id2path(file_id):
462
path = new_entries_map.get(file_id)
465
entry = old_entries[file_id]
466
if entry.parent_id is None:
468
return os.path.join(id2path(entry.parent_id), entry.name)
470
for file_id in old_entries:
471
entry = old_entries[file_id]
472
path = id2path(file_id)
473
new_inventory[file_id] = (path, file_id, entry.parent_id, entry.kind)
474
by_path[path] = file_id
479
for path, file_id in new_entries:
481
del new_inventory[file_id]
484
new_path_list.append((path, file_id))
485
if file_id not in old_entries:
487
# Ensure no file is added before its parent
489
for path, file_id in new_path_list:
493
parent = by_path[os.path.dirname(path)]
494
kind = bzrlib.osutils.file_kind(os.path.join(root, path))
495
new_inventory[file_id] = (path, file_id, parent, kind)
496
by_path[path] = file_id
498
# Get a list in insertion order
499
new_inventory_list = new_inventory.values()
500
mutter ("""Inventory regeneration:
501
old length: %i insertions: %i deletions: %i new_length: %i"""\
502
% (len(old_entries), insertions, deletions, len(new_inventory_list)))
503
assert len(new_inventory_list) == len(old_entries) + insertions - deletions
504
new_inventory_list.sort()
505
return new_inventory_list
507
merge_types = { "merge3": (ApplyMerge3, "Native diff3-style merge"),
508
"diff3": (Diff3Merge, "Merge using external diff3")
699
this_path = "<deleted>"
700
file_id = self.tt.final_file_id(trans_id)
701
self.cooked_conflicts.append(('path conflict', file_id, this_path,
705
class WeaveMerger(Merge3Merger):
706
"""Three-way tree merger, text weave merger."""
707
supports_reprocess = False
708
supports_show_base = False
710
def __init__(self, working_tree, this_tree, base_tree, other_tree,
712
self.this_revision_tree = self._get_revision_tree(this_tree)
713
self.other_revision_tree = self._get_revision_tree(other_tree)
714
super(WeaveMerger, self).__init__(working_tree, this_tree,
715
base_tree, other_tree, pb=pb)
717
def _get_revision_tree(self, tree):
718
"""Return a revision tree releated to this tree.
719
If the tree is a WorkingTree, the basis will be returned.
721
if getattr(tree, 'get_weave', False) is False:
722
# If we have a WorkingTree, try using the basis
723
return tree.branch.basis_tree()
727
def _check_file(self, file_id):
728
"""Check that the revision tree's version of the file matches."""
729
for tree, rt in ((self.this_tree, self.this_revision_tree),
730
(self.other_tree, self.other_revision_tree)):
733
if tree.get_file_sha1(file_id) != rt.get_file_sha1(file_id):
734
raise WorkingTreeNotRevision(self.this_tree)
736
def _merged_lines(self, file_id):
737
"""Generate the merged lines.
738
There is no distinction between lines that are meant to contain <<<<<<<
741
weave = self.this_revision_tree.get_weave(file_id)
742
this_revision_id = self.this_revision_tree.inventory[file_id].revision
743
other_revision_id = \
744
self.other_revision_tree.inventory[file_id].revision
745
this_i = weave.lookup(this_revision_id)
746
other_i = weave.lookup(other_revision_id)
747
plan = weave.plan_merge(this_i, other_i)
748
return weave.weave_merge(plan)
750
def text_merge(self, file_id, trans_id):
751
"""Perform a (weave) text merge for a given file and file-id.
752
If conflicts are encountered, .THIS and .OTHER files will be emitted,
753
and a conflict will be noted.
755
self._check_file(file_id)
756
lines = self._merged_lines(file_id)
757
conflicts = '<<<<<<<\n' in lines
758
self.tt.create_file(lines, trans_id)
760
self._raw_conflicts.append(('text conflict', trans_id))
761
name = self.tt.final_name(trans_id)
762
parent_id = self.tt.final_parent(trans_id)
763
file_group = self._dump_conflicts(name, parent_id, file_id,
765
file_group.append(trans_id)
768
class Diff3Merger(Merge3Merger):
769
"""Three-way merger using external diff3 for text merging"""
770
def dump_file(self, temp_dir, name, tree, file_id):
771
out_path = pathjoin(temp_dir, name)
772
out_file = file(out_path, "wb")
773
in_file = tree.get_file(file_id)
778
def text_merge(self, file_id, trans_id):
779
"""Perform a diff3 merge using a specified file-id and trans-id.
780
If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
781
will be dumped, and a will be conflict noted.
784
temp_dir = mkdtemp(prefix="bzr-")
786
new_file = pathjoin(temp_dir, "new")
787
this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
788
base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
789
other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
790
status = bzrlib.patch.diff3(new_file, this, base, other)
791
if status not in (0, 1):
792
raise BzrError("Unhandled diff3 exit code")
793
self.tt.create_file(file(new_file, "rb"), trans_id)
795
name = self.tt.final_name(trans_id)
796
parent_id = self.tt.final_parent(trans_id)
797
self._dump_conflicts(name, parent_id, file_id)
798
self._raw_conflicts.append(('text conflict', trans_id))
803
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
805
merge_type=Merge3Merger,
806
interesting_ids=None,
810
interesting_files=None,
813
"""Primary interface for merging.
815
typical use is probably
816
'merge_inner(branch, branch.get_revision_tree(other_revision),
817
branch.get_revision_tree(base_revision))'
819
if this_tree is None:
820
warn("bzrlib.merge.merge_inner requires a this_tree parameter as of "
821
"bzrlib version 0.8.",
824
this_tree = this_branch.bzrdir.open_workingtree()
825
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
827
merger.backup_files = backup_files
828
merger.merge_type = merge_type
829
merger.interesting_ids = interesting_ids
830
if interesting_files:
831
assert not interesting_ids, ('Only supply interesting_ids'
832
' or interesting_files')
833
merger._set_interesting_files(interesting_files)
834
merger.show_base = show_base
835
merger.reprocess = reprocess
836
merger.other_rev_id = other_rev_id
837
merger.other_basis = other_rev_id
838
return merger.do_merge()
841
merge_types = { "merge3": (Merge3Merger, "Native diff3-style merge"),
842
"diff3": (Diff3Merger, "Merge using external diff3"),
843
'weave': (WeaveMerger, "Weave-based merge")