1
from merge_core import merge_flex, ApplyMerge3, BackupBeforeChange
2
from changeset import generate_changeset, ExceptionConflictHandler
3
from changeset import Inventory, Diff3Merge
4
from bzrlib import find_branch
6
from bzrlib.errors import BzrCommandError
7
from bzrlib.delta import compare_trees
8
from trace import mutter, warning
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
14
class UnrelatedBranches(BzrCommandError):
16
msg = "Branches have no common ancestor, and no base revision"\
18
BzrCommandError.__init__(self, msg)
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
39
# TODO: build_working_dir can be built on something simpler than merge()
41
# FIXME: merge() parameters seem oriented towards the command line
43
# comments from abentley on irc: merge happens in two stages, each
44
# of which generates a changeset object
46
# stage 1: generate OLD->OTHER,
47
# stage 2: use MINE and OLD->OTHER to generate MINE -> RESULT
21
49
class MergeConflictHandler(ExceptionConflictHandler):
22
"""Handle conflicts encountered while merging"""
23
def __init__(self, dir, ignore_zero=False):
24
ExceptionConflictHandler.__init__(self, dir)
50
"""Handle conflicts encountered while merging.
52
This subclasses ExceptionConflictHandler, so that any types of
53
conflict that are not explicitly handled cause an exception and
56
def __init__(self, this_tree, base_tree, other_tree, ignore_zero=False):
57
ExceptionConflictHandler.__init__(self)
26
59
self.ignore_zero = ignore_zero
60
self.this_tree = this_tree
61
self.base_tree = base_tree
62
self.other_tree = other_tree
28
64
def copy(self, source, dest):
29
65
"""Copy the text and mode of a file
70
115
:param other_path: Path to the file text for the OTHER tree
72
117
self.add_suffix(this_path, ".THIS")
73
self.copy(base_path, this_path+".BASE")
74
self.copy(other_path, this_path+".OTHER")
75
os.rename(new_file, this_path)
118
self.dump(base_lines, this_path+".BASE")
119
self.dump(other_lines, this_path+".OTHER")
120
rename(new_file, this_path)
76
121
self.conflict("Diff3 conflict encountered in %s" % this_path)
123
def new_contents_conflict(self, filename, other_contents):
124
"""Conflicting contents for newly added file."""
125
self.copy(other_contents, filename + ".OTHER")
126
self.conflict("Conflict in newly added file %s" % filename)
78
129
def target_exists(self, entry, target, old_path):
79
130
"""Handle the case when the target file or dir exists"""
80
131
moved_path = self.add_suffix(target, ".moved")
140
def rem_contents_conflict(self, filename, this_contents, base_contents):
141
base_contents(filename+".BASE", self, False)
142
this_contents(filename+".THIS", self, False)
143
self.conflict("Other branch deleted locally modified file %s" %
145
return ReplaceContents(this_contents, None)
147
def abs_this_path(self, file_id):
148
"""Return the absolute path for a file_id in the this tree."""
149
relpath = self.this_tree.id2path(file_id)
150
return self.this_tree.tree.abspath(relpath)
152
def add_missing_parents(self, file_id, tree):
153
"""If some of the parents for file_id are missing, add them."""
154
entry = tree.tree.inventory[file_id]
155
if entry.parent_id not in self.this_tree:
156
return self.create_all_missing(entry.parent_id, tree)
158
return self.abs_this_path(entry.parent_id)
160
def create_all_missing(self, file_id, tree):
161
"""Add contents for a file_id and all its parents to a tree."""
162
entry = tree.tree.inventory[file_id]
163
if entry.parent_id is not None and entry.parent_id not in self.this_tree:
164
abspath = self.create_all_missing(entry.parent_id, tree)
166
abspath = self.abs_this_path(entry.parent_id)
167
entry_path = os.path.join(abspath, entry.name)
168
if not os.path.isdir(entry_path):
169
self.create(file_id, entry_path, tree)
172
def create(self, file_id, path, tree, reverse=False):
173
"""Uses tree data to create a filesystem object for the file_id"""
174
from merge_core import get_id_contents
175
get_id_contents(file_id, tree)(path, self, reverse)
177
def missing_for_merge(self, file_id, other_path):
178
"""The file_id doesn't exist in THIS, but does in OTHER and BASE"""
179
self.conflict("Other branch modified locally deleted file %s" %
181
parent_dir = self.add_missing_parents(file_id, self.other_tree)
182
stem = os.path.join(parent_dir, os.path.basename(other_path))
183
self.create(file_id, stem+".OTHER", self.other_tree)
184
self.create(file_id, stem+".BASE", self.base_tree)
89
186
def finalize(self):
90
187
if not self.ignore_zero:
91
188
print "%d conflicts encountered.\n" % self.conflicts
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):
190
def get_tree(treespec, temp_root, label, local_branch=None):
105
191
location, revno = treespec
106
branch = find_branch(location)
192
branch = Branch.open_containing(location)
107
193
if revno is None:
196
revision = branch.last_revision()
198
revision = branch.get_rev_id(revno)
199
return branch, get_revid_tree(branch, revision, temp_root, label,
202
def get_revid_tree(branch, revision, temp_root, label, local_branch):
108
204
base_tree = branch.working_tree()
110
base_tree = branch.basis_tree()
112
base_tree = branch.revision_tree(branch.lookup_revision(revno))
206
if local_branch is not None:
207
greedy_fetch(local_branch, branch, revision)
208
base_tree = local_branch.revision_tree(revision)
210
base_tree = branch.revision_tree(revision)
113
211
temp_path = os.path.join(temp_root, label)
114
212
os.mkdir(temp_path)
115
return branch, MergeTree(base_tree, temp_path)
118
def abspath(tree, file_id):
119
path = tree.inventory.id2path(file_id)
213
return MergeTree(base_tree, temp_path)
124
216
def file_exists(tree, file_id):
125
217
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)
135
220
class MergeTree(object):
136
221
def __init__(self, tree, tempdir):
139
224
self.root = tree.basedir
142
self.inventory = inventory_map(tree)
144
228
self.tempdir = tempdir
145
229
os.mkdir(os.path.join(self.tempdir, "texts"))
230
os.mkdir(os.path.join(self.tempdir, "symlinks"))
234
return self.tree.__iter__()
236
def __contains__(self, file_id):
237
return file_id in self.tree
239
def get_file(self, file_id):
240
return self.tree.get_file(file_id)
242
def get_file_sha1(self, id):
243
return self.tree.get_file_sha1(id)
245
def id2path(self, file_id):
246
return self.tree.id2path(file_id)
248
def has_id(self, file_id):
249
return self.tree.has_id(file_id)
251
def has_or_had_id(self, file_id):
252
if file_id == self.tree.inventory.root.file_id:
254
return self.tree.inventory.has_id(file_id)
256
def has_or_had_id(self, file_id):
257
if file_id == self.tree.inventory.root.file_id:
259
return self.tree.inventory.has_id(file_id)
148
261
def readonly_path(self, id):
149
262
if id not in self.tree:
151
264
if self.root is not None:
152
265
return self.tree.abspath(self.tree.id2path(id))
154
if self.tree.inventory[id].kind in ("directory", "root_directory"):
267
kind = self.tree.inventory[id].kind
268
if kind in ("directory", "root_directory"):
155
269
return self.tempdir
156
270
if not self.cached.has_key(id):
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))
272
path = os.path.join(self.tempdir, "texts", id)
273
outfile = file(path, "wb")
274
outfile.write(self.tree.get_file(id).read())
275
assert(bzrlib.osutils.lexists(path))
277
assert kind == "symlink"
278
path = os.path.join(self.tempdir, "symlinks", id)
279
target = self.tree.get_symlink_target(id)
280
os.symlink(target, path)
161
281
self.cached[id] = path
162
282
return self.cached[id]
285
def build_working_dir(to_dir):
286
"""Build a working directory in an empty directory.
288
to_dir is a directory containing branch metadata but no working files,
289
typically constructed by cloning an existing branch.
291
This is split out as a special idiomatic case of merge. It could
292
eventually be done by just building the tree directly calling into
293
lower-level code (e.g. constructing a changeset).
295
merge((to_dir, -1), (to_dir, 0), this_dir=to_dir,
296
check_clean=False, ignore_zero=True)
166
299
def merge(other_revision, base_revision,
167
300
check_clean=True, ignore_zero=False,
170
303
"""Merge changes into a tree.
173
Base for three-way merge.
306
tuple(path, revision) Base for three-way merge.
175
Other revision for three-way merge.
308
tuple(path, revision) Other revision for three-way merge.
177
310
Directory to merge changes into; '.' by default.
179
312
If true, this_dir must have no uncommitted changes before the
314
ignore_zero - If true, suppress the "zero conflicts" message when
315
there are no conflicts; should be set when doing something we expect
316
to complete perfectly.
318
All available ancestors of other_revision and base_revision are
319
automatically pulled into the branch.
182
321
tempdir = tempfile.mkdtemp(prefix="bzr-")
184
323
if this_dir is None:
186
this_branch = find_branch(this_dir)
325
this_branch = Branch.open_containing(this_dir)
326
this_rev_id = this_branch.last_revision()
327
if this_rev_id is None:
328
raise BzrCommandError("This branch has no commits")
188
330
changes = compare_trees(this_branch.working_tree(),
189
331
this_branch.basis_tree(), False)
190
332
if changes.has_changed():
191
333
raise BzrCommandError("Working tree has uncommitted changes.")
192
other_branch, other_tree = get_tree(other_revision, tempdir, "other")
334
other_branch, other_tree = get_tree(other_revision, tempdir, "other",
336
if other_revision[1] == -1:
337
other_rev_id = other_branch.last_revision()
338
if other_rev_id is None:
339
raise NoCommits(other_branch)
340
other_basis = other_rev_id
341
elif other_revision[1] is not None:
342
other_rev_id = other_branch.get_rev_id(other_revision[1])
343
other_basis = other_rev_id
346
other_basis = other_branch.last_revision()
347
if other_basis is None:
348
raise NoCommits(other_branch)
193
349
if base_revision == [None, None]:
194
if other_revision[1] == -1:
197
o_revno = other_revision[1]
198
base_revno = this_branch.common_ancestor(other_branch,
199
other_revno=o_revno)[0]
200
if base_revno is None:
351
base_rev_id = common_ancestor(this_rev_id, other_basis,
353
except NoCommonAncestor:
201
354
raise UnrelatedBranches()
202
base_revision = ['.', base_revno]
203
base_branch, base_tree = get_tree(base_revision, tempdir, "base")
355
base_tree = get_revid_tree(this_branch, base_rev_id, tempdir,
357
base_is_ancestor = True
359
base_branch, base_tree = get_tree(base_revision, tempdir, "base")
360
if base_revision[1] == -1:
361
base_rev_id = base_branch.last_revision()
362
elif base_revision[1] is None:
365
base_rev_id = base_branch.get_rev_id(base_revision[1])
366
fetch(from_branch=base_branch, to_branch=this_branch)
367
base_is_ancestor = is_ancestor(this_rev_id, base_rev_id,
204
369
if file_list is None:
205
370
interesting_ids = None
232
400
source_file.interesting = source_file.id in interesting_ids
235
def set_optimized(tree_a, tree_b, inventory_a, inventory_b):
236
"""Mark files that have changed texts as interesting
238
for file_id in tree_a.tree.inventory:
239
if file_id not in tree_b.tree.inventory:
241
entry_a = tree_a.tree.inventory[file_id]
242
entry_b = tree_b.tree.inventory[file_id]
243
if (entry_a.kind, entry_b.kind) != ("file", "file"):
245
if None in (entry_a.text_id, entry_b.text_id):
247
if entry_a.text_id != entry_b.text_id:
249
inventory_a[abspath(tree_a.tree, file_id)].interesting = False
250
inventory_b[abspath(tree_b.tree, file_id)].interesting = False
253
def generate_cset_optimized(tree_a, tree_b, inventory_a, inventory_b,
254
interesting_ids=None):
255
"""Generate a changeset, with preprocessing to select interesting files.
256
using the text_id to mark really-changed files.
257
This permits blazing comparisons when text_ids are present. It also
258
disables metadata comparison for files with identical texts.
403
def generate_cset_optimized(tree_a, tree_b, interesting_ids=None):
404
"""Generate a changeset. If interesting_ids is supplied, only changes
405
to those files will be shown. Metadata changes are stripped.
260
if interesting_ids is None:
261
set_optimized(tree_a, tree_b, inventory_a, inventory_b)
263
set_interesting(inventory_a, inventory_b, interesting_ids)
264
cset = generate_changeset(tree_a, tree_b, inventory_a, inventory_b)
407
cset = generate_changeset(tree_a, tree_b, interesting_ids)
265
408
for entry in cset.entries.itervalues():
266
409
entry.metadata_change = None
271
414
ignore_zero=False, merge_type=ApplyMerge3, backup_files=False,
272
415
interesting_ids=None):
274
def merge_factory(base_file, other_file):
275
contents_change = merge_type(base_file, other_file)
417
def merge_factory(file_id, base, other):
418
contents_change = merge_type(file_id, base, other)
277
420
contents_change = BackupBeforeChange(contents_change)
278
421
return contents_change
280
def generate_cset(tree_a, tree_b, inventory_a, inventory_b):
281
return generate_cset_optimized(tree_a, tree_b, inventory_a, inventory_b,
284
423
this_tree = get_tree((this_branch.base, None), tempdir, "this")[1]
286
425
def get_inventory(tree):
287
return tree.inventory
426
return tree.tree.inventory
289
428
inv_changes = merge_flex(this_tree, base_tree, other_tree,
290
generate_cset, get_inventory,
291
MergeConflictHandler(base_tree.root,
292
ignore_zero=ignore_zero),
293
merge_factory=merge_factory)
429
generate_cset_optimized, get_inventory,
430
MergeConflictHandler(this_tree, base_tree,
431
other_tree, ignore_zero=ignore_zero),
432
merge_factory=merge_factory,
433
interesting_ids=interesting_ids)
296
436
for id, path in inv_changes.iteritems():
301
assert path.startswith('./')
441
assert path.startswith('.' + os.sep), "path is %s" % path
303
443
adjust_ids.append((path, id))
304
this_branch.set_inventory(regen_inventory(this_branch, this_tree.root, adjust_ids))
444
if len(adjust_ids) > 0:
445
this_branch.set_inventory(regen_inventory(this_branch, this_tree.root,
307
449
def regen_inventory(this_branch, root, new_entries):
308
450
old_entries = this_branch.read_working_inventory()
309
451
new_inventory = {}
454
for path, file_id in new_entries:
457
new_entries_map[file_id] = path
459
def id2path(file_id):
460
path = new_entries_map.get(file_id)
463
entry = old_entries[file_id]
464
if entry.parent_id is None:
466
return os.path.join(id2path(entry.parent_id), entry.name)
311
468
for file_id in old_entries:
312
469
entry = old_entries[file_id]
313
path = old_entries.id2path(file_id)
470
path = id2path(file_id)
314
471
new_inventory[file_id] = (path, file_id, entry.parent_id, entry.kind)
315
472
by_path[path] = file_id
added
removed
bzrlib/merge.py
