~bzr-pqm/bzr/bzr.dev

1563.2.12 by Robert Collins
Checkpointing: created InterObject to factor out common inter object worker code, added InterVersionedFile and tests to allow making join work between any versionedfile.
1
# Copyright (C) 2006 Canonical Ltd
2
#
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
7
#
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
# GNU General Public License for more details.
12
#
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
4183.7.1 by Sabin Iacob
update FSF mailing address
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
1563.2.12 by Robert Collins
Checkpointing: created InterObject to factor out common inter object worker code, added InterVersionedFile and tests to allow making join work between any versionedfile.
16
17
18
"""Inter-object utility class."""
19
20
5837.1.1 by Jelmer Vernooij
Make Inter.get raise NoCompatibleInter.
21
from bzrlib.errors import NoCompatibleInter
22
23
1563.2.12 by Robert Collins
Checkpointing: created InterObject to factor out common inter object worker code, added InterVersionedFile and tests to allow making join work between any versionedfile.
24
class InterObject(object):
25
    """This class represents operations taking place between two objects.
26
27
    Its instances have methods like join or copy_content or fetch, and contain
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
28
    references to the source and target objects these operations can be
1563.2.12 by Robert Collins
Checkpointing: created InterObject to factor out common inter object worker code, added InterVersionedFile and tests to allow making join work between any versionedfile.
29
    carried out between.
30
31
    Often we will provide convenience methods on the objects which carry out
32
    operations with another of similar type - they will always forward to
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
33
    a subclass of InterObject - i.e.
1563.2.12 by Robert Collins
Checkpointing: created InterObject to factor out common inter object worker code, added InterVersionedFile and tests to allow making join work between any versionedfile.
34
    InterVersionedFile.get(other).method_name(parameters).
1852.11.1 by Robert Collins
Deprecate compare_trees and move its body to InterTree.changes_from.
35
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
36
    If the source and target objects implement the locking protocol -
1852.11.1 by Robert Collins
Deprecate compare_trees and move its body to InterTree.changes_from.
37
    lock_read, lock_write, unlock, then the InterObject's lock_read,
38
    lock_write and unlock methods may be used (optionally in conjunction with
39
    the needs_read_lock and needs_write_lock decorators.)
2241.1.4 by Martin Pool
Moved old weave-based repository formats into bzrlib.repofmt.weaverepo.
40
41
    When looking for an inter, the most recently registered types are tested
42
    first.  So typically the most generic and slowest InterObjects should be
43
    registered first.
1563.2.12 by Robert Collins
Checkpointing: created InterObject to factor out common inter object worker code, added InterVersionedFile and tests to allow making join work between any versionedfile.
44
    """
45
1910.2.15 by Aaron Bentley
Back out inter.get changes, make optimizers an ordered list
46
    # _optimisers = list()
47
    # Each concrete InterObject type should have its own optimisers list.
1563.2.12 by Robert Collins
Checkpointing: created InterObject to factor out common inter object worker code, added InterVersionedFile and tests to allow making join work between any versionedfile.
48
49
    def __init__(self, source, target):
50
        """Construct a default InterObject instance. Please use 'get'.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
51
52
        Only subclasses of InterObject should call
1563.2.12 by Robert Collins
Checkpointing: created InterObject to factor out common inter object worker code, added InterVersionedFile and tests to allow making join work between any versionedfile.
53
        InterObject.__init__ - clients should call InterFOO.get where FOO
54
        is the base type of the objects they are interacting between. I.e.
55
        InterVersionedFile or InterRepository.
56
        get() is a convenience class method which will create an optimised
57
        InterFOO if possible.
58
        """
59
        self.source = source
60
        self.target = target
61
1852.11.1 by Robert Collins
Deprecate compare_trees and move its body to InterTree.changes_from.
62
    def _double_lock(self, lock_source, lock_target):
1852.11.3 by Robert Collins
Fix typo in inter.py.
63
        """Take out two locks, rolling back the first if the second throws."""
1852.11.1 by Robert Collins
Deprecate compare_trees and move its body to InterTree.changes_from.
64
        lock_source()
65
        try:
66
            lock_target()
67
        except Exception:
68
            # we want to ensure that we don't leave source locked by mistake.
69
            # and any error on target should not confuse source.
70
            self.source.unlock()
71
            raise
72
1563.2.12 by Robert Collins
Checkpointing: created InterObject to factor out common inter object worker code, added InterVersionedFile and tests to allow making join work between any versionedfile.
73
    @classmethod
74
    def get(klass, source, target):
75
        """Retrieve a Inter worker object for these objects.
76
77
        :param source: the object to be the 'source' member of
78
                       the InterObject instance.
79
        :param target: the object to be the 'target' member of
80
                       the InterObject instance.
5891.1.3 by Andrew Bennetts
Move docstring formatting fixes.
81
1563.2.12 by Robert Collins
Checkpointing: created InterObject to factor out common inter object worker code, added InterVersionedFile and tests to allow making join work between any versionedfile.
82
        If an optimised worker exists it will be used otherwise
83
        a default Inter worker instance will be created.
84
        """
1910.2.15 by Aaron Bentley
Back out inter.get changes, make optimizers an ordered list
85
        for provider in reversed(klass._optimisers):
1563.2.12 by Robert Collins
Checkpointing: created InterObject to factor out common inter object worker code, added InterVersionedFile and tests to allow making join work between any versionedfile.
86
            if provider.is_compatible(source, target):
87
                return provider(source, target)
5837.1.1 by Jelmer Vernooij
Make Inter.get raise NoCompatibleInter.
88
        raise NoCompatibleInter(source, target)
1563.2.12 by Robert Collins
Checkpointing: created InterObject to factor out common inter object worker code, added InterVersionedFile and tests to allow making join work between any versionedfile.
89
1852.11.1 by Robert Collins
Deprecate compare_trees and move its body to InterTree.changes_from.
90
    def lock_read(self):
91
        """Take out a logical read lock.
92
93
        This will lock the source branch and the target branch. The source gets
94
        a read lock and the target a read lock.
95
        """
96
        self._double_lock(self.source.lock_read, self.target.lock_read)
97
98
    def lock_write(self):
99
        """Take out a logical write lock.
100
101
        This will lock the source branch and the target branch. The source gets
102
        a read lock and the target a write lock.
103
        """
104
        self._double_lock(self.source.lock_read, self.target.lock_write)
105
1563.2.12 by Robert Collins
Checkpointing: created InterObject to factor out common inter object worker code, added InterVersionedFile and tests to allow making join work between any versionedfile.
106
    @classmethod
107
    def register_optimiser(klass, optimiser):
108
        """Register an InterObject optimiser."""
1910.2.15 by Aaron Bentley
Back out inter.get changes, make optimizers an ordered list
109
        klass._optimisers.append(optimiser)
1563.2.12 by Robert Collins
Checkpointing: created InterObject to factor out common inter object worker code, added InterVersionedFile and tests to allow making join work between any versionedfile.
110
1852.11.1 by Robert Collins
Deprecate compare_trees and move its body to InterTree.changes_from.
111
    def unlock(self):
112
        """Release the locks on source and target."""
113
        try:
114
            self.target.unlock()
115
        finally:
116
            self.source.unlock()
117
1563.2.12 by Robert Collins
Checkpointing: created InterObject to factor out common inter object worker code, added InterVersionedFile and tests to allow making join work between any versionedfile.
118
    @classmethod
119
    def unregister_optimiser(klass, optimiser):
120
        """Unregister an InterObject optimiser."""
121
        klass._optimisers.remove(optimiser)