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
23
19
from bzrlib import (
20
branch as _mod_branch,
21
conflicts as _mod_conflicts,
26
25
graph as _mod_graph,
30
30
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
39
from bzrlib.cleanup import OperationWithCleanups
40
from bzrlib.symbol_versioning import (
62
44
# TODO: Report back as changes are merged in
65
47
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)
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_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)
70
216
class Merger(object):
71
220
def __init__(self, this_branch, other_tree=None, base_tree=None,
72
this_tree=None, pb=DummyProgress(), change_reporter=None,
221
this_tree=None, pb=None, change_reporter=None,
73
222
recurse='down', revision_graph=None):
74
223
object.__init__(self)
75
224
self.this_branch = this_branch
244
417
if self.this_rev_id is None:
245
418
if self.this_basis_tree.get_file_sha1(file_id) != \
246
419
self.this_tree.get_file_sha1(file_id):
247
raise WorkingTreeNotRevision(self.this_tree)
420
raise errors.WorkingTreeNotRevision(self.this_tree)
249
422
trees = (self.this_basis_tree, self.other_tree)
250
423
return [get_id(tree, file_id) for tree in trees]
425
@deprecated_method(deprecated_in((2, 1, 0)))
252
426
def check_basis(self, check_clean, require_commits=True):
253
427
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')")
428
raise errors.BzrCommandError(
429
"This branch has no commits."
430
" (perhaps you would prefer 'bzr pull')")
257
432
self.compare_basis()
258
433
if self.this_basis != self.this_rev_id:
259
434
raise errors.UncommittedChanges(self.this_tree)
436
@deprecated_method(deprecated_in((2, 1, 0)))
261
437
def compare_basis(self):
263
439
basis_tree = self.revision_tree(self.this_tree.last_revision())
264
440
except errors.NoSuchRevision:
265
441
basis_tree = self.this_tree.basis_tree()
266
changes = self.this_tree.changes_from(basis_tree)
267
if not changes.has_changed():
442
if not self.this_tree.has_changes(basis_tree):
268
443
self.this_rev_id = self.this_basis
270
445
def set_interesting_files(self, file_list):
271
446
self.interesting_files = file_list
273
448
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:
449
if (not self.base_is_ancestor or not self.base_is_other_ancestor
450
or self.other_rev_id is None):
276
452
self._add_parent()
278
454
def _add_parent(self):
279
455
new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
280
456
new_parent_trees = []
457
operation = OperationWithCleanups(self.this_tree.set_parent_trees)
281
458
for revision_id in new_parents:
283
460
tree = self.revision_tree(revision_id)
349
521
target.fetch(source, revision_id)
351
523
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
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
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)
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)
365
568
self.base_is_ancestor = True
366
569
self.base_is_other_ancestor = True
570
trace.mutter('Base revid: %r' % self.base_rev_id)
368
572
def set_base(self, base_revision):
369
573
"""Set the base revision to use for the merge.
371
575
:param base_revision: A 2-list containing a path and revision number.
373
mutter("doing merge() with no base_revision specified")
577
trace.mutter("doing merge() with no base_revision specified")
374
578
if base_revision == [None, None]:
389
593
'other_tree': self.other_tree,
390
594
'interesting_ids': self.interesting_ids,
391
595
'interesting_files': self.interesting_files,
596
'this_branch': self.this_branch,
393
597
'do_merge': False}
394
598
if self.merge_type.requires_base:
395
599
kwargs['base_tree'] = self.base_tree
396
600
if self.merge_type.supports_reprocess:
397
601
kwargs['reprocess'] = self.reprocess
398
602
elif self.reprocess:
399
raise BzrError("Conflict reduction is not supported for merge"
400
" type %s." % self.merge_type)
603
raise errors.BzrError(
604
"Conflict reduction is not supported for merge"
605
" type %s." % self.merge_type)
401
606
if self.merge_type.supports_show_base:
402
607
kwargs['show_base'] = self.show_base
403
608
elif self.show_base:
404
raise BzrError("Showing base is not supported for this"
405
" merge type. %s" % self.merge_type)
609
raise errors.BzrError("Showing base is not supported for this"
610
" merge type. %s" % self.merge_type)
406
611
if (not getattr(self.merge_type, 'supports_reverse_cherrypick', True)
407
612
and not self.base_is_other_ancestor):
408
613
raise errors.CannotReverseCherrypick()
409
614
if self.merge_type.supports_cherrypick:
410
615
kwargs['cherrypick'] = (not self.base_is_ancestor or
411
616
not self.base_is_other_ancestor)
412
return self.merge_type(pb=self._pb,
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,
413
621
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
416
647
def do_merge(self):
648
operation = OperationWithCleanups(self._do_merge_to)
417
649
self.this_tree.lock_tree_write()
650
operation.add_cleanup(self.this_tree.unlock)
418
651
if self.base_tree is not None:
419
652
self.base_tree.lock_read()
653
operation.add_cleanup(self.base_tree.unlock)
420
654
if self.other_tree is not None:
421
655
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()
656
operation.add_cleanup(self.other_tree.unlock)
657
merge = operation.run_simple()
448
658
if len(merge.cooked_conflicts) == 0:
449
if not self.ignore_zero and not is_quiet():
450
note("All changes applied successfully.")
659
if not self.ignore_zero and not trace.is_quiet():
660
trace.note("All changes applied successfully.")
452
note("%d conflicts encountered." % len(merge.cooked_conflicts))
662
trace.note("%d conflicts encountered."
663
% len(merge.cooked_conflicts))
454
665
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()
457
685
class Merge3Merger(object):
458
686
"""Three-way merger that uses the merge3 text merger"""
459
687
requires_base = True
463
691
supports_cherrypick = True
464
692
supports_reverse_cherrypick = True
465
693
winner_idx = {"this": 2, "other": 1, "conflict": 1}
694
supports_lca_trees = True
467
def __init__(self, working_tree, this_tree, base_tree, other_tree,
696
def __init__(self, working_tree, this_tree, base_tree, other_tree,
468
697
interesting_ids=None, reprocess=False, show_base=False,
469
pb=DummyProgress(), pp=None, change_reporter=None,
698
pb=None, pp=None, change_reporter=None,
470
699
interesting_files=None, do_merge=True,
700
cherrypick=False, lca_trees=None, this_branch=None):
472
701
"""Initialize the merger object and perform the merge.
474
703
:param working_tree: The working tree to apply the merge to
475
704
:param this_tree: The local tree in the merge operation
476
705
:param base_tree: The common tree in the merge operation
477
:param other_tree: The other other tree to merge changes from
706
:param other_tree: The other tree to merge changes from
707
:param this_branch: The branch associated with this_tree
478
708
:param interesting_ids: The file_ids of files that should be
479
709
participate in the merge. May not be combined with
480
710
interesting_files.
481
711
:param: reprocess If True, perform conflict-reduction processing.
482
712
:param show_base: If True, show the base revision in text conflicts.
483
713
(incompatible with reprocess)
484
:param pb: A Progress bar
485
715
:param pp: A ProgressPhase object
486
716
:param change_reporter: An object that should report changes made
487
717
:param interesting_files: The tree-relative paths of files that should
500
733
self.this_tree = working_tree
501
734
self.base_tree = base_tree
502
735
self.other_tree = other_tree
736
self.this_branch = this_branch
503
737
self._raw_conflicts = []
504
738
self.cooked_conflicts = []
505
739
self.reprocess = reprocess
506
740
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]
509
747
self.change_reporter = change_reporter
510
748
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")
516
756
def do_merge(self):
757
operation = OperationWithCleanups(self._do_merge)
517
758
self.this_tree.lock_tree_write()
759
operation.add_cleanup(self.this_tree.unlock)
518
760
self.base_tree.lock_read()
761
operation.add_cleanup(self.base_tree.unlock)
519
762
self.other_tree.lock_read()
520
self.tt = TreeTransform(self.this_tree, self.pb)
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)
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()
773
self.this_tree.add_conflicts(self.cooked_conflicts)
774
except errors.UnsupportedOperation:
538
777
def make_preview_transform(self):
778
operation = OperationWithCleanups(self._make_preview_transform)
539
779
self.base_tree.lock_read()
780
operation.add_cleanup(self.base_tree.unlock)
540
781
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()
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()
552
790
def _compute_transform(self):
553
entries = self._entries3()
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
554
797
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]
556
802
for num, (file_id, changed, parents3, names3,
557
803
executable3) in enumerate(entries):
558
804
child_pb.update('Preparing file merge', num, len(entries))
559
self._merge_names(file_id, parents3, names3)
805
self._merge_names(file_id, parents3, names3, resolver=resolver)
561
file_status = self.merge_contents(file_id)
807
file_status = self._do_merge_contents(file_id)
563
809
file_status = 'unmodified'
564
810
self._merge_executable(file_id,
565
executable3, file_status)
811
executable3, file_status, resolver=resolver)
567
813
child_pb.finished()
570
815
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))
817
fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
818
lambda t, c: transform.conflict_pass(t, c, self.other_tree))
575
820
child_pb.finished()
576
821
if self.change_reporter is not None:
614
862
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)
617
1032
def fix_root(self):
619
1034
self.tt.final_kind(self.tt.root)
1035
except errors.NoSuchFile:
621
1036
self.tt.cancel_deletion(self.tt.root)
622
1037
if self.tt.final_file_id(self.tt.root) is None:
623
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
1038
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
625
if self.other_tree.inventory.root is None:
627
1040
other_root_file_id = self.other_tree.get_root_id()
1041
if other_root_file_id is None:
628
1043
other_root = self.tt.trans_id_file_id(other_root_file_id)
629
1044
if other_root == self.tt.root:
632
1047
self.tt.final_kind(other_root)
1048
except errors.NoSuchFile:
635
if self.other_tree.inventory.root.file_id in self.this_tree.inventory:
1050
if self.this_tree.has_id(self.other_tree.inventory.root.file_id):
636
1051
# the other tree's root is a non-root in the current tree
638
1053
self.reparent_children(self.other_tree.inventory.root, self.tt.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
@deprecated_method(deprecated_in((2, 2, 0)))
711
1177
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
712
1178
"""Do a three-way test on a scalar.
713
1179
Return "this", "other" or "conflict", depending whether a value wins.
797
1264
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
1266
# See SPOT run. run, SPOT, run.
812
1267
# So we're not QUITE repeating ourselves; we do tricky things with
814
1269
base_pair = contents_pair(self.base_tree)
815
1270
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()
1272
this_pair = contents_pair(self.this_tree)
1273
lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
1274
winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
1275
this_pair, allow_overriding_lca=False)
1277
if base_pair == other_pair:
1280
# We delayed evaluating this_pair as long as we can to avoid
1281
# unnecessary sha1 calculation
1282
this_pair = contents_pair(self.this_tree)
1283
winner = self._three_way(base_pair, other_pair, this_pair)
1284
if winner == 'this':
1285
# No interesting changes introduced by OTHER
1287
# We have a hypothetical conflict, but if we have files, then we
1288
# can try to merge the content
1289
trans_id = self.tt.trans_id_file_id(file_id)
1290
params = MergeHookParams(self, file_id, trans_id, this_pair[0],
1291
other_pair[0], winner)
1292
hooks = self.active_hooks
1293
hook_status = 'not_applicable'
1295
hook_status, lines = hook.merge_contents(params)
1296
if hook_status != 'not_applicable':
1297
# Don't try any more hooks, this one applies.
1300
if hook_status == 'not_applicable':
1301
# This is a contents conflict, because none of the available
1302
# functions could merge it.
1304
name = self.tt.final_name(trans_id)
1305
parent_id = self.tt.final_parent(trans_id)
1306
if self.this_tree.has_id(file_id):
1307
self.tt.unversion_file(trans_id)
1308
file_group = self._dump_conflicts(name, parent_id, file_id,
1310
self._raw_conflicts.append(('contents conflict', file_group))
1311
elif hook_status == 'success':
1312
self.tt.create_file(lines, trans_id)
1313
elif hook_status == 'conflicted':
1314
# XXX: perhaps the hook should be able to provide
1315
# the BASE/THIS/OTHER files?
1316
self.tt.create_file(lines, trans_id)
1317
self._raw_conflicts.append(('text conflict', trans_id))
1318
name = self.tt.final_name(trans_id)
1319
parent_id = self.tt.final_parent(trans_id)
1320
self._dump_conflicts(name, parent_id, file_id)
1321
elif hook_status == 'delete':
1322
self.tt.unversion_file(trans_id)
1324
elif hook_status == 'done':
1325
# The hook function did whatever it needs to do directly, no
1326
# further action needed here.
1329
raise AssertionError('unknown hook_status: %r' % (hook_status,))
1330
if not self.this_tree.has_id(file_id) and result == "modified":
1331
self.tt.version_file(file_id, trans_id)
1332
# The merge has been performed, so the old contents should not be
1335
self.tt.delete_contents(trans_id)
1336
except errors.NoSuchFile:
1340
def _default_other_winner_merge(self, merge_hook_params):
1341
"""Replace this contents with other."""
1342
file_id = merge_hook_params.file_id
1343
trans_id = merge_hook_params.trans_id
1344
file_in_this = self.this_tree.has_id(file_id)
1345
if self.other_tree.has_id(file_id):
1346
# OTHER changed the file
1348
if wt.supports_content_filtering():
1349
# We get the path from the working tree if it exists.
1350
# That fails though when OTHER is adding a file, so
1351
# we fall back to the other tree to find the path if
1352
# it doesn't exist locally.
1354
filter_tree_path = wt.id2path(file_id)
1355
except errors.NoSuchId:
1356
filter_tree_path = self.other_tree.id2path(file_id)
1358
# Skip the id2path lookup for older formats
1359
filter_tree_path = None
1360
transform.create_from_tree(self.tt, trans_id,
1361
self.other_tree, file_id,
1362
filter_tree_path=filter_tree_path)
1365
# OTHER deleted the file
1366
return 'delete', None
1368
raise AssertionError(
1369
'winner is OTHER, but file_id %r not in THIS or OTHER tree'
1372
def merge_contents(self, merge_hook_params):
1373
"""Fallback merge logic after user installed hooks."""
1374
# This function is used in merge hooks as the fallback instance.
1375
# Perhaps making this function and the functions it calls be a
1376
# a separate class would be better.
1377
if merge_hook_params.winner == 'other':
1378
# OTHER is a straight winner, so replace this contents with other
1379
return self._default_other_winner_merge(merge_hook_params)
1380
elif merge_hook_params.is_file_merge():
1381
# THIS and OTHER are both files, so text merge. Either
1382
# BASE is a file, or both converted to files, so at least we
1383
# have agreement that output should be a file.
1385
self.text_merge(merge_hook_params.file_id,
1386
merge_hook_params.trans_id)
1387
except errors.BinaryFile:
1388
return 'not_applicable', None
1391
return 'not_applicable', None
863
1393
def get_lines(self, tree, file_id):
864
1394
"""Return the lines in a file, or an empty list."""
1395
if tree.has_id(file_id):
866
1396
return tree.get_file(file_id).readlines()
919
1449
determined automatically. If set_version is true, the .OTHER, .THIS
920
1450
or .BASE (in that order) will be created as versioned files.
922
data = [('OTHER', self.other_tree, other_lines),
1452
data = [('OTHER', self.other_tree, other_lines),
923
1453
('THIS', self.this_tree, this_lines)]
925
1455
data.append(('BASE', self.base_tree, base_lines))
1457
# We need to use the actual path in the working tree of the file here,
1458
# ignoring the conflict suffixes
1460
if wt.supports_content_filtering():
1462
filter_tree_path = wt.id2path(file_id)
1463
except errors.NoSuchId:
1464
# file has been deleted
1465
filter_tree_path = None
1467
# Skip the id2path lookup for older formats
1468
filter_tree_path = None
926
1470
versioned = False
928
1472
for suffix, tree, lines in data:
1473
if tree.has_id(file_id):
930
1474
trans_id = self._conflict_file(name, parent_id, tree, file_id,
1475
suffix, lines, filter_tree_path)
932
1476
file_group.append(trans_id)
933
1477
if set_version and not versioned:
934
1478
self.tt.version_file(file_id, trans_id)
935
1479
versioned = True
936
1480
return file_group
938
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1482
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1483
lines=None, filter_tree_path=None):
940
1484
"""Emit a single conflict file."""
941
1485
name = name + '.' + suffix
942
1486
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)
1487
transform.create_from_tree(self.tt, trans_id, tree, file_id, lines,
947
1491
def merge_executable(self, file_id, file_status):
948
1492
"""Perform a merge on the execute bit."""
949
1493
executable = [self.executable(t, file_id) for t in (self.base_tree,
950
1494
self.other_tree, self.this_tree)]
951
self._merge_executable(file_id, executable, file_status)
1495
self._merge_executable(file_id, executable, file_status,
1496
resolver=self._three_way)
953
def _merge_executable(self, file_id, executable, file_status):
1498
def _merge_executable(self, file_id, executable, file_status,
954
1500
"""Perform a merge on the execute bit."""
955
1501
base_executable, other_executable, this_executable = executable
956
1502
if file_status == "deleted":
958
winner = self._three_way(*executable)
1504
winner = resolver(*executable)
959
1505
if winner == "conflict":
960
1506
# There must be a None in here, if we have a conflict, but we
961
1507
# need executability since file status was not deleted.
1053
1602
supports_reverse_cherrypick = False
1054
1603
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,
1605
def _generate_merge_plan(self, file_id, base):
1606
return self.this_tree.plan_file_merge(file_id, self.other_tree,
1609
def _merged_lines(self, file_id):
1610
"""Generate the merged lines.
1611
There is no distinction between lines that are meant to contain <<<<<<<
1615
base = self.base_tree
1618
plan = self._generate_merge_plan(file_id, base)
1067
1619
if 'merge' in debug.debug_flags:
1068
1620
plan = list(plan)
1069
1621
trans_id = self.tt.trans_id_file_id(file_id)
1070
1622
name = self.tt.final_name(trans_id) + '.plan'
1071
contents = ('%10s|%s' % l for l in plan)
1623
contents = ('%11s|%s' % l for l in plan)
1072
1624
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)
1625
textmerge = versionedfile.PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1626
'>>>>>>> MERGE-SOURCE\n')
1627
lines, conflicts = textmerge.merge_lines(self.reprocess)
1629
base_lines = textmerge.base_from_plan()
1632
return lines, base_lines
1077
1634
def text_merge(self, file_id, trans_id):
1078
1635
"""Perform a (weave) text merge for a given file and file-id.
1079
1636
If conflicts are encountered, .THIS and .OTHER files will be emitted,
1080
1637
and a conflict will be noted.
1082
lines, conflicts = self._merged_lines(file_id)
1639
lines, base_lines = self._merged_lines(file_id)
1083
1640
lines = list(lines)
1084
# Note we're checking whether the OUTPUT is binary in this case,
1641
# Note we're checking whether the OUTPUT is binary in this case,
1085
1642
# because we don't want to get into weave merge guts.
1086
check_text_lines(lines)
1643
textfile.check_text_lines(lines)
1087
1644
self.tt.create_file(lines, trans_id)
1645
if base_lines is not None:
1089
1647
self._raw_conflicts.append(('text conflict', trans_id))
1090
1648
name = self.tt.final_name(trans_id)
1091
1649
parent_id = self.tt.final_parent(trans_id)
1092
file_group = self._dump_conflicts(name, parent_id, file_id,
1650
file_group = self._dump_conflicts(name, parent_id, file_id,
1652
base_lines=base_lines)
1094
1653
file_group.append(trans_id)
1097
1656
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,
1658
def _generate_merge_plan(self, file_id, base):
1659
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
1662
class Diff3Merger(Merge3Merger):
1122
1663
"""Three-way merger using external diff3 for text merging"""
1124
1665
def dump_file(self, temp_dir, name, tree, file_id):
1125
out_path = pathjoin(temp_dir, name)
1666
out_path = osutils.pathjoin(temp_dir, name)
1126
1667
out_file = open(out_path, "wb")
1128
1669
in_file = tree.get_file(file_id)
added
removed
bzrlib/merge.py
