1
# Copyright (C) 2005 Canonical Ltd
1
# Copyright (C) 2005, 2006 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
22
from fetch import greedy_fetch
25
import bzrlib.revision
26
from bzrlib.merge_core import merge_flex, ApplyMerge3, BackupBeforeChange
27
from bzrlib.changeset import generate_changeset, ExceptionConflictHandler
28
from bzrlib.changeset import Inventory, Diff3Merge
29
from bzrlib.branch import find_branch
30
from bzrlib.errors import BzrCommandError, UnrelatedBranches, NoCommonAncestor
31
from bzrlib.errors import NoCommits
32
from bzrlib.delta import compare_trees
33
from bzrlib.trace import mutter, warning
34
from bzrlib.fetch import greedy_fetch
35
from bzrlib.revision import is_ancestor
37
# comments from abentley on irc: merge happens in two stages, each
38
# of which generates a changeset object
40
# stage 1: generate OLD->OTHER,
41
# stage 2: use MINE and OLD->OTHER to generate MINE -> RESULT
43
class MergeConflictHandler(ExceptionConflictHandler):
44
"""Handle conflicts encountered while merging.
46
This subclasses ExceptionConflictHandler, so that any types of
47
conflict that are not explicitly handled cause an exception and
50
def __init__(self, dir, ignore_zero=False):
51
ExceptionConflictHandler.__init__(self, dir)
53
self.ignore_zero = ignore_zero
55
def copy(self, source, dest):
56
"""Copy the text and mode of a file
57
:param source: The path of the file to copy
58
:param dest: The distination file to create
60
s_file = file(source, "rb")
61
d_file = file(dest, "wb")
64
os.chmod(dest, 0777 & os.stat(source).st_mode)
66
def dump(self, lines, 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
d_file = file(dest, "wb")
75
def add_suffix(self, name, suffix, last_new_name=None):
76
"""Rename a file to append a suffix. If the new name exists, the
77
suffix is added repeatedly until a non-existant name is found
79
:param name: The path of the file
80
:param suffix: The suffix to append
81
:param last_new_name: (used for recursive calls) the last name tried
83
if last_new_name is None:
85
new_name = last_new_name+suffix
87
os.rename(name, new_name)
90
if e.errno != errno.EEXIST and e.errno != errno.ENOTEMPTY:
92
return self.add_suffix(name, suffix, last_new_name=new_name)
94
def conflict(self, text):
99
def merge_conflict(self, new_file, this_path, base_lines, other_lines):
101
Handle diff3 conflicts by producing a .THIS, .BASE and .OTHER. The
102
main file will be a version with diff3 conflicts.
103
:param new_file: Path to the output file with diff3 markers
104
:param this_path: Path to the file text for the THIS tree
105
:param base_path: Path to the file text for the BASE tree
106
:param other_path: Path to the file text for the OTHER tree
108
self.add_suffix(this_path, ".THIS")
109
self.dump(base_lines, this_path+".BASE")
110
self.dump(other_lines, this_path+".OTHER")
111
os.rename(new_file, this_path)
112
self.conflict("Diff3 conflict encountered in %s" % this_path)
114
def new_contents_conflict(self, filename, other_contents):
115
"""Conflicting contents for newly added file."""
116
self.copy(other_contents, filename + ".OTHER")
117
self.conflict("Conflict in newly added file %s" % filename)
120
def target_exists(self, entry, target, old_path):
121
"""Handle the case when the target file or dir exists"""
122
moved_path = self.add_suffix(target, ".moved")
123
self.conflict("Moved existing %s to %s" % (target, moved_path))
125
def rmdir_non_empty(self, filename):
126
"""Handle the case where the dir to be removed still has contents"""
127
self.conflict("Directory %s not removed because it is not empty"\
132
if not self.ignore_zero:
133
print "%d conflicts encountered.\n" % self.conflicts
135
def get_tree(treespec, temp_root, label, local_branch=None):
26
from bzrlib.branch import Branch
27
from bzrlib.conflicts import ConflictList, Conflict
28
from bzrlib.errors import (BzrCommandError,
38
WorkingTreeNotRevision,
41
from bzrlib.merge3 import Merge3
42
from bzrlib.osutils import rename, pathjoin
43
from progress import DummyProgress, ProgressPhase
44
from bzrlib.revision import common_ancestor, is_ancestor, NULL_REVISION
45
from bzrlib.textfile import check_text_lines
46
from bzrlib.trace import mutter, warning, note
47
from bzrlib.transform import (TreeTransform, resolve_conflicts, cook_conflicts,
48
FinalPaths, create_by_entry, unique_add,
50
from bzrlib.versionedfile import WeaveMerge
53
# TODO: Report back as changes are merged in
55
def _get_tree(treespec, local_branch=None):
56
from bzrlib import workingtree
136
57
location, revno = treespec
137
branch = find_branch(location)
141
revision = branch.last_patch()
59
tree = workingtree.WorkingTree.open_containing(location)[0]
60
return tree.branch, tree
61
branch = Branch.open_containing(location)[0]
63
revision_id = branch.last_revision()
143
revision = branch.lookup_revision(revno)
144
return branch, get_revid_tree(branch, revision, temp_root, label,
147
def get_revid_tree(branch, revision, temp_root, label, local_branch):
149
base_tree = branch.working_tree()
65
revision_id = branch.get_rev_id(revno)
66
if revision_id is None:
67
revision_id = NULL_REVISION
68
return branch, _get_revid_tree(branch, revision_id, local_branch)
71
def _get_revid_tree(branch, revision_id, local_branch):
72
if revision_id is None:
73
base_tree = branch.bzrdir.open_workingtree()
151
75
if local_branch is not None:
152
greedy_fetch(local_branch, branch, revision)
153
base_tree = local_branch.revision_tree(revision)
76
if local_branch.base != branch.base:
77
local_branch.fetch(branch, revision_id)
78
base_tree = local_branch.repository.revision_tree(revision_id)
155
base_tree = branch.revision_tree(revision)
156
temp_path = os.path.join(temp_root, label)
158
return MergeTree(base_tree, temp_path)
161
def file_exists(tree, file_id):
162
return tree.has_filename(tree.id2path(file_id))
165
class MergeTree(object):
166
def __init__(self, tree, tempdir):
80
base_tree = branch.repository.revision_tree(revision_id)
84
def _get_revid_tree_from_tree(tree, revision_id, local_branch):
85
if revision_id is None:
87
if local_branch is not None:
88
if local_branch.base != tree.branch.base:
89
local_branch.fetch(tree.branch, revision_id)
90
return local_branch.repository.revision_tree(revision_id)
91
return tree.branch.repository.revision_tree(revision_id)
94
def transform_tree(from_tree, to_tree, interesting_ids=None):
95
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
96
interesting_ids=interesting_ids, this_tree=from_tree)
100
def __init__(self, this_branch, other_tree=None, base_tree=None,
101
this_tree=None, pb=DummyProgress(), change_reporter=None,
167
103
object.__init__(self)
168
if hasattr(tree, "basedir"):
169
self.root = tree.basedir
173
self.tempdir = tempdir
174
os.mkdir(os.path.join(self.tempdir, "texts"))
178
return self.tree.__iter__()
180
def __contains__(self, file_id):
181
return file_id in self.tree
183
def get_file(self, file_id):
184
return self.tree.get_file(file_id)
186
def get_file_sha1(self, id):
187
return self.tree.get_file_sha1(id)
189
def id2path(self, file_id):
190
return self.tree.id2path(file_id)
192
def has_id(self, file_id):
193
return self.tree.has_id(file_id)
195
def has_or_had_id(self, file_id):
196
if file_id == self.tree.inventory.root.file_id:
198
return self.tree.inventory.has_id(file_id)
200
def has_or_had_id(self, file_id):
201
if file_id == self.tree.inventory.root.file_id:
203
return self.tree.inventory.has_id(file_id)
205
def readonly_path(self, id):
206
if id not in self.tree:
208
if self.root is not None:
209
return self.tree.abspath(self.tree.id2path(id))
211
if self.tree.inventory[id].kind in ("directory", "root_directory"):
213
if not self.cached.has_key(id):
214
path = os.path.join(self.tempdir, "texts", id)
215
outfile = file(path, "wb")
216
outfile.write(self.tree.get_file(id).read())
217
assert(os.path.exists(path))
218
self.cached[id] = path
219
return self.cached[id]
223
def merge(other_revision, base_revision,
224
check_clean=True, ignore_zero=False,
225
this_dir=None, backup_files=False, merge_type=ApplyMerge3,
227
"""Merge changes into a tree.
230
tuple(path, revision) Base for three-way merge.
232
tuple(path, revision) Other revision for three-way merge.
234
Directory to merge changes into; '.' by default.
236
If true, this_dir must have no uncommitted changes before the
238
all available ancestors of other_revision and base_revision are
239
automatically pulled into the branch.
241
from bzrlib.revision import common_ancestor, MultipleRevisionSources
242
from bzrlib.errors import NoSuchRevision
243
tempdir = tempfile.mkdtemp(prefix="bzr-")
247
this_branch = find_branch(this_dir)
248
this_rev_id = this_branch.last_patch()
249
if this_rev_id is None:
250
raise BzrCommandError("This branch has no commits")
104
assert this_tree is not None, "this_tree is required"
105
self.this_branch = this_branch
106
self.this_basis = this_branch.last_revision()
107
self.this_rev_id = None
108
self.this_tree = this_tree
109
self.this_revision_tree = None
110
self.this_basis_tree = None
111
self.other_tree = other_tree
112
self.other_branch = None
113
self.base_tree = base_tree
114
self.ignore_zero = False
115
self.backup_files = False
116
self.interesting_ids = None
117
self.show_base = False
118
self.reprocess = False
121
self.recurse = recurse
122
self.change_reporter = change_reporter
124
def revision_tree(self, revision_id):
125
return self.this_branch.repository.revision_tree(revision_id)
127
def ensure_revision_trees(self):
128
if self.this_revision_tree is None:
129
self.this_basis_tree = self.this_branch.repository.revision_tree(
131
if self.this_basis == self.this_rev_id:
132
self.this_revision_tree = self.this_basis_tree
134
if self.other_rev_id is None:
135
other_basis_tree = self.revision_tree(self.other_basis)
136
changes = other_basis_tree.changes_from(self.other_tree)
137
if changes.has_changed():
138
raise WorkingTreeNotRevision(self.this_tree)
139
other_rev_id = self.other_basis
140
self.other_tree = other_basis_tree
142
def file_revisions(self, file_id):
143
self.ensure_revision_trees()
144
def get_id(tree, file_id):
145
revision_id = tree.inventory[file_id].revision
146
assert revision_id is not None
148
if self.this_rev_id is None:
149
if self.this_basis_tree.get_file_sha1(file_id) != \
150
self.this_tree.get_file_sha1(file_id):
151
raise WorkingTreeNotRevision(self.this_tree)
153
trees = (self.this_basis_tree, self.other_tree)
154
return [get_id(tree, file_id) for tree in trees]
156
def check_basis(self, check_clean, require_commits=True):
157
if self.this_basis is None and require_commits is True:
158
raise BzrCommandError("This branch has no commits."
159
" (perhaps you would prefer 'bzr pull')")
252
changes = compare_trees(this_branch.working_tree(),
253
this_branch.basis_tree(), False)
254
if changes.has_changed():
162
if self.this_basis != self.this_rev_id:
255
163
raise BzrCommandError("Working tree has uncommitted changes.")
256
other_branch, other_tree = get_tree(other_revision, tempdir, "other",
165
def compare_basis(self):
166
changes = self.this_tree.changes_from(self.this_tree.basis_tree())
167
if not changes.has_changed():
168
self.this_rev_id = self.this_basis
170
def set_interesting_files(self, file_list):
172
self._set_interesting_files(file_list)
173
except NotVersionedError, e:
174
raise BzrCommandError("%s is not a source file in any"
177
def _set_interesting_files(self, file_list):
178
"""Set the list of interesting ids from a list of files."""
179
if file_list is None:
180
self.interesting_ids = None
183
interesting_ids = set()
184
for path in file_list:
186
# TODO: jam 20070226 The trees are not locked at this time,
187
# wouldn't it make merge faster if it locks everything in the
188
# beginning? It locks at do_merge time, but this happens
190
for tree in (self.this_tree, self.base_tree, self.other_tree):
191
file_id = tree.path2id(path)
192
if file_id is not None:
193
interesting_ids.add(file_id)
196
raise NotVersionedError(path=path)
197
self.interesting_ids = interesting_ids
199
def set_pending(self):
200
if not self.base_is_ancestor:
202
if self.other_rev_id is None:
204
ancestry = self.this_branch.repository.get_ancestry(self.this_basis)
205
if self.other_rev_id in ancestry:
207
self.this_tree.add_parent_tree((self.other_rev_id, self.other_tree))
209
def set_other(self, other_revision):
210
"""Set the revision and tree to merge from.
212
This sets the other_tree, other_rev_id, other_basis attributes.
214
:param other_revision: The [path, revision] list to merge from.
216
self.other_branch, self.other_tree = _get_tree(other_revision,
258
218
if other_revision[1] == -1:
259
other_rev_id = other_branch.last_patch()
260
if other_rev_id is None:
261
raise NoCommits(other_branch)
262
other_basis = other_rev_id
219
self.other_rev_id = self.other_branch.last_revision()
220
if self.other_rev_id is None:
221
raise NoCommits(self.other_branch)
222
self.other_basis = self.other_rev_id
263
223
elif other_revision[1] is not None:
264
other_rev_id = other_branch.lookup_revision(other_revision[1])
265
other_basis = other_rev_id
224
self.other_rev_id = self.other_branch.get_rev_id(other_revision[1])
225
self.other_basis = self.other_rev_id
268
other_basis = other_branch.last_patch()
269
if other_basis is None:
270
raise NoCommits(other_branch)
227
self.other_rev_id = None
228
self.other_basis = self.other_branch.last_revision()
229
if self.other_basis is None:
230
raise NoCommits(self.other_branch)
231
if self.other_branch.base != self.this_branch.base:
232
self.this_branch.fetch(self.other_branch,
233
last_revision=self.other_basis)
235
def set_other_revision(self, revision_id, other_branch):
236
"""Set 'other' based on a branch and revision id
238
:param revision_id: The revision to use for a tree
239
:param other_branch: The branch containing this tree
241
self.other_rev_id = revision_id
242
self.other_branch = other_branch
243
self.this_branch.fetch(other_branch, self.other_rev_id)
244
self.other_tree = self.revision_tree(revision_id)
245
self.other_basis = revision_id
248
self.set_base([None, None])
250
def set_base(self, base_revision):
251
"""Set the base revision to use for the merge.
253
:param base_revision: A 2-list containing a path and revision number.
255
mutter("doing merge() with no base_revision specified")
271
256
if base_revision == [None, None]:
273
base_rev_id = common_ancestor(this_rev_id, other_basis,
258
pb = ui.ui_factory.nested_progress_bar()
260
this_repo = self.this_branch.repository
261
self.base_rev_id = common_ancestor(self.this_basis,
275
266
except NoCommonAncestor:
276
267
raise UnrelatedBranches()
277
base_tree = get_revid_tree(this_branch, base_rev_id, tempdir,
279
base_is_ancestor = True
268
self.base_tree = _get_revid_tree_from_tree(self.this_tree,
271
self.base_is_ancestor = True
281
base_branch, base_tree = get_tree(base_revision, tempdir, "base")
273
base_branch, self.base_tree = _get_tree(base_revision)
282
274
if base_revision[1] == -1:
283
base_rev_id = base_branch.last_patch()
275
self.base_rev_id = base_branch.last_revision()
284
276
elif base_revision[1] is None:
287
base_rev_id = base_branch.lookup_revision(base_revision[1])
288
if base_rev_id is not None:
289
base_is_ancestor = is_ancestor(this_rev_id, base_rev_id,
290
MultipleRevisionSources(this_branch,
293
base_is_ancestor = False
294
if file_list is None:
295
interesting_ids = None
297
interesting_ids = set()
298
this_tree = this_branch.working_tree()
299
for fname in file_list:
300
path = this_branch.relpath(fname)
302
for tree in (this_tree, base_tree.tree, other_tree.tree):
303
file_id = tree.inventory.path2id(path)
277
self.base_rev_id = None
279
self.base_rev_id = base_branch.get_rev_id(base_revision[1])
280
if self.this_branch.base != base_branch.base:
281
self.this_branch.fetch(base_branch)
282
self.base_is_ancestor = is_ancestor(self.this_basis,
287
kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
288
'other_tree': self.other_tree,
289
'interesting_ids': self.interesting_ids,
291
if self.merge_type.requires_base:
292
kwargs['base_tree'] = self.base_tree
293
if self.merge_type.supports_reprocess:
294
kwargs['reprocess'] = self.reprocess
296
raise BzrError("Conflict reduction is not supported for merge"
297
" type %s." % self.merge_type)
298
if self.merge_type.supports_show_base:
299
kwargs['show_base'] = self.show_base
301
raise BzrError("Showing base is not supported for this"
302
" merge type. %s" % self.merge_type)
303
self.this_tree.lock_tree_write()
304
if self.base_tree is not None:
305
self.base_tree.lock_read()
306
if self.other_tree is not None:
307
self.other_tree.lock_read()
309
merge = self.merge_type(pb=self._pb,
310
change_reporter=self.change_reporter,
312
if self.recurse == 'down':
313
for path, file_id in self.this_tree.iter_references():
314
sub_tree = self.this_tree.get_nested_tree(file_id, path)
315
other_revision = self.other_tree.get_reference_revision(
317
if other_revision == sub_tree.last_revision():
319
sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
320
sub_merge.merge_type = self.merge_type
321
relpath = self.this_tree.relpath(path)
322
other_branch = self.other_branch.reference_parent(file_id, relpath)
323
sub_merge.set_other_revision(other_revision, other_branch)
324
base_revision = self.base_tree.get_reference_revision(file_id)
325
sub_merge.base_tree = \
326
sub_tree.branch.repository.revision_tree(base_revision)
330
if self.other_tree is not None:
331
self.other_tree.unlock()
332
if self.base_tree is not None:
333
self.base_tree.unlock()
334
self.this_tree.unlock()
335
if len(merge.cooked_conflicts) == 0:
336
if not self.ignore_zero:
337
note("All changes applied successfully.")
339
note("%d conflicts encountered." % len(merge.cooked_conflicts))
341
return len(merge.cooked_conflicts)
343
def regen_inventory(self, new_entries):
344
old_entries = self.this_tree.read_working_inventory()
348
for path, file_id in new_entries:
351
new_entries_map[file_id] = path
353
def id2path(file_id):
354
path = new_entries_map.get(file_id)
357
entry = old_entries[file_id]
358
if entry.parent_id is None:
360
return pathjoin(id2path(entry.parent_id), entry.name)
362
for file_id in old_entries:
363
entry = old_entries[file_id]
364
path = id2path(file_id)
365
if file_id in self.base_tree.inventory:
366
executable = getattr(self.base_tree.inventory[file_id], 'executable', False)
368
executable = getattr(entry, 'executable', False)
369
new_inventory[file_id] = (path, file_id, entry.parent_id,
370
entry.kind, executable)
372
by_path[path] = file_id
377
for path, file_id in new_entries:
379
del new_inventory[file_id]
382
new_path_list.append((path, file_id))
383
if file_id not in old_entries:
385
# Ensure no file is added before its parent
387
for path, file_id in new_path_list:
391
parent = by_path[os.path.dirname(path)]
392
abspath = pathjoin(self.this_tree.basedir, path)
393
kind = osutils.file_kind(abspath)
394
if file_id in self.base_tree.inventory:
395
executable = getattr(self.base_tree.inventory[file_id], 'executable', False)
398
new_inventory[file_id] = (path, file_id, parent, kind, executable)
399
by_path[path] = file_id
401
# Get a list in insertion order
402
new_inventory_list = new_inventory.values()
403
mutter ("""Inventory regeneration:
404
old length: %i insertions: %i deletions: %i new_length: %i"""\
405
% (len(old_entries), insertions, deletions,
406
len(new_inventory_list)))
407
assert len(new_inventory_list) == len(old_entries) + insertions\
409
new_inventory_list.sort()
410
return new_inventory_list
413
class Merge3Merger(object):
414
"""Three-way merger that uses the merge3 text merger"""
416
supports_reprocess = True
417
supports_show_base = True
418
history_based = False
420
def __init__(self, working_tree, this_tree, base_tree, other_tree,
421
interesting_ids=None, reprocess=False, show_base=False,
422
pb=DummyProgress(), pp=None, change_reporter=None):
423
"""Initialize the merger object and perform the merge."""
424
object.__init__(self)
425
self.this_tree = working_tree
426
self.this_tree.lock_tree_write()
427
self.base_tree = base_tree
428
self.base_tree.lock_read()
429
self.other_tree = other_tree
430
self.other_tree.lock_read()
431
self._raw_conflicts = []
432
self.cooked_conflicts = []
433
self.reprocess = reprocess
434
self.show_base = show_base
437
self.change_reporter = change_reporter
439
self.pp = ProgressPhase("Merge phase", 3, self.pb)
441
if interesting_ids is not None:
442
all_ids = interesting_ids
444
all_ids = set(base_tree)
445
all_ids.update(other_tree)
446
self.tt = TreeTransform(working_tree, self.pb)
449
child_pb = ui.ui_factory.nested_progress_bar()
451
for num, file_id in enumerate(all_ids):
452
child_pb.update('Preparing file merge', num, len(all_ids))
453
self.merge_names(file_id)
454
file_status = self.merge_contents(file_id)
455
self.merge_executable(file_id, file_status)
460
child_pb = ui.ui_factory.nested_progress_bar()
462
fs_conflicts = resolve_conflicts(self.tt, child_pb)
465
if change_reporter is not None:
466
from bzrlib import delta
467
delta.report_changes(self.tt._iter_changes(), change_reporter)
468
self.cook_conflicts(fs_conflicts)
469
for conflict in self.cooked_conflicts:
472
results = self.tt.apply()
473
self.write_modified(results)
475
working_tree.add_conflicts(self.cooked_conflicts)
476
except UnsupportedOperation:
480
self.other_tree.unlock()
481
self.base_tree.unlock()
482
self.this_tree.unlock()
487
self.tt.final_kind(self.tt.root)
489
self.tt.cancel_deletion(self.tt.root)
490
if self.tt.final_file_id(self.tt.root) is None:
491
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
493
if self.other_tree.inventory.root is None:
495
other_root_file_id = self.other_tree.inventory.root.file_id
496
other_root = self.tt.trans_id_file_id(other_root_file_id)
497
if other_root == self.tt.root:
500
self.tt.final_kind(other_root)
503
self.reparent_children(self.other_tree.inventory.root, self.tt.root)
504
self.tt.cancel_creation(other_root)
505
self.tt.cancel_versioning(other_root)
507
def reparent_children(self, ie, target):
508
for thing, child in ie.children.iteritems():
509
trans_id = self.tt.trans_id_file_id(child.file_id)
510
self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
512
def write_modified(self, results):
514
for path in results.modified_paths:
515
file_id = self.this_tree.path2id(self.this_tree.relpath(path))
518
hash = self.this_tree.get_file_sha1(file_id)
521
modified_hashes[file_id] = hash
522
self.this_tree.set_merge_modified(modified_hashes)
525
def parent(entry, file_id):
526
"""Determine the parent for a file_id (used as a key method)"""
529
return entry.parent_id
532
def name(entry, file_id):
533
"""Determine the name for a file_id (used as a key method)"""
539
def contents_sha1(tree, file_id):
540
"""Determine the sha1 of the file contents (used as a key method)."""
541
if file_id not in tree:
543
return tree.get_file_sha1(file_id)
546
def executable(tree, file_id):
547
"""Determine the executability of a file-id (used as a key method)."""
548
if file_id not in tree:
550
if tree.kind(file_id) != "file":
552
return tree.is_executable(file_id)
555
def kind(tree, file_id):
556
"""Determine the kind of a file-id (used as a key method)."""
557
if file_id not in tree:
559
return tree.kind(file_id)
562
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
563
"""Do a three-way test on a scalar.
564
Return "this", "other" or "conflict", depending whether a value wins.
566
key_base = key(base_tree, file_id)
567
key_other = key(other_tree, file_id)
568
#if base == other, either they all agree, or only THIS has changed.
569
if key_base == key_other:
571
key_this = key(this_tree, file_id)
572
if key_this not in (key_base, key_other):
574
# "Ambiguous clean merge"
575
elif key_this == key_other:
578
assert key_this == key_base
581
def merge_names(self, file_id):
582
"""Perform a merge on file_id names and parents"""
584
if file_id in tree.inventory:
585
return tree.inventory[file_id]
588
this_entry = get_entry(self.this_tree)
589
other_entry = get_entry(self.other_tree)
590
base_entry = get_entry(self.base_tree)
591
name_winner = self.scalar_three_way(this_entry, base_entry,
592
other_entry, file_id, self.name)
593
parent_id_winner = self.scalar_three_way(this_entry, base_entry,
594
other_entry, file_id,
596
if this_entry is None:
597
if name_winner == "this":
598
name_winner = "other"
599
if parent_id_winner == "this":
600
parent_id_winner = "other"
601
if name_winner == "this" and parent_id_winner == "this":
603
if name_winner == "conflict":
604
trans_id = self.tt.trans_id_file_id(file_id)
605
self._raw_conflicts.append(('name conflict', trans_id,
606
self.name(this_entry, file_id),
607
self.name(other_entry, file_id)))
608
if parent_id_winner == "conflict":
609
trans_id = self.tt.trans_id_file_id(file_id)
610
self._raw_conflicts.append(('parent conflict', trans_id,
611
self.parent(this_entry, file_id),
612
self.parent(other_entry, file_id)))
613
if other_entry is None:
614
# it doesn't matter whether the result was 'other' or
615
# 'conflict'-- if there's no 'other', we leave it alone.
617
# if we get here, name_winner and parent_winner are set to safe values.
618
winner_entry = {"this": this_entry, "other": other_entry,
619
"conflict": other_entry}
620
trans_id = self.tt.trans_id_file_id(file_id)
621
parent_id = winner_entry[parent_id_winner].parent_id
622
if parent_id is not None:
623
parent_trans_id = self.tt.trans_id_file_id(parent_id)
624
self.tt.adjust_path(winner_entry[name_winner].name,
625
parent_trans_id, trans_id)
627
def merge_contents(self, file_id):
628
"""Performa a merge on file_id contents."""
629
def contents_pair(tree):
630
if file_id not in tree:
632
kind = tree.kind(file_id)
634
contents = tree.get_file_sha1(file_id)
635
elif kind == "symlink":
636
contents = tree.get_symlink_target(file_id)
639
return kind, contents
641
def contents_conflict():
642
trans_id = self.tt.trans_id_file_id(file_id)
643
name = self.tt.final_name(trans_id)
644
parent_id = self.tt.final_parent(trans_id)
645
if file_id in self.this_tree.inventory:
646
self.tt.unversion_file(trans_id)
647
if file_id in self.this_tree:
648
self.tt.delete_contents(trans_id)
649
file_group = self._dump_conflicts(name, parent_id, file_id,
651
self._raw_conflicts.append(('contents conflict', file_group))
653
# See SPOT run. run, SPOT, run.
654
# So we're not QUITE repeating ourselves; we do tricky things with
656
base_pair = contents_pair(self.base_tree)
657
other_pair = contents_pair(self.other_tree)
658
if base_pair == other_pair:
659
# OTHER introduced no changes
661
this_pair = contents_pair(self.this_tree)
662
if this_pair == other_pair:
663
# THIS and OTHER introduced the same changes
666
trans_id = self.tt.trans_id_file_id(file_id)
667
if this_pair == base_pair:
668
# only OTHER introduced changes
669
if file_id in self.this_tree:
670
# Remove any existing contents
671
self.tt.delete_contents(trans_id)
672
if file_id in self.other_tree:
673
# OTHER changed the file
674
create_by_entry(self.tt,
675
self.other_tree.inventory[file_id],
676
self.other_tree, trans_id)
677
if file_id not in self.this_tree.inventory:
678
self.tt.version_file(file_id, trans_id)
680
elif file_id in self.this_tree.inventory:
681
# OTHER deleted the file
682
self.tt.unversion_file(trans_id)
684
#BOTH THIS and OTHER introduced changes; scalar conflict
685
elif this_pair[0] == "file" and other_pair[0] == "file":
686
# THIS and OTHER are both files, so text merge. Either
687
# BASE is a file, or both converted to files, so at least we
688
# have agreement that output should be a file.
690
self.text_merge(file_id, trans_id)
692
return contents_conflict()
693
if file_id not in self.this_tree.inventory:
694
self.tt.version_file(file_id, trans_id)
696
self.tt.tree_kind(trans_id)
697
self.tt.delete_contents(trans_id)
702
# Scalar conflict, can't text merge. Dump conflicts
703
return contents_conflict()
705
def get_lines(self, tree, file_id):
706
"""Return the lines in a file, or an empty list."""
708
return tree.get_file(file_id).readlines()
712
def text_merge(self, file_id, trans_id):
713
"""Perform a three-way text merge on a file_id"""
714
# it's possible that we got here with base as a different type.
715
# if so, we just want two-way text conflicts.
716
if file_id in self.base_tree and \
717
self.base_tree.kind(file_id) == "file":
718
base_lines = self.get_lines(self.base_tree, file_id)
721
other_lines = self.get_lines(self.other_tree, file_id)
722
this_lines = self.get_lines(self.this_tree, file_id)
723
m3 = Merge3(base_lines, this_lines, other_lines)
724
start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
725
if self.show_base is True:
726
base_marker = '|' * 7
730
def iter_merge3(retval):
731
retval["text_conflicts"] = False
732
for line in m3.merge_lines(name_a = "TREE",
733
name_b = "MERGE-SOURCE",
734
name_base = "BASE-REVISION",
735
start_marker=start_marker,
736
base_marker=base_marker,
737
reprocess=self.reprocess):
738
if line.startswith(start_marker):
739
retval["text_conflicts"] = True
740
yield line.replace(start_marker, '<' * 7)
744
merge3_iterator = iter_merge3(retval)
745
self.tt.create_file(merge3_iterator, trans_id)
746
if retval["text_conflicts"] is True:
747
self._raw_conflicts.append(('text conflict', trans_id))
748
name = self.tt.final_name(trans_id)
749
parent_id = self.tt.final_parent(trans_id)
750
file_group = self._dump_conflicts(name, parent_id, file_id,
751
this_lines, base_lines,
753
file_group.append(trans_id)
755
def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
756
base_lines=None, other_lines=None, set_version=False,
758
"""Emit conflict files.
759
If this_lines, base_lines, or other_lines are omitted, they will be
760
determined automatically. If set_version is true, the .OTHER, .THIS
761
or .BASE (in that order) will be created as versioned files.
763
data = [('OTHER', self.other_tree, other_lines),
764
('THIS', self.this_tree, this_lines)]
766
data.append(('BASE', self.base_tree, base_lines))
769
for suffix, tree, lines in data:
771
trans_id = self._conflict_file(name, parent_id, tree, file_id,
773
file_group.append(trans_id)
774
if set_version and not versioned:
775
self.tt.version_file(file_id, trans_id)
779
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
781
"""Emit a single conflict file."""
782
name = name + '.' + suffix
783
trans_id = self.tt.create_path(name, parent_id)
784
entry = tree.inventory[file_id]
785
create_by_entry(self.tt, entry, tree, trans_id, lines)
788
def merge_executable(self, file_id, file_status):
789
"""Perform a merge on the execute bit."""
790
if file_status == "deleted":
792
trans_id = self.tt.trans_id_file_id(file_id)
794
if self.tt.final_kind(trans_id) != "file":
798
winner = self.scalar_three_way(self.this_tree, self.base_tree,
799
self.other_tree, file_id,
801
if winner == "conflict":
802
# There must be a None in here, if we have a conflict, but we
803
# need executability since file status was not deleted.
804
if self.executable(self.other_tree, file_id) is None:
809
if file_status == "modified":
810
executability = self.this_tree.is_executable(file_id)
811
if executability is not None:
812
trans_id = self.tt.trans_id_file_id(file_id)
813
self.tt.set_executability(executability, trans_id)
815
assert winner == "other"
816
if file_id in self.other_tree:
817
executability = self.other_tree.is_executable(file_id)
818
elif file_id in self.this_tree:
819
executability = self.this_tree.is_executable(file_id)
820
elif file_id in self.base_tree:
821
executability = self.base_tree.is_executable(file_id)
822
if executability is not None:
823
trans_id = self.tt.trans_id_file_id(file_id)
824
self.tt.set_executability(executability, trans_id)
826
def cook_conflicts(self, fs_conflicts):
827
"""Convert all conflicts into a form that doesn't depend on trans_id"""
828
from conflicts import Conflict
830
self.cooked_conflicts.extend(cook_conflicts(fs_conflicts, self.tt))
831
fp = FinalPaths(self.tt)
832
for conflict in self._raw_conflicts:
833
conflict_type = conflict[0]
834
if conflict_type in ('name conflict', 'parent conflict'):
835
trans_id = conflict[1]
836
conflict_args = conflict[2:]
837
if trans_id not in name_conflicts:
838
name_conflicts[trans_id] = {}
839
unique_add(name_conflicts[trans_id], conflict_type,
841
if conflict_type == 'contents conflict':
842
for trans_id in conflict[1]:
843
file_id = self.tt.final_file_id(trans_id)
304
844
if file_id is not None:
305
interesting_ids.add(file_id)
308
raise BzrCommandError("%s is not a source file in any"
310
merge_inner(this_branch, other_tree, base_tree, tempdir,
311
ignore_zero=ignore_zero, backup_files=backup_files,
312
merge_type=merge_type, interesting_ids=interesting_ids)
313
if base_is_ancestor and other_rev_id is not None\
314
and other_rev_id not in this_branch.revision_history():
315
this_branch.add_pending_merge(other_rev_id)
317
shutil.rmtree(tempdir)
320
def set_interesting(inventory_a, inventory_b, interesting_ids):
321
"""Mark files whose ids are in interesting_ids as interesting
846
path = fp.get_path(trans_id)
847
for suffix in ('.BASE', '.THIS', '.OTHER'):
848
if path.endswith(suffix):
849
path = path[:-len(suffix)]
851
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
852
self.cooked_conflicts.append(c)
853
if conflict_type == 'text conflict':
854
trans_id = conflict[1]
855
path = fp.get_path(trans_id)
856
file_id = self.tt.final_file_id(trans_id)
857
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
858
self.cooked_conflicts.append(c)
860
for trans_id, conflicts in name_conflicts.iteritems():
862
this_parent, other_parent = conflicts['parent conflict']
863
assert this_parent != other_parent
865
this_parent = other_parent = \
866
self.tt.final_file_id(self.tt.final_parent(trans_id))
868
this_name, other_name = conflicts['name conflict']
869
assert this_name != other_name
871
this_name = other_name = self.tt.final_name(trans_id)
872
other_path = fp.get_path(trans_id)
873
if this_parent is not None:
875
fp.get_path(self.tt.trans_id_file_id(this_parent))
876
this_path = pathjoin(this_parent_path, this_name)
878
this_path = "<deleted>"
879
file_id = self.tt.final_file_id(trans_id)
880
c = Conflict.factory('path conflict', path=this_path,
881
conflict_path=other_path, file_id=file_id)
882
self.cooked_conflicts.append(c)
883
self.cooked_conflicts.sort(key=Conflict.sort_key)
886
class WeaveMerger(Merge3Merger):
887
"""Three-way tree merger, text weave merger."""
888
supports_reprocess = True
889
supports_show_base = False
891
def __init__(self, working_tree, this_tree, base_tree, other_tree,
892
interesting_ids=None, pb=DummyProgress(), pp=None,
893
reprocess=False, change_reporter=None):
894
self.this_revision_tree = self._get_revision_tree(this_tree)
895
self.other_revision_tree = self._get_revision_tree(other_tree)
896
super(WeaveMerger, self).__init__(working_tree, this_tree,
897
base_tree, other_tree,
898
interesting_ids=interesting_ids,
899
pb=pb, pp=pp, reprocess=reprocess,
900
change_reporter=change_reporter)
902
def _get_revision_tree(self, tree):
903
"""Return a revision tree related to this tree.
904
If the tree is a WorkingTree, the basis will be returned.
906
if getattr(tree, 'get_weave', False) is False:
907
# If we have a WorkingTree, try using the basis
908
return tree.branch.basis_tree()
912
def _check_file(self, file_id):
913
"""Check that the revision tree's version of the file matches."""
914
for tree, rt in ((self.this_tree, self.this_revision_tree),
915
(self.other_tree, self.other_revision_tree)):
918
if tree.get_file_sha1(file_id) != rt.get_file_sha1(file_id):
919
raise WorkingTreeNotRevision(self.this_tree)
921
def _merged_lines(self, file_id):
922
"""Generate the merged lines.
923
There is no distinction between lines that are meant to contain <<<<<<<
926
weave = self.this_revision_tree.get_weave(file_id)
927
this_revision_id = self.this_revision_tree.inventory[file_id].revision
928
other_revision_id = \
929
self.other_revision_tree.inventory[file_id].revision
930
wm = WeaveMerge(weave, this_revision_id, other_revision_id,
931
'<<<<<<< TREE\n', '>>>>>>> MERGE-SOURCE\n')
932
return wm.merge_lines(self.reprocess)
934
def text_merge(self, file_id, trans_id):
935
"""Perform a (weave) text merge for a given file and file-id.
936
If conflicts are encountered, .THIS and .OTHER files will be emitted,
937
and a conflict will be noted.
939
self._check_file(file_id)
940
lines, conflicts = self._merged_lines(file_id)
942
# Note we're checking whether the OUTPUT is binary in this case,
943
# because we don't want to get into weave merge guts.
944
check_text_lines(lines)
945
self.tt.create_file(lines, trans_id)
947
self._raw_conflicts.append(('text conflict', trans_id))
948
name = self.tt.final_name(trans_id)
949
parent_id = self.tt.final_parent(trans_id)
950
file_group = self._dump_conflicts(name, parent_id, file_id,
952
file_group.append(trans_id)
955
class Diff3Merger(Merge3Merger):
956
"""Three-way merger using external diff3 for text merging"""
958
def dump_file(self, temp_dir, name, tree, file_id):
959
out_path = pathjoin(temp_dir, name)
960
out_file = open(out_path, "wb")
962
in_file = tree.get_file(file_id)
969
def text_merge(self, file_id, trans_id):
970
"""Perform a diff3 merge using a specified file-id and trans-id.
971
If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
972
will be dumped, and a will be conflict noted.
975
temp_dir = osutils.mkdtemp(prefix="bzr-")
977
new_file = pathjoin(temp_dir, "new")
978
this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
979
base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
980
other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
981
status = bzrlib.patch.diff3(new_file, this, base, other)
982
if status not in (0, 1):
983
raise BzrError("Unhandled diff3 exit code")
984
f = open(new_file, 'rb')
986
self.tt.create_file(f, trans_id)
990
name = self.tt.final_name(trans_id)
991
parent_id = self.tt.final_parent(trans_id)
992
self._dump_conflicts(name, parent_id, file_id)
993
self._raw_conflicts.append(('text conflict', trans_id))
995
osutils.rmtree(temp_dir)
998
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1000
merge_type=Merge3Merger,
1001
interesting_ids=None,
1005
interesting_files=None,
1008
change_reporter=None):
1009
"""Primary interface for merging.
1011
typical use is probably
1012
'merge_inner(branch, branch.get_revision_tree(other_revision),
1013
branch.get_revision_tree(base_revision))'
1015
if this_tree is None:
1016
raise BzrError("bzrlib.merge.merge_inner requires a this_tree "
1017
"parameter as of bzrlib version 0.8.")
1018
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1019
pb=pb, change_reporter=change_reporter)
1020
merger.backup_files = backup_files
1021
merger.merge_type = merge_type
1022
merger.interesting_ids = interesting_ids
1023
merger.ignore_zero = ignore_zero
1024
if interesting_files:
1025
assert not interesting_ids, ('Only supply interesting_ids'
1026
' or interesting_files')
1027
merger._set_interesting_files(interesting_files)
1028
merger.show_base = show_base
1029
merger.reprocess = reprocess
1030
merger.other_rev_id = other_rev_id
1031
merger.other_basis = other_rev_id
1032
return merger.do_merge()
1034
def get_merge_type_registry():
1035
"""Merge type registry is in bzrlib.option to avoid circular imports.
1037
This method provides a sanctioned way to retrieve it.
323
for inventory in (inventory_a, inventory_b):
324
for path, source_file in inventory.iteritems():
325
source_file.interesting = source_file.id in interesting_ids
328
def generate_cset_optimized(tree_a, tree_b, interesting_ids=None):
329
"""Generate a changeset. If interesting_ids is supplied, only changes
330
to those files will be shown. Metadata changes are stripped.
332
cset = generate_changeset(tree_a, tree_b, interesting_ids)
333
for entry in cset.entries.itervalues():
334
entry.metadata_change = None
338
def merge_inner(this_branch, other_tree, base_tree, tempdir,
339
ignore_zero=False, merge_type=ApplyMerge3, backup_files=False,
340
interesting_ids=None):
342
def merge_factory(file_id, base, other):
343
contents_change = merge_type(file_id, base, other)
345
contents_change = BackupBeforeChange(contents_change)
346
return contents_change
348
this_tree = get_tree((this_branch.base, None), tempdir, "this")[1]
350
def get_inventory(tree):
351
return tree.tree.inventory
353
inv_changes = merge_flex(this_tree, base_tree, other_tree,
354
generate_cset_optimized, get_inventory,
355
MergeConflictHandler(base_tree.root,
356
ignore_zero=ignore_zero),
357
merge_factory=merge_factory,
358
interesting_ids=interesting_ids)
361
for id, path in inv_changes.iteritems():
366
assert path.startswith('.' + os.sep), "path is %s" % path
368
adjust_ids.append((path, id))
369
if len(adjust_ids) > 0:
370
this_branch.set_inventory(regen_inventory(this_branch, this_tree.root,
374
def regen_inventory(this_branch, root, new_entries):
375
old_entries = this_branch.read_working_inventory()
379
for path, file_id in new_entries:
382
new_entries_map[file_id] = path
384
def id2path(file_id):
385
path = new_entries_map.get(file_id)
388
entry = old_entries[file_id]
389
if entry.parent_id is None:
391
return os.path.join(id2path(entry.parent_id), entry.name)
393
for file_id in old_entries:
394
entry = old_entries[file_id]
395
path = id2path(file_id)
396
new_inventory[file_id] = (path, file_id, entry.parent_id, entry.kind)
397
by_path[path] = file_id
402
for path, file_id in new_entries:
404
del new_inventory[file_id]
407
new_path_list.append((path, file_id))
408
if file_id not in old_entries:
410
# Ensure no file is added before its parent
412
for path, file_id in new_path_list:
416
parent = by_path[os.path.dirname(path)]
417
kind = bzrlib.osutils.file_kind(os.path.join(root, path))
418
new_inventory[file_id] = (path, file_id, parent, kind)
419
by_path[path] = file_id
421
# Get a list in insertion order
422
new_inventory_list = new_inventory.values()
423
mutter ("""Inventory regeneration:
424
old length: %i insertions: %i deletions: %i new_length: %i"""\
425
% (len(old_entries), insertions, deletions, len(new_inventory_list)))
426
assert len(new_inventory_list) == len(old_entries) + insertions - deletions
427
new_inventory_list.sort()
428
return new_inventory_list
430
merge_types = { "merge3": (ApplyMerge3, "Native diff3-style merge"),
431
"diff3": (Diff3Merge, "Merge using external diff3")
1039
from bzrlib import option
1040
return option._merge_type_registry
added
removed
bzrlib/merge.py
