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.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, UnrelatedBranches, NoCommonAncestor
30
from bzrlib.errors import NoCommits
31
from bzrlib.delta import compare_trees
32
from bzrlib.trace import mutter, warning
33
from bzrlib.fetch import greedy_fetch, fetch
34
from bzrlib.revision import is_ancestor
35
from bzrlib.osutils import rename
36
from bzrlib.revision import common_ancestor, MultipleRevisionSources
37
from bzrlib.errors import NoSuchRevision
40
# comments from abentley on irc: merge happens in two stages, each
41
# of which generates a changeset object
43
# stage 1: generate OLD->OTHER,
44
# stage 2: use MINE and OLD->OTHER to generate MINE -> RESULT
46
class MergeConflictHandler(ExceptionConflictHandler):
47
"""Handle conflicts encountered while merging.
49
This subclasses ExceptionConflictHandler, so that any types of
50
conflict that are not explicitly handled cause an exception and
53
def __init__(self, ignore_zero=False):
54
ExceptionConflictHandler.__init__(self)
56
self.ignore_zero = ignore_zero
58
def copy(self, source, dest):
59
"""Copy the text and mode of a file
60
:param source: The path of the file to copy
61
:param dest: The distination file to create
63
s_file = file(source, "rb")
64
d_file = file(dest, "wb")
67
os.chmod(dest, 0777 & os.stat(source).st_mode)
69
def dump(self, lines, 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
d_file = file(dest, "wb")
78
def add_suffix(self, name, suffix, last_new_name=None):
79
"""Rename a file to append a suffix. If the new name exists, the
80
suffix is added repeatedly until a non-existant name is found
82
:param name: The path of the file
83
:param suffix: The suffix to append
84
:param last_new_name: (used for recursive calls) the last name tried
86
if last_new_name is None:
88
new_name = last_new_name+suffix
90
rename(name, new_name)
93
if e.errno != errno.EEXIST and e.errno != errno.ENOTEMPTY:
95
return self.add_suffix(name, suffix, last_new_name=new_name)
97
def conflict(self, text):
102
def merge_conflict(self, new_file, this_path, base_lines, other_lines):
104
Handle diff3 conflicts by producing a .THIS, .BASE and .OTHER. The
105
main file will be a version with diff3 conflicts.
106
:param new_file: Path to the output file with diff3 markers
107
:param this_path: Path to the file text for the THIS tree
108
:param base_path: Path to the file text for the BASE tree
109
:param other_path: Path to the file text for the OTHER tree
111
self.add_suffix(this_path, ".THIS")
112
self.dump(base_lines, this_path+".BASE")
113
self.dump(other_lines, this_path+".OTHER")
114
rename(new_file, this_path)
115
self.conflict("Diff3 conflict encountered in %s" % this_path)
117
def new_contents_conflict(self, filename, other_contents):
118
"""Conflicting contents for newly added file."""
119
self.copy(other_contents, filename + ".OTHER")
120
self.conflict("Conflict in newly added file %s" % filename)
123
def target_exists(self, entry, target, old_path):
124
"""Handle the case when the target file or dir exists"""
125
moved_path = self.add_suffix(target, ".moved")
126
self.conflict("Moved existing %s to %s" % (target, moved_path))
128
def rmdir_non_empty(self, filename):
129
"""Handle the case where the dir to be removed still has contents"""
130
self.conflict("Directory %s not removed because it is not empty"\
134
def rem_contents_conflict(self, filename, this_contents, base_contents):
135
base_contents(filename+".BASE", self, False)
136
this_contents(filename+".THIS", self, False)
137
return ReplaceContents(this_contents, None)
140
if not self.ignore_zero:
141
print "%d conflicts encountered.\n" % self.conflicts
143
def get_tree(treespec, temp_root, label, local_branch=None):
144
location, revno = treespec
145
branch = Branch.open_containing(location)
149
revision = branch.last_revision()
151
revision = branch.get_rev_id(revno)
152
return branch, get_revid_tree(branch, revision, temp_root, label,
155
def get_revid_tree(branch, revision, temp_root, label, local_branch):
157
base_tree = branch.working_tree()
159
if local_branch is not None:
160
greedy_fetch(local_branch, branch, revision)
161
base_tree = local_branch.revision_tree(revision)
163
base_tree = branch.revision_tree(revision)
164
temp_path = os.path.join(temp_root, label)
166
return MergeTree(base_tree, temp_path)
169
def file_exists(tree, file_id):
170
return tree.has_filename(tree.id2path(file_id))
173
class MergeTree(object):
174
def __init__(self, tree, tempdir):
175
object.__init__(self)
176
if hasattr(tree, "basedir"):
177
self.root = tree.basedir
181
self.tempdir = tempdir
182
os.mkdir(os.path.join(self.tempdir, "texts"))
186
return self.tree.__iter__()
188
def __contains__(self, file_id):
189
return file_id in self.tree
191
def get_file(self, file_id):
192
return self.tree.get_file(file_id)
194
def get_file_sha1(self, id):
195
return self.tree.get_file_sha1(id)
197
def id2path(self, file_id):
198
return self.tree.id2path(file_id)
200
def has_id(self, file_id):
201
return self.tree.has_id(file_id)
203
def has_or_had_id(self, file_id):
204
if file_id == self.tree.inventory.root.file_id:
206
return self.tree.inventory.has_id(file_id)
208
def has_or_had_id(self, file_id):
209
if file_id == self.tree.inventory.root.file_id:
211
return self.tree.inventory.has_id(file_id)
213
def readonly_path(self, id):
214
if id not in self.tree:
216
if self.root is not None:
217
return self.tree.abspath(self.tree.id2path(id))
219
if self.tree.inventory[id].kind in ("directory", "root_directory"):
221
if not self.cached.has_key(id):
222
path = os.path.join(self.tempdir, "texts", id)
223
outfile = file(path, "wb")
224
outfile.write(self.tree.get_file(id).read())
225
assert(os.path.exists(path))
226
self.cached[id] = path
227
return self.cached[id]
231
def merge(other_revision, base_revision,
232
check_clean=True, ignore_zero=False,
233
this_dir=None, backup_files=False, merge_type=ApplyMerge3,
235
"""Merge changes into a tree.
238
tuple(path, revision) Base for three-way merge.
240
tuple(path, revision) Other revision for three-way merge.
242
Directory to merge changes into; '.' by default.
244
If true, this_dir must have no uncommitted changes before the
247
All available ancestors of other_revision and base_revision are
248
automatically pulled into the branch.
250
tempdir = tempfile.mkdtemp(prefix="bzr-")
254
this_branch = Branch.open_containing(this_dir)
255
this_rev_id = this_branch.last_revision()
256
if this_rev_id is None:
257
raise BzrCommandError("This branch has no commits")
259
changes = compare_trees(this_branch.working_tree(),
260
this_branch.basis_tree(), False)
261
if changes.has_changed():
262
raise BzrCommandError("Working tree has uncommitted changes.")
263
other_branch, other_tree = get_tree(other_revision, tempdir, "other",
265
if other_revision[1] == -1:
266
other_rev_id = other_branch.last_revision()
267
if other_rev_id is None:
268
raise NoCommits(other_branch)
269
other_basis = other_rev_id
270
elif other_revision[1] is not None:
271
other_rev_id = other_branch.get_rev_id(other_revision[1])
272
other_basis = other_rev_id
275
other_basis = other_branch.last_revision()
276
if other_basis is None:
277
raise NoCommits(other_branch)
278
if base_revision == [None, None]:
280
base_rev_id = common_ancestor(this_rev_id, other_basis,
282
except NoCommonAncestor:
283
raise UnrelatedBranches()
284
base_tree = get_revid_tree(this_branch, base_rev_id, tempdir,
286
base_is_ancestor = True
288
base_branch, base_tree = get_tree(base_revision, tempdir, "base")
289
if base_revision[1] == -1:
290
base_rev_id = base_branch.last_revision()
291
elif base_revision[1] is None:
294
base_rev_id = base_branch.get_rev_id(base_revision[1])
295
fetch(from_branch=base_branch, to_branch=this_branch)
296
base_is_ancestor = is_ancestor(this_rev_id, base_rev_id,
298
if file_list is None:
299
interesting_ids = None
301
interesting_ids = set()
302
this_tree = this_branch.working_tree()
303
for fname in file_list:
304
path = this_branch.relpath(fname)
306
for tree in (this_tree, base_tree.tree, other_tree.tree):
307
file_id = tree.inventory.path2id(path)
308
if file_id is not None:
309
interesting_ids.add(file_id)
312
raise BzrCommandError("%s is not a source file in any"
314
merge_inner(this_branch, other_tree, base_tree, tempdir,
315
ignore_zero=ignore_zero, backup_files=backup_files,
316
merge_type=merge_type, interesting_ids=interesting_ids)
317
if base_is_ancestor and other_rev_id is not None\
318
and other_rev_id not in this_branch.revision_history():
319
this_branch.add_pending_merge(other_rev_id)
321
shutil.rmtree(tempdir)
324
def set_interesting(inventory_a, inventory_b, interesting_ids):
325
"""Mark files whose ids are in interesting_ids as interesting
327
for inventory in (inventory_a, inventory_b):
328
for path, source_file in inventory.iteritems():
329
source_file.interesting = source_file.id in interesting_ids
332
def generate_cset_optimized(tree_a, tree_b, interesting_ids=None):
333
"""Generate a changeset. If interesting_ids is supplied, only changes
334
to those files will be shown. Metadata changes are stripped.
336
cset = generate_changeset(tree_a, tree_b, interesting_ids)
337
for entry in cset.entries.itervalues():
338
entry.metadata_change = None
342
def merge_inner(this_branch, other_tree, base_tree, tempdir,
343
ignore_zero=False, merge_type=ApplyMerge3, backup_files=False,
344
interesting_ids=None):
346
def merge_factory(file_id, base, other):
347
contents_change = merge_type(file_id, base, other)
349
contents_change = BackupBeforeChange(contents_change)
350
return contents_change
352
this_tree = get_tree((this_branch.base, None), tempdir, "this")[1]
354
def get_inventory(tree):
355
return tree.tree.inventory
357
inv_changes = merge_flex(this_tree, base_tree, other_tree,
358
generate_cset_optimized, get_inventory,
359
MergeConflictHandler(ignore_zero=ignore_zero),
360
merge_factory=merge_factory,
361
interesting_ids=interesting_ids)
364
for id, path in inv_changes.iteritems():
369
assert path.startswith('.' + os.sep), "path is %s" % path
371
adjust_ids.append((path, id))
372
if len(adjust_ids) > 0:
373
this_branch.set_inventory(regen_inventory(this_branch, this_tree.root,
377
def regen_inventory(this_branch, root, new_entries):
378
old_entries = this_branch.read_working_inventory()
382
for path, file_id in new_entries:
385
new_entries_map[file_id] = path
387
def id2path(file_id):
388
path = new_entries_map.get(file_id)
391
entry = old_entries[file_id]
392
if entry.parent_id is None:
394
return os.path.join(id2path(entry.parent_id), entry.name)
396
for file_id in old_entries:
397
entry = old_entries[file_id]
398
path = id2path(file_id)
399
new_inventory[file_id] = (path, file_id, entry.parent_id, entry.kind)
400
by_path[path] = file_id
405
for path, file_id in new_entries:
407
del new_inventory[file_id]
410
new_path_list.append((path, file_id))
411
if file_id not in old_entries:
413
# Ensure no file is added before its parent
415
for path, file_id in new_path_list:
419
parent = by_path[os.path.dirname(path)]
420
kind = bzrlib.osutils.file_kind(os.path.join(root, path))
421
new_inventory[file_id] = (path, file_id, parent, kind)
422
by_path[path] = file_id
424
# Get a list in insertion order
425
new_inventory_list = new_inventory.values()
426
mutter ("""Inventory regeneration:
427
old length: %i insertions: %i deletions: %i new_length: %i"""\
428
% (len(old_entries), insertions, deletions, len(new_inventory_list)))
429
assert len(new_inventory_list) == len(old_entries) + insertions - deletions
430
new_inventory_list.sort()
431
return new_inventory_list
433
merge_types = { "merge3": (ApplyMerge3, "Native diff3-style merge"),
434
"diff3": (Diff3Merge, "Merge using external diff3")
added
removed
bzrlib/merge.py
