← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: Martin Pool
  • Date: 2010-06-02 05:03:31 UTC
  • mto: This revision was merged to the branch mainline in revision 5279.
  • Revision ID: mbp@canonical.com-20100602050331-n2p1qt8hfsahspnv
Correct more sloppy use of the term 'Linux'

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/merge.py
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
 
from bzrlib.lazy_import import lazy_import
22
 
lazy_import(globals(), """
23
19
from bzrlib import (
24
20
    branch as _mod_branch,
25
 
    cleanup,
26
21
    conflicts as _mod_conflicts,
27
22
    debug,
28
 
    generate_ids,
 
23
    decorators,
 
24
    errors,
29
25
    graph as _mod_graph,
 
26
    hooks,
30
27
    merge3,
31
28
    osutils,
32
29
    patiencediff,
37
34
    tree as _mod_tree,
38
35
    tsort,
39
36
    ui,
40
 
    versionedfile,
41
 
    workingtree,
42
 
    )
43
 
from bzrlib.i18n import gettext
44
 
""")
45
 
from bzrlib import (
46
 
    decorators,
47
 
    errors,
48
 
    hooks,
49
 
    registry,
50
 
    )
 
37
    versionedfile
 
38
    )
 
39
from bzrlib.cleanup import OperationWithCleanups
51
40
from bzrlib.symbol_versioning import (
52
41
    deprecated_in,
53
42
    deprecated_method,
57
46
 
58
47
def transform_tree(from_tree, to_tree, interesting_ids=None):
59
48
    from_tree.lock_tree_write()
60
 
    operation = cleanup.OperationWithCleanups(merge_inner)
 
49
    operation = OperationWithCleanups(merge_inner)
61
50
    operation.add_cleanup(from_tree.unlock)
62
51
    operation.run_simple(from_tree.branch, to_tree, from_tree,
63
52
        ignore_zero=True, interesting_ids=interesting_ids, this_tree=from_tree)
66
55
class MergeHooks(hooks.Hooks):
67
56
 
68
57
    def __init__(self):
69
 
        hooks.Hooks.__init__(self, "bzrlib.merge", "Merger.hooks")
70
 
        self.add_hook('merge_file_content',
 
58
        hooks.Hooks.__init__(self)
 
59
        self.create_hook(hooks.HookPoint('merge_file_content',
71
60
            "Called with a bzrlib.merge.Merger object to create a per file "
72
61
            "merge object when starting a merge. "
73
62
            "Should return either None or a subclass of "
77
66
            "side has deleted the file and the other has changed it). "
78
67
            "See the AbstractPerFileMerger API docs for details on how it is "
79
68
            "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))
 
69
            (2, 1), None))
90
70
 
91
71
 
92
72
class AbstractPerFileMerger(object):
104
84
    def merge_contents(self, merge_params):
105
85
        """Attempt to merge the contents of a single file.
106
86
        
107
 
        :param merge_params: A bzrlib.merge.MergeFileHookParams
108
 
        :return: A tuple of (status, chunks), where status is one of
 
87
        :param merge_params: A bzrlib.merge.MergeHookParams
 
88
        :return : A tuple of (status, chunks), where status is one of
109
89
            'not_applicable', 'success', 'conflicted', or 'delete'.  If status
110
90
            is 'success' or 'conflicted', then chunks should be an iterable of
111
91
            strings for the new file contents.
131
111
 
132
112
    def get_filename(self, params, tree):
133
113
        """Lookup the filename (i.e. basename, not path), given a Tree (e.g.
134
 
        self.merger.this_tree) and a MergeFileHookParams.
 
114
        self.merger.this_tree) and a MergeHookParams.
135
115
        """
136
116
        return osutils.basename(tree.id2path(params.file_id))
137
117
 
138
118
    def get_filepath(self, params, tree):
139
119
        """Calculate the path to the file in a tree.
140
120
 
141
 
        :param params: A MergeFileHookParams describing the file to merge
 
121
        :param params: A MergeHookParams describing the file to merge
142
122
        :param tree: a Tree, e.g. self.merger.this_tree.
143
123
        """
144
124
        return tree.id2path(params.file_id)
151
131
            params.winner == 'other' or
152
132
            # THIS and OTHER aren't both files.
153
133
            not params.is_file_merge() or
154
 
            # The filename doesn't match
 
134
            # The filename doesn't match *.xml
155
135
            not self.file_matches(params)):
156
136
            return 'not_applicable', None
157
137
        return self.merge_matching(params)
233
213
        raise NotImplementedError(self.merge_text)
234
214
 
235
215
 
236
 
class MergeFileHookParams(object):
 
216
class MergeHookParams(object):
237
217
    """Object holding parameters passed to merge_file_content hooks.
238
218
 
239
219
    There are some fields hooks can access:
441
421
        return self._cached_trees[revision_id]
442
422
 
443
423
    def _get_tree(self, treespec, possible_transports=None):
 
424
        from bzrlib import workingtree
444
425
        location, revno = treespec
445
426
        if revno is None:
446
427
            tree = workingtree.WorkingTree.open_containing(location)[0]
454
435
        revision_id = _mod_revision.ensure_null(revision_id)
455
436
        return branch, self.revision_tree(revision_id, branch)
456
437
 
 
438
    @deprecated_method(deprecated_in((2, 1, 0)))
 
439
    def ensure_revision_trees(self):
 
440
        if self.this_revision_tree is None:
 
441
            self.this_basis_tree = self.revision_tree(self.this_basis)
 
442
            if self.this_basis == self.this_rev_id:
 
443
                self.this_revision_tree = self.this_basis_tree
 
444
 
 
445
        if self.other_rev_id is None:
 
446
            other_basis_tree = self.revision_tree(self.other_basis)
 
447
            if other_basis_tree.has_changes(self.other_tree):
 
448
                raise errors.WorkingTreeNotRevision(self.this_tree)
 
449
            other_rev_id = self.other_basis
 
450
            self.other_tree = other_basis_tree
 
451
 
 
452
    @deprecated_method(deprecated_in((2, 1, 0)))
 
453
    def file_revisions(self, file_id):
 
454
        self.ensure_revision_trees()
 
455
        def get_id(tree, file_id):
 
456
            revision_id = tree.inventory[file_id].revision
 
457
            return revision_id
 
458
        if self.this_rev_id is None:
 
459
            if self.this_basis_tree.get_file_sha1(file_id) != \
 
460
                self.this_tree.get_file_sha1(file_id):
 
461
                raise errors.WorkingTreeNotRevision(self.this_tree)
 
462
 
 
463
        trees = (self.this_basis_tree, self.other_tree)
 
464
        return [get_id(tree, file_id) for tree in trees]
 
465
 
 
466
    @deprecated_method(deprecated_in((2, 1, 0)))
 
467
    def check_basis(self, check_clean, require_commits=True):
 
468
        if self.this_basis is None and require_commits is True:
 
469
            raise errors.BzrCommandError(
 
470
                "This branch has no commits."
 
471
                " (perhaps you would prefer 'bzr pull')")
 
472
        if check_clean:
 
473
            self.compare_basis()
 
474
            if self.this_basis != self.this_rev_id:
 
475
                raise errors.UncommittedChanges(self.this_tree)
 
476
 
 
477
    @deprecated_method(deprecated_in((2, 1, 0)))
 
478
    def compare_basis(self):
 
479
        try:
 
480
            basis_tree = self.revision_tree(self.this_tree.last_revision())
 
481
        except errors.NoSuchRevision:
 
482
            basis_tree = self.this_tree.basis_tree()
 
483
        if not self.this_tree.has_changes(basis_tree):
 
484
            self.this_rev_id = self.this_basis
 
485
 
457
486
    def set_interesting_files(self, file_list):
458
487
        self.interesting_files = file_list
459
488
 
466
495
    def _add_parent(self):
467
496
        new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
468
497
        new_parent_trees = []
469
 
        operation = cleanup.OperationWithCleanups(
470
 
            self.this_tree.set_parent_trees)
 
498
        operation = OperationWithCleanups(self.this_tree.set_parent_trees)
471
499
        for revision_id in new_parents:
472
500
            try:
473
501
                tree = self.revision_tree(revision_id)
504
532
                raise errors.NoCommits(self.other_branch)
505
533
        if self.other_rev_id is not None:
506
534
            self._cached_trees[self.other_rev_id] = self.other_tree
507
 
        self._maybe_fetch(self.other_branch, self.this_branch, self.other_basis)
 
535
        self._maybe_fetch(self.other_branch,self.this_branch, self.other_basis)
508
536
 
509
537
    def set_other_revision(self, revision_id, other_branch):
510
538
        """Set 'other' based on a branch and revision id
548
576
            elif len(lcas) == 1:
549
577
                self.base_rev_id = list(lcas)[0]
550
578
            else: # len(lcas) > 1
551
 
                self._is_criss_cross = True
552
579
                if len(lcas) > 2:
553
580
                    # find_unique_lca can only handle 2 nodes, so we have to
554
581
                    # start back at the beginning. It is a shame to traverse
559
586
                else:
560
587
                    self.base_rev_id = self.revision_graph.find_unique_lca(
561
588
                                            *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
 
 
 
589
                self._is_criss_cross = True
567
590
            if self.base_rev_id == _mod_revision.NULL_REVISION:
568
591
                raise errors.UnrelatedBranches()
569
592
            if self._is_criss_cross:
570
593
                trace.warning('Warning: criss-cross merge encountered.  See bzr'
571
594
                              ' help criss-cross.')
572
595
                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)
 
596
                interesting_revision_ids = [self.base_rev_id]
 
597
                interesting_revision_ids.extend(lcas)
579
598
                interesting_trees = dict((t.get_revision_id(), t)
580
599
                    for t in self.this_branch.repository.revision_trees(
581
600
                        interesting_revision_ids))
582
601
                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)
 
602
                self.base_tree = interesting_trees.pop(self.base_rev_id)
 
603
                sorted_lca_keys = self.revision_graph.find_merge_order(
 
604
                    revisions[0], lcas)
587
605
                self._lca_trees = [interesting_trees[key]
588
606
                                   for key in sorted_lca_keys]
589
607
            else:
612
630
            self._maybe_fetch(base_branch, self.this_branch, self.base_rev_id)
613
631
 
614
632
    def make_merger(self):
615
 
        kwargs = {'working_tree': self.this_tree, 'this_tree': self.this_tree,
 
633
        kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
616
634
                  'other_tree': self.other_tree,
617
635
                  'interesting_ids': self.interesting_ids,
618
636
                  'interesting_files': self.interesting_files,
648
666
        merge = self.make_merger()
649
667
        if self.other_branch is not None:
650
668
            self.other_branch.update_references(self.this_branch)
651
 
        for hook in Merger.hooks['pre_merge']:
652
 
            hook(merge)
653
669
        merge.do_merge()
654
 
        for hook in Merger.hooks['post_merge']:
655
 
            hook(merge)
656
670
        if self.recurse == 'down':
657
671
            for relpath, file_id in self.this_tree.iter_references():
658
672
                sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
662
676
                    continue
663
677
                sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
664
678
                sub_merge.merge_type = self.merge_type
665
 
                other_branch = self.other_branch.reference_parent(file_id,
666
 
                                                                  relpath)
 
679
                other_branch = self.other_branch.reference_parent(file_id, relpath)
667
680
                sub_merge.set_other_revision(other_revision, other_branch)
668
681
                base_revision = self.base_tree.get_reference_revision(file_id)
669
682
                sub_merge.base_tree = \
673
686
        return merge
674
687
 
675
688
    def do_merge(self):
676
 
        operation = cleanup.OperationWithCleanups(self._do_merge_to)
 
689
        operation = OperationWithCleanups(self._do_merge_to)
677
690
        self.this_tree.lock_tree_write()
678
691
        operation.add_cleanup(self.this_tree.unlock)
679
692
        if self.base_tree is not None:
685
698
        merge = operation.run_simple()
686
699
        if len(merge.cooked_conflicts) == 0:
687
700
            if not self.ignore_zero and not trace.is_quiet():
688
 
                trace.note(gettext("All changes applied successfully."))
 
701
                trace.note("All changes applied successfully.")
689
702
        else:
690
 
            trace.note(gettext("%d conflicts encountered.")
 
703
            trace.note("%d conflicts encountered."
691
704
                       % len(merge.cooked_conflicts))
692
705
 
693
706
        return len(merge.cooked_conflicts)
785
798
            warnings.warn("pb argument to Merge3Merger is deprecated")
786
799
 
787
800
    def do_merge(self):
788
 
        operation = cleanup.OperationWithCleanups(self._do_merge)
 
801
        operation = OperationWithCleanups(self._do_merge)
789
802
        self.this_tree.lock_tree_write()
790
803
        operation.add_cleanup(self.this_tree.unlock)
791
804
        self.base_tree.lock_read()
806
819
            pass
807
820
 
808
821
    def make_preview_transform(self):
809
 
        operation = cleanup.OperationWithCleanups(self._make_preview_transform)
 
822
        operation = OperationWithCleanups(self._make_preview_transform)
810
823
        self.base_tree.lock_read()
811
824
        operation.add_cleanup(self.base_tree.unlock)
812
825
        self.other_tree.lock_read()
825
838
        else:
826
839
            entries = self._entries_lca()
827
840
            resolver = self._lca_multi_way
828
 
        # Prepare merge hooks
829
 
        factories = Merger.hooks['merge_file_content']
830
 
        # One hook for each registered one plus our default merger
831
 
        hooks = [factory(self) for factory in factories] + [self]
832
 
        self.active_hooks = [hook for hook in hooks if hook is not None]
833
841
        child_pb = ui.ui_factory.nested_progress_bar()
834
842
        try:
 
843
            factories = Merger.hooks['merge_file_content']
 
844
            hooks = [factory(self) for factory in factories] + [self]
 
845
            self.active_hooks = [hook for hook in hooks if hook is not None]
835
846
            for num, (file_id, changed, parents3, names3,
836
847
                      executable3) in enumerate(entries):
837
 
                # Try merging each entry
838
 
                child_pb.update(gettext('Preparing file merge'),
839
 
                                num, len(entries))
 
848
                child_pb.update('Preparing file merge', num, len(entries))
840
849
                self._merge_names(file_id, parents3, names3, resolver=resolver)
841
850
                if changed:
842
851
                    file_status = self._do_merge_contents(file_id)
846
855
                    executable3, file_status, resolver=resolver)
847
856
        finally:
848
857
            child_pb.finished()
849
 
        self.tt.fixup_new_roots()
850
 
        self._finish_computing_transform()
851
 
 
852
 
    def _finish_computing_transform(self):
853
 
        """Finalize the transform and report the changes.
854
 
 
855
 
        This is the second half of _compute_transform.
856
 
        """
 
858
        self.fix_root()
857
859
        child_pb = ui.ui_factory.nested_progress_bar()
858
860
        try:
859
861
            fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
866
868
                self.tt.iter_changes(), self.change_reporter)
867
869
        self.cook_conflicts(fs_conflicts)
868
870
        for conflict in self.cooked_conflicts:
869
 
            trace.warning(unicode(conflict))
 
871
            trace.warning(conflict)
870
872
 
871
873
    def _entries3(self):
872
874
        """Gather data about files modified between three trees.
879
881
        """
880
882
        result = []
881
883
        iterator = self.other_tree.iter_changes(self.base_tree,
882
 
                specific_files=self.interesting_files,
 
884
                include_unchanged=True, specific_files=self.interesting_files,
883
885
                extra_trees=[self.this_tree])
884
886
        this_entries = dict((e.file_id, e) for p, e in
885
887
                            self.this_tree.iter_entries_by_dir(
911
913
        it then compares with THIS and BASE.
912
914
 
913
915
        For the multi-valued entries, the format will be (BASE, [lca1, lca2])
914
 
 
915
 
        :return: [(file_id, changed, parents, names, executable)], where:
916
 
 
917
 
            * file_id: Simple file_id of the entry
918
 
            * changed: Boolean, True if the kind or contents changed else False
919
 
            * parents: ((base, [parent_id, in, lcas]), parent_id_other,
920
 
                        parent_id_this)
921
 
            * names:   ((base, [name, in, lcas]), name_in_other, name_in_this)
922
 
            * executable: ((base, [exec, in, lcas]), exec_in_other,
923
 
                        exec_in_this)
 
916
        :return: [(file_id, changed, parents, names, executable)]
 
917
            file_id     Simple file_id of the entry
 
918
            changed     Boolean, True if the kind or contents changed
 
919
                        else False
 
920
            parents     ((base, [parent_id, in, lcas]), parent_id_other,
 
921
                         parent_id_this)
 
922
            names       ((base, [name, in, lcas]), name_in_other, name_in_this)
 
923
            executable  ((base, [exec, in, lcas]), exec_in_other, exec_in_this)
924
924
        """
925
925
        if self.interesting_files is not None:
926
926
            lookup_trees = [self.this_tree, self.base_tree]
968
968
                else:
969
969
                    lca_entries.append(lca_ie)
970
970
 
971
 
            if base_inventory.has_id(file_id):
 
971
            if file_id in base_inventory:
972
972
                base_ie = base_inventory[file_id]
973
973
            else:
974
974
                base_ie = _none_entry
975
975
 
976
 
            if this_inventory.has_id(file_id):
 
976
            if file_id in this_inventory:
977
977
                this_ie = this_inventory[file_id]
978
978
            else:
979
979
                this_ie = _none_entry
1071
1071
                          ))
1072
1072
        return result
1073
1073
 
1074
 
    @deprecated_method(deprecated_in((2, 4, 0)))
 
1074
 
1075
1075
    def fix_root(self):
1076
 
        if self.tt.final_kind(self.tt.root) is None:
 
1076
        try:
 
1077
            self.tt.final_kind(self.tt.root)
 
1078
        except errors.NoSuchFile:
1077
1079
            self.tt.cancel_deletion(self.tt.root)
1078
1080
        if self.tt.final_file_id(self.tt.root) is None:
1079
1081
            self.tt.version_file(self.tt.tree_file_id(self.tt.root),
1084
1086
        other_root = self.tt.trans_id_file_id(other_root_file_id)
1085
1087
        if other_root == self.tt.root:
1086
1088
            return
1087
 
        if self.this_tree.inventory.has_id(
1088
 
            self.other_tree.inventory.root.file_id):
1089
 
            # the other tree's root is a non-root in the current tree (as
1090
 
            # when a previously unrelated branch is merged into another)
 
1089
        if self.other_tree.inventory.root.file_id in self.this_tree.inventory:
 
1090
            # the other tree's root is a non-root in the current tree (as when
 
1091
            # a previously unrelated branch is merged into another)
1091
1092
            return
1092
 
        if self.tt.final_kind(other_root) is not None:
 
1093
        try:
 
1094
            self.tt.final_kind(other_root)
1093
1095
            other_root_is_present = True
1094
 
        else:
 
1096
        except errors.NoSuchFile:
1095
1097
            # other_root doesn't have a physical representation. We still need
1096
1098
            # to move any references to the actual root of the tree.
1097
1099
            other_root_is_present = False
1098
1100
        # 'other_tree.inventory.root' is not present in this tree. We are
1099
1101
        # calling adjust_path for children which *want* to be present with a
1100
1102
        # correct place to go.
1101
 
        for _, child in self.other_tree.inventory.root.children.iteritems():
 
1103
        for thing, child in self.other_tree.inventory.root.children.iteritems():
1102
1104
            trans_id = self.tt.trans_id_file_id(child.file_id)
1103
1105
            if not other_root_is_present:
1104
 
                if self.tt.final_kind(trans_id) is not None:
 
1106
                # FIXME: Make final_kind returns None instead of raising
 
1107
                # NoSuchFile to avoid the ugly construct below -- vila 20100402
 
1108
                try:
 
1109
                    self.tt.final_kind(trans_id)
1105
1110
                    # The item exist in the final tree and has a defined place
1106
1111
                    # to go already.
1107
1112
                    continue
 
1113
                except errors.NoSuchFile, e:
 
1114
                    pass
1108
1115
            # Move the item into the root
1109
 
            try:
1110
 
                final_name = self.tt.final_name(trans_id)
1111
 
            except errors.NoFinalPath:
1112
 
                # This file is not present anymore, ignore it.
1113
 
                continue
1114
 
            self.tt.adjust_path(final_name, self.tt.root, trans_id)
 
1116
            self.tt.adjust_path(self.tt.final_name(trans_id),
 
1117
                                self.tt.root, trans_id)
1115
1118
        if other_root_is_present:
1116
1119
            self.tt.cancel_creation(other_root)
1117
1120
            self.tt.cancel_versioning(other_root)
1145
1148
    @staticmethod
1146
1149
    def contents_sha1(tree, file_id):
1147
1150
        """Determine the sha1 of the file contents (used as a key method)."""
1148
 
        if not tree.has_id(file_id):
 
1151
        if file_id not in tree:
1149
1152
            return None
1150
1153
        return tree.get_file_sha1(file_id)
1151
1154
 
1296
1299
            self._raw_conflicts.append(('path conflict', trans_id, file_id,
1297
1300
                                        this_parent, this_name,
1298
1301
                                        other_parent, other_name))
1299
 
        if not self.other_tree.has_id(file_id):
 
1302
        if other_name is None:
1300
1303
            # it doesn't matter whether the result was 'other' or
1301
 
            # 'conflict'-- if it has no file id, we leave it alone.
 
1304
            # 'conflict'-- if there's no 'other', we leave it alone.
1302
1305
            return
1303
1306
        parent_id = parents[self.winner_idx[parent_id_winner]]
1304
 
        name = names[self.winner_idx[name_winner]]
1305
 
        if parent_id is not None or name is not None:
 
1307
        if parent_id is not None:
1306
1308
            # if we get here, name_winner and parent_winner are set to safe
1307
1309
            # values.
1308
 
            if parent_id is None and name is not None:
1309
 
                # if parent_id is None and name is non-None, current file is
1310
 
                # the tree root.
1311
 
                if names[self.winner_idx[parent_id_winner]] != '':
1312
 
                    raise AssertionError(
1313
 
                        'File looks like a root, but named %s' %
1314
 
                        names[self.winner_idx[parent_id_winner]])
1315
 
                parent_trans_id = transform.ROOT_PARENT
1316
 
            else:
1317
 
                parent_trans_id = self.tt.trans_id_file_id(parent_id)
1318
 
            self.tt.adjust_path(name, parent_trans_id,
 
1310
            self.tt.adjust_path(names[self.winner_idx[name_winner]],
 
1311
                                self.tt.trans_id_file_id(parent_id),
1319
1312
                                self.tt.trans_id_file_id(file_id))
1320
1313
 
1321
1314
    def _do_merge_contents(self, file_id):
1322
1315
        """Performs a merge on file_id contents."""
1323
1316
        def contents_pair(tree):
1324
 
            if not tree.has_id(file_id):
 
1317
            if file_id not in tree:
1325
1318
                return (None, None)
1326
1319
            kind = tree.kind(file_id)
1327
1320
            if kind == "file":
1356
1349
        # We have a hypothetical conflict, but if we have files, then we
1357
1350
        # can try to merge the content
1358
1351
        trans_id = self.tt.trans_id_file_id(file_id)
1359
 
        params = MergeFileHookParams(self, file_id, trans_id, this_pair[0],
 
1352
        params = MergeHookParams(self, file_id, trans_id, this_pair[0],
1360
1353
            other_pair[0], winner)
1361
1354
        hooks = self.active_hooks
1362
1355
        hook_status = 'not_applicable'
1365
1358
            if hook_status != 'not_applicable':
1366
1359
                # Don't try any more hooks, this one applies.
1367
1360
                break
1368
 
        # If the merge ends up replacing the content of the file, we get rid of
1369
 
        # it at the end of this method (this variable is used to track the
1370
 
        # exceptions to this rule).
1371
 
        keep_this = False
1372
1361
        result = "modified"
1373
1362
        if hook_status == 'not_applicable':
1374
 
            # No merge hook was able to resolve the situation. Two cases exist:
1375
 
            # a content conflict or a duplicate one.
 
1363
            # This is a contents conflict, because none of the available
 
1364
            # functions could merge it.
1376
1365
            result = None
1377
1366
            name = self.tt.final_name(trans_id)
1378
1367
            parent_id = self.tt.final_parent(trans_id)
1379
 
            duplicate = False
1380
 
            inhibit_content_conflict = False
1381
 
            if params.this_kind is None: # file_id is not in THIS
1382
 
                # Is the name used for a different file_id ?
1383
 
                dupe_path = self.other_tree.id2path(file_id)
1384
 
                this_id = self.this_tree.path2id(dupe_path)
1385
 
                if this_id is not None:
1386
 
                    # Two entries for the same path
1387
 
                    keep_this = True
1388
 
                    # versioning the merged file will trigger a duplicate
1389
 
                    # conflict
1390
 
                    self.tt.version_file(file_id, trans_id)
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))
1394
 
                    inhibit_content_conflict = True
1395
 
            elif params.other_kind is None: # file_id is not in OTHER
1396
 
                # Is the name used for a different file_id ?
1397
 
                dupe_path = self.this_tree.id2path(file_id)
1398
 
                other_id = self.other_tree.path2id(dupe_path)
1399
 
                if other_id is not None:
1400
 
                    # Two entries for the same path again, but here, the other
1401
 
                    # entry will also be merged.  We simply inhibit the
1402
 
                    # 'content' conflict creation because we know OTHER will
1403
 
                    # create (or has already created depending on ordering) an
1404
 
                    # entry at the same path. This will trigger a 'duplicate'
1405
 
                    # conflict later.
1406
 
                    keep_this = True
1407
 
                    inhibit_content_conflict = True
1408
 
            if not inhibit_content_conflict:
1409
 
                if params.this_kind is not None:
1410
 
                    self.tt.unversion_file(trans_id)
1411
 
                # This is a contents conflict, because none of the available
1412
 
                # functions could merge it.
1413
 
                file_group = self._dump_conflicts(name, parent_id, file_id,
1414
 
                                                  set_version=True)
1415
 
                self._raw_conflicts.append(('contents conflict', file_group))
 
1368
            if self.this_tree.has_id(file_id):
 
1369
                self.tt.unversion_file(trans_id)
 
1370
            file_group = self._dump_conflicts(name, parent_id, file_id,
 
1371
                                              set_version=True)
 
1372
            self._raw_conflicts.append(('contents conflict', file_group))
1416
1373
        elif hook_status == 'success':
1417
1374
            self.tt.create_file(lines, trans_id)
1418
1375
        elif hook_status == 'conflicted':
1434
1391
            raise AssertionError('unknown hook_status: %r' % (hook_status,))
1435
1392
        if not self.this_tree.has_id(file_id) and result == "modified":
1436
1393
            self.tt.version_file(file_id, trans_id)
1437
 
        if not keep_this:
1438
 
            # The merge has been performed and produced a new content, so the
1439
 
            # old contents should not be retained.
 
1394
        # The merge has been performed, so the old contents should not be
 
1395
        # retained.
 
1396
        try:
1440
1397
            self.tt.delete_contents(trans_id)
 
1398
        except errors.NoSuchFile:
 
1399
            pass
1441
1400
        return result
1442
1401
 
1443
1402
    def _default_other_winner_merge(self, merge_hook_params):
1444
1403
        """Replace this contents with other."""
1445
1404
        file_id = merge_hook_params.file_id
1446
1405
        trans_id = merge_hook_params.trans_id
 
1406
        file_in_this = self.this_tree.has_id(file_id)
1447
1407
        if self.other_tree.has_id(file_id):
1448
1408
            # OTHER changed the file
1449
 
            transform.create_from_tree(
1450
 
                self.tt, trans_id, self.other_tree, file_id,
1451
 
                filter_tree_path=self._get_filter_tree_path(file_id))
 
1409
            wt = self.this_tree
 
1410
            if wt.supports_content_filtering():
 
1411
                # We get the path from the working tree if it exists.
 
1412
                # That fails though when OTHER is adding a file, so
 
1413
                # we fall back to the other tree to find the path if
 
1414
                # it doesn't exist locally.
 
1415
                try:
 
1416
                    filter_tree_path = wt.id2path(file_id)
 
1417
                except errors.NoSuchId:
 
1418
                    filter_tree_path = self.other_tree.id2path(file_id)
 
1419
            else:
 
1420
                # Skip the id2path lookup for older formats
 
1421
                filter_tree_path = None
 
1422
            transform.create_from_tree(self.tt, trans_id,
 
1423
                             self.other_tree, file_id,
 
1424
                             filter_tree_path=filter_tree_path)
1452
1425
            return 'done', None
1453
 
        elif self.this_tree.has_id(file_id):
 
1426
        elif file_in_this:
1454
1427
            # OTHER deleted the file
1455
1428
            return 'delete', None
1456
1429
        else:
1530
1503
                                              other_lines)
1531
1504
            file_group.append(trans_id)
1532
1505
 
1533
 
 
1534
 
    def _get_filter_tree_path(self, file_id):
1535
 
        if self.this_tree.supports_content_filtering():
1536
 
            # We get the path from the working tree if it exists.
1537
 
            # That fails though when OTHER is adding a file, so
1538
 
            # we fall back to the other tree to find the path if
1539
 
            # it doesn't exist locally.
1540
 
            try:
1541
 
                return self.this_tree.id2path(file_id)
1542
 
            except errors.NoSuchId:
1543
 
                return self.other_tree.id2path(file_id)
1544
 
        # Skip the id2path lookup for older formats
1545
 
        return None
1546
 
 
1547
1506
    def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
1548
1507
                        base_lines=None, other_lines=None, set_version=False,
1549
1508
                        no_base=False):
1615
1574
        if winner == 'this' and file_status != "modified":
1616
1575
            return
1617
1576
        trans_id = self.tt.trans_id_file_id(file_id)
1618
 
        if self.tt.final_kind(trans_id) != "file":
 
1577
        try:
 
1578
            if self.tt.final_kind(trans_id) != "file":
 
1579
                return
 
1580
        except errors.NoSuchFile:
1619
1581
            return
1620
1582
        if winner == "this":
1621
1583
            executability = this_executable
1632
1594
 
1633
1595
    def cook_conflicts(self, fs_conflicts):
1634
1596
        """Convert all conflicts into a form that doesn't depend on trans_id"""
1635
 
        content_conflict_file_ids = set()
1636
 
        cooked_conflicts = transform.cook_conflicts(fs_conflicts, self.tt)
 
1597
        self.cooked_conflicts.extend(transform.cook_conflicts(
 
1598
                fs_conflicts, self.tt))
1637
1599
        fp = transform.FinalPaths(self.tt)
1638
1600
        for conflict in self._raw_conflicts:
1639
1601
            conflict_type = conflict[0]
1650
1612
                if other_parent is None or other_name is None:
1651
1613
                    other_path = '<deleted>'
1652
1614
                else:
1653
 
                    if other_parent == self.other_tree.get_root_id():
1654
 
                        # The tree transform doesn't know about the other root,
1655
 
                        # so we special case here to avoid a NoFinalPath
1656
 
                        # exception
1657
 
                        parent_path = ''
1658
 
                    else:
1659
 
                        parent_path =  fp.get_path(
1660
 
                            self.tt.trans_id_file_id(other_parent))
 
1615
                    parent_path =  fp.get_path(
 
1616
                        self.tt.trans_id_file_id(other_parent))
1661
1617
                    other_path = osutils.pathjoin(parent_path, other_name)
1662
1618
                c = _mod_conflicts.Conflict.factory(
1663
1619
                    'path conflict', path=this_path,
1667
1623
                for trans_id in conflict[1]:
1668
1624
                    file_id = self.tt.final_file_id(trans_id)
1669
1625
                    if file_id is not None:
1670
 
                        # Ok we found the relevant file-id
1671
1626
                        break
1672
1627
                path = fp.get_path(trans_id)
1673
1628
                for suffix in ('.BASE', '.THIS', '.OTHER'):
1674
1629
                    if path.endswith(suffix):
1675
 
                        # Here is the raw path
1676
1630
                        path = path[:-len(suffix)]
1677
1631
                        break
1678
1632
                c = _mod_conflicts.Conflict.factory(conflict_type,
1679
1633
                                                    path=path, file_id=file_id)
1680
 
                content_conflict_file_ids.add(file_id)
1681
1634
            elif conflict_type == 'text conflict':
1682
1635
                trans_id = conflict[1]
1683
1636
                path = fp.get_path(trans_id)
1686
1639
                                                    path=path, file_id=file_id)
1687
1640
            else:
1688
1641
                raise AssertionError('bad conflict type: %r' % (conflict,))
1689
 
            cooked_conflicts.append(c)
1690
 
 
1691
 
        self.cooked_conflicts = []
1692
 
        # We want to get rid of path conflicts when a corresponding contents
1693
 
        # conflict exists. This can occur when one branch deletes a file while
1694
 
        # the other renames *and* modifies it. In this case, the content
1695
 
        # conflict is enough.
1696
 
        for c in cooked_conflicts:
1697
 
            if (c.typestring == 'path conflict'
1698
 
                and c.file_id in content_conflict_file_ids):
1699
 
                continue
1700
1642
            self.cooked_conflicts.append(c)
1701
1643
        self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
1702
1644
 
1808
1750
            osutils.rmtree(temp_dir)
1809
1751
 
1810
1752
 
1811
 
class PathNotInTree(errors.BzrError):
1812
 
 
1813
 
    _fmt = """Merge-into failed because %(tree)s does not contain %(path)s."""
1814
 
 
1815
 
    def __init__(self, path, tree):
1816
 
        errors.BzrError.__init__(self, path=path, tree=tree)
1817
 
 
1818
 
 
1819
 
class MergeIntoMerger(Merger):
1820
 
    """Merger that understands other_tree will be merged into a subdir.
1821
 
 
1822
 
    This also changes the Merger api so that it uses real Branch, revision_id,
1823
 
    and RevisonTree objects, rather than using revision specs.
1824
 
    """
1825
 
 
1826
 
    def __init__(self, this_tree, other_branch, other_tree, target_subdir,
1827
 
            source_subpath, other_rev_id=None):
1828
 
        """Create a new MergeIntoMerger object.
1829
 
 
1830
 
        source_subpath in other_tree will be effectively copied to
1831
 
        target_subdir in this_tree.
1832
 
 
1833
 
        :param this_tree: The tree that we will be merging into.
1834
 
        :param other_branch: The Branch we will be merging from.
1835
 
        :param other_tree: The RevisionTree object we want to merge.
1836
 
        :param target_subdir: The relative path where we want to merge
1837
 
            other_tree into this_tree
1838
 
        :param source_subpath: The relative path specifying the subtree of
1839
 
            other_tree to merge into this_tree.
1840
 
        """
1841
 
        # It is assumed that we are merging a tree that is not in our current
1842
 
        # ancestry, which means we are using the "EmptyTree" as our basis.
1843
 
        null_ancestor_tree = this_tree.branch.repository.revision_tree(
1844
 
                                _mod_revision.NULL_REVISION)
1845
 
        super(MergeIntoMerger, self).__init__(
1846
 
            this_branch=this_tree.branch,
1847
 
            this_tree=this_tree,
1848
 
            other_tree=other_tree,
1849
 
            base_tree=null_ancestor_tree,
1850
 
            )
1851
 
        self._target_subdir = target_subdir
1852
 
        self._source_subpath = source_subpath
1853
 
        self.other_branch = other_branch
1854
 
        if other_rev_id is None:
1855
 
            other_rev_id = other_tree.get_revision_id()
1856
 
        self.other_rev_id = self.other_basis = other_rev_id
1857
 
        self.base_is_ancestor = True
1858
 
        self.backup_files = True
1859
 
        self.merge_type = Merge3Merger
1860
 
        self.show_base = False
1861
 
        self.reprocess = False
1862
 
        self.interesting_ids = None
1863
 
        self.merge_type = _MergeTypeParameterizer(MergeIntoMergeType,
1864
 
              target_subdir=self._target_subdir,
1865
 
              source_subpath=self._source_subpath)
1866
 
        if self._source_subpath != '':
1867
 
            # If this isn't a partial merge make sure the revisions will be
1868
 
            # present.
1869
 
            self._maybe_fetch(self.other_branch, self.this_branch,
1870
 
                self.other_basis)
1871
 
 
1872
 
    def set_pending(self):
1873
 
        if self._source_subpath != '':
1874
 
            return
1875
 
        Merger.set_pending(self)
1876
 
 
1877
 
 
1878
 
class _MergeTypeParameterizer(object):
1879
 
    """Wrap a merge-type class to provide extra parameters.
1880
 
    
1881
 
    This is hack used by MergeIntoMerger to pass some extra parameters to its
1882
 
    merge_type.  Merger.do_merge() sets up its own set of parameters to pass to
1883
 
    the 'merge_type' member.  It is difficult override do_merge without
1884
 
    re-writing the whole thing, so instead we create a wrapper which will pass
1885
 
    the extra parameters.
1886
 
    """
1887
 
 
1888
 
    def __init__(self, merge_type, **kwargs):
1889
 
        self._extra_kwargs = kwargs
1890
 
        self._merge_type = merge_type
1891
 
 
1892
 
    def __call__(self, *args, **kwargs):
1893
 
        kwargs.update(self._extra_kwargs)
1894
 
        return self._merge_type(*args, **kwargs)
1895
 
 
1896
 
    def __getattr__(self, name):
1897
 
        return getattr(self._merge_type, name)
1898
 
 
1899
 
 
1900
 
class MergeIntoMergeType(Merge3Merger):
1901
 
    """Merger that incorporates a tree (or part of a tree) into another."""
1902
 
 
1903
 
    def __init__(self, *args, **kwargs):
1904
 
        """Initialize the merger object.
1905
 
 
1906
 
        :param args: See Merge3Merger.__init__'s args.
1907
 
        :param kwargs: See Merge3Merger.__init__'s keyword args, except for
1908
 
            source_subpath and target_subdir.
1909
 
        :keyword source_subpath: The relative path specifying the subtree of
1910
 
            other_tree to merge into this_tree.
1911
 
        :keyword target_subdir: The relative path where we want to merge
1912
 
            other_tree into this_tree
1913
 
        """
1914
 
        # All of the interesting work happens during Merge3Merger.__init__(),
1915
 
        # so we have have to hack in to get our extra parameters set.
1916
 
        self._source_subpath = kwargs.pop('source_subpath')
1917
 
        self._target_subdir = kwargs.pop('target_subdir')
1918
 
        super(MergeIntoMergeType, self).__init__(*args, **kwargs)
1919
 
 
1920
 
    def _compute_transform(self):
1921
 
        child_pb = ui.ui_factory.nested_progress_bar()
1922
 
        try:
1923
 
            entries = self._entries_to_incorporate()
1924
 
            entries = list(entries)
1925
 
            for num, (entry, parent_id) in enumerate(entries):
1926
 
                child_pb.update(gettext('Preparing file merge'), num, len(entries))
1927
 
                parent_trans_id = self.tt.trans_id_file_id(parent_id)
1928
 
                trans_id = transform.new_by_entry(self.tt, entry,
1929
 
                    parent_trans_id, self.other_tree)
1930
 
        finally:
1931
 
            child_pb.finished()
1932
 
        self._finish_computing_transform()
1933
 
 
1934
 
    def _entries_to_incorporate(self):
1935
 
        """Yields pairs of (inventory_entry, new_parent)."""
1936
 
        other_inv = self.other_tree.inventory
1937
 
        subdir_id = other_inv.path2id(self._source_subpath)
1938
 
        if subdir_id is None:
1939
 
            # XXX: The error would be clearer if it gave the URL of the source
1940
 
            # branch, but we don't have a reference to that here.
1941
 
            raise PathNotInTree(self._source_subpath, "Source tree")
1942
 
        subdir = other_inv[subdir_id]
1943
 
        parent_in_target = osutils.dirname(self._target_subdir)
1944
 
        target_id = self.this_tree.inventory.path2id(parent_in_target)
1945
 
        if target_id is None:
1946
 
            raise PathNotInTree(self._target_subdir, "Target tree")
1947
 
        name_in_target = osutils.basename(self._target_subdir)
1948
 
        merge_into_root = subdir.copy()
1949
 
        merge_into_root.name = name_in_target
1950
 
        if self.this_tree.inventory.has_id(merge_into_root.file_id):
1951
 
            # Give the root a new file-id.
1952
 
            # This can happen fairly easily if the directory we are
1953
 
            # incorporating is the root, and both trees have 'TREE_ROOT' as
1954
 
            # their root_id.  Users will expect this to Just Work, so we
1955
 
            # change the file-id here.
1956
 
            # Non-root file-ids could potentially conflict too.  That's really
1957
 
            # an edge case, so we don't do anything special for those.  We let
1958
 
            # them cause conflicts.
1959
 
            merge_into_root.file_id = generate_ids.gen_file_id(name_in_target)
1960
 
        yield (merge_into_root, target_id)
1961
 
        if subdir.kind != 'directory':
1962
 
            # No children, so we are done.
1963
 
            return
1964
 
        for ignored_path, entry in other_inv.iter_entries_by_dir(subdir_id):
1965
 
            parent_id = entry.parent_id
1966
 
            if parent_id == subdir.file_id:
1967
 
                # The root's parent ID has changed, so make sure children of
1968
 
                # the root refer to the new ID.
1969
 
                parent_id = merge_into_root.file_id
1970
 
            yield (entry, parent_id)
1971
 
 
1972
 
 
1973
1753
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1974
1754
                backup_files=False,
1975
1755
                merge_type=Merge3Merger,
1983
1763
                change_reporter=None):
1984
1764
    """Primary interface for merging.
1985
1765
 
1986
 
    Typical use is probably::
1987
 
 
1988
 
        merge_inner(branch, branch.get_revision_tree(other_revision),
1989
 
                    branch.get_revision_tree(base_revision))
1990
 
    """
 
1766
        typical use is probably
 
1767
        'merge_inner(branch, branch.get_revision_tree(other_revision),
 
1768
                     branch.get_revision_tree(base_revision))'
 
1769
        """
1991
1770
    if this_tree is None:
1992
1771
        raise errors.BzrError("bzrlib.merge.merge_inner requires a this_tree "
1993
 
                              "parameter")
 
1772
                              "parameter as of bzrlib version 0.8.")
1994
1773
    merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1995
1774
                    pb=pb, change_reporter=change_reporter)
1996
1775
    merger.backup_files = backup_files
2013
1792
    merger.set_base_revision(get_revision_id(), this_branch)
2014
1793
    return merger.do_merge()
2015
1794
 
2016
 
 
2017
 
merge_type_registry = registry.Registry()
2018
 
merge_type_registry.register('diff3', Diff3Merger,
2019
 
                             "Merge using external diff3.")
2020
 
merge_type_registry.register('lca', LCAMerger,
2021
 
                             "LCA-newness merge.")
2022
 
merge_type_registry.register('merge3', Merge3Merger,
2023
 
                             "Native diff3-style merge.")
2024
 
merge_type_registry.register('weave', WeaveMerger,
2025
 
                             "Weave-based merge.")
2026
 
 
2027
 
 
2028
1795
def get_merge_type_registry():
2029
 
    """Merge type registry was previously in bzrlib.option
 
1796
    """Merge type registry is in bzrlib.option to avoid circular imports.
2030
1797
 
2031
 
    This method provides a backwards compatible way to retrieve it.
 
1798
    This method provides a sanctioned way to retrieve it.
2032
1799
    """
2033
 
    return merge_type_registry
 
1800
    from bzrlib import option
 
1801
    return option._merge_type_registry
2034
1802
 
2035
1803
 
2036
1804
def _plan_annotate_merge(annotated_a, annotated_b, ancestors_a, ancestors_b):
2461
2229
class _PlanLCAMerge(_PlanMergeBase):
2462
2230
    """
2463
2231
    This merge algorithm differs from _PlanMerge in that:
2464
 
 
2465
2232
    1. comparisons are done against LCAs only
2466
2233
    2. cases where a contested line is new versus one LCA but old versus
2467
2234
       another are marked as conflicts, by emitting the line as conflicted-a
2508
2275
 
2509
2276
        If a line is killed and new, this indicates that the two merge
2510
2277
        revisions contain differing conflict resolutions.
2511
 
 
2512
2278
        :param revision_id: The id of the revision in which the lines are
2513
2279
            unique
2514
2280
        :param unique_line_numbers: The line numbers of unique lines.
2515
 
        :return: a tuple of (new_this, killed_other)
 
2281
        :return a tuple of (new_this, killed_other):
2516
2282
        """
2517
2283
        new = set()
2518
2284
        killed = set()