/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: Jelmer Vernooij
  • Date: 2011-12-29 21:05:11 UTC
  • mto: This revision was merged to the branch mainline in revision 6406.
  • Revision ID: jelmer@samba.org-20111229210511-2hfcqpkn001cwzn1
Fix 'bzr shell-complete' and add a really basic test for it.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/merge.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 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
 
17
19
import warnings
18
20
 
 
21
from bzrlib.lazy_import import lazy_import
 
22
lazy_import(globals(), """
19
23
from bzrlib import (
20
24
    branch as _mod_branch,
 
25
    cleanup,
21
26
    conflicts as _mod_conflicts,
22
27
    debug,
23
 
    decorators,
24
 
    errors,
 
28
    generate_ids,
25
29
    graph as _mod_graph,
26
 
    hooks,
27
30
    merge3,
28
31
    osutils,
29
32
    patiencediff,
34
37
    tree as _mod_tree,
35
38
    tsort,
36
39
    ui,
37
 
    versionedfile
38
 
    )
39
 
from bzrlib.cleanup import OperationWithCleanups
 
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
    )
40
51
from bzrlib.symbol_versioning import (
41
52
    deprecated_in,
42
53
    deprecated_method,
46
57
 
47
58
def transform_tree(from_tree, to_tree, interesting_ids=None):
48
59
    from_tree.lock_tree_write()
49
 
    operation = OperationWithCleanups(merge_inner)
 
60
    operation = cleanup.OperationWithCleanups(merge_inner)
50
61
    operation.add_cleanup(from_tree.unlock)
51
62
    operation.run_simple(from_tree.branch, to_tree, from_tree,
52
63
        ignore_zero=True, interesting_ids=interesting_ids, this_tree=from_tree)
55
66
class MergeHooks(hooks.Hooks):
56
67
 
57
68
    def __init__(self):
58
 
        hooks.Hooks.__init__(self)
59
 
        self.create_hook(hooks.HookPoint('merge_file_content',
 
69
        hooks.Hooks.__init__(self, "bzrlib.merge", "Merger.hooks")
 
70
        self.add_hook('merge_file_content',
60
71
            "Called with a bzrlib.merge.Merger object to create a per file "
61
72
            "merge object when starting a merge. "
62
73
            "Should return either None or a subclass of "
66
77
            "side has deleted the file and the other has changed it). "
67
78
            "See the AbstractPerFileMerger API docs for details on how it is "
68
79
            "used by merge.",
69
 
            (2, 1), None))
 
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))
70
90
 
71
91
 
72
92
class AbstractPerFileMerger(object):
84
104
    def merge_contents(self, merge_params):
85
105
        """Attempt to merge the contents of a single file.
86
106
        
87
 
        :param merge_params: A bzrlib.merge.MergeHookParams
88
 
        :return : A tuple of (status, chunks), where status is one of
 
107
        :param merge_params: A bzrlib.merge.MergeFileHookParams
 
108
        :return: A tuple of (status, chunks), where status is one of
89
109
            'not_applicable', 'success', 'conflicted', or 'delete'.  If status
90
110
            is 'success' or 'conflicted', then chunks should be an iterable of
91
111
            strings for the new file contents.
111
131
 
112
132
    def get_filename(self, params, tree):
113
133
        """Lookup the filename (i.e. basename, not path), given a Tree (e.g.
114
 
        self.merger.this_tree) and a MergeHookParams.
 
134
        self.merger.this_tree) and a MergeFileHookParams.
115
135
        """
116
136
        return osutils.basename(tree.id2path(params.file_id))
117
137
 
118
138
    def get_filepath(self, params, tree):
119
139
        """Calculate the path to the file in a tree.
120
140
 
121
 
        :param params: A MergeHookParams describing the file to merge
 
141
        :param params: A MergeFileHookParams describing the file to merge
122
142
        :param tree: a Tree, e.g. self.merger.this_tree.
123
143
        """
124
144
        return tree.id2path(params.file_id)
131
151
            params.winner == 'other' or
132
152
            # THIS and OTHER aren't both files.
133
153
            not params.is_file_merge() or
134
 
            # The filename doesn't match *.xml
 
154
            # The filename doesn't match
135
155
            not self.file_matches(params)):
136
156
            return 'not_applicable', None
137
157
        return self.merge_matching(params)
213
233
        raise NotImplementedError(self.merge_text)
214
234
 
215
235
 
216
 
class MergeHookParams(object):
 
236
class MergeFileHookParams(object):
217
237
    """Object holding parameters passed to merge_file_content hooks.
218
238
 
219
239
    There are some fields hooks can access:
421
441
        return self._cached_trees[revision_id]
422
442
 
423
443
    def _get_tree(self, treespec, possible_transports=None):
424
 
        from bzrlib import workingtree
425
444
        location, revno = treespec
426
445
        if revno is None:
427
446
            tree = workingtree.WorkingTree.open_containing(location)[0]
435
454
        revision_id = _mod_revision.ensure_null(revision_id)
436
455
        return branch, self.revision_tree(revision_id, branch)
437
456
 
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
 
 
486
457
    def set_interesting_files(self, file_list):
487
458
        self.interesting_files = file_list
488
459
 
495
466
    def _add_parent(self):
496
467
        new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
497
468
        new_parent_trees = []
498
 
        operation = OperationWithCleanups(self.this_tree.set_parent_trees)
 
469
        operation = cleanup.OperationWithCleanups(
 
470
            self.this_tree.set_parent_trees)
499
471
        for revision_id in new_parents:
500
472
            try:
501
473
                tree = self.revision_tree(revision_id)
532
504
                raise errors.NoCommits(self.other_branch)
533
505
        if self.other_rev_id is not None:
534
506
            self._cached_trees[self.other_rev_id] = self.other_tree
535
 
        self._maybe_fetch(self.other_branch,self.this_branch, self.other_basis)
 
507
        self._maybe_fetch(self.other_branch, self.this_branch, self.other_basis)
536
508
 
537
509
    def set_other_revision(self, revision_id, other_branch):
538
510
        """Set 'other' based on a branch and revision id
576
548
            elif len(lcas) == 1:
577
549
                self.base_rev_id = list(lcas)[0]
578
550
            else: # len(lcas) > 1
 
551
                self._is_criss_cross = True
579
552
                if len(lcas) > 2:
580
553
                    # find_unique_lca can only handle 2 nodes, so we have to
581
554
                    # start back at the beginning. It is a shame to traverse
586
559
                else:
587
560
                    self.base_rev_id = self.revision_graph.find_unique_lca(
588
561
                                            *lcas)
589
 
                self._is_criss_cross = True
 
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
 
590
567
            if self.base_rev_id == _mod_revision.NULL_REVISION:
591
568
                raise errors.UnrelatedBranches()
592
569
            if self._is_criss_cross:
593
570
                trace.warning('Warning: criss-cross merge encountered.  See bzr'
594
571
                              ' help criss-cross.')
595
572
                trace.mutter('Criss-cross lcas: %r' % lcas)
596
 
                interesting_revision_ids = [self.base_rev_id]
597
 
                interesting_revision_ids.extend(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)
598
579
                interesting_trees = dict((t.get_revision_id(), t)
599
580
                    for t in self.this_branch.repository.revision_trees(
600
581
                        interesting_revision_ids))
601
582
                self._cached_trees.update(interesting_trees)
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)
 
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)
605
587
                self._lca_trees = [interesting_trees[key]
606
588
                                   for key in sorted_lca_keys]
607
589
            else:
630
612
            self._maybe_fetch(base_branch, self.this_branch, self.base_rev_id)
631
613
 
632
614
    def make_merger(self):
633
 
        kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
 
615
        kwargs = {'working_tree': self.this_tree, 'this_tree': self.this_tree,
634
616
                  'other_tree': self.other_tree,
635
617
                  'interesting_ids': self.interesting_ids,
636
618
                  'interesting_files': self.interesting_files,
666
648
        merge = self.make_merger()
667
649
        if self.other_branch is not None:
668
650
            self.other_branch.update_references(self.this_branch)
 
651
        for hook in Merger.hooks['pre_merge']:
 
652
            hook(merge)
669
653
        merge.do_merge()
 
654
        for hook in Merger.hooks['post_merge']:
 
655
            hook(merge)
670
656
        if self.recurse == 'down':
671
657
            for relpath, file_id in self.this_tree.iter_references():
672
658
                sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
676
662
                    continue
677
663
                sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
678
664
                sub_merge.merge_type = self.merge_type
679
 
                other_branch = self.other_branch.reference_parent(file_id, relpath)
 
665
                other_branch = self.other_branch.reference_parent(file_id,
 
666
                                                                  relpath)
680
667
                sub_merge.set_other_revision(other_revision, other_branch)
681
668
                base_revision = self.base_tree.get_reference_revision(file_id)
682
669
                sub_merge.base_tree = \
686
673
        return merge
687
674
 
688
675
    def do_merge(self):
689
 
        operation = OperationWithCleanups(self._do_merge_to)
 
676
        operation = cleanup.OperationWithCleanups(self._do_merge_to)
690
677
        self.this_tree.lock_tree_write()
691
678
        operation.add_cleanup(self.this_tree.unlock)
692
679
        if self.base_tree is not None:
698
685
        merge = operation.run_simple()
699
686
        if len(merge.cooked_conflicts) == 0:
700
687
            if not self.ignore_zero and not trace.is_quiet():
701
 
                trace.note("All changes applied successfully.")
 
688
                trace.note(gettext("All changes applied successfully."))
702
689
        else:
703
 
            trace.note("%d conflicts encountered."
 
690
            trace.note(gettext("%d conflicts encountered.")
704
691
                       % len(merge.cooked_conflicts))
705
692
 
706
693
        return len(merge.cooked_conflicts)
798
785
            warnings.warn("pb argument to Merge3Merger is deprecated")
799
786
 
800
787
    def do_merge(self):
801
 
        operation = OperationWithCleanups(self._do_merge)
 
788
        operation = cleanup.OperationWithCleanups(self._do_merge)
802
789
        self.this_tree.lock_tree_write()
803
790
        operation.add_cleanup(self.this_tree.unlock)
804
791
        self.base_tree.lock_read()
819
806
            pass
820
807
 
821
808
    def make_preview_transform(self):
822
 
        operation = OperationWithCleanups(self._make_preview_transform)
 
809
        operation = cleanup.OperationWithCleanups(self._make_preview_transform)
823
810
        self.base_tree.lock_read()
824
811
        operation.add_cleanup(self.base_tree.unlock)
825
812
        self.other_tree.lock_read()
838
825
        else:
839
826
            entries = self._entries_lca()
840
827
            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]
841
833
        child_pb = ui.ui_factory.nested_progress_bar()
842
834
        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]
846
835
            for num, (file_id, changed, parents3, names3,
847
836
                      executable3) in enumerate(entries):
848
 
                child_pb.update('Preparing file merge', num, len(entries))
 
837
                # Try merging each entry
 
838
                child_pb.update(gettext('Preparing file merge'),
 
839
                                num, len(entries))
849
840
                self._merge_names(file_id, parents3, names3, resolver=resolver)
850
841
                if changed:
851
842
                    file_status = self._do_merge_contents(file_id)
855
846
                    executable3, file_status, resolver=resolver)
856
847
        finally:
857
848
            child_pb.finished()
858
 
        self.fix_root()
 
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
        """
859
857
        child_pb = ui.ui_factory.nested_progress_bar()
860
858
        try:
861
859
            fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
868
866
                self.tt.iter_changes(), self.change_reporter)
869
867
        self.cook_conflicts(fs_conflicts)
870
868
        for conflict in self.cooked_conflicts:
871
 
            trace.warning(conflict)
 
869
            trace.warning(unicode(conflict))
872
870
 
873
871
    def _entries3(self):
874
872
        """Gather data about files modified between three trees.
881
879
        """
882
880
        result = []
883
881
        iterator = self.other_tree.iter_changes(self.base_tree,
884
 
                include_unchanged=True, specific_files=self.interesting_files,
 
882
                specific_files=self.interesting_files,
885
883
                extra_trees=[self.this_tree])
886
884
        this_entries = dict((e.file_id, e) for p, e in
887
885
                            self.this_tree.iter_entries_by_dir(
913
911
        it then compares with THIS and BASE.
914
912
 
915
913
        For the multi-valued entries, the format will be (BASE, [lca1, lca2])
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)
 
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)
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 file_id in base_inventory:
 
971
            if base_inventory.has_id(file_id):
972
972
                base_ie = base_inventory[file_id]
973
973
            else:
974
974
                base_ie = _none_entry
975
975
 
976
 
            if file_id in this_inventory:
 
976
            if this_inventory.has_id(file_id):
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
 
 
 
1074
    @deprecated_method(deprecated_in((2, 4, 0)))
1075
1075
    def fix_root(self):
1076
 
        try:
1077
 
            self.tt.final_kind(self.tt.root)
1078
 
        except errors.NoSuchFile:
 
1076
        if self.tt.final_kind(self.tt.root) is None:
1079
1077
            self.tt.cancel_deletion(self.tt.root)
1080
1078
        if self.tt.final_file_id(self.tt.root) is None:
1081
1079
            self.tt.version_file(self.tt.tree_file_id(self.tt.root),
1086
1084
        other_root = self.tt.trans_id_file_id(other_root_file_id)
1087
1085
        if other_root == self.tt.root:
1088
1086
            return
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)
 
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)
1092
1091
            return
1093
 
        try:
1094
 
            self.tt.final_kind(other_root)
 
1092
        if self.tt.final_kind(other_root) is not None:
1095
1093
            other_root_is_present = True
1096
 
        except errors.NoSuchFile:
 
1094
        else:
1097
1095
            # other_root doesn't have a physical representation. We still need
1098
1096
            # to move any references to the actual root of the tree.
1099
1097
            other_root_is_present = False
1100
1098
        # 'other_tree.inventory.root' is not present in this tree. We are
1101
1099
        # calling adjust_path for children which *want* to be present with a
1102
1100
        # correct place to go.
1103
 
        for thing, child in self.other_tree.inventory.root.children.iteritems():
 
1101
        for _, child in self.other_tree.inventory.root.children.iteritems():
1104
1102
            trans_id = self.tt.trans_id_file_id(child.file_id)
1105
1103
            if not other_root_is_present:
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)
 
1104
                if self.tt.final_kind(trans_id) is not None:
1110
1105
                    # The item exist in the final tree and has a defined place
1111
1106
                    # to go already.
1112
1107
                    continue
1113
 
                except errors.NoSuchFile, e:
1114
 
                    pass
1115
1108
            # Move the item into the root
1116
 
            self.tt.adjust_path(self.tt.final_name(trans_id),
1117
 
                                self.tt.root, trans_id)
 
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)
1118
1115
        if other_root_is_present:
1119
1116
            self.tt.cancel_creation(other_root)
1120
1117
            self.tt.cancel_versioning(other_root)
1148
1145
    @staticmethod
1149
1146
    def contents_sha1(tree, file_id):
1150
1147
        """Determine the sha1 of the file contents (used as a key method)."""
1151
 
        if file_id not in tree:
 
1148
        if not tree.has_id(file_id):
1152
1149
            return None
1153
1150
        return tree.get_file_sha1(file_id)
1154
1151
 
1299
1296
            self._raw_conflicts.append(('path conflict', trans_id, file_id,
1300
1297
                                        this_parent, this_name,
1301
1298
                                        other_parent, other_name))
1302
 
        if other_name is None:
 
1299
        if not self.other_tree.has_id(file_id):
1303
1300
            # it doesn't matter whether the result was 'other' or
1304
 
            # 'conflict'-- if there's no 'other', we leave it alone.
 
1301
            # 'conflict'-- if it has no file id, we leave it alone.
1305
1302
            return
1306
1303
        parent_id = parents[self.winner_idx[parent_id_winner]]
1307
 
        if parent_id is not None:
 
1304
        name = names[self.winner_idx[name_winner]]
 
1305
        if parent_id is not None or name is not None:
1308
1306
            # if we get here, name_winner and parent_winner are set to safe
1309
1307
            # values.
1310
 
            self.tt.adjust_path(names[self.winner_idx[name_winner]],
1311
 
                                self.tt.trans_id_file_id(parent_id),
 
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,
1312
1319
                                self.tt.trans_id_file_id(file_id))
1313
1320
 
1314
1321
    def _do_merge_contents(self, file_id):
1315
1322
        """Performs a merge on file_id contents."""
1316
1323
        def contents_pair(tree):
1317
 
            if file_id not in tree:
 
1324
            if not tree.has_id(file_id):
1318
1325
                return (None, None)
1319
1326
            kind = tree.kind(file_id)
1320
1327
            if kind == "file":
1349
1356
        # We have a hypothetical conflict, but if we have files, then we
1350
1357
        # can try to merge the content
1351
1358
        trans_id = self.tt.trans_id_file_id(file_id)
1352
 
        params = MergeHookParams(self, file_id, trans_id, this_pair[0],
 
1359
        params = MergeFileHookParams(self, file_id, trans_id, this_pair[0],
1353
1360
            other_pair[0], winner)
1354
1361
        hooks = self.active_hooks
1355
1362
        hook_status = 'not_applicable'
1358
1365
            if hook_status != 'not_applicable':
1359
1366
                # Don't try any more hooks, this one applies.
1360
1367
                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
1361
1372
        result = "modified"
1362
1373
        if hook_status == 'not_applicable':
1363
 
            # This is a contents conflict, because none of the available
1364
 
            # functions could merge it.
 
1374
            # No merge hook was able to resolve the situation. Two cases exist:
 
1375
            # a content conflict or a duplicate one.
1365
1376
            result = None
1366
1377
            name = self.tt.final_name(trans_id)
1367
1378
            parent_id = self.tt.final_parent(trans_id)
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))
 
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))
1373
1416
        elif hook_status == 'success':
1374
1417
            self.tt.create_file(lines, trans_id)
1375
1418
        elif hook_status == 'conflicted':
1391
1434
            raise AssertionError('unknown hook_status: %r' % (hook_status,))
1392
1435
        if not self.this_tree.has_id(file_id) and result == "modified":
1393
1436
            self.tt.version_file(file_id, trans_id)
1394
 
        # The merge has been performed, so the old contents should not be
1395
 
        # retained.
1396
 
        try:
 
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.
1397
1440
            self.tt.delete_contents(trans_id)
1398
 
        except errors.NoSuchFile:
1399
 
            pass
1400
1441
        return result
1401
1442
 
1402
1443
    def _default_other_winner_merge(self, merge_hook_params):
1403
1444
        """Replace this contents with other."""
1404
1445
        file_id = merge_hook_params.file_id
1405
1446
        trans_id = merge_hook_params.trans_id
1406
 
        file_in_this = self.this_tree.has_id(file_id)
1407
1447
        if self.other_tree.has_id(file_id):
1408
1448
            # OTHER changed the file
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)
 
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))
1425
1452
            return 'done', None
1426
 
        elif file_in_this:
 
1453
        elif self.this_tree.has_id(file_id):
1427
1454
            # OTHER deleted the file
1428
1455
            return 'delete', None
1429
1456
        else:
1455
1482
    def get_lines(self, tree, file_id):
1456
1483
        """Return the lines in a file, or an empty list."""
1457
1484
        if tree.has_id(file_id):
1458
 
            return tree.get_file(file_id).readlines()
 
1485
            return tree.get_file_lines(file_id)
1459
1486
        else:
1460
1487
            return []
1461
1488
 
1503
1530
                                              other_lines)
1504
1531
            file_group.append(trans_id)
1505
1532
 
 
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
 
1506
1547
    def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
1507
1548
                        base_lines=None, other_lines=None, set_version=False,
1508
1549
                        no_base=False):
1574
1615
        if winner == 'this' and file_status != "modified":
1575
1616
            return
1576
1617
        trans_id = self.tt.trans_id_file_id(file_id)
1577
 
        try:
1578
 
            if self.tt.final_kind(trans_id) != "file":
1579
 
                return
1580
 
        except errors.NoSuchFile:
 
1618
        if self.tt.final_kind(trans_id) != "file":
1581
1619
            return
1582
1620
        if winner == "this":
1583
1621
            executability = this_executable
1594
1632
 
1595
1633
    def cook_conflicts(self, fs_conflicts):
1596
1634
        """Convert all conflicts into a form that doesn't depend on trans_id"""
1597
 
        self.cooked_conflicts.extend(transform.cook_conflicts(
1598
 
                fs_conflicts, self.tt))
 
1635
        content_conflict_file_ids = set()
 
1636
        cooked_conflicts = transform.cook_conflicts(fs_conflicts, self.tt)
1599
1637
        fp = transform.FinalPaths(self.tt)
1600
1638
        for conflict in self._raw_conflicts:
1601
1639
            conflict_type = conflict[0]
1612
1650
                if other_parent is None or other_name is None:
1613
1651
                    other_path = '<deleted>'
1614
1652
                else:
1615
 
                    parent_path =  fp.get_path(
1616
 
                        self.tt.trans_id_file_id(other_parent))
 
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))
1617
1661
                    other_path = osutils.pathjoin(parent_path, other_name)
1618
1662
                c = _mod_conflicts.Conflict.factory(
1619
1663
                    'path conflict', path=this_path,
1623
1667
                for trans_id in conflict[1]:
1624
1668
                    file_id = self.tt.final_file_id(trans_id)
1625
1669
                    if file_id is not None:
 
1670
                        # Ok we found the relevant file-id
1626
1671
                        break
1627
1672
                path = fp.get_path(trans_id)
1628
1673
                for suffix in ('.BASE', '.THIS', '.OTHER'):
1629
1674
                    if path.endswith(suffix):
 
1675
                        # Here is the raw path
1630
1676
                        path = path[:-len(suffix)]
1631
1677
                        break
1632
1678
                c = _mod_conflicts.Conflict.factory(conflict_type,
1633
1679
                                                    path=path, file_id=file_id)
 
1680
                content_conflict_file_ids.add(file_id)
1634
1681
            elif conflict_type == 'text conflict':
1635
1682
                trans_id = conflict[1]
1636
1683
                path = fp.get_path(trans_id)
1639
1686
                                                    path=path, file_id=file_id)
1640
1687
            else:
1641
1688
                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
1642
1700
            self.cooked_conflicts.append(c)
1643
1701
        self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
1644
1702
 
1750
1808
            osutils.rmtree(temp_dir)
1751
1809
 
1752
1810
 
 
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
 
1753
1973
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1754
1974
                backup_files=False,
1755
1975
                merge_type=Merge3Merger,
1763
1983
                change_reporter=None):
1764
1984
    """Primary interface for merging.
1765
1985
 
1766
 
        typical use is probably
1767
 
        'merge_inner(branch, branch.get_revision_tree(other_revision),
1768
 
                     branch.get_revision_tree(base_revision))'
1769
 
        """
 
1986
    Typical use is probably::
 
1987
 
 
1988
        merge_inner(branch, branch.get_revision_tree(other_revision),
 
1989
                    branch.get_revision_tree(base_revision))
 
1990
    """
1770
1991
    if this_tree is None:
1771
1992
        raise errors.BzrError("bzrlib.merge.merge_inner requires a this_tree "
1772
 
                              "parameter as of bzrlib version 0.8.")
 
1993
                              "parameter")
1773
1994
    merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1774
1995
                    pb=pb, change_reporter=change_reporter)
1775
1996
    merger.backup_files = backup_files
1792
2013
    merger.set_base_revision(get_revision_id(), this_branch)
1793
2014
    return merger.do_merge()
1794
2015
 
 
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
 
1795
2028
def get_merge_type_registry():
1796
 
    """Merge type registry is in bzrlib.option to avoid circular imports.
 
2029
    """Merge type registry was previously in bzrlib.option
1797
2030
 
1798
 
    This method provides a sanctioned way to retrieve it.
 
2031
    This method provides a backwards compatible way to retrieve it.
1799
2032
    """
1800
 
    from bzrlib import option
1801
 
    return option._merge_type_registry
 
2033
    return merge_type_registry
1802
2034
 
1803
2035
 
1804
2036
def _plan_annotate_merge(annotated_a, annotated_b, ancestors_a, ancestors_b):
2229
2461
class _PlanLCAMerge(_PlanMergeBase):
2230
2462
    """
2231
2463
    This merge algorithm differs from _PlanMerge in that:
 
2464
 
2232
2465
    1. comparisons are done against LCAs only
2233
2466
    2. cases where a contested line is new versus one LCA but old versus
2234
2467
       another are marked as conflicts, by emitting the line as conflicted-a
2275
2508
 
2276
2509
        If a line is killed and new, this indicates that the two merge
2277
2510
        revisions contain differing conflict resolutions.
 
2511
 
2278
2512
        :param revision_id: The id of the revision in which the lines are
2279
2513
            unique
2280
2514
        :param unique_line_numbers: The line numbers of unique lines.
2281
 
        :return a tuple of (new_this, killed_other):
 
2515
        :return: a tuple of (new_this, killed_other)
2282
2516
        """
2283
2517
        new = set()
2284
2518
        killed = set()