~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

  • Committer: Jelmer Vernooij
  • Date: 2008-07-08 15:58:12 UTC
  • mfrom: (3353.1.4 paramiko-1.7.2-compat)
  • mto: This revision was merged to the branch mainline in revision 3531.
  • Revision ID: jelmer@samba.org-20080708155812-gacwrgs7d7n48a0d
Merge bashprompt script that prints the bzr branch nick.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2012 Canonical Ltd
 
1
# Copyright (C) 2006, 2007, 2008 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
from __future__ import absolute_import
 
17
# TODO: At some point, handle upgrades by just passing the whole request
 
18
# across to run on the server.
18
19
 
19
20
import bz2
20
 
import zlib
 
21
from cStringIO import StringIO
21
22
 
22
23
from bzrlib import (
23
 
    bencode,
24
24
    branch,
25
 
    bzrdir as _mod_bzrdir,
26
 
    config as _mod_config,
27
 
    controldir,
28
25
    debug,
29
26
    errors,
30
 
    gpg,
31
27
    graph,
32
 
    inventory_delta,
33
 
    lock,
34
28
    lockdir,
35
 
    osutils,
36
 
    registry,
37
 
    repository as _mod_repository,
38
 
    revision as _mod_revision,
39
 
    static_tuple,
 
29
    repository,
 
30
    revision,
40
31
    symbol_versioning,
41
 
    testament as _mod_testament,
42
 
    urlutils,
43
 
    vf_repository,
44
 
    vf_search,
45
 
    )
46
 
from bzrlib.branch import BranchReferenceFormat, BranchWriteLockResult
47
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
32
)
 
33
from bzrlib.branch import BranchReferenceFormat
 
34
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
 
35
from bzrlib.config import BranchConfig, TreeConfig
 
36
from bzrlib.decorators import needs_read_lock, needs_write_lock
48
37
from bzrlib.errors import (
49
38
    NoSuchRevision,
50
39
    SmartProtocolError,
51
40
    )
52
 
from bzrlib.i18n import gettext
53
 
from bzrlib.inventory import Inventory
54
41
from bzrlib.lockable_files import LockableFiles
55
 
from bzrlib.smart import client, vfs, repository as smart_repo
56
 
from bzrlib.smart.client import _SmartClient
57
 
from bzrlib.revision import NULL_REVISION
58
 
from bzrlib.revisiontree import InventoryRevisionTree
59
 
from bzrlib.repository import RepositoryWriteLockResult, _LazyListJoin
60
 
from bzrlib.serializer import format_registry as serializer_format_registry
61
 
from bzrlib.trace import mutter, note, warning, log_exception_quietly
62
 
from bzrlib.versionedfile import FulltextContentFactory
63
 
 
64
 
 
65
 
_DEFAULT_SEARCH_DEPTH = 100
66
 
 
67
 
 
68
 
class _RpcHelper(object):
69
 
    """Mixin class that helps with issuing RPCs."""
70
 
 
71
 
    def _call(self, method, *args, **err_context):
72
 
        try:
73
 
            return self._client.call(method, *args)
74
 
        except errors.ErrorFromSmartServer, err:
75
 
            self._translate_error(err, **err_context)
76
 
 
77
 
    def _call_expecting_body(self, method, *args, **err_context):
78
 
        try:
79
 
            return self._client.call_expecting_body(method, *args)
80
 
        except errors.ErrorFromSmartServer, err:
81
 
            self._translate_error(err, **err_context)
82
 
 
83
 
    def _call_with_body_bytes(self, method, args, body_bytes, **err_context):
84
 
        try:
85
 
            return self._client.call_with_body_bytes(method, args, body_bytes)
86
 
        except errors.ErrorFromSmartServer, err:
87
 
            self._translate_error(err, **err_context)
88
 
 
89
 
    def _call_with_body_bytes_expecting_body(self, method, args, body_bytes,
90
 
                                             **err_context):
91
 
        try:
92
 
            return self._client.call_with_body_bytes_expecting_body(
93
 
                method, args, body_bytes)
94
 
        except errors.ErrorFromSmartServer, err:
95
 
            self._translate_error(err, **err_context)
96
 
 
97
 
 
98
 
def response_tuple_to_repo_format(response):
99
 
    """Convert a response tuple describing a repository format to a format."""
100
 
    format = RemoteRepositoryFormat()
101
 
    format._rich_root_data = (response[0] == 'yes')
102
 
    format._supports_tree_reference = (response[1] == 'yes')
103
 
    format._supports_external_lookups = (response[2] == 'yes')
104
 
    format._network_name = response[3]
105
 
    return format
106
 
 
107
 
 
108
 
# Note that RemoteBzrDirProber lives in bzrlib.bzrdir so bzrlib.remote
109
 
# does not have to be imported unless a remote format is involved.
110
 
 
111
 
class RemoteBzrDirFormat(_mod_bzrdir.BzrDirMetaFormat1):
112
 
    """Format representing bzrdirs accessed via a smart server"""
113
 
 
114
 
    supports_workingtrees = False
115
 
 
116
 
    colocated_branches = False
117
 
 
118
 
    def __init__(self):
119
 
        _mod_bzrdir.BzrDirMetaFormat1.__init__(self)
120
 
        # XXX: It's a bit ugly that the network name is here, because we'd
121
 
        # like to believe that format objects are stateless or at least
122
 
        # immutable,  However, we do at least avoid mutating the name after
123
 
        # it's returned.  See <https://bugs.launchpad.net/bzr/+bug/504102>
124
 
        self._network_name = None
125
 
 
126
 
    def __repr__(self):
127
 
        return "%s(_network_name=%r)" % (self.__class__.__name__,
128
 
            self._network_name)
129
 
 
130
 
    def get_format_description(self):
131
 
        if self._network_name:
132
 
            try:
133
 
                real_format = controldir.network_format_registry.get(
134
 
                        self._network_name)
135
 
            except KeyError:
136
 
                pass
137
 
            else:
138
 
                return 'Remote: ' + real_format.get_format_description()
139
 
        return 'bzr remote bzrdir'
140
 
 
141
 
    def get_format_string(self):
142
 
        raise NotImplementedError(self.get_format_string)
143
 
 
144
 
    def network_name(self):
145
 
        if self._network_name:
146
 
            return self._network_name
147
 
        else:
148
 
            raise AssertionError("No network name set.")
149
 
 
150
 
    def initialize_on_transport(self, transport):
151
 
        try:
152
 
            # hand off the request to the smart server
153
 
            client_medium = transport.get_smart_medium()
154
 
        except errors.NoSmartMedium:
155
 
            # TODO: lookup the local format from a server hint.
156
 
            local_dir_format = _mod_bzrdir.BzrDirMetaFormat1()
157
 
            return local_dir_format.initialize_on_transport(transport)
158
 
        client = _SmartClient(client_medium)
159
 
        path = client.remote_path_from_transport(transport)
160
 
        try:
161
 
            response = client.call('BzrDirFormat.initialize', path)
162
 
        except errors.ErrorFromSmartServer, err:
163
 
            _translate_error(err, path=path)
164
 
        if response[0] != 'ok':
165
 
            raise errors.SmartProtocolError('unexpected response code %s' % (response,))
166
 
        format = RemoteBzrDirFormat()
167
 
        self._supply_sub_formats_to(format)
168
 
        return RemoteBzrDir(transport, format)
169
 
 
170
 
    def parse_NoneTrueFalse(self, arg):
171
 
        if not arg:
172
 
            return None
173
 
        if arg == 'False':
174
 
            return False
175
 
        if arg == 'True':
176
 
            return True
177
 
        raise AssertionError("invalid arg %r" % arg)
178
 
 
179
 
    def _serialize_NoneTrueFalse(self, arg):
180
 
        if arg is False:
181
 
            return 'False'
182
 
        if arg:
183
 
            return 'True'
184
 
        return ''
185
 
 
186
 
    def _serialize_NoneString(self, arg):
187
 
        return arg or ''
188
 
 
189
 
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
190
 
        create_prefix=False, force_new_repo=False, stacked_on=None,
191
 
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
192
 
        shared_repo=False):
193
 
        try:
194
 
            # hand off the request to the smart server
195
 
            client_medium = transport.get_smart_medium()
196
 
        except errors.NoSmartMedium:
197
 
            do_vfs = True
198
 
        else:
199
 
            # Decline to open it if the server doesn't support our required
200
 
            # version (3) so that the VFS-based transport will do it.
201
 
            if client_medium.should_probe():
202
 
                try:
203
 
                    server_version = client_medium.protocol_version()
204
 
                    if server_version != '2':
205
 
                        do_vfs = True
206
 
                    else:
207
 
                        do_vfs = False
208
 
                except errors.SmartProtocolError:
209
 
                    # Apparently there's no usable smart server there, even though
210
 
                    # the medium supports the smart protocol.
211
 
                    do_vfs = True
212
 
            else:
213
 
                do_vfs = False
214
 
        if not do_vfs:
215
 
            client = _SmartClient(client_medium)
216
 
            path = client.remote_path_from_transport(transport)
217
 
            if client_medium._is_remote_before((1, 16)):
218
 
                do_vfs = True
219
 
        if do_vfs:
220
 
            # TODO: lookup the local format from a server hint.
221
 
            local_dir_format = _mod_bzrdir.BzrDirMetaFormat1()
222
 
            self._supply_sub_formats_to(local_dir_format)
223
 
            return local_dir_format.initialize_on_transport_ex(transport,
224
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
225
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
226
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
227
 
                make_working_trees=make_working_trees, shared_repo=shared_repo,
228
 
                vfs_only=True)
229
 
        return self._initialize_on_transport_ex_rpc(client, path, transport,
230
 
            use_existing_dir, create_prefix, force_new_repo, stacked_on,
231
 
            stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
232
 
 
233
 
    def _initialize_on_transport_ex_rpc(self, client, path, transport,
234
 
        use_existing_dir, create_prefix, force_new_repo, stacked_on,
235
 
        stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
236
 
        args = []
237
 
        args.append(self._serialize_NoneTrueFalse(use_existing_dir))
238
 
        args.append(self._serialize_NoneTrueFalse(create_prefix))
239
 
        args.append(self._serialize_NoneTrueFalse(force_new_repo))
240
 
        args.append(self._serialize_NoneString(stacked_on))
241
 
        # stack_on_pwd is often/usually our transport
242
 
        if stack_on_pwd:
243
 
            try:
244
 
                stack_on_pwd = transport.relpath(stack_on_pwd)
245
 
                if not stack_on_pwd:
246
 
                    stack_on_pwd = '.'
247
 
            except errors.PathNotChild:
248
 
                pass
249
 
        args.append(self._serialize_NoneString(stack_on_pwd))
250
 
        args.append(self._serialize_NoneString(repo_format_name))
251
 
        args.append(self._serialize_NoneTrueFalse(make_working_trees))
252
 
        args.append(self._serialize_NoneTrueFalse(shared_repo))
253
 
        request_network_name = self._network_name or \
254
 
            _mod_bzrdir.BzrDirFormat.get_default_format().network_name()
255
 
        try:
256
 
            response = client.call('BzrDirFormat.initialize_ex_1.16',
257
 
                request_network_name, path, *args)
258
 
        except errors.UnknownSmartMethod:
259
 
            client._medium._remember_remote_is_before((1,16))
260
 
            local_dir_format = _mod_bzrdir.BzrDirMetaFormat1()
261
 
            self._supply_sub_formats_to(local_dir_format)
262
 
            return local_dir_format.initialize_on_transport_ex(transport,
263
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
264
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
265
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
266
 
                make_working_trees=make_working_trees, shared_repo=shared_repo,
267
 
                vfs_only=True)
268
 
        except errors.ErrorFromSmartServer, err:
269
 
            _translate_error(err, path=path)
270
 
        repo_path = response[0]
271
 
        bzrdir_name = response[6]
272
 
        require_stacking = response[7]
273
 
        require_stacking = self.parse_NoneTrueFalse(require_stacking)
274
 
        format = RemoteBzrDirFormat()
275
 
        format._network_name = bzrdir_name
276
 
        self._supply_sub_formats_to(format)
277
 
        bzrdir = RemoteBzrDir(transport, format, _client=client)
278
 
        if repo_path:
279
 
            repo_format = response_tuple_to_repo_format(response[1:])
280
 
            if repo_path == '.':
281
 
                repo_path = ''
282
 
            if repo_path:
283
 
                repo_bzrdir_format = RemoteBzrDirFormat()
284
 
                repo_bzrdir_format._network_name = response[5]
285
 
                repo_bzr = RemoteBzrDir(transport.clone(repo_path),
286
 
                    repo_bzrdir_format)
287
 
            else:
288
 
                repo_bzr = bzrdir
289
 
            final_stack = response[8] or None
290
 
            final_stack_pwd = response[9] or None
291
 
            if final_stack_pwd:
292
 
                final_stack_pwd = urlutils.join(
293
 
                    transport.base, final_stack_pwd)
294
 
            remote_repo = RemoteRepository(repo_bzr, repo_format)
295
 
            if len(response) > 10:
296
 
                # Updated server verb that locks remotely.
297
 
                repo_lock_token = response[10] or None
298
 
                remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
299
 
                if repo_lock_token:
300
 
                    remote_repo.dont_leave_lock_in_place()
301
 
            else:
302
 
                remote_repo.lock_write()
303
 
            policy = _mod_bzrdir.UseExistingRepository(remote_repo, final_stack,
304
 
                final_stack_pwd, require_stacking)
305
 
            policy.acquire_repository()
306
 
        else:
307
 
            remote_repo = None
308
 
            policy = None
309
 
        bzrdir._format.set_branch_format(self.get_branch_format())
310
 
        if require_stacking:
311
 
            # The repo has already been created, but we need to make sure that
312
 
            # we'll make a stackable branch.
313
 
            bzrdir._format.require_stacking(_skip_repo=True)
314
 
        return remote_repo, bzrdir, require_stacking, policy
315
 
 
316
 
    def _open(self, transport):
317
 
        return RemoteBzrDir(transport, self)
318
 
 
319
 
    def __eq__(self, other):
320
 
        if not isinstance(other, RemoteBzrDirFormat):
321
 
            return False
322
 
        return self.get_format_description() == other.get_format_description()
323
 
 
324
 
    def __return_repository_format(self):
325
 
        # Always return a RemoteRepositoryFormat object, but if a specific bzr
326
 
        # repository format has been asked for, tell the RemoteRepositoryFormat
327
 
        # that it should use that for init() etc.
328
 
        result = RemoteRepositoryFormat()
329
 
        custom_format = getattr(self, '_repository_format', None)
330
 
        if custom_format:
331
 
            if isinstance(custom_format, RemoteRepositoryFormat):
332
 
                return custom_format
333
 
            else:
334
 
                # We will use the custom format to create repositories over the
335
 
                # wire; expose its details like rich_root_data for code to
336
 
                # query
337
 
                result._custom_format = custom_format
338
 
        return result
339
 
 
340
 
    def get_branch_format(self):
341
 
        result = _mod_bzrdir.BzrDirMetaFormat1.get_branch_format(self)
342
 
        if not isinstance(result, RemoteBranchFormat):
343
 
            new_result = RemoteBranchFormat()
344
 
            new_result._custom_format = result
345
 
            # cache the result
346
 
            self.set_branch_format(new_result)
347
 
            result = new_result
348
 
        return result
349
 
 
350
 
    repository_format = property(__return_repository_format,
351
 
        _mod_bzrdir.BzrDirMetaFormat1._set_repository_format) #.im_func)
352
 
 
353
 
 
354
 
class RemoteControlStore(_mod_config.IniFileStore):
355
 
    """Control store which attempts to use HPSS calls to retrieve control store.
356
 
 
357
 
    Note that this is specific to bzr-based formats.
358
 
    """
359
 
 
360
 
    def __init__(self, bzrdir):
361
 
        super(RemoteControlStore, self).__init__()
362
 
        self.bzrdir = bzrdir
363
 
        self._real_store = None
364
 
 
365
 
    def lock_write(self, token=None):
366
 
        self._ensure_real()
367
 
        return self._real_store.lock_write(token)
368
 
 
369
 
    def unlock(self):
370
 
        self._ensure_real()
371
 
        return self._real_store.unlock()
372
 
 
373
 
    @needs_write_lock
374
 
    def save(self):
375
 
        # We need to be able to override the undecorated implementation
376
 
        self.save_without_locking()
377
 
 
378
 
    def save_without_locking(self):
379
 
        super(RemoteControlStore, self).save()
380
 
 
381
 
    def _ensure_real(self):
382
 
        self.bzrdir._ensure_real()
383
 
        if self._real_store is None:
384
 
            self._real_store = _mod_config.ControlStore(self.bzrdir)
385
 
 
386
 
    def external_url(self):
387
 
        return urlutils.join(self.branch.user_url, 'control.conf')
388
 
 
389
 
    def _load_content(self):
390
 
        medium = self.bzrdir._client._medium
391
 
        path = self.bzrdir._path_for_remote_call(self.bzrdir._client)
392
 
        try:
393
 
            response, handler = self.bzrdir._call_expecting_body(
394
 
                'BzrDir.get_config_file', path)
395
 
        except errors.UnknownSmartMethod:
396
 
            self._ensure_real()
397
 
            return self._real_store._load_content()
398
 
        if len(response) and response[0] != 'ok':
399
 
            raise errors.UnexpectedSmartServerResponse(response)
400
 
        return handler.read_body_bytes()
401
 
 
402
 
    def _save_content(self, content):
403
 
        # FIXME JRV 2011-11-22: Ideally this should use a
404
 
        # HPSS call too, but at the moment it is not possible
405
 
        # to write lock control directories.
406
 
        self._ensure_real()
407
 
        return self._real_store._save_content(content)
408
 
 
409
 
 
410
 
class RemoteBzrDir(_mod_bzrdir.BzrDir, _RpcHelper):
 
42
from bzrlib.pack import ContainerPushParser
 
43
from bzrlib.smart import client, vfs
 
44
from bzrlib.symbol_versioning import (
 
45
    deprecated_in,
 
46
    deprecated_method,
 
47
    )
 
48
from bzrlib.revision import ensure_null, NULL_REVISION
 
49
from bzrlib.trace import mutter, note, warning
 
50
 
 
51
 
 
52
# Note: RemoteBzrDirFormat is in bzrdir.py
 
53
 
 
54
class RemoteBzrDir(BzrDir):
411
55
    """Control directory on a remote server, accessed via bzr:// or similar."""
412
56
 
413
 
    def __init__(self, transport, format, _client=None, _force_probe=False):
 
57
    def __init__(self, transport, _client=None):
414
58
        """Construct a RemoteBzrDir.
415
59
 
416
60
        :param _client: Private parameter for testing. Disables probing and the
417
61
            use of a real bzrdir.
418
62
        """
419
 
        _mod_bzrdir.BzrDir.__init__(self, transport, format)
 
63
        BzrDir.__init__(self, transport, RemoteBzrDirFormat())
420
64
        # this object holds a delegated bzrdir that uses file-level operations
421
65
        # to talk to the other side
422
66
        self._real_bzrdir = None
423
 
        self._has_working_tree = None
424
 
        # 1-shot cache for the call pattern 'create_branch; open_branch' - see
425
 
        # create_branch for details.
426
 
        self._next_open_branch_result = None
427
67
 
428
68
        if _client is None:
429
69
            medium = transport.get_smart_medium()
430
70
            self._client = client._SmartClient(medium)
431
71
        else:
432
72
            self._client = _client
433
 
            if not _force_probe:
434
 
                return
435
 
 
436
 
        self._probe_bzrdir()
437
 
 
438
 
    def __repr__(self):
439
 
        return '%s(%r)' % (self.__class__.__name__, self._client)
440
 
 
441
 
    def _probe_bzrdir(self):
442
 
        medium = self._client._medium
 
73
            return
 
74
 
443
75
        path = self._path_for_remote_call(self._client)
444
 
        if medium._is_remote_before((2, 1)):
445
 
            self._rpc_open(path)
446
 
            return
447
 
        try:
448
 
            self._rpc_open_2_1(path)
449
 
            return
450
 
        except errors.UnknownSmartMethod:
451
 
            medium._remember_remote_is_before((2, 1))
452
 
            self._rpc_open(path)
453
 
 
454
 
    def _rpc_open_2_1(self, path):
455
 
        response = self._call('BzrDir.open_2.1', path)
456
 
        if response == ('no',):
457
 
            raise errors.NotBranchError(path=self.root_transport.base)
458
 
        elif response[0] == 'yes':
459
 
            if response[1] == 'yes':
460
 
                self._has_working_tree = True
461
 
            elif response[1] == 'no':
462
 
                self._has_working_tree = False
463
 
            else:
464
 
                raise errors.UnexpectedSmartServerResponse(response)
465
 
        else:
466
 
            raise errors.UnexpectedSmartServerResponse(response)
467
 
 
468
 
    def _rpc_open(self, path):
469
 
        response = self._call('BzrDir.open', path)
 
76
        response = self._client.call('BzrDir.open', path)
470
77
        if response not in [('yes',), ('no',)]:
471
78
            raise errors.UnexpectedSmartServerResponse(response)
472
79
        if response == ('no',):
473
 
            raise errors.NotBranchError(path=self.root_transport.base)
 
80
            raise errors.NotBranchError(path=transport.base)
474
81
 
475
82
    def _ensure_real(self):
476
83
        """Ensure that there is a _real_bzrdir set.
478
85
        Used before calls to self._real_bzrdir.
479
86
        """
480
87
        if not self._real_bzrdir:
481
 
            if 'hpssvfs' in debug.debug_flags:
482
 
                import traceback
483
 
                warning('VFS BzrDir access triggered\n%s',
484
 
                    ''.join(traceback.format_stack()))
485
 
            self._real_bzrdir = _mod_bzrdir.BzrDir.open_from_transport(
486
 
                self.root_transport, probers=[_mod_bzrdir.BzrProber])
487
 
            self._format._network_name = \
488
 
                self._real_bzrdir._format.network_name()
489
 
 
490
 
    def _translate_error(self, err, **context):
491
 
        _translate_error(err, bzrdir=self, **context)
492
 
 
493
 
    def break_lock(self):
494
 
        # Prevent aliasing problems in the next_open_branch_result cache.
495
 
        # See create_branch for rationale.
496
 
        self._next_open_branch_result = None
497
 
        return _mod_bzrdir.BzrDir.break_lock(self)
498
 
 
499
 
    def _vfs_checkout_metadir(self):
500
 
        self._ensure_real()
501
 
        return self._real_bzrdir.checkout_metadir()
502
 
 
503
 
    def checkout_metadir(self):
504
 
        """Retrieve the controldir format to use for checkouts of this one.
505
 
        """
506
 
        medium = self._client._medium
507
 
        if medium._is_remote_before((2, 5)):
508
 
            return self._vfs_checkout_metadir()
509
 
        path = self._path_for_remote_call(self._client)
510
 
        try:
511
 
            response = self._client.call('BzrDir.checkout_metadir',
512
 
                path)
513
 
        except errors.UnknownSmartMethod:
514
 
            medium._remember_remote_is_before((2, 5))
515
 
            return self._vfs_checkout_metadir()
516
 
        if len(response) != 3:
517
 
            raise errors.UnexpectedSmartServerResponse(response)
518
 
        control_name, repo_name, branch_name = response
519
 
        try:
520
 
            format = controldir.network_format_registry.get(control_name)
521
 
        except KeyError:
522
 
            raise errors.UnknownFormatError(kind='control',
523
 
                format=control_name)
524
 
        if repo_name:
525
 
            try:
526
 
                repo_format = _mod_repository.network_format_registry.get(
527
 
                    repo_name)
528
 
            except KeyError:
529
 
                raise errors.UnknownFormatError(kind='repository',
530
 
                    format=repo_name)
531
 
            format.repository_format = repo_format
532
 
        if branch_name:
533
 
            try:
534
 
                format.set_branch_format(
535
 
                    branch.network_format_registry.get(branch_name))
536
 
            except KeyError:
537
 
                raise errors.UnknownFormatError(kind='branch',
538
 
                    format=branch_name)
539
 
        return format
540
 
 
541
 
    def _vfs_cloning_metadir(self, require_stacking=False):
542
 
        self._ensure_real()
543
 
        return self._real_bzrdir.cloning_metadir(
544
 
            require_stacking=require_stacking)
545
 
 
546
 
    def cloning_metadir(self, require_stacking=False):
547
 
        medium = self._client._medium
548
 
        if medium._is_remote_before((1, 13)):
549
 
            return self._vfs_cloning_metadir(require_stacking=require_stacking)
550
 
        verb = 'BzrDir.cloning_metadir'
551
 
        if require_stacking:
552
 
            stacking = 'True'
553
 
        else:
554
 
            stacking = 'False'
555
 
        path = self._path_for_remote_call(self._client)
556
 
        try:
557
 
            response = self._call(verb, path, stacking)
558
 
        except errors.UnknownSmartMethod:
559
 
            medium._remember_remote_is_before((1, 13))
560
 
            return self._vfs_cloning_metadir(require_stacking=require_stacking)
561
 
        except errors.UnknownErrorFromSmartServer, err:
562
 
            if err.error_tuple != ('BranchReference',):
563
 
                raise
564
 
            # We need to resolve the branch reference to determine the
565
 
            # cloning_metadir.  This causes unnecessary RPCs to open the
566
 
            # referenced branch (and bzrdir, etc) but only when the caller
567
 
            # didn't already resolve the branch reference.
568
 
            referenced_branch = self.open_branch()
569
 
            return referenced_branch.bzrdir.cloning_metadir()
570
 
        if len(response) != 3:
571
 
            raise errors.UnexpectedSmartServerResponse(response)
572
 
        control_name, repo_name, branch_info = response
573
 
        if len(branch_info) != 2:
574
 
            raise errors.UnexpectedSmartServerResponse(response)
575
 
        branch_ref, branch_name = branch_info
576
 
        try:
577
 
            format = controldir.network_format_registry.get(control_name)
578
 
        except KeyError:
579
 
            raise errors.UnknownFormatError(kind='control', format=control_name)
580
 
 
581
 
        if repo_name:
582
 
            try:
583
 
                format.repository_format = _mod_repository.network_format_registry.get(
584
 
                    repo_name)
585
 
            except KeyError:
586
 
                raise errors.UnknownFormatError(kind='repository',
587
 
                    format=repo_name)
588
 
        if branch_ref == 'ref':
589
 
            # XXX: we need possible_transports here to avoid reopening the
590
 
            # connection to the referenced location
591
 
            ref_bzrdir = _mod_bzrdir.BzrDir.open(branch_name)
592
 
            branch_format = ref_bzrdir.cloning_metadir().get_branch_format()
593
 
            format.set_branch_format(branch_format)
594
 
        elif branch_ref == 'branch':
595
 
            if branch_name:
596
 
                try:
597
 
                    branch_format = branch.network_format_registry.get(
598
 
                        branch_name)
599
 
                except KeyError:
600
 
                    raise errors.UnknownFormatError(kind='branch',
601
 
                        format=branch_name)
602
 
                format.set_branch_format(branch_format)
603
 
        else:
604
 
            raise errors.UnexpectedSmartServerResponse(response)
605
 
        return format
 
88
            self._real_bzrdir = BzrDir.open_from_transport(
 
89
                self.root_transport, _server_formats=False)
606
90
 
607
91
    def create_repository(self, shared=False):
608
 
        # as per meta1 formats - just delegate to the format object which may
609
 
        # be parameterised.
610
 
        result = self._format.repository_format.initialize(self, shared)
611
 
        if not isinstance(result, RemoteRepository):
612
 
            return self.open_repository()
613
 
        else:
614
 
            return result
 
92
        self._ensure_real()
 
93
        self._real_bzrdir.create_repository(shared=shared)
 
94
        return self.open_repository()
615
95
 
616
96
    def destroy_repository(self):
617
97
        """See BzrDir.destroy_repository"""
618
 
        path = self._path_for_remote_call(self._client)
619
 
        try:
620
 
            response = self._call('BzrDir.destroy_repository', path)
621
 
        except errors.UnknownSmartMethod:
622
 
            self._ensure_real()
623
 
            self._real_bzrdir.destroy_repository()
624
 
            return
625
 
        if response[0] != 'ok':
626
 
            raise SmartProtocolError('unexpected response code %s' % (response,))
627
 
 
628
 
    def create_branch(self, name=None, repository=None,
629
 
                      append_revisions_only=None):
630
 
        if name is None:
631
 
            name = self._get_selected_branch()
632
 
        if name != "":
633
 
            raise errors.NoColocatedBranchSupport(self)
634
 
        # as per meta1 formats - just delegate to the format object which may
635
 
        # be parameterised.
636
 
        real_branch = self._format.get_branch_format().initialize(self,
637
 
            name=name, repository=repository,
638
 
            append_revisions_only=append_revisions_only)
639
 
        if not isinstance(real_branch, RemoteBranch):
640
 
            if not isinstance(repository, RemoteRepository):
641
 
                raise AssertionError(
642
 
                    'need a RemoteRepository to use with RemoteBranch, got %r'
643
 
                    % (repository,))
644
 
            result = RemoteBranch(self, repository, real_branch, name=name)
645
 
        else:
646
 
            result = real_branch
647
 
        # BzrDir.clone_on_transport() uses the result of create_branch but does
648
 
        # not return it to its callers; we save approximately 8% of our round
649
 
        # trips by handing the branch we created back to the first caller to
650
 
        # open_branch rather than probing anew. Long term we need a API in
651
 
        # bzrdir that doesn't discard result objects (like result_branch).
652
 
        # RBC 20090225
653
 
        self._next_open_branch_result = result
654
 
        return result
655
 
 
656
 
    def destroy_branch(self, name=None):
 
98
        self._ensure_real()
 
99
        self._real_bzrdir.destroy_repository()
 
100
 
 
101
    def create_branch(self):
 
102
        self._ensure_real()
 
103
        real_branch = self._real_bzrdir.create_branch()
 
104
        return RemoteBranch(self, self.find_repository(), real_branch)
 
105
 
 
106
    def destroy_branch(self):
657
107
        """See BzrDir.destroy_branch"""
658
 
        if name is None:
659
 
            name = self._get_selected_branch()
660
 
        if name != "":
661
 
            raise errors.NoColocatedBranchSupport(self)
662
 
        path = self._path_for_remote_call(self._client)
663
 
        try:
664
 
            if name != "":
665
 
                args = (name, )
666
 
            else:
667
 
                args = ()
668
 
            response = self._call('BzrDir.destroy_branch', path, *args)
669
 
        except errors.UnknownSmartMethod:
670
 
            self._ensure_real()
671
 
            self._real_bzrdir.destroy_branch(name=name)
672
 
            self._next_open_branch_result = None
673
 
            return
674
 
        self._next_open_branch_result = None
675
 
        if response[0] != 'ok':
676
 
            raise SmartProtocolError('unexpected response code %s' % (response,))
 
108
        self._ensure_real()
 
109
        self._real_bzrdir.destroy_branch()
677
110
 
678
 
    def create_workingtree(self, revision_id=None, from_branch=None,
679
 
        accelerator_tree=None, hardlink=False):
 
111
    def create_workingtree(self, revision_id=None, from_branch=None):
680
112
        raise errors.NotLocalUrl(self.transport.base)
681
113
 
682
 
    def find_branch_format(self, name=None):
 
114
    def find_branch_format(self):
683
115
        """Find the branch 'format' for this bzrdir.
684
116
 
685
117
        This might be a synthetic object for e.g. RemoteBranch and SVN.
686
118
        """
687
 
        b = self.open_branch(name=name)
 
119
        b = self.open_branch()
688
120
        return b._format
689
121
 
690
 
    def get_branches(self, possible_transports=None, ignore_fallbacks=False):
691
 
        path = self._path_for_remote_call(self._client)
692
 
        try:
693
 
            response, handler = self._call_expecting_body(
694
 
                'BzrDir.get_branches', path)
695
 
        except errors.UnknownSmartMethod:
696
 
            self._ensure_real()
697
 
            return self._real_bzrdir.get_branches()
698
 
        if response[0] != "success":
699
 
            raise errors.UnexpectedSmartServerResponse(response)
700
 
        body = bencode.bdecode(handler.read_body_bytes())
701
 
        ret = {}
702
 
        for (name, value) in body.iteritems():
703
 
            ret[name] = self._open_branch(name, value[0], value[1],
704
 
                possible_transports=possible_transports,
705
 
                ignore_fallbacks=ignore_fallbacks)
706
 
        return ret
707
 
 
708
 
    def set_branch_reference(self, target_branch, name=None):
709
 
        """See BzrDir.set_branch_reference()."""
710
 
        if name is None:
711
 
            name = self._get_selected_branch()
712
 
        if name != "":
713
 
            raise errors.NoColocatedBranchSupport(self)
714
 
        self._ensure_real()
715
 
        return self._real_bzrdir.set_branch_reference(target_branch, name=name)
716
 
 
717
 
    def get_branch_reference(self, name=None):
 
122
    def get_branch_reference(self):
718
123
        """See BzrDir.get_branch_reference()."""
719
 
        if name is None:
720
 
            name = self._get_selected_branch()
721
 
        if name != "":
722
 
            raise errors.NoColocatedBranchSupport(self)
723
 
        response = self._get_branch_reference()
724
 
        if response[0] == 'ref':
725
 
            return response[1]
 
124
        path = self._path_for_remote_call(self._client)
 
125
        try:
 
126
            response = self._client.call('BzrDir.open_branch', path)
 
127
        except errors.ErrorFromSmartServer, err:
 
128
            if err.error_tuple == ('nobranch',):
 
129
                raise errors.NotBranchError(path=self.root_transport.base)
 
130
            raise
 
131
        if response[0] == 'ok':
 
132
            if response[1] == '':
 
133
                # branch at this location.
 
134
                return None
 
135
            else:
 
136
                # a branch reference, use the existing BranchReference logic.
 
137
                return response[1]
726
138
        else:
727
 
            return None
728
 
 
729
 
    def _get_branch_reference(self):
730
 
        path = self._path_for_remote_call(self._client)
731
 
        medium = self._client._medium
732
 
        candidate_calls = [
733
 
            ('BzrDir.open_branchV3', (2, 1)),
734
 
            ('BzrDir.open_branchV2', (1, 13)),
735
 
            ('BzrDir.open_branch', None),
736
 
            ]
737
 
        for verb, required_version in candidate_calls:
738
 
            if required_version and medium._is_remote_before(required_version):
739
 
                continue
740
 
            try:
741
 
                response = self._call(verb, path)
742
 
            except errors.UnknownSmartMethod:
743
 
                if required_version is None:
744
 
                    raise
745
 
                medium._remember_remote_is_before(required_version)
746
 
            else:
747
 
                break
748
 
        if verb == 'BzrDir.open_branch':
749
 
            if response[0] != 'ok':
750
 
                raise errors.UnexpectedSmartServerResponse(response)
751
 
            if response[1] != '':
752
 
                return ('ref', response[1])
753
 
            else:
754
 
                return ('branch', '')
755
 
        if response[0] not in ('ref', 'branch'):
756
139
            raise errors.UnexpectedSmartServerResponse(response)
757
 
        return response
758
140
 
759
 
    def _get_tree_branch(self, name=None):
 
141
    def _get_tree_branch(self):
760
142
        """See BzrDir._get_tree_branch()."""
761
 
        return None, self.open_branch(name=name)
 
143
        return None, self.open_branch()
762
144
 
763
 
    def _open_branch(self, name, kind, location_or_format,
764
 
                     ignore_fallbacks=False, possible_transports=None):
765
 
        if kind == 'ref':
 
145
    def open_branch(self, _unsupported=False):
 
146
        if _unsupported:
 
147
            raise NotImplementedError('unsupported flag support not implemented yet.')
 
148
        reference_url = self.get_branch_reference()
 
149
        if reference_url is None:
 
150
            # branch at this location.
 
151
            return RemoteBranch(self, self.find_repository())
 
152
        else:
766
153
            # a branch reference, use the existing BranchReference logic.
767
154
            format = BranchReferenceFormat()
768
 
            return format.open(self, name=name, _found=True,
769
 
                location=location_or_format, ignore_fallbacks=ignore_fallbacks,
770
 
                possible_transports=possible_transports)
771
 
        branch_format_name = location_or_format
772
 
        if not branch_format_name:
773
 
            branch_format_name = None
774
 
        format = RemoteBranchFormat(network_name=branch_format_name)
775
 
        return RemoteBranch(self, self.find_repository(), format=format,
776
 
            setup_stacking=not ignore_fallbacks, name=name,
777
 
            possible_transports=possible_transports)
778
 
 
779
 
    def open_branch(self, name=None, unsupported=False,
780
 
                    ignore_fallbacks=False, possible_transports=None):
781
 
        if name is None:
782
 
            name = self._get_selected_branch()
783
 
        if name != "":
784
 
            raise errors.NoColocatedBranchSupport(self)
785
 
        if unsupported:
786
 
            raise NotImplementedError('unsupported flag support not implemented yet.')
787
 
        if self._next_open_branch_result is not None:
788
 
            # See create_branch for details.
789
 
            result = self._next_open_branch_result
790
 
            self._next_open_branch_result = None
791
 
            return result
792
 
        response = self._get_branch_reference()
793
 
        return self._open_branch(name, response[0], response[1],
794
 
            possible_transports=possible_transports,
795
 
            ignore_fallbacks=ignore_fallbacks)
796
 
 
797
 
    def _open_repo_v1(self, path):
798
 
        verb = 'BzrDir.find_repository'
799
 
        response = self._call(verb, path)
800
 
        if response[0] != 'ok':
801
 
            raise errors.UnexpectedSmartServerResponse(response)
802
 
        # servers that only support the v1 method don't support external
803
 
        # references either.
804
 
        self._ensure_real()
805
 
        repo = self._real_bzrdir.open_repository()
806
 
        response = response + ('no', repo._format.network_name())
807
 
        return response, repo
808
 
 
809
 
    def _open_repo_v2(self, path):
 
155
            return format.open(self, _found=True, location=reference_url)
 
156
                
 
157
    def open_repository(self):
 
158
        path = self._path_for_remote_call(self._client)
810
159
        verb = 'BzrDir.find_repositoryV2'
811
 
        response = self._call(verb, path)
812
 
        if response[0] != 'ok':
813
 
            raise errors.UnexpectedSmartServerResponse(response)
814
 
        self._ensure_real()
815
 
        repo = self._real_bzrdir.open_repository()
816
 
        response = response + (repo._format.network_name(),)
817
 
        return response, repo
818
 
 
819
 
    def _open_repo_v3(self, path):
820
 
        verb = 'BzrDir.find_repositoryV3'
821
 
        medium = self._client._medium
822
 
        if medium._is_remote_before((1, 13)):
823
 
            raise errors.UnknownSmartMethod(verb)
824
160
        try:
825
 
            response = self._call(verb, path)
826
 
        except errors.UnknownSmartMethod:
827
 
            medium._remember_remote_is_before((1, 13))
828
 
            raise
829
 
        if response[0] != 'ok':
830
 
            raise errors.UnexpectedSmartServerResponse(response)
831
 
        return response, None
832
 
 
833
 
    def open_repository(self):
834
 
        path = self._path_for_remote_call(self._client)
835
 
        response = None
836
 
        for probe in [self._open_repo_v3, self._open_repo_v2,
837
 
            self._open_repo_v1]:
838
161
            try:
839
 
                response, real_repo = probe(path)
840
 
                break
 
162
                response = self._client.call(verb, path)
841
163
            except errors.UnknownSmartMethod:
842
 
                pass
843
 
        if response is None:
844
 
            raise errors.UnknownSmartMethod('BzrDir.find_repository{3,2,}')
 
164
                verb = 'BzrDir.find_repository'
 
165
                response = self._client.call(verb, path)
 
166
        except errors.ErrorFromSmartServer, err:
 
167
            if err.error_verb == 'norepository':
 
168
                raise errors.NoRepositoryPresent(self)
 
169
            raise
845
170
        if response[0] != 'ok':
846
171
            raise errors.UnexpectedSmartServerResponse(response)
847
 
        if len(response) != 6:
 
172
        if verb == 'BzrDir.find_repository':
 
173
            # servers that don't support the V2 method don't support external
 
174
            # references either.
 
175
            response = response + ('no', )
 
176
        if not (len(response) == 5):
848
177
            raise SmartProtocolError('incorrect response length %s' % (response,))
849
178
        if response[1] == '':
850
 
            # repo is at this dir.
851
 
            format = response_tuple_to_repo_format(response[2:])
852
 
            # Used to support creating a real format instance when needed.
853
 
            format._creating_bzrdir = self
854
 
            remote_repo = RemoteRepository(self, format)
855
 
            format._creating_repo = remote_repo
856
 
            if real_repo is not None:
857
 
                remote_repo._set_real_repository(real_repo)
858
 
            return remote_repo
 
179
            format = RemoteRepositoryFormat()
 
180
            format.rich_root_data = (response[2] == 'yes')
 
181
            format.supports_tree_reference = (response[3] == 'yes')
 
182
            # No wire format to check this yet.
 
183
            format.supports_external_lookups = (response[4] == 'yes')
 
184
            return RemoteRepository(self, format)
859
185
        else:
860
186
            raise errors.NoRepositoryPresent(self)
861
187
 
862
 
    def has_workingtree(self):
863
 
        if self._has_working_tree is None:
864
 
            path = self._path_for_remote_call(self._client)
865
 
            try:
866
 
                response = self._call('BzrDir.has_workingtree', path)
867
 
            except errors.UnknownSmartMethod:
868
 
                self._ensure_real()
869
 
                self._has_working_tree = self._real_bzrdir.has_workingtree()
870
 
            else:
871
 
                if response[0] not in ('yes', 'no'):
872
 
                    raise SmartProtocolError('unexpected response code %s' % (response,))
873
 
                self._has_working_tree = (response[0] == 'yes')
874
 
        return self._has_working_tree
875
 
 
876
188
    def open_workingtree(self, recommend_upgrade=True):
877
 
        if self.has_workingtree():
 
189
        self._ensure_real()
 
190
        if self._real_bzrdir.has_workingtree():
878
191
            raise errors.NotLocalUrl(self.root_transport)
879
192
        else:
880
193
            raise errors.NoWorkingTree(self.root_transport.base)
881
194
 
882
195
    def _path_for_remote_call(self, client):
883
196
        """Return the path to be used for this bzrdir in a remote call."""
884
 
        return urlutils.split_segment_parameters_raw(
885
 
            client.remote_path_from_transport(self.root_transport))[0]
 
197
        return client.remote_path_from_transport(self.root_transport)
886
198
 
887
 
    def get_branch_transport(self, branch_format, name=None):
 
199
    def get_branch_transport(self, branch_format):
888
200
        self._ensure_real()
889
 
        return self._real_bzrdir.get_branch_transport(branch_format, name=name)
 
201
        return self._real_bzrdir.get_branch_transport(branch_format)
890
202
 
891
203
    def get_repository_transport(self, repository_format):
892
204
        self._ensure_real()
900
212
        """Upgrading of remote bzrdirs is not supported yet."""
901
213
        return False
902
214
 
903
 
    def needs_format_conversion(self, format):
 
215
    def needs_format_conversion(self, format=None):
904
216
        """Upgrading of remote bzrdirs is not supported yet."""
905
217
        return False
906
218
 
907
 
    def _get_config(self):
908
 
        return RemoteBzrDirConfig(self)
909
 
 
910
 
    def _get_config_store(self):
911
 
        return RemoteControlStore(self)
912
 
 
913
 
 
914
 
class RemoteRepositoryFormat(vf_repository.VersionedFileRepositoryFormat):
 
219
    def clone(self, url, revision_id=None, force_new_repo=False):
 
220
        self._ensure_real()
 
221
        return self._real_bzrdir.clone(url, revision_id=revision_id,
 
222
            force_new_repo=force_new_repo)
 
223
 
 
224
 
 
225
class RemoteRepositoryFormat(repository.RepositoryFormat):
915
226
    """Format for repositories accessed over a _SmartClient.
916
227
 
917
228
    Instances of this repository are represented by RemoteRepository
922
233
    the attributes rich_root_data and supports_tree_reference are set
923
234
    on a per instance basis, and are not set (and should not be) at
924
235
    the class level.
925
 
 
926
 
    :ivar _custom_format: If set, a specific concrete repository format that
927
 
        will be used when initializing a repository with this
928
 
        RemoteRepositoryFormat.
929
 
    :ivar _creating_repo: If set, the repository object that this
930
 
        RemoteRepositoryFormat was created for: it can be called into
931
 
        to obtain data like the network name.
932
236
    """
933
237
 
934
 
    _matchingbzrdir = RemoteBzrDirFormat()
935
 
    supports_full_versioned_files = True
936
 
    supports_leaving_lock = True
937
 
 
938
 
    def __init__(self):
939
 
        _mod_repository.RepositoryFormat.__init__(self)
940
 
        self._custom_format = None
941
 
        self._network_name = None
942
 
        self._creating_bzrdir = None
943
 
        self._revision_graph_can_have_wrong_parents = None
944
 
        self._supports_chks = None
945
 
        self._supports_external_lookups = None
946
 
        self._supports_tree_reference = None
947
 
        self._supports_funky_characters = None
948
 
        self._supports_nesting_repositories = None
949
 
        self._rich_root_data = None
950
 
 
951
 
    def __repr__(self):
952
 
        return "%s(_network_name=%r)" % (self.__class__.__name__,
953
 
            self._network_name)
954
 
 
955
 
    @property
956
 
    def fast_deltas(self):
957
 
        self._ensure_real()
958
 
        return self._custom_format.fast_deltas
959
 
 
960
 
    @property
961
 
    def rich_root_data(self):
962
 
        if self._rich_root_data is None:
963
 
            self._ensure_real()
964
 
            self._rich_root_data = self._custom_format.rich_root_data
965
 
        return self._rich_root_data
966
 
 
967
 
    @property
968
 
    def supports_chks(self):
969
 
        if self._supports_chks is None:
970
 
            self._ensure_real()
971
 
            self._supports_chks = self._custom_format.supports_chks
972
 
        return self._supports_chks
973
 
 
974
 
    @property
975
 
    def supports_external_lookups(self):
976
 
        if self._supports_external_lookups is None:
977
 
            self._ensure_real()
978
 
            self._supports_external_lookups = \
979
 
                self._custom_format.supports_external_lookups
980
 
        return self._supports_external_lookups
981
 
 
982
 
    @property
983
 
    def supports_funky_characters(self):
984
 
        if self._supports_funky_characters is None:
985
 
            self._ensure_real()
986
 
            self._supports_funky_characters = \
987
 
                self._custom_format.supports_funky_characters
988
 
        return self._supports_funky_characters
989
 
 
990
 
    @property
991
 
    def supports_nesting_repositories(self):
992
 
        if self._supports_nesting_repositories is None:
993
 
            self._ensure_real()
994
 
            self._supports_nesting_repositories = \
995
 
                self._custom_format.supports_nesting_repositories
996
 
        return self._supports_nesting_repositories
997
 
 
998
 
    @property
999
 
    def supports_tree_reference(self):
1000
 
        if self._supports_tree_reference is None:
1001
 
            self._ensure_real()
1002
 
            self._supports_tree_reference = \
1003
 
                self._custom_format.supports_tree_reference
1004
 
        return self._supports_tree_reference
1005
 
 
1006
 
    @property
1007
 
    def revision_graph_can_have_wrong_parents(self):
1008
 
        if self._revision_graph_can_have_wrong_parents is None:
1009
 
            self._ensure_real()
1010
 
            self._revision_graph_can_have_wrong_parents = \
1011
 
                self._custom_format.revision_graph_can_have_wrong_parents
1012
 
        return self._revision_graph_can_have_wrong_parents
1013
 
 
1014
 
    def _vfs_initialize(self, a_bzrdir, shared):
1015
 
        """Helper for common code in initialize."""
1016
 
        if self._custom_format:
1017
 
            # Custom format requested
1018
 
            result = self._custom_format.initialize(a_bzrdir, shared=shared)
1019
 
        elif self._creating_bzrdir is not None:
1020
 
            # Use the format that the repository we were created to back
1021
 
            # has.
1022
 
            prior_repo = self._creating_bzrdir.open_repository()
1023
 
            prior_repo._ensure_real()
1024
 
            result = prior_repo._real_repository._format.initialize(
1025
 
                a_bzrdir, shared=shared)
1026
 
        else:
1027
 
            # assume that a_bzr is a RemoteBzrDir but the smart server didn't
1028
 
            # support remote initialization.
1029
 
            # We delegate to a real object at this point (as RemoteBzrDir
1030
 
            # delegate to the repository format which would lead to infinite
1031
 
            # recursion if we just called a_bzrdir.create_repository.
1032
 
            a_bzrdir._ensure_real()
1033
 
            result = a_bzrdir._real_bzrdir.create_repository(shared=shared)
1034
 
        if not isinstance(result, RemoteRepository):
1035
 
            return self.open(a_bzrdir)
1036
 
        else:
1037
 
            return result
 
238
    _matchingbzrdir = RemoteBzrDirFormat
1038
239
 
1039
240
    def initialize(self, a_bzrdir, shared=False):
1040
 
        # Being asked to create on a non RemoteBzrDir:
1041
241
        if not isinstance(a_bzrdir, RemoteBzrDir):
1042
 
            return self._vfs_initialize(a_bzrdir, shared)
1043
 
        medium = a_bzrdir._client._medium
1044
 
        if medium._is_remote_before((1, 13)):
1045
 
            return self._vfs_initialize(a_bzrdir, shared)
1046
 
        # Creating on a remote bzr dir.
1047
 
        # 1) get the network name to use.
1048
 
        if self._custom_format:
1049
 
            network_name = self._custom_format.network_name()
1050
 
        elif self._network_name:
1051
 
            network_name = self._network_name
1052
 
        else:
1053
 
            # Select the current bzrlib default and ask for that.
1054
 
            reference_bzrdir_format = controldir.format_registry.get('default')()
1055
 
            reference_format = reference_bzrdir_format.repository_format
1056
 
            network_name = reference_format.network_name()
1057
 
        # 2) try direct creation via RPC
1058
 
        path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
1059
 
        verb = 'BzrDir.create_repository'
1060
 
        if shared:
1061
 
            shared_str = 'True'
1062
 
        else:
1063
 
            shared_str = 'False'
1064
 
        try:
1065
 
            response = a_bzrdir._call(verb, path, network_name, shared_str)
1066
 
        except errors.UnknownSmartMethod:
1067
 
            # Fallback - use vfs methods
1068
 
            medium._remember_remote_is_before((1, 13))
1069
 
            return self._vfs_initialize(a_bzrdir, shared)
1070
 
        else:
1071
 
            # Turn the response into a RemoteRepository object.
1072
 
            format = response_tuple_to_repo_format(response[1:])
1073
 
            # Used to support creating a real format instance when needed.
1074
 
            format._creating_bzrdir = a_bzrdir
1075
 
            remote_repo = RemoteRepository(a_bzrdir, format)
1076
 
            format._creating_repo = remote_repo
1077
 
            return remote_repo
1078
 
 
 
242
            raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
 
243
        return a_bzrdir.create_repository(shared=shared)
 
244
    
1079
245
    def open(self, a_bzrdir):
1080
246
        if not isinstance(a_bzrdir, RemoteBzrDir):
1081
247
            raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
1082
248
        return a_bzrdir.open_repository()
1083
249
 
1084
 
    def _ensure_real(self):
1085
 
        if self._custom_format is None:
1086
 
            try:
1087
 
                self._custom_format = _mod_repository.network_format_registry.get(
1088
 
                    self._network_name)
1089
 
            except KeyError:
1090
 
                raise errors.UnknownFormatError(kind='repository',
1091
 
                    format=self._network_name)
1092
 
 
1093
 
    @property
1094
 
    def _fetch_order(self):
1095
 
        self._ensure_real()
1096
 
        return self._custom_format._fetch_order
1097
 
 
1098
 
    @property
1099
 
    def _fetch_uses_deltas(self):
1100
 
        self._ensure_real()
1101
 
        return self._custom_format._fetch_uses_deltas
1102
 
 
1103
 
    @property
1104
 
    def _fetch_reconcile(self):
1105
 
        self._ensure_real()
1106
 
        return self._custom_format._fetch_reconcile
1107
 
 
1108
250
    def get_format_description(self):
1109
 
        self._ensure_real()
1110
 
        return 'Remote: ' + self._custom_format.get_format_description()
 
251
        return 'bzr remote repository'
1111
252
 
1112
253
    def __eq__(self, other):
1113
 
        return self.__class__ is other.__class__
1114
 
 
1115
 
    def network_name(self):
1116
 
        if self._network_name:
1117
 
            return self._network_name
1118
 
        self._creating_repo._ensure_real()
1119
 
        return self._creating_repo._real_repository._format.network_name()
1120
 
 
1121
 
    @property
1122
 
    def pack_compresses(self):
1123
 
        self._ensure_real()
1124
 
        return self._custom_format.pack_compresses
1125
 
 
1126
 
    @property
1127
 
    def _serializer(self):
1128
 
        self._ensure_real()
1129
 
        return self._custom_format._serializer
1130
 
 
1131
 
 
1132
 
class RemoteRepository(_mod_repository.Repository, _RpcHelper,
1133
 
        lock._RelockDebugMixin):
 
254
        return self.__class__ == other.__class__
 
255
 
 
256
    def check_conversion_target(self, target_format):
 
257
        if self.rich_root_data and not target_format.rich_root_data:
 
258
            raise errors.BadConversionTarget(
 
259
                'Does not support rich root data.', target_format)
 
260
        if (self.supports_tree_reference and
 
261
            not getattr(target_format, 'supports_tree_reference', False)):
 
262
            raise errors.BadConversionTarget(
 
263
                'Does not support nested trees', target_format)
 
264
 
 
265
 
 
266
class RemoteRepository(object):
1134
267
    """Repository accessed over rpc.
1135
268
 
1136
269
    For the moment most operations are performed using local transport-backed
1139
272
 
1140
273
    def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
1141
274
        """Create a RemoteRepository instance.
1142
 
 
 
275
        
1143
276
        :param remote_bzrdir: The bzrdir hosting this repository.
1144
277
        :param format: The RemoteFormat object to use.
1145
278
        :param real_repository: If not None, a local implementation of the
1160
293
        self._format = format
1161
294
        self._lock_mode = None
1162
295
        self._lock_token = None
1163
 
        self._write_group_tokens = None
1164
296
        self._lock_count = 0
1165
297
        self._leave_lock = False
1166
 
        # Cache of revision parents; misses are cached during read locks, and
1167
 
        # write locks when no _real_repository has been set.
1168
 
        self._unstacked_provider = graph.CachingParentsProvider(
1169
 
            get_parent_map=self._get_parent_map_rpc)
1170
 
        self._unstacked_provider.disable_cache()
 
298
        # A cache of looked up revision parent data; reset at unlock time.
 
299
        self._parents_map = None
 
300
        if 'hpss' in debug.debug_flags:
 
301
            self._requested_parents = None
1171
302
        # For tests:
1172
303
        # These depend on the actual remote format, so force them off for
1173
304
        # maximum compatibility. XXX: In future these should depend on the
1177
308
        self._reconcile_fixes_text_parents = False
1178
309
        self._reconcile_backsup_inventory = False
1179
310
        self.base = self.bzrdir.transport.base
1180
 
        # Additional places to query for data.
1181
 
        self._fallback_repositories = []
1182
 
 
1183
 
    @property
1184
 
    def user_transport(self):
1185
 
        return self.bzrdir.user_transport
1186
 
 
1187
 
    @property
1188
 
    def control_transport(self):
1189
 
        # XXX: Normally you shouldn't directly get at the remote repository
1190
 
        # transport, but I'm not sure it's worth making this method
1191
 
        # optional -- mbp 2010-04-21
1192
 
        return self.bzrdir.get_repository_transport(None)
1193
311
 
1194
312
    def __str__(self):
1195
313
        return "%s(%s)" % (self.__class__.__name__, self.base)
1196
314
 
1197
315
    __repr__ = __str__
1198
316
 
1199
 
    def abort_write_group(self, suppress_errors=False):
 
317
    def abort_write_group(self):
1200
318
        """Complete a write group on the decorated repository.
1201
 
 
1202
 
        Smart methods perform operations in a single step so this API
 
319
        
 
320
        Smart methods peform operations in a single step so this api
1203
321
        is not really applicable except as a compatibility thunk
1204
322
        for older plugins that don't use e.g. the CommitBuilder
1205
323
        facility.
1206
 
 
1207
 
        :param suppress_errors: see Repository.abort_write_group.
1208
 
        """
1209
 
        if self._real_repository:
1210
 
            self._ensure_real()
1211
 
            return self._real_repository.abort_write_group(
1212
 
                suppress_errors=suppress_errors)
1213
 
        if not self.is_in_write_group():
1214
 
            if suppress_errors:
1215
 
                mutter('(suppressed) not in write group')
1216
 
                return
1217
 
            raise errors.BzrError("not in write group")
1218
 
        path = self.bzrdir._path_for_remote_call(self._client)
1219
 
        try:
1220
 
            response = self._call('Repository.abort_write_group', path,
1221
 
                self._lock_token, self._write_group_tokens)
1222
 
        except Exception, exc:
1223
 
            self._write_group = None
1224
 
            if not suppress_errors:
1225
 
                raise
1226
 
            mutter('abort_write_group failed')
1227
 
            log_exception_quietly()
1228
 
            note(gettext('bzr: ERROR (ignored): %s'), exc)
1229
 
        else:
1230
 
            if response != ('ok', ):
1231
 
                raise errors.UnexpectedSmartServerResponse(response)
1232
 
            self._write_group_tokens = None
1233
 
 
1234
 
    @property
1235
 
    def chk_bytes(self):
1236
 
        """Decorate the real repository for now.
1237
 
 
1238
 
        In the long term a full blown network facility is needed to avoid
1239
 
        creating a real repository object locally.
1240
324
        """
1241
325
        self._ensure_real()
1242
 
        return self._real_repository.chk_bytes
 
326
        return self._real_repository.abort_write_group()
1243
327
 
1244
328
    def commit_write_group(self):
1245
329
        """Complete a write group on the decorated repository.
1246
 
 
1247
 
        Smart methods perform operations in a single step so this API
 
330
        
 
331
        Smart methods peform operations in a single step so this api
1248
332
        is not really applicable except as a compatibility thunk
1249
333
        for older plugins that don't use e.g. the CommitBuilder
1250
334
        facility.
1251
335
        """
1252
 
        if self._real_repository:
1253
 
            self._ensure_real()
1254
 
            return self._real_repository.commit_write_group()
1255
 
        if not self.is_in_write_group():
1256
 
            raise errors.BzrError("not in write group")
1257
 
        path = self.bzrdir._path_for_remote_call(self._client)
1258
 
        response = self._call('Repository.commit_write_group', path,
1259
 
            self._lock_token, self._write_group_tokens)
1260
 
        if response != ('ok', ):
1261
 
            raise errors.UnexpectedSmartServerResponse(response)
1262
 
        self._write_group_tokens = None
1263
 
        # Refresh data after writing to the repository.
1264
 
        self.refresh_data()
1265
 
 
1266
 
    def resume_write_group(self, tokens):
1267
 
        if self._real_repository:
1268
 
            return self._real_repository.resume_write_group(tokens)
1269
 
        path = self.bzrdir._path_for_remote_call(self._client)
1270
 
        try:
1271
 
            response = self._call('Repository.check_write_group', path,
1272
 
               self._lock_token, tokens)
1273
 
        except errors.UnknownSmartMethod:
1274
 
            self._ensure_real()
1275
 
            return self._real_repository.resume_write_group(tokens)
1276
 
        if response != ('ok', ):
1277
 
            raise errors.UnexpectedSmartServerResponse(response)
1278
 
        self._write_group_tokens = tokens
1279
 
 
1280
 
    def suspend_write_group(self):
1281
 
        if self._real_repository:
1282
 
            return self._real_repository.suspend_write_group()
1283
 
        ret = self._write_group_tokens or []
1284
 
        self._write_group_tokens = None
1285
 
        return ret
1286
 
 
1287
 
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
1288
 
        self._ensure_real()
1289
 
        return self._real_repository.get_missing_parent_inventories(
1290
 
            check_for_missing_texts=check_for_missing_texts)
1291
 
 
1292
 
    def _get_rev_id_for_revno_vfs(self, revno, known_pair):
1293
 
        self._ensure_real()
1294
 
        return self._real_repository.get_rev_id_for_revno(
1295
 
            revno, known_pair)
1296
 
 
1297
 
    def get_rev_id_for_revno(self, revno, known_pair):
1298
 
        """See Repository.get_rev_id_for_revno."""
1299
 
        path = self.bzrdir._path_for_remote_call(self._client)
1300
 
        try:
1301
 
            if self._client._medium._is_remote_before((1, 17)):
1302
 
                return self._get_rev_id_for_revno_vfs(revno, known_pair)
1303
 
            response = self._call(
1304
 
                'Repository.get_rev_id_for_revno', path, revno, known_pair)
1305
 
        except errors.UnknownSmartMethod:
1306
 
            self._client._medium._remember_remote_is_before((1, 17))
1307
 
            return self._get_rev_id_for_revno_vfs(revno, known_pair)
1308
 
        if response[0] == 'ok':
1309
 
            return True, response[1]
1310
 
        elif response[0] == 'history-incomplete':
1311
 
            known_pair = response[1:3]
1312
 
            for fallback in self._fallback_repositories:
1313
 
                found, result = fallback.get_rev_id_for_revno(revno, known_pair)
1314
 
                if found:
1315
 
                    return True, result
1316
 
                else:
1317
 
                    known_pair = result
1318
 
            # Not found in any fallbacks
1319
 
            return False, known_pair
1320
 
        else:
1321
 
            raise errors.UnexpectedSmartServerResponse(response)
 
336
        self._ensure_real()
 
337
        return self._real_repository.commit_write_group()
1322
338
 
1323
339
    def _ensure_real(self):
1324
340
        """Ensure that there is a _real_repository set.
1325
341
 
1326
342
        Used before calls to self._real_repository.
1327
 
 
1328
 
        Note that _ensure_real causes many roundtrips to the server which are
1329
 
        not desirable, and prevents the use of smart one-roundtrip RPC's to
1330
 
        perform complex operations (such as accessing parent data, streaming
1331
 
        revisions etc). Adding calls to _ensure_real should only be done when
1332
 
        bringing up new functionality, adding fallbacks for smart methods that
1333
 
        require a fallback path, and never to replace an existing smart method
1334
 
        invocation. If in doubt chat to the bzr network team.
1335
343
        """
1336
 
        if self._real_repository is None:
1337
 
            if 'hpssvfs' in debug.debug_flags:
1338
 
                import traceback
1339
 
                warning('VFS Repository access triggered\n%s',
1340
 
                    ''.join(traceback.format_stack()))
1341
 
            self._unstacked_provider.missing_keys.clear()
 
344
        if not self._real_repository:
1342
345
            self.bzrdir._ensure_real()
1343
 
            self._set_real_repository(
1344
 
                self.bzrdir._real_bzrdir.open_repository())
1345
 
 
1346
 
    def _translate_error(self, err, **context):
1347
 
        self.bzrdir._translate_error(err, repository=self, **context)
 
346
            #self._real_repository = self.bzrdir._real_bzrdir.open_repository()
 
347
            self._set_real_repository(self.bzrdir._real_bzrdir.open_repository())
1348
348
 
1349
349
    def find_text_key_references(self):
1350
350
        """Find the text key references within the repository.
1351
351
 
 
352
        :return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
 
353
        revision_ids. Each altered file-ids has the exact revision_ids that
 
354
        altered it listed explicitly.
1352
355
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
1353
356
            to whether they were referred to by the inventory of the
1354
357
            revision_id that they contain. The inventory texts from all present
1368
371
        self._ensure_real()
1369
372
        return self._real_repository._generate_text_key_index()
1370
373
 
 
374
    @symbol_versioning.deprecated_method(symbol_versioning.one_four)
 
375
    def get_revision_graph(self, revision_id=None):
 
376
        """See Repository.get_revision_graph()."""
 
377
        return self._get_revision_graph(revision_id)
 
378
 
1371
379
    def _get_revision_graph(self, revision_id):
1372
380
        """Private method for using with old (< 1.2) servers to fallback."""
1373
381
        if revision_id is None:
1374
382
            revision_id = ''
1375
 
        elif _mod_revision.is_null(revision_id):
 
383
        elif revision.is_null(revision_id):
1376
384
            return {}
1377
385
 
1378
386
        path = self.bzrdir._path_for_remote_call(self._client)
1379
 
        response = self._call_expecting_body(
1380
 
            'Repository.get_revision_graph', path, revision_id)
 
387
        try:
 
388
            response = self._client.call_expecting_body(
 
389
                'Repository.get_revision_graph', path, revision_id)
 
390
        except errors.ErrorFromSmartServer, err:
 
391
            if err.error_verb == 'nosuchrevision':
 
392
                raise NoSuchRevision(self, revision_id)
 
393
            raise
1381
394
        response_tuple, response_handler = response
1382
395
        if response_tuple[0] != 'ok':
1383
396
            raise errors.UnexpectedSmartServerResponse(response_tuple)
1390
403
        for line in lines:
1391
404
            d = tuple(line.split())
1392
405
            revision_graph[d[0]] = d[1:]
1393
 
 
 
406
            
1394
407
        return revision_graph
1395
408
 
1396
 
    def _get_sink(self):
1397
 
        """See Repository._get_sink()."""
1398
 
        return RemoteStreamSink(self)
1399
 
 
1400
 
    def _get_source(self, to_format):
1401
 
        """Return a source for streaming from this repository."""
1402
 
        return RemoteStreamSource(self, to_format)
1403
 
 
1404
 
    @needs_read_lock
1405
 
    def get_file_graph(self):
1406
 
        return graph.Graph(self.texts)
1407
 
 
1408
 
    @needs_read_lock
1409
409
    def has_revision(self, revision_id):
1410
 
        """True if this repository has a copy of the revision."""
1411
 
        # Copy of bzrlib.repository.Repository.has_revision
1412
 
        return revision_id in self.has_revisions((revision_id,))
 
410
        """See Repository.has_revision()."""
 
411
        if revision_id == NULL_REVISION:
 
412
            # The null revision is always present.
 
413
            return True
 
414
        path = self.bzrdir._path_for_remote_call(self._client)
 
415
        response = self._client.call(
 
416
            'Repository.has_revision', path, revision_id)
 
417
        if response[0] not in ('yes', 'no'):
 
418
            raise errors.UnexpectedSmartServerResponse(response)
 
419
        return response[0] == 'yes'
1413
420
 
1414
 
    @needs_read_lock
1415
421
    def has_revisions(self, revision_ids):
1416
 
        """Probe to find out the presence of multiple revisions.
1417
 
 
1418
 
        :param revision_ids: An iterable of revision_ids.
1419
 
        :return: A set of the revision_ids that were present.
1420
 
        """
1421
 
        # Copy of bzrlib.repository.Repository.has_revisions
1422
 
        parent_map = self.get_parent_map(revision_ids)
1423
 
        result = set(parent_map)
1424
 
        if _mod_revision.NULL_REVISION in revision_ids:
1425
 
            result.add(_mod_revision.NULL_REVISION)
 
422
        """See Repository.has_revisions()."""
 
423
        result = set()
 
424
        for revision_id in revision_ids:
 
425
            if self.has_revision(revision_id):
 
426
                result.add(revision_id)
1426
427
        return result
1427
428
 
1428
 
    def _has_same_fallbacks(self, other_repo):
1429
 
        """Returns true if the repositories have the same fallbacks."""
1430
 
        # XXX: copied from Repository; it should be unified into a base class
1431
 
        # <https://bugs.launchpad.net/bzr/+bug/401622>
1432
 
        my_fb = self._fallback_repositories
1433
 
        other_fb = other_repo._fallback_repositories
1434
 
        if len(my_fb) != len(other_fb):
1435
 
            return False
1436
 
        for f, g in zip(my_fb, other_fb):
1437
 
            if not f.has_same_location(g):
1438
 
                return False
1439
 
        return True
1440
 
 
1441
429
    def has_same_location(self, other):
1442
 
        # TODO: Move to RepositoryBase and unify with the regular Repository
1443
 
        # one; unfortunately the tests rely on slightly different behaviour at
1444
 
        # present -- mbp 20090710
1445
 
        return (self.__class__ is other.__class__ and
 
430
        return (self.__class__ == other.__class__ and
1446
431
                self.bzrdir.transport.base == other.bzrdir.transport.base)
1447
 
 
 
432
        
1448
433
    def get_graph(self, other_repository=None):
1449
434
        """Return the graph for this repository format"""
1450
 
        parents_provider = self._make_parents_provider(other_repository)
 
435
        parents_provider = self
 
436
        if (other_repository is not None and
 
437
            other_repository.bzrdir.transport.base !=
 
438
            self.bzrdir.transport.base):
 
439
            parents_provider = graph._StackedParentsProvider(
 
440
                [parents_provider, other_repository._make_parents_provider()])
1451
441
        return graph.Graph(parents_provider)
1452
442
 
1453
 
    @needs_read_lock
1454
 
    def get_known_graph_ancestry(self, revision_ids):
1455
 
        """Return the known graph for a set of revision ids and their ancestors.
1456
 
        """
1457
 
        st = static_tuple.StaticTuple
1458
 
        revision_keys = [st(r_id).intern() for r_id in revision_ids]
1459
 
        known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
1460
 
        return graph.GraphThunkIdsToKeys(known_graph)
1461
 
 
1462
443
    def gather_stats(self, revid=None, committers=None):
1463
444
        """See Repository.gather_stats()."""
1464
445
        path = self.bzrdir._path_for_remote_call(self._client)
1465
446
        # revid can be None to indicate no revisions, not just NULL_REVISION
1466
 
        if revid is None or _mod_revision.is_null(revid):
 
447
        if revid is None or revision.is_null(revid):
1467
448
            fmt_revid = ''
1468
449
        else:
1469
450
            fmt_revid = revid
1471
452
            fmt_committers = 'no'
1472
453
        else:
1473
454
            fmt_committers = 'yes'
1474
 
        response_tuple, response_handler = self._call_expecting_body(
 
455
        response_tuple, response_handler = self._client.call_expecting_body(
1475
456
            'Repository.gather_stats', path, fmt_revid, fmt_committers)
1476
457
        if response_tuple[0] != 'ok':
1477
458
            raise errors.UnexpectedSmartServerResponse(response_tuple)
1498
479
 
1499
480
    def get_physical_lock_status(self):
1500
481
        """See Repository.get_physical_lock_status()."""
1501
 
        path = self.bzrdir._path_for_remote_call(self._client)
1502
 
        try:
1503
 
            response = self._call('Repository.get_physical_lock_status', path)
1504
 
        except errors.UnknownSmartMethod:
1505
 
            self._ensure_real()
1506
 
            return self._real_repository.get_physical_lock_status()
1507
 
        if response[0] not in ('yes', 'no'):
1508
 
            raise errors.UnexpectedSmartServerResponse(response)
1509
 
        return (response[0] == 'yes')
 
482
        # should be an API call to the server.
 
483
        self._ensure_real()
 
484
        return self._real_repository.get_physical_lock_status()
1510
485
 
1511
486
    def is_in_write_group(self):
1512
487
        """Return True if there is an open write group.
1513
488
 
1514
489
        write groups are only applicable locally for the smart server..
1515
490
        """
1516
 
        if self._write_group_tokens is not None:
1517
 
            return True
1518
491
        if self._real_repository:
1519
492
            return self._real_repository.is_in_write_group()
1520
493
 
1524
497
    def is_shared(self):
1525
498
        """See Repository.is_shared()."""
1526
499
        path = self.bzrdir._path_for_remote_call(self._client)
1527
 
        response = self._call('Repository.is_shared', path)
 
500
        response = self._client.call('Repository.is_shared', path)
1528
501
        if response[0] not in ('yes', 'no'):
1529
502
            raise SmartProtocolError('unexpected response code %s' % (response,))
1530
503
        return response[0] == 'yes'
1532
505
    def is_write_locked(self):
1533
506
        return self._lock_mode == 'w'
1534
507
 
1535
 
    def _warn_if_deprecated(self, branch=None):
1536
 
        # If we have a real repository, the check will be done there, if we
1537
 
        # don't the check will be done remotely.
1538
 
        pass
1539
 
 
1540
508
    def lock_read(self):
1541
 
        """Lock the repository for read operations.
1542
 
 
1543
 
        :return: A bzrlib.lock.LogicalLockResult.
1544
 
        """
1545
509
        # wrong eventually - want a local lock cache context
1546
510
        if not self._lock_mode:
1547
 
            self._note_lock('r')
1548
511
            self._lock_mode = 'r'
1549
512
            self._lock_count = 1
1550
 
            self._unstacked_provider.enable_cache(cache_misses=True)
 
513
            self._parents_map = {}
 
514
            if 'hpss' in debug.debug_flags:
 
515
                self._requested_parents = set()
1551
516
            if self._real_repository is not None:
1552
517
                self._real_repository.lock_read()
1553
 
            for repo in self._fallback_repositories:
1554
 
                repo.lock_read()
1555
518
        else:
1556
519
            self._lock_count += 1
1557
 
        return lock.LogicalLockResult(self.unlock)
1558
520
 
1559
521
    def _remote_lock_write(self, token):
1560
522
        path = self.bzrdir._path_for_remote_call(self._client)
1561
523
        if token is None:
1562
524
            token = ''
1563
 
        err_context = {'token': token}
1564
 
        response = self._call('Repository.lock_write', path, token,
1565
 
                              **err_context)
 
525
        try:
 
526
            response = self._client.call('Repository.lock_write', path, token)
 
527
        except errors.ErrorFromSmartServer, err:
 
528
            if err.error_verb == 'LockContention':
 
529
                raise errors.LockContention('(remote lock)')
 
530
            elif err.error_verb == 'UnlockableTransport':
 
531
                raise errors.UnlockableTransport(self.bzrdir.root_transport)
 
532
            elif err.error_verb == 'LockFailed':
 
533
                raise errors.LockFailed(err.error_args[0], err.error_args[1])
 
534
            raise
 
535
 
1566
536
        if response[0] == 'ok':
1567
537
            ok, token = response
1568
538
            return token
1569
539
        else:
1570
540
            raise errors.UnexpectedSmartServerResponse(response)
1571
541
 
1572
 
    def lock_write(self, token=None, _skip_rpc=False):
 
542
    def lock_write(self, token=None):
1573
543
        if not self._lock_mode:
1574
 
            self._note_lock('w')
1575
 
            if _skip_rpc:
1576
 
                if self._lock_token is not None:
1577
 
                    if token != self._lock_token:
1578
 
                        raise errors.TokenMismatch(token, self._lock_token)
1579
 
                self._lock_token = token
1580
 
            else:
1581
 
                self._lock_token = self._remote_lock_write(token)
 
544
            self._lock_token = self._remote_lock_write(token)
1582
545
            # if self._lock_token is None, then this is something like packs or
1583
546
            # svn where we don't get to lock the repo, or a weave style repository
1584
547
            # where we cannot lock it over the wire and attempts to do so will
1591
554
                self._leave_lock = False
1592
555
            self._lock_mode = 'w'
1593
556
            self._lock_count = 1
1594
 
            cache_misses = self._real_repository is None
1595
 
            self._unstacked_provider.enable_cache(cache_misses=cache_misses)
1596
 
            for repo in self._fallback_repositories:
1597
 
                # Writes don't affect fallback repos
1598
 
                repo.lock_read()
 
557
            self._parents_map = {}
 
558
            if 'hpss' in debug.debug_flags:
 
559
                self._requested_parents = set()
1599
560
        elif self._lock_mode == 'r':
1600
561
            raise errors.ReadOnlyError(self)
1601
562
        else:
1602
563
            self._lock_count += 1
1603
 
        return RepositoryWriteLockResult(self.unlock, self._lock_token or None)
 
564
        return self._lock_token or None
1604
565
 
1605
566
    def leave_lock_in_place(self):
1606
567
        if not self._lock_token:
1618
579
        :param repository: The repository to fallback to for non-hpss
1619
580
            implemented operations.
1620
581
        """
1621
 
        if self._real_repository is not None:
1622
 
            # Replacing an already set real repository.
1623
 
            # We cannot do this [currently] if the repository is locked -
1624
 
            # synchronised state might be lost.
1625
 
            if self.is_locked():
1626
 
                raise AssertionError('_real_repository is already set')
1627
582
        if isinstance(repository, RemoteRepository):
1628
583
            raise AssertionError()
1629
584
        self._real_repository = repository
1630
 
        # three code paths happen here:
1631
 
        # 1) old servers, RemoteBranch.open() calls _ensure_real before setting
1632
 
        # up stacking. In this case self._fallback_repositories is [], and the
1633
 
        # real repo is already setup. Preserve the real repo and
1634
 
        # RemoteRepository.add_fallback_repository will avoid adding
1635
 
        # duplicates.
1636
 
        # 2) new servers, RemoteBranch.open() sets up stacking, and when
1637
 
        # ensure_real is triggered from a branch, the real repository to
1638
 
        # set already has a matching list with separate instances, but
1639
 
        # as they are also RemoteRepositories we don't worry about making the
1640
 
        # lists be identical.
1641
 
        # 3) new servers, RemoteRepository.ensure_real is triggered before
1642
 
        # RemoteBranch.ensure real, in this case we get a repo with no fallbacks
1643
 
        # and need to populate it.
1644
 
        if (self._fallback_repositories and
1645
 
            len(self._real_repository._fallback_repositories) !=
1646
 
            len(self._fallback_repositories)):
1647
 
            if len(self._real_repository._fallback_repositories):
1648
 
                raise AssertionError(
1649
 
                    "cannot cleanly remove existing _fallback_repositories")
1650
 
        for fb in self._fallback_repositories:
1651
 
            self._real_repository.add_fallback_repository(fb)
1652
585
        if self._lock_mode == 'w':
1653
586
            # if we are already locked, the real repository must be able to
1654
587
            # acquire the lock with our token.
1655
588
            self._real_repository.lock_write(self._lock_token)
1656
589
        elif self._lock_mode == 'r':
1657
590
            self._real_repository.lock_read()
1658
 
        if self._write_group_tokens is not None:
1659
 
            # if we are already in a write group, resume it
1660
 
            self._real_repository.resume_write_group(self._write_group_tokens)
1661
 
            self._write_group_tokens = None
1662
591
 
1663
592
    def start_write_group(self):
1664
593
        """Start a write group on the decorated repository.
1665
 
 
1666
 
        Smart methods perform operations in a single step so this API
 
594
        
 
595
        Smart methods peform operations in a single step so this api
1667
596
        is not really applicable except as a compatibility thunk
1668
597
        for older plugins that don't use e.g. the CommitBuilder
1669
598
        facility.
1670
599
        """
1671
 
        if self._real_repository:
1672
 
            self._ensure_real()
1673
 
            return self._real_repository.start_write_group()
1674
 
        if not self.is_write_locked():
1675
 
            raise errors.NotWriteLocked(self)
1676
 
        if self._write_group_tokens is not None:
1677
 
            raise errors.BzrError('already in a write group')
1678
 
        path = self.bzrdir._path_for_remote_call(self._client)
1679
 
        try:
1680
 
            response = self._call('Repository.start_write_group', path,
1681
 
                self._lock_token)
1682
 
        except (errors.UnknownSmartMethod, errors.UnsuspendableWriteGroup):
1683
 
            self._ensure_real()
1684
 
            return self._real_repository.start_write_group()
1685
 
        if response[0] != 'ok':
1686
 
            raise errors.UnexpectedSmartServerResponse(response)
1687
 
        self._write_group_tokens = response[1]
 
600
        self._ensure_real()
 
601
        return self._real_repository.start_write_group()
1688
602
 
1689
603
    def _unlock(self, token):
1690
604
        path = self.bzrdir._path_for_remote_call(self._client)
1691
605
        if not token:
1692
606
            # with no token the remote repository is not persistently locked.
1693
607
            return
1694
 
        err_context = {'token': token}
1695
 
        response = self._call('Repository.unlock', path, token,
1696
 
                              **err_context)
 
608
        try:
 
609
            response = self._client.call('Repository.unlock', path, token)
 
610
        except errors.ErrorFromSmartServer, err:
 
611
            if err.error_verb == 'TokenMismatch':
 
612
                raise errors.TokenMismatch(token, '(remote token)')
 
613
            raise
1697
614
        if response == ('ok',):
1698
615
            return
1699
616
        else:
1700
617
            raise errors.UnexpectedSmartServerResponse(response)
1701
618
 
1702
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1703
619
    def unlock(self):
1704
 
        if not self._lock_count:
1705
 
            return lock.cant_unlock_not_held(self)
1706
620
        self._lock_count -= 1
1707
621
        if self._lock_count > 0:
1708
622
            return
1709
 
        self._unstacked_provider.disable_cache()
 
623
        self._parents_map = None
 
624
        if 'hpss' in debug.debug_flags:
 
625
            self._requested_parents = None
1710
626
        old_mode = self._lock_mode
1711
627
        self._lock_mode = None
1712
628
        try:
1717
633
            # This is just to let the _real_repository stay up to date.
1718
634
            if self._real_repository is not None:
1719
635
                self._real_repository.unlock()
1720
 
            elif self._write_group_tokens is not None:
1721
 
                self.abort_write_group()
1722
636
        finally:
1723
637
            # The rpc-level lock should be released even if there was a
1724
638
            # problem releasing the vfs-based lock.
1725
639
            if old_mode == 'w':
1726
640
                # Only write-locked repositories need to make a remote method
1727
 
                # call to perform the unlock.
 
641
                # call to perfom the unlock.
1728
642
                old_token = self._lock_token
1729
643
                self._lock_token = None
1730
644
                if not self._leave_lock:
1731
645
                    self._unlock(old_token)
1732
 
        # Fallbacks are always 'lock_read()' so we don't pay attention to
1733
 
        # self._leave_lock
1734
 
        for repo in self._fallback_repositories:
1735
 
            repo.unlock()
1736
646
 
1737
647
    def break_lock(self):
1738
648
        # should hand off to the network
1739
 
        path = self.bzrdir._path_for_remote_call(self._client)
1740
 
        try:
1741
 
            response = self._call("Repository.break_lock", path)
1742
 
        except errors.UnknownSmartMethod:
1743
 
            self._ensure_real()
1744
 
            return self._real_repository.break_lock()
1745
 
        if response != ('ok',):
1746
 
            raise errors.UnexpectedSmartServerResponse(response)
 
649
        self._ensure_real()
 
650
        return self._real_repository.break_lock()
1747
651
 
1748
652
    def _get_tarball(self, compression):
1749
653
        """Return a TemporaryFile containing a repository tarball.
1750
 
 
 
654
        
1751
655
        Returns None if the server does not support sending tarballs.
1752
656
        """
1753
657
        import tempfile
1754
658
        path = self.bzrdir._path_for_remote_call(self._client)
1755
659
        try:
1756
 
            response, protocol = self._call_expecting_body(
 
660
            response, protocol = self._client.call_expecting_body(
1757
661
                'Repository.tarball', path, compression)
1758
662
        except errors.UnknownSmartMethod:
1759
663
            protocol.cancel_read_body()
1767
671
            return t
1768
672
        raise errors.UnexpectedSmartServerResponse(response)
1769
673
 
1770
 
    @needs_read_lock
1771
674
    def sprout(self, to_bzrdir, revision_id=None):
1772
 
        """Create a descendent repository for new development.
1773
 
 
1774
 
        Unlike clone, this does not copy the settings of the repository.
1775
 
        """
1776
 
        dest_repo = self._create_sprouting_repo(to_bzrdir, shared=False)
 
675
        # TODO: Option to control what format is created?
 
676
        self._ensure_real()
 
677
        dest_repo = self._real_repository._format.initialize(to_bzrdir,
 
678
                                                             shared=False)
1777
679
        dest_repo.fetch(self, revision_id=revision_id)
1778
680
        return dest_repo
1779
681
 
1780
 
    def _create_sprouting_repo(self, a_bzrdir, shared):
1781
 
        if not isinstance(a_bzrdir._format, self.bzrdir._format.__class__):
1782
 
            # use target default format.
1783
 
            dest_repo = a_bzrdir.create_repository()
1784
 
        else:
1785
 
            # Most control formats need the repository to be specifically
1786
 
            # created, but on some old all-in-one formats it's not needed
1787
 
            try:
1788
 
                dest_repo = self._format.initialize(a_bzrdir, shared=shared)
1789
 
            except errors.UninitializableFormat:
1790
 
                dest_repo = a_bzrdir.open_repository()
1791
 
        return dest_repo
1792
 
 
1793
682
    ### These methods are just thin shims to the VFS object for now.
1794
683
 
1795
 
    @needs_read_lock
1796
684
    def revision_tree(self, revision_id):
1797
 
        revision_id = _mod_revision.ensure_null(revision_id)
1798
 
        if revision_id == _mod_revision.NULL_REVISION:
1799
 
            return InventoryRevisionTree(self,
1800
 
                Inventory(root_id=None), _mod_revision.NULL_REVISION)
1801
 
        else:
1802
 
            return list(self.revision_trees([revision_id]))[0]
 
685
        self._ensure_real()
 
686
        return self._real_repository.revision_tree(revision_id)
1803
687
 
1804
688
    def get_serializer_format(self):
1805
 
        path = self.bzrdir._path_for_remote_call(self._client)
1806
 
        try:
1807
 
            response = self._call('VersionedFileRepository.get_serializer_format',
1808
 
                path)
1809
 
        except errors.UnknownSmartMethod:
1810
 
            self._ensure_real()
1811
 
            return self._real_repository.get_serializer_format()
1812
 
        if response[0] != 'ok':
1813
 
            raise errors.UnexpectedSmartServerResponse(response)
1814
 
        return response[1]
 
689
        self._ensure_real()
 
690
        return self._real_repository.get_serializer_format()
1815
691
 
1816
692
    def get_commit_builder(self, branch, parents, config, timestamp=None,
1817
693
                           timezone=None, committer=None, revprops=None,
1818
 
                           revision_id=None, lossy=False):
1819
 
        """Obtain a CommitBuilder for this repository.
1820
 
 
1821
 
        :param branch: Branch to commit to.
1822
 
        :param parents: Revision ids of the parents of the new revision.
1823
 
        :param config: Configuration to use.
1824
 
        :param timestamp: Optional timestamp recorded for commit.
1825
 
        :param timezone: Optional timezone for timestamp.
1826
 
        :param committer: Optional committer to set for commit.
1827
 
        :param revprops: Optional dictionary of revision properties.
1828
 
        :param revision_id: Optional revision id.
1829
 
        :param lossy: Whether to discard data that can not be natively
1830
 
            represented, when pushing to a foreign VCS
1831
 
        """
1832
 
        if self._fallback_repositories and not self._format.supports_chks:
1833
 
            raise errors.BzrError("Cannot commit directly to a stacked branch"
1834
 
                " in pre-2a formats. See "
1835
 
                "https://bugs.launchpad.net/bzr/+bug/375013 for details.")
1836
 
        if self._format.rich_root_data:
1837
 
            commit_builder_kls = vf_repository.VersionedFileRootCommitBuilder
1838
 
        else:
1839
 
            commit_builder_kls = vf_repository.VersionedFileCommitBuilder
1840
 
        result = commit_builder_kls(self, parents, config,
1841
 
            timestamp, timezone, committer, revprops, revision_id,
1842
 
            lossy)
1843
 
        self.start_write_group()
1844
 
        return result
1845
 
 
1846
 
    def add_fallback_repository(self, repository):
1847
 
        """Add a repository to use for looking up data not held locally.
1848
 
 
1849
 
        :param repository: A repository.
1850
 
        """
1851
 
        if not self._format.supports_external_lookups:
1852
 
            raise errors.UnstackableRepositoryFormat(
1853
 
                self._format.network_name(), self.base)
1854
 
        # We need to accumulate additional repositories here, to pass them in
1855
 
        # on various RPC's.
1856
 
        #
1857
 
        # Make the check before we lock: this raises an exception.
1858
 
        self._check_fallback_repository(repository)
1859
 
        if self.is_locked():
1860
 
            # We will call fallback.unlock() when we transition to the unlocked
1861
 
            # state, so always add a lock here. If a caller passes us a locked
1862
 
            # repository, they are responsible for unlocking it later.
1863
 
            repository.lock_read()
1864
 
        self._fallback_repositories.append(repository)
1865
 
        # If self._real_repository was parameterised already (e.g. because a
1866
 
        # _real_branch had its get_stacked_on_url method called), then the
1867
 
        # repository to be added may already be in the _real_repositories list.
1868
 
        if self._real_repository is not None:
1869
 
            fallback_locations = [repo.user_url for repo in
1870
 
                self._real_repository._fallback_repositories]
1871
 
            if repository.user_url not in fallback_locations:
1872
 
                self._real_repository.add_fallback_repository(repository)
1873
 
 
1874
 
    def _check_fallback_repository(self, repository):
1875
 
        """Check that this repository can fallback to repository safely.
1876
 
 
1877
 
        Raise an error if not.
1878
 
 
1879
 
        :param repository: A repository to fallback to.
1880
 
        """
1881
 
        return _mod_repository.InterRepository._assert_same_model(
1882
 
            self, repository)
 
694
                           revision_id=None):
 
695
        # FIXME: It ought to be possible to call this without immediately
 
696
        # triggering _ensure_real.  For now it's the easiest thing to do.
 
697
        self._ensure_real()
 
698
        builder = self._real_repository.get_commit_builder(branch, parents,
 
699
                config, timestamp=timestamp, timezone=timezone,
 
700
                committer=committer, revprops=revprops, revision_id=revision_id)
 
701
        return builder
1883
702
 
1884
703
    def add_inventory(self, revid, inv, parents):
1885
704
        self._ensure_real()
1886
705
        return self._real_repository.add_inventory(revid, inv, parents)
1887
706
 
1888
 
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1889
 
            parents, basis_inv=None, propagate_caches=False):
 
707
    def add_revision(self, rev_id, rev, inv=None, config=None):
1890
708
        self._ensure_real()
1891
 
        return self._real_repository.add_inventory_by_delta(basis_revision_id,
1892
 
            delta, new_revision_id, parents, basis_inv=basis_inv,
1893
 
            propagate_caches=propagate_caches)
1894
 
 
1895
 
    def add_revision(self, revision_id, rev, inv=None):
1896
 
        _mod_revision.check_not_reserved_id(revision_id)
1897
 
        key = (revision_id,)
1898
 
        # check inventory present
1899
 
        if not self.inventories.get_parent_map([key]):
1900
 
            if inv is None:
1901
 
                raise errors.WeaveRevisionNotPresent(revision_id,
1902
 
                                                     self.inventories)
1903
 
            else:
1904
 
                # yes, this is not suitable for adding with ghosts.
1905
 
                rev.inventory_sha1 = self.add_inventory(revision_id, inv,
1906
 
                                                        rev.parent_ids)
1907
 
        else:
1908
 
            rev.inventory_sha1 = self.inventories.get_sha1s([key])[key]
1909
 
        self._add_revision(rev)
1910
 
 
1911
 
    def _add_revision(self, rev):
1912
 
        if self._real_repository is not None:
1913
 
            return self._real_repository._add_revision(rev)
1914
 
        text = self._serializer.write_revision_to_string(rev)
1915
 
        key = (rev.revision_id,)
1916
 
        parents = tuple((parent,) for parent in rev.parent_ids)
1917
 
        self._write_group_tokens, missing_keys = self._get_sink().insert_stream(
1918
 
            [('revisions', [FulltextContentFactory(key, parents, None, text)])],
1919
 
            self._format, self._write_group_tokens)
 
709
        return self._real_repository.add_revision(
 
710
            rev_id, rev, inv=inv, config=config)
1920
711
 
1921
712
    @needs_read_lock
1922
713
    def get_inventory(self, revision_id):
1923
 
        return list(self.iter_inventories([revision_id]))[0]
1924
 
 
1925
 
    def _iter_inventories_rpc(self, revision_ids, ordering):
1926
 
        if ordering is None:
1927
 
            ordering = 'unordered'
1928
 
        path = self.bzrdir._path_for_remote_call(self._client)
1929
 
        body = "\n".join(revision_ids)
1930
 
        response_tuple, response_handler = (
1931
 
            self._call_with_body_bytes_expecting_body(
1932
 
                "VersionedFileRepository.get_inventories",
1933
 
                (path, ordering), body))
1934
 
        if response_tuple[0] != "ok":
1935
 
            raise errors.UnexpectedSmartServerResponse(response_tuple)
1936
 
        deserializer = inventory_delta.InventoryDeltaDeserializer()
1937
 
        byte_stream = response_handler.read_streamed_body()
1938
 
        decoded = smart_repo._byte_stream_to_stream(byte_stream)
1939
 
        if decoded is None:
1940
 
            # no results whatsoever
1941
 
            return
1942
 
        src_format, stream = decoded
1943
 
        if src_format.network_name() != self._format.network_name():
1944
 
            raise AssertionError(
1945
 
                "Mismatched RemoteRepository and stream src %r, %r" % (
1946
 
                src_format.network_name(), self._format.network_name()))
1947
 
        # ignore the src format, it's not really relevant
1948
 
        prev_inv = Inventory(root_id=None,
1949
 
            revision_id=_mod_revision.NULL_REVISION)
1950
 
        # there should be just one substream, with inventory deltas
1951
 
        substream_kind, substream = stream.next()
1952
 
        if substream_kind != "inventory-deltas":
1953
 
            raise AssertionError(
1954
 
                 "Unexpected stream %r received" % substream_kind)
1955
 
        for record in substream:
1956
 
            (parent_id, new_id, versioned_root, tree_references, invdelta) = (
1957
 
                deserializer.parse_text_bytes(record.get_bytes_as("fulltext")))
1958
 
            if parent_id != prev_inv.revision_id:
1959
 
                raise AssertionError("invalid base %r != %r" % (parent_id,
1960
 
                    prev_inv.revision_id))
1961
 
            inv = prev_inv.create_by_apply_delta(invdelta, new_id)
1962
 
            yield inv, inv.revision_id
1963
 
            prev_inv = inv
1964
 
 
1965
 
    def _iter_inventories_vfs(self, revision_ids, ordering=None):
1966
 
        self._ensure_real()
1967
 
        return self._real_repository._iter_inventories(revision_ids, ordering)
1968
 
 
1969
 
    def iter_inventories(self, revision_ids, ordering=None):
1970
 
        """Get many inventories by revision_ids.
1971
 
 
1972
 
        This will buffer some or all of the texts used in constructing the
1973
 
        inventories in memory, but will only parse a single inventory at a
1974
 
        time.
1975
 
 
1976
 
        :param revision_ids: The expected revision ids of the inventories.
1977
 
        :param ordering: optional ordering, e.g. 'topological'.  If not
1978
 
            specified, the order of revision_ids will be preserved (by
1979
 
            buffering if necessary).
1980
 
        :return: An iterator of inventories.
1981
 
        """
1982
 
        if ((None in revision_ids)
1983
 
            or (_mod_revision.NULL_REVISION in revision_ids)):
1984
 
            raise ValueError('cannot get null revision inventory')
1985
 
        for inv, revid in self._iter_inventories(revision_ids, ordering):
1986
 
            if inv is None:
1987
 
                raise errors.NoSuchRevision(self, revid)
1988
 
            yield inv
1989
 
 
1990
 
    def _iter_inventories(self, revision_ids, ordering=None):
1991
 
        if len(revision_ids) == 0:
1992
 
            return
1993
 
        missing = set(revision_ids)
1994
 
        if ordering is None:
1995
 
            order_as_requested = True
1996
 
            invs = {}
1997
 
            order = list(revision_ids)
1998
 
            order.reverse()
1999
 
            next_revid = order.pop()
2000
 
        else:
2001
 
            order_as_requested = False
2002
 
            if ordering != 'unordered' and self._fallback_repositories:
2003
 
                raise ValueError('unsupported ordering %r' % ordering)
2004
 
        iter_inv_fns = [self._iter_inventories_rpc] + [
2005
 
            fallback._iter_inventories for fallback in
2006
 
            self._fallback_repositories]
2007
 
        try:
2008
 
            for iter_inv in iter_inv_fns:
2009
 
                request = [revid for revid in revision_ids if revid in missing]
2010
 
                for inv, revid in iter_inv(request, ordering):
2011
 
                    if inv is None:
2012
 
                        continue
2013
 
                    missing.remove(inv.revision_id)
2014
 
                    if ordering != 'unordered':
2015
 
                        invs[revid] = inv
2016
 
                    else:
2017
 
                        yield inv, revid
2018
 
                if order_as_requested:
2019
 
                    # Yield as many results as we can while preserving order.
2020
 
                    while next_revid in invs:
2021
 
                        inv = invs.pop(next_revid)
2022
 
                        yield inv, inv.revision_id
2023
 
                        try:
2024
 
                            next_revid = order.pop()
2025
 
                        except IndexError:
2026
 
                            # We still want to fully consume the stream, just
2027
 
                            # in case it is not actually finished at this point
2028
 
                            next_revid = None
2029
 
                            break
2030
 
        except errors.UnknownSmartMethod:
2031
 
            for inv, revid in self._iter_inventories_vfs(revision_ids, ordering):
2032
 
                yield inv, revid
2033
 
            return
2034
 
        # Report missing
2035
 
        if order_as_requested:
2036
 
            if next_revid is not None:
2037
 
                yield None, next_revid
2038
 
            while order:
2039
 
                revid = order.pop()
2040
 
                yield invs.get(revid), revid
2041
 
        else:
2042
 
            while missing:
2043
 
                yield None, missing.pop()
 
714
        self._ensure_real()
 
715
        return self._real_repository.get_inventory(revision_id)
 
716
 
 
717
    def iter_inventories(self, revision_ids):
 
718
        self._ensure_real()
 
719
        return self._real_repository.iter_inventories(revision_ids)
2044
720
 
2045
721
    @needs_read_lock
2046
722
    def get_revision(self, revision_id):
2047
 
        return self.get_revisions([revision_id])[0]
 
723
        self._ensure_real()
 
724
        return self._real_repository.get_revision(revision_id)
2048
725
 
2049
726
    def get_transaction(self):
2050
727
        self._ensure_real()
2052
729
 
2053
730
    @needs_read_lock
2054
731
    def clone(self, a_bzrdir, revision_id=None):
2055
 
        dest_repo = self._create_sprouting_repo(
2056
 
            a_bzrdir, shared=self.is_shared())
2057
 
        self.copy_content_into(dest_repo, revision_id)
2058
 
        return dest_repo
 
732
        self._ensure_real()
 
733
        return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
2059
734
 
2060
735
    def make_working_trees(self):
2061
736
        """See Repository.make_working_trees"""
2062
 
        path = self.bzrdir._path_for_remote_call(self._client)
2063
 
        try:
2064
 
            response = self._call('Repository.make_working_trees', path)
2065
 
        except errors.UnknownSmartMethod:
2066
 
            self._ensure_real()
2067
 
            return self._real_repository.make_working_trees()
2068
 
        if response[0] not in ('yes', 'no'):
2069
 
            raise SmartProtocolError('unexpected response code %s' % (response,))
2070
 
        return response[0] == 'yes'
2071
 
 
2072
 
    def refresh_data(self):
2073
 
        """Re-read any data needed to synchronise with disk.
2074
 
 
2075
 
        This method is intended to be called after another repository instance
2076
 
        (such as one used by a smart server) has inserted data into the
2077
 
        repository. On all repositories this will work outside of write groups.
2078
 
        Some repository formats (pack and newer for bzrlib native formats)
2079
 
        support refresh_data inside write groups. If called inside a write
2080
 
        group on a repository that does not support refreshing in a write group
2081
 
        IsInWriteGroupError will be raised.
2082
 
        """
2083
 
        if self._real_repository is not None:
2084
 
            self._real_repository.refresh_data()
2085
 
        # Refresh the parents cache for this object
2086
 
        self._unstacked_provider.disable_cache()
2087
 
        self._unstacked_provider.enable_cache()
 
737
        self._ensure_real()
 
738
        return self._real_repository.make_working_trees()
2088
739
 
2089
740
    def revision_ids_to_search_result(self, result_set):
2090
741
        """Convert a set of revision ids to a graph SearchResult."""
2095
746
        included_keys = result_set.intersection(result_parents)
2096
747
        start_keys = result_set.difference(included_keys)
2097
748
        exclude_keys = result_parents.difference(result_set)
2098
 
        result = vf_search.SearchResult(start_keys, exclude_keys,
 
749
        result = graph.SearchResult(start_keys, exclude_keys,
2099
750
            len(result_set), result_set)
2100
751
        return result
2101
752
 
2102
753
    @needs_read_lock
2103
 
    def search_missing_revision_ids(self, other,
2104
 
            revision_id=symbol_versioning.DEPRECATED_PARAMETER,
2105
 
            find_ghosts=True, revision_ids=None, if_present_ids=None,
2106
 
            limit=None):
 
754
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
2107
755
        """Return the revision ids that other has that this does not.
2108
 
 
 
756
        
2109
757
        These are returned in topological order.
2110
758
 
2111
759
        revision_id: only return revision ids included by revision_id.
2112
760
        """
2113
 
        if symbol_versioning.deprecated_passed(revision_id):
2114
 
            symbol_versioning.warn(
2115
 
                'search_missing_revision_ids(revision_id=...) was '
2116
 
                'deprecated in 2.4.  Use revision_ids=[...] instead.',
2117
 
                DeprecationWarning, stacklevel=2)
2118
 
            if revision_ids is not None:
2119
 
                raise AssertionError(
2120
 
                    'revision_ids is mutually exclusive with revision_id')
2121
 
            if revision_id is not None:
2122
 
                revision_ids = [revision_id]
2123
 
        inter_repo = _mod_repository.InterRepository.get(other, self)
2124
 
        return inter_repo.search_missing_revision_ids(
2125
 
            find_ghosts=find_ghosts, revision_ids=revision_ids,
2126
 
            if_present_ids=if_present_ids, limit=limit)
 
761
        return repository.InterRepository.get(
 
762
            other, self).search_missing_revision_ids(revision_id, find_ghosts)
2127
763
 
2128
 
    def fetch(self, source, revision_id=None, find_ghosts=False,
2129
 
            fetch_spec=None):
2130
 
        # No base implementation to use as RemoteRepository is not a subclass
2131
 
        # of Repository; so this is a copy of Repository.fetch().
2132
 
        if fetch_spec is not None and revision_id is not None:
2133
 
            raise AssertionError(
2134
 
                "fetch_spec and revision_id are mutually exclusive.")
2135
 
        if self.is_in_write_group():
2136
 
            raise errors.InternalBzrError(
2137
 
                "May not fetch while in a write group.")
2138
 
        # fast path same-url fetch operations
2139
 
        if (self.has_same_location(source)
2140
 
            and fetch_spec is None
2141
 
            and self._has_same_fallbacks(source)):
 
764
    def fetch(self, source, revision_id=None, pb=None):
 
765
        if self.has_same_location(source):
2142
766
            # check that last_revision is in 'from' and then return a
2143
767
            # no-operation.
2144
768
            if (revision_id is not None and
2145
 
                not _mod_revision.is_null(revision_id)):
 
769
                not revision.is_null(revision_id)):
2146
770
                self.get_revision(revision_id)
2147
771
            return 0, []
2148
 
        # if there is no specific appropriate InterRepository, this will get
2149
 
        # the InterRepository base class, which raises an
2150
 
        # IncompatibleRepositories when asked to fetch.
2151
 
        inter = _mod_repository.InterRepository.get(source, self)
2152
 
        if (fetch_spec is not None and
2153
 
            not getattr(inter, "supports_fetch_spec", False)):
2154
 
            raise errors.UnsupportedOperation(
2155
 
                "fetch_spec not supported for %r" % inter)
2156
 
        return inter.fetch(revision_id=revision_id,
2157
 
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
 
772
        self._ensure_real()
 
773
        return self._real_repository.fetch(
 
774
            source, revision_id=revision_id, pb=pb)
2158
775
 
2159
776
    def create_bundle(self, target, base, fileobj, format=None):
2160
777
        self._ensure_real()
2161
778
        self._real_repository.create_bundle(target, base, fileobj, format)
2162
779
 
 
780
    @needs_read_lock
 
781
    def get_ancestry(self, revision_id, topo_sorted=True):
 
782
        self._ensure_real()
 
783
        return self._real_repository.get_ancestry(revision_id, topo_sorted)
 
784
 
2163
785
    def fileids_altered_by_revision_ids(self, revision_ids):
2164
786
        self._ensure_real()
2165
787
        return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
2168
790
        self._ensure_real()
2169
791
        return self._real_repository._get_versioned_file_checker(
2170
792
            revisions, revision_versions_cache)
2171
 
 
2172
 
    def _iter_files_bytes_rpc(self, desired_files, absent):
2173
 
        path = self.bzrdir._path_for_remote_call(self._client)
2174
 
        lines = []
2175
 
        identifiers = []
2176
 
        for (file_id, revid, identifier) in desired_files:
2177
 
            lines.append("%s\0%s" % (
2178
 
                osutils.safe_file_id(file_id),
2179
 
                osutils.safe_revision_id(revid)))
2180
 
            identifiers.append(identifier)
2181
 
        (response_tuple, response_handler) = (
2182
 
            self._call_with_body_bytes_expecting_body(
2183
 
            "Repository.iter_files_bytes", (path, ), "\n".join(lines)))
2184
 
        if response_tuple != ('ok', ):
2185
 
            response_handler.cancel_read_body()
2186
 
            raise errors.UnexpectedSmartServerResponse(response_tuple)
2187
 
        byte_stream = response_handler.read_streamed_body()
2188
 
        def decompress_stream(start, byte_stream, unused):
2189
 
            decompressor = zlib.decompressobj()
2190
 
            yield decompressor.decompress(start)
2191
 
            while decompressor.unused_data == "":
2192
 
                try:
2193
 
                    data = byte_stream.next()
2194
 
                except StopIteration:
2195
 
                    break
2196
 
                yield decompressor.decompress(data)
2197
 
            yield decompressor.flush()
2198
 
            unused.append(decompressor.unused_data)
2199
 
        unused = ""
2200
 
        while True:
2201
 
            while not "\n" in unused:
2202
 
                unused += byte_stream.next()
2203
 
            header, rest = unused.split("\n", 1)
2204
 
            args = header.split("\0")
2205
 
            if args[0] == "absent":
2206
 
                absent[identifiers[int(args[3])]] = (args[1], args[2])
2207
 
                unused = rest
2208
 
                continue
2209
 
            elif args[0] == "ok":
2210
 
                idx = int(args[1])
2211
 
            else:
2212
 
                raise errors.UnexpectedSmartServerResponse(args)
2213
 
            unused_chunks = []
2214
 
            yield (identifiers[idx],
2215
 
                decompress_stream(rest, byte_stream, unused_chunks))
2216
 
            unused = "".join(unused_chunks)
2217
 
 
 
793
        
2218
794
    def iter_files_bytes(self, desired_files):
2219
795
        """See Repository.iter_file_bytes.
2220
796
        """
2221
 
        try:
2222
 
            absent = {}
2223
 
            for (identifier, bytes_iterator) in self._iter_files_bytes_rpc(
2224
 
                    desired_files, absent):
2225
 
                yield identifier, bytes_iterator
2226
 
            for fallback in self._fallback_repositories:
2227
 
                if not absent:
2228
 
                    break
2229
 
                desired_files = [(key[0], key[1], identifier) for
2230
 
                    (identifier, key) in absent.iteritems()]
2231
 
                for (identifier, bytes_iterator) in fallback.iter_files_bytes(desired_files):
2232
 
                    del absent[identifier]
2233
 
                    yield identifier, bytes_iterator
2234
 
            if absent:
2235
 
                # There may be more missing items, but raise an exception
2236
 
                # for just one.
2237
 
                missing_identifier = absent.keys()[0]
2238
 
                missing_key = absent[missing_identifier]
2239
 
                raise errors.RevisionNotPresent(revision_id=missing_key[1],
2240
 
                    file_id=missing_key[0])
2241
 
        except errors.UnknownSmartMethod:
2242
 
            self._ensure_real()
2243
 
            for (identifier, bytes_iterator) in (
2244
 
                self._real_repository.iter_files_bytes(desired_files)):
2245
 
                yield identifier, bytes_iterator
2246
 
 
2247
 
    def get_cached_parent_map(self, revision_ids):
2248
 
        """See bzrlib.CachingParentsProvider.get_cached_parent_map"""
2249
 
        return self._unstacked_provider.get_cached_parent_map(revision_ids)
2250
 
 
2251
 
    def get_parent_map(self, revision_ids):
 
797
        self._ensure_real()
 
798
        return self._real_repository.iter_files_bytes(desired_files)
 
799
 
 
800
    def get_parent_map(self, keys):
2252
801
        """See bzrlib.Graph.get_parent_map()."""
2253
 
        return self._make_parents_provider().get_parent_map(revision_ids)
 
802
        # Hack to build up the caching logic.
 
803
        ancestry = self._parents_map
 
804
        if ancestry is None:
 
805
            # Repository is not locked, so there's no cache.
 
806
            missing_revisions = set(keys)
 
807
            ancestry = {}
 
808
        else:
 
809
            missing_revisions = set(key for key in keys if key not in ancestry)
 
810
        if missing_revisions:
 
811
            parent_map = self._get_parent_map(missing_revisions)
 
812
            if 'hpss' in debug.debug_flags:
 
813
                mutter('retransmitted revisions: %d of %d',
 
814
                        len(set(ancestry).intersection(parent_map)),
 
815
                        len(parent_map))
 
816
            ancestry.update(parent_map)
 
817
        present_keys = [k for k in keys if k in ancestry]
 
818
        if 'hpss' in debug.debug_flags:
 
819
            if self._requested_parents is not None and len(ancestry) != 0:
 
820
                self._requested_parents.update(present_keys)
 
821
                mutter('Current RemoteRepository graph hit rate: %d%%',
 
822
                    100.0 * len(self._requested_parents) / len(ancestry))
 
823
        return dict((k, ancestry[k]) for k in present_keys)
2254
824
 
2255
 
    def _get_parent_map_rpc(self, keys):
 
825
    def _get_parent_map(self, keys):
2256
826
        """Helper for get_parent_map that performs the RPC."""
2257
827
        medium = self._client._medium
2258
828
        if medium._is_remote_before((1, 2)):
2259
829
            # We already found out that the server can't understand
2260
830
            # Repository.get_parent_map requests, so just fetch the whole
2261
831
            # graph.
2262
 
            #
2263
 
            # Note that this reads the whole graph, when only some keys are
2264
 
            # wanted.  On this old server there's no way (?) to get them all
2265
 
            # in one go, and the user probably will have seen a warning about
2266
 
            # the server being old anyhow.
2267
 
            rg = self._get_revision_graph(None)
2268
 
            # There is an API discrepancy between get_parent_map and
 
832
            # XXX: Note that this will issue a deprecation warning. This is ok
 
833
            # :- its because we're working with a deprecated server anyway, and
 
834
            # the user will almost certainly have seen a warning about the
 
835
            # server version already.
 
836
            rg = self.get_revision_graph()
 
837
            # There is an api discrepency between get_parent_map and
2269
838
            # get_revision_graph. Specifically, a "key:()" pair in
2270
839
            # get_revision_graph just means a node has no parents. For
2271
840
            # "get_parent_map" it means the node is a ghost. So fix up the
2301
870
        # TODO: Manage this incrementally to avoid covering the same path
2302
871
        # repeatedly. (The server will have to on each request, but the less
2303
872
        # work done the better).
2304
 
        #
2305
 
        # Negative caching notes:
2306
 
        # new server sends missing when a request including the revid
2307
 
        # 'include-missing:' is present in the request.
2308
 
        # missing keys are serialised as missing:X, and we then call
2309
 
        # provider.note_missing(X) for-all X
2310
 
        parents_map = self._unstacked_provider.get_cached_map()
 
873
        parents_map = self._parents_map
2311
874
        if parents_map is None:
2312
875
            # Repository is not locked, so there's no cache.
2313
876
            parents_map = {}
2314
 
        if _DEFAULT_SEARCH_DEPTH <= 0:
2315
 
            (start_set, stop_keys,
2316
 
             key_count) = vf_search.search_result_from_parent_map(
2317
 
                parents_map, self._unstacked_provider.missing_keys)
2318
 
        else:
2319
 
            (start_set, stop_keys,
2320
 
             key_count) = vf_search.limited_search_result_from_parent_map(
2321
 
                parents_map, self._unstacked_provider.missing_keys,
2322
 
                keys, depth=_DEFAULT_SEARCH_DEPTH)
2323
 
        recipe = ('manual', start_set, stop_keys, key_count)
 
877
        start_set = set(parents_map)
 
878
        result_parents = set()
 
879
        for parents in parents_map.itervalues():
 
880
            result_parents.update(parents)
 
881
        stop_keys = result_parents.difference(start_set)
 
882
        included_keys = start_set.intersection(result_parents)
 
883
        start_set.difference_update(included_keys)
 
884
        recipe = (start_set, stop_keys, len(parents_map))
2324
885
        body = self._serialise_search_recipe(recipe)
2325
886
        path = self.bzrdir._path_for_remote_call(self._client)
2326
887
        for key in keys:
2328
889
                raise ValueError(
2329
890
                    "key %r not a plain string" % (key,))
2330
891
        verb = 'Repository.get_parent_map'
2331
 
        args = (path, 'include-missing:') + tuple(keys)
 
892
        args = (path,) + tuple(keys)
2332
893
        try:
2333
 
            response = self._call_with_body_bytes_expecting_body(
2334
 
                verb, args, body)
 
894
            response = self._client.call_with_body_bytes_expecting_body(
 
895
                verb, args, self._serialise_search_recipe(recipe))
2335
896
        except errors.UnknownSmartMethod:
2336
897
            # Server does not support this method, so get the whole graph.
2337
898
            # Worse, we have to force a disconnection, because the server now
2344
905
            # To avoid having to disconnect repeatedly, we keep track of the
2345
906
            # fact the server doesn't understand remote methods added in 1.2.
2346
907
            medium._remember_remote_is_before((1, 2))
2347
 
            # Recurse just once and we should use the fallback code.
2348
 
            return self._get_parent_map_rpc(keys)
 
908
            return self.get_revision_graph(None)
2349
909
        response_tuple, response_handler = response
2350
910
        if response_tuple[0] not in ['ok']:
2351
911
            response_handler.cancel_read_body()
2362
922
                if len(d) > 1:
2363
923
                    revision_graph[d[0]] = d[1:]
2364
924
                else:
2365
 
                    # No parents:
2366
 
                    if d[0].startswith('missing:'):
2367
 
                        revid = d[0][8:]
2368
 
                        self._unstacked_provider.note_missing_key(revid)
2369
 
                    else:
2370
 
                        # no parents - so give the Graph result
2371
 
                        # (NULL_REVISION,).
2372
 
                        revision_graph[d[0]] = (NULL_REVISION,)
 
925
                    # No parents - so give the Graph result (NULL_REVISION,).
 
926
                    revision_graph[d[0]] = (NULL_REVISION,)
2373
927
            return revision_graph
2374
928
 
2375
929
    @needs_read_lock
2376
930
    def get_signature_text(self, revision_id):
2377
 
        path = self.bzrdir._path_for_remote_call(self._client)
2378
 
        try:
2379
 
            response_tuple, response_handler = self._call_expecting_body(
2380
 
                'Repository.get_revision_signature_text', path, revision_id)
2381
 
        except errors.UnknownSmartMethod:
2382
 
            self._ensure_real()
2383
 
            return self._real_repository.get_signature_text(revision_id)
2384
 
        except errors.NoSuchRevision, err:
2385
 
            for fallback in self._fallback_repositories:
2386
 
                try:
2387
 
                    return fallback.get_signature_text(revision_id)
2388
 
                except errors.NoSuchRevision:
2389
 
                    pass
2390
 
            raise err
2391
 
        else:
2392
 
            if response_tuple[0] != 'ok':
2393
 
                raise errors.UnexpectedSmartServerResponse(response_tuple)
2394
 
            return response_handler.read_body_bytes()
2395
 
 
2396
 
    @needs_read_lock
2397
 
    def _get_inventory_xml(self, revision_id):
2398
 
        # This call is used by older working tree formats,
2399
 
        # which stored a serialized basis inventory.
2400
 
        self._ensure_real()
2401
 
        return self._real_repository._get_inventory_xml(revision_id)
2402
 
 
2403
 
    @needs_write_lock
 
931
        self._ensure_real()
 
932
        return self._real_repository.get_signature_text(revision_id)
 
933
 
 
934
    @needs_read_lock
 
935
    @symbol_versioning.deprecated_method(symbol_versioning.one_three)
 
936
    def get_revision_graph_with_ghosts(self, revision_ids=None):
 
937
        self._ensure_real()
 
938
        return self._real_repository.get_revision_graph_with_ghosts(
 
939
            revision_ids=revision_ids)
 
940
 
 
941
    @needs_read_lock
 
942
    def get_inventory_xml(self, revision_id):
 
943
        self._ensure_real()
 
944
        return self._real_repository.get_inventory_xml(revision_id)
 
945
 
 
946
    def deserialise_inventory(self, revision_id, xml):
 
947
        self._ensure_real()
 
948
        return self._real_repository.deserialise_inventory(revision_id, xml)
 
949
 
2404
950
    def reconcile(self, other=None, thorough=False):
2405
 
        from bzrlib.reconcile import RepoReconciler
2406
 
        path = self.bzrdir._path_for_remote_call(self._client)
2407
 
        try:
2408
 
            response, handler = self._call_expecting_body(
2409
 
                'Repository.reconcile', path, self._lock_token)
2410
 
        except (errors.UnknownSmartMethod, errors.TokenLockingNotSupported):
2411
 
            self._ensure_real()
2412
 
            return self._real_repository.reconcile(other=other, thorough=thorough)
2413
 
        if response != ('ok', ):
2414
 
            raise errors.UnexpectedSmartServerResponse(response)
2415
 
        body = handler.read_body_bytes()
2416
 
        result = RepoReconciler(self)
2417
 
        for line in body.split('\n'):
2418
 
            if not line:
2419
 
                continue
2420
 
            key, val_text = line.split(':')
2421
 
            if key == "garbage_inventories":
2422
 
                result.garbage_inventories = int(val_text)
2423
 
            elif key == "inconsistent_parents":
2424
 
                result.inconsistent_parents = int(val_text)
2425
 
            else:
2426
 
                mutter("unknown reconcile key %r" % key)
2427
 
        return result
2428
 
 
 
951
        self._ensure_real()
 
952
        return self._real_repository.reconcile(other=other, thorough=thorough)
 
953
        
2429
954
    def all_revision_ids(self):
2430
 
        path = self.bzrdir._path_for_remote_call(self._client)
2431
 
        try:
2432
 
            response_tuple, response_handler = self._call_expecting_body(
2433
 
                "Repository.all_revision_ids", path)
2434
 
        except errors.UnknownSmartMethod:
2435
 
            self._ensure_real()
2436
 
            return self._real_repository.all_revision_ids()
2437
 
        if response_tuple != ("ok", ):
2438
 
            raise errors.UnexpectedSmartServerResponse(response_tuple)
2439
 
        revids = set(response_handler.read_body_bytes().splitlines())
2440
 
        for fallback in self._fallback_repositories:
2441
 
            revids.update(set(fallback.all_revision_ids()))
2442
 
        return list(revids)
2443
 
 
2444
 
    def _filtered_revision_trees(self, revision_ids, file_ids):
2445
 
        """Return Tree for a revision on this branch with only some files.
2446
 
 
2447
 
        :param revision_ids: a sequence of revision-ids;
2448
 
          a revision-id may not be None or 'null:'
2449
 
        :param file_ids: if not None, the result is filtered
2450
 
          so that only those file-ids, their parents and their
2451
 
          children are included.
2452
 
        """
2453
 
        inventories = self.iter_inventories(revision_ids)
2454
 
        for inv in inventories:
2455
 
            # Should we introduce a FilteredRevisionTree class rather
2456
 
            # than pre-filter the inventory here?
2457
 
            filtered_inv = inv.filter(file_ids)
2458
 
            yield InventoryRevisionTree(self, filtered_inv, filtered_inv.revision_id)
2459
 
 
2460
 
    @needs_read_lock
2461
 
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
2462
 
        medium = self._client._medium
2463
 
        if medium._is_remote_before((1, 2)):
2464
 
            self._ensure_real()
2465
 
            for delta in self._real_repository.get_deltas_for_revisions(
2466
 
                    revisions, specific_fileids):
2467
 
                yield delta
2468
 
            return
2469
 
        # Get the revision-ids of interest
2470
 
        required_trees = set()
2471
 
        for revision in revisions:
2472
 
            required_trees.add(revision.revision_id)
2473
 
            required_trees.update(revision.parent_ids[:1])
2474
 
 
2475
 
        # Get the matching filtered trees. Note that it's more
2476
 
        # efficient to pass filtered trees to changes_from() rather
2477
 
        # than doing the filtering afterwards. changes_from() could
2478
 
        # arguably do the filtering itself but it's path-based, not
2479
 
        # file-id based, so filtering before or afterwards is
2480
 
        # currently easier.
2481
 
        if specific_fileids is None:
2482
 
            trees = dict((t.get_revision_id(), t) for
2483
 
                t in self.revision_trees(required_trees))
2484
 
        else:
2485
 
            trees = dict((t.get_revision_id(), t) for
2486
 
                t in self._filtered_revision_trees(required_trees,
2487
 
                specific_fileids))
2488
 
 
2489
 
        # Calculate the deltas
2490
 
        for revision in revisions:
2491
 
            if not revision.parent_ids:
2492
 
                old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
2493
 
            else:
2494
 
                old_tree = trees[revision.parent_ids[0]]
2495
 
            yield trees[revision.revision_id].changes_from(old_tree)
2496
 
 
2497
 
    @needs_read_lock
2498
 
    def get_revision_delta(self, revision_id, specific_fileids=None):
2499
 
        r = self.get_revision(revision_id)
2500
 
        return list(self.get_deltas_for_revisions([r],
2501
 
            specific_fileids=specific_fileids))[0]
 
955
        self._ensure_real()
 
956
        return self._real_repository.all_revision_ids()
 
957
    
 
958
    @needs_read_lock
 
959
    def get_deltas_for_revisions(self, revisions):
 
960
        self._ensure_real()
 
961
        return self._real_repository.get_deltas_for_revisions(revisions)
 
962
 
 
963
    @needs_read_lock
 
964
    def get_revision_delta(self, revision_id):
 
965
        self._ensure_real()
 
966
        return self._real_repository.get_revision_delta(revision_id)
2502
967
 
2503
968
    @needs_read_lock
2504
969
    def revision_trees(self, revision_ids):
2505
 
        inventories = self.iter_inventories(revision_ids)
2506
 
        for inv in inventories:
2507
 
            yield InventoryRevisionTree(self, inv, inv.revision_id)
 
970
        self._ensure_real()
 
971
        return self._real_repository.revision_trees(revision_ids)
2508
972
 
2509
973
    @needs_read_lock
2510
974
    def get_revision_reconcile(self, revision_id):
2512
976
        return self._real_repository.get_revision_reconcile(revision_id)
2513
977
 
2514
978
    @needs_read_lock
2515
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
979
    def check(self, revision_ids=None):
2516
980
        self._ensure_real()
2517
 
        return self._real_repository.check(revision_ids=revision_ids,
2518
 
            callback_refs=callback_refs, check_repo=check_repo)
 
981
        return self._real_repository.check(revision_ids=revision_ids)
2519
982
 
2520
983
    def copy_content_into(self, destination, revision_id=None):
2521
 
        """Make a complete copy of the content in self into destination.
2522
 
 
2523
 
        This is a destructive operation! Do not use it on existing
2524
 
        repositories.
2525
 
        """
2526
 
        interrepo = _mod_repository.InterRepository.get(self, destination)
2527
 
        return interrepo.copy_content(revision_id)
 
984
        self._ensure_real()
 
985
        return self._real_repository.copy_content_into(
 
986
            destination, revision_id=revision_id)
2528
987
 
2529
988
    def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
2530
989
        # get a tarball of the remote repository, and copy from that into the
2531
990
        # destination
 
991
        from bzrlib import osutils
2532
992
        import tarfile
 
993
        import tempfile
2533
994
        # TODO: Maybe a progress bar while streaming the tarball?
2534
 
        note(gettext("Copying repository content as tarball..."))
 
995
        note("Copying repository content as tarball...")
2535
996
        tar_file = self._get_tarball('bz2')
2536
997
        if tar_file is None:
2537
998
            return None
2539
1000
        try:
2540
1001
            tar = tarfile.open('repository', fileobj=tar_file,
2541
1002
                mode='r|bz2')
2542
 
            tmpdir = osutils.mkdtemp()
 
1003
            tmpdir = tempfile.mkdtemp()
2543
1004
            try:
2544
1005
                _extract_tar(tar, tmpdir)
2545
 
                tmp_bzrdir = _mod_bzrdir.BzrDir.open(tmpdir)
 
1006
                tmp_bzrdir = BzrDir.open(tmpdir)
2546
1007
                tmp_repo = tmp_bzrdir.open_repository()
2547
1008
                tmp_repo.copy_content_into(destination, revision_id)
2548
1009
            finally:
2564
1025
        return self._real_repository.inventories
2565
1026
 
2566
1027
    @needs_write_lock
2567
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
1028
    def pack(self):
2568
1029
        """Compress the data within the repository.
 
1030
 
 
1031
        This is not currently implemented within the smart server.
2569
1032
        """
2570
 
        if hint is None:
2571
 
            body = ""
2572
 
        else:
2573
 
            body = "".join([l+"\n" for l in hint])
2574
 
        path = self.bzrdir._path_for_remote_call(self._client)
2575
 
        try:
2576
 
            response, handler = self._call_with_body_bytes_expecting_body(
2577
 
                'Repository.pack', (path, self._lock_token,
2578
 
                    str(clean_obsolete_packs)), body)
2579
 
        except errors.UnknownSmartMethod:
2580
 
            self._ensure_real()
2581
 
            return self._real_repository.pack(hint=hint,
2582
 
                clean_obsolete_packs=clean_obsolete_packs)
2583
 
        handler.cancel_read_body()
2584
 
        if response != ('ok', ):
2585
 
            raise errors.UnexpectedSmartServerResponse(response)
 
1033
        self._ensure_real()
 
1034
        return self._real_repository.pack()
2586
1035
 
2587
1036
    @property
2588
1037
    def revisions(self):
2589
1038
        """Decorate the real repository for now.
2590
1039
 
 
1040
        In the short term this should become a real object to intercept graph
 
1041
        lookups.
 
1042
 
2591
1043
        In the long term a full blown network facility is needed.
2592
1044
        """
2593
1045
        self._ensure_real()
2594
1046
        return self._real_repository.revisions
2595
1047
 
2596
1048
    def set_make_working_trees(self, new_value):
2597
 
        if new_value:
2598
 
            new_value_str = "True"
2599
 
        else:
2600
 
            new_value_str = "False"
2601
 
        path = self.bzrdir._path_for_remote_call(self._client)
2602
 
        try:
2603
 
            response = self._call(
2604
 
                'Repository.set_make_working_trees', path, new_value_str)
2605
 
        except errors.UnknownSmartMethod:
2606
 
            self._ensure_real()
2607
 
            self._real_repository.set_make_working_trees(new_value)
2608
 
        else:
2609
 
            if response[0] != 'ok':
2610
 
                raise errors.UnexpectedSmartServerResponse(response)
 
1049
        self._ensure_real()
 
1050
        self._real_repository.set_make_working_trees(new_value)
2611
1051
 
2612
1052
    @property
2613
1053
    def signatures(self):
2621
1061
 
2622
1062
    @needs_write_lock
2623
1063
    def sign_revision(self, revision_id, gpg_strategy):
2624
 
        testament = _mod_testament.Testament.from_revision(self, revision_id)
2625
 
        plaintext = testament.as_short_text()
2626
 
        self.store_revision_signature(gpg_strategy, plaintext, revision_id)
 
1064
        self._ensure_real()
 
1065
        return self._real_repository.sign_revision(revision_id, gpg_strategy)
2627
1066
 
2628
1067
    @property
2629
1068
    def texts(self):
2635
1074
        self._ensure_real()
2636
1075
        return self._real_repository.texts
2637
1076
 
2638
 
    def _iter_revisions_rpc(self, revision_ids):
2639
 
        body = "\n".join(revision_ids)
2640
 
        path = self.bzrdir._path_for_remote_call(self._client)
2641
 
        response_tuple, response_handler = (
2642
 
            self._call_with_body_bytes_expecting_body(
2643
 
            "Repository.iter_revisions", (path, ), body))
2644
 
        if response_tuple[0] != "ok":
2645
 
            raise errors.UnexpectedSmartServerResponse(response_tuple)
2646
 
        serializer_format = response_tuple[1]
2647
 
        serializer = serializer_format_registry.get(serializer_format)
2648
 
        byte_stream = response_handler.read_streamed_body()
2649
 
        decompressor = zlib.decompressobj()
2650
 
        chunks = []
2651
 
        for bytes in byte_stream:
2652
 
            chunks.append(decompressor.decompress(bytes))
2653
 
            if decompressor.unused_data != "":
2654
 
                chunks.append(decompressor.flush())
2655
 
                yield serializer.read_revision_from_string("".join(chunks))
2656
 
                unused = decompressor.unused_data
2657
 
                decompressor = zlib.decompressobj()
2658
 
                chunks = [decompressor.decompress(unused)]
2659
 
        chunks.append(decompressor.flush())
2660
 
        text = "".join(chunks)
2661
 
        if text != "":
2662
 
            yield serializer.read_revision_from_string("".join(chunks))
2663
 
 
2664
1077
    @needs_read_lock
2665
1078
    def get_revisions(self, revision_ids):
2666
 
        if revision_ids is None:
2667
 
            revision_ids = self.all_revision_ids()
2668
 
        else:
2669
 
            for rev_id in revision_ids:
2670
 
                if not rev_id or not isinstance(rev_id, basestring):
2671
 
                    raise errors.InvalidRevisionId(
2672
 
                        revision_id=rev_id, branch=self)
2673
 
        try:
2674
 
            missing = set(revision_ids)
2675
 
            revs = {}
2676
 
            for rev in self._iter_revisions_rpc(revision_ids):
2677
 
                missing.remove(rev.revision_id)
2678
 
                revs[rev.revision_id] = rev
2679
 
        except errors.UnknownSmartMethod:
2680
 
            self._ensure_real()
2681
 
            return self._real_repository.get_revisions(revision_ids)
2682
 
        for fallback in self._fallback_repositories:
2683
 
            if not missing:
2684
 
                break
2685
 
            for revid in list(missing):
2686
 
                # XXX JRV 2011-11-20: It would be nice if there was a
2687
 
                # public method on Repository that could be used to query
2688
 
                # for revision objects *without* failing completely if one
2689
 
                # was missing. There is VersionedFileRepository._iter_revisions,
2690
 
                # but unfortunately that's private and not provided by
2691
 
                # all repository implementations.
2692
 
                try:
2693
 
                    revs[revid] = fallback.get_revision(revid)
2694
 
                except errors.NoSuchRevision:
2695
 
                    pass
2696
 
                else:
2697
 
                    missing.remove(revid)
2698
 
        if missing:
2699
 
            raise errors.NoSuchRevision(self, list(missing)[0])
2700
 
        return [revs[revid] for revid in revision_ids]
 
1079
        self._ensure_real()
 
1080
        return self._real_repository.get_revisions(revision_ids)
2701
1081
 
2702
1082
    def supports_rich_root(self):
2703
 
        return self._format.rich_root_data
 
1083
        self._ensure_real()
 
1084
        return self._real_repository.supports_rich_root()
 
1085
 
 
1086
    def iter_reverse_revision_history(self, revision_id):
 
1087
        self._ensure_real()
 
1088
        return self._real_repository.iter_reverse_revision_history(revision_id)
2704
1089
 
2705
1090
    @property
2706
1091
    def _serializer(self):
2707
 
        return self._format._serializer
 
1092
        self._ensure_real()
 
1093
        return self._real_repository._serializer
2708
1094
 
2709
 
    @needs_write_lock
2710
1095
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
2711
 
        signature = gpg_strategy.sign(plaintext)
2712
 
        self.add_signature_text(revision_id, signature)
 
1096
        self._ensure_real()
 
1097
        return self._real_repository.store_revision_signature(
 
1098
            gpg_strategy, plaintext, revision_id)
2713
1099
 
2714
1100
    def add_signature_text(self, revision_id, signature):
2715
 
        if self._real_repository:
2716
 
            # If there is a real repository the write group will
2717
 
            # be in the real repository as well, so use that:
2718
 
            self._ensure_real()
2719
 
            return self._real_repository.add_signature_text(
2720
 
                revision_id, signature)
2721
 
        path = self.bzrdir._path_for_remote_call(self._client)
2722
 
        response, handler = self._call_with_body_bytes_expecting_body(
2723
 
            'Repository.add_signature_text', (path, self._lock_token,
2724
 
                revision_id) + tuple(self._write_group_tokens), signature)
2725
 
        handler.cancel_read_body()
2726
 
        self.refresh_data()
2727
 
        if response[0] != 'ok':
2728
 
            raise errors.UnexpectedSmartServerResponse(response)
2729
 
        self._write_group_tokens = response[1:]
 
1101
        self._ensure_real()
 
1102
        return self._real_repository.add_signature_text(revision_id, signature)
2730
1103
 
2731
1104
    def has_signature_for_revision_id(self, revision_id):
2732
 
        path = self.bzrdir._path_for_remote_call(self._client)
2733
 
        try:
2734
 
            response = self._call('Repository.has_signature_for_revision_id',
2735
 
                path, revision_id)
2736
 
        except errors.UnknownSmartMethod:
2737
 
            self._ensure_real()
2738
 
            return self._real_repository.has_signature_for_revision_id(
2739
 
                revision_id)
2740
 
        if response[0] not in ('yes', 'no'):
2741
 
            raise SmartProtocolError('unexpected response code %s' % (response,))
2742
 
        if response[0] == 'yes':
2743
 
            return True
2744
 
        for fallback in self._fallback_repositories:
2745
 
            if fallback.has_signature_for_revision_id(revision_id):
2746
 
                return True
2747
 
        return False
2748
 
 
2749
 
    @needs_read_lock
2750
 
    def verify_revision_signature(self, revision_id, gpg_strategy):
2751
 
        if not self.has_signature_for_revision_id(revision_id):
2752
 
            return gpg.SIGNATURE_NOT_SIGNED, None
2753
 
        signature = self.get_signature_text(revision_id)
2754
 
 
2755
 
        testament = _mod_testament.Testament.from_revision(self, revision_id)
2756
 
        plaintext = testament.as_short_text()
2757
 
 
2758
 
        return gpg_strategy.verify(signature, plaintext)
 
1105
        self._ensure_real()
 
1106
        return self._real_repository.has_signature_for_revision_id(revision_id)
2759
1107
 
2760
1108
    def item_keys_introduced_by(self, revision_ids, _files_pb=None):
2761
1109
        self._ensure_real()
2762
1110
        return self._real_repository.item_keys_introduced_by(revision_ids,
2763
1111
            _files_pb=_files_pb)
2764
1112
 
2765
 
    def _find_inconsistent_revision_parents(self, revisions_iterator=None):
2766
 
        self._ensure_real()
2767
 
        return self._real_repository._find_inconsistent_revision_parents(
2768
 
            revisions_iterator)
 
1113
    def revision_graph_can_have_wrong_parents(self):
 
1114
        # The answer depends on the remote repo format.
 
1115
        self._ensure_real()
 
1116
        return self._real_repository.revision_graph_can_have_wrong_parents()
 
1117
 
 
1118
    def _find_inconsistent_revision_parents(self):
 
1119
        self._ensure_real()
 
1120
        return self._real_repository._find_inconsistent_revision_parents()
2769
1121
 
2770
1122
    def _check_for_inconsistent_revision_parents(self):
2771
1123
        self._ensure_real()
2772
1124
        return self._real_repository._check_for_inconsistent_revision_parents()
2773
1125
 
2774
 
    def _make_parents_provider(self, other=None):
2775
 
        providers = [self._unstacked_provider]
2776
 
        if other is not None:
2777
 
            providers.insert(0, other)
2778
 
        return graph.StackedParentsProvider(_LazyListJoin(
2779
 
            providers, self._fallback_repositories))
 
1126
    def _make_parents_provider(self):
 
1127
        return self
2780
1128
 
2781
1129
    def _serialise_search_recipe(self, recipe):
2782
1130
        """Serialise a graph search recipe.
2784
1132
        :param recipe: A search recipe (start, stop, count).
2785
1133
        :return: Serialised bytes.
2786
1134
        """
2787
 
        start_keys = ' '.join(recipe[1])
2788
 
        stop_keys = ' '.join(recipe[2])
2789
 
        count = str(recipe[3])
 
1135
        start_keys = ' '.join(recipe[0])
 
1136
        stop_keys = ' '.join(recipe[1])
 
1137
        count = str(recipe[2])
2790
1138
        return '\n'.join((start_keys, stop_keys, count))
2791
1139
 
2792
 
    def _serialise_search_result(self, search_result):
2793
 
        parts = search_result.get_network_struct()
2794
 
        return '\n'.join(parts)
2795
 
 
2796
 
    def autopack(self):
2797
 
        path = self.bzrdir._path_for_remote_call(self._client)
2798
 
        try:
2799
 
            response = self._call('PackRepository.autopack', path)
2800
 
        except errors.UnknownSmartMethod:
2801
 
            self._ensure_real()
2802
 
            self._real_repository._pack_collection.autopack()
2803
 
            return
2804
 
        self.refresh_data()
2805
 
        if response[0] != 'ok':
2806
 
            raise errors.UnexpectedSmartServerResponse(response)
2807
 
 
2808
 
 
2809
 
class RemoteStreamSink(vf_repository.StreamSink):
2810
 
 
2811
 
    def _insert_real(self, stream, src_format, resume_tokens):
2812
 
        self.target_repo._ensure_real()
2813
 
        sink = self.target_repo._real_repository._get_sink()
2814
 
        result = sink.insert_stream(stream, src_format, resume_tokens)
2815
 
        if not result:
2816
 
            self.target_repo.autopack()
2817
 
        return result
2818
 
 
2819
 
    def insert_stream(self, stream, src_format, resume_tokens):
2820
 
        target = self.target_repo
2821
 
        target._unstacked_provider.missing_keys.clear()
2822
 
        candidate_calls = [('Repository.insert_stream_1.19', (1, 19))]
2823
 
        if target._lock_token:
2824
 
            candidate_calls.append(('Repository.insert_stream_locked', (1, 14)))
2825
 
            lock_args = (target._lock_token or '',)
2826
 
        else:
2827
 
            candidate_calls.append(('Repository.insert_stream', (1, 13)))
2828
 
            lock_args = ()
2829
 
        client = target._client
2830
 
        medium = client._medium
2831
 
        path = target.bzrdir._path_for_remote_call(client)
2832
 
        # Probe for the verb to use with an empty stream before sending the
2833
 
        # real stream to it.  We do this both to avoid the risk of sending a
2834
 
        # large request that is then rejected, and because we don't want to
2835
 
        # implement a way to buffer, rewind, or restart the stream.
2836
 
        found_verb = False
2837
 
        for verb, required_version in candidate_calls:
2838
 
            if medium._is_remote_before(required_version):
2839
 
                continue
2840
 
            if resume_tokens:
2841
 
                # We've already done the probing (and set _is_remote_before) on
2842
 
                # a previous insert.
2843
 
                found_verb = True
2844
 
                break
2845
 
            byte_stream = smart_repo._stream_to_byte_stream([], src_format)
2846
 
            try:
2847
 
                response = client.call_with_body_stream(
2848
 
                    (verb, path, '') + lock_args, byte_stream)
2849
 
            except errors.UnknownSmartMethod:
2850
 
                medium._remember_remote_is_before(required_version)
2851
 
            else:
2852
 
                found_verb = True
2853
 
                break
2854
 
        if not found_verb:
2855
 
            # Have to use VFS.
2856
 
            return self._insert_real(stream, src_format, resume_tokens)
2857
 
        self._last_inv_record = None
2858
 
        self._last_substream = None
2859
 
        if required_version < (1, 19):
2860
 
            # Remote side doesn't support inventory deltas.  Wrap the stream to
2861
 
            # make sure we don't send any.  If the stream contains inventory
2862
 
            # deltas we'll interrupt the smart insert_stream request and
2863
 
            # fallback to VFS.
2864
 
            stream = self._stop_stream_if_inventory_delta(stream)
2865
 
        byte_stream = smart_repo._stream_to_byte_stream(
2866
 
            stream, src_format)
2867
 
        resume_tokens = ' '.join(resume_tokens)
2868
 
        response = client.call_with_body_stream(
2869
 
            (verb, path, resume_tokens) + lock_args, byte_stream)
2870
 
        if response[0][0] not in ('ok', 'missing-basis'):
2871
 
            raise errors.UnexpectedSmartServerResponse(response)
2872
 
        if self._last_substream is not None:
2873
 
            # The stream included an inventory-delta record, but the remote
2874
 
            # side isn't new enough to support them.  So we need to send the
2875
 
            # rest of the stream via VFS.
2876
 
            self.target_repo.refresh_data()
2877
 
            return self._resume_stream_with_vfs(response, src_format)
2878
 
        if response[0][0] == 'missing-basis':
2879
 
            tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
2880
 
            resume_tokens = tokens
2881
 
            return resume_tokens, set(missing_keys)
2882
 
        else:
2883
 
            self.target_repo.refresh_data()
2884
 
            return [], set()
2885
 
 
2886
 
    def _resume_stream_with_vfs(self, response, src_format):
2887
 
        """Resume sending a stream via VFS, first resending the record and
2888
 
        substream that couldn't be sent via an insert_stream verb.
2889
 
        """
2890
 
        if response[0][0] == 'missing-basis':
2891
 
            tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
2892
 
            # Ignore missing_keys, we haven't finished inserting yet
2893
 
        else:
2894
 
            tokens = []
2895
 
        def resume_substream():
2896
 
            # Yield the substream that was interrupted.
2897
 
            for record in self._last_substream:
2898
 
                yield record
2899
 
            self._last_substream = None
2900
 
        def resume_stream():
2901
 
            # Finish sending the interrupted substream
2902
 
            yield ('inventory-deltas', resume_substream())
2903
 
            # Then simply continue sending the rest of the stream.
2904
 
            for substream_kind, substream in self._last_stream:
2905
 
                yield substream_kind, substream
2906
 
        return self._insert_real(resume_stream(), src_format, tokens)
2907
 
 
2908
 
    def _stop_stream_if_inventory_delta(self, stream):
2909
 
        """Normally this just lets the original stream pass-through unchanged.
2910
 
 
2911
 
        However if any 'inventory-deltas' substream occurs it will stop
2912
 
        streaming, and store the interrupted substream and stream in
2913
 
        self._last_substream and self._last_stream so that the stream can be
2914
 
        resumed by _resume_stream_with_vfs.
2915
 
        """
2916
 
 
2917
 
        stream_iter = iter(stream)
2918
 
        for substream_kind, substream in stream_iter:
2919
 
            if substream_kind == 'inventory-deltas':
2920
 
                self._last_substream = substream
2921
 
                self._last_stream = stream_iter
2922
 
                return
2923
 
            else:
2924
 
                yield substream_kind, substream
2925
 
 
2926
 
 
2927
 
class RemoteStreamSource(vf_repository.StreamSource):
2928
 
    """Stream data from a remote server."""
2929
 
 
2930
 
    def get_stream(self, search):
2931
 
        if (self.from_repository._fallback_repositories and
2932
 
            self.to_format._fetch_order == 'topological'):
2933
 
            return self._real_stream(self.from_repository, search)
2934
 
        sources = []
2935
 
        seen = set()
2936
 
        repos = [self.from_repository]
2937
 
        while repos:
2938
 
            repo = repos.pop(0)
2939
 
            if repo in seen:
2940
 
                continue
2941
 
            seen.add(repo)
2942
 
            repos.extend(repo._fallback_repositories)
2943
 
            sources.append(repo)
2944
 
        return self.missing_parents_chain(search, sources)
2945
 
 
2946
 
    def get_stream_for_missing_keys(self, missing_keys):
2947
 
        self.from_repository._ensure_real()
2948
 
        real_repo = self.from_repository._real_repository
2949
 
        real_source = real_repo._get_source(self.to_format)
2950
 
        return real_source.get_stream_for_missing_keys(missing_keys)
2951
 
 
2952
 
    def _real_stream(self, repo, search):
2953
 
        """Get a stream for search from repo.
2954
 
 
2955
 
        This never called RemoteStreamSource.get_stream, and is a helper
2956
 
        for RemoteStreamSource._get_stream to allow getting a stream
2957
 
        reliably whether fallback back because of old servers or trying
2958
 
        to stream from a non-RemoteRepository (which the stacked support
2959
 
        code will do).
2960
 
        """
2961
 
        source = repo._get_source(self.to_format)
2962
 
        if isinstance(source, RemoteStreamSource):
2963
 
            repo._ensure_real()
2964
 
            source = repo._real_repository._get_source(self.to_format)
2965
 
        return source.get_stream(search)
2966
 
 
2967
 
    def _get_stream(self, repo, search):
2968
 
        """Core worker to get a stream from repo for search.
2969
 
 
2970
 
        This is used by both get_stream and the stacking support logic. It
2971
 
        deliberately gets a stream for repo which does not need to be
2972
 
        self.from_repository. In the event that repo is not Remote, or
2973
 
        cannot do a smart stream, a fallback is made to the generic
2974
 
        repository._get_stream() interface, via self._real_stream.
2975
 
 
2976
 
        In the event of stacking, streams from _get_stream will not
2977
 
        contain all the data for search - this is normal (see get_stream).
2978
 
 
2979
 
        :param repo: A repository.
2980
 
        :param search: A search.
2981
 
        """
2982
 
        # Fallbacks may be non-smart
2983
 
        if not isinstance(repo, RemoteRepository):
2984
 
            return self._real_stream(repo, search)
2985
 
        client = repo._client
2986
 
        medium = client._medium
2987
 
        path = repo.bzrdir._path_for_remote_call(client)
2988
 
        search_bytes = repo._serialise_search_result(search)
2989
 
        args = (path, self.to_format.network_name())
2990
 
        candidate_verbs = [
2991
 
            ('Repository.get_stream_1.19', (1, 19)),
2992
 
            ('Repository.get_stream', (1, 13))]
2993
 
 
2994
 
        found_verb = False
2995
 
        for verb, version in candidate_verbs:
2996
 
            if medium._is_remote_before(version):
2997
 
                continue
2998
 
            try:
2999
 
                response = repo._call_with_body_bytes_expecting_body(
3000
 
                    verb, args, search_bytes)
3001
 
            except errors.UnknownSmartMethod:
3002
 
                medium._remember_remote_is_before(version)
3003
 
            except errors.UnknownErrorFromSmartServer, e:
3004
 
                if isinstance(search, vf_search.EverythingResult):
3005
 
                    error_verb = e.error_from_smart_server.error_verb
3006
 
                    if error_verb == 'BadSearch':
3007
 
                        # Pre-2.4 servers don't support this sort of search.
3008
 
                        # XXX: perhaps falling back to VFS on BadSearch is a
3009
 
                        # good idea in general?  It might provide a little bit
3010
 
                        # of protection against client-side bugs.
3011
 
                        medium._remember_remote_is_before((2, 4))
3012
 
                        break
3013
 
                raise
3014
 
            else:
3015
 
                response_tuple, response_handler = response
3016
 
                found_verb = True
3017
 
                break
3018
 
        if not found_verb:
3019
 
            return self._real_stream(repo, search)
3020
 
        if response_tuple[0] != 'ok':
3021
 
            raise errors.UnexpectedSmartServerResponse(response_tuple)
3022
 
        byte_stream = response_handler.read_streamed_body()
3023
 
        src_format, stream = smart_repo._byte_stream_to_stream(byte_stream,
3024
 
            self._record_counter)
3025
 
        if src_format.network_name() != repo._format.network_name():
3026
 
            raise AssertionError(
3027
 
                "Mismatched RemoteRepository and stream src %r, %r" % (
3028
 
                src_format.network_name(), repo._format.network_name()))
3029
 
        return stream
3030
 
 
3031
 
    def missing_parents_chain(self, search, sources):
3032
 
        """Chain multiple streams together to handle stacking.
3033
 
 
3034
 
        :param search: The overall search to satisfy with streams.
3035
 
        :param sources: A list of Repository objects to query.
3036
 
        """
3037
 
        self.from_serialiser = self.from_repository._format._serializer
3038
 
        self.seen_revs = set()
3039
 
        self.referenced_revs = set()
3040
 
        # If there are heads in the search, or the key count is > 0, we are not
3041
 
        # done.
3042
 
        while not search.is_empty() and len(sources) > 1:
3043
 
            source = sources.pop(0)
3044
 
            stream = self._get_stream(source, search)
3045
 
            for kind, substream in stream:
3046
 
                if kind != 'revisions':
3047
 
                    yield kind, substream
3048
 
                else:
3049
 
                    yield kind, self.missing_parents_rev_handler(substream)
3050
 
            search = search.refine(self.seen_revs, self.referenced_revs)
3051
 
            self.seen_revs = set()
3052
 
            self.referenced_revs = set()
3053
 
        if not search.is_empty():
3054
 
            for kind, stream in self._get_stream(sources[0], search):
3055
 
                yield kind, stream
3056
 
 
3057
 
    def missing_parents_rev_handler(self, substream):
3058
 
        for content in substream:
3059
 
            revision_bytes = content.get_bytes_as('fulltext')
3060
 
            revision = self.from_serialiser.read_revision_from_string(
3061
 
                revision_bytes)
3062
 
            self.seen_revs.add(content.key[-1])
3063
 
            self.referenced_revs.update(revision.parent_ids)
3064
 
            yield content
3065
 
 
3066
1140
 
3067
1141
class RemoteBranchLockableFiles(LockableFiles):
3068
1142
    """A 'LockableFiles' implementation that talks to a smart server.
3069
 
 
 
1143
    
3070
1144
    This is not a public interface class.
3071
1145
    """
3072
1146
 
3086
1160
 
3087
1161
class RemoteBranchFormat(branch.BranchFormat):
3088
1162
 
3089
 
    def __init__(self, network_name=None):
3090
 
        super(RemoteBranchFormat, self).__init__()
3091
 
        self._matchingbzrdir = RemoteBzrDirFormat()
3092
 
        self._matchingbzrdir.set_branch_format(self)
3093
 
        self._custom_format = None
3094
 
        self._network_name = network_name
3095
 
 
3096
1163
    def __eq__(self, other):
3097
 
        return (isinstance(other, RemoteBranchFormat) and
 
1164
        return (isinstance(other, RemoteBranchFormat) and 
3098
1165
            self.__dict__ == other.__dict__)
3099
1166
 
3100
 
    def _ensure_real(self):
3101
 
        if self._custom_format is None:
3102
 
            try:
3103
 
                self._custom_format = branch.network_format_registry.get(
3104
 
                    self._network_name)
3105
 
            except KeyError:
3106
 
                raise errors.UnknownFormatError(kind='branch',
3107
 
                    format=self._network_name)
3108
 
 
3109
1167
    def get_format_description(self):
3110
 
        self._ensure_real()
3111
 
        return 'Remote: ' + self._custom_format.get_format_description()
3112
 
 
3113
 
    def network_name(self):
3114
 
        return self._network_name
3115
 
 
3116
 
    def open(self, a_bzrdir, name=None, ignore_fallbacks=False):
3117
 
        return a_bzrdir.open_branch(name=name, 
3118
 
            ignore_fallbacks=ignore_fallbacks)
3119
 
 
3120
 
    def _vfs_initialize(self, a_bzrdir, name, append_revisions_only,
3121
 
                        repository=None):
3122
 
        # Initialisation when using a local bzrdir object, or a non-vfs init
3123
 
        # method is not available on the server.
3124
 
        # self._custom_format is always set - the start of initialize ensures
3125
 
        # that.
3126
 
        if isinstance(a_bzrdir, RemoteBzrDir):
3127
 
            a_bzrdir._ensure_real()
3128
 
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
3129
 
                name=name, append_revisions_only=append_revisions_only,
3130
 
                repository=repository)
3131
 
        else:
3132
 
            # We assume the bzrdir is parameterised; it may not be.
3133
 
            result = self._custom_format.initialize(a_bzrdir, name=name,
3134
 
                append_revisions_only=append_revisions_only,
3135
 
                repository=repository)
3136
 
        if (isinstance(a_bzrdir, RemoteBzrDir) and
3137
 
            not isinstance(result, RemoteBranch)):
3138
 
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
3139
 
                                  name=name)
3140
 
        return result
3141
 
 
3142
 
    def initialize(self, a_bzrdir, name=None, repository=None,
3143
 
                   append_revisions_only=None):
3144
 
        if name is None:
3145
 
            name = a_bzrdir._get_selected_branch()
3146
 
        # 1) get the network name to use.
3147
 
        if self._custom_format:
3148
 
            network_name = self._custom_format.network_name()
3149
 
        else:
3150
 
            # Select the current bzrlib default and ask for that.
3151
 
            reference_bzrdir_format = controldir.format_registry.get('default')()
3152
 
            reference_format = reference_bzrdir_format.get_branch_format()
3153
 
            self._custom_format = reference_format
3154
 
            network_name = reference_format.network_name()
3155
 
        # Being asked to create on a non RemoteBzrDir:
3156
 
        if not isinstance(a_bzrdir, RemoteBzrDir):
3157
 
            return self._vfs_initialize(a_bzrdir, name=name,
3158
 
                append_revisions_only=append_revisions_only,
3159
 
                repository=repository)
3160
 
        medium = a_bzrdir._client._medium
3161
 
        if medium._is_remote_before((1, 13)):
3162
 
            return self._vfs_initialize(a_bzrdir, name=name,
3163
 
                append_revisions_only=append_revisions_only,
3164
 
                repository=repository)
3165
 
        # Creating on a remote bzr dir.
3166
 
        # 2) try direct creation via RPC
3167
 
        path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
3168
 
        if name != "":
3169
 
            # XXX JRV20100304: Support creating colocated branches
3170
 
            raise errors.NoColocatedBranchSupport(self)
3171
 
        verb = 'BzrDir.create_branch'
3172
 
        try:
3173
 
            response = a_bzrdir._call(verb, path, network_name)
3174
 
        except errors.UnknownSmartMethod:
3175
 
            # Fallback - use vfs methods
3176
 
            medium._remember_remote_is_before((1, 13))
3177
 
            return self._vfs_initialize(a_bzrdir, name=name,
3178
 
                    append_revisions_only=append_revisions_only,
3179
 
                    repository=repository)
3180
 
        if response[0] != 'ok':
3181
 
            raise errors.UnexpectedSmartServerResponse(response)
3182
 
        # Turn the response into a RemoteRepository object.
3183
 
        format = RemoteBranchFormat(network_name=response[1])
3184
 
        repo_format = response_tuple_to_repo_format(response[3:])
3185
 
        repo_path = response[2]
3186
 
        if repository is not None:
3187
 
            remote_repo_url = urlutils.join(a_bzrdir.user_url, repo_path)
3188
 
            url_diff = urlutils.relative_url(repository.user_url,
3189
 
                    remote_repo_url)
3190
 
            if url_diff != '.':
3191
 
                raise AssertionError(
3192
 
                    'repository.user_url %r does not match URL from server '
3193
 
                    'response (%r + %r)'
3194
 
                    % (repository.user_url, a_bzrdir.user_url, repo_path))
3195
 
            remote_repo = repository
3196
 
        else:
3197
 
            if repo_path == '':
3198
 
                repo_bzrdir = a_bzrdir
3199
 
            else:
3200
 
                repo_bzrdir = RemoteBzrDir(
3201
 
                    a_bzrdir.root_transport.clone(repo_path), a_bzrdir._format,
3202
 
                    a_bzrdir._client)
3203
 
            remote_repo = RemoteRepository(repo_bzrdir, repo_format)
3204
 
        remote_branch = RemoteBranch(a_bzrdir, remote_repo,
3205
 
            format=format, setup_stacking=False, name=name)
3206
 
        if append_revisions_only:
3207
 
            remote_branch.set_append_revisions_only(append_revisions_only)
3208
 
        # XXX: We know this is a new branch, so it must have revno 0, revid
3209
 
        # NULL_REVISION. Creating the branch locked would make this be unable
3210
 
        # to be wrong; here its simply very unlikely to be wrong. RBC 20090225
3211
 
        remote_branch._last_revision_info_cache = 0, NULL_REVISION
3212
 
        return remote_branch
3213
 
 
3214
 
    def make_tags(self, branch):
3215
 
        self._ensure_real()
3216
 
        return self._custom_format.make_tags(branch)
 
1168
        return 'Remote BZR Branch'
 
1169
 
 
1170
    def get_format_string(self):
 
1171
        return 'Remote BZR Branch'
 
1172
 
 
1173
    def open(self, a_bzrdir):
 
1174
        return a_bzrdir.open_branch()
 
1175
 
 
1176
    def initialize(self, a_bzrdir):
 
1177
        return a_bzrdir.create_branch()
3217
1178
 
3218
1179
    def supports_tags(self):
3219
1180
        # Remote branches might support tags, but we won't know until we
3220
1181
        # access the real remote branch.
3221
 
        self._ensure_real()
3222
 
        return self._custom_format.supports_tags()
3223
 
 
3224
 
    def supports_stacking(self):
3225
 
        self._ensure_real()
3226
 
        return self._custom_format.supports_stacking()
3227
 
 
3228
 
    def supports_set_append_revisions_only(self):
3229
 
        self._ensure_real()
3230
 
        return self._custom_format.supports_set_append_revisions_only()
3231
 
 
3232
 
    def _use_default_local_heads_to_fetch(self):
3233
 
        # If the branch format is a metadir format *and* its heads_to_fetch
3234
 
        # implementation is not overridden vs the base class, we can use the
3235
 
        # base class logic rather than use the heads_to_fetch RPC.  This is
3236
 
        # usually cheaper in terms of net round trips, as the last-revision and
3237
 
        # tags info fetched is cached and would be fetched anyway.
3238
 
        self._ensure_real()
3239
 
        if isinstance(self._custom_format, branch.BranchFormatMetadir):
3240
 
            branch_class = self._custom_format._branch_class()
3241
 
            heads_to_fetch_impl = branch_class.heads_to_fetch.im_func
3242
 
            if heads_to_fetch_impl is branch.Branch.heads_to_fetch.im_func:
3243
 
                return True
3244
 
        return False
3245
 
 
3246
 
 
3247
 
class RemoteBranchStore(_mod_config.IniFileStore):
3248
 
    """Branch store which attempts to use HPSS calls to retrieve branch store.
3249
 
 
3250
 
    Note that this is specific to bzr-based formats.
3251
 
    """
3252
 
 
3253
 
    def __init__(self, branch):
3254
 
        super(RemoteBranchStore, self).__init__()
3255
 
        self.branch = branch
3256
 
        self.id = "branch"
3257
 
        self._real_store = None
3258
 
 
3259
 
    def external_url(self):
3260
 
        return urlutils.join(self.branch.user_url, 'branch.conf')
3261
 
 
3262
 
    def _load_content(self):
3263
 
        path = self.branch._remote_path()
3264
 
        try:
3265
 
            response, handler = self.branch._call_expecting_body(
3266
 
                'Branch.get_config_file', path)
3267
 
        except errors.UnknownSmartMethod:
3268
 
            self._ensure_real()
3269
 
            return self._real_store._load_content()
3270
 
        if len(response) and response[0] != 'ok':
3271
 
            raise errors.UnexpectedSmartServerResponse(response)
3272
 
        return handler.read_body_bytes()
3273
 
 
3274
 
    def _save_content(self, content):
3275
 
        path = self.branch._remote_path()
3276
 
        try:
3277
 
            response, handler = self.branch._call_with_body_bytes_expecting_body(
3278
 
                'Branch.put_config_file', (path,
3279
 
                    self.branch._lock_token, self.branch._repo_lock_token),
3280
 
                content)
3281
 
        except errors.UnknownSmartMethod:
3282
 
            self._ensure_real()
3283
 
            return self._real_store._save_content(content)
3284
 
        handler.cancel_read_body()
3285
 
        if response != ('ok', ):
3286
 
            raise errors.UnexpectedSmartServerResponse(response)
3287
 
 
3288
 
    def _ensure_real(self):
3289
 
        self.branch._ensure_real()
3290
 
        if self._real_store is None:
3291
 
            self._real_store = _mod_config.BranchStore(self.branch)
3292
 
 
3293
 
 
3294
 
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
 
1182
        return True
 
1183
 
 
1184
 
 
1185
class RemoteBranch(branch.Branch):
3295
1186
    """Branch stored on a server accessed by HPSS RPC.
3296
1187
 
3297
1188
    At the moment most operations are mapped down to simple file operations.
3298
1189
    """
3299
1190
 
3300
1191
    def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
3301
 
        _client=None, format=None, setup_stacking=True, name=None,
3302
 
        possible_transports=None):
 
1192
        _client=None):
3303
1193
        """Create a RemoteBranch instance.
3304
1194
 
3305
1195
        :param real_branch: An optional local implementation of the branch
3306
1196
            format, usually accessing the data via the VFS.
3307
1197
        :param _client: Private parameter for testing.
3308
 
        :param format: A RemoteBranchFormat object, None to create one
3309
 
            automatically. If supplied it should have a network_name already
3310
 
            supplied.
3311
 
        :param setup_stacking: If True make an RPC call to determine the
3312
 
            stacked (or not) status of the branch. If False assume the branch
3313
 
            is not stacked.
3314
 
        :param name: Colocated branch name
3315
1198
        """
3316
1199
        # We intentionally don't call the parent class's __init__, because it
3317
1200
        # will try to assign to self.tags, which is a property in this subclass.
3318
1201
        # And the parent's __init__ doesn't do much anyway.
 
1202
        self._revision_id_to_revno_cache = None
 
1203
        self._revision_history_cache = None
 
1204
        self._last_revision_info_cache = None
3319
1205
        self.bzrdir = remote_bzrdir
3320
 
        self.name = name
3321
1206
        if _client is not None:
3322
1207
            self._client = _client
3323
1208
        else:
3335
1220
            self._real_branch.repository = self.repository
3336
1221
        else:
3337
1222
            self._real_branch = None
3338
 
        # Fill out expected attributes of branch for bzrlib API users.
3339
 
        self._clear_cached_state()
3340
 
        # TODO: deprecate self.base in favor of user_url
3341
 
        self.base = self.bzrdir.user_url
3342
 
        self._name = name
 
1223
        # Fill out expected attributes of branch for bzrlib api users.
 
1224
        self._format = RemoteBranchFormat()
 
1225
        self.base = self.bzrdir.root_transport.base
3343
1226
        self._control_files = None
3344
1227
        self._lock_mode = None
3345
1228
        self._lock_token = None
3346
1229
        self._repo_lock_token = None
3347
1230
        self._lock_count = 0
3348
1231
        self._leave_lock = False
3349
 
        self.conf_store = None
3350
 
        # Setup a format: note that we cannot call _ensure_real until all the
3351
 
        # attributes above are set: This code cannot be moved higher up in this
3352
 
        # function.
3353
 
        if format is None:
3354
 
            self._format = RemoteBranchFormat()
3355
 
            if real_branch is not None:
3356
 
                self._format._network_name = \
3357
 
                    self._real_branch._format.network_name()
3358
 
        else:
3359
 
            self._format = format
3360
 
        # when we do _ensure_real we may need to pass ignore_fallbacks to the
3361
 
        # branch.open_branch method.
3362
 
        self._real_ignore_fallbacks = not setup_stacking
3363
 
        if not self._format._network_name:
3364
 
            # Did not get from open_branchV2 - old server.
3365
 
            self._ensure_real()
3366
 
            self._format._network_name = \
3367
 
                self._real_branch._format.network_name()
3368
 
        self.tags = self._format.make_tags(self)
3369
 
        # The base class init is not called, so we duplicate this:
3370
 
        hooks = branch.Branch.hooks['open']
3371
 
        for hook in hooks:
3372
 
            hook(self)
3373
 
        self._is_stacked = False
3374
 
        if setup_stacking:
3375
 
            self._setup_stacking(possible_transports)
3376
 
 
3377
 
    def _setup_stacking(self, possible_transports):
3378
 
        # configure stacking into the remote repository, by reading it from
3379
 
        # the vfs branch.
3380
 
        try:
3381
 
            fallback_url = self.get_stacked_on_url()
3382
 
        except (errors.NotStacked, errors.UnstackableBranchFormat,
3383
 
            errors.UnstackableRepositoryFormat), e:
3384
 
            return
3385
 
        self._is_stacked = True
3386
 
        if possible_transports is None:
3387
 
            possible_transports = []
3388
 
        else:
3389
 
            possible_transports = list(possible_transports)
3390
 
        possible_transports.append(self.bzrdir.root_transport)
3391
 
        self._activate_fallback_location(fallback_url,
3392
 
            possible_transports=possible_transports)
3393
 
 
3394
 
    def _get_config(self):
3395
 
        return RemoteBranchConfig(self)
3396
 
 
3397
 
    def _get_config_store(self):
3398
 
        if self.conf_store is None:
3399
 
            self.conf_store =  RemoteBranchStore(self)
3400
 
        return self.conf_store
3401
 
 
3402
 
    def store_uncommitted(self, creator):
3403
 
        self._ensure_real()
3404
 
        return self._real_branch.store_uncommitted(creator)
3405
 
 
3406
 
    def get_unshelver(self, tree):
3407
 
        self._ensure_real()
3408
 
        return self._real_branch.get_unshelver(tree)
3409
1232
 
3410
1233
    def _get_real_transport(self):
3411
1234
        # if we try vfs access, return the real branch's vfs transport
3429
1252
                raise AssertionError('smart server vfs must be enabled '
3430
1253
                    'to use vfs implementation')
3431
1254
            self.bzrdir._ensure_real()
3432
 
            self._real_branch = self.bzrdir._real_bzrdir.open_branch(
3433
 
                ignore_fallbacks=self._real_ignore_fallbacks, name=self._name)
3434
 
            # The remote branch and the real branch shares the same store. If
3435
 
            # we don't, there will always be cases where one of the stores
3436
 
            # doesn't see an update made on the other.
3437
 
            self._real_branch.conf_store = self.conf_store
3438
 
            if self.repository._real_repository is None:
3439
 
                # Give the remote repository the matching real repo.
3440
 
                real_repo = self._real_branch.repository
3441
 
                if isinstance(real_repo, RemoteRepository):
3442
 
                    real_repo._ensure_real()
3443
 
                    real_repo = real_repo._real_repository
3444
 
                self.repository._set_real_repository(real_repo)
3445
 
            # Give the real branch the remote repository to let fast-pathing
3446
 
            # happen.
 
1255
            self._real_branch = self.bzrdir._real_bzrdir.open_branch()
 
1256
            # Give the remote repository the matching real repo.
 
1257
            real_repo = self._real_branch.repository
 
1258
            if isinstance(real_repo, RemoteRepository):
 
1259
                real_repo._ensure_real()
 
1260
                real_repo = real_repo._real_repository
 
1261
            self.repository._set_real_repository(real_repo)
 
1262
            # Give the branch the remote repository to let fast-pathing happen.
3447
1263
            self._real_branch.repository = self.repository
 
1264
            # XXX: deal with _lock_mode == 'w'
3448
1265
            if self._lock_mode == 'r':
3449
1266
                self._real_branch.lock_read()
3450
 
            elif self._lock_mode == 'w':
3451
 
                self._real_branch.lock_write(token=self._lock_token)
3452
 
 
3453
 
    def _translate_error(self, err, **context):
3454
 
        self.repository._translate_error(err, branch=self, **context)
3455
1267
 
3456
1268
    def _clear_cached_state(self):
3457
1269
        super(RemoteBranch, self)._clear_cached_state()
3469
1281
        too, in fact doing so might harm performance.
3470
1282
        """
3471
1283
        super(RemoteBranch, self)._clear_cached_state()
3472
 
 
 
1284
        
3473
1285
    @property
3474
1286
    def control_files(self):
3475
1287
        # Defer actually creating RemoteBranchLockableFiles until its needed,
3479
1291
                self.bzrdir, self._client)
3480
1292
        return self._control_files
3481
1293
 
 
1294
    def _get_checkout_format(self):
 
1295
        self._ensure_real()
 
1296
        return self._real_branch._get_checkout_format()
 
1297
 
3482
1298
    def get_physical_lock_status(self):
3483
1299
        """See Branch.get_physical_lock_status()."""
3484
 
        try:
3485
 
            response = self._client.call('Branch.get_physical_lock_status',
3486
 
                self._remote_path())
3487
 
        except errors.UnknownSmartMethod:
3488
 
            self._ensure_real()
3489
 
            return self._real_branch.get_physical_lock_status()
3490
 
        if response[0] not in ('yes', 'no'):
3491
 
            raise errors.UnexpectedSmartServerResponse(response)
3492
 
        return (response[0] == 'yes')
3493
 
 
3494
 
    def get_stacked_on_url(self):
3495
 
        """Get the URL this branch is stacked against.
3496
 
 
3497
 
        :raises NotStacked: If the branch is not stacked.
3498
 
        :raises UnstackableBranchFormat: If the branch does not support
3499
 
            stacking.
3500
 
        :raises UnstackableRepositoryFormat: If the repository does not support
3501
 
            stacking.
3502
 
        """
3503
 
        try:
3504
 
            # there may not be a repository yet, so we can't use
3505
 
            # self._translate_error, so we can't use self._call either.
3506
 
            response = self._client.call('Branch.get_stacked_on_url',
3507
 
                self._remote_path())
3508
 
        except errors.ErrorFromSmartServer, err:
3509
 
            # there may not be a repository yet, so we can't call through
3510
 
            # its _translate_error
3511
 
            _translate_error(err, branch=self)
3512
 
        except errors.UnknownSmartMethod, err:
3513
 
            self._ensure_real()
3514
 
            return self._real_branch.get_stacked_on_url()
3515
 
        if response[0] != 'ok':
3516
 
            raise errors.UnexpectedSmartServerResponse(response)
3517
 
        return response[1]
3518
 
 
3519
 
    def set_stacked_on_url(self, url):
3520
 
        branch.Branch.set_stacked_on_url(self, url)
3521
 
        # We need the stacked_on_url to be visible both locally (to not query
3522
 
        # it repeatedly) and remotely (so smart verbs can get it server side)
3523
 
        # Without the following line,
3524
 
        # bzrlib.tests.per_branch.test_create_clone.TestCreateClone
3525
 
        # .test_create_clone_on_transport_stacked_hooks_get_stacked_branch
3526
 
        # fails for remote branches -- vila 2012-01-04
3527
 
        self.conf_store.save_changes()
3528
 
        if not url:
3529
 
            self._is_stacked = False
3530
 
        else:
3531
 
            self._is_stacked = True
3532
 
 
3533
 
    def _vfs_get_tags_bytes(self):
3534
 
        self._ensure_real()
3535
 
        return self._real_branch._get_tags_bytes()
3536
 
 
3537
 
    @needs_read_lock
3538
 
    def _get_tags_bytes(self):
3539
 
        if self._tags_bytes is None:
3540
 
            self._tags_bytes = self._get_tags_bytes_via_hpss()
3541
 
        return self._tags_bytes
3542
 
 
3543
 
    def _get_tags_bytes_via_hpss(self):
3544
 
        medium = self._client._medium
3545
 
        if medium._is_remote_before((1, 13)):
3546
 
            return self._vfs_get_tags_bytes()
3547
 
        try:
3548
 
            response = self._call('Branch.get_tags_bytes', self._remote_path())
3549
 
        except errors.UnknownSmartMethod:
3550
 
            medium._remember_remote_is_before((1, 13))
3551
 
            return self._vfs_get_tags_bytes()
3552
 
        return response[0]
3553
 
 
3554
 
    def _vfs_set_tags_bytes(self, bytes):
3555
 
        self._ensure_real()
3556
 
        return self._real_branch._set_tags_bytes(bytes)
3557
 
 
3558
 
    def _set_tags_bytes(self, bytes):
3559
 
        if self.is_locked():
3560
 
            self._tags_bytes = bytes
3561
 
        medium = self._client._medium
3562
 
        if medium._is_remote_before((1, 18)):
3563
 
            self._vfs_set_tags_bytes(bytes)
3564
 
            return
3565
 
        try:
3566
 
            args = (
3567
 
                self._remote_path(), self._lock_token, self._repo_lock_token)
3568
 
            response = self._call_with_body_bytes(
3569
 
                'Branch.set_tags_bytes', args, bytes)
3570
 
        except errors.UnknownSmartMethod:
3571
 
            medium._remember_remote_is_before((1, 18))
3572
 
            self._vfs_set_tags_bytes(bytes)
 
1300
        # should be an API call to the server, as branches must be lockable.
 
1301
        self._ensure_real()
 
1302
        return self._real_branch.get_physical_lock_status()
3573
1303
 
3574
1304
    def lock_read(self):
3575
 
        """Lock the branch for read operations.
3576
 
 
3577
 
        :return: A bzrlib.lock.LogicalLockResult.
3578
 
        """
3579
 
        self.repository.lock_read()
3580
1305
        if not self._lock_mode:
3581
 
            self._note_lock('r')
3582
1306
            self._lock_mode = 'r'
3583
1307
            self._lock_count = 1
3584
1308
            if self._real_branch is not None:
3585
1309
                self._real_branch.lock_read()
3586
1310
        else:
3587
1311
            self._lock_count += 1
3588
 
        return lock.LogicalLockResult(self.unlock)
3589
1312
 
3590
1313
    def _remote_lock_write(self, token):
3591
1314
        if token is None:
3592
1315
            branch_token = repo_token = ''
3593
1316
        else:
3594
1317
            branch_token = token
3595
 
            repo_token = self.repository.lock_write().repository_token
 
1318
            repo_token = self.repository.lock_write()
3596
1319
            self.repository.unlock()
3597
 
        err_context = {'token': token}
 
1320
        path = self.bzrdir._path_for_remote_call(self._client)
3598
1321
        try:
3599
 
            response = self._call(
3600
 
                'Branch.lock_write', self._remote_path(), branch_token,
3601
 
                repo_token or '', **err_context)
3602
 
        except errors.LockContention, e:
3603
 
            # The LockContention from the server doesn't have any
3604
 
            # information about the lock_url. We re-raise LockContention
3605
 
            # with valid lock_url.
3606
 
            raise errors.LockContention('(remote lock)',
3607
 
                self.repository.base.split('.bzr/')[0])
 
1322
            response = self._client.call(
 
1323
                'Branch.lock_write', path, branch_token, repo_token or '')
 
1324
        except errors.ErrorFromSmartServer, err:
 
1325
            if err.error_verb == 'LockContention':
 
1326
                raise errors.LockContention('(remote lock)')
 
1327
            elif err.error_verb == 'TokenMismatch':
 
1328
                raise errors.TokenMismatch(token, '(remote token)')
 
1329
            elif err.error_verb == 'UnlockableTransport':
 
1330
                raise errors.UnlockableTransport(self.bzrdir.root_transport)
 
1331
            elif err.error_verb == 'ReadOnlyError':
 
1332
                raise errors.ReadOnlyError(self)
 
1333
            elif err.error_verb == 'LockFailed':
 
1334
                raise errors.LockFailed(err.error_args[0], err.error_args[1])
 
1335
            raise
3608
1336
        if response[0] != 'ok':
3609
1337
            raise errors.UnexpectedSmartServerResponse(response)
3610
1338
        ok, branch_token, repo_token = response
3611
1339
        return branch_token, repo_token
3612
 
 
 
1340
            
3613
1341
    def lock_write(self, token=None):
3614
1342
        if not self._lock_mode:
3615
 
            self._note_lock('w')
3616
 
            # Lock the branch and repo in one remote call.
3617
1343
            remote_tokens = self._remote_lock_write(token)
3618
1344
            self._lock_token, self._repo_lock_token = remote_tokens
3619
1345
            if not self._lock_token:
3620
1346
                raise SmartProtocolError('Remote server did not return a token!')
3621
 
            # Tell the self.repository object that it is locked.
3622
 
            self.repository.lock_write(
3623
 
                self._repo_lock_token, _skip_rpc=True)
3624
 
 
 
1347
            # TODO: We really, really, really don't want to call _ensure_real
 
1348
            # here, but it's the easiest way to ensure coherency between the
 
1349
            # state of the RemoteBranch and RemoteRepository objects and the
 
1350
            # physical locks.  If we don't materialise the real objects here,
 
1351
            # then getting everything in the right state later is complex, so
 
1352
            # for now we just do it the lazy way.
 
1353
            #   -- Andrew Bennetts, 2007-02-22.
 
1354
            self._ensure_real()
3625
1355
            if self._real_branch is not None:
3626
 
                self._real_branch.lock_write(token=self._lock_token)
 
1356
                self._real_branch.repository.lock_write(
 
1357
                    token=self._repo_lock_token)
 
1358
                try:
 
1359
                    self._real_branch.lock_write(token=self._lock_token)
 
1360
                finally:
 
1361
                    self._real_branch.repository.unlock()
3627
1362
            if token is not None:
3628
1363
                self._leave_lock = True
3629
1364
            else:
 
1365
                # XXX: this case seems to be unreachable; token cannot be None.
3630
1366
                self._leave_lock = False
3631
1367
            self._lock_mode = 'w'
3632
1368
            self._lock_count = 1
3633
1369
        elif self._lock_mode == 'r':
3634
 
            raise errors.ReadOnlyError(self)
 
1370
            raise errors.ReadOnlyTransaction
3635
1371
        else:
3636
1372
            if token is not None:
3637
 
                # A token was given to lock_write, and we're relocking, so
3638
 
                # check that the given token actually matches the one we
3639
 
                # already have.
 
1373
                # A token was given to lock_write, and we're relocking, so check
 
1374
                # that the given token actually matches the one we already have.
3640
1375
                if token != self._lock_token:
3641
1376
                    raise errors.TokenMismatch(token, self._lock_token)
3642
1377
            self._lock_count += 1
3643
 
            # Re-lock the repository too.
3644
 
            self.repository.lock_write(self._repo_lock_token)
3645
 
        return BranchWriteLockResult(self.unlock, self._lock_token or None)
 
1378
        return self._lock_token or None
3646
1379
 
3647
1380
    def _unlock(self, branch_token, repo_token):
3648
 
        err_context = {'token': str((branch_token, repo_token))}
3649
 
        response = self._call(
3650
 
            'Branch.unlock', self._remote_path(), branch_token,
3651
 
            repo_token or '', **err_context)
 
1381
        path = self.bzrdir._path_for_remote_call(self._client)
 
1382
        try:
 
1383
            response = self._client.call('Branch.unlock', path, branch_token,
 
1384
                                         repo_token or '')
 
1385
        except errors.ErrorFromSmartServer, err:
 
1386
            if err.error_verb == 'TokenMismatch':
 
1387
                raise errors.TokenMismatch(
 
1388
                    str((branch_token, repo_token)), '(remote tokens)')
 
1389
            raise
3652
1390
        if response == ('ok',):
3653
1391
            return
3654
1392
        raise errors.UnexpectedSmartServerResponse(response)
3655
1393
 
3656
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
3657
1394
    def unlock(self):
3658
 
        try:
3659
 
            self._lock_count -= 1
3660
 
            if not self._lock_count:
3661
 
                if self.conf_store is not None:
3662
 
                    self.conf_store.save_changes()
3663
 
                self._clear_cached_state()
3664
 
                mode = self._lock_mode
3665
 
                self._lock_mode = None
3666
 
                if self._real_branch is not None:
3667
 
                    if (not self._leave_lock and mode == 'w' and
3668
 
                        self._repo_lock_token):
3669
 
                        # If this RemoteBranch will remove the physical lock
3670
 
                        # for the repository, make sure the _real_branch
3671
 
                        # doesn't do it first.  (Because the _real_branch's
3672
 
                        # repository is set to be the RemoteRepository.)
3673
 
                        self._real_branch.repository.leave_lock_in_place()
3674
 
                    self._real_branch.unlock()
3675
 
                if mode != 'w':
3676
 
                    # Only write-locked branched need to make a remote method
3677
 
                    # call to perform the unlock.
3678
 
                    return
3679
 
                if not self._lock_token:
3680
 
                    raise AssertionError('Locked, but no token!')
3681
 
                branch_token = self._lock_token
3682
 
                repo_token = self._repo_lock_token
3683
 
                self._lock_token = None
3684
 
                self._repo_lock_token = None
3685
 
                if not self._leave_lock:
3686
 
                    self._unlock(branch_token, repo_token)
3687
 
        finally:
3688
 
            self.repository.unlock()
 
1395
        self._lock_count -= 1
 
1396
        if not self._lock_count:
 
1397
            self._clear_cached_state()
 
1398
            mode = self._lock_mode
 
1399
            self._lock_mode = None
 
1400
            if self._real_branch is not None:
 
1401
                if (not self._leave_lock and mode == 'w' and
 
1402
                    self._repo_lock_token):
 
1403
                    # If this RemoteBranch will remove the physical lock for the
 
1404
                    # repository, make sure the _real_branch doesn't do it
 
1405
                    # first.  (Because the _real_branch's repository is set to
 
1406
                    # be the RemoteRepository.)
 
1407
                    self._real_branch.repository.leave_lock_in_place()
 
1408
                self._real_branch.unlock()
 
1409
            if mode != 'w':
 
1410
                # Only write-locked branched need to make a remote method call
 
1411
                # to perfom the unlock.
 
1412
                return
 
1413
            if not self._lock_token:
 
1414
                raise AssertionError('Locked, but no token!')
 
1415
            branch_token = self._lock_token
 
1416
            repo_token = self._repo_lock_token
 
1417
            self._lock_token = None
 
1418
            self._repo_lock_token = None
 
1419
            if not self._leave_lock:
 
1420
                self._unlock(branch_token, repo_token)
3689
1421
 
3690
1422
    def break_lock(self):
3691
 
        try:
3692
 
            response = self._call(
3693
 
                'Branch.break_lock', self._remote_path())
3694
 
        except errors.UnknownSmartMethod:
3695
 
            self._ensure_real()
3696
 
            return self._real_branch.break_lock()
3697
 
        if response != ('ok',):
3698
 
            raise errors.UnexpectedSmartServerResponse(response)
 
1423
        self._ensure_real()
 
1424
        return self._real_branch.break_lock()
3699
1425
 
3700
1426
    def leave_lock_in_place(self):
3701
1427
        if not self._lock_token:
3707
1433
            raise NotImplementedError(self.dont_leave_lock_in_place)
3708
1434
        self._leave_lock = False
3709
1435
 
3710
 
    @needs_read_lock
3711
 
    def get_rev_id(self, revno, history=None):
3712
 
        if revno == 0:
3713
 
            return _mod_revision.NULL_REVISION
3714
 
        last_revision_info = self.last_revision_info()
3715
 
        ok, result = self.repository.get_rev_id_for_revno(
3716
 
            revno, last_revision_info)
3717
 
        if ok:
3718
 
            return result
3719
 
        missing_parent = result[1]
3720
 
        # Either the revision named by the server is missing, or its parent
3721
 
        # is.  Call get_parent_map to determine which, so that we report a
3722
 
        # useful error.
3723
 
        parent_map = self.repository.get_parent_map([missing_parent])
3724
 
        if missing_parent in parent_map:
3725
 
            missing_parent = parent_map[missing_parent]
3726
 
        raise errors.RevisionNotPresent(missing_parent, self.repository)
3727
 
 
3728
 
    def _read_last_revision_info(self):
3729
 
        response = self._call('Branch.last_revision_info', self._remote_path())
 
1436
    def _last_revision_info(self):
 
1437
        path = self.bzrdir._path_for_remote_call(self._client)
 
1438
        response = self._client.call('Branch.last_revision_info', path)
3730
1439
        if response[0] != 'ok':
3731
1440
            raise SmartProtocolError('unexpected response code %s' % (response,))
3732
1441
        revno = int(response[1])
3735
1444
 
3736
1445
    def _gen_revision_history(self):
3737
1446
        """See Branch._gen_revision_history()."""
3738
 
        if self._is_stacked:
3739
 
            self._ensure_real()
3740
 
            return self._real_branch._gen_revision_history()
3741
 
        response_tuple, response_handler = self._call_expecting_body(
3742
 
            'Branch.revision_history', self._remote_path())
 
1447
        path = self.bzrdir._path_for_remote_call(self._client)
 
1448
        response_tuple, response_handler = self._client.call_expecting_body(
 
1449
            'Branch.revision_history', path)
3743
1450
        if response_tuple[0] != 'ok':
3744
1451
            raise errors.UnexpectedSmartServerResponse(response_tuple)
3745
1452
        result = response_handler.read_body_bytes().split('\x00')
3747
1454
            return []
3748
1455
        return result
3749
1456
 
3750
 
    def _remote_path(self):
3751
 
        return self.bzrdir._path_for_remote_call(self._client)
3752
 
 
3753
1457
    def _set_last_revision_descendant(self, revision_id, other_branch,
3754
1458
            allow_diverged=False, allow_overwrite_descendant=False):
3755
 
        # This performs additional work to meet the hook contract; while its
3756
 
        # undesirable, we have to synthesise the revno to call the hook, and
3757
 
        # not calling the hook is worse as it means changes can't be prevented.
3758
 
        # Having calculated this though, we can't just call into
3759
 
        # set_last_revision_info as a simple call, because there is a set_rh
3760
 
        # hook that some folk may still be using.
3761
 
        old_revno, old_revid = self.last_revision_info()
3762
 
        history = self._lefthand_history(revision_id)
3763
 
        self._run_pre_change_branch_tip_hooks(len(history), revision_id)
3764
 
        err_context = {'other_branch': other_branch}
3765
 
        response = self._call('Branch.set_last_revision_ex',
3766
 
            self._remote_path(), self._lock_token, self._repo_lock_token,
3767
 
            revision_id, int(allow_diverged), int(allow_overwrite_descendant),
3768
 
            **err_context)
 
1459
        path = self.bzrdir._path_for_remote_call(self._client)
 
1460
        try:
 
1461
            response = self._client.call('Branch.set_last_revision_ex',
 
1462
                path, self._lock_token, self._repo_lock_token, revision_id,
 
1463
                int(allow_diverged), int(allow_overwrite_descendant))
 
1464
        except errors.ErrorFromSmartServer, err:
 
1465
            if err.error_verb == 'NoSuchRevision':
 
1466
                raise NoSuchRevision(self, revision_id)
 
1467
            elif err.error_verb == 'Diverged':
 
1468
                raise errors.DivergedBranches(self, other_branch)
 
1469
            raise
3769
1470
        self._clear_cached_state()
3770
1471
        if len(response) != 3 and response[0] != 'ok':
3771
1472
            raise errors.UnexpectedSmartServerResponse(response)
3772
1473
        new_revno, new_revision_id = response[1:]
3773
1474
        self._last_revision_info_cache = new_revno, new_revision_id
3774
 
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
3775
 
        if self._real_branch is not None:
3776
 
            cache = new_revno, new_revision_id
3777
 
            self._real_branch._last_revision_info_cache = cache
 
1475
        self._real_branch._last_revision_info_cache = new_revno, new_revision_id
3778
1476
 
3779
1477
    def _set_last_revision(self, revision_id):
3780
 
        old_revno, old_revid = self.last_revision_info()
3781
 
        # This performs additional work to meet the hook contract; while its
3782
 
        # undesirable, we have to synthesise the revno to call the hook, and
3783
 
        # not calling the hook is worse as it means changes can't be prevented.
3784
 
        # Having calculated this though, we can't just call into
3785
 
        # set_last_revision_info as a simple call, because there is a set_rh
3786
 
        # hook that some folk may still be using.
3787
 
        history = self._lefthand_history(revision_id)
3788
 
        self._run_pre_change_branch_tip_hooks(len(history), revision_id)
 
1478
        path = self.bzrdir._path_for_remote_call(self._client)
3789
1479
        self._clear_cached_state()
3790
 
        response = self._call('Branch.set_last_revision',
3791
 
            self._remote_path(), self._lock_token, self._repo_lock_token,
3792
 
            revision_id)
 
1480
        try:
 
1481
            response = self._client.call('Branch.set_last_revision',
 
1482
                path, self._lock_token, self._repo_lock_token, revision_id)
 
1483
        except errors.ErrorFromSmartServer, err:
 
1484
            if err.error_verb == 'NoSuchRevision':
 
1485
                raise NoSuchRevision(self, revision_id)
 
1486
            raise
3793
1487
        if response != ('ok',):
3794
1488
            raise errors.UnexpectedSmartServerResponse(response)
3795
 
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
3796
 
 
3797
 
    def _get_parent_location(self):
3798
 
        medium = self._client._medium
3799
 
        if medium._is_remote_before((1, 13)):
3800
 
            return self._vfs_get_parent_location()
3801
 
        try:
3802
 
            response = self._call('Branch.get_parent', self._remote_path())
3803
 
        except errors.UnknownSmartMethod:
3804
 
            medium._remember_remote_is_before((1, 13))
3805
 
            return self._vfs_get_parent_location()
3806
 
        if len(response) != 1:
3807
 
            raise errors.UnexpectedSmartServerResponse(response)
3808
 
        parent_location = response[0]
3809
 
        if parent_location == '':
3810
 
            return None
3811
 
        return parent_location
3812
 
 
3813
 
    def _vfs_get_parent_location(self):
3814
 
        self._ensure_real()
3815
 
        return self._real_branch._get_parent_location()
3816
 
 
3817
 
    def _set_parent_location(self, url):
3818
 
        medium = self._client._medium
3819
 
        if medium._is_remote_before((1, 15)):
3820
 
            return self._vfs_set_parent_location(url)
3821
 
        try:
3822
 
            call_url = url or ''
3823
 
            if type(call_url) is not str:
3824
 
                raise AssertionError('url must be a str or None (%s)' % url)
3825
 
            response = self._call('Branch.set_parent_location',
3826
 
                self._remote_path(), self._lock_token, self._repo_lock_token,
3827
 
                call_url)
3828
 
        except errors.UnknownSmartMethod:
3829
 
            medium._remember_remote_is_before((1, 15))
3830
 
            return self._vfs_set_parent_location(url)
3831
 
        if response != ():
3832
 
            raise errors.UnexpectedSmartServerResponse(response)
3833
 
 
3834
 
    def _vfs_set_parent_location(self, url):
3835
 
        self._ensure_real()
3836
 
        return self._real_branch._set_parent_location(url)
 
1489
 
 
1490
    @needs_write_lock
 
1491
    def set_revision_history(self, rev_history):
 
1492
        # Send just the tip revision of the history; the server will generate
 
1493
        # the full history from that.  If the revision doesn't exist in this
 
1494
        # branch, NoSuchRevision will be raised.
 
1495
        if rev_history == []:
 
1496
            rev_id = 'null:'
 
1497
        else:
 
1498
            rev_id = rev_history[-1]
 
1499
        self._set_last_revision(rev_id)
 
1500
        self._cache_revision_history(rev_history)
 
1501
 
 
1502
    def get_parent(self):
 
1503
        self._ensure_real()
 
1504
        return self._real_branch.get_parent()
 
1505
        
 
1506
    def set_parent(self, url):
 
1507
        self._ensure_real()
 
1508
        return self._real_branch.set_parent(url)
 
1509
        
 
1510
    def sprout(self, to_bzrdir, revision_id=None):
 
1511
        # Like Branch.sprout, except that it sprouts a branch in the default
 
1512
        # format, because RemoteBranches can't be created at arbitrary URLs.
 
1513
        # XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
 
1514
        # to_bzrdir.create_branch...
 
1515
        self._ensure_real()
 
1516
        result = self._real_branch._format.initialize(to_bzrdir)
 
1517
        self.copy_content_into(result, revision_id=revision_id)
 
1518
        result.set_parent(self.bzrdir.root_transport.base)
 
1519
        return result
3837
1520
 
3838
1521
    @needs_write_lock
3839
1522
    def pull(self, source, overwrite=False, stop_revision=None,
3845
1528
            _override_hook_target=self, **kwargs)
3846
1529
 
3847
1530
    @needs_read_lock
3848
 
    def push(self, target, overwrite=False, stop_revision=None, lossy=False):
 
1531
    def push(self, target, overwrite=False, stop_revision=None):
3849
1532
        self._ensure_real()
3850
1533
        return self._real_branch.push(
3851
 
            target, overwrite=overwrite, stop_revision=stop_revision, lossy=lossy,
 
1534
            target, overwrite=overwrite, stop_revision=stop_revision,
3852
1535
            _override_hook_source_branch=self)
3853
1536
 
3854
 
    def peek_lock_mode(self):
3855
 
        return self._lock_mode
3856
 
 
3857
1537
    def is_locked(self):
3858
1538
        return self._lock_count >= 1
3859
1539
 
3860
 
    @needs_read_lock
3861
 
    def revision_id_to_dotted_revno(self, revision_id):
3862
 
        """Given a revision id, return its dotted revno.
3863
 
 
3864
 
        :return: a tuple like (1,) or (400,1,3).
3865
 
        """
3866
 
        try:
3867
 
            response = self._call('Branch.revision_id_to_revno',
3868
 
                self._remote_path(), revision_id)
3869
 
        except errors.UnknownSmartMethod:
3870
 
            self._ensure_real()
3871
 
            return self._real_branch.revision_id_to_dotted_revno(revision_id)
3872
 
        if response[0] == 'ok':
3873
 
            return tuple([int(x) for x in response[1:]])
3874
 
        else:
3875
 
            raise errors.UnexpectedSmartServerResponse(response)
3876
 
 
3877
 
    @needs_read_lock
3878
 
    def revision_id_to_revno(self, revision_id):
3879
 
        """Given a revision id on the branch mainline, return its revno.
3880
 
 
3881
 
        :return: an integer
3882
 
        """
3883
 
        try:
3884
 
            response = self._call('Branch.revision_id_to_revno',
3885
 
                self._remote_path(), revision_id)
3886
 
        except errors.UnknownSmartMethod:
3887
 
            self._ensure_real()
3888
 
            return self._real_branch.revision_id_to_revno(revision_id)
3889
 
        if response[0] == 'ok':
3890
 
            if len(response) == 2:
3891
 
                return int(response[1])
3892
 
            raise NoSuchRevision(self, revision_id)
3893
 
        else:
3894
 
            raise errors.UnexpectedSmartServerResponse(response)
3895
 
 
3896
1540
    @needs_write_lock
3897
1541
    def set_last_revision_info(self, revno, revision_id):
3898
 
        # XXX: These should be returned by the set_last_revision_info verb
3899
 
        old_revno, old_revid = self.last_revision_info()
3900
 
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
3901
 
        if not revision_id or not isinstance(revision_id, basestring):
3902
 
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
 
1542
        revision_id = ensure_null(revision_id)
 
1543
        path = self.bzrdir._path_for_remote_call(self._client)
3903
1544
        try:
3904
 
            response = self._call('Branch.set_last_revision_info',
3905
 
                self._remote_path(), self._lock_token, self._repo_lock_token,
3906
 
                str(revno), revision_id)
 
1545
            response = self._client.call('Branch.set_last_revision_info',
 
1546
                path, self._lock_token, self._repo_lock_token, str(revno), revision_id)
3907
1547
        except errors.UnknownSmartMethod:
3908
1548
            self._ensure_real()
3909
1549
            self._clear_cached_state_of_remote_branch_only()
3910
1550
            self._real_branch.set_last_revision_info(revno, revision_id)
3911
1551
            self._last_revision_info_cache = revno, revision_id
3912
1552
            return
 
1553
        except errors.ErrorFromSmartServer, err:
 
1554
            if err.error_verb == 'NoSuchRevision':
 
1555
                raise NoSuchRevision(self, err.error_args[0])
 
1556
            raise
3913
1557
        if response == ('ok',):
3914
1558
            self._clear_cached_state()
3915
1559
            self._last_revision_info_cache = revno, revision_id
3916
 
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
3917
1560
            # Update the _real_branch's cache too.
3918
1561
            if self._real_branch is not None:
3919
1562
                cache = self._last_revision_info_cache
3926
1569
                                  other_branch=None):
3927
1570
        medium = self._client._medium
3928
1571
        if not medium._is_remote_before((1, 6)):
3929
 
            # Use a smart method for 1.6 and above servers
3930
1572
            try:
3931
1573
                self._set_last_revision_descendant(revision_id, other_branch,
3932
1574
                    allow_diverged=True, allow_overwrite_descendant=True)
3934
1576
            except errors.UnknownSmartMethod:
3935
1577
                medium._remember_remote_is_before((1, 6))
3936
1578
        self._clear_cached_state_of_remote_branch_only()
3937
 
        graph = self.repository.get_graph()
3938
 
        (last_revno, last_revid) = self.last_revision_info()
3939
 
        known_revision_ids = [
3940
 
            (last_revid, last_revno),
3941
 
            (_mod_revision.NULL_REVISION, 0),
3942
 
            ]
3943
 
        if last_rev is not None:
3944
 
            if not graph.is_ancestor(last_rev, revision_id):
3945
 
                # our previous tip is not merged into stop_revision
3946
 
                raise errors.DivergedBranches(self, other_branch)
3947
 
        revno = graph.find_distance_to_null(revision_id, known_revision_ids)
3948
 
        self.set_last_revision_info(revno, revision_id)
 
1579
        self._ensure_real()
 
1580
        self._real_branch.generate_revision_history(
 
1581
            revision_id, last_rev=last_rev, other_branch=other_branch)
 
1582
 
 
1583
    @property
 
1584
    def tags(self):
 
1585
        self._ensure_real()
 
1586
        return self._real_branch.tags
3949
1587
 
3950
1588
    def set_push_location(self, location):
3951
 
        self._set_config_location('push_location', location)
3952
 
 
3953
 
    def heads_to_fetch(self):
3954
 
        if self._format._use_default_local_heads_to_fetch():
3955
 
            # We recognise this format, and its heads-to-fetch implementation
3956
 
            # is the default one (tip + tags).  In this case it's cheaper to
3957
 
            # just use the default implementation rather than a special RPC as
3958
 
            # the tip and tags data is cached.
3959
 
            return branch.Branch.heads_to_fetch(self)
3960
 
        medium = self._client._medium
3961
 
        if medium._is_remote_before((2, 4)):
3962
 
            return self._vfs_heads_to_fetch()
3963
 
        try:
3964
 
            return self._rpc_heads_to_fetch()
3965
 
        except errors.UnknownSmartMethod:
3966
 
            medium._remember_remote_is_before((2, 4))
3967
 
            return self._vfs_heads_to_fetch()
3968
 
 
3969
 
    def _rpc_heads_to_fetch(self):
3970
 
        response = self._call('Branch.heads_to_fetch', self._remote_path())
3971
 
        if len(response) != 2:
3972
 
            raise errors.UnexpectedSmartServerResponse(response)
3973
 
        must_fetch, if_present_fetch = response
3974
 
        return set(must_fetch), set(if_present_fetch)
3975
 
 
3976
 
    def _vfs_heads_to_fetch(self):
3977
1589
        self._ensure_real()
3978
 
        return self._real_branch.heads_to_fetch()
3979
 
 
3980
 
 
3981
 
class RemoteConfig(object):
3982
 
    """A Config that reads and writes from smart verbs.
3983
 
 
3984
 
    It is a low-level object that considers config data to be name/value pairs
3985
 
    that may be associated with a section. Assigning meaning to the these
3986
 
    values is done at higher levels like bzrlib.config.TreeConfig.
3987
 
    """
3988
 
 
3989
 
    def get_option(self, name, section=None, default=None):
3990
 
        """Return the value associated with a named option.
3991
 
 
3992
 
        :param name: The name of the value
3993
 
        :param section: The section the option is in (if any)
3994
 
        :param default: The value to return if the value is not set
3995
 
        :return: The value or default value
3996
 
        """
3997
 
        try:
3998
 
            configobj = self._get_configobj()
3999
 
            section_obj = None
4000
 
            if section is None:
4001
 
                section_obj = configobj
4002
 
            else:
4003
 
                try:
4004
 
                    section_obj = configobj[section]
4005
 
                except KeyError:
4006
 
                    pass
4007
 
            if section_obj is None:
4008
 
                value = default
4009
 
            else:
4010
 
                value = section_obj.get(name, default)
4011
 
        except errors.UnknownSmartMethod:
4012
 
            value = self._vfs_get_option(name, section, default)
4013
 
        for hook in _mod_config.OldConfigHooks['get']:
4014
 
            hook(self, name, value)
4015
 
        return value
4016
 
 
4017
 
    def _response_to_configobj(self, response):
4018
 
        if len(response[0]) and response[0][0] != 'ok':
4019
 
            raise errors.UnexpectedSmartServerResponse(response)
4020
 
        lines = response[1].read_body_bytes().splitlines()
4021
 
        conf = _mod_config.ConfigObj(lines, encoding='utf-8')
4022
 
        for hook in _mod_config.OldConfigHooks['load']:
4023
 
            hook(self)
4024
 
        return conf
4025
 
 
4026
 
 
4027
 
class RemoteBranchConfig(RemoteConfig):
4028
 
    """A RemoteConfig for Branches."""
4029
 
 
4030
 
    def __init__(self, branch):
4031
 
        self._branch = branch
4032
 
 
4033
 
    def _get_configobj(self):
4034
 
        path = self._branch._remote_path()
4035
 
        response = self._branch._client.call_expecting_body(
4036
 
            'Branch.get_config_file', path)
4037
 
        return self._response_to_configobj(response)
4038
 
 
4039
 
    def set_option(self, value, name, section=None):
4040
 
        """Set the value associated with a named option.
4041
 
 
4042
 
        :param value: The value to set
4043
 
        :param name: The name of the value to set
4044
 
        :param section: The section the option is in (if any)
4045
 
        """
4046
 
        medium = self._branch._client._medium
4047
 
        if medium._is_remote_before((1, 14)):
4048
 
            return self._vfs_set_option(value, name, section)
4049
 
        if isinstance(value, dict):
4050
 
            if medium._is_remote_before((2, 2)):
4051
 
                return self._vfs_set_option(value, name, section)
4052
 
            return self._set_config_option_dict(value, name, section)
4053
 
        else:
4054
 
            return self._set_config_option(value, name, section)
4055
 
 
4056
 
    def _set_config_option(self, value, name, section):
4057
 
        try:
4058
 
            path = self._branch._remote_path()
4059
 
            response = self._branch._client.call('Branch.set_config_option',
4060
 
                path, self._branch._lock_token, self._branch._repo_lock_token,
4061
 
                value.encode('utf8'), name, section or '')
4062
 
        except errors.UnknownSmartMethod:
4063
 
            medium = self._branch._client._medium
4064
 
            medium._remember_remote_is_before((1, 14))
4065
 
            return self._vfs_set_option(value, name, section)
4066
 
        if response != ():
4067
 
            raise errors.UnexpectedSmartServerResponse(response)
4068
 
 
4069
 
    def _serialize_option_dict(self, option_dict):
4070
 
        utf8_dict = {}
4071
 
        for key, value in option_dict.items():
4072
 
            if isinstance(key, unicode):
4073
 
                key = key.encode('utf8')
4074
 
            if isinstance(value, unicode):
4075
 
                value = value.encode('utf8')
4076
 
            utf8_dict[key] = value
4077
 
        return bencode.bencode(utf8_dict)
4078
 
 
4079
 
    def _set_config_option_dict(self, value, name, section):
4080
 
        try:
4081
 
            path = self._branch._remote_path()
4082
 
            serialised_dict = self._serialize_option_dict(value)
4083
 
            response = self._branch._client.call(
4084
 
                'Branch.set_config_option_dict',
4085
 
                path, self._branch._lock_token, self._branch._repo_lock_token,
4086
 
                serialised_dict, name, section or '')
4087
 
        except errors.UnknownSmartMethod:
4088
 
            medium = self._branch._client._medium
4089
 
            medium._remember_remote_is_before((2, 2))
4090
 
            return self._vfs_set_option(value, name, section)
4091
 
        if response != ():
4092
 
            raise errors.UnexpectedSmartServerResponse(response)
4093
 
 
4094
 
    def _real_object(self):
4095
 
        self._branch._ensure_real()
4096
 
        return self._branch._real_branch
4097
 
 
4098
 
    def _vfs_set_option(self, value, name, section=None):
4099
 
        return self._real_object()._get_config().set_option(
4100
 
            value, name, section)
4101
 
 
4102
 
 
4103
 
class RemoteBzrDirConfig(RemoteConfig):
4104
 
    """A RemoteConfig for BzrDirs."""
4105
 
 
4106
 
    def __init__(self, bzrdir):
4107
 
        self._bzrdir = bzrdir
4108
 
 
4109
 
    def _get_configobj(self):
4110
 
        medium = self._bzrdir._client._medium
4111
 
        verb = 'BzrDir.get_config_file'
4112
 
        if medium._is_remote_before((1, 15)):
4113
 
            raise errors.UnknownSmartMethod(verb)
4114
 
        path = self._bzrdir._path_for_remote_call(self._bzrdir._client)
4115
 
        response = self._bzrdir._call_expecting_body(
4116
 
            verb, path)
4117
 
        return self._response_to_configobj(response)
4118
 
 
4119
 
    def _vfs_get_option(self, name, section, default):
4120
 
        return self._real_object()._get_config().get_option(
4121
 
            name, section, default)
4122
 
 
4123
 
    def set_option(self, value, name, section=None):
4124
 
        """Set the value associated with a named option.
4125
 
 
4126
 
        :param value: The value to set
4127
 
        :param name: The name of the value to set
4128
 
        :param section: The section the option is in (if any)
4129
 
        """
4130
 
        return self._real_object()._get_config().set_option(
4131
 
            value, name, section)
4132
 
 
4133
 
    def _real_object(self):
4134
 
        self._bzrdir._ensure_real()
4135
 
        return self._bzrdir._real_bzrdir
 
1590
        return self._real_branch.set_push_location(location)
 
1591
 
 
1592
    @needs_write_lock
 
1593
    def update_revisions(self, other, stop_revision=None, overwrite=False,
 
1594
                         graph=None):
 
1595
        """See Branch.update_revisions."""
 
1596
        other.lock_read()
 
1597
        try:
 
1598
            if stop_revision is None:
 
1599
                stop_revision = other.last_revision()
 
1600
                if revision.is_null(stop_revision):
 
1601
                    # if there are no commits, we're done.
 
1602
                    return
 
1603
            self.fetch(other, stop_revision)
 
1604
 
 
1605
            if overwrite:
 
1606
                # Just unconditionally set the new revision.  We don't care if
 
1607
                # the branches have diverged.
 
1608
                self._set_last_revision(stop_revision)
 
1609
            else:
 
1610
                medium = self._client._medium
 
1611
                if not medium._is_remote_before((1, 6)):
 
1612
                    try:
 
1613
                        self._set_last_revision_descendant(stop_revision, other)
 
1614
                        return
 
1615
                    except errors.UnknownSmartMethod:
 
1616
                        medium._remember_remote_is_before((1, 6))
 
1617
                # Fallback for pre-1.6 servers: check for divergence
 
1618
                # client-side, then do _set_last_revision.
 
1619
                last_rev = revision.ensure_null(self.last_revision())
 
1620
                if graph is None:
 
1621
                    graph = self.repository.get_graph()
 
1622
                if self._check_if_descendant_or_diverged(
 
1623
                        stop_revision, last_rev, graph, other):
 
1624
                    # stop_revision is a descendant of last_rev, but we aren't
 
1625
                    # overwriting, so we're done.
 
1626
                    return
 
1627
                self._set_last_revision(stop_revision)
 
1628
        finally:
 
1629
            other.unlock()
4136
1630
 
4137
1631
 
4138
1632
def _extract_tar(tar, to_dir):
4142
1636
    """
4143
1637
    for tarinfo in tar:
4144
1638
        tar.extract(tarinfo, to_dir)
4145
 
 
4146
 
 
4147
 
error_translators = registry.Registry()
4148
 
no_context_error_translators = registry.Registry()
4149
 
 
4150
 
 
4151
 
def _translate_error(err, **context):
4152
 
    """Translate an ErrorFromSmartServer into a more useful error.
4153
 
 
4154
 
    Possible context keys:
4155
 
      - branch
4156
 
      - repository
4157
 
      - bzrdir
4158
 
      - token
4159
 
      - other_branch
4160
 
      - path
4161
 
 
4162
 
    If the error from the server doesn't match a known pattern, then
4163
 
    UnknownErrorFromSmartServer is raised.
4164
 
    """
4165
 
    def find(name):
4166
 
        try:
4167
 
            return context[name]
4168
 
        except KeyError, key_err:
4169
 
            mutter('Missing key %r in context %r', key_err.args[0], context)
4170
 
            raise err
4171
 
    def get_path():
4172
 
        """Get the path from the context if present, otherwise use first error
4173
 
        arg.
4174
 
        """
4175
 
        try:
4176
 
            return context['path']
4177
 
        except KeyError, key_err:
4178
 
            try:
4179
 
                return err.error_args[0]
4180
 
            except IndexError, idx_err:
4181
 
                mutter(
4182
 
                    'Missing key %r in context %r', key_err.args[0], context)
4183
 
                raise err
4184
 
 
4185
 
    try:
4186
 
        translator = error_translators.get(err.error_verb)
4187
 
    except KeyError:
4188
 
        pass
4189
 
    else:
4190
 
        raise translator(err, find, get_path)
4191
 
    try:
4192
 
        translator = no_context_error_translators.get(err.error_verb)
4193
 
    except KeyError:
4194
 
        raise errors.UnknownErrorFromSmartServer(err)
4195
 
    else:
4196
 
        raise translator(err)
4197
 
 
4198
 
 
4199
 
error_translators.register('NoSuchRevision',
4200
 
    lambda err, find, get_path: NoSuchRevision(
4201
 
        find('branch'), err.error_args[0]))
4202
 
error_translators.register('nosuchrevision',
4203
 
    lambda err, find, get_path: NoSuchRevision(
4204
 
        find('repository'), err.error_args[0]))
4205
 
 
4206
 
def _translate_nobranch_error(err, find, get_path):
4207
 
    if len(err.error_args) >= 1:
4208
 
        extra = err.error_args[0]
4209
 
    else:
4210
 
        extra = None
4211
 
    return errors.NotBranchError(path=find('bzrdir').root_transport.base,
4212
 
        detail=extra)
4213
 
 
4214
 
error_translators.register('nobranch', _translate_nobranch_error)
4215
 
error_translators.register('norepository',
4216
 
    lambda err, find, get_path: errors.NoRepositoryPresent(
4217
 
        find('bzrdir')))
4218
 
error_translators.register('UnlockableTransport',
4219
 
    lambda err, find, get_path: errors.UnlockableTransport(
4220
 
        find('bzrdir').root_transport))
4221
 
error_translators.register('TokenMismatch',
4222
 
    lambda err, find, get_path: errors.TokenMismatch(
4223
 
        find('token'), '(remote token)'))
4224
 
error_translators.register('Diverged',
4225
 
    lambda err, find, get_path: errors.DivergedBranches(
4226
 
        find('branch'), find('other_branch')))
4227
 
error_translators.register('NotStacked',
4228
 
    lambda err, find, get_path: errors.NotStacked(branch=find('branch')))
4229
 
 
4230
 
def _translate_PermissionDenied(err, find, get_path):
4231
 
    path = get_path()
4232
 
    if len(err.error_args) >= 2:
4233
 
        extra = err.error_args[1]
4234
 
    else:
4235
 
        extra = None
4236
 
    return errors.PermissionDenied(path, extra=extra)
4237
 
 
4238
 
error_translators.register('PermissionDenied', _translate_PermissionDenied)
4239
 
error_translators.register('ReadError',
4240
 
    lambda err, find, get_path: errors.ReadError(get_path()))
4241
 
error_translators.register('NoSuchFile',
4242
 
    lambda err, find, get_path: errors.NoSuchFile(get_path()))
4243
 
error_translators.register('TokenLockingNotSupported',
4244
 
    lambda err, find, get_path: errors.TokenLockingNotSupported(
4245
 
        find('repository')))
4246
 
error_translators.register('UnsuspendableWriteGroup',
4247
 
    lambda err, find, get_path: errors.UnsuspendableWriteGroup(
4248
 
        repository=find('repository')))
4249
 
error_translators.register('UnresumableWriteGroup',
4250
 
    lambda err, find, get_path: errors.UnresumableWriteGroup(
4251
 
        repository=find('repository'), write_groups=err.error_args[0],
4252
 
        reason=err.error_args[1]))
4253
 
no_context_error_translators.register('IncompatibleRepositories',
4254
 
    lambda err: errors.IncompatibleRepositories(
4255
 
        err.error_args[0], err.error_args[1], err.error_args[2]))
4256
 
no_context_error_translators.register('LockContention',
4257
 
    lambda err: errors.LockContention('(remote lock)'))
4258
 
no_context_error_translators.register('LockFailed',
4259
 
    lambda err: errors.LockFailed(err.error_args[0], err.error_args[1]))
4260
 
no_context_error_translators.register('TipChangeRejected',
4261
 
    lambda err: errors.TipChangeRejected(err.error_args[0].decode('utf8')))
4262
 
no_context_error_translators.register('UnstackableBranchFormat',
4263
 
    lambda err: errors.UnstackableBranchFormat(*err.error_args))
4264
 
no_context_error_translators.register('UnstackableRepositoryFormat',
4265
 
    lambda err: errors.UnstackableRepositoryFormat(*err.error_args))
4266
 
no_context_error_translators.register('FileExists',
4267
 
    lambda err: errors.FileExists(err.error_args[0]))
4268
 
no_context_error_translators.register('DirectoryNotEmpty',
4269
 
    lambda err: errors.DirectoryNotEmpty(err.error_args[0]))
4270
 
 
4271
 
def _translate_short_readv_error(err):
4272
 
    args = err.error_args
4273
 
    return errors.ShortReadvError(args[0], int(args[1]), int(args[2]),
4274
 
        int(args[3]))
4275
 
 
4276
 
no_context_error_translators.register('ShortReadvError',
4277
 
    _translate_short_readv_error)
4278
 
 
4279
 
def _translate_unicode_error(err):
4280
 
        encoding = str(err.error_args[0]) # encoding must always be a string
4281
 
        val = err.error_args[1]
4282
 
        start = int(err.error_args[2])
4283
 
        end = int(err.error_args[3])
4284
 
        reason = str(err.error_args[4]) # reason must always be a string
4285
 
        if val.startswith('u:'):
4286
 
            val = val[2:].decode('utf-8')
4287
 
        elif val.startswith('s:'):
4288
 
            val = val[2:].decode('base64')
4289
 
        if err.error_verb == 'UnicodeDecodeError':
4290
 
            raise UnicodeDecodeError(encoding, val, start, end, reason)
4291
 
        elif err.error_verb == 'UnicodeEncodeError':
4292
 
            raise UnicodeEncodeError(encoding, val, start, end, reason)
4293
 
 
4294
 
no_context_error_translators.register('UnicodeEncodeError',
4295
 
    _translate_unicode_error)
4296
 
no_context_error_translators.register('UnicodeDecodeError',
4297
 
    _translate_unicode_error)
4298
 
no_context_error_translators.register('ReadOnlyError',
4299
 
    lambda err: errors.TransportNotPossible('readonly transport'))
4300
 
no_context_error_translators.register('MemoryError',
4301
 
    lambda err: errors.BzrError("remote server out of memory\n"
4302
 
        "Retry non-remotely, or contact the server admin for details."))
4303
 
no_context_error_translators.register('RevisionNotPresent',
4304
 
    lambda err: errors.RevisionNotPresent(err.error_args[0], err.error_args[1]))
4305
 
 
4306
 
no_context_error_translators.register('BzrCheckError',
4307
 
    lambda err: errors.BzrCheckError(msg=err.error_args[0]))
4308