1
# Copyright (C) 2005 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23
import bzrlib.revision
24
from bzrlib.merge_core import merge_flex, ApplyMerge3, BackupBeforeChange
25
from bzrlib.merge_core import WeaveMerge
26
from bzrlib.changeset import generate_changeset, ExceptionConflictHandler
27
from bzrlib.changeset import Inventory, Diff3Merge, ReplaceContents
28
from bzrlib.branch import Branch
29
from bzrlib.errors import (BzrCommandError,
33
WorkingTreeNotRevision,
37
from bzrlib.delta import compare_trees
38
from bzrlib.trace import mutter, warning, note
39
from bzrlib.fetch import greedy_fetch, fetch
40
from bzrlib.revision import is_ancestor, NULL_REVISION
41
from bzrlib.osutils import rename, pathjoin
42
from bzrlib.revision import common_ancestor, MultipleRevisionSources
43
from bzrlib.errors import NoSuchRevision
45
# TODO: Report back as changes are merged in
47
# TODO: build_working_dir can be built on something simpler than merge()
49
# FIXME: merge() parameters seem oriented towards the command line
50
# NOTABUG: merge is a helper for commandline functions. merge_inner is the
51
# the core functionality.
53
# comments from abentley on irc: merge happens in two stages, each
54
# of which generates a changeset object
56
# stage 1: generate OLD->OTHER,
57
# stage 2: use MINE and OLD->OTHER to generate MINE -> RESULT
59
class MergeConflictHandler(ExceptionConflictHandler):
60
"""Handle conflicts encountered while merging.
62
This subclasses ExceptionConflictHandler, so that any types of
63
conflict that are not explicitly handled cause an exception and
66
def __init__(self, this_tree, base_tree, other_tree, ignore_zero=False):
67
ExceptionConflictHandler.__init__(self)
69
self.ignore_zero = ignore_zero
70
self.this_tree = this_tree
71
self.base_tree = base_tree
72
self.other_tree = other_tree
74
def copy(self, source, dest):
75
"""Copy the text and mode of a file
76
:param source: The path of the file to copy
77
:param dest: The distination file to create
79
s_file = file(source, "rb")
80
d_file = file(dest, "wb")
83
os.chmod(dest, 0777 & os.stat(source).st_mode)
85
def dump(self, lines, dest):
86
"""Copy the text and mode of a file
87
:param source: The path of the file to copy
88
:param dest: The distination file to create
90
d_file = file(dest, "wb")
94
def add_suffix(self, name, suffix, last_new_name=None, fix_inventory=True):
95
"""Rename a file to append a suffix. If the new name exists, the
96
suffix is added repeatedly until a non-existant name is found
98
:param name: The path of the file
99
:param suffix: The suffix to append
100
:param last_new_name: (used for recursive calls) the last name tried
102
if last_new_name is None:
104
new_name = last_new_name+suffix
106
rename(name, new_name)
107
if fix_inventory is True:
109
relpath = self.this_tree.relpath(name)
110
except NotBranchError:
112
if relpath is not None:
113
file_id = self.this_tree.path2id(relpath)
114
if file_id is not None:
115
new_path = self.this_tree.relpath(new_name)
116
rename(new_name, name)
117
self.this_tree.rename_one(relpath, new_path)
118
assert self.this_tree.id2path(file_id) == new_path
120
if e.errno != errno.EEXIST and e.errno != errno.ENOTEMPTY:
122
return self.add_suffix(name, suffix, last_new_name=new_name,
123
fix_inventory=fix_inventory)
126
def conflict(self, text):
131
def merge_conflict(self, new_file, this_path, base_lines, other_lines):
133
Handle diff3 conflicts by producing a .THIS, .BASE and .OTHER. The
134
main file will be a version with diff3 conflicts.
135
:param new_file: Path to the output file with diff3 markers
136
:param this_path: Path to the file text for the THIS tree
137
:param base_path: Path to the file text for the BASE tree
138
:param other_path: Path to the file text for the OTHER tree
140
self.add_suffix(this_path, ".THIS", fix_inventory=False)
141
self.dump(base_lines, this_path+".BASE")
142
self.dump(other_lines, this_path+".OTHER")
143
rename(new_file, this_path)
144
self.conflict("Diff3 conflict encountered in %s" % this_path)
146
def weave_merge_conflict(self, filename, weave, other_i, out_file):
148
Handle weave conflicts by producing a .THIS, and .OTHER. The
149
main file will be a version with diff3-style conflicts.
151
self.add_suffix(filename, ".THIS", fix_inventory=False)
153
self.dump(weave.get_iter(other_i), filename+".OTHER")
154
self.conflict("Text conflict encountered in %s" % filename)
156
def new_contents_conflict(self, filename, other_contents):
157
"""Conflicting contents for newly added file."""
158
other_contents(filename + ".OTHER", self, False)
159
self.conflict("Conflict in newly added file %s" % filename)
162
def target_exists(self, entry, target, old_path):
163
"""Handle the case when the target file or dir exists"""
164
moved_path = self.add_suffix(target, ".moved")
165
self.conflict("Moved existing %s to %s" % (target, moved_path))
167
def rmdir_non_empty(self, filename):
168
"""Handle the case where the dir to be removed still has contents"""
169
self.conflict("Directory %s not removed because it is not empty"\
173
def rem_contents_conflict(self, filename, this_contents, base_contents):
174
base_contents(filename+".BASE", self, False)
175
this_contents(filename+".THIS", self, False)
176
return ReplaceContents(this_contents, None)
178
def rem_contents_conflict(self, filename, this_contents, base_contents):
179
base_contents(filename+".BASE", self, False)
180
this_contents(filename+".THIS", self, False)
181
self.conflict("Other branch deleted locally modified file %s" %
183
return ReplaceContents(this_contents, None)
185
def abs_this_path(self, file_id):
186
"""Return the absolute path for a file_id in the this tree."""
187
return self.this_tree.id2abspath(file_id)
189
def add_missing_parents(self, file_id, tree):
190
"""If some of the parents for file_id are missing, add them."""
191
entry = tree.inventory[file_id]
192
if entry.parent_id not in self.this_tree:
193
return self.create_all_missing(entry.parent_id, tree)
195
return self.abs_this_path(entry.parent_id)
197
def create_all_missing(self, file_id, tree):
198
"""Add contents for a file_id and all its parents to a tree."""
199
entry = tree.inventory[file_id]
200
if entry.parent_id is not None and entry.parent_id not in self.this_tree:
201
abspath = self.create_all_missing(entry.parent_id, tree)
203
abspath = self.abs_this_path(entry.parent_id)
204
entry_path = pathjoin(abspath, entry.name)
205
if not os.path.isdir(entry_path):
206
self.create(file_id, entry_path, tree)
209
def create(self, file_id, path, tree, reverse=False):
210
"""Uses tree data to create a filesystem object for the file_id"""
211
from changeset import get_contents
212
get_contents(tree, file_id)(path, self, reverse)
214
def missing_for_merge(self, file_id, other_path):
215
"""The file_id doesn't exist in THIS, but does in OTHER and BASE"""
216
self.conflict("Other branch modified locally deleted file %s" %
218
parent_dir = self.add_missing_parents(file_id, self.other_tree)
219
stem = pathjoin(parent_dir, os.path.basename(other_path))
220
self.create(file_id, stem+".OTHER", self.other_tree)
221
self.create(file_id, stem+".BASE", self.base_tree)
223
def threeway_contents_conflict(filename, this_contents, base_contents,
225
self.conflict("Three-way conflict merging %s" % filename)
228
if self.conflicts == 0:
229
if not self.ignore_zero:
230
note("All changes applied successfully.")
232
note("%d conflicts encountered." % self.conflicts)
234
def get_tree(treespec, local_branch=None):
235
location, revno = treespec
236
branch = Branch.open_containing(location)[0]
240
revision = branch.last_revision()
242
revision = branch.get_rev_id(revno)
244
revision = NULL_REVISION
245
return branch, get_revid_tree(branch, revision, local_branch)
247
def get_revid_tree(branch, revision, local_branch):
249
base_tree = branch.working_tree()
251
if local_branch is not None:
252
greedy_fetch(local_branch, branch, revision)
253
base_tree = local_branch.revision_tree(revision)
255
base_tree = branch.revision_tree(revision)
259
def file_exists(tree, file_id):
260
return tree.has_filename(tree.id2path(file_id))
263
def build_working_dir(to_dir):
264
"""Build a working directory in an empty directory.
266
to_dir is a directory containing branch metadata but no working files,
267
typically constructed by cloning an existing branch.
269
This is split out as a special idiomatic case of merge. It could
270
eventually be done by just building the tree directly calling into
271
lower-level code (e.g. constructing a changeset).
273
# RBC 20051019 is this not just 'export' ?
274
# AB Well, export doesn't take care of inventory...
275
this_branch = Branch.open_containing(to_dir)[0]
276
transform_tree(this_branch.working_tree(), this_branch.basis_tree())
279
def transform_tree(from_tree, to_tree, interesting_ids=None):
280
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
281
interesting_ids=interesting_ids)
284
def merge(other_revision, base_revision,
285
check_clean=True, ignore_zero=False,
286
this_dir=None, backup_files=False, merge_type=ApplyMerge3,
287
file_list=None, show_base=False, reprocess=False):
288
"""Merge changes into a tree.
291
list(path, revno) Base for three-way merge.
292
If [None, None] then a base will be automatically determined.
294
list(path, revno) Other revision for three-way merge.
296
Directory to merge changes into; '.' by default.
298
If true, this_dir must have no uncommitted changes before the
300
ignore_zero - If true, suppress the "zero conflicts" message when
301
there are no conflicts; should be set when doing something we expect
302
to complete perfectly.
303
file_list - If supplied, merge only changes to selected files.
305
All available ancestors of other_revision and base_revision are
306
automatically pulled into the branch.
308
The revno may be -1 to indicate the last revision on the branch, which is
311
This function is intended for use from the command line; programmatic
312
clients might prefer to call merge_inner(), which has less magic behavior.
316
this_branch = Branch.open_containing(this_dir)[0]
317
if show_base and not merge_type is ApplyMerge3:
318
raise BzrCommandError("Show-base is not supported for this merge"
319
" type. %s" % merge_type)
320
if reprocess and not merge_type is ApplyMerge3:
321
raise BzrCommandError("Reprocess is not supported for this merge"
322
" type. %s" % merge_type)
323
if reprocess and show_base:
324
raise BzrCommandError("Cannot reprocess and show base.")
325
merger = Merger(this_branch)
326
merger.check_basis(check_clean)
327
merger.set_other(other_revision)
328
merger.set_base(base_revision)
329
if merger.base_rev_id == merger.other_rev_id:
330
note('Nothing to do.')
332
merger.backup_files = backup_files
333
merger.merge_type = merge_type
334
merger.set_interesting_files(file_list)
335
merger.show_base = show_base
336
merger.reprocess = reprocess
337
merger.conflict_handler = MergeConflictHandler(merger.this_tree,
340
ignore_zero=ignore_zero)
341
conflicts = merger.do_merge()
345
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
347
merge_type=ApplyMerge3,
348
interesting_ids=None,
352
interesting_files=None):
353
"""Primary interface for merging.
355
typical use is probably
356
'merge_inner(branch, branch.get_revision_tree(other_revision),
357
branch.get_revision_tree(base_revision))'
359
merger = Merger(this_branch, other_tree, base_tree)
360
merger.backup_files = backup_files
361
merger.merge_type = merge_type
362
merger.interesting_ids = interesting_ids
363
if interesting_files:
364
assert not interesting_ids, ('Only supply interesting_ids'
365
' or interesting_files')
366
merger._set_interesting_files(interesting_files)
367
merger.show_base = show_base
368
merger.reprocess = reprocess
369
merger.conflict_handler = MergeConflictHandler(merger.this_tree, base_tree,
371
ignore_zero=ignore_zero)
372
merger.other_rev_id = other_rev_id
373
merger.other_basis = other_rev_id
374
return merger.do_merge()
377
class Merger(object):
378
def __init__(self, this_branch, other_tree=None, base_tree=None):
379
object.__init__(self)
380
self.this_branch = this_branch
381
self.this_basis = this_branch.last_revision()
382
self.this_rev_id = None
383
self.this_tree = this_branch.working_tree()
384
self.this_revision_tree = None
385
self.this_basis_tree = None
386
self.other_tree = other_tree
387
self.base_tree = base_tree
388
self.ignore_zero = False
389
self.backup_files = False
390
self.interesting_ids = None
391
self.show_base = False
392
self.reprocess = False
393
self.conflict_handler = MergeConflictHandler(self.this_tree, base_tree,
396
def revision_tree(self, revision_id):
397
return self.this_branch.revision_tree(revision_id)
399
def ensure_revision_trees(self):
400
if self.this_revision_tree is None:
401
self.this_basis_tree = self.this_branch.revision_tree(
403
if self.this_basis == self.this_rev_id:
404
self.this_revision_tree = self.this_basis_tree
407
if self.other_rev_id is None:
408
other_basis_tree = self.revision_tree(self.other_basis)
409
changes = compare_trees(self.other_tree, other_basis_tree)
410
if changes.has_changed():
411
raise WorkingTreeNotRevision(self.this_tree)
412
other_rev_id = other_basis
413
self.other_tree = other_basis_tree
416
def file_revisions(self, file_id):
417
self.ensure_revision_trees()
418
def get_id(tree, file_id):
419
revision_id = tree.inventory[file_id].revision
420
assert revision_id is not None
422
if self.this_rev_id is None:
423
if self.this_basis_tree.get_file_sha1(file_id) != \
424
self.this_tree.get_file_sha1(file_id):
425
raise WorkingTreeNotRevision(self.this_tree)
427
trees = (self.this_basis_tree, self.other_tree)
428
return [get_id(tree, file_id) for tree in trees]
431
def merge_factory(self, file_id, base, other):
432
if self.merge_type.history_based:
433
if self.show_base is True:
434
raise BzrError("Cannot show base for hisory-based merges")
435
if self.reprocess is True:
436
raise BzrError("Cannot reprocess history-based merges")
438
t_revid, o_revid = self.file_revisions(file_id)
439
weave = self.this_basis_tree.get_weave(file_id)
440
contents_change = self.merge_type(weave, t_revid, o_revid)
442
if self.show_base is True or self.reprocess is True:
443
contents_change = self.merge_type(file_id, base, other,
444
show_base=self.show_base,
445
reprocess=self.reprocess)
447
contents_change = self.merge_type(file_id, base, other)
448
if self.backup_files:
449
contents_change = BackupBeforeChange(contents_change)
450
return contents_change
452
def check_basis(self, check_clean):
453
if self.this_basis is None:
454
raise BzrCommandError("This branch has no commits")
457
if self.this_basis != self.this_rev_id:
458
raise BzrCommandError("Working tree has uncommitted changes.")
460
def compare_basis(self):
461
changes = compare_trees(self.this_branch.working_tree(),
462
self.this_branch.basis_tree(), False)
463
if not changes.has_changed():
464
self.this_rev_id = self.this_basis
466
def set_interesting_files(self, file_list):
468
self._set_interesting_files(file_list)
469
except NotVersionedError, e:
470
raise BzrCommandError("%s is not a source file in any"
473
def _set_interesting_files(self, file_list):
474
"""Set the list of interesting ids from a list of files."""
475
if file_list is None:
476
self.interesting_ids = None
479
interesting_ids = set()
480
for fname in file_list:
481
path = self.this_tree.relpath(fname)
483
for tree in (self.this_tree, self.base_tree, self.other_tree):
484
file_id = tree.inventory.path2id(path)
485
if file_id is not None:
486
interesting_ids.add(file_id)
489
raise NotVersionedError(path=fname)
490
self.interesting_ids = interesting_ids
492
def set_pending(self):
493
if not self.base_is_ancestor:
495
if self.other_rev_id is None:
497
if self.other_rev_id in self.this_branch.get_ancestry(self.this_basis):
499
self.this_branch.working_tree().add_pending_merge(self.other_rev_id)
501
def set_other(self, other_revision):
502
other_branch, self.other_tree = get_tree(other_revision,
504
if other_revision[1] == -1:
505
self.other_rev_id = other_branch.last_revision()
506
if self.other_rev_id is None:
507
raise NoCommits(other_branch)
508
self.other_basis = self.other_rev_id
509
elif other_revision[1] is not None:
510
self.other_rev_id = other_branch.get_rev_id(other_revision[1])
511
self.other_basis = self.other_rev_id
513
self.other_rev_id = None
514
self.other_basis = other_branch.last_revision()
515
if self.other_basis is None:
516
raise NoCommits(other_branch)
517
fetch(from_branch=other_branch, to_branch=self.this_branch,
518
last_revision=self.other_basis)
520
def set_base(self, base_revision):
521
mutter("doing merge() with no base_revision specified")
522
if base_revision == [None, None]:
524
self.base_rev_id = common_ancestor(self.this_basis,
527
except NoCommonAncestor:
528
raise UnrelatedBranches()
529
self.base_tree = get_revid_tree(self.this_branch, self.base_rev_id,
531
self.base_is_ancestor = True
533
base_branch, self.base_tree = get_tree(base_revision)
534
if base_revision[1] == -1:
535
self.base_rev_id = base_branch.last_revision()
536
elif base_revision[1] is None:
537
self.base_rev_id = None
539
self.base_rev_id = base_branch.get_rev_id(base_revision[1])
540
fetch(from_branch=base_branch, to_branch=self.this_branch)
541
self.base_is_ancestor = is_ancestor(self.this_basis,
546
def get_inventory(tree):
547
return tree.inventory
549
inv_changes = merge_flex(self.this_tree, self.base_tree,
551
generate_changeset, get_inventory,
552
self.conflict_handler,
553
merge_factory=self.merge_factory,
554
interesting_ids=self.interesting_ids)
557
for id, path in inv_changes.iteritems():
562
assert path.startswith('.' + '/') or path.startswith('.' + '\\'), "path is %s" % path
564
adjust_ids.append((path, id))
565
if len(adjust_ids) > 0:
566
self.this_branch.working_tree().set_inventory(self.regen_inventory(adjust_ids))
567
conflicts = self.conflict_handler.conflicts
568
self.conflict_handler.finalize()
571
def regen_inventory(self, new_entries):
572
old_entries = self.this_branch.working_tree().read_working_inventory()
576
for path, file_id in new_entries:
579
new_entries_map[file_id] = path
581
def id2path(file_id):
582
path = new_entries_map.get(file_id)
585
entry = old_entries[file_id]
586
if entry.parent_id is None:
588
return pathjoin(id2path(entry.parent_id), entry.name)
590
for file_id in old_entries:
591
entry = old_entries[file_id]
592
path = id2path(file_id)
593
new_inventory[file_id] = (path, file_id, entry.parent_id,
595
by_path[path] = file_id
600
for path, file_id in new_entries:
602
del new_inventory[file_id]
605
new_path_list.append((path, file_id))
606
if file_id not in old_entries:
608
# Ensure no file is added before its parent
610
for path, file_id in new_path_list:
614
parent = by_path[os.path.dirname(path)]
615
abspath = pathjoin(self.this_tree.basedir, path)
616
kind = bzrlib.osutils.file_kind(abspath)
617
new_inventory[file_id] = (path, file_id, parent, kind)
618
by_path[path] = file_id
620
# Get a list in insertion order
621
new_inventory_list = new_inventory.values()
622
mutter ("""Inventory regeneration:
623
old length: %i insertions: %i deletions: %i new_length: %i"""\
624
% (len(old_entries), insertions, deletions,
625
len(new_inventory_list)))
626
assert len(new_inventory_list) == len(old_entries) + insertions\
628
new_inventory_list.sort()
629
return new_inventory_list
631
merge_types = { "merge3": (ApplyMerge3, "Native diff3-style merge"),
632
"diff3": (Diff3Merge, "Merge using external diff3"),
633
'weave': (WeaveMerge, "Weave-based merge")
added
removed
bzrlib/merge.py
