~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

  • Committer: Robert Collins
  • Date: 2010-01-28 18:05:44 UTC
  • mto: (4797.2.5 2.1)
  • mto: This revision was merged to the branch mainline in revision 4989.
  • Revision ID: robertc@robertcollins.net-20100128180544-6l8x7o7obaq7b51x
Tweak ConfigurableFileMerger to use class variables rather than requiring __init__ wrapping as future proofing for helper functions.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
 
1
# Copyright (C) 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
 
 
17
 
# TODO: At some point, handle upgrades by just passing the whole request
18
 
# across to run on the server.
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
16
 
20
17
import bz2
21
18
 
22
19
from bzrlib import (
 
20
    bencode,
23
21
    branch,
 
22
    bzrdir,
 
23
    config,
24
24
    debug,
25
25
    errors,
26
26
    graph,
 
27
    lock,
27
28
    lockdir,
28
29
    repository,
29
30
    revision,
 
31
    revision as _mod_revision,
30
32
    symbol_versioning,
31
 
    urlutils,
32
33
)
33
34
from bzrlib.branch import BranchReferenceFormat
34
35
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
35
 
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
36
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
36
37
from bzrlib.errors import (
37
38
    NoSuchRevision,
38
39
    SmartProtocolError,
39
40
    )
40
41
from bzrlib.lockable_files import LockableFiles
41
 
from bzrlib.smart import client, vfs
 
42
from bzrlib.smart import client, vfs, repository as smart_repo
42
43
from bzrlib.revision import ensure_null, NULL_REVISION
43
44
from bzrlib.trace import mutter, note, warning
44
45
 
51
52
            return self._client.call(method, *args)
52
53
        except errors.ErrorFromSmartServer, err:
53
54
            self._translate_error(err, **err_context)
54
 
        
 
55
 
55
56
    def _call_expecting_body(self, method, *args, **err_context):
56
57
        try:
57
58
            return self._client.call_expecting_body(method, *args)
58
59
        except errors.ErrorFromSmartServer, err:
59
60
            self._translate_error(err, **err_context)
60
 
        
 
61
 
 
62
    def _call_with_body_bytes(self, method, args, body_bytes, **err_context):
 
63
        try:
 
64
            return self._client.call_with_body_bytes(method, args, body_bytes)
 
65
        except errors.ErrorFromSmartServer, err:
 
66
            self._translate_error(err, **err_context)
 
67
 
61
68
    def _call_with_body_bytes_expecting_body(self, method, args, body_bytes,
62
69
                                             **err_context):
63
70
        try:
65
72
                method, args, body_bytes)
66
73
        except errors.ErrorFromSmartServer, err:
67
74
            self._translate_error(err, **err_context)
68
 
        
 
75
 
 
76
 
 
77
def response_tuple_to_repo_format(response):
 
78
    """Convert a response tuple describing a repository format to a format."""
 
79
    format = RemoteRepositoryFormat()
 
80
    format._rich_root_data = (response[0] == 'yes')
 
81
    format._supports_tree_reference = (response[1] == 'yes')
 
82
    format._supports_external_lookups = (response[2] == 'yes')
 
83
    format._network_name = response[3]
 
84
    return format
 
85
 
 
86
 
69
87
# Note: RemoteBzrDirFormat is in bzrdir.py
70
88
 
71
89
class RemoteBzrDir(BzrDir, _RpcHelper):
72
90
    """Control directory on a remote server, accessed via bzr:// or similar."""
73
91
 
74
 
    def __init__(self, transport, _client=None):
 
92
    def __init__(self, transport, format, _client=None, _force_probe=False):
75
93
        """Construct a RemoteBzrDir.
76
94
 
77
95
        :param _client: Private parameter for testing. Disables probing and the
78
96
            use of a real bzrdir.
79
97
        """
80
 
        BzrDir.__init__(self, transport, RemoteBzrDirFormat())
 
98
        BzrDir.__init__(self, transport, format)
81
99
        # this object holds a delegated bzrdir that uses file-level operations
82
100
        # to talk to the other side
83
101
        self._real_bzrdir = None
 
102
        self._has_working_tree = None
 
103
        # 1-shot cache for the call pattern 'create_branch; open_branch' - see
 
104
        # create_branch for details.
 
105
        self._next_open_branch_result = None
84
106
 
85
107
        if _client is None:
86
108
            medium = transport.get_smart_medium()
87
109
            self._client = client._SmartClient(medium)
88
110
        else:
89
111
            self._client = _client
90
 
            return
91
 
 
 
112
            if not _force_probe:
 
113
                return
 
114
 
 
115
        self._probe_bzrdir()
 
116
 
 
117
    def __repr__(self):
 
118
        return '%s(%r)' % (self.__class__.__name__, self._client)
 
119
 
 
120
    def _probe_bzrdir(self):
 
121
        medium = self._client._medium
92
122
        path = self._path_for_remote_call(self._client)
 
123
        if medium._is_remote_before((2, 1)):
 
124
            self._rpc_open(path)
 
125
            return
 
126
        try:
 
127
            self._rpc_open_2_1(path)
 
128
            return
 
129
        except errors.UnknownSmartMethod:
 
130
            medium._remember_remote_is_before((2, 1))
 
131
            self._rpc_open(path)
 
132
 
 
133
    def _rpc_open_2_1(self, path):
 
134
        response = self._call('BzrDir.open_2.1', path)
 
135
        if response == ('no',):
 
136
            raise errors.NotBranchError(path=self.root_transport.base)
 
137
        elif response[0] == 'yes':
 
138
            if response[1] == 'yes':
 
139
                self._has_working_tree = True
 
140
            elif response[1] == 'no':
 
141
                self._has_working_tree = False
 
142
            else:
 
143
                raise errors.UnexpectedSmartServerResponse(response)
 
144
        else:
 
145
            raise errors.UnexpectedSmartServerResponse(response)
 
146
 
 
147
    def _rpc_open(self, path):
93
148
        response = self._call('BzrDir.open', path)
94
149
        if response not in [('yes',), ('no',)]:
95
150
            raise errors.UnexpectedSmartServerResponse(response)
96
151
        if response == ('no',):
97
 
            raise errors.NotBranchError(path=transport.base)
 
152
            raise errors.NotBranchError(path=self.root_transport.base)
98
153
 
99
154
    def _ensure_real(self):
100
155
        """Ensure that there is a _real_bzrdir set.
102
157
        Used before calls to self._real_bzrdir.
103
158
        """
104
159
        if not self._real_bzrdir:
 
160
            if 'hpssvfs' in debug.debug_flags:
 
161
                import traceback
 
162
                warning('VFS BzrDir access triggered\n%s',
 
163
                    ''.join(traceback.format_stack()))
105
164
            self._real_bzrdir = BzrDir.open_from_transport(
106
165
                self.root_transport, _server_formats=False)
 
166
            self._format._network_name = \
 
167
                self._real_bzrdir._format.network_name()
107
168
 
108
169
    def _translate_error(self, err, **context):
109
170
        _translate_error(err, bzrdir=self, **context)
110
171
 
111
 
    def cloning_metadir(self, stacked=False):
 
172
    def break_lock(self):
 
173
        # Prevent aliasing problems in the next_open_branch_result cache.
 
174
        # See create_branch for rationale.
 
175
        self._next_open_branch_result = None
 
176
        return BzrDir.break_lock(self)
 
177
 
 
178
    def _vfs_cloning_metadir(self, require_stacking=False):
112
179
        self._ensure_real()
113
 
        return self._real_bzrdir.cloning_metadir(stacked)
 
180
        return self._real_bzrdir.cloning_metadir(
 
181
            require_stacking=require_stacking)
 
182
 
 
183
    def cloning_metadir(self, require_stacking=False):
 
184
        medium = self._client._medium
 
185
        if medium._is_remote_before((1, 13)):
 
186
            return self._vfs_cloning_metadir(require_stacking=require_stacking)
 
187
        verb = 'BzrDir.cloning_metadir'
 
188
        if require_stacking:
 
189
            stacking = 'True'
 
190
        else:
 
191
            stacking = 'False'
 
192
        path = self._path_for_remote_call(self._client)
 
193
        try:
 
194
            response = self._call(verb, path, stacking)
 
195
        except errors.UnknownSmartMethod:
 
196
            medium._remember_remote_is_before((1, 13))
 
197
            return self._vfs_cloning_metadir(require_stacking=require_stacking)
 
198
        except errors.UnknownErrorFromSmartServer, err:
 
199
            if err.error_tuple != ('BranchReference',):
 
200
                raise
 
201
            # We need to resolve the branch reference to determine the
 
202
            # cloning_metadir.  This causes unnecessary RPCs to open the
 
203
            # referenced branch (and bzrdir, etc) but only when the caller
 
204
            # didn't already resolve the branch reference.
 
205
            referenced_branch = self.open_branch()
 
206
            return referenced_branch.bzrdir.cloning_metadir()
 
207
        if len(response) != 3:
 
208
            raise errors.UnexpectedSmartServerResponse(response)
 
209
        control_name, repo_name, branch_info = response
 
210
        if len(branch_info) != 2:
 
211
            raise errors.UnexpectedSmartServerResponse(response)
 
212
        branch_ref, branch_name = branch_info
 
213
        format = bzrdir.network_format_registry.get(control_name)
 
214
        if repo_name:
 
215
            format.repository_format = repository.network_format_registry.get(
 
216
                repo_name)
 
217
        if branch_ref == 'ref':
 
218
            # XXX: we need possible_transports here to avoid reopening the
 
219
            # connection to the referenced location
 
220
            ref_bzrdir = BzrDir.open(branch_name)
 
221
            branch_format = ref_bzrdir.cloning_metadir().get_branch_format()
 
222
            format.set_branch_format(branch_format)
 
223
        elif branch_ref == 'branch':
 
224
            if branch_name:
 
225
                format.set_branch_format(
 
226
                    branch.network_format_registry.get(branch_name))
 
227
        else:
 
228
            raise errors.UnexpectedSmartServerResponse(response)
 
229
        return format
114
230
 
115
231
    def create_repository(self, shared=False):
116
 
        self._ensure_real()
117
 
        self._real_bzrdir.create_repository(shared=shared)
118
 
        return self.open_repository()
 
232
        # as per meta1 formats - just delegate to the format object which may
 
233
        # be parameterised.
 
234
        result = self._format.repository_format.initialize(self, shared)
 
235
        if not isinstance(result, RemoteRepository):
 
236
            return self.open_repository()
 
237
        else:
 
238
            return result
119
239
 
120
240
    def destroy_repository(self):
121
241
        """See BzrDir.destroy_repository"""
123
243
        self._real_bzrdir.destroy_repository()
124
244
 
125
245
    def create_branch(self):
126
 
        self._ensure_real()
127
 
        real_branch = self._real_bzrdir.create_branch()
128
 
        return RemoteBranch(self, self.find_repository(), real_branch)
 
246
        # as per meta1 formats - just delegate to the format object which may
 
247
        # be parameterised.
 
248
        real_branch = self._format.get_branch_format().initialize(self)
 
249
        if not isinstance(real_branch, RemoteBranch):
 
250
            result = RemoteBranch(self, self.find_repository(), real_branch)
 
251
        else:
 
252
            result = real_branch
 
253
        # BzrDir.clone_on_transport() uses the result of create_branch but does
 
254
        # not return it to its callers; we save approximately 8% of our round
 
255
        # trips by handing the branch we created back to the first caller to
 
256
        # open_branch rather than probing anew. Long term we need a API in
 
257
        # bzrdir that doesn't discard result objects (like result_branch).
 
258
        # RBC 20090225
 
259
        self._next_open_branch_result = result
 
260
        return result
129
261
 
130
262
    def destroy_branch(self):
131
263
        """See BzrDir.destroy_branch"""
132
264
        self._ensure_real()
133
265
        self._real_bzrdir.destroy_branch()
 
266
        self._next_open_branch_result = None
134
267
 
135
268
    def create_workingtree(self, revision_id=None, from_branch=None):
136
269
        raise errors.NotLocalUrl(self.transport.base)
145
278
 
146
279
    def get_branch_reference(self):
147
280
        """See BzrDir.get_branch_reference()."""
 
281
        response = self._get_branch_reference()
 
282
        if response[0] == 'ref':
 
283
            return response[1]
 
284
        else:
 
285
            return None
 
286
 
 
287
    def _get_branch_reference(self):
148
288
        path = self._path_for_remote_call(self._client)
149
 
        response = self._call('BzrDir.open_branch', path)
150
 
        if response[0] == 'ok':
151
 
            if response[1] == '':
152
 
                # branch at this location.
153
 
                return None
154
 
            else:
155
 
                # a branch reference, use the existing BranchReference logic.
156
 
                return response[1]
157
 
        else:
 
289
        medium = self._client._medium
 
290
        candidate_calls = [
 
291
            ('BzrDir.open_branchV3', (2, 1)),
 
292
            ('BzrDir.open_branchV2', (1, 13)),
 
293
            ('BzrDir.open_branch', None),
 
294
            ]
 
295
        for verb, required_version in candidate_calls:
 
296
            if required_version and medium._is_remote_before(required_version):
 
297
                continue
 
298
            try:
 
299
                response = self._call(verb, path)
 
300
            except errors.UnknownSmartMethod:
 
301
                if required_version is None:
 
302
                    raise
 
303
                medium._remember_remote_is_before(required_version)
 
304
            else:
 
305
                break
 
306
        if verb == 'BzrDir.open_branch':
 
307
            if response[0] != 'ok':
 
308
                raise errors.UnexpectedSmartServerResponse(response)
 
309
            if response[1] != '':
 
310
                return ('ref', response[1])
 
311
            else:
 
312
                return ('branch', '')
 
313
        if response[0] not in ('ref', 'branch'):
158
314
            raise errors.UnexpectedSmartServerResponse(response)
 
315
        return response
159
316
 
160
317
    def _get_tree_branch(self):
161
318
        """See BzrDir._get_tree_branch()."""
162
319
        return None, self.open_branch()
163
320
 
164
 
    def open_branch(self, _unsupported=False):
 
321
    def open_branch(self, _unsupported=False, ignore_fallbacks=False):
165
322
        if _unsupported:
166
323
            raise NotImplementedError('unsupported flag support not implemented yet.')
167
 
        reference_url = self.get_branch_reference()
168
 
        if reference_url is None:
169
 
            # branch at this location.
170
 
            return RemoteBranch(self, self.find_repository())
171
 
        else:
 
324
        if self._next_open_branch_result is not None:
 
325
            # See create_branch for details.
 
326
            result = self._next_open_branch_result
 
327
            self._next_open_branch_result = None
 
328
            return result
 
329
        response = self._get_branch_reference()
 
330
        if response[0] == 'ref':
172
331
            # a branch reference, use the existing BranchReference logic.
173
332
            format = BranchReferenceFormat()
174
 
            return format.open(self, _found=True, location=reference_url)
175
 
                
 
333
            return format.open(self, _found=True, location=response[1],
 
334
                ignore_fallbacks=ignore_fallbacks)
 
335
        branch_format_name = response[1]
 
336
        if not branch_format_name:
 
337
            branch_format_name = None
 
338
        format = RemoteBranchFormat(network_name=branch_format_name)
 
339
        return RemoteBranch(self, self.find_repository(), format=format,
 
340
            setup_stacking=not ignore_fallbacks)
 
341
 
 
342
    def _open_repo_v1(self, path):
 
343
        verb = 'BzrDir.find_repository'
 
344
        response = self._call(verb, path)
 
345
        if response[0] != 'ok':
 
346
            raise errors.UnexpectedSmartServerResponse(response)
 
347
        # servers that only support the v1 method don't support external
 
348
        # references either.
 
349
        self._ensure_real()
 
350
        repo = self._real_bzrdir.open_repository()
 
351
        response = response + ('no', repo._format.network_name())
 
352
        return response, repo
 
353
 
 
354
    def _open_repo_v2(self, path):
 
355
        verb = 'BzrDir.find_repositoryV2'
 
356
        response = self._call(verb, path)
 
357
        if response[0] != 'ok':
 
358
            raise errors.UnexpectedSmartServerResponse(response)
 
359
        self._ensure_real()
 
360
        repo = self._real_bzrdir.open_repository()
 
361
        response = response + (repo._format.network_name(),)
 
362
        return response, repo
 
363
 
 
364
    def _open_repo_v3(self, path):
 
365
        verb = 'BzrDir.find_repositoryV3'
 
366
        medium = self._client._medium
 
367
        if medium._is_remote_before((1, 13)):
 
368
            raise errors.UnknownSmartMethod(verb)
 
369
        try:
 
370
            response = self._call(verb, path)
 
371
        except errors.UnknownSmartMethod:
 
372
            medium._remember_remote_is_before((1, 13))
 
373
            raise
 
374
        if response[0] != 'ok':
 
375
            raise errors.UnexpectedSmartServerResponse(response)
 
376
        return response, None
 
377
 
176
378
    def open_repository(self):
177
379
        path = self._path_for_remote_call(self._client)
178
 
        verb = 'BzrDir.find_repositoryV2'
179
 
        try:
180
 
            response = self._call(verb, path)
181
 
        except errors.UnknownSmartMethod:
182
 
            verb = 'BzrDir.find_repository'
183
 
            response = self._call(verb, path)
 
380
        response = None
 
381
        for probe in [self._open_repo_v3, self._open_repo_v2,
 
382
            self._open_repo_v1]:
 
383
            try:
 
384
                response, real_repo = probe(path)
 
385
                break
 
386
            except errors.UnknownSmartMethod:
 
387
                pass
 
388
        if response is None:
 
389
            raise errors.UnknownSmartMethod('BzrDir.find_repository{3,2,}')
184
390
        if response[0] != 'ok':
185
391
            raise errors.UnexpectedSmartServerResponse(response)
186
 
        if verb == 'BzrDir.find_repository':
187
 
            # servers that don't support the V2 method don't support external
188
 
            # references either.
189
 
            response = response + ('no', )
190
 
        if not (len(response) == 5):
 
392
        if len(response) != 6:
191
393
            raise SmartProtocolError('incorrect response length %s' % (response,))
192
394
        if response[1] == '':
193
 
            format = RemoteRepositoryFormat()
194
 
            format.rich_root_data = (response[2] == 'yes')
195
 
            format.supports_tree_reference = (response[3] == 'yes')
196
 
            # No wire format to check this yet.
197
 
            format.supports_external_lookups = (response[4] == 'yes')
 
395
            # repo is at this dir.
 
396
            format = response_tuple_to_repo_format(response[2:])
198
397
            # Used to support creating a real format instance when needed.
199
398
            format._creating_bzrdir = self
200
 
            return RemoteRepository(self, format)
 
399
            remote_repo = RemoteRepository(self, format)
 
400
            format._creating_repo = remote_repo
 
401
            if real_repo is not None:
 
402
                remote_repo._set_real_repository(real_repo)
 
403
            return remote_repo
201
404
        else:
202
405
            raise errors.NoRepositoryPresent(self)
203
406
 
 
407
    def has_workingtree(self):
 
408
        if self._has_working_tree is None:
 
409
            self._ensure_real()
 
410
            self._has_working_tree = self._real_bzrdir.has_workingtree()
 
411
        return self._has_working_tree
 
412
 
204
413
    def open_workingtree(self, recommend_upgrade=True):
205
 
        self._ensure_real()
206
 
        if self._real_bzrdir.has_workingtree():
 
414
        if self.has_workingtree():
207
415
            raise errors.NotLocalUrl(self.root_transport)
208
416
        else:
209
417
            raise errors.NoWorkingTree(self.root_transport.base)
241
449
        return self._real_bzrdir.clone(url, revision_id=revision_id,
242
450
            force_new_repo=force_new_repo, preserve_stacking=preserve_stacking)
243
451
 
244
 
    def get_config(self):
245
 
        self._ensure_real()
246
 
        return self._real_bzrdir.get_config()
 
452
    def _get_config(self):
 
453
        return RemoteBzrDirConfig(self)
247
454
 
248
455
 
249
456
class RemoteRepositoryFormat(repository.RepositoryFormat):
257
464
    the attributes rich_root_data and supports_tree_reference are set
258
465
    on a per instance basis, and are not set (and should not be) at
259
466
    the class level.
 
467
 
 
468
    :ivar _custom_format: If set, a specific concrete repository format that
 
469
        will be used when initializing a repository with this
 
470
        RemoteRepositoryFormat.
 
471
    :ivar _creating_repo: If set, the repository object that this
 
472
        RemoteRepositoryFormat was created for: it can be called into
 
473
        to obtain data like the network name.
260
474
    """
261
475
 
262
476
    _matchingbzrdir = RemoteBzrDirFormat()
263
477
 
264
 
    def initialize(self, a_bzrdir, shared=False):
265
 
        if not isinstance(a_bzrdir, RemoteBzrDir):
 
478
    def __init__(self):
 
479
        repository.RepositoryFormat.__init__(self)
 
480
        self._custom_format = None
 
481
        self._network_name = None
 
482
        self._creating_bzrdir = None
 
483
        self._supports_chks = None
 
484
        self._supports_external_lookups = None
 
485
        self._supports_tree_reference = None
 
486
        self._rich_root_data = None
 
487
 
 
488
    def __repr__(self):
 
489
        return "%s(_network_name=%r)" % (self.__class__.__name__,
 
490
            self._network_name)
 
491
 
 
492
    @property
 
493
    def fast_deltas(self):
 
494
        self._ensure_real()
 
495
        return self._custom_format.fast_deltas
 
496
 
 
497
    @property
 
498
    def rich_root_data(self):
 
499
        if self._rich_root_data is None:
 
500
            self._ensure_real()
 
501
            self._rich_root_data = self._custom_format.rich_root_data
 
502
        return self._rich_root_data
 
503
 
 
504
    @property
 
505
    def supports_chks(self):
 
506
        if self._supports_chks is None:
 
507
            self._ensure_real()
 
508
            self._supports_chks = self._custom_format.supports_chks
 
509
        return self._supports_chks
 
510
 
 
511
    @property
 
512
    def supports_external_lookups(self):
 
513
        if self._supports_external_lookups is None:
 
514
            self._ensure_real()
 
515
            self._supports_external_lookups = \
 
516
                self._custom_format.supports_external_lookups
 
517
        return self._supports_external_lookups
 
518
 
 
519
    @property
 
520
    def supports_tree_reference(self):
 
521
        if self._supports_tree_reference is None:
 
522
            self._ensure_real()
 
523
            self._supports_tree_reference = \
 
524
                self._custom_format.supports_tree_reference
 
525
        return self._supports_tree_reference
 
526
 
 
527
    def _vfs_initialize(self, a_bzrdir, shared):
 
528
        """Helper for common code in initialize."""
 
529
        if self._custom_format:
 
530
            # Custom format requested
 
531
            result = self._custom_format.initialize(a_bzrdir, shared=shared)
 
532
        elif self._creating_bzrdir is not None:
 
533
            # Use the format that the repository we were created to back
 
534
            # has.
266
535
            prior_repo = self._creating_bzrdir.open_repository()
267
536
            prior_repo._ensure_real()
268
 
            return prior_repo._real_repository._format.initialize(
 
537
            result = prior_repo._real_repository._format.initialize(
269
538
                a_bzrdir, shared=shared)
270
 
        return a_bzrdir.create_repository(shared=shared)
271
 
    
 
539
        else:
 
540
            # assume that a_bzr is a RemoteBzrDir but the smart server didn't
 
541
            # support remote initialization.
 
542
            # We delegate to a real object at this point (as RemoteBzrDir
 
543
            # delegate to the repository format which would lead to infinite
 
544
            # recursion if we just called a_bzrdir.create_repository.
 
545
            a_bzrdir._ensure_real()
 
546
            result = a_bzrdir._real_bzrdir.create_repository(shared=shared)
 
547
        if not isinstance(result, RemoteRepository):
 
548
            return self.open(a_bzrdir)
 
549
        else:
 
550
            return result
 
551
 
 
552
    def initialize(self, a_bzrdir, shared=False):
 
553
        # Being asked to create on a non RemoteBzrDir:
 
554
        if not isinstance(a_bzrdir, RemoteBzrDir):
 
555
            return self._vfs_initialize(a_bzrdir, shared)
 
556
        medium = a_bzrdir._client._medium
 
557
        if medium._is_remote_before((1, 13)):
 
558
            return self._vfs_initialize(a_bzrdir, shared)
 
559
        # Creating on a remote bzr dir.
 
560
        # 1) get the network name to use.
 
561
        if self._custom_format:
 
562
            network_name = self._custom_format.network_name()
 
563
        elif self._network_name:
 
564
            network_name = self._network_name
 
565
        else:
 
566
            # Select the current bzrlib default and ask for that.
 
567
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
 
568
            reference_format = reference_bzrdir_format.repository_format
 
569
            network_name = reference_format.network_name()
 
570
        # 2) try direct creation via RPC
 
571
        path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
 
572
        verb = 'BzrDir.create_repository'
 
573
        if shared:
 
574
            shared_str = 'True'
 
575
        else:
 
576
            shared_str = 'False'
 
577
        try:
 
578
            response = a_bzrdir._call(verb, path, network_name, shared_str)
 
579
        except errors.UnknownSmartMethod:
 
580
            # Fallback - use vfs methods
 
581
            medium._remember_remote_is_before((1, 13))
 
582
            return self._vfs_initialize(a_bzrdir, shared)
 
583
        else:
 
584
            # Turn the response into a RemoteRepository object.
 
585
            format = response_tuple_to_repo_format(response[1:])
 
586
            # Used to support creating a real format instance when needed.
 
587
            format._creating_bzrdir = a_bzrdir
 
588
            remote_repo = RemoteRepository(a_bzrdir, format)
 
589
            format._creating_repo = remote_repo
 
590
            return remote_repo
 
591
 
272
592
    def open(self, a_bzrdir):
273
593
        if not isinstance(a_bzrdir, RemoteBzrDir):
274
594
            raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
275
595
        return a_bzrdir.open_repository()
276
596
 
 
597
    def _ensure_real(self):
 
598
        if self._custom_format is None:
 
599
            self._custom_format = repository.network_format_registry.get(
 
600
                self._network_name)
 
601
 
 
602
    @property
 
603
    def _fetch_order(self):
 
604
        self._ensure_real()
 
605
        return self._custom_format._fetch_order
 
606
 
 
607
    @property
 
608
    def _fetch_uses_deltas(self):
 
609
        self._ensure_real()
 
610
        return self._custom_format._fetch_uses_deltas
 
611
 
 
612
    @property
 
613
    def _fetch_reconcile(self):
 
614
        self._ensure_real()
 
615
        return self._custom_format._fetch_reconcile
 
616
 
277
617
    def get_format_description(self):
278
 
        return 'bzr remote repository'
 
618
        self._ensure_real()
 
619
        return 'Remote: ' + self._custom_format.get_format_description()
279
620
 
280
621
    def __eq__(self, other):
281
 
        return self.__class__ == other.__class__
282
 
 
283
 
    def check_conversion_target(self, target_format):
284
 
        if self.rich_root_data and not target_format.rich_root_data:
285
 
            raise errors.BadConversionTarget(
286
 
                'Does not support rich root data.', target_format)
287
 
        if (self.supports_tree_reference and
288
 
            not getattr(target_format, 'supports_tree_reference', False)):
289
 
            raise errors.BadConversionTarget(
290
 
                'Does not support nested trees', target_format)
291
 
 
292
 
 
293
 
class RemoteRepository(_RpcHelper):
 
622
        return self.__class__ is other.__class__
 
623
 
 
624
    def network_name(self):
 
625
        if self._network_name:
 
626
            return self._network_name
 
627
        self._creating_repo._ensure_real()
 
628
        return self._creating_repo._real_repository._format.network_name()
 
629
 
 
630
    @property
 
631
    def pack_compresses(self):
 
632
        self._ensure_real()
 
633
        return self._custom_format.pack_compresses
 
634
 
 
635
    @property
 
636
    def _serializer(self):
 
637
        self._ensure_real()
 
638
        return self._custom_format._serializer
 
639
 
 
640
 
 
641
class RemoteRepository(_RpcHelper, lock._RelockDebugMixin):
294
642
    """Repository accessed over rpc.
295
643
 
296
644
    For the moment most operations are performed using local transport-backed
299
647
 
300
648
    def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
301
649
        """Create a RemoteRepository instance.
302
 
        
 
650
 
303
651
        :param remote_bzrdir: The bzrdir hosting this repository.
304
652
        :param format: The RemoteFormat object to use.
305
653
        :param real_repository: If not None, a local implementation of the
322
670
        self._lock_token = None
323
671
        self._lock_count = 0
324
672
        self._leave_lock = False
 
673
        # Cache of revision parents; misses are cached during read locks, and
 
674
        # write locks when no _real_repository has been set.
325
675
        self._unstacked_provider = graph.CachingParentsProvider(
326
676
            get_parent_map=self._get_parent_map_rpc)
327
677
        self._unstacked_provider.disable_cache()
344
694
 
345
695
    def abort_write_group(self, suppress_errors=False):
346
696
        """Complete a write group on the decorated repository.
347
 
        
348
 
        Smart methods peform operations in a single step so this api
 
697
 
 
698
        Smart methods perform operations in a single step so this API
349
699
        is not really applicable except as a compatibility thunk
350
700
        for older plugins that don't use e.g. the CommitBuilder
351
701
        facility.
356
706
        return self._real_repository.abort_write_group(
357
707
            suppress_errors=suppress_errors)
358
708
 
 
709
    @property
 
710
    def chk_bytes(self):
 
711
        """Decorate the real repository for now.
 
712
 
 
713
        In the long term a full blown network facility is needed to avoid
 
714
        creating a real repository object locally.
 
715
        """
 
716
        self._ensure_real()
 
717
        return self._real_repository.chk_bytes
 
718
 
359
719
    def commit_write_group(self):
360
720
        """Complete a write group on the decorated repository.
361
 
        
362
 
        Smart methods peform operations in a single step so this api
 
721
 
 
722
        Smart methods perform operations in a single step so this API
363
723
        is not really applicable except as a compatibility thunk
364
724
        for older plugins that don't use e.g. the CommitBuilder
365
725
        facility.
367
727
        self._ensure_real()
368
728
        return self._real_repository.commit_write_group()
369
729
 
 
730
    def resume_write_group(self, tokens):
 
731
        self._ensure_real()
 
732
        return self._real_repository.resume_write_group(tokens)
 
733
 
 
734
    def suspend_write_group(self):
 
735
        self._ensure_real()
 
736
        return self._real_repository.suspend_write_group()
 
737
 
 
738
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
 
739
        self._ensure_real()
 
740
        return self._real_repository.get_missing_parent_inventories(
 
741
            check_for_missing_texts=check_for_missing_texts)
 
742
 
 
743
    def _get_rev_id_for_revno_vfs(self, revno, known_pair):
 
744
        self._ensure_real()
 
745
        return self._real_repository.get_rev_id_for_revno(
 
746
            revno, known_pair)
 
747
 
 
748
    def get_rev_id_for_revno(self, revno, known_pair):
 
749
        """See Repository.get_rev_id_for_revno."""
 
750
        path = self.bzrdir._path_for_remote_call(self._client)
 
751
        try:
 
752
            if self._client._medium._is_remote_before((1, 17)):
 
753
                return self._get_rev_id_for_revno_vfs(revno, known_pair)
 
754
            response = self._call(
 
755
                'Repository.get_rev_id_for_revno', path, revno, known_pair)
 
756
        except errors.UnknownSmartMethod:
 
757
            self._client._medium._remember_remote_is_before((1, 17))
 
758
            return self._get_rev_id_for_revno_vfs(revno, known_pair)
 
759
        if response[0] == 'ok':
 
760
            return True, response[1]
 
761
        elif response[0] == 'history-incomplete':
 
762
            known_pair = response[1:3]
 
763
            for fallback in self._fallback_repositories:
 
764
                found, result = fallback.get_rev_id_for_revno(revno, known_pair)
 
765
                if found:
 
766
                    return True, result
 
767
                else:
 
768
                    known_pair = result
 
769
            # Not found in any fallbacks
 
770
            return False, known_pair
 
771
        else:
 
772
            raise errors.UnexpectedSmartServerResponse(response)
 
773
 
370
774
    def _ensure_real(self):
371
775
        """Ensure that there is a _real_repository set.
372
776
 
373
777
        Used before calls to self._real_repository.
 
778
 
 
779
        Note that _ensure_real causes many roundtrips to the server which are
 
780
        not desirable, and prevents the use of smart one-roundtrip RPC's to
 
781
        perform complex operations (such as accessing parent data, streaming
 
782
        revisions etc). Adding calls to _ensure_real should only be done when
 
783
        bringing up new functionality, adding fallbacks for smart methods that
 
784
        require a fallback path, and never to replace an existing smart method
 
785
        invocation. If in doubt chat to the bzr network team.
374
786
        """
375
787
        if self._real_repository is None:
 
788
            if 'hpssvfs' in debug.debug_flags:
 
789
                import traceback
 
790
                warning('VFS Repository access triggered\n%s',
 
791
                    ''.join(traceback.format_stack()))
 
792
            self._unstacked_provider.missing_keys.clear()
376
793
            self.bzrdir._ensure_real()
377
794
            self._set_real_repository(
378
795
                self.bzrdir._real_bzrdir.open_repository())
405
822
        self._ensure_real()
406
823
        return self._real_repository._generate_text_key_index()
407
824
 
408
 
    @symbol_versioning.deprecated_method(symbol_versioning.one_four)
409
 
    def get_revision_graph(self, revision_id=None):
410
 
        """See Repository.get_revision_graph()."""
411
 
        return self._get_revision_graph(revision_id)
412
 
 
413
825
    def _get_revision_graph(self, revision_id):
414
826
        """Private method for using with old (< 1.2) servers to fallback."""
415
827
        if revision_id is None:
432
844
        for line in lines:
433
845
            d = tuple(line.split())
434
846
            revision_graph[d[0]] = d[1:]
435
 
            
 
847
 
436
848
        return revision_graph
437
849
 
 
850
    def _get_sink(self):
 
851
        """See Repository._get_sink()."""
 
852
        return RemoteStreamSink(self)
 
853
 
 
854
    def _get_source(self, to_format):
 
855
        """Return a source for streaming from this repository."""
 
856
        return RemoteStreamSource(self, to_format)
 
857
 
 
858
    @needs_read_lock
438
859
    def has_revision(self, revision_id):
439
 
        """See Repository.has_revision()."""
440
 
        if revision_id == NULL_REVISION:
441
 
            # The null revision is always present.
442
 
            return True
443
 
        path = self.bzrdir._path_for_remote_call(self._client)
444
 
        response = self._call('Repository.has_revision', path, revision_id)
445
 
        if response[0] not in ('yes', 'no'):
446
 
            raise errors.UnexpectedSmartServerResponse(response)
447
 
        if response[0] == 'yes':
448
 
            return True
449
 
        for fallback_repo in self._fallback_repositories:
450
 
            if fallback_repo.has_revision(revision_id):
451
 
                return True
452
 
        return False
 
860
        """True if this repository has a copy of the revision."""
 
861
        # Copy of bzrlib.repository.Repository.has_revision
 
862
        return revision_id in self.has_revisions((revision_id,))
453
863
 
 
864
    @needs_read_lock
454
865
    def has_revisions(self, revision_ids):
455
 
        """See Repository.has_revisions()."""
456
 
        # FIXME: This does many roundtrips, particularly when there are
457
 
        # fallback repositories.  -- mbp 20080905
458
 
        result = set()
459
 
        for revision_id in revision_ids:
460
 
            if self.has_revision(revision_id):
461
 
                result.add(revision_id)
 
866
        """Probe to find out the presence of multiple revisions.
 
867
 
 
868
        :param revision_ids: An iterable of revision_ids.
 
869
        :return: A set of the revision_ids that were present.
 
870
        """
 
871
        # Copy of bzrlib.repository.Repository.has_revisions
 
872
        parent_map = self.get_parent_map(revision_ids)
 
873
        result = set(parent_map)
 
874
        if _mod_revision.NULL_REVISION in revision_ids:
 
875
            result.add(_mod_revision.NULL_REVISION)
462
876
        return result
463
877
 
 
878
    def _has_same_fallbacks(self, other_repo):
 
879
        """Returns true if the repositories have the same fallbacks."""
 
880
        # XXX: copied from Repository; it should be unified into a base class
 
881
        # <https://bugs.edge.launchpad.net/bzr/+bug/401622>
 
882
        my_fb = self._fallback_repositories
 
883
        other_fb = other_repo._fallback_repositories
 
884
        if len(my_fb) != len(other_fb):
 
885
            return False
 
886
        for f, g in zip(my_fb, other_fb):
 
887
            if not f.has_same_location(g):
 
888
                return False
 
889
        return True
 
890
 
464
891
    def has_same_location(self, other):
465
 
        return (self.__class__ == other.__class__ and
 
892
        # TODO: Move to RepositoryBase and unify with the regular Repository
 
893
        # one; unfortunately the tests rely on slightly different behaviour at
 
894
        # present -- mbp 20090710
 
895
        return (self.__class__ is other.__class__ and
466
896
                self.bzrdir.transport.base == other.bzrdir.transport.base)
467
897
 
468
898
    def get_graph(self, other_repository=None):
535
965
    def is_write_locked(self):
536
966
        return self._lock_mode == 'w'
537
967
 
 
968
    def _warn_if_deprecated(self, branch=None):
 
969
        # If we have a real repository, the check will be done there, if we
 
970
        # don't the check will be done remotely.
 
971
        pass
 
972
 
538
973
    def lock_read(self):
539
974
        # wrong eventually - want a local lock cache context
540
975
        if not self._lock_mode:
 
976
            self._note_lock('r')
541
977
            self._lock_mode = 'r'
542
978
            self._lock_count = 1
543
 
            self._unstacked_provider.enable_cache(cache_misses=False)
 
979
            self._unstacked_provider.enable_cache(cache_misses=True)
544
980
            if self._real_repository is not None:
545
981
                self._real_repository.lock_read()
 
982
            for repo in self._fallback_repositories:
 
983
                repo.lock_read()
546
984
        else:
547
985
            self._lock_count += 1
548
986
 
561
999
 
562
1000
    def lock_write(self, token=None, _skip_rpc=False):
563
1001
        if not self._lock_mode:
 
1002
            self._note_lock('w')
564
1003
            if _skip_rpc:
565
1004
                if self._lock_token is not None:
566
1005
                    if token != self._lock_token:
580
1019
                self._leave_lock = False
581
1020
            self._lock_mode = 'w'
582
1021
            self._lock_count = 1
583
 
            self._unstacked_provider.enable_cache(cache_misses=False)
 
1022
            cache_misses = self._real_repository is None
 
1023
            self._unstacked_provider.enable_cache(cache_misses=cache_misses)
 
1024
            for repo in self._fallback_repositories:
 
1025
                # Writes don't affect fallback repos
 
1026
                repo.lock_read()
584
1027
        elif self._lock_mode == 'r':
585
1028
            raise errors.ReadOnlyError(self)
586
1029
        else:
604
1047
            implemented operations.
605
1048
        """
606
1049
        if self._real_repository is not None:
607
 
            raise AssertionError('_real_repository is already set')
 
1050
            # Replacing an already set real repository.
 
1051
            # We cannot do this [currently] if the repository is locked -
 
1052
            # synchronised state might be lost.
 
1053
            if self.is_locked():
 
1054
                raise AssertionError('_real_repository is already set')
608
1055
        if isinstance(repository, RemoteRepository):
609
1056
            raise AssertionError()
610
1057
        self._real_repository = repository
 
1058
        # three code paths happen here:
 
1059
        # 1) old servers, RemoteBranch.open() calls _ensure_real before setting
 
1060
        # up stacking. In this case self._fallback_repositories is [], and the
 
1061
        # real repo is already setup. Preserve the real repo and
 
1062
        # RemoteRepository.add_fallback_repository will avoid adding
 
1063
        # duplicates.
 
1064
        # 2) new servers, RemoteBranch.open() sets up stacking, and when
 
1065
        # ensure_real is triggered from a branch, the real repository to
 
1066
        # set already has a matching list with separate instances, but
 
1067
        # as they are also RemoteRepositories we don't worry about making the
 
1068
        # lists be identical.
 
1069
        # 3) new servers, RemoteRepository.ensure_real is triggered before
 
1070
        # RemoteBranch.ensure real, in this case we get a repo with no fallbacks
 
1071
        # and need to populate it.
 
1072
        if (self._fallback_repositories and
 
1073
            len(self._real_repository._fallback_repositories) !=
 
1074
            len(self._fallback_repositories)):
 
1075
            if len(self._real_repository._fallback_repositories):
 
1076
                raise AssertionError(
 
1077
                    "cannot cleanly remove existing _fallback_repositories")
611
1078
        for fb in self._fallback_repositories:
612
1079
            self._real_repository.add_fallback_repository(fb)
613
1080
        if self._lock_mode == 'w':
619
1086
 
620
1087
    def start_write_group(self):
621
1088
        """Start a write group on the decorated repository.
622
 
        
623
 
        Smart methods peform operations in a single step so this api
 
1089
 
 
1090
        Smart methods perform operations in a single step so this API
624
1091
        is not really applicable except as a compatibility thunk
625
1092
        for older plugins that don't use e.g. the CommitBuilder
626
1093
        facility.
641
1108
        else:
642
1109
            raise errors.UnexpectedSmartServerResponse(response)
643
1110
 
 
1111
    @only_raises(errors.LockNotHeld, errors.LockBroken)
644
1112
    def unlock(self):
 
1113
        if not self._lock_count:
 
1114
            return lock.cant_unlock_not_held(self)
645
1115
        self._lock_count -= 1
646
1116
        if self._lock_count > 0:
647
1117
            return
661
1131
            # problem releasing the vfs-based lock.
662
1132
            if old_mode == 'w':
663
1133
                # Only write-locked repositories need to make a remote method
664
 
                # call to perfom the unlock.
 
1134
                # call to perform the unlock.
665
1135
                old_token = self._lock_token
666
1136
                self._lock_token = None
667
1137
                if not self._leave_lock:
668
1138
                    self._unlock(old_token)
 
1139
        # Fallbacks are always 'lock_read()' so we don't pay attention to
 
1140
        # self._leave_lock
 
1141
        for repo in self._fallback_repositories:
 
1142
            repo.unlock()
669
1143
 
670
1144
    def break_lock(self):
671
1145
        # should hand off to the network
674
1148
 
675
1149
    def _get_tarball(self, compression):
676
1150
        """Return a TemporaryFile containing a repository tarball.
677
 
        
 
1151
 
678
1152
        Returns None if the server does not support sending tarballs.
679
1153
        """
680
1154
        import tempfile
726
1200
 
727
1201
    def add_fallback_repository(self, repository):
728
1202
        """Add a repository to use for looking up data not held locally.
729
 
        
 
1203
 
730
1204
        :param repository: A repository.
731
1205
        """
732
 
        # XXX: At the moment the RemoteRepository will allow fallbacks
733
 
        # unconditionally - however, a _real_repository will usually exist,
734
 
        # and may raise an error if it's not accommodated by the underlying
735
 
        # format.  Eventually we should check when opening the repository
736
 
        # whether it's willing to allow them or not.
737
 
        #
 
1206
        if not self._format.supports_external_lookups:
 
1207
            raise errors.UnstackableRepositoryFormat(
 
1208
                self._format.network_name(), self.base)
738
1209
        # We need to accumulate additional repositories here, to pass them in
739
1210
        # on various RPC's.
 
1211
        #
 
1212
        if self.is_locked():
 
1213
            # We will call fallback.unlock() when we transition to the unlocked
 
1214
            # state, so always add a lock here. If a caller passes us a locked
 
1215
            # repository, they are responsible for unlocking it later.
 
1216
            repository.lock_read()
740
1217
        self._fallback_repositories.append(repository)
741
 
        # They are also seen by the fallback repository.  If it doesn't exist
742
 
        # yet they'll be added then.  This implicitly copies them.
743
 
        self._ensure_real()
 
1218
        # If self._real_repository was parameterised already (e.g. because a
 
1219
        # _real_branch had its get_stacked_on_url method called), then the
 
1220
        # repository to be added may already be in the _real_repositories list.
 
1221
        if self._real_repository is not None:
 
1222
            fallback_locations = [repo.bzrdir.root_transport.base for repo in
 
1223
                self._real_repository._fallback_repositories]
 
1224
            if repository.bzrdir.root_transport.base not in fallback_locations:
 
1225
                self._real_repository.add_fallback_repository(repository)
744
1226
 
745
1227
    def add_inventory(self, revid, inv, parents):
746
1228
        self._ensure_real()
762
1244
        self._ensure_real()
763
1245
        return self._real_repository.get_inventory(revision_id)
764
1246
 
765
 
    def iter_inventories(self, revision_ids):
 
1247
    def iter_inventories(self, revision_ids, ordering=None):
766
1248
        self._ensure_real()
767
 
        return self._real_repository.iter_inventories(revision_ids)
 
1249
        return self._real_repository.iter_inventories(revision_ids, ordering)
768
1250
 
769
1251
    @needs_read_lock
770
1252
    def get_revision(self, revision_id):
785
1267
        self._ensure_real()
786
1268
        return self._real_repository.make_working_trees()
787
1269
 
 
1270
    def refresh_data(self):
 
1271
        """Re-read any data needed to to synchronise with disk.
 
1272
 
 
1273
        This method is intended to be called after another repository instance
 
1274
        (such as one used by a smart server) has inserted data into the
 
1275
        repository. It may not be called during a write group, but may be
 
1276
        called at any other time.
 
1277
        """
 
1278
        if self.is_in_write_group():
 
1279
            raise errors.InternalBzrError(
 
1280
                "May not refresh_data while in a write group.")
 
1281
        if self._real_repository is not None:
 
1282
            self._real_repository.refresh_data()
 
1283
 
788
1284
    def revision_ids_to_search_result(self, result_set):
789
1285
        """Convert a set of revision ids to a graph SearchResult."""
790
1286
        result_parents = set()
801
1297
    @needs_read_lock
802
1298
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
803
1299
        """Return the revision ids that other has that this does not.
804
 
        
 
1300
 
805
1301
        These are returned in topological order.
806
1302
 
807
1303
        revision_id: only return revision ids included by revision_id.
809
1305
        return repository.InterRepository.get(
810
1306
            other, self).search_missing_revision_ids(revision_id, find_ghosts)
811
1307
 
812
 
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False):
813
 
        # Not delegated to _real_repository so that InterRepository.get has a
814
 
        # chance to find an InterRepository specialised for RemoteRepository.
815
 
        if self.has_same_location(source):
 
1308
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
 
1309
            fetch_spec=None):
 
1310
        # No base implementation to use as RemoteRepository is not a subclass
 
1311
        # of Repository; so this is a copy of Repository.fetch().
 
1312
        if fetch_spec is not None and revision_id is not None:
 
1313
            raise AssertionError(
 
1314
                "fetch_spec and revision_id are mutually exclusive.")
 
1315
        if self.is_in_write_group():
 
1316
            raise errors.InternalBzrError(
 
1317
                "May not fetch while in a write group.")
 
1318
        # fast path same-url fetch operations
 
1319
        if (self.has_same_location(source)
 
1320
            and fetch_spec is None
 
1321
            and self._has_same_fallbacks(source)):
816
1322
            # check that last_revision is in 'from' and then return a
817
1323
            # no-operation.
818
1324
            if (revision_id is not None and
819
1325
                not revision.is_null(revision_id)):
820
1326
                self.get_revision(revision_id)
821
1327
            return 0, []
 
1328
        # if there is no specific appropriate InterRepository, this will get
 
1329
        # the InterRepository base class, which raises an
 
1330
        # IncompatibleRepositories when asked to fetch.
822
1331
        inter = repository.InterRepository.get(source, self)
823
 
        try:
824
 
            return inter.fetch(revision_id=revision_id, pb=pb, find_ghosts=find_ghosts)
825
 
        except NotImplementedError:
826
 
            raise errors.IncompatibleRepositories(source, self)
 
1332
        return inter.fetch(revision_id=revision_id, pb=pb,
 
1333
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
827
1334
 
828
1335
    def create_bundle(self, target, base, fileobj, format=None):
829
1336
        self._ensure_real()
842
1349
        self._ensure_real()
843
1350
        return self._real_repository._get_versioned_file_checker(
844
1351
            revisions, revision_versions_cache)
845
 
        
 
1352
 
846
1353
    def iter_files_bytes(self, desired_files):
847
1354
        """See Repository.iter_file_bytes.
848
1355
        """
849
1356
        self._ensure_real()
850
1357
        return self._real_repository.iter_files_bytes(desired_files)
851
1358
 
852
 
    @property
853
 
    def _fetch_order(self):
854
 
        """Decorate the real repository for now.
855
 
 
856
 
        In the long term getting this back from the remote repository as part
857
 
        of open would be more efficient.
858
 
        """
859
 
        self._ensure_real()
860
 
        return self._real_repository._fetch_order
861
 
 
862
 
    @property
863
 
    def _fetch_uses_deltas(self):
864
 
        """Decorate the real repository for now.
865
 
 
866
 
        In the long term getting this back from the remote repository as part
867
 
        of open would be more efficient.
868
 
        """
869
 
        self._ensure_real()
870
 
        return self._real_repository._fetch_uses_deltas
871
 
 
872
 
    @property
873
 
    def _fetch_reconcile(self):
874
 
        """Decorate the real repository for now.
875
 
 
876
 
        In the long term getting this back from the remote repository as part
877
 
        of open would be more efficient.
878
 
        """
879
 
        self._ensure_real()
880
 
        return self._real_repository._fetch_reconcile
881
 
 
882
1359
    def get_parent_map(self, revision_ids):
883
1360
        """See bzrlib.Graph.get_parent_map()."""
884
1361
        return self._make_parents_provider().get_parent_map(revision_ids)
890
1367
            # We already found out that the server can't understand
891
1368
            # Repository.get_parent_map requests, so just fetch the whole
892
1369
            # graph.
893
 
            # XXX: Note that this will issue a deprecation warning. This is ok
894
 
            # :- its because we're working with a deprecated server anyway, and
895
 
            # the user will almost certainly have seen a warning about the
896
 
            # server version already.
897
 
            rg = self.get_revision_graph()
898
 
            # There is an api discrepency between get_parent_map and
 
1370
            #
 
1371
            # Note that this reads the whole graph, when only some keys are
 
1372
            # wanted.  On this old server there's no way (?) to get them all
 
1373
            # in one go, and the user probably will have seen a warning about
 
1374
            # the server being old anyhow.
 
1375
            rg = self._get_revision_graph(None)
 
1376
            # There is an API discrepancy between get_parent_map and
899
1377
            # get_revision_graph. Specifically, a "key:()" pair in
900
1378
            # get_revision_graph just means a node has no parents. For
901
1379
            # "get_parent_map" it means the node is a ghost. So fix up the
931
1409
        # TODO: Manage this incrementally to avoid covering the same path
932
1410
        # repeatedly. (The server will have to on each request, but the less
933
1411
        # work done the better).
 
1412
        #
 
1413
        # Negative caching notes:
 
1414
        # new server sends missing when a request including the revid
 
1415
        # 'include-missing:' is present in the request.
 
1416
        # missing keys are serialised as missing:X, and we then call
 
1417
        # provider.note_missing(X) for-all X
934
1418
        parents_map = self._unstacked_provider.get_cached_map()
935
1419
        if parents_map is None:
936
1420
            # Repository is not locked, so there's no cache.
937
1421
            parents_map = {}
 
1422
        # start_set is all the keys in the cache
938
1423
        start_set = set(parents_map)
 
1424
        # result set is all the references to keys in the cache
939
1425
        result_parents = set()
940
1426
        for parents in parents_map.itervalues():
941
1427
            result_parents.update(parents)
942
1428
        stop_keys = result_parents.difference(start_set)
 
1429
        # We don't need to send ghosts back to the server as a position to
 
1430
        # stop either.
 
1431
        stop_keys.difference_update(self._unstacked_provider.missing_keys)
 
1432
        key_count = len(parents_map)
 
1433
        if (NULL_REVISION in result_parents
 
1434
            and NULL_REVISION in self._unstacked_provider.missing_keys):
 
1435
            # If we pruned NULL_REVISION from the stop_keys because it's also
 
1436
            # in our cache of "missing" keys we need to increment our key count
 
1437
            # by 1, because the reconsitituted SearchResult on the server will
 
1438
            # still consider NULL_REVISION to be an included key.
 
1439
            key_count += 1
943
1440
        included_keys = start_set.intersection(result_parents)
944
1441
        start_set.difference_update(included_keys)
945
 
        recipe = (start_set, stop_keys, len(parents_map))
 
1442
        recipe = ('manual', start_set, stop_keys, key_count)
946
1443
        body = self._serialise_search_recipe(recipe)
947
1444
        path = self.bzrdir._path_for_remote_call(self._client)
948
1445
        for key in keys:
950
1447
                raise ValueError(
951
1448
                    "key %r not a plain string" % (key,))
952
1449
        verb = 'Repository.get_parent_map'
953
 
        args = (path,) + tuple(keys)
 
1450
        args = (path, 'include-missing:') + tuple(keys)
954
1451
        try:
955
1452
            response = self._call_with_body_bytes_expecting_body(
956
1453
                verb, args, body)
966
1463
            # To avoid having to disconnect repeatedly, we keep track of the
967
1464
            # fact the server doesn't understand remote methods added in 1.2.
968
1465
            medium._remember_remote_is_before((1, 2))
969
 
            return self.get_revision_graph(None)
 
1466
            # Recurse just once and we should use the fallback code.
 
1467
            return self._get_parent_map_rpc(keys)
970
1468
        response_tuple, response_handler = response
971
1469
        if response_tuple[0] not in ['ok']:
972
1470
            response_handler.cancel_read_body()
983
1481
                if len(d) > 1:
984
1482
                    revision_graph[d[0]] = d[1:]
985
1483
                else:
986
 
                    # No parents - so give the Graph result (NULL_REVISION,).
987
 
                    revision_graph[d[0]] = (NULL_REVISION,)
 
1484
                    # No parents:
 
1485
                    if d[0].startswith('missing:'):
 
1486
                        revid = d[0][8:]
 
1487
                        self._unstacked_provider.note_missing_key(revid)
 
1488
                    else:
 
1489
                        # no parents - so give the Graph result
 
1490
                        # (NULL_REVISION,).
 
1491
                        revision_graph[d[0]] = (NULL_REVISION,)
988
1492
            return revision_graph
989
1493
 
990
1494
    @needs_read_lock
993
1497
        return self._real_repository.get_signature_text(revision_id)
994
1498
 
995
1499
    @needs_read_lock
996
 
    @symbol_versioning.deprecated_method(symbol_versioning.one_three)
997
 
    def get_revision_graph_with_ghosts(self, revision_ids=None):
998
 
        self._ensure_real()
999
 
        return self._real_repository.get_revision_graph_with_ghosts(
1000
 
            revision_ids=revision_ids)
1001
 
 
1002
 
    @needs_read_lock
1003
1500
    def get_inventory_xml(self, revision_id):
1004
1501
        self._ensure_real()
1005
1502
        return self._real_repository.get_inventory_xml(revision_id)
1011
1508
    def reconcile(self, other=None, thorough=False):
1012
1509
        self._ensure_real()
1013
1510
        return self._real_repository.reconcile(other=other, thorough=thorough)
1014
 
        
 
1511
 
1015
1512
    def all_revision_ids(self):
1016
1513
        self._ensure_real()
1017
1514
        return self._real_repository.all_revision_ids()
1018
 
    
1019
 
    @needs_read_lock
1020
 
    def get_deltas_for_revisions(self, revisions):
1021
 
        self._ensure_real()
1022
 
        return self._real_repository.get_deltas_for_revisions(revisions)
1023
 
 
1024
 
    @needs_read_lock
1025
 
    def get_revision_delta(self, revision_id):
1026
 
        self._ensure_real()
1027
 
        return self._real_repository.get_revision_delta(revision_id)
 
1515
 
 
1516
    @needs_read_lock
 
1517
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
 
1518
        self._ensure_real()
 
1519
        return self._real_repository.get_deltas_for_revisions(revisions,
 
1520
            specific_fileids=specific_fileids)
 
1521
 
 
1522
    @needs_read_lock
 
1523
    def get_revision_delta(self, revision_id, specific_fileids=None):
 
1524
        self._ensure_real()
 
1525
        return self._real_repository.get_revision_delta(revision_id,
 
1526
            specific_fileids=specific_fileids)
1028
1527
 
1029
1528
    @needs_read_lock
1030
1529
    def revision_trees(self, revision_ids):
1037
1536
        return self._real_repository.get_revision_reconcile(revision_id)
1038
1537
 
1039
1538
    @needs_read_lock
1040
 
    def check(self, revision_ids=None):
 
1539
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
1041
1540
        self._ensure_real()
1042
 
        return self._real_repository.check(revision_ids=revision_ids)
 
1541
        return self._real_repository.check(revision_ids=revision_ids,
 
1542
            callback_refs=callback_refs, check_repo=check_repo)
1043
1543
 
1044
1544
    def copy_content_into(self, destination, revision_id=None):
1045
1545
        self._ensure_real()
1085
1585
        return self._real_repository.inventories
1086
1586
 
1087
1587
    @needs_write_lock
1088
 
    def pack(self):
 
1588
    def pack(self, hint=None):
1089
1589
        """Compress the data within the repository.
1090
1590
 
1091
1591
        This is not currently implemented within the smart server.
1092
1592
        """
1093
1593
        self._ensure_real()
1094
 
        return self._real_repository.pack()
 
1594
        return self._real_repository.pack(hint=hint)
1095
1595
 
1096
1596
    @property
1097
1597
    def revisions(self):
1106
1606
        return self._real_repository.revisions
1107
1607
 
1108
1608
    def set_make_working_trees(self, new_value):
1109
 
        self._ensure_real()
1110
 
        self._real_repository.set_make_working_trees(new_value)
 
1609
        if new_value:
 
1610
            new_value_str = "True"
 
1611
        else:
 
1612
            new_value_str = "False"
 
1613
        path = self.bzrdir._path_for_remote_call(self._client)
 
1614
        try:
 
1615
            response = self._call(
 
1616
                'Repository.set_make_working_trees', path, new_value_str)
 
1617
        except errors.UnknownSmartMethod:
 
1618
            self._ensure_real()
 
1619
            self._real_repository.set_make_working_trees(new_value)
 
1620
        else:
 
1621
            if response[0] != 'ok':
 
1622
                raise errors.UnexpectedSmartServerResponse(response)
1111
1623
 
1112
1624
    @property
1113
1625
    def signatures(self):
1140
1652
        return self._real_repository.get_revisions(revision_ids)
1141
1653
 
1142
1654
    def supports_rich_root(self):
1143
 
        self._ensure_real()
1144
 
        return self._real_repository.supports_rich_root()
 
1655
        return self._format.rich_root_data
1145
1656
 
1146
1657
    def iter_reverse_revision_history(self, revision_id):
1147
1658
        self._ensure_real()
1149
1660
 
1150
1661
    @property
1151
1662
    def _serializer(self):
1152
 
        self._ensure_real()
1153
 
        return self._real_repository._serializer
 
1663
        return self._format._serializer
1154
1664
 
1155
1665
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1156
1666
        self._ensure_real()
1175
1685
        self._ensure_real()
1176
1686
        return self._real_repository.revision_graph_can_have_wrong_parents()
1177
1687
 
1178
 
    def _find_inconsistent_revision_parents(self):
 
1688
    def _find_inconsistent_revision_parents(self, revisions_iterator=None):
1179
1689
        self._ensure_real()
1180
 
        return self._real_repository._find_inconsistent_revision_parents()
 
1690
        return self._real_repository._find_inconsistent_revision_parents(
 
1691
            revisions_iterator)
1181
1692
 
1182
1693
    def _check_for_inconsistent_revision_parents(self):
1183
1694
        self._ensure_real()
1189
1700
            providers.insert(0, other)
1190
1701
        providers.extend(r._make_parents_provider() for r in
1191
1702
                         self._fallback_repositories)
1192
 
        return graph._StackedParentsProvider(providers)
 
1703
        return graph.StackedParentsProvider(providers)
1193
1704
 
1194
1705
    def _serialise_search_recipe(self, recipe):
1195
1706
        """Serialise a graph search recipe.
1197
1708
        :param recipe: A search recipe (start, stop, count).
1198
1709
        :return: Serialised bytes.
1199
1710
        """
1200
 
        start_keys = ' '.join(recipe[0])
1201
 
        stop_keys = ' '.join(recipe[1])
1202
 
        count = str(recipe[2])
 
1711
        start_keys = ' '.join(recipe[1])
 
1712
        stop_keys = ' '.join(recipe[2])
 
1713
        count = str(recipe[3])
1203
1714
        return '\n'.join((start_keys, stop_keys, count))
1204
1715
 
 
1716
    def _serialise_search_result(self, search_result):
 
1717
        if isinstance(search_result, graph.PendingAncestryResult):
 
1718
            parts = ['ancestry-of']
 
1719
            parts.extend(search_result.heads)
 
1720
        else:
 
1721
            recipe = search_result.get_recipe()
 
1722
            parts = [recipe[0], self._serialise_search_recipe(recipe)]
 
1723
        return '\n'.join(parts)
 
1724
 
1205
1725
    def autopack(self):
1206
1726
        path = self.bzrdir._path_for_remote_call(self._client)
1207
1727
        try:
1210
1730
            self._ensure_real()
1211
1731
            self._real_repository._pack_collection.autopack()
1212
1732
            return
1213
 
        if self._real_repository is not None:
1214
 
            # Reset the real repository's cache of pack names.
1215
 
            # XXX: At some point we may be able to skip this and just rely on
1216
 
            # the automatic retry logic to do the right thing, but for now we
1217
 
            # err on the side of being correct rather than being optimal.
1218
 
            self._real_repository._pack_collection.reload_pack_names()
 
1733
        self.refresh_data()
1219
1734
        if response[0] != 'ok':
1220
1735
            raise errors.UnexpectedSmartServerResponse(response)
1221
1736
 
1222
1737
 
 
1738
class RemoteStreamSink(repository.StreamSink):
 
1739
 
 
1740
    def _insert_real(self, stream, src_format, resume_tokens):
 
1741
        self.target_repo._ensure_real()
 
1742
        sink = self.target_repo._real_repository._get_sink()
 
1743
        result = sink.insert_stream(stream, src_format, resume_tokens)
 
1744
        if not result:
 
1745
            self.target_repo.autopack()
 
1746
        return result
 
1747
 
 
1748
    def insert_stream(self, stream, src_format, resume_tokens):
 
1749
        target = self.target_repo
 
1750
        target._unstacked_provider.missing_keys.clear()
 
1751
        candidate_calls = [('Repository.insert_stream_1.19', (1, 19))]
 
1752
        if target._lock_token:
 
1753
            candidate_calls.append(('Repository.insert_stream_locked', (1, 14)))
 
1754
            lock_args = (target._lock_token or '',)
 
1755
        else:
 
1756
            candidate_calls.append(('Repository.insert_stream', (1, 13)))
 
1757
            lock_args = ()
 
1758
        client = target._client
 
1759
        medium = client._medium
 
1760
        path = target.bzrdir._path_for_remote_call(client)
 
1761
        # Probe for the verb to use with an empty stream before sending the
 
1762
        # real stream to it.  We do this both to avoid the risk of sending a
 
1763
        # large request that is then rejected, and because we don't want to
 
1764
        # implement a way to buffer, rewind, or restart the stream.
 
1765
        found_verb = False
 
1766
        for verb, required_version in candidate_calls:
 
1767
            if medium._is_remote_before(required_version):
 
1768
                continue
 
1769
            if resume_tokens:
 
1770
                # We've already done the probing (and set _is_remote_before) on
 
1771
                # a previous insert.
 
1772
                found_verb = True
 
1773
                break
 
1774
            byte_stream = smart_repo._stream_to_byte_stream([], src_format)
 
1775
            try:
 
1776
                response = client.call_with_body_stream(
 
1777
                    (verb, path, '') + lock_args, byte_stream)
 
1778
            except errors.UnknownSmartMethod:
 
1779
                medium._remember_remote_is_before(required_version)
 
1780
            else:
 
1781
                found_verb = True
 
1782
                break
 
1783
        if not found_verb:
 
1784
            # Have to use VFS.
 
1785
            return self._insert_real(stream, src_format, resume_tokens)
 
1786
        self._last_inv_record = None
 
1787
        self._last_substream = None
 
1788
        if required_version < (1, 19):
 
1789
            # Remote side doesn't support inventory deltas.  Wrap the stream to
 
1790
            # make sure we don't send any.  If the stream contains inventory
 
1791
            # deltas we'll interrupt the smart insert_stream request and
 
1792
            # fallback to VFS.
 
1793
            stream = self._stop_stream_if_inventory_delta(stream)
 
1794
        byte_stream = smart_repo._stream_to_byte_stream(
 
1795
            stream, src_format)
 
1796
        resume_tokens = ' '.join(resume_tokens)
 
1797
        response = client.call_with_body_stream(
 
1798
            (verb, path, resume_tokens) + lock_args, byte_stream)
 
1799
        if response[0][0] not in ('ok', 'missing-basis'):
 
1800
            raise errors.UnexpectedSmartServerResponse(response)
 
1801
        if self._last_substream is not None:
 
1802
            # The stream included an inventory-delta record, but the remote
 
1803
            # side isn't new enough to support them.  So we need to send the
 
1804
            # rest of the stream via VFS.
 
1805
            self.target_repo.refresh_data()
 
1806
            return self._resume_stream_with_vfs(response, src_format)
 
1807
        if response[0][0] == 'missing-basis':
 
1808
            tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
 
1809
            resume_tokens = tokens
 
1810
            return resume_tokens, set(missing_keys)
 
1811
        else:
 
1812
            self.target_repo.refresh_data()
 
1813
            return [], set()
 
1814
 
 
1815
    def _resume_stream_with_vfs(self, response, src_format):
 
1816
        """Resume sending a stream via VFS, first resending the record and
 
1817
        substream that couldn't be sent via an insert_stream verb.
 
1818
        """
 
1819
        if response[0][0] == 'missing-basis':
 
1820
            tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
 
1821
            # Ignore missing_keys, we haven't finished inserting yet
 
1822
        else:
 
1823
            tokens = []
 
1824
        def resume_substream():
 
1825
            # Yield the substream that was interrupted.
 
1826
            for record in self._last_substream:
 
1827
                yield record
 
1828
            self._last_substream = None
 
1829
        def resume_stream():
 
1830
            # Finish sending the interrupted substream
 
1831
            yield ('inventory-deltas', resume_substream())
 
1832
            # Then simply continue sending the rest of the stream.
 
1833
            for substream_kind, substream in self._last_stream:
 
1834
                yield substream_kind, substream
 
1835
        return self._insert_real(resume_stream(), src_format, tokens)
 
1836
 
 
1837
    def _stop_stream_if_inventory_delta(self, stream):
 
1838
        """Normally this just lets the original stream pass-through unchanged.
 
1839
 
 
1840
        However if any 'inventory-deltas' substream occurs it will stop
 
1841
        streaming, and store the interrupted substream and stream in
 
1842
        self._last_substream and self._last_stream so that the stream can be
 
1843
        resumed by _resume_stream_with_vfs.
 
1844
        """
 
1845
                    
 
1846
        stream_iter = iter(stream)
 
1847
        for substream_kind, substream in stream_iter:
 
1848
            if substream_kind == 'inventory-deltas':
 
1849
                self._last_substream = substream
 
1850
                self._last_stream = stream_iter
 
1851
                return
 
1852
            else:
 
1853
                yield substream_kind, substream
 
1854
            
 
1855
 
 
1856
class RemoteStreamSource(repository.StreamSource):
 
1857
    """Stream data from a remote server."""
 
1858
 
 
1859
    def get_stream(self, search):
 
1860
        if (self.from_repository._fallback_repositories and
 
1861
            self.to_format._fetch_order == 'topological'):
 
1862
            return self._real_stream(self.from_repository, search)
 
1863
        sources = []
 
1864
        seen = set()
 
1865
        repos = [self.from_repository]
 
1866
        while repos:
 
1867
            repo = repos.pop(0)
 
1868
            if repo in seen:
 
1869
                continue
 
1870
            seen.add(repo)
 
1871
            repos.extend(repo._fallback_repositories)
 
1872
            sources.append(repo)
 
1873
        return self.missing_parents_chain(search, sources)
 
1874
 
 
1875
    def get_stream_for_missing_keys(self, missing_keys):
 
1876
        self.from_repository._ensure_real()
 
1877
        real_repo = self.from_repository._real_repository
 
1878
        real_source = real_repo._get_source(self.to_format)
 
1879
        return real_source.get_stream_for_missing_keys(missing_keys)
 
1880
 
 
1881
    def _real_stream(self, repo, search):
 
1882
        """Get a stream for search from repo.
 
1883
        
 
1884
        This never called RemoteStreamSource.get_stream, and is a heler
 
1885
        for RemoteStreamSource._get_stream to allow getting a stream 
 
1886
        reliably whether fallback back because of old servers or trying
 
1887
        to stream from a non-RemoteRepository (which the stacked support
 
1888
        code will do).
 
1889
        """
 
1890
        source = repo._get_source(self.to_format)
 
1891
        if isinstance(source, RemoteStreamSource):
 
1892
            repo._ensure_real()
 
1893
            source = repo._real_repository._get_source(self.to_format)
 
1894
        return source.get_stream(search)
 
1895
 
 
1896
    def _get_stream(self, repo, search):
 
1897
        """Core worker to get a stream from repo for search.
 
1898
 
 
1899
        This is used by both get_stream and the stacking support logic. It
 
1900
        deliberately gets a stream for repo which does not need to be
 
1901
        self.from_repository. In the event that repo is not Remote, or
 
1902
        cannot do a smart stream, a fallback is made to the generic
 
1903
        repository._get_stream() interface, via self._real_stream.
 
1904
 
 
1905
        In the event of stacking, streams from _get_stream will not
 
1906
        contain all the data for search - this is normal (see get_stream).
 
1907
 
 
1908
        :param repo: A repository.
 
1909
        :param search: A search.
 
1910
        """
 
1911
        # Fallbacks may be non-smart
 
1912
        if not isinstance(repo, RemoteRepository):
 
1913
            return self._real_stream(repo, search)
 
1914
        client = repo._client
 
1915
        medium = client._medium
 
1916
        path = repo.bzrdir._path_for_remote_call(client)
 
1917
        search_bytes = repo._serialise_search_result(search)
 
1918
        args = (path, self.to_format.network_name())
 
1919
        candidate_verbs = [
 
1920
            ('Repository.get_stream_1.19', (1, 19)),
 
1921
            ('Repository.get_stream', (1, 13))]
 
1922
        found_verb = False
 
1923
        for verb, version in candidate_verbs:
 
1924
            if medium._is_remote_before(version):
 
1925
                continue
 
1926
            try:
 
1927
                response = repo._call_with_body_bytes_expecting_body(
 
1928
                    verb, args, search_bytes)
 
1929
            except errors.UnknownSmartMethod:
 
1930
                medium._remember_remote_is_before(version)
 
1931
            else:
 
1932
                response_tuple, response_handler = response
 
1933
                found_verb = True
 
1934
                break
 
1935
        if not found_verb:
 
1936
            return self._real_stream(repo, search)
 
1937
        if response_tuple[0] != 'ok':
 
1938
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
1939
        byte_stream = response_handler.read_streamed_body()
 
1940
        src_format, stream = smart_repo._byte_stream_to_stream(byte_stream)
 
1941
        if src_format.network_name() != repo._format.network_name():
 
1942
            raise AssertionError(
 
1943
                "Mismatched RemoteRepository and stream src %r, %r" % (
 
1944
                src_format.network_name(), repo._format.network_name()))
 
1945
        return stream
 
1946
 
 
1947
    def missing_parents_chain(self, search, sources):
 
1948
        """Chain multiple streams together to handle stacking.
 
1949
 
 
1950
        :param search: The overall search to satisfy with streams.
 
1951
        :param sources: A list of Repository objects to query.
 
1952
        """
 
1953
        self.from_serialiser = self.from_repository._format._serializer
 
1954
        self.seen_revs = set()
 
1955
        self.referenced_revs = set()
 
1956
        # If there are heads in the search, or the key count is > 0, we are not
 
1957
        # done.
 
1958
        while not search.is_empty() and len(sources) > 1:
 
1959
            source = sources.pop(0)
 
1960
            stream = self._get_stream(source, search)
 
1961
            for kind, substream in stream:
 
1962
                if kind != 'revisions':
 
1963
                    yield kind, substream
 
1964
                else:
 
1965
                    yield kind, self.missing_parents_rev_handler(substream)
 
1966
            search = search.refine(self.seen_revs, self.referenced_revs)
 
1967
            self.seen_revs = set()
 
1968
            self.referenced_revs = set()
 
1969
        if not search.is_empty():
 
1970
            for kind, stream in self._get_stream(sources[0], search):
 
1971
                yield kind, stream
 
1972
 
 
1973
    def missing_parents_rev_handler(self, substream):
 
1974
        for content in substream:
 
1975
            revision_bytes = content.get_bytes_as('fulltext')
 
1976
            revision = self.from_serialiser.read_revision_from_string(
 
1977
                revision_bytes)
 
1978
            self.seen_revs.add(content.key[-1])
 
1979
            self.referenced_revs.update(revision.parent_ids)
 
1980
            yield content
 
1981
 
 
1982
 
1223
1983
class RemoteBranchLockableFiles(LockableFiles):
1224
1984
    """A 'LockableFiles' implementation that talks to a smart server.
1225
 
    
 
1985
 
1226
1986
    This is not a public interface class.
1227
1987
    """
1228
1988
 
1242
2002
 
1243
2003
class RemoteBranchFormat(branch.BranchFormat):
1244
2004
 
1245
 
    def __init__(self):
 
2005
    def __init__(self, network_name=None):
1246
2006
        super(RemoteBranchFormat, self).__init__()
1247
2007
        self._matchingbzrdir = RemoteBzrDirFormat()
1248
2008
        self._matchingbzrdir.set_branch_format(self)
 
2009
        self._custom_format = None
 
2010
        self._network_name = network_name
1249
2011
 
1250
2012
    def __eq__(self, other):
1251
 
        return (isinstance(other, RemoteBranchFormat) and 
 
2013
        return (isinstance(other, RemoteBranchFormat) and
1252
2014
            self.__dict__ == other.__dict__)
1253
2015
 
 
2016
    def _ensure_real(self):
 
2017
        if self._custom_format is None:
 
2018
            self._custom_format = branch.network_format_registry.get(
 
2019
                self._network_name)
 
2020
 
1254
2021
    def get_format_description(self):
1255
 
        return 'Remote BZR Branch'
1256
 
 
1257
 
    def get_format_string(self):
1258
 
        return 'Remote BZR Branch'
1259
 
 
1260
 
    def open(self, a_bzrdir):
1261
 
        return a_bzrdir.open_branch()
 
2022
        self._ensure_real()
 
2023
        return 'Remote: ' + self._custom_format.get_format_description()
 
2024
 
 
2025
    def network_name(self):
 
2026
        return self._network_name
 
2027
 
 
2028
    def open(self, a_bzrdir, ignore_fallbacks=False):
 
2029
        return a_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
 
2030
 
 
2031
    def _vfs_initialize(self, a_bzrdir):
 
2032
        # Initialisation when using a local bzrdir object, or a non-vfs init
 
2033
        # method is not available on the server.
 
2034
        # self._custom_format is always set - the start of initialize ensures
 
2035
        # that.
 
2036
        if isinstance(a_bzrdir, RemoteBzrDir):
 
2037
            a_bzrdir._ensure_real()
 
2038
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir)
 
2039
        else:
 
2040
            # We assume the bzrdir is parameterised; it may not be.
 
2041
            result = self._custom_format.initialize(a_bzrdir)
 
2042
        if (isinstance(a_bzrdir, RemoteBzrDir) and
 
2043
            not isinstance(result, RemoteBranch)):
 
2044
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
 
2045
        return result
1262
2046
 
1263
2047
    def initialize(self, a_bzrdir):
1264
 
        return a_bzrdir.create_branch()
 
2048
        # 1) get the network name to use.
 
2049
        if self._custom_format:
 
2050
            network_name = self._custom_format.network_name()
 
2051
        else:
 
2052
            # Select the current bzrlib default and ask for that.
 
2053
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
 
2054
            reference_format = reference_bzrdir_format.get_branch_format()
 
2055
            self._custom_format = reference_format
 
2056
            network_name = reference_format.network_name()
 
2057
        # Being asked to create on a non RemoteBzrDir:
 
2058
        if not isinstance(a_bzrdir, RemoteBzrDir):
 
2059
            return self._vfs_initialize(a_bzrdir)
 
2060
        medium = a_bzrdir._client._medium
 
2061
        if medium._is_remote_before((1, 13)):
 
2062
            return self._vfs_initialize(a_bzrdir)
 
2063
        # Creating on a remote bzr dir.
 
2064
        # 2) try direct creation via RPC
 
2065
        path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
 
2066
        verb = 'BzrDir.create_branch'
 
2067
        try:
 
2068
            response = a_bzrdir._call(verb, path, network_name)
 
2069
        except errors.UnknownSmartMethod:
 
2070
            # Fallback - use vfs methods
 
2071
            medium._remember_remote_is_before((1, 13))
 
2072
            return self._vfs_initialize(a_bzrdir)
 
2073
        if response[0] != 'ok':
 
2074
            raise errors.UnexpectedSmartServerResponse(response)
 
2075
        # Turn the response into a RemoteRepository object.
 
2076
        format = RemoteBranchFormat(network_name=response[1])
 
2077
        repo_format = response_tuple_to_repo_format(response[3:])
 
2078
        if response[2] == '':
 
2079
            repo_bzrdir = a_bzrdir
 
2080
        else:
 
2081
            repo_bzrdir = RemoteBzrDir(
 
2082
                a_bzrdir.root_transport.clone(response[2]), a_bzrdir._format,
 
2083
                a_bzrdir._client)
 
2084
        remote_repo = RemoteRepository(repo_bzrdir, repo_format)
 
2085
        remote_branch = RemoteBranch(a_bzrdir, remote_repo,
 
2086
            format=format, setup_stacking=False)
 
2087
        # XXX: We know this is a new branch, so it must have revno 0, revid
 
2088
        # NULL_REVISION. Creating the branch locked would make this be unable
 
2089
        # to be wrong; here its simply very unlikely to be wrong. RBC 20090225
 
2090
        remote_branch._last_revision_info_cache = 0, NULL_REVISION
 
2091
        return remote_branch
 
2092
 
 
2093
    def make_tags(self, branch):
 
2094
        self._ensure_real()
 
2095
        return self._custom_format.make_tags(branch)
1265
2096
 
1266
2097
    def supports_tags(self):
1267
2098
        # Remote branches might support tags, but we won't know until we
1268
2099
        # access the real remote branch.
1269
 
        return True
1270
 
 
1271
 
 
1272
 
class RemoteBranch(branch.Branch, _RpcHelper):
 
2100
        self._ensure_real()
 
2101
        return self._custom_format.supports_tags()
 
2102
 
 
2103
    def supports_stacking(self):
 
2104
        self._ensure_real()
 
2105
        return self._custom_format.supports_stacking()
 
2106
 
 
2107
    def supports_set_append_revisions_only(self):
 
2108
        self._ensure_real()
 
2109
        return self._custom_format.supports_set_append_revisions_only()
 
2110
 
 
2111
 
 
2112
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
1273
2113
    """Branch stored on a server accessed by HPSS RPC.
1274
2114
 
1275
2115
    At the moment most operations are mapped down to simple file operations.
1276
2116
    """
1277
2117
 
1278
2118
    def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
1279
 
        _client=None):
 
2119
        _client=None, format=None, setup_stacking=True):
1280
2120
        """Create a RemoteBranch instance.
1281
2121
 
1282
2122
        :param real_branch: An optional local implementation of the branch
1283
2123
            format, usually accessing the data via the VFS.
1284
2124
        :param _client: Private parameter for testing.
 
2125
        :param format: A RemoteBranchFormat object, None to create one
 
2126
            automatically. If supplied it should have a network_name already
 
2127
            supplied.
 
2128
        :param setup_stacking: If True make an RPC call to determine the
 
2129
            stacked (or not) status of the branch. If False assume the branch
 
2130
            is not stacked.
1285
2131
        """
1286
2132
        # We intentionally don't call the parent class's __init__, because it
1287
2133
        # will try to assign to self.tags, which is a property in this subclass.
1288
2134
        # And the parent's __init__ doesn't do much anyway.
1289
 
        self._revision_id_to_revno_cache = None
1290
 
        self._partial_revision_id_to_revno_cache = {}
1291
 
        self._revision_history_cache = None
1292
 
        self._last_revision_info_cache = None
1293
 
        self._merge_sorted_revisions_cache = None
1294
2135
        self.bzrdir = remote_bzrdir
1295
2136
        if _client is not None:
1296
2137
            self._client = _client
1309
2150
            self._real_branch.repository = self.repository
1310
2151
        else:
1311
2152
            self._real_branch = None
1312
 
        # Fill out expected attributes of branch for bzrlib api users.
1313
 
        self._format = RemoteBranchFormat()
 
2153
        # Fill out expected attributes of branch for bzrlib API users.
 
2154
        self._clear_cached_state()
1314
2155
        self.base = self.bzrdir.root_transport.base
1315
2156
        self._control_files = None
1316
2157
        self._lock_mode = None
1318
2159
        self._repo_lock_token = None
1319
2160
        self._lock_count = 0
1320
2161
        self._leave_lock = False
 
2162
        # Setup a format: note that we cannot call _ensure_real until all the
 
2163
        # attributes above are set: This code cannot be moved higher up in this
 
2164
        # function.
 
2165
        if format is None:
 
2166
            self._format = RemoteBranchFormat()
 
2167
            if real_branch is not None:
 
2168
                self._format._network_name = \
 
2169
                    self._real_branch._format.network_name()
 
2170
        else:
 
2171
            self._format = format
 
2172
        # when we do _ensure_real we may need to pass ignore_fallbacks to the
 
2173
        # branch.open_branch method.
 
2174
        self._real_ignore_fallbacks = not setup_stacking
 
2175
        if not self._format._network_name:
 
2176
            # Did not get from open_branchV2 - old server.
 
2177
            self._ensure_real()
 
2178
            self._format._network_name = \
 
2179
                self._real_branch._format.network_name()
 
2180
        self.tags = self._format.make_tags(self)
1321
2181
        # The base class init is not called, so we duplicate this:
1322
2182
        hooks = branch.Branch.hooks['open']
1323
2183
        for hook in hooks:
1324
2184
            hook(self)
1325
 
        self._setup_stacking()
 
2185
        self._is_stacked = False
 
2186
        if setup_stacking:
 
2187
            self._setup_stacking()
1326
2188
 
1327
2189
    def _setup_stacking(self):
1328
2190
        # configure stacking into the remote repository, by reading it from
1332
2194
        except (errors.NotStacked, errors.UnstackableBranchFormat,
1333
2195
            errors.UnstackableRepositoryFormat), e:
1334
2196
            return
1335
 
        # it's relative to this branch...
1336
 
        fallback_url = urlutils.join(self.base, fallback_url)
1337
 
        transports = [self.bzrdir.root_transport]
1338
 
        if self._real_branch is not None:
1339
 
            transports.append(self._real_branch._transport)
1340
 
        stacked_on = branch.Branch.open(fallback_url,
1341
 
                                        possible_transports=transports)
1342
 
        self.repository.add_fallback_repository(stacked_on.repository)
 
2197
        self._is_stacked = True
 
2198
        self._activate_fallback_location(fallback_url)
 
2199
 
 
2200
    def _get_config(self):
 
2201
        return RemoteBranchConfig(self)
1343
2202
 
1344
2203
    def _get_real_transport(self):
1345
2204
        # if we try vfs access, return the real branch's vfs transport
1363
2222
                raise AssertionError('smart server vfs must be enabled '
1364
2223
                    'to use vfs implementation')
1365
2224
            self.bzrdir._ensure_real()
1366
 
            self._real_branch = self.bzrdir._real_bzrdir.open_branch()
 
2225
            self._real_branch = self.bzrdir._real_bzrdir.open_branch(
 
2226
                ignore_fallbacks=self._real_ignore_fallbacks)
1367
2227
            if self.repository._real_repository is None:
1368
2228
                # Give the remote repository the matching real repo.
1369
2229
                real_repo = self._real_branch.repository
1398
2258
        too, in fact doing so might harm performance.
1399
2259
        """
1400
2260
        super(RemoteBranch, self)._clear_cached_state()
1401
 
        
 
2261
 
1402
2262
    @property
1403
2263
    def control_files(self):
1404
2264
        # Defer actually creating RemoteBranchLockableFiles until its needed,
1443
2303
            raise errors.UnexpectedSmartServerResponse(response)
1444
2304
        return response[1]
1445
2305
 
 
2306
    def set_stacked_on_url(self, url):
 
2307
        branch.Branch.set_stacked_on_url(self, url)
 
2308
        if not url:
 
2309
            self._is_stacked = False
 
2310
        else:
 
2311
            self._is_stacked = True
 
2312
        
 
2313
    def _vfs_get_tags_bytes(self):
 
2314
        self._ensure_real()
 
2315
        return self._real_branch._get_tags_bytes()
 
2316
 
 
2317
    def _get_tags_bytes(self):
 
2318
        medium = self._client._medium
 
2319
        if medium._is_remote_before((1, 13)):
 
2320
            return self._vfs_get_tags_bytes()
 
2321
        try:
 
2322
            response = self._call('Branch.get_tags_bytes', self._remote_path())
 
2323
        except errors.UnknownSmartMethod:
 
2324
            medium._remember_remote_is_before((1, 13))
 
2325
            return self._vfs_get_tags_bytes()
 
2326
        return response[0]
 
2327
 
 
2328
    def _vfs_set_tags_bytes(self, bytes):
 
2329
        self._ensure_real()
 
2330
        return self._real_branch._set_tags_bytes(bytes)
 
2331
 
 
2332
    def _set_tags_bytes(self, bytes):
 
2333
        medium = self._client._medium
 
2334
        if medium._is_remote_before((1, 18)):
 
2335
            self._vfs_set_tags_bytes(bytes)
 
2336
            return
 
2337
        try:
 
2338
            args = (
 
2339
                self._remote_path(), self._lock_token, self._repo_lock_token)
 
2340
            response = self._call_with_body_bytes(
 
2341
                'Branch.set_tags_bytes', args, bytes)
 
2342
        except errors.UnknownSmartMethod:
 
2343
            medium._remember_remote_is_before((1, 18))
 
2344
            self._vfs_set_tags_bytes(bytes)
 
2345
 
1446
2346
    def lock_read(self):
1447
2347
        self.repository.lock_read()
1448
2348
        if not self._lock_mode:
 
2349
            self._note_lock('r')
1449
2350
            self._lock_mode = 'r'
1450
2351
            self._lock_count = 1
1451
2352
            if self._real_branch is not None:
1468
2369
            raise errors.UnexpectedSmartServerResponse(response)
1469
2370
        ok, branch_token, repo_token = response
1470
2371
        return branch_token, repo_token
1471
 
            
 
2372
 
1472
2373
    def lock_write(self, token=None):
1473
2374
        if not self._lock_mode:
 
2375
            self._note_lock('w')
1474
2376
            # Lock the branch and repo in one remote call.
1475
2377
            remote_tokens = self._remote_lock_write(token)
1476
2378
            self._lock_token, self._repo_lock_token = remote_tokens
1511
2413
            return
1512
2414
        raise errors.UnexpectedSmartServerResponse(response)
1513
2415
 
 
2416
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1514
2417
    def unlock(self):
1515
2418
        try:
1516
2419
            self._lock_count -= 1
1529
2432
                    self._real_branch.unlock()
1530
2433
                if mode != 'w':
1531
2434
                    # Only write-locked branched need to make a remote method
1532
 
                    # call to perfom the unlock.
 
2435
                    # call to perform the unlock.
1533
2436
                    return
1534
2437
                if not self._lock_token:
1535
2438
                    raise AssertionError('Locked, but no token!')
1556
2459
            raise NotImplementedError(self.dont_leave_lock_in_place)
1557
2460
        self._leave_lock = False
1558
2461
 
 
2462
    @needs_read_lock
 
2463
    def get_rev_id(self, revno, history=None):
 
2464
        if revno == 0:
 
2465
            return _mod_revision.NULL_REVISION
 
2466
        last_revision_info = self.last_revision_info()
 
2467
        ok, result = self.repository.get_rev_id_for_revno(
 
2468
            revno, last_revision_info)
 
2469
        if ok:
 
2470
            return result
 
2471
        missing_parent = result[1]
 
2472
        # Either the revision named by the server is missing, or its parent
 
2473
        # is.  Call get_parent_map to determine which, so that we report a
 
2474
        # useful error.
 
2475
        parent_map = self.repository.get_parent_map([missing_parent])
 
2476
        if missing_parent in parent_map:
 
2477
            missing_parent = parent_map[missing_parent]
 
2478
        raise errors.RevisionNotPresent(missing_parent, self.repository)
 
2479
 
1559
2480
    def _last_revision_info(self):
1560
2481
        response = self._call('Branch.last_revision_info', self._remote_path())
1561
2482
        if response[0] != 'ok':
1566
2487
 
1567
2488
    def _gen_revision_history(self):
1568
2489
        """See Branch._gen_revision_history()."""
 
2490
        if self._is_stacked:
 
2491
            self._ensure_real()
 
2492
            return self._real_branch._gen_revision_history()
1569
2493
        response_tuple, response_handler = self._call_expecting_body(
1570
2494
            'Branch.revision_history', self._remote_path())
1571
2495
        if response_tuple[0] != 'ok':
1580
2504
 
1581
2505
    def _set_last_revision_descendant(self, revision_id, other_branch,
1582
2506
            allow_diverged=False, allow_overwrite_descendant=False):
 
2507
        # This performs additional work to meet the hook contract; while its
 
2508
        # undesirable, we have to synthesise the revno to call the hook, and
 
2509
        # not calling the hook is worse as it means changes can't be prevented.
 
2510
        # Having calculated this though, we can't just call into
 
2511
        # set_last_revision_info as a simple call, because there is a set_rh
 
2512
        # hook that some folk may still be using.
 
2513
        old_revno, old_revid = self.last_revision_info()
 
2514
        history = self._lefthand_history(revision_id)
 
2515
        self._run_pre_change_branch_tip_hooks(len(history), revision_id)
1583
2516
        err_context = {'other_branch': other_branch}
1584
2517
        response = self._call('Branch.set_last_revision_ex',
1585
2518
            self._remote_path(), self._lock_token, self._repo_lock_token,
1590
2523
            raise errors.UnexpectedSmartServerResponse(response)
1591
2524
        new_revno, new_revision_id = response[1:]
1592
2525
        self._last_revision_info_cache = new_revno, new_revision_id
 
2526
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1593
2527
        if self._real_branch is not None:
1594
2528
            cache = new_revno, new_revision_id
1595
2529
            self._real_branch._last_revision_info_cache = cache
1596
2530
 
1597
2531
    def _set_last_revision(self, revision_id):
 
2532
        old_revno, old_revid = self.last_revision_info()
 
2533
        # This performs additional work to meet the hook contract; while its
 
2534
        # undesirable, we have to synthesise the revno to call the hook, and
 
2535
        # not calling the hook is worse as it means changes can't be prevented.
 
2536
        # Having calculated this though, we can't just call into
 
2537
        # set_last_revision_info as a simple call, because there is a set_rh
 
2538
        # hook that some folk may still be using.
 
2539
        history = self._lefthand_history(revision_id)
 
2540
        self._run_pre_change_branch_tip_hooks(len(history), revision_id)
1598
2541
        self._clear_cached_state()
1599
2542
        response = self._call('Branch.set_last_revision',
1600
2543
            self._remote_path(), self._lock_token, self._repo_lock_token,
1601
2544
            revision_id)
1602
2545
        if response != ('ok',):
1603
2546
            raise errors.UnexpectedSmartServerResponse(response)
 
2547
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1604
2548
 
1605
2549
    @needs_write_lock
1606
2550
    def set_revision_history(self, rev_history):
1612
2556
        else:
1613
2557
            rev_id = rev_history[-1]
1614
2558
        self._set_last_revision(rev_id)
 
2559
        for hook in branch.Branch.hooks['set_rh']:
 
2560
            hook(self, rev_history)
1615
2561
        self._cache_revision_history(rev_history)
1616
2562
 
1617
 
    def get_parent(self):
1618
 
        self._ensure_real()
1619
 
        return self._real_branch.get_parent()
1620
 
        
1621
 
    def set_parent(self, url):
1622
 
        self._ensure_real()
1623
 
        return self._real_branch.set_parent(url)
1624
 
        
1625
 
    def set_stacked_on_url(self, stacked_location):
1626
 
        """Set the URL this branch is stacked against.
1627
 
 
1628
 
        :raises UnstackableBranchFormat: If the branch does not support
1629
 
            stacking.
1630
 
        :raises UnstackableRepositoryFormat: If the repository does not support
1631
 
            stacking.
1632
 
        """
1633
 
        self._ensure_real()
1634
 
        return self._real_branch.set_stacked_on_url(stacked_location)
1635
 
 
1636
 
    def sprout(self, to_bzrdir, revision_id=None):
1637
 
        branch_format = to_bzrdir._format._branch_format
1638
 
        if (branch_format is None or
1639
 
            isinstance(branch_format, RemoteBranchFormat)):
1640
 
            # The to_bzrdir specifies RemoteBranchFormat (or no format, which
1641
 
            # implies the same thing), but RemoteBranches can't be created at
1642
 
            # arbitrary URLs.  So create a branch in the same format as
1643
 
            # _real_branch instead.
1644
 
            # XXX: if to_bzrdir is a RemoteBzrDir, this should perhaps do
1645
 
            # to_bzrdir.create_branch to create a RemoteBranch after all...
1646
 
            self._ensure_real()
1647
 
            result = self._real_branch._format.initialize(to_bzrdir)
1648
 
            self.copy_content_into(result, revision_id=revision_id)
1649
 
            result.set_parent(self.bzrdir.root_transport.base)
1650
 
        else:
1651
 
            result = branch.Branch.sprout(
1652
 
                self, to_bzrdir, revision_id=revision_id)
1653
 
        return result
 
2563
    def _get_parent_location(self):
 
2564
        medium = self._client._medium
 
2565
        if medium._is_remote_before((1, 13)):
 
2566
            return self._vfs_get_parent_location()
 
2567
        try:
 
2568
            response = self._call('Branch.get_parent', self._remote_path())
 
2569
        except errors.UnknownSmartMethod:
 
2570
            medium._remember_remote_is_before((1, 13))
 
2571
            return self._vfs_get_parent_location()
 
2572
        if len(response) != 1:
 
2573
            raise errors.UnexpectedSmartServerResponse(response)
 
2574
        parent_location = response[0]
 
2575
        if parent_location == '':
 
2576
            return None
 
2577
        return parent_location
 
2578
 
 
2579
    def _vfs_get_parent_location(self):
 
2580
        self._ensure_real()
 
2581
        return self._real_branch._get_parent_location()
 
2582
 
 
2583
    def _set_parent_location(self, url):
 
2584
        medium = self._client._medium
 
2585
        if medium._is_remote_before((1, 15)):
 
2586
            return self._vfs_set_parent_location(url)
 
2587
        try:
 
2588
            call_url = url or ''
 
2589
            if type(call_url) is not str:
 
2590
                raise AssertionError('url must be a str or None (%s)' % url)
 
2591
            response = self._call('Branch.set_parent_location',
 
2592
                self._remote_path(), self._lock_token, self._repo_lock_token,
 
2593
                call_url)
 
2594
        except errors.UnknownSmartMethod:
 
2595
            medium._remember_remote_is_before((1, 15))
 
2596
            return self._vfs_set_parent_location(url)
 
2597
        if response != ():
 
2598
            raise errors.UnexpectedSmartServerResponse(response)
 
2599
 
 
2600
    def _vfs_set_parent_location(self, url):
 
2601
        self._ensure_real()
 
2602
        return self._real_branch._set_parent_location(url)
1654
2603
 
1655
2604
    @needs_write_lock
1656
2605
    def pull(self, source, overwrite=False, stop_revision=None,
1678
2627
 
1679
2628
    @needs_write_lock
1680
2629
    def set_last_revision_info(self, revno, revision_id):
 
2630
        # XXX: These should be returned by the set_last_revision_info verb
 
2631
        old_revno, old_revid = self.last_revision_info()
 
2632
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
1681
2633
        revision_id = ensure_null(revision_id)
1682
2634
        try:
1683
2635
            response = self._call('Branch.set_last_revision_info',
1692
2644
        if response == ('ok',):
1693
2645
            self._clear_cached_state()
1694
2646
            self._last_revision_info_cache = revno, revision_id
 
2647
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1695
2648
            # Update the _real_branch's cache too.
1696
2649
            if self._real_branch is not None:
1697
2650
                cache = self._last_revision_info_cache
1704
2657
                                  other_branch=None):
1705
2658
        medium = self._client._medium
1706
2659
        if not medium._is_remote_before((1, 6)):
 
2660
            # Use a smart method for 1.6 and above servers
1707
2661
            try:
1708
2662
                self._set_last_revision_descendant(revision_id, other_branch,
1709
2663
                    allow_diverged=True, allow_overwrite_descendant=True)
1711
2665
            except errors.UnknownSmartMethod:
1712
2666
                medium._remember_remote_is_before((1, 6))
1713
2667
        self._clear_cached_state_of_remote_branch_only()
1714
 
        self._ensure_real()
1715
 
        self._real_branch.generate_revision_history(
1716
 
            revision_id, last_rev=last_rev, other_branch=other_branch)
1717
 
 
1718
 
    @property
1719
 
    def tags(self):
1720
 
        self._ensure_real()
1721
 
        return self._real_branch.tags
 
2668
        self.set_revision_history(self._lefthand_history(revision_id,
 
2669
            last_rev=last_rev,other_branch=other_branch))
1722
2670
 
1723
2671
    def set_push_location(self, location):
1724
2672
        self._ensure_real()
1725
2673
        return self._real_branch.set_push_location(location)
1726
2674
 
1727
 
    @needs_write_lock
1728
 
    def update_revisions(self, other, stop_revision=None, overwrite=False,
1729
 
                         graph=None):
1730
 
        """See Branch.update_revisions."""
1731
 
        other.lock_read()
 
2675
 
 
2676
class RemoteConfig(object):
 
2677
    """A Config that reads and writes from smart verbs.
 
2678
 
 
2679
    It is a low-level object that considers config data to be name/value pairs
 
2680
    that may be associated with a section. Assigning meaning to the these
 
2681
    values is done at higher levels like bzrlib.config.TreeConfig.
 
2682
    """
 
2683
 
 
2684
    def get_option(self, name, section=None, default=None):
 
2685
        """Return the value associated with a named option.
 
2686
 
 
2687
        :param name: The name of the value
 
2688
        :param section: The section the option is in (if any)
 
2689
        :param default: The value to return if the value is not set
 
2690
        :return: The value or default value
 
2691
        """
1732
2692
        try:
1733
 
            if stop_revision is None:
1734
 
                stop_revision = other.last_revision()
1735
 
                if revision.is_null(stop_revision):
1736
 
                    # if there are no commits, we're done.
1737
 
                    return
1738
 
            self.fetch(other, stop_revision)
1739
 
 
1740
 
            if overwrite:
1741
 
                # Just unconditionally set the new revision.  We don't care if
1742
 
                # the branches have diverged.
1743
 
                self._set_last_revision(stop_revision)
 
2693
            configobj = self._get_configobj()
 
2694
            if section is None:
 
2695
                section_obj = configobj
1744
2696
            else:
1745
 
                medium = self._client._medium
1746
 
                if not medium._is_remote_before((1, 6)):
1747
 
                    try:
1748
 
                        self._set_last_revision_descendant(stop_revision, other)
1749
 
                        return
1750
 
                    except errors.UnknownSmartMethod:
1751
 
                        medium._remember_remote_is_before((1, 6))
1752
 
                # Fallback for pre-1.6 servers: check for divergence
1753
 
                # client-side, then do _set_last_revision.
1754
 
                last_rev = revision.ensure_null(self.last_revision())
1755
 
                if graph is None:
1756
 
                    graph = self.repository.get_graph()
1757
 
                if self._check_if_descendant_or_diverged(
1758
 
                        stop_revision, last_rev, graph, other):
1759
 
                    # stop_revision is a descendant of last_rev, but we aren't
1760
 
                    # overwriting, so we're done.
1761
 
                    return
1762
 
                self._set_last_revision(stop_revision)
1763
 
        finally:
1764
 
            other.unlock()
 
2697
                try:
 
2698
                    section_obj = configobj[section]
 
2699
                except KeyError:
 
2700
                    return default
 
2701
            return section_obj.get(name, default)
 
2702
        except errors.UnknownSmartMethod:
 
2703
            return self._vfs_get_option(name, section, default)
 
2704
 
 
2705
    def _response_to_configobj(self, response):
 
2706
        if len(response[0]) and response[0][0] != 'ok':
 
2707
            raise errors.UnexpectedSmartServerResponse(response)
 
2708
        lines = response[1].read_body_bytes().splitlines()
 
2709
        return config.ConfigObj(lines, encoding='utf-8')
 
2710
 
 
2711
 
 
2712
class RemoteBranchConfig(RemoteConfig):
 
2713
    """A RemoteConfig for Branches."""
 
2714
 
 
2715
    def __init__(self, branch):
 
2716
        self._branch = branch
 
2717
 
 
2718
    def _get_configobj(self):
 
2719
        path = self._branch._remote_path()
 
2720
        response = self._branch._client.call_expecting_body(
 
2721
            'Branch.get_config_file', path)
 
2722
        return self._response_to_configobj(response)
 
2723
 
 
2724
    def set_option(self, value, name, section=None):
 
2725
        """Set the value associated with a named option.
 
2726
 
 
2727
        :param value: The value to set
 
2728
        :param name: The name of the value to set
 
2729
        :param section: The section the option is in (if any)
 
2730
        """
 
2731
        medium = self._branch._client._medium
 
2732
        if medium._is_remote_before((1, 14)):
 
2733
            return self._vfs_set_option(value, name, section)
 
2734
        try:
 
2735
            path = self._branch._remote_path()
 
2736
            response = self._branch._client.call('Branch.set_config_option',
 
2737
                path, self._branch._lock_token, self._branch._repo_lock_token,
 
2738
                value.encode('utf8'), name, section or '')
 
2739
        except errors.UnknownSmartMethod:
 
2740
            medium._remember_remote_is_before((1, 14))
 
2741
            return self._vfs_set_option(value, name, section)
 
2742
        if response != ():
 
2743
            raise errors.UnexpectedSmartServerResponse(response)
 
2744
 
 
2745
    def _real_object(self):
 
2746
        self._branch._ensure_real()
 
2747
        return self._branch._real_branch
 
2748
 
 
2749
    def _vfs_set_option(self, value, name, section=None):
 
2750
        return self._real_object()._get_config().set_option(
 
2751
            value, name, section)
 
2752
 
 
2753
 
 
2754
class RemoteBzrDirConfig(RemoteConfig):
 
2755
    """A RemoteConfig for BzrDirs."""
 
2756
 
 
2757
    def __init__(self, bzrdir):
 
2758
        self._bzrdir = bzrdir
 
2759
 
 
2760
    def _get_configobj(self):
 
2761
        medium = self._bzrdir._client._medium
 
2762
        verb = 'BzrDir.get_config_file'
 
2763
        if medium._is_remote_before((1, 15)):
 
2764
            raise errors.UnknownSmartMethod(verb)
 
2765
        path = self._bzrdir._path_for_remote_call(self._bzrdir._client)
 
2766
        response = self._bzrdir._call_expecting_body(
 
2767
            verb, path)
 
2768
        return self._response_to_configobj(response)
 
2769
 
 
2770
    def _vfs_get_option(self, name, section, default):
 
2771
        return self._real_object()._get_config().get_option(
 
2772
            name, section, default)
 
2773
 
 
2774
    def set_option(self, value, name, section=None):
 
2775
        """Set the value associated with a named option.
 
2776
 
 
2777
        :param value: The value to set
 
2778
        :param name: The name of the value to set
 
2779
        :param section: The section the option is in (if any)
 
2780
        """
 
2781
        return self._real_object()._get_config().set_option(
 
2782
            value, name, section)
 
2783
 
 
2784
    def _real_object(self):
 
2785
        self._bzrdir._ensure_real()
 
2786
        return self._bzrdir._real_bzrdir
 
2787
 
1765
2788
 
1766
2789
 
1767
2790
def _extract_tar(tar, to_dir):
1807
2830
                    'Missing key %r in context %r', key_err.args[0], context)
1808
2831
                raise err
1809
2832
 
1810
 
    if err.error_verb == 'NoSuchRevision':
 
2833
    if err.error_verb == 'IncompatibleRepositories':
 
2834
        raise errors.IncompatibleRepositories(err.error_args[0],
 
2835
            err.error_args[1], err.error_args[2])
 
2836
    elif err.error_verb == 'NoSuchRevision':
1811
2837
        raise NoSuchRevision(find('branch'), err.error_args[0])
1812
2838
    elif err.error_verb == 'nosuchrevision':
1813
2839
        raise NoSuchRevision(find('repository'), err.error_args[0])
1814
 
    elif err.error_tuple == ('nobranch',):
1815
 
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
 
2840
    elif err.error_verb == 'nobranch':
 
2841
        if len(err.error_args) >= 1:
 
2842
            extra = err.error_args[0]
 
2843
        else:
 
2844
            extra = None
 
2845
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base,
 
2846
            detail=extra)
1816
2847
    elif err.error_verb == 'norepository':
1817
2848
        raise errors.NoRepositoryPresent(find('bzrdir'))
1818
2849
    elif err.error_verb == 'LockContention':