~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: Andrew Bennetts
  • Date: 2010-10-08 08:15:14 UTC
  • mto: This revision was merged to the branch mainline in revision 5498.
  • Revision ID: andrew.bennetts@canonical.com-20101008081514-dviqzrdfwyzsqbz2
Split NEWS into per-release doc/en/release-notes/bzr-*.txt

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
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
 
 
19
17
import warnings
20
18
 
21
19
from bzrlib.lazy_import import lazy_import
22
20
lazy_import(globals(), """
23
21
from bzrlib import (
24
22
    branch as _mod_branch,
25
 
    cleanup,
26
23
    conflicts as _mod_conflicts,
27
24
    debug,
28
25
    generate_ids,
40
37
    versionedfile,
41
38
    workingtree,
42
39
    )
43
 
from bzrlib.i18n import gettext
 
40
from bzrlib.cleanup import OperationWithCleanups
44
41
""")
45
42
from bzrlib import (
46
43
    decorators,
47
44
    errors,
48
45
    hooks,
49
 
    registry,
50
46
    )
51
47
from bzrlib.symbol_versioning import (
52
48
    deprecated_in,
57
53
 
58
54
def transform_tree(from_tree, to_tree, interesting_ids=None):
59
55
    from_tree.lock_tree_write()
60
 
    operation = cleanup.OperationWithCleanups(merge_inner)
 
56
    operation = OperationWithCleanups(merge_inner)
61
57
    operation.add_cleanup(from_tree.unlock)
62
58
    operation.run_simple(from_tree.branch, to_tree, from_tree,
63
59
        ignore_zero=True, interesting_ids=interesting_ids, this_tree=from_tree)
66
62
class MergeHooks(hooks.Hooks):
67
63
 
68
64
    def __init__(self):
69
 
        hooks.Hooks.__init__(self, "bzrlib.merge", "Merger.hooks")
70
 
        self.add_hook('merge_file_content',
 
65
        hooks.Hooks.__init__(self)
 
66
        self.create_hook(hooks.HookPoint('merge_file_content',
71
67
            "Called with a bzrlib.merge.Merger object to create a per file "
72
68
            "merge object when starting a merge. "
73
69
            "Should return either None or a subclass of "
77
73
            "side has deleted the file and the other has changed it). "
78
74
            "See the AbstractPerFileMerger API docs for details on how it is "
79
75
            "used by merge.",
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))
 
76
            (2, 1), None))
90
77
 
91
78
 
92
79
class AbstractPerFileMerger(object):
104
91
    def merge_contents(self, merge_params):
105
92
        """Attempt to merge the contents of a single file.
106
93
        
107
 
        :param merge_params: A bzrlib.merge.MergeFileHookParams
108
 
        :return: A tuple of (status, chunks), where status is one of
 
94
        :param merge_params: A bzrlib.merge.MergeHookParams
 
95
        :return : A tuple of (status, chunks), where status is one of
109
96
            'not_applicable', 'success', 'conflicted', or 'delete'.  If status
110
97
            is 'success' or 'conflicted', then chunks should be an iterable of
111
98
            strings for the new file contents.
131
118
 
132
119
    def get_filename(self, params, tree):
133
120
        """Lookup the filename (i.e. basename, not path), given a Tree (e.g.
134
 
        self.merger.this_tree) and a MergeFileHookParams.
 
121
        self.merger.this_tree) and a MergeHookParams.
135
122
        """
136
123
        return osutils.basename(tree.id2path(params.file_id))
137
124
 
138
125
    def get_filepath(self, params, tree):
139
126
        """Calculate the path to the file in a tree.
140
127
 
141
 
        :param params: A MergeFileHookParams describing the file to merge
 
128
        :param params: A MergeHookParams describing the file to merge
142
129
        :param tree: a Tree, e.g. self.merger.this_tree.
143
130
        """
144
131
        return tree.id2path(params.file_id)
151
138
            params.winner == 'other' or
152
139
            # THIS and OTHER aren't both files.
153
140
            not params.is_file_merge() or
154
 
            # The filename doesn't match
 
141
            # The filename doesn't match *.xml
155
142
            not self.file_matches(params)):
156
143
            return 'not_applicable', None
157
144
        return self.merge_matching(params)
233
220
        raise NotImplementedError(self.merge_text)
234
221
 
235
222
 
236
 
class MergeFileHookParams(object):
 
223
class MergeHookParams(object):
237
224
    """Object holding parameters passed to merge_file_content hooks.
238
225
 
239
226
    There are some fields hooks can access:
454
441
        revision_id = _mod_revision.ensure_null(revision_id)
455
442
        return branch, self.revision_tree(revision_id, branch)
456
443
 
 
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
        def get_id(tree, file_id):
 
462
            revision_id = tree.inventory[file_id].revision
 
463
            return revision_id
 
464
        if self.this_rev_id is None:
 
465
            if self.this_basis_tree.get_file_sha1(file_id) != \
 
466
                self.this_tree.get_file_sha1(file_id):
 
467
                raise errors.WorkingTreeNotRevision(self.this_tree)
 
468
 
 
469
        trees = (self.this_basis_tree, self.other_tree)
 
470
        return [get_id(tree, file_id) for tree in trees]
 
471
 
 
472
    @deprecated_method(deprecated_in((2, 1, 0)))
 
473
    def check_basis(self, check_clean, require_commits=True):
 
474
        if self.this_basis is None and require_commits is True:
 
475
            raise errors.BzrCommandError(
 
476
                "This branch has no commits."
 
477
                " (perhaps you would prefer 'bzr pull')")
 
478
        if check_clean:
 
479
            self.compare_basis()
 
480
            if self.this_basis != self.this_rev_id:
 
481
                raise errors.UncommittedChanges(self.this_tree)
 
482
 
 
483
    @deprecated_method(deprecated_in((2, 1, 0)))
 
484
    def compare_basis(self):
 
485
        try:
 
486
            basis_tree = self.revision_tree(self.this_tree.last_revision())
 
487
        except errors.NoSuchRevision:
 
488
            basis_tree = self.this_tree.basis_tree()
 
489
        if not self.this_tree.has_changes(basis_tree):
 
490
            self.this_rev_id = self.this_basis
 
491
 
457
492
    def set_interesting_files(self, file_list):
458
493
        self.interesting_files = file_list
459
494
 
466
501
    def _add_parent(self):
467
502
        new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
468
503
        new_parent_trees = []
469
 
        operation = cleanup.OperationWithCleanups(
470
 
            self.this_tree.set_parent_trees)
 
504
        operation = OperationWithCleanups(self.this_tree.set_parent_trees)
471
505
        for revision_id in new_parents:
472
506
            try:
473
507
                tree = self.revision_tree(revision_id)
504
538
                raise errors.NoCommits(self.other_branch)
505
539
        if self.other_rev_id is not None:
506
540
            self._cached_trees[self.other_rev_id] = self.other_tree
507
 
        self._maybe_fetch(self.other_branch, self.this_branch, self.other_basis)
 
541
        self._maybe_fetch(self.other_branch,self.this_branch, self.other_basis)
508
542
 
509
543
    def set_other_revision(self, revision_id, other_branch):
510
544
        """Set 'other' based on a branch and revision id
548
582
            elif len(lcas) == 1:
549
583
                self.base_rev_id = list(lcas)[0]
550
584
            else: # len(lcas) > 1
551
 
                self._is_criss_cross = True
552
585
                if len(lcas) > 2:
553
586
                    # find_unique_lca can only handle 2 nodes, so we have to
554
587
                    # start back at the beginning. It is a shame to traverse
559
592
                else:
560
593
                    self.base_rev_id = self.revision_graph.find_unique_lca(
561
594
                                            *lcas)
562
 
                sorted_lca_keys = self.revision_graph.find_merge_order(
563
 
                    revisions[0], lcas)
564
 
                if self.base_rev_id == _mod_revision.NULL_REVISION:
565
 
                    self.base_rev_id = sorted_lca_keys[0]
566
 
 
 
595
                self._is_criss_cross = True
567
596
            if self.base_rev_id == _mod_revision.NULL_REVISION:
568
597
                raise errors.UnrelatedBranches()
569
598
            if self._is_criss_cross:
570
599
                trace.warning('Warning: criss-cross merge encountered.  See bzr'
571
600
                              ' help criss-cross.')
572
601
                trace.mutter('Criss-cross lcas: %r' % lcas)
573
 
                if self.base_rev_id in lcas:
574
 
                    trace.mutter('Unable to find unique lca. '
575
 
                                 'Fallback %r as best option.'
576
 
                                 % self.base_rev_id)
577
 
                interesting_revision_ids = set(lcas)
578
 
                interesting_revision_ids.add(self.base_rev_id)
 
602
                interesting_revision_ids = [self.base_rev_id]
 
603
                interesting_revision_ids.extend(lcas)
579
604
                interesting_trees = dict((t.get_revision_id(), t)
580
605
                    for t in self.this_branch.repository.revision_trees(
581
606
                        interesting_revision_ids))
582
607
                self._cached_trees.update(interesting_trees)
583
 
                if self.base_rev_id in lcas:
584
 
                    self.base_tree = interesting_trees[self.base_rev_id]
585
 
                else:
586
 
                    self.base_tree = interesting_trees.pop(self.base_rev_id)
 
608
                self.base_tree = interesting_trees.pop(self.base_rev_id)
 
609
                sorted_lca_keys = self.revision_graph.find_merge_order(
 
610
                    revisions[0], lcas)
587
611
                self._lca_trees = [interesting_trees[key]
588
612
                                   for key in sorted_lca_keys]
589
613
            else:
612
636
            self._maybe_fetch(base_branch, self.this_branch, self.base_rev_id)
613
637
 
614
638
    def make_merger(self):
615
 
        kwargs = {'working_tree': self.this_tree, 'this_tree': self.this_tree,
 
639
        kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
616
640
                  'other_tree': self.other_tree,
617
641
                  'interesting_ids': self.interesting_ids,
618
642
                  'interesting_files': self.interesting_files,
619
643
                  'this_branch': self.this_branch,
620
 
                  'other_branch': self.other_branch,
621
644
                  'do_merge': False}
622
645
        if self.merge_type.requires_base:
623
646
            kwargs['base_tree'] = self.base_tree
649
672
        merge = self.make_merger()
650
673
        if self.other_branch is not None:
651
674
            self.other_branch.update_references(self.this_branch)
652
 
        for hook in Merger.hooks['pre_merge']:
653
 
            hook(merge)
654
675
        merge.do_merge()
655
 
        for hook in Merger.hooks['post_merge']:
656
 
            hook(merge)
657
676
        if self.recurse == 'down':
658
677
            for relpath, file_id in self.this_tree.iter_references():
659
678
                sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
663
682
                    continue
664
683
                sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
665
684
                sub_merge.merge_type = self.merge_type
666
 
                other_branch = self.other_branch.reference_parent(file_id,
667
 
                                                                  relpath)
 
685
                other_branch = self.other_branch.reference_parent(file_id, relpath)
668
686
                sub_merge.set_other_revision(other_revision, other_branch)
669
687
                base_revision = self.base_tree.get_reference_revision(file_id)
670
688
                sub_merge.base_tree = \
674
692
        return merge
675
693
 
676
694
    def do_merge(self):
677
 
        operation = cleanup.OperationWithCleanups(self._do_merge_to)
 
695
        operation = OperationWithCleanups(self._do_merge_to)
678
696
        self.this_tree.lock_tree_write()
679
697
        operation.add_cleanup(self.this_tree.unlock)
680
698
        if self.base_tree is not None:
686
704
        merge = operation.run_simple()
687
705
        if len(merge.cooked_conflicts) == 0:
688
706
            if not self.ignore_zero and not trace.is_quiet():
689
 
                trace.note(gettext("All changes applied successfully."))
 
707
                trace.note("All changes applied successfully.")
690
708
        else:
691
 
            trace.note(gettext("%d conflicts encountered.")
 
709
            trace.note("%d conflicts encountered."
692
710
                       % len(merge.cooked_conflicts))
693
711
 
694
712
        return len(merge.cooked_conflicts)
726
744
                 interesting_ids=None, reprocess=False, show_base=False,
727
745
                 pb=None, pp=None, change_reporter=None,
728
746
                 interesting_files=None, do_merge=True,
729
 
                 cherrypick=False, lca_trees=None, this_branch=None,
730
 
                 other_branch=None):
 
747
                 cherrypick=False, lca_trees=None, this_branch=None):
731
748
        """Initialize the merger object and perform the merge.
732
749
 
733
750
        :param working_tree: The working tree to apply the merge to
736
753
        :param other_tree: The other tree to merge changes from
737
754
        :param this_branch: The branch associated with this_tree.  Defaults to
738
755
            this_tree.branch if not supplied.
739
 
        :param other_branch: The branch associated with other_tree, if any.
740
756
        :param interesting_ids: The file_ids of files that should be
741
757
            participate in the merge.  May not be combined with
742
758
            interesting_files.
764
780
            this_branch = this_tree.branch
765
781
        self.interesting_ids = interesting_ids
766
782
        self.interesting_files = interesting_files
767
 
        self.working_tree = working_tree
768
 
        self.this_tree = this_tree
 
783
        self.this_tree = working_tree
769
784
        self.base_tree = base_tree
770
785
        self.other_tree = other_tree
771
786
        self.this_branch = this_branch
772
 
        self.other_branch = other_branch
773
787
        self._raw_conflicts = []
774
788
        self.cooked_conflicts = []
775
789
        self.reprocess = reprocess
790
804
            warnings.warn("pb argument to Merge3Merger is deprecated")
791
805
 
792
806
    def do_merge(self):
793
 
        operation = cleanup.OperationWithCleanups(self._do_merge)
794
 
        self.working_tree.lock_tree_write()
795
 
        operation.add_cleanup(self.working_tree.unlock)
796
 
        self.this_tree.lock_read()
 
807
        operation = OperationWithCleanups(self._do_merge)
 
808
        self.this_tree.lock_tree_write()
797
809
        operation.add_cleanup(self.this_tree.unlock)
798
810
        self.base_tree.lock_read()
799
811
        operation.add_cleanup(self.base_tree.unlock)
802
814
        operation.run()
803
815
 
804
816
    def _do_merge(self, operation):
805
 
        self.tt = transform.TreeTransform(self.working_tree, None)
 
817
        self.tt = transform.TreeTransform(self.this_tree, None)
806
818
        operation.add_cleanup(self.tt.finalize)
807
819
        self._compute_transform()
808
820
        results = self.tt.apply(no_conflicts=True)
809
821
        self.write_modified(results)
810
822
        try:
811
 
            self.working_tree.add_conflicts(self.cooked_conflicts)
 
823
            self.this_tree.add_conflicts(self.cooked_conflicts)
812
824
        except errors.UnsupportedOperation:
813
825
            pass
814
826
 
815
827
    def make_preview_transform(self):
816
 
        operation = cleanup.OperationWithCleanups(self._make_preview_transform)
 
828
        operation = OperationWithCleanups(self._make_preview_transform)
817
829
        self.base_tree.lock_read()
818
830
        operation.add_cleanup(self.base_tree.unlock)
819
831
        self.other_tree.lock_read()
821
833
        return operation.run_simple()
822
834
 
823
835
    def _make_preview_transform(self):
824
 
        self.tt = transform.TransformPreview(self.working_tree)
 
836
        self.tt = transform.TransformPreview(self.this_tree)
825
837
        self._compute_transform()
826
838
        return self.tt
827
839
 
832
844
        else:
833
845
            entries = self._entries_lca()
834
846
            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]
840
847
        child_pb = ui.ui_factory.nested_progress_bar()
841
848
        try:
 
849
            factories = Merger.hooks['merge_file_content']
 
850
            hooks = [factory(self) for factory in factories] + [self]
 
851
            self.active_hooks = [hook for hook in hooks if hook is not None]
842
852
            for num, (file_id, changed, parents3, names3,
843
853
                      executable3) in enumerate(entries):
844
 
                # Try merging each entry
845
 
                child_pb.update(gettext('Preparing file merge'),
846
 
                                num, len(entries))
 
854
                child_pb.update('Preparing file merge', num, len(entries))
847
855
                self._merge_names(file_id, parents3, names3, resolver=resolver)
848
856
                if changed:
849
857
                    file_status = self._do_merge_contents(file_id)
853
861
                    executable3, file_status, resolver=resolver)
854
862
        finally:
855
863
            child_pb.finished()
856
 
        self.tt.fixup_new_roots()
 
864
        self.fix_root()
857
865
        self._finish_computing_transform()
858
866
 
859
867
    def _finish_computing_transform(self):
873
881
                self.tt.iter_changes(), self.change_reporter)
874
882
        self.cook_conflicts(fs_conflicts)
875
883
        for conflict in self.cooked_conflicts:
876
 
            trace.warning(unicode(conflict))
 
884
            trace.warning(conflict)
877
885
 
878
886
    def _entries3(self):
879
887
        """Gather data about files modified between three trees.
886
894
        """
887
895
        result = []
888
896
        iterator = self.other_tree.iter_changes(self.base_tree,
889
 
                specific_files=self.interesting_files,
 
897
                include_unchanged=True, specific_files=self.interesting_files,
890
898
                extra_trees=[self.this_tree])
891
899
        this_entries = dict((e.file_id, e) for p, e in
892
900
                            self.this_tree.iter_entries_by_dir(
918
926
        it then compares with THIS and BASE.
919
927
 
920
928
        For the multi-valued entries, the format will be (BASE, [lca1, lca2])
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)
 
929
        :return: [(file_id, changed, parents, names, executable)]
 
930
            file_id     Simple file_id of the entry
 
931
            changed     Boolean, True if the kind or contents changed
 
932
                        else False
 
933
            parents     ((base, [parent_id, in, lcas]), parent_id_other,
 
934
                         parent_id_this)
 
935
            names       ((base, [name, in, lcas]), name_in_other, name_in_this)
 
936
            executable  ((base, [exec, in, lcas]), exec_in_other, exec_in_this)
931
937
        """
932
938
        if self.interesting_files is not None:
933
939
            lookup_trees = [self.this_tree, self.base_tree]
940
946
        result = []
941
947
        walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
942
948
 
943
 
        base_inventory = self.base_tree.root_inventory
944
 
        this_inventory = self.this_tree.root_inventory
 
949
        base_inventory = self.base_tree.inventory
 
950
        this_inventory = self.this_tree.inventory
945
951
        for path, file_id, other_ie, lca_values in walker.iter_all():
946
952
            # Is this modified at all from any of the other trees?
947
953
            if other_ie is None:
975
981
                else:
976
982
                    lca_entries.append(lca_ie)
977
983
 
978
 
            if base_inventory.has_id(file_id):
 
984
            if file_id in base_inventory:
979
985
                base_ie = base_inventory[file_id]
980
986
            else:
981
987
                base_ie = _none_entry
982
988
 
983
 
            if this_inventory.has_id(file_id):
 
989
            if file_id in this_inventory:
984
990
                this_ie = this_inventory[file_id]
985
991
            else:
986
992
                this_ie = _none_entry
1078
1084
                          ))
1079
1085
        return result
1080
1086
 
 
1087
    def fix_root(self):
 
1088
        if self.tt.final_kind(self.tt.root) is None:
 
1089
            self.tt.cancel_deletion(self.tt.root)
 
1090
        if self.tt.final_file_id(self.tt.root) is None:
 
1091
            self.tt.version_file(self.tt.tree_file_id(self.tt.root),
 
1092
                                 self.tt.root)
 
1093
        other_root_file_id = self.other_tree.get_root_id()
 
1094
        if other_root_file_id is None:
 
1095
            return
 
1096
        other_root = self.tt.trans_id_file_id(other_root_file_id)
 
1097
        if other_root == self.tt.root:
 
1098
            return
 
1099
        if self.other_tree.inventory.root.file_id in self.this_tree.inventory:
 
1100
            # the other tree's root is a non-root in the current tree (as when
 
1101
            # a previously unrelated branch is merged into another)
 
1102
            return
 
1103
        if self.tt.final_kind(other_root) is not None:
 
1104
            other_root_is_present = True
 
1105
        else:
 
1106
            # other_root doesn't have a physical representation. We still need
 
1107
            # to move any references to the actual root of the tree.
 
1108
            other_root_is_present = False
 
1109
        # 'other_tree.inventory.root' is not present in this tree. We are
 
1110
        # calling adjust_path for children which *want* to be present with a
 
1111
        # correct place to go.
 
1112
        for thing, child in self.other_tree.inventory.root.children.iteritems():
 
1113
            trans_id = self.tt.trans_id_file_id(child.file_id)
 
1114
            if not other_root_is_present:
 
1115
                if self.tt.final_kind(trans_id) is not None:
 
1116
                    # The item exist in the final tree and has a defined place
 
1117
                    # to go already.
 
1118
                    continue
 
1119
            # Move the item into the root
 
1120
            self.tt.adjust_path(self.tt.final_name(trans_id),
 
1121
                                self.tt.root, trans_id)
 
1122
        if other_root_is_present:
 
1123
            self.tt.cancel_creation(other_root)
 
1124
            self.tt.cancel_versioning(other_root)
 
1125
 
1081
1126
    def write_modified(self, results):
1082
1127
        modified_hashes = {}
1083
1128
        for path in results.modified_paths:
1084
 
            file_id = self.working_tree.path2id(self.working_tree.relpath(path))
 
1129
            file_id = self.this_tree.path2id(self.this_tree.relpath(path))
1085
1130
            if file_id is None:
1086
1131
                continue
1087
 
            hash = self.working_tree.get_file_sha1(file_id)
 
1132
            hash = self.this_tree.get_file_sha1(file_id)
1088
1133
            if hash is None:
1089
1134
                continue
1090
1135
            modified_hashes[file_id] = hash
1091
 
        self.working_tree.set_merge_modified(modified_hashes)
 
1136
        self.this_tree.set_merge_modified(modified_hashes)
1092
1137
 
1093
1138
    @staticmethod
1094
1139
    def parent(entry, file_id):
1107
1152
    @staticmethod
1108
1153
    def contents_sha1(tree, file_id):
1109
1154
        """Determine the sha1 of the file contents (used as a key method)."""
1110
 
        if not tree.has_id(file_id):
 
1155
        if file_id not in tree:
1111
1156
            return None
1112
1157
        return tree.get_file_sha1(file_id)
1113
1158
 
1193
1238
        # At this point, the lcas disagree, and the tip disagree
1194
1239
        return 'conflict'
1195
1240
 
 
1241
    @staticmethod
 
1242
    @deprecated_method(deprecated_in((2, 2, 0)))
 
1243
    def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
 
1244
        """Do a three-way test on a scalar.
 
1245
        Return "this", "other" or "conflict", depending whether a value wins.
 
1246
        """
 
1247
        key_base = key(base_tree, file_id)
 
1248
        key_other = key(other_tree, file_id)
 
1249
        #if base == other, either they all agree, or only THIS has changed.
 
1250
        if key_base == key_other:
 
1251
            return "this"
 
1252
        key_this = key(this_tree, file_id)
 
1253
        # "Ambiguous clean merge"
 
1254
        if key_this == key_other:
 
1255
            return "this"
 
1256
        elif key_this == key_base:
 
1257
            return "other"
 
1258
        else:
 
1259
            return "conflict"
 
1260
 
1196
1261
    def merge_names(self, file_id):
1197
1262
        def get_entry(tree):
1198
 
            try:
1199
 
                return tree.root_inventory[file_id]
1200
 
            except errors.NoSuchId:
 
1263
            if tree.has_id(file_id):
 
1264
                return tree.inventory[file_id]
 
1265
            else:
1201
1266
                return None
1202
1267
        this_entry = get_entry(self.this_tree)
1203
1268
        other_entry = get_entry(self.other_tree)
1238
1303
            self._raw_conflicts.append(('path conflict', trans_id, file_id,
1239
1304
                                        this_parent, this_name,
1240
1305
                                        other_parent, other_name))
1241
 
        if not self.other_tree.has_id(file_id):
 
1306
        if other_name is None:
1242
1307
            # it doesn't matter whether the result was 'other' or
1243
 
            # 'conflict'-- if it has no file id, we leave it alone.
 
1308
            # 'conflict'-- if there's no 'other', we leave it alone.
1244
1309
            return
1245
1310
        parent_id = parents[self.winner_idx[parent_id_winner]]
1246
 
        name = names[self.winner_idx[name_winner]]
1247
 
        if parent_id is not None or name is not None:
 
1311
        if parent_id is not None:
1248
1312
            # if we get here, name_winner and parent_winner are set to safe
1249
1313
            # values.
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,
 
1314
            self.tt.adjust_path(names[self.winner_idx[name_winner]],
 
1315
                                self.tt.trans_id_file_id(parent_id),
1261
1316
                                self.tt.trans_id_file_id(file_id))
1262
1317
 
1263
1318
    def _do_merge_contents(self, file_id):
1264
1319
        """Performs a merge on file_id contents."""
1265
1320
        def contents_pair(tree):
1266
 
            if not tree.has_id(file_id):
 
1321
            if file_id not in tree:
1267
1322
                return (None, None)
1268
1323
            kind = tree.kind(file_id)
1269
1324
            if kind == "file":
1298
1353
        # We have a hypothetical conflict, but if we have files, then we
1299
1354
        # can try to merge the content
1300
1355
        trans_id = self.tt.trans_id_file_id(file_id)
1301
 
        params = MergeFileHookParams(self, file_id, trans_id, this_pair[0],
 
1356
        params = MergeHookParams(self, file_id, trans_id, this_pair[0],
1302
1357
            other_pair[0], winner)
1303
1358
        hooks = self.active_hooks
1304
1359
        hook_status = 'not_applicable'
1307
1362
            if hook_status != 'not_applicable':
1308
1363
                # Don't try any more hooks, this one applies.
1309
1364
                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
1314
1365
        result = "modified"
1315
1366
        if hook_status == 'not_applicable':
1316
 
            # No merge hook was able to resolve the situation. Two cases exist:
1317
 
            # a content conflict or a duplicate one.
 
1367
            # This is a contents conflict, because none of the available
 
1368
            # functions could merge it.
1318
1369
            result = None
1319
1370
            name = self.tt.final_name(trans_id)
1320
1371
            parent_id = self.tt.final_parent(trans_id)
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))
 
1372
            if self.this_tree.has_id(file_id):
 
1373
                self.tt.unversion_file(trans_id)
 
1374
            file_group = self._dump_conflicts(name, parent_id, file_id,
 
1375
                                              set_version=True)
 
1376
            self._raw_conflicts.append(('contents conflict', file_group))
1358
1377
        elif hook_status == 'success':
1359
1378
            self.tt.create_file(lines, trans_id)
1360
1379
        elif hook_status == 'conflicted':
1376
1395
            raise AssertionError('unknown hook_status: %r' % (hook_status,))
1377
1396
        if not self.this_tree.has_id(file_id) and result == "modified":
1378
1397
            self.tt.version_file(file_id, 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)
 
1398
        # The merge has been performed, so the old contents should not be
 
1399
        # retained.
 
1400
        self.tt.delete_contents(trans_id)
1383
1401
        return result
1384
1402
 
1385
1403
    def _default_other_winner_merge(self, merge_hook_params):
1386
1404
        """Replace this contents with other."""
1387
1405
        file_id = merge_hook_params.file_id
1388
1406
        trans_id = merge_hook_params.trans_id
 
1407
        file_in_this = self.this_tree.has_id(file_id)
1389
1408
        if self.other_tree.has_id(file_id):
1390
1409
            # OTHER changed the file
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))
 
1410
            wt = self.this_tree
 
1411
            if wt.supports_content_filtering():
 
1412
                # We get the path from the working tree if it exists.
 
1413
                # That fails though when OTHER is adding a file, so
 
1414
                # we fall back to the other tree to find the path if
 
1415
                # it doesn't exist locally.
 
1416
                try:
 
1417
                    filter_tree_path = wt.id2path(file_id)
 
1418
                except errors.NoSuchId:
 
1419
                    filter_tree_path = self.other_tree.id2path(file_id)
 
1420
            else:
 
1421
                # Skip the id2path lookup for older formats
 
1422
                filter_tree_path = None
 
1423
            transform.create_from_tree(self.tt, trans_id,
 
1424
                             self.other_tree, file_id,
 
1425
                             filter_tree_path=filter_tree_path)
1394
1426
            return 'done', None
1395
 
        elif self.this_tree.has_id(file_id):
 
1427
        elif file_in_this:
1396
1428
            # OTHER deleted the file
1397
1429
            return 'delete', None
1398
1430
        else:
1472
1504
                                              other_lines)
1473
1505
            file_group.append(trans_id)
1474
1506
 
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
 
 
1489
1507
    def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
1490
1508
                        base_lines=None, other_lines=None, set_version=False,
1491
1509
                        no_base=False):
1574
1592
 
1575
1593
    def cook_conflicts(self, fs_conflicts):
1576
1594
        """Convert all conflicts into a form that doesn't depend on trans_id"""
1577
 
        content_conflict_file_ids = set()
1578
 
        cooked_conflicts = transform.cook_conflicts(fs_conflicts, self.tt)
 
1595
        self.cooked_conflicts.extend(transform.cook_conflicts(
 
1596
                fs_conflicts, self.tt))
1579
1597
        fp = transform.FinalPaths(self.tt)
1580
1598
        for conflict in self._raw_conflicts:
1581
1599
            conflict_type = conflict[0]
1592
1610
                if other_parent is None or other_name is None:
1593
1611
                    other_path = '<deleted>'
1594
1612
                else:
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))
 
1613
                    parent_path =  fp.get_path(
 
1614
                        self.tt.trans_id_file_id(other_parent))
1603
1615
                    other_path = osutils.pathjoin(parent_path, other_name)
1604
1616
                c = _mod_conflicts.Conflict.factory(
1605
1617
                    'path conflict', path=this_path,
1609
1621
                for trans_id in conflict[1]:
1610
1622
                    file_id = self.tt.final_file_id(trans_id)
1611
1623
                    if file_id is not None:
1612
 
                        # Ok we found the relevant file-id
1613
1624
                        break
1614
1625
                path = fp.get_path(trans_id)
1615
1626
                for suffix in ('.BASE', '.THIS', '.OTHER'):
1616
1627
                    if path.endswith(suffix):
1617
 
                        # Here is the raw path
1618
1628
                        path = path[:-len(suffix)]
1619
1629
                        break
1620
1630
                c = _mod_conflicts.Conflict.factory(conflict_type,
1621
1631
                                                    path=path, file_id=file_id)
1622
 
                content_conflict_file_ids.add(file_id)
1623
1632
            elif conflict_type == 'text conflict':
1624
1633
                trans_id = conflict[1]
1625
1634
                path = fp.get_path(trans_id)
1628
1637
                                                    path=path, file_id=file_id)
1629
1638
            else:
1630
1639
                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
1642
1640
            self.cooked_conflicts.append(c)
1643
1641
        self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
1644
1642
 
1865
1863
            entries = self._entries_to_incorporate()
1866
1864
            entries = list(entries)
1867
1865
            for num, (entry, parent_id) in enumerate(entries):
1868
 
                child_pb.update(gettext('Preparing file merge'), num, len(entries))
 
1866
                child_pb.update('Preparing file merge', num, len(entries))
1869
1867
                parent_trans_id = self.tt.trans_id_file_id(parent_id)
1870
1868
                trans_id = transform.new_by_entry(self.tt, entry,
1871
1869
                    parent_trans_id, self.other_tree)
1875
1873
 
1876
1874
    def _entries_to_incorporate(self):
1877
1875
        """Yields pairs of (inventory_entry, new_parent)."""
1878
 
        other_inv = self.other_tree.root_inventory
 
1876
        other_inv = self.other_tree.inventory
1879
1877
        subdir_id = other_inv.path2id(self._source_subpath)
1880
1878
        if subdir_id is None:
1881
1879
            # XXX: The error would be clearer if it gave the URL of the source
1883
1881
            raise PathNotInTree(self._source_subpath, "Source tree")
1884
1882
        subdir = other_inv[subdir_id]
1885
1883
        parent_in_target = osutils.dirname(self._target_subdir)
1886
 
        target_id = self.this_tree.path2id(parent_in_target)
 
1884
        target_id = self.this_tree.inventory.path2id(parent_in_target)
1887
1885
        if target_id is None:
1888
1886
            raise PathNotInTree(self._target_subdir, "Target tree")
1889
1887
        name_in_target = osutils.basename(self._target_subdir)
1890
1888
        merge_into_root = subdir.copy()
1891
1889
        merge_into_root.name = name_in_target
1892
 
        if self.this_tree.has_id(merge_into_root.file_id):
 
1890
        if merge_into_root.file_id in self.this_tree.inventory:
1893
1891
            # Give the root a new file-id.
1894
1892
            # This can happen fairly easily if the directory we are
1895
1893
            # incorporating is the root, and both trees have 'TREE_ROOT' as
1932
1930
    """
1933
1931
    if this_tree is None:
1934
1932
        raise errors.BzrError("bzrlib.merge.merge_inner requires a this_tree "
1935
 
                              "parameter")
 
1933
                              "parameter as of bzrlib version 0.8.")
1936
1934
    merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1937
1935
                    pb=pb, change_reporter=change_reporter)
1938
1936
    merger.backup_files = backup_files
1955
1953
    merger.set_base_revision(get_revision_id(), this_branch)
1956
1954
    return merger.do_merge()
1957
1955
 
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
 
 
1970
1956
def get_merge_type_registry():
1971
 
    """Merge type registry was previously in bzrlib.option
 
1957
    """Merge type registry is in bzrlib.option to avoid circular imports.
1972
1958
 
1973
 
    This method provides a backwards compatible way to retrieve it.
 
1959
    This method provides a sanctioned way to retrieve it.
1974
1960
    """
1975
 
    return merge_type_registry
 
1961
    from bzrlib import option
 
1962
    return option._merge_type_registry
1976
1963
 
1977
1964
 
1978
1965
def _plan_annotate_merge(annotated_a, annotated_b, ancestors_a, ancestors_b):
2403
2390
class _PlanLCAMerge(_PlanMergeBase):
2404
2391
    """
2405
2392
    This merge algorithm differs from _PlanMerge in that:
2406
 
 
2407
2393
    1. comparisons are done against LCAs only
2408
2394
    2. cases where a contested line is new versus one LCA but old versus
2409
2395
       another are marked as conflicts, by emitting the line as conflicted-a
2450
2436
 
2451
2437
        If a line is killed and new, this indicates that the two merge
2452
2438
        revisions contain differing conflict resolutions.
2453
 
 
2454
2439
        :param revision_id: The id of the revision in which the lines are
2455
2440
            unique
2456
2441
        :param unique_line_numbers: The line numbers of unique lines.
2457
 
        :return: a tuple of (new_this, killed_other)
 
2442
        :return a tuple of (new_this, killed_other):
2458
2443
        """
2459
2444
        new = set()
2460
2445
        killed = set()