~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-04-01 00:40:31 UTC
  • mfrom: (4081.2.5 bug513322-first)
  • Revision ID: pqm@pqm.ubuntu.com-20100401004031-pc7s84z6ahqunmy2
(mbp, for gagern) show first apparent author in gnu changelog

Show diffs side-by-side

added added

removed removed

Lines of Context:
16
16
 
17
17
import warnings
18
18
 
19
 
from bzrlib.lazy_import import lazy_import
20
 
lazy_import(globals(), """
21
19
from bzrlib import (
22
20
    branch as _mod_branch,
23
21
    conflicts as _mod_conflicts,
24
22
    debug,
25
 
    generate_ids,
 
23
    decorators,
 
24
    errors,
26
25
    graph as _mod_graph,
 
26
    hooks,
27
27
    merge3,
28
28
    osutils,
29
29
    patiencediff,
34
34
    tree as _mod_tree,
35
35
    tsort,
36
36
    ui,
37
 
    versionedfile,
38
 
    workingtree,
 
37
    versionedfile
39
38
    )
40
39
from bzrlib.cleanup import OperationWithCleanups
41
 
""")
42
 
from bzrlib import (
43
 
    decorators,
44
 
    errors,
45
 
    hooks,
46
 
    )
47
40
from bzrlib.symbol_versioning import (
48
41
    deprecated_in,
49
42
    deprecated_method,
100
93
        return ('not applicable', None)
101
94
 
102
95
 
103
 
class PerFileMerger(AbstractPerFileMerger):
104
 
    """Merge individual files when self.file_matches returns True.
105
 
 
106
 
    This class is intended to be subclassed.  The file_matches and
107
 
    merge_matching methods should be overridden with concrete implementations.
108
 
    """
109
 
 
110
 
    def file_matches(self, params):
111
 
        """Return True if merge_matching should be called on this file.
112
 
 
113
 
        Only called with merges of plain files with no clear winner.
114
 
 
115
 
        Subclasses must override this.
116
 
        """
117
 
        raise NotImplementedError(self.file_matches)
118
 
 
119
 
    def get_filename(self, params, tree):
120
 
        """Lookup the filename (i.e. basename, not path), given a Tree (e.g.
121
 
        self.merger.this_tree) and a MergeHookParams.
122
 
        """
123
 
        return osutils.basename(tree.id2path(params.file_id))
124
 
 
125
 
    def get_filepath(self, params, tree):
126
 
        """Calculate the path to the file in a tree.
127
 
 
128
 
        :param params: A MergeHookParams describing the file to merge
129
 
        :param tree: a Tree, e.g. self.merger.this_tree.
130
 
        """
131
 
        return tree.id2path(params.file_id)
132
 
 
133
 
    def merge_contents(self, params):
134
 
        """Merge the contents of a single file."""
135
 
        # Check whether this custom merge logic should be used.
136
 
        if (
137
 
            # OTHER is a straight winner, rely on default merge.
138
 
            params.winner == 'other' or
139
 
            # THIS and OTHER aren't both files.
140
 
            not params.is_file_merge() or
141
 
            # The filename doesn't match *.xml
142
 
            not self.file_matches(params)):
143
 
            return 'not_applicable', None
144
 
        return self.merge_matching(params)
145
 
 
146
 
    def merge_matching(self, params):
147
 
        """Merge the contents of a single file that has matched the criteria
148
 
        in PerFileMerger.merge_contents (is a conflict, is a file,
149
 
        self.file_matches is True).
150
 
 
151
 
        Subclasses must override this.
152
 
        """
153
 
        raise NotImplementedError(self.merge_matching)
154
 
 
155
 
 
156
 
class ConfigurableFileMerger(PerFileMerger):
 
96
class ConfigurableFileMerger(AbstractPerFileMerger):
157
97
    """Merge individual files when configured via a .conf file.
158
98
 
159
99
    This is a base class for concrete custom file merging logic. Concrete
182
122
        if self.name_prefix is None:
183
123
            raise ValueError("name_prefix must be set.")
184
124
 
185
 
    def file_matches(self, params):
 
125
    def filename_matches_config(self, params):
186
126
        """Check whether the file should call the merge hook.
187
127
 
188
128
        <name_prefix>_merge_files configuration variable is a list of files
202
142
                affected_files = self.default_files
203
143
            self.affected_files = affected_files
204
144
        if affected_files:
205
 
            filepath = self.get_filepath(params, self.merger.this_tree)
206
 
            if filepath in affected_files:
 
145
            filename = self.merger.this_tree.id2path(params.file_id)
 
146
            if filename in affected_files:
207
147
                return True
208
148
        return False
209
149
 
210
 
    def merge_matching(self, params):
 
150
    def merge_contents(self, params):
 
151
        """Merge the contents of a single file."""
 
152
        # First, check whether this custom merge logic should be used.  We
 
153
        # expect most files should not be merged by this handler.
 
154
        if (
 
155
            # OTHER is a straight winner, rely on default merge.
 
156
            params.winner == 'other' or
 
157
            # THIS and OTHER aren't both files.
 
158
            not params.is_file_merge() or
 
159
            # The filename isn't listed in the 'NAME_merge_files' config
 
160
            # option.
 
161
            not self.filename_matches_config(params)):
 
162
            return 'not_applicable', None
211
163
        return self.merge_text(params)
212
164
 
213
165
    def merge_text(self, params):
428
380
        return self._cached_trees[revision_id]
429
381
 
430
382
    def _get_tree(self, treespec, possible_transports=None):
 
383
        from bzrlib import workingtree
431
384
        location, revno = treespec
432
385
        if revno is None:
433
386
            tree = workingtree.WorkingTree.open_containing(location)[0]
751
704
        :param this_tree: The local tree in the merge operation
752
705
        :param base_tree: The common tree in the merge operation
753
706
        :param other_tree: The other tree to merge changes from
754
 
        :param this_branch: The branch associated with this_tree.  Defaults to
755
 
            this_tree.branch if not supplied.
 
707
        :param this_branch: The branch associated with this_tree
756
708
        :param interesting_ids: The file_ids of files that should be
757
709
            participate in the merge.  May not be combined with
758
710
            interesting_files.
776
728
        if interesting_files is not None and interesting_ids is not None:
777
729
            raise ValueError(
778
730
                'specify either interesting_ids or interesting_files')
779
 
        if this_branch is None:
780
 
            this_branch = this_tree.branch
781
731
        self.interesting_ids = interesting_ids
782
732
        self.interesting_files = interesting_files
783
733
        self.this_tree = working_tree
862
812
        finally:
863
813
            child_pb.finished()
864
814
        self.fix_root()
865
 
        self._finish_computing_transform()
866
 
 
867
 
    def _finish_computing_transform(self):
868
 
        """Finalize the transform and report the changes.
869
 
 
870
 
        This is the second half of _compute_transform.
871
 
        """
872
815
        child_pb = ui.ui_factory.nested_progress_bar()
873
816
        try:
874
817
            fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
1072
1015
                        continue
1073
1016
                else:
1074
1017
                    raise AssertionError('unhandled kind: %s' % other_ie.kind)
 
1018
                # XXX: We need to handle kind == 'symlink'
1075
1019
 
1076
1020
            # If we have gotten this far, that means something has changed
1077
1021
            result.append((file_id, content_changed,
1084
1028
                          ))
1085
1029
        return result
1086
1030
 
 
1031
 
1087
1032
    def fix_root(self):
1088
 
        if self.tt.final_kind(self.tt.root) is None:
 
1033
        try:
 
1034
            self.tt.final_kind(self.tt.root)
 
1035
        except errors.NoSuchFile:
1089
1036
            self.tt.cancel_deletion(self.tt.root)
1090
1037
        if self.tt.final_file_id(self.tt.root) is None:
1091
1038
            self.tt.version_file(self.tt.tree_file_id(self.tt.root),
1096
1043
        other_root = self.tt.trans_id_file_id(other_root_file_id)
1097
1044
        if other_root == self.tt.root:
1098
1045
            return
1099
 
        if self.other_tree.inventory.root.file_id in self.this_tree.inventory:
1100
 
            # the other tree's root is a non-root in the current tree (as when
1101
 
            # a previously unrelated branch is merged into another)
1102
 
            return
1103
 
        if self.tt.final_kind(other_root) is not None:
1104
 
            other_root_is_present = True
1105
 
        else:
1106
 
            # other_root doesn't have a physical representation. We still need
1107
 
            # to move any references to the actual root of the tree.
1108
 
            other_root_is_present = False
1109
 
        # 'other_tree.inventory.root' is not present in this tree. We are
1110
 
        # calling adjust_path for children which *want* to be present with a
1111
 
        # correct place to go.
1112
 
        for thing, child in self.other_tree.inventory.root.children.iteritems():
 
1046
        try:
 
1047
            self.tt.final_kind(other_root)
 
1048
        except errors.NoSuchFile:
 
1049
            return
 
1050
        if self.this_tree.has_id(self.other_tree.inventory.root.file_id):
 
1051
            # the other tree's root is a non-root in the current tree
 
1052
            return
 
1053
        self.reparent_children(self.other_tree.inventory.root, self.tt.root)
 
1054
        self.tt.cancel_creation(other_root)
 
1055
        self.tt.cancel_versioning(other_root)
 
1056
 
 
1057
    def reparent_children(self, ie, target):
 
1058
        for thing, child in ie.children.iteritems():
1113
1059
            trans_id = self.tt.trans_id_file_id(child.file_id)
1114
 
            if not other_root_is_present:
1115
 
                if self.tt.final_kind(trans_id) is not None:
1116
 
                    # The item exist in the final tree and has a defined place
1117
 
                    # to go already.
1118
 
                    continue
1119
 
            # Move the item into the root
1120
 
            self.tt.adjust_path(self.tt.final_name(trans_id),
1121
 
                                self.tt.root, trans_id)
1122
 
        if other_root_is_present:
1123
 
            self.tt.cancel_creation(other_root)
1124
 
            self.tt.cancel_versioning(other_root)
 
1060
            self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
1125
1061
 
1126
1062
    def write_modified(self, results):
1127
1063
        modified_hashes = {}
1174
1110
 
1175
1111
    @staticmethod
1176
1112
    def _three_way(base, other, this):
 
1113
        #if base == other, either they all agree, or only THIS has changed.
1177
1114
        if base == other:
1178
 
            # if 'base == other', either they all agree, or only 'this' has
1179
 
            # changed.
1180
1115
            return 'this'
1181
1116
        elif this not in (base, other):
1182
 
            # 'this' is neither 'base' nor 'other', so both sides changed
1183
1117
            return 'conflict'
 
1118
        # "Ambiguous clean merge" -- both sides have made the same change.
1184
1119
        elif this == other:
1185
 
            # "Ambiguous clean merge" -- both sides have made the same change.
1186
1120
            return "this"
 
1121
        # this == base: only other has changed.
1187
1122
        else:
1188
 
            # this == base: only other has changed.
1189
1123
            return "other"
1190
1124
 
1191
1125
    @staticmethod
1235
1169
                # only has an lca value
1236
1170
                return 'other'
1237
1171
 
1238
 
        # At this point, the lcas disagree, and the tip disagree
 
1172
        # At this point, the lcas disagree, and the tips disagree
1239
1173
        return 'conflict'
1240
1174
 
1241
1175
    @staticmethod
1397
1331
            self.tt.version_file(file_id, trans_id)
1398
1332
        # The merge has been performed, so the old contents should not be
1399
1333
        # retained.
1400
 
        self.tt.delete_contents(trans_id)
 
1334
        try:
 
1335
            self.tt.delete_contents(trans_id)
 
1336
        except errors.NoSuchFile:
 
1337
            pass
1401
1338
        return result
1402
1339
 
1403
1340
    def _default_other_winner_merge(self, merge_hook_params):
1456
1393
    def get_lines(self, tree, file_id):
1457
1394
        """Return the lines in a file, or an empty list."""
1458
1395
        if tree.has_id(file_id):
1459
 
            return tree.get_file_lines(file_id)
 
1396
            return tree.get_file(file_id).readlines()
1460
1397
        else:
1461
1398
            return []
1462
1399
 
1575
1512
        if winner == 'this' and file_status != "modified":
1576
1513
            return
1577
1514
        trans_id = self.tt.trans_id_file_id(file_id)
1578
 
        if self.tt.final_kind(trans_id) != "file":
 
1515
        try:
 
1516
            if self.tt.final_kind(trans_id) != "file":
 
1517
                return
 
1518
        except errors.NoSuchFile:
1579
1519
            return
1580
1520
        if winner == "this":
1581
1521
            executability = this_executable
1748
1688
            osutils.rmtree(temp_dir)
1749
1689
 
1750
1690
 
1751
 
class PathNotInTree(errors.BzrError):
1752
 
 
1753
 
    _fmt = """Merge-into failed because %(tree)s does not contain %(path)s."""
1754
 
 
1755
 
    def __init__(self, path, tree):
1756
 
        errors.BzrError.__init__(self, path=path, tree=tree)
1757
 
 
1758
 
 
1759
 
class MergeIntoMerger(Merger):
1760
 
    """Merger that understands other_tree will be merged into a subdir.
1761
 
 
1762
 
    This also changes the Merger api so that it uses real Branch, revision_id,
1763
 
    and RevisonTree objects, rather than using revision specs.
1764
 
    """
1765
 
 
1766
 
    def __init__(self, this_tree, other_branch, other_tree, target_subdir,
1767
 
            source_subpath, other_rev_id=None):
1768
 
        """Create a new MergeIntoMerger object.
1769
 
 
1770
 
        source_subpath in other_tree will be effectively copied to
1771
 
        target_subdir in this_tree.
1772
 
 
1773
 
        :param this_tree: The tree that we will be merging into.
1774
 
        :param other_branch: The Branch we will be merging from.
1775
 
        :param other_tree: The RevisionTree object we want to merge.
1776
 
        :param target_subdir: The relative path where we want to merge
1777
 
            other_tree into this_tree
1778
 
        :param source_subpath: The relative path specifying the subtree of
1779
 
            other_tree to merge into this_tree.
1780
 
        """
1781
 
        # It is assumed that we are merging a tree that is not in our current
1782
 
        # ancestry, which means we are using the "EmptyTree" as our basis.
1783
 
        null_ancestor_tree = this_tree.branch.repository.revision_tree(
1784
 
                                _mod_revision.NULL_REVISION)
1785
 
        super(MergeIntoMerger, self).__init__(
1786
 
            this_branch=this_tree.branch,
1787
 
            this_tree=this_tree,
1788
 
            other_tree=other_tree,
1789
 
            base_tree=null_ancestor_tree,
1790
 
            )
1791
 
        self._target_subdir = target_subdir
1792
 
        self._source_subpath = source_subpath
1793
 
        self.other_branch = other_branch
1794
 
        if other_rev_id is None:
1795
 
            other_rev_id = other_tree.get_revision_id()
1796
 
        self.other_rev_id = self.other_basis = other_rev_id
1797
 
        self.base_is_ancestor = True
1798
 
        self.backup_files = True
1799
 
        self.merge_type = Merge3Merger
1800
 
        self.show_base = False
1801
 
        self.reprocess = False
1802
 
        self.interesting_ids = None
1803
 
        self.merge_type = _MergeTypeParameterizer(MergeIntoMergeType,
1804
 
              target_subdir=self._target_subdir,
1805
 
              source_subpath=self._source_subpath)
1806
 
        if self._source_subpath != '':
1807
 
            # If this isn't a partial merge make sure the revisions will be
1808
 
            # present.
1809
 
            self._maybe_fetch(self.other_branch, self.this_branch,
1810
 
                self.other_basis)
1811
 
 
1812
 
    def set_pending(self):
1813
 
        if self._source_subpath != '':
1814
 
            return
1815
 
        Merger.set_pending(self)
1816
 
 
1817
 
 
1818
 
class _MergeTypeParameterizer(object):
1819
 
    """Wrap a merge-type class to provide extra parameters.
1820
 
    
1821
 
    This is hack used by MergeIntoMerger to pass some extra parameters to its
1822
 
    merge_type.  Merger.do_merge() sets up its own set of parameters to pass to
1823
 
    the 'merge_type' member.  It is difficult override do_merge without
1824
 
    re-writing the whole thing, so instead we create a wrapper which will pass
1825
 
    the extra parameters.
1826
 
    """
1827
 
 
1828
 
    def __init__(self, merge_type, **kwargs):
1829
 
        self._extra_kwargs = kwargs
1830
 
        self._merge_type = merge_type
1831
 
 
1832
 
    def __call__(self, *args, **kwargs):
1833
 
        kwargs.update(self._extra_kwargs)
1834
 
        return self._merge_type(*args, **kwargs)
1835
 
 
1836
 
    def __getattr__(self, name):
1837
 
        return getattr(self._merge_type, name)
1838
 
 
1839
 
 
1840
 
class MergeIntoMergeType(Merge3Merger):
1841
 
    """Merger that incorporates a tree (or part of a tree) into another."""
1842
 
 
1843
 
    def __init__(self, *args, **kwargs):
1844
 
        """Initialize the merger object.
1845
 
 
1846
 
        :param args: See Merge3Merger.__init__'s args.
1847
 
        :param kwargs: See Merge3Merger.__init__'s keyword args, except for
1848
 
            source_subpath and target_subdir.
1849
 
        :keyword source_subpath: The relative path specifying the subtree of
1850
 
            other_tree to merge into this_tree.
1851
 
        :keyword target_subdir: The relative path where we want to merge
1852
 
            other_tree into this_tree
1853
 
        """
1854
 
        # All of the interesting work happens during Merge3Merger.__init__(),
1855
 
        # so we have have to hack in to get our extra parameters set.
1856
 
        self._source_subpath = kwargs.pop('source_subpath')
1857
 
        self._target_subdir = kwargs.pop('target_subdir')
1858
 
        super(MergeIntoMergeType, self).__init__(*args, **kwargs)
1859
 
 
1860
 
    def _compute_transform(self):
1861
 
        child_pb = ui.ui_factory.nested_progress_bar()
1862
 
        try:
1863
 
            entries = self._entries_to_incorporate()
1864
 
            entries = list(entries)
1865
 
            for num, (entry, parent_id) in enumerate(entries):
1866
 
                child_pb.update('Preparing file merge', num, len(entries))
1867
 
                parent_trans_id = self.tt.trans_id_file_id(parent_id)
1868
 
                trans_id = transform.new_by_entry(self.tt, entry,
1869
 
                    parent_trans_id, self.other_tree)
1870
 
        finally:
1871
 
            child_pb.finished()
1872
 
        self._finish_computing_transform()
1873
 
 
1874
 
    def _entries_to_incorporate(self):
1875
 
        """Yields pairs of (inventory_entry, new_parent)."""
1876
 
        other_inv = self.other_tree.inventory
1877
 
        subdir_id = other_inv.path2id(self._source_subpath)
1878
 
        if subdir_id is None:
1879
 
            # XXX: The error would be clearer if it gave the URL of the source
1880
 
            # branch, but we don't have a reference to that here.
1881
 
            raise PathNotInTree(self._source_subpath, "Source tree")
1882
 
        subdir = other_inv[subdir_id]
1883
 
        parent_in_target = osutils.dirname(self._target_subdir)
1884
 
        target_id = self.this_tree.inventory.path2id(parent_in_target)
1885
 
        if target_id is None:
1886
 
            raise PathNotInTree(self._target_subdir, "Target tree")
1887
 
        name_in_target = osutils.basename(self._target_subdir)
1888
 
        merge_into_root = subdir.copy()
1889
 
        merge_into_root.name = name_in_target
1890
 
        if merge_into_root.file_id in self.this_tree.inventory:
1891
 
            # Give the root a new file-id.
1892
 
            # This can happen fairly easily if the directory we are
1893
 
            # incorporating is the root, and both trees have 'TREE_ROOT' as
1894
 
            # their root_id.  Users will expect this to Just Work, so we
1895
 
            # change the file-id here.
1896
 
            # Non-root file-ids could potentially conflict too.  That's really
1897
 
            # an edge case, so we don't do anything special for those.  We let
1898
 
            # them cause conflicts.
1899
 
            merge_into_root.file_id = generate_ids.gen_file_id(name_in_target)
1900
 
        yield (merge_into_root, target_id)
1901
 
        if subdir.kind != 'directory':
1902
 
            # No children, so we are done.
1903
 
            return
1904
 
        for ignored_path, entry in other_inv.iter_entries_by_dir(subdir_id):
1905
 
            parent_id = entry.parent_id
1906
 
            if parent_id == subdir.file_id:
1907
 
                # The root's parent ID has changed, so make sure children of
1908
 
                # the root refer to the new ID.
1909
 
                parent_id = merge_into_root.file_id
1910
 
            yield (entry, parent_id)
1911
 
 
1912
 
 
1913
1691
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1914
1692
                backup_files=False,
1915
1693
                merge_type=Merge3Merger,
1923
1701
                change_reporter=None):
1924
1702
    """Primary interface for merging.
1925
1703
 
1926
 
    Typical use is probably::
1927
 
 
1928
 
        merge_inner(branch, branch.get_revision_tree(other_revision),
1929
 
                    branch.get_revision_tree(base_revision))
1930
 
    """
 
1704
        typical use is probably
 
1705
        'merge_inner(branch, branch.get_revision_tree(other_revision),
 
1706
                     branch.get_revision_tree(base_revision))'
 
1707
        """
1931
1708
    if this_tree is None:
1932
1709
        raise errors.BzrError("bzrlib.merge.merge_inner requires a this_tree "
1933
1710
                              "parameter as of bzrlib version 0.8.")