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
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
29
from bzrlib.branch import Branch
30
from bzrlib.errors import (BzrCommandError,
34
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
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.branch.rename_one(relpath, new_path)
118
assert self.this_tree.id2path(file_id) == relpath
119
self.this_tree._inventory = self.this_tree.read_working_inventory()
120
assert self.this_tree.id2path(file_id) == new_path
122
if e.errno != errno.EEXIST and e.errno != errno.ENOTEMPTY:
124
return self.add_suffix(name, suffix, last_new_name=new_name,
125
fix_inventory=fix_inventory)
128
def conflict(self, text):
133
def merge_conflict(self, new_file, this_path, base_lines, other_lines):
135
Handle diff3 conflicts by producing a .THIS, .BASE and .OTHER. The
136
main file will be a version with diff3 conflicts.
137
:param new_file: Path to the output file with diff3 markers
138
:param this_path: Path to the file text for the THIS tree
139
:param base_path: Path to the file text for the BASE tree
140
:param other_path: Path to the file text for the OTHER tree
142
self.add_suffix(this_path, ".THIS", fix_inventory=False)
143
self.dump(base_lines, this_path+".BASE")
144
self.dump(other_lines, this_path+".OTHER")
145
rename(new_file, this_path)
146
self.conflict("Diff3 conflict encountered in %s" % this_path)
148
def weave_merge_conflict(self, filename, weave, other_i, out_file):
150
Handle weave conflicts by producing a .THIS, and .OTHER. The
151
main file will be a version with diff3-style conflicts.
153
self.add_suffix(filename, ".THIS")
155
self.dump(weave.get_iter(other_i), filename+".OTHER")
156
self.conflict("Text conflict encountered in %s" % filename)
158
def new_contents_conflict(self, filename, other_contents):
159
"""Conflicting contents for newly added file."""
160
other_contents(filename + ".OTHER", self, False)
161
self.conflict("Conflict in newly added file %s" % filename)
164
def target_exists(self, entry, target, old_path):
165
"""Handle the case when the target file or dir exists"""
166
moved_path = self.add_suffix(target, ".moved")
167
self.conflict("Moved existing %s to %s" % (target, moved_path))
169
def rmdir_non_empty(self, filename):
170
"""Handle the case where the dir to be removed still has contents"""
171
self.conflict("Directory %s not removed because it is not empty"\
175
def rem_contents_conflict(self, filename, this_contents, base_contents):
176
base_contents(filename+".BASE", self, False)
177
this_contents(filename+".THIS", self, False)
178
return ReplaceContents(this_contents, None)
180
def rem_contents_conflict(self, filename, this_contents, base_contents):
181
base_contents(filename+".BASE", self, False)
182
this_contents(filename+".THIS", self, False)
183
self.conflict("Other branch deleted locally modified file %s" %
185
return ReplaceContents(this_contents, None)
187
def abs_this_path(self, file_id):
188
"""Return the absolute path for a file_id in the this tree."""
189
return self.this_tree.id2abspath(file_id)
191
def add_missing_parents(self, file_id, tree):
192
"""If some of the parents for file_id are missing, add them."""
193
entry = tree.inventory[file_id]
194
if entry.parent_id not in self.this_tree:
195
return self.create_all_missing(entry.parent_id, tree)
197
return self.abs_this_path(entry.parent_id)
199
def create_all_missing(self, file_id, tree):
200
"""Add contents for a file_id and all its parents to a tree."""
201
entry = tree.inventory[file_id]
202
if entry.parent_id is not None and entry.parent_id not in self.this_tree:
203
abspath = self.create_all_missing(entry.parent_id, tree)
205
abspath = self.abs_this_path(entry.parent_id)
206
entry_path = os.path.join(abspath, entry.name)
207
if not os.path.isdir(entry_path):
208
self.create(file_id, entry_path, tree)
211
def create(self, file_id, path, tree, reverse=False):
212
"""Uses tree data to create a filesystem object for the file_id"""
213
from changeset import get_contents
214
get_contents(tree, file_id)(path, self, reverse)
216
def missing_for_merge(self, file_id, other_path):
217
"""The file_id doesn't exist in THIS, but does in OTHER and BASE"""
218
self.conflict("Other branch modified locally deleted file %s" %
220
parent_dir = self.add_missing_parents(file_id, self.other_tree)
221
stem = os.path.join(parent_dir, os.path.basename(other_path))
222
self.create(file_id, stem+".OTHER", self.other_tree)
223
self.create(file_id, stem+".BASE", self.base_tree)
225
def threeway_contents_conflict(filename, this_contents, base_contents,
227
self.conflict("Three-way conflict merging %s" % filename)
230
if not self.ignore_zero:
231
note("%d conflicts encountered.\n" % self.conflicts)
233
def get_tree(treespec, local_branch=None):
234
location, revno = treespec
235
branch = Branch.open_containing(location)[0]
239
revision = branch.last_revision()
241
revision = branch.get_rev_id(revno)
243
revision = NULL_REVISION
244
return branch, get_revid_tree(branch, revision, local_branch)
246
def get_revid_tree(branch, revision, local_branch):
248
base_tree = branch.working_tree()
250
if local_branch is not None:
251
greedy_fetch(local_branch, branch, revision)
252
base_tree = local_branch.revision_tree(revision)
254
base_tree = branch.revision_tree(revision)
258
def file_exists(tree, file_id):
259
return tree.has_filename(tree.id2path(file_id))
262
def build_working_dir(to_dir):
263
"""Build a working directory in an empty directory.
265
to_dir is a directory containing branch metadata but no working files,
266
typically constructed by cloning an existing branch.
268
This is split out as a special idiomatic case of merge. It could
269
eventually be done by just building the tree directly calling into
270
lower-level code (e.g. constructing a changeset).
272
# RBC 20051019 is this not just 'export' ?
273
# AB Well, export doesn't take care of inventory...
274
this_branch = Branch.open_containing(to_dir)[0]
275
transform_tree(this_branch.working_tree(), this_branch.basis_tree())
278
def transform_tree(from_tree, to_tree):
279
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True)
282
def merge(other_revision, base_revision,
283
check_clean=True, ignore_zero=False,
284
this_dir=None, backup_files=False, merge_type=ApplyMerge3,
285
file_list=None, show_base=False, reprocess=False):
286
"""Merge changes into a tree.
289
list(path, revno) Base for three-way merge.
290
If [None, None] then a base will be automatically determined.
292
list(path, revno) Other revision for three-way merge.
294
Directory to merge changes into; '.' by default.
296
If true, this_dir must have no uncommitted changes before the
298
ignore_zero - If true, suppress the "zero conflicts" message when
299
there are no conflicts; should be set when doing something we expect
300
to complete perfectly.
301
file_list - If supplied, merge only changes to selected files.
303
All available ancestors of other_revision and base_revision are
304
automatically pulled into the branch.
306
The revno may be -1 to indicate the last revision on the branch, which is
309
This function is intended for use from the command line; programmatic
310
clients might prefer to call merge_inner(), which has less magic behavior.
314
this_branch = Branch.open_containing(this_dir)[0]
315
if show_base and not merge_type is ApplyMerge3:
316
raise BzrCommandError("Show-base is not supported for this merge"
317
" type. %s" % merge_type)
318
if reprocess and not merge_type is ApplyMerge3:
319
raise BzrCommandError("Reprocess is not supported for this merge"
320
" type. %s" % merge_type)
321
if reprocess and show_base:
322
raise BzrCommandError("Cannot reprocess and show base.")
323
merger = Merger(this_branch)
324
merger.check_basis(check_clean)
325
merger.set_other(other_revision)
326
merger.set_base(base_revision)
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,
341
backup_files=False, merge_type=ApplyMerge3,
342
interesting_ids=None, show_base=False, reprocess=False,
343
interesting_files=None):
344
"""Primary interface for merging.
346
typical use is probably
347
'merge_inner(branch, branch.get_revision_tree(other_revision),
348
branch.get_revision_tree(base_revision))'
350
merger = Merger(this_branch, other_tree, base_tree)
351
merger.backup_files = backup_files
352
merger.merge_type = merge_type
353
merger.interesting_ids = interesting_ids
354
if interesting_files:
355
assert not interesting_ids, ('Only supply interesting_ids'
356
' or interesting_files')
357
merger._set_interesting_files(interesting_files)
358
merger.show_base = show_base
359
merger.reprocess = reprocess
360
merger.conflict_handler = MergeConflictHandler(merger.this_tree, base_tree,
362
ignore_zero=ignore_zero)
363
return merger.do_merge()
366
class Merger(object):
367
def __init__(self, this_branch, other_tree=None, base_tree=None):
368
object.__init__(self)
369
self.this_branch = this_branch
370
self.this_basis = this_branch.last_revision()
371
self.this_rev_id = None
372
self.this_tree = this_branch.working_tree()
373
self.this_revision_tree = None
374
self.other_tree = other_tree
375
self.base_tree = base_tree
376
self.ignore_zero = False
377
self.backup_files = False
378
self.interesting_ids = None
379
self.show_base = False
380
self.reprocess = False
381
self.conflict_handler = MergeConflictHandler(self.this_tree, base_tree,
384
def revision_tree(self, revision_id):
385
return self.this_branch.revision_tree(revision_id)
387
def ensure_revision_trees(self):
388
if self.this_revision_tree is None:
389
if self.this_rev_id is None:
391
if self.this_rev_id is None:
392
raise WorkingTreeNotRevision(self.this_tree)
393
self.this_revision_tree = self.this_branch.revision_tree(
396
if self.other_rev_id is None:
397
other_basis_tree = self.revision_tree(self.other_basis)
398
changes = compare_trees(self.other_tree, other_basis_tree)
399
if changes.has_changed():
400
raise WorkingTreeNotRevision(self.this_tree)
401
other_rev_id = other_basis
402
self.other_tree = other_basis_tree
405
def file_revisions(self, file_id):
406
self.ensure_revision_trees()
407
def get_id(tree, file_id):
408
revision_id = tree.inventory[file_id].revision
409
assert revision_id is not None
411
trees = (self.this_revision_tree, self.other_tree)
412
return [get_id(tree, file_id) for tree in trees]
415
def merge_factory(self, file_id, base, other):
416
if self.merge_type.history_based:
417
t_revid, o_revid = self.file_revisions(file_id)
418
weave = self.this_revision_tree.get_weave(file_id)
419
contents_change = self.merge_type(weave, t_revid, o_revid)
421
if self.show_base is True or self.reprocess is True:
422
contents_change = self.merge_type(file_id, base, other,
423
show_base=self.show_base,
424
reprocess=self.reprocess)
426
contents_change = self.merge_type(file_id, base, other)
427
if self.backup_files:
428
contents_change = BackupBeforeChange(contents_change)
429
return contents_change
431
def check_basis(self, check_clean):
432
if self.this_basis is None:
433
raise BzrCommandError("This branch has no commits")
436
if self.this_basis != self.this_rev_id:
437
raise BzrCommandError("Working tree has uncommitted changes.")
439
def compare_basis(self):
440
changes = compare_trees(self.this_branch.working_tree(),
441
self.this_branch.basis_tree(), False)
442
if not changes.has_changed():
443
self.this_rev_id = self.this_basis
445
def set_interesting_files(self, file_list):
447
self._set_interesting_files(file_list)
448
except NotVersionedError, e:
449
raise BzrCommandError("%s is not a source file in any"
452
def _set_interesting_files(self, file_list):
453
"""Set the list of interesting ids from a list of files."""
454
if file_list is None:
455
self.interesting_ids = None
458
interesting_ids = set()
459
for fname in file_list:
460
path = self.this_tree.relpath(fname)
462
for tree in (self.this_tree, self.base_tree, self.other_tree):
463
file_id = tree.inventory.path2id(path)
464
if file_id is not None:
465
interesting_ids.add(file_id)
468
raise NotVersionedError(path=fname)
469
self.interesting_ids = interesting_ids
471
def set_pending(self):
472
if not self.base_is_ancestor:
474
if self.other_rev_id is None:
476
if self.other_rev_id in self.this_branch.get_ancestry(self.this_basis):
478
self.this_branch.add_pending_merge(self.other_rev_id)
480
def set_other(self, other_revision):
481
other_branch, self.other_tree = get_tree(other_revision,
483
if other_revision[1] == -1:
484
self.other_rev_id = other_branch.last_revision()
485
if self.other_rev_id is None:
486
raise NoCommits(other_branch)
487
self.other_basis = self.other_rev_id
488
elif other_revision[1] is not None:
489
self.other_rev_id = other_branch.get_rev_id(other_revision[1])
490
self.other_basis = self.other_rev_id
492
self.other_rev_id = None
493
self.other_basis = other_branch.last_revision()
494
if self.other_basis is None:
495
raise NoCommits(other_branch)
496
fetch(from_branch=other_branch, to_branch=self.this_branch,
497
last_revision=self.other_basis)
499
def set_base(self, base_revision):
500
mutter("doing merge() with no base_revision specified")
501
if base_revision == [None, None]:
503
self.base_rev_id = common_ancestor(self.this_basis,
506
except NoCommonAncestor:
507
raise UnrelatedBranches()
508
self.base_tree = get_revid_tree(self.this_branch, self.base_rev_id,
510
self.base_is_ancestor = True
512
base_branch, self.base_tree = get_tree(base_revision)
513
if base_revision[1] == -1:
514
self.base_rev_id = base_branch.last_revision()
515
elif base_revision[1] is None:
516
self.base_rev_id = None
518
self.base_rev_id = base_branch.get_rev_id(base_revision[1])
519
fetch(from_branch=base_branch, to_branch=self.this_branch)
520
self.base_is_ancestor = is_ancestor(self.this_basis,
525
def get_inventory(tree):
526
return tree.inventory
528
inv_changes = merge_flex(self.this_tree, self.base_tree,
530
generate_changeset, get_inventory,
531
self.conflict_handler,
532
merge_factory=self.merge_factory,
533
interesting_ids=self.interesting_ids)
536
for id, path in inv_changes.iteritems():
541
assert path.startswith('.' + os.sep), "path is %s" % path
543
adjust_ids.append((path, id))
544
if len(adjust_ids) > 0:
545
self.this_branch.working_tree().set_inventory(self.regen_inventory(adjust_ids))
546
conflicts = self.conflict_handler.conflicts
547
self.conflict_handler.finalize()
550
def regen_inventory(self, new_entries):
551
old_entries = self.this_branch.working_tree().read_working_inventory()
555
for path, file_id in new_entries:
558
new_entries_map[file_id] = path
560
def id2path(file_id):
561
path = new_entries_map.get(file_id)
564
entry = old_entries[file_id]
565
if entry.parent_id is None:
567
return os.path.join(id2path(entry.parent_id), entry.name)
569
for file_id in old_entries:
570
entry = old_entries[file_id]
571
path = id2path(file_id)
572
new_inventory[file_id] = (path, file_id, entry.parent_id,
574
by_path[path] = file_id
579
for path, file_id in new_entries:
581
del new_inventory[file_id]
584
new_path_list.append((path, file_id))
585
if file_id not in old_entries:
587
# Ensure no file is added before its parent
589
for path, file_id in new_path_list:
593
parent = by_path[os.path.dirname(path)]
594
abspath = os.path.join(self.this_tree.basedir, path)
595
kind = bzrlib.osutils.file_kind(abspath)
596
new_inventory[file_id] = (path, file_id, parent, kind)
597
by_path[path] = file_id
599
# Get a list in insertion order
600
new_inventory_list = new_inventory.values()
601
mutter ("""Inventory regeneration:
602
old length: %i insertions: %i deletions: %i new_length: %i"""\
603
% (len(old_entries), insertions, deletions,
604
len(new_inventory_list)))
605
assert len(new_inventory_list) == len(old_entries) + insertions\
607
new_inventory_list.sort()
608
return new_inventory_list
610
merge_types = { "merge3": (ApplyMerge3, "Native diff3-style merge"),
611
"diff3": (Diff3Merge, "Merge using external diff3"),
612
'weave': (WeaveMerge, "Weave-based merge")
added
removed
bzrlib/merge.py
