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,
37
WorkingTreeNotRevision,
39
from bzrlib.fetch import greedy_fetch, fetch
41
from bzrlib.osutils import rename, pathjoin
42
from bzrlib.revision import common_ancestor, is_ancestor, NULL_REVISION
43
from bzrlib.trace import mutter, warning, note
44
from bzrlib.workingtree import WorkingTree
46
# TODO: Report back as changes are merged in
48
# comments from abentley on irc: merge happens in two stages, each
49
# of which generates a changeset object
51
# stage 1: generate OLD->OTHER,
52
# stage 2: use MINE and OLD->OTHER to generate MINE -> RESULT
54
class _MergeConflictHandler(ExceptionConflictHandler):
55
"""Handle conflicts encountered while merging.
57
This subclasses ExceptionConflictHandler, so that any types of
58
conflict that are not explicitly handled cause an exception and
61
def __init__(self, this_tree, base_tree, other_tree, ignore_zero=False):
62
ExceptionConflictHandler.__init__(self)
64
self.ignore_zero = ignore_zero
65
self.this_tree = this_tree
66
self.base_tree = base_tree
67
self.other_tree = other_tree
69
def copy(self, source, dest):
70
"""Copy the text and mode of a file
71
:param source: The path of the file to copy
72
:param dest: The distination file to create
74
s_file = file(source, "rb")
75
d_file = file(dest, "wb")
78
os.chmod(dest, 0777 & os.stat(source).st_mode)
80
def dump(self, lines, dest):
81
"""Copy the text and mode of a file
82
:param source: The path of the file to copy
83
:param dest: The distination file to create
85
d_file = file(dest, "wb")
89
def add_suffix(self, name, suffix, last_new_name=None, fix_inventory=True):
90
"""Rename a file to append a suffix. If the new name exists, the
91
suffix is added repeatedly until a non-existant name is found
93
:param name: The path of the file
94
:param suffix: The suffix to append
95
:param last_new_name: (used for recursive calls) the last name tried
97
if last_new_name is None:
99
new_name = last_new_name+suffix
101
rename(name, new_name)
102
if fix_inventory is True:
104
relpath = self.this_tree.relpath(name)
105
except NotBranchError:
107
if relpath is not None:
108
file_id = self.this_tree.path2id(relpath)
109
if file_id is not None:
110
new_path = self.this_tree.relpath(new_name)
111
rename(new_name, name)
112
self.this_tree.rename_one(relpath, new_path)
113
assert self.this_tree.id2path(file_id) == new_path
115
if e.errno != errno.EEXIST and e.errno != errno.ENOTEMPTY:
117
return self.add_suffix(name, suffix, last_new_name=new_name,
118
fix_inventory=fix_inventory)
121
def conflict(self, text):
126
def merge_conflict(self, new_file, this_path, base_lines, other_lines):
128
Handle diff3 conflicts by producing a .THIS, .BASE and .OTHER. The
129
main file will be a version with diff3 conflicts.
130
:param new_file: Path to the output file with diff3 markers
131
:param this_path: Path to the file text for the THIS tree
132
:param base_path: Path to the file text for the BASE tree
133
:param other_path: Path to the file text for the OTHER tree
135
self.add_suffix(this_path, ".THIS", fix_inventory=False)
136
self.dump(base_lines, this_path+".BASE")
137
self.dump(other_lines, this_path+".OTHER")
138
rename(new_file, this_path)
139
self.conflict("Diff3 conflict encountered in %s" % this_path)
141
def weave_merge_conflict(self, filename, weave, other_i, out_file):
143
Handle weave conflicts by producing a .THIS, and .OTHER. The
144
main file will be a version with diff3-style conflicts.
146
self.add_suffix(filename, ".THIS", fix_inventory=False)
148
self.dump(weave.get_iter(other_i), filename+".OTHER")
149
self.conflict("Text conflict encountered in %s" % filename)
151
def new_contents_conflict(self, filename, other_contents):
152
"""Conflicting contents for newly added file."""
153
other_contents(filename + ".OTHER", self, False)
154
self.conflict("Conflict in newly added file %s" % filename)
157
def target_exists(self, entry, target, old_path):
158
"""Handle the case when the target file or dir exists"""
159
moved_path = self.add_suffix(target, ".moved")
160
self.conflict("Moved existing %s to %s" % (target, moved_path))
162
def rmdir_non_empty(self, filename):
163
"""Handle the case where the dir to be removed still has contents"""
164
self.conflict("Directory %s not removed because it is not empty"\
168
def rem_contents_conflict(self, filename, this_contents, base_contents):
169
base_contents(filename+".BASE", self)
170
this_contents(filename+".THIS", self)
171
self.conflict("Other branch deleted locally modified file %s" %
173
return ReplaceContents(this_contents, None)
175
def abs_this_path(self, file_id):
176
"""Return the absolute path for a file_id in the this tree."""
177
return self.this_tree.id2abspath(file_id)
179
def add_missing_parents(self, file_id, tree):
180
"""If some of the parents for file_id are missing, add them."""
181
entry = tree.inventory[file_id]
182
if entry.parent_id not in self.this_tree:
183
return self.create_all_missing(entry.parent_id, tree)
185
return self.abs_this_path(entry.parent_id)
187
def create_all_missing(self, file_id, tree):
188
"""Add contents for a file_id and all its parents to a tree."""
189
entry = tree.inventory[file_id]
190
if entry.parent_id is not None and entry.parent_id not in self.this_tree:
191
abspath = self.create_all_missing(entry.parent_id, tree)
193
abspath = self.abs_this_path(entry.parent_id)
194
entry_path = pathjoin(abspath, entry.name)
195
if not os.path.isdir(entry_path):
196
self.create(file_id, entry_path, tree)
199
def create(self, file_id, path, tree):
200
"""Uses tree data to create a filesystem object for the file_id"""
201
from bzrlib._changeset import get_contents
202
get_contents(tree, file_id)(path, self)
204
def missing_for_merge(self, file_id, other_path):
205
"""The file_id doesn't exist in THIS, but does in OTHER and BASE"""
206
self.conflict("Other branch modified locally deleted file %s" %
208
parent_dir = self.add_missing_parents(file_id, self.other_tree)
209
stem = pathjoin(parent_dir, os.path.basename(other_path))
210
self.create(file_id, stem+".OTHER", self.other_tree)
211
self.create(file_id, stem+".BASE", self.base_tree)
213
def threeway_contents_conflict(filename, this_contents, base_contents,
215
self.conflict("Three-way conflict merging %s" % filename)
218
if self.conflicts == 0:
219
if not self.ignore_zero:
220
note("All changes applied successfully.")
222
note("%d conflicts encountered." % self.conflicts)
224
def _get_tree(treespec, local_branch=None):
225
location, revno = treespec
226
branch = Branch.open_containing(location)[0]
230
revision = branch.last_revision()
232
revision = branch.get_rev_id(revno)
234
revision = NULL_REVISION
235
return branch, _get_revid_tree(branch, revision, local_branch)
238
def _get_revid_tree(branch, revision, local_branch):
240
base_tree = branch.working_tree()
242
if local_branch is not None:
243
if local_branch.base != branch.base:
244
greedy_fetch(local_branch, branch, revision)
245
base_tree = local_branch.repository.revision_tree(revision)
247
base_tree = branch.repository.revision_tree(revision)
251
def build_working_dir(to_dir):
252
"""Build a working directory in an empty directory.
254
to_dir is a directory containing branch metadata but no working files,
255
typically constructed by cloning an existing branch.
257
This is split out as a special idiomatic case of merge. It could
258
eventually be done by just building the tree directly calling into
259
lower-level code (e.g. constructing a changeset).
261
# RBC 20051019 is this not just 'export' ?
262
# AB Well, export doesn't take care of inventory...
263
this_branch = Branch.open_containing(to_dir)[0]
264
transform_tree(this_branch.working_tree(), this_branch.basis_tree())
267
def transform_tree(from_tree, to_tree, interesting_ids=None):
268
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
269
interesting_ids=interesting_ids)
272
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
274
merge_type=ApplyMerge3,
275
interesting_ids=None,
279
interesting_files=None,
281
"""Primary interface for merging.
283
typical use is probably
284
'merge_inner(branch, branch.get_revision_tree(other_revision),
285
branch.get_revision_tree(base_revision))'
287
if this_tree is None:
288
this_tree = this_branch.working_tree()
289
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree)
290
merger.backup_files = backup_files
291
merger.merge_type = merge_type
292
merger.interesting_ids = interesting_ids
293
if interesting_files:
294
assert not interesting_ids, ('Only supply interesting_ids'
295
' or interesting_files')
296
merger._set_interesting_files(interesting_files)
297
merger.show_base = show_base
298
merger.reprocess = reprocess
299
merger.conflict_handler = _MergeConflictHandler(merger.this_tree,
300
base_tree, other_tree,
301
ignore_zero=ignore_zero)
302
merger.other_rev_id = other_rev_id
303
merger.other_basis = other_rev_id
304
return merger.do_merge()
307
class Merger(object):
308
def __init__(self, this_branch, other_tree=None, base_tree=None, this_tree=None):
309
object.__init__(self)
310
assert this_tree is not None, "this_tree is required"
311
self.this_branch = this_branch
312
self.this_basis = this_branch.last_revision()
313
self.this_rev_id = None
314
self.this_tree = this_tree
315
self.this_revision_tree = None
316
self.this_basis_tree = None
317
self.other_tree = other_tree
318
self.base_tree = base_tree
319
self.ignore_zero = False
320
self.backup_files = False
321
self.interesting_ids = None
322
self.show_base = False
323
self.reprocess = False
324
self.conflict_handler = _MergeConflictHandler(self.this_tree,
325
base_tree, other_tree)
327
def revision_tree(self, revision_id):
328
return self.this_branch.repository.revision_tree(revision_id)
330
def ensure_revision_trees(self):
331
if self.this_revision_tree is None:
332
self.this_basis_tree = self.this_branch.repository.revision_tree(
334
if self.this_basis == self.this_rev_id:
335
self.this_revision_tree = self.this_basis_tree
337
if self.other_rev_id is None:
338
other_basis_tree = self.revision_tree(self.other_basis)
339
changes = compare_trees(self.other_tree, other_basis_tree)
340
if changes.has_changed():
341
raise WorkingTreeNotRevision(self.this_tree)
342
other_rev_id = other_basis
343
self.other_tree = other_basis_tree
345
def file_revisions(self, file_id):
346
self.ensure_revision_trees()
347
def get_id(tree, file_id):
348
revision_id = tree.inventory[file_id].revision
349
assert revision_id is not None
351
if self.this_rev_id is None:
352
if self.this_basis_tree.get_file_sha1(file_id) != \
353
self.this_tree.get_file_sha1(file_id):
354
raise WorkingTreeNotRevision(self.this_tree)
356
trees = (self.this_basis_tree, self.other_tree)
357
return [get_id(tree, file_id) for tree in trees]
359
def merge_factory(self, file_id, base, other):
360
if self.merge_type.history_based:
361
if self.show_base is True:
362
raise BzrError("Cannot show base for hisory-based merges")
363
if self.reprocess is True:
364
raise BzrError("Cannot reprocess history-based merges")
366
t_revid, o_revid = self.file_revisions(file_id)
367
weave = self.this_basis_tree.get_weave(file_id)
368
contents_change = self.merge_type(weave, t_revid, o_revid)
370
if self.show_base is True or self.reprocess is True:
371
contents_change = self.merge_type(file_id, base, other,
372
show_base=self.show_base,
373
reprocess=self.reprocess)
375
contents_change = self.merge_type(file_id, base, other)
376
if self.backup_files:
377
contents_change = BackupBeforeChange(contents_change)
378
return contents_change
380
def check_basis(self, check_clean):
381
if self.this_basis is None:
382
raise BzrCommandError("This branch has no commits")
385
if self.this_basis != self.this_rev_id:
386
raise BzrCommandError("Working tree has uncommitted changes.")
388
def compare_basis(self):
389
changes = compare_trees(self.this_tree,
390
self.this_branch.basis_tree(), False)
391
if not changes.has_changed():
392
self.this_rev_id = self.this_basis
394
def set_interesting_files(self, file_list):
396
self._set_interesting_files(file_list)
397
except NotVersionedError, e:
398
raise BzrCommandError("%s is not a source file in any"
401
def _set_interesting_files(self, file_list):
402
"""Set the list of interesting ids from a list of files."""
403
if file_list is None:
404
self.interesting_ids = None
407
interesting_ids = set()
408
for path in file_list:
410
for tree in (self.this_tree, self.base_tree, self.other_tree):
411
file_id = tree.inventory.path2id(path)
412
if file_id is not None:
413
interesting_ids.add(file_id)
416
raise NotVersionedError(path=path)
417
self.interesting_ids = interesting_ids
419
def set_pending(self):
420
if not self.base_is_ancestor:
422
if self.other_rev_id is None:
424
ancestry = self.this_branch.repository.get_ancestry(self.this_basis)
425
if self.other_rev_id in ancestry:
427
self.this_tree.add_pending_merge(self.other_rev_id)
429
def set_other(self, other_revision):
430
other_branch, self.other_tree = _get_tree(other_revision,
432
if other_revision[1] == -1:
433
self.other_rev_id = other_branch.last_revision()
434
if self.other_rev_id is None:
435
raise NoCommits(other_branch)
436
self.other_basis = self.other_rev_id
437
elif other_revision[1] is not None:
438
self.other_rev_id = other_branch.get_rev_id(other_revision[1])
439
self.other_basis = self.other_rev_id
441
self.other_rev_id = None
442
self.other_basis = other_branch.last_revision()
443
if self.other_basis is None:
444
raise NoCommits(other_branch)
445
if other_branch.base != self.this_branch.base:
446
fetch(from_branch=other_branch, to_branch=self.this_branch,
447
last_revision=self.other_basis)
449
def set_base(self, base_revision):
450
mutter("doing merge() with no base_revision specified")
451
if base_revision == [None, None]:
453
self.base_rev_id = common_ancestor(self.this_basis,
455
self.this_branch.repository)
456
except NoCommonAncestor:
457
raise UnrelatedBranches()
458
self.base_tree = _get_revid_tree(self.this_branch, self.base_rev_id,
460
self.base_is_ancestor = True
462
base_branch, self.base_tree = _get_tree(base_revision)
463
if base_revision[1] == -1:
464
self.base_rev_id = base_branch.last_revision()
465
elif base_revision[1] is None:
466
self.base_rev_id = None
468
self.base_rev_id = base_branch.get_rev_id(base_revision[1])
469
fetch(from_branch=base_branch, to_branch=self.this_branch)
470
self.base_is_ancestor = is_ancestor(self.this_basis,
475
def get_inventory(tree):
476
return tree.inventory
478
inv_changes = merge_flex(self.this_tree, self.base_tree,
480
generate_changeset, get_inventory,
481
self.conflict_handler,
482
merge_factory=self.merge_factory,
483
interesting_ids=self.interesting_ids)
486
for id, path in inv_changes.iteritems():
491
assert path.startswith('.' + '/') or path.startswith('.' + '\\'), "path is %s" % path
493
adjust_ids.append((path, id))
494
if len(adjust_ids) > 0:
495
self.this_tree.set_inventory(self.regen_inventory(adjust_ids))
496
conflicts = self.conflict_handler.conflicts
497
self.conflict_handler.finalize()
500
def regen_inventory(self, new_entries):
501
old_entries = self.this_tree.read_working_inventory()
505
for path, file_id in new_entries:
508
new_entries_map[file_id] = path
510
def id2path(file_id):
511
path = new_entries_map.get(file_id)
514
entry = old_entries[file_id]
515
if entry.parent_id is None:
517
return pathjoin(id2path(entry.parent_id), entry.name)
519
for file_id in old_entries:
520
entry = old_entries[file_id]
521
path = id2path(file_id)
522
new_inventory[file_id] = (path, file_id, entry.parent_id,
524
by_path[path] = file_id
529
for path, file_id in new_entries:
531
del new_inventory[file_id]
534
new_path_list.append((path, file_id))
535
if file_id not in old_entries:
537
# Ensure no file is added before its parent
539
for path, file_id in new_path_list:
543
parent = by_path[os.path.dirname(path)]
544
abspath = pathjoin(self.this_tree.basedir, path)
545
kind = bzrlib.osutils.file_kind(abspath)
546
new_inventory[file_id] = (path, file_id, parent, kind)
547
by_path[path] = file_id
549
# Get a list in insertion order
550
new_inventory_list = new_inventory.values()
551
mutter ("""Inventory regeneration:
552
old length: %i insertions: %i deletions: %i new_length: %i"""\
553
% (len(old_entries), insertions, deletions,
554
len(new_inventory_list)))
555
assert len(new_inventory_list) == len(old_entries) + insertions\
557
new_inventory_list.sort()
558
return new_inventory_list
561
merge_types = { "merge3": (ApplyMerge3, "Native diff3-style merge"),
562
"diff3": (Diff3Merge, "Merge using external diff3"),
563
'weave': (WeaveMerge, "Weave-based merge")
added
removed
bzrlib/merge.py
