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
17
# TODO: build_working_dir can be built on something simpler than merge()
23
from bzrlib._changeset import generate_changeset, ExceptionConflictHandler
24
from bzrlib._changeset import Inventory, Diff3Merge, ReplaceContents
25
from bzrlib._merge_core import WeaveMerge
26
from bzrlib._merge_core import merge_flex, ApplyMerge3, BackupBeforeChange
27
from bzrlib.branch import Branch
28
from bzrlib.delta import compare_trees
29
from bzrlib.errors import (BzrCommandError,
34
WorkingTreeNotRevision,
37
from bzrlib.fetch import greedy_fetch, fetch
39
from bzrlib.osutils import rename, pathjoin
40
from bzrlib.revision import common_ancestor, MultipleRevisionSources
41
from bzrlib.revision import is_ancestor, NULL_REVISION
42
from bzrlib.trace import mutter, warning, note
44
# TODO: Report back as changes are merged in
46
# comments from abentley on irc: merge happens in two stages, each
47
# of which generates a changeset object
49
# stage 1: generate OLD->OTHER,
50
# stage 2: use MINE and OLD->OTHER to generate MINE -> RESULT
52
class _MergeConflictHandler(ExceptionConflictHandler):
53
"""Handle conflicts encountered while merging.
55
This subclasses ExceptionConflictHandler, so that any types of
56
conflict that are not explicitly handled cause an exception and
59
def __init__(self, this_tree, base_tree, other_tree, ignore_zero=False):
60
ExceptionConflictHandler.__init__(self)
62
self.ignore_zero = ignore_zero
63
self.this_tree = this_tree
64
self.base_tree = base_tree
65
self.other_tree = other_tree
67
def copy(self, source, dest):
68
"""Copy the text and mode of a file
69
:param source: The path of the file to copy
70
:param dest: The distination file to create
72
s_file = file(source, "rb")
73
d_file = file(dest, "wb")
76
os.chmod(dest, 0777 & os.stat(source).st_mode)
78
def dump(self, lines, dest):
79
"""Copy the text and mode of a file
80
:param source: The path of the file to copy
81
:param dest: The distination file to create
83
d_file = file(dest, "wb")
87
def add_suffix(self, name, suffix, last_new_name=None, fix_inventory=True):
88
"""Rename a file to append a suffix. If the new name exists, the
89
suffix is added repeatedly until a non-existant name is found
91
:param name: The path of the file
92
:param suffix: The suffix to append
93
:param last_new_name: (used for recursive calls) the last name tried
95
if last_new_name is None:
97
new_name = last_new_name+suffix
99
rename(name, new_name)
100
if fix_inventory is True:
102
relpath = self.this_tree.relpath(name)
103
except NotBranchError:
105
if relpath is not None:
106
file_id = self.this_tree.path2id(relpath)
107
if file_id is not None:
108
new_path = self.this_tree.relpath(new_name)
109
rename(new_name, name)
110
self.this_tree.rename_one(relpath, new_path)
111
assert self.this_tree.id2path(file_id) == new_path
113
if e.errno != errno.EEXIST and e.errno != errno.ENOTEMPTY:
115
return self.add_suffix(name, suffix, last_new_name=new_name,
116
fix_inventory=fix_inventory)
119
def conflict(self, text):
124
def merge_conflict(self, new_file, this_path, base_lines, other_lines):
126
Handle diff3 conflicts by producing a .THIS, .BASE and .OTHER. The
127
main file will be a version with diff3 conflicts.
128
:param new_file: Path to the output file with diff3 markers
129
:param this_path: Path to the file text for the THIS tree
130
:param base_path: Path to the file text for the BASE tree
131
:param other_path: Path to the file text for the OTHER tree
133
self.add_suffix(this_path, ".THIS", fix_inventory=False)
134
self.dump(base_lines, this_path+".BASE")
135
self.dump(other_lines, this_path+".OTHER")
136
rename(new_file, this_path)
137
self.conflict("Diff3 conflict encountered in %s" % this_path)
139
def weave_merge_conflict(self, filename, weave, other_i, out_file):
141
Handle weave conflicts by producing a .THIS, and .OTHER. The
142
main file will be a version with diff3-style conflicts.
144
self.add_suffix(filename, ".THIS", fix_inventory=False)
146
self.dump(weave.get_iter(other_i), filename+".OTHER")
147
self.conflict("Text conflict encountered in %s" % filename)
149
def new_contents_conflict(self, filename, other_contents):
150
"""Conflicting contents for newly added file."""
151
other_contents(filename + ".OTHER", self, False)
152
self.conflict("Conflict in newly added file %s" % filename)
155
def target_exists(self, entry, target, old_path):
156
"""Handle the case when the target file or dir exists"""
157
moved_path = self.add_suffix(target, ".moved")
158
self.conflict("Moved existing %s to %s" % (target, moved_path))
160
def rmdir_non_empty(self, filename):
161
"""Handle the case where the dir to be removed still has contents"""
162
self.conflict("Directory %s not removed because it is not empty"\
166
def rem_contents_conflict(self, filename, this_contents, base_contents):
167
base_contents(filename+".BASE", self)
168
this_contents(filename+".THIS", self)
169
self.conflict("Other branch deleted locally modified file %s" %
171
return ReplaceContents(this_contents, None)
173
def abs_this_path(self, file_id):
174
"""Return the absolute path for a file_id in the this tree."""
175
return self.this_tree.id2abspath(file_id)
177
def add_missing_parents(self, file_id, tree):
178
"""If some of the parents for file_id are missing, add them."""
179
entry = tree.inventory[file_id]
180
if entry.parent_id not in self.this_tree:
181
return self.create_all_missing(entry.parent_id, tree)
183
return self.abs_this_path(entry.parent_id)
185
def create_all_missing(self, file_id, tree):
186
"""Add contents for a file_id and all its parents to a tree."""
187
entry = tree.inventory[file_id]
188
if entry.parent_id is not None and entry.parent_id not in self.this_tree:
189
abspath = self.create_all_missing(entry.parent_id, tree)
191
abspath = self.abs_this_path(entry.parent_id)
192
entry_path = pathjoin(abspath, entry.name)
193
if not os.path.isdir(entry_path):
194
self.create(file_id, entry_path, tree)
197
def create(self, file_id, path, tree):
198
"""Uses tree data to create a filesystem object for the file_id"""
199
from _changeset import get_contents
200
get_contents(tree, file_id)(path, self)
202
def missing_for_merge(self, file_id, other_path):
203
"""The file_id doesn't exist in THIS, but does in OTHER and BASE"""
204
self.conflict("Other branch modified locally deleted file %s" %
206
parent_dir = self.add_missing_parents(file_id, self.other_tree)
207
stem = pathjoin(parent_dir, os.path.basename(other_path))
208
self.create(file_id, stem+".OTHER", self.other_tree)
209
self.create(file_id, stem+".BASE", self.base_tree)
211
def threeway_contents_conflict(filename, this_contents, base_contents,
213
self.conflict("Three-way conflict merging %s" % filename)
216
if self.conflicts == 0:
217
if not self.ignore_zero:
218
note("All changes applied successfully.")
220
note("%d conflicts encountered." % self.conflicts)
222
def _get_tree(treespec, local_branch=None):
223
location, revno = treespec
224
branch = Branch.open_containing(location)[0]
228
revision = branch.last_revision()
230
revision = branch.get_rev_id(revno)
232
revision = NULL_REVISION
233
return branch, _get_revid_tree(branch, revision, local_branch)
236
def _get_revid_tree(branch, revision, local_branch):
238
base_tree = branch.working_tree()
240
if local_branch is not None:
241
greedy_fetch(local_branch, branch, revision)
242
base_tree = local_branch.revision_tree(revision)
244
base_tree = branch.revision_tree(revision)
248
def build_working_dir(to_dir):
249
"""Build a working directory in an empty directory.
251
to_dir is a directory containing branch metadata but no working files,
252
typically constructed by cloning an existing branch.
254
This is split out as a special idiomatic case of merge. It could
255
eventually be done by just building the tree directly calling into
256
lower-level code (e.g. constructing a changeset).
258
# RBC 20051019 is this not just 'export' ?
259
# AB Well, export doesn't take care of inventory...
260
this_branch = Branch.open_containing(to_dir)[0]
261
transform_tree(this_branch.working_tree(), this_branch.basis_tree())
264
def transform_tree(from_tree, to_tree, interesting_ids=None):
265
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
266
interesting_ids=interesting_ids)
269
def merge(other_revision, base_revision,
270
check_clean=True, ignore_zero=False,
271
this_dir=None, backup_files=False, merge_type=ApplyMerge3,
272
file_list=None, show_base=False, reprocess=False):
273
"""Merge changes into a tree.
276
list(path, revno) Base for three-way merge.
277
If [None, None] then a base will be automatically determined.
279
list(path, revno) Other revision for three-way merge.
281
Directory to merge changes into; '.' by default.
283
If true, this_dir must have no uncommitted changes before the
285
ignore_zero - If true, suppress the "zero conflicts" message when
286
there are no conflicts; should be set when doing something we expect
287
to complete perfectly.
288
file_list - If supplied, merge only changes to selected files.
290
All available ancestors of other_revision and base_revision are
291
automatically pulled into the branch.
293
The revno may be -1 to indicate the last revision on the branch, which is
296
This function is intended for use from the command line; programmatic
297
clients might prefer to call merge_inner(), which has less magic behavior.
301
this_branch = Branch.open_containing(this_dir)[0]
302
if show_base and not merge_type is ApplyMerge3:
303
raise BzrCommandError("Show-base is not supported for this merge"
304
" type. %s" % merge_type)
305
if reprocess and not merge_type is ApplyMerge3:
306
raise BzrCommandError("Reprocess is not supported for this merge"
307
" type. %s" % merge_type)
308
if reprocess and show_base:
309
raise BzrCommandError("Cannot reprocess and show base.")
310
merger = Merger(this_branch)
311
merger.check_basis(check_clean)
312
merger.set_other(other_revision)
313
merger.set_base(base_revision)
314
if merger.base_rev_id == merger.other_rev_id:
315
note('Nothing to do.')
317
merger.backup_files = backup_files
318
merger.merge_type = merge_type
319
merger.set_interesting_files(file_list)
320
merger.show_base = show_base
321
merger.reprocess = reprocess
322
merger.conflict_handler = _MergeConflictHandler(merger.this_tree,
325
ignore_zero=ignore_zero)
326
conflicts = merger.do_merge()
331
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
333
merge_type=ApplyMerge3,
334
interesting_ids=None,
338
interesting_files=None):
339
"""Primary interface for merging.
341
typical use is probably
342
'merge_inner(branch, branch.get_revision_tree(other_revision),
343
branch.get_revision_tree(base_revision))'
345
merger = Merger(this_branch, other_tree, base_tree)
346
merger.backup_files = backup_files
347
merger.merge_type = merge_type
348
merger.interesting_ids = interesting_ids
349
if interesting_files:
350
assert not interesting_ids, ('Only supply interesting_ids'
351
' or interesting_files')
352
merger._set_interesting_files(interesting_files)
353
merger.show_base = show_base
354
merger.reprocess = reprocess
355
merger.conflict_handler = _MergeConflictHandler(merger.this_tree,
356
base_tree, other_tree,
357
ignore_zero=ignore_zero)
358
merger.other_rev_id = other_rev_id
359
merger.other_basis = other_rev_id
360
return merger.do_merge()
363
class Merger(object):
364
def __init__(self, this_branch, other_tree=None, base_tree=None):
365
object.__init__(self)
366
self.this_branch = this_branch
367
self.this_basis = this_branch.last_revision()
368
self.this_rev_id = None
369
self.this_tree = this_branch.working_tree()
370
self.this_revision_tree = None
371
self.this_basis_tree = None
372
self.other_tree = other_tree
373
self.base_tree = base_tree
374
self.ignore_zero = False
375
self.backup_files = False
376
self.interesting_ids = None
377
self.show_base = False
378
self.reprocess = False
379
self.conflict_handler = _MergeConflictHandler(self.this_tree,
380
base_tree, other_tree)
382
def revision_tree(self, revision_id):
383
return self.this_branch.revision_tree(revision_id)
385
def ensure_revision_trees(self):
386
if self.this_revision_tree is None:
387
self.this_basis_tree = self.this_branch.revision_tree(
389
if self.this_basis == self.this_rev_id:
390
self.this_revision_tree = self.this_basis_tree
392
if self.other_rev_id is None:
393
other_basis_tree = self.revision_tree(self.other_basis)
394
changes = compare_trees(self.other_tree, other_basis_tree)
395
if changes.has_changed():
396
raise WorkingTreeNotRevision(self.this_tree)
397
other_rev_id = other_basis
398
self.other_tree = other_basis_tree
400
def file_revisions(self, file_id):
401
self.ensure_revision_trees()
402
def get_id(tree, file_id):
403
revision_id = tree.inventory[file_id].revision
404
assert revision_id is not None
406
if self.this_rev_id is None:
407
if self.this_basis_tree.get_file_sha1(file_id) != \
408
self.this_tree.get_file_sha1(file_id):
409
raise WorkingTreeNotRevision(self.this_tree)
411
trees = (self.this_basis_tree, self.other_tree)
412
return [get_id(tree, file_id) for tree in trees]
414
def merge_factory(self, file_id, base, other):
415
if self.merge_type.history_based:
416
if self.show_base is True:
417
raise BzrError("Cannot show base for hisory-based merges")
418
if self.reprocess is True:
419
raise BzrError("Cannot reprocess history-based merges")
421
t_revid, o_revid = self.file_revisions(file_id)
422
weave = self.this_basis_tree.get_weave(file_id)
423
contents_change = self.merge_type(weave, t_revid, o_revid)
425
if self.show_base is True or self.reprocess is True:
426
contents_change = self.merge_type(file_id, base, other,
427
show_base=self.show_base,
428
reprocess=self.reprocess)
430
contents_change = self.merge_type(file_id, base, other)
431
if self.backup_files:
432
contents_change = BackupBeforeChange(contents_change)
433
return contents_change
435
def check_basis(self, check_clean):
436
if self.this_basis is None:
437
raise BzrCommandError("This branch has no commits")
440
if self.this_basis != self.this_rev_id:
441
raise BzrCommandError("Working tree has uncommitted changes.")
443
def compare_basis(self):
444
changes = compare_trees(self.this_branch.working_tree(),
445
self.this_branch.basis_tree(), False)
446
if not changes.has_changed():
447
self.this_rev_id = self.this_basis
449
def set_interesting_files(self, file_list):
451
self._set_interesting_files(file_list)
452
except NotVersionedError, e:
453
raise BzrCommandError("%s is not a source file in any"
456
def _set_interesting_files(self, file_list):
457
"""Set the list of interesting ids from a list of files."""
458
if file_list is None:
459
self.interesting_ids = None
462
interesting_ids = set()
463
for fname in file_list:
464
path = self.this_tree.relpath(fname)
466
for tree in (self.this_tree, self.base_tree, self.other_tree):
467
file_id = tree.inventory.path2id(path)
468
if file_id is not None:
469
interesting_ids.add(file_id)
472
raise NotVersionedError(path=fname)
473
self.interesting_ids = interesting_ids
475
def set_pending(self):
476
if not self.base_is_ancestor:
478
if self.other_rev_id is None:
480
if self.other_rev_id in self.this_branch.get_ancestry(self.this_basis):
482
self.this_branch.working_tree().add_pending_merge(self.other_rev_id)
484
def set_other(self, other_revision):
485
other_branch, self.other_tree = _get_tree(other_revision,
487
if other_revision[1] == -1:
488
self.other_rev_id = other_branch.last_revision()
489
if self.other_rev_id is None:
490
raise NoCommits(other_branch)
491
self.other_basis = self.other_rev_id
492
elif other_revision[1] is not None:
493
self.other_rev_id = other_branch.get_rev_id(other_revision[1])
494
self.other_basis = self.other_rev_id
496
self.other_rev_id = None
497
self.other_basis = other_branch.last_revision()
498
if self.other_basis is None:
499
raise NoCommits(other_branch)
500
fetch(from_branch=other_branch, to_branch=self.this_branch,
501
last_revision=self.other_basis)
503
def set_base(self, base_revision):
504
mutter("doing merge() with no base_revision specified")
505
if base_revision == [None, None]:
507
self.base_rev_id = common_ancestor(self.this_basis,
510
except NoCommonAncestor:
511
raise UnrelatedBranches()
512
self.base_tree = _get_revid_tree(self.this_branch, self.base_rev_id,
514
self.base_is_ancestor = True
516
base_branch, self.base_tree = _get_tree(base_revision)
517
if base_revision[1] == -1:
518
self.base_rev_id = base_branch.last_revision()
519
elif base_revision[1] is None:
520
self.base_rev_id = None
522
self.base_rev_id = base_branch.get_rev_id(base_revision[1])
523
fetch(from_branch=base_branch, to_branch=self.this_branch)
524
self.base_is_ancestor = is_ancestor(self.this_basis,
529
def get_inventory(tree):
530
return tree.inventory
532
inv_changes = merge_flex(self.this_tree, self.base_tree,
534
generate_changeset, get_inventory,
535
self.conflict_handler,
536
merge_factory=self.merge_factory,
537
interesting_ids=self.interesting_ids)
540
for id, path in inv_changes.iteritems():
545
assert path.startswith('.' + '/') or path.startswith('.' + '\\'), "path is %s" % path
547
adjust_ids.append((path, id))
548
if len(adjust_ids) > 0:
549
self.this_branch.working_tree().set_inventory(self.regen_inventory(adjust_ids))
550
conflicts = self.conflict_handler.conflicts
551
self.conflict_handler.finalize()
554
def regen_inventory(self, new_entries):
555
old_entries = self.this_branch.working_tree().read_working_inventory()
559
for path, file_id in new_entries:
562
new_entries_map[file_id] = path
564
def id2path(file_id):
565
path = new_entries_map.get(file_id)
568
entry = old_entries[file_id]
569
if entry.parent_id is None:
571
return pathjoin(id2path(entry.parent_id), entry.name)
573
for file_id in old_entries:
574
entry = old_entries[file_id]
575
path = id2path(file_id)
576
new_inventory[file_id] = (path, file_id, entry.parent_id,
578
by_path[path] = file_id
583
for path, file_id in new_entries:
585
del new_inventory[file_id]
588
new_path_list.append((path, file_id))
589
if file_id not in old_entries:
591
# Ensure no file is added before its parent
593
for path, file_id in new_path_list:
597
parent = by_path[os.path.dirname(path)]
598
abspath = pathjoin(self.this_tree.basedir, path)
599
kind = bzrlib.osutils.file_kind(abspath)
600
new_inventory[file_id] = (path, file_id, parent, kind)
601
by_path[path] = file_id
603
# Get a list in insertion order
604
new_inventory_list = new_inventory.values()
605
mutter ("""Inventory regeneration:
606
old length: %i insertions: %i deletions: %i new_length: %i"""\
607
% (len(old_entries), insertions, deletions,
608
len(new_inventory_list)))
609
assert len(new_inventory_list) == len(old_entries) + insertions\
611
new_inventory_list.sort()
612
return new_inventory_list
615
merge_types = { "merge3": (ApplyMerge3, "Native diff3-style merge"),
616
"diff3": (Diff3Merge, "Merge using external diff3"),
617
'weave': (WeaveMerge, "Weave-based merge")
added
removed
bzrlib/merge.py
