~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: Martin
  • Date: 2010-06-22 00:32:37 UTC
  • mto: This revision was merged to the branch mainline in revision 5315.
  • Revision ID: gzlist@googlemail.com-20100622003237-zntnpyx8hjb5jnpw
Change interface of _command_line_to_argv so old tests can still be used with new stripping logic

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
20
20
lazy_import(globals(), """
21
21
from bzrlib import (
22
22
    branch as _mod_branch,
23
 
    cleanup,
24
23
    conflicts as _mod_conflicts,
25
24
    debug,
26
 
    generate_ids,
 
25
    errors,
27
26
    graph as _mod_graph,
28
27
    merge3,
29
28
    osutils,
36
35
    tsort,
37
36
    ui,
38
37
    versionedfile,
39
 
    workingtree,
40
38
    )
 
39
from bzrlib.cleanup import OperationWithCleanups
41
40
""")
42
41
from bzrlib import (
43
42
    decorators,
44
 
    errors,
45
43
    hooks,
46
44
    )
47
45
from bzrlib.symbol_versioning import (
53
51
 
54
52
def transform_tree(from_tree, to_tree, interesting_ids=None):
55
53
    from_tree.lock_tree_write()
56
 
    operation = cleanup.OperationWithCleanups(merge_inner)
 
54
    operation = OperationWithCleanups(merge_inner)
57
55
    operation.add_cleanup(from_tree.unlock)
58
56
    operation.run_simple(from_tree.branch, to_tree, from_tree,
59
57
        ignore_zero=True, interesting_ids=interesting_ids, this_tree=from_tree)
62
60
class MergeHooks(hooks.Hooks):
63
61
 
64
62
    def __init__(self):
65
 
        hooks.Hooks.__init__(self, "bzrlib.merge", "Merger.hooks")
66
 
        self.add_hook('merge_file_content',
 
63
        hooks.Hooks.__init__(self)
 
64
        self.create_hook(hooks.HookPoint('merge_file_content',
67
65
            "Called with a bzrlib.merge.Merger object to create a per file "
68
66
            "merge object when starting a merge. "
69
67
            "Should return either None or a subclass of "
73
71
            "side has deleted the file and the other has changed it). "
74
72
            "See the AbstractPerFileMerger API docs for details on how it is "
75
73
            "used by merge.",
76
 
            (2, 1))
 
74
            (2, 1), None))
77
75
 
78
76
 
79
77
class AbstractPerFileMerger(object):
428
426
        return self._cached_trees[revision_id]
429
427
 
430
428
    def _get_tree(self, treespec, possible_transports=None):
 
429
        from bzrlib import workingtree
431
430
        location, revno = treespec
432
431
        if revno is None:
433
432
            tree = workingtree.WorkingTree.open_containing(location)[0]
458
457
    @deprecated_method(deprecated_in((2, 1, 0)))
459
458
    def file_revisions(self, file_id):
460
459
        self.ensure_revision_trees()
 
460
        def get_id(tree, file_id):
 
461
            revision_id = tree.inventory[file_id].revision
 
462
            return revision_id
461
463
        if self.this_rev_id is None:
462
464
            if self.this_basis_tree.get_file_sha1(file_id) != \
463
465
                self.this_tree.get_file_sha1(file_id):
464
466
                raise errors.WorkingTreeNotRevision(self.this_tree)
465
467
 
466
468
        trees = (self.this_basis_tree, self.other_tree)
467
 
        return [tree.get_file_revision(file_id) for tree in trees]
 
469
        return [get_id(tree, file_id) for tree in trees]
468
470
 
469
471
    @deprecated_method(deprecated_in((2, 1, 0)))
470
472
    def check_basis(self, check_clean, require_commits=True):
498
500
    def _add_parent(self):
499
501
        new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
500
502
        new_parent_trees = []
501
 
        operation = cleanup.OperationWithCleanups(
502
 
            self.this_tree.set_parent_trees)
 
503
        operation = OperationWithCleanups(self.this_tree.set_parent_trees)
503
504
        for revision_id in new_parents:
504
505
            try:
505
506
                tree = self.revision_tree(revision_id)
580
581
            elif len(lcas) == 1:
581
582
                self.base_rev_id = list(lcas)[0]
582
583
            else: # len(lcas) > 1
583
 
                self._is_criss_cross = True
584
584
                if len(lcas) > 2:
585
585
                    # find_unique_lca can only handle 2 nodes, so we have to
586
586
                    # start back at the beginning. It is a shame to traverse
591
591
                else:
592
592
                    self.base_rev_id = self.revision_graph.find_unique_lca(
593
593
                                            *lcas)
594
 
                sorted_lca_keys = self.revision_graph.find_merge_order(                
595
 
                    revisions[0], lcas)
596
 
                if self.base_rev_id == _mod_revision.NULL_REVISION:
597
 
                    self.base_rev_id = sorted_lca_keys[0]
598
 
                
 
594
                self._is_criss_cross = True
599
595
            if self.base_rev_id == _mod_revision.NULL_REVISION:
600
596
                raise errors.UnrelatedBranches()
601
597
            if self._is_criss_cross:
602
598
                trace.warning('Warning: criss-cross merge encountered.  See bzr'
603
599
                              ' help criss-cross.')
604
600
                trace.mutter('Criss-cross lcas: %r' % lcas)
605
 
                if self.base_rev_id in lcas:
606
 
                    trace.mutter('Unable to find unique lca. '
607
 
                                 'Fallback %r as best option.' % self.base_rev_id)
608
 
                interesting_revision_ids = set(lcas)
609
 
                interesting_revision_ids.add(self.base_rev_id)
 
601
                interesting_revision_ids = [self.base_rev_id]
 
602
                interesting_revision_ids.extend(lcas)
610
603
                interesting_trees = dict((t.get_revision_id(), t)
611
604
                    for t in self.this_branch.repository.revision_trees(
612
605
                        interesting_revision_ids))
613
606
                self._cached_trees.update(interesting_trees)
614
 
                if self.base_rev_id in lcas:
615
 
                    self.base_tree = interesting_trees[self.base_rev_id]
616
 
                else:
617
 
                    self.base_tree = interesting_trees.pop(self.base_rev_id)
 
607
                self.base_tree = interesting_trees.pop(self.base_rev_id)
 
608
                sorted_lca_keys = self.revision_graph.find_merge_order(
 
609
                    revisions[0], lcas)
618
610
                self._lca_trees = [interesting_trees[key]
619
611
                                   for key in sorted_lca_keys]
620
612
            else:
699
691
        return merge
700
692
 
701
693
    def do_merge(self):
702
 
        operation = cleanup.OperationWithCleanups(self._do_merge_to)
 
694
        operation = OperationWithCleanups(self._do_merge_to)
703
695
        self.this_tree.lock_tree_write()
704
696
        operation.add_cleanup(self.this_tree.unlock)
705
697
        if self.base_tree is not None:
811
803
            warnings.warn("pb argument to Merge3Merger is deprecated")
812
804
 
813
805
    def do_merge(self):
814
 
        operation = cleanup.OperationWithCleanups(self._do_merge)
 
806
        operation = OperationWithCleanups(self._do_merge)
815
807
        self.this_tree.lock_tree_write()
816
808
        operation.add_cleanup(self.this_tree.unlock)
817
809
        self.base_tree.lock_read()
832
824
            pass
833
825
 
834
826
    def make_preview_transform(self):
835
 
        operation = cleanup.OperationWithCleanups(self._make_preview_transform)
 
827
        operation = OperationWithCleanups(self._make_preview_transform)
836
828
        self.base_tree.lock_read()
837
829
        operation.add_cleanup(self.base_tree.unlock)
838
830
        self.other_tree.lock_read()
869
861
        finally:
870
862
            child_pb.finished()
871
863
        self.fix_root()
872
 
        self._finish_computing_transform()
873
 
 
874
 
    def _finish_computing_transform(self):
875
 
        """Finalize the transform and report the changes.
876
 
 
877
 
        This is the second half of _compute_transform.
878
 
        """
879
864
        child_pb = ui.ui_factory.nested_progress_bar()
880
865
        try:
881
866
            fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
901
886
        """
902
887
        result = []
903
888
        iterator = self.other_tree.iter_changes(self.base_tree,
904
 
                specific_files=self.interesting_files,
 
889
                include_unchanged=True, specific_files=self.interesting_files,
905
890
                extra_trees=[self.this_tree])
906
891
        this_entries = dict((e.file_id, e) for p, e in
907
892
                            self.this_tree.iter_entries_by_dir(
1091
1076
                          ))
1092
1077
        return result
1093
1078
 
 
1079
 
1094
1080
    def fix_root(self):
1095
 
        if self.tt.final_kind(self.tt.root) is None:
 
1081
        try:
 
1082
            self.tt.final_kind(self.tt.root)
 
1083
        except errors.NoSuchFile:
1096
1084
            self.tt.cancel_deletion(self.tt.root)
1097
1085
        if self.tt.final_file_id(self.tt.root) is None:
1098
1086
            self.tt.version_file(self.tt.tree_file_id(self.tt.root),
1107
1095
            # the other tree's root is a non-root in the current tree (as when
1108
1096
            # a previously unrelated branch is merged into another)
1109
1097
            return
1110
 
        if self.tt.final_kind(other_root) is not None:
 
1098
        try:
 
1099
            self.tt.final_kind(other_root)
1111
1100
            other_root_is_present = True
1112
 
        else:
 
1101
        except errors.NoSuchFile:
1113
1102
            # other_root doesn't have a physical representation. We still need
1114
1103
            # to move any references to the actual root of the tree.
1115
1104
            other_root_is_present = False
1116
1105
        # 'other_tree.inventory.root' is not present in this tree. We are
1117
1106
        # calling adjust_path for children which *want* to be present with a
1118
1107
        # correct place to go.
1119
 
        for _, child in self.other_tree.inventory.root.children.iteritems():
 
1108
        for thing, child in self.other_tree.inventory.root.children.iteritems():
1120
1109
            trans_id = self.tt.trans_id_file_id(child.file_id)
1121
1110
            if not other_root_is_present:
1122
 
                if self.tt.final_kind(trans_id) is not None:
 
1111
                # FIXME: Make final_kind returns None instead of raising
 
1112
                # NoSuchFile to avoid the ugly construct below -- vila 20100402
 
1113
                try:
 
1114
                    self.tt.final_kind(trans_id)
1123
1115
                    # The item exist in the final tree and has a defined place
1124
1116
                    # to go already.
1125
1117
                    continue
 
1118
                except errors.NoSuchFile, e:
 
1119
                    pass
1126
1120
            # Move the item into the root
1127
 
            try:
1128
 
                final_name = self.tt.final_name(trans_id)
1129
 
            except errors.NoFinalPath:
1130
 
                # This file is not present anymore, ignore it.
1131
 
                continue
1132
 
            self.tt.adjust_path(final_name, self.tt.root, trans_id)
 
1121
            self.tt.adjust_path(self.tt.final_name(trans_id),
 
1122
                                self.tt.root, trans_id)
1133
1123
        if other_root_is_present:
1134
1124
            self.tt.cancel_creation(other_root)
1135
1125
            self.tt.cancel_versioning(other_root)
1408
1398
            self.tt.version_file(file_id, trans_id)
1409
1399
        # The merge has been performed, so the old contents should not be
1410
1400
        # retained.
1411
 
        self.tt.delete_contents(trans_id)
 
1401
        try:
 
1402
            self.tt.delete_contents(trans_id)
 
1403
        except errors.NoSuchFile:
 
1404
            pass
1412
1405
        return result
1413
1406
 
1414
1407
    def _default_other_winner_merge(self, merge_hook_params):
1586
1579
        if winner == 'this' and file_status != "modified":
1587
1580
            return
1588
1581
        trans_id = self.tt.trans_id_file_id(file_id)
1589
 
        if self.tt.final_kind(trans_id) != "file":
 
1582
        try:
 
1583
            if self.tt.final_kind(trans_id) != "file":
 
1584
                return
 
1585
        except errors.NoSuchFile:
1590
1586
            return
1591
1587
        if winner == "this":
1592
1588
            executability = this_executable
1759
1755
            osutils.rmtree(temp_dir)
1760
1756
 
1761
1757
 
1762
 
class PathNotInTree(errors.BzrError):
1763
 
 
1764
 
    _fmt = """Merge-into failed because %(tree)s does not contain %(path)s."""
1765
 
 
1766
 
    def __init__(self, path, tree):
1767
 
        errors.BzrError.__init__(self, path=path, tree=tree)
1768
 
 
1769
 
 
1770
 
class MergeIntoMerger(Merger):
1771
 
    """Merger that understands other_tree will be merged into a subdir.
1772
 
 
1773
 
    This also changes the Merger api so that it uses real Branch, revision_id,
1774
 
    and RevisonTree objects, rather than using revision specs.
1775
 
    """
1776
 
 
1777
 
    def __init__(self, this_tree, other_branch, other_tree, target_subdir,
1778
 
            source_subpath, other_rev_id=None):
1779
 
        """Create a new MergeIntoMerger object.
1780
 
 
1781
 
        source_subpath in other_tree will be effectively copied to
1782
 
        target_subdir in this_tree.
1783
 
 
1784
 
        :param this_tree: The tree that we will be merging into.
1785
 
        :param other_branch: The Branch we will be merging from.
1786
 
        :param other_tree: The RevisionTree object we want to merge.
1787
 
        :param target_subdir: The relative path where we want to merge
1788
 
            other_tree into this_tree
1789
 
        :param source_subpath: The relative path specifying the subtree of
1790
 
            other_tree to merge into this_tree.
1791
 
        """
1792
 
        # It is assumed that we are merging a tree that is not in our current
1793
 
        # ancestry, which means we are using the "EmptyTree" as our basis.
1794
 
        null_ancestor_tree = this_tree.branch.repository.revision_tree(
1795
 
                                _mod_revision.NULL_REVISION)
1796
 
        super(MergeIntoMerger, self).__init__(
1797
 
            this_branch=this_tree.branch,
1798
 
            this_tree=this_tree,
1799
 
            other_tree=other_tree,
1800
 
            base_tree=null_ancestor_tree,
1801
 
            )
1802
 
        self._target_subdir = target_subdir
1803
 
        self._source_subpath = source_subpath
1804
 
        self.other_branch = other_branch
1805
 
        if other_rev_id is None:
1806
 
            other_rev_id = other_tree.get_revision_id()
1807
 
        self.other_rev_id = self.other_basis = other_rev_id
1808
 
        self.base_is_ancestor = True
1809
 
        self.backup_files = True
1810
 
        self.merge_type = Merge3Merger
1811
 
        self.show_base = False
1812
 
        self.reprocess = False
1813
 
        self.interesting_ids = None
1814
 
        self.merge_type = _MergeTypeParameterizer(MergeIntoMergeType,
1815
 
              target_subdir=self._target_subdir,
1816
 
              source_subpath=self._source_subpath)
1817
 
        if self._source_subpath != '':
1818
 
            # If this isn't a partial merge make sure the revisions will be
1819
 
            # present.
1820
 
            self._maybe_fetch(self.other_branch, self.this_branch,
1821
 
                self.other_basis)
1822
 
 
1823
 
    def set_pending(self):
1824
 
        if self._source_subpath != '':
1825
 
            return
1826
 
        Merger.set_pending(self)
1827
 
 
1828
 
 
1829
 
class _MergeTypeParameterizer(object):
1830
 
    """Wrap a merge-type class to provide extra parameters.
1831
 
    
1832
 
    This is hack used by MergeIntoMerger to pass some extra parameters to its
1833
 
    merge_type.  Merger.do_merge() sets up its own set of parameters to pass to
1834
 
    the 'merge_type' member.  It is difficult override do_merge without
1835
 
    re-writing the whole thing, so instead we create a wrapper which will pass
1836
 
    the extra parameters.
1837
 
    """
1838
 
 
1839
 
    def __init__(self, merge_type, **kwargs):
1840
 
        self._extra_kwargs = kwargs
1841
 
        self._merge_type = merge_type
1842
 
 
1843
 
    def __call__(self, *args, **kwargs):
1844
 
        kwargs.update(self._extra_kwargs)
1845
 
        return self._merge_type(*args, **kwargs)
1846
 
 
1847
 
    def __getattr__(self, name):
1848
 
        return getattr(self._merge_type, name)
1849
 
 
1850
 
 
1851
 
class MergeIntoMergeType(Merge3Merger):
1852
 
    """Merger that incorporates a tree (or part of a tree) into another."""
1853
 
 
1854
 
    def __init__(self, *args, **kwargs):
1855
 
        """Initialize the merger object.
1856
 
 
1857
 
        :param args: See Merge3Merger.__init__'s args.
1858
 
        :param kwargs: See Merge3Merger.__init__'s keyword args, except for
1859
 
            source_subpath and target_subdir.
1860
 
        :keyword source_subpath: The relative path specifying the subtree of
1861
 
            other_tree to merge into this_tree.
1862
 
        :keyword target_subdir: The relative path where we want to merge
1863
 
            other_tree into this_tree
1864
 
        """
1865
 
        # All of the interesting work happens during Merge3Merger.__init__(),
1866
 
        # so we have have to hack in to get our extra parameters set.
1867
 
        self._source_subpath = kwargs.pop('source_subpath')
1868
 
        self._target_subdir = kwargs.pop('target_subdir')
1869
 
        super(MergeIntoMergeType, self).__init__(*args, **kwargs)
1870
 
 
1871
 
    def _compute_transform(self):
1872
 
        child_pb = ui.ui_factory.nested_progress_bar()
1873
 
        try:
1874
 
            entries = self._entries_to_incorporate()
1875
 
            entries = list(entries)
1876
 
            for num, (entry, parent_id) in enumerate(entries):
1877
 
                child_pb.update('Preparing file merge', num, len(entries))
1878
 
                parent_trans_id = self.tt.trans_id_file_id(parent_id)
1879
 
                trans_id = transform.new_by_entry(self.tt, entry,
1880
 
                    parent_trans_id, self.other_tree)
1881
 
        finally:
1882
 
            child_pb.finished()
1883
 
        self._finish_computing_transform()
1884
 
 
1885
 
    def _entries_to_incorporate(self):
1886
 
        """Yields pairs of (inventory_entry, new_parent)."""
1887
 
        other_inv = self.other_tree.inventory
1888
 
        subdir_id = other_inv.path2id(self._source_subpath)
1889
 
        if subdir_id is None:
1890
 
            # XXX: The error would be clearer if it gave the URL of the source
1891
 
            # branch, but we don't have a reference to that here.
1892
 
            raise PathNotInTree(self._source_subpath, "Source tree")
1893
 
        subdir = other_inv[subdir_id]
1894
 
        parent_in_target = osutils.dirname(self._target_subdir)
1895
 
        target_id = self.this_tree.inventory.path2id(parent_in_target)
1896
 
        if target_id is None:
1897
 
            raise PathNotInTree(self._target_subdir, "Target tree")
1898
 
        name_in_target = osutils.basename(self._target_subdir)
1899
 
        merge_into_root = subdir.copy()
1900
 
        merge_into_root.name = name_in_target
1901
 
        if merge_into_root.file_id in self.this_tree.inventory:
1902
 
            # Give the root a new file-id.
1903
 
            # This can happen fairly easily if the directory we are
1904
 
            # incorporating is the root, and both trees have 'TREE_ROOT' as
1905
 
            # their root_id.  Users will expect this to Just Work, so we
1906
 
            # change the file-id here.
1907
 
            # Non-root file-ids could potentially conflict too.  That's really
1908
 
            # an edge case, so we don't do anything special for those.  We let
1909
 
            # them cause conflicts.
1910
 
            merge_into_root.file_id = generate_ids.gen_file_id(name_in_target)
1911
 
        yield (merge_into_root, target_id)
1912
 
        if subdir.kind != 'directory':
1913
 
            # No children, so we are done.
1914
 
            return
1915
 
        for ignored_path, entry in other_inv.iter_entries_by_dir(subdir_id):
1916
 
            parent_id = entry.parent_id
1917
 
            if parent_id == subdir.file_id:
1918
 
                # The root's parent ID has changed, so make sure children of
1919
 
                # the root refer to the new ID.
1920
 
                parent_id = merge_into_root.file_id
1921
 
            yield (entry, parent_id)
1922
 
 
1923
 
 
1924
1758
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1925
1759
                backup_files=False,
1926
1760
                merge_type=Merge3Merger,
1934
1768
                change_reporter=None):
1935
1769
    """Primary interface for merging.
1936
1770
 
1937
 
    Typical use is probably::
1938
 
 
1939
 
        merge_inner(branch, branch.get_revision_tree(other_revision),
1940
 
                    branch.get_revision_tree(base_revision))
1941
 
    """
 
1771
        typical use is probably
 
1772
        'merge_inner(branch, branch.get_revision_tree(other_revision),
 
1773
                     branch.get_revision_tree(base_revision))'
 
1774
        """
1942
1775
    if this_tree is None:
1943
1776
        raise errors.BzrError("bzrlib.merge.merge_inner requires a this_tree "
1944
1777
                              "parameter as of bzrlib version 0.8.")