1
# Copyright (C) 2005, 2006 Canonical Ltd
1
# Copyright (C) 2005 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
24
import bzrlib.revision
25
from bzrlib.merge_core import merge_flex, ApplyMerge3, BackupBeforeChange
26
from bzrlib.merge_core import WeaveMerge
27
from bzrlib.changeset import generate_changeset, ExceptionConflictHandler
28
from bzrlib.changeset import Inventory, Diff3Merge, ReplaceContents
26
29
from bzrlib.branch import Branch
27
from bzrlib.conflicts import ConflictList, Conflict
28
30
from bzrlib.errors import (BzrCommandError,
34
WorkingTreeNotRevision,
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
38
from bzrlib.delta import compare_trees
46
39
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
40
from bzrlib.fetch import greedy_fetch, fetch
41
from bzrlib.revision import is_ancestor, NULL_REVISION
42
from bzrlib.osutils import rename
43
from bzrlib.revision import common_ancestor, MultipleRevisionSources
44
from bzrlib.errors import NoSuchRevision
53
46
# TODO: Report back as changes are merged in
55
def _get_tree(treespec, local_branch=None):
56
from bzrlib import workingtree
48
# TODO: build_working_dir can be built on something simpler than merge()
50
# FIXME: merge() parameters seem oriented towards the command line
51
# NOTABUG: merge is a helper for commandline functions. merge_inner is the
52
# the core functionality.
54
# comments from abentley on irc: merge happens in two stages, each
55
# of which generates a changeset object
57
# stage 1: generate OLD->OTHER,
58
# stage 2: use MINE and OLD->OTHER to generate MINE -> RESULT
60
class MergeConflictHandler(ExceptionConflictHandler):
61
"""Handle conflicts encountered while merging.
63
This subclasses ExceptionConflictHandler, so that any types of
64
conflict that are not explicitly handled cause an exception and
67
def __init__(self, this_tree, base_tree, other_tree, ignore_zero=False):
68
ExceptionConflictHandler.__init__(self)
70
self.ignore_zero = ignore_zero
71
self.this_tree = this_tree
72
self.base_tree = base_tree
73
self.other_tree = other_tree
75
def copy(self, source, dest):
76
"""Copy the text and mode of a file
77
:param source: The path of the file to copy
78
:param dest: The distination file to create
80
s_file = file(source, "rb")
81
d_file = file(dest, "wb")
84
os.chmod(dest, 0777 & os.stat(source).st_mode)
86
def dump(self, lines, dest):
87
"""Copy the text and mode of a file
88
:param source: The path of the file to copy
89
:param dest: The distination file to create
91
d_file = file(dest, "wb")
95
def add_suffix(self, name, suffix, last_new_name=None, fix_inventory=True):
96
"""Rename a file to append a suffix. If the new name exists, the
97
suffix is added repeatedly until a non-existant name is found
99
:param name: The path of the file
100
:param suffix: The suffix to append
101
:param last_new_name: (used for recursive calls) the last name tried
103
if last_new_name is None:
105
new_name = last_new_name+suffix
107
rename(name, new_name)
108
if fix_inventory is True:
110
relpath = self.this_tree.relpath(name)
111
except NotBranchError:
113
if relpath is not None:
114
file_id = self.this_tree.path2id(relpath)
115
if file_id is not None:
116
new_path = self.this_tree.relpath(new_name)
117
rename(new_name, name)
118
self.this_tree.rename_one(relpath, new_path)
119
assert self.this_tree.id2path(file_id) == new_path
121
if e.errno != errno.EEXIST and e.errno != errno.ENOTEMPTY:
123
return self.add_suffix(name, suffix, last_new_name=new_name,
124
fix_inventory=fix_inventory)
127
def conflict(self, text):
132
def merge_conflict(self, new_file, this_path, base_lines, other_lines):
134
Handle diff3 conflicts by producing a .THIS, .BASE and .OTHER. The
135
main file will be a version with diff3 conflicts.
136
:param new_file: Path to the output file with diff3 markers
137
:param this_path: Path to the file text for the THIS tree
138
:param base_path: Path to the file text for the BASE tree
139
:param other_path: Path to the file text for the OTHER tree
141
self.add_suffix(this_path, ".THIS", fix_inventory=False)
142
self.dump(base_lines, this_path+".BASE")
143
self.dump(other_lines, this_path+".OTHER")
144
rename(new_file, this_path)
145
self.conflict("Diff3 conflict encountered in %s" % this_path)
147
def weave_merge_conflict(self, filename, weave, other_i, out_file):
149
Handle weave conflicts by producing a .THIS, and .OTHER. The
150
main file will be a version with diff3-style conflicts.
152
self.add_suffix(filename, ".THIS", fix_inventory=False)
154
self.dump(weave.get_iter(other_i), filename+".OTHER")
155
self.conflict("Text conflict encountered in %s" % filename)
157
def new_contents_conflict(self, filename, other_contents):
158
"""Conflicting contents for newly added file."""
159
other_contents(filename + ".OTHER", self, False)
160
self.conflict("Conflict in newly added file %s" % filename)
163
def target_exists(self, entry, target, old_path):
164
"""Handle the case when the target file or dir exists"""
165
moved_path = self.add_suffix(target, ".moved")
166
self.conflict("Moved existing %s to %s" % (target, moved_path))
168
def rmdir_non_empty(self, filename):
169
"""Handle the case where the dir to be removed still has contents"""
170
self.conflict("Directory %s not removed because it is not empty"\
174
def rem_contents_conflict(self, filename, this_contents, base_contents):
175
base_contents(filename+".BASE", self, False)
176
this_contents(filename+".THIS", self, False)
177
return ReplaceContents(this_contents, None)
179
def rem_contents_conflict(self, filename, this_contents, base_contents):
180
base_contents(filename+".BASE", self, False)
181
this_contents(filename+".THIS", self, False)
182
self.conflict("Other branch deleted locally modified file %s" %
184
return ReplaceContents(this_contents, None)
186
def abs_this_path(self, file_id):
187
"""Return the absolute path for a file_id in the this tree."""
188
return self.this_tree.id2abspath(file_id)
190
def add_missing_parents(self, file_id, tree):
191
"""If some of the parents for file_id are missing, add them."""
192
entry = tree.inventory[file_id]
193
if entry.parent_id not in self.this_tree:
194
return self.create_all_missing(entry.parent_id, tree)
196
return self.abs_this_path(entry.parent_id)
198
def create_all_missing(self, file_id, tree):
199
"""Add contents for a file_id and all its parents to a tree."""
200
entry = tree.inventory[file_id]
201
if entry.parent_id is not None and entry.parent_id not in self.this_tree:
202
abspath = self.create_all_missing(entry.parent_id, tree)
204
abspath = self.abs_this_path(entry.parent_id)
205
entry_path = os.path.join(abspath, entry.name)
206
if not os.path.isdir(entry_path):
207
self.create(file_id, entry_path, tree)
210
def create(self, file_id, path, tree, reverse=False):
211
"""Uses tree data to create a filesystem object for the file_id"""
212
from changeset import get_contents
213
get_contents(tree, file_id)(path, self, reverse)
215
def missing_for_merge(self, file_id, other_path):
216
"""The file_id doesn't exist in THIS, but does in OTHER and BASE"""
217
self.conflict("Other branch modified locally deleted file %s" %
219
parent_dir = self.add_missing_parents(file_id, self.other_tree)
220
stem = os.path.join(parent_dir, os.path.basename(other_path))
221
self.create(file_id, stem+".OTHER", self.other_tree)
222
self.create(file_id, stem+".BASE", self.base_tree)
224
def threeway_contents_conflict(filename, this_contents, base_contents,
226
self.conflict("Three-way conflict merging %s" % filename)
229
if self.conflicts == 0:
230
if not self.ignore_zero:
231
note("All changes applied successfully.")
233
note("%d conflicts encountered." % self.conflicts)
235
def get_tree(treespec, local_branch=None):
57
236
location, revno = treespec
237
branch = Branch.open_containing(location)[0]
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()
241
revision = branch.last_revision()
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()
243
revision = branch.get_rev_id(revno)
245
revision = NULL_REVISION
246
return branch, get_revid_tree(branch, revision, local_branch)
248
def get_revid_tree(branch, revision, local_branch):
250
base_tree = branch.working_tree()
75
252
if local_branch is not None:
76
if local_branch.base != branch.base:
77
local_branch.fetch(branch, revision_id)
78
base_tree = local_branch.repository.revision_tree(revision_id)
253
greedy_fetch(local_branch, branch, revision)
254
base_tree = local_branch.revision_tree(revision)
80
base_tree = branch.repository.revision_tree(revision_id)
256
base_tree = branch.revision_tree(revision)
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)
260
def file_exists(tree, file_id):
261
return tree.has_filename(tree.id2path(file_id))
264
def build_working_dir(to_dir):
265
"""Build a working directory in an empty directory.
267
to_dir is a directory containing branch metadata but no working files,
268
typically constructed by cloning an existing branch.
270
This is split out as a special idiomatic case of merge. It could
271
eventually be done by just building the tree directly calling into
272
lower-level code (e.g. constructing a changeset).
274
# RBC 20051019 is this not just 'export' ?
275
# AB Well, export doesn't take care of inventory...
276
this_branch = Branch.open_containing(to_dir)[0]
277
transform_tree(this_branch.working_tree(), this_branch.basis_tree())
94
280
def transform_tree(from_tree, to_tree, interesting_ids=None):
95
281
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
96
interesting_ids=interesting_ids, this_tree=from_tree)
282
interesting_ids=interesting_ids)
285
def merge(other_revision, base_revision,
286
check_clean=True, ignore_zero=False,
287
this_dir=None, backup_files=False, merge_type=ApplyMerge3,
288
file_list=None, show_base=False, reprocess=False):
289
"""Merge changes into a tree.
292
list(path, revno) Base for three-way merge.
293
If [None, None] then a base will be automatically determined.
295
list(path, revno) Other revision for three-way merge.
297
Directory to merge changes into; '.' by default.
299
If true, this_dir must have no uncommitted changes before the
301
ignore_zero - If true, suppress the "zero conflicts" message when
302
there are no conflicts; should be set when doing something we expect
303
to complete perfectly.
304
file_list - If supplied, merge only changes to selected files.
306
All available ancestors of other_revision and base_revision are
307
automatically pulled into the branch.
309
The revno may be -1 to indicate the last revision on the branch, which is
312
This function is intended for use from the command line; programmatic
313
clients might prefer to call merge_inner(), which has less magic behavior.
317
this_branch = Branch.open_containing(this_dir)[0]
318
if show_base and not merge_type is ApplyMerge3:
319
raise BzrCommandError("Show-base is not supported for this merge"
320
" type. %s" % merge_type)
321
if reprocess and not merge_type is ApplyMerge3:
322
raise BzrCommandError("Reprocess is not supported for this merge"
323
" type. %s" % merge_type)
324
if reprocess and show_base:
325
raise BzrCommandError("Cannot reprocess and show base.")
326
merger = Merger(this_branch)
327
merger.check_basis(check_clean)
328
merger.set_other(other_revision)
329
merger.set_base(base_revision)
330
if merger.base_rev_id == merger.other_rev_id:
331
note('Nothing to do.')
333
merger.backup_files = backup_files
334
merger.merge_type = merge_type
335
merger.set_interesting_files(file_list)
336
merger.show_base = show_base
337
merger.reprocess = reprocess
338
merger.conflict_handler = MergeConflictHandler(merger.this_tree,
341
ignore_zero=ignore_zero)
342
conflicts = merger.do_merge()
346
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
348
merge_type=ApplyMerge3,
349
interesting_ids=None,
353
interesting_files=None):
354
"""Primary interface for merging.
356
typical use is probably
357
'merge_inner(branch, branch.get_revision_tree(other_revision),
358
branch.get_revision_tree(base_revision))'
360
merger = Merger(this_branch, other_tree, base_tree)
361
merger.backup_files = backup_files
362
merger.merge_type = merge_type
363
merger.interesting_ids = interesting_ids
364
if interesting_files:
365
assert not interesting_ids, ('Only supply interesting_ids'
366
' or interesting_files')
367
merger._set_interesting_files(interesting_files)
368
merger.show_base = show_base
369
merger.reprocess = reprocess
370
merger.conflict_handler = MergeConflictHandler(merger.this_tree, base_tree,
372
ignore_zero=ignore_zero)
373
merger.other_rev_id = other_rev_id
374
merger.other_basis = other_rev_id
375
return merger.do_merge()
99
378
class Merger(object):
100
def __init__(self, this_branch, other_tree=None, base_tree=None,
101
this_tree=None, pb=DummyProgress(), change_reporter=None,
379
def __init__(self, this_branch, other_tree=None, base_tree=None):
103
380
object.__init__(self)
104
assert this_tree is not None, "this_tree is required"
105
381
self.this_branch = this_branch
106
382
self.this_basis = this_branch.last_revision()
107
383
self.this_rev_id = None
108
self.this_tree = this_tree
384
self.this_tree = this_branch.working_tree()
109
385
self.this_revision_tree = None
110
386
self.this_basis_tree = None
111
387
self.other_tree = other_tree
112
self.other_branch = None
113
388
self.base_tree = base_tree
114
389
self.ignore_zero = False
115
390
self.backup_files = False
116
391
self.interesting_ids = None
117
392
self.show_base = False
118
393
self.reprocess = False
121
self.recurse = recurse
122
self.change_reporter = change_reporter
394
self.conflict_handler = MergeConflictHandler(self.this_tree, base_tree,
124
397
def revision_tree(self, revision_id):
125
return self.this_branch.repository.revision_tree(revision_id)
398
return self.this_branch.revision_tree(revision_id)
127
400
def ensure_revision_trees(self):
128
401
if self.this_revision_tree is None:
129
self.this_basis_tree = self.this_branch.repository.revision_tree(
402
self.this_basis_tree = self.this_branch.revision_tree(
131
404
if self.this_basis == self.this_rev_id:
132
405
self.this_revision_tree = self.this_basis_tree
134
408
if self.other_rev_id is None:
135
409
other_basis_tree = self.revision_tree(self.other_basis)
136
changes = other_basis_tree.changes_from(self.other_tree)
410
changes = compare_trees(self.other_tree, other_basis_tree)
137
411
if changes.has_changed():
138
412
raise WorkingTreeNotRevision(self.this_tree)
139
other_rev_id = self.other_basis
413
other_rev_id = other_basis
140
414
self.other_tree = other_basis_tree
142
417
def file_revisions(self, file_id):
143
418
self.ensure_revision_trees()
144
419
def get_id(tree, file_id):
202
496
if self.other_rev_id is None:
204
ancestry = set(self.this_branch.repository.get_ancestry(
205
self.this_basis, topo_sorted=False))
206
if self.other_rev_id in ancestry:
498
if self.other_rev_id in self.this_branch.get_ancestry(self.this_basis):
208
self.this_tree.add_parent_tree((self.other_rev_id, self.other_tree))
500
self.this_branch.working_tree().add_pending_merge(self.other_rev_id)
210
502
def set_other(self, other_revision):
211
"""Set the revision and tree to merge from.
213
This sets the other_tree, other_rev_id, other_basis attributes.
215
:param other_revision: The [path, revision] list to merge from.
217
self.other_branch, self.other_tree = _get_tree(other_revision,
503
other_branch, self.other_tree = get_tree(other_revision,
219
505
if other_revision[1] == -1:
220
self.other_rev_id = self.other_branch.last_revision()
506
self.other_rev_id = other_branch.last_revision()
221
507
if self.other_rev_id is None:
222
raise NoCommits(self.other_branch)
508
raise NoCommits(other_branch)
223
509
self.other_basis = self.other_rev_id
224
510
elif other_revision[1] is not None:
225
self.other_rev_id = self.other_branch.get_rev_id(other_revision[1])
511
self.other_rev_id = other_branch.get_rev_id(other_revision[1])
226
512
self.other_basis = self.other_rev_id
228
514
self.other_rev_id = None
229
self.other_basis = self.other_branch.last_revision()
515
self.other_basis = other_branch.last_revision()
230
516
if self.other_basis is None:
231
raise NoCommits(self.other_branch)
232
if self.other_branch.base != self.this_branch.base:
233
self.this_branch.fetch(self.other_branch,
234
last_revision=self.other_basis)
236
def set_other_revision(self, revision_id, other_branch):
237
"""Set 'other' based on a branch and revision id
239
:param revision_id: The revision to use for a tree
240
:param other_branch: The branch containing this tree
242
self.other_rev_id = revision_id
243
self.other_branch = other_branch
244
self.this_branch.fetch(other_branch, self.other_rev_id)
245
self.other_tree = self.revision_tree(revision_id)
246
self.other_basis = revision_id
249
self.set_base([None, None])
517
raise NoCommits(other_branch)
518
fetch(from_branch=other_branch, to_branch=self.this_branch,
519
last_revision=self.other_basis)
251
521
def set_base(self, base_revision):
252
"""Set the base revision to use for the merge.
254
:param base_revision: A 2-list containing a path and revision number.
256
522
mutter("doing merge() with no base_revision specified")
257
523
if base_revision == [None, None]:
259
pb = ui.ui_factory.nested_progress_bar()
261
this_repo = self.this_branch.repository
262
graph = this_repo.get_graph()
263
revisions = [ensure_null(self.this_basis),
264
ensure_null(self.other_basis)]
265
if NULL_REVISION in revisions:
266
self.base_rev_id = NULL_REVISION
268
self.base_rev_id = graph.find_unique_lca(*revisions)
269
if self.base_rev_id == NULL_REVISION:
270
raise UnrelatedBranches()
525
self.base_rev_id = common_ancestor(self.this_basis,
273
528
except NoCommonAncestor:
274
529
raise UnrelatedBranches()
275
self.base_tree = _get_revid_tree_from_tree(self.this_tree,
530
self.base_tree = get_revid_tree(self.this_branch, self.base_rev_id,
278
532
self.base_is_ancestor = True
280
base_branch, self.base_tree = _get_tree(base_revision)
534
base_branch, self.base_tree = get_tree(base_revision)
281
535
if base_revision[1] == -1:
282
536
self.base_rev_id = base_branch.last_revision()
283
537
elif base_revision[1] is None:
284
538
self.base_rev_id = None
286
540
self.base_rev_id = base_branch.get_rev_id(base_revision[1])
287
if self.this_branch.base != base_branch.base:
288
self.this_branch.fetch(base_branch)
541
fetch(from_branch=base_branch, to_branch=self.this_branch)
289
542
self.base_is_ancestor = is_ancestor(self.this_basis,
290
543
self.base_rev_id,
291
544
self.this_branch)
293
546
def do_merge(self):
294
kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
295
'other_tree': self.other_tree,
296
'interesting_ids': self.interesting_ids,
298
if self.merge_type.requires_base:
299
kwargs['base_tree'] = self.base_tree
300
if self.merge_type.supports_reprocess:
301
kwargs['reprocess'] = self.reprocess
303
raise BzrError("Conflict reduction is not supported for merge"
304
" type %s." % self.merge_type)
305
if self.merge_type.supports_show_base:
306
kwargs['show_base'] = self.show_base
308
raise BzrError("Showing base is not supported for this"
309
" merge type. %s" % self.merge_type)
310
self.this_tree.lock_tree_write()
311
if self.base_tree is not None:
312
self.base_tree.lock_read()
313
if self.other_tree is not None:
314
self.other_tree.lock_read()
316
merge = self.merge_type(pb=self._pb,
317
change_reporter=self.change_reporter,
319
if self.recurse == 'down':
320
for path, file_id in self.this_tree.iter_references():
321
sub_tree = self.this_tree.get_nested_tree(file_id, path)
322
other_revision = self.other_tree.get_reference_revision(
324
if other_revision == sub_tree.last_revision():
326
sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
327
sub_merge.merge_type = self.merge_type
328
relpath = self.this_tree.relpath(path)
329
other_branch = self.other_branch.reference_parent(file_id, relpath)
330
sub_merge.set_other_revision(other_revision, other_branch)
331
base_revision = self.base_tree.get_reference_revision(file_id)
332
sub_merge.base_tree = \
333
sub_tree.branch.repository.revision_tree(base_revision)
337
if self.other_tree is not None:
338
self.other_tree.unlock()
339
if self.base_tree is not None:
340
self.base_tree.unlock()
341
self.this_tree.unlock()
342
if len(merge.cooked_conflicts) == 0:
343
if not self.ignore_zero:
344
note("All changes applied successfully.")
346
note("%d conflicts encountered." % len(merge.cooked_conflicts))
348
return len(merge.cooked_conflicts)
547
def get_inventory(tree):
548
return tree.inventory
550
inv_changes = merge_flex(self.this_tree, self.base_tree,
552
generate_changeset, get_inventory,
553
self.conflict_handler,
554
merge_factory=self.merge_factory,
555
interesting_ids=self.interesting_ids)
558
for id, path in inv_changes.iteritems():
563
assert path.startswith('.' + '/') or path.startswith('.' + '\\'), "path is %s" % path
565
adjust_ids.append((path, id))
566
if len(adjust_ids) > 0:
567
self.this_branch.working_tree().set_inventory(self.regen_inventory(adjust_ids))
568
conflicts = self.conflict_handler.conflicts
569
self.conflict_handler.finalize()
350
572
def regen_inventory(self, new_entries):
351
old_entries = self.this_tree.read_working_inventory()
573
old_entries = self.this_branch.working_tree().read_working_inventory()
352
574
new_inventory = {}
354
576
new_entries_map = {}
416
629
new_inventory_list.sort()
417
630
return new_inventory_list
420
class Merge3Merger(object):
421
"""Three-way merger that uses the merge3 text merger"""
423
supports_reprocess = True
424
supports_show_base = True
425
history_based = False
427
def __init__(self, working_tree, this_tree, base_tree, other_tree,
428
interesting_ids=None, reprocess=False, show_base=False,
429
pb=DummyProgress(), pp=None, change_reporter=None):
430
"""Initialize the merger object and perform the merge."""
431
object.__init__(self)
432
self.this_tree = working_tree
433
self.this_tree.lock_tree_write()
434
self.base_tree = base_tree
435
self.base_tree.lock_read()
436
self.other_tree = other_tree
437
self.other_tree.lock_read()
438
self._raw_conflicts = []
439
self.cooked_conflicts = []
440
self.reprocess = reprocess
441
self.show_base = show_base
444
self.change_reporter = change_reporter
446
self.pp = ProgressPhase("Merge phase", 3, self.pb)
448
if interesting_ids is not None:
449
all_ids = interesting_ids
451
all_ids = set(base_tree)
452
all_ids.update(other_tree)
453
self.tt = TreeTransform(working_tree, self.pb)
456
child_pb = ui.ui_factory.nested_progress_bar()
458
for num, file_id in enumerate(all_ids):
459
child_pb.update('Preparing file merge', num, len(all_ids))
460
self.merge_names(file_id)
461
file_status = self.merge_contents(file_id)
462
self.merge_executable(file_id, file_status)
467
child_pb = ui.ui_factory.nested_progress_bar()
469
fs_conflicts = resolve_conflicts(self.tt, child_pb)
472
if change_reporter is not None:
473
from bzrlib import delta
474
delta.report_changes(self.tt._iter_changes(), change_reporter)
475
self.cook_conflicts(fs_conflicts)
476
for conflict in self.cooked_conflicts:
479
results = self.tt.apply()
480
self.write_modified(results)
482
working_tree.add_conflicts(self.cooked_conflicts)
483
except UnsupportedOperation:
487
self.other_tree.unlock()
488
self.base_tree.unlock()
489
self.this_tree.unlock()
494
self.tt.final_kind(self.tt.root)
496
self.tt.cancel_deletion(self.tt.root)
497
if self.tt.final_file_id(self.tt.root) is None:
498
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
500
if self.other_tree.inventory.root is None:
502
other_root_file_id = self.other_tree.inventory.root.file_id
503
other_root = self.tt.trans_id_file_id(other_root_file_id)
504
if other_root == self.tt.root:
507
self.tt.final_kind(other_root)
510
self.reparent_children(self.other_tree.inventory.root, self.tt.root)
511
self.tt.cancel_creation(other_root)
512
self.tt.cancel_versioning(other_root)
514
def reparent_children(self, ie, target):
515
for thing, child in ie.children.iteritems():
516
trans_id = self.tt.trans_id_file_id(child.file_id)
517
self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
519
def write_modified(self, results):
521
for path in results.modified_paths:
522
file_id = self.this_tree.path2id(self.this_tree.relpath(path))
525
hash = self.this_tree.get_file_sha1(file_id)
528
modified_hashes[file_id] = hash
529
self.this_tree.set_merge_modified(modified_hashes)
532
def parent(entry, file_id):
533
"""Determine the parent for a file_id (used as a key method)"""
536
return entry.parent_id
539
def name(entry, file_id):
540
"""Determine the name for a file_id (used as a key method)"""
546
def contents_sha1(tree, file_id):
547
"""Determine the sha1 of the file contents (used as a key method)."""
548
if file_id not in tree:
550
return tree.get_file_sha1(file_id)
553
def executable(tree, file_id):
554
"""Determine the executability of a file-id (used as a key method)."""
555
if file_id not in tree:
557
if tree.kind(file_id) != "file":
559
return tree.is_executable(file_id)
562
def kind(tree, file_id):
563
"""Determine the kind of a file-id (used as a key method)."""
564
if file_id not in tree:
566
return tree.kind(file_id)
569
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
570
"""Do a three-way test on a scalar.
571
Return "this", "other" or "conflict", depending whether a value wins.
573
key_base = key(base_tree, file_id)
574
key_other = key(other_tree, file_id)
575
#if base == other, either they all agree, or only THIS has changed.
576
if key_base == key_other:
578
key_this = key(this_tree, file_id)
579
if key_this not in (key_base, key_other):
581
# "Ambiguous clean merge"
582
elif key_this == key_other:
585
assert key_this == key_base
588
def merge_names(self, file_id):
589
"""Perform a merge on file_id names and parents"""
591
if file_id in tree.inventory:
592
return tree.inventory[file_id]
595
this_entry = get_entry(self.this_tree)
596
other_entry = get_entry(self.other_tree)
597
base_entry = get_entry(self.base_tree)
598
name_winner = self.scalar_three_way(this_entry, base_entry,
599
other_entry, file_id, self.name)
600
parent_id_winner = self.scalar_three_way(this_entry, base_entry,
601
other_entry, file_id,
603
if this_entry is None:
604
if name_winner == "this":
605
name_winner = "other"
606
if parent_id_winner == "this":
607
parent_id_winner = "other"
608
if name_winner == "this" and parent_id_winner == "this":
610
if name_winner == "conflict":
611
trans_id = self.tt.trans_id_file_id(file_id)
612
self._raw_conflicts.append(('name conflict', trans_id,
613
self.name(this_entry, file_id),
614
self.name(other_entry, file_id)))
615
if parent_id_winner == "conflict":
616
trans_id = self.tt.trans_id_file_id(file_id)
617
self._raw_conflicts.append(('parent conflict', trans_id,
618
self.parent(this_entry, file_id),
619
self.parent(other_entry, file_id)))
620
if other_entry is None:
621
# it doesn't matter whether the result was 'other' or
622
# 'conflict'-- if there's no 'other', we leave it alone.
624
# if we get here, name_winner and parent_winner are set to safe values.
625
winner_entry = {"this": this_entry, "other": other_entry,
626
"conflict": other_entry}
627
trans_id = self.tt.trans_id_file_id(file_id)
628
parent_id = winner_entry[parent_id_winner].parent_id
629
if parent_id is not None:
630
parent_trans_id = self.tt.trans_id_file_id(parent_id)
631
self.tt.adjust_path(winner_entry[name_winner].name,
632
parent_trans_id, trans_id)
634
def merge_contents(self, file_id):
635
"""Performa a merge on file_id contents."""
636
def contents_pair(tree):
637
if file_id not in tree:
639
kind = tree.kind(file_id)
641
contents = tree.get_file_sha1(file_id)
642
elif kind == "symlink":
643
contents = tree.get_symlink_target(file_id)
646
return kind, contents
648
def contents_conflict():
649
trans_id = self.tt.trans_id_file_id(file_id)
650
name = self.tt.final_name(trans_id)
651
parent_id = self.tt.final_parent(trans_id)
652
if file_id in self.this_tree.inventory:
653
self.tt.unversion_file(trans_id)
654
if file_id in self.this_tree:
655
self.tt.delete_contents(trans_id)
656
file_group = self._dump_conflicts(name, parent_id, file_id,
658
self._raw_conflicts.append(('contents conflict', file_group))
660
# See SPOT run. run, SPOT, run.
661
# So we're not QUITE repeating ourselves; we do tricky things with
663
base_pair = contents_pair(self.base_tree)
664
other_pair = contents_pair(self.other_tree)
665
if base_pair == other_pair:
666
# OTHER introduced no changes
668
this_pair = contents_pair(self.this_tree)
669
if this_pair == other_pair:
670
# THIS and OTHER introduced the same changes
673
trans_id = self.tt.trans_id_file_id(file_id)
674
if this_pair == base_pair:
675
# only OTHER introduced changes
676
if file_id in self.this_tree:
677
# Remove any existing contents
678
self.tt.delete_contents(trans_id)
679
if file_id in self.other_tree:
680
# OTHER changed the file
681
create_by_entry(self.tt,
682
self.other_tree.inventory[file_id],
683
self.other_tree, trans_id)
684
if file_id not in self.this_tree.inventory:
685
self.tt.version_file(file_id, trans_id)
687
elif file_id in self.this_tree.inventory:
688
# OTHER deleted the file
689
self.tt.unversion_file(trans_id)
691
#BOTH THIS and OTHER introduced changes; scalar conflict
692
elif this_pair[0] == "file" and other_pair[0] == "file":
693
# THIS and OTHER are both files, so text merge. Either
694
# BASE is a file, or both converted to files, so at least we
695
# have agreement that output should be a file.
697
self.text_merge(file_id, trans_id)
699
return contents_conflict()
700
if file_id not in self.this_tree.inventory:
701
self.tt.version_file(file_id, trans_id)
703
self.tt.tree_kind(trans_id)
704
self.tt.delete_contents(trans_id)
709
# Scalar conflict, can't text merge. Dump conflicts
710
return contents_conflict()
712
def get_lines(self, tree, file_id):
713
"""Return the lines in a file, or an empty list."""
715
return tree.get_file(file_id).readlines()
719
def text_merge(self, file_id, trans_id):
720
"""Perform a three-way text merge on a file_id"""
721
# it's possible that we got here with base as a different type.
722
# if so, we just want two-way text conflicts.
723
if file_id in self.base_tree and \
724
self.base_tree.kind(file_id) == "file":
725
base_lines = self.get_lines(self.base_tree, file_id)
728
other_lines = self.get_lines(self.other_tree, file_id)
729
this_lines = self.get_lines(self.this_tree, file_id)
730
m3 = Merge3(base_lines, this_lines, other_lines)
731
start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
732
if self.show_base is True:
733
base_marker = '|' * 7
737
def iter_merge3(retval):
738
retval["text_conflicts"] = False
739
for line in m3.merge_lines(name_a = "TREE",
740
name_b = "MERGE-SOURCE",
741
name_base = "BASE-REVISION",
742
start_marker=start_marker,
743
base_marker=base_marker,
744
reprocess=self.reprocess):
745
if line.startswith(start_marker):
746
retval["text_conflicts"] = True
747
yield line.replace(start_marker, '<' * 7)
751
merge3_iterator = iter_merge3(retval)
752
self.tt.create_file(merge3_iterator, trans_id)
753
if retval["text_conflicts"] is True:
754
self._raw_conflicts.append(('text conflict', trans_id))
755
name = self.tt.final_name(trans_id)
756
parent_id = self.tt.final_parent(trans_id)
757
file_group = self._dump_conflicts(name, parent_id, file_id,
758
this_lines, base_lines,
760
file_group.append(trans_id)
762
def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
763
base_lines=None, other_lines=None, set_version=False,
765
"""Emit conflict files.
766
If this_lines, base_lines, or other_lines are omitted, they will be
767
determined automatically. If set_version is true, the .OTHER, .THIS
768
or .BASE (in that order) will be created as versioned files.
770
data = [('OTHER', self.other_tree, other_lines),
771
('THIS', self.this_tree, this_lines)]
773
data.append(('BASE', self.base_tree, base_lines))
776
for suffix, tree, lines in data:
778
trans_id = self._conflict_file(name, parent_id, tree, file_id,
780
file_group.append(trans_id)
781
if set_version and not versioned:
782
self.tt.version_file(file_id, trans_id)
786
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
788
"""Emit a single conflict file."""
789
name = name + '.' + suffix
790
trans_id = self.tt.create_path(name, parent_id)
791
entry = tree.inventory[file_id]
792
create_by_entry(self.tt, entry, tree, trans_id, lines)
795
def merge_executable(self, file_id, file_status):
796
"""Perform a merge on the execute bit."""
797
if file_status == "deleted":
799
trans_id = self.tt.trans_id_file_id(file_id)
801
if self.tt.final_kind(trans_id) != "file":
805
winner = self.scalar_three_way(self.this_tree, self.base_tree,
806
self.other_tree, file_id,
808
if winner == "conflict":
809
# There must be a None in here, if we have a conflict, but we
810
# need executability since file status was not deleted.
811
if self.executable(self.other_tree, file_id) is None:
816
if file_status == "modified":
817
executability = self.this_tree.is_executable(file_id)
818
if executability is not None:
819
trans_id = self.tt.trans_id_file_id(file_id)
820
self.tt.set_executability(executability, trans_id)
822
assert winner == "other"
823
if file_id in self.other_tree:
824
executability = self.other_tree.is_executable(file_id)
825
elif file_id in self.this_tree:
826
executability = self.this_tree.is_executable(file_id)
827
elif file_id in self.base_tree:
828
executability = self.base_tree.is_executable(file_id)
829
if executability is not None:
830
trans_id = self.tt.trans_id_file_id(file_id)
831
self.tt.set_executability(executability, trans_id)
833
def cook_conflicts(self, fs_conflicts):
834
"""Convert all conflicts into a form that doesn't depend on trans_id"""
835
from conflicts import Conflict
837
self.cooked_conflicts.extend(cook_conflicts(fs_conflicts, self.tt))
838
fp = FinalPaths(self.tt)
839
for conflict in self._raw_conflicts:
840
conflict_type = conflict[0]
841
if conflict_type in ('name conflict', 'parent conflict'):
842
trans_id = conflict[1]
843
conflict_args = conflict[2:]
844
if trans_id not in name_conflicts:
845
name_conflicts[trans_id] = {}
846
unique_add(name_conflicts[trans_id], conflict_type,
848
if conflict_type == 'contents conflict':
849
for trans_id in conflict[1]:
850
file_id = self.tt.final_file_id(trans_id)
851
if file_id is not None:
853
path = fp.get_path(trans_id)
854
for suffix in ('.BASE', '.THIS', '.OTHER'):
855
if path.endswith(suffix):
856
path = path[:-len(suffix)]
858
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
859
self.cooked_conflicts.append(c)
860
if conflict_type == 'text conflict':
861
trans_id = conflict[1]
862
path = fp.get_path(trans_id)
863
file_id = self.tt.final_file_id(trans_id)
864
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
865
self.cooked_conflicts.append(c)
867
for trans_id, conflicts in name_conflicts.iteritems():
869
this_parent, other_parent = conflicts['parent conflict']
870
assert this_parent != other_parent
872
this_parent = other_parent = \
873
self.tt.final_file_id(self.tt.final_parent(trans_id))
875
this_name, other_name = conflicts['name conflict']
876
assert this_name != other_name
878
this_name = other_name = self.tt.final_name(trans_id)
879
other_path = fp.get_path(trans_id)
880
if this_parent is not None and this_name is not None:
882
fp.get_path(self.tt.trans_id_file_id(this_parent))
883
this_path = pathjoin(this_parent_path, this_name)
885
this_path = "<deleted>"
886
file_id = self.tt.final_file_id(trans_id)
887
c = Conflict.factory('path conflict', path=this_path,
888
conflict_path=other_path, file_id=file_id)
889
self.cooked_conflicts.append(c)
890
self.cooked_conflicts.sort(key=Conflict.sort_key)
893
class WeaveMerger(Merge3Merger):
894
"""Three-way tree merger, text weave merger."""
895
supports_reprocess = True
896
supports_show_base = False
898
def __init__(self, working_tree, this_tree, base_tree, other_tree,
899
interesting_ids=None, pb=DummyProgress(), pp=None,
900
reprocess=False, change_reporter=None):
901
self.this_revision_tree = self._get_revision_tree(this_tree)
902
self.other_revision_tree = self._get_revision_tree(other_tree)
903
super(WeaveMerger, self).__init__(working_tree, this_tree,
904
base_tree, other_tree,
905
interesting_ids=interesting_ids,
906
pb=pb, pp=pp, reprocess=reprocess,
907
change_reporter=change_reporter)
909
def _get_revision_tree(self, tree):
910
"""Return a revision tree related to this tree.
911
If the tree is a WorkingTree, the basis will be returned.
913
if getattr(tree, 'get_weave', False) is False:
914
# If we have a WorkingTree, try using the basis
915
return tree.branch.basis_tree()
919
def _check_file(self, file_id):
920
"""Check that the revision tree's version of the file matches."""
921
for tree, rt in ((self.this_tree, self.this_revision_tree),
922
(self.other_tree, self.other_revision_tree)):
925
if tree.get_file_sha1(file_id) != rt.get_file_sha1(file_id):
926
raise WorkingTreeNotRevision(self.this_tree)
928
def _merged_lines(self, file_id):
929
"""Generate the merged lines.
930
There is no distinction between lines that are meant to contain <<<<<<<
933
weave = self.this_revision_tree.get_weave(file_id)
934
this_revision_id = self.this_revision_tree.inventory[file_id].revision
935
other_revision_id = \
936
self.other_revision_tree.inventory[file_id].revision
937
wm = WeaveMerge(weave, this_revision_id, other_revision_id,
938
'<<<<<<< TREE\n', '>>>>>>> MERGE-SOURCE\n')
939
return wm.merge_lines(self.reprocess)
941
def text_merge(self, file_id, trans_id):
942
"""Perform a (weave) text merge for a given file and file-id.
943
If conflicts are encountered, .THIS and .OTHER files will be emitted,
944
and a conflict will be noted.
946
self._check_file(file_id)
947
lines, conflicts = self._merged_lines(file_id)
949
# Note we're checking whether the OUTPUT is binary in this case,
950
# because we don't want to get into weave merge guts.
951
check_text_lines(lines)
952
self.tt.create_file(lines, trans_id)
954
self._raw_conflicts.append(('text conflict', trans_id))
955
name = self.tt.final_name(trans_id)
956
parent_id = self.tt.final_parent(trans_id)
957
file_group = self._dump_conflicts(name, parent_id, file_id,
959
file_group.append(trans_id)
962
class Diff3Merger(Merge3Merger):
963
"""Three-way merger using external diff3 for text merging"""
965
def dump_file(self, temp_dir, name, tree, file_id):
966
out_path = pathjoin(temp_dir, name)
967
out_file = open(out_path, "wb")
969
in_file = tree.get_file(file_id)
976
def text_merge(self, file_id, trans_id):
977
"""Perform a diff3 merge using a specified file-id and trans-id.
978
If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
979
will be dumped, and a will be conflict noted.
982
temp_dir = osutils.mkdtemp(prefix="bzr-")
984
new_file = pathjoin(temp_dir, "new")
985
this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
986
base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
987
other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
988
status = bzrlib.patch.diff3(new_file, this, base, other)
989
if status not in (0, 1):
990
raise BzrError("Unhandled diff3 exit code")
991
f = open(new_file, 'rb')
993
self.tt.create_file(f, trans_id)
997
name = self.tt.final_name(trans_id)
998
parent_id = self.tt.final_parent(trans_id)
999
self._dump_conflicts(name, parent_id, file_id)
1000
self._raw_conflicts.append(('text conflict', trans_id))
1002
osutils.rmtree(temp_dir)
1005
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1007
merge_type=Merge3Merger,
1008
interesting_ids=None,
1012
interesting_files=None,
1015
change_reporter=None):
1016
"""Primary interface for merging.
1018
typical use is probably
1019
'merge_inner(branch, branch.get_revision_tree(other_revision),
1020
branch.get_revision_tree(base_revision))'
1022
if this_tree is None:
1023
raise BzrError("bzrlib.merge.merge_inner requires a this_tree "
1024
"parameter as of bzrlib version 0.8.")
1025
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1026
pb=pb, change_reporter=change_reporter)
1027
merger.backup_files = backup_files
1028
merger.merge_type = merge_type
1029
merger.interesting_ids = interesting_ids
1030
merger.ignore_zero = ignore_zero
1031
if interesting_files:
1032
assert not interesting_ids, ('Only supply interesting_ids'
1033
' or interesting_files')
1034
merger._set_interesting_files(interesting_files)
1035
merger.show_base = show_base
1036
merger.reprocess = reprocess
1037
merger.other_rev_id = other_rev_id
1038
merger.other_basis = other_rev_id
1039
return merger.do_merge()
1041
def get_merge_type_registry():
1042
"""Merge type registry is in bzrlib.option to avoid circular imports.
1044
This method provides a sanctioned way to retrieve it.
1046
from bzrlib import option
1047
return option._merge_type_registry
632
merge_types = { "merge3": (ApplyMerge3, "Native diff3-style merge"),
633
"diff3": (Diff3Merge, "Merge using external diff3"),
634
'weave': (WeaveMerge, "Weave-based merge")
added
removed
bzrlib/merge.py
