1
# Copyright (C) 2005, 2006 Canonical Ltd
1
# Copyright (C) 2005 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20
from tempfile import mkdtemp
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
23
28
from bzrlib.branch import Branch
24
from bzrlib.conflicts import ConflictList, Conflict
25
from bzrlib.errors import (BzrCommandError,
35
WorkingTreeNotRevision,
38
from bzrlib.merge3 import Merge3
40
from bzrlib.osutils import rename, pathjoin, rmtree
41
from progress import DummyProgress, ProgressPhase
42
from bzrlib.revision import common_ancestor, is_ancestor, NULL_REVISION
43
from bzrlib.textfile import check_text_lines
29
from bzrlib.errors import BzrCommandError, UnrelatedBranches, NoCommonAncestor
30
from bzrlib.errors import NoCommits
31
from bzrlib.delta import compare_trees
44
32
from bzrlib.trace import mutter, warning, note
45
from bzrlib.transform import (TreeTransform, resolve_conflicts, cook_conflicts,
46
FinalPaths, create_by_entry, unique_add)
47
from bzrlib.versionedfile import WeaveMerge
50
# TODO: Report back as changes are merged in
52
def _get_tree(treespec, local_branch=None):
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
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):
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)
101
if e.errno != errno.EEXIST and e.errno != errno.ENOTEMPTY:
103
return self.add_suffix(name, suffix, last_new_name=new_name)
105
def conflict(self, text):
110
def merge_conflict(self, new_file, this_path, base_lines, other_lines):
112
Handle diff3 conflicts by producing a .THIS, .BASE and .OTHER. The
113
main file will be a version with diff3 conflicts.
114
:param new_file: Path to the output file with diff3 markers
115
:param this_path: Path to the file text for the THIS tree
116
:param base_path: Path to the file text for the BASE tree
117
:param other_path: Path to the file text for the OTHER tree
119
self.add_suffix(this_path, ".THIS")
120
self.dump(base_lines, this_path+".BASE")
121
self.dump(other_lines, this_path+".OTHER")
122
rename(new_file, this_path)
123
self.conflict("Diff3 conflict encountered in %s" % this_path)
125
def new_contents_conflict(self, filename, other_contents):
126
"""Conflicting contents for newly added file."""
127
self.copy(other_contents, filename + ".OTHER")
128
self.conflict("Conflict in newly added file %s" % filename)
131
def target_exists(self, entry, target, old_path):
132
"""Handle the case when the target file or dir exists"""
133
moved_path = self.add_suffix(target, ".moved")
134
self.conflict("Moved existing %s to %s" % (target, moved_path))
136
def rmdir_non_empty(self, filename):
137
"""Handle the case where the dir to be removed still has contents"""
138
self.conflict("Directory %s not removed because it is not empty"\
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)
194
if not self.ignore_zero:
195
note("%d conflicts encountered.\n" % self.conflicts)
197
def get_tree(treespec, temp_root, label, local_branch=None):
53
198
location, revno = treespec
54
branch = Branch.open_containing(location)[0]
199
branch = Branch.open_containing(location)
58
203
revision = branch.last_revision()
60
205
revision = branch.get_rev_id(revno)
62
revision = NULL_REVISION
63
return branch, _get_revid_tree(branch, revision, local_branch)
66
def _get_revid_tree(branch, revision, local_branch):
206
return branch, get_revid_tree(branch, revision, temp_root, label,
209
def get_revid_tree(branch, revision, temp_root, label, local_branch):
67
210
if revision is None:
68
base_tree = branch.bzrdir.open_workingtree()
211
base_tree = branch.working_tree()
70
213
if local_branch is not None:
71
if local_branch.base != branch.base:
72
local_branch.fetch(branch, revision)
73
base_tree = local_branch.repository.revision_tree(revision)
214
greedy_fetch(local_branch, branch, revision)
215
base_tree = local_branch.revision_tree(revision)
75
base_tree = branch.repository.revision_tree(revision)
79
def transform_tree(from_tree, to_tree, interesting_ids=None):
80
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
81
interesting_ids=interesting_ids, this_tree=from_tree)
85
def __init__(self, this_branch, other_tree=None, base_tree=None,
86
this_tree=None, pb=DummyProgress()):
217
base_tree = branch.revision_tree(revision)
218
temp_path = os.path.join(temp_root, label)
220
return MergeTree(base_tree, temp_path)
223
def file_exists(tree, file_id):
224
return tree.has_filename(tree.id2path(file_id))
227
class MergeTree(object):
228
def __init__(self, tree, tempdir):
87
229
object.__init__(self)
88
assert this_tree is not None, "this_tree is required"
89
self.this_branch = this_branch
90
self.this_basis = this_branch.last_revision()
91
self.this_rev_id = None
92
self.this_tree = this_tree
93
self.this_revision_tree = None
94
self.this_basis_tree = None
95
self.other_tree = other_tree
96
self.base_tree = base_tree
97
self.ignore_zero = False
98
self.backup_files = False
99
self.interesting_ids = None
100
self.show_base = False
101
self.reprocess = False
106
def revision_tree(self, revision_id):
107
return self.this_branch.repository.revision_tree(revision_id)
109
def ensure_revision_trees(self):
110
if self.this_revision_tree is None:
111
self.this_basis_tree = self.this_branch.repository.revision_tree(
113
if self.this_basis == self.this_rev_id:
114
self.this_revision_tree = self.this_basis_tree
116
if self.other_rev_id is None:
117
other_basis_tree = self.revision_tree(self.other_basis)
118
changes = other_basis_tree.changes_from(self.other_tree)
119
if changes.has_changed():
120
raise WorkingTreeNotRevision(self.this_tree)
121
other_rev_id = self.other_basis
122
self.other_tree = other_basis_tree
124
def file_revisions(self, file_id):
125
self.ensure_revision_trees()
126
def get_id(tree, file_id):
127
revision_id = tree.inventory[file_id].revision
128
assert revision_id is not None
130
if self.this_rev_id is None:
131
if self.this_basis_tree.get_file_sha1(file_id) != \
132
self.this_tree.get_file_sha1(file_id):
133
raise WorkingTreeNotRevision(self.this_tree)
135
trees = (self.this_basis_tree, self.other_tree)
136
return [get_id(tree, file_id) for tree in trees]
138
def check_basis(self, check_clean, require_commits=True):
139
if self.this_basis is None and require_commits is True:
230
if hasattr(tree, "basedir"):
231
self.root = tree.basedir
235
self.tempdir = tempdir
236
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
def readonly_path(self, id):
272
if id not in self.tree:
274
if self.root is not None:
275
return self.tree.abspath(self.tree.id2path(id))
277
kind = self.tree.inventory[id].kind
278
if kind in ("directory", "root_directory"):
280
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)
293
self.cached[id] = path
294
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
def merge(other_revision, base_revision,
312
check_clean=True, ignore_zero=False,
313
this_dir=None, backup_files=False, merge_type=ApplyMerge3,
315
"""Merge changes into a tree.
318
tuple(path, revision) Base for three-way merge.
320
tuple(path, revision) Other revision for three-way merge.
322
Directory to merge changes into; '.' by default.
324
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
tempdir = tempfile.mkdtemp(prefix="bzr-")
337
this_branch = Branch.open_containing(this_dir)
338
this_rev_id = this_branch.last_revision()
339
if this_rev_id is None:
140
340
raise BzrCommandError("This branch has no commits")
143
if self.this_basis != self.this_rev_id:
342
changes = compare_trees(this_branch.working_tree(),
343
this_branch.basis_tree(), False)
344
if changes.has_changed():
144
345
raise BzrCommandError("Working tree has uncommitted changes.")
146
def compare_basis(self):
147
changes = self.this_tree.changes_from(self.this_tree.basis_tree())
148
if not changes.has_changed():
149
self.this_rev_id = self.this_basis
151
def set_interesting_files(self, file_list):
153
self._set_interesting_files(file_list)
154
except NotVersionedError, e:
155
raise BzrCommandError("%s is not a source file in any"
158
def _set_interesting_files(self, file_list):
159
"""Set the list of interesting ids from a list of files."""
160
if file_list is None:
161
self.interesting_ids = None
164
interesting_ids = set()
165
for path in file_list:
167
for tree in (self.this_tree, self.base_tree, self.other_tree):
168
file_id = tree.inventory.path2id(path)
169
if file_id is not None:
170
interesting_ids.add(file_id)
173
raise NotVersionedError(path=path)
174
self.interesting_ids = interesting_ids
176
def set_pending(self):
177
if not self.base_is_ancestor:
179
if self.other_rev_id is None:
181
ancestry = self.this_branch.repository.get_ancestry(self.this_basis)
182
if self.other_rev_id in ancestry:
184
self.this_tree.add_pending_merge(self.other_rev_id)
186
def set_other(self, other_revision):
187
other_branch, self.other_tree = _get_tree(other_revision,
346
other_branch, other_tree = get_tree(other_revision, tempdir, "other",
189
348
if other_revision[1] == -1:
190
self.other_rev_id = other_branch.last_revision()
191
if self.other_rev_id is None:
349
other_rev_id = other_branch.last_revision()
350
if other_rev_id is None:
192
351
raise NoCommits(other_branch)
193
self.other_basis = self.other_rev_id
352
other_basis = other_rev_id
194
353
elif other_revision[1] is not None:
195
self.other_rev_id = other_branch.get_rev_id(other_revision[1])
196
self.other_basis = self.other_rev_id
354
other_rev_id = other_branch.get_rev_id(other_revision[1])
355
other_basis = other_rev_id
198
self.other_rev_id = None
199
self.other_basis = other_branch.last_revision()
200
if self.other_basis is None:
358
other_basis = other_branch.last_revision()
359
if other_basis is None:
201
360
raise NoCommits(other_branch)
202
if other_branch.base != self.this_branch.base:
203
self.this_branch.fetch(other_branch, last_revision=self.other_basis)
206
self.set_base([None, None])
208
def set_base(self, base_revision):
209
mutter("doing merge() with no base_revision specified")
210
361
if base_revision == [None, None]:
212
pb = bzrlib.ui.ui_factory.nested_progress_bar()
214
this_repo = self.this_branch.repository
215
self.base_rev_id = common_ancestor(self.this_basis,
363
base_rev_id = common_ancestor(this_rev_id, other_basis,
220
365
except NoCommonAncestor:
221
366
raise UnrelatedBranches()
222
self.base_tree = _get_revid_tree(self.this_branch, self.base_rev_id,
224
self.base_is_ancestor = True
367
base_tree = get_revid_tree(this_branch, base_rev_id, tempdir,
369
base_is_ancestor = True
226
base_branch, self.base_tree = _get_tree(base_revision)
371
base_branch, base_tree = get_tree(base_revision, tempdir, "base")
227
372
if base_revision[1] == -1:
228
self.base_rev_id = base_branch.last_revision()
373
base_rev_id = base_branch.last_revision()
229
374
elif base_revision[1] is None:
230
self.base_rev_id = None
232
self.base_rev_id = base_branch.get_rev_id(base_revision[1])
233
if self.this_branch.base != base_branch.base:
234
self.this_branch.fetch(base_branch)
235
self.base_is_ancestor = is_ancestor(self.this_basis,
240
kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
241
'other_tree': self.other_tree,
242
'interesting_ids': self.interesting_ids,
244
if self.merge_type.requires_base:
245
kwargs['base_tree'] = self.base_tree
246
if self.merge_type.supports_reprocess:
247
kwargs['reprocess'] = self.reprocess
249
raise BzrError("Conflict reduction is not supported for merge"
250
" type %s." % self.merge_type)
251
if self.merge_type.supports_show_base:
252
kwargs['show_base'] = self.show_base
254
raise BzrError("Showing base is not supported for this"
255
" merge type. %s" % self.merge_type)
256
merge = self.merge_type(pb=self._pb, **kwargs)
257
if len(merge.cooked_conflicts) == 0:
258
if not self.ignore_zero:
259
note("All changes applied successfully.")
261
note("%d conflicts encountered." % len(merge.cooked_conflicts))
263
return len(merge.cooked_conflicts)
265
def regen_inventory(self, new_entries):
266
old_entries = self.this_tree.read_working_inventory()
270
for path, file_id in new_entries:
273
new_entries_map[file_id] = path
275
def id2path(file_id):
276
path = new_entries_map.get(file_id)
279
entry = old_entries[file_id]
280
if entry.parent_id is None:
282
return pathjoin(id2path(entry.parent_id), entry.name)
284
for file_id in old_entries:
285
entry = old_entries[file_id]
286
path = id2path(file_id)
287
if file_id in self.base_tree.inventory:
288
executable = getattr(self.base_tree.inventory[file_id], 'executable', False)
290
executable = getattr(entry, 'executable', False)
291
new_inventory[file_id] = (path, file_id, entry.parent_id,
292
entry.kind, executable)
294
by_path[path] = file_id
299
for path, file_id in new_entries:
301
del new_inventory[file_id]
304
new_path_list.append((path, file_id))
305
if file_id not in old_entries:
307
# Ensure no file is added before its parent
309
for path, file_id in new_path_list:
313
parent = by_path[os.path.dirname(path)]
314
abspath = pathjoin(self.this_tree.basedir, path)
315
kind = bzrlib.osutils.file_kind(abspath)
316
if file_id in self.base_tree.inventory:
317
executable = getattr(self.base_tree.inventory[file_id], 'executable', False)
320
new_inventory[file_id] = (path, file_id, parent, kind, executable)
321
by_path[path] = file_id
323
# Get a list in insertion order
324
new_inventory_list = new_inventory.values()
325
mutter ("""Inventory regeneration:
326
old length: %i insertions: %i deletions: %i new_length: %i"""\
327
% (len(old_entries), insertions, deletions,
328
len(new_inventory_list)))
329
assert len(new_inventory_list) == len(old_entries) + insertions\
331
new_inventory_list.sort()
332
return new_inventory_list
335
class Merge3Merger(object):
336
"""Three-way merger that uses the merge3 text merger"""
338
supports_reprocess = True
339
supports_show_base = True
340
history_based = False
342
def __init__(self, working_tree, this_tree, base_tree, other_tree,
343
interesting_ids=None, reprocess=False, show_base=False,
344
pb=DummyProgress(), pp=None):
345
"""Initialize the merger object and perform the merge."""
346
object.__init__(self)
347
self.this_tree = working_tree
348
self.base_tree = base_tree
349
self.other_tree = other_tree
350
self._raw_conflicts = []
351
self.cooked_conflicts = []
352
self.reprocess = reprocess
353
self.show_base = show_base
357
self.pp = ProgressPhase("Merge phase", 3, self.pb)
359
if interesting_ids is not None:
360
all_ids = interesting_ids
362
all_ids = set(base_tree)
363
all_ids.update(other_tree)
364
working_tree.lock_write()
365
self.tt = TreeTransform(working_tree, self.pb)
368
child_pb = ui.ui_factory.nested_progress_bar()
370
for num, file_id in enumerate(all_ids):
371
child_pb.update('Preparing file merge', num, len(all_ids))
372
self.merge_names(file_id)
373
file_status = self.merge_contents(file_id)
374
self.merge_executable(file_id, file_status)
379
child_pb = ui.ui_factory.nested_progress_bar()
381
fs_conflicts = resolve_conflicts(self.tt, child_pb)
384
self.cook_conflicts(fs_conflicts)
385
for conflict in self.cooked_conflicts:
388
results = self.tt.apply()
389
self.write_modified(results)
391
working_tree.add_conflicts(self.cooked_conflicts)
392
except UnsupportedOperation:
396
working_tree.unlock()
399
def write_modified(self, results):
401
for path in results.modified_paths:
402
file_id = self.this_tree.path2id(self.this_tree.relpath(path))
405
hash = self.this_tree.get_file_sha1(file_id)
408
modified_hashes[file_id] = hash
409
self.this_tree.set_merge_modified(modified_hashes)
412
def parent(entry, file_id):
413
"""Determine the parent for a file_id (used as a key method)"""
416
return entry.parent_id
419
def name(entry, file_id):
420
"""Determine the name for a file_id (used as a key method)"""
426
def contents_sha1(tree, file_id):
427
"""Determine the sha1 of the file contents (used as a key method)."""
428
if file_id not in tree:
430
return tree.get_file_sha1(file_id)
433
def executable(tree, file_id):
434
"""Determine the executability of a file-id (used as a key method)."""
435
if file_id not in tree:
437
if tree.kind(file_id) != "file":
439
return tree.is_executable(file_id)
442
def kind(tree, file_id):
443
"""Determine the kind of a file-id (used as a key method)."""
444
if file_id not in tree:
446
return tree.kind(file_id)
449
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
450
"""Do a three-way test on a scalar.
451
Return "this", "other" or "conflict", depending whether a value wins.
453
key_base = key(base_tree, file_id)
454
key_other = key(other_tree, file_id)
455
#if base == other, either they all agree, or only THIS has changed.
456
if key_base == key_other:
458
key_this = key(this_tree, file_id)
459
if key_this not in (key_base, key_other):
461
# "Ambiguous clean merge"
462
elif key_this == key_other:
465
assert key_this == key_base
468
def merge_names(self, file_id):
469
"""Perform a merge on file_id names and parents"""
471
if file_id in tree.inventory:
472
return tree.inventory[file_id]
475
this_entry = get_entry(self.this_tree)
476
other_entry = get_entry(self.other_tree)
477
base_entry = get_entry(self.base_tree)
478
name_winner = self.scalar_three_way(this_entry, base_entry,
479
other_entry, file_id, self.name)
480
parent_id_winner = self.scalar_three_way(this_entry, base_entry,
481
other_entry, file_id,
483
if this_entry is None:
484
if name_winner == "this":
485
name_winner = "other"
486
if parent_id_winner == "this":
487
parent_id_winner = "other"
488
if name_winner == "this" and parent_id_winner == "this":
490
if name_winner == "conflict":
491
trans_id = self.tt.trans_id_file_id(file_id)
492
self._raw_conflicts.append(('name conflict', trans_id,
493
self.name(this_entry, file_id),
494
self.name(other_entry, file_id)))
495
if parent_id_winner == "conflict":
496
trans_id = self.tt.trans_id_file_id(file_id)
497
self._raw_conflicts.append(('parent conflict', trans_id,
498
self.parent(this_entry, file_id),
499
self.parent(other_entry, file_id)))
500
if other_entry is None:
501
# it doesn't matter whether the result was 'other' or
502
# 'conflict'-- if there's no 'other', we leave it alone.
504
# if we get here, name_winner and parent_winner are set to safe values.
505
winner_entry = {"this": this_entry, "other": other_entry,
506
"conflict": other_entry}
507
trans_id = self.tt.trans_id_file_id(file_id)
508
parent_id = winner_entry[parent_id_winner].parent_id
509
parent_trans_id = self.tt.trans_id_file_id(parent_id)
510
self.tt.adjust_path(winner_entry[name_winner].name, parent_trans_id,
513
def merge_contents(self, file_id):
514
"""Performa a merge on file_id contents."""
515
def contents_pair(tree):
516
if file_id not in tree:
518
kind = tree.kind(file_id)
519
if kind == "root_directory":
522
contents = tree.get_file_sha1(file_id)
523
elif kind == "symlink":
524
contents = tree.get_symlink_target(file_id)
527
return kind, contents
529
def contents_conflict():
530
trans_id = self.tt.trans_id_file_id(file_id)
531
name = self.tt.final_name(trans_id)
532
parent_id = self.tt.final_parent(trans_id)
533
if file_id in self.this_tree.inventory:
534
self.tt.unversion_file(trans_id)
535
self.tt.delete_contents(trans_id)
536
file_group = self._dump_conflicts(name, parent_id, file_id,
538
self._raw_conflicts.append(('contents conflict', file_group))
540
# See SPOT run. run, SPOT, run.
541
# So we're not QUITE repeating ourselves; we do tricky things with
543
base_pair = contents_pair(self.base_tree)
544
other_pair = contents_pair(self.other_tree)
545
if base_pair == other_pair:
546
# OTHER introduced no changes
548
this_pair = contents_pair(self.this_tree)
549
if this_pair == other_pair:
550
# THIS and OTHER introduced the same changes
553
trans_id = self.tt.trans_id_file_id(file_id)
554
if this_pair == base_pair:
555
# only OTHER introduced changes
556
if file_id in self.this_tree:
557
# Remove any existing contents
558
self.tt.delete_contents(trans_id)
559
if file_id in self.other_tree:
560
# OTHER changed the file
561
create_by_entry(self.tt,
562
self.other_tree.inventory[file_id],
563
self.other_tree, trans_id)
564
if file_id not in self.this_tree.inventory:
565
self.tt.version_file(file_id, trans_id)
567
elif file_id in self.this_tree.inventory:
568
# OTHER deleted the file
569
self.tt.unversion_file(trans_id)
571
#BOTH THIS and OTHER introduced changes; scalar conflict
572
elif this_pair[0] == "file" and other_pair[0] == "file":
573
# THIS and OTHER are both files, so text merge. Either
574
# BASE is a file, or both converted to files, so at least we
575
# have agreement that output should be a file.
577
self.text_merge(file_id, trans_id)
579
return contents_conflict()
580
if file_id not in self.this_tree.inventory:
581
self.tt.version_file(file_id, trans_id)
583
self.tt.tree_kind(trans_id)
584
self.tt.delete_contents(trans_id)
589
# Scalar conflict, can't text merge. Dump conflicts
590
return contents_conflict()
592
def get_lines(self, tree, file_id):
593
"""Return the lines in a file, or an empty list."""
595
return tree.get_file(file_id).readlines()
599
def text_merge(self, file_id, trans_id):
600
"""Perform a three-way text merge on a file_id"""
601
# it's possible that we got here with base as a different type.
602
# if so, we just want two-way text conflicts.
603
if file_id in self.base_tree and \
604
self.base_tree.kind(file_id) == "file":
605
base_lines = self.get_lines(self.base_tree, file_id)
608
other_lines = self.get_lines(self.other_tree, file_id)
609
this_lines = self.get_lines(self.this_tree, file_id)
610
m3 = Merge3(base_lines, this_lines, other_lines)
611
start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
612
if self.show_base is True:
613
base_marker = '|' * 7
617
def iter_merge3(retval):
618
retval["text_conflicts"] = False
619
for line in m3.merge_lines(name_a = "TREE",
620
name_b = "MERGE-SOURCE",
621
name_base = "BASE-REVISION",
622
start_marker=start_marker,
623
base_marker=base_marker,
624
reprocess=self.reprocess):
625
if line.startswith(start_marker):
626
retval["text_conflicts"] = True
627
yield line.replace(start_marker, '<' * 7)
631
merge3_iterator = iter_merge3(retval)
632
self.tt.create_file(merge3_iterator, trans_id)
633
if retval["text_conflicts"] is True:
634
self._raw_conflicts.append(('text conflict', trans_id))
635
name = self.tt.final_name(trans_id)
636
parent_id = self.tt.final_parent(trans_id)
637
file_group = self._dump_conflicts(name, parent_id, file_id,
638
this_lines, base_lines,
640
file_group.append(trans_id)
642
def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
643
base_lines=None, other_lines=None, set_version=False,
645
"""Emit conflict files.
646
If this_lines, base_lines, or other_lines are omitted, they will be
647
determined automatically. If set_version is true, the .OTHER, .THIS
648
or .BASE (in that order) will be created as versioned files.
650
data = [('OTHER', self.other_tree, other_lines),
651
('THIS', self.this_tree, this_lines)]
653
data.append(('BASE', self.base_tree, base_lines))
656
for suffix, tree, lines in data:
658
trans_id = self._conflict_file(name, parent_id, tree, file_id,
660
file_group.append(trans_id)
661
if set_version and not versioned:
662
self.tt.version_file(file_id, trans_id)
666
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
668
"""Emit a single conflict file."""
669
name = name + '.' + suffix
670
trans_id = self.tt.create_path(name, parent_id)
671
entry = tree.inventory[file_id]
672
create_by_entry(self.tt, entry, tree, trans_id, lines)
675
def merge_executable(self, file_id, file_status):
676
"""Perform a merge on the execute bit."""
677
if file_status == "deleted":
679
trans_id = self.tt.trans_id_file_id(file_id)
681
if self.tt.final_kind(trans_id) != "file":
685
winner = self.scalar_three_way(self.this_tree, self.base_tree,
686
self.other_tree, file_id,
688
if winner == "conflict":
689
# There must be a None in here, if we have a conflict, but we
690
# need executability since file status was not deleted.
691
if self.executable(self.other_tree, file_id) is None:
696
if file_status == "modified":
697
executability = self.this_tree.is_executable(file_id)
698
if executability is not None:
699
trans_id = self.tt.trans_id_file_id(file_id)
700
self.tt.set_executability(executability, trans_id)
702
assert winner == "other"
703
if file_id in self.other_tree:
704
executability = self.other_tree.is_executable(file_id)
705
elif file_id in self.this_tree:
706
executability = self.this_tree.is_executable(file_id)
707
elif file_id in self.base_tree:
708
executability = self.base_tree.is_executable(file_id)
709
if executability is not None:
710
trans_id = self.tt.trans_id_file_id(file_id)
711
self.tt.set_executability(executability, trans_id)
713
def cook_conflicts(self, fs_conflicts):
714
"""Convert all conflicts into a form that doesn't depend on trans_id"""
715
from conflicts import Conflict
717
self.cooked_conflicts.extend(cook_conflicts(fs_conflicts, self.tt))
718
fp = FinalPaths(self.tt)
719
for conflict in self._raw_conflicts:
720
conflict_type = conflict[0]
721
if conflict_type in ('name conflict', 'parent conflict'):
722
trans_id = conflict[1]
723
conflict_args = conflict[2:]
724
if trans_id not in name_conflicts:
725
name_conflicts[trans_id] = {}
726
unique_add(name_conflicts[trans_id], conflict_type,
728
if conflict_type == 'contents conflict':
729
for trans_id in conflict[1]:
730
file_id = self.tt.final_file_id(trans_id)
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)
731
391
if file_id is not None:
733
path = fp.get_path(trans_id)
734
for suffix in ('.BASE', '.THIS', '.OTHER'):
735
if path.endswith(suffix):
736
path = path[:-len(suffix)]
738
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
739
self.cooked_conflicts.append(c)
740
if conflict_type == 'text conflict':
741
trans_id = conflict[1]
742
path = fp.get_path(trans_id)
743
file_id = self.tt.final_file_id(trans_id)
744
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
745
self.cooked_conflicts.append(c)
747
for trans_id, conflicts in name_conflicts.iteritems():
749
this_parent, other_parent = conflicts['parent conflict']
750
assert this_parent != other_parent
752
this_parent = other_parent = \
753
self.tt.final_file_id(self.tt.final_parent(trans_id))
755
this_name, other_name = conflicts['name conflict']
756
assert this_name != other_name
758
this_name = other_name = self.tt.final_name(trans_id)
759
other_path = fp.get_path(trans_id)
760
if this_parent is not None:
762
fp.get_path(self.tt.trans_id_file_id(this_parent))
763
this_path = pathjoin(this_parent_path, this_name)
392
interesting_ids.add(file_id)
395
raise BzrCommandError("%s is not a source file in any"
397
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)
404
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
415
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
this_tree = get_tree((this_branch.base, None), tempdir, "this")[1]
427
def get_inventory(tree):
428
return tree.tree.inventory
430
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)
438
for id, path in inv_changes.iteritems():
765
this_path = "<deleted>"
766
file_id = self.tt.final_file_id(trans_id)
767
c = Conflict.factory('path conflict', path=this_path,
768
conflict_path=other_path, file_id=file_id)
769
self.cooked_conflicts.append(c)
770
self.cooked_conflicts.sort(key=Conflict.sort_key)
773
class WeaveMerger(Merge3Merger):
774
"""Three-way tree merger, text weave merger."""
775
supports_reprocess = True
776
supports_show_base = False
778
def __init__(self, working_tree, this_tree, base_tree, other_tree,
779
interesting_ids=None, pb=DummyProgress(), pp=None,
781
self.this_revision_tree = self._get_revision_tree(this_tree)
782
self.other_revision_tree = self._get_revision_tree(other_tree)
783
super(WeaveMerger, self).__init__(working_tree, this_tree,
784
base_tree, other_tree,
785
interesting_ids=interesting_ids,
786
pb=pb, pp=pp, reprocess=reprocess)
788
def _get_revision_tree(self, tree):
789
"""Return a revision tree related to this tree.
790
If the tree is a WorkingTree, the basis will be returned.
792
if getattr(tree, 'get_weave', False) is False:
793
# If we have a WorkingTree, try using the basis
794
return tree.branch.basis_tree()
798
def _check_file(self, file_id):
799
"""Check that the revision tree's version of the file matches."""
800
for tree, rt in ((self.this_tree, self.this_revision_tree),
801
(self.other_tree, self.other_revision_tree)):
804
if tree.get_file_sha1(file_id) != rt.get_file_sha1(file_id):
805
raise WorkingTreeNotRevision(self.this_tree)
807
def _merged_lines(self, file_id):
808
"""Generate the merged lines.
809
There is no distinction between lines that are meant to contain <<<<<<<
812
weave = self.this_revision_tree.get_weave(file_id)
813
this_revision_id = self.this_revision_tree.inventory[file_id].revision
814
other_revision_id = \
815
self.other_revision_tree.inventory[file_id].revision
816
wm = WeaveMerge(weave, this_revision_id, other_revision_id,
817
'<<<<<<< TREE\n', '>>>>>>> MERGE-SOURCE\n')
818
return wm.merge_lines(self.reprocess)
820
def text_merge(self, file_id, trans_id):
821
"""Perform a (weave) text merge for a given file and file-id.
822
If conflicts are encountered, .THIS and .OTHER files will be emitted,
823
and a conflict will be noted.
825
self._check_file(file_id)
826
lines, conflicts = self._merged_lines(file_id)
828
# Note we're checking whether the OUTPUT is binary in this case,
829
# because we don't want to get into weave merge guts.
830
check_text_lines(lines)
831
self.tt.create_file(lines, trans_id)
833
self._raw_conflicts.append(('text conflict', trans_id))
834
name = self.tt.final_name(trans_id)
835
parent_id = self.tt.final_parent(trans_id)
836
file_group = self._dump_conflicts(name, parent_id, file_id,
838
file_group.append(trans_id)
841
class Diff3Merger(Merge3Merger):
842
"""Three-way merger using external diff3 for text merging"""
844
def dump_file(self, temp_dir, name, tree, file_id):
845
out_path = pathjoin(temp_dir, name)
846
out_file = open(out_path, "wb")
848
in_file = tree.get_file(file_id)
855
def text_merge(self, file_id, trans_id):
856
"""Perform a diff3 merge using a specified file-id and trans-id.
857
If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
858
will be dumped, and a will be conflict noted.
861
temp_dir = mkdtemp(prefix="bzr-")
863
new_file = pathjoin(temp_dir, "new")
864
this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
865
base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
866
other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
867
status = bzrlib.patch.diff3(new_file, this, base, other)
868
if status not in (0, 1):
869
raise BzrError("Unhandled diff3 exit code")
870
f = open(new_file, 'rb')
872
self.tt.create_file(f, trans_id)
876
name = self.tt.final_name(trans_id)
877
parent_id = self.tt.final_parent(trans_id)
878
self._dump_conflicts(name, parent_id, file_id)
879
self._raw_conflicts.append(('text conflict', trans_id))
884
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
886
merge_type=Merge3Merger,
887
interesting_ids=None,
891
interesting_files=None,
894
"""Primary interface for merging.
896
typical use is probably
897
'merge_inner(branch, branch.get_revision_tree(other_revision),
898
branch.get_revision_tree(base_revision))'
900
if this_tree is None:
901
warnings.warn("bzrlib.merge.merge_inner requires a this_tree parameter as of "
902
"bzrlib version 0.8.",
905
this_tree = this_branch.bzrdir.open_workingtree()
906
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
908
merger.backup_files = backup_files
909
merger.merge_type = merge_type
910
merger.interesting_ids = interesting_ids
911
merger.ignore_zero = ignore_zero
912
if interesting_files:
913
assert not interesting_ids, ('Only supply interesting_ids'
914
' or interesting_files')
915
merger._set_interesting_files(interesting_files)
916
merger.show_base = show_base
917
merger.reprocess = reprocess
918
merger.other_rev_id = other_rev_id
919
merger.other_basis = other_rev_id
920
return merger.do_merge()
923
merge_types = { "merge3": (Merge3Merger, "Native diff3-style merge"),
924
"diff3": (Diff3Merger, "Merge using external diff3"),
925
'weave': (WeaveMerger, "Weave-based merge")
443
assert path.startswith('.' + os.sep), "path is %s" % path
445
adjust_ids.append((path, id))
446
if len(adjust_ids) > 0:
447
this_branch.set_inventory(regen_inventory(this_branch, this_tree.root,
451
def regen_inventory(this_branch, root, new_entries):
452
old_entries = this_branch.read_working_inventory()
456
for path, file_id in new_entries:
459
new_entries_map[file_id] = path
461
def id2path(file_id):
462
path = new_entries_map.get(file_id)
465
entry = old_entries[file_id]
466
if entry.parent_id is None:
468
return os.path.join(id2path(entry.parent_id), entry.name)
470
for file_id in old_entries:
471
entry = old_entries[file_id]
472
path = id2path(file_id)
473
new_inventory[file_id] = (path, file_id, entry.parent_id, entry.kind)
474
by_path[path] = file_id
479
for path, file_id in new_entries:
481
del new_inventory[file_id]
484
new_path_list.append((path, file_id))
485
if file_id not in old_entries:
487
# Ensure no file is added before its parent
489
for path, file_id in new_path_list:
493
parent = by_path[os.path.dirname(path)]
494
kind = bzrlib.osutils.file_kind(os.path.join(root, path))
495
new_inventory[file_id] = (path, file_id, parent, kind)
496
by_path[path] = file_id
498
# Get a list in insertion order
499
new_inventory_list = new_inventory.values()
500
mutter ("""Inventory regeneration:
501
old length: %i insertions: %i deletions: %i new_length: %i"""\
502
% (len(old_entries), insertions, deletions, len(new_inventory_list)))
503
assert len(new_inventory_list) == len(old_entries) + insertions - deletions
504
new_inventory_list.sort()
505
return new_inventory_list
507
merge_types = { "merge3": (ApplyMerge3, "Native diff3-style merge"),
508
"diff3": (Diff3Merge, "Merge using external diff3")
929
def merge_type_help():
930
templ = '%s%%7s: %%s' % (' '*12)
931
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
932
return '\n'.join(lines)
added
removed
bzrlib/merge.py
