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
1
from merge_core import merge_flex
2
from changeset import generate_changeset, ExceptionConflictHandler
3
from changeset import Inventory
4
from bzrlib import find_branch
6
from bzrlib.errors import BzrCommandError
7
from bzrlib.diff import compare_trees
8
from trace import mutter, warning
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, note
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
39
# TODO: build_working_dir can be built on something simpler than merge()
41
# FIXME: merge() parameters seem oriented towards the command line
42
# NOTABUG: merge is a helper for commandline functions. merge_inner is the
43
# the core functionality.
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
14
class UnrelatedBranches(BzrCommandError):
16
msg = "Branches have no common ancestor, and no base revision"\
18
BzrCommandError.__init__(self, msg)
51
21
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)
22
"""Handle conflicts encountered while merging"""
23
def __init__(self, dir, ignore_zero=False):
24
ExceptionConflictHandler.__init__(self, dir)
61
26
self.ignore_zero = ignore_zero
62
self.this_tree = this_tree
63
self.base_tree = base_tree
64
self.other_tree = other_tree
66
28
def copy(self, source, dest):
67
29
"""Copy the text and mode of a file
142
def rem_contents_conflict(self, filename, this_contents, base_contents):
143
base_contents(filename+".BASE", self, False)
144
this_contents(filename+".THIS", self, False)
145
return ReplaceContents(this_contents, None)
147
def rem_contents_conflict(self, filename, this_contents, base_contents):
148
base_contents(filename+".BASE", self, False)
149
this_contents(filename+".THIS", self, False)
150
self.conflict("Other branch deleted locally modified file %s" %
152
return ReplaceContents(this_contents, None)
154
def abs_this_path(self, file_id):
155
"""Return the absolute path for a file_id in the this tree."""
156
relpath = self.this_tree.id2path(file_id)
157
return self.this_tree.tree.abspath(relpath)
159
def add_missing_parents(self, file_id, tree):
160
"""If some of the parents for file_id are missing, add them."""
161
entry = tree.tree.inventory[file_id]
162
if entry.parent_id not in self.this_tree:
163
return self.create_all_missing(entry.parent_id, tree)
165
return self.abs_this_path(entry.parent_id)
167
def create_all_missing(self, file_id, tree):
168
"""Add contents for a file_id and all its parents to a tree."""
169
entry = tree.tree.inventory[file_id]
170
if entry.parent_id is not None and entry.parent_id not in self.this_tree:
171
abspath = self.create_all_missing(entry.parent_id, tree)
173
abspath = self.abs_this_path(entry.parent_id)
174
entry_path = os.path.join(abspath, entry.name)
175
if not os.path.isdir(entry_path):
176
self.create(file_id, entry_path, tree)
179
def create(self, file_id, path, tree, reverse=False):
180
"""Uses tree data to create a filesystem object for the file_id"""
181
from merge_core import get_id_contents
182
get_id_contents(file_id, tree)(path, self, reverse)
184
def missing_for_merge(self, file_id, other_path):
185
"""The file_id doesn't exist in THIS, but does in OTHER and BASE"""
186
self.conflict("Other branch modified locally deleted file %s" %
188
parent_dir = self.add_missing_parents(file_id, self.other_tree)
189
stem = os.path.join(parent_dir, os.path.basename(other_path))
190
self.create(file_id, stem+".OTHER", self.other_tree)
191
self.create(file_id, stem+".BASE", self.base_tree)
193
89
def finalize(self):
194
90
if not self.ignore_zero:
195
note("%d conflicts encountered.\n" % self.conflicts)
91
print "%d conflicts encountered.\n" % self.conflicts
197
def get_tree(treespec, temp_root, label, local_branch=None):
93
class SourceFile(object):
94
def __init__(self, path, id, present=None, isdir=None):
97
self.present = present
99
self.interesting = True
102
return "SourceFile(%s, %s)" % (self.path, self.id)
104
def get_tree(treespec, temp_root, label):
198
105
location, revno = treespec
199
branch = Branch.open_containing(location)
106
branch = find_branch(location)
200
107
if revno is None:
108
base_tree = branch.working_tree()
202
109
elif revno == -1:
203
revision = branch.last_revision()
205
revision = branch.get_rev_id(revno)
206
return branch, get_revid_tree(branch, revision, temp_root, label,
209
def get_revid_tree(branch, revision, temp_root, label, local_branch):
211
base_tree = branch.working_tree()
213
if local_branch is not None:
214
greedy_fetch(local_branch, branch, revision)
215
base_tree = local_branch.revision_tree(revision)
217
base_tree = branch.revision_tree(revision)
110
base_tree = branch.basis_tree()
112
base_tree = branch.revision_tree(branch.lookup_revision(revno))
218
113
temp_path = os.path.join(temp_root, label)
219
114
os.mkdir(temp_path)
220
return MergeTree(base_tree, temp_path)
115
return branch, MergeTree(base_tree, temp_path)
118
def abspath(tree, file_id):
119
path = tree.inventory.id2path(file_id)
223
124
def file_exists(tree, file_id):
224
125
return tree.has_filename(tree.id2path(file_id))
127
def inventory_map(tree):
129
for file_id in tree.inventory:
130
path = abspath(tree, file_id)
131
inventory[path] = SourceFile(path, file_id)
227
135
class MergeTree(object):
228
136
def __init__(self, tree, tempdir):
231
139
self.root = tree.basedir
142
self.inventory = inventory_map(tree)
235
144
self.tempdir = tempdir
236
145
os.mkdir(os.path.join(self.tempdir, "texts"))
237
os.mkdir(os.path.join(self.tempdir, "symlinks"))
241
return self.tree.__iter__()
243
def __contains__(self, file_id):
244
return file_id in self.tree
246
def get_file(self, file_id):
247
return self.tree.get_file(file_id)
249
def get_file_sha1(self, id):
250
return self.tree.get_file_sha1(id)
252
def is_executable(self, id):
253
return self.tree.is_executable(id)
255
def id2path(self, file_id):
256
return self.tree.id2path(file_id)
258
def has_id(self, file_id):
259
return self.tree.has_id(file_id)
261
def has_or_had_id(self, file_id):
262
if file_id == self.tree.inventory.root.file_id:
264
return self.tree.inventory.has_id(file_id)
266
def has_or_had_id(self, file_id):
267
if file_id == self.tree.inventory.root.file_id:
269
return self.tree.inventory.has_id(file_id)
271
148
def readonly_path(self, id):
272
149
if id not in self.tree:
274
151
if self.root is not None:
275
152
return self.tree.abspath(self.tree.id2path(id))
277
kind = self.tree.inventory[id].kind
278
if kind in ("directory", "root_directory"):
154
if self.tree.inventory[id].kind in ("directory", "root_directory"):
279
155
return self.tempdir
280
156
if not self.cached.has_key(id):
282
path = os.path.join(self.tempdir, "texts", id)
283
outfile = file(path, "wb")
284
outfile.write(self.tree.get_file(id).read())
285
assert(bzrlib.osutils.lexists(path))
286
if self.tree.is_executable(id):
289
assert kind == "symlink"
290
path = os.path.join(self.tempdir, "symlinks", id)
291
target = self.tree.get_symlink_target(id)
292
os.symlink(target, path)
157
path = os.path.join(self.tempdir, "texts", id)
158
outfile = file(path, "wb")
159
outfile.write(self.tree.get_file(id).read())
160
assert(os.path.exists(path))
293
161
self.cached[id] = path
294
162
return self.cached[id]
297
def build_working_dir(to_dir):
298
"""Build a working directory in an empty directory.
300
to_dir is a directory containing branch metadata but no working files,
301
typically constructed by cloning an existing branch.
303
This is split out as a special idiomatic case of merge. It could
304
eventually be done by just building the tree directly calling into
305
lower-level code (e.g. constructing a changeset).
307
merge((to_dir, -1), (to_dir, 0), this_dir=to_dir,
308
check_clean=False, ignore_zero=True)
311
166
def merge(other_revision, base_revision,
312
167
check_clean=True, ignore_zero=False,
313
this_dir=None, backup_files=False, merge_type=ApplyMerge3,
315
169
"""Merge changes into a tree.
318
tuple(path, revision) Base for three-way merge.
172
Base for three-way merge.
320
tuple(path, revision) Other revision for three-way merge.
174
Other revision for three-way merge.
322
176
Directory to merge changes into; '.' by default.
324
178
If true, this_dir must have no uncommitted changes before the
326
ignore_zero - If true, suppress the "zero conflicts" message when
327
there are no conflicts; should be set when doing something we expect
328
to complete perfectly.
330
All available ancestors of other_revision and base_revision are
331
automatically pulled into the branch.
333
181
tempdir = tempfile.mkdtemp(prefix="bzr-")
335
183
if this_dir is None:
337
this_branch = Branch.open_containing(this_dir)
338
this_rev_id = this_branch.last_revision()
339
if this_rev_id is None:
340
raise BzrCommandError("This branch has no commits")
185
this_branch = find_branch(this_dir)
342
187
changes = compare_trees(this_branch.working_tree(),
343
188
this_branch.basis_tree(), False)
344
189
if changes.has_changed():
345
190
raise BzrCommandError("Working tree has uncommitted changes.")
346
other_branch, other_tree = get_tree(other_revision, tempdir, "other",
348
if other_revision[1] == -1:
349
other_rev_id = other_branch.last_revision()
350
if other_rev_id is None:
351
raise NoCommits(other_branch)
352
other_basis = other_rev_id
353
elif other_revision[1] is not None:
354
other_rev_id = other_branch.get_rev_id(other_revision[1])
355
other_basis = other_rev_id
358
other_basis = other_branch.last_revision()
359
if other_basis is None:
360
raise NoCommits(other_branch)
191
other_branch, other_tree = get_tree(other_revision, tempdir, "other")
361
192
if base_revision == [None, None]:
363
base_rev_id = common_ancestor(this_rev_id, other_basis,
365
except NoCommonAncestor:
193
if other_revision[1] == -1:
196
o_revno = other_revision[1]
197
base_revno = this_branch.common_ancestor(other_branch,
198
other_revno=o_revno)[0]
199
if base_revno is None:
366
200
raise UnrelatedBranches()
367
base_tree = get_revid_tree(this_branch, base_rev_id, tempdir,
369
base_is_ancestor = True
371
base_branch, base_tree = get_tree(base_revision, tempdir, "base")
372
if base_revision[1] == -1:
373
base_rev_id = base_branch.last_revision()
374
elif base_revision[1] is None:
377
base_rev_id = base_branch.get_rev_id(base_revision[1])
378
fetch(from_branch=base_branch, to_branch=this_branch)
379
base_is_ancestor = is_ancestor(this_rev_id, base_rev_id,
381
if file_list is None:
382
interesting_ids = None
384
interesting_ids = set()
385
this_tree = this_branch.working_tree()
386
for fname in file_list:
387
path = this_branch.relpath(fname)
389
for tree in (this_tree, base_tree.tree, other_tree.tree):
390
file_id = tree.inventory.path2id(path)
391
if file_id is not None:
392
interesting_ids.add(file_id)
395
raise BzrCommandError("%s is not a source file in any"
201
base_revision = ['.', base_revno]
202
base_branch, base_tree = get_tree(base_revision, tempdir, "base")
397
203
merge_inner(this_branch, other_tree, base_tree, tempdir,
398
ignore_zero=ignore_zero, backup_files=backup_files,
399
merge_type=merge_type, interesting_ids=interesting_ids)
400
if base_is_ancestor and other_rev_id is not None\
401
and other_rev_id not in this_branch.revision_history():
402
this_branch.add_pending_merge(other_rev_id)
204
ignore_zero=ignore_zero)
404
206
shutil.rmtree(tempdir)
407
def set_interesting(inventory_a, inventory_b, interesting_ids):
408
"""Mark files whose ids are in interesting_ids as interesting
410
for inventory in (inventory_a, inventory_b):
411
for path, source_file in inventory.iteritems():
412
source_file.interesting = source_file.id in interesting_ids
209
def generate_cset_optimized(tree_a, tree_b, inventory_a, inventory_b):
210
"""Generate a changeset, using the text_id to mark really-changed files.
211
This permits blazing comparisons when text_ids are present. It also
212
disables metadata comparison for files with identical texts.
214
for file_id in tree_a.tree.inventory:
215
if file_id not in tree_b.tree.inventory:
217
entry_a = tree_a.tree.inventory[file_id]
218
entry_b = tree_b.tree.inventory[file_id]
219
if (entry_a.kind, entry_b.kind) != ("file", "file"):
221
if None in (entry_a.text_id, entry_b.text_id):
223
if entry_a.text_id != entry_b.text_id:
225
inventory_a[abspath(tree_a.tree, file_id)].interesting = False
226
inventory_b[abspath(tree_b.tree, file_id)].interesting = False
227
cset = generate_changeset(tree_a, tree_b, inventory_a, inventory_b)
228
for entry in cset.entries.itervalues():
229
entry.metadata_change = None
415
233
def merge_inner(this_branch, other_tree, base_tree, tempdir,
416
ignore_zero=False, merge_type=ApplyMerge3, backup_files=False,
417
interesting_ids=None):
419
def merge_factory(file_id, base, other):
420
contents_change = merge_type(file_id, base, other)
422
contents_change = BackupBeforeChange(contents_change)
423
return contents_change
425
235
this_tree = get_tree((this_branch.base, None), tempdir, "this")[1]
427
237
def get_inventory(tree):
428
return tree.tree.inventory
238
return tree.inventory
430
240
inv_changes = merge_flex(this_tree, base_tree, other_tree,
431
generate_changeset, get_inventory,
432
MergeConflictHandler(this_tree, base_tree,
433
other_tree, ignore_zero=ignore_zero),
434
merge_factory=merge_factory,
435
interesting_ids=interesting_ids)
241
generate_cset_optimized, get_inventory,
242
MergeConflictHandler(base_tree.root,
243
ignore_zero=ignore_zero))
438
246
for id, path in inv_changes.iteritems():
added
removed
bzrlib/merge.py
