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)
175
this_contents(filename+".THIS", self)
176
self.conflict("Other branch deleted locally modified file %s" %
178
return ReplaceContents(this_contents, None)
180
def abs_this_path(self, file_id):
181
"""Return the absolute path for a file_id in the this tree."""
182
return self.this_tree.id2abspath(file_id)
184
def add_missing_parents(self, file_id, tree):
185
"""If some of the parents for file_id are missing, add them."""
186
entry = tree.inventory[file_id]
187
if entry.parent_id not in self.this_tree:
188
return self.create_all_missing(entry.parent_id, tree)
190
return self.abs_this_path(entry.parent_id)
192
def create_all_missing(self, file_id, tree):
193
"""Add contents for a file_id and all its parents to a tree."""
194
entry = tree.inventory[file_id]
195
if entry.parent_id is not None and entry.parent_id not in self.this_tree:
196
abspath = self.create_all_missing(entry.parent_id, tree)
198
abspath = self.abs_this_path(entry.parent_id)
199
entry_path = pathjoin(abspath, entry.name)
200
if not os.path.isdir(entry_path):
201
self.create(file_id, entry_path, tree)
204
def create(self, file_id, path, tree):
205
"""Uses tree data to create a filesystem object for the file_id"""
206
from changeset import get_contents
207
get_contents(tree, file_id)(path, self)
209
def missing_for_merge(self, file_id, other_path):
210
"""The file_id doesn't exist in THIS, but does in OTHER and BASE"""
211
self.conflict("Other branch modified locally deleted file %s" %
213
parent_dir = self.add_missing_parents(file_id, self.other_tree)
214
stem = pathjoin(parent_dir, os.path.basename(other_path))
215
self.create(file_id, stem+".OTHER", self.other_tree)
216
self.create(file_id, stem+".BASE", self.base_tree)
218
def threeway_contents_conflict(filename, this_contents, base_contents,
220
self.conflict("Three-way conflict merging %s" % filename)
223
if self.conflicts == 0:
224
if not self.ignore_zero:
225
note("All changes applied successfully.")
227
note("%d conflicts encountered." % self.conflicts)
229
def get_tree(treespec, local_branch=None):
230
location, revno = treespec
231
branch = Branch.open_containing(location)[0]
235
revision = branch.last_revision()
237
revision = branch.get_rev_id(revno)
239
revision = NULL_REVISION
240
return branch, get_revid_tree(branch, revision, local_branch)
242
def get_revid_tree(branch, revision, local_branch):
244
base_tree = branch.working_tree()
246
if local_branch is not None:
247
greedy_fetch(local_branch, branch, revision)
248
base_tree = local_branch.revision_tree(revision)
250
base_tree = branch.revision_tree(revision)
254
def file_exists(tree, file_id):
255
return tree.has_filename(tree.id2path(file_id))
258
def build_working_dir(to_dir):
259
"""Build a working directory in an empty directory.
261
to_dir is a directory containing branch metadata but no working files,
262
typically constructed by cloning an existing branch.
264
This is split out as a special idiomatic case of merge. It could
265
eventually be done by just building the tree directly calling into
266
lower-level code (e.g. constructing a changeset).
268
# RBC 20051019 is this not just 'export' ?
269
# AB Well, export doesn't take care of inventory...
270
this_branch = Branch.open_containing(to_dir)[0]
271
transform_tree(this_branch.working_tree(), this_branch.basis_tree())
274
def transform_tree(from_tree, to_tree, interesting_ids=None):
275
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
276
interesting_ids=interesting_ids)
279
def merge(other_revision, base_revision,
280
check_clean=True, ignore_zero=False,
281
this_dir=None, backup_files=False, merge_type=ApplyMerge3,
282
file_list=None, show_base=False, reprocess=False):
283
"""Merge changes into a tree.
286
list(path, revno) Base for three-way merge.
287
If [None, None] then a base will be automatically determined.
289
list(path, revno) Other revision for three-way merge.
291
Directory to merge changes into; '.' by default.
293
If true, this_dir must have no uncommitted changes before the
295
ignore_zero - If true, suppress the "zero conflicts" message when
296
there are no conflicts; should be set when doing something we expect
297
to complete perfectly.
298
file_list - If supplied, merge only changes to selected files.
300
All available ancestors of other_revision and base_revision are
301
automatically pulled into the branch.
303
The revno may be -1 to indicate the last revision on the branch, which is
306
This function is intended for use from the command line; programmatic
307
clients might prefer to call merge_inner(), which has less magic behavior.
311
this_branch = Branch.open_containing(this_dir)[0]
312
if show_base and not merge_type is ApplyMerge3:
313
raise BzrCommandError("Show-base is not supported for this merge"
314
" type. %s" % merge_type)
315
if reprocess and not merge_type is ApplyMerge3:
316
raise BzrCommandError("Reprocess is not supported for this merge"
317
" type. %s" % merge_type)
318
if reprocess and show_base:
319
raise BzrCommandError("Cannot reprocess and show base.")
320
merger = Merger(this_branch)
321
merger.check_basis(check_clean)
322
merger.set_other(other_revision)
323
merger.set_base(base_revision)
324
if merger.base_rev_id == merger.other_rev_id:
325
note('Nothing to do.')
327
merger.backup_files = backup_files
328
merger.merge_type = merge_type
329
merger.set_interesting_files(file_list)
330
merger.show_base = show_base
331
merger.reprocess = reprocess
332
merger.conflict_handler = MergeConflictHandler(merger.this_tree,
335
ignore_zero=ignore_zero)
336
conflicts = merger.do_merge()
340
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
342
merge_type=ApplyMerge3,
343
interesting_ids=None,
347
interesting_files=None):
348
"""Primary interface for merging.
350
typical use is probably
351
'merge_inner(branch, branch.get_revision_tree(other_revision),
352
branch.get_revision_tree(base_revision))'
354
merger = Merger(this_branch, other_tree, base_tree)
355
merger.backup_files = backup_files
356
merger.merge_type = merge_type
357
merger.interesting_ids = interesting_ids
358
if interesting_files:
359
assert not interesting_ids, ('Only supply interesting_ids'
360
' or interesting_files')
361
merger._set_interesting_files(interesting_files)
362
merger.show_base = show_base
363
merger.reprocess = reprocess
364
merger.conflict_handler = MergeConflictHandler(merger.this_tree, base_tree,
366
ignore_zero=ignore_zero)
367
merger.other_rev_id = other_rev_id
368
merger.other_basis = other_rev_id
369
return merger.do_merge()
372
class Merger(object):
373
def __init__(self, this_branch, other_tree=None, base_tree=None):
374
object.__init__(self)
375
self.this_branch = this_branch
376
self.this_basis = this_branch.last_revision()
377
self.this_rev_id = None
378
self.this_tree = this_branch.working_tree()
379
self.this_revision_tree = None
380
self.this_basis_tree = None
381
self.other_tree = other_tree
382
self.base_tree = base_tree
383
self.ignore_zero = False
384
self.backup_files = False
385
self.interesting_ids = None
386
self.show_base = False
387
self.reprocess = False
388
self.conflict_handler = MergeConflictHandler(self.this_tree, base_tree,
391
def revision_tree(self, revision_id):
392
return self.this_branch.revision_tree(revision_id)
394
def ensure_revision_trees(self):
395
if self.this_revision_tree is None:
396
self.this_basis_tree = self.this_branch.revision_tree(
398
if self.this_basis == self.this_rev_id:
399
self.this_revision_tree = self.this_basis_tree
402
if self.other_rev_id is None:
403
other_basis_tree = self.revision_tree(self.other_basis)
404
changes = compare_trees(self.other_tree, other_basis_tree)
405
if changes.has_changed():
406
raise WorkingTreeNotRevision(self.this_tree)
407
other_rev_id = other_basis
408
self.other_tree = other_basis_tree
411
def file_revisions(self, file_id):
412
self.ensure_revision_trees()
413
def get_id(tree, file_id):
414
revision_id = tree.inventory[file_id].revision
415
assert revision_id is not None
417
if self.this_rev_id is None:
418
if self.this_basis_tree.get_file_sha1(file_id) != \
419
self.this_tree.get_file_sha1(file_id):
420
raise WorkingTreeNotRevision(self.this_tree)
422
trees = (self.this_basis_tree, self.other_tree)
423
return [get_id(tree, file_id) for tree in trees]
426
def merge_factory(self, file_id, base, other):
427
if self.merge_type.history_based:
428
if self.show_base is True:
429
raise BzrError("Cannot show base for hisory-based merges")
430
if self.reprocess is True:
431
raise BzrError("Cannot reprocess history-based merges")
433
t_revid, o_revid = self.file_revisions(file_id)
434
weave = self.this_basis_tree.get_weave(file_id)
435
contents_change = self.merge_type(weave, t_revid, o_revid)
437
if self.show_base is True or self.reprocess is True:
438
contents_change = self.merge_type(file_id, base, other,
439
show_base=self.show_base,
440
reprocess=self.reprocess)
442
contents_change = self.merge_type(file_id, base, other)
443
if self.backup_files:
444
contents_change = BackupBeforeChange(contents_change)
445
return contents_change
447
def check_basis(self, check_clean):
448
if self.this_basis is None:
449
raise BzrCommandError("This branch has no commits")
452
if self.this_basis != self.this_rev_id:
453
raise BzrCommandError("Working tree has uncommitted changes.")
455
def compare_basis(self):
456
changes = compare_trees(self.this_branch.working_tree(),
457
self.this_branch.basis_tree(), False)
458
if not changes.has_changed():
459
self.this_rev_id = self.this_basis
461
def set_interesting_files(self, file_list):
463
self._set_interesting_files(file_list)
464
except NotVersionedError, e:
465
raise BzrCommandError("%s is not a source file in any"
468
def _set_interesting_files(self, file_list):
469
"""Set the list of interesting ids from a list of files."""
470
if file_list is None:
471
self.interesting_ids = None
474
interesting_ids = set()
475
for fname in file_list:
476
path = self.this_tree.relpath(fname)
478
for tree in (self.this_tree, self.base_tree, self.other_tree):
479
file_id = tree.inventory.path2id(path)
480
if file_id is not None:
481
interesting_ids.add(file_id)
484
raise NotVersionedError(path=fname)
485
self.interesting_ids = interesting_ids
487
def set_pending(self):
488
if not self.base_is_ancestor:
490
if self.other_rev_id is None:
492
if self.other_rev_id in self.this_branch.get_ancestry(self.this_basis):
494
self.this_branch.working_tree().add_pending_merge(self.other_rev_id)
496
def set_other(self, other_revision):
497
other_branch, self.other_tree = get_tree(other_revision,
499
if other_revision[1] == -1:
500
self.other_rev_id = other_branch.last_revision()
501
if self.other_rev_id is None:
502
raise NoCommits(other_branch)
503
self.other_basis = self.other_rev_id
504
elif other_revision[1] is not None:
505
self.other_rev_id = other_branch.get_rev_id(other_revision[1])
506
self.other_basis = self.other_rev_id
508
self.other_rev_id = None
509
self.other_basis = other_branch.last_revision()
510
if self.other_basis is None:
511
raise NoCommits(other_branch)
512
fetch(from_branch=other_branch, to_branch=self.this_branch,
513
last_revision=self.other_basis)
515
def set_base(self, base_revision):
516
mutter("doing merge() with no base_revision specified")
517
if base_revision == [None, None]:
519
self.base_rev_id = common_ancestor(self.this_basis,
522
except NoCommonAncestor:
523
raise UnrelatedBranches()
524
self.base_tree = get_revid_tree(self.this_branch, self.base_rev_id,
526
self.base_is_ancestor = True
528
base_branch, self.base_tree = get_tree(base_revision)
529
if base_revision[1] == -1:
530
self.base_rev_id = base_branch.last_revision()
531
elif base_revision[1] is None:
532
self.base_rev_id = None
534
self.base_rev_id = base_branch.get_rev_id(base_revision[1])
535
fetch(from_branch=base_branch, to_branch=self.this_branch)
536
self.base_is_ancestor = is_ancestor(self.this_basis,
541
def get_inventory(tree):
542
return tree.inventory
544
inv_changes = merge_flex(self.this_tree, self.base_tree,
546
generate_changeset, get_inventory,
547
self.conflict_handler,
548
merge_factory=self.merge_factory,
549
interesting_ids=self.interesting_ids)
552
for id, path in inv_changes.iteritems():
557
assert path.startswith('.' + '/') or path.startswith('.' + '\\'), "path is %s" % path
559
adjust_ids.append((path, id))
560
if len(adjust_ids) > 0:
561
self.this_branch.working_tree().set_inventory(self.regen_inventory(adjust_ids))
562
conflicts = self.conflict_handler.conflicts
563
self.conflict_handler.finalize()
566
def regen_inventory(self, new_entries):
567
old_entries = self.this_branch.working_tree().read_working_inventory()
571
for path, file_id in new_entries:
574
new_entries_map[file_id] = path
576
def id2path(file_id):
577
path = new_entries_map.get(file_id)
580
entry = old_entries[file_id]
581
if entry.parent_id is None:
583
return pathjoin(id2path(entry.parent_id), entry.name)
585
for file_id in old_entries:
586
entry = old_entries[file_id]
587
path = id2path(file_id)
588
new_inventory[file_id] = (path, file_id, entry.parent_id,
590
by_path[path] = file_id
595
for path, file_id in new_entries:
597
del new_inventory[file_id]
600
new_path_list.append((path, file_id))
601
if file_id not in old_entries:
603
# Ensure no file is added before its parent
605
for path, file_id in new_path_list:
609
parent = by_path[os.path.dirname(path)]
610
abspath = pathjoin(self.this_tree.basedir, path)
611
kind = bzrlib.osutils.file_kind(abspath)
612
new_inventory[file_id] = (path, file_id, parent, kind)
613
by_path[path] = file_id
615
# Get a list in insertion order
616
new_inventory_list = new_inventory.values()
617
mutter ("""Inventory regeneration:
618
old length: %i insertions: %i deletions: %i new_length: %i"""\
619
% (len(old_entries), insertions, deletions,
620
len(new_inventory_list)))
621
assert len(new_inventory_list) == len(old_entries) + insertions\
623
new_inventory_list.sort()
624
return new_inventory_list
626
merge_types = { "merge3": (ApplyMerge3, "Native diff3-style merge"),
627
"diff3": (Diff3Merge, "Merge using external diff3"),
628
'weave': (WeaveMerge, "Weave-based merge")
added
removed
bzrlib/merge.py
