~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: Jelmer Vernooij
  • Date: 2011-12-05 14:12:23 UTC
  • mto: This revision was merged to the branch mainline in revision 6348.
  • Revision ID: jelmer@samba.org-20111205141223-8qxae4h37satlzgq
Move more functionality to vf_search.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
16
16
 
17
17
import warnings
18
18
 
 
19
from bzrlib.lazy_import import lazy_import
 
20
lazy_import(globals(), """
19
21
from bzrlib import (
20
22
    branch as _mod_branch,
 
23
    cleanup,
21
24
    conflicts as _mod_conflicts,
22
25
    debug,
23
 
    decorators,
24
 
    errors,
 
26
    generate_ids,
25
27
    graph as _mod_graph,
26
 
    hooks,
27
28
    merge3,
28
29
    osutils,
29
30
    patiencediff,
34
35
    tree as _mod_tree,
35
36
    tsort,
36
37
    ui,
37
 
    versionedfile
38
 
    )
39
 
from bzrlib.cleanup import OperationWithCleanups
 
38
    versionedfile,
 
39
    workingtree,
 
40
    )
 
41
from bzrlib.i18n import gettext
 
42
""")
 
43
from bzrlib import (
 
44
    decorators,
 
45
    errors,
 
46
    hooks,
 
47
    registry,
 
48
    )
40
49
from bzrlib.symbol_versioning import (
41
50
    deprecated_in,
42
51
    deprecated_method,
46
55
 
47
56
def transform_tree(from_tree, to_tree, interesting_ids=None):
48
57
    from_tree.lock_tree_write()
49
 
    operation = OperationWithCleanups(merge_inner)
 
58
    operation = cleanup.OperationWithCleanups(merge_inner)
50
59
    operation.add_cleanup(from_tree.unlock)
51
60
    operation.run_simple(from_tree.branch, to_tree, from_tree,
52
61
        ignore_zero=True, interesting_ids=interesting_ids, this_tree=from_tree)
55
64
class MergeHooks(hooks.Hooks):
56
65
 
57
66
    def __init__(self):
58
 
        hooks.Hooks.__init__(self)
59
 
        self.create_hook(hooks.HookPoint('merge_file_content',
 
67
        hooks.Hooks.__init__(self, "bzrlib.merge", "Merger.hooks")
 
68
        self.add_hook('merge_file_content',
60
69
            "Called with a bzrlib.merge.Merger object to create a per file "
61
70
            "merge object when starting a merge. "
62
71
            "Should return either None or a subclass of "
66
75
            "side has deleted the file and the other has changed it). "
67
76
            "See the AbstractPerFileMerger API docs for details on how it is "
68
77
            "used by merge.",
69
 
            (2, 1), None))
 
78
            (2, 1))
70
79
 
71
80
 
72
81
class AbstractPerFileMerger(object):
85
94
        """Attempt to merge the contents of a single file.
86
95
        
87
96
        :param merge_params: A bzrlib.merge.MergeHookParams
88
 
        :return : A tuple of (status, chunks), where status is one of
 
97
        :return: A tuple of (status, chunks), where status is one of
89
98
            'not_applicable', 'success', 'conflicted', or 'delete'.  If status
90
99
            is 'success' or 'conflicted', then chunks should be an iterable of
91
100
            strings for the new file contents.
131
140
            params.winner == 'other' or
132
141
            # THIS and OTHER aren't both files.
133
142
            not params.is_file_merge() or
134
 
            # The filename doesn't match *.xml
 
143
            # The filename doesn't match
135
144
            not self.file_matches(params)):
136
145
            return 'not_applicable', None
137
146
        return self.merge_matching(params)
421
430
        return self._cached_trees[revision_id]
422
431
 
423
432
    def _get_tree(self, treespec, possible_transports=None):
424
 
        from bzrlib import workingtree
425
433
        location, revno = treespec
426
434
        if revno is None:
427
435
            tree = workingtree.WorkingTree.open_containing(location)[0]
452
460
    @deprecated_method(deprecated_in((2, 1, 0)))
453
461
    def file_revisions(self, file_id):
454
462
        self.ensure_revision_trees()
455
 
        def get_id(tree, file_id):
456
 
            revision_id = tree.inventory[file_id].revision
457
 
            return revision_id
458
463
        if self.this_rev_id is None:
459
464
            if self.this_basis_tree.get_file_sha1(file_id) != \
460
465
                self.this_tree.get_file_sha1(file_id):
461
466
                raise errors.WorkingTreeNotRevision(self.this_tree)
462
467
 
463
468
        trees = (self.this_basis_tree, self.other_tree)
464
 
        return [get_id(tree, file_id) for tree in trees]
 
469
        return [tree.get_file_revision(file_id) for tree in trees]
465
470
 
466
471
    @deprecated_method(deprecated_in((2, 1, 0)))
467
472
    def check_basis(self, check_clean, require_commits=True):
495
500
    def _add_parent(self):
496
501
        new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
497
502
        new_parent_trees = []
498
 
        operation = OperationWithCleanups(self.this_tree.set_parent_trees)
 
503
        operation = cleanup.OperationWithCleanups(
 
504
            self.this_tree.set_parent_trees)
499
505
        for revision_id in new_parents:
500
506
            try:
501
507
                tree = self.revision_tree(revision_id)
576
582
            elif len(lcas) == 1:
577
583
                self.base_rev_id = list(lcas)[0]
578
584
            else: # len(lcas) > 1
 
585
                self._is_criss_cross = True
579
586
                if len(lcas) > 2:
580
587
                    # find_unique_lca can only handle 2 nodes, so we have to
581
588
                    # start back at the beginning. It is a shame to traverse
586
593
                else:
587
594
                    self.base_rev_id = self.revision_graph.find_unique_lca(
588
595
                                            *lcas)
589
 
                self._is_criss_cross = True
 
596
                sorted_lca_keys = self.revision_graph.find_merge_order(
 
597
                    revisions[0], lcas)
 
598
                if self.base_rev_id == _mod_revision.NULL_REVISION:
 
599
                    self.base_rev_id = sorted_lca_keys[0]
 
600
 
590
601
            if self.base_rev_id == _mod_revision.NULL_REVISION:
591
602
                raise errors.UnrelatedBranches()
592
603
            if self._is_criss_cross:
593
604
                trace.warning('Warning: criss-cross merge encountered.  See bzr'
594
605
                              ' help criss-cross.')
595
606
                trace.mutter('Criss-cross lcas: %r' % lcas)
596
 
                interesting_revision_ids = [self.base_rev_id]
597
 
                interesting_revision_ids.extend(lcas)
 
607
                if self.base_rev_id in lcas:
 
608
                    trace.mutter('Unable to find unique lca. '
 
609
                                 'Fallback %r as best option.'
 
610
                                 % self.base_rev_id)
 
611
                interesting_revision_ids = set(lcas)
 
612
                interesting_revision_ids.add(self.base_rev_id)
598
613
                interesting_trees = dict((t.get_revision_id(), t)
599
614
                    for t in self.this_branch.repository.revision_trees(
600
615
                        interesting_revision_ids))
601
616
                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)
 
617
                if self.base_rev_id in lcas:
 
618
                    self.base_tree = interesting_trees[self.base_rev_id]
 
619
                else:
 
620
                    self.base_tree = interesting_trees.pop(self.base_rev_id)
605
621
                self._lca_trees = [interesting_trees[key]
606
622
                                   for key in sorted_lca_keys]
607
623
            else:
676
692
                    continue
677
693
                sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
678
694
                sub_merge.merge_type = self.merge_type
679
 
                other_branch = self.other_branch.reference_parent(file_id, relpath)
 
695
                other_branch = self.other_branch.reference_parent(file_id,
 
696
                                                                  relpath)
680
697
                sub_merge.set_other_revision(other_revision, other_branch)
681
698
                base_revision = self.base_tree.get_reference_revision(file_id)
682
699
                sub_merge.base_tree = \
686
703
        return merge
687
704
 
688
705
    def do_merge(self):
689
 
        operation = OperationWithCleanups(self._do_merge_to)
 
706
        operation = cleanup.OperationWithCleanups(self._do_merge_to)
690
707
        self.this_tree.lock_tree_write()
691
708
        operation.add_cleanup(self.this_tree.unlock)
692
709
        if self.base_tree is not None:
698
715
        merge = operation.run_simple()
699
716
        if len(merge.cooked_conflicts) == 0:
700
717
            if not self.ignore_zero and not trace.is_quiet():
701
 
                trace.note("All changes applied successfully.")
 
718
                trace.note(gettext("All changes applied successfully."))
702
719
        else:
703
 
            trace.note("%d conflicts encountered."
 
720
            trace.note(gettext("%d conflicts encountered.")
704
721
                       % len(merge.cooked_conflicts))
705
722
 
706
723
        return len(merge.cooked_conflicts)
798
815
            warnings.warn("pb argument to Merge3Merger is deprecated")
799
816
 
800
817
    def do_merge(self):
801
 
        operation = OperationWithCleanups(self._do_merge)
 
818
        operation = cleanup.OperationWithCleanups(self._do_merge)
802
819
        self.this_tree.lock_tree_write()
803
820
        operation.add_cleanup(self.this_tree.unlock)
804
821
        self.base_tree.lock_read()
819
836
            pass
820
837
 
821
838
    def make_preview_transform(self):
822
 
        operation = OperationWithCleanups(self._make_preview_transform)
 
839
        operation = cleanup.OperationWithCleanups(self._make_preview_transform)
823
840
        self.base_tree.lock_read()
824
841
        operation.add_cleanup(self.base_tree.unlock)
825
842
        self.other_tree.lock_read()
838
855
        else:
839
856
            entries = self._entries_lca()
840
857
            resolver = self._lca_multi_way
 
858
        # Prepare merge hooks
 
859
        factories = Merger.hooks['merge_file_content']
 
860
        # One hook for each registered one plus our default merger
 
861
        hooks = [factory(self) for factory in factories] + [self]
 
862
        self.active_hooks = [hook for hook in hooks if hook is not None]
841
863
        child_pb = ui.ui_factory.nested_progress_bar()
842
864
        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
865
            for num, (file_id, changed, parents3, names3,
847
866
                      executable3) in enumerate(entries):
848
 
                child_pb.update('Preparing file merge', num, len(entries))
 
867
                # Try merging each entry
 
868
                child_pb.update(gettext('Preparing file merge'),
 
869
                                num, len(entries))
849
870
                self._merge_names(file_id, parents3, names3, resolver=resolver)
850
871
                if changed:
851
872
                    file_status = self._do_merge_contents(file_id)
855
876
                    executable3, file_status, resolver=resolver)
856
877
        finally:
857
878
            child_pb.finished()
858
 
        self.fix_root()
 
879
        self.tt.fixup_new_roots()
 
880
        self._finish_computing_transform()
 
881
 
 
882
    def _finish_computing_transform(self):
 
883
        """Finalize the transform and report the changes.
 
884
 
 
885
        This is the second half of _compute_transform.
 
886
        """
859
887
        child_pb = ui.ui_factory.nested_progress_bar()
860
888
        try:
861
889
            fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
868
896
                self.tt.iter_changes(), self.change_reporter)
869
897
        self.cook_conflicts(fs_conflicts)
870
898
        for conflict in self.cooked_conflicts:
871
 
            trace.warning(conflict)
 
899
            trace.warning(unicode(conflict))
872
900
 
873
901
    def _entries3(self):
874
902
        """Gather data about files modified between three trees.
881
909
        """
882
910
        result = []
883
911
        iterator = self.other_tree.iter_changes(self.base_tree,
884
 
                include_unchanged=True, specific_files=self.interesting_files,
 
912
                specific_files=self.interesting_files,
885
913
                extra_trees=[self.this_tree])
886
914
        this_entries = dict((e.file_id, e) for p, e in
887
915
                            self.this_tree.iter_entries_by_dir(
913
941
        it then compares with THIS and BASE.
914
942
 
915
943
        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)
 
944
 
 
945
        :return: [(file_id, changed, parents, names, executable)], where:
 
946
 
 
947
            * file_id: Simple file_id of the entry
 
948
            * changed: Boolean, True if the kind or contents changed else False
 
949
            * parents: ((base, [parent_id, in, lcas]), parent_id_other,
 
950
                        parent_id_this)
 
951
            * names:   ((base, [name, in, lcas]), name_in_other, name_in_this)
 
952
            * executable: ((base, [exec, in, lcas]), exec_in_other,
 
953
                        exec_in_this)
924
954
        """
925
955
        if self.interesting_files is not None:
926
956
            lookup_trees = [self.this_tree, self.base_tree]
968
998
                else:
969
999
                    lca_entries.append(lca_ie)
970
1000
 
971
 
            if file_id in base_inventory:
 
1001
            if base_inventory.has_id(file_id):
972
1002
                base_ie = base_inventory[file_id]
973
1003
            else:
974
1004
                base_ie = _none_entry
975
1005
 
976
 
            if file_id in this_inventory:
 
1006
            if this_inventory.has_id(file_id):
977
1007
                this_ie = this_inventory[file_id]
978
1008
            else:
979
1009
                this_ie = _none_entry
1071
1101
                          ))
1072
1102
        return result
1073
1103
 
1074
 
 
 
1104
    @deprecated_method(deprecated_in((2, 4, 0)))
1075
1105
    def fix_root(self):
1076
 
        try:
1077
 
            self.tt.final_kind(self.tt.root)
1078
 
        except errors.NoSuchFile:
 
1106
        if self.tt.final_kind(self.tt.root) is None:
1079
1107
            self.tt.cancel_deletion(self.tt.root)
1080
1108
        if self.tt.final_file_id(self.tt.root) is None:
1081
1109
            self.tt.version_file(self.tt.tree_file_id(self.tt.root),
1086
1114
        other_root = self.tt.trans_id_file_id(other_root_file_id)
1087
1115
        if other_root == self.tt.root:
1088
1116
            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)
 
1117
        if self.this_tree.inventory.has_id(
 
1118
            self.other_tree.inventory.root.file_id):
 
1119
            # the other tree's root is a non-root in the current tree (as
 
1120
            # when a previously unrelated branch is merged into another)
1092
1121
            return
1093
 
        try:
1094
 
            self.tt.final_kind(other_root)
 
1122
        if self.tt.final_kind(other_root) is not None:
1095
1123
            other_root_is_present = True
1096
 
        except errors.NoSuchFile:
 
1124
        else:
1097
1125
            # other_root doesn't have a physical representation. We still need
1098
1126
            # to move any references to the actual root of the tree.
1099
1127
            other_root_is_present = False
1100
1128
        # 'other_tree.inventory.root' is not present in this tree. We are
1101
1129
        # calling adjust_path for children which *want* to be present with a
1102
1130
        # correct place to go.
1103
 
        for thing, child in self.other_tree.inventory.root.children.iteritems():
 
1131
        for _, child in self.other_tree.inventory.root.children.iteritems():
1104
1132
            trans_id = self.tt.trans_id_file_id(child.file_id)
1105
1133
            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)
 
1134
                if self.tt.final_kind(trans_id) is not None:
1110
1135
                    # The item exist in the final tree and has a defined place
1111
1136
                    # to go already.
1112
1137
                    continue
1113
 
                except errors.NoSuchFile, e:
1114
 
                    pass
1115
1138
            # Move the item into the root
1116
 
            self.tt.adjust_path(self.tt.final_name(trans_id),
1117
 
                                self.tt.root, trans_id)
 
1139
            try:
 
1140
                final_name = self.tt.final_name(trans_id)
 
1141
            except errors.NoFinalPath:
 
1142
                # This file is not present anymore, ignore it.
 
1143
                continue
 
1144
            self.tt.adjust_path(final_name, self.tt.root, trans_id)
1118
1145
        if other_root_is_present:
1119
1146
            self.tt.cancel_creation(other_root)
1120
1147
            self.tt.cancel_versioning(other_root)
1148
1175
    @staticmethod
1149
1176
    def contents_sha1(tree, file_id):
1150
1177
        """Determine the sha1 of the file contents (used as a key method)."""
1151
 
        if file_id not in tree:
 
1178
        if not tree.has_id(file_id):
1152
1179
            return None
1153
1180
        return tree.get_file_sha1(file_id)
1154
1181
 
1299
1326
            self._raw_conflicts.append(('path conflict', trans_id, file_id,
1300
1327
                                        this_parent, this_name,
1301
1328
                                        other_parent, other_name))
1302
 
        if other_name is None:
 
1329
        if not self.other_tree.has_id(file_id):
1303
1330
            # it doesn't matter whether the result was 'other' or
1304
 
            # 'conflict'-- if there's no 'other', we leave it alone.
 
1331
            # 'conflict'-- if it has no file id, we leave it alone.
1305
1332
            return
1306
1333
        parent_id = parents[self.winner_idx[parent_id_winner]]
1307
 
        if parent_id is not None:
 
1334
        name = names[self.winner_idx[name_winner]]
 
1335
        if parent_id is not None or name is not None:
1308
1336
            # if we get here, name_winner and parent_winner are set to safe
1309
1337
            # values.
1310
 
            self.tt.adjust_path(names[self.winner_idx[name_winner]],
1311
 
                                self.tt.trans_id_file_id(parent_id),
 
1338
            if parent_id is None and name is not None:
 
1339
                # if parent_id is None and name is non-None, current file is
 
1340
                # the tree root.
 
1341
                if names[self.winner_idx[parent_id_winner]] != '':
 
1342
                    raise AssertionError(
 
1343
                        'File looks like a root, but named %s' %
 
1344
                        names[self.winner_idx[parent_id_winner]])
 
1345
                parent_trans_id = transform.ROOT_PARENT
 
1346
            else:
 
1347
                parent_trans_id = self.tt.trans_id_file_id(parent_id)
 
1348
            self.tt.adjust_path(name, parent_trans_id,
1312
1349
                                self.tt.trans_id_file_id(file_id))
1313
1350
 
1314
1351
    def _do_merge_contents(self, file_id):
1315
1352
        """Performs a merge on file_id contents."""
1316
1353
        def contents_pair(tree):
1317
 
            if file_id not in tree:
 
1354
            if not tree.has_id(file_id):
1318
1355
                return (None, None)
1319
1356
            kind = tree.kind(file_id)
1320
1357
            if kind == "file":
1358
1395
            if hook_status != 'not_applicable':
1359
1396
                # Don't try any more hooks, this one applies.
1360
1397
                break
 
1398
        # If the merge ends up replacing the content of the file, we get rid of
 
1399
        # it at the end of this method (this variable is used to track the
 
1400
        # exceptions to this rule).
 
1401
        keep_this = False
1361
1402
        result = "modified"
1362
1403
        if hook_status == 'not_applicable':
1363
 
            # This is a contents conflict, because none of the available
1364
 
            # functions could merge it.
 
1404
            # No merge hook was able to resolve the situation. Two cases exist:
 
1405
            # a content conflict or a duplicate one.
1365
1406
            result = None
1366
1407
            name = self.tt.final_name(trans_id)
1367
1408
            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))
 
1409
            duplicate = False
 
1410
            inhibit_content_conflict = False
 
1411
            if params.this_kind is None: # file_id is not in THIS
 
1412
                # Is the name used for a different file_id ?
 
1413
                dupe_path = self.other_tree.id2path(file_id)
 
1414
                this_id = self.this_tree.path2id(dupe_path)
 
1415
                if this_id is not None:
 
1416
                    # Two entries for the same path
 
1417
                    keep_this = True
 
1418
                    # versioning the merged file will trigger a duplicate
 
1419
                    # conflict
 
1420
                    self.tt.version_file(file_id, trans_id)
 
1421
                    transform.create_from_tree(
 
1422
                        self.tt, trans_id, self.other_tree, file_id,
 
1423
                        filter_tree_path=self._get_filter_tree_path(file_id))
 
1424
                    inhibit_content_conflict = True
 
1425
            elif params.other_kind is None: # file_id is not in OTHER
 
1426
                # Is the name used for a different file_id ?
 
1427
                dupe_path = self.this_tree.id2path(file_id)
 
1428
                other_id = self.other_tree.path2id(dupe_path)
 
1429
                if other_id is not None:
 
1430
                    # Two entries for the same path again, but here, the other
 
1431
                    # entry will also be merged.  We simply inhibit the
 
1432
                    # 'content' conflict creation because we know OTHER will
 
1433
                    # create (or has already created depending on ordering) an
 
1434
                    # entry at the same path. This will trigger a 'duplicate'
 
1435
                    # conflict later.
 
1436
                    keep_this = True
 
1437
                    inhibit_content_conflict = True
 
1438
            if not inhibit_content_conflict:
 
1439
                if params.this_kind is not None:
 
1440
                    self.tt.unversion_file(trans_id)
 
1441
                # This is a contents conflict, because none of the available
 
1442
                # functions could merge it.
 
1443
                file_group = self._dump_conflicts(name, parent_id, file_id,
 
1444
                                                  set_version=True)
 
1445
                self._raw_conflicts.append(('contents conflict', file_group))
1373
1446
        elif hook_status == 'success':
1374
1447
            self.tt.create_file(lines, trans_id)
1375
1448
        elif hook_status == 'conflicted':
1391
1464
            raise AssertionError('unknown hook_status: %r' % (hook_status,))
1392
1465
        if not self.this_tree.has_id(file_id) and result == "modified":
1393
1466
            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:
 
1467
        if not keep_this:
 
1468
            # The merge has been performed and produced a new content, so the
 
1469
            # old contents should not be retained.
1397
1470
            self.tt.delete_contents(trans_id)
1398
 
        except errors.NoSuchFile:
1399
 
            pass
1400
1471
        return result
1401
1472
 
1402
1473
    def _default_other_winner_merge(self, merge_hook_params):
1403
1474
        """Replace this contents with other."""
1404
1475
        file_id = merge_hook_params.file_id
1405
1476
        trans_id = merge_hook_params.trans_id
1406
 
        file_in_this = self.this_tree.has_id(file_id)
1407
1477
        if self.other_tree.has_id(file_id):
1408
1478
            # 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)
 
1479
            transform.create_from_tree(
 
1480
                self.tt, trans_id, self.other_tree, file_id,
 
1481
                filter_tree_path=self._get_filter_tree_path(file_id))
1425
1482
            return 'done', None
1426
 
        elif file_in_this:
 
1483
        elif self.this_tree.has_id(file_id):
1427
1484
            # OTHER deleted the file
1428
1485
            return 'delete', None
1429
1486
        else:
1455
1512
    def get_lines(self, tree, file_id):
1456
1513
        """Return the lines in a file, or an empty list."""
1457
1514
        if tree.has_id(file_id):
1458
 
            return tree.get_file(file_id).readlines()
 
1515
            return tree.get_file_lines(file_id)
1459
1516
        else:
1460
1517
            return []
1461
1518
 
1503
1560
                                              other_lines)
1504
1561
            file_group.append(trans_id)
1505
1562
 
 
1563
 
 
1564
    def _get_filter_tree_path(self, file_id):
 
1565
        if self.this_tree.supports_content_filtering():
 
1566
            # We get the path from the working tree if it exists.
 
1567
            # That fails though when OTHER is adding a file, so
 
1568
            # we fall back to the other tree to find the path if
 
1569
            # it doesn't exist locally.
 
1570
            try:
 
1571
                return self.this_tree.id2path(file_id)
 
1572
            except errors.NoSuchId:
 
1573
                return self.other_tree.id2path(file_id)
 
1574
        # Skip the id2path lookup for older formats
 
1575
        return None
 
1576
 
1506
1577
    def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
1507
1578
                        base_lines=None, other_lines=None, set_version=False,
1508
1579
                        no_base=False):
1574
1645
        if winner == 'this' and file_status != "modified":
1575
1646
            return
1576
1647
        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:
 
1648
        if self.tt.final_kind(trans_id) != "file":
1581
1649
            return
1582
1650
        if winner == "this":
1583
1651
            executability = this_executable
1594
1662
 
1595
1663
    def cook_conflicts(self, fs_conflicts):
1596
1664
        """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))
 
1665
        content_conflict_file_ids = set()
 
1666
        cooked_conflicts = transform.cook_conflicts(fs_conflicts, self.tt)
1599
1667
        fp = transform.FinalPaths(self.tt)
1600
1668
        for conflict in self._raw_conflicts:
1601
1669
            conflict_type = conflict[0]
1612
1680
                if other_parent is None or other_name is None:
1613
1681
                    other_path = '<deleted>'
1614
1682
                else:
1615
 
                    parent_path =  fp.get_path(
1616
 
                        self.tt.trans_id_file_id(other_parent))
 
1683
                    if other_parent == self.other_tree.get_root_id():
 
1684
                        # The tree transform doesn't know about the other root,
 
1685
                        # so we special case here to avoid a NoFinalPath
 
1686
                        # exception
 
1687
                        parent_path = ''
 
1688
                    else:
 
1689
                        parent_path =  fp.get_path(
 
1690
                            self.tt.trans_id_file_id(other_parent))
1617
1691
                    other_path = osutils.pathjoin(parent_path, other_name)
1618
1692
                c = _mod_conflicts.Conflict.factory(
1619
1693
                    'path conflict', path=this_path,
1623
1697
                for trans_id in conflict[1]:
1624
1698
                    file_id = self.tt.final_file_id(trans_id)
1625
1699
                    if file_id is not None:
 
1700
                        # Ok we found the relevant file-id
1626
1701
                        break
1627
1702
                path = fp.get_path(trans_id)
1628
1703
                for suffix in ('.BASE', '.THIS', '.OTHER'):
1629
1704
                    if path.endswith(suffix):
 
1705
                        # Here is the raw path
1630
1706
                        path = path[:-len(suffix)]
1631
1707
                        break
1632
1708
                c = _mod_conflicts.Conflict.factory(conflict_type,
1633
1709
                                                    path=path, file_id=file_id)
 
1710
                content_conflict_file_ids.add(file_id)
1634
1711
            elif conflict_type == 'text conflict':
1635
1712
                trans_id = conflict[1]
1636
1713
                path = fp.get_path(trans_id)
1639
1716
                                                    path=path, file_id=file_id)
1640
1717
            else:
1641
1718
                raise AssertionError('bad conflict type: %r' % (conflict,))
 
1719
            cooked_conflicts.append(c)
 
1720
 
 
1721
        self.cooked_conflicts = []
 
1722
        # We want to get rid of path conflicts when a corresponding contents
 
1723
        # conflict exists. This can occur when one branch deletes a file while
 
1724
        # the other renames *and* modifies it. In this case, the content
 
1725
        # conflict is enough.
 
1726
        for c in cooked_conflicts:
 
1727
            if (c.typestring == 'path conflict'
 
1728
                and c.file_id in content_conflict_file_ids):
 
1729
                continue
1642
1730
            self.cooked_conflicts.append(c)
1643
1731
        self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
1644
1732
 
1750
1838
            osutils.rmtree(temp_dir)
1751
1839
 
1752
1840
 
 
1841
class PathNotInTree(errors.BzrError):
 
1842
 
 
1843
    _fmt = """Merge-into failed because %(tree)s does not contain %(path)s."""
 
1844
 
 
1845
    def __init__(self, path, tree):
 
1846
        errors.BzrError.__init__(self, path=path, tree=tree)
 
1847
 
 
1848
 
 
1849
class MergeIntoMerger(Merger):
 
1850
    """Merger that understands other_tree will be merged into a subdir.
 
1851
 
 
1852
    This also changes the Merger api so that it uses real Branch, revision_id,
 
1853
    and RevisonTree objects, rather than using revision specs.
 
1854
    """
 
1855
 
 
1856
    def __init__(self, this_tree, other_branch, other_tree, target_subdir,
 
1857
            source_subpath, other_rev_id=None):
 
1858
        """Create a new MergeIntoMerger object.
 
1859
 
 
1860
        source_subpath in other_tree will be effectively copied to
 
1861
        target_subdir in this_tree.
 
1862
 
 
1863
        :param this_tree: The tree that we will be merging into.
 
1864
        :param other_branch: The Branch we will be merging from.
 
1865
        :param other_tree: The RevisionTree object we want to merge.
 
1866
        :param target_subdir: The relative path where we want to merge
 
1867
            other_tree into this_tree
 
1868
        :param source_subpath: The relative path specifying the subtree of
 
1869
            other_tree to merge into this_tree.
 
1870
        """
 
1871
        # It is assumed that we are merging a tree that is not in our current
 
1872
        # ancestry, which means we are using the "EmptyTree" as our basis.
 
1873
        null_ancestor_tree = this_tree.branch.repository.revision_tree(
 
1874
                                _mod_revision.NULL_REVISION)
 
1875
        super(MergeIntoMerger, self).__init__(
 
1876
            this_branch=this_tree.branch,
 
1877
            this_tree=this_tree,
 
1878
            other_tree=other_tree,
 
1879
            base_tree=null_ancestor_tree,
 
1880
            )
 
1881
        self._target_subdir = target_subdir
 
1882
        self._source_subpath = source_subpath
 
1883
        self.other_branch = other_branch
 
1884
        if other_rev_id is None:
 
1885
            other_rev_id = other_tree.get_revision_id()
 
1886
        self.other_rev_id = self.other_basis = other_rev_id
 
1887
        self.base_is_ancestor = True
 
1888
        self.backup_files = True
 
1889
        self.merge_type = Merge3Merger
 
1890
        self.show_base = False
 
1891
        self.reprocess = False
 
1892
        self.interesting_ids = None
 
1893
        self.merge_type = _MergeTypeParameterizer(MergeIntoMergeType,
 
1894
              target_subdir=self._target_subdir,
 
1895
              source_subpath=self._source_subpath)
 
1896
        if self._source_subpath != '':
 
1897
            # If this isn't a partial merge make sure the revisions will be
 
1898
            # present.
 
1899
            self._maybe_fetch(self.other_branch, self.this_branch,
 
1900
                self.other_basis)
 
1901
 
 
1902
    def set_pending(self):
 
1903
        if self._source_subpath != '':
 
1904
            return
 
1905
        Merger.set_pending(self)
 
1906
 
 
1907
 
 
1908
class _MergeTypeParameterizer(object):
 
1909
    """Wrap a merge-type class to provide extra parameters.
 
1910
    
 
1911
    This is hack used by MergeIntoMerger to pass some extra parameters to its
 
1912
    merge_type.  Merger.do_merge() sets up its own set of parameters to pass to
 
1913
    the 'merge_type' member.  It is difficult override do_merge without
 
1914
    re-writing the whole thing, so instead we create a wrapper which will pass
 
1915
    the extra parameters.
 
1916
    """
 
1917
 
 
1918
    def __init__(self, merge_type, **kwargs):
 
1919
        self._extra_kwargs = kwargs
 
1920
        self._merge_type = merge_type
 
1921
 
 
1922
    def __call__(self, *args, **kwargs):
 
1923
        kwargs.update(self._extra_kwargs)
 
1924
        return self._merge_type(*args, **kwargs)
 
1925
 
 
1926
    def __getattr__(self, name):
 
1927
        return getattr(self._merge_type, name)
 
1928
 
 
1929
 
 
1930
class MergeIntoMergeType(Merge3Merger):
 
1931
    """Merger that incorporates a tree (or part of a tree) into another."""
 
1932
 
 
1933
    def __init__(self, *args, **kwargs):
 
1934
        """Initialize the merger object.
 
1935
 
 
1936
        :param args: See Merge3Merger.__init__'s args.
 
1937
        :param kwargs: See Merge3Merger.__init__'s keyword args, except for
 
1938
            source_subpath and target_subdir.
 
1939
        :keyword source_subpath: The relative path specifying the subtree of
 
1940
            other_tree to merge into this_tree.
 
1941
        :keyword target_subdir: The relative path where we want to merge
 
1942
            other_tree into this_tree
 
1943
        """
 
1944
        # All of the interesting work happens during Merge3Merger.__init__(),
 
1945
        # so we have have to hack in to get our extra parameters set.
 
1946
        self._source_subpath = kwargs.pop('source_subpath')
 
1947
        self._target_subdir = kwargs.pop('target_subdir')
 
1948
        super(MergeIntoMergeType, self).__init__(*args, **kwargs)
 
1949
 
 
1950
    def _compute_transform(self):
 
1951
        child_pb = ui.ui_factory.nested_progress_bar()
 
1952
        try:
 
1953
            entries = self._entries_to_incorporate()
 
1954
            entries = list(entries)
 
1955
            for num, (entry, parent_id) in enumerate(entries):
 
1956
                child_pb.update(gettext('Preparing file merge'), num, len(entries))
 
1957
                parent_trans_id = self.tt.trans_id_file_id(parent_id)
 
1958
                trans_id = transform.new_by_entry(self.tt, entry,
 
1959
                    parent_trans_id, self.other_tree)
 
1960
        finally:
 
1961
            child_pb.finished()
 
1962
        self._finish_computing_transform()
 
1963
 
 
1964
    def _entries_to_incorporate(self):
 
1965
        """Yields pairs of (inventory_entry, new_parent)."""
 
1966
        other_inv = self.other_tree.inventory
 
1967
        subdir_id = other_inv.path2id(self._source_subpath)
 
1968
        if subdir_id is None:
 
1969
            # XXX: The error would be clearer if it gave the URL of the source
 
1970
            # branch, but we don't have a reference to that here.
 
1971
            raise PathNotInTree(self._source_subpath, "Source tree")
 
1972
        subdir = other_inv[subdir_id]
 
1973
        parent_in_target = osutils.dirname(self._target_subdir)
 
1974
        target_id = self.this_tree.inventory.path2id(parent_in_target)
 
1975
        if target_id is None:
 
1976
            raise PathNotInTree(self._target_subdir, "Target tree")
 
1977
        name_in_target = osutils.basename(self._target_subdir)
 
1978
        merge_into_root = subdir.copy()
 
1979
        merge_into_root.name = name_in_target
 
1980
        if self.this_tree.inventory.has_id(merge_into_root.file_id):
 
1981
            # Give the root a new file-id.
 
1982
            # This can happen fairly easily if the directory we are
 
1983
            # incorporating is the root, and both trees have 'TREE_ROOT' as
 
1984
            # their root_id.  Users will expect this to Just Work, so we
 
1985
            # change the file-id here.
 
1986
            # Non-root file-ids could potentially conflict too.  That's really
 
1987
            # an edge case, so we don't do anything special for those.  We let
 
1988
            # them cause conflicts.
 
1989
            merge_into_root.file_id = generate_ids.gen_file_id(name_in_target)
 
1990
        yield (merge_into_root, target_id)
 
1991
        if subdir.kind != 'directory':
 
1992
            # No children, so we are done.
 
1993
            return
 
1994
        for ignored_path, entry in other_inv.iter_entries_by_dir(subdir_id):
 
1995
            parent_id = entry.parent_id
 
1996
            if parent_id == subdir.file_id:
 
1997
                # The root's parent ID has changed, so make sure children of
 
1998
                # the root refer to the new ID.
 
1999
                parent_id = merge_into_root.file_id
 
2000
            yield (entry, parent_id)
 
2001
 
 
2002
 
1753
2003
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1754
2004
                backup_files=False,
1755
2005
                merge_type=Merge3Merger,
1763
2013
                change_reporter=None):
1764
2014
    """Primary interface for merging.
1765
2015
 
1766
 
        typical use is probably
1767
 
        'merge_inner(branch, branch.get_revision_tree(other_revision),
1768
 
                     branch.get_revision_tree(base_revision))'
1769
 
        """
 
2016
    Typical use is probably::
 
2017
 
 
2018
        merge_inner(branch, branch.get_revision_tree(other_revision),
 
2019
                    branch.get_revision_tree(base_revision))
 
2020
    """
1770
2021
    if this_tree is None:
1771
2022
        raise errors.BzrError("bzrlib.merge.merge_inner requires a this_tree "
1772
 
                              "parameter as of bzrlib version 0.8.")
 
2023
                              "parameter")
1773
2024
    merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1774
2025
                    pb=pb, change_reporter=change_reporter)
1775
2026
    merger.backup_files = backup_files
1792
2043
    merger.set_base_revision(get_revision_id(), this_branch)
1793
2044
    return merger.do_merge()
1794
2045
 
 
2046
 
 
2047
merge_type_registry = registry.Registry()
 
2048
merge_type_registry.register('diff3', Diff3Merger,
 
2049
                             "Merge using external diff3.")
 
2050
merge_type_registry.register('lca', LCAMerger,
 
2051
                             "LCA-newness merge.")
 
2052
merge_type_registry.register('merge3', Merge3Merger,
 
2053
                             "Native diff3-style merge.")
 
2054
merge_type_registry.register('weave', WeaveMerger,
 
2055
                             "Weave-based merge.")
 
2056
 
 
2057
 
1795
2058
def get_merge_type_registry():
1796
 
    """Merge type registry is in bzrlib.option to avoid circular imports.
 
2059
    """Merge type registry was previously in bzrlib.option
1797
2060
 
1798
 
    This method provides a sanctioned way to retrieve it.
 
2061
    This method provides a backwards compatible way to retrieve it.
1799
2062
    """
1800
 
    from bzrlib import option
1801
 
    return option._merge_type_registry
 
2063
    return merge_type_registry
1802
2064
 
1803
2065
 
1804
2066
def _plan_annotate_merge(annotated_a, annotated_b, ancestors_a, ancestors_b):
2229
2491
class _PlanLCAMerge(_PlanMergeBase):
2230
2492
    """
2231
2493
    This merge algorithm differs from _PlanMerge in that:
 
2494
 
2232
2495
    1. comparisons are done against LCAs only
2233
2496
    2. cases where a contested line is new versus one LCA but old versus
2234
2497
       another are marked as conflicts, by emitting the line as conflicted-a
2275
2538
 
2276
2539
        If a line is killed and new, this indicates that the two merge
2277
2540
        revisions contain differing conflict resolutions.
 
2541
 
2278
2542
        :param revision_id: The id of the revision in which the lines are
2279
2543
            unique
2280
2544
        :param unique_line_numbers: The line numbers of unique lines.
2281
 
        :return a tuple of (new_this, killed_other):
 
2545
        :return: a tuple of (new_this, killed_other)
2282
2546
        """
2283
2547
        new = set()
2284
2548
        killed = set()