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
22
from bzrlib._changeset import generate_changeset, ExceptionConflictHandler
23
from bzrlib._changeset import Inventory, Diff3Merge, ReplaceContents
24
from bzrlib._merge_core import WeaveMerge
25
from bzrlib._merge_core import merge_flex, ApplyMerge3, BackupBeforeChange
26
from bzrlib.branch import Branch
27
from bzrlib.delta import compare_trees
28
from bzrlib.errors import (BzrCommandError,
36
WorkingTreeNotRevision,
39
from bzrlib.osutils import rename, pathjoin
40
from bzrlib.revision import common_ancestor, is_ancestor, NULL_REVISION
41
from bzrlib.trace import mutter, warning, note
43
# TODO: Report back as changes are merged in
45
# comments from abentley on irc: merge happens in two stages, each
46
# of which generates a changeset object
48
# stage 1: generate OLD->OTHER,
49
# stage 2: use MINE and OLD->OTHER to generate MINE -> RESULT
51
class _MergeConflictHandler(ExceptionConflictHandler):
52
"""Handle conflicts encountered while merging.
54
This subclasses ExceptionConflictHandler, so that any types of
55
conflict that are not explicitly handled cause an exception and
58
def __init__(self, this_tree, base_tree, other_tree, ignore_zero=False):
59
ExceptionConflictHandler.__init__(self)
61
self.ignore_zero = ignore_zero
62
self.this_tree = this_tree
63
self.base_tree = base_tree
64
self.other_tree = other_tree
66
def copy(self, source, dest):
67
"""Copy the text and mode of a file
68
:param source: The path of the file to copy
69
:param dest: The distination file to create
71
s_file = file(source, "rb")
72
d_file = file(dest, "wb")
75
os.chmod(dest, 0777 & os.stat(source).st_mode)
77
def dump(self, lines, dest):
78
"""Copy the text and mode of a file
79
:param source: The path of the file to copy
80
:param dest: The distination file to create
82
d_file = file(dest, "wb")
86
def add_suffix(self, name, suffix, last_new_name=None, fix_inventory=True):
87
"""Rename a file to append a suffix. If the new name exists, the
88
suffix is added repeatedly until a non-existant name is found
90
:param name: The path of the file
91
:param suffix: The suffix to append
92
:param last_new_name: (used for recursive calls) the last name tried
94
if last_new_name is None:
96
new_name = last_new_name+suffix
98
rename(name, new_name)
99
if fix_inventory is True:
101
relpath = self.this_tree.relpath(name)
102
except NotBranchError:
104
if relpath is not None:
105
file_id = self.this_tree.path2id(relpath)
106
if file_id is not None:
107
new_path = self.this_tree.relpath(new_name)
108
rename(new_name, name)
109
self.this_tree.rename_one(relpath, new_path)
110
assert self.this_tree.id2path(file_id) == new_path
112
if e.errno != errno.EEXIST and e.errno != errno.ENOTEMPTY:
114
return self.add_suffix(name, suffix, last_new_name=new_name,
115
fix_inventory=fix_inventory)
118
def conflict(self, text):
123
def merge_conflict(self, new_file, this_path, base_lines, other_lines):
125
Handle diff3 conflicts by producing a .THIS, .BASE and .OTHER. The
126
main file will be a version with diff3 conflicts.
127
:param new_file: Path to the output file with diff3 markers
128
:param this_path: Path to the file text for the THIS tree
129
:param base_path: Path to the file text for the BASE tree
130
:param other_path: Path to the file text for the OTHER tree
132
self.add_suffix(this_path, ".THIS", fix_inventory=False)
133
self.dump(base_lines, this_path+".BASE")
134
self.dump(other_lines, this_path+".OTHER")
135
rename(new_file, this_path)
136
self.conflict("Diff3 conflict encountered in %s" % this_path)
138
def weave_merge_conflict(self, filename, weave, other_i, out_file):
140
Handle weave conflicts by producing a .THIS, and .OTHER. The
141
main file will be a version with diff3-style conflicts.
143
self.add_suffix(filename, ".THIS", fix_inventory=False)
145
self.dump(weave.get_iter(other_i), filename+".OTHER")
146
self.conflict("Text conflict encountered in %s" % filename)
148
def new_contents_conflict(self, filename, other_contents):
149
"""Conflicting contents for newly added file."""
150
other_contents(filename + ".OTHER", self, False)
151
self.conflict("Conflict in newly added file %s" % filename)
154
def target_exists(self, entry, target, old_path):
155
"""Handle the case when the target file or dir exists"""
156
moved_path = self.add_suffix(target, ".moved")
157
self.conflict("Moved existing %s to %s" % (target, moved_path))
159
def rmdir_non_empty(self, filename):
160
"""Handle the case where the dir to be removed still has contents"""
161
self.conflict("Directory %s not removed because it is not empty"\
165
def rem_contents_conflict(self, filename, this_contents, base_contents):
166
base_contents(filename+".BASE", self)
167
this_contents(filename+".THIS", self)
168
self.conflict("Other branch deleted locally modified file %s" %
170
return ReplaceContents(this_contents, None)
172
def abs_this_path(self, file_id):
173
"""Return the absolute path for a file_id in the this tree."""
174
return self.this_tree.id2abspath(file_id)
176
def add_missing_parents(self, file_id, tree):
177
"""If some of the parents for file_id are missing, add them."""
178
entry = tree.inventory[file_id]
179
if entry.parent_id not in self.this_tree:
180
return self.create_all_missing(entry.parent_id, tree)
182
return self.abs_this_path(entry.parent_id)
184
def create_all_missing(self, file_id, tree):
185
"""Add contents for a file_id and all its parents to a tree."""
186
entry = tree.inventory[file_id]
187
if entry.parent_id is not None and entry.parent_id not in self.this_tree:
188
abspath = self.create_all_missing(entry.parent_id, tree)
190
abspath = self.abs_this_path(entry.parent_id)
191
entry_path = pathjoin(abspath, entry.name)
192
if not os.path.isdir(entry_path):
193
self.create(file_id, entry_path, tree)
196
def create(self, file_id, path, tree):
197
"""Uses tree data to create a filesystem object for the file_id"""
198
from bzrlib._changeset import get_contents
199
get_contents(tree, file_id)(path, self)
201
def missing_for_merge(self, file_id, other_path):
202
"""The file_id doesn't exist in THIS, but does in OTHER and BASE"""
203
self.conflict("Other branch modified locally deleted file %s" %
205
parent_dir = self.add_missing_parents(file_id, self.other_tree)
206
stem = pathjoin(parent_dir, os.path.basename(other_path))
207
self.create(file_id, stem+".OTHER", self.other_tree)
208
self.create(file_id, stem+".BASE", self.base_tree)
210
def threeway_contents_conflict(filename, this_contents, base_contents,
212
self.conflict("Three-way conflict merging %s" % filename)
215
if self.conflicts == 0:
216
if not self.ignore_zero:
217
note("All changes applied successfully.")
219
note("%d conflicts encountered." % self.conflicts)
221
def _get_tree(treespec, local_branch=None):
222
location, revno = treespec
223
branch = Branch.open_containing(location)[0]
227
revision = branch.last_revision()
229
revision = branch.get_rev_id(revno)
231
revision = NULL_REVISION
232
return branch, _get_revid_tree(branch, revision, local_branch)
235
def _get_revid_tree(branch, revision, local_branch):
237
base_tree = branch.bzrdir.open_workingtree()
239
if local_branch is not None:
240
if local_branch.base != branch.base:
241
local_branch.fetch(branch, revision)
242
base_tree = local_branch.repository.revision_tree(revision)
244
base_tree = branch.repository.revision_tree(revision)
248
def transform_tree(from_tree, to_tree, interesting_ids=None):
249
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
250
interesting_ids=interesting_ids)
253
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
255
merge_type=ApplyMerge3,
256
interesting_ids=None,
260
interesting_files=None,
262
"""Primary interface for merging.
264
typical use is probably
265
'merge_inner(branch, branch.get_revision_tree(other_revision),
266
branch.get_revision_tree(base_revision))'
268
if this_tree is None:
269
this_tree = this_branch.bzrdir.open_workingtree()
270
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree)
271
merger.backup_files = backup_files
272
merger.merge_type = merge_type
273
merger.interesting_ids = interesting_ids
274
if interesting_files:
275
assert not interesting_ids, ('Only supply interesting_ids'
276
' or interesting_files')
277
merger._set_interesting_files(interesting_files)
278
merger.show_base = show_base
279
merger.reprocess = reprocess
280
merger.conflict_handler = _MergeConflictHandler(merger.this_tree,
281
base_tree, other_tree,
282
ignore_zero=ignore_zero)
283
merger.other_rev_id = other_rev_id
284
merger.other_basis = other_rev_id
285
return merger.do_merge()
288
class Merger(object):
289
def __init__(self, this_branch, other_tree=None, base_tree=None, this_tree=None):
290
object.__init__(self)
291
assert this_tree is not None, "this_tree is required"
292
self.this_branch = this_branch
293
self.this_basis = this_branch.last_revision()
294
self.this_rev_id = None
295
self.this_tree = this_tree
296
self.this_revision_tree = None
297
self.this_basis_tree = None
298
self.other_tree = other_tree
299
self.base_tree = base_tree
300
self.ignore_zero = False
301
self.backup_files = False
302
self.interesting_ids = None
303
self.show_base = False
304
self.reprocess = False
305
self.conflict_handler = _MergeConflictHandler(self.this_tree,
306
base_tree, other_tree)
308
def revision_tree(self, revision_id):
309
return self.this_branch.repository.revision_tree(revision_id)
311
def ensure_revision_trees(self):
312
if self.this_revision_tree is None:
313
self.this_basis_tree = self.this_branch.repository.revision_tree(
315
if self.this_basis == self.this_rev_id:
316
self.this_revision_tree = self.this_basis_tree
318
if self.other_rev_id is None:
319
other_basis_tree = self.revision_tree(self.other_basis)
320
changes = compare_trees(self.other_tree, other_basis_tree)
321
if changes.has_changed():
322
raise WorkingTreeNotRevision(self.this_tree)
323
other_rev_id = other_basis
324
self.other_tree = other_basis_tree
326
def file_revisions(self, file_id):
327
self.ensure_revision_trees()
328
def get_id(tree, file_id):
329
revision_id = tree.inventory[file_id].revision
330
assert revision_id is not None
332
if self.this_rev_id is None:
333
if self.this_basis_tree.get_file_sha1(file_id) != \
334
self.this_tree.get_file_sha1(file_id):
335
raise WorkingTreeNotRevision(self.this_tree)
337
trees = (self.this_basis_tree, self.other_tree)
338
return [get_id(tree, file_id) for tree in trees]
340
def merge_factory(self, file_id, base, other):
341
if self.merge_type.history_based:
342
if self.show_base is True:
343
raise BzrError("Cannot show base for hisory-based merges")
344
if self.reprocess is True:
345
raise BzrError("Cannot reprocess history-based merges")
347
t_revid, o_revid = self.file_revisions(file_id)
348
weave = self.this_basis_tree.get_weave(file_id)
349
contents_change = self.merge_type(weave, t_revid, o_revid)
351
if self.show_base is True or self.reprocess is True:
352
contents_change = self.merge_type(file_id, base, other,
353
show_base=self.show_base,
354
reprocess=self.reprocess)
356
contents_change = self.merge_type(file_id, base, other)
357
if self.backup_files:
358
contents_change = BackupBeforeChange(contents_change)
359
return contents_change
361
def check_basis(self, check_clean):
362
if self.this_basis is None:
363
raise BzrCommandError("This branch has no commits")
366
if self.this_basis != self.this_rev_id:
367
raise BzrCommandError("Working tree has uncommitted changes.")
369
def compare_basis(self):
370
changes = compare_trees(self.this_tree,
371
self.this_tree.basis_tree(), False)
372
if not changes.has_changed():
373
self.this_rev_id = self.this_basis
375
def set_interesting_files(self, file_list):
377
self._set_interesting_files(file_list)
378
except NotVersionedError, e:
379
raise BzrCommandError("%s is not a source file in any"
382
def _set_interesting_files(self, file_list):
383
"""Set the list of interesting ids from a list of files."""
384
if file_list is None:
385
self.interesting_ids = None
388
interesting_ids = set()
389
for path in file_list:
391
for tree in (self.this_tree, self.base_tree, self.other_tree):
392
file_id = tree.inventory.path2id(path)
393
if file_id is not None:
394
interesting_ids.add(file_id)
397
raise NotVersionedError(path=path)
398
self.interesting_ids = interesting_ids
400
def set_pending(self):
401
if not self.base_is_ancestor:
403
if self.other_rev_id is None:
405
ancestry = self.this_branch.repository.get_ancestry(self.this_basis)
406
if self.other_rev_id in ancestry:
408
self.this_tree.add_pending_merge(self.other_rev_id)
410
def set_other(self, other_revision):
411
other_branch, self.other_tree = _get_tree(other_revision,
413
if other_revision[1] == -1:
414
self.other_rev_id = other_branch.last_revision()
415
if self.other_rev_id is None:
416
raise NoCommits(other_branch)
417
self.other_basis = self.other_rev_id
418
elif other_revision[1] is not None:
419
self.other_rev_id = other_branch.get_rev_id(other_revision[1])
420
self.other_basis = self.other_rev_id
422
self.other_rev_id = None
423
self.other_basis = other_branch.last_revision()
424
if self.other_basis is None:
425
raise NoCommits(other_branch)
426
if other_branch.base != self.this_branch.base:
427
self.this_branch.fetch(other_branch, last_revision=self.other_basis)
429
def set_base(self, base_revision):
430
mutter("doing merge() with no base_revision specified")
431
if base_revision == [None, None]:
433
self.base_rev_id = common_ancestor(self.this_basis,
435
self.this_branch.repository)
436
except NoCommonAncestor:
437
raise UnrelatedBranches()
438
self.base_tree = _get_revid_tree(self.this_branch, self.base_rev_id,
440
self.base_is_ancestor = True
442
base_branch, self.base_tree = _get_tree(base_revision)
443
if base_revision[1] == -1:
444
self.base_rev_id = base_branch.last_revision()
445
elif base_revision[1] is None:
446
self.base_rev_id = None
448
self.base_rev_id = base_branch.get_rev_id(base_revision[1])
449
self.this_branch.fetch(base_branch)
450
self.base_is_ancestor = is_ancestor(self.this_basis,
455
def get_inventory(tree):
456
return tree.inventory
458
inv_changes = merge_flex(self.this_tree, self.base_tree,
460
generate_changeset, get_inventory,
461
self.conflict_handler,
462
merge_factory=self.merge_factory,
463
interesting_ids=self.interesting_ids)
466
for id, path in inv_changes.iteritems():
471
assert path.startswith('.' + '/') or path.startswith('.' + '\\'), "path is %s" % path
473
adjust_ids.append((path, id))
474
if len(adjust_ids) > 0:
475
self.this_tree.set_inventory(self.regen_inventory(adjust_ids))
476
conflicts = self.conflict_handler.conflicts
477
self.conflict_handler.finalize()
480
def regen_inventory(self, new_entries):
481
old_entries = self.this_tree.read_working_inventory()
485
for path, file_id in new_entries:
488
new_entries_map[file_id] = path
490
def id2path(file_id):
491
path = new_entries_map.get(file_id)
494
entry = old_entries[file_id]
495
if entry.parent_id is None:
497
return pathjoin(id2path(entry.parent_id), entry.name)
499
for file_id in old_entries:
500
entry = old_entries[file_id]
501
path = id2path(file_id)
502
new_inventory[file_id] = (path, file_id, entry.parent_id,
504
by_path[path] = file_id
509
for path, file_id in new_entries:
511
del new_inventory[file_id]
514
new_path_list.append((path, file_id))
515
if file_id not in old_entries:
517
# Ensure no file is added before its parent
519
for path, file_id in new_path_list:
523
parent = by_path[os.path.dirname(path)]
524
abspath = pathjoin(self.this_tree.basedir, path)
525
kind = bzrlib.osutils.file_kind(abspath)
526
new_inventory[file_id] = (path, file_id, parent, kind)
527
by_path[path] = file_id
529
# Get a list in insertion order
530
new_inventory_list = new_inventory.values()
531
mutter ("""Inventory regeneration:
532
old length: %i insertions: %i deletions: %i new_length: %i"""\
533
% (len(old_entries), insertions, deletions,
534
len(new_inventory_list)))
535
assert len(new_inventory_list) == len(old_entries) + insertions\
537
new_inventory_list.sort()
538
return new_inventory_list
541
merge_types = { "merge3": (ApplyMerge3, "Native diff3-style merge"),
542
"diff3": (Diff3Merge, "Merge using external diff3"),
543
'weave': (WeaveMerge, "Weave-based merge")
added
removed
bzrlib/merge.py
