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, 2006 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)
21
class MergeConflictHandler(ExceptionConflictHandler):
22
"""Handle conflicts encountered while merging"""
23
def __init__(self, dir, ignore_zero=False):
24
ExceptionConflictHandler.__init__(self, dir)
26
self.ignore_zero = ignore_zero
28
def copy(self, source, dest):
29
"""Copy the text and mode of a file
30
:param source: The path of the file to copy
31
:param dest: The distination file to create
33
s_file = file(source, "rb")
34
d_file = file(dest, "wb")
37
os.chmod(dest, 0777 & os.stat(source).st_mode)
39
def add_suffix(self, name, suffix, last_new_name=None):
40
"""Rename a file to append a suffix. If the new name exists, the
41
suffix is added repeatedly until a non-existant name is found
43
:param name: The path of the file
44
:param suffix: The suffix to append
45
:param last_new_name: (used for recursive calls) the last name tried
47
if last_new_name is None:
49
new_name = last_new_name+suffix
51
os.rename(name, new_name)
54
if e.errno != errno.EEXIST and e.errno != errno.ENOTEMPTY:
56
return self.add_suffix(name, suffix, last_new_name=new_name)
58
def conflict(self, text):
63
def merge_conflict(self, new_file, this_path, base_path, other_path):
65
Handle diff3 conflicts by producing a .THIS, .BASE and .OTHER. The
66
main file will be a version with diff3 conflicts.
67
:param new_file: Path to the output file with diff3 markers
68
:param this_path: Path to the file text for the THIS tree
69
:param base_path: Path to the file text for the BASE tree
70
:param other_path: Path to the file text for the OTHER tree
72
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)
76
self.conflict("Diff3 conflict encountered in %s" % this_path)
78
def target_exists(self, entry, target, old_path):
79
"""Handle the case when the target file or dir exists"""
80
moved_path = self.add_suffix(target, ".moved")
81
self.conflict("Moved existing %s to %s" % (target, moved_path))
83
def rmdir_non_empty(self, filename):
84
"""Handle the case where the dir to be removed still has contents"""
85
self.conflict("Directory %s not removed because it is not empty"\
90
if not self.ignore_zero:
91
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):
105
location, revno = treespec
106
branch = find_branch(location)
108
base_tree = branch.working_tree()
110
base_tree = branch.basis_tree()
112
base_tree = branch.revision_tree(branch.lookup_revision(revno))
113
temp_path = os.path.join(temp_root, label)
115
return branch, MergeTree(base_tree, temp_path)
118
def abspath(tree, file_id):
119
path = tree.inventory.id2path(file_id)
124
def file_exists(tree, file_id):
125
return tree.has_filename(tree.id2path(file_id))
127
def inventory_map(tree):
129
for file_id in tree.inventory:
130
path = abspath(tree, file_id)
131
inventory[path] = SourceFile(path, file_id)
135
class MergeTree(object):
136
def __init__(self, tree, tempdir):
26
revision as _mod_revision,
28
from bzrlib.branch import Branch
29
from bzrlib.conflicts import ConflictList, Conflict
30
from bzrlib.errors import (BzrCommandError,
40
WorkingTreeNotRevision,
43
from bzrlib.merge3 import Merge3
44
from bzrlib.osutils import rename, pathjoin
45
from progress import DummyProgress, ProgressPhase
46
from bzrlib.revision import (is_ancestor, NULL_REVISION, ensure_null)
47
from bzrlib.textfile import check_text_lines
48
from bzrlib.trace import mutter, warning, note
49
from bzrlib.transform import (TreeTransform, resolve_conflicts, cook_conflicts,
50
conflict_pass, FinalPaths, create_by_entry,
51
unique_add, ROOT_PARENT)
52
from bzrlib.versionedfile import WeaveMerge
55
# TODO: Report back as changes are merged in
58
def transform_tree(from_tree, to_tree, interesting_ids=None):
59
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
60
interesting_ids=interesting_ids, this_tree=from_tree)
64
def __init__(self, this_branch, other_tree=None, base_tree=None,
65
this_tree=None, pb=DummyProgress(), change_reporter=None,
137
67
object.__init__(self)
138
if hasattr(tree, "basedir"):
139
self.root = tree.basedir
142
self.inventory = inventory_map(tree)
144
self.tempdir = tempdir
145
os.mkdir(os.path.join(self.tempdir, "texts"))
148
def readonly_path(self, id):
149
if id not in self.tree:
151
if self.root is not None:
152
return self.tree.abspath(self.tree.id2path(id))
154
if self.tree.inventory[id].kind in ("directory", "root_directory"):
156
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))
161
self.cached[id] = path
162
return self.cached[id]
166
def merge(other_revision, base_revision,
167
check_clean=True, ignore_zero=False,
168
this_dir=None, backup_files=False, merge_type=ApplyMerge3,
170
"""Merge changes into a tree.
173
Base for three-way merge.
175
Other revision for three-way merge.
177
Directory to merge changes into; '.' by default.
179
If true, this_dir must have no uncommitted changes before the
182
tempdir = tempfile.mkdtemp(prefix="bzr-")
186
this_branch = find_branch(this_dir)
68
assert this_tree is not None, "this_tree is required"
69
self.this_branch = this_branch
70
self.this_basis = _mod_revision.ensure_null(
71
this_branch.last_revision())
72
self.this_rev_id = None
73
self.this_tree = this_tree
74
self.this_revision_tree = None
75
self.this_basis_tree = None
76
self.other_tree = other_tree
77
self.other_branch = None
78
self.base_tree = base_tree
79
self.ignore_zero = False
80
self.backup_files = False
81
self.interesting_ids = None
82
self.interesting_files = None
83
self.show_base = False
84
self.reprocess = False
87
self.recurse = recurse
88
self.change_reporter = change_reporter
89
self._cached_trees = {}
91
def revision_tree(self, revision_id, branch=None):
92
if revision_id not in self._cached_trees:
94
branch = self.this_branch
96
tree = self.this_tree.revision_tree(revision_id)
97
except errors.NoSuchRevisionInTree:
98
tree = branch.repository.revision_tree(revision_id)
99
self._cached_trees[revision_id] = tree
100
return self._cached_trees[revision_id]
102
def _get_tree(self, treespec):
103
from bzrlib import workingtree
104
location, revno = treespec
106
tree = workingtree.WorkingTree.open_containing(location)[0]
107
return tree.branch, tree
108
branch = Branch.open_containing(location)[0]
110
revision_id = branch.last_revision()
112
revision_id = branch.get_rev_id(revno)
113
revision_id = ensure_null(revision_id)
114
return branch, self.revision_tree(revision_id, branch)
116
def ensure_revision_trees(self):
117
if self.this_revision_tree is None:
118
self.this_basis_tree = self.revision_tree(self.this_basis)
119
if self.this_basis == self.this_rev_id:
120
self.this_revision_tree = self.this_basis_tree
122
if self.other_rev_id is None:
123
other_basis_tree = self.revision_tree(self.other_basis)
124
changes = other_basis_tree.changes_from(self.other_tree)
125
if changes.has_changed():
126
raise WorkingTreeNotRevision(self.this_tree)
127
other_rev_id = self.other_basis
128
self.other_tree = other_basis_tree
130
def file_revisions(self, file_id):
131
self.ensure_revision_trees()
132
def get_id(tree, file_id):
133
revision_id = tree.inventory[file_id].revision
134
assert revision_id is not None
136
if self.this_rev_id is None:
137
if self.this_basis_tree.get_file_sha1(file_id) != \
138
self.this_tree.get_file_sha1(file_id):
139
raise WorkingTreeNotRevision(self.this_tree)
141
trees = (self.this_basis_tree, self.other_tree)
142
return [get_id(tree, file_id) for tree in trees]
144
def check_basis(self, check_clean, require_commits=True):
145
if self.this_basis is None and require_commits is True:
146
raise BzrCommandError("This branch has no commits."
147
" (perhaps you would prefer 'bzr pull')")
188
changes = compare_trees(this_branch.working_tree(),
189
this_branch.basis_tree(), False)
190
if changes.has_changed():
150
if self.this_basis != self.this_rev_id:
191
151
raise BzrCommandError("Working tree has uncommitted changes.")
192
other_branch, other_tree = get_tree(other_revision, tempdir, "other")
153
def compare_basis(self):
155
basis_tree = self.revision_tree(self.this_tree.last_revision())
156
except errors.RevisionNotPresent:
157
basis_tree = self.this_tree.basis_tree()
158
changes = self.this_tree.changes_from(basis_tree)
159
if not changes.has_changed():
160
self.this_rev_id = self.this_basis
162
def set_interesting_files(self, file_list):
163
self.interesting_files = file_list
165
def set_pending(self):
166
if not self.base_is_ancestor or not self.base_is_other_ancestor:
170
def _add_parent(self):
171
new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
172
new_parent_trees = []
173
for revision_id in new_parents:
175
tree = self.revision_tree(revision_id)
176
except errors.RevisionNotPresent:
180
new_parent_trees.append((revision_id, tree))
182
self.this_tree.set_parent_trees(new_parent_trees,
183
allow_leftmost_as_ghost=True)
185
for _revision_id, tree in new_parent_trees:
189
def set_other(self, other_revision):
190
"""Set the revision and tree to merge from.
192
This sets the other_tree, other_rev_id, other_basis attributes.
194
:param other_revision: The [path, revision] list to merge from.
196
self.other_branch, self.other_tree = self._get_tree(other_revision)
197
if other_revision[1] == -1:
198
self.other_rev_id = _mod_revision.ensure_null(
199
self.other_branch.last_revision())
200
if _mod_revision.is_null(self.other_rev_id):
201
raise NoCommits(self.other_branch)
202
self.other_basis = self.other_rev_id
203
elif other_revision[1] is not None:
204
self.other_rev_id = self.other_branch.get_rev_id(other_revision[1])
205
self.other_basis = self.other_rev_id
207
self.other_rev_id = None
208
self.other_basis = self.other_branch.last_revision()
209
if self.other_basis is None:
210
raise NoCommits(self.other_branch)
211
if self.other_rev_id is not None:
212
self._cached_trees[self.other_rev_id] = self.other_tree
213
self._maybe_fetch(self.other_branch,self.this_branch, self.other_basis)
215
def set_other_revision(self, revision_id, other_branch):
216
"""Set 'other' based on a branch and revision id
218
:param revision_id: The revision to use for a tree
219
:param other_branch: The branch containing this tree
221
self.other_rev_id = revision_id
222
self.other_branch = other_branch
223
self._maybe_fetch(other_branch, self.this_branch, self.other_rev_id)
224
self.other_tree = self.revision_tree(revision_id)
225
self.other_basis = revision_id
227
def set_base_revision(self, revision_id, branch):
228
"""Set 'base' based on a branch and revision id
230
:param revision_id: The revision to use for a tree
231
:param branch: The branch containing this tree
233
self.base_rev_id = revision_id
234
self.base_branch = branch
235
self._maybe_fetch(branch, self.this_branch, revision_id)
236
self.base_tree = self.revision_tree(revision_id)
237
self.base_is_ancestor = is_ancestor(self.this_basis,
240
self.base_is_other_ancestor = is_ancestor(self.other_basis,
244
def _maybe_fetch(self, source, target, revision_id):
245
if (source.repository.bzrdir.root_transport.base !=
246
target.repository.bzrdir.root_transport.base):
247
target.fetch(source, revision_id)
250
this_repo = self.this_branch.repository
251
graph = this_repo.get_graph()
252
revisions = [ensure_null(self.this_basis),
253
ensure_null(self.other_basis)]
254
if NULL_REVISION in revisions:
255
self.base_rev_id = NULL_REVISION
257
self.base_rev_id = graph.find_unique_lca(*revisions)
258
if self.base_rev_id == NULL_REVISION:
259
raise UnrelatedBranches()
260
self.base_tree = self.revision_tree(self.base_rev_id)
261
self.base_is_ancestor = True
262
self.base_is_other_ancestor = True
264
def set_base(self, base_revision):
265
"""Set the base revision to use for the merge.
267
:param base_revision: A 2-list containing a path and revision number.
269
mutter("doing merge() with no base_revision specified")
193
270
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:
201
raise UnrelatedBranches()
202
base_revision = ['.', base_revno]
203
base_branch, base_tree = get_tree(base_revision, tempdir, "base")
204
if file_list is None:
205
interesting_ids = None
207
interesting_ids = set()
208
this_tree = this_branch.working_tree()
209
for fname in file_list:
210
path = this_branch.relpath(fname)
212
for tree in (this_tree, base_tree.tree, other_tree.tree):
213
file_id = tree.inventory.path2id(path)
273
base_branch, self.base_tree = self._get_tree(base_revision)
274
if base_revision[1] == -1:
275
self.base_rev_id = base_branch.last_revision()
276
elif base_revision[1] is None:
277
self.base_rev_id = _mod_revision.NULL_REVISION
279
self.base_rev_id = _mod_revision.ensure_null(
280
base_branch.get_rev_id(base_revision[1]))
281
self._maybe_fetch(base_branch, self.this_branch, self.base_rev_id)
282
self.base_is_ancestor = is_ancestor(self.this_basis,
285
self.base_is_other_ancestor = is_ancestor(self.other_basis,
290
kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
291
'other_tree': self.other_tree,
292
'interesting_ids': self.interesting_ids,
293
'interesting_files': self.interesting_files,
295
if self.merge_type.requires_base:
296
kwargs['base_tree'] = self.base_tree
297
if self.merge_type.supports_reprocess:
298
kwargs['reprocess'] = self.reprocess
300
raise BzrError("Conflict reduction is not supported for merge"
301
" type %s." % self.merge_type)
302
if self.merge_type.supports_show_base:
303
kwargs['show_base'] = self.show_base
305
raise BzrError("Showing base is not supported for this"
306
" merge type. %s" % self.merge_type)
307
self.this_tree.lock_tree_write()
308
if self.base_tree is not None:
309
self.base_tree.lock_read()
310
if self.other_tree is not None:
311
self.other_tree.lock_read()
313
merge = self.merge_type(pb=self._pb,
314
change_reporter=self.change_reporter,
316
if self.recurse == 'down':
317
for path, file_id in self.this_tree.iter_references():
318
sub_tree = self.this_tree.get_nested_tree(file_id, path)
319
other_revision = self.other_tree.get_reference_revision(
321
if other_revision == sub_tree.last_revision():
323
sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
324
sub_merge.merge_type = self.merge_type
325
relpath = self.this_tree.relpath(path)
326
other_branch = self.other_branch.reference_parent(file_id, relpath)
327
sub_merge.set_other_revision(other_revision, other_branch)
328
base_revision = self.base_tree.get_reference_revision(file_id)
329
sub_merge.base_tree = \
330
sub_tree.branch.repository.revision_tree(base_revision)
334
if self.other_tree is not None:
335
self.other_tree.unlock()
336
if self.base_tree is not None:
337
self.base_tree.unlock()
338
self.this_tree.unlock()
339
if len(merge.cooked_conflicts) == 0:
340
if not self.ignore_zero:
341
note("All changes applied successfully.")
343
note("%d conflicts encountered." % len(merge.cooked_conflicts))
345
return len(merge.cooked_conflicts)
348
class Merge3Merger(object):
349
"""Three-way merger that uses the merge3 text merger"""
351
supports_reprocess = True
352
supports_show_base = True
353
history_based = False
354
winner_idx = {"this": 2, "other": 1, "conflict": 1}
356
def __init__(self, working_tree, this_tree, base_tree, other_tree,
357
interesting_ids=None, reprocess=False, show_base=False,
358
pb=DummyProgress(), pp=None, change_reporter=None,
359
interesting_files=None):
360
"""Initialize the merger object and perform the merge.
362
:param working_tree: The working tree to apply the merge to
363
:param this_tree: The local tree in the merge operation
364
:param base_tree: The common tree in the merge operation
365
:param other_tree: The other other tree to merge changes from
366
:param interesting_ids: The file_ids of files that should be
367
participate in the merge. May not be combined with
369
:param: reprocess If True, perform conflict-reduction processing.
370
:param show_base: If True, show the base revision in text conflicts.
371
(incompatible with reprocess)
372
:param pb: A Progress bar
373
:param pp: A ProgressPhase object
374
:param change_reporter: An object that should report changes made
375
:param interesting_files: The tree-relative paths of files that should
376
participate in the merge. If these paths refer to directories,
377
the contents of those directories will also be included. May not
378
be combined with interesting_ids. If neither interesting_files nor
379
interesting_ids is specified, all files may participate in the
382
object.__init__(self)
383
if interesting_files is not None:
384
assert interesting_ids is None
385
self.interesting_ids = interesting_ids
386
self.interesting_files = interesting_files
387
self.this_tree = working_tree
388
self.this_tree.lock_tree_write()
389
self.base_tree = base_tree
390
self.base_tree.lock_read()
391
self.other_tree = other_tree
392
self.other_tree.lock_read()
393
self._raw_conflicts = []
394
self.cooked_conflicts = []
395
self.reprocess = reprocess
396
self.show_base = show_base
399
self.change_reporter = change_reporter
401
self.pp = ProgressPhase("Merge phase", 3, self.pb)
403
self.tt = TreeTransform(working_tree, self.pb)
406
entries = self._entries3()
407
child_pb = ui.ui_factory.nested_progress_bar()
409
for num, (file_id, changed, parents3, names3,
410
executable3) in enumerate(entries):
411
child_pb.update('Preparing file merge', num, len(entries))
412
self._merge_names(file_id, parents3, names3)
414
file_status = self.merge_contents(file_id)
416
file_status = 'unmodified'
417
self._merge_executable(file_id,
418
executable3, file_status)
423
child_pb = ui.ui_factory.nested_progress_bar()
425
fs_conflicts = resolve_conflicts(self.tt, child_pb,
426
lambda t, c: conflict_pass(t, c, self.other_tree))
429
if change_reporter is not None:
430
from bzrlib import delta
431
delta.report_changes(self.tt._iter_changes(), change_reporter)
432
self.cook_conflicts(fs_conflicts)
433
for conflict in self.cooked_conflicts:
436
results = self.tt.apply(no_conflicts=True)
437
self.write_modified(results)
439
working_tree.add_conflicts(self.cooked_conflicts)
440
except UnsupportedOperation:
444
self.other_tree.unlock()
445
self.base_tree.unlock()
446
self.this_tree.unlock()
450
"""Gather data about files modified between three trees.
452
Return a list of tuples of file_id, changed, parents3, names3,
453
executable3. changed is a boolean indicating whether the file contents
454
or kind were changed. parents3 is a tuple of parent ids for base,
455
other and this. names3 is a tuple of names for base, other and this.
456
executable3 is a tuple of execute-bit values for base, other and this.
459
iterator = self.other_tree._iter_changes(self.base_tree,
460
include_unchanged=True, specific_files=self.interesting_files,
461
extra_trees=[self.this_tree])
462
for (file_id, paths, changed, versioned, parents, names, kind,
463
executable) in iterator:
464
if (self.interesting_ids is not None and
465
file_id not in self.interesting_ids):
467
if file_id in self.this_tree.inventory:
468
entry = self.this_tree.inventory[file_id]
469
this_name = entry.name
470
this_parent = entry.parent_id
471
this_executable = entry.executable
475
this_executable = None
476
parents3 = parents + (this_parent,)
477
names3 = names + (this_name,)
478
executable3 = executable + (this_executable,)
479
result.append((file_id, changed, parents3, names3, executable3))
484
self.tt.final_kind(self.tt.root)
486
self.tt.cancel_deletion(self.tt.root)
487
if self.tt.final_file_id(self.tt.root) is None:
488
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
490
if self.other_tree.inventory.root is None:
492
other_root_file_id = self.other_tree.inventory.root.file_id
493
other_root = self.tt.trans_id_file_id(other_root_file_id)
494
if other_root == self.tt.root:
497
self.tt.final_kind(other_root)
500
self.reparent_children(self.other_tree.inventory.root, self.tt.root)
501
self.tt.cancel_creation(other_root)
502
self.tt.cancel_versioning(other_root)
504
def reparent_children(self, ie, target):
505
for thing, child in ie.children.iteritems():
506
trans_id = self.tt.trans_id_file_id(child.file_id)
507
self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
509
def write_modified(self, results):
511
for path in results.modified_paths:
512
file_id = self.this_tree.path2id(self.this_tree.relpath(path))
515
hash = self.this_tree.get_file_sha1(file_id)
518
modified_hashes[file_id] = hash
519
self.this_tree.set_merge_modified(modified_hashes)
522
def parent(entry, file_id):
523
"""Determine the parent for a file_id (used as a key method)"""
526
return entry.parent_id
529
def name(entry, file_id):
530
"""Determine the name for a file_id (used as a key method)"""
536
def contents_sha1(tree, file_id):
537
"""Determine the sha1 of the file contents (used as a key method)."""
538
if file_id not in tree:
540
return tree.get_file_sha1(file_id)
543
def executable(tree, file_id):
544
"""Determine the executability of a file-id (used as a key method)."""
545
if file_id not in tree:
547
if tree.kind(file_id) != "file":
549
return tree.is_executable(file_id)
552
def kind(tree, file_id):
553
"""Determine the kind of a file-id (used as a key method)."""
554
if file_id not in tree:
556
return tree.kind(file_id)
559
def _three_way(base, other, this):
560
#if base == other, either they all agree, or only THIS has changed.
563
elif this not in (base, other):
565
# "Ambiguous clean merge" -- both sides have made the same change.
568
# this == base: only other has changed.
573
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
574
"""Do a three-way test on a scalar.
575
Return "this", "other" or "conflict", depending whether a value wins.
577
key_base = key(base_tree, file_id)
578
key_other = key(other_tree, file_id)
579
#if base == other, either they all agree, or only THIS has changed.
580
if key_base == key_other:
582
key_this = key(this_tree, file_id)
583
if key_this not in (key_base, key_other):
585
# "Ambiguous clean merge"
586
elif key_this == key_other:
589
assert key_this == key_base
592
def merge_names(self, file_id):
594
if file_id in tree.inventory:
595
return tree.inventory[file_id]
598
this_entry = get_entry(self.this_tree)
599
other_entry = get_entry(self.other_tree)
600
base_entry = get_entry(self.base_tree)
601
entries = (base_entry, other_entry, this_entry)
604
for entry in entries:
609
names.append(entry.name)
610
parents.append(entry.parent_id)
611
return self._merge_names(file_id, parents, names)
613
def _merge_names(self, file_id, parents, names):
614
"""Perform a merge on file_id names and parents"""
615
base_name, other_name, this_name = names
616
base_parent, other_parent, this_parent = parents
618
name_winner = self._three_way(*names)
620
parent_id_winner = self._three_way(*parents)
621
if this_name is None:
622
if name_winner == "this":
623
name_winner = "other"
624
if parent_id_winner == "this":
625
parent_id_winner = "other"
626
if name_winner == "this" and parent_id_winner == "this":
628
if name_winner == "conflict":
629
trans_id = self.tt.trans_id_file_id(file_id)
630
self._raw_conflicts.append(('name conflict', trans_id,
631
this_name, other_name))
632
if parent_id_winner == "conflict":
633
trans_id = self.tt.trans_id_file_id(file_id)
634
self._raw_conflicts.append(('parent conflict', trans_id,
635
this_parent, other_parent))
636
if other_name is None:
637
# it doesn't matter whether the result was 'other' or
638
# 'conflict'-- if there's no 'other', we leave it alone.
640
# if we get here, name_winner and parent_winner are set to safe values.
641
trans_id = self.tt.trans_id_file_id(file_id)
642
parent_id = parents[self.winner_idx[parent_id_winner]]
643
if parent_id is not None:
644
parent_trans_id = self.tt.trans_id_file_id(parent_id)
645
self.tt.adjust_path(names[self.winner_idx[name_winner]],
646
parent_trans_id, trans_id)
648
def merge_contents(self, file_id):
649
"""Performa a merge on file_id contents."""
650
def contents_pair(tree):
651
if file_id not in tree:
653
kind = tree.kind(file_id)
655
contents = tree.get_file_sha1(file_id)
656
elif kind == "symlink":
657
contents = tree.get_symlink_target(file_id)
660
return kind, contents
662
def contents_conflict():
663
trans_id = self.tt.trans_id_file_id(file_id)
664
name = self.tt.final_name(trans_id)
665
parent_id = self.tt.final_parent(trans_id)
666
if file_id in self.this_tree.inventory:
667
self.tt.unversion_file(trans_id)
668
if file_id in self.this_tree:
669
self.tt.delete_contents(trans_id)
670
file_group = self._dump_conflicts(name, parent_id, file_id,
672
self._raw_conflicts.append(('contents conflict', file_group))
674
# See SPOT run. run, SPOT, run.
675
# So we're not QUITE repeating ourselves; we do tricky things with
677
base_pair = contents_pair(self.base_tree)
678
other_pair = contents_pair(self.other_tree)
679
if base_pair == other_pair:
680
# OTHER introduced no changes
682
this_pair = contents_pair(self.this_tree)
683
if this_pair == other_pair:
684
# THIS and OTHER introduced the same changes
687
trans_id = self.tt.trans_id_file_id(file_id)
688
if this_pair == base_pair:
689
# only OTHER introduced changes
690
if file_id in self.this_tree:
691
# Remove any existing contents
692
self.tt.delete_contents(trans_id)
693
if file_id in self.other_tree:
694
# OTHER changed the file
695
create_by_entry(self.tt,
696
self.other_tree.inventory[file_id],
697
self.other_tree, trans_id)
698
if file_id not in self.this_tree.inventory:
699
self.tt.version_file(file_id, trans_id)
701
elif file_id in self.this_tree.inventory:
702
# OTHER deleted the file
703
self.tt.unversion_file(trans_id)
705
#BOTH THIS and OTHER introduced changes; scalar conflict
706
elif this_pair[0] == "file" and other_pair[0] == "file":
707
# THIS and OTHER are both files, so text merge. Either
708
# BASE is a file, or both converted to files, so at least we
709
# have agreement that output should be a file.
711
self.text_merge(file_id, trans_id)
713
return contents_conflict()
714
if file_id not in self.this_tree.inventory:
715
self.tt.version_file(file_id, trans_id)
717
self.tt.tree_kind(trans_id)
718
self.tt.delete_contents(trans_id)
723
# Scalar conflict, can't text merge. Dump conflicts
724
return contents_conflict()
726
def get_lines(self, tree, file_id):
727
"""Return the lines in a file, or an empty list."""
729
return tree.get_file(file_id).readlines()
733
def text_merge(self, file_id, trans_id):
734
"""Perform a three-way text merge on a file_id"""
735
# it's possible that we got here with base as a different type.
736
# if so, we just want two-way text conflicts.
737
if file_id in self.base_tree and \
738
self.base_tree.kind(file_id) == "file":
739
base_lines = self.get_lines(self.base_tree, file_id)
742
other_lines = self.get_lines(self.other_tree, file_id)
743
this_lines = self.get_lines(self.this_tree, file_id)
744
m3 = Merge3(base_lines, this_lines, other_lines)
745
start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
746
if self.show_base is True:
747
base_marker = '|' * 7
751
def iter_merge3(retval):
752
retval["text_conflicts"] = False
753
for line in m3.merge_lines(name_a = "TREE",
754
name_b = "MERGE-SOURCE",
755
name_base = "BASE-REVISION",
756
start_marker=start_marker,
757
base_marker=base_marker,
758
reprocess=self.reprocess):
759
if line.startswith(start_marker):
760
retval["text_conflicts"] = True
761
yield line.replace(start_marker, '<' * 7)
765
merge3_iterator = iter_merge3(retval)
766
self.tt.create_file(merge3_iterator, trans_id)
767
if retval["text_conflicts"] is True:
768
self._raw_conflicts.append(('text conflict', trans_id))
769
name = self.tt.final_name(trans_id)
770
parent_id = self.tt.final_parent(trans_id)
771
file_group = self._dump_conflicts(name, parent_id, file_id,
772
this_lines, base_lines,
774
file_group.append(trans_id)
776
def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
777
base_lines=None, other_lines=None, set_version=False,
779
"""Emit conflict files.
780
If this_lines, base_lines, or other_lines are omitted, they will be
781
determined automatically. If set_version is true, the .OTHER, .THIS
782
or .BASE (in that order) will be created as versioned files.
784
data = [('OTHER', self.other_tree, other_lines),
785
('THIS', self.this_tree, this_lines)]
787
data.append(('BASE', self.base_tree, base_lines))
790
for suffix, tree, lines in data:
792
trans_id = self._conflict_file(name, parent_id, tree, file_id,
794
file_group.append(trans_id)
795
if set_version and not versioned:
796
self.tt.version_file(file_id, trans_id)
800
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
802
"""Emit a single conflict file."""
803
name = name + '.' + suffix
804
trans_id = self.tt.create_path(name, parent_id)
805
entry = tree.inventory[file_id]
806
create_by_entry(self.tt, entry, tree, trans_id, lines)
809
def merge_executable(self, file_id, file_status):
810
"""Perform a merge on the execute bit."""
811
executable = [self.executable(t, file_id) for t in (self.base_tree,
812
self.other_tree, self.this_tree)]
813
self._merge_executable(file_id, executable, file_status)
815
def _merge_executable(self, file_id, executable, file_status):
816
"""Perform a merge on the execute bit."""
817
base_executable, other_executable, this_executable = executable
818
if file_status == "deleted":
820
trans_id = self.tt.trans_id_file_id(file_id)
822
if self.tt.final_kind(trans_id) != "file":
826
winner = self._three_way(*executable)
827
if winner == "conflict":
828
# There must be a None in here, if we have a conflict, but we
829
# need executability since file status was not deleted.
830
if self.executable(self.other_tree, file_id) is None:
835
if file_status == "modified":
836
executability = this_executable
837
if executability is not None:
838
trans_id = self.tt.trans_id_file_id(file_id)
839
self.tt.set_executability(executability, trans_id)
841
assert winner == "other"
842
if file_id in self.other_tree:
843
executability = other_executable
844
elif file_id in self.this_tree:
845
executability = this_executable
846
elif file_id in self.base_tree:
847
executability = base_executable
848
if executability is not None:
849
trans_id = self.tt.trans_id_file_id(file_id)
850
self.tt.set_executability(executability, trans_id)
852
def cook_conflicts(self, fs_conflicts):
853
"""Convert all conflicts into a form that doesn't depend on trans_id"""
854
from conflicts import Conflict
856
self.cooked_conflicts.extend(cook_conflicts(fs_conflicts, self.tt))
857
fp = FinalPaths(self.tt)
858
for conflict in self._raw_conflicts:
859
conflict_type = conflict[0]
860
if conflict_type in ('name conflict', 'parent conflict'):
861
trans_id = conflict[1]
862
conflict_args = conflict[2:]
863
if trans_id not in name_conflicts:
864
name_conflicts[trans_id] = {}
865
unique_add(name_conflicts[trans_id], conflict_type,
867
if conflict_type == 'contents conflict':
868
for trans_id in conflict[1]:
869
file_id = self.tt.final_file_id(trans_id)
214
870
if file_id is not None:
215
interesting_ids.add(file_id)
218
raise BzrCommandError("%s is not a source file in any"
220
merge_inner(this_branch, other_tree, base_tree, tempdir,
221
ignore_zero=ignore_zero, backup_files=backup_files,
222
merge_type=merge_type, interesting_ids=interesting_ids)
224
shutil.rmtree(tempdir)
227
def set_interesting(inventory_a, inventory_b, interesting_ids):
228
"""Mark files whose ids are in interesting_ids as interesting
230
for inventory in (inventory_a, inventory_b):
231
for path, source_file in inventory.iteritems():
232
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.
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)
265
for entry in cset.entries.itervalues():
266
entry.metadata_change = None
270
def merge_inner(this_branch, other_tree, base_tree, tempdir,
271
ignore_zero=False, merge_type=ApplyMerge3, backup_files=False,
272
interesting_ids=None):
274
def merge_factory(base_file, other_file):
275
contents_change = merge_type(base_file, other_file)
277
contents_change = BackupBeforeChange(contents_change)
278
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
this_tree = get_tree((this_branch.base, None), tempdir, "this")[1]
286
def get_inventory(tree):
287
return tree.inventory
289
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)
296
for id, path in inv_changes.iteritems():
872
path = fp.get_path(trans_id)
873
for suffix in ('.BASE', '.THIS', '.OTHER'):
874
if path.endswith(suffix):
875
path = path[:-len(suffix)]
877
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
878
self.cooked_conflicts.append(c)
879
if conflict_type == 'text conflict':
880
trans_id = conflict[1]
881
path = fp.get_path(trans_id)
882
file_id = self.tt.final_file_id(trans_id)
883
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
884
self.cooked_conflicts.append(c)
886
for trans_id, conflicts in name_conflicts.iteritems():
888
this_parent, other_parent = conflicts['parent conflict']
889
assert this_parent != other_parent
891
this_parent = other_parent = \
892
self.tt.final_file_id(self.tt.final_parent(trans_id))
894
this_name, other_name = conflicts['name conflict']
895
assert this_name != other_name
897
this_name = other_name = self.tt.final_name(trans_id)
898
other_path = fp.get_path(trans_id)
899
if this_parent is not None and this_name is not None:
901
fp.get_path(self.tt.trans_id_file_id(this_parent))
902
this_path = pathjoin(this_parent_path, this_name)
301
assert path.startswith('./')
303
adjust_ids.append((path, id))
304
this_branch.set_inventory(regen_inventory(this_branch, this_tree.root, adjust_ids))
307
def regen_inventory(this_branch, root, new_entries):
308
old_entries = this_branch.read_working_inventory()
311
for file_id in old_entries:
312
entry = old_entries[file_id]
313
path = old_entries.id2path(file_id)
314
new_inventory[file_id] = (path, file_id, entry.parent_id, entry.kind)
315
by_path[path] = file_id
320
for path, file_id in new_entries:
322
del new_inventory[file_id]
325
new_path_list.append((path, file_id))
326
if file_id not in old_entries:
328
# Ensure no file is added before its parent
330
for path, file_id in new_path_list:
334
parent = by_path[os.path.dirname(path)]
335
kind = bzrlib.osutils.file_kind(os.path.join(root, path))
336
new_inventory[file_id] = (path, file_id, parent, kind)
337
by_path[path] = file_id
339
# Get a list in insertion order
340
new_inventory_list = new_inventory.values()
341
mutter ("""Inventory regeneration:
342
old length: %i insertions: %i deletions: %i new_length: %i"""\
343
% (len(old_entries), insertions, deletions, len(new_inventory_list)))
344
assert len(new_inventory_list) == len(old_entries) + insertions - deletions
345
new_inventory_list.sort()
346
return new_inventory_list
348
merge_types = { "merge3": (ApplyMerge3, "Native diff3-style merge"),
349
"diff3": (Diff3Merge, "Merge using external diff3")
904
this_path = "<deleted>"
905
file_id = self.tt.final_file_id(trans_id)
906
c = Conflict.factory('path conflict', path=this_path,
907
conflict_path=other_path, file_id=file_id)
908
self.cooked_conflicts.append(c)
909
self.cooked_conflicts.sort(key=Conflict.sort_key)
912
class WeaveMerger(Merge3Merger):
913
"""Three-way tree merger, text weave merger."""
914
supports_reprocess = True
915
supports_show_base = False
917
def __init__(self, working_tree, this_tree, base_tree, other_tree,
918
interesting_ids=None, pb=DummyProgress(), pp=None,
919
reprocess=False, change_reporter=None,
920
interesting_files=None):
921
self.this_revision_tree = self._get_revision_tree(this_tree)
922
self.other_revision_tree = self._get_revision_tree(other_tree)
923
super(WeaveMerger, self).__init__(working_tree, this_tree,
924
base_tree, other_tree,
925
interesting_ids=interesting_ids,
926
pb=pb, pp=pp, reprocess=reprocess,
927
change_reporter=change_reporter)
929
def _get_revision_tree(self, tree):
930
"""Return a revision tree related to this tree.
931
If the tree is a WorkingTree, the basis will be returned.
933
if getattr(tree, 'get_weave', False) is False:
934
# If we have a WorkingTree, try using the basis
935
return tree.branch.basis_tree()
939
def _check_file(self, file_id):
940
"""Check that the revision tree's version of the file matches."""
941
for tree, rt in ((self.this_tree, self.this_revision_tree),
942
(self.other_tree, self.other_revision_tree)):
945
if tree.get_file_sha1(file_id) != rt.get_file_sha1(file_id):
946
raise WorkingTreeNotRevision(self.this_tree)
948
def _merged_lines(self, file_id):
949
"""Generate the merged lines.
950
There is no distinction between lines that are meant to contain <<<<<<<
953
weave = self.this_revision_tree.get_weave(file_id)
954
this_revision_id = self.this_revision_tree.inventory[file_id].revision
955
other_revision_id = \
956
self.other_revision_tree.inventory[file_id].revision
957
wm = WeaveMerge(weave, this_revision_id, other_revision_id,
958
'<<<<<<< TREE\n', '>>>>>>> MERGE-SOURCE\n')
959
return wm.merge_lines(self.reprocess)
961
def text_merge(self, file_id, trans_id):
962
"""Perform a (weave) text merge for a given file and file-id.
963
If conflicts are encountered, .THIS and .OTHER files will be emitted,
964
and a conflict will be noted.
966
self._check_file(file_id)
967
lines, conflicts = self._merged_lines(file_id)
969
# Note we're checking whether the OUTPUT is binary in this case,
970
# because we don't want to get into weave merge guts.
971
check_text_lines(lines)
972
self.tt.create_file(lines, trans_id)
974
self._raw_conflicts.append(('text conflict', trans_id))
975
name = self.tt.final_name(trans_id)
976
parent_id = self.tt.final_parent(trans_id)
977
file_group = self._dump_conflicts(name, parent_id, file_id,
979
file_group.append(trans_id)
982
class Diff3Merger(Merge3Merger):
983
"""Three-way merger using external diff3 for text merging"""
985
def dump_file(self, temp_dir, name, tree, file_id):
986
out_path = pathjoin(temp_dir, name)
987
out_file = open(out_path, "wb")
989
in_file = tree.get_file(file_id)
996
def text_merge(self, file_id, trans_id):
997
"""Perform a diff3 merge using a specified file-id and trans-id.
998
If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
999
will be dumped, and a will be conflict noted.
1002
temp_dir = osutils.mkdtemp(prefix="bzr-")
1004
new_file = pathjoin(temp_dir, "new")
1005
this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
1006
base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
1007
other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
1008
status = bzrlib.patch.diff3(new_file, this, base, other)
1009
if status not in (0, 1):
1010
raise BzrError("Unhandled diff3 exit code")
1011
f = open(new_file, 'rb')
1013
self.tt.create_file(f, trans_id)
1017
name = self.tt.final_name(trans_id)
1018
parent_id = self.tt.final_parent(trans_id)
1019
self._dump_conflicts(name, parent_id, file_id)
1020
self._raw_conflicts.append(('text conflict', trans_id))
1022
osutils.rmtree(temp_dir)
1025
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1027
merge_type=Merge3Merger,
1028
interesting_ids=None,
1032
interesting_files=None,
1035
change_reporter=None):
1036
"""Primary interface for merging.
1038
typical use is probably
1039
'merge_inner(branch, branch.get_revision_tree(other_revision),
1040
branch.get_revision_tree(base_revision))'
1042
if this_tree is None:
1043
raise BzrError("bzrlib.merge.merge_inner requires a this_tree "
1044
"parameter as of bzrlib version 0.8.")
1045
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1046
pb=pb, change_reporter=change_reporter)
1047
merger.backup_files = backup_files
1048
merger.merge_type = merge_type
1049
merger.interesting_ids = interesting_ids
1050
merger.ignore_zero = ignore_zero
1051
if interesting_files:
1052
assert not interesting_ids, ('Only supply interesting_ids'
1053
' or interesting_files')
1054
merger.interesting_files = interesting_files
1055
merger.show_base = show_base
1056
merger.reprocess = reprocess
1057
merger.other_rev_id = other_rev_id
1058
merger.other_basis = other_rev_id
1059
return merger.do_merge()
1061
def get_merge_type_registry():
1062
"""Merge type registry is in bzrlib.option to avoid circular imports.
1064
This method provides a sanctioned way to retrieve it.
1066
from bzrlib import option
1067
return option._merge_type_registry
added
removed
bzrlib/merge.py
