~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: Richard Wilbur
  • Date: 2016-02-04 19:07:28 UTC
  • mto: This revision was merged to the branch mainline in revision 6618.
  • Revision ID: richard.wilbur@gmail.com-20160204190728-p0zvfii6zase0fw7
Update COPYING.txt from the original http://www.gnu.org/licenses/gpl-2.0.txt  (Only differences were in whitespace.)  Thanks to Petr Stodulka for pointing out the discrepancy.

Show diffs side-by-side

added added

removed removed

Lines of Context:
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
from __future__ import absolute_import
 
18
 
17
19
import warnings
18
20
 
19
21
from bzrlib.lazy_import import lazy_import
38
40
    versionedfile,
39
41
    workingtree,
40
42
    )
 
43
from bzrlib.i18n import gettext
41
44
""")
42
45
from bzrlib import (
43
46
    decorators,
44
47
    errors,
45
48
    hooks,
 
49
    registry,
46
50
    )
47
51
from bzrlib.symbol_versioning import (
48
52
    deprecated_in,
74
78
            "See the AbstractPerFileMerger API docs for details on how it is "
75
79
            "used by merge.",
76
80
            (2, 1))
 
81
        self.add_hook('pre_merge',
 
82
            'Called before a merge. '
 
83
            'Receives a Merger object as the single argument.',
 
84
            (2, 5))
 
85
        self.add_hook('post_merge',
 
86
            'Called after a merge. '
 
87
            'Receives a Merger object as the single argument. '
 
88
            'The return value is ignored.',
 
89
            (2, 5))
77
90
 
78
91
 
79
92
class AbstractPerFileMerger(object):
91
104
    def merge_contents(self, merge_params):
92
105
        """Attempt to merge the contents of a single file.
93
106
        
94
 
        :param merge_params: A bzrlib.merge.MergeHookParams
95
 
        :return : A tuple of (status, chunks), where status is one of
 
107
        :param merge_params: A bzrlib.merge.MergeFileHookParams
 
108
        :return: A tuple of (status, chunks), where status is one of
96
109
            'not_applicable', 'success', 'conflicted', or 'delete'.  If status
97
110
            is 'success' or 'conflicted', then chunks should be an iterable of
98
111
            strings for the new file contents.
118
131
 
119
132
    def get_filename(self, params, tree):
120
133
        """Lookup the filename (i.e. basename, not path), given a Tree (e.g.
121
 
        self.merger.this_tree) and a MergeHookParams.
 
134
        self.merger.this_tree) and a MergeFileHookParams.
122
135
        """
123
136
        return osutils.basename(tree.id2path(params.file_id))
124
137
 
125
138
    def get_filepath(self, params, tree):
126
139
        """Calculate the path to the file in a tree.
127
140
 
128
 
        :param params: A MergeHookParams describing the file to merge
 
141
        :param params: A MergeFileHookParams describing the file to merge
129
142
        :param tree: a Tree, e.g. self.merger.this_tree.
130
143
        """
131
144
        return tree.id2path(params.file_id)
138
151
            params.winner == 'other' or
139
152
            # THIS and OTHER aren't both files.
140
153
            not params.is_file_merge() or
141
 
            # The filename doesn't match *.xml
 
154
            # The filename doesn't match
142
155
            not self.file_matches(params)):
143
156
            return 'not_applicable', None
144
157
        return self.merge_matching(params)
220
233
        raise NotImplementedError(self.merge_text)
221
234
 
222
235
 
223
 
class MergeHookParams(object):
 
236
class MergeFileHookParams(object):
224
237
    """Object holding parameters passed to merge_file_content hooks.
225
238
 
226
239
    There are some fields hooks can access:
441
454
        revision_id = _mod_revision.ensure_null(revision_id)
442
455
        return branch, self.revision_tree(revision_id, branch)
443
456
 
444
 
    @deprecated_method(deprecated_in((2, 1, 0)))
445
 
    def ensure_revision_trees(self):
446
 
        if self.this_revision_tree is None:
447
 
            self.this_basis_tree = self.revision_tree(self.this_basis)
448
 
            if self.this_basis == self.this_rev_id:
449
 
                self.this_revision_tree = self.this_basis_tree
450
 
 
451
 
        if self.other_rev_id is None:
452
 
            other_basis_tree = self.revision_tree(self.other_basis)
453
 
            if other_basis_tree.has_changes(self.other_tree):
454
 
                raise errors.WorkingTreeNotRevision(self.this_tree)
455
 
            other_rev_id = self.other_basis
456
 
            self.other_tree = other_basis_tree
457
 
 
458
 
    @deprecated_method(deprecated_in((2, 1, 0)))
459
 
    def file_revisions(self, file_id):
460
 
        self.ensure_revision_trees()
461
 
        if self.this_rev_id is None:
462
 
            if self.this_basis_tree.get_file_sha1(file_id) != \
463
 
                self.this_tree.get_file_sha1(file_id):
464
 
                raise errors.WorkingTreeNotRevision(self.this_tree)
465
 
 
466
 
        trees = (self.this_basis_tree, self.other_tree)
467
 
        return [tree.get_file_revision(file_id) for tree in trees]
468
 
 
469
 
    @deprecated_method(deprecated_in((2, 1, 0)))
470
 
    def check_basis(self, check_clean, require_commits=True):
471
 
        if self.this_basis is None and require_commits is True:
472
 
            raise errors.BzrCommandError(
473
 
                "This branch has no commits."
474
 
                " (perhaps you would prefer 'bzr pull')")
475
 
        if check_clean:
476
 
            self.compare_basis()
477
 
            if self.this_basis != self.this_rev_id:
478
 
                raise errors.UncommittedChanges(self.this_tree)
479
 
 
480
 
    @deprecated_method(deprecated_in((2, 1, 0)))
481
 
    def compare_basis(self):
482
 
        try:
483
 
            basis_tree = self.revision_tree(self.this_tree.last_revision())
484
 
        except errors.NoSuchRevision:
485
 
            basis_tree = self.this_tree.basis_tree()
486
 
        if not self.this_tree.has_changes(basis_tree):
487
 
            self.this_rev_id = self.this_basis
488
 
 
489
457
    def set_interesting_files(self, file_list):
490
458
        self.interesting_files = file_list
491
459
 
536
504
                raise errors.NoCommits(self.other_branch)
537
505
        if self.other_rev_id is not None:
538
506
            self._cached_trees[self.other_rev_id] = self.other_tree
539
 
        self._maybe_fetch(self.other_branch,self.this_branch, self.other_basis)
 
507
        self._maybe_fetch(self.other_branch, self.this_branch, self.other_basis)
540
508
 
541
509
    def set_other_revision(self, revision_id, other_branch):
542
510
        """Set 'other' based on a branch and revision id
563
531
 
564
532
    def _maybe_fetch(self, source, target, revision_id):
565
533
        if not source.repository.has_same_location(target.repository):
566
 
            try:
567
 
                tags_to_fetch = set(source.tags.get_reverse_tag_dict())
568
 
            except errors.TagsNotSupported:
569
 
                tags_to_fetch = None
570
 
            fetch_spec = _mod_graph.NotInOtherForRevs(target.repository,
571
 
                source.repository, [revision_id],
572
 
                if_present_ids=tags_to_fetch).execute()
573
 
            target.fetch(source, fetch_spec=fetch_spec)
 
534
            target.fetch(source, revision_id)
574
535
 
575
536
    def find_base(self):
576
537
        revisions = [_mod_revision.ensure_null(self.this_basis),
598
559
                else:
599
560
                    self.base_rev_id = self.revision_graph.find_unique_lca(
600
561
                                            *lcas)
601
 
                sorted_lca_keys = self.revision_graph.find_merge_order(                
 
562
                sorted_lca_keys = self.revision_graph.find_merge_order(
602
563
                    revisions[0], lcas)
603
564
                if self.base_rev_id == _mod_revision.NULL_REVISION:
604
565
                    self.base_rev_id = sorted_lca_keys[0]
605
 
                
 
566
 
606
567
            if self.base_rev_id == _mod_revision.NULL_REVISION:
607
568
                raise errors.UnrelatedBranches()
608
569
            if self._is_criss_cross:
611
572
                trace.mutter('Criss-cross lcas: %r' % lcas)
612
573
                if self.base_rev_id in lcas:
613
574
                    trace.mutter('Unable to find unique lca. '
614
 
                                 'Fallback %r as best option.' % self.base_rev_id)
 
575
                                 'Fallback %r as best option.'
 
576
                                 % self.base_rev_id)
615
577
                interesting_revision_ids = set(lcas)
616
578
                interesting_revision_ids.add(self.base_rev_id)
617
579
                interesting_trees = dict((t.get_revision_id(), t)
650
612
            self._maybe_fetch(base_branch, self.this_branch, self.base_rev_id)
651
613
 
652
614
    def make_merger(self):
653
 
        kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
 
615
        kwargs = {'working_tree': self.this_tree, 'this_tree': self.this_tree,
654
616
                  'other_tree': self.other_tree,
655
617
                  'interesting_ids': self.interesting_ids,
656
618
                  'interesting_files': self.interesting_files,
657
619
                  'this_branch': self.this_branch,
 
620
                  'other_branch': self.other_branch,
658
621
                  'do_merge': False}
659
622
        if self.merge_type.requires_base:
660
623
            kwargs['base_tree'] = self.base_tree
686
649
        merge = self.make_merger()
687
650
        if self.other_branch is not None:
688
651
            self.other_branch.update_references(self.this_branch)
 
652
        for hook in Merger.hooks['pre_merge']:
 
653
            hook(merge)
689
654
        merge.do_merge()
 
655
        for hook in Merger.hooks['post_merge']:
 
656
            hook(merge)
690
657
        if self.recurse == 'down':
691
658
            for relpath, file_id in self.this_tree.iter_references():
692
659
                sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
696
663
                    continue
697
664
                sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
698
665
                sub_merge.merge_type = self.merge_type
699
 
                other_branch = self.other_branch.reference_parent(file_id, relpath)
 
666
                other_branch = self.other_branch.reference_parent(file_id,
 
667
                                                                  relpath)
700
668
                sub_merge.set_other_revision(other_revision, other_branch)
701
669
                base_revision = self.base_tree.get_reference_revision(file_id)
702
670
                sub_merge.base_tree = \
718
686
        merge = operation.run_simple()
719
687
        if len(merge.cooked_conflicts) == 0:
720
688
            if not self.ignore_zero and not trace.is_quiet():
721
 
                trace.note("All changes applied successfully.")
 
689
                trace.note(gettext("All changes applied successfully."))
722
690
        else:
723
 
            trace.note("%d conflicts encountered."
 
691
            trace.note(gettext("%d conflicts encountered.")
724
692
                       % len(merge.cooked_conflicts))
725
693
 
726
694
        return len(merge.cooked_conflicts)
758
726
                 interesting_ids=None, reprocess=False, show_base=False,
759
727
                 pb=None, pp=None, change_reporter=None,
760
728
                 interesting_files=None, do_merge=True,
761
 
                 cherrypick=False, lca_trees=None, this_branch=None):
 
729
                 cherrypick=False, lca_trees=None, this_branch=None,
 
730
                 other_branch=None):
762
731
        """Initialize the merger object and perform the merge.
763
732
 
764
733
        :param working_tree: The working tree to apply the merge to
767
736
        :param other_tree: The other tree to merge changes from
768
737
        :param this_branch: The branch associated with this_tree.  Defaults to
769
738
            this_tree.branch if not supplied.
 
739
        :param other_branch: The branch associated with other_tree, if any.
770
740
        :param interesting_ids: The file_ids of files that should be
771
741
            participate in the merge.  May not be combined with
772
742
            interesting_files.
794
764
            this_branch = this_tree.branch
795
765
        self.interesting_ids = interesting_ids
796
766
        self.interesting_files = interesting_files
797
 
        self.this_tree = working_tree
 
767
        self.working_tree = working_tree
 
768
        self.this_tree = this_tree
798
769
        self.base_tree = base_tree
799
770
        self.other_tree = other_tree
800
771
        self.this_branch = this_branch
 
772
        self.other_branch = other_branch
801
773
        self._raw_conflicts = []
802
774
        self.cooked_conflicts = []
803
775
        self.reprocess = reprocess
819
791
 
820
792
    def do_merge(self):
821
793
        operation = cleanup.OperationWithCleanups(self._do_merge)
822
 
        self.this_tree.lock_tree_write()
 
794
        self.working_tree.lock_tree_write()
 
795
        operation.add_cleanup(self.working_tree.unlock)
 
796
        self.this_tree.lock_read()
823
797
        operation.add_cleanup(self.this_tree.unlock)
824
798
        self.base_tree.lock_read()
825
799
        operation.add_cleanup(self.base_tree.unlock)
828
802
        operation.run()
829
803
 
830
804
    def _do_merge(self, operation):
831
 
        self.tt = transform.TreeTransform(self.this_tree, None)
 
805
        self.tt = transform.TreeTransform(self.working_tree, None)
832
806
        operation.add_cleanup(self.tt.finalize)
833
807
        self._compute_transform()
834
808
        results = self.tt.apply(no_conflicts=True)
835
809
        self.write_modified(results)
836
810
        try:
837
 
            self.this_tree.add_conflicts(self.cooked_conflicts)
 
811
            self.working_tree.add_conflicts(self.cooked_conflicts)
838
812
        except errors.UnsupportedOperation:
839
813
            pass
840
814
 
847
821
        return operation.run_simple()
848
822
 
849
823
    def _make_preview_transform(self):
850
 
        self.tt = transform.TransformPreview(self.this_tree)
 
824
        self.tt = transform.TransformPreview(self.working_tree)
851
825
        self._compute_transform()
852
826
        return self.tt
853
827
 
858
832
        else:
859
833
            entries = self._entries_lca()
860
834
            resolver = self._lca_multi_way
 
835
        # Prepare merge hooks
 
836
        factories = Merger.hooks['merge_file_content']
 
837
        # One hook for each registered one plus our default merger
 
838
        hooks = [factory(self) for factory in factories] + [self]
 
839
        self.active_hooks = [hook for hook in hooks if hook is not None]
861
840
        child_pb = ui.ui_factory.nested_progress_bar()
862
841
        try:
863
 
            factories = Merger.hooks['merge_file_content']
864
 
            hooks = [factory(self) for factory in factories] + [self]
865
 
            self.active_hooks = [hook for hook in hooks if hook is not None]
866
842
            for num, (file_id, changed, parents3, names3,
867
843
                      executable3) in enumerate(entries):
868
 
                child_pb.update('Preparing file merge', num, len(entries))
 
844
                # Try merging each entry
 
845
                child_pb.update(gettext('Preparing file merge'),
 
846
                                num, len(entries))
869
847
                self._merge_names(file_id, parents3, names3, resolver=resolver)
870
848
                if changed:
871
849
                    file_status = self._do_merge_contents(file_id)
875
853
                    executable3, file_status, resolver=resolver)
876
854
        finally:
877
855
            child_pb.finished()
878
 
        self.fix_root()
 
856
        self.tt.fixup_new_roots()
879
857
        self._finish_computing_transform()
880
858
 
881
859
    def _finish_computing_transform(self):
895
873
                self.tt.iter_changes(), self.change_reporter)
896
874
        self.cook_conflicts(fs_conflicts)
897
875
        for conflict in self.cooked_conflicts:
898
 
            trace.warning(conflict)
 
876
            trace.warning(unicode(conflict))
899
877
 
900
878
    def _entries3(self):
901
879
        """Gather data about files modified between three trees.
940
918
        it then compares with THIS and BASE.
941
919
 
942
920
        For the multi-valued entries, the format will be (BASE, [lca1, lca2])
943
 
        :return: [(file_id, changed, parents, names, executable)]
944
 
            file_id     Simple file_id of the entry
945
 
            changed     Boolean, True if the kind or contents changed
946
 
                        else False
947
 
            parents     ((base, [parent_id, in, lcas]), parent_id_other,
948
 
                         parent_id_this)
949
 
            names       ((base, [name, in, lcas]), name_in_other, name_in_this)
950
 
            executable  ((base, [exec, in, lcas]), exec_in_other, exec_in_this)
 
921
 
 
922
        :return: [(file_id, changed, parents, names, executable)], where:
 
923
 
 
924
            * file_id: Simple file_id of the entry
 
925
            * changed: Boolean, True if the kind or contents changed else False
 
926
            * parents: ((base, [parent_id, in, lcas]), parent_id_other,
 
927
                        parent_id_this)
 
928
            * names:   ((base, [name, in, lcas]), name_in_other, name_in_this)
 
929
            * executable: ((base, [exec, in, lcas]), exec_in_other,
 
930
                        exec_in_this)
951
931
        """
952
932
        if self.interesting_files is not None:
953
933
            lookup_trees = [self.this_tree, self.base_tree]
960
940
        result = []
961
941
        walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
962
942
 
963
 
        base_inventory = self.base_tree.inventory
964
 
        this_inventory = self.this_tree.inventory
 
943
        base_inventory = self.base_tree.root_inventory
 
944
        this_inventory = self.this_tree.root_inventory
965
945
        for path, file_id, other_ie, lca_values in walker.iter_all():
966
946
            # Is this modified at all from any of the other trees?
967
947
            if other_ie is None:
995
975
                else:
996
976
                    lca_entries.append(lca_ie)
997
977
 
998
 
            if file_id in base_inventory:
 
978
            if base_inventory.has_id(file_id):
999
979
                base_ie = base_inventory[file_id]
1000
980
            else:
1001
981
                base_ie = _none_entry
1002
982
 
1003
 
            if file_id in this_inventory:
 
983
            if this_inventory.has_id(file_id):
1004
984
                this_ie = this_inventory[file_id]
1005
985
            else:
1006
986
                this_ie = _none_entry
1098
1078
                          ))
1099
1079
        return result
1100
1080
 
1101
 
    def fix_root(self):
1102
 
        if self.tt.final_kind(self.tt.root) is None:
1103
 
            self.tt.cancel_deletion(self.tt.root)
1104
 
        if self.tt.final_file_id(self.tt.root) is None:
1105
 
            self.tt.version_file(self.tt.tree_file_id(self.tt.root),
1106
 
                                 self.tt.root)
1107
 
        other_root_file_id = self.other_tree.get_root_id()
1108
 
        if other_root_file_id is None:
1109
 
            return
1110
 
        other_root = self.tt.trans_id_file_id(other_root_file_id)
1111
 
        if other_root == self.tt.root:
1112
 
            return
1113
 
        if self.other_tree.inventory.root.file_id in self.this_tree.inventory:
1114
 
            # the other tree's root is a non-root in the current tree (as when
1115
 
            # a previously unrelated branch is merged into another)
1116
 
            return
1117
 
        if self.tt.final_kind(other_root) is not None:
1118
 
            other_root_is_present = True
1119
 
        else:
1120
 
            # other_root doesn't have a physical representation. We still need
1121
 
            # to move any references to the actual root of the tree.
1122
 
            other_root_is_present = False
1123
 
        # 'other_tree.inventory.root' is not present in this tree. We are
1124
 
        # calling adjust_path for children which *want* to be present with a
1125
 
        # correct place to go.
1126
 
        for _, child in self.other_tree.inventory.root.children.iteritems():
1127
 
            trans_id = self.tt.trans_id_file_id(child.file_id)
1128
 
            if not other_root_is_present:
1129
 
                if self.tt.final_kind(trans_id) is not None:
1130
 
                    # The item exist in the final tree and has a defined place
1131
 
                    # to go already.
1132
 
                    continue
1133
 
            # Move the item into the root
1134
 
            try:
1135
 
                final_name = self.tt.final_name(trans_id)
1136
 
            except errors.NoFinalPath:
1137
 
                # This file is not present anymore, ignore it.
1138
 
                continue
1139
 
            self.tt.adjust_path(final_name, self.tt.root, trans_id)
1140
 
        if other_root_is_present:
1141
 
            self.tt.cancel_creation(other_root)
1142
 
            self.tt.cancel_versioning(other_root)
1143
 
 
1144
1081
    def write_modified(self, results):
1145
1082
        modified_hashes = {}
1146
1083
        for path in results.modified_paths:
1147
 
            file_id = self.this_tree.path2id(self.this_tree.relpath(path))
 
1084
            file_id = self.working_tree.path2id(self.working_tree.relpath(path))
1148
1085
            if file_id is None:
1149
1086
                continue
1150
 
            hash = self.this_tree.get_file_sha1(file_id)
 
1087
            hash = self.working_tree.get_file_sha1(file_id)
1151
1088
            if hash is None:
1152
1089
                continue
1153
1090
            modified_hashes[file_id] = hash
1154
 
        self.this_tree.set_merge_modified(modified_hashes)
 
1091
        self.working_tree.set_merge_modified(modified_hashes)
1155
1092
 
1156
1093
    @staticmethod
1157
1094
    def parent(entry, file_id):
1170
1107
    @staticmethod
1171
1108
    def contents_sha1(tree, file_id):
1172
1109
        """Determine the sha1 of the file contents (used as a key method)."""
1173
 
        if file_id not in tree:
 
1110
        if not tree.has_id(file_id):
1174
1111
            return None
1175
1112
        return tree.get_file_sha1(file_id)
1176
1113
 
1256
1193
        # At this point, the lcas disagree, and the tip disagree
1257
1194
        return 'conflict'
1258
1195
 
1259
 
    @staticmethod
1260
 
    @deprecated_method(deprecated_in((2, 2, 0)))
1261
 
    def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
1262
 
        """Do a three-way test on a scalar.
1263
 
        Return "this", "other" or "conflict", depending whether a value wins.
1264
 
        """
1265
 
        key_base = key(base_tree, file_id)
1266
 
        key_other = key(other_tree, file_id)
1267
 
        #if base == other, either they all agree, or only THIS has changed.
1268
 
        if key_base == key_other:
1269
 
            return "this"
1270
 
        key_this = key(this_tree, file_id)
1271
 
        # "Ambiguous clean merge"
1272
 
        if key_this == key_other:
1273
 
            return "this"
1274
 
        elif key_this == key_base:
1275
 
            return "other"
1276
 
        else:
1277
 
            return "conflict"
1278
 
 
1279
1196
    def merge_names(self, file_id):
1280
1197
        def get_entry(tree):
1281
 
            if tree.has_id(file_id):
1282
 
                return tree.inventory[file_id]
1283
 
            else:
 
1198
            try:
 
1199
                return tree.root_inventory[file_id]
 
1200
            except errors.NoSuchId:
1284
1201
                return None
1285
1202
        this_entry = get_entry(self.this_tree)
1286
1203
        other_entry = get_entry(self.other_tree)
1321
1238
            self._raw_conflicts.append(('path conflict', trans_id, file_id,
1322
1239
                                        this_parent, this_name,
1323
1240
                                        other_parent, other_name))
1324
 
        if other_name is None:
 
1241
        if not self.other_tree.has_id(file_id):
1325
1242
            # it doesn't matter whether the result was 'other' or
1326
 
            # 'conflict'-- if there's no 'other', we leave it alone.
 
1243
            # 'conflict'-- if it has no file id, we leave it alone.
1327
1244
            return
1328
1245
        parent_id = parents[self.winner_idx[parent_id_winner]]
1329
 
        if parent_id is not None:
 
1246
        name = names[self.winner_idx[name_winner]]
 
1247
        if parent_id is not None or name is not None:
1330
1248
            # if we get here, name_winner and parent_winner are set to safe
1331
1249
            # values.
1332
 
            self.tt.adjust_path(names[self.winner_idx[name_winner]],
1333
 
                                self.tt.trans_id_file_id(parent_id),
 
1250
            if parent_id is None and name is not None:
 
1251
                # if parent_id is None and name is non-None, current file is
 
1252
                # the tree root.
 
1253
                if names[self.winner_idx[parent_id_winner]] != '':
 
1254
                    raise AssertionError(
 
1255
                        'File looks like a root, but named %s' %
 
1256
                        names[self.winner_idx[parent_id_winner]])
 
1257
                parent_trans_id = transform.ROOT_PARENT
 
1258
            else:
 
1259
                parent_trans_id = self.tt.trans_id_file_id(parent_id)
 
1260
            self.tt.adjust_path(name, parent_trans_id,
1334
1261
                                self.tt.trans_id_file_id(file_id))
1335
1262
 
1336
1263
    def _do_merge_contents(self, file_id):
1337
1264
        """Performs a merge on file_id contents."""
1338
1265
        def contents_pair(tree):
1339
 
            if file_id not in tree:
 
1266
            if not tree.has_id(file_id):
1340
1267
                return (None, None)
1341
1268
            kind = tree.kind(file_id)
1342
1269
            if kind == "file":
1371
1298
        # We have a hypothetical conflict, but if we have files, then we
1372
1299
        # can try to merge the content
1373
1300
        trans_id = self.tt.trans_id_file_id(file_id)
1374
 
        params = MergeHookParams(self, file_id, trans_id, this_pair[0],
 
1301
        params = MergeFileHookParams(self, file_id, trans_id, this_pair[0],
1375
1302
            other_pair[0], winner)
1376
1303
        hooks = self.active_hooks
1377
1304
        hook_status = 'not_applicable'
1380
1307
            if hook_status != 'not_applicable':
1381
1308
                # Don't try any more hooks, this one applies.
1382
1309
                break
 
1310
        # If the merge ends up replacing the content of the file, we get rid of
 
1311
        # it at the end of this method (this variable is used to track the
 
1312
        # exceptions to this rule).
 
1313
        keep_this = False
1383
1314
        result = "modified"
1384
1315
        if hook_status == 'not_applicable':
1385
 
            # This is a contents conflict, because none of the available
1386
 
            # functions could merge it.
 
1316
            # No merge hook was able to resolve the situation. Two cases exist:
 
1317
            # a content conflict or a duplicate one.
1387
1318
            result = None
1388
1319
            name = self.tt.final_name(trans_id)
1389
1320
            parent_id = self.tt.final_parent(trans_id)
1390
 
            if self.this_tree.has_id(file_id):
1391
 
                self.tt.unversion_file(trans_id)
1392
 
            file_group = self._dump_conflicts(name, parent_id, file_id,
1393
 
                                              set_version=True)
1394
 
            self._raw_conflicts.append(('contents conflict', file_group))
 
1321
            duplicate = False
 
1322
            inhibit_content_conflict = False
 
1323
            if params.this_kind is None: # file_id is not in THIS
 
1324
                # Is the name used for a different file_id ?
 
1325
                dupe_path = self.other_tree.id2path(file_id)
 
1326
                this_id = self.this_tree.path2id(dupe_path)
 
1327
                if this_id is not None:
 
1328
                    # Two entries for the same path
 
1329
                    keep_this = True
 
1330
                    # versioning the merged file will trigger a duplicate
 
1331
                    # conflict
 
1332
                    self.tt.version_file(file_id, trans_id)
 
1333
                    transform.create_from_tree(
 
1334
                        self.tt, trans_id, self.other_tree, file_id,
 
1335
                        filter_tree_path=self._get_filter_tree_path(file_id))
 
1336
                    inhibit_content_conflict = True
 
1337
            elif params.other_kind is None: # file_id is not in OTHER
 
1338
                # Is the name used for a different file_id ?
 
1339
                dupe_path = self.this_tree.id2path(file_id)
 
1340
                other_id = self.other_tree.path2id(dupe_path)
 
1341
                if other_id is not None:
 
1342
                    # Two entries for the same path again, but here, the other
 
1343
                    # entry will also be merged.  We simply inhibit the
 
1344
                    # 'content' conflict creation because we know OTHER will
 
1345
                    # create (or has already created depending on ordering) an
 
1346
                    # entry at the same path. This will trigger a 'duplicate'
 
1347
                    # conflict later.
 
1348
                    keep_this = True
 
1349
                    inhibit_content_conflict = True
 
1350
            if not inhibit_content_conflict:
 
1351
                if params.this_kind is not None:
 
1352
                    self.tt.unversion_file(trans_id)
 
1353
                # This is a contents conflict, because none of the available
 
1354
                # functions could merge it.
 
1355
                file_group = self._dump_conflicts(name, parent_id, file_id,
 
1356
                                                  set_version=True)
 
1357
                self._raw_conflicts.append(('contents conflict', file_group))
1395
1358
        elif hook_status == 'success':
1396
1359
            self.tt.create_file(lines, trans_id)
1397
1360
        elif hook_status == 'conflicted':
1413
1376
            raise AssertionError('unknown hook_status: %r' % (hook_status,))
1414
1377
        if not self.this_tree.has_id(file_id) and result == "modified":
1415
1378
            self.tt.version_file(file_id, trans_id)
1416
 
        # The merge has been performed, so the old contents should not be
1417
 
        # retained.
1418
 
        self.tt.delete_contents(trans_id)
 
1379
        if not keep_this:
 
1380
            # The merge has been performed and produced a new content, so the
 
1381
            # old contents should not be retained.
 
1382
            self.tt.delete_contents(trans_id)
1419
1383
        return result
1420
1384
 
1421
1385
    def _default_other_winner_merge(self, merge_hook_params):
1422
1386
        """Replace this contents with other."""
1423
1387
        file_id = merge_hook_params.file_id
1424
1388
        trans_id = merge_hook_params.trans_id
1425
 
        file_in_this = self.this_tree.has_id(file_id)
1426
1389
        if self.other_tree.has_id(file_id):
1427
1390
            # OTHER changed the file
1428
 
            wt = self.this_tree
1429
 
            if wt.supports_content_filtering():
1430
 
                # We get the path from the working tree if it exists.
1431
 
                # That fails though when OTHER is adding a file, so
1432
 
                # we fall back to the other tree to find the path if
1433
 
                # it doesn't exist locally.
1434
 
                try:
1435
 
                    filter_tree_path = wt.id2path(file_id)
1436
 
                except errors.NoSuchId:
1437
 
                    filter_tree_path = self.other_tree.id2path(file_id)
1438
 
            else:
1439
 
                # Skip the id2path lookup for older formats
1440
 
                filter_tree_path = None
1441
 
            transform.create_from_tree(self.tt, trans_id,
1442
 
                             self.other_tree, file_id,
1443
 
                             filter_tree_path=filter_tree_path)
 
1391
            transform.create_from_tree(
 
1392
                self.tt, trans_id, self.other_tree, file_id,
 
1393
                filter_tree_path=self._get_filter_tree_path(file_id))
1444
1394
            return 'done', None
1445
 
        elif file_in_this:
 
1395
        elif self.this_tree.has_id(file_id):
1446
1396
            # OTHER deleted the file
1447
1397
            return 'delete', None
1448
1398
        else:
1522
1472
                                              other_lines)
1523
1473
            file_group.append(trans_id)
1524
1474
 
 
1475
 
 
1476
    def _get_filter_tree_path(self, file_id):
 
1477
        if self.this_tree.supports_content_filtering():
 
1478
            # We get the path from the working tree if it exists.
 
1479
            # That fails though when OTHER is adding a file, so
 
1480
            # we fall back to the other tree to find the path if
 
1481
            # it doesn't exist locally.
 
1482
            try:
 
1483
                return self.this_tree.id2path(file_id)
 
1484
            except errors.NoSuchId:
 
1485
                return self.other_tree.id2path(file_id)
 
1486
        # Skip the id2path lookup for older formats
 
1487
        return None
 
1488
 
1525
1489
    def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
1526
1490
                        base_lines=None, other_lines=None, set_version=False,
1527
1491
                        no_base=False):
1610
1574
 
1611
1575
    def cook_conflicts(self, fs_conflicts):
1612
1576
        """Convert all conflicts into a form that doesn't depend on trans_id"""
1613
 
        self.cooked_conflicts.extend(transform.cook_conflicts(
1614
 
                fs_conflicts, self.tt))
 
1577
        content_conflict_file_ids = set()
 
1578
        cooked_conflicts = transform.cook_conflicts(fs_conflicts, self.tt)
1615
1579
        fp = transform.FinalPaths(self.tt)
1616
1580
        for conflict in self._raw_conflicts:
1617
1581
            conflict_type = conflict[0]
1628
1592
                if other_parent is None or other_name is None:
1629
1593
                    other_path = '<deleted>'
1630
1594
                else:
1631
 
                    parent_path =  fp.get_path(
1632
 
                        self.tt.trans_id_file_id(other_parent))
 
1595
                    if other_parent == self.other_tree.get_root_id():
 
1596
                        # The tree transform doesn't know about the other root,
 
1597
                        # so we special case here to avoid a NoFinalPath
 
1598
                        # exception
 
1599
                        parent_path = ''
 
1600
                    else:
 
1601
                        parent_path =  fp.get_path(
 
1602
                            self.tt.trans_id_file_id(other_parent))
1633
1603
                    other_path = osutils.pathjoin(parent_path, other_name)
1634
1604
                c = _mod_conflicts.Conflict.factory(
1635
1605
                    'path conflict', path=this_path,
1639
1609
                for trans_id in conflict[1]:
1640
1610
                    file_id = self.tt.final_file_id(trans_id)
1641
1611
                    if file_id is not None:
 
1612
                        # Ok we found the relevant file-id
1642
1613
                        break
1643
1614
                path = fp.get_path(trans_id)
1644
1615
                for suffix in ('.BASE', '.THIS', '.OTHER'):
1645
1616
                    if path.endswith(suffix):
 
1617
                        # Here is the raw path
1646
1618
                        path = path[:-len(suffix)]
1647
1619
                        break
1648
1620
                c = _mod_conflicts.Conflict.factory(conflict_type,
1649
1621
                                                    path=path, file_id=file_id)
 
1622
                content_conflict_file_ids.add(file_id)
1650
1623
            elif conflict_type == 'text conflict':
1651
1624
                trans_id = conflict[1]
1652
1625
                path = fp.get_path(trans_id)
1655
1628
                                                    path=path, file_id=file_id)
1656
1629
            else:
1657
1630
                raise AssertionError('bad conflict type: %r' % (conflict,))
 
1631
            cooked_conflicts.append(c)
 
1632
 
 
1633
        self.cooked_conflicts = []
 
1634
        # We want to get rid of path conflicts when a corresponding contents
 
1635
        # conflict exists. This can occur when one branch deletes a file while
 
1636
        # the other renames *and* modifies it. In this case, the content
 
1637
        # conflict is enough.
 
1638
        for c in cooked_conflicts:
 
1639
            if (c.typestring == 'path conflict'
 
1640
                and c.file_id in content_conflict_file_ids):
 
1641
                continue
1658
1642
            self.cooked_conflicts.append(c)
1659
1643
        self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
1660
1644
 
1881
1865
            entries = self._entries_to_incorporate()
1882
1866
            entries = list(entries)
1883
1867
            for num, (entry, parent_id) in enumerate(entries):
1884
 
                child_pb.update('Preparing file merge', num, len(entries))
 
1868
                child_pb.update(gettext('Preparing file merge'), num, len(entries))
1885
1869
                parent_trans_id = self.tt.trans_id_file_id(parent_id)
1886
1870
                trans_id = transform.new_by_entry(self.tt, entry,
1887
1871
                    parent_trans_id, self.other_tree)
1891
1875
 
1892
1876
    def _entries_to_incorporate(self):
1893
1877
        """Yields pairs of (inventory_entry, new_parent)."""
1894
 
        other_inv = self.other_tree.inventory
 
1878
        other_inv = self.other_tree.root_inventory
1895
1879
        subdir_id = other_inv.path2id(self._source_subpath)
1896
1880
        if subdir_id is None:
1897
1881
            # XXX: The error would be clearer if it gave the URL of the source
1899
1883
            raise PathNotInTree(self._source_subpath, "Source tree")
1900
1884
        subdir = other_inv[subdir_id]
1901
1885
        parent_in_target = osutils.dirname(self._target_subdir)
1902
 
        target_id = self.this_tree.inventory.path2id(parent_in_target)
 
1886
        target_id = self.this_tree.path2id(parent_in_target)
1903
1887
        if target_id is None:
1904
1888
            raise PathNotInTree(self._target_subdir, "Target tree")
1905
1889
        name_in_target = osutils.basename(self._target_subdir)
1906
1890
        merge_into_root = subdir.copy()
1907
1891
        merge_into_root.name = name_in_target
1908
 
        if merge_into_root.file_id in self.this_tree.inventory:
 
1892
        if self.this_tree.has_id(merge_into_root.file_id):
1909
1893
            # Give the root a new file-id.
1910
1894
            # This can happen fairly easily if the directory we are
1911
1895
            # incorporating is the root, and both trees have 'TREE_ROOT' as
1948
1932
    """
1949
1933
    if this_tree is None:
1950
1934
        raise errors.BzrError("bzrlib.merge.merge_inner requires a this_tree "
1951
 
                              "parameter as of bzrlib version 0.8.")
 
1935
                              "parameter")
1952
1936
    merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1953
1937
                    pb=pb, change_reporter=change_reporter)
1954
1938
    merger.backup_files = backup_files
1971
1955
    merger.set_base_revision(get_revision_id(), this_branch)
1972
1956
    return merger.do_merge()
1973
1957
 
 
1958
 
 
1959
merge_type_registry = registry.Registry()
 
1960
merge_type_registry.register('diff3', Diff3Merger,
 
1961
                             "Merge using external diff3.")
 
1962
merge_type_registry.register('lca', LCAMerger,
 
1963
                             "LCA-newness merge.")
 
1964
merge_type_registry.register('merge3', Merge3Merger,
 
1965
                             "Native diff3-style merge.")
 
1966
merge_type_registry.register('weave', WeaveMerger,
 
1967
                             "Weave-based merge.")
 
1968
 
 
1969
 
1974
1970
def get_merge_type_registry():
1975
 
    """Merge type registry is in bzrlib.option to avoid circular imports.
 
1971
    """Merge type registry was previously in bzrlib.option
1976
1972
 
1977
 
    This method provides a sanctioned way to retrieve it.
 
1973
    This method provides a backwards compatible way to retrieve it.
1978
1974
    """
1979
 
    from bzrlib import option
1980
 
    return option._merge_type_registry
 
1975
    return merge_type_registry
1981
1976
 
1982
1977
 
1983
1978
def _plan_annotate_merge(annotated_a, annotated_b, ancestors_a, ancestors_b):
2408
2403
class _PlanLCAMerge(_PlanMergeBase):
2409
2404
    """
2410
2405
    This merge algorithm differs from _PlanMerge in that:
 
2406
 
2411
2407
    1. comparisons are done against LCAs only
2412
2408
    2. cases where a contested line is new versus one LCA but old versus
2413
2409
       another are marked as conflicts, by emitting the line as conflicted-a
2454
2450
 
2455
2451
        If a line is killed and new, this indicates that the two merge
2456
2452
        revisions contain differing conflict resolutions.
 
2453
 
2457
2454
        :param revision_id: The id of the revision in which the lines are
2458
2455
            unique
2459
2456
        :param unique_line_numbers: The line numbers of unique lines.
2460
 
        :return a tuple of (new_this, killed_other):
 
2457
        :return: a tuple of (new_this, killed_other)
2461
2458
        """
2462
2459
        new = set()
2463
2460
        killed = set()