13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
from itertools import chain
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(), """
23
21
from bzrlib import (
22
branch as _mod_branch,
24
conflicts as _mod_conflicts,
26
27
graph as _mod_graph,
30
31
revision as _mod_revision,
33
from bzrlib.branch import Branch
34
from bzrlib.conflicts import ConflictList, Conflict
35
from bzrlib.errors import (BzrCommandError,
45
WorkingTreeNotRevision,
48
from bzrlib.graph import Graph
49
from bzrlib.merge3 import Merge3
50
from bzrlib.osutils import rename, pathjoin
51
from progress import DummyProgress, ProgressPhase
52
from bzrlib.revision import (NULL_REVISION, ensure_null)
53
from bzrlib.textfile import check_text_lines
54
from bzrlib.trace import mutter, warning, note, is_quiet
55
from bzrlib.transform import (TransformPreview, TreeTransform,
56
resolve_conflicts, cook_conflicts,
57
conflict_pass, FinalPaths, create_by_entry,
58
unique_add, ROOT_PARENT)
59
from bzrlib.versionedfile import PlanWeaveMerge
47
from bzrlib.symbol_versioning import (
62
51
# TODO: Report back as changes are merged in
65
54
def transform_tree(from_tree, to_tree, interesting_ids=None):
66
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
67
interesting_ids=interesting_ids, this_tree=from_tree)
55
from_tree.lock_tree_write()
56
operation = cleanup.OperationWithCleanups(merge_inner)
57
operation.add_cleanup(from_tree.unlock)
58
operation.run_simple(from_tree.branch, to_tree, from_tree,
59
ignore_zero=True, interesting_ids=interesting_ids, this_tree=from_tree)
62
class MergeHooks(hooks.Hooks):
65
hooks.Hooks.__init__(self, "bzrlib.merge", "Merger.hooks")
66
self.add_hook('merge_file_content',
67
"Called with a bzrlib.merge.Merger object to create a per file "
68
"merge object when starting a merge. "
69
"Should return either None or a subclass of "
70
"``bzrlib.merge.AbstractPerFileMerger``. "
71
"Such objects will then be called per file "
72
"that needs to be merged (including when one "
73
"side has deleted the file and the other has changed it). "
74
"See the AbstractPerFileMerger API docs for details on how it is "
79
class AbstractPerFileMerger(object):
80
"""PerFileMerger objects are used by plugins extending merge for bzrlib.
82
See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
84
:ivar merger: The Merge3Merger performing the merge.
87
def __init__(self, merger):
88
"""Create a PerFileMerger for use with merger."""
91
def merge_contents(self, merge_params):
92
"""Attempt to merge the contents of a single file.
94
:param merge_params: A bzrlib.merge.MergeHookParams
95
:return: A tuple of (status, chunks), where status is one of
96
'not_applicable', 'success', 'conflicted', or 'delete'. If status
97
is 'success' or 'conflicted', then chunks should be an iterable of
98
strings for the new file contents.
100
return ('not applicable', None)
103
class PerFileMerger(AbstractPerFileMerger):
104
"""Merge individual files when self.file_matches returns True.
106
This class is intended to be subclassed. The file_matches and
107
merge_matching methods should be overridden with concrete implementations.
110
def file_matches(self, params):
111
"""Return True if merge_matching should be called on this file.
113
Only called with merges of plain files with no clear winner.
115
Subclasses must override this.
117
raise NotImplementedError(self.file_matches)
119
def get_filename(self, params, tree):
120
"""Lookup the filename (i.e. basename, not path), given a Tree (e.g.
121
self.merger.this_tree) and a MergeHookParams.
123
return osutils.basename(tree.id2path(params.file_id))
125
def get_filepath(self, params, tree):
126
"""Calculate the path to the file in a tree.
128
:param params: A MergeHookParams describing the file to merge
129
:param tree: a Tree, e.g. self.merger.this_tree.
131
return tree.id2path(params.file_id)
133
def merge_contents(self, params):
134
"""Merge the contents of a single file."""
135
# Check whether this custom merge logic should be used.
137
# OTHER is a straight winner, rely on default merge.
138
params.winner == 'other' or
139
# THIS and OTHER aren't both files.
140
not params.is_file_merge() or
141
# The filename doesn't match *.xml
142
not self.file_matches(params)):
143
return 'not_applicable', None
144
return self.merge_matching(params)
146
def merge_matching(self, params):
147
"""Merge the contents of a single file that has matched the criteria
148
in PerFileMerger.merge_contents (is a conflict, is a file,
149
self.file_matches is True).
151
Subclasses must override this.
153
raise NotImplementedError(self.merge_matching)
156
class ConfigurableFileMerger(PerFileMerger):
157
"""Merge individual files when configured via a .conf file.
159
This is a base class for concrete custom file merging logic. Concrete
160
classes should implement ``merge_text``.
162
See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
164
:ivar affected_files: The configured file paths to merge.
166
:cvar name_prefix: The prefix to use when looking up configuration
167
details. <name_prefix>_merge_files describes the files targeted by the
170
:cvar default_files: The default file paths to merge when no configuration
177
def __init__(self, merger):
178
super(ConfigurableFileMerger, self).__init__(merger)
179
self.affected_files = None
180
self.default_files = self.__class__.default_files or []
181
self.name_prefix = self.__class__.name_prefix
182
if self.name_prefix is None:
183
raise ValueError("name_prefix must be set.")
185
def file_matches(self, params):
186
"""Check whether the file should call the merge hook.
188
<name_prefix>_merge_files configuration variable is a list of files
189
that should use the hook.
191
affected_files = self.affected_files
192
if affected_files is None:
193
config = self.merger.this_branch.get_config()
194
# Until bzr provides a better policy for caching the config, we
195
# just add the part we're interested in to the params to avoid
196
# reading the config files repeatedly (bazaar.conf, location.conf,
198
config_key = self.name_prefix + '_merge_files'
199
affected_files = config.get_user_option_as_list(config_key)
200
if affected_files is None:
201
# If nothing was specified in the config, use the default.
202
affected_files = self.default_files
203
self.affected_files = affected_files
205
filepath = self.get_filepath(params, self.merger.this_tree)
206
if filepath in affected_files:
210
def merge_matching(self, params):
211
return self.merge_text(params)
213
def merge_text(self, params):
214
"""Merge the byte contents of a single file.
216
This is called after checking that the merge should be performed in
217
merge_contents, and it should behave as per
218
``bzrlib.merge.AbstractPerFileMerger.merge_contents``.
220
raise NotImplementedError(self.merge_text)
223
class MergeHookParams(object):
224
"""Object holding parameters passed to merge_file_content hooks.
226
There are some fields hooks can access:
228
:ivar file_id: the file ID of the file being merged
229
:ivar trans_id: the transform ID for the merge of this file
230
:ivar this_kind: kind of file_id in 'this' tree
231
:ivar other_kind: kind of file_id in 'other' tree
232
:ivar winner: one of 'this', 'other', 'conflict'
235
def __init__(self, merger, file_id, trans_id, this_kind, other_kind,
237
self._merger = merger
238
self.file_id = file_id
239
self.trans_id = trans_id
240
self.this_kind = this_kind
241
self.other_kind = other_kind
244
def is_file_merge(self):
245
"""True if this_kind and other_kind are both 'file'."""
246
return self.this_kind == 'file' and self.other_kind == 'file'
248
@decorators.cachedproperty
249
def base_lines(self):
250
"""The lines of the 'base' version of the file."""
251
return self._merger.get_lines(self._merger.base_tree, self.file_id)
253
@decorators.cachedproperty
254
def this_lines(self):
255
"""The lines of the 'this' version of the file."""
256
return self._merger.get_lines(self._merger.this_tree, self.file_id)
258
@decorators.cachedproperty
259
def other_lines(self):
260
"""The lines of the 'other' version of the file."""
261
return self._merger.get_lines(self._merger.other_tree, self.file_id)
70
264
class Merger(object):
71
268
def __init__(self, this_branch, other_tree=None, base_tree=None,
72
this_tree=None, pb=DummyProgress(), change_reporter=None,
269
this_tree=None, pb=None, change_reporter=None,
73
270
recurse='down', revision_graph=None):
74
271
object.__init__(self)
75
272
self.this_branch = this_branch
231
451
if self.other_rev_id is None:
232
452
other_basis_tree = self.revision_tree(self.other_basis)
233
changes = other_basis_tree.changes_from(self.other_tree)
234
if changes.has_changed():
235
raise WorkingTreeNotRevision(self.this_tree)
453
if other_basis_tree.has_changes(self.other_tree):
454
raise errors.WorkingTreeNotRevision(self.this_tree)
236
455
other_rev_id = self.other_basis
237
456
self.other_tree = other_basis_tree
458
@deprecated_method(deprecated_in((2, 1, 0)))
239
459
def file_revisions(self, file_id):
240
460
self.ensure_revision_trees()
241
def get_id(tree, file_id):
242
revision_id = tree.inventory[file_id].revision
244
461
if self.this_rev_id is None:
245
462
if self.this_basis_tree.get_file_sha1(file_id) != \
246
463
self.this_tree.get_file_sha1(file_id):
247
raise WorkingTreeNotRevision(self.this_tree)
464
raise errors.WorkingTreeNotRevision(self.this_tree)
249
466
trees = (self.this_basis_tree, self.other_tree)
250
return [get_id(tree, file_id) for tree in trees]
467
return [tree.get_file_revision(file_id) for tree in trees]
469
@deprecated_method(deprecated_in((2, 1, 0)))
252
470
def check_basis(self, check_clean, require_commits=True):
253
471
if self.this_basis is None and require_commits is True:
254
raise BzrCommandError("This branch has no commits."
255
" (perhaps you would prefer 'bzr pull')")
472
raise errors.BzrCommandError(
473
"This branch has no commits."
474
" (perhaps you would prefer 'bzr pull')")
257
476
self.compare_basis()
258
477
if self.this_basis != self.this_rev_id:
259
478
raise errors.UncommittedChanges(self.this_tree)
480
@deprecated_method(deprecated_in((2, 1, 0)))
261
481
def compare_basis(self):
263
483
basis_tree = self.revision_tree(self.this_tree.last_revision())
264
484
except errors.NoSuchRevision:
265
485
basis_tree = self.this_tree.basis_tree()
266
changes = self.this_tree.changes_from(basis_tree)
267
if not changes.has_changed():
486
if not self.this_tree.has_changes(basis_tree):
268
487
self.this_rev_id = self.this_basis
270
489
def set_interesting_files(self, file_list):
271
490
self.interesting_files = file_list
273
492
def set_pending(self):
274
if not self.base_is_ancestor or not self.base_is_other_ancestor or self.other_rev_id is None:
493
if (not self.base_is_ancestor or not self.base_is_other_ancestor
494
or self.other_rev_id is None):
276
496
self._add_parent()
278
498
def _add_parent(self):
279
499
new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
280
500
new_parent_trees = []
501
operation = cleanup.OperationWithCleanups(
502
self.this_tree.set_parent_trees)
281
503
for revision_id in new_parents:
283
505
tree = self.revision_tree(revision_id)
349
566
target.fetch(source, revision_id)
351
568
def find_base(self):
352
revisions = [ensure_null(self.this_basis),
353
ensure_null(self.other_basis)]
354
if NULL_REVISION in revisions:
355
self.base_rev_id = NULL_REVISION
569
revisions = [_mod_revision.ensure_null(self.this_basis),
570
_mod_revision.ensure_null(self.other_basis)]
571
if _mod_revision.NULL_REVISION in revisions:
572
self.base_rev_id = _mod_revision.NULL_REVISION
573
self.base_tree = self.revision_tree(self.base_rev_id)
574
self._is_criss_cross = False
357
self.base_rev_id, steps = self.revision_graph.find_unique_lca(
358
revisions[0], revisions[1], count_steps=True)
359
if self.base_rev_id == NULL_REVISION:
360
raise UnrelatedBranches()
362
warning('Warning: criss-cross merge encountered. See bzr'
363
' help criss-cross.')
364
self.base_tree = self.revision_tree(self.base_rev_id)
576
lcas = self.revision_graph.find_lca(revisions[0], revisions[1])
577
self._is_criss_cross = False
579
self.base_rev_id = _mod_revision.NULL_REVISION
581
self.base_rev_id = list(lcas)[0]
582
else: # len(lcas) > 1
583
self._is_criss_cross = True
585
# find_unique_lca can only handle 2 nodes, so we have to
586
# start back at the beginning. It is a shame to traverse
587
# the graph again, but better than re-implementing
589
self.base_rev_id = self.revision_graph.find_unique_lca(
590
revisions[0], revisions[1])
592
self.base_rev_id = self.revision_graph.find_unique_lca(
594
sorted_lca_keys = self.revision_graph.find_merge_order(
596
if self.base_rev_id == _mod_revision.NULL_REVISION:
597
self.base_rev_id = sorted_lca_keys[0]
599
if self.base_rev_id == _mod_revision.NULL_REVISION:
600
raise errors.UnrelatedBranches()
601
if self._is_criss_cross:
602
trace.warning('Warning: criss-cross merge encountered. See bzr'
603
' help criss-cross.')
604
trace.mutter('Criss-cross lcas: %r' % lcas)
605
if self.base_rev_id in lcas:
606
trace.mutter('Unable to find unique lca. '
607
'Fallback %r as best option.' % self.base_rev_id)
608
interesting_revision_ids = set(lcas)
609
interesting_revision_ids.add(self.base_rev_id)
610
interesting_trees = dict((t.get_revision_id(), t)
611
for t in self.this_branch.repository.revision_trees(
612
interesting_revision_ids))
613
self._cached_trees.update(interesting_trees)
614
if self.base_rev_id in lcas:
615
self.base_tree = interesting_trees[self.base_rev_id]
617
self.base_tree = interesting_trees.pop(self.base_rev_id)
618
self._lca_trees = [interesting_trees[key]
619
for key in sorted_lca_keys]
621
self.base_tree = self.revision_tree(self.base_rev_id)
365
622
self.base_is_ancestor = True
366
623
self.base_is_other_ancestor = True
624
trace.mutter('Base revid: %r' % self.base_rev_id)
368
626
def set_base(self, base_revision):
369
627
"""Set the base revision to use for the merge.
371
629
:param base_revision: A 2-list containing a path and revision number.
373
mutter("doing merge() with no base_revision specified")
631
trace.mutter("doing merge() with no base_revision specified")
374
632
if base_revision == [None, None]:
389
647
'other_tree': self.other_tree,
390
648
'interesting_ids': self.interesting_ids,
391
649
'interesting_files': self.interesting_files,
650
'this_branch': self.this_branch,
393
651
'do_merge': False}
394
652
if self.merge_type.requires_base:
395
653
kwargs['base_tree'] = self.base_tree
396
654
if self.merge_type.supports_reprocess:
397
655
kwargs['reprocess'] = self.reprocess
398
656
elif self.reprocess:
399
raise BzrError("Conflict reduction is not supported for merge"
400
" type %s." % self.merge_type)
657
raise errors.BzrError(
658
"Conflict reduction is not supported for merge"
659
" type %s." % self.merge_type)
401
660
if self.merge_type.supports_show_base:
402
661
kwargs['show_base'] = self.show_base
403
662
elif self.show_base:
404
raise BzrError("Showing base is not supported for this"
405
" merge type. %s" % self.merge_type)
663
raise errors.BzrError("Showing base is not supported for this"
664
" merge type. %s" % self.merge_type)
406
665
if (not getattr(self.merge_type, 'supports_reverse_cherrypick', True)
407
666
and not self.base_is_other_ancestor):
408
667
raise errors.CannotReverseCherrypick()
409
668
if self.merge_type.supports_cherrypick:
410
669
kwargs['cherrypick'] = (not self.base_is_ancestor or
411
670
not self.base_is_other_ancestor)
412
return self.merge_type(pb=self._pb,
671
if self._is_criss_cross and getattr(self.merge_type,
672
'supports_lca_trees', False):
673
kwargs['lca_trees'] = self._lca_trees
674
return self.merge_type(pb=None,
413
675
change_reporter=self.change_reporter,
678
def _do_merge_to(self):
679
merge = self.make_merger()
680
if self.other_branch is not None:
681
self.other_branch.update_references(self.this_branch)
683
if self.recurse == 'down':
684
for relpath, file_id in self.this_tree.iter_references():
685
sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
686
other_revision = self.other_tree.get_reference_revision(
688
if other_revision == sub_tree.last_revision():
690
sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
691
sub_merge.merge_type = self.merge_type
692
other_branch = self.other_branch.reference_parent(file_id, relpath)
693
sub_merge.set_other_revision(other_revision, other_branch)
694
base_revision = self.base_tree.get_reference_revision(file_id)
695
sub_merge.base_tree = \
696
sub_tree.branch.repository.revision_tree(base_revision)
697
sub_merge.base_rev_id = base_revision
416
701
def do_merge(self):
702
operation = cleanup.OperationWithCleanups(self._do_merge_to)
417
703
self.this_tree.lock_tree_write()
704
operation.add_cleanup(self.this_tree.unlock)
418
705
if self.base_tree is not None:
419
706
self.base_tree.lock_read()
707
operation.add_cleanup(self.base_tree.unlock)
420
708
if self.other_tree is not None:
421
709
self.other_tree.lock_read()
423
merge = self.make_merger()
425
if self.recurse == 'down':
426
for relpath, file_id in self.this_tree.iter_references():
427
sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
428
other_revision = self.other_tree.get_reference_revision(
430
if other_revision == sub_tree.last_revision():
432
sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
433
sub_merge.merge_type = self.merge_type
434
other_branch = self.other_branch.reference_parent(file_id, relpath)
435
sub_merge.set_other_revision(other_revision, other_branch)
436
base_revision = self.base_tree.get_reference_revision(file_id)
437
sub_merge.base_tree = \
438
sub_tree.branch.repository.revision_tree(base_revision)
439
sub_merge.base_rev_id = base_revision
443
if self.other_tree is not None:
444
self.other_tree.unlock()
445
if self.base_tree is not None:
446
self.base_tree.unlock()
447
self.this_tree.unlock()
710
operation.add_cleanup(self.other_tree.unlock)
711
merge = operation.run_simple()
448
712
if len(merge.cooked_conflicts) == 0:
449
if not self.ignore_zero and not is_quiet():
450
note("All changes applied successfully.")
713
if not self.ignore_zero and not trace.is_quiet():
714
trace.note("All changes applied successfully.")
452
note("%d conflicts encountered." % len(merge.cooked_conflicts))
716
trace.note("%d conflicts encountered."
717
% len(merge.cooked_conflicts))
454
719
return len(merge.cooked_conflicts)
722
class _InventoryNoneEntry(object):
723
"""This represents an inventory entry which *isn't there*.
725
It simplifies the merging logic if we always have an InventoryEntry, even
726
if it isn't actually present
733
symlink_target = None
736
_none_entry = _InventoryNoneEntry()
457
739
class Merge3Merger(object):
458
740
"""Three-way merger that uses the merge3 text merger"""
459
741
requires_base = True
463
745
supports_cherrypick = True
464
746
supports_reverse_cherrypick = True
465
747
winner_idx = {"this": 2, "other": 1, "conflict": 1}
748
supports_lca_trees = True
467
def __init__(self, working_tree, this_tree, base_tree, other_tree,
750
def __init__(self, working_tree, this_tree, base_tree, other_tree,
468
751
interesting_ids=None, reprocess=False, show_base=False,
469
pb=DummyProgress(), pp=None, change_reporter=None,
752
pb=None, pp=None, change_reporter=None,
470
753
interesting_files=None, do_merge=True,
754
cherrypick=False, lca_trees=None, this_branch=None):
472
755
"""Initialize the merger object and perform the merge.
474
757
:param working_tree: The working tree to apply the merge to
475
758
:param this_tree: The local tree in the merge operation
476
759
:param base_tree: The common tree in the merge operation
477
:param other_tree: The other other tree to merge changes from
760
:param other_tree: The other tree to merge changes from
761
:param this_branch: The branch associated with this_tree. Defaults to
762
this_tree.branch if not supplied.
478
763
:param interesting_ids: The file_ids of files that should be
479
764
participate in the merge. May not be combined with
480
765
interesting_files.
481
766
:param: reprocess If True, perform conflict-reduction processing.
482
767
:param show_base: If True, show the base revision in text conflicts.
483
768
(incompatible with reprocess)
484
:param pb: A Progress bar
485
770
:param pp: A ProgressPhase object
486
771
:param change_reporter: An object that should report changes made
487
772
:param interesting_files: The tree-relative paths of files that should
490
775
be combined with interesting_ids. If neither interesting_files nor
491
776
interesting_ids is specified, all files may participate in the
778
:param lca_trees: Can be set to a dictionary of {revision_id:rev_tree}
779
if the ancestry was found to include a criss-cross merge.
780
Otherwise should be None.
494
782
object.__init__(self)
495
783
if interesting_files is not None and interesting_ids is not None:
496
784
raise ValueError(
497
785
'specify either interesting_ids or interesting_files')
786
if this_branch is None:
787
this_branch = this_tree.branch
498
788
self.interesting_ids = interesting_ids
499
789
self.interesting_files = interesting_files
500
790
self.this_tree = working_tree
501
791
self.base_tree = base_tree
502
792
self.other_tree = other_tree
793
self.this_branch = this_branch
503
794
self._raw_conflicts = []
504
795
self.cooked_conflicts = []
505
796
self.reprocess = reprocess
506
797
self.show_base = show_base
798
self._lca_trees = lca_trees
799
# Uncommenting this will change the default algorithm to always use
800
# _entries_lca. This can be useful for running the test suite and
801
# making sure we haven't missed any corner cases.
802
# if lca_trees is None:
803
# self._lca_trees = [self.base_tree]
509
804
self.change_reporter = change_reporter
510
805
self.cherrypick = cherrypick
512
self.pp = ProgressPhase("Merge phase", 3, self.pb)
809
warnings.warn("pp argument to Merge3Merger is deprecated")
811
warnings.warn("pb argument to Merge3Merger is deprecated")
516
813
def do_merge(self):
814
operation = cleanup.OperationWithCleanups(self._do_merge)
517
815
self.this_tree.lock_tree_write()
816
operation.add_cleanup(self.this_tree.unlock)
518
817
self.base_tree.lock_read()
818
operation.add_cleanup(self.base_tree.unlock)
519
819
self.other_tree.lock_read()
520
self.tt = TreeTransform(self.this_tree, self.pb)
820
operation.add_cleanup(self.other_tree.unlock)
823
def _do_merge(self, operation):
824
self.tt = transform.TreeTransform(self.this_tree, None)
825
operation.add_cleanup(self.tt.finalize)
826
self._compute_transform()
827
results = self.tt.apply(no_conflicts=True)
828
self.write_modified(results)
523
self._compute_transform()
525
results = self.tt.apply(no_conflicts=True)
526
self.write_modified(results)
528
self.this_tree.add_conflicts(self.cooked_conflicts)
529
except UnsupportedOperation:
533
self.other_tree.unlock()
534
self.base_tree.unlock()
535
self.this_tree.unlock()
830
self.this_tree.add_conflicts(self.cooked_conflicts)
831
except errors.UnsupportedOperation:
538
834
def make_preview_transform(self):
835
operation = cleanup.OperationWithCleanups(self._make_preview_transform)
539
836
self.base_tree.lock_read()
837
operation.add_cleanup(self.base_tree.unlock)
540
838
self.other_tree.lock_read()
541
self.tt = TransformPreview(self.this_tree)
544
self._compute_transform()
547
self.other_tree.unlock()
548
self.base_tree.unlock()
839
operation.add_cleanup(self.other_tree.unlock)
840
return operation.run_simple()
842
def _make_preview_transform(self):
843
self.tt = transform.TransformPreview(self.this_tree)
844
self._compute_transform()
552
847
def _compute_transform(self):
553
entries = self._entries3()
848
if self._lca_trees is None:
849
entries = self._entries3()
850
resolver = self._three_way
852
entries = self._entries_lca()
853
resolver = self._lca_multi_way
554
854
child_pb = ui.ui_factory.nested_progress_bar()
856
factories = Merger.hooks['merge_file_content']
857
hooks = [factory(self) for factory in factories] + [self]
858
self.active_hooks = [hook for hook in hooks if hook is not None]
556
859
for num, (file_id, changed, parents3, names3,
557
860
executable3) in enumerate(entries):
558
861
child_pb.update('Preparing file merge', num, len(entries))
559
self._merge_names(file_id, parents3, names3)
862
self._merge_names(file_id, parents3, names3, resolver=resolver)
561
file_status = self.merge_contents(file_id)
864
file_status = self._do_merge_contents(file_id)
563
866
file_status = 'unmodified'
564
867
self._merge_executable(file_id,
565
executable3, file_status)
868
executable3, file_status, resolver=resolver)
567
870
child_pb.finished()
872
self._finish_computing_transform()
874
def _finish_computing_transform(self):
875
"""Finalize the transform and report the changes.
877
This is the second half of _compute_transform.
570
879
child_pb = ui.ui_factory.nested_progress_bar()
572
fs_conflicts = resolve_conflicts(self.tt, child_pb,
573
lambda t, c: conflict_pass(t, c, self.other_tree))
881
fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
882
lambda t, c: transform.conflict_pass(t, c, self.other_tree))
575
884
child_pb.finished()
576
885
if self.change_reporter is not None:
614
926
result.append((file_id, changed, parents3, names3, executable3))
929
def _entries_lca(self):
930
"""Gather data about files modified between multiple trees.
932
This compares OTHER versus all LCA trees, and for interesting entries,
933
it then compares with THIS and BASE.
935
For the multi-valued entries, the format will be (BASE, [lca1, lca2])
937
:return: [(file_id, changed, parents, names, executable)], where:
939
* file_id: Simple file_id of the entry
940
* changed: Boolean, True if the kind or contents changed else False
941
* parents: ((base, [parent_id, in, lcas]), parent_id_other,
943
* names: ((base, [name, in, lcas]), name_in_other, name_in_this)
944
* executable: ((base, [exec, in, lcas]), exec_in_other,
947
if self.interesting_files is not None:
948
lookup_trees = [self.this_tree, self.base_tree]
949
lookup_trees.extend(self._lca_trees)
950
# I think we should include the lca trees as well
951
interesting_ids = self.other_tree.paths2ids(self.interesting_files,
954
interesting_ids = self.interesting_ids
956
walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
958
base_inventory = self.base_tree.inventory
959
this_inventory = self.this_tree.inventory
960
for path, file_id, other_ie, lca_values in walker.iter_all():
961
# Is this modified at all from any of the other trees?
963
other_ie = _none_entry
964
if interesting_ids is not None and file_id not in interesting_ids:
967
# If other_revision is found in any of the lcas, that means this
968
# node is uninteresting. This is because when merging, if there are
969
# multiple heads(), we have to create a new node. So if we didn't,
970
# we know that the ancestry is linear, and that OTHER did not
972
# See doc/developers/lca_merge_resolution.txt for details
973
other_revision = other_ie.revision
974
if other_revision is not None:
975
# We can't use this shortcut when other_revision is None,
976
# because it may be None because things are WorkingTrees, and
977
# not because it is *actually* None.
978
is_unmodified = False
979
for lca_path, ie in lca_values:
980
if ie is not None and ie.revision == other_revision:
987
for lca_path, lca_ie in lca_values:
989
lca_entries.append(_none_entry)
991
lca_entries.append(lca_ie)
993
if file_id in base_inventory:
994
base_ie = base_inventory[file_id]
996
base_ie = _none_entry
998
if file_id in this_inventory:
999
this_ie = this_inventory[file_id]
1001
this_ie = _none_entry
1007
for lca_ie in lca_entries:
1008
lca_kinds.append(lca_ie.kind)
1009
lca_parent_ids.append(lca_ie.parent_id)
1010
lca_names.append(lca_ie.name)
1011
lca_executable.append(lca_ie.executable)
1013
kind_winner = self._lca_multi_way(
1014
(base_ie.kind, lca_kinds),
1015
other_ie.kind, this_ie.kind)
1016
parent_id_winner = self._lca_multi_way(
1017
(base_ie.parent_id, lca_parent_ids),
1018
other_ie.parent_id, this_ie.parent_id)
1019
name_winner = self._lca_multi_way(
1020
(base_ie.name, lca_names),
1021
other_ie.name, this_ie.name)
1023
content_changed = True
1024
if kind_winner == 'this':
1025
# No kind change in OTHER, see if there are *any* changes
1026
if other_ie.kind == 'directory':
1027
if parent_id_winner == 'this' and name_winner == 'this':
1028
# No change for this directory in OTHER, skip
1030
content_changed = False
1031
elif other_ie.kind is None or other_ie.kind == 'file':
1032
def get_sha1(ie, tree):
1033
if ie.kind != 'file':
1035
return tree.get_file_sha1(file_id)
1036
base_sha1 = get_sha1(base_ie, self.base_tree)
1037
lca_sha1s = [get_sha1(ie, tree) for ie, tree
1038
in zip(lca_entries, self._lca_trees)]
1039
this_sha1 = get_sha1(this_ie, self.this_tree)
1040
other_sha1 = get_sha1(other_ie, self.other_tree)
1041
sha1_winner = self._lca_multi_way(
1042
(base_sha1, lca_sha1s), other_sha1, this_sha1,
1043
allow_overriding_lca=False)
1044
exec_winner = self._lca_multi_way(
1045
(base_ie.executable, lca_executable),
1046
other_ie.executable, this_ie.executable)
1047
if (parent_id_winner == 'this' and name_winner == 'this'
1048
and sha1_winner == 'this' and exec_winner == 'this'):
1049
# No kind, parent, name, exec, or content change for
1050
# OTHER, so this node is not considered interesting
1052
if sha1_winner == 'this':
1053
content_changed = False
1054
elif other_ie.kind == 'symlink':
1055
def get_target(ie, tree):
1056
if ie.kind != 'symlink':
1058
return tree.get_symlink_target(file_id)
1059
base_target = get_target(base_ie, self.base_tree)
1060
lca_targets = [get_target(ie, tree) for ie, tree
1061
in zip(lca_entries, self._lca_trees)]
1062
this_target = get_target(this_ie, self.this_tree)
1063
other_target = get_target(other_ie, self.other_tree)
1064
target_winner = self._lca_multi_way(
1065
(base_target, lca_targets),
1066
other_target, this_target)
1067
if (parent_id_winner == 'this' and name_winner == 'this'
1068
and target_winner == 'this'):
1069
# No kind, parent, name, or symlink target change
1072
if target_winner == 'this':
1073
content_changed = False
1074
elif other_ie.kind == 'tree-reference':
1075
# The 'changed' information seems to be handled at a higher
1076
# level. At least, _entries3 returns False for content
1077
# changed, even when at a new revision_id.
1078
content_changed = False
1079
if (parent_id_winner == 'this' and name_winner == 'this'):
1080
# Nothing interesting
1083
raise AssertionError('unhandled kind: %s' % other_ie.kind)
1085
# If we have gotten this far, that means something has changed
1086
result.append((file_id, content_changed,
1087
((base_ie.parent_id, lca_parent_ids),
1088
other_ie.parent_id, this_ie.parent_id),
1089
((base_ie.name, lca_names),
1090
other_ie.name, this_ie.name),
1091
((base_ie.executable, lca_executable),
1092
other_ie.executable, this_ie.executable)
617
1096
def fix_root(self):
619
self.tt.final_kind(self.tt.root)
1097
if self.tt.final_kind(self.tt.root) is None:
621
1098
self.tt.cancel_deletion(self.tt.root)
622
1099
if self.tt.final_file_id(self.tt.root) is None:
623
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
1100
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
625
if self.other_tree.inventory.root is None:
627
1102
other_root_file_id = self.other_tree.get_root_id()
1103
if other_root_file_id is None:
628
1105
other_root = self.tt.trans_id_file_id(other_root_file_id)
629
1106
if other_root == self.tt.root:
632
self.tt.final_kind(other_root)
635
1108
if self.other_tree.inventory.root.file_id in self.this_tree.inventory:
636
# the other tree's root is a non-root in the current tree
1109
# the other tree's root is a non-root in the current tree (as when
1110
# a previously unrelated branch is merged into another)
638
self.reparent_children(self.other_tree.inventory.root, self.tt.root)
639
self.tt.cancel_creation(other_root)
640
self.tt.cancel_versioning(other_root)
642
def reparent_children(self, ie, target):
643
for thing, child in ie.children.iteritems():
1112
if self.tt.final_kind(other_root) is not None:
1113
other_root_is_present = True
1115
# other_root doesn't have a physical representation. We still need
1116
# to move any references to the actual root of the tree.
1117
other_root_is_present = False
1118
# 'other_tree.inventory.root' is not present in this tree. We are
1119
# calling adjust_path for children which *want* to be present with a
1120
# correct place to go.
1121
for _, child in self.other_tree.inventory.root.children.iteritems():
644
1122
trans_id = self.tt.trans_id_file_id(child.file_id)
645
self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
1123
if not other_root_is_present:
1124
if self.tt.final_kind(trans_id) is not None:
1125
# The item exist in the final tree and has a defined place
1128
# Move the item into the root
1130
final_name = self.tt.final_name(trans_id)
1131
except errors.NoFinalPath:
1132
# This file is not present anymore, ignore it.
1134
self.tt.adjust_path(final_name, self.tt.root, trans_id)
1135
if other_root_is_present:
1136
self.tt.cancel_creation(other_root)
1137
self.tt.cancel_versioning(other_root)
647
1139
def write_modified(self, results):
648
1140
modified_hashes = {}
690
1182
def kind(tree, file_id):
691
1183
"""Determine the kind of a file-id (used as a key method)."""
692
if file_id not in tree:
1184
if not tree.has_id(file_id):
694
1186
return tree.kind(file_id)
697
1189
def _three_way(base, other, this):
698
#if base == other, either they all agree, or only THIS has changed.
699
1190
if base == other:
1191
# if 'base == other', either they all agree, or only 'this' has
701
1194
elif this not in (base, other):
1195
# 'this' is neither 'base' nor 'other', so both sides changed
702
1196
return 'conflict'
703
# "Ambiguous clean merge" -- both sides have made the same change.
704
1197
elif this == other:
1198
# "Ambiguous clean merge" -- both sides have made the same change.
706
# this == base: only other has changed.
1201
# this == base: only other has changed.
1205
def _lca_multi_way(bases, other, this, allow_overriding_lca=True):
1206
"""Consider LCAs when determining whether a change has occurred.
1208
If LCAS are all identical, this is the same as a _three_way comparison.
1210
:param bases: value in (BASE, [LCAS])
1211
:param other: value in OTHER
1212
:param this: value in THIS
1213
:param allow_overriding_lca: If there is more than one unique lca
1214
value, allow OTHER to override THIS if it has a new value, and
1215
THIS only has an lca value, or vice versa. This is appropriate for
1216
truly scalar values, not as much for non-scalars.
1217
:return: 'this', 'other', or 'conflict' depending on whether an entry
1220
# See doc/developers/lca_tree_merging.txt for details about this
1223
# Either Ambiguously clean, or nothing was actually changed. We
1226
base_val, lca_vals = bases
1227
# Remove 'base_val' from the lca_vals, because it is not interesting
1228
filtered_lca_vals = [lca_val for lca_val in lca_vals
1229
if lca_val != base_val]
1230
if len(filtered_lca_vals) == 0:
1231
return Merge3Merger._three_way(base_val, other, this)
1233
unique_lca_vals = set(filtered_lca_vals)
1234
if len(unique_lca_vals) == 1:
1235
return Merge3Merger._three_way(unique_lca_vals.pop(), other, this)
1237
if allow_overriding_lca:
1238
if other in unique_lca_vals:
1239
if this in unique_lca_vals:
1240
# Each side picked a different lca, conflict
1243
# This has a value which supersedes both lca values, and
1244
# other only has an lca value
1246
elif this in unique_lca_vals:
1247
# OTHER has a value which supersedes both lca values, and this
1248
# only has an lca value
1251
# At this point, the lcas disagree, and the tip disagree
1255
@deprecated_method(deprecated_in((2, 2, 0)))
711
1256
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
712
1257
"""Do a three-way test on a scalar.
713
1258
Return "this", "other" or "conflict", depending whether a value wins.
762
1308
parent_id_winner = "other"
763
1309
if name_winner == "this" and parent_id_winner == "this":
765
if name_winner == "conflict":
766
trans_id = self.tt.trans_id_file_id(file_id)
767
self._raw_conflicts.append(('name conflict', trans_id,
768
this_name, other_name))
769
if parent_id_winner == "conflict":
770
trans_id = self.tt.trans_id_file_id(file_id)
771
self._raw_conflicts.append(('parent conflict', trans_id,
772
this_parent, other_parent))
1311
if name_winner == 'conflict' or parent_id_winner == 'conflict':
1312
# Creating helpers (.OTHER or .THIS) here cause problems down the
1313
# road if a ContentConflict needs to be created so we should not do
1315
trans_id = self.tt.trans_id_file_id(file_id)
1316
self._raw_conflicts.append(('path conflict', trans_id, file_id,
1317
this_parent, this_name,
1318
other_parent, other_name))
773
1319
if other_name is None:
774
# it doesn't matter whether the result was 'other' or
1320
# it doesn't matter whether the result was 'other' or
775
1321
# 'conflict'-- if there's no 'other', we leave it alone.
777
# if we get here, name_winner and parent_winner are set to safe values.
778
trans_id = self.tt.trans_id_file_id(file_id)
779
1323
parent_id = parents[self.winner_idx[parent_id_winner]]
780
1324
if parent_id is not None:
781
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1325
# if we get here, name_winner and parent_winner are set to safe
782
1327
self.tt.adjust_path(names[self.winner_idx[name_winner]],
783
parent_trans_id, trans_id)
1328
self.tt.trans_id_file_id(parent_id),
1329
self.tt.trans_id_file_id(file_id))
785
def merge_contents(self, file_id):
786
"""Performa a merge on file_id contents."""
1331
def _do_merge_contents(self, file_id):
1332
"""Performs a merge on file_id contents."""
787
1333
def contents_pair(tree):
788
1334
if file_id not in tree:
789
1335
return (None, None)
797
1343
return kind, contents
799
def contents_conflict():
800
trans_id = self.tt.trans_id_file_id(file_id)
801
name = self.tt.final_name(trans_id)
802
parent_id = self.tt.final_parent(trans_id)
803
if file_id in self.this_tree.inventory:
804
self.tt.unversion_file(trans_id)
805
if file_id in self.this_tree:
806
self.tt.delete_contents(trans_id)
807
file_group = self._dump_conflicts(name, parent_id, file_id,
809
self._raw_conflicts.append(('contents conflict', file_group))
811
1345
# See SPOT run. run, SPOT, run.
812
1346
# So we're not QUITE repeating ourselves; we do tricky things with
814
1348
base_pair = contents_pair(self.base_tree)
815
1349
other_pair = contents_pair(self.other_tree)
816
if base_pair == other_pair:
817
# OTHER introduced no changes
819
this_pair = contents_pair(self.this_tree)
820
if this_pair == other_pair:
821
# THIS and OTHER introduced the same changes
824
trans_id = self.tt.trans_id_file_id(file_id)
825
if this_pair == base_pair:
826
# only OTHER introduced changes
827
if file_id in self.this_tree:
828
# Remove any existing contents
829
self.tt.delete_contents(trans_id)
830
if file_id in self.other_tree:
831
# OTHER changed the file
832
create_by_entry(self.tt,
833
self.other_tree.inventory[file_id],
834
self.other_tree, trans_id)
835
if file_id not in self.this_tree.inventory:
836
self.tt.version_file(file_id, trans_id)
838
elif file_id in self.this_tree.inventory:
839
# OTHER deleted the file
840
self.tt.unversion_file(trans_id)
842
#BOTH THIS and OTHER introduced changes; scalar conflict
843
elif this_pair[0] == "file" and other_pair[0] == "file":
844
# THIS and OTHER are both files, so text merge. Either
845
# BASE is a file, or both converted to files, so at least we
846
# have agreement that output should be a file.
848
self.text_merge(file_id, trans_id)
850
return contents_conflict()
851
if file_id not in self.this_tree.inventory:
852
self.tt.version_file(file_id, trans_id)
854
self.tt.tree_kind(trans_id)
855
self.tt.delete_contents(trans_id)
860
# Scalar conflict, can't text merge. Dump conflicts
861
return contents_conflict()
1351
this_pair = contents_pair(self.this_tree)
1352
lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
1353
winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
1354
this_pair, allow_overriding_lca=False)
1356
if base_pair == other_pair:
1359
# We delayed evaluating this_pair as long as we can to avoid
1360
# unnecessary sha1 calculation
1361
this_pair = contents_pair(self.this_tree)
1362
winner = self._three_way(base_pair, other_pair, this_pair)
1363
if winner == 'this':
1364
# No interesting changes introduced by OTHER
1366
# We have a hypothetical conflict, but if we have files, then we
1367
# can try to merge the content
1368
trans_id = self.tt.trans_id_file_id(file_id)
1369
params = MergeHookParams(self, file_id, trans_id, this_pair[0],
1370
other_pair[0], winner)
1371
hooks = self.active_hooks
1372
hook_status = 'not_applicable'
1374
hook_status, lines = hook.merge_contents(params)
1375
if hook_status != 'not_applicable':
1376
# Don't try any more hooks, this one applies.
1379
if hook_status == 'not_applicable':
1380
# This is a contents conflict, because none of the available
1381
# functions could merge it.
1383
name = self.tt.final_name(trans_id)
1384
parent_id = self.tt.final_parent(trans_id)
1385
if self.this_tree.has_id(file_id):
1386
self.tt.unversion_file(trans_id)
1387
file_group = self._dump_conflicts(name, parent_id, file_id,
1389
self._raw_conflicts.append(('contents conflict', file_group))
1390
elif hook_status == 'success':
1391
self.tt.create_file(lines, trans_id)
1392
elif hook_status == 'conflicted':
1393
# XXX: perhaps the hook should be able to provide
1394
# the BASE/THIS/OTHER files?
1395
self.tt.create_file(lines, trans_id)
1396
self._raw_conflicts.append(('text conflict', trans_id))
1397
name = self.tt.final_name(trans_id)
1398
parent_id = self.tt.final_parent(trans_id)
1399
self._dump_conflicts(name, parent_id, file_id)
1400
elif hook_status == 'delete':
1401
self.tt.unversion_file(trans_id)
1403
elif hook_status == 'done':
1404
# The hook function did whatever it needs to do directly, no
1405
# further action needed here.
1408
raise AssertionError('unknown hook_status: %r' % (hook_status,))
1409
if not self.this_tree.has_id(file_id) and result == "modified":
1410
self.tt.version_file(file_id, trans_id)
1411
# The merge has been performed, so the old contents should not be
1413
self.tt.delete_contents(trans_id)
1416
def _default_other_winner_merge(self, merge_hook_params):
1417
"""Replace this contents with other."""
1418
file_id = merge_hook_params.file_id
1419
trans_id = merge_hook_params.trans_id
1420
file_in_this = self.this_tree.has_id(file_id)
1421
if self.other_tree.has_id(file_id):
1422
# OTHER changed the file
1424
if wt.supports_content_filtering():
1425
# We get the path from the working tree if it exists.
1426
# That fails though when OTHER is adding a file, so
1427
# we fall back to the other tree to find the path if
1428
# it doesn't exist locally.
1430
filter_tree_path = wt.id2path(file_id)
1431
except errors.NoSuchId:
1432
filter_tree_path = self.other_tree.id2path(file_id)
1434
# Skip the id2path lookup for older formats
1435
filter_tree_path = None
1436
transform.create_from_tree(self.tt, trans_id,
1437
self.other_tree, file_id,
1438
filter_tree_path=filter_tree_path)
1441
# OTHER deleted the file
1442
return 'delete', None
1444
raise AssertionError(
1445
'winner is OTHER, but file_id %r not in THIS or OTHER tree'
1448
def merge_contents(self, merge_hook_params):
1449
"""Fallback merge logic after user installed hooks."""
1450
# This function is used in merge hooks as the fallback instance.
1451
# Perhaps making this function and the functions it calls be a
1452
# a separate class would be better.
1453
if merge_hook_params.winner == 'other':
1454
# OTHER is a straight winner, so replace this contents with other
1455
return self._default_other_winner_merge(merge_hook_params)
1456
elif merge_hook_params.is_file_merge():
1457
# THIS and OTHER are both files, so text merge. Either
1458
# BASE is a file, or both converted to files, so at least we
1459
# have agreement that output should be a file.
1461
self.text_merge(merge_hook_params.file_id,
1462
merge_hook_params.trans_id)
1463
except errors.BinaryFile:
1464
return 'not_applicable', None
1467
return 'not_applicable', None
863
1469
def get_lines(self, tree, file_id):
864
1470
"""Return the lines in a file, or an empty list."""
866
return tree.get_file(file_id).readlines()
1471
if tree.has_id(file_id):
1472
return tree.get_file_lines(file_id)
919
1525
determined automatically. If set_version is true, the .OTHER, .THIS
920
1526
or .BASE (in that order) will be created as versioned files.
922
data = [('OTHER', self.other_tree, other_lines),
1528
data = [('OTHER', self.other_tree, other_lines),
923
1529
('THIS', self.this_tree, this_lines)]
925
1531
data.append(('BASE', self.base_tree, base_lines))
1533
# We need to use the actual path in the working tree of the file here,
1534
# ignoring the conflict suffixes
1536
if wt.supports_content_filtering():
1538
filter_tree_path = wt.id2path(file_id)
1539
except errors.NoSuchId:
1540
# file has been deleted
1541
filter_tree_path = None
1543
# Skip the id2path lookup for older formats
1544
filter_tree_path = None
926
1546
versioned = False
928
1548
for suffix, tree, lines in data:
1549
if tree.has_id(file_id):
930
1550
trans_id = self._conflict_file(name, parent_id, tree, file_id,
1551
suffix, lines, filter_tree_path)
932
1552
file_group.append(trans_id)
933
1553
if set_version and not versioned:
934
1554
self.tt.version_file(file_id, trans_id)
935
1555
versioned = True
936
1556
return file_group
938
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1558
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1559
lines=None, filter_tree_path=None):
940
1560
"""Emit a single conflict file."""
941
1561
name = name + '.' + suffix
942
1562
trans_id = self.tt.create_path(name, parent_id)
943
entry = tree.inventory[file_id]
944
create_by_entry(self.tt, entry, tree, trans_id, lines)
1563
transform.create_from_tree(self.tt, trans_id, tree, file_id, lines,
947
1567
def merge_executable(self, file_id, file_status):
948
1568
"""Perform a merge on the execute bit."""
949
1569
executable = [self.executable(t, file_id) for t in (self.base_tree,
950
1570
self.other_tree, self.this_tree)]
951
self._merge_executable(file_id, executable, file_status)
1571
self._merge_executable(file_id, executable, file_status,
1572
resolver=self._three_way)
953
def _merge_executable(self, file_id, executable, file_status):
1574
def _merge_executable(self, file_id, executable, file_status,
954
1576
"""Perform a merge on the execute bit."""
955
1577
base_executable, other_executable, this_executable = executable
956
1578
if file_status == "deleted":
958
winner = self._three_way(*executable)
1580
winner = resolver(*executable)
959
1581
if winner == "conflict":
960
1582
# There must be a None in here, if we have a conflict, but we
961
1583
# need executability since file status was not deleted.
1009
1640
if path.endswith(suffix):
1010
1641
path = path[:-len(suffix)]
1012
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
1013
self.cooked_conflicts.append(c)
1014
if conflict_type == 'text conflict':
1643
c = _mod_conflicts.Conflict.factory(conflict_type,
1644
path=path, file_id=file_id)
1645
elif conflict_type == 'text conflict':
1015
1646
trans_id = conflict[1]
1016
1647
path = fp.get_path(trans_id)
1017
1648
file_id = self.tt.final_file_id(trans_id)
1018
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
1019
self.cooked_conflicts.append(c)
1021
for trans_id, conflicts in name_conflicts.iteritems():
1023
this_parent, other_parent = conflicts['parent conflict']
1024
if this_parent == other_parent:
1025
raise AssertionError()
1027
this_parent = other_parent = \
1028
self.tt.final_file_id(self.tt.final_parent(trans_id))
1030
this_name, other_name = conflicts['name conflict']
1031
if this_name == other_name:
1032
raise AssertionError()
1034
this_name = other_name = self.tt.final_name(trans_id)
1035
other_path = fp.get_path(trans_id)
1036
if this_parent is not None and this_name is not None:
1037
this_parent_path = \
1038
fp.get_path(self.tt.trans_id_file_id(this_parent))
1039
this_path = pathjoin(this_parent_path, this_name)
1649
c = _mod_conflicts.Conflict.factory(conflict_type,
1650
path=path, file_id=file_id)
1041
this_path = "<deleted>"
1042
file_id = self.tt.final_file_id(trans_id)
1043
c = Conflict.factory('path conflict', path=this_path,
1044
conflict_path=other_path, file_id=file_id)
1652
raise AssertionError('bad conflict type: %r' % (conflict,))
1045
1653
self.cooked_conflicts.append(c)
1046
self.cooked_conflicts.sort(key=Conflict.sort_key)
1654
self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
1049
1657
class WeaveMerger(Merge3Merger):
1053
1661
supports_reverse_cherrypick = False
1054
1662
history_based = True
1056
def _merged_lines(self, file_id):
1057
"""Generate the merged lines.
1058
There is no distinction between lines that are meant to contain <<<<<<<
1062
base = self.base_tree
1065
plan = self.this_tree.plan_file_merge(file_id, self.other_tree,
1664
def _generate_merge_plan(self, file_id, base):
1665
return self.this_tree.plan_file_merge(file_id, self.other_tree,
1668
def _merged_lines(self, file_id):
1669
"""Generate the merged lines.
1670
There is no distinction between lines that are meant to contain <<<<<<<
1674
base = self.base_tree
1677
plan = self._generate_merge_plan(file_id, base)
1067
1678
if 'merge' in debug.debug_flags:
1068
1679
plan = list(plan)
1069
1680
trans_id = self.tt.trans_id_file_id(file_id)
1070
1681
name = self.tt.final_name(trans_id) + '.plan'
1071
contents = ('%10s|%s' % l for l in plan)
1682
contents = ('%11s|%s' % l for l in plan)
1072
1683
self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1073
textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1074
'>>>>>>> MERGE-SOURCE\n')
1075
return textmerge.merge_lines(self.reprocess)
1684
textmerge = versionedfile.PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1685
'>>>>>>> MERGE-SOURCE\n')
1686
lines, conflicts = textmerge.merge_lines(self.reprocess)
1688
base_lines = textmerge.base_from_plan()
1691
return lines, base_lines
1077
1693
def text_merge(self, file_id, trans_id):
1078
1694
"""Perform a (weave) text merge for a given file and file-id.
1079
1695
If conflicts are encountered, .THIS and .OTHER files will be emitted,
1080
1696
and a conflict will be noted.
1082
lines, conflicts = self._merged_lines(file_id)
1698
lines, base_lines = self._merged_lines(file_id)
1083
1699
lines = list(lines)
1084
# Note we're checking whether the OUTPUT is binary in this case,
1700
# Note we're checking whether the OUTPUT is binary in this case,
1085
1701
# because we don't want to get into weave merge guts.
1086
check_text_lines(lines)
1702
textfile.check_text_lines(lines)
1087
1703
self.tt.create_file(lines, trans_id)
1704
if base_lines is not None:
1089
1706
self._raw_conflicts.append(('text conflict', trans_id))
1090
1707
name = self.tt.final_name(trans_id)
1091
1708
parent_id = self.tt.final_parent(trans_id)
1092
file_group = self._dump_conflicts(name, parent_id, file_id,
1709
file_group = self._dump_conflicts(name, parent_id, file_id,
1711
base_lines=base_lines)
1094
1712
file_group.append(trans_id)
1097
1715
class LCAMerger(WeaveMerger):
1099
def _merged_lines(self, file_id):
1100
"""Generate the merged lines.
1101
There is no distinction between lines that are meant to contain <<<<<<<
1105
base = self.base_tree
1108
plan = self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
1717
def _generate_merge_plan(self, file_id, base):
1718
return self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
1110
if 'merge' in debug.debug_flags:
1112
trans_id = self.tt.trans_id_file_id(file_id)
1113
name = self.tt.final_name(trans_id) + '.plan'
1114
contents = ('%10s|%s' % l for l in plan)
1115
self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1116
textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1117
'>>>>>>> MERGE-SOURCE\n')
1118
return textmerge.merge_lines(self.reprocess)
1121
1721
class Diff3Merger(Merge3Merger):
1122
1722
"""Three-way merger using external diff3 for text merging"""
1124
1724
def dump_file(self, temp_dir, name, tree, file_id):
1125
out_path = pathjoin(temp_dir, name)
1725
out_path = osutils.pathjoin(temp_dir, name)
1126
1726
out_file = open(out_path, "wb")
1128
1728
in_file = tree.get_file(file_id)
1161
1761
osutils.rmtree(temp_dir)
1764
class PathNotInTree(errors.BzrError):
1766
_fmt = """Merge-into failed because %(tree)s does not contain %(path)s."""
1768
def __init__(self, path, tree):
1769
errors.BzrError.__init__(self, path=path, tree=tree)
1772
class MergeIntoMerger(Merger):
1773
"""Merger that understands other_tree will be merged into a subdir.
1775
This also changes the Merger api so that it uses real Branch, revision_id,
1776
and RevisonTree objects, rather than using revision specs.
1779
def __init__(self, this_tree, other_branch, other_tree, target_subdir,
1780
source_subpath, other_rev_id=None):
1781
"""Create a new MergeIntoMerger object.
1783
source_subpath in other_tree will be effectively copied to
1784
target_subdir in this_tree.
1786
:param this_tree: The tree that we will be merging into.
1787
:param other_branch: The Branch we will be merging from.
1788
:param other_tree: The RevisionTree object we want to merge.
1789
:param target_subdir: The relative path where we want to merge
1790
other_tree into this_tree
1791
:param source_subpath: The relative path specifying the subtree of
1792
other_tree to merge into this_tree.
1794
# It is assumed that we are merging a tree that is not in our current
1795
# ancestry, which means we are using the "EmptyTree" as our basis.
1796
null_ancestor_tree = this_tree.branch.repository.revision_tree(
1797
_mod_revision.NULL_REVISION)
1798
super(MergeIntoMerger, self).__init__(
1799
this_branch=this_tree.branch,
1800
this_tree=this_tree,
1801
other_tree=other_tree,
1802
base_tree=null_ancestor_tree,
1804
self._target_subdir = target_subdir
1805
self._source_subpath = source_subpath
1806
self.other_branch = other_branch
1807
if other_rev_id is None:
1808
other_rev_id = other_tree.get_revision_id()
1809
self.other_rev_id = self.other_basis = other_rev_id
1810
self.base_is_ancestor = True
1811
self.backup_files = True
1812
self.merge_type = Merge3Merger
1813
self.show_base = False
1814
self.reprocess = False
1815
self.interesting_ids = None
1816
self.merge_type = _MergeTypeParameterizer(MergeIntoMergeType,
1817
target_subdir=self._target_subdir,
1818
source_subpath=self._source_subpath)
1819
if self._source_subpath != '':
1820
# If this isn't a partial merge make sure the revisions will be
1822
self._maybe_fetch(self.other_branch, self.this_branch,
1825
def set_pending(self):
1826
if self._source_subpath != '':
1828
Merger.set_pending(self)
1831
class _MergeTypeParameterizer(object):
1832
"""Wrap a merge-type class to provide extra parameters.
1834
This is hack used by MergeIntoMerger to pass some extra parameters to its
1835
merge_type. Merger.do_merge() sets up its own set of parameters to pass to
1836
the 'merge_type' member. It is difficult override do_merge without
1837
re-writing the whole thing, so instead we create a wrapper which will pass
1838
the extra parameters.
1841
def __init__(self, merge_type, **kwargs):
1842
self._extra_kwargs = kwargs
1843
self._merge_type = merge_type
1845
def __call__(self, *args, **kwargs):
1846
kwargs.update(self._extra_kwargs)
1847
return self._merge_type(*args, **kwargs)
1849
def __getattr__(self, name):
1850
return getattr(self._merge_type, name)
1853
class MergeIntoMergeType(Merge3Merger):
1854
"""Merger that incorporates a tree (or part of a tree) into another."""
1856
def __init__(self, *args, **kwargs):
1857
"""Initialize the merger object.
1859
:param args: See Merge3Merger.__init__'s args.
1860
:param kwargs: See Merge3Merger.__init__'s keyword args, except for
1861
source_subpath and target_subdir.
1862
:keyword source_subpath: The relative path specifying the subtree of
1863
other_tree to merge into this_tree.
1864
:keyword target_subdir: The relative path where we want to merge
1865
other_tree into this_tree
1867
# All of the interesting work happens during Merge3Merger.__init__(),
1868
# so we have have to hack in to get our extra parameters set.
1869
self._source_subpath = kwargs.pop('source_subpath')
1870
self._target_subdir = kwargs.pop('target_subdir')
1871
super(MergeIntoMergeType, self).__init__(*args, **kwargs)
1873
def _compute_transform(self):
1874
child_pb = ui.ui_factory.nested_progress_bar()
1876
entries = self._entries_to_incorporate()
1877
entries = list(entries)
1878
for num, (entry, parent_id) in enumerate(entries):
1879
child_pb.update('Preparing file merge', num, len(entries))
1880
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1881
trans_id = transform.new_by_entry(self.tt, entry,
1882
parent_trans_id, self.other_tree)
1885
self._finish_computing_transform()
1887
def _entries_to_incorporate(self):
1888
"""Yields pairs of (inventory_entry, new_parent)."""
1889
other_inv = self.other_tree.inventory
1890
subdir_id = other_inv.path2id(self._source_subpath)
1891
if subdir_id is None:
1892
# XXX: The error would be clearer if it gave the URL of the source
1893
# branch, but we don't have a reference to that here.
1894
raise PathNotInTree(self._source_subpath, "Source tree")
1895
subdir = other_inv[subdir_id]
1896
parent_in_target = osutils.dirname(self._target_subdir)
1897
target_id = self.this_tree.inventory.path2id(parent_in_target)
1898
if target_id is None:
1899
raise PathNotInTree(self._target_subdir, "Target tree")
1900
name_in_target = osutils.basename(self._target_subdir)
1901
merge_into_root = subdir.copy()
1902
merge_into_root.name = name_in_target
1903
if merge_into_root.file_id in self.this_tree.inventory:
1904
# Give the root a new file-id.
1905
# This can happen fairly easily if the directory we are
1906
# incorporating is the root, and both trees have 'TREE_ROOT' as
1907
# their root_id. Users will expect this to Just Work, so we
1908
# change the file-id here.
1909
# Non-root file-ids could potentially conflict too. That's really
1910
# an edge case, so we don't do anything special for those. We let
1911
# them cause conflicts.
1912
merge_into_root.file_id = generate_ids.gen_file_id(name_in_target)
1913
yield (merge_into_root, target_id)
1914
if subdir.kind != 'directory':
1915
# No children, so we are done.
1917
for ignored_path, entry in other_inv.iter_entries_by_dir(subdir_id):
1918
parent_id = entry.parent_id
1919
if parent_id == subdir.file_id:
1920
# The root's parent ID has changed, so make sure children of
1921
# the root refer to the new ID.
1922
parent_id = merge_into_root.file_id
1923
yield (entry, parent_id)
1164
1926
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1165
1927
backup_files=False,
1166
1928
merge_type=Merge3Merger,
added
removed
bzrlib/merge.py
