~bzr-pqm/bzr/bzr.dev

2018.5.51 by Wouter van Heyst
Test and implement RemoteBranch.last_revision_info()
1
# Copyright (C) 2006, 2007 Canonical Ltd
1752.2.30 by Martin Pool
Start adding a RemoteBzrDir, etc
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
1752.2.39 by Martin Pool
[broken] implement upgrade apis on remote bzrdirs
17
# TODO: At some point, handle upgrades by just passing the whole request
18
# across to run on the server.
19
2018.5.59 by Robert Collins
Get BranchConfig working somewhat on RemoteBranches (Robert Collins, Vincent Ladeuil).
20
from cStringIO import StringIO
1752.2.30 by Martin Pool
Start adding a RemoteBzrDir, etc
21
2490.2.5 by Aaron Bentley
Use GraphWalker.unique_ancestor to determine merge base
22
from bzrlib import (
23
    branch,
24
    errors,
25
    lockdir,
26
    repository,
27
)
2477.1.5 by Martin Pool
More cleanups of Branch.push to get the right behaviour with RemoteBranches
28
from bzrlib.branch import Branch, BranchReferenceFormat
2018.5.174 by Andrew Bennetts
Various nits discovered by pyflakes.
29
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
2018.14.2 by Andrew Bennetts
All but one repository_implementation tests for RemoteRepository passing.
30
from bzrlib.config import BranchConfig, TreeConfig
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
31
from bzrlib.decorators import needs_read_lock, needs_write_lock
2018.5.67 by Wouter van Heyst
Implement RemoteRepository.get_revision_graph (Wouter van Heyst, Robert Collins)
32
from bzrlib.errors import NoSuchRevision
2018.5.127 by Andrew Bennetts
Fix most of the lockable_files tests for RemoteBranchLockableFiles.
33
from bzrlib.lockable_files import LockableFiles
2018.5.51 by Wouter van Heyst
Test and implement RemoteBranch.last_revision_info()
34
from bzrlib.revision import NULL_REVISION
2018.6.1 by Robert Collins
Implement a BzrDir.open_branch smart server method for opening a branch without VFS.
35
from bzrlib.smart import client, vfs
2018.18.20 by Martin Pool
Route branch operations through remote copy_content_into
36
from bzrlib.trace import note
1752.2.30 by Martin Pool
Start adding a RemoteBzrDir, etc
37
2018.5.25 by Andrew Bennetts
Make sure RemoteBzrDirFormat is always registered (John Arbash Meinel, Robert Collins, Andrew Bennetts).
38
# Note: RemoteBzrDirFormat is in bzrdir.py
1752.2.30 by Martin Pool
Start adding a RemoteBzrDir, etc
39
40
class RemoteBzrDir(BzrDir):
2018.5.163 by Andrew Bennetts
Deal with various review comments from Robert.
41
    """Control directory on a remote server, accessed via bzr:// or similar."""
1752.2.30 by Martin Pool
Start adding a RemoteBzrDir, etc
42
2018.5.51 by Wouter van Heyst
Test and implement RemoteBranch.last_revision_info()
43
    def __init__(self, transport, _client=None):
44
        """Construct a RemoteBzrDir.
45
46
        :param _client: Private parameter for testing. Disables probing and the
47
            use of a real bzrdir.
48
        """
1752.2.39 by Martin Pool
[broken] implement upgrade apis on remote bzrdirs
49
        BzrDir.__init__(self, transport, RemoteBzrDirFormat())
1752.2.31 by Martin Pool
[broken] some support for write operations over hpss
50
        # this object holds a delegated bzrdir that uses file-level operations
51
        # to talk to the other side
2018.5.70 by Robert Collins
Only try to get real repositories when an operation requires them.
52
        self._real_bzrdir = None
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
53
54
        if _client is None:
55
            self._medium = transport.get_smart_client()
2018.5.159 by Andrew Bennetts
Rename SmartClient to _SmartClient.
56
            self._client = client._SmartClient(self._medium)
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
57
        else:
58
            self._client = _client
59
            self._medium = None
60
            return
61
62
        path = self._path_for_remote_call(self._client)
2018.5.163 by Andrew Bennetts
Deal with various review comments from Robert.
63
        response = self._client.call('BzrDir.open', path)
64
        if response not in [('yes',), ('no',)]:
65
            raise errors.UnexpectedSmartServerResponse(response)
2018.5.26 by Andrew Bennetts
Extract a simple SmartClient class from RemoteTransport, and a hack to avoid VFS operations when probing for a bzrdir over a smart transport.
66
        if response == ('no',):
67
            raise errors.NotBranchError(path=transport.base)
1752.2.31 by Martin Pool
[broken] some support for write operations over hpss
68
2018.5.70 by Robert Collins
Only try to get real repositories when an operation requires them.
69
    def _ensure_real(self):
70
        """Ensure that there is a _real_bzrdir set.
71
2018.5.163 by Andrew Bennetts
Deal with various review comments from Robert.
72
        Used before calls to self._real_bzrdir.
2018.5.70 by Robert Collins
Only try to get real repositories when an operation requires them.
73
        """
74
        if not self._real_bzrdir:
2018.5.169 by Andrew Bennetts
Add a _server_formats flag to BzrDir.open_from_transport and BzrDirFormat.find_format, make RemoteBranch.control_files into a property.
75
            self._real_bzrdir = BzrDir.open_from_transport(
76
                self.root_transport, _server_formats=False)
2018.5.70 by Robert Collins
Only try to get real repositories when an operation requires them.
77
1752.2.39 by Martin Pool
[broken] implement upgrade apis on remote bzrdirs
78
    def create_repository(self, shared=False):
2018.5.162 by Andrew Bennetts
Add some missing _ensure_real calls, and a missing import.
79
        self._ensure_real()
2018.5.118 by Robert Collins
Fix RemoteRepositoryFormat to have appropriate rich_root_data and support_tree_reference.
80
        self._real_bzrdir.create_repository(shared=shared)
81
        return self.open_repository()
1752.2.50 by Andrew Bennetts
Implement RemoteBzrDir.create_{branch,workingtree}
82
83
    def create_branch(self):
2018.5.162 by Andrew Bennetts
Add some missing _ensure_real calls, and a missing import.
84
        self._ensure_real()
1752.2.72 by Andrew Bennetts
Make Remote* classes in remote.py more consistent and remove some dead code.
85
        real_branch = self._real_bzrdir.create_branch()
2018.5.70 by Robert Collins
Only try to get real repositories when an operation requires them.
86
        return RemoteBranch(self, self.find_repository(), real_branch)
1752.2.50 by Andrew Bennetts
Implement RemoteBzrDir.create_{branch,workingtree}
87
88
    def create_workingtree(self, revision_id=None):
2018.5.174 by Andrew Bennetts
Various nits discovered by pyflakes.
89
        raise errors.NotLocalUrl(self.transport.base)
1752.2.39 by Martin Pool
[broken] implement upgrade apis on remote bzrdirs
90
2018.5.124 by Robert Collins
Fix test_format_initialize_find_open by delegating Branch formt lookup to the BzrDir, where it should have stayed from the start.
91
    def find_branch_format(self):
92
        """Find the branch 'format' for this bzrdir.
93
94
        This might be a synthetic object for e.g. RemoteBranch and SVN.
95
        """
96
        b = self.open_branch()
97
        return b._format
98
2018.5.132 by Robert Collins
Make all BzrDir implementation tests pass on RemoteBzrDir - fix some things, and remove the incomplete_with_basis tests as cruft.
99
    def get_branch_reference(self):
100
        """See BzrDir.get_branch_reference()."""
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
101
        path = self._path_for_remote_call(self._client)
102
        response = self._client.call('BzrDir.open_branch', path)
103
        if response[0] == 'ok':
104
            if response[1] == '':
105
                # branch at this location.
2018.5.132 by Robert Collins
Make all BzrDir implementation tests pass on RemoteBzrDir - fix some things, and remove the incomplete_with_basis tests as cruft.
106
                return None
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
107
            else:
108
                # a branch reference, use the existing BranchReference logic.
2018.5.132 by Robert Collins
Make all BzrDir implementation tests pass on RemoteBzrDir - fix some things, and remove the incomplete_with_basis tests as cruft.
109
                return response[1]
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
110
        elif response == ('nobranch',):
2018.6.1 by Robert Collins
Implement a BzrDir.open_branch smart server method for opening a branch without VFS.
111
            raise errors.NotBranchError(path=self.root_transport.base)
112
        else:
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
113
            assert False, 'unexpected response code %r' % (response,)
2018.5.132 by Robert Collins
Make all BzrDir implementation tests pass on RemoteBzrDir - fix some things, and remove the incomplete_with_basis tests as cruft.
114
115
    def open_branch(self, _unsupported=False):
116
        assert _unsupported == False, 'unsupported flag support not implemented yet.'
117
        reference_url = self.get_branch_reference()
118
        if reference_url is None:
119
            # branch at this location.
120
            return RemoteBranch(self, self.find_repository())
121
        else:
122
            # a branch reference, use the existing BranchReference logic.
123
            format = BranchReferenceFormat()
124
            return format.open(self, _found=True, location=reference_url)
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
125
                
1752.2.31 by Martin Pool
[broken] some support for write operations over hpss
126
    def open_repository(self):
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
127
        path = self._path_for_remote_call(self._client)
128
        response = self._client.call('BzrDir.find_repository', path)
2018.5.42 by Robert Collins
Various hopefully improvements, but wsgi is broken, handing over to spiv :).
129
        assert response[0] in ('ok', 'norepository'), \
2018.5.52 by Wouter van Heyst
Provide more information when encountering unexpected responses from a smart
130
            'unexpected response code %s' % (response,)
2018.5.42 by Robert Collins
Various hopefully improvements, but wsgi is broken, handing over to spiv :).
131
        if response[0] == 'norepository':
132
            raise errors.NoRepositoryPresent(self)
2018.5.118 by Robert Collins
Fix RemoteRepositoryFormat to have appropriate rich_root_data and support_tree_reference.
133
        assert len(response) == 4, 'incorrect response length %s' % (response,)
2018.5.34 by Robert Collins
Get test_remote.BasicRemoteObjectTests.test_open_remote_branch passing by implementing a remote method BzrDir.find_repository.
134
        if response[1] == '':
2018.5.118 by Robert Collins
Fix RemoteRepositoryFormat to have appropriate rich_root_data and support_tree_reference.
135
            format = RemoteRepositoryFormat()
2018.5.166 by Andrew Bennetts
Small changes in response to Aaron's review.
136
            format.rich_root_data = (response[2] == 'yes')
137
            format.supports_tree_reference = (response[3] == 'yes')
2018.5.118 by Robert Collins
Fix RemoteRepositoryFormat to have appropriate rich_root_data and support_tree_reference.
138
            return RemoteRepository(self, format)
2018.5.34 by Robert Collins
Get test_remote.BasicRemoteObjectTests.test_open_remote_branch passing by implementing a remote method BzrDir.find_repository.
139
        else:
140
            raise errors.NoRepositoryPresent(self)
1752.2.30 by Martin Pool
Start adding a RemoteBzrDir, etc
141
2018.5.138 by Robert Collins
Merge bzr.dev.
142
    def open_workingtree(self, recommend_upgrade=True):
2445.1.1 by Andrew Bennetts
Make RemoteBzrDir.open_workingtree raise NoWorkingTree rather than NotLocalUrl
143
        self._ensure_real()
144
        if self._real_bzrdir.has_workingtree():
145
            raise errors.NotLocalUrl(self.root_transport)
146
        else:
147
            raise errors.NoWorkingTree(self.root_transport.base)
1752.2.50 by Andrew Bennetts
Implement RemoteBzrDir.create_{branch,workingtree}
148
2018.5.42 by Robert Collins
Various hopefully improvements, but wsgi is broken, handing over to spiv :).
149
    def _path_for_remote_call(self, client):
2018.6.1 by Robert Collins
Implement a BzrDir.open_branch smart server method for opening a branch without VFS.
150
        """Return the path to be used for this bzrdir in a remote call."""
2018.5.42 by Robert Collins
Various hopefully improvements, but wsgi is broken, handing over to spiv :).
151
        return client.remote_path_from_transport(self.root_transport)
2018.6.1 by Robert Collins
Implement a BzrDir.open_branch smart server method for opening a branch without VFS.
152
1752.2.31 by Martin Pool
[broken] some support for write operations over hpss
153
    def get_branch_transport(self, branch_format):
2018.5.162 by Andrew Bennetts
Add some missing _ensure_real calls, and a missing import.
154
        self._ensure_real()
1752.2.31 by Martin Pool
[broken] some support for write operations over hpss
155
        return self._real_bzrdir.get_branch_transport(branch_format)
156
1752.2.43 by Andrew Bennetts
Fix get_{branch,repository,workingtree}_transport.
157
    def get_repository_transport(self, repository_format):
2018.5.162 by Andrew Bennetts
Add some missing _ensure_real calls, and a missing import.
158
        self._ensure_real()
1752.2.43 by Andrew Bennetts
Fix get_{branch,repository,workingtree}_transport.
159
        return self._real_bzrdir.get_repository_transport(repository_format)
160
161
    def get_workingtree_transport(self, workingtree_format):
2018.5.162 by Andrew Bennetts
Add some missing _ensure_real calls, and a missing import.
162
        self._ensure_real()
1752.2.43 by Andrew Bennetts
Fix get_{branch,repository,workingtree}_transport.
163
        return self._real_bzrdir.get_workingtree_transport(workingtree_format)
164
1752.2.39 by Martin Pool
[broken] implement upgrade apis on remote bzrdirs
165
    def can_convert_format(self):
166
        """Upgrading of remote bzrdirs is not supported yet."""
167
        return False
168
169
    def needs_format_conversion(self, format=None):
170
        """Upgrading of remote bzrdirs is not supported yet."""
171
        return False
172
2018.5.138 by Robert Collins
Merge bzr.dev.
173
    def clone(self, url, revision_id=None, force_new_repo=False):
2018.5.94 by Andrew Bennetts
Various small changes in aid of making tests pass (including deleting one invalid test).
174
        self._ensure_real()
175
        return self._real_bzrdir.clone(url, revision_id=revision_id,
2018.5.138 by Robert Collins
Merge bzr.dev.
176
            force_new_repo=force_new_repo)
2018.5.94 by Andrew Bennetts
Various small changes in aid of making tests pass (including deleting one invalid test).
177
1752.2.31 by Martin Pool
[broken] some support for write operations over hpss
178
1752.2.52 by Andrew Bennetts
Flesh out more Remote* methods needed to open and initialise remote branches/trees/repositories.
179
class RemoteRepositoryFormat(repository.RepositoryFormat):
2018.5.159 by Andrew Bennetts
Rename SmartClient to _SmartClient.
180
    """Format for repositories accessed over a _SmartClient.
1752.2.31 by Martin Pool
[broken] some support for write operations over hpss
181
1752.2.50 by Andrew Bennetts
Implement RemoteBzrDir.create_{branch,workingtree}
182
    Instances of this repository are represented by RemoteRepository
1752.2.31 by Martin Pool
[broken] some support for write operations over hpss
183
    instances.
2018.5.118 by Robert Collins
Fix RemoteRepositoryFormat to have appropriate rich_root_data and support_tree_reference.
184
185
    The RemoteRepositoryFormat is parameterised during construction
186
    to reflect the capabilities of the real, remote format. Specifically
2018.5.138 by Robert Collins
Merge bzr.dev.
187
    the attributes rich_root_data and supports_tree_reference are set
2018.5.118 by Robert Collins
Fix RemoteRepositoryFormat to have appropriate rich_root_data and support_tree_reference.
188
    on a per instance basis, and are not set (and should not be) at
189
    the class level.
1752.2.31 by Martin Pool
[broken] some support for write operations over hpss
190
    """
191
192
    _matchingbzrdir = RemoteBzrDirFormat
193
1752.2.52 by Andrew Bennetts
Flesh out more Remote* methods needed to open and initialise remote branches/trees/repositories.
194
    def initialize(self, a_bzrdir, shared=False):
2018.5.138 by Robert Collins
Merge bzr.dev.
195
        assert isinstance(a_bzrdir, RemoteBzrDir), \
196
            '%r is not a RemoteBzrDir' % (a_bzrdir,)
1752.2.72 by Andrew Bennetts
Make Remote* classes in remote.py more consistent and remove some dead code.
197
        return a_bzrdir.create_repository(shared=shared)
1752.2.52 by Andrew Bennetts
Flesh out more Remote* methods needed to open and initialise remote branches/trees/repositories.
198
    
199
    def open(self, a_bzrdir):
1752.2.72 by Andrew Bennetts
Make Remote* classes in remote.py more consistent and remove some dead code.
200
        assert isinstance(a_bzrdir, RemoteBzrDir)
201
        return a_bzrdir.open_repository()
1752.2.52 by Andrew Bennetts
Flesh out more Remote* methods needed to open and initialise remote branches/trees/repositories.
202
203
    def get_format_description(self):
204
        return 'bzr remote repository'
205
206
    def __eq__(self, other):
1752.2.87 by Andrew Bennetts
Make tests pass.
207
        return self.__class__ == other.__class__
208
2018.5.118 by Robert Collins
Fix RemoteRepositoryFormat to have appropriate rich_root_data and support_tree_reference.
209
    def check_conversion_target(self, target_format):
210
        if self.rich_root_data and not target_format.rich_root_data:
211
            raise errors.BadConversionTarget(
212
                'Does not support rich root data.', target_format)
2018.5.138 by Robert Collins
Merge bzr.dev.
213
        if (self.supports_tree_reference and
214
            not getattr(target_format, 'supports_tree_reference', False)):
2018.5.118 by Robert Collins
Fix RemoteRepositoryFormat to have appropriate rich_root_data and support_tree_reference.
215
            raise errors.BadConversionTarget(
216
                'Does not support nested trees', target_format)
1752.2.52 by Andrew Bennetts
Flesh out more Remote* methods needed to open and initialise remote branches/trees/repositories.
217
1752.2.31 by Martin Pool
[broken] some support for write operations over hpss
218
1752.2.50 by Andrew Bennetts
Implement RemoteBzrDir.create_{branch,workingtree}
219
class RemoteRepository(object):
1752.2.31 by Martin Pool
[broken] some support for write operations over hpss
220
    """Repository accessed over rpc.
221
2018.5.163 by Andrew Bennetts
Deal with various review comments from Robert.
222
    For the moment most operations are performed using local transport-backed
223
    Repository objects.
1752.2.31 by Martin Pool
[broken] some support for write operations over hpss
224
    """
225
2018.5.118 by Robert Collins
Fix RemoteRepositoryFormat to have appropriate rich_root_data and support_tree_reference.
226
    def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
2018.5.34 by Robert Collins
Get test_remote.BasicRemoteObjectTests.test_open_remote_branch passing by implementing a remote method BzrDir.find_repository.
227
        """Create a RemoteRepository instance.
228
        
229
        :param remote_bzrdir: The bzrdir hosting this repository.
2018.5.118 by Robert Collins
Fix RemoteRepositoryFormat to have appropriate rich_root_data and support_tree_reference.
230
        :param format: The RemoteFormat object to use.
2018.5.34 by Robert Collins
Get test_remote.BasicRemoteObjectTests.test_open_remote_branch passing by implementing a remote method BzrDir.find_repository.
231
        :param real_repository: If not None, a local implementation of the
232
            repository logic for the repository, usually accessing the data
233
            via the VFS.
2018.5.57 by Robert Collins
Implement RemoteRepository.is_shared (Robert Collins, Vincent Ladeuil).
234
        :param _client: Private testing parameter - override the smart client
235
            to be used by the repository.
2018.5.34 by Robert Collins
Get test_remote.BasicRemoteObjectTests.test_open_remote_branch passing by implementing a remote method BzrDir.find_repository.
236
        """
237
        if real_repository:
2018.5.36 by Andrew Bennetts
Fix typo, and clean up some ununsed import warnings from pyflakes at the same time.
238
            self._real_repository = real_repository
2018.5.70 by Robert Collins
Only try to get real repositories when an operation requires them.
239
        else:
240
            self._real_repository = None
1752.2.50 by Andrew Bennetts
Implement RemoteBzrDir.create_{branch,workingtree}
241
        self.bzrdir = remote_bzrdir
2018.5.57 by Robert Collins
Implement RemoteRepository.is_shared (Robert Collins, Vincent Ladeuil).
242
        if _client is None:
2018.5.159 by Andrew Bennetts
Rename SmartClient to _SmartClient.
243
            self._client = client._SmartClient(self.bzrdir._medium)
2018.5.57 by Robert Collins
Implement RemoteRepository.is_shared (Robert Collins, Vincent Ladeuil).
244
        else:
245
            self._client = _client
2018.5.118 by Robert Collins
Fix RemoteRepositoryFormat to have appropriate rich_root_data and support_tree_reference.
246
        self._format = format
2018.5.75 by Andrew Bennetts
Add Repository.{dont_,}leave_lock_in_place.
247
        self._lock_mode = None
248
        self._lock_token = None
249
        self._lock_count = 0
2018.5.78 by Andrew Bennetts
Implement RemoteRepository.lock_write/unlock to expect and send tokens over the
250
        self._leave_lock = False
1752.2.52 by Andrew Bennetts
Flesh out more Remote* methods needed to open and initialise remote branches/trees/repositories.
251
2018.5.70 by Robert Collins
Only try to get real repositories when an operation requires them.
252
    def _ensure_real(self):
253
        """Ensure that there is a _real_repository set.
254
2018.5.163 by Andrew Bennetts
Deal with various review comments from Robert.
255
        Used before calls to self._real_repository.
2018.5.70 by Robert Collins
Only try to get real repositories when an operation requires them.
256
        """
257
        if not self._real_repository:
258
            self.bzrdir._ensure_real()
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
259
            #self._real_repository = self.bzrdir._real_bzrdir.open_repository()
260
            self._set_real_repository(self.bzrdir._real_bzrdir.open_repository())
2018.5.70 by Robert Collins
Only try to get real repositories when an operation requires them.
261
2018.5.67 by Wouter van Heyst
Implement RemoteRepository.get_revision_graph (Wouter van Heyst, Robert Collins)
262
    def get_revision_graph(self, revision_id=None):
263
        """See Repository.get_revision_graph()."""
264
        if revision_id is None:
265
            revision_id = ''
266
        elif revision_id == NULL_REVISION:
267
            return {}
268
269
        path = self.bzrdir._path_for_remote_call(self._client)
2018.5.83 by Andrew Bennetts
Fix some test failures caused by the switch from unicode to UTF-8-encoded strs for revision IDs.
270
        assert type(revision_id) is str
2018.5.153 by Andrew Bennetts
Rename call2 to call_expecting_body, and other small changes prompted by review.
271
        response = self._client.call_expecting_body(
2018.5.83 by Andrew Bennetts
Fix some test failures caused by the switch from unicode to UTF-8-encoded strs for revision IDs.
272
            'Repository.get_revision_graph', path, revision_id)
2018.5.163 by Andrew Bennetts
Deal with various review comments from Robert.
273
        if response[0][0] not in ['ok', 'nosuchrevision']:
274
            raise errors.UnexpectedSmartServerResponse(response[0])
2018.5.67 by Wouter van Heyst
Implement RemoteRepository.get_revision_graph (Wouter van Heyst, Robert Collins)
275
        if response[0][0] == 'ok':
276
            coded = response[1].read_body_bytes()
2018.5.105 by Andrew Bennetts
Implement revision_history caching for RemoteBranch.
277
            if coded == '':
278
                # no revisions in this repository!
279
                return {}
2018.5.83 by Andrew Bennetts
Fix some test failures caused by the switch from unicode to UTF-8-encoded strs for revision IDs.
280
            lines = coded.split('\n')
2018.5.67 by Wouter van Heyst
Implement RemoteRepository.get_revision_graph (Wouter van Heyst, Robert Collins)
281
            revision_graph = {}
282
            for line in lines:
283
                d = list(line.split())
284
                revision_graph[d[0]] = d[1:]
285
                
286
            return revision_graph
287
        else:
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
288
            response_body = response[1].read_body_bytes()
289
            assert response_body == ''
2018.5.67 by Wouter van Heyst
Implement RemoteRepository.get_revision_graph (Wouter van Heyst, Robert Collins)
290
            raise NoSuchRevision(self, revision_id)
291
2018.5.40 by Robert Collins
Implement a remote Repository.has_revision method.
292
    def has_revision(self, revision_id):
293
        """See Repository.has_revision()."""
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
294
        if revision_id is None:
295
            # The null revision is always present.
296
            return True
2018.5.42 by Robert Collins
Various hopefully improvements, but wsgi is broken, handing over to spiv :).
297
        path = self.bzrdir._path_for_remote_call(self._client)
2018.5.83 by Andrew Bennetts
Fix some test failures caused by the switch from unicode to UTF-8-encoded strs for revision IDs.
298
        response = self._client.call('Repository.has_revision', path, revision_id)
2018.5.158 by Andrew Bennetts
Return 'yes'/'no' rather than 'ok'/'no' from the Repository.has_revision smart command.
299
        assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
300
        return response[0] == 'yes'
2018.5.40 by Robert Collins
Implement a remote Repository.has_revision method.
301
2490.2.21 by Aaron Bentley
Rename graph to deprecated_graph
302
    def get_graph(self, other_repository=None):
303
        """Return the graph for this repository format"""
304
        return self._real_repository.get_graph(other_repository)
2490.2.5 by Aaron Bentley
Use GraphWalker.unique_ancestor to determine merge base
305
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
306
    def gather_stats(self, revid=None, committers=None):
2018.5.62 by Robert Collins
Stub out RemoteRepository.gather_stats while its implemented in parallel.
307
        """See Repository.gather_stats()."""
2018.10.3 by v.ladeuil+lp at free
more tests for gather_stats
308
        path = self.bzrdir._path_for_remote_call(self._client)
309
        if revid in (None, NULL_REVISION):
310
            fmt_revid = ''
311
        else:
2018.5.83 by Andrew Bennetts
Fix some test failures caused by the switch from unicode to UTF-8-encoded strs for revision IDs.
312
            fmt_revid = revid
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
313
        if committers is None or not committers:
2018.10.3 by v.ladeuil+lp at free
more tests for gather_stats
314
            fmt_committers = 'no'
315
        else:
316
            fmt_committers = 'yes'
2018.5.153 by Andrew Bennetts
Rename call2 to call_expecting_body, and other small changes prompted by review.
317
        response = self._client.call_expecting_body(
318
            'Repository.gather_stats', path, fmt_revid, fmt_committers)
2018.10.3 by v.ladeuil+lp at free
more tests for gather_stats
319
        assert response[0][0] == 'ok', \
320
            'unexpected response code %s' % (response[0],)
321
322
        body = response[1].read_body_bytes()
323
        result = {}
324
        for line in body.split('\n'):
325
            if not line:
326
                continue
327
            key, val_text = line.split(':')
328
            if key in ('revisions', 'size', 'committers'):
329
                result[key] = int(val_text)
330
            elif key in ('firstrev', 'latestrev'):
331
                values = val_text.split(' ')[1:]
332
                result[key] = (float(values[0]), long(values[1]))
333
334
        return result
2018.5.62 by Robert Collins
Stub out RemoteRepository.gather_stats while its implemented in parallel.
335
2018.5.60 by Robert Collins
More missing methods from RemoteBranch and RemoteRepository to let 'info' get further.
336
    def get_physical_lock_status(self):
337
        """See Repository.get_physical_lock_status()."""
338
        return False
339
2018.5.57 by Robert Collins
Implement RemoteRepository.is_shared (Robert Collins, Vincent Ladeuil).
340
    def is_shared(self):
341
        """See Repository.is_shared()."""
342
        path = self.bzrdir._path_for_remote_call(self._client)
343
        response = self._client.call('Repository.is_shared', path)
344
        assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
345
        return response[0] == 'yes'
346
2018.5.60 by Robert Collins
More missing methods from RemoteBranch and RemoteRepository to let 'info' get further.
347
    def lock_read(self):
348
        # wrong eventually - want a local lock cache context
2018.5.75 by Andrew Bennetts
Add Repository.{dont_,}leave_lock_in_place.
349
        if not self._lock_mode:
350
            self._lock_mode = 'r'
351
            self._lock_count = 1
2018.5.78 by Andrew Bennetts
Implement RemoteRepository.lock_write/unlock to expect and send tokens over the
352
            if self._real_repository is not None:
353
                self._real_repository.lock_read()
2018.5.75 by Andrew Bennetts
Add Repository.{dont_,}leave_lock_in_place.
354
        else:
355
            self._lock_count += 1
2018.5.78 by Andrew Bennetts
Implement RemoteRepository.lock_write/unlock to expect and send tokens over the
356
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
357
    def _remote_lock_write(self, token):
2018.5.78 by Andrew Bennetts
Implement RemoteRepository.lock_write/unlock to expect and send tokens over the
358
        path = self.bzrdir._path_for_remote_call(self._client)
359
        if token is None:
360
            token = ''
361
        response = self._client.call('Repository.lock_write', path, token)
362
        if response[0] == 'ok':
363
            ok, token = response
364
            return token
365
        elif response[0] == 'LockContention':
366
            raise errors.LockContention('(remote lock)')
2018.5.95 by Andrew Bennetts
Add a Transport.is_readonly remote call, let {Branch,Repository}.lock_write remote call return UnlockableTransport, and miscellaneous test fixes.
367
        elif response[0] == 'UnlockableTransport':
368
            raise errors.UnlockableTransport(self.bzrdir.root_transport)
2018.5.78 by Andrew Bennetts
Implement RemoteRepository.lock_write/unlock to expect and send tokens over the
369
        else:
370
            assert False, 'unexpected response code %s' % (response,)
2018.5.60 by Robert Collins
More missing methods from RemoteBranch and RemoteRepository to let 'info' get further.
371
2018.5.75 by Andrew Bennetts
Add Repository.{dont_,}leave_lock_in_place.
372
    def lock_write(self, token=None):
373
        if not self._lock_mode:
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
374
            self._lock_token = self._remote_lock_write(token)
2018.5.78 by Andrew Bennetts
Implement RemoteRepository.lock_write/unlock to expect and send tokens over the
375
            assert self._lock_token, 'Remote server did not return a token!'
376
            if self._real_repository is not None:
377
                self._real_repository.lock_write(token=self._lock_token)
378
            if token is not None:
379
                self._leave_lock = True
380
            else:
381
                self._leave_lock = False
2018.5.75 by Andrew Bennetts
Add Repository.{dont_,}leave_lock_in_place.
382
            self._lock_mode = 'w'
383
            self._lock_count = 1
384
        elif self._lock_mode == 'r':
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
385
            raise errors.ReadOnlyError(self)
2018.5.75 by Andrew Bennetts
Add Repository.{dont_,}leave_lock_in_place.
386
        else:
387
            self._lock_count += 1
388
        return self._lock_token
389
390
    def leave_lock_in_place(self):
2018.5.78 by Andrew Bennetts
Implement RemoteRepository.lock_write/unlock to expect and send tokens over the
391
        self._leave_lock = True
2018.5.75 by Andrew Bennetts
Add Repository.{dont_,}leave_lock_in_place.
392
393
    def dont_leave_lock_in_place(self):
2018.5.78 by Andrew Bennetts
Implement RemoteRepository.lock_write/unlock to expect and send tokens over the
394
        self._leave_lock = False
2018.5.75 by Andrew Bennetts
Add Repository.{dont_,}leave_lock_in_place.
395
396
    def _set_real_repository(self, repository):
397
        """Set the _real_repository for this repository.
398
399
        :param repository: The repository to fallback to for non-hpss
400
            implemented operations.
401
        """
2018.5.97 by Andrew Bennetts
Fix more tests.
402
        assert not isinstance(repository, RemoteRepository)
2018.5.75 by Andrew Bennetts
Add Repository.{dont_,}leave_lock_in_place.
403
        self._real_repository = repository
404
        if self._lock_mode == 'w':
405
            # if we are already locked, the real repository must be able to
406
            # acquire the lock with our token.
407
            self._real_repository.lock_write(self._lock_token)
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
408
        elif self._lock_mode == 'r':
409
            self._real_repository.lock_read()
2018.5.60 by Robert Collins
More missing methods from RemoteBranch and RemoteRepository to let 'info' get further.
410
2018.5.78 by Andrew Bennetts
Implement RemoteRepository.lock_write/unlock to expect and send tokens over the
411
    def _unlock(self, token):
412
        path = self.bzrdir._path_for_remote_call(self._client)
413
        response = self._client.call('Repository.unlock', path, token)
414
        if response == ('ok',):
415
            return
416
        elif response[0] == 'TokenMismatch':
417
            raise errors.TokenMismatch(token, '(remote token)')
418
        else:
419
            assert False, 'unexpected response code %s' % (response,)
420
2018.5.60 by Robert Collins
More missing methods from RemoteBranch and RemoteRepository to let 'info' get further.
421
    def unlock(self):
2018.5.75 by Andrew Bennetts
Add Repository.{dont_,}leave_lock_in_place.
422
        self._lock_count -= 1
423
        if not self._lock_count:
2018.5.78 by Andrew Bennetts
Implement RemoteRepository.lock_write/unlock to expect and send tokens over the
424
            mode = self._lock_mode
2018.5.75 by Andrew Bennetts
Add Repository.{dont_,}leave_lock_in_place.
425
            self._lock_mode = None
2018.5.78 by Andrew Bennetts
Implement RemoteRepository.lock_write/unlock to expect and send tokens over the
426
            if self._real_repository is not None:
427
                self._real_repository.unlock()
428
            if mode != 'w':
2018.5.163 by Andrew Bennetts
Deal with various review comments from Robert.
429
                # Only write-locked repositories need to make a remote method
430
                # call to perfom the unlock.
2018.5.78 by Andrew Bennetts
Implement RemoteRepository.lock_write/unlock to expect and send tokens over the
431
                return
432
            assert self._lock_token, 'Locked, but no token!'
433
            token = self._lock_token
2018.5.75 by Andrew Bennetts
Add Repository.{dont_,}leave_lock_in_place.
434
            self._lock_token = None
2018.5.78 by Andrew Bennetts
Implement RemoteRepository.lock_write/unlock to expect and send tokens over the
435
            if not self._leave_lock:
436
                self._unlock(token)
2018.5.60 by Robert Collins
More missing methods from RemoteBranch and RemoteRepository to let 'info' get further.
437
438
    def break_lock(self):
2018.5.78 by Andrew Bennetts
Implement RemoteRepository.lock_write/unlock to expect and send tokens over the
439
        # should hand off to the network
2018.5.70 by Robert Collins
Only try to get real repositories when an operation requires them.
440
        self._ensure_real()
2018.5.60 by Robert Collins
More missing methods from RemoteBranch and RemoteRepository to let 'info' get further.
441
        return self._real_repository.break_lock()
442
2018.18.8 by Ian Clatworthy
Tarball proxy code & tests
443
    def _get_tarball(self, compression):
2018.18.25 by Martin Pool
Repository.tarball fixes for python2.4
444
        """Return a TemporaryFile containing a repository tarball"""
445
        import tempfile
2018.18.8 by Ian Clatworthy
Tarball proxy code & tests
446
        path = self.bzrdir._path_for_remote_call(self._client)
2018.18.14 by Martin Pool
merge hpss again; restore incorrectly removed RemoteRepository.break_lock
447
        response, protocol = self._client.call_expecting_body(
448
            'Repository.tarball', path, compression)
2018.18.8 by Ian Clatworthy
Tarball proxy code & tests
449
        assert response[0] in ('ok', 'failure'), \
450
            'unexpected response code %s' % (response,)
451
        if response[0] == 'ok':
452
            # Extract the tarball and return it
2018.18.25 by Martin Pool
Repository.tarball fixes for python2.4
453
            t = tempfile.NamedTemporaryFile()
454
            # TODO: rpc layer should read directly into it...
455
            t.write(protocol.read_body_bytes())
456
            t.seek(0)
457
            return t
2018.18.8 by Ian Clatworthy
Tarball proxy code & tests
458
        else:
459
            raise errors.SmartServerError(error_code=response)
460
2440.1.1 by Martin Pool
Add new Repository.sprout,
461
    def sprout(self, to_bzrdir, revision_id=None):
462
        # TODO: Option to control what format is created?
463
        to_repo = to_bzrdir.create_repository()
2018.18.24 by Martin Pool
Merge Repository.sprout refactoring, and make that use Repository.tarball
464
        self._copy_repository_tarball(to_repo, revision_id)
2440.1.1 by Martin Pool
Add new Repository.sprout,
465
        return to_repo
466
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
467
    ### These methods are just thin shims to the VFS object for now.
468
469
    def revision_tree(self, revision_id):
470
        self._ensure_real()
471
        return self._real_repository.revision_tree(revision_id)
472
473
    def get_commit_builder(self, branch, parents, config, timestamp=None,
474
                           timezone=None, committer=None, revprops=None,
475
                           revision_id=None):
476
        # FIXME: It ought to be possible to call this without immediately
477
        # triggering _ensure_real.  For now it's the easiest thing to do.
478
        self._ensure_real()
479
        builder = self._real_repository.get_commit_builder(branch, parents,
480
                config, timestamp=timestamp, timezone=timezone,
481
                committer=committer, revprops=revprops, revision_id=revision_id)
482
        # Make the builder use this RemoteRepository rather than the real one.
483
        builder.repository = self
484
        return builder
485
486
    @needs_write_lock
487
    def add_inventory(self, revid, inv, parents):
488
        self._ensure_real()
489
        return self._real_repository.add_inventory(revid, inv, parents)
490
491
    @needs_write_lock
492
    def add_revision(self, rev_id, rev, inv=None, config=None):
493
        self._ensure_real()
494
        return self._real_repository.add_revision(
495
            rev_id, rev, inv=inv, config=config)
496
497
    @needs_read_lock
498
    def get_inventory(self, revision_id):
499
        self._ensure_real()
500
        return self._real_repository.get_inventory(revision_id)
501
502
    @needs_read_lock
503
    def get_revision(self, revision_id):
504
        self._ensure_real()
505
        return self._real_repository.get_revision(revision_id)
506
507
    @property
508
    def weave_store(self):
509
        self._ensure_real()
510
        return self._real_repository.weave_store
511
512
    def get_transaction(self):
513
        self._ensure_real()
514
        return self._real_repository.get_transaction()
515
516
    @needs_read_lock
2018.5.138 by Robert Collins
Merge bzr.dev.
517
    def clone(self, a_bzrdir, revision_id=None):
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
518
        self._ensure_real()
2018.5.138 by Robert Collins
Merge bzr.dev.
519
        return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
520
521
    def make_working_trees(self):
2018.5.120 by Robert Collins
The Repository API ``make_working_trees`` is now permitted to return
522
        """RemoteRepositories never create working trees by default."""
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
523
        return False
524
525
    def fetch(self, source, revision_id=None, pb=None):
526
        self._ensure_real()
527
        return self._real_repository.fetch(
528
            source, revision_id=revision_id, pb=pb)
529
530
    @property
531
    def control_weaves(self):
532
        self._ensure_real()
533
        return self._real_repository.control_weaves
534
535
    @needs_read_lock
2530.1.1 by Aaron Bentley
Make topological sorting optional for get_ancestry
536
    def get_ancestry(self, revision_id, topo_sorted=True):
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
537
        self._ensure_real()
2530.1.1 by Aaron Bentley
Make topological sorting optional for get_ancestry
538
        return self._real_repository.get_ancestry(revision_id, topo_sorted)
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
539
540
    @needs_read_lock
541
    def get_inventory_weave(self):
542
        self._ensure_real()
543
        return self._real_repository.get_inventory_weave()
544
545
    def fileids_altered_by_revision_ids(self, revision_ids):
546
        self._ensure_real()
547
        return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
548
549
    @needs_read_lock
550
    def get_signature_text(self, revision_id):
551
        self._ensure_real()
552
        return self._real_repository.get_signature_text(revision_id)
553
554
    @needs_read_lock
555
    def get_revision_graph_with_ghosts(self, revision_ids=None):
556
        self._ensure_real()
557
        return self._real_repository.get_revision_graph_with_ghosts(
558
            revision_ids=revision_ids)
559
560
    @needs_read_lock
561
    def get_inventory_xml(self, revision_id):
562
        self._ensure_real()
563
        return self._real_repository.get_inventory_xml(revision_id)
564
565
    def deserialise_inventory(self, revision_id, xml):
566
        self._ensure_real()
567
        return self._real_repository.deserialise_inventory(revision_id, xml)
568
569
    def reconcile(self, other=None, thorough=False):
570
        self._ensure_real()
571
        return self._real_repository.reconcile(other=other, thorough=thorough)
572
        
573
    def all_revision_ids(self):
574
        self._ensure_real()
575
        return self._real_repository.all_revision_ids()
576
    
577
    @needs_read_lock
578
    def get_deltas_for_revisions(self, revisions):
579
        self._ensure_real()
580
        return self._real_repository.get_deltas_for_revisions(revisions)
581
582
    @needs_read_lock
583
    def get_revision_delta(self, revision_id):
584
        self._ensure_real()
585
        return self._real_repository.get_revision_delta(revision_id)
586
587
    @needs_read_lock
588
    def revision_trees(self, revision_ids):
589
        self._ensure_real()
590
        return self._real_repository.revision_trees(revision_ids)
591
592
    @needs_read_lock
593
    def get_revision_reconcile(self, revision_id):
594
        self._ensure_real()
595
        return self._real_repository.get_revision_reconcile(revision_id)
596
597
    @needs_read_lock
598
    def check(self, revision_ids):
599
        self._ensure_real()
600
        return self._real_repository.check(revision_ids)
601
2018.5.138 by Robert Collins
Merge bzr.dev.
602
    def copy_content_into(self, destination, revision_id=None):
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
603
        self._ensure_real()
604
        return self._real_repository.copy_content_into(
2018.5.138 by Robert Collins
Merge bzr.dev.
605
            destination, revision_id=revision_id)
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
606
2018.18.24 by Martin Pool
Merge Repository.sprout refactoring, and make that use Repository.tarball
607
    def _copy_repository_tarball(self, destination, revision_id=None):
2018.18.10 by Martin Pool
copy_content_into from Remote repositories by using temporary directories on both ends.
608
        # get a tarball of the remote repository, and copy from that into the
609
        # destination
610
        from bzrlib import osutils
2018.18.9 by Martin Pool
remote Repository.tarball builds a temporary directory and tars that
611
        import tarfile
2018.18.10 by Martin Pool
copy_content_into from Remote repositories by using temporary directories on both ends.
612
        import tempfile
2018.18.9 by Martin Pool
remote Repository.tarball builds a temporary directory and tars that
613
        from StringIO import StringIO
2018.18.20 by Martin Pool
Route branch operations through remote copy_content_into
614
        # TODO: Maybe a progress bar while streaming the tarball?
615
        note("Copying repository content as tarball...")
2018.18.25 by Martin Pool
Repository.tarball fixes for python2.4
616
        tar_file = self._get_tarball('bz2')
2018.18.10 by Martin Pool
copy_content_into from Remote repositories by using temporary directories on both ends.
617
        try:
2018.18.25 by Martin Pool
Repository.tarball fixes for python2.4
618
            tar = tarfile.open('repository', fileobj=tar_file,
619
                mode='r|bz2')
620
            tmpdir = tempfile.mkdtemp()
621
            try:
622
                _extract_tar(tar, tmpdir)
623
                tmp_bzrdir = BzrDir.open(tmpdir)
624
                tmp_repo = tmp_bzrdir.open_repository()
625
                tmp_repo.copy_content_into(destination, revision_id)
626
            finally:
627
                osutils.rmtree(tmpdir)
2018.18.10 by Martin Pool
copy_content_into from Remote repositories by using temporary directories on both ends.
628
        finally:
2018.18.25 by Martin Pool
Repository.tarball fixes for python2.4
629
            tar_file.close()
2018.18.10 by Martin Pool
copy_content_into from Remote repositories by using temporary directories on both ends.
630
        # TODO: if the server doesn't support this operation, maybe do it the
631
        # slow way using the _real_repository?
2018.18.23 by Martin Pool
review cleanups
632
        #
633
        # TODO: Suggestion from john: using external tar is much faster than
634
        # python's tarfile library, but it may not work on windows.
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
635
636
    def set_make_working_trees(self, new_value):
637
        raise NotImplementedError(self.set_make_working_trees)
638
639
    @needs_write_lock
640
    def sign_revision(self, revision_id, gpg_strategy):
641
        self._ensure_real()
642
        return self._real_repository.sign_revision(revision_id, gpg_strategy)
643
644
    @needs_read_lock
645
    def get_revisions(self, revision_ids):
646
        self._ensure_real()
647
        return self._real_repository.get_revisions(revision_ids)
648
649
    def supports_rich_root(self):
2018.5.84 by Andrew Bennetts
Merge in supports-rich-root, another test passing.
650
        self._ensure_real()
651
        return self._real_repository.supports_rich_root()
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
652
2018.5.83 by Andrew Bennetts
Fix some test failures caused by the switch from unicode to UTF-8-encoded strs for revision IDs.
653
    def iter_reverse_revision_history(self, revision_id):
654
        self._ensure_real()
655
        return self._real_repository.iter_reverse_revision_history(revision_id)
656
2018.5.96 by Andrew Bennetts
Merge from bzr.dev, resolving the worst of the semantic conflicts, but there's
657
    @property
658
    def _serializer(self):
659
        self._ensure_real()
660
        return self._real_repository._serializer
661
2018.5.97 by Andrew Bennetts
Fix more tests.
662
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
663
        self._ensure_real()
664
        return self._real_repository.store_revision_signature(
665
            gpg_strategy, plaintext, revision_id)
666
667
    def has_signature_for_revision_id(self, revision_id):
668
        self._ensure_real()
669
        return self._real_repository.has_signature_for_revision_id(revision_id)
670
1752.2.31 by Martin Pool
[broken] some support for write operations over hpss
671
2018.5.127 by Andrew Bennetts
Fix most of the lockable_files tests for RemoteBranchLockableFiles.
672
class RemoteBranchLockableFiles(LockableFiles):
2018.5.59 by Robert Collins
Get BranchConfig working somewhat on RemoteBranches (Robert Collins, Vincent Ladeuil).
673
    """A 'LockableFiles' implementation that talks to a smart server.
674
    
675
    This is not a public interface class.
676
    """
677
678
    def __init__(self, bzrdir, _client):
679
        self.bzrdir = bzrdir
680
        self._client = _client
2018.5.135 by Andrew Bennetts
Prevent remote branch clients from determining the 'right' mode for control files, because we don't want clients setting the mode anyway.
681
        self._need_find_modes = True
2018.5.133 by Andrew Bennetts
All TestLockableFiles_RemoteLockDir tests passing.
682
        LockableFiles.__init__(
2018.5.163 by Andrew Bennetts
Deal with various review comments from Robert.
683
            self, bzrdir.get_branch_transport(None),
2018.5.133 by Andrew Bennetts
All TestLockableFiles_RemoteLockDir tests passing.
684
            'lock', lockdir.LockDir)
2018.5.59 by Robert Collins
Get BranchConfig working somewhat on RemoteBranches (Robert Collins, Vincent Ladeuil).
685
2018.5.135 by Andrew Bennetts
Prevent remote branch clients from determining the 'right' mode for control files, because we don't want clients setting the mode anyway.
686
    def _find_modes(self):
687
        # RemoteBranches don't let the client set the mode of control files.
688
        self._dir_mode = None
689
        self._file_mode = None
690
2018.5.59 by Robert Collins
Get BranchConfig working somewhat on RemoteBranches (Robert Collins, Vincent Ladeuil).
691
    def get(self, path):
692
        """'get' a remote path as per the LockableFiles interface.
693
694
        :param path: the file to 'get'. If this is 'branch.conf', we do not
695
             just retrieve a file, instead we ask the smart server to generate
696
             a configuration for us - which is retrieved as an INI file.
697
        """
2018.5.133 by Andrew Bennetts
All TestLockableFiles_RemoteLockDir tests passing.
698
        if path == 'branch.conf':
699
            path = self.bzrdir._path_for_remote_call(self._client)
2018.5.153 by Andrew Bennetts
Rename call2 to call_expecting_body, and other small changes prompted by review.
700
            response = self._client.call_expecting_body(
701
                'Branch.get_config_file', path)
2018.5.133 by Andrew Bennetts
All TestLockableFiles_RemoteLockDir tests passing.
702
            assert response[0][0] == 'ok', \
703
                'unexpected response code %s' % (response[0],)
704
            return StringIO(response[1].read_body_bytes())
705
        else:
706
            # VFS fallback.
707
            return LockableFiles.get(self, path)
2018.5.59 by Robert Collins
Get BranchConfig working somewhat on RemoteBranches (Robert Collins, Vincent Ladeuil).
708
709
1752.2.31 by Martin Pool
[broken] some support for write operations over hpss
710
class RemoteBranchFormat(branch.BranchFormat):
711
2018.5.124 by Robert Collins
Fix test_format_initialize_find_open by delegating Branch formt lookup to the BzrDir, where it should have stayed from the start.
712
    def __eq__(self, other):
713
        return (isinstance(other, RemoteBranchFormat) and 
714
            self.__dict__ == other.__dict__)
715
2018.5.60 by Robert Collins
More missing methods from RemoteBranch and RemoteRepository to let 'info' get further.
716
    def get_format_description(self):
717
        return 'Remote BZR Branch'
718
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
719
    def get_format_string(self):
720
        return 'Remote BZR Branch'
721
1752.2.31 by Martin Pool
[broken] some support for write operations over hpss
722
    def open(self, a_bzrdir):
1752.2.72 by Andrew Bennetts
Make Remote* classes in remote.py more consistent and remove some dead code.
723
        assert isinstance(a_bzrdir, RemoteBzrDir)
724
        return a_bzrdir.open_branch()
1752.2.52 by Andrew Bennetts
Flesh out more Remote* methods needed to open and initialise remote branches/trees/repositories.
725
726
    def initialize(self, a_bzrdir):
727
        assert isinstance(a_bzrdir, RemoteBzrDir)
728
        return a_bzrdir.create_branch()
1752.2.31 by Martin Pool
[broken] some support for write operations over hpss
729
730
731
class RemoteBranch(branch.Branch):
732
    """Branch stored on a server accessed by HPSS RPC.
733
734
    At the moment most operations are mapped down to simple file operations.
735
    """
1752.2.30 by Martin Pool
Start adding a RemoteBzrDir, etc
736
2018.5.51 by Wouter van Heyst
Test and implement RemoteBranch.last_revision_info()
737
    def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
738
        _client=None):
2018.5.34 by Robert Collins
Get test_remote.BasicRemoteObjectTests.test_open_remote_branch passing by implementing a remote method BzrDir.find_repository.
739
        """Create a RemoteBranch instance.
740
741
        :param real_branch: An optional local implementation of the branch
742
            format, usually accessing the data via the VFS.
2018.5.51 by Wouter van Heyst
Test and implement RemoteBranch.last_revision_info()
743
        :param _client: Private parameter for testing.
2018.5.34 by Robert Collins
Get test_remote.BasicRemoteObjectTests.test_open_remote_branch passing by implementing a remote method BzrDir.find_repository.
744
        """
2018.5.163 by Andrew Bennetts
Deal with various review comments from Robert.
745
        # We intentionally don't call the parent class's __init__, because it
746
        # will try to assign to self.tags, which is a property in this subclass.
747
        # And the parent's __init__ doesn't do much anyway.
2018.5.105 by Andrew Bennetts
Implement revision_history caching for RemoteBranch.
748
        self._revision_history_cache = None
1752.2.64 by Andrew Bennetts
Improve how RemoteBzrDir.open_branch works to handle references and not double-open repositories.
749
        self.bzrdir = remote_bzrdir
2018.5.51 by Wouter van Heyst
Test and implement RemoteBranch.last_revision_info()
750
        if _client is not None:
751
            self._client = _client
752
        else:
2018.5.159 by Andrew Bennetts
Rename SmartClient to _SmartClient.
753
            self._client = client._SmartClient(self.bzrdir._medium)
1752.2.64 by Andrew Bennetts
Improve how RemoteBzrDir.open_branch works to handle references and not double-open repositories.
754
        self.repository = remote_repository
2018.5.34 by Robert Collins
Get test_remote.BasicRemoteObjectTests.test_open_remote_branch passing by implementing a remote method BzrDir.find_repository.
755
        if real_branch is not None:
756
            self._real_branch = real_branch
2018.5.79 by Andrew Bennetts
Implement RemoteBranch.lock_write/unlock as smart operations.
757
            # Give the remote repository the matching real repo.
2018.5.97 by Andrew Bennetts
Fix more tests.
758
            real_repo = self._real_branch.repository
759
            if isinstance(real_repo, RemoteRepository):
760
                real_repo._ensure_real()
761
                real_repo = real_repo._real_repository
762
            self.repository._set_real_repository(real_repo)
2018.5.79 by Andrew Bennetts
Implement RemoteBranch.lock_write/unlock as smart operations.
763
            # Give the branch the remote repository to let fast-pathing happen.
764
            self._real_branch.repository = self.repository
2018.5.70 by Robert Collins
Only try to get real repositories when an operation requires them.
765
        else:
766
            self._real_branch = None
2018.5.59 by Robert Collins
Get BranchConfig working somewhat on RemoteBranches (Robert Collins, Vincent Ladeuil).
767
        # Fill out expected attributes of branch for bzrlib api users.
1752.2.64 by Andrew Bennetts
Improve how RemoteBzrDir.open_branch works to handle references and not double-open repositories.
768
        self._format = RemoteBranchFormat()
2018.5.55 by Robert Collins
Give RemoteBranch a base url in line with the Branch protocol.
769
        self.base = self.bzrdir.root_transport.base
2018.5.169 by Andrew Bennetts
Add a _server_formats flag to BzrDir.open_from_transport and BzrDirFormat.find_format, make RemoteBranch.control_files into a property.
770
        self._control_files = None
2018.5.79 by Andrew Bennetts
Implement RemoteBranch.lock_write/unlock as smart operations.
771
        self._lock_mode = None
772
        self._lock_token = None
773
        self._lock_count = 0
774
        self._leave_lock = False
1752.2.64 by Andrew Bennetts
Improve how RemoteBzrDir.open_branch works to handle references and not double-open repositories.
775
2477.1.1 by Martin Pool
Add RemoteBranch repr
776
    def __str__(self):
777
        return "%s(%s)" % (self.__class__.__name__, self.base)
778
779
    __repr__ = __str__
780
2018.5.70 by Robert Collins
Only try to get real repositories when an operation requires them.
781
    def _ensure_real(self):
782
        """Ensure that there is a _real_branch set.
783
2018.5.163 by Andrew Bennetts
Deal with various review comments from Robert.
784
        Used before calls to self._real_branch.
2018.5.70 by Robert Collins
Only try to get real repositories when an operation requires them.
785
        """
786
        if not self._real_branch:
787
            assert vfs.vfs_enabled()
788
            self.bzrdir._ensure_real()
789
            self._real_branch = self.bzrdir._real_bzrdir.open_branch()
2018.5.75 by Andrew Bennetts
Add Repository.{dont_,}leave_lock_in_place.
790
            # Give the remote repository the matching real repo.
2018.5.97 by Andrew Bennetts
Fix more tests.
791
            real_repo = self._real_branch.repository
792
            if isinstance(real_repo, RemoteRepository):
793
                real_repo._ensure_real()
794
                real_repo = real_repo._real_repository
795
            self.repository._set_real_repository(real_repo)
2018.5.75 by Andrew Bennetts
Add Repository.{dont_,}leave_lock_in_place.
796
            # Give the branch the remote repository to let fast-pathing happen.
2018.5.70 by Robert Collins
Only try to get real repositories when an operation requires them.
797
            self._real_branch.repository = self.repository
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
798
            # XXX: deal with _lock_mode == 'w'
799
            if self._lock_mode == 'r':
800
                self._real_branch.lock_read()
2018.5.70 by Robert Collins
Only try to get real repositories when an operation requires them.
801
2018.5.169 by Andrew Bennetts
Add a _server_formats flag to BzrDir.open_from_transport and BzrDirFormat.find_format, make RemoteBranch.control_files into a property.
802
    @property
803
    def control_files(self):
804
        # Defer actually creating RemoteBranchLockableFiles until its needed,
805
        # because it triggers an _ensure_real that we otherwise might not need.
806
        if self._control_files is None:
807
            self._control_files = RemoteBranchLockableFiles(
808
                self.bzrdir, self._client)
809
        return self._control_files
810
2018.5.166 by Andrew Bennetts
Small changes in response to Aaron's review.
811
    def _get_checkout_format(self):
812
        self._ensure_real()
813
        return self._real_branch._get_checkout_format()
814
2018.5.60 by Robert Collins
More missing methods from RemoteBranch and RemoteRepository to let 'info' get further.
815
    def get_physical_lock_status(self):
816
        """See Branch.get_physical_lock_status()."""
817
        # should be an API call to the server, as branches must be lockable.
2018.5.70 by Robert Collins
Only try to get real repositories when an operation requires them.
818
        self._ensure_real()
2018.5.60 by Robert Collins
More missing methods from RemoteBranch and RemoteRepository to let 'info' get further.
819
        return self._real_branch.get_physical_lock_status()
820
1752.2.31 by Martin Pool
[broken] some support for write operations over hpss
821
    def lock_read(self):
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
822
        if not self._lock_mode:
823
            self._lock_mode = 'r'
824
            self._lock_count = 1
825
            if self._real_branch is not None:
826
                self._real_branch.lock_read()
827
        else:
828
            self._lock_count += 1
1752.2.52 by Andrew Bennetts
Flesh out more Remote* methods needed to open and initialise remote branches/trees/repositories.
829
2018.5.142 by Andrew Bennetts
Change Branch.lock_token to only accept and receive the branch lock token (rather than the branch and repo lock tokens).
830
    def _remote_lock_write(self, token):
831
        if token is None:
2018.5.79 by Andrew Bennetts
Implement RemoteBranch.lock_write/unlock as smart operations.
832
            branch_token = repo_token = ''
833
        else:
2018.5.142 by Andrew Bennetts
Change Branch.lock_token to only accept and receive the branch lock token (rather than the branch and repo lock tokens).
834
            branch_token = token
835
            repo_token = self.repository.lock_write()
836
            self.repository.unlock()
2018.5.79 by Andrew Bennetts
Implement RemoteBranch.lock_write/unlock as smart operations.
837
        path = self.bzrdir._path_for_remote_call(self._client)
838
        response = self._client.call('Branch.lock_write', path, branch_token,
839
                                     repo_token)
840
        if response[0] == 'ok':
841
            ok, branch_token, repo_token = response
842
            return branch_token, repo_token
843
        elif response[0] == 'LockContention':
844
            raise errors.LockContention('(remote lock)')
845
        elif response[0] == 'TokenMismatch':
2018.5.142 by Andrew Bennetts
Change Branch.lock_token to only accept and receive the branch lock token (rather than the branch and repo lock tokens).
846
            raise errors.TokenMismatch(token, '(remote token)')
2018.5.95 by Andrew Bennetts
Add a Transport.is_readonly remote call, let {Branch,Repository}.lock_write remote call return UnlockableTransport, and miscellaneous test fixes.
847
        elif response[0] == 'UnlockableTransport':
848
            raise errors.UnlockableTransport(self.bzrdir.root_transport)
2018.5.123 by Robert Collins
Translate ReadOnlyError in RemoteBranch._remote_lock_write.
849
        elif response[0] == 'ReadOnlyError':
850
            raise errors.ReadOnlyError(self)
2018.5.79 by Andrew Bennetts
Implement RemoteBranch.lock_write/unlock as smart operations.
851
        else:
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
852
            assert False, 'unexpected response code %r' % (response,)
2018.5.79 by Andrew Bennetts
Implement RemoteBranch.lock_write/unlock as smart operations.
853
            
2018.5.142 by Andrew Bennetts
Change Branch.lock_token to only accept and receive the branch lock token (rather than the branch and repo lock tokens).
854
    def lock_write(self, token=None):
2018.5.79 by Andrew Bennetts
Implement RemoteBranch.lock_write/unlock as smart operations.
855
        if not self._lock_mode:
2018.5.142 by Andrew Bennetts
Change Branch.lock_token to only accept and receive the branch lock token (rather than the branch and repo lock tokens).
856
            remote_tokens = self._remote_lock_write(token)
2018.5.79 by Andrew Bennetts
Implement RemoteBranch.lock_write/unlock as smart operations.
857
            self._lock_token, self._repo_lock_token = remote_tokens
858
            assert self._lock_token, 'Remote server did not return a token!'
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
859
            # TODO: We really, really, really don't want to call _ensure_real
860
            # here, but it's the easiest way to ensure coherency between the
861
            # state of the RemoteBranch and RemoteRepository objects and the
862
            # physical locks.  If we don't materialise the real objects here,
863
            # then getting everything in the right state later is complex, so
864
            # for now we just do it the lazy way.
865
            #   -- Andrew Bennetts, 2007-02-22.
866
            self._ensure_real()
2018.5.79 by Andrew Bennetts
Implement RemoteBranch.lock_write/unlock as smart operations.
867
            if self._real_branch is not None:
2018.5.142 by Andrew Bennetts
Change Branch.lock_token to only accept and receive the branch lock token (rather than the branch and repo lock tokens).
868
                self._real_branch.repository.lock_write(
869
                    token=self._repo_lock_token)
870
                try:
871
                    self._real_branch.lock_write(token=self._lock_token)
872
                finally:
873
                    self._real_branch.repository.unlock()
874
            if token is not None:
2018.5.79 by Andrew Bennetts
Implement RemoteBranch.lock_write/unlock as smart operations.
875
                self._leave_lock = True
876
            else:
2018.5.142 by Andrew Bennetts
Change Branch.lock_token to only accept and receive the branch lock token (rather than the branch and repo lock tokens).
877
                # XXX: this case seems to be unreachable; token cannot be None.
2018.5.79 by Andrew Bennetts
Implement RemoteBranch.lock_write/unlock as smart operations.
878
                self._leave_lock = False
879
            self._lock_mode = 'w'
880
            self._lock_count = 1
881
        elif self._lock_mode == 'r':
882
            raise errors.ReadOnlyTransaction
883
        else:
2018.5.142 by Andrew Bennetts
Change Branch.lock_token to only accept and receive the branch lock token (rather than the branch and repo lock tokens).
884
            if token is not None:
885
                # A token was given to lock_write, and we're relocking, so check
886
                # that the given token actually matches the one we already have.
887
                if token != self._lock_token:
888
                    raise errors.TokenMismatch(token, self._lock_token)
2018.5.79 by Andrew Bennetts
Implement RemoteBranch.lock_write/unlock as smart operations.
889
            self._lock_count += 1
2018.5.142 by Andrew Bennetts
Change Branch.lock_token to only accept and receive the branch lock token (rather than the branch and repo lock tokens).
890
        return self._lock_token
2018.5.79 by Andrew Bennetts
Implement RemoteBranch.lock_write/unlock as smart operations.
891
892
    def _unlock(self, branch_token, repo_token):
893
        path = self.bzrdir._path_for_remote_call(self._client)
894
        response = self._client.call('Branch.unlock', path, branch_token,
895
                                     repo_token)
896
        if response == ('ok',):
897
            return
898
        elif response[0] == 'TokenMismatch':
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
899
            raise errors.TokenMismatch(
900
                str((branch_token, repo_token)), '(remote tokens)')
2018.5.79 by Andrew Bennetts
Implement RemoteBranch.lock_write/unlock as smart operations.
901
        else:
902
            assert False, 'unexpected response code %s' % (response,)
1752.2.31 by Martin Pool
[broken] some support for write operations over hpss
903
904
    def unlock(self):
2018.5.79 by Andrew Bennetts
Implement RemoteBranch.lock_write/unlock as smart operations.
905
        self._lock_count -= 1
906
        if not self._lock_count:
2018.5.105 by Andrew Bennetts
Implement revision_history caching for RemoteBranch.
907
            self._clear_cached_state()
2018.5.79 by Andrew Bennetts
Implement RemoteBranch.lock_write/unlock as smart operations.
908
            mode = self._lock_mode
909
            self._lock_mode = None
910
            if self._real_branch is not None:
2018.15.1 by Andrew Bennetts
All branch_implementations/test_locking tests passing.
911
                if not self._leave_lock:
912
                    # If this RemoteBranch will remove the physical lock for the
913
                    # repository, make sure the _real_branch doesn't do it
914
                    # first.  (Because the _real_branch's repository is set to
915
                    # be the RemoteRepository.)
916
                    self._real_branch.repository.leave_lock_in_place()
2018.5.79 by Andrew Bennetts
Implement RemoteBranch.lock_write/unlock as smart operations.
917
                self._real_branch.unlock()
918
            if mode != 'w':
2018.5.163 by Andrew Bennetts
Deal with various review comments from Robert.
919
                # Only write-locked branched need to make a remote method call
920
                # to perfom the unlock.
2018.5.79 by Andrew Bennetts
Implement RemoteBranch.lock_write/unlock as smart operations.
921
                return
922
            assert self._lock_token, 'Locked, but no token!'
923
            branch_token = self._lock_token
924
            repo_token = self._repo_lock_token
925
            self._lock_token = None
926
            self._repo_lock_token = None
927
            if not self._leave_lock:
928
                self._unlock(branch_token, repo_token)
1752.2.52 by Andrew Bennetts
Flesh out more Remote* methods needed to open and initialise remote branches/trees/repositories.
929
930
    def break_lock(self):
2018.5.70 by Robert Collins
Only try to get real repositories when an operation requires them.
931
        self._ensure_real()
1752.2.52 by Andrew Bennetts
Flesh out more Remote* methods needed to open and initialise remote branches/trees/repositories.
932
        return self._real_branch.break_lock()
1752.2.31 by Martin Pool
[broken] some support for write operations over hpss
933
2018.5.79 by Andrew Bennetts
Implement RemoteBranch.lock_write/unlock as smart operations.
934
    def leave_lock_in_place(self):
935
        self._leave_lock = True
936
937
    def dont_leave_lock_in_place(self):
938
        self._leave_lock = False
939
2018.5.51 by Wouter van Heyst
Test and implement RemoteBranch.last_revision_info()
940
    def last_revision_info(self):
941
        """See Branch.last_revision_info()."""
942
        path = self.bzrdir._path_for_remote_call(self._client)
943
        response = self._client.call('Branch.last_revision_info', path)
2018.5.52 by Wouter van Heyst
Provide more information when encountering unexpected responses from a smart
944
        assert response[0] == 'ok', 'unexpected response code %s' % (response,)
2018.5.51 by Wouter van Heyst
Test and implement RemoteBranch.last_revision_info()
945
        revno = int(response[1])
2018.5.83 by Andrew Bennetts
Fix some test failures caused by the switch from unicode to UTF-8-encoded strs for revision IDs.
946
        last_revision = response[2]
2018.5.51 by Wouter van Heyst
Test and implement RemoteBranch.last_revision_info()
947
        return (revno, last_revision)
948
2018.5.105 by Andrew Bennetts
Implement revision_history caching for RemoteBranch.
949
    def _gen_revision_history(self):
950
        """See Branch._gen_revision_history()."""
2018.5.42 by Robert Collins
Various hopefully improvements, but wsgi is broken, handing over to spiv :).
951
        path = self.bzrdir._path_for_remote_call(self._client)
2018.5.153 by Andrew Bennetts
Rename call2 to call_expecting_body, and other small changes prompted by review.
952
        response = self._client.call_expecting_body(
953
            'Branch.revision_history', path)
954
        assert response[0][0] == 'ok', ('unexpected response code %s'
955
                                        % (response[0],))
2018.5.83 by Andrew Bennetts
Fix some test failures caused by the switch from unicode to UTF-8-encoded strs for revision IDs.
956
        result = response[1].read_body_bytes().split('\x00')
2018.5.38 by Robert Collins
Implement RemoteBranch.revision_history().
957
        if result == ['']:
958
            return []
959
        return result
1752.2.30 by Martin Pool
Start adding a RemoteBzrDir, etc
960
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
961
    @needs_write_lock
1752.2.52 by Andrew Bennetts
Flesh out more Remote* methods needed to open and initialise remote branches/trees/repositories.
962
    def set_revision_history(self, rev_history):
2018.12.3 by Andrew Bennetts
Add a Branch.set_last_revision smart method, and make RemoteBranch.set_revision_history use it.
963
        # Send just the tip revision of the history; the server will generate
964
        # the full history from that.  If the revision doesn't exist in this
965
        # branch, NoSuchRevision will be raised.
966
        path = self.bzrdir._path_for_remote_call(self._client)
967
        if rev_history == []:
2018.5.170 by Andrew Bennetts
Use 'null:' instead of '' to mean NULL_REVISION on the wire.
968
            rev_id = 'null:'
2018.12.3 by Andrew Bennetts
Add a Branch.set_last_revision smart method, and make RemoteBranch.set_revision_history use it.
969
        else:
970
            rev_id = rev_history[-1]
2418.5.12 by John Arbash Meinel
Move functions from BzrBranch to base Branch object.
971
        self._clear_cached_state()
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
972
        response = self._client.call('Branch.set_last_revision',
973
            path, self._lock_token, self._repo_lock_token, rev_id)
2018.12.3 by Andrew Bennetts
Add a Branch.set_last_revision smart method, and make RemoteBranch.set_revision_history use it.
974
        if response[0] == 'NoSuchRevision':
975
            raise NoSuchRevision(self, rev_id)
976
        else:
977
            assert response == ('ok',), (
978
                'unexpected response code %r' % (response,))
2018.5.105 by Andrew Bennetts
Implement revision_history caching for RemoteBranch.
979
        self._cache_revision_history(rev_history)
1752.2.52 by Andrew Bennetts
Flesh out more Remote* methods needed to open and initialise remote branches/trees/repositories.
980
981
    def get_parent(self):
2018.5.70 by Robert Collins
Only try to get real repositories when an operation requires them.
982
        self._ensure_real()
1752.2.52 by Andrew Bennetts
Flesh out more Remote* methods needed to open and initialise remote branches/trees/repositories.
983
        return self._real_branch.get_parent()
984
        
1752.2.63 by Andrew Bennetts
Delegate set_parent.
985
    def set_parent(self, url):
2018.5.70 by Robert Collins
Only try to get real repositories when an operation requires them.
986
        self._ensure_real()
1752.2.63 by Andrew Bennetts
Delegate set_parent.
987
        return self._real_branch.set_parent(url)
988
        
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
989
    def get_config(self):
990
        return RemoteBranchConfig(self)
991
2018.5.94 by Andrew Bennetts
Various small changes in aid of making tests pass (including deleting one invalid test).
992
    def sprout(self, to_bzrdir, revision_id=None):
993
        # Like Branch.sprout, except that it sprouts a branch in the default
994
        # format, because RemoteBranches can't be created at arbitrary URLs.
995
        # XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
996
        # to_bzrdir.create_branch...
997
        result = branch.BranchFormat.get_default_format().initialize(to_bzrdir)
2018.18.20 by Martin Pool
Route branch operations through remote copy_content_into
998
        self.copy_content_into(result, revision_id=revision_id)
2018.5.94 by Andrew Bennetts
Various small changes in aid of making tests pass (including deleting one invalid test).
999
        result.set_parent(self.bzrdir.root_transport.base)
1000
        return result
1001
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
1002
    @needs_write_lock
1003
    def append_revision(self, *revision_ids):
1004
        self._ensure_real()
1005
        return self._real_branch.append_revision(*revision_ids)
1006
1007
    @needs_write_lock
2477.1.2 by Martin Pool
Rename push/pull back to 'run_hooks' (jameinel)
1008
    def pull(self, source, overwrite=False, stop_revision=None,
2477.1.9 by Martin Pool
Review cleanups from John, mostly docs
1009
             **kwargs):
1010
        # FIXME: This asks the real branch to run the hooks, which means
1011
        # they're called with the wrong target branch parameter. 
1012
        # The test suite specifically allows this at present but it should be
1013
        # fixed.  It should get a _override_hook_target branch,
1014
        # as push does.  -- mbp 20070405
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
1015
        self._ensure_real()
1016
        self._real_branch.pull(
2477.1.2 by Martin Pool
Rename push/pull back to 'run_hooks' (jameinel)
1017
            source, overwrite=overwrite, stop_revision=stop_revision,
1018
            **kwargs)
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
1019
2018.14.3 by Andrew Bennetts
Make a couple more branch_implementations tests pass.
1020
    @needs_read_lock
1021
    def push(self, target, overwrite=False, stop_revision=None):
1022
        self._ensure_real()
2018.5.97 by Andrew Bennetts
Fix more tests.
1023
        return self._real_branch.push(
2477.1.5 by Martin Pool
More cleanups of Branch.push to get the right behaviour with RemoteBranches
1024
            target, overwrite=overwrite, stop_revision=stop_revision,
1025
            _override_hook_source_branch=self)
2018.14.3 by Andrew Bennetts
Make a couple more branch_implementations tests pass.
1026
1027
    def is_locked(self):
1028
        return self._lock_count >= 1
1029
2018.5.83 by Andrew Bennetts
Fix some test failures caused by the switch from unicode to UTF-8-encoded strs for revision IDs.
1030
    def set_last_revision_info(self, revno, revision_id):
1031
        self._ensure_real()
2018.5.105 by Andrew Bennetts
Implement revision_history caching for RemoteBranch.
1032
        self._clear_cached_state()
2018.5.83 by Andrew Bennetts
Fix some test failures caused by the switch from unicode to UTF-8-encoded strs for revision IDs.
1033
        return self._real_branch.set_last_revision_info(revno, revision_id)
1034
2018.5.95 by Andrew Bennetts
Add a Transport.is_readonly remote call, let {Branch,Repository}.lock_write remote call return UnlockableTransport, and miscellaneous test fixes.
1035
    def generate_revision_history(self, revision_id, last_rev=None,
1036
                                  other_branch=None):
1037
        self._ensure_real()
1038
        return self._real_branch.generate_revision_history(
1039
            revision_id, last_rev=last_rev, other_branch=other_branch)
1040
2018.5.96 by Andrew Bennetts
Merge from bzr.dev, resolving the worst of the semantic conflicts, but there's
1041
    @property
1042
    def tags(self):
1043
        self._ensure_real()
1044
        return self._real_branch.tags
1045
2018.5.97 by Andrew Bennetts
Fix more tests.
1046
    def set_push_location(self, location):
1047
        self._ensure_real()
1048
        return self._real_branch.set_push_location(location)
1049
1050
    def update_revisions(self, other, stop_revision=None):
1051
        self._ensure_real()
1052
        return self._real_branch.update_revisions(
1053
            other, stop_revision=stop_revision)
1054
1752.2.30 by Martin Pool
Start adding a RemoteBzrDir, etc
1055
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
1056
class RemoteBranchConfig(BranchConfig):
1057
1058
    def username(self):
1059
        self.branch._ensure_real()
1060
        return self.branch._real_branch.get_config().username()
1061
2018.14.2 by Andrew Bennetts
All but one repository_implementation tests for RemoteRepository passing.
1062
    def _get_branch_data_config(self):
1063
        self.branch._ensure_real()
1064
        if self._branch_data_config is None:
1065
            self._branch_data_config = TreeConfig(self.branch._real_branch)
1066
        return self._branch_data_config
1067
2018.18.25 by Martin Pool
Repository.tarball fixes for python2.4
1068
1069
def _extract_tar(tar, to_dir):
1070
    """Extract all the contents of a tarfile object.
1071
1072
    A replacement for extractall, which is not present in python2.4
1073
    """
1074
    for tarinfo in tar:
1075
        tar.extract(tarinfo, to_dir)