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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
from itertools import chain
19
23
from bzrlib import (
20
branch as _mod_branch,
21
conflicts as _mod_conflicts,
25
26
graph as _mod_graph,
30
30
revision as _mod_revision,
39
from bzrlib.cleanup import OperationWithCleanups
40
from bzrlib.symbol_versioning import (
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
44
62
# TODO: Report back as changes are merged in
47
65
def transform_tree(from_tree, to_tree, interesting_ids=None):
48
from_tree.lock_tree_write()
49
operation = OperationWithCleanups(merge_inner)
50
operation.add_cleanup(from_tree.unlock)
51
operation.run_simple(from_tree.branch, to_tree, from_tree,
52
ignore_zero=True, interesting_ids=interesting_ids, this_tree=from_tree)
55
class MergeHooks(hooks.Hooks):
58
hooks.Hooks.__init__(self)
59
self.create_hook(hooks.HookPoint('merge_file_content',
60
"Called with a bzrlib.merge.Merger object to create a per file "
61
"merge object when starting a merge. "
62
"Should return either None or a subclass of "
63
"``bzrlib.merge.AbstractPerFileMerger``. "
64
"Such objects will then be called per file "
65
"that needs to be merged (including when one "
66
"side has deleted the file and the other has changed it). "
67
"See the AbstractPerFileMerger API docs for details on how it is "
72
class AbstractPerFileMerger(object):
73
"""PerFileMerger objects are used by plugins extending merge for bzrlib.
75
See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
77
:ivar merger: The Merge3Merger performing the merge.
80
def __init__(self, merger):
81
"""Create a PerFileMerger for use with merger."""
84
def merge_contents(self, merge_params):
85
"""Attempt to merge the contents of a single file.
87
:param merge_params: A bzrlib.merge.MergeHookParams
88
:return : A tuple of (status, chunks), where status is one of
89
'not_applicable', 'success', 'conflicted', or 'delete'. If status
90
is 'success' or 'conflicted', then chunks should be an iterable of
91
strings for the new file contents.
93
return ('not applicable', None)
96
class ConfigurableFileMerger(AbstractPerFileMerger):
97
"""Merge individual files when configured via a .conf file.
99
This is a base class for concrete custom file merging logic. Concrete
100
classes should implement ``merge_text``.
102
See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
104
:ivar affected_files: The configured file paths to merge.
106
:cvar name_prefix: The prefix to use when looking up configuration
107
details. <name_prefix>_merge_files describes the files targeted by the
110
:cvar default_files: The default file paths to merge when no configuration
117
def __init__(self, merger):
118
super(ConfigurableFileMerger, self).__init__(merger)
119
self.affected_files = None
120
self.default_files = self.__class__.default_files or []
121
self.name_prefix = self.__class__.name_prefix
122
if self.name_prefix is None:
123
raise ValueError("name_prefix must be set.")
125
def filename_matches_config(self, params):
126
"""Check whether the file should call the merge hook.
128
<name_prefix>_merge_files configuration variable is a list of files
129
that should use the hook.
131
affected_files = self.affected_files
132
if affected_files is None:
133
config = self.merger.this_tree.branch.get_config()
134
# Until bzr provides a better policy for caching the config, we
135
# just add the part we're interested in to the params to avoid
136
# reading the config files repeatedly (bazaar.conf, location.conf,
138
config_key = self.name_prefix + '_merge_files'
139
affected_files = config.get_user_option_as_list(config_key)
140
if affected_files is None:
141
# If nothing was specified in the config, use the default.
142
affected_files = self.default_files
143
self.affected_files = affected_files
145
filename = self.merger.this_tree.id2path(params.file_id)
146
if filename in affected_files:
150
def merge_contents(self, params):
151
"""Merge the contents of a single file."""
152
# First, check whether this custom merge logic should be used. We
153
# expect most files should not be merged by this handler.
155
# OTHER is a straight winner, rely on default merge.
156
params.winner == 'other' or
157
# THIS and OTHER aren't both files.
158
not params.is_file_merge() or
159
# The filename isn't listed in the 'NAME_merge_files' config
161
not self.filename_matches_config(params)):
162
return 'not_applicable', None
163
return self.merge_text(params)
165
def merge_text(self, params):
166
"""Merge the byte contents of a single file.
168
This is called after checking that the merge should be performed in
169
merge_contents, and it should behave as per
170
``bzrlib.merge.AbstractPerFileMerger.merge_contents``.
172
raise NotImplementedError(self.merge_text)
175
class MergeHookParams(object):
176
"""Object holding parameters passed to merge_file_content hooks.
178
There are some fields hooks can access:
180
:ivar file_id: the file ID of the file being merged
181
:ivar trans_id: the transform ID for the merge of this file
182
:ivar this_kind: kind of file_id in 'this' tree
183
:ivar other_kind: kind of file_id in 'other' tree
184
:ivar winner: one of 'this', 'other', 'conflict'
187
def __init__(self, merger, file_id, trans_id, this_kind, other_kind,
189
self._merger = merger
190
self.file_id = file_id
191
self.trans_id = trans_id
192
self.this_kind = this_kind
193
self.other_kind = other_kind
196
def is_file_merge(self):
197
"""True if this_kind and other_kind are both 'file'."""
198
return self.this_kind == 'file' and self.other_kind == 'file'
200
@decorators.cachedproperty
201
def base_lines(self):
202
"""The lines of the 'base' version of the file."""
203
return self._merger.get_lines(self._merger.base_tree, self.file_id)
205
@decorators.cachedproperty
206
def this_lines(self):
207
"""The lines of the 'this' version of the file."""
208
return self._merger.get_lines(self._merger.this_tree, self.file_id)
210
@decorators.cachedproperty
211
def other_lines(self):
212
"""The lines of the 'other' version of the file."""
213
return self._merger.get_lines(self._merger.other_tree, self.file_id)
66
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
67
interesting_ids=interesting_ids, this_tree=from_tree)
216
70
class Merger(object):
220
71
def __init__(self, this_branch, other_tree=None, base_tree=None,
221
this_tree=None, pb=None, change_reporter=None,
72
this_tree=None, pb=DummyProgress(), change_reporter=None,
222
73
recurse='down', revision_graph=None):
223
74
object.__init__(self)
224
75
self.this_branch = this_branch
417
244
if self.this_rev_id is None:
418
245
if self.this_basis_tree.get_file_sha1(file_id) != \
419
246
self.this_tree.get_file_sha1(file_id):
420
raise errors.WorkingTreeNotRevision(self.this_tree)
247
raise WorkingTreeNotRevision(self.this_tree)
422
249
trees = (self.this_basis_tree, self.other_tree)
423
250
return [get_id(tree, file_id) for tree in trees]
425
@deprecated_method(deprecated_in((2, 1, 0)))
426
252
def check_basis(self, check_clean, require_commits=True):
427
253
if self.this_basis is None and require_commits is True:
428
raise errors.BzrCommandError(
429
"This branch has no commits."
430
" (perhaps you would prefer 'bzr pull')")
254
raise BzrCommandError("This branch has no commits."
255
" (perhaps you would prefer 'bzr pull')")
432
257
self.compare_basis()
433
258
if self.this_basis != self.this_rev_id:
434
259
raise errors.UncommittedChanges(self.this_tree)
436
@deprecated_method(deprecated_in((2, 1, 0)))
437
261
def compare_basis(self):
439
263
basis_tree = self.revision_tree(self.this_tree.last_revision())
440
264
except errors.NoSuchRevision:
441
265
basis_tree = self.this_tree.basis_tree()
442
if not self.this_tree.has_changes(basis_tree):
266
changes = self.this_tree.changes_from(basis_tree)
267
if not changes.has_changed():
443
268
self.this_rev_id = self.this_basis
445
270
def set_interesting_files(self, file_list):
446
271
self.interesting_files = file_list
448
273
def set_pending(self):
449
if (not self.base_is_ancestor or not self.base_is_other_ancestor
450
or self.other_rev_id is None):
274
if not self.base_is_ancestor or not self.base_is_other_ancestor or self.other_rev_id is None:
452
276
self._add_parent()
454
278
def _add_parent(self):
455
279
new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
456
280
new_parent_trees = []
457
operation = OperationWithCleanups(self.this_tree.set_parent_trees)
458
281
for revision_id in new_parents:
460
283
tree = self.revision_tree(revision_id)
521
349
target.fetch(source, revision_id)
523
351
def find_base(self):
524
revisions = [_mod_revision.ensure_null(self.this_basis),
525
_mod_revision.ensure_null(self.other_basis)]
526
if _mod_revision.NULL_REVISION in revisions:
527
self.base_rev_id = _mod_revision.NULL_REVISION
528
self.base_tree = self.revision_tree(self.base_rev_id)
529
self._is_criss_cross = False
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
531
lcas = self.revision_graph.find_lca(revisions[0], revisions[1])
532
self._is_criss_cross = False
534
self.base_rev_id = _mod_revision.NULL_REVISION
536
self.base_rev_id = list(lcas)[0]
537
else: # len(lcas) > 1
539
# find_unique_lca can only handle 2 nodes, so we have to
540
# start back at the beginning. It is a shame to traverse
541
# the graph again, but better than re-implementing
543
self.base_rev_id = self.revision_graph.find_unique_lca(
544
revisions[0], revisions[1])
546
self.base_rev_id = self.revision_graph.find_unique_lca(
548
self._is_criss_cross = True
549
if self.base_rev_id == _mod_revision.NULL_REVISION:
550
raise errors.UnrelatedBranches()
551
if self._is_criss_cross:
552
trace.warning('Warning: criss-cross merge encountered. See bzr'
553
' help criss-cross.')
554
trace.mutter('Criss-cross lcas: %r' % lcas)
555
interesting_revision_ids = [self.base_rev_id]
556
interesting_revision_ids.extend(lcas)
557
interesting_trees = dict((t.get_revision_id(), t)
558
for t in self.this_branch.repository.revision_trees(
559
interesting_revision_ids))
560
self._cached_trees.update(interesting_trees)
561
self.base_tree = interesting_trees.pop(self.base_rev_id)
562
sorted_lca_keys = self.revision_graph.find_merge_order(
564
self._lca_trees = [interesting_trees[key]
565
for key in sorted_lca_keys]
567
self.base_tree = self.revision_tree(self.base_rev_id)
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)
568
365
self.base_is_ancestor = True
569
366
self.base_is_other_ancestor = True
570
trace.mutter('Base revid: %r' % self.base_rev_id)
572
368
def set_base(self, base_revision):
573
369
"""Set the base revision to use for the merge.
575
371
:param base_revision: A 2-list containing a path and revision number.
577
trace.mutter("doing merge() with no base_revision specified")
373
mutter("doing merge() with no base_revision specified")
578
374
if base_revision == [None, None]:
593
389
'other_tree': self.other_tree,
594
390
'interesting_ids': self.interesting_ids,
595
391
'interesting_files': self.interesting_files,
596
'this_branch': self.this_branch,
597
393
'do_merge': False}
598
394
if self.merge_type.requires_base:
599
395
kwargs['base_tree'] = self.base_tree
600
396
if self.merge_type.supports_reprocess:
601
397
kwargs['reprocess'] = self.reprocess
602
398
elif self.reprocess:
603
raise errors.BzrError(
604
"Conflict reduction is not supported for merge"
605
" type %s." % self.merge_type)
399
raise BzrError("Conflict reduction is not supported for merge"
400
" type %s." % self.merge_type)
606
401
if self.merge_type.supports_show_base:
607
402
kwargs['show_base'] = self.show_base
608
403
elif self.show_base:
609
raise errors.BzrError("Showing base is not supported for this"
610
" merge type. %s" % self.merge_type)
404
raise BzrError("Showing base is not supported for this"
405
" merge type. %s" % self.merge_type)
611
406
if (not getattr(self.merge_type, 'supports_reverse_cherrypick', True)
612
407
and not self.base_is_other_ancestor):
613
408
raise errors.CannotReverseCherrypick()
614
409
if self.merge_type.supports_cherrypick:
615
410
kwargs['cherrypick'] = (not self.base_is_ancestor or
616
411
not self.base_is_other_ancestor)
617
if self._is_criss_cross and getattr(self.merge_type,
618
'supports_lca_trees', False):
619
kwargs['lca_trees'] = self._lca_trees
620
return self.merge_type(pb=None,
412
return self.merge_type(pb=self._pb,
621
413
change_reporter=self.change_reporter,
624
def _do_merge_to(self):
625
merge = self.make_merger()
626
if self.other_branch is not None:
627
self.other_branch.update_references(self.this_branch)
629
if self.recurse == 'down':
630
for relpath, file_id in self.this_tree.iter_references():
631
sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
632
other_revision = self.other_tree.get_reference_revision(
634
if other_revision == sub_tree.last_revision():
636
sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
637
sub_merge.merge_type = self.merge_type
638
other_branch = self.other_branch.reference_parent(file_id, relpath)
639
sub_merge.set_other_revision(other_revision, other_branch)
640
base_revision = self.base_tree.get_reference_revision(file_id)
641
sub_merge.base_tree = \
642
sub_tree.branch.repository.revision_tree(base_revision)
643
sub_merge.base_rev_id = base_revision
647
416
def do_merge(self):
648
operation = OperationWithCleanups(self._do_merge_to)
649
417
self.this_tree.lock_tree_write()
650
operation.add_cleanup(self.this_tree.unlock)
651
418
if self.base_tree is not None:
652
419
self.base_tree.lock_read()
653
operation.add_cleanup(self.base_tree.unlock)
654
420
if self.other_tree is not None:
655
421
self.other_tree.lock_read()
656
operation.add_cleanup(self.other_tree.unlock)
657
merge = operation.run_simple()
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()
658
448
if len(merge.cooked_conflicts) == 0:
659
if not self.ignore_zero and not trace.is_quiet():
660
trace.note("All changes applied successfully.")
449
if not self.ignore_zero and not is_quiet():
450
note("All changes applied successfully.")
662
trace.note("%d conflicts encountered."
663
% len(merge.cooked_conflicts))
452
note("%d conflicts encountered." % len(merge.cooked_conflicts))
665
454
return len(merge.cooked_conflicts)
668
class _InventoryNoneEntry(object):
669
"""This represents an inventory entry which *isn't there*.
671
It simplifies the merging logic if we always have an InventoryEntry, even
672
if it isn't actually present
679
symlink_target = None
682
_none_entry = _InventoryNoneEntry()
685
457
class Merge3Merger(object):
686
458
"""Three-way merger that uses the merge3 text merger"""
687
459
requires_base = True
691
463
supports_cherrypick = True
692
464
supports_reverse_cherrypick = True
693
465
winner_idx = {"this": 2, "other": 1, "conflict": 1}
694
supports_lca_trees = True
696
def __init__(self, working_tree, this_tree, base_tree, other_tree,
467
def __init__(self, working_tree, this_tree, base_tree, other_tree,
697
468
interesting_ids=None, reprocess=False, show_base=False,
698
pb=None, pp=None, change_reporter=None,
469
pb=DummyProgress(), pp=None, change_reporter=None,
699
470
interesting_files=None, do_merge=True,
700
cherrypick=False, lca_trees=None, this_branch=None):
701
472
"""Initialize the merger object and perform the merge.
703
474
:param working_tree: The working tree to apply the merge to
704
475
:param this_tree: The local tree in the merge operation
705
476
:param base_tree: The common tree in the merge operation
706
:param other_tree: The other tree to merge changes from
707
:param this_branch: The branch associated with this_tree
477
:param other_tree: The other other tree to merge changes from
708
478
:param interesting_ids: The file_ids of files that should be
709
479
participate in the merge. May not be combined with
710
480
interesting_files.
711
481
:param: reprocess If True, perform conflict-reduction processing.
712
482
:param show_base: If True, show the base revision in text conflicts.
713
483
(incompatible with reprocess)
484
:param pb: A Progress bar
715
485
:param pp: A ProgressPhase object
716
486
:param change_reporter: An object that should report changes made
717
487
:param interesting_files: The tree-relative paths of files that should
733
500
self.this_tree = working_tree
734
501
self.base_tree = base_tree
735
502
self.other_tree = other_tree
736
self.this_branch = this_branch
737
503
self._raw_conflicts = []
738
504
self.cooked_conflicts = []
739
505
self.reprocess = reprocess
740
506
self.show_base = show_base
741
self._lca_trees = lca_trees
742
# Uncommenting this will change the default algorithm to always use
743
# _entries_lca. This can be useful for running the test suite and
744
# making sure we haven't missed any corner cases.
745
# if lca_trees is None:
746
# self._lca_trees = [self.base_tree]
747
509
self.change_reporter = change_reporter
748
510
self.cherrypick = cherrypick
512
self.pp = ProgressPhase("Merge phase", 3, self.pb)
752
warnings.warn("pp argument to Merge3Merger is deprecated")
754
warnings.warn("pb argument to Merge3Merger is deprecated")
756
516
def do_merge(self):
757
operation = OperationWithCleanups(self._do_merge)
758
517
self.this_tree.lock_tree_write()
759
operation.add_cleanup(self.this_tree.unlock)
760
518
self.base_tree.lock_read()
761
operation.add_cleanup(self.base_tree.unlock)
762
519
self.other_tree.lock_read()
763
operation.add_cleanup(self.other_tree.unlock)
766
def _do_merge(self, operation):
767
self.tt = transform.TreeTransform(self.this_tree, None)
768
operation.add_cleanup(self.tt.finalize)
769
self._compute_transform()
770
results = self.tt.apply(no_conflicts=True)
771
self.write_modified(results)
520
self.tt = TreeTransform(self.this_tree, self.pb)
773
self.this_tree.add_conflicts(self.cooked_conflicts)
774
except errors.UnsupportedOperation:
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()
777
538
def make_preview_transform(self):
778
operation = OperationWithCleanups(self._make_preview_transform)
779
539
self.base_tree.lock_read()
780
operation.add_cleanup(self.base_tree.unlock)
781
540
self.other_tree.lock_read()
782
operation.add_cleanup(self.other_tree.unlock)
783
return operation.run_simple()
785
def _make_preview_transform(self):
786
self.tt = transform.TransformPreview(self.this_tree)
787
self._compute_transform()
541
self.tt = TransformPreview(self.this_tree)
544
self._compute_transform()
547
self.other_tree.unlock()
548
self.base_tree.unlock()
790
552
def _compute_transform(self):
791
if self._lca_trees is None:
792
entries = self._entries3()
793
resolver = self._three_way
795
entries = self._entries_lca()
796
resolver = self._lca_multi_way
553
entries = self._entries3()
797
554
child_pb = ui.ui_factory.nested_progress_bar()
799
factories = Merger.hooks['merge_file_content']
800
hooks = [factory(self) for factory in factories] + [self]
801
self.active_hooks = [hook for hook in hooks if hook is not None]
802
556
for num, (file_id, changed, parents3, names3,
803
557
executable3) in enumerate(entries):
804
558
child_pb.update('Preparing file merge', num, len(entries))
805
self._merge_names(file_id, parents3, names3, resolver=resolver)
559
self._merge_names(file_id, parents3, names3)
807
file_status = self._do_merge_contents(file_id)
561
file_status = self.merge_contents(file_id)
809
563
file_status = 'unmodified'
810
564
self._merge_executable(file_id,
811
executable3, file_status, resolver=resolver)
565
executable3, file_status)
813
567
child_pb.finished()
815
570
child_pb = ui.ui_factory.nested_progress_bar()
817
fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
818
lambda t, c: transform.conflict_pass(t, c, self.other_tree))
572
fs_conflicts = resolve_conflicts(self.tt, child_pb,
573
lambda t, c: conflict_pass(t, c, self.other_tree))
820
575
child_pb.finished()
821
576
if self.change_reporter is not None:
862
614
result.append((file_id, changed, parents3, names3, executable3))
865
def _entries_lca(self):
866
"""Gather data about files modified between multiple trees.
868
This compares OTHER versus all LCA trees, and for interesting entries,
869
it then compares with THIS and BASE.
871
For the multi-valued entries, the format will be (BASE, [lca1, lca2])
872
:return: [(file_id, changed, parents, names, executable)]
873
file_id Simple file_id of the entry
874
changed Boolean, True if the kind or contents changed
876
parents ((base, [parent_id, in, lcas]), parent_id_other,
878
names ((base, [name, in, lcas]), name_in_other, name_in_this)
879
executable ((base, [exec, in, lcas]), exec_in_other, exec_in_this)
881
if self.interesting_files is not None:
882
lookup_trees = [self.this_tree, self.base_tree]
883
lookup_trees.extend(self._lca_trees)
884
# I think we should include the lca trees as well
885
interesting_ids = self.other_tree.paths2ids(self.interesting_files,
888
interesting_ids = self.interesting_ids
890
walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
892
base_inventory = self.base_tree.inventory
893
this_inventory = self.this_tree.inventory
894
for path, file_id, other_ie, lca_values in walker.iter_all():
895
# Is this modified at all from any of the other trees?
897
other_ie = _none_entry
898
if interesting_ids is not None and file_id not in interesting_ids:
901
# If other_revision is found in any of the lcas, that means this
902
# node is uninteresting. This is because when merging, if there are
903
# multiple heads(), we have to create a new node. So if we didn't,
904
# we know that the ancestry is linear, and that OTHER did not
906
# See doc/developers/lca_merge_resolution.txt for details
907
other_revision = other_ie.revision
908
if other_revision is not None:
909
# We can't use this shortcut when other_revision is None,
910
# because it may be None because things are WorkingTrees, and
911
# not because it is *actually* None.
912
is_unmodified = False
913
for lca_path, ie in lca_values:
914
if ie is not None and ie.revision == other_revision:
921
for lca_path, lca_ie in lca_values:
923
lca_entries.append(_none_entry)
925
lca_entries.append(lca_ie)
927
if file_id in base_inventory:
928
base_ie = base_inventory[file_id]
930
base_ie = _none_entry
932
if file_id in this_inventory:
933
this_ie = this_inventory[file_id]
935
this_ie = _none_entry
941
for lca_ie in lca_entries:
942
lca_kinds.append(lca_ie.kind)
943
lca_parent_ids.append(lca_ie.parent_id)
944
lca_names.append(lca_ie.name)
945
lca_executable.append(lca_ie.executable)
947
kind_winner = self._lca_multi_way(
948
(base_ie.kind, lca_kinds),
949
other_ie.kind, this_ie.kind)
950
parent_id_winner = self._lca_multi_way(
951
(base_ie.parent_id, lca_parent_ids),
952
other_ie.parent_id, this_ie.parent_id)
953
name_winner = self._lca_multi_way(
954
(base_ie.name, lca_names),
955
other_ie.name, this_ie.name)
957
content_changed = True
958
if kind_winner == 'this':
959
# No kind change in OTHER, see if there are *any* changes
960
if other_ie.kind == 'directory':
961
if parent_id_winner == 'this' and name_winner == 'this':
962
# No change for this directory in OTHER, skip
964
content_changed = False
965
elif other_ie.kind is None or other_ie.kind == 'file':
966
def get_sha1(ie, tree):
967
if ie.kind != 'file':
969
return tree.get_file_sha1(file_id)
970
base_sha1 = get_sha1(base_ie, self.base_tree)
971
lca_sha1s = [get_sha1(ie, tree) for ie, tree
972
in zip(lca_entries, self._lca_trees)]
973
this_sha1 = get_sha1(this_ie, self.this_tree)
974
other_sha1 = get_sha1(other_ie, self.other_tree)
975
sha1_winner = self._lca_multi_way(
976
(base_sha1, lca_sha1s), other_sha1, this_sha1,
977
allow_overriding_lca=False)
978
exec_winner = self._lca_multi_way(
979
(base_ie.executable, lca_executable),
980
other_ie.executable, this_ie.executable)
981
if (parent_id_winner == 'this' and name_winner == 'this'
982
and sha1_winner == 'this' and exec_winner == 'this'):
983
# No kind, parent, name, exec, or content change for
984
# OTHER, so this node is not considered interesting
986
if sha1_winner == 'this':
987
content_changed = False
988
elif other_ie.kind == 'symlink':
989
def get_target(ie, tree):
990
if ie.kind != 'symlink':
992
return tree.get_symlink_target(file_id)
993
base_target = get_target(base_ie, self.base_tree)
994
lca_targets = [get_target(ie, tree) for ie, tree
995
in zip(lca_entries, self._lca_trees)]
996
this_target = get_target(this_ie, self.this_tree)
997
other_target = get_target(other_ie, self.other_tree)
998
target_winner = self._lca_multi_way(
999
(base_target, lca_targets),
1000
other_target, this_target)
1001
if (parent_id_winner == 'this' and name_winner == 'this'
1002
and target_winner == 'this'):
1003
# No kind, parent, name, or symlink target change
1006
if target_winner == 'this':
1007
content_changed = False
1008
elif other_ie.kind == 'tree-reference':
1009
# The 'changed' information seems to be handled at a higher
1010
# level. At least, _entries3 returns False for content
1011
# changed, even when at a new revision_id.
1012
content_changed = False
1013
if (parent_id_winner == 'this' and name_winner == 'this'):
1014
# Nothing interesting
1017
raise AssertionError('unhandled kind: %s' % other_ie.kind)
1018
# XXX: We need to handle kind == 'symlink'
1020
# If we have gotten this far, that means something has changed
1021
result.append((file_id, content_changed,
1022
((base_ie.parent_id, lca_parent_ids),
1023
other_ie.parent_id, this_ie.parent_id),
1024
((base_ie.name, lca_names),
1025
other_ie.name, this_ie.name),
1026
((base_ie.executable, lca_executable),
1027
other_ie.executable, this_ie.executable)
1032
617
def fix_root(self):
1034
619
self.tt.final_kind(self.tt.root)
1035
except errors.NoSuchFile:
1036
621
self.tt.cancel_deletion(self.tt.root)
1037
622
if self.tt.final_file_id(self.tt.root) is None:
1038
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
623
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
625
if self.other_tree.inventory.root is None:
1040
627
other_root_file_id = self.other_tree.get_root_id()
1041
if other_root_file_id is None:
1043
628
other_root = self.tt.trans_id_file_id(other_root_file_id)
1044
629
if other_root == self.tt.root:
1047
632
self.tt.final_kind(other_root)
1048
except errors.NoSuchFile:
1050
if self.this_tree.has_id(self.other_tree.inventory.root.file_id):
1051
# the other tree's root is a non-root in the current tree
1053
635
self.reparent_children(self.other_tree.inventory.root, self.tt.root)
1054
636
self.tt.cancel_creation(other_root)
1126
def _lca_multi_way(bases, other, this, allow_overriding_lca=True):
1127
"""Consider LCAs when determining whether a change has occurred.
1129
If LCAS are all identical, this is the same as a _three_way comparison.
1131
:param bases: value in (BASE, [LCAS])
1132
:param other: value in OTHER
1133
:param this: value in THIS
1134
:param allow_overriding_lca: If there is more than one unique lca
1135
value, allow OTHER to override THIS if it has a new value, and
1136
THIS only has an lca value, or vice versa. This is appropriate for
1137
truly scalar values, not as much for non-scalars.
1138
:return: 'this', 'other', or 'conflict' depending on whether an entry
1141
# See doc/developers/lca_tree_merging.txt for details about this
1144
# Either Ambiguously clean, or nothing was actually changed. We
1147
base_val, lca_vals = bases
1148
# Remove 'base_val' from the lca_vals, because it is not interesting
1149
filtered_lca_vals = [lca_val for lca_val in lca_vals
1150
if lca_val != base_val]
1151
if len(filtered_lca_vals) == 0:
1152
return Merge3Merger._three_way(base_val, other, this)
1154
unique_lca_vals = set(filtered_lca_vals)
1155
if len(unique_lca_vals) == 1:
1156
return Merge3Merger._three_way(unique_lca_vals.pop(), other, this)
1158
if allow_overriding_lca:
1159
if other in unique_lca_vals:
1160
if this in unique_lca_vals:
1161
# Each side picked a different lca, conflict
1164
# This has a value which supersedes both lca values, and
1165
# other only has an lca value
1167
elif this in unique_lca_vals:
1168
# OTHER has a value which supersedes both lca values, and this
1169
# only has an lca value
1172
# At this point, the lcas disagree, and the tips disagree
1176
708
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
1177
709
"""Do a three-way test on a scalar.
1178
710
Return "this", "other" or "conflict", depending whether a value wins.
1263
794
return kind, contents
796
def contents_conflict():
797
trans_id = self.tt.trans_id_file_id(file_id)
798
name = self.tt.final_name(trans_id)
799
parent_id = self.tt.final_parent(trans_id)
800
if file_id in self.this_tree.inventory:
801
self.tt.unversion_file(trans_id)
802
if file_id in self.this_tree:
803
self.tt.delete_contents(trans_id)
804
file_group = self._dump_conflicts(name, parent_id, file_id,
806
self._raw_conflicts.append(('contents conflict', file_group))
1265
808
# See SPOT run. run, SPOT, run.
1266
809
# So we're not QUITE repeating ourselves; we do tricky things with
1268
811
base_pair = contents_pair(self.base_tree)
1269
812
other_pair = contents_pair(self.other_tree)
1271
this_pair = contents_pair(self.this_tree)
1272
lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
1273
winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
1274
this_pair, allow_overriding_lca=False)
1276
if base_pair == other_pair:
1279
# We delayed evaluating this_pair as long as we can to avoid
1280
# unnecessary sha1 calculation
1281
this_pair = contents_pair(self.this_tree)
1282
winner = self._three_way(base_pair, other_pair, this_pair)
1283
if winner == 'this':
1284
# No interesting changes introduced by OTHER
1286
# We have a hypothetical conflict, but if we have files, then we
1287
# can try to merge the content
1288
trans_id = self.tt.trans_id_file_id(file_id)
1289
params = MergeHookParams(self, file_id, trans_id, this_pair[0],
1290
other_pair[0], winner)
1291
hooks = self.active_hooks
1292
hook_status = 'not_applicable'
1294
hook_status, lines = hook.merge_contents(params)
1295
if hook_status != 'not_applicable':
1296
# Don't try any more hooks, this one applies.
1299
if hook_status == 'not_applicable':
1300
# This is a contents conflict, because none of the available
1301
# functions could merge it.
1303
name = self.tt.final_name(trans_id)
1304
parent_id = self.tt.final_parent(trans_id)
1305
if self.this_tree.has_id(file_id):
1306
self.tt.unversion_file(trans_id)
1307
file_group = self._dump_conflicts(name, parent_id, file_id,
1309
self._raw_conflicts.append(('contents conflict', file_group))
1310
elif hook_status == 'success':
1311
self.tt.create_file(lines, trans_id)
1312
elif hook_status == 'conflicted':
1313
# XXX: perhaps the hook should be able to provide
1314
# the BASE/THIS/OTHER files?
1315
self.tt.create_file(lines, trans_id)
1316
self._raw_conflicts.append(('text conflict', trans_id))
1317
name = self.tt.final_name(trans_id)
1318
parent_id = self.tt.final_parent(trans_id)
1319
self._dump_conflicts(name, parent_id, file_id)
1320
elif hook_status == 'delete':
1321
self.tt.unversion_file(trans_id)
1323
elif hook_status == 'done':
1324
# The hook function did whatever it needs to do directly, no
1325
# further action needed here.
1328
raise AssertionError('unknown hook_status: %r' % (hook_status,))
1329
if not self.this_tree.has_id(file_id) and result == "modified":
1330
self.tt.version_file(file_id, trans_id)
1331
# The merge has been performed, so the old contents should not be
1334
self.tt.delete_contents(trans_id)
1335
except errors.NoSuchFile:
1339
def _default_other_winner_merge(self, merge_hook_params):
1340
"""Replace this contents with other."""
1341
file_id = merge_hook_params.file_id
1342
trans_id = merge_hook_params.trans_id
1343
file_in_this = self.this_tree.has_id(file_id)
1344
if self.other_tree.has_id(file_id):
1345
# OTHER changed the file
1347
if wt.supports_content_filtering():
1348
# We get the path from the working tree if it exists.
1349
# That fails though when OTHER is adding a file, so
1350
# we fall back to the other tree to find the path if
1351
# it doesn't exist locally.
1353
filter_tree_path = wt.id2path(file_id)
1354
except errors.NoSuchId:
1355
filter_tree_path = self.other_tree.id2path(file_id)
1357
# Skip the id2path lookup for older formats
1358
filter_tree_path = None
1359
transform.create_from_tree(self.tt, trans_id,
1360
self.other_tree, file_id,
1361
filter_tree_path=filter_tree_path)
1364
# OTHER deleted the file
1365
return 'delete', None
1367
raise AssertionError(
1368
'winner is OTHER, but file_id %r not in THIS or OTHER tree'
1371
def merge_contents(self, merge_hook_params):
1372
"""Fallback merge logic after user installed hooks."""
1373
# This function is used in merge hooks as the fallback instance.
1374
# Perhaps making this function and the functions it calls be a
1375
# a separate class would be better.
1376
if merge_hook_params.winner == 'other':
1377
# OTHER is a straight winner, so replace this contents with other
1378
return self._default_other_winner_merge(merge_hook_params)
1379
elif merge_hook_params.is_file_merge():
1380
# THIS and OTHER are both files, so text merge. Either
1381
# BASE is a file, or both converted to files, so at least we
1382
# have agreement that output should be a file.
1384
self.text_merge(merge_hook_params.file_id,
1385
merge_hook_params.trans_id)
1386
except errors.BinaryFile:
1387
return 'not_applicable', None
1390
return 'not_applicable', None
813
if base_pair == other_pair:
814
# OTHER introduced no changes
816
this_pair = contents_pair(self.this_tree)
817
if this_pair == other_pair:
818
# THIS and OTHER introduced the same changes
821
trans_id = self.tt.trans_id_file_id(file_id)
822
if this_pair == base_pair:
823
# only OTHER introduced changes
824
if file_id in self.this_tree:
825
# Remove any existing contents
826
self.tt.delete_contents(trans_id)
827
if file_id in self.other_tree:
828
# OTHER changed the file
829
create_by_entry(self.tt,
830
self.other_tree.inventory[file_id],
831
self.other_tree, trans_id)
832
if file_id not in self.this_tree.inventory:
833
self.tt.version_file(file_id, trans_id)
835
elif file_id in self.this_tree.inventory:
836
# OTHER deleted the file
837
self.tt.unversion_file(trans_id)
839
#BOTH THIS and OTHER introduced changes; scalar conflict
840
elif this_pair[0] == "file" and other_pair[0] == "file":
841
# THIS and OTHER are both files, so text merge. Either
842
# BASE is a file, or both converted to files, so at least we
843
# have agreement that output should be a file.
845
self.text_merge(file_id, trans_id)
847
return contents_conflict()
848
if file_id not in self.this_tree.inventory:
849
self.tt.version_file(file_id, trans_id)
851
self.tt.tree_kind(trans_id)
852
self.tt.delete_contents(trans_id)
857
# Scalar conflict, can't text merge. Dump conflicts
858
return contents_conflict()
1392
860
def get_lines(self, tree, file_id):
1393
861
"""Return the lines in a file, or an empty list."""
1394
if tree.has_id(file_id):
1395
863
return tree.get_file(file_id).readlines()
1448
916
determined automatically. If set_version is true, the .OTHER, .THIS
1449
917
or .BASE (in that order) will be created as versioned files.
1451
data = [('OTHER', self.other_tree, other_lines),
919
data = [('OTHER', self.other_tree, other_lines),
1452
920
('THIS', self.this_tree, this_lines)]
1454
922
data.append(('BASE', self.base_tree, base_lines))
1456
# We need to use the actual path in the working tree of the file here,
1457
# ignoring the conflict suffixes
1459
if wt.supports_content_filtering():
1461
filter_tree_path = wt.id2path(file_id)
1462
except errors.NoSuchId:
1463
# file has been deleted
1464
filter_tree_path = None
1466
# Skip the id2path lookup for older formats
1467
filter_tree_path = None
1469
923
versioned = False
1471
925
for suffix, tree, lines in data:
1472
if tree.has_id(file_id):
1473
927
trans_id = self._conflict_file(name, parent_id, tree, file_id,
1474
suffix, lines, filter_tree_path)
1475
929
file_group.append(trans_id)
1476
930
if set_version and not versioned:
1477
931
self.tt.version_file(file_id, trans_id)
1478
932
versioned = True
1479
933
return file_group
1481
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1482
lines=None, filter_tree_path=None):
935
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1483
937
"""Emit a single conflict file."""
1484
938
name = name + '.' + suffix
1485
939
trans_id = self.tt.create_path(name, parent_id)
1486
transform.create_from_tree(self.tt, trans_id, tree, file_id, lines,
940
entry = tree.inventory[file_id]
941
create_by_entry(self.tt, entry, tree, trans_id, lines)
1490
944
def merge_executable(self, file_id, file_status):
1491
945
"""Perform a merge on the execute bit."""
1492
946
executable = [self.executable(t, file_id) for t in (self.base_tree,
1493
947
self.other_tree, self.this_tree)]
1494
self._merge_executable(file_id, executable, file_status,
1495
resolver=self._three_way)
948
self._merge_executable(file_id, executable, file_status)
1497
def _merge_executable(self, file_id, executable, file_status,
950
def _merge_executable(self, file_id, executable, file_status):
1499
951
"""Perform a merge on the execute bit."""
1500
952
base_executable, other_executable, this_executable = executable
1501
953
if file_status == "deleted":
1503
winner = resolver(*executable)
955
winner = self._three_way(*executable)
1504
956
if winner == "conflict":
1505
957
# There must be a None in here, if we have a conflict, but we
1506
958
# need executability since file status was not deleted.
1601
1050
supports_reverse_cherrypick = False
1602
1051
history_based = True
1604
def _generate_merge_plan(self, file_id, base):
1605
return self.this_tree.plan_file_merge(file_id, self.other_tree,
1053
def _merged_lines(self, file_id):
1054
"""Generate the merged lines.
1055
There is no distinction between lines that are meant to contain <<<<<<<
1059
base = self.base_tree
1062
plan = self.this_tree.plan_file_merge(file_id, self.other_tree,
1608
def _merged_lines(self, file_id):
1609
"""Generate the merged lines.
1610
There is no distinction between lines that are meant to contain <<<<<<<
1614
base = self.base_tree
1617
plan = self._generate_merge_plan(file_id, base)
1618
1064
if 'merge' in debug.debug_flags:
1619
1065
plan = list(plan)
1620
1066
trans_id = self.tt.trans_id_file_id(file_id)
1621
1067
name = self.tt.final_name(trans_id) + '.plan'
1622
contents = ('%11s|%s' % l for l in plan)
1068
contents = ('%10s|%s' % l for l in plan)
1623
1069
self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1624
textmerge = versionedfile.PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1625
'>>>>>>> MERGE-SOURCE\n')
1626
lines, conflicts = textmerge.merge_lines(self.reprocess)
1628
base_lines = textmerge.base_from_plan()
1631
return lines, base_lines
1070
textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1071
'>>>>>>> MERGE-SOURCE\n')
1072
return textmerge.merge_lines(self.reprocess)
1633
1074
def text_merge(self, file_id, trans_id):
1634
1075
"""Perform a (weave) text merge for a given file and file-id.
1635
1076
If conflicts are encountered, .THIS and .OTHER files will be emitted,
1636
1077
and a conflict will be noted.
1638
lines, base_lines = self._merged_lines(file_id)
1079
lines, conflicts = self._merged_lines(file_id)
1639
1080
lines = list(lines)
1640
# Note we're checking whether the OUTPUT is binary in this case,
1081
# Note we're checking whether the OUTPUT is binary in this case,
1641
1082
# because we don't want to get into weave merge guts.
1642
textfile.check_text_lines(lines)
1083
check_text_lines(lines)
1643
1084
self.tt.create_file(lines, trans_id)
1644
if base_lines is not None:
1646
1086
self._raw_conflicts.append(('text conflict', trans_id))
1647
1087
name = self.tt.final_name(trans_id)
1648
1088
parent_id = self.tt.final_parent(trans_id)
1649
file_group = self._dump_conflicts(name, parent_id, file_id,
1651
base_lines=base_lines)
1089
file_group = self._dump_conflicts(name, parent_id, file_id,
1652
1091
file_group.append(trans_id)
1655
1094
class LCAMerger(WeaveMerger):
1657
def _generate_merge_plan(self, file_id, base):
1658
return self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
1096
def _merged_lines(self, file_id):
1097
"""Generate the merged lines.
1098
There is no distinction between lines that are meant to contain <<<<<<<
1102
base = self.base_tree
1105
plan = self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
1107
if 'merge' in debug.debug_flags:
1109
trans_id = self.tt.trans_id_file_id(file_id)
1110
name = self.tt.final_name(trans_id) + '.plan'
1111
contents = ('%10s|%s' % l for l in plan)
1112
self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1113
textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1114
'>>>>>>> MERGE-SOURCE\n')
1115
return textmerge.merge_lines(self.reprocess)
1661
1118
class Diff3Merger(Merge3Merger):
1662
1119
"""Three-way merger using external diff3 for text merging"""
1664
1121
def dump_file(self, temp_dir, name, tree, file_id):
1665
out_path = osutils.pathjoin(temp_dir, name)
1122
out_path = pathjoin(temp_dir, name)
1666
1123
out_file = open(out_path, "wb")
1668
1125
in_file = tree.get_file(file_id)
added
removed
bzrlib/merge.py
