1
from merge_core import merge_flex
2
from changeset import generate_changeset, ExceptionConflictHandler
3
from changeset import Inventory
4
from bzrlib import find_branch
6
from bzrlib.errors import BzrCommandError
7
from bzrlib.diff import compare_trees
8
from trace import mutter, warning
14
class UnrelatedBranches(BzrCommandError):
1
# Copyright (C) 2005-2011 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
from bzrlib.lazy_import import lazy_import
20
lazy_import(globals(), """
22
branch as _mod_branch,
24
conflicts as _mod_conflicts,
31
revision as _mod_revision,
41
from bzrlib.i18n import gettext
48
from bzrlib.symbol_versioning import (
52
# TODO: Report back as changes are merged in
55
def transform_tree(from_tree, to_tree, interesting_ids=None):
56
from_tree.lock_tree_write()
57
operation = cleanup.OperationWithCleanups(merge_inner)
58
operation.add_cleanup(from_tree.unlock)
59
operation.run_simple(from_tree.branch, to_tree, from_tree,
60
ignore_zero=True, interesting_ids=interesting_ids, this_tree=from_tree)
63
class MergeHooks(hooks.Hooks):
15
65
def __init__(self):
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):
66
hooks.Hooks.__init__(self, "bzrlib.merge", "Merger.hooks")
67
self.add_hook('merge_file_content',
68
"Called with a bzrlib.merge.Merger object to create a per file "
69
"merge object when starting a merge. "
70
"Should return either None or a subclass of "
71
"``bzrlib.merge.AbstractPerFileMerger``. "
72
"Such objects will then be called per file "
73
"that needs to be merged (including when one "
74
"side has deleted the file and the other has changed it). "
75
"See the AbstractPerFileMerger API docs for details on how it is "
80
class AbstractPerFileMerger(object):
81
"""PerFileMerger objects are used by plugins extending merge for bzrlib.
83
See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
85
:ivar merger: The Merge3Merger performing the merge.
88
def __init__(self, merger):
89
"""Create a PerFileMerger for use with merger."""
92
def merge_contents(self, merge_params):
93
"""Attempt to merge the contents of a single file.
95
:param merge_params: A bzrlib.merge.MergeHookParams
96
:return: A tuple of (status, chunks), where status is one of
97
'not_applicable', 'success', 'conflicted', or 'delete'. If status
98
is 'success' or 'conflicted', then chunks should be an iterable of
99
strings for the new file contents.
101
return ('not applicable', None)
104
class PerFileMerger(AbstractPerFileMerger):
105
"""Merge individual files when self.file_matches returns True.
107
This class is intended to be subclassed. The file_matches and
108
merge_matching methods should be overridden with concrete implementations.
111
def file_matches(self, params):
112
"""Return True if merge_matching should be called on this file.
114
Only called with merges of plain files with no clear winner.
116
Subclasses must override this.
118
raise NotImplementedError(self.file_matches)
120
def get_filename(self, params, tree):
121
"""Lookup the filename (i.e. basename, not path), given a Tree (e.g.
122
self.merger.this_tree) and a MergeHookParams.
124
return osutils.basename(tree.id2path(params.file_id))
126
def get_filepath(self, params, tree):
127
"""Calculate the path to the file in a tree.
129
:param params: A MergeHookParams describing the file to merge
130
:param tree: a Tree, e.g. self.merger.this_tree.
132
return tree.id2path(params.file_id)
134
def merge_contents(self, params):
135
"""Merge the contents of a single file."""
136
# Check whether this custom merge logic should be used.
138
# OTHER is a straight winner, rely on default merge.
139
params.winner == 'other' or
140
# THIS and OTHER aren't both files.
141
not params.is_file_merge() or
142
# The filename doesn't match *.xml
143
not self.file_matches(params)):
144
return 'not_applicable', None
145
return self.merge_matching(params)
147
def merge_matching(self, params):
148
"""Merge the contents of a single file that has matched the criteria
149
in PerFileMerger.merge_contents (is a conflict, is a file,
150
self.file_matches is True).
152
Subclasses must override this.
154
raise NotImplementedError(self.merge_matching)
157
class ConfigurableFileMerger(PerFileMerger):
158
"""Merge individual files when configured via a .conf file.
160
This is a base class for concrete custom file merging logic. Concrete
161
classes should implement ``merge_text``.
163
See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
165
:ivar affected_files: The configured file paths to merge.
167
:cvar name_prefix: The prefix to use when looking up configuration
168
details. <name_prefix>_merge_files describes the files targeted by the
171
:cvar default_files: The default file paths to merge when no configuration
178
def __init__(self, merger):
179
super(ConfigurableFileMerger, self).__init__(merger)
180
self.affected_files = None
181
self.default_files = self.__class__.default_files or []
182
self.name_prefix = self.__class__.name_prefix
183
if self.name_prefix is None:
184
raise ValueError("name_prefix must be set.")
186
def file_matches(self, params):
187
"""Check whether the file should call the merge hook.
189
<name_prefix>_merge_files configuration variable is a list of files
190
that should use the hook.
192
affected_files = self.affected_files
193
if affected_files is None:
194
config = self.merger.this_branch.get_config()
195
# Until bzr provides a better policy for caching the config, we
196
# just add the part we're interested in to the params to avoid
197
# reading the config files repeatedly (bazaar.conf, location.conf,
199
config_key = self.name_prefix + '_merge_files'
200
affected_files = config.get_user_option_as_list(config_key)
201
if affected_files is None:
202
# If nothing was specified in the config, use the default.
203
affected_files = self.default_files
204
self.affected_files = affected_files
206
filepath = self.get_filepath(params, self.merger.this_tree)
207
if filepath in affected_files:
211
def merge_matching(self, params):
212
return self.merge_text(params)
214
def merge_text(self, params):
215
"""Merge the byte contents of a single file.
217
This is called after checking that the merge should be performed in
218
merge_contents, and it should behave as per
219
``bzrlib.merge.AbstractPerFileMerger.merge_contents``.
221
raise NotImplementedError(self.merge_text)
224
class MergeHookParams(object):
225
"""Object holding parameters passed to merge_file_content hooks.
227
There are some fields hooks can access:
229
:ivar file_id: the file ID of the file being merged
230
:ivar trans_id: the transform ID for the merge of this file
231
:ivar this_kind: kind of file_id in 'this' tree
232
:ivar other_kind: kind of file_id in 'other' tree
233
:ivar winner: one of 'this', 'other', 'conflict'
236
def __init__(self, merger, file_id, trans_id, this_kind, other_kind,
238
self._merger = merger
239
self.file_id = file_id
240
self.trans_id = trans_id
241
self.this_kind = this_kind
242
self.other_kind = other_kind
245
def is_file_merge(self):
246
"""True if this_kind and other_kind are both 'file'."""
247
return self.this_kind == 'file' and self.other_kind == 'file'
249
@decorators.cachedproperty
250
def base_lines(self):
251
"""The lines of the 'base' version of the file."""
252
return self._merger.get_lines(self._merger.base_tree, self.file_id)
254
@decorators.cachedproperty
255
def this_lines(self):
256
"""The lines of the 'this' version of the file."""
257
return self._merger.get_lines(self._merger.this_tree, self.file_id)
259
@decorators.cachedproperty
260
def other_lines(self):
261
"""The lines of the 'other' version of the file."""
262
return self._merger.get_lines(self._merger.other_tree, self.file_id)
265
class Merger(object):
269
def __init__(self, this_branch, other_tree=None, base_tree=None,
270
this_tree=None, pb=None, change_reporter=None,
271
recurse='down', revision_graph=None):
137
272
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,
169
"""Merge changes into a tree.
172
Base for three-way merge.
174
Other revision for three-way merge.
176
Directory to merge changes into; '.' by default.
178
If true, this_dir must have no uncommitted changes before the
181
tempdir = tempfile.mkdtemp(prefix="bzr-")
185
this_branch = find_branch(this_dir)
273
self.this_branch = this_branch
274
self.this_basis = _mod_revision.ensure_null(
275
this_branch.last_revision())
276
self.this_rev_id = None
277
self.this_tree = this_tree
278
self.this_revision_tree = None
279
self.this_basis_tree = None
280
self.other_tree = other_tree
281
self.other_branch = None
282
self.base_tree = base_tree
283
self.ignore_zero = False
284
self.backup_files = False
285
self.interesting_ids = None
286
self.interesting_files = None
287
self.show_base = False
288
self.reprocess = False
290
warnings.warn("pb parameter to Merger() is deprecated and ignored")
292
self.recurse = recurse
293
self.change_reporter = change_reporter
294
self._cached_trees = {}
295
self._revision_graph = revision_graph
296
self._base_is_ancestor = None
297
self._base_is_other_ancestor = None
298
self._is_criss_cross = None
299
self._lca_trees = None
301
def cache_trees_with_revision_ids(self, trees):
302
"""Cache any tree in trees if it has a revision_id."""
303
for maybe_tree in trees:
304
if maybe_tree is None:
307
rev_id = maybe_tree.get_revision_id()
308
except AttributeError:
310
self._cached_trees[rev_id] = maybe_tree
313
def revision_graph(self):
314
if self._revision_graph is None:
315
self._revision_graph = self.this_branch.repository.get_graph()
316
return self._revision_graph
318
def _set_base_is_ancestor(self, value):
319
self._base_is_ancestor = value
321
def _get_base_is_ancestor(self):
322
if self._base_is_ancestor is None:
323
self._base_is_ancestor = self.revision_graph.is_ancestor(
324
self.base_rev_id, self.this_basis)
325
return self._base_is_ancestor
327
base_is_ancestor = property(_get_base_is_ancestor, _set_base_is_ancestor)
329
def _set_base_is_other_ancestor(self, value):
330
self._base_is_other_ancestor = value
332
def _get_base_is_other_ancestor(self):
333
if self._base_is_other_ancestor is None:
334
if self.other_basis is None:
336
self._base_is_other_ancestor = self.revision_graph.is_ancestor(
337
self.base_rev_id, self.other_basis)
338
return self._base_is_other_ancestor
340
base_is_other_ancestor = property(_get_base_is_other_ancestor,
341
_set_base_is_other_ancestor)
344
def from_uncommitted(tree, other_tree, pb=None, base_tree=None):
345
"""Return a Merger for uncommitted changes in other_tree.
347
:param tree: The tree to merge into
348
:param other_tree: The tree to get uncommitted changes from
349
:param pb: A progress indicator
350
:param base_tree: The basis to use for the merge. If unspecified,
351
other_tree.basis_tree() will be used.
353
if base_tree is None:
354
base_tree = other_tree.basis_tree()
355
merger = Merger(tree.branch, other_tree, base_tree, tree, pb)
356
merger.base_rev_id = merger.base_tree.get_revision_id()
357
merger.other_rev_id = None
358
merger.other_basis = merger.base_rev_id
362
def from_mergeable(klass, tree, mergeable, pb):
363
"""Return a Merger for a bundle or merge directive.
365
:param tree: The tree to merge changes into
366
:param mergeable: A merge directive or bundle
367
:param pb: A progress indicator
369
mergeable.install_revisions(tree.branch.repository)
370
base_revision_id, other_revision_id, verified =\
371
mergeable.get_merge_request(tree.branch.repository)
372
revision_graph = tree.branch.repository.get_graph()
373
if base_revision_id is not None:
374
if (base_revision_id != _mod_revision.NULL_REVISION and
375
revision_graph.is_ancestor(
376
base_revision_id, tree.branch.last_revision())):
377
base_revision_id = None
379
trace.warning('Performing cherrypick')
380
merger = klass.from_revision_ids(pb, tree, other_revision_id,
381
base_revision_id, revision_graph=
383
return merger, verified
386
def from_revision_ids(pb, tree, other, base=None, other_branch=None,
387
base_branch=None, revision_graph=None,
389
"""Return a Merger for revision-ids.
391
:param pb: A progress indicator
392
:param tree: The tree to merge changes into
393
:param other: The revision-id to use as OTHER
394
:param base: The revision-id to use as BASE. If not specified, will
396
:param other_branch: A branch containing the other revision-id. If
397
not supplied, tree.branch is used.
398
:param base_branch: A branch containing the base revision-id. If
399
not supplied, other_branch or tree.branch will be used.
400
:param revision_graph: If you have a revision_graph precomputed, pass
401
it in, otherwise it will be created for you.
402
:param tree_branch: The branch associated with tree. If not supplied,
403
tree.branch will be used.
405
if tree_branch is None:
406
tree_branch = tree.branch
407
merger = Merger(tree_branch, this_tree=tree, pb=pb,
408
revision_graph=revision_graph)
409
if other_branch is None:
410
other_branch = tree.branch
411
merger.set_other_revision(other, other_branch)
415
if base_branch is None:
416
base_branch = other_branch
417
merger.set_base_revision(base, base_branch)
420
def revision_tree(self, revision_id, branch=None):
421
if revision_id not in self._cached_trees:
423
branch = self.this_branch
425
tree = self.this_tree.revision_tree(revision_id)
426
except errors.NoSuchRevisionInTree:
427
tree = branch.repository.revision_tree(revision_id)
428
self._cached_trees[revision_id] = tree
429
return self._cached_trees[revision_id]
431
def _get_tree(self, treespec, possible_transports=None):
432
location, revno = treespec
434
tree = workingtree.WorkingTree.open_containing(location)[0]
435
return tree.branch, tree
436
branch = _mod_branch.Branch.open_containing(
437
location, possible_transports)[0]
439
revision_id = branch.last_revision()
441
revision_id = branch.get_rev_id(revno)
442
revision_id = _mod_revision.ensure_null(revision_id)
443
return branch, self.revision_tree(revision_id, branch)
445
@deprecated_method(deprecated_in((2, 1, 0)))
446
def ensure_revision_trees(self):
447
if self.this_revision_tree is None:
448
self.this_basis_tree = self.revision_tree(self.this_basis)
449
if self.this_basis == self.this_rev_id:
450
self.this_revision_tree = self.this_basis_tree
452
if self.other_rev_id is None:
453
other_basis_tree = self.revision_tree(self.other_basis)
454
if other_basis_tree.has_changes(self.other_tree):
455
raise errors.WorkingTreeNotRevision(self.this_tree)
456
other_rev_id = self.other_basis
457
self.other_tree = other_basis_tree
459
@deprecated_method(deprecated_in((2, 1, 0)))
460
def file_revisions(self, file_id):
461
self.ensure_revision_trees()
462
if self.this_rev_id is None:
463
if self.this_basis_tree.get_file_sha1(file_id) != \
464
self.this_tree.get_file_sha1(file_id):
465
raise errors.WorkingTreeNotRevision(self.this_tree)
467
trees = (self.this_basis_tree, self.other_tree)
468
return [tree.get_file_revision(file_id) for tree in trees]
470
@deprecated_method(deprecated_in((2, 1, 0)))
471
def check_basis(self, check_clean, require_commits=True):
472
if self.this_basis is None and require_commits is True:
473
raise errors.BzrCommandError(
474
"This branch has no commits."
475
" (perhaps you would prefer 'bzr pull')")
187
changes = compare_trees(this_branch.working_tree(),
188
this_branch.basis_tree(), False)
189
if changes.has_changed():
190
raise BzrCommandError("Working tree has uncommitted changes.")
191
other_branch, other_tree = get_tree(other_revision, tempdir, "other")
478
if self.this_basis != self.this_rev_id:
479
raise errors.UncommittedChanges(self.this_tree)
481
@deprecated_method(deprecated_in((2, 1, 0)))
482
def compare_basis(self):
484
basis_tree = self.revision_tree(self.this_tree.last_revision())
485
except errors.NoSuchRevision:
486
basis_tree = self.this_tree.basis_tree()
487
if not self.this_tree.has_changes(basis_tree):
488
self.this_rev_id = self.this_basis
490
def set_interesting_files(self, file_list):
491
self.interesting_files = file_list
493
def set_pending(self):
494
if (not self.base_is_ancestor or not self.base_is_other_ancestor
495
or self.other_rev_id is None):
499
def _add_parent(self):
500
new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
501
new_parent_trees = []
502
operation = cleanup.OperationWithCleanups(
503
self.this_tree.set_parent_trees)
504
for revision_id in new_parents:
506
tree = self.revision_tree(revision_id)
507
except errors.NoSuchRevision:
511
operation.add_cleanup(tree.unlock)
512
new_parent_trees.append((revision_id, tree))
513
operation.run_simple(new_parent_trees, allow_leftmost_as_ghost=True)
515
def set_other(self, other_revision, possible_transports=None):
516
"""Set the revision and tree to merge from.
518
This sets the other_tree, other_rev_id, other_basis attributes.
520
:param other_revision: The [path, revision] list to merge from.
522
self.other_branch, self.other_tree = self._get_tree(other_revision,
524
if other_revision[1] == -1:
525
self.other_rev_id = _mod_revision.ensure_null(
526
self.other_branch.last_revision())
527
if _mod_revision.is_null(self.other_rev_id):
528
raise errors.NoCommits(self.other_branch)
529
self.other_basis = self.other_rev_id
530
elif other_revision[1] is not None:
531
self.other_rev_id = self.other_branch.get_rev_id(other_revision[1])
532
self.other_basis = self.other_rev_id
534
self.other_rev_id = None
535
self.other_basis = self.other_branch.last_revision()
536
if self.other_basis is None:
537
raise errors.NoCommits(self.other_branch)
538
if self.other_rev_id is not None:
539
self._cached_trees[self.other_rev_id] = self.other_tree
540
self._maybe_fetch(self.other_branch,self.this_branch, self.other_basis)
542
def set_other_revision(self, revision_id, other_branch):
543
"""Set 'other' based on a branch and revision id
545
:param revision_id: The revision to use for a tree
546
:param other_branch: The branch containing this tree
548
self.other_rev_id = revision_id
549
self.other_branch = other_branch
550
self._maybe_fetch(other_branch, self.this_branch, self.other_rev_id)
551
self.other_tree = self.revision_tree(revision_id)
552
self.other_basis = revision_id
554
def set_base_revision(self, revision_id, branch):
555
"""Set 'base' based on a branch and revision id
557
:param revision_id: The revision to use for a tree
558
:param branch: The branch containing this tree
560
self.base_rev_id = revision_id
561
self.base_branch = branch
562
self._maybe_fetch(branch, self.this_branch, revision_id)
563
self.base_tree = self.revision_tree(revision_id)
565
def _maybe_fetch(self, source, target, revision_id):
566
if not source.repository.has_same_location(target.repository):
567
target.fetch(source, revision_id)
570
revisions = [_mod_revision.ensure_null(self.this_basis),
571
_mod_revision.ensure_null(self.other_basis)]
572
if _mod_revision.NULL_REVISION in revisions:
573
self.base_rev_id = _mod_revision.NULL_REVISION
574
self.base_tree = self.revision_tree(self.base_rev_id)
575
self._is_criss_cross = False
577
lcas = self.revision_graph.find_lca(revisions[0], revisions[1])
578
self._is_criss_cross = False
580
self.base_rev_id = _mod_revision.NULL_REVISION
582
self.base_rev_id = list(lcas)[0]
583
else: # len(lcas) > 1
584
self._is_criss_cross = True
586
# find_unique_lca can only handle 2 nodes, so we have to
587
# start back at the beginning. It is a shame to traverse
588
# the graph again, but better than re-implementing
590
self.base_rev_id = self.revision_graph.find_unique_lca(
591
revisions[0], revisions[1])
593
self.base_rev_id = self.revision_graph.find_unique_lca(
595
sorted_lca_keys = self.revision_graph.find_merge_order(
597
if self.base_rev_id == _mod_revision.NULL_REVISION:
598
self.base_rev_id = sorted_lca_keys[0]
600
if self.base_rev_id == _mod_revision.NULL_REVISION:
601
raise errors.UnrelatedBranches()
602
if self._is_criss_cross:
603
trace.warning('Warning: criss-cross merge encountered. See bzr'
604
' help criss-cross.')
605
trace.mutter('Criss-cross lcas: %r' % lcas)
606
if self.base_rev_id in lcas:
607
trace.mutter('Unable to find unique lca. '
608
'Fallback %r as best option.'
610
interesting_revision_ids = set(lcas)
611
interesting_revision_ids.add(self.base_rev_id)
612
interesting_trees = dict((t.get_revision_id(), t)
613
for t in self.this_branch.repository.revision_trees(
614
interesting_revision_ids))
615
self._cached_trees.update(interesting_trees)
616
if self.base_rev_id in lcas:
617
self.base_tree = interesting_trees[self.base_rev_id]
619
self.base_tree = interesting_trees.pop(self.base_rev_id)
620
self._lca_trees = [interesting_trees[key]
621
for key in sorted_lca_keys]
623
self.base_tree = self.revision_tree(self.base_rev_id)
624
self.base_is_ancestor = True
625
self.base_is_other_ancestor = True
626
trace.mutter('Base revid: %r' % self.base_rev_id)
628
def set_base(self, base_revision):
629
"""Set the base revision to use for the merge.
631
:param base_revision: A 2-list containing a path and revision number.
633
trace.mutter("doing merge() with no base_revision specified")
192
634
if base_revision == [None, None]:
193
if other_revision[1] == -1:
196
o_revno = other_revision[1]
197
base_revno = this_branch.common_ancestor(other_branch,
198
other_revno=o_revno)[0]
199
if base_revno is None:
200
raise UnrelatedBranches()
201
base_revision = ['.', base_revno]
202
base_branch, base_tree = get_tree(base_revision, tempdir, "base")
203
merge_inner(this_branch, other_tree, base_tree, tempdir,
204
ignore_zero=ignore_zero)
206
shutil.rmtree(tempdir)
209
def generate_cset_optimized(tree_a, tree_b, inventory_a, inventory_b):
210
"""Generate a changeset, using the text_id to mark really-changed files.
211
This permits blazing comparisons when text_ids are present. It also
212
disables metadata comparison for files with identical texts.
214
for file_id in tree_a.tree.inventory:
215
if file_id not in tree_b.tree.inventory:
217
entry_a = tree_a.tree.inventory[file_id]
218
entry_b = tree_b.tree.inventory[file_id]
219
if (entry_a.kind, entry_b.kind) != ("file", "file"):
221
if None in (entry_a.text_id, entry_b.text_id):
223
if entry_a.text_id != entry_b.text_id:
225
inventory_a[abspath(tree_a.tree, file_id)].interesting = False
226
inventory_b[abspath(tree_b.tree, file_id)].interesting = False
227
cset = generate_changeset(tree_a, tree_b, inventory_a, inventory_b)
228
for entry in cset.entries.itervalues():
229
entry.metadata_change = None
233
def merge_inner(this_branch, other_tree, base_tree, tempdir,
235
this_tree = get_tree((this_branch.base, None), tempdir, "this")[1]
237
def get_inventory(tree):
238
return tree.inventory
240
inv_changes = merge_flex(this_tree, base_tree, other_tree,
241
generate_cset_optimized, get_inventory,
242
MergeConflictHandler(base_tree.root,
243
ignore_zero=ignore_zero))
246
for id, path in inv_changes.iteritems():
251
assert path.startswith('./')
253
adjust_ids.append((path, id))
254
this_branch.set_inventory(regen_inventory(this_branch, this_tree.root, adjust_ids))
257
def regen_inventory(this_branch, root, new_entries):
258
old_entries = this_branch.read_working_inventory()
261
for file_id in old_entries:
262
entry = old_entries[file_id]
263
path = old_entries.id2path(file_id)
264
new_inventory[file_id] = (path, file_id, entry.parent_id, entry.kind)
265
by_path[path] = file_id
637
base_branch, self.base_tree = self._get_tree(base_revision)
638
if base_revision[1] == -1:
639
self.base_rev_id = base_branch.last_revision()
640
elif base_revision[1] is None:
641
self.base_rev_id = _mod_revision.NULL_REVISION
643
self.base_rev_id = _mod_revision.ensure_null(
644
base_branch.get_rev_id(base_revision[1]))
645
self._maybe_fetch(base_branch, self.this_branch, self.base_rev_id)
647
def make_merger(self):
648
kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
649
'other_tree': self.other_tree,
650
'interesting_ids': self.interesting_ids,
651
'interesting_files': self.interesting_files,
652
'this_branch': self.this_branch,
654
if self.merge_type.requires_base:
655
kwargs['base_tree'] = self.base_tree
656
if self.merge_type.supports_reprocess:
657
kwargs['reprocess'] = self.reprocess
659
raise errors.BzrError(
660
"Conflict reduction is not supported for merge"
661
" type %s." % self.merge_type)
662
if self.merge_type.supports_show_base:
663
kwargs['show_base'] = self.show_base
665
raise errors.BzrError("Showing base is not supported for this"
666
" merge type. %s" % self.merge_type)
667
if (not getattr(self.merge_type, 'supports_reverse_cherrypick', True)
668
and not self.base_is_other_ancestor):
669
raise errors.CannotReverseCherrypick()
670
if self.merge_type.supports_cherrypick:
671
kwargs['cherrypick'] = (not self.base_is_ancestor or
672
not self.base_is_other_ancestor)
673
if self._is_criss_cross and getattr(self.merge_type,
674
'supports_lca_trees', False):
675
kwargs['lca_trees'] = self._lca_trees
676
return self.merge_type(pb=None,
677
change_reporter=self.change_reporter,
680
def _do_merge_to(self):
681
merge = self.make_merger()
682
if self.other_branch is not None:
683
self.other_branch.update_references(self.this_branch)
685
if self.recurse == 'down':
686
for relpath, file_id in self.this_tree.iter_references():
687
sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
688
other_revision = self.other_tree.get_reference_revision(
690
if other_revision == sub_tree.last_revision():
692
sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
693
sub_merge.merge_type = self.merge_type
694
other_branch = self.other_branch.reference_parent(file_id,
696
sub_merge.set_other_revision(other_revision, other_branch)
697
base_revision = self.base_tree.get_reference_revision(file_id)
698
sub_merge.base_tree = \
699
sub_tree.branch.repository.revision_tree(base_revision)
700
sub_merge.base_rev_id = base_revision
705
operation = cleanup.OperationWithCleanups(self._do_merge_to)
706
self.this_tree.lock_tree_write()
707
operation.add_cleanup(self.this_tree.unlock)
708
if self.base_tree is not None:
709
self.base_tree.lock_read()
710
operation.add_cleanup(self.base_tree.unlock)
711
if self.other_tree is not None:
712
self.other_tree.lock_read()
713
operation.add_cleanup(self.other_tree.unlock)
714
merge = operation.run_simple()
715
if len(merge.cooked_conflicts) == 0:
716
if not self.ignore_zero and not trace.is_quiet():
717
trace.note(gettext("All changes applied successfully."))
719
trace.note(gettext("%d conflicts encountered.")
720
% len(merge.cooked_conflicts))
722
return len(merge.cooked_conflicts)
725
class _InventoryNoneEntry(object):
726
"""This represents an inventory entry which *isn't there*.
728
It simplifies the merging logic if we always have an InventoryEntry, even
729
if it isn't actually present
736
symlink_target = None
739
_none_entry = _InventoryNoneEntry()
742
class Merge3Merger(object):
743
"""Three-way merger that uses the merge3 text merger"""
745
supports_reprocess = True
746
supports_show_base = True
747
history_based = False
748
supports_cherrypick = True
749
supports_reverse_cherrypick = True
750
winner_idx = {"this": 2, "other": 1, "conflict": 1}
751
supports_lca_trees = True
753
def __init__(self, working_tree, this_tree, base_tree, other_tree,
754
interesting_ids=None, reprocess=False, show_base=False,
755
pb=None, pp=None, change_reporter=None,
756
interesting_files=None, do_merge=True,
757
cherrypick=False, lca_trees=None, this_branch=None):
758
"""Initialize the merger object and perform the merge.
760
:param working_tree: The working tree to apply the merge to
761
:param this_tree: The local tree in the merge operation
762
:param base_tree: The common tree in the merge operation
763
:param other_tree: The other tree to merge changes from
764
:param this_branch: The branch associated with this_tree. Defaults to
765
this_tree.branch if not supplied.
766
:param interesting_ids: The file_ids of files that should be
767
participate in the merge. May not be combined with
769
:param: reprocess If True, perform conflict-reduction processing.
770
:param show_base: If True, show the base revision in text conflicts.
771
(incompatible with reprocess)
773
:param pp: A ProgressPhase object
774
:param change_reporter: An object that should report changes made
775
:param interesting_files: The tree-relative paths of files that should
776
participate in the merge. If these paths refer to directories,
777
the contents of those directories will also be included. May not
778
be combined with interesting_ids. If neither interesting_files nor
779
interesting_ids is specified, all files may participate in the
781
:param lca_trees: Can be set to a dictionary of {revision_id:rev_tree}
782
if the ancestry was found to include a criss-cross merge.
783
Otherwise should be None.
785
object.__init__(self)
786
if interesting_files is not None and interesting_ids is not None:
788
'specify either interesting_ids or interesting_files')
789
if this_branch is None:
790
this_branch = this_tree.branch
791
self.interesting_ids = interesting_ids
792
self.interesting_files = interesting_files
793
self.this_tree = working_tree
794
self.base_tree = base_tree
795
self.other_tree = other_tree
796
self.this_branch = this_branch
797
self._raw_conflicts = []
798
self.cooked_conflicts = []
799
self.reprocess = reprocess
800
self.show_base = show_base
801
self._lca_trees = lca_trees
802
# Uncommenting this will change the default algorithm to always use
803
# _entries_lca. This can be useful for running the test suite and
804
# making sure we haven't missed any corner cases.
805
# if lca_trees is None:
806
# self._lca_trees = [self.base_tree]
807
self.change_reporter = change_reporter
808
self.cherrypick = cherrypick
812
warnings.warn("pp argument to Merge3Merger is deprecated")
814
warnings.warn("pb argument to Merge3Merger is deprecated")
817
operation = cleanup.OperationWithCleanups(self._do_merge)
818
self.this_tree.lock_tree_write()
819
operation.add_cleanup(self.this_tree.unlock)
820
self.base_tree.lock_read()
821
operation.add_cleanup(self.base_tree.unlock)
822
self.other_tree.lock_read()
823
operation.add_cleanup(self.other_tree.unlock)
826
def _do_merge(self, operation):
827
self.tt = transform.TreeTransform(self.this_tree, None)
828
operation.add_cleanup(self.tt.finalize)
829
self._compute_transform()
830
results = self.tt.apply(no_conflicts=True)
831
self.write_modified(results)
833
self.this_tree.add_conflicts(self.cooked_conflicts)
834
except errors.UnsupportedOperation:
837
def make_preview_transform(self):
838
operation = cleanup.OperationWithCleanups(self._make_preview_transform)
839
self.base_tree.lock_read()
840
operation.add_cleanup(self.base_tree.unlock)
841
self.other_tree.lock_read()
842
operation.add_cleanup(self.other_tree.unlock)
843
return operation.run_simple()
845
def _make_preview_transform(self):
846
self.tt = transform.TransformPreview(self.this_tree)
847
self._compute_transform()
850
def _compute_transform(self):
851
if self._lca_trees is None:
852
entries = self._entries3()
853
resolver = self._three_way
855
entries = self._entries_lca()
856
resolver = self._lca_multi_way
857
child_pb = ui.ui_factory.nested_progress_bar()
859
factories = Merger.hooks['merge_file_content']
860
hooks = [factory(self) for factory in factories] + [self]
861
self.active_hooks = [hook for hook in hooks if hook is not None]
862
for num, (file_id, changed, parents3, names3,
863
executable3) in enumerate(entries):
864
child_pb.update(gettext('Preparing file merge'), num, len(entries))
865
self._merge_names(file_id, parents3, names3, resolver=resolver)
867
file_status = self._do_merge_contents(file_id)
869
file_status = 'unmodified'
870
self._merge_executable(file_id,
871
executable3, file_status, resolver=resolver)
874
self.tt.fixup_new_roots()
875
self._finish_computing_transform()
877
def _finish_computing_transform(self):
878
"""Finalize the transform and report the changes.
880
This is the second half of _compute_transform.
882
child_pb = ui.ui_factory.nested_progress_bar()
884
fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
885
lambda t, c: transform.conflict_pass(t, c, self.other_tree))
888
if self.change_reporter is not None:
889
from bzrlib import delta
890
delta.report_changes(
891
self.tt.iter_changes(), self.change_reporter)
892
self.cook_conflicts(fs_conflicts)
893
for conflict in self.cooked_conflicts:
894
trace.warning(unicode(conflict))
897
"""Gather data about files modified between three trees.
899
Return a list of tuples of file_id, changed, parents3, names3,
900
executable3. changed is a boolean indicating whether the file contents
901
or kind were changed. parents3 is a tuple of parent ids for base,
902
other and this. names3 is a tuple of names for base, other and this.
903
executable3 is a tuple of execute-bit values for base, other and this.
906
iterator = self.other_tree.iter_changes(self.base_tree,
907
specific_files=self.interesting_files,
908
extra_trees=[self.this_tree])
909
this_entries = dict((e.file_id, e) for p, e in
910
self.this_tree.iter_entries_by_dir(
911
self.interesting_ids))
912
for (file_id, paths, changed, versioned, parents, names, kind,
913
executable) in iterator:
914
if (self.interesting_ids is not None and
915
file_id not in self.interesting_ids):
917
entry = this_entries.get(file_id)
918
if entry is not None:
919
this_name = entry.name
920
this_parent = entry.parent_id
921
this_executable = entry.executable
925
this_executable = None
926
parents3 = parents + (this_parent,)
927
names3 = names + (this_name,)
928
executable3 = executable + (this_executable,)
929
result.append((file_id, changed, parents3, names3, executable3))
932
def _entries_lca(self):
933
"""Gather data about files modified between multiple trees.
935
This compares OTHER versus all LCA trees, and for interesting entries,
936
it then compares with THIS and BASE.
938
For the multi-valued entries, the format will be (BASE, [lca1, lca2])
940
:return: [(file_id, changed, parents, names, executable)], where:
942
* file_id: Simple file_id of the entry
943
* changed: Boolean, True if the kind or contents changed else False
944
* parents: ((base, [parent_id, in, lcas]), parent_id_other,
946
* names: ((base, [name, in, lcas]), name_in_other, name_in_this)
947
* executable: ((base, [exec, in, lcas]), exec_in_other,
950
if self.interesting_files is not None:
951
lookup_trees = [self.this_tree, self.base_tree]
952
lookup_trees.extend(self._lca_trees)
953
# I think we should include the lca trees as well
954
interesting_ids = self.other_tree.paths2ids(self.interesting_files,
957
interesting_ids = self.interesting_ids
959
walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
961
base_inventory = self.base_tree.inventory
962
this_inventory = self.this_tree.inventory
963
for path, file_id, other_ie, lca_values in walker.iter_all():
964
# Is this modified at all from any of the other trees?
966
other_ie = _none_entry
967
if interesting_ids is not None and file_id not in interesting_ids:
970
# If other_revision is found in any of the lcas, that means this
971
# node is uninteresting. This is because when merging, if there are
972
# multiple heads(), we have to create a new node. So if we didn't,
973
# we know that the ancestry is linear, and that OTHER did not
975
# See doc/developers/lca_merge_resolution.txt for details
976
other_revision = other_ie.revision
977
if other_revision is not None:
978
# We can't use this shortcut when other_revision is None,
979
# because it may be None because things are WorkingTrees, and
980
# not because it is *actually* None.
981
is_unmodified = False
982
for lca_path, ie in lca_values:
983
if ie is not None and ie.revision == other_revision:
990
for lca_path, lca_ie in lca_values:
992
lca_entries.append(_none_entry)
994
lca_entries.append(lca_ie)
996
if base_inventory.has_id(file_id):
997
base_ie = base_inventory[file_id]
999
base_ie = _none_entry
1001
if this_inventory.has_id(file_id):
1002
this_ie = this_inventory[file_id]
1004
this_ie = _none_entry
1010
for lca_ie in lca_entries:
1011
lca_kinds.append(lca_ie.kind)
1012
lca_parent_ids.append(lca_ie.parent_id)
1013
lca_names.append(lca_ie.name)
1014
lca_executable.append(lca_ie.executable)
1016
kind_winner = self._lca_multi_way(
1017
(base_ie.kind, lca_kinds),
1018
other_ie.kind, this_ie.kind)
1019
parent_id_winner = self._lca_multi_way(
1020
(base_ie.parent_id, lca_parent_ids),
1021
other_ie.parent_id, this_ie.parent_id)
1022
name_winner = self._lca_multi_way(
1023
(base_ie.name, lca_names),
1024
other_ie.name, this_ie.name)
1026
content_changed = True
1027
if kind_winner == 'this':
1028
# No kind change in OTHER, see if there are *any* changes
1029
if other_ie.kind == 'directory':
1030
if parent_id_winner == 'this' and name_winner == 'this':
1031
# No change for this directory in OTHER, skip
1033
content_changed = False
1034
elif other_ie.kind is None or other_ie.kind == 'file':
1035
def get_sha1(ie, tree):
1036
if ie.kind != 'file':
1038
return tree.get_file_sha1(file_id)
1039
base_sha1 = get_sha1(base_ie, self.base_tree)
1040
lca_sha1s = [get_sha1(ie, tree) for ie, tree
1041
in zip(lca_entries, self._lca_trees)]
1042
this_sha1 = get_sha1(this_ie, self.this_tree)
1043
other_sha1 = get_sha1(other_ie, self.other_tree)
1044
sha1_winner = self._lca_multi_way(
1045
(base_sha1, lca_sha1s), other_sha1, this_sha1,
1046
allow_overriding_lca=False)
1047
exec_winner = self._lca_multi_way(
1048
(base_ie.executable, lca_executable),
1049
other_ie.executable, this_ie.executable)
1050
if (parent_id_winner == 'this' and name_winner == 'this'
1051
and sha1_winner == 'this' and exec_winner == 'this'):
1052
# No kind, parent, name, exec, or content change for
1053
# OTHER, so this node is not considered interesting
1055
if sha1_winner == 'this':
1056
content_changed = False
1057
elif other_ie.kind == 'symlink':
1058
def get_target(ie, tree):
1059
if ie.kind != 'symlink':
1061
return tree.get_symlink_target(file_id)
1062
base_target = get_target(base_ie, self.base_tree)
1063
lca_targets = [get_target(ie, tree) for ie, tree
1064
in zip(lca_entries, self._lca_trees)]
1065
this_target = get_target(this_ie, self.this_tree)
1066
other_target = get_target(other_ie, self.other_tree)
1067
target_winner = self._lca_multi_way(
1068
(base_target, lca_targets),
1069
other_target, this_target)
1070
if (parent_id_winner == 'this' and name_winner == 'this'
1071
and target_winner == 'this'):
1072
# No kind, parent, name, or symlink target change
1075
if target_winner == 'this':
1076
content_changed = False
1077
elif other_ie.kind == 'tree-reference':
1078
# The 'changed' information seems to be handled at a higher
1079
# level. At least, _entries3 returns False for content
1080
# changed, even when at a new revision_id.
1081
content_changed = False
1082
if (parent_id_winner == 'this' and name_winner == 'this'):
1083
# Nothing interesting
1086
raise AssertionError('unhandled kind: %s' % other_ie.kind)
1088
# If we have gotten this far, that means something has changed
1089
result.append((file_id, content_changed,
1090
((base_ie.parent_id, lca_parent_ids),
1091
other_ie.parent_id, this_ie.parent_id),
1092
((base_ie.name, lca_names),
1093
other_ie.name, this_ie.name),
1094
((base_ie.executable, lca_executable),
1095
other_ie.executable, this_ie.executable)
1099
@deprecated_method(deprecated_in((2, 4, 0)))
1101
if self.tt.final_kind(self.tt.root) is None:
1102
self.tt.cancel_deletion(self.tt.root)
1103
if self.tt.final_file_id(self.tt.root) is None:
1104
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
1106
other_root_file_id = self.other_tree.get_root_id()
1107
if other_root_file_id is None:
1109
other_root = self.tt.trans_id_file_id(other_root_file_id)
1110
if other_root == self.tt.root:
1112
if self.this_tree.inventory.has_id(
1113
self.other_tree.inventory.root.file_id):
1114
# the other tree's root is a non-root in the current tree (as
1115
# when a previously unrelated branch is merged into another)
1117
if self.tt.final_kind(other_root) is not None:
1118
other_root_is_present = True
1120
# other_root doesn't have a physical representation. We still need
1121
# to move any references to the actual root of the tree.
1122
other_root_is_present = False
1123
# 'other_tree.inventory.root' is not present in this tree. We are
1124
# calling adjust_path for children which *want* to be present with a
1125
# correct place to go.
1126
for _, child in self.other_tree.inventory.root.children.iteritems():
1127
trans_id = self.tt.trans_id_file_id(child.file_id)
1128
if not other_root_is_present:
1129
if self.tt.final_kind(trans_id) is not None:
1130
# The item exist in the final tree and has a defined place
1133
# Move the item into the root
1135
final_name = self.tt.final_name(trans_id)
1136
except errors.NoFinalPath:
1137
# This file is not present anymore, ignore it.
1139
self.tt.adjust_path(final_name, self.tt.root, trans_id)
1140
if other_root_is_present:
1141
self.tt.cancel_creation(other_root)
1142
self.tt.cancel_versioning(other_root)
1144
def write_modified(self, results):
1145
modified_hashes = {}
1146
for path in results.modified_paths:
1147
file_id = self.this_tree.path2id(self.this_tree.relpath(path))
1150
hash = self.this_tree.get_file_sha1(file_id)
1153
modified_hashes[file_id] = hash
1154
self.this_tree.set_merge_modified(modified_hashes)
1157
def parent(entry, file_id):
1158
"""Determine the parent for a file_id (used as a key method)"""
1161
return entry.parent_id
1164
def name(entry, file_id):
1165
"""Determine the name for a file_id (used as a key method)"""
1171
def contents_sha1(tree, file_id):
1172
"""Determine the sha1 of the file contents (used as a key method)."""
1173
if not tree.has_id(file_id):
1175
return tree.get_file_sha1(file_id)
1178
def executable(tree, file_id):
1179
"""Determine the executability of a file-id (used as a key method)."""
1180
if not tree.has_id(file_id):
1182
if tree.kind(file_id) != "file":
1184
return tree.is_executable(file_id)
1187
def kind(tree, file_id):
1188
"""Determine the kind of a file-id (used as a key method)."""
1189
if not tree.has_id(file_id):
1191
return tree.kind(file_id)
1194
def _three_way(base, other, this):
1196
# if 'base == other', either they all agree, or only 'this' has
1199
elif this not in (base, other):
1200
# 'this' is neither 'base' nor 'other', so both sides changed
1203
# "Ambiguous clean merge" -- both sides have made the same change.
1206
# this == base: only other has changed.
1210
def _lca_multi_way(bases, other, this, allow_overriding_lca=True):
1211
"""Consider LCAs when determining whether a change has occurred.
1213
If LCAS are all identical, this is the same as a _three_way comparison.
1215
:param bases: value in (BASE, [LCAS])
1216
:param other: value in OTHER
1217
:param this: value in THIS
1218
:param allow_overriding_lca: If there is more than one unique lca
1219
value, allow OTHER to override THIS if it has a new value, and
1220
THIS only has an lca value, or vice versa. This is appropriate for
1221
truly scalar values, not as much for non-scalars.
1222
:return: 'this', 'other', or 'conflict' depending on whether an entry
1225
# See doc/developers/lca_tree_merging.txt for details about this
1228
# Either Ambiguously clean, or nothing was actually changed. We
1231
base_val, lca_vals = bases
1232
# Remove 'base_val' from the lca_vals, because it is not interesting
1233
filtered_lca_vals = [lca_val for lca_val in lca_vals
1234
if lca_val != base_val]
1235
if len(filtered_lca_vals) == 0:
1236
return Merge3Merger._three_way(base_val, other, this)
1238
unique_lca_vals = set(filtered_lca_vals)
1239
if len(unique_lca_vals) == 1:
1240
return Merge3Merger._three_way(unique_lca_vals.pop(), other, this)
1242
if allow_overriding_lca:
1243
if other in unique_lca_vals:
1244
if this in unique_lca_vals:
1245
# Each side picked a different lca, conflict
1248
# This has a value which supersedes both lca values, and
1249
# other only has an lca value
1251
elif this in unique_lca_vals:
1252
# OTHER has a value which supersedes both lca values, and this
1253
# only has an lca value
1256
# At this point, the lcas disagree, and the tip disagree
1260
@deprecated_method(deprecated_in((2, 2, 0)))
1261
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
1262
"""Do a three-way test on a scalar.
1263
Return "this", "other" or "conflict", depending whether a value wins.
1265
key_base = key(base_tree, file_id)
1266
key_other = key(other_tree, file_id)
1267
#if base == other, either they all agree, or only THIS has changed.
1268
if key_base == key_other:
1270
key_this = key(this_tree, file_id)
1271
# "Ambiguous clean merge"
1272
if key_this == key_other:
1274
elif key_this == key_base:
1279
def merge_names(self, file_id):
1280
def get_entry(tree):
1281
if tree.has_id(file_id):
1282
return tree.inventory[file_id]
1285
this_entry = get_entry(self.this_tree)
1286
other_entry = get_entry(self.other_tree)
1287
base_entry = get_entry(self.base_tree)
1288
entries = (base_entry, other_entry, this_entry)
1291
for entry in entries:
1294
parents.append(None)
1296
names.append(entry.name)
1297
parents.append(entry.parent_id)
1298
return self._merge_names(file_id, parents, names,
1299
resolver=self._three_way)
1301
def _merge_names(self, file_id, parents, names, resolver):
1302
"""Perform a merge on file_id names and parents"""
1303
base_name, other_name, this_name = names
1304
base_parent, other_parent, this_parent = parents
1306
name_winner = resolver(*names)
1308
parent_id_winner = resolver(*parents)
1309
if this_name is None:
1310
if name_winner == "this":
1311
name_winner = "other"
1312
if parent_id_winner == "this":
1313
parent_id_winner = "other"
1314
if name_winner == "this" and parent_id_winner == "this":
1316
if name_winner == 'conflict' or parent_id_winner == 'conflict':
1317
# Creating helpers (.OTHER or .THIS) here cause problems down the
1318
# road if a ContentConflict needs to be created so we should not do
1320
trans_id = self.tt.trans_id_file_id(file_id)
1321
self._raw_conflicts.append(('path conflict', trans_id, file_id,
1322
this_parent, this_name,
1323
other_parent, other_name))
1324
if not self.other_tree.has_id(file_id):
1325
# it doesn't matter whether the result was 'other' or
1326
# 'conflict'-- if it has no file id, we leave it alone.
1328
parent_id = parents[self.winner_idx[parent_id_winner]]
1329
name = names[self.winner_idx[name_winner]]
1330
if parent_id is not None or name is not None:
1331
# if we get here, name_winner and parent_winner are set to safe
1333
if parent_id is None and name is not None:
1334
# if parent_id is None and name is non-None, current file is
1336
if names[self.winner_idx[parent_id_winner]] != '':
1337
raise AssertionError(
1338
'File looks like a root, but named %s' %
1339
names[self.winner_idx[parent_id_winner]])
1340
parent_trans_id = transform.ROOT_PARENT
1342
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1343
self.tt.adjust_path(name, parent_trans_id,
1344
self.tt.trans_id_file_id(file_id))
1346
def _do_merge_contents(self, file_id):
1347
"""Performs a merge on file_id contents."""
1348
def contents_pair(tree):
1349
if not tree.has_id(file_id):
1351
kind = tree.kind(file_id)
1353
contents = tree.get_file_sha1(file_id)
1354
elif kind == "symlink":
1355
contents = tree.get_symlink_target(file_id)
1358
return kind, contents
1360
# See SPOT run. run, SPOT, run.
1361
# So we're not QUITE repeating ourselves; we do tricky things with
1363
base_pair = contents_pair(self.base_tree)
1364
other_pair = contents_pair(self.other_tree)
1366
this_pair = contents_pair(self.this_tree)
1367
lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
1368
winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
1369
this_pair, allow_overriding_lca=False)
1371
if base_pair == other_pair:
1374
# We delayed evaluating this_pair as long as we can to avoid
1375
# unnecessary sha1 calculation
1376
this_pair = contents_pair(self.this_tree)
1377
winner = self._three_way(base_pair, other_pair, this_pair)
1378
if winner == 'this':
1379
# No interesting changes introduced by OTHER
1381
# We have a hypothetical conflict, but if we have files, then we
1382
# can try to merge the content
1383
trans_id = self.tt.trans_id_file_id(file_id)
1384
params = MergeHookParams(self, file_id, trans_id, this_pair[0],
1385
other_pair[0], winner)
1386
hooks = self.active_hooks
1387
hook_status = 'not_applicable'
1389
hook_status, lines = hook.merge_contents(params)
1390
if hook_status != 'not_applicable':
1391
# Don't try any more hooks, this one applies.
1393
# If the merge ends up replacing the content of the file, we get rid of
1394
# it at the end of this method (this variable is used to track the
1395
# exceptions to this rule).
1398
if hook_status == 'not_applicable':
1399
# No merge hook was able to resolve the situation. Two cases exist:
1400
# a content conflict or a duplicate one.
1402
name = self.tt.final_name(trans_id)
1403
parent_id = self.tt.final_parent(trans_id)
1405
inhibit_content_conflict = False
1406
if params.this_kind is None: # file_id is not in THIS
1407
# Is the name used for a different file_id ?
1408
dupe_path = self.other_tree.id2path(file_id)
1409
this_id = self.this_tree.path2id(dupe_path)
1410
if this_id is not None:
1411
# Two entries for the same path
1413
# versioning the merged file will trigger a duplicate
1415
self.tt.version_file(file_id, trans_id)
1416
transform.create_from_tree(
1417
self.tt, trans_id, self.other_tree, file_id,
1418
filter_tree_path=self._get_filter_tree_path(file_id))
1419
inhibit_content_conflict = True
1420
elif params.other_kind is None: # file_id is not in OTHER
1421
# Is the name used for a different file_id ?
1422
dupe_path = self.this_tree.id2path(file_id)
1423
other_id = self.other_tree.path2id(dupe_path)
1424
if other_id is not None:
1425
# Two entries for the same path again, but here, the other
1426
# entry will also be merged. We simply inhibit the
1427
# 'content' conflict creation because we know OTHER will
1428
# create (or has already created depending on ordering) an
1429
# entry at the same path. This will trigger a 'duplicate'
1432
inhibit_content_conflict = True
1433
if not inhibit_content_conflict:
1434
if params.this_kind is not None:
1435
self.tt.unversion_file(trans_id)
1436
# This is a contents conflict, because none of the available
1437
# functions could merge it.
1438
file_group = self._dump_conflicts(name, parent_id, file_id,
1440
self._raw_conflicts.append(('contents conflict', file_group))
1441
elif hook_status == 'success':
1442
self.tt.create_file(lines, trans_id)
1443
elif hook_status == 'conflicted':
1444
# XXX: perhaps the hook should be able to provide
1445
# the BASE/THIS/OTHER files?
1446
self.tt.create_file(lines, trans_id)
1447
self._raw_conflicts.append(('text conflict', trans_id))
1448
name = self.tt.final_name(trans_id)
1449
parent_id = self.tt.final_parent(trans_id)
1450
self._dump_conflicts(name, parent_id, file_id)
1451
elif hook_status == 'delete':
1452
self.tt.unversion_file(trans_id)
1454
elif hook_status == 'done':
1455
# The hook function did whatever it needs to do directly, no
1456
# further action needed here.
1459
raise AssertionError('unknown hook_status: %r' % (hook_status,))
1460
if not self.this_tree.has_id(file_id) and result == "modified":
1461
self.tt.version_file(file_id, trans_id)
1463
# The merge has been performed and produced a new content, so the
1464
# old contents should not be retained.
1465
self.tt.delete_contents(trans_id)
1468
def _default_other_winner_merge(self, merge_hook_params):
1469
"""Replace this contents with other."""
1470
file_id = merge_hook_params.file_id
1471
trans_id = merge_hook_params.trans_id
1472
if self.other_tree.has_id(file_id):
1473
# OTHER changed the file
1474
transform.create_from_tree(
1475
self.tt, trans_id, self.other_tree, file_id,
1476
filter_tree_path=self._get_filter_tree_path(file_id))
1478
elif self.this_tree.has_id(file_id):
1479
# OTHER deleted the file
1480
return 'delete', None
1482
raise AssertionError(
1483
'winner is OTHER, but file_id %r not in THIS or OTHER tree'
1486
def merge_contents(self, merge_hook_params):
1487
"""Fallback merge logic after user installed hooks."""
1488
# This function is used in merge hooks as the fallback instance.
1489
# Perhaps making this function and the functions it calls be a
1490
# a separate class would be better.
1491
if merge_hook_params.winner == 'other':
1492
# OTHER is a straight winner, so replace this contents with other
1493
return self._default_other_winner_merge(merge_hook_params)
1494
elif merge_hook_params.is_file_merge():
1495
# THIS and OTHER are both files, so text merge. Either
1496
# BASE is a file, or both converted to files, so at least we
1497
# have agreement that output should be a file.
1499
self.text_merge(merge_hook_params.file_id,
1500
merge_hook_params.trans_id)
1501
except errors.BinaryFile:
1502
return 'not_applicable', None
1505
return 'not_applicable', None
1507
def get_lines(self, tree, file_id):
1508
"""Return the lines in a file, or an empty list."""
1509
if tree.has_id(file_id):
1510
return tree.get_file_lines(file_id)
1514
def text_merge(self, file_id, trans_id):
1515
"""Perform a three-way text merge on a file_id"""
1516
# it's possible that we got here with base as a different type.
1517
# if so, we just want two-way text conflicts.
1518
if self.base_tree.has_id(file_id) and \
1519
self.base_tree.kind(file_id) == "file":
1520
base_lines = self.get_lines(self.base_tree, file_id)
1523
other_lines = self.get_lines(self.other_tree, file_id)
1524
this_lines = self.get_lines(self.this_tree, file_id)
1525
m3 = merge3.Merge3(base_lines, this_lines, other_lines,
1526
is_cherrypick=self.cherrypick)
1527
start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
1528
if self.show_base is True:
1529
base_marker = '|' * 7
1533
def iter_merge3(retval):
1534
retval["text_conflicts"] = False
1535
for line in m3.merge_lines(name_a = "TREE",
1536
name_b = "MERGE-SOURCE",
1537
name_base = "BASE-REVISION",
1538
start_marker=start_marker,
1539
base_marker=base_marker,
1540
reprocess=self.reprocess):
1541
if line.startswith(start_marker):
1542
retval["text_conflicts"] = True
1543
yield line.replace(start_marker, '<' * 7)
1547
merge3_iterator = iter_merge3(retval)
1548
self.tt.create_file(merge3_iterator, trans_id)
1549
if retval["text_conflicts"] is True:
1550
self._raw_conflicts.append(('text conflict', trans_id))
1551
name = self.tt.final_name(trans_id)
1552
parent_id = self.tt.final_parent(trans_id)
1553
file_group = self._dump_conflicts(name, parent_id, file_id,
1554
this_lines, base_lines,
1556
file_group.append(trans_id)
1559
def _get_filter_tree_path(self, file_id):
1560
if self.this_tree.supports_content_filtering():
1561
# We get the path from the working tree if it exists.
1562
# That fails though when OTHER is adding a file, so
1563
# we fall back to the other tree to find the path if
1564
# it doesn't exist locally.
1566
return self.this_tree.id2path(file_id)
1567
except errors.NoSuchId:
1568
return self.other_tree.id2path(file_id)
1569
# Skip the id2path lookup for older formats
1572
def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
1573
base_lines=None, other_lines=None, set_version=False,
1575
"""Emit conflict files.
1576
If this_lines, base_lines, or other_lines are omitted, they will be
1577
determined automatically. If set_version is true, the .OTHER, .THIS
1578
or .BASE (in that order) will be created as versioned files.
1580
data = [('OTHER', self.other_tree, other_lines),
1581
('THIS', self.this_tree, this_lines)]
1583
data.append(('BASE', self.base_tree, base_lines))
1585
# We need to use the actual path in the working tree of the file here,
1586
# ignoring the conflict suffixes
1588
if wt.supports_content_filtering():
1590
filter_tree_path = wt.id2path(file_id)
1591
except errors.NoSuchId:
1592
# file has been deleted
1593
filter_tree_path = None
1595
# Skip the id2path lookup for older formats
1596
filter_tree_path = None
1600
for suffix, tree, lines in data:
1601
if tree.has_id(file_id):
1602
trans_id = self._conflict_file(name, parent_id, tree, file_id,
1603
suffix, lines, filter_tree_path)
1604
file_group.append(trans_id)
1605
if set_version and not versioned:
1606
self.tt.version_file(file_id, trans_id)
1610
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1611
lines=None, filter_tree_path=None):
1612
"""Emit a single conflict file."""
1613
name = name + '.' + suffix
1614
trans_id = self.tt.create_path(name, parent_id)
1615
transform.create_from_tree(self.tt, trans_id, tree, file_id, lines,
1619
def merge_executable(self, file_id, file_status):
1620
"""Perform a merge on the execute bit."""
1621
executable = [self.executable(t, file_id) for t in (self.base_tree,
1622
self.other_tree, self.this_tree)]
1623
self._merge_executable(file_id, executable, file_status,
1624
resolver=self._three_way)
1626
def _merge_executable(self, file_id, executable, file_status,
1628
"""Perform a merge on the execute bit."""
1629
base_executable, other_executable, this_executable = executable
1630
if file_status == "deleted":
1632
winner = resolver(*executable)
1633
if winner == "conflict":
1634
# There must be a None in here, if we have a conflict, but we
1635
# need executability since file status was not deleted.
1636
if self.executable(self.other_tree, file_id) is None:
1640
if winner == 'this' and file_status != "modified":
1642
trans_id = self.tt.trans_id_file_id(file_id)
1643
if self.tt.final_kind(trans_id) != "file":
1645
if winner == "this":
1646
executability = this_executable
1648
if self.other_tree.has_id(file_id):
1649
executability = other_executable
1650
elif self.this_tree.has_id(file_id):
1651
executability = this_executable
1652
elif self.base_tree_has_id(file_id):
1653
executability = base_executable
1654
if executability is not None:
1655
trans_id = self.tt.trans_id_file_id(file_id)
1656
self.tt.set_executability(executability, trans_id)
1658
def cook_conflicts(self, fs_conflicts):
1659
"""Convert all conflicts into a form that doesn't depend on trans_id"""
1660
content_conflict_file_ids = set()
1661
cooked_conflicts = transform.cook_conflicts(fs_conflicts, self.tt)
1662
fp = transform.FinalPaths(self.tt)
1663
for conflict in self._raw_conflicts:
1664
conflict_type = conflict[0]
1665
if conflict_type == 'path conflict':
1667
this_parent, this_name,
1668
other_parent, other_name) = conflict[1:]
1669
if this_parent is None or this_name is None:
1670
this_path = '<deleted>'
1672
parent_path = fp.get_path(
1673
self.tt.trans_id_file_id(this_parent))
1674
this_path = osutils.pathjoin(parent_path, this_name)
1675
if other_parent is None or other_name is None:
1676
other_path = '<deleted>'
1678
if other_parent == self.other_tree.get_root_id():
1679
# The tree transform doesn't know about the other root,
1680
# so we special case here to avoid a NoFinalPath
1684
parent_path = fp.get_path(
1685
self.tt.trans_id_file_id(other_parent))
1686
other_path = osutils.pathjoin(parent_path, other_name)
1687
c = _mod_conflicts.Conflict.factory(
1688
'path conflict', path=this_path,
1689
conflict_path=other_path,
1691
elif conflict_type == 'contents conflict':
1692
for trans_id in conflict[1]:
1693
file_id = self.tt.final_file_id(trans_id)
1694
if file_id is not None:
1695
# Ok we found the relevant file-id
1697
path = fp.get_path(trans_id)
1698
for suffix in ('.BASE', '.THIS', '.OTHER'):
1699
if path.endswith(suffix):
1700
# Here is the raw path
1701
path = path[:-len(suffix)]
1703
c = _mod_conflicts.Conflict.factory(conflict_type,
1704
path=path, file_id=file_id)
1705
content_conflict_file_ids.add(file_id)
1706
elif conflict_type == 'text conflict':
1707
trans_id = conflict[1]
1708
path = fp.get_path(trans_id)
1709
file_id = self.tt.final_file_id(trans_id)
1710
c = _mod_conflicts.Conflict.factory(conflict_type,
1711
path=path, file_id=file_id)
1713
raise AssertionError('bad conflict type: %r' % (conflict,))
1714
cooked_conflicts.append(c)
1716
self.cooked_conflicts = []
1717
# We want to get rid of path conflicts when a corresponding contents
1718
# conflict exists. This can occur when one branch deletes a file while
1719
# the other renames *and* modifies it. In this case, the content
1720
# conflict is enough.
1721
for c in cooked_conflicts:
1722
if (c.typestring == 'path conflict'
1723
and c.file_id in content_conflict_file_ids):
1725
self.cooked_conflicts.append(c)
1726
self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
1729
class WeaveMerger(Merge3Merger):
1730
"""Three-way tree merger, text weave merger."""
1731
supports_reprocess = True
1732
supports_show_base = False
1733
supports_reverse_cherrypick = False
1734
history_based = True
1736
def _generate_merge_plan(self, file_id, base):
1737
return self.this_tree.plan_file_merge(file_id, self.other_tree,
1740
def _merged_lines(self, file_id):
1741
"""Generate the merged lines.
1742
There is no distinction between lines that are meant to contain <<<<<<<
1746
base = self.base_tree
1749
plan = self._generate_merge_plan(file_id, base)
1750
if 'merge' in debug.debug_flags:
1752
trans_id = self.tt.trans_id_file_id(file_id)
1753
name = self.tt.final_name(trans_id) + '.plan'
1754
contents = ('%11s|%s' % l for l in plan)
1755
self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1756
textmerge = versionedfile.PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1757
'>>>>>>> MERGE-SOURCE\n')
1758
lines, conflicts = textmerge.merge_lines(self.reprocess)
1760
base_lines = textmerge.base_from_plan()
1763
return lines, base_lines
1765
def text_merge(self, file_id, trans_id):
1766
"""Perform a (weave) text merge for a given file and file-id.
1767
If conflicts are encountered, .THIS and .OTHER files will be emitted,
1768
and a conflict will be noted.
1770
lines, base_lines = self._merged_lines(file_id)
1772
# Note we're checking whether the OUTPUT is binary in this case,
1773
# because we don't want to get into weave merge guts.
1774
textfile.check_text_lines(lines)
1775
self.tt.create_file(lines, trans_id)
1776
if base_lines is not None:
1778
self._raw_conflicts.append(('text conflict', trans_id))
1779
name = self.tt.final_name(trans_id)
1780
parent_id = self.tt.final_parent(trans_id)
1781
file_group = self._dump_conflicts(name, parent_id, file_id,
1783
base_lines=base_lines)
1784
file_group.append(trans_id)
1787
class LCAMerger(WeaveMerger):
1789
def _generate_merge_plan(self, file_id, base):
1790
return self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
1793
class Diff3Merger(Merge3Merger):
1794
"""Three-way merger using external diff3 for text merging"""
1796
def dump_file(self, temp_dir, name, tree, file_id):
1797
out_path = osutils.pathjoin(temp_dir, name)
1798
out_file = open(out_path, "wb")
1800
in_file = tree.get_file(file_id)
1801
for line in in_file:
1802
out_file.write(line)
1807
def text_merge(self, file_id, trans_id):
1808
"""Perform a diff3 merge using a specified file-id and trans-id.
1809
If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
1810
will be dumped, and a will be conflict noted.
1813
temp_dir = osutils.mkdtemp(prefix="bzr-")
1815
new_file = osutils.pathjoin(temp_dir, "new")
1816
this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
1817
base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
1818
other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
1819
status = bzrlib.patch.diff3(new_file, this, base, other)
1820
if status not in (0, 1):
1821
raise errors.BzrError("Unhandled diff3 exit code")
1822
f = open(new_file, 'rb')
1824
self.tt.create_file(f, trans_id)
1828
name = self.tt.final_name(trans_id)
1829
parent_id = self.tt.final_parent(trans_id)
1830
self._dump_conflicts(name, parent_id, file_id)
1831
self._raw_conflicts.append(('text conflict', trans_id))
1833
osutils.rmtree(temp_dir)
1836
class PathNotInTree(errors.BzrError):
1838
_fmt = """Merge-into failed because %(tree)s does not contain %(path)s."""
1840
def __init__(self, path, tree):
1841
errors.BzrError.__init__(self, path=path, tree=tree)
1844
class MergeIntoMerger(Merger):
1845
"""Merger that understands other_tree will be merged into a subdir.
1847
This also changes the Merger api so that it uses real Branch, revision_id,
1848
and RevisonTree objects, rather than using revision specs.
1851
def __init__(self, this_tree, other_branch, other_tree, target_subdir,
1852
source_subpath, other_rev_id=None):
1853
"""Create a new MergeIntoMerger object.
1855
source_subpath in other_tree will be effectively copied to
1856
target_subdir in this_tree.
1858
:param this_tree: The tree that we will be merging into.
1859
:param other_branch: The Branch we will be merging from.
1860
:param other_tree: The RevisionTree object we want to merge.
1861
:param target_subdir: The relative path where we want to merge
1862
other_tree into this_tree
1863
:param source_subpath: The relative path specifying the subtree of
1864
other_tree to merge into this_tree.
1866
# It is assumed that we are merging a tree that is not in our current
1867
# ancestry, which means we are using the "EmptyTree" as our basis.
1868
null_ancestor_tree = this_tree.branch.repository.revision_tree(
1869
_mod_revision.NULL_REVISION)
1870
super(MergeIntoMerger, self).__init__(
1871
this_branch=this_tree.branch,
1872
this_tree=this_tree,
1873
other_tree=other_tree,
1874
base_tree=null_ancestor_tree,
1876
self._target_subdir = target_subdir
1877
self._source_subpath = source_subpath
1878
self.other_branch = other_branch
1879
if other_rev_id is None:
1880
other_rev_id = other_tree.get_revision_id()
1881
self.other_rev_id = self.other_basis = other_rev_id
1882
self.base_is_ancestor = True
1883
self.backup_files = True
1884
self.merge_type = Merge3Merger
1885
self.show_base = False
1886
self.reprocess = False
1887
self.interesting_ids = None
1888
self.merge_type = _MergeTypeParameterizer(MergeIntoMergeType,
1889
target_subdir=self._target_subdir,
1890
source_subpath=self._source_subpath)
1891
if self._source_subpath != '':
1892
# If this isn't a partial merge make sure the revisions will be
1894
self._maybe_fetch(self.other_branch, self.this_branch,
1897
def set_pending(self):
1898
if self._source_subpath != '':
1900
Merger.set_pending(self)
1903
class _MergeTypeParameterizer(object):
1904
"""Wrap a merge-type class to provide extra parameters.
270
for path, file_id in new_entries:
272
del new_inventory[file_id]
275
new_path_list.append((path, file_id))
276
if file_id not in old_entries:
278
# Ensure no file is added before its parent
280
for path, file_id in new_path_list:
284
parent = by_path[os.path.dirname(path)]
285
kind = bzrlib.osutils.file_kind(os.path.join(root, path))
286
new_inventory[file_id] = (path, file_id, parent, kind)
287
by_path[path] = file_id
289
# Get a list in insertion order
290
new_inventory_list = new_inventory.values()
291
mutter ("""Inventory regeneration:
292
old length: %i insertions: %i deletions: %i new_length: %i"""\
293
% (len(old_entries), insertions, deletions, len(new_inventory_list)))
294
assert len(new_inventory_list) == len(old_entries) + insertions - deletions
295
new_inventory_list.sort()
296
return new_inventory_list
1906
This is hack used by MergeIntoMerger to pass some extra parameters to its
1907
merge_type. Merger.do_merge() sets up its own set of parameters to pass to
1908
the 'merge_type' member. It is difficult override do_merge without
1909
re-writing the whole thing, so instead we create a wrapper which will pass
1910
the extra parameters.
1913
def __init__(self, merge_type, **kwargs):
1914
self._extra_kwargs = kwargs
1915
self._merge_type = merge_type
1917
def __call__(self, *args, **kwargs):
1918
kwargs.update(self._extra_kwargs)
1919
return self._merge_type(*args, **kwargs)
1921
def __getattr__(self, name):
1922
return getattr(self._merge_type, name)
1925
class MergeIntoMergeType(Merge3Merger):
1926
"""Merger that incorporates a tree (or part of a tree) into another."""
1928
def __init__(self, *args, **kwargs):
1929
"""Initialize the merger object.
1931
:param args: See Merge3Merger.__init__'s args.
1932
:param kwargs: See Merge3Merger.__init__'s keyword args, except for
1933
source_subpath and target_subdir.
1934
:keyword source_subpath: The relative path specifying the subtree of
1935
other_tree to merge into this_tree.
1936
:keyword target_subdir: The relative path where we want to merge
1937
other_tree into this_tree
1939
# All of the interesting work happens during Merge3Merger.__init__(),
1940
# so we have have to hack in to get our extra parameters set.
1941
self._source_subpath = kwargs.pop('source_subpath')
1942
self._target_subdir = kwargs.pop('target_subdir')
1943
super(MergeIntoMergeType, self).__init__(*args, **kwargs)
1945
def _compute_transform(self):
1946
child_pb = ui.ui_factory.nested_progress_bar()
1948
entries = self._entries_to_incorporate()
1949
entries = list(entries)
1950
for num, (entry, parent_id) in enumerate(entries):
1951
child_pb.update(gettext('Preparing file merge'), num, len(entries))
1952
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1953
trans_id = transform.new_by_entry(self.tt, entry,
1954
parent_trans_id, self.other_tree)
1957
self._finish_computing_transform()
1959
def _entries_to_incorporate(self):
1960
"""Yields pairs of (inventory_entry, new_parent)."""
1961
other_inv = self.other_tree.inventory
1962
subdir_id = other_inv.path2id(self._source_subpath)
1963
if subdir_id is None:
1964
# XXX: The error would be clearer if it gave the URL of the source
1965
# branch, but we don't have a reference to that here.
1966
raise PathNotInTree(self._source_subpath, "Source tree")
1967
subdir = other_inv[subdir_id]
1968
parent_in_target = osutils.dirname(self._target_subdir)
1969
target_id = self.this_tree.inventory.path2id(parent_in_target)
1970
if target_id is None:
1971
raise PathNotInTree(self._target_subdir, "Target tree")
1972
name_in_target = osutils.basename(self._target_subdir)
1973
merge_into_root = subdir.copy()
1974
merge_into_root.name = name_in_target
1975
if self.this_tree.inventory.has_id(merge_into_root.file_id):
1976
# Give the root a new file-id.
1977
# This can happen fairly easily if the directory we are
1978
# incorporating is the root, and both trees have 'TREE_ROOT' as
1979
# their root_id. Users will expect this to Just Work, so we
1980
# change the file-id here.
1981
# Non-root file-ids could potentially conflict too. That's really
1982
# an edge case, so we don't do anything special for those. We let
1983
# them cause conflicts.
1984
merge_into_root.file_id = generate_ids.gen_file_id(name_in_target)
1985
yield (merge_into_root, target_id)
1986
if subdir.kind != 'directory':
1987
# No children, so we are done.
1989
for ignored_path, entry in other_inv.iter_entries_by_dir(subdir_id):
1990
parent_id = entry.parent_id
1991
if parent_id == subdir.file_id:
1992
# The root's parent ID has changed, so make sure children of
1993
# the root refer to the new ID.
1994
parent_id = merge_into_root.file_id
1995
yield (entry, parent_id)
1998
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
2000
merge_type=Merge3Merger,
2001
interesting_ids=None,
2005
interesting_files=None,
2008
change_reporter=None):
2009
"""Primary interface for merging.
2011
Typical use is probably::
2013
merge_inner(branch, branch.get_revision_tree(other_revision),
2014
branch.get_revision_tree(base_revision))
2016
if this_tree is None:
2017
raise errors.BzrError("bzrlib.merge.merge_inner requires a this_tree "
2019
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
2020
pb=pb, change_reporter=change_reporter)
2021
merger.backup_files = backup_files
2022
merger.merge_type = merge_type
2023
merger.interesting_ids = interesting_ids
2024
merger.ignore_zero = ignore_zero
2025
if interesting_files:
2027
raise ValueError('Only supply interesting_ids'
2028
' or interesting_files')
2029
merger.interesting_files = interesting_files
2030
merger.show_base = show_base
2031
merger.reprocess = reprocess
2032
merger.other_rev_id = other_rev_id
2033
merger.other_basis = other_rev_id
2034
get_revision_id = getattr(base_tree, 'get_revision_id', None)
2035
if get_revision_id is None:
2036
get_revision_id = base_tree.last_revision
2037
merger.cache_trees_with_revision_ids([other_tree, base_tree, this_tree])
2038
merger.set_base_revision(get_revision_id(), this_branch)
2039
return merger.do_merge()
2041
def get_merge_type_registry():
2042
"""Merge type registry is in bzrlib.option to avoid circular imports.
2044
This method provides a sanctioned way to retrieve it.
2046
from bzrlib import option
2047
return option._merge_type_registry
2050
def _plan_annotate_merge(annotated_a, annotated_b, ancestors_a, ancestors_b):
2051
def status_a(revision, text):
2052
if revision in ancestors_b:
2053
return 'killed-b', text
2055
return 'new-a', text
2057
def status_b(revision, text):
2058
if revision in ancestors_a:
2059
return 'killed-a', text
2061
return 'new-b', text
2063
plain_a = [t for (a, t) in annotated_a]
2064
plain_b = [t for (a, t) in annotated_b]
2065
matcher = patiencediff.PatienceSequenceMatcher(None, plain_a, plain_b)
2066
blocks = matcher.get_matching_blocks()
2069
for ai, bi, l in blocks:
2070
# process all mismatched sections
2071
# (last mismatched section is handled because blocks always
2072
# includes a 0-length last block)
2073
for revision, text in annotated_a[a_cur:ai]:
2074
yield status_a(revision, text)
2075
for revision, text in annotated_b[b_cur:bi]:
2076
yield status_b(revision, text)
2077
# and now the matched section
2080
for text_a in plain_a[ai:a_cur]:
2081
yield "unchanged", text_a
2084
class _PlanMergeBase(object):
2086
def __init__(self, a_rev, b_rev, vf, key_prefix):
2089
:param a_rev: Revision-id of one revision to merge
2090
:param b_rev: Revision-id of the other revision to merge
2091
:param vf: A VersionedFiles containing both revisions
2092
:param key_prefix: A prefix for accessing keys in vf, typically
2098
self._last_lines = None
2099
self._last_lines_revision_id = None
2100
self._cached_matching_blocks = {}
2101
self._key_prefix = key_prefix
2102
self._precache_tip_lines()
2104
def _precache_tip_lines(self):
2105
lines = self.get_lines([self.a_rev, self.b_rev])
2106
self.lines_a = lines[self.a_rev]
2107
self.lines_b = lines[self.b_rev]
2109
def get_lines(self, revisions):
2110
"""Get lines for revisions from the backing VersionedFiles.
2112
:raises RevisionNotPresent: on absent texts.
2114
keys = [(self._key_prefix + (rev,)) for rev in revisions]
2116
for record in self.vf.get_record_stream(keys, 'unordered', True):
2117
if record.storage_kind == 'absent':
2118
raise errors.RevisionNotPresent(record.key, self.vf)
2119
result[record.key[-1]] = osutils.chunks_to_lines(
2120
record.get_bytes_as('chunked'))
2123
def plan_merge(self):
2124
"""Generate a 'plan' for merging the two revisions.
2126
This involves comparing their texts and determining the cause of
2127
differences. If text A has a line and text B does not, then either the
2128
line was added to text A, or it was deleted from B. Once the causes
2129
are combined, they are written out in the format described in
2130
VersionedFile.plan_merge
2132
blocks = self._get_matching_blocks(self.a_rev, self.b_rev)
2133
unique_a, unique_b = self._unique_lines(blocks)
2134
new_a, killed_b = self._determine_status(self.a_rev, unique_a)
2135
new_b, killed_a = self._determine_status(self.b_rev, unique_b)
2136
return self._iter_plan(blocks, new_a, killed_b, new_b, killed_a)
2138
def _iter_plan(self, blocks, new_a, killed_b, new_b, killed_a):
2141
for i, j, n in blocks:
2142
for a_index in range(last_i, i):
2143
if a_index in new_a:
2144
if a_index in killed_b:
2145
yield 'conflicted-a', self.lines_a[a_index]
2147
yield 'new-a', self.lines_a[a_index]
2149
yield 'killed-b', self.lines_a[a_index]
2150
for b_index in range(last_j, j):
2151
if b_index in new_b:
2152
if b_index in killed_a:
2153
yield 'conflicted-b', self.lines_b[b_index]
2155
yield 'new-b', self.lines_b[b_index]
2157
yield 'killed-a', self.lines_b[b_index]
2158
# handle common lines
2159
for a_index in range(i, i+n):
2160
yield 'unchanged', self.lines_a[a_index]
2164
def _get_matching_blocks(self, left_revision, right_revision):
2165
"""Return a description of which sections of two revisions match.
2167
See SequenceMatcher.get_matching_blocks
2169
cached = self._cached_matching_blocks.get((left_revision,
2171
if cached is not None:
2173
if self._last_lines_revision_id == left_revision:
2174
left_lines = self._last_lines
2175
right_lines = self.get_lines([right_revision])[right_revision]
2177
lines = self.get_lines([left_revision, right_revision])
2178
left_lines = lines[left_revision]
2179
right_lines = lines[right_revision]
2180
self._last_lines = right_lines
2181
self._last_lines_revision_id = right_revision
2182
matcher = patiencediff.PatienceSequenceMatcher(None, left_lines,
2184
return matcher.get_matching_blocks()
2186
def _unique_lines(self, matching_blocks):
2187
"""Analyse matching_blocks to determine which lines are unique
2189
:return: a tuple of (unique_left, unique_right), where the values are
2190
sets of line numbers of unique lines.
2196
for i, j, n in matching_blocks:
2197
unique_left.extend(range(last_i, i))
2198
unique_right.extend(range(last_j, j))
2201
return unique_left, unique_right
2204
def _subtract_plans(old_plan, new_plan):
2205
"""Remove changes from new_plan that came from old_plan.
2207
It is assumed that the difference between the old_plan and new_plan
2208
is their choice of 'b' text.
2210
All lines from new_plan that differ from old_plan are emitted
2211
verbatim. All lines from new_plan that match old_plan but are
2212
not about the 'b' revision are emitted verbatim.
2214
Lines that match and are about the 'b' revision are the lines we
2215
don't want, so we convert 'killed-b' -> 'unchanged', and 'new-b'
2216
is skipped entirely.
2218
matcher = patiencediff.PatienceSequenceMatcher(None, old_plan,
2221
for i, j, n in matcher.get_matching_blocks():
2222
for jj in range(last_j, j):
2224
for jj in range(j, j+n):
2225
plan_line = new_plan[jj]
2226
if plan_line[0] == 'new-b':
2228
elif plan_line[0] == 'killed-b':
2229
yield 'unchanged', plan_line[1]
2235
class _PlanMerge(_PlanMergeBase):
2236
"""Plan an annotate merge using on-the-fly annotation"""
2238
def __init__(self, a_rev, b_rev, vf, key_prefix):
2239
super(_PlanMerge, self).__init__(a_rev, b_rev, vf, key_prefix)
2240
self.a_key = self._key_prefix + (self.a_rev,)
2241
self.b_key = self._key_prefix + (self.b_rev,)
2242
self.graph = _mod_graph.Graph(self.vf)
2243
heads = self.graph.heads((self.a_key, self.b_key))
2245
# one side dominates, so we can just return its values, yay for
2247
# Ideally we would know that before we get this far
2248
self._head_key = heads.pop()
2249
if self._head_key == self.a_key:
2253
trace.mutter('found dominating revision for %s\n%s > %s', self.vf,
2254
self._head_key[-1], other)
2257
self._head_key = None
2260
def _precache_tip_lines(self):
2261
# Turn this into a no-op, because we will do this later
2264
def _find_recursive_lcas(self):
2265
"""Find all the ancestors back to a unique lca"""
2266
cur_ancestors = (self.a_key, self.b_key)
2267
# graph.find_lca(uncommon, keys) now returns plain NULL_REVISION,
2268
# rather than a key tuple. We will just map that directly to no common
2272
next_lcas = self.graph.find_lca(*cur_ancestors)
2273
# Map a plain NULL_REVISION to a simple no-ancestors
2274
if next_lcas == set([_mod_revision.NULL_REVISION]):
2276
# Order the lca's based on when they were merged into the tip
2277
# While the actual merge portion of weave merge uses a set() of
2278
# active revisions, the order of insertion *does* effect the
2279
# implicit ordering of the texts.
2280
for rev_key in cur_ancestors:
2281
ordered_parents = tuple(self.graph.find_merge_order(rev_key,
2283
parent_map[rev_key] = ordered_parents
2284
if len(next_lcas) == 0:
2286
elif len(next_lcas) == 1:
2287
parent_map[list(next_lcas)[0]] = ()
2289
elif len(next_lcas) > 2:
2290
# More than 2 lca's, fall back to grabbing all nodes between
2291
# this and the unique lca.
2292
trace.mutter('More than 2 LCAs, falling back to all nodes for:'
2294
self.a_key, self.b_key, cur_ancestors)
2295
cur_lcas = next_lcas
2296
while len(cur_lcas) > 1:
2297
cur_lcas = self.graph.find_lca(*cur_lcas)
2298
if len(cur_lcas) == 0:
2299
# No common base to find, use the full ancestry
2302
unique_lca = list(cur_lcas)[0]
2303
if unique_lca == _mod_revision.NULL_REVISION:
2304
# find_lca will return a plain 'NULL_REVISION' rather
2305
# than a key tuple when there is no common ancestor, we
2306
# prefer to just use None, because it doesn't confuse
2307
# _get_interesting_texts()
2309
parent_map.update(self._find_unique_parents(next_lcas,
2312
cur_ancestors = next_lcas
2315
def _find_unique_parents(self, tip_keys, base_key):
2316
"""Find ancestors of tip that aren't ancestors of base.
2318
:param tip_keys: Nodes that are interesting
2319
:param base_key: Cull all ancestors of this node
2320
:return: The parent map for all revisions between tip_keys and
2321
base_key. base_key will be included. References to nodes outside of
2322
the ancestor set will also be removed.
2324
# TODO: this would be simpler if find_unique_ancestors took a list
2325
# instead of a single tip, internally it supports it, but it
2326
# isn't a "backwards compatible" api change.
2327
if base_key is None:
2328
parent_map = dict(self.graph.iter_ancestry(tip_keys))
2329
# We remove NULL_REVISION because it isn't a proper tuple key, and
2330
# thus confuses things like _get_interesting_texts, and our logic
2331
# to add the texts into the memory weave.
2332
if _mod_revision.NULL_REVISION in parent_map:
2333
parent_map.pop(_mod_revision.NULL_REVISION)
2336
for tip in tip_keys:
2338
self.graph.find_unique_ancestors(tip, [base_key]))
2339
parent_map = self.graph.get_parent_map(interesting)
2340
parent_map[base_key] = ()
2341
culled_parent_map, child_map, tails = self._remove_external_references(
2343
# Remove all the tails but base_key
2344
if base_key is not None:
2345
tails.remove(base_key)
2346
self._prune_tails(culled_parent_map, child_map, tails)
2347
# Now remove all the uninteresting 'linear' regions
2348
simple_map = _mod_graph.collapse_linear_regions(culled_parent_map)
2352
def _remove_external_references(parent_map):
2353
"""Remove references that go outside of the parent map.
2355
:param parent_map: Something returned from Graph.get_parent_map(keys)
2356
:return: (filtered_parent_map, child_map, tails)
2357
filtered_parent_map is parent_map without external references
2358
child_map is the {parent_key: [child_keys]} mapping
2359
tails is a list of nodes that do not have any parents in the map
2361
# TODO: The basic effect of this function seems more generic than
2362
# _PlanMerge. But the specific details of building a child_map,
2363
# and computing tails seems very specific to _PlanMerge.
2364
# Still, should this be in Graph land?
2365
filtered_parent_map = {}
2368
for key, parent_keys in parent_map.iteritems():
2369
culled_parent_keys = [p for p in parent_keys if p in parent_map]
2370
if not culled_parent_keys:
2372
for parent_key in culled_parent_keys:
2373
child_map.setdefault(parent_key, []).append(key)
2374
# TODO: Do we want to do this, it adds overhead for every node,
2375
# just to say that the node has no children
2376
child_map.setdefault(key, [])
2377
filtered_parent_map[key] = culled_parent_keys
2378
return filtered_parent_map, child_map, tails
2381
def _prune_tails(parent_map, child_map, tails_to_remove):
2382
"""Remove tails from the parent map.
2384
This will remove the supplied revisions until no more children have 0
2387
:param parent_map: A dict of {child: [parents]}, this dictionary will
2388
be modified in place.
2389
:param tails_to_remove: A list of tips that should be removed,
2390
this list will be consumed
2391
:param child_map: The reverse dict of parent_map ({parent: [children]})
2392
this dict will be modified
2393
:return: None, parent_map will be modified in place.
2395
while tails_to_remove:
2396
next = tails_to_remove.pop()
2397
parent_map.pop(next)
2398
children = child_map.pop(next)
2399
for child in children:
2400
child_parents = parent_map[child]
2401
child_parents.remove(next)
2402
if len(child_parents) == 0:
2403
tails_to_remove.append(child)
2405
def _get_interesting_texts(self, parent_map):
2406
"""Return a dict of texts we are interested in.
2408
Note that the input is in key tuples, but the output is in plain
2411
:param parent_map: The output from _find_recursive_lcas
2412
:return: A dict of {'revision_id':lines} as returned by
2413
_PlanMergeBase.get_lines()
2415
all_revision_keys = set(parent_map)
2416
all_revision_keys.add(self.a_key)
2417
all_revision_keys.add(self.b_key)
2419
# Everything else is in 'keys' but get_lines is in 'revision_ids'
2420
all_texts = self.get_lines([k[-1] for k in all_revision_keys])
2423
def _build_weave(self):
2424
from bzrlib import weave
2425
self._weave = weave.Weave(weave_name='in_memory_weave',
2426
allow_reserved=True)
2427
parent_map = self._find_recursive_lcas()
2429
all_texts = self._get_interesting_texts(parent_map)
2431
# Note: Unfortunately, the order given by topo_sort will effect the
2432
# ordering resolution in the output. Specifically, if you add A then B,
2433
# then in the output text A lines will show up before B lines. And, of
2434
# course, topo_sort doesn't guarantee any real ordering.
2435
# So we use merge_sort, and add a fake node on the tip.
2436
# This ensures that left-hand parents will always be inserted into the
2437
# weave before right-hand parents.
2438
tip_key = self._key_prefix + (_mod_revision.CURRENT_REVISION,)
2439
parent_map[tip_key] = (self.a_key, self.b_key)
2441
for seq_num, key, depth, eom in reversed(tsort.merge_sort(parent_map,
2445
# for key in tsort.topo_sort(parent_map):
2446
parent_keys = parent_map[key]
2447
revision_id = key[-1]
2448
parent_ids = [k[-1] for k in parent_keys]
2449
self._weave.add_lines(revision_id, parent_ids,
2450
all_texts[revision_id])
2452
def plan_merge(self):
2453
"""Generate a 'plan' for merging the two revisions.
2455
This involves comparing their texts and determining the cause of
2456
differences. If text A has a line and text B does not, then either the
2457
line was added to text A, or it was deleted from B. Once the causes
2458
are combined, they are written out in the format described in
2459
VersionedFile.plan_merge
2461
if self._head_key is not None: # There was a single head
2462
if self._head_key == self.a_key:
2465
if self._head_key != self.b_key:
2466
raise AssertionError('There was an invalid head: %s != %s'
2467
% (self.b_key, self._head_key))
2469
head_rev = self._head_key[-1]
2470
lines = self.get_lines([head_rev])[head_rev]
2471
return ((plan, line) for line in lines)
2472
return self._weave.plan_merge(self.a_rev, self.b_rev)
2475
class _PlanLCAMerge(_PlanMergeBase):
2477
This merge algorithm differs from _PlanMerge in that:
2479
1. comparisons are done against LCAs only
2480
2. cases where a contested line is new versus one LCA but old versus
2481
another are marked as conflicts, by emitting the line as conflicted-a
2484
This is faster, and hopefully produces more useful output.
2487
def __init__(self, a_rev, b_rev, vf, key_prefix, graph):
2488
_PlanMergeBase.__init__(self, a_rev, b_rev, vf, key_prefix)
2489
lcas = graph.find_lca(key_prefix + (a_rev,), key_prefix + (b_rev,))
2492
if lca == _mod_revision.NULL_REVISION:
2495
self.lcas.add(lca[-1])
2496
for lca in self.lcas:
2497
if _mod_revision.is_null(lca):
2500
lca_lines = self.get_lines([lca])[lca]
2501
matcher = patiencediff.PatienceSequenceMatcher(None, self.lines_a,
2503
blocks = list(matcher.get_matching_blocks())
2504
self._cached_matching_blocks[(a_rev, lca)] = blocks
2505
matcher = patiencediff.PatienceSequenceMatcher(None, self.lines_b,
2507
blocks = list(matcher.get_matching_blocks())
2508
self._cached_matching_blocks[(b_rev, lca)] = blocks
2510
def _determine_status(self, revision_id, unique_line_numbers):
2511
"""Determines the status unique lines versus all lcas.
2513
Basically, determines why the line is unique to this revision.
2515
A line may be determined new, killed, or both.
2517
If a line is determined new, that means it was not present in at least
2518
one LCA, and is not present in the other merge revision.
2520
If a line is determined killed, that means the line was present in
2523
If a line is killed and new, this indicates that the two merge
2524
revisions contain differing conflict resolutions.
2526
:param revision_id: The id of the revision in which the lines are
2528
:param unique_line_numbers: The line numbers of unique lines.
2529
:return: a tuple of (new_this, killed_other)
2533
unique_line_numbers = set(unique_line_numbers)
2534
for lca in self.lcas:
2535
blocks = self._get_matching_blocks(revision_id, lca)
2536
unique_vs_lca, _ignored = self._unique_lines(blocks)
2537
new.update(unique_line_numbers.intersection(unique_vs_lca))
2538
killed.update(unique_line_numbers.difference(unique_vs_lca))
added
removed
bzrlib/merge.py
