1
# Copyright (C) 2005 Canonical Ltd
1
# Copyright (C) 2005, 2006 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
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 find_branch
30
from bzrlib.errors import BzrCommandError, UnrelatedBranches
31
from bzrlib.delta import compare_trees
32
from bzrlib.trace import mutter, warning
33
from bzrlib.fetch import greedy_fetch
34
from bzrlib.revision import is_ancestor
36
# comments from abentley on irc: merge happens in two stages, each
37
# of which generates a changeset object
39
# stage 1: generate OLD->OTHER,
40
# stage 2: use MINE and OLD->OTHER to generate MINE -> RESULT
42
class MergeConflictHandler(ExceptionConflictHandler):
43
"""Handle conflicts encountered while merging.
45
This subclasses ExceptionConflictHandler, so that any types of
46
conflict that are not explicitly handled cause an exception and
49
def __init__(self, dir, ignore_zero=False):
50
ExceptionConflictHandler.__init__(self, dir)
52
self.ignore_zero = ignore_zero
54
def copy(self, source, dest):
55
"""Copy the text and mode of a file
56
:param source: The path of the file to copy
57
:param dest: The distination file to create
59
s_file = file(source, "rb")
60
d_file = file(dest, "wb")
63
os.chmod(dest, 0777 & os.stat(source).st_mode)
65
def dump(self, lines, dest):
66
"""Copy the text and mode of a file
67
:param source: The path of the file to copy
68
:param dest: The distination file to create
70
d_file = file(dest, "wb")
74
def add_suffix(self, name, suffix, last_new_name=None):
75
"""Rename a file to append a suffix. If the new name exists, the
76
suffix is added repeatedly until a non-existant name is found
78
:param name: The path of the file
79
:param suffix: The suffix to append
80
:param last_new_name: (used for recursive calls) the last name tried
82
if last_new_name is None:
84
new_name = last_new_name+suffix
86
os.rename(name, new_name)
89
if e.errno != errno.EEXIST and e.errno != errno.ENOTEMPTY:
91
return self.add_suffix(name, suffix, last_new_name=new_name)
93
def conflict(self, text):
98
def merge_conflict(self, new_file, this_path, base_lines, other_lines):
100
Handle diff3 conflicts by producing a .THIS, .BASE and .OTHER. The
101
main file will be a version with diff3 conflicts.
102
:param new_file: Path to the output file with diff3 markers
103
:param this_path: Path to the file text for the THIS tree
104
:param base_path: Path to the file text for the BASE tree
105
:param other_path: Path to the file text for the OTHER tree
107
self.add_suffix(this_path, ".THIS")
108
self.dump(base_lines, this_path+".BASE")
109
self.dump(other_lines, this_path+".OTHER")
110
os.rename(new_file, this_path)
111
self.conflict("Diff3 conflict encountered in %s" % this_path)
113
def new_contents_conflict(self, filename, other_contents):
114
"""Conflicting contents for newly added file."""
115
self.copy(other_contents, filename + ".OTHER")
116
self.conflict("Conflict in newly added file %s" % filename)
119
def target_exists(self, entry, target, old_path):
120
"""Handle the case when the target file or dir exists"""
121
moved_path = self.add_suffix(target, ".moved")
122
self.conflict("Moved existing %s to %s" % (target, moved_path))
124
def rmdir_non_empty(self, filename):
125
"""Handle the case where the dir to be removed still has contents"""
126
self.conflict("Directory %s not removed because it is not empty"\
131
if not self.ignore_zero:
132
print "%d conflicts encountered.\n" % self.conflicts
134
def get_tree(treespec, temp_root, label, local_branch=None):
26
from bzrlib.branch import Branch
27
from bzrlib.conflicts import ConflictList, Conflict
28
from bzrlib.errors import (BzrCommandError,
38
WorkingTreeNotRevision,
41
from bzrlib.merge3 import Merge3
42
from bzrlib.osutils import rename, pathjoin
43
from progress import DummyProgress, ProgressPhase
44
from bzrlib.revision import (is_ancestor, NULL_REVISION, ensure_null)
45
from bzrlib.textfile import check_text_lines
46
from bzrlib.trace import mutter, warning, note
47
from bzrlib.transform import (TreeTransform, resolve_conflicts, cook_conflicts,
48
FinalPaths, create_by_entry, unique_add,
50
from bzrlib.versionedfile import WeaveMerge
53
# TODO: Report back as changes are merged in
55
def _get_tree(treespec, local_branch=None):
56
from bzrlib import workingtree
135
57
location, revno = treespec
136
branch = find_branch(location)
140
revision = branch.last_patch()
59
tree = workingtree.WorkingTree.open_containing(location)[0]
60
return tree.branch, tree
61
branch = Branch.open_containing(location)[0]
63
revision_id = branch.last_revision()
142
revision = branch.lookup_revision(revno)
143
return branch, get_revid_tree(branch, revision, temp_root, label,
146
def get_revid_tree(branch, revision, temp_root, label, local_branch):
148
base_tree = branch.working_tree()
65
revision_id = branch.get_rev_id(revno)
66
if revision_id is None:
67
revision_id = NULL_REVISION
68
return branch, _get_revid_tree(branch, revision_id, local_branch)
71
def _get_revid_tree(branch, revision_id, local_branch):
72
if revision_id is None:
73
base_tree = branch.bzrdir.open_workingtree()
150
75
if local_branch is not None:
151
greedy_fetch(local_branch, branch, revision)
152
base_tree = local_branch.revision_tree(revision)
76
if local_branch.base != branch.base:
77
local_branch.fetch(branch, revision_id)
78
base_tree = local_branch.repository.revision_tree(revision_id)
154
base_tree = branch.revision_tree(revision)
155
temp_path = os.path.join(temp_root, label)
157
return MergeTree(base_tree, temp_path)
160
def file_exists(tree, file_id):
161
return tree.has_filename(tree.id2path(file_id))
164
class MergeTree(object):
165
def __init__(self, tree, tempdir):
80
base_tree = branch.repository.revision_tree(revision_id)
84
def _get_revid_tree_from_tree(tree, revision_id, local_branch):
85
if revision_id is None:
87
if local_branch is not None:
88
if local_branch.base != tree.branch.base:
89
local_branch.fetch(tree.branch, revision_id)
90
return local_branch.repository.revision_tree(revision_id)
91
return tree.branch.repository.revision_tree(revision_id)
94
def transform_tree(from_tree, to_tree, interesting_ids=None):
95
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
96
interesting_ids=interesting_ids, this_tree=from_tree)
100
def __init__(self, this_branch, other_tree=None, base_tree=None,
101
this_tree=None, pb=DummyProgress(), change_reporter=None,
166
103
object.__init__(self)
167
if hasattr(tree, "basedir"):
168
self.root = tree.basedir
172
self.tempdir = tempdir
173
os.mkdir(os.path.join(self.tempdir, "texts"))
177
return self.tree.__iter__()
179
def __contains__(self, file_id):
180
return file_id in self.tree
182
def get_file(self, file_id):
183
return self.tree.get_file(file_id)
185
def get_file_sha1(self, id):
186
return self.tree.get_file_sha1(id)
188
def id2path(self, file_id):
189
return self.tree.id2path(file_id)
191
def has_id(self, file_id):
192
return self.tree.has_id(file_id)
194
def has_or_had_id(self, file_id):
195
if file_id == self.tree.inventory.root.file_id:
197
return self.tree.inventory.has_id(file_id)
199
def has_or_had_id(self, file_id):
200
if file_id == self.tree.inventory.root.file_id:
202
return self.tree.inventory.has_id(file_id)
204
def readonly_path(self, id):
205
if id not in self.tree:
207
if self.root is not None:
208
return self.tree.abspath(self.tree.id2path(id))
210
if self.tree.inventory[id].kind in ("directory", "root_directory"):
212
if not self.cached.has_key(id):
213
path = os.path.join(self.tempdir, "texts", id)
214
outfile = file(path, "wb")
215
outfile.write(self.tree.get_file(id).read())
216
assert(os.path.exists(path))
217
self.cached[id] = path
218
return self.cached[id]
222
def merge(other_revision, base_revision,
223
check_clean=True, ignore_zero=False,
224
this_dir=None, backup_files=False, merge_type=ApplyMerge3,
226
"""Merge changes into a tree.
229
tuple(path, revision) Base for three-way merge.
231
tuple(path, revision) Other revision for three-way merge.
233
Directory to merge changes into; '.' by default.
235
If true, this_dir must have no uncommitted changes before the
237
all available ancestors of other_revision and base_revision are
238
automatically pulled into the branch.
240
from bzrlib.revision import common_ancestor, MultipleRevisionSources
241
from bzrlib.errors import NoSuchRevision
242
tempdir = tempfile.mkdtemp(prefix="bzr-")
246
this_branch = find_branch(this_dir)
247
this_rev_id = this_branch.last_patch()
248
if this_rev_id is None:
249
raise BzrCommandError("This branch has no commits")
104
assert this_tree is not None, "this_tree is required"
105
self.this_branch = this_branch
106
self.this_basis = this_branch.last_revision()
107
self.this_rev_id = None
108
self.this_tree = this_tree
109
self.this_revision_tree = None
110
self.this_basis_tree = None
111
self.other_tree = other_tree
112
self.other_branch = None
113
self.base_tree = base_tree
114
self.ignore_zero = False
115
self.backup_files = False
116
self.interesting_ids = None
117
self.show_base = False
118
self.reprocess = False
121
self.recurse = recurse
122
self.change_reporter = change_reporter
124
def revision_tree(self, revision_id):
125
return self.this_branch.repository.revision_tree(revision_id)
127
def ensure_revision_trees(self):
128
if self.this_revision_tree is None:
129
self.this_basis_tree = self.this_branch.repository.revision_tree(
131
if self.this_basis == self.this_rev_id:
132
self.this_revision_tree = self.this_basis_tree
134
if self.other_rev_id is None:
135
other_basis_tree = self.revision_tree(self.other_basis)
136
changes = other_basis_tree.changes_from(self.other_tree)
137
if changes.has_changed():
138
raise WorkingTreeNotRevision(self.this_tree)
139
other_rev_id = self.other_basis
140
self.other_tree = other_basis_tree
142
def file_revisions(self, file_id):
143
self.ensure_revision_trees()
144
def get_id(tree, file_id):
145
revision_id = tree.inventory[file_id].revision
146
assert revision_id is not None
148
if self.this_rev_id is None:
149
if self.this_basis_tree.get_file_sha1(file_id) != \
150
self.this_tree.get_file_sha1(file_id):
151
raise WorkingTreeNotRevision(self.this_tree)
153
trees = (self.this_basis_tree, self.other_tree)
154
return [get_id(tree, file_id) for tree in trees]
156
def check_basis(self, check_clean, require_commits=True):
157
if self.this_basis is None and require_commits is True:
158
raise BzrCommandError("This branch has no commits."
159
" (perhaps you would prefer 'bzr pull')")
251
changes = compare_trees(this_branch.working_tree(),
252
this_branch.basis_tree(), False)
253
if changes.has_changed():
162
if self.this_basis != self.this_rev_id:
254
163
raise BzrCommandError("Working tree has uncommitted changes.")
255
other_branch, other_tree = get_tree(other_revision, tempdir, "other",
165
def compare_basis(self):
166
changes = self.this_tree.changes_from(self.this_tree.basis_tree())
167
if not changes.has_changed():
168
self.this_rev_id = self.this_basis
170
def set_interesting_files(self, file_list):
172
self._set_interesting_files(file_list)
173
except NotVersionedError, e:
174
raise BzrCommandError("%s is not a source file in any"
177
def _set_interesting_files(self, file_list):
178
"""Set the list of interesting ids from a list of files."""
179
if file_list is None:
180
self.interesting_ids = None
183
interesting_ids = set()
184
for path in file_list:
186
# TODO: jam 20070226 The trees are not locked at this time,
187
# wouldn't it make merge faster if it locks everything in the
188
# beginning? It locks at do_merge time, but this happens
190
for tree in (self.this_tree, self.base_tree, self.other_tree):
191
file_id = tree.path2id(path)
192
if file_id is not None:
193
interesting_ids.add(file_id)
196
raise NotVersionedError(path=path)
197
self.interesting_ids = interesting_ids
199
def set_pending(self):
200
if not self.base_is_ancestor:
202
if self.other_rev_id is None:
204
ancestry = self.this_branch.repository.get_ancestry(self.this_basis)
205
if self.other_rev_id in ancestry:
207
self.this_tree.add_parent_tree((self.other_rev_id, self.other_tree))
209
def set_other(self, other_revision):
210
"""Set the revision and tree to merge from.
212
This sets the other_tree, other_rev_id, other_basis attributes.
214
:param other_revision: The [path, revision] list to merge from.
216
self.other_branch, self.other_tree = _get_tree(other_revision,
257
218
if other_revision[1] == -1:
258
other_rev_id = other_branch.last_patch()
259
other_basis = other_rev_id
219
self.other_rev_id = self.other_branch.last_revision()
220
if self.other_rev_id is None:
221
raise NoCommits(self.other_branch)
222
self.other_basis = self.other_rev_id
260
223
elif other_revision[1] is not None:
261
other_rev_id = other_branch.lookup_revision(other_revision[1])
262
other_basis = other_rev_id
224
self.other_rev_id = self.other_branch.get_rev_id(other_revision[1])
225
self.other_basis = self.other_rev_id
265
other_basis = other_branch.last_patch()
227
self.other_rev_id = None
228
self.other_basis = self.other_branch.last_revision()
229
if self.other_basis is None:
230
raise NoCommits(self.other_branch)
231
if self.other_branch.base != self.this_branch.base:
232
self.this_branch.fetch(self.other_branch,
233
last_revision=self.other_basis)
235
def set_other_revision(self, revision_id, other_branch):
236
"""Set 'other' based on a branch and revision id
238
:param revision_id: The revision to use for a tree
239
:param other_branch: The branch containing this tree
241
self.other_rev_id = revision_id
242
self.other_branch = other_branch
243
self.this_branch.fetch(other_branch, self.other_rev_id)
244
self.other_tree = self.revision_tree(revision_id)
245
self.other_basis = revision_id
248
self.set_base([None, None])
250
def set_base(self, base_revision):
251
"""Set the base revision to use for the merge.
253
:param base_revision: A 2-list containing a path and revision number.
255
mutter("doing merge() with no base_revision specified")
266
256
if base_revision == [None, None]:
267
base_rev_id = common_ancestor(this_rev_id, other_basis,
269
if base_rev_id is None:
258
pb = ui.ui_factory.nested_progress_bar()
260
this_repo = self.this_branch.repository
261
graph = this_repo.get_graph()
262
revisions = [ensure_null(self.this_basis),
263
ensure_null(self.other_basis)]
264
if NULL_REVISION in revisions:
265
self.base_rev_id = NULL_REVISION
267
self.base_rev_id = graph.find_unique_lca(*revisions)
268
if self.base_rev_id == NULL_REVISION:
269
raise UnrelatedBranches()
272
except NoCommonAncestor:
270
273
raise UnrelatedBranches()
271
base_tree = get_revid_tree(this_branch, base_rev_id, tempdir,
273
base_is_ancestor = True
274
self.base_tree = _get_revid_tree_from_tree(self.this_tree,
277
self.base_is_ancestor = True
275
base_branch, base_tree = get_tree(base_revision, tempdir, "base")
279
base_branch, self.base_tree = _get_tree(base_revision)
276
280
if base_revision[1] == -1:
277
base_rev_id = base_branch.last_patch()
281
self.base_rev_id = base_branch.last_revision()
278
282
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)
283
self.base_rev_id = None
285
self.base_rev_id = base_branch.get_rev_id(base_revision[1])
286
if self.this_branch.base != base_branch.base:
287
self.this_branch.fetch(base_branch)
288
self.base_is_ancestor = is_ancestor(self.this_basis,
293
kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
294
'other_tree': self.other_tree,
295
'interesting_ids': self.interesting_ids,
297
if self.merge_type.requires_base:
298
kwargs['base_tree'] = self.base_tree
299
if self.merge_type.supports_reprocess:
300
kwargs['reprocess'] = self.reprocess
302
raise BzrError("Conflict reduction is not supported for merge"
303
" type %s." % self.merge_type)
304
if self.merge_type.supports_show_base:
305
kwargs['show_base'] = self.show_base
307
raise BzrError("Showing base is not supported for this"
308
" merge type. %s" % self.merge_type)
309
self.this_tree.lock_tree_write()
310
if self.base_tree is not None:
311
self.base_tree.lock_read()
312
if self.other_tree is not None:
313
self.other_tree.lock_read()
315
merge = self.merge_type(pb=self._pb,
316
change_reporter=self.change_reporter,
318
if self.recurse == 'down':
319
for path, file_id in self.this_tree.iter_references():
320
sub_tree = self.this_tree.get_nested_tree(file_id, path)
321
other_revision = self.other_tree.get_reference_revision(
323
if other_revision == sub_tree.last_revision():
325
sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
326
sub_merge.merge_type = self.merge_type
327
relpath = self.this_tree.relpath(path)
328
other_branch = self.other_branch.reference_parent(file_id, relpath)
329
sub_merge.set_other_revision(other_revision, other_branch)
330
base_revision = self.base_tree.get_reference_revision(file_id)
331
sub_merge.base_tree = \
332
sub_tree.branch.repository.revision_tree(base_revision)
336
if self.other_tree is not None:
337
self.other_tree.unlock()
338
if self.base_tree is not None:
339
self.base_tree.unlock()
340
self.this_tree.unlock()
341
if len(merge.cooked_conflicts) == 0:
342
if not self.ignore_zero:
343
note("All changes applied successfully.")
345
note("%d conflicts encountered." % len(merge.cooked_conflicts))
347
return len(merge.cooked_conflicts)
349
def regen_inventory(self, new_entries):
350
old_entries = self.this_tree.read_working_inventory()
354
for path, file_id in new_entries:
357
new_entries_map[file_id] = path
359
def id2path(file_id):
360
path = new_entries_map.get(file_id)
363
entry = old_entries[file_id]
364
if entry.parent_id is None:
366
return pathjoin(id2path(entry.parent_id), entry.name)
368
for file_id in old_entries:
369
entry = old_entries[file_id]
370
path = id2path(file_id)
371
if file_id in self.base_tree.inventory:
372
executable = getattr(self.base_tree.inventory[file_id], 'executable', False)
374
executable = getattr(entry, 'executable', False)
375
new_inventory[file_id] = (path, file_id, entry.parent_id,
376
entry.kind, executable)
378
by_path[path] = file_id
383
for path, file_id in new_entries:
385
del new_inventory[file_id]
388
new_path_list.append((path, file_id))
389
if file_id not in old_entries:
391
# Ensure no file is added before its parent
393
for path, file_id in new_path_list:
397
parent = by_path[os.path.dirname(path)]
398
abspath = pathjoin(self.this_tree.basedir, path)
399
kind = osutils.file_kind(abspath)
400
if file_id in self.base_tree.inventory:
401
executable = getattr(self.base_tree.inventory[file_id], 'executable', False)
404
new_inventory[file_id] = (path, file_id, parent, kind, executable)
405
by_path[path] = file_id
407
# Get a list in insertion order
408
new_inventory_list = new_inventory.values()
409
mutter ("""Inventory regeneration:
410
old length: %i insertions: %i deletions: %i new_length: %i"""\
411
% (len(old_entries), insertions, deletions,
412
len(new_inventory_list)))
413
assert len(new_inventory_list) == len(old_entries) + insertions\
415
new_inventory_list.sort()
416
return new_inventory_list
419
class Merge3Merger(object):
420
"""Three-way merger that uses the merge3 text merger"""
422
supports_reprocess = True
423
supports_show_base = True
424
history_based = False
426
def __init__(self, working_tree, this_tree, base_tree, other_tree,
427
interesting_ids=None, reprocess=False, show_base=False,
428
pb=DummyProgress(), pp=None, change_reporter=None):
429
"""Initialize the merger object and perform the merge."""
430
object.__init__(self)
431
self.this_tree = working_tree
432
self.this_tree.lock_tree_write()
433
self.base_tree = base_tree
434
self.base_tree.lock_read()
435
self.other_tree = other_tree
436
self.other_tree.lock_read()
437
self._raw_conflicts = []
438
self.cooked_conflicts = []
439
self.reprocess = reprocess
440
self.show_base = show_base
443
self.change_reporter = change_reporter
445
self.pp = ProgressPhase("Merge phase", 3, self.pb)
447
if interesting_ids is not None:
448
all_ids = interesting_ids
450
all_ids = set(base_tree)
451
all_ids.update(other_tree)
452
self.tt = TreeTransform(working_tree, self.pb)
455
child_pb = ui.ui_factory.nested_progress_bar()
457
for num, file_id in enumerate(all_ids):
458
child_pb.update('Preparing file merge', num, len(all_ids))
459
self.merge_names(file_id)
460
file_status = self.merge_contents(file_id)
461
self.merge_executable(file_id, file_status)
466
child_pb = ui.ui_factory.nested_progress_bar()
468
fs_conflicts = resolve_conflicts(self.tt, child_pb)
471
if change_reporter is not None:
472
from bzrlib import delta
473
delta.report_changes(self.tt._iter_changes(), change_reporter)
474
self.cook_conflicts(fs_conflicts)
475
for conflict in self.cooked_conflicts:
478
results = self.tt.apply()
479
self.write_modified(results)
481
working_tree.add_conflicts(self.cooked_conflicts)
482
except UnsupportedOperation:
486
self.other_tree.unlock()
487
self.base_tree.unlock()
488
self.this_tree.unlock()
493
self.tt.final_kind(self.tt.root)
495
self.tt.cancel_deletion(self.tt.root)
496
if self.tt.final_file_id(self.tt.root) is None:
497
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
499
if self.other_tree.inventory.root is None:
501
other_root_file_id = self.other_tree.inventory.root.file_id
502
other_root = self.tt.trans_id_file_id(other_root_file_id)
503
if other_root == self.tt.root:
506
self.tt.final_kind(other_root)
509
self.reparent_children(self.other_tree.inventory.root, self.tt.root)
510
self.tt.cancel_creation(other_root)
511
self.tt.cancel_versioning(other_root)
513
def reparent_children(self, ie, target):
514
for thing, child in ie.children.iteritems():
515
trans_id = self.tt.trans_id_file_id(child.file_id)
516
self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
518
def write_modified(self, results):
520
for path in results.modified_paths:
521
file_id = self.this_tree.path2id(self.this_tree.relpath(path))
524
hash = self.this_tree.get_file_sha1(file_id)
527
modified_hashes[file_id] = hash
528
self.this_tree.set_merge_modified(modified_hashes)
531
def parent(entry, file_id):
532
"""Determine the parent for a file_id (used as a key method)"""
535
return entry.parent_id
538
def name(entry, file_id):
539
"""Determine the name for a file_id (used as a key method)"""
545
def contents_sha1(tree, file_id):
546
"""Determine the sha1 of the file contents (used as a key method)."""
547
if file_id not in tree:
549
return tree.get_file_sha1(file_id)
552
def executable(tree, file_id):
553
"""Determine the executability of a file-id (used as a key method)."""
554
if file_id not in tree:
556
if tree.kind(file_id) != "file":
558
return tree.is_executable(file_id)
561
def kind(tree, file_id):
562
"""Determine the kind of a file-id (used as a key method)."""
563
if file_id not in tree:
565
return tree.kind(file_id)
568
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
569
"""Do a three-way test on a scalar.
570
Return "this", "other" or "conflict", depending whether a value wins.
572
key_base = key(base_tree, file_id)
573
key_other = key(other_tree, file_id)
574
#if base == other, either they all agree, or only THIS has changed.
575
if key_base == key_other:
577
key_this = key(this_tree, file_id)
578
if key_this not in (key_base, key_other):
580
# "Ambiguous clean merge"
581
elif key_this == key_other:
584
assert key_this == key_base
587
def merge_names(self, file_id):
588
"""Perform a merge on file_id names and parents"""
590
if file_id in tree.inventory:
591
return tree.inventory[file_id]
594
this_entry = get_entry(self.this_tree)
595
other_entry = get_entry(self.other_tree)
596
base_entry = get_entry(self.base_tree)
597
name_winner = self.scalar_three_way(this_entry, base_entry,
598
other_entry, file_id, self.name)
599
parent_id_winner = self.scalar_three_way(this_entry, base_entry,
600
other_entry, file_id,
602
if this_entry is None:
603
if name_winner == "this":
604
name_winner = "other"
605
if parent_id_winner == "this":
606
parent_id_winner = "other"
607
if name_winner == "this" and parent_id_winner == "this":
609
if name_winner == "conflict":
610
trans_id = self.tt.trans_id_file_id(file_id)
611
self._raw_conflicts.append(('name conflict', trans_id,
612
self.name(this_entry, file_id),
613
self.name(other_entry, file_id)))
614
if parent_id_winner == "conflict":
615
trans_id = self.tt.trans_id_file_id(file_id)
616
self._raw_conflicts.append(('parent conflict', trans_id,
617
self.parent(this_entry, file_id),
618
self.parent(other_entry, file_id)))
619
if other_entry is None:
620
# it doesn't matter whether the result was 'other' or
621
# 'conflict'-- if there's no 'other', we leave it alone.
623
# if we get here, name_winner and parent_winner are set to safe values.
624
winner_entry = {"this": this_entry, "other": other_entry,
625
"conflict": other_entry}
626
trans_id = self.tt.trans_id_file_id(file_id)
627
parent_id = winner_entry[parent_id_winner].parent_id
628
if parent_id is not None:
629
parent_trans_id = self.tt.trans_id_file_id(parent_id)
630
self.tt.adjust_path(winner_entry[name_winner].name,
631
parent_trans_id, trans_id)
633
def merge_contents(self, file_id):
634
"""Performa a merge on file_id contents."""
635
def contents_pair(tree):
636
if file_id not in tree:
638
kind = tree.kind(file_id)
640
contents = tree.get_file_sha1(file_id)
641
elif kind == "symlink":
642
contents = tree.get_symlink_target(file_id)
645
return kind, contents
647
def contents_conflict():
648
trans_id = self.tt.trans_id_file_id(file_id)
649
name = self.tt.final_name(trans_id)
650
parent_id = self.tt.final_parent(trans_id)
651
if file_id in self.this_tree.inventory:
652
self.tt.unversion_file(trans_id)
653
if file_id in self.this_tree:
654
self.tt.delete_contents(trans_id)
655
file_group = self._dump_conflicts(name, parent_id, file_id,
657
self._raw_conflicts.append(('contents conflict', file_group))
659
# See SPOT run. run, SPOT, run.
660
# So we're not QUITE repeating ourselves; we do tricky things with
662
base_pair = contents_pair(self.base_tree)
663
other_pair = contents_pair(self.other_tree)
664
if base_pair == other_pair:
665
# OTHER introduced no changes
667
this_pair = contents_pair(self.this_tree)
668
if this_pair == other_pair:
669
# THIS and OTHER introduced the same changes
672
trans_id = self.tt.trans_id_file_id(file_id)
673
if this_pair == base_pair:
674
# only OTHER introduced changes
675
if file_id in self.this_tree:
676
# Remove any existing contents
677
self.tt.delete_contents(trans_id)
678
if file_id in self.other_tree:
679
# OTHER changed the file
680
create_by_entry(self.tt,
681
self.other_tree.inventory[file_id],
682
self.other_tree, trans_id)
683
if file_id not in self.this_tree.inventory:
684
self.tt.version_file(file_id, trans_id)
686
elif file_id in self.this_tree.inventory:
687
# OTHER deleted the file
688
self.tt.unversion_file(trans_id)
690
#BOTH THIS and OTHER introduced changes; scalar conflict
691
elif this_pair[0] == "file" and other_pair[0] == "file":
692
# THIS and OTHER are both files, so text merge. Either
693
# BASE is a file, or both converted to files, so at least we
694
# have agreement that output should be a file.
696
self.text_merge(file_id, trans_id)
698
return contents_conflict()
699
if file_id not in self.this_tree.inventory:
700
self.tt.version_file(file_id, trans_id)
702
self.tt.tree_kind(trans_id)
703
self.tt.delete_contents(trans_id)
708
# Scalar conflict, can't text merge. Dump conflicts
709
return contents_conflict()
711
def get_lines(self, tree, file_id):
712
"""Return the lines in a file, or an empty list."""
714
return tree.get_file(file_id).readlines()
718
def text_merge(self, file_id, trans_id):
719
"""Perform a three-way text merge on a file_id"""
720
# it's possible that we got here with base as a different type.
721
# if so, we just want two-way text conflicts.
722
if file_id in self.base_tree and \
723
self.base_tree.kind(file_id) == "file":
724
base_lines = self.get_lines(self.base_tree, file_id)
727
other_lines = self.get_lines(self.other_tree, file_id)
728
this_lines = self.get_lines(self.this_tree, file_id)
729
m3 = Merge3(base_lines, this_lines, other_lines)
730
start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
731
if self.show_base is True:
732
base_marker = '|' * 7
736
def iter_merge3(retval):
737
retval["text_conflicts"] = False
738
for line in m3.merge_lines(name_a = "TREE",
739
name_b = "MERGE-SOURCE",
740
name_base = "BASE-REVISION",
741
start_marker=start_marker,
742
base_marker=base_marker,
743
reprocess=self.reprocess):
744
if line.startswith(start_marker):
745
retval["text_conflicts"] = True
746
yield line.replace(start_marker, '<' * 7)
750
merge3_iterator = iter_merge3(retval)
751
self.tt.create_file(merge3_iterator, trans_id)
752
if retval["text_conflicts"] is True:
753
self._raw_conflicts.append(('text conflict', trans_id))
754
name = self.tt.final_name(trans_id)
755
parent_id = self.tt.final_parent(trans_id)
756
file_group = self._dump_conflicts(name, parent_id, file_id,
757
this_lines, base_lines,
759
file_group.append(trans_id)
761
def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
762
base_lines=None, other_lines=None, set_version=False,
764
"""Emit conflict files.
765
If this_lines, base_lines, or other_lines are omitted, they will be
766
determined automatically. If set_version is true, the .OTHER, .THIS
767
or .BASE (in that order) will be created as versioned files.
769
data = [('OTHER', self.other_tree, other_lines),
770
('THIS', self.this_tree, this_lines)]
772
data.append(('BASE', self.base_tree, base_lines))
775
for suffix, tree, lines in data:
777
trans_id = self._conflict_file(name, parent_id, tree, file_id,
779
file_group.append(trans_id)
780
if set_version and not versioned:
781
self.tt.version_file(file_id, trans_id)
785
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
787
"""Emit a single conflict file."""
788
name = name + '.' + suffix
789
trans_id = self.tt.create_path(name, parent_id)
790
entry = tree.inventory[file_id]
791
create_by_entry(self.tt, entry, tree, trans_id, lines)
794
def merge_executable(self, file_id, file_status):
795
"""Perform a merge on the execute bit."""
796
if file_status == "deleted":
798
trans_id = self.tt.trans_id_file_id(file_id)
800
if self.tt.final_kind(trans_id) != "file":
804
winner = self.scalar_three_way(self.this_tree, self.base_tree,
805
self.other_tree, file_id,
807
if winner == "conflict":
808
# There must be a None in here, if we have a conflict, but we
809
# need executability since file status was not deleted.
810
if self.executable(self.other_tree, file_id) is None:
815
if file_status == "modified":
816
executability = self.this_tree.is_executable(file_id)
817
if executability is not None:
818
trans_id = self.tt.trans_id_file_id(file_id)
819
self.tt.set_executability(executability, trans_id)
821
assert winner == "other"
822
if file_id in self.other_tree:
823
executability = self.other_tree.is_executable(file_id)
824
elif file_id in self.this_tree:
825
executability = self.this_tree.is_executable(file_id)
826
elif file_id in self.base_tree:
827
executability = self.base_tree.is_executable(file_id)
828
if executability is not None:
829
trans_id = self.tt.trans_id_file_id(file_id)
830
self.tt.set_executability(executability, trans_id)
832
def cook_conflicts(self, fs_conflicts):
833
"""Convert all conflicts into a form that doesn't depend on trans_id"""
834
from conflicts import Conflict
836
self.cooked_conflicts.extend(cook_conflicts(fs_conflicts, self.tt))
837
fp = FinalPaths(self.tt)
838
for conflict in self._raw_conflicts:
839
conflict_type = conflict[0]
840
if conflict_type in ('name conflict', 'parent conflict'):
841
trans_id = conflict[1]
842
conflict_args = conflict[2:]
843
if trans_id not in name_conflicts:
844
name_conflicts[trans_id] = {}
845
unique_add(name_conflicts[trans_id], conflict_type,
847
if conflict_type == 'contents conflict':
848
for trans_id in conflict[1]:
849
file_id = self.tt.final_file_id(trans_id)
298
850
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
and other_rev_id not in this_branch.revision_history():
309
this_branch.add_pending_merge(other_rev_id)
311
shutil.rmtree(tempdir)
314
def set_interesting(inventory_a, inventory_b, interesting_ids):
315
"""Mark files whose ids are in interesting_ids as interesting
852
path = fp.get_path(trans_id)
853
for suffix in ('.BASE', '.THIS', '.OTHER'):
854
if path.endswith(suffix):
855
path = path[:-len(suffix)]
857
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
858
self.cooked_conflicts.append(c)
859
if conflict_type == 'text conflict':
860
trans_id = conflict[1]
861
path = fp.get_path(trans_id)
862
file_id = self.tt.final_file_id(trans_id)
863
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
864
self.cooked_conflicts.append(c)
866
for trans_id, conflicts in name_conflicts.iteritems():
868
this_parent, other_parent = conflicts['parent conflict']
869
assert this_parent != other_parent
871
this_parent = other_parent = \
872
self.tt.final_file_id(self.tt.final_parent(trans_id))
874
this_name, other_name = conflicts['name conflict']
875
assert this_name != other_name
877
this_name = other_name = self.tt.final_name(trans_id)
878
other_path = fp.get_path(trans_id)
879
if this_parent is not None and this_name is not None:
881
fp.get_path(self.tt.trans_id_file_id(this_parent))
882
this_path = pathjoin(this_parent_path, this_name)
884
this_path = "<deleted>"
885
file_id = self.tt.final_file_id(trans_id)
886
c = Conflict.factory('path conflict', path=this_path,
887
conflict_path=other_path, file_id=file_id)
888
self.cooked_conflicts.append(c)
889
self.cooked_conflicts.sort(key=Conflict.sort_key)
892
class WeaveMerger(Merge3Merger):
893
"""Three-way tree merger, text weave merger."""
894
supports_reprocess = True
895
supports_show_base = False
897
def __init__(self, working_tree, this_tree, base_tree, other_tree,
898
interesting_ids=None, pb=DummyProgress(), pp=None,
899
reprocess=False, change_reporter=None):
900
self.this_revision_tree = self._get_revision_tree(this_tree)
901
self.other_revision_tree = self._get_revision_tree(other_tree)
902
super(WeaveMerger, self).__init__(working_tree, this_tree,
903
base_tree, other_tree,
904
interesting_ids=interesting_ids,
905
pb=pb, pp=pp, reprocess=reprocess,
906
change_reporter=change_reporter)
908
def _get_revision_tree(self, tree):
909
"""Return a revision tree related to this tree.
910
If the tree is a WorkingTree, the basis will be returned.
912
if getattr(tree, 'get_weave', False) is False:
913
# If we have a WorkingTree, try using the basis
914
return tree.branch.basis_tree()
918
def _check_file(self, file_id):
919
"""Check that the revision tree's version of the file matches."""
920
for tree, rt in ((self.this_tree, self.this_revision_tree),
921
(self.other_tree, self.other_revision_tree)):
924
if tree.get_file_sha1(file_id) != rt.get_file_sha1(file_id):
925
raise WorkingTreeNotRevision(self.this_tree)
927
def _merged_lines(self, file_id):
928
"""Generate the merged lines.
929
There is no distinction between lines that are meant to contain <<<<<<<
932
weave = self.this_revision_tree.get_weave(file_id)
933
this_revision_id = self.this_revision_tree.inventory[file_id].revision
934
other_revision_id = \
935
self.other_revision_tree.inventory[file_id].revision
936
wm = WeaveMerge(weave, this_revision_id, other_revision_id,
937
'<<<<<<< TREE\n', '>>>>>>> MERGE-SOURCE\n')
938
return wm.merge_lines(self.reprocess)
940
def text_merge(self, file_id, trans_id):
941
"""Perform a (weave) text merge for a given file and file-id.
942
If conflicts are encountered, .THIS and .OTHER files will be emitted,
943
and a conflict will be noted.
945
self._check_file(file_id)
946
lines, conflicts = self._merged_lines(file_id)
948
# Note we're checking whether the OUTPUT is binary in this case,
949
# because we don't want to get into weave merge guts.
950
check_text_lines(lines)
951
self.tt.create_file(lines, trans_id)
953
self._raw_conflicts.append(('text conflict', trans_id))
954
name = self.tt.final_name(trans_id)
955
parent_id = self.tt.final_parent(trans_id)
956
file_group = self._dump_conflicts(name, parent_id, file_id,
958
file_group.append(trans_id)
961
class Diff3Merger(Merge3Merger):
962
"""Three-way merger using external diff3 for text merging"""
964
def dump_file(self, temp_dir, name, tree, file_id):
965
out_path = pathjoin(temp_dir, name)
966
out_file = open(out_path, "wb")
968
in_file = tree.get_file(file_id)
975
def text_merge(self, file_id, trans_id):
976
"""Perform a diff3 merge using a specified file-id and trans-id.
977
If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
978
will be dumped, and a will be conflict noted.
981
temp_dir = osutils.mkdtemp(prefix="bzr-")
983
new_file = pathjoin(temp_dir, "new")
984
this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
985
base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
986
other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
987
status = bzrlib.patch.diff3(new_file, this, base, other)
988
if status not in (0, 1):
989
raise BzrError("Unhandled diff3 exit code")
990
f = open(new_file, 'rb')
992
self.tt.create_file(f, trans_id)
996
name = self.tt.final_name(trans_id)
997
parent_id = self.tt.final_parent(trans_id)
998
self._dump_conflicts(name, parent_id, file_id)
999
self._raw_conflicts.append(('text conflict', trans_id))
1001
osutils.rmtree(temp_dir)
1004
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1006
merge_type=Merge3Merger,
1007
interesting_ids=None,
1011
interesting_files=None,
1014
change_reporter=None):
1015
"""Primary interface for merging.
1017
typical use is probably
1018
'merge_inner(branch, branch.get_revision_tree(other_revision),
1019
branch.get_revision_tree(base_revision))'
1021
if this_tree is None:
1022
raise BzrError("bzrlib.merge.merge_inner requires a this_tree "
1023
"parameter as of bzrlib version 0.8.")
1024
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1025
pb=pb, change_reporter=change_reporter)
1026
merger.backup_files = backup_files
1027
merger.merge_type = merge_type
1028
merger.interesting_ids = interesting_ids
1029
merger.ignore_zero = ignore_zero
1030
if interesting_files:
1031
assert not interesting_ids, ('Only supply interesting_ids'
1032
' or interesting_files')
1033
merger._set_interesting_files(interesting_files)
1034
merger.show_base = show_base
1035
merger.reprocess = reprocess
1036
merger.other_rev_id = other_rev_id
1037
merger.other_basis = other_rev_id
1038
return merger.do_merge()
1040
def get_merge_type_registry():
1041
"""Merge type registry is in bzrlib.option to avoid circular imports.
1043
This method provides a sanctioned way to retrieve it.
317
for inventory in (inventory_a, inventory_b):
318
for path, source_file in inventory.iteritems():
319
source_file.interesting = source_file.id in interesting_ids
322
def generate_cset_optimized(tree_a, tree_b, interesting_ids=None):
323
"""Generate a changeset. If interesting_ids is supplied, only changes
324
to those files will be shown. Metadata changes are stripped.
326
cset = generate_changeset(tree_a, tree_b, interesting_ids)
327
for entry in cset.entries.itervalues():
328
entry.metadata_change = None
332
def merge_inner(this_branch, other_tree, base_tree, tempdir,
333
ignore_zero=False, merge_type=ApplyMerge3, backup_files=False,
334
interesting_ids=None):
336
def merge_factory(file_id, base, other):
337
contents_change = merge_type(file_id, base, other)
339
contents_change = BackupBeforeChange(contents_change)
340
return contents_change
342
this_tree = get_tree((this_branch.base, None), tempdir, "this")[1]
344
def get_inventory(tree):
345
return tree.tree.inventory
347
inv_changes = merge_flex(this_tree, base_tree, other_tree,
348
generate_cset_optimized, get_inventory,
349
MergeConflictHandler(base_tree.root,
350
ignore_zero=ignore_zero),
351
merge_factory=merge_factory,
352
interesting_ids=interesting_ids)
355
for id, path in inv_changes.iteritems():
360
assert path.startswith('./'), "path is %s" % path
362
adjust_ids.append((path, id))
363
if len(adjust_ids) > 0:
364
this_branch.set_inventory(regen_inventory(this_branch, this_tree.root,
368
def regen_inventory(this_branch, root, new_entries):
369
old_entries = this_branch.read_working_inventory()
373
for path, file_id in new_entries:
376
new_entries_map[file_id] = path
378
def id2path(file_id):
379
path = new_entries_map.get(file_id)
382
entry = old_entries[file_id]
383
if entry.parent_id is None:
385
return os.path.join(id2path(entry.parent_id), entry.name)
387
for file_id in old_entries:
388
entry = old_entries[file_id]
389
path = id2path(file_id)
390
new_inventory[file_id] = (path, file_id, entry.parent_id, entry.kind)
391
by_path[path] = file_id
396
for path, file_id in new_entries:
398
del new_inventory[file_id]
401
new_path_list.append((path, file_id))
402
if file_id not in old_entries:
404
# Ensure no file is added before its parent
406
for path, file_id in new_path_list:
410
parent = by_path[os.path.dirname(path)]
411
kind = bzrlib.osutils.file_kind(os.path.join(root, path))
412
new_inventory[file_id] = (path, file_id, parent, kind)
413
by_path[path] = file_id
415
# Get a list in insertion order
416
new_inventory_list = new_inventory.values()
417
mutter ("""Inventory regeneration:
418
old length: %i insertions: %i deletions: %i new_length: %i"""\
419
% (len(old_entries), insertions, deletions, len(new_inventory_list)))
420
assert len(new_inventory_list) == len(old_entries) + insertions - deletions
421
new_inventory_list.sort()
422
return new_inventory_list
424
merge_types = { "merge3": (ApplyMerge3, "Native diff3-style merge"),
425
"diff3": (Diff3Merge, "Merge using external diff3")
1045
from bzrlib import option
1046
return option._merge_type_registry
added
removed
bzrlib/merge.py
