~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

  • Committer: Vincent Ladeuil
  • Date: 2012-03-13 16:42:20 UTC
  • mto: This revision was merged to the branch mainline in revision 6512.
  • Revision ID: v.ladeuil+lp@free.fr-20120313164220-atkou2zprhlspmwg
Mention that a given config option cannot be safely handled via both APIs at the same time.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006, 2007, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2006-2012 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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
from __future__ import absolute_import
 
18
 
17
19
import bz2
 
20
import zlib
18
21
 
19
22
from bzrlib import (
20
23
    bencode,
21
24
    branch,
22
 
    bzrdir,
23
 
    config,
 
25
    bzrdir as _mod_bzrdir,
 
26
    config as _mod_config,
 
27
    controldir,
24
28
    debug,
25
29
    errors,
 
30
    gpg,
26
31
    graph,
 
32
    inventory_delta,
27
33
    lock,
28
34
    lockdir,
29
 
    repository,
30
 
    revision,
 
35
    osutils,
 
36
    registry,
 
37
    repository as _mod_repository,
31
38
    revision as _mod_revision,
 
39
    static_tuple,
32
40
    symbol_versioning,
33
 
)
34
 
from bzrlib.branch import BranchReferenceFormat
35
 
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
 
41
    testament as _mod_testament,
 
42
    urlutils,
 
43
    vf_repository,
 
44
    vf_search,
 
45
    )
 
46
from bzrlib.branch import BranchReferenceFormat, BranchWriteLockResult
36
47
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
37
48
from bzrlib.errors import (
38
49
    NoSuchRevision,
39
50
    SmartProtocolError,
40
51
    )
 
52
from bzrlib.i18n import gettext
 
53
from bzrlib.inventory import Inventory
41
54
from bzrlib.lockable_files import LockableFiles
42
55
from bzrlib.smart import client, vfs, repository as smart_repo
43
 
from bzrlib.revision import ensure_null, NULL_REVISION
44
 
from bzrlib.trace import mutter, note, warning
 
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
45
66
 
46
67
 
47
68
class _RpcHelper(object):
84
105
    return format
85
106
 
86
107
 
87
 
# Note: RemoteBzrDirFormat is in bzrdir.py
88
 
 
89
 
class RemoteBzrDir(BzrDir, _RpcHelper):
 
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 self.bzrdir.user_url
 
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):
90
411
    """Control directory on a remote server, accessed via bzr:// or similar."""
91
412
 
92
413
    def __init__(self, transport, format, _client=None, _force_probe=False):
95
416
        :param _client: Private parameter for testing. Disables probing and the
96
417
            use of a real bzrdir.
97
418
        """
98
 
        BzrDir.__init__(self, transport, format)
 
419
        _mod_bzrdir.BzrDir.__init__(self, transport, format)
99
420
        # this object holds a delegated bzrdir that uses file-level operations
100
421
        # to talk to the other side
101
422
        self._real_bzrdir = None
114
435
 
115
436
        self._probe_bzrdir()
116
437
 
 
438
    def __repr__(self):
 
439
        return '%s(%r)' % (self.__class__.__name__, self._client)
 
440
 
117
441
    def _probe_bzrdir(self):
118
442
        medium = self._client._medium
119
443
        path = self._path_for_remote_call(self._client)
158
482
                import traceback
159
483
                warning('VFS BzrDir access triggered\n%s',
160
484
                    ''.join(traceback.format_stack()))
161
 
            self._real_bzrdir = BzrDir.open_from_transport(
162
 
                self.root_transport, _server_formats=False)
 
485
            self._real_bzrdir = _mod_bzrdir.BzrDir.open_from_transport(
 
486
                self.root_transport, probers=[_mod_bzrdir.BzrProber])
163
487
            self._format._network_name = \
164
488
                self._real_bzrdir._format.network_name()
165
489
 
170
494
        # Prevent aliasing problems in the next_open_branch_result cache.
171
495
        # See create_branch for rationale.
172
496
        self._next_open_branch_result = None
173
 
        return BzrDir.break_lock(self)
 
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
174
540
 
175
541
    def _vfs_cloning_metadir(self, require_stacking=False):
176
542
        self._ensure_real()
207
573
        if len(branch_info) != 2:
208
574
            raise errors.UnexpectedSmartServerResponse(response)
209
575
        branch_ref, branch_name = branch_info
210
 
        format = bzrdir.network_format_registry.get(control_name)
 
576
        try:
 
577
            format = controldir.network_format_registry.get(control_name)
 
578
        except KeyError:
 
579
            raise errors.UnknownFormatError(kind='control', format=control_name)
 
580
 
211
581
        if repo_name:
212
 
            format.repository_format = repository.network_format_registry.get(
213
 
                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)
214
588
        if branch_ref == 'ref':
215
589
            # XXX: we need possible_transports here to avoid reopening the
216
590
            # connection to the referenced location
217
 
            ref_bzrdir = BzrDir.open(branch_name)
 
591
            ref_bzrdir = _mod_bzrdir.BzrDir.open(branch_name)
218
592
            branch_format = ref_bzrdir.cloning_metadir().get_branch_format()
219
593
            format.set_branch_format(branch_format)
220
594
        elif branch_ref == 'branch':
221
595
            if branch_name:
222
 
                format.set_branch_format(
223
 
                    branch.network_format_registry.get(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)
224
603
        else:
225
604
            raise errors.UnexpectedSmartServerResponse(response)
226
605
        return format
236
615
 
237
616
    def destroy_repository(self):
238
617
        """See BzrDir.destroy_repository"""
239
 
        self._ensure_real()
240
 
        self._real_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,))
241
627
 
242
 
    def create_branch(self):
 
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)
243
634
        # as per meta1 formats - just delegate to the format object which may
244
635
        # be parameterised.
245
 
        real_branch = self._format.get_branch_format().initialize(self)
 
636
        real_branch = self._format.get_branch_format().initialize(self,
 
637
            name=name, repository=repository,
 
638
            append_revisions_only=append_revisions_only)
246
639
        if not isinstance(real_branch, RemoteBranch):
247
 
            result = RemoteBranch(self, self.find_repository(), real_branch)
 
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)
248
645
        else:
249
646
            result = real_branch
250
647
        # BzrDir.clone_on_transport() uses the result of create_branch but does
256
653
        self._next_open_branch_result = result
257
654
        return result
258
655
 
259
 
    def destroy_branch(self):
 
656
    def destroy_branch(self, name=None):
260
657
        """See BzrDir.destroy_branch"""
261
 
        self._ensure_real()
262
 
        self._real_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
263
674
        self._next_open_branch_result = None
 
675
        if response[0] != 'ok':
 
676
            raise SmartProtocolError('unexpected response code %s' % (response,))
264
677
 
265
 
    def create_workingtree(self, revision_id=None, from_branch=None):
 
678
    def create_workingtree(self, revision_id=None, from_branch=None,
 
679
        accelerator_tree=None, hardlink=False):
266
680
        raise errors.NotLocalUrl(self.transport.base)
267
681
 
268
 
    def find_branch_format(self):
 
682
    def find_branch_format(self, name=None):
269
683
        """Find the branch 'format' for this bzrdir.
270
684
 
271
685
        This might be a synthetic object for e.g. RemoteBranch and SVN.
272
686
        """
273
 
        b = self.open_branch()
 
687
        b = self.open_branch(name=name)
274
688
        return b._format
275
689
 
276
 
    def get_branch_reference(self):
 
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):
277
718
        """See BzrDir.get_branch_reference()."""
 
719
        if name is None:
 
720
            name = self._get_selected_branch()
 
721
        if name != "":
 
722
            raise errors.NoColocatedBranchSupport(self)
278
723
        response = self._get_branch_reference()
279
724
        if response[0] == 'ref':
280
725
            return response[1]
284
729
    def _get_branch_reference(self):
285
730
        path = self._path_for_remote_call(self._client)
286
731
        medium = self._client._medium
287
 
        if not medium._is_remote_before((1, 13)):
 
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
288
740
            try:
289
 
                response = self._call('BzrDir.open_branchV2', path)
290
 
                if response[0] not in ('ref', 'branch'):
291
 
                    raise errors.UnexpectedSmartServerResponse(response)
292
 
                return response
 
741
                response = self._call(verb, path)
293
742
            except errors.UnknownSmartMethod:
294
 
                medium._remember_remote_is_before((1, 13))
295
 
        response = self._call('BzrDir.open_branch', path)
296
 
        if response[0] != 'ok':
 
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'):
297
756
            raise errors.UnexpectedSmartServerResponse(response)
298
 
        if response[1] != '':
299
 
            return ('ref', response[1])
300
 
        else:
301
 
            return ('branch', '')
 
757
        return response
302
758
 
303
 
    def _get_tree_branch(self):
 
759
    def _get_tree_branch(self, name=None):
304
760
        """See BzrDir._get_tree_branch()."""
305
 
        return None, self.open_branch()
 
761
        return None, self.open_branch(name=name)
306
762
 
307
 
    def open_branch(self, _unsupported=False, ignore_fallbacks=False):
308
 
        if _unsupported:
309
 
            raise NotImplementedError('unsupported flag support not implemented yet.')
310
 
        if self._next_open_branch_result is not None:
311
 
            # See create_branch for details.
312
 
            result = self._next_open_branch_result
313
 
            self._next_open_branch_result = None
314
 
            return result
315
 
        response = self._get_branch_reference()
316
 
        if response[0] == 'ref':
 
763
    def _open_branch(self, name, kind, location_or_format,
 
764
                     ignore_fallbacks=False, possible_transports=None):
 
765
        if kind == 'ref':
317
766
            # a branch reference, use the existing BranchReference logic.
318
767
            format = BranchReferenceFormat()
319
 
            return format.open(self, _found=True, location=response[1],
320
 
                ignore_fallbacks=ignore_fallbacks)
321
 
        branch_format_name = response[1]
 
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
322
772
        if not branch_format_name:
323
773
            branch_format_name = None
324
774
        format = RemoteBranchFormat(network_name=branch_format_name)
325
775
        return RemoteBranch(self, self.find_repository(), format=format,
326
 
            setup_stacking=not ignore_fallbacks)
 
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)
327
796
 
328
797
    def _open_repo_v1(self, path):
329
798
        verb = 'BzrDir.find_repository'
392
861
 
393
862
    def has_workingtree(self):
394
863
        if self._has_working_tree is None:
395
 
            self._ensure_real()
396
 
            self._has_working_tree = self._real_bzrdir.has_workingtree()
 
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')
397
874
        return self._has_working_tree
398
875
 
399
876
    def open_workingtree(self, recommend_upgrade=True):
404
881
 
405
882
    def _path_for_remote_call(self, client):
406
883
        """Return the path to be used for this bzrdir in a remote call."""
407
 
        return client.remote_path_from_transport(self.root_transport)
 
884
        return urlutils.split_segment_parameters_raw(
 
885
            client.remote_path_from_transport(self.root_transport))[0]
408
886
 
409
 
    def get_branch_transport(self, branch_format):
 
887
    def get_branch_transport(self, branch_format, name=None):
410
888
        self._ensure_real()
411
 
        return self._real_bzrdir.get_branch_transport(branch_format)
 
889
        return self._real_bzrdir.get_branch_transport(branch_format, name=name)
412
890
 
413
891
    def get_repository_transport(self, repository_format):
414
892
        self._ensure_real()
422
900
        """Upgrading of remote bzrdirs is not supported yet."""
423
901
        return False
424
902
 
425
 
    def needs_format_conversion(self, format=None):
 
903
    def needs_format_conversion(self, format):
426
904
        """Upgrading of remote bzrdirs is not supported yet."""
427
 
        if format is None:
428
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
429
 
                % 'needs_format_conversion(format=None)')
430
905
        return False
431
906
 
432
 
    def clone(self, url, revision_id=None, force_new_repo=False,
433
 
              preserve_stacking=False):
434
 
        self._ensure_real()
435
 
        return self._real_bzrdir.clone(url, revision_id=revision_id,
436
 
            force_new_repo=force_new_repo, preserve_stacking=preserve_stacking)
437
 
 
438
907
    def _get_config(self):
439
908
        return RemoteBzrDirConfig(self)
440
909
 
441
 
 
442
 
class RemoteRepositoryFormat(repository.RepositoryFormat):
 
910
    def _get_config_store(self):
 
911
        return RemoteControlStore(self)
 
912
 
 
913
 
 
914
class RemoteRepositoryFormat(vf_repository.VersionedFileRepositoryFormat):
443
915
    """Format for repositories accessed over a _SmartClient.
444
916
 
445
917
    Instances of this repository are represented by RemoteRepository
460
932
    """
461
933
 
462
934
    _matchingbzrdir = RemoteBzrDirFormat()
 
935
    supports_full_versioned_files = True
 
936
    supports_leaving_lock = True
463
937
 
464
938
    def __init__(self):
465
 
        repository.RepositoryFormat.__init__(self)
 
939
        _mod_repository.RepositoryFormat.__init__(self)
466
940
        self._custom_format = None
467
941
        self._network_name = None
468
942
        self._creating_bzrdir = None
 
943
        self._revision_graph_can_have_wrong_parents = None
469
944
        self._supports_chks = None
470
945
        self._supports_external_lookups = None
471
946
        self._supports_tree_reference = None
 
947
        self._supports_funky_characters = None
 
948
        self._supports_nesting_repositories = None
472
949
        self._rich_root_data = None
473
950
 
474
951
    def __repr__(self):
503
980
        return self._supports_external_lookups
504
981
 
505
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
506
999
    def supports_tree_reference(self):
507
1000
        if self._supports_tree_reference is None:
508
1001
            self._ensure_real()
510
1003
                self._custom_format.supports_tree_reference
511
1004
        return self._supports_tree_reference
512
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
 
513
1014
    def _vfs_initialize(self, a_bzrdir, shared):
514
1015
        """Helper for common code in initialize."""
515
1016
        if self._custom_format:
550
1051
            network_name = self._network_name
551
1052
        else:
552
1053
            # Select the current bzrlib default and ask for that.
553
 
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
 
1054
            reference_bzrdir_format = controldir.format_registry.get('default')()
554
1055
            reference_format = reference_bzrdir_format.repository_format
555
1056
            network_name = reference_format.network_name()
556
1057
        # 2) try direct creation via RPC
582
1083
 
583
1084
    def _ensure_real(self):
584
1085
        if self._custom_format is None:
585
 
            self._custom_format = repository.network_format_registry.get(
586
 
                self._network_name)
 
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)
587
1092
 
588
1093
    @property
589
1094
    def _fetch_order(self):
624
1129
        return self._custom_format._serializer
625
1130
 
626
1131
 
627
 
class RemoteRepository(_RpcHelper, lock._RelockDebugMixin):
 
1132
class RemoteRepository(_mod_repository.Repository, _RpcHelper,
 
1133
        lock._RelockDebugMixin):
628
1134
    """Repository accessed over rpc.
629
1135
 
630
1136
    For the moment most operations are performed using local transport-backed
654
1160
        self._format = format
655
1161
        self._lock_mode = None
656
1162
        self._lock_token = None
 
1163
        self._write_group_tokens = None
657
1164
        self._lock_count = 0
658
1165
        self._leave_lock = False
659
1166
        # Cache of revision parents; misses are cached during read locks, and
673
1180
        # Additional places to query for data.
674
1181
        self._fallback_repositories = []
675
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
 
676
1194
    def __str__(self):
677
1195
        return "%s(%s)" % (self.__class__.__name__, self.base)
678
1196
 
688
1206
 
689
1207
        :param suppress_errors: see Repository.abort_write_group.
690
1208
        """
691
 
        self._ensure_real()
692
 
        return self._real_repository.abort_write_group(
693
 
            suppress_errors=suppress_errors)
 
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
694
1233
 
695
1234
    @property
696
1235
    def chk_bytes(self):
710
1249
        for older plugins that don't use e.g. the CommitBuilder
711
1250
        facility.
712
1251
        """
713
 
        self._ensure_real()
714
 
        return self._real_repository.commit_write_group()
 
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()
715
1265
 
716
1266
    def resume_write_group(self, tokens):
717
 
        self._ensure_real()
718
 
        return self._real_repository.resume_write_group(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
719
1279
 
720
1280
    def suspend_write_group(self):
721
 
        self._ensure_real()
722
 
        return self._real_repository.suspend_write_group()
 
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
723
1286
 
724
1287
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
725
1288
        self._ensure_real()
786
1349
    def find_text_key_references(self):
787
1350
        """Find the text key references within the repository.
788
1351
 
789
 
        :return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
790
 
        revision_ids. Each altered file-ids has the exact revision_ids that
791
 
        altered it listed explicitly.
792
1352
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
793
1353
            to whether they were referred to by the inventory of the
794
1354
            revision_id that they contain. The inventory texts from all present
812
1372
        """Private method for using with old (< 1.2) servers to fallback."""
813
1373
        if revision_id is None:
814
1374
            revision_id = ''
815
 
        elif revision.is_null(revision_id):
 
1375
        elif _mod_revision.is_null(revision_id):
816
1376
            return {}
817
1377
 
818
1378
        path = self.bzrdir._path_for_remote_call(self._client)
842
1402
        return RemoteStreamSource(self, to_format)
843
1403
 
844
1404
    @needs_read_lock
 
1405
    def get_file_graph(self):
 
1406
        return graph.Graph(self.texts)
 
1407
 
 
1408
    @needs_read_lock
845
1409
    def has_revision(self, revision_id):
846
1410
        """True if this repository has a copy of the revision."""
847
1411
        # Copy of bzrlib.repository.Repository.has_revision
864
1428
    def _has_same_fallbacks(self, other_repo):
865
1429
        """Returns true if the repositories have the same fallbacks."""
866
1430
        # XXX: copied from Repository; it should be unified into a base class
867
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/401622>
 
1431
        # <https://bugs.launchpad.net/bzr/+bug/401622>
868
1432
        my_fb = self._fallback_repositories
869
1433
        other_fb = other_repo._fallback_repositories
870
1434
        if len(my_fb) != len(other_fb):
886
1450
        parents_provider = self._make_parents_provider(other_repository)
887
1451
        return graph.Graph(parents_provider)
888
1452
 
 
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
 
889
1462
    def gather_stats(self, revid=None, committers=None):
890
1463
        """See Repository.gather_stats()."""
891
1464
        path = self.bzrdir._path_for_remote_call(self._client)
892
1465
        # revid can be None to indicate no revisions, not just NULL_REVISION
893
 
        if revid is None or revision.is_null(revid):
 
1466
        if revid is None or _mod_revision.is_null(revid):
894
1467
            fmt_revid = ''
895
1468
        else:
896
1469
            fmt_revid = revid
925
1498
 
926
1499
    def get_physical_lock_status(self):
927
1500
        """See Repository.get_physical_lock_status()."""
928
 
        # should be an API call to the server.
929
 
        self._ensure_real()
930
 
        return self._real_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')
931
1510
 
932
1511
    def is_in_write_group(self):
933
1512
        """Return True if there is an open write group.
934
1513
 
935
1514
        write groups are only applicable locally for the smart server..
936
1515
        """
 
1516
        if self._write_group_tokens is not None:
 
1517
            return True
937
1518
        if self._real_repository:
938
1519
            return self._real_repository.is_in_write_group()
939
1520
 
957
1538
        pass
958
1539
 
959
1540
    def lock_read(self):
 
1541
        """Lock the repository for read operations.
 
1542
 
 
1543
        :return: A bzrlib.lock.LogicalLockResult.
 
1544
        """
960
1545
        # wrong eventually - want a local lock cache context
961
1546
        if not self._lock_mode:
962
1547
            self._note_lock('r')
969
1554
                repo.lock_read()
970
1555
        else:
971
1556
            self._lock_count += 1
 
1557
        return lock.LogicalLockResult(self.unlock)
972
1558
 
973
1559
    def _remote_lock_write(self, token):
974
1560
        path = self.bzrdir._path_for_remote_call(self._client)
1014
1600
            raise errors.ReadOnlyError(self)
1015
1601
        else:
1016
1602
            self._lock_count += 1
1017
 
        return self._lock_token or None
 
1603
        return RepositoryWriteLockResult(self.unlock, self._lock_token or None)
1018
1604
 
1019
1605
    def leave_lock_in_place(self):
1020
1606
        if not self._lock_token:
1069
1655
            self._real_repository.lock_write(self._lock_token)
1070
1656
        elif self._lock_mode == 'r':
1071
1657
            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
1072
1662
 
1073
1663
    def start_write_group(self):
1074
1664
        """Start a write group on the decorated repository.
1078
1668
        for older plugins that don't use e.g. the CommitBuilder
1079
1669
        facility.
1080
1670
        """
1081
 
        self._ensure_real()
1082
 
        return self._real_repository.start_write_group()
 
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]
1083
1688
 
1084
1689
    def _unlock(self, token):
1085
1690
        path = self.bzrdir._path_for_remote_call(self._client)
1112
1717
            # This is just to let the _real_repository stay up to date.
1113
1718
            if self._real_repository is not None:
1114
1719
                self._real_repository.unlock()
 
1720
            elif self._write_group_tokens is not None:
 
1721
                self.abort_write_group()
1115
1722
        finally:
1116
1723
            # The rpc-level lock should be released even if there was a
1117
1724
            # problem releasing the vfs-based lock.
1129
1736
 
1130
1737
    def break_lock(self):
1131
1738
        # should hand off to the network
1132
 
        self._ensure_real()
1133
 
        return self._real_repository.break_lock()
 
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)
1134
1747
 
1135
1748
    def _get_tarball(self, compression):
1136
1749
        """Return a TemporaryFile containing a repository tarball.
1154
1767
            return t
1155
1768
        raise errors.UnexpectedSmartServerResponse(response)
1156
1769
 
 
1770
    @needs_read_lock
1157
1771
    def sprout(self, to_bzrdir, revision_id=None):
1158
 
        # TODO: Option to control what format is created?
1159
 
        self._ensure_real()
1160
 
        dest_repo = self._real_repository._format.initialize(to_bzrdir,
1161
 
                                                             shared=False)
 
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)
1162
1777
        dest_repo.fetch(self, revision_id=revision_id)
1163
1778
        return dest_repo
1164
1779
 
 
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
 
1165
1793
    ### These methods are just thin shims to the VFS object for now.
1166
1794
 
 
1795
    @needs_read_lock
1167
1796
    def revision_tree(self, revision_id):
1168
 
        self._ensure_real()
1169
 
        return self._real_repository.revision_tree(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]
1170
1803
 
1171
1804
    def get_serializer_format(self):
1172
 
        self._ensure_real()
1173
 
        return self._real_repository.get_serializer_format()
 
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]
1174
1815
 
1175
1816
    def get_commit_builder(self, branch, parents, config, timestamp=None,
1176
1817
                           timezone=None, committer=None, revprops=None,
1177
 
                           revision_id=None):
1178
 
        # FIXME: It ought to be possible to call this without immediately
1179
 
        # triggering _ensure_real.  For now it's the easiest thing to do.
1180
 
        self._ensure_real()
1181
 
        real_repo = self._real_repository
1182
 
        builder = real_repo.get_commit_builder(branch, parents,
1183
 
                config, timestamp=timestamp, timezone=timezone,
1184
 
                committer=committer, revprops=revprops, revision_id=revision_id)
1185
 
        return builder
 
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
1186
1845
 
1187
1846
    def add_fallback_repository(self, repository):
1188
1847
        """Add a repository to use for looking up data not held locally.
1195
1854
        # We need to accumulate additional repositories here, to pass them in
1196
1855
        # on various RPC's.
1197
1856
        #
 
1857
        # Make the check before we lock: this raises an exception.
 
1858
        self._check_fallback_repository(repository)
1198
1859
        if self.is_locked():
1199
1860
            # We will call fallback.unlock() when we transition to the unlocked
1200
1861
            # state, so always add a lock here. If a caller passes us a locked
1205
1866
        # _real_branch had its get_stacked_on_url method called), then the
1206
1867
        # repository to be added may already be in the _real_repositories list.
1207
1868
        if self._real_repository is not None:
1208
 
            fallback_locations = [repo.bzrdir.root_transport.base for repo in
 
1869
            fallback_locations = [repo.user_url for repo in
1209
1870
                self._real_repository._fallback_repositories]
1210
 
            if repository.bzrdir.root_transport.base not in fallback_locations:
 
1871
            if repository.user_url not in fallback_locations:
1211
1872
                self._real_repository.add_fallback_repository(repository)
1212
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)
 
1883
 
1213
1884
    def add_inventory(self, revid, inv, parents):
1214
1885
        self._ensure_real()
1215
1886
        return self._real_repository.add_inventory(revid, inv, parents)
1216
1887
 
1217
1888
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1218
 
                               parents):
 
1889
            parents, basis_inv=None, propagate_caches=False):
1219
1890
        self._ensure_real()
1220
1891
        return self._real_repository.add_inventory_by_delta(basis_revision_id,
1221
 
            delta, new_revision_id, parents)
1222
 
 
1223
 
    def add_revision(self, rev_id, rev, inv=None, config=None):
1224
 
        self._ensure_real()
1225
 
        return self._real_repository.add_revision(
1226
 
            rev_id, rev, inv=inv, config=config)
 
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)
1227
1920
 
1228
1921
    @needs_read_lock
1229
1922
    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):
1230
1966
        self._ensure_real()
1231
 
        return self._real_repository.get_inventory(revision_id)
 
1967
        return self._real_repository._iter_inventories(revision_ids, ordering)
1232
1968
 
1233
1969
    def iter_inventories(self, revision_ids, ordering=None):
1234
 
        self._ensure_real()
1235
 
        return self._real_repository.iter_inventories(revision_ids, ordering)
 
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()
1236
2044
 
1237
2045
    @needs_read_lock
1238
2046
    def get_revision(self, revision_id):
1239
 
        self._ensure_real()
1240
 
        return self._real_repository.get_revision(revision_id)
 
2047
        return self.get_revisions([revision_id])[0]
1241
2048
 
1242
2049
    def get_transaction(self):
1243
2050
        self._ensure_real()
1245
2052
 
1246
2053
    @needs_read_lock
1247
2054
    def clone(self, a_bzrdir, revision_id=None):
1248
 
        self._ensure_real()
1249
 
        return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
 
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
1250
2059
 
1251
2060
    def make_working_trees(self):
1252
2061
        """See Repository.make_working_trees"""
1253
 
        self._ensure_real()
1254
 
        return self._real_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'
1255
2071
 
1256
2072
    def refresh_data(self):
1257
 
        """Re-read any data needed to to synchronise with disk.
 
2073
        """Re-read any data needed to synchronise with disk.
1258
2074
 
1259
2075
        This method is intended to be called after another repository instance
1260
2076
        (such as one used by a smart server) has inserted data into the
1261
 
        repository. It may not be called during a write group, but may be
1262
 
        called at any other time.
 
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.
1263
2082
        """
1264
 
        if self.is_in_write_group():
1265
 
            raise errors.InternalBzrError(
1266
 
                "May not refresh_data while in a write group.")
1267
2083
        if self._real_repository is not None:
1268
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()
1269
2088
 
1270
2089
    def revision_ids_to_search_result(self, result_set):
1271
2090
        """Convert a set of revision ids to a graph SearchResult."""
1276
2095
        included_keys = result_set.intersection(result_parents)
1277
2096
        start_keys = result_set.difference(included_keys)
1278
2097
        exclude_keys = result_parents.difference(result_set)
1279
 
        result = graph.SearchResult(start_keys, exclude_keys,
 
2098
        result = vf_search.SearchResult(start_keys, exclude_keys,
1280
2099
            len(result_set), result_set)
1281
2100
        return result
1282
2101
 
1283
2102
    @needs_read_lock
1284
 
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
 
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):
1285
2107
        """Return the revision ids that other has that this does not.
1286
2108
 
1287
2109
        These are returned in topological order.
1288
2110
 
1289
2111
        revision_id: only return revision ids included by revision_id.
1290
2112
        """
1291
 
        return repository.InterRepository.get(
1292
 
            other, self).search_missing_revision_ids(revision_id, find_ghosts)
 
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)
1293
2127
 
1294
 
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
 
2128
    def fetch(self, source, revision_id=None, find_ghosts=False,
1295
2129
            fetch_spec=None):
1296
2130
        # No base implementation to use as RemoteRepository is not a subclass
1297
2131
        # of Repository; so this is a copy of Repository.fetch().
1308
2142
            # check that last_revision is in 'from' and then return a
1309
2143
            # no-operation.
1310
2144
            if (revision_id is not None and
1311
 
                not revision.is_null(revision_id)):
 
2145
                not _mod_revision.is_null(revision_id)):
1312
2146
                self.get_revision(revision_id)
1313
2147
            return 0, []
1314
2148
        # if there is no specific appropriate InterRepository, this will get
1315
2149
        # the InterRepository base class, which raises an
1316
2150
        # IncompatibleRepositories when asked to fetch.
1317
 
        inter = repository.InterRepository.get(source, self)
1318
 
        return inter.fetch(revision_id=revision_id, pb=pb,
 
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,
1319
2157
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
1320
2158
 
1321
2159
    def create_bundle(self, target, base, fileobj, format=None):
1323
2161
        self._real_repository.create_bundle(target, base, fileobj, format)
1324
2162
 
1325
2163
    @needs_read_lock
 
2164
    @symbol_versioning.deprecated_method(
 
2165
        symbol_versioning.deprecated_in((2, 4, 0)))
1326
2166
    def get_ancestry(self, revision_id, topo_sorted=True):
1327
2167
        self._ensure_real()
1328
2168
        return self._real_repository.get_ancestry(revision_id, topo_sorted)
1336
2176
        return self._real_repository._get_versioned_file_checker(
1337
2177
            revisions, revision_versions_cache)
1338
2178
 
 
2179
    def _iter_files_bytes_rpc(self, desired_files, absent):
 
2180
        path = self.bzrdir._path_for_remote_call(self._client)
 
2181
        lines = []
 
2182
        identifiers = []
 
2183
        for (file_id, revid, identifier) in desired_files:
 
2184
            lines.append("%s\0%s" % (
 
2185
                osutils.safe_file_id(file_id),
 
2186
                osutils.safe_revision_id(revid)))
 
2187
            identifiers.append(identifier)
 
2188
        (response_tuple, response_handler) = (
 
2189
            self._call_with_body_bytes_expecting_body(
 
2190
            "Repository.iter_files_bytes", (path, ), "\n".join(lines)))
 
2191
        if response_tuple != ('ok', ):
 
2192
            response_handler.cancel_read_body()
 
2193
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
2194
        byte_stream = response_handler.read_streamed_body()
 
2195
        def decompress_stream(start, byte_stream, unused):
 
2196
            decompressor = zlib.decompressobj()
 
2197
            yield decompressor.decompress(start)
 
2198
            while decompressor.unused_data == "":
 
2199
                try:
 
2200
                    data = byte_stream.next()
 
2201
                except StopIteration:
 
2202
                    break
 
2203
                yield decompressor.decompress(data)
 
2204
            yield decompressor.flush()
 
2205
            unused.append(decompressor.unused_data)
 
2206
        unused = ""
 
2207
        while True:
 
2208
            while not "\n" in unused:
 
2209
                unused += byte_stream.next()
 
2210
            header, rest = unused.split("\n", 1)
 
2211
            args = header.split("\0")
 
2212
            if args[0] == "absent":
 
2213
                absent[identifiers[int(args[3])]] = (args[1], args[2])
 
2214
                unused = rest
 
2215
                continue
 
2216
            elif args[0] == "ok":
 
2217
                idx = int(args[1])
 
2218
            else:
 
2219
                raise errors.UnexpectedSmartServerResponse(args)
 
2220
            unused_chunks = []
 
2221
            yield (identifiers[idx],
 
2222
                decompress_stream(rest, byte_stream, unused_chunks))
 
2223
            unused = "".join(unused_chunks)
 
2224
 
1339
2225
    def iter_files_bytes(self, desired_files):
1340
2226
        """See Repository.iter_file_bytes.
1341
2227
        """
1342
 
        self._ensure_real()
1343
 
        return self._real_repository.iter_files_bytes(desired_files)
 
2228
        try:
 
2229
            absent = {}
 
2230
            for (identifier, bytes_iterator) in self._iter_files_bytes_rpc(
 
2231
                    desired_files, absent):
 
2232
                yield identifier, bytes_iterator
 
2233
            for fallback in self._fallback_repositories:
 
2234
                if not absent:
 
2235
                    break
 
2236
                desired_files = [(key[0], key[1], identifier) for
 
2237
                    (identifier, key) in absent.iteritems()]
 
2238
                for (identifier, bytes_iterator) in fallback.iter_files_bytes(desired_files):
 
2239
                    del absent[identifier]
 
2240
                    yield identifier, bytes_iterator
 
2241
            if absent:
 
2242
                # There may be more missing items, but raise an exception
 
2243
                # for just one.
 
2244
                missing_identifier = absent.keys()[0]
 
2245
                missing_key = absent[missing_identifier]
 
2246
                raise errors.RevisionNotPresent(revision_id=missing_key[1],
 
2247
                    file_id=missing_key[0])
 
2248
        except errors.UnknownSmartMethod:
 
2249
            self._ensure_real()
 
2250
            for (identifier, bytes_iterator) in (
 
2251
                self._real_repository.iter_files_bytes(desired_files)):
 
2252
                yield identifier, bytes_iterator
 
2253
 
 
2254
    def get_cached_parent_map(self, revision_ids):
 
2255
        """See bzrlib.CachingParentsProvider.get_cached_parent_map"""
 
2256
        return self._unstacked_provider.get_cached_parent_map(revision_ids)
1344
2257
 
1345
2258
    def get_parent_map(self, revision_ids):
1346
2259
        """See bzrlib.Graph.get_parent_map()."""
1405
2318
        if parents_map is None:
1406
2319
            # Repository is not locked, so there's no cache.
1407
2320
            parents_map = {}
1408
 
        # start_set is all the keys in the cache
1409
 
        start_set = set(parents_map)
1410
 
        # result set is all the references to keys in the cache
1411
 
        result_parents = set()
1412
 
        for parents in parents_map.itervalues():
1413
 
            result_parents.update(parents)
1414
 
        stop_keys = result_parents.difference(start_set)
1415
 
        # We don't need to send ghosts back to the server as a position to
1416
 
        # stop either.
1417
 
        stop_keys.difference_update(self._unstacked_provider.missing_keys)
1418
 
        key_count = len(parents_map)
1419
 
        if (NULL_REVISION in result_parents
1420
 
            and NULL_REVISION in self._unstacked_provider.missing_keys):
1421
 
            # If we pruned NULL_REVISION from the stop_keys because it's also
1422
 
            # in our cache of "missing" keys we need to increment our key count
1423
 
            # by 1, because the reconsitituted SearchResult on the server will
1424
 
            # still consider NULL_REVISION to be an included key.
1425
 
            key_count += 1
1426
 
        included_keys = start_set.intersection(result_parents)
1427
 
        start_set.difference_update(included_keys)
 
2321
        if _DEFAULT_SEARCH_DEPTH <= 0:
 
2322
            (start_set, stop_keys,
 
2323
             key_count) = vf_search.search_result_from_parent_map(
 
2324
                parents_map, self._unstacked_provider.missing_keys)
 
2325
        else:
 
2326
            (start_set, stop_keys,
 
2327
             key_count) = vf_search.limited_search_result_from_parent_map(
 
2328
                parents_map, self._unstacked_provider.missing_keys,
 
2329
                keys, depth=_DEFAULT_SEARCH_DEPTH)
1428
2330
        recipe = ('manual', start_set, stop_keys, key_count)
1429
2331
        body = self._serialise_search_recipe(recipe)
1430
2332
        path = self.bzrdir._path_for_remote_call(self._client)
1479
2381
 
1480
2382
    @needs_read_lock
1481
2383
    def get_signature_text(self, revision_id):
1482
 
        self._ensure_real()
1483
 
        return self._real_repository.get_signature_text(revision_id)
 
2384
        path = self.bzrdir._path_for_remote_call(self._client)
 
2385
        try:
 
2386
            response_tuple, response_handler = self._call_expecting_body(
 
2387
                'Repository.get_revision_signature_text', path, revision_id)
 
2388
        except errors.UnknownSmartMethod:
 
2389
            self._ensure_real()
 
2390
            return self._real_repository.get_signature_text(revision_id)
 
2391
        except errors.NoSuchRevision, err:
 
2392
            for fallback in self._fallback_repositories:
 
2393
                try:
 
2394
                    return fallback.get_signature_text(revision_id)
 
2395
                except errors.NoSuchRevision:
 
2396
                    pass
 
2397
            raise err
 
2398
        else:
 
2399
            if response_tuple[0] != 'ok':
 
2400
                raise errors.UnexpectedSmartServerResponse(response_tuple)
 
2401
            return response_handler.read_body_bytes()
1484
2402
 
1485
2403
    @needs_read_lock
1486
 
    def get_inventory_xml(self, revision_id):
1487
 
        self._ensure_real()
1488
 
        return self._real_repository.get_inventory_xml(revision_id)
1489
 
 
1490
 
    def deserialise_inventory(self, revision_id, xml):
1491
 
        self._ensure_real()
1492
 
        return self._real_repository.deserialise_inventory(revision_id, xml)
1493
 
 
 
2404
    def _get_inventory_xml(self, revision_id):
 
2405
        # This call is used by older working tree formats,
 
2406
        # which stored a serialized basis inventory.
 
2407
        self._ensure_real()
 
2408
        return self._real_repository._get_inventory_xml(revision_id)
 
2409
 
 
2410
    @needs_write_lock
1494
2411
    def reconcile(self, other=None, thorough=False):
1495
 
        self._ensure_real()
1496
 
        return self._real_repository.reconcile(other=other, thorough=thorough)
 
2412
        from bzrlib.reconcile import RepoReconciler
 
2413
        path = self.bzrdir._path_for_remote_call(self._client)
 
2414
        try:
 
2415
            response, handler = self._call_expecting_body(
 
2416
                'Repository.reconcile', path, self._lock_token)
 
2417
        except (errors.UnknownSmartMethod, errors.TokenLockingNotSupported):
 
2418
            self._ensure_real()
 
2419
            return self._real_repository.reconcile(other=other, thorough=thorough)
 
2420
        if response != ('ok', ):
 
2421
            raise errors.UnexpectedSmartServerResponse(response)
 
2422
        body = handler.read_body_bytes()
 
2423
        result = RepoReconciler(self)
 
2424
        for line in body.split('\n'):
 
2425
            if not line:
 
2426
                continue
 
2427
            key, val_text = line.split(':')
 
2428
            if key == "garbage_inventories":
 
2429
                result.garbage_inventories = int(val_text)
 
2430
            elif key == "inconsistent_parents":
 
2431
                result.inconsistent_parents = int(val_text)
 
2432
            else:
 
2433
                mutter("unknown reconcile key %r" % key)
 
2434
        return result
1497
2435
 
1498
2436
    def all_revision_ids(self):
1499
 
        self._ensure_real()
1500
 
        return self._real_repository.all_revision_ids()
 
2437
        path = self.bzrdir._path_for_remote_call(self._client)
 
2438
        try:
 
2439
            response_tuple, response_handler = self._call_expecting_body(
 
2440
                "Repository.all_revision_ids", path)
 
2441
        except errors.UnknownSmartMethod:
 
2442
            self._ensure_real()
 
2443
            return self._real_repository.all_revision_ids()
 
2444
        if response_tuple != ("ok", ):
 
2445
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
2446
        revids = set(response_handler.read_body_bytes().splitlines())
 
2447
        for fallback in self._fallback_repositories:
 
2448
            revids.update(set(fallback.all_revision_ids()))
 
2449
        return list(revids)
 
2450
 
 
2451
    def _filtered_revision_trees(self, revision_ids, file_ids):
 
2452
        """Return Tree for a revision on this branch with only some files.
 
2453
 
 
2454
        :param revision_ids: a sequence of revision-ids;
 
2455
          a revision-id may not be None or 'null:'
 
2456
        :param file_ids: if not None, the result is filtered
 
2457
          so that only those file-ids, their parents and their
 
2458
          children are included.
 
2459
        """
 
2460
        inventories = self.iter_inventories(revision_ids)
 
2461
        for inv in inventories:
 
2462
            # Should we introduce a FilteredRevisionTree class rather
 
2463
            # than pre-filter the inventory here?
 
2464
            filtered_inv = inv.filter(file_ids)
 
2465
            yield InventoryRevisionTree(self, filtered_inv, filtered_inv.revision_id)
1501
2466
 
1502
2467
    @needs_read_lock
1503
2468
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1504
 
        self._ensure_real()
1505
 
        return self._real_repository.get_deltas_for_revisions(revisions,
1506
 
            specific_fileids=specific_fileids)
 
2469
        medium = self._client._medium
 
2470
        if medium._is_remote_before((1, 2)):
 
2471
            self._ensure_real()
 
2472
            for delta in self._real_repository.get_deltas_for_revisions(
 
2473
                    revisions, specific_fileids):
 
2474
                yield delta
 
2475
            return
 
2476
        # Get the revision-ids of interest
 
2477
        required_trees = set()
 
2478
        for revision in revisions:
 
2479
            required_trees.add(revision.revision_id)
 
2480
            required_trees.update(revision.parent_ids[:1])
 
2481
 
 
2482
        # Get the matching filtered trees. Note that it's more
 
2483
        # efficient to pass filtered trees to changes_from() rather
 
2484
        # than doing the filtering afterwards. changes_from() could
 
2485
        # arguably do the filtering itself but it's path-based, not
 
2486
        # file-id based, so filtering before or afterwards is
 
2487
        # currently easier.
 
2488
        if specific_fileids is None:
 
2489
            trees = dict((t.get_revision_id(), t) for
 
2490
                t in self.revision_trees(required_trees))
 
2491
        else:
 
2492
            trees = dict((t.get_revision_id(), t) for
 
2493
                t in self._filtered_revision_trees(required_trees,
 
2494
                specific_fileids))
 
2495
 
 
2496
        # Calculate the deltas
 
2497
        for revision in revisions:
 
2498
            if not revision.parent_ids:
 
2499
                old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
 
2500
            else:
 
2501
                old_tree = trees[revision.parent_ids[0]]
 
2502
            yield trees[revision.revision_id].changes_from(old_tree)
1507
2503
 
1508
2504
    @needs_read_lock
1509
2505
    def get_revision_delta(self, revision_id, specific_fileids=None):
1510
 
        self._ensure_real()
1511
 
        return self._real_repository.get_revision_delta(revision_id,
1512
 
            specific_fileids=specific_fileids)
 
2506
        r = self.get_revision(revision_id)
 
2507
        return list(self.get_deltas_for_revisions([r],
 
2508
            specific_fileids=specific_fileids))[0]
1513
2509
 
1514
2510
    @needs_read_lock
1515
2511
    def revision_trees(self, revision_ids):
1516
 
        self._ensure_real()
1517
 
        return self._real_repository.revision_trees(revision_ids)
 
2512
        inventories = self.iter_inventories(revision_ids)
 
2513
        for inv in inventories:
 
2514
            yield InventoryRevisionTree(self, inv, inv.revision_id)
1518
2515
 
1519
2516
    @needs_read_lock
1520
2517
    def get_revision_reconcile(self, revision_id):
1528
2525
            callback_refs=callback_refs, check_repo=check_repo)
1529
2526
 
1530
2527
    def copy_content_into(self, destination, revision_id=None):
1531
 
        self._ensure_real()
1532
 
        return self._real_repository.copy_content_into(
1533
 
            destination, revision_id=revision_id)
 
2528
        """Make a complete copy of the content in self into destination.
 
2529
 
 
2530
        This is a destructive operation! Do not use it on existing
 
2531
        repositories.
 
2532
        """
 
2533
        interrepo = _mod_repository.InterRepository.get(self, destination)
 
2534
        return interrepo.copy_content(revision_id)
1534
2535
 
1535
2536
    def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
1536
2537
        # get a tarball of the remote repository, and copy from that into the
1537
2538
        # destination
1538
 
        from bzrlib import osutils
1539
2539
        import tarfile
1540
2540
        # TODO: Maybe a progress bar while streaming the tarball?
1541
 
        note("Copying repository content as tarball...")
 
2541
        note(gettext("Copying repository content as tarball..."))
1542
2542
        tar_file = self._get_tarball('bz2')
1543
2543
        if tar_file is None:
1544
2544
            return None
1549
2549
            tmpdir = osutils.mkdtemp()
1550
2550
            try:
1551
2551
                _extract_tar(tar, tmpdir)
1552
 
                tmp_bzrdir = BzrDir.open(tmpdir)
 
2552
                tmp_bzrdir = _mod_bzrdir.BzrDir.open(tmpdir)
1553
2553
                tmp_repo = tmp_bzrdir.open_repository()
1554
2554
                tmp_repo.copy_content_into(destination, revision_id)
1555
2555
            finally:
1571
2571
        return self._real_repository.inventories
1572
2572
 
1573
2573
    @needs_write_lock
1574
 
    def pack(self, hint=None):
 
2574
    def pack(self, hint=None, clean_obsolete_packs=False):
1575
2575
        """Compress the data within the repository.
1576
 
 
1577
 
        This is not currently implemented within the smart server.
1578
2576
        """
1579
 
        self._ensure_real()
1580
 
        return self._real_repository.pack(hint=hint)
 
2577
        if hint is None:
 
2578
            body = ""
 
2579
        else:
 
2580
            body = "".join([l+"\n" for l in hint])
 
2581
        path = self.bzrdir._path_for_remote_call(self._client)
 
2582
        try:
 
2583
            response, handler = self._call_with_body_bytes_expecting_body(
 
2584
                'Repository.pack', (path, self._lock_token,
 
2585
                    str(clean_obsolete_packs)), body)
 
2586
        except errors.UnknownSmartMethod:
 
2587
            self._ensure_real()
 
2588
            return self._real_repository.pack(hint=hint,
 
2589
                clean_obsolete_packs=clean_obsolete_packs)
 
2590
        handler.cancel_read_body()
 
2591
        if response != ('ok', ):
 
2592
            raise errors.UnexpectedSmartServerResponse(response)
1581
2593
 
1582
2594
    @property
1583
2595
    def revisions(self):
1584
2596
        """Decorate the real repository for now.
1585
2597
 
1586
 
        In the short term this should become a real object to intercept graph
1587
 
        lookups.
1588
 
 
1589
2598
        In the long term a full blown network facility is needed.
1590
2599
        """
1591
2600
        self._ensure_real()
1619
2628
 
1620
2629
    @needs_write_lock
1621
2630
    def sign_revision(self, revision_id, gpg_strategy):
1622
 
        self._ensure_real()
1623
 
        return self._real_repository.sign_revision(revision_id, gpg_strategy)
 
2631
        testament = _mod_testament.Testament.from_revision(self, revision_id)
 
2632
        plaintext = testament.as_short_text()
 
2633
        self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1624
2634
 
1625
2635
    @property
1626
2636
    def texts(self):
1632
2642
        self._ensure_real()
1633
2643
        return self._real_repository.texts
1634
2644
 
 
2645
    def _iter_revisions_rpc(self, revision_ids):
 
2646
        body = "\n".join(revision_ids)
 
2647
        path = self.bzrdir._path_for_remote_call(self._client)
 
2648
        response_tuple, response_handler = (
 
2649
            self._call_with_body_bytes_expecting_body(
 
2650
            "Repository.iter_revisions", (path, ), body))
 
2651
        if response_tuple[0] != "ok":
 
2652
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
2653
        serializer_format = response_tuple[1]
 
2654
        serializer = serializer_format_registry.get(serializer_format)
 
2655
        byte_stream = response_handler.read_streamed_body()
 
2656
        decompressor = zlib.decompressobj()
 
2657
        chunks = []
 
2658
        for bytes in byte_stream:
 
2659
            chunks.append(decompressor.decompress(bytes))
 
2660
            if decompressor.unused_data != "":
 
2661
                chunks.append(decompressor.flush())
 
2662
                yield serializer.read_revision_from_string("".join(chunks))
 
2663
                unused = decompressor.unused_data
 
2664
                decompressor = zlib.decompressobj()
 
2665
                chunks = [decompressor.decompress(unused)]
 
2666
        chunks.append(decompressor.flush())
 
2667
        text = "".join(chunks)
 
2668
        if text != "":
 
2669
            yield serializer.read_revision_from_string("".join(chunks))
 
2670
 
1635
2671
    @needs_read_lock
1636
2672
    def get_revisions(self, revision_ids):
1637
 
        self._ensure_real()
1638
 
        return self._real_repository.get_revisions(revision_ids)
 
2673
        if revision_ids is None:
 
2674
            revision_ids = self.all_revision_ids()
 
2675
        else:
 
2676
            for rev_id in revision_ids:
 
2677
                if not rev_id or not isinstance(rev_id, basestring):
 
2678
                    raise errors.InvalidRevisionId(
 
2679
                        revision_id=rev_id, branch=self)
 
2680
        try:
 
2681
            missing = set(revision_ids)
 
2682
            revs = {}
 
2683
            for rev in self._iter_revisions_rpc(revision_ids):
 
2684
                missing.remove(rev.revision_id)
 
2685
                revs[rev.revision_id] = rev
 
2686
        except errors.UnknownSmartMethod:
 
2687
            self._ensure_real()
 
2688
            return self._real_repository.get_revisions(revision_ids)
 
2689
        for fallback in self._fallback_repositories:
 
2690
            if not missing:
 
2691
                break
 
2692
            for revid in list(missing):
 
2693
                # XXX JRV 2011-11-20: It would be nice if there was a
 
2694
                # public method on Repository that could be used to query
 
2695
                # for revision objects *without* failing completely if one
 
2696
                # was missing. There is VersionedFileRepository._iter_revisions,
 
2697
                # but unfortunately that's private and not provided by
 
2698
                # all repository implementations.
 
2699
                try:
 
2700
                    revs[revid] = fallback.get_revision(revid)
 
2701
                except errors.NoSuchRevision:
 
2702
                    pass
 
2703
                else:
 
2704
                    missing.remove(revid)
 
2705
        if missing:
 
2706
            raise errors.NoSuchRevision(self, list(missing)[0])
 
2707
        return [revs[revid] for revid in revision_ids]
1639
2708
 
1640
2709
    def supports_rich_root(self):
1641
2710
        return self._format.rich_root_data
1642
2711
 
 
2712
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1643
2713
    def iter_reverse_revision_history(self, revision_id):
1644
2714
        self._ensure_real()
1645
2715
        return self._real_repository.iter_reverse_revision_history(revision_id)
1648
2718
    def _serializer(self):
1649
2719
        return self._format._serializer
1650
2720
 
 
2721
    @needs_write_lock
1651
2722
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1652
 
        self._ensure_real()
1653
 
        return self._real_repository.store_revision_signature(
1654
 
            gpg_strategy, plaintext, revision_id)
 
2723
        signature = gpg_strategy.sign(plaintext)
 
2724
        self.add_signature_text(revision_id, signature)
1655
2725
 
1656
2726
    def add_signature_text(self, revision_id, signature):
1657
 
        self._ensure_real()
1658
 
        return self._real_repository.add_signature_text(revision_id, signature)
 
2727
        if self._real_repository:
 
2728
            # If there is a real repository the write group will
 
2729
            # be in the real repository as well, so use that:
 
2730
            self._ensure_real()
 
2731
            return self._real_repository.add_signature_text(
 
2732
                revision_id, signature)
 
2733
        path = self.bzrdir._path_for_remote_call(self._client)
 
2734
        response, handler = self._call_with_body_bytes_expecting_body(
 
2735
            'Repository.add_signature_text', (path, self._lock_token,
 
2736
                revision_id) + tuple(self._write_group_tokens), signature)
 
2737
        handler.cancel_read_body()
 
2738
        self.refresh_data()
 
2739
        if response[0] != 'ok':
 
2740
            raise errors.UnexpectedSmartServerResponse(response)
 
2741
        self._write_group_tokens = response[1:]
1659
2742
 
1660
2743
    def has_signature_for_revision_id(self, revision_id):
1661
 
        self._ensure_real()
1662
 
        return self._real_repository.has_signature_for_revision_id(revision_id)
 
2744
        path = self.bzrdir._path_for_remote_call(self._client)
 
2745
        try:
 
2746
            response = self._call('Repository.has_signature_for_revision_id',
 
2747
                path, revision_id)
 
2748
        except errors.UnknownSmartMethod:
 
2749
            self._ensure_real()
 
2750
            return self._real_repository.has_signature_for_revision_id(
 
2751
                revision_id)
 
2752
        if response[0] not in ('yes', 'no'):
 
2753
            raise SmartProtocolError('unexpected response code %s' % (response,))
 
2754
        if response[0] == 'yes':
 
2755
            return True
 
2756
        for fallback in self._fallback_repositories:
 
2757
            if fallback.has_signature_for_revision_id(revision_id):
 
2758
                return True
 
2759
        return False
 
2760
 
 
2761
    @needs_read_lock
 
2762
    def verify_revision_signature(self, revision_id, gpg_strategy):
 
2763
        if not self.has_signature_for_revision_id(revision_id):
 
2764
            return gpg.SIGNATURE_NOT_SIGNED, None
 
2765
        signature = self.get_signature_text(revision_id)
 
2766
 
 
2767
        testament = _mod_testament.Testament.from_revision(self, revision_id)
 
2768
        plaintext = testament.as_short_text()
 
2769
 
 
2770
        return gpg_strategy.verify(signature, plaintext)
1663
2771
 
1664
2772
    def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1665
2773
        self._ensure_real()
1666
2774
        return self._real_repository.item_keys_introduced_by(revision_ids,
1667
2775
            _files_pb=_files_pb)
1668
2776
 
1669
 
    def revision_graph_can_have_wrong_parents(self):
1670
 
        # The answer depends on the remote repo format.
1671
 
        self._ensure_real()
1672
 
        return self._real_repository.revision_graph_can_have_wrong_parents()
1673
 
 
1674
2777
    def _find_inconsistent_revision_parents(self, revisions_iterator=None):
1675
2778
        self._ensure_real()
1676
2779
        return self._real_repository._find_inconsistent_revision_parents(
1684
2787
        providers = [self._unstacked_provider]
1685
2788
        if other is not None:
1686
2789
            providers.insert(0, other)
1687
 
        providers.extend(r._make_parents_provider() for r in
1688
 
                         self._fallback_repositories)
1689
 
        return graph.StackedParentsProvider(providers)
 
2790
        return graph.StackedParentsProvider(_LazyListJoin(
 
2791
            providers, self._fallback_repositories))
1690
2792
 
1691
2793
    def _serialise_search_recipe(self, recipe):
1692
2794
        """Serialise a graph search recipe.
1700
2802
        return '\n'.join((start_keys, stop_keys, count))
1701
2803
 
1702
2804
    def _serialise_search_result(self, search_result):
1703
 
        if isinstance(search_result, graph.PendingAncestryResult):
1704
 
            parts = ['ancestry-of']
1705
 
            parts.extend(search_result.heads)
1706
 
        else:
1707
 
            recipe = search_result.get_recipe()
1708
 
            parts = [recipe[0], self._serialise_search_recipe(recipe)]
 
2805
        parts = search_result.get_network_struct()
1709
2806
        return '\n'.join(parts)
1710
2807
 
1711
2808
    def autopack(self):
1721
2818
            raise errors.UnexpectedSmartServerResponse(response)
1722
2819
 
1723
2820
 
1724
 
class RemoteStreamSink(repository.StreamSink):
 
2821
class RemoteStreamSink(vf_repository.StreamSink):
1725
2822
 
1726
2823
    def _insert_real(self, stream, src_format, resume_tokens):
1727
2824
        self.target_repo._ensure_real()
1828
2925
        self._last_substream and self._last_stream so that the stream can be
1829
2926
        resumed by _resume_stream_with_vfs.
1830
2927
        """
1831
 
                    
 
2928
 
1832
2929
        stream_iter = iter(stream)
1833
2930
        for substream_kind, substream in stream_iter:
1834
2931
            if substream_kind == 'inventory-deltas':
1837
2934
                return
1838
2935
            else:
1839
2936
                yield substream_kind, substream
1840
 
            
1841
 
 
1842
 
class RemoteStreamSource(repository.StreamSource):
 
2937
 
 
2938
 
 
2939
class RemoteStreamSource(vf_repository.StreamSource):
1843
2940
    """Stream data from a remote server."""
1844
2941
 
1845
2942
    def get_stream(self, search):
1866
2963
 
1867
2964
    def _real_stream(self, repo, search):
1868
2965
        """Get a stream for search from repo.
1869
 
        
1870
 
        This never called RemoteStreamSource.get_stream, and is a heler
1871
 
        for RemoteStreamSource._get_stream to allow getting a stream 
 
2966
 
 
2967
        This never called RemoteStreamSource.get_stream, and is a helper
 
2968
        for RemoteStreamSource._get_stream to allow getting a stream
1872
2969
        reliably whether fallback back because of old servers or trying
1873
2970
        to stream from a non-RemoteRepository (which the stacked support
1874
2971
        code will do).
1905
3002
        candidate_verbs = [
1906
3003
            ('Repository.get_stream_1.19', (1, 19)),
1907
3004
            ('Repository.get_stream', (1, 13))]
 
3005
 
1908
3006
        found_verb = False
1909
3007
        for verb, version in candidate_verbs:
1910
3008
            if medium._is_remote_before(version):
1914
3012
                    verb, args, search_bytes)
1915
3013
            except errors.UnknownSmartMethod:
1916
3014
                medium._remember_remote_is_before(version)
 
3015
            except errors.UnknownErrorFromSmartServer, e:
 
3016
                if isinstance(search, vf_search.EverythingResult):
 
3017
                    error_verb = e.error_from_smart_server.error_verb
 
3018
                    if error_verb == 'BadSearch':
 
3019
                        # Pre-2.4 servers don't support this sort of search.
 
3020
                        # XXX: perhaps falling back to VFS on BadSearch is a
 
3021
                        # good idea in general?  It might provide a little bit
 
3022
                        # of protection against client-side bugs.
 
3023
                        medium._remember_remote_is_before((2, 4))
 
3024
                        break
 
3025
                raise
1917
3026
            else:
1918
3027
                response_tuple, response_handler = response
1919
3028
                found_verb = True
1923
3032
        if response_tuple[0] != 'ok':
1924
3033
            raise errors.UnexpectedSmartServerResponse(response_tuple)
1925
3034
        byte_stream = response_handler.read_streamed_body()
1926
 
        src_format, stream = smart_repo._byte_stream_to_stream(byte_stream)
 
3035
        src_format, stream = smart_repo._byte_stream_to_stream(byte_stream,
 
3036
            self._record_counter)
1927
3037
        if src_format.network_name() != repo._format.network_name():
1928
3038
            raise AssertionError(
1929
3039
                "Mismatched RemoteRepository and stream src %r, %r" % (
2001
3111
 
2002
3112
    def _ensure_real(self):
2003
3113
        if self._custom_format is None:
2004
 
            self._custom_format = branch.network_format_registry.get(
2005
 
                self._network_name)
 
3114
            try:
 
3115
                self._custom_format = branch.network_format_registry.get(
 
3116
                    self._network_name)
 
3117
            except KeyError:
 
3118
                raise errors.UnknownFormatError(kind='branch',
 
3119
                    format=self._network_name)
2006
3120
 
2007
3121
    def get_format_description(self):
2008
3122
        self._ensure_real()
2011
3125
    def network_name(self):
2012
3126
        return self._network_name
2013
3127
 
2014
 
    def open(self, a_bzrdir, ignore_fallbacks=False):
2015
 
        return a_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
 
3128
    def open(self, a_bzrdir, name=None, ignore_fallbacks=False):
 
3129
        return a_bzrdir.open_branch(name=name, 
 
3130
            ignore_fallbacks=ignore_fallbacks)
2016
3131
 
2017
 
    def _vfs_initialize(self, a_bzrdir):
 
3132
    def _vfs_initialize(self, a_bzrdir, name, append_revisions_only):
2018
3133
        # Initialisation when using a local bzrdir object, or a non-vfs init
2019
3134
        # method is not available on the server.
2020
3135
        # self._custom_format is always set - the start of initialize ensures
2021
3136
        # that.
2022
3137
        if isinstance(a_bzrdir, RemoteBzrDir):
2023
3138
            a_bzrdir._ensure_real()
2024
 
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir)
 
3139
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
 
3140
                name=name, append_revisions_only=append_revisions_only)
2025
3141
        else:
2026
3142
            # We assume the bzrdir is parameterised; it may not be.
2027
 
            result = self._custom_format.initialize(a_bzrdir)
 
3143
            result = self._custom_format.initialize(a_bzrdir, name=name,
 
3144
                append_revisions_only=append_revisions_only)
2028
3145
        if (isinstance(a_bzrdir, RemoteBzrDir) and
2029
3146
            not isinstance(result, RemoteBranch)):
2030
 
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
 
3147
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
 
3148
                                  name=name)
2031
3149
        return result
2032
3150
 
2033
 
    def initialize(self, a_bzrdir):
 
3151
    def initialize(self, a_bzrdir, name=None, repository=None,
 
3152
                   append_revisions_only=None):
 
3153
        if name is None:
 
3154
            name = a_bzrdir._get_selected_branch()
2034
3155
        # 1) get the network name to use.
2035
3156
        if self._custom_format:
2036
3157
            network_name = self._custom_format.network_name()
2037
3158
        else:
2038
3159
            # Select the current bzrlib default and ask for that.
2039
 
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
 
3160
            reference_bzrdir_format = controldir.format_registry.get('default')()
2040
3161
            reference_format = reference_bzrdir_format.get_branch_format()
2041
3162
            self._custom_format = reference_format
2042
3163
            network_name = reference_format.network_name()
2043
3164
        # Being asked to create on a non RemoteBzrDir:
2044
3165
        if not isinstance(a_bzrdir, RemoteBzrDir):
2045
 
            return self._vfs_initialize(a_bzrdir)
 
3166
            return self._vfs_initialize(a_bzrdir, name=name,
 
3167
                append_revisions_only=append_revisions_only)
2046
3168
        medium = a_bzrdir._client._medium
2047
3169
        if medium._is_remote_before((1, 13)):
2048
 
            return self._vfs_initialize(a_bzrdir)
 
3170
            return self._vfs_initialize(a_bzrdir, name=name,
 
3171
                append_revisions_only=append_revisions_only)
2049
3172
        # Creating on a remote bzr dir.
2050
3173
        # 2) try direct creation via RPC
2051
3174
        path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
 
3175
        if name != "":
 
3176
            # XXX JRV20100304: Support creating colocated branches
 
3177
            raise errors.NoColocatedBranchSupport(self)
2052
3178
        verb = 'BzrDir.create_branch'
2053
3179
        try:
2054
3180
            response = a_bzrdir._call(verb, path, network_name)
2055
3181
        except errors.UnknownSmartMethod:
2056
3182
            # Fallback - use vfs methods
2057
3183
            medium._remember_remote_is_before((1, 13))
2058
 
            return self._vfs_initialize(a_bzrdir)
 
3184
            return self._vfs_initialize(a_bzrdir, name=name,
 
3185
                    append_revisions_only=append_revisions_only)
2059
3186
        if response[0] != 'ok':
2060
3187
            raise errors.UnexpectedSmartServerResponse(response)
2061
3188
        # Turn the response into a RemoteRepository object.
2062
3189
        format = RemoteBranchFormat(network_name=response[1])
2063
3190
        repo_format = response_tuple_to_repo_format(response[3:])
2064
 
        if response[2] == '':
2065
 
            repo_bzrdir = a_bzrdir
 
3191
        repo_path = response[2]
 
3192
        if repository is not None:
 
3193
            remote_repo_url = urlutils.join(a_bzrdir.user_url, repo_path)
 
3194
            url_diff = urlutils.relative_url(repository.user_url,
 
3195
                    remote_repo_url)
 
3196
            if url_diff != '.':
 
3197
                raise AssertionError(
 
3198
                    'repository.user_url %r does not match URL from server '
 
3199
                    'response (%r + %r)'
 
3200
                    % (repository.user_url, a_bzrdir.user_url, repo_path))
 
3201
            remote_repo = repository
2066
3202
        else:
2067
 
            repo_bzrdir = RemoteBzrDir(
2068
 
                a_bzrdir.root_transport.clone(response[2]), a_bzrdir._format,
2069
 
                a_bzrdir._client)
2070
 
        remote_repo = RemoteRepository(repo_bzrdir, repo_format)
 
3203
            if repo_path == '':
 
3204
                repo_bzrdir = a_bzrdir
 
3205
            else:
 
3206
                repo_bzrdir = RemoteBzrDir(
 
3207
                    a_bzrdir.root_transport.clone(repo_path), a_bzrdir._format,
 
3208
                    a_bzrdir._client)
 
3209
            remote_repo = RemoteRepository(repo_bzrdir, repo_format)
2071
3210
        remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2072
 
            format=format, setup_stacking=False)
 
3211
            format=format, setup_stacking=False, name=name)
 
3212
        if append_revisions_only:
 
3213
            remote_branch.set_append_revisions_only(append_revisions_only)
2073
3214
        # XXX: We know this is a new branch, so it must have revno 0, revid
2074
3215
        # NULL_REVISION. Creating the branch locked would make this be unable
2075
3216
        # to be wrong; here its simply very unlikely to be wrong. RBC 20090225
2094
3235
        self._ensure_real()
2095
3236
        return self._custom_format.supports_set_append_revisions_only()
2096
3237
 
 
3238
    def _use_default_local_heads_to_fetch(self):
 
3239
        # If the branch format is a metadir format *and* its heads_to_fetch
 
3240
        # implementation is not overridden vs the base class, we can use the
 
3241
        # base class logic rather than use the heads_to_fetch RPC.  This is
 
3242
        # usually cheaper in terms of net round trips, as the last-revision and
 
3243
        # tags info fetched is cached and would be fetched anyway.
 
3244
        self._ensure_real()
 
3245
        if isinstance(self._custom_format, branch.BranchFormatMetadir):
 
3246
            branch_class = self._custom_format._branch_class()
 
3247
            heads_to_fetch_impl = branch_class.heads_to_fetch.im_func
 
3248
            if heads_to_fetch_impl is branch.Branch.heads_to_fetch.im_func:
 
3249
                return True
 
3250
        return False
 
3251
 
 
3252
 
 
3253
class RemoteBranchStore(_mod_config.IniFileStore):
 
3254
    """Branch store which attempts to use HPSS calls to retrieve branch store.
 
3255
 
 
3256
    Note that this is specific to bzr-based formats.
 
3257
    """
 
3258
 
 
3259
    def __init__(self, branch):
 
3260
        super(RemoteBranchStore, self).__init__()
 
3261
        self.branch = branch
 
3262
        self.id = "branch"
 
3263
        self._real_store = None
 
3264
 
 
3265
    def external_url(self):
 
3266
        return self.branch.user_url
 
3267
 
 
3268
    def _load_content(self):
 
3269
        path = self.branch._remote_path()
 
3270
        try:
 
3271
            response, handler = self.branch._call_expecting_body(
 
3272
                'Branch.get_config_file', path)
 
3273
        except errors.UnknownSmartMethod:
 
3274
            self._ensure_real()
 
3275
            return self._real_store._load_content()
 
3276
        if len(response) and response[0] != 'ok':
 
3277
            raise errors.UnexpectedSmartServerResponse(response)
 
3278
        return handler.read_body_bytes()
 
3279
 
 
3280
    def _save_content(self, content):
 
3281
        path = self.branch._remote_path()
 
3282
        try:
 
3283
            response, handler = self.branch._call_with_body_bytes_expecting_body(
 
3284
                'Branch.put_config_file', (path,
 
3285
                    self.branch._lock_token, self.branch._repo_lock_token),
 
3286
                content)
 
3287
        except errors.UnknownSmartMethod:
 
3288
            self._ensure_real()
 
3289
            return self._real_store._save_content(content)
 
3290
        handler.cancel_read_body()
 
3291
        if response != ('ok', ):
 
3292
            raise errors.UnexpectedSmartServerResponse(response)
 
3293
 
 
3294
    def _ensure_real(self):
 
3295
        self.branch._ensure_real()
 
3296
        if self._real_store is None:
 
3297
            self._real_store = _mod_config.BranchStore(self.branch)
 
3298
 
2097
3299
 
2098
3300
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
2099
3301
    """Branch stored on a server accessed by HPSS RPC.
2102
3304
    """
2103
3305
 
2104
3306
    def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
2105
 
        _client=None, format=None, setup_stacking=True):
 
3307
        _client=None, format=None, setup_stacking=True, name=None,
 
3308
        possible_transports=None):
2106
3309
        """Create a RemoteBranch instance.
2107
3310
 
2108
3311
        :param real_branch: An optional local implementation of the branch
2114
3317
        :param setup_stacking: If True make an RPC call to determine the
2115
3318
            stacked (or not) status of the branch. If False assume the branch
2116
3319
            is not stacked.
 
3320
        :param name: Colocated branch name
2117
3321
        """
2118
3322
        # We intentionally don't call the parent class's __init__, because it
2119
3323
        # will try to assign to self.tags, which is a property in this subclass.
2120
3324
        # And the parent's __init__ doesn't do much anyway.
2121
3325
        self.bzrdir = remote_bzrdir
 
3326
        self.name = name
2122
3327
        if _client is not None:
2123
3328
            self._client = _client
2124
3329
        else:
2138
3343
            self._real_branch = None
2139
3344
        # Fill out expected attributes of branch for bzrlib API users.
2140
3345
        self._clear_cached_state()
2141
 
        self.base = self.bzrdir.root_transport.base
 
3346
        # TODO: deprecate self.base in favor of user_url
 
3347
        self.base = self.bzrdir.user_url
 
3348
        self._name = name
2142
3349
        self._control_files = None
2143
3350
        self._lock_mode = None
2144
3351
        self._lock_token = None
2145
3352
        self._repo_lock_token = None
2146
3353
        self._lock_count = 0
2147
3354
        self._leave_lock = False
 
3355
        self.conf_store = None
2148
3356
        # Setup a format: note that we cannot call _ensure_real until all the
2149
3357
        # attributes above are set: This code cannot be moved higher up in this
2150
3358
        # function.
2170
3378
            hook(self)
2171
3379
        self._is_stacked = False
2172
3380
        if setup_stacking:
2173
 
            self._setup_stacking()
 
3381
            self._setup_stacking(possible_transports)
2174
3382
 
2175
 
    def _setup_stacking(self):
 
3383
    def _setup_stacking(self, possible_transports):
2176
3384
        # configure stacking into the remote repository, by reading it from
2177
3385
        # the vfs branch.
2178
3386
        try:
2181
3389
            errors.UnstackableRepositoryFormat), e:
2182
3390
            return
2183
3391
        self._is_stacked = True
2184
 
        self._activate_fallback_location(fallback_url)
 
3392
        if possible_transports is None:
 
3393
            possible_transports = []
 
3394
        else:
 
3395
            possible_transports = list(possible_transports)
 
3396
        possible_transports.append(self.bzrdir.root_transport)
 
3397
        self._activate_fallback_location(fallback_url,
 
3398
            possible_transports=possible_transports)
2185
3399
 
2186
3400
    def _get_config(self):
2187
3401
        return RemoteBranchConfig(self)
2188
3402
 
 
3403
    def _get_config_store(self):
 
3404
        if self.conf_store is None:
 
3405
            self.conf_store =  RemoteBranchStore(self)
 
3406
        return self.conf_store
 
3407
 
2189
3408
    def _get_real_transport(self):
2190
3409
        # if we try vfs access, return the real branch's vfs transport
2191
3410
        self._ensure_real()
2209
3428
                    'to use vfs implementation')
2210
3429
            self.bzrdir._ensure_real()
2211
3430
            self._real_branch = self.bzrdir._real_bzrdir.open_branch(
2212
 
                ignore_fallbacks=self._real_ignore_fallbacks)
 
3431
                ignore_fallbacks=self._real_ignore_fallbacks, name=self._name)
 
3432
            # The remote branch and the real branch shares the same store. If
 
3433
            # we don't, there will always be cases where one of the stores
 
3434
            # doesn't see an update made on the other.
 
3435
            self._real_branch.conf_store = self.conf_store
2213
3436
            if self.repository._real_repository is None:
2214
3437
                # Give the remote repository the matching real repo.
2215
3438
                real_repo = self._real_branch.repository
2254
3477
                self.bzrdir, self._client)
2255
3478
        return self._control_files
2256
3479
 
2257
 
    def _get_checkout_format(self):
2258
 
        self._ensure_real()
2259
 
        return self._real_branch._get_checkout_format()
2260
 
 
2261
3480
    def get_physical_lock_status(self):
2262
3481
        """See Branch.get_physical_lock_status()."""
2263
 
        # should be an API call to the server, as branches must be lockable.
2264
 
        self._ensure_real()
2265
 
        return self._real_branch.get_physical_lock_status()
 
3482
        try:
 
3483
            response = self._client.call('Branch.get_physical_lock_status',
 
3484
                self._remote_path())
 
3485
        except errors.UnknownSmartMethod:
 
3486
            self._ensure_real()
 
3487
            return self._real_branch.get_physical_lock_status()
 
3488
        if response[0] not in ('yes', 'no'):
 
3489
            raise errors.UnexpectedSmartServerResponse(response)
 
3490
        return (response[0] == 'yes')
2266
3491
 
2267
3492
    def get_stacked_on_url(self):
2268
3493
        """Get the URL this branch is stacked against.
2291
3516
 
2292
3517
    def set_stacked_on_url(self, url):
2293
3518
        branch.Branch.set_stacked_on_url(self, url)
 
3519
        # We need the stacked_on_url to be visible both locally (to not query
 
3520
        # it repeatedly) and remotely (so smart verbs can get it server side)
 
3521
        # Without the following line,
 
3522
        # bzrlib.tests.per_branch.test_create_clone.TestCreateClone
 
3523
        # .test_create_clone_on_transport_stacked_hooks_get_stacked_branch
 
3524
        # fails for remote branches -- vila 2012-01-04
 
3525
        self.conf_store.save_changes()
2294
3526
        if not url:
2295
3527
            self._is_stacked = False
2296
3528
        else:
2297
3529
            self._is_stacked = True
2298
 
        
 
3530
 
2299
3531
    def _vfs_get_tags_bytes(self):
2300
3532
        self._ensure_real()
2301
3533
        return self._real_branch._get_tags_bytes()
2302
3534
 
 
3535
    @needs_read_lock
2303
3536
    def _get_tags_bytes(self):
 
3537
        if self._tags_bytes is None:
 
3538
            self._tags_bytes = self._get_tags_bytes_via_hpss()
 
3539
        return self._tags_bytes
 
3540
 
 
3541
    def _get_tags_bytes_via_hpss(self):
2304
3542
        medium = self._client._medium
2305
3543
        if medium._is_remote_before((1, 13)):
2306
3544
            return self._vfs_get_tags_bytes()
2316
3554
        return self._real_branch._set_tags_bytes(bytes)
2317
3555
 
2318
3556
    def _set_tags_bytes(self, bytes):
 
3557
        if self.is_locked():
 
3558
            self._tags_bytes = bytes
2319
3559
        medium = self._client._medium
2320
3560
        if medium._is_remote_before((1, 18)):
2321
3561
            self._vfs_set_tags_bytes(bytes)
2330
3570
            self._vfs_set_tags_bytes(bytes)
2331
3571
 
2332
3572
    def lock_read(self):
 
3573
        """Lock the branch for read operations.
 
3574
 
 
3575
        :return: A bzrlib.lock.LogicalLockResult.
 
3576
        """
2333
3577
        self.repository.lock_read()
2334
3578
        if not self._lock_mode:
2335
3579
            self._note_lock('r')
2339
3583
                self._real_branch.lock_read()
2340
3584
        else:
2341
3585
            self._lock_count += 1
 
3586
        return lock.LogicalLockResult(self.unlock)
2342
3587
 
2343
3588
    def _remote_lock_write(self, token):
2344
3589
        if token is None:
2345
3590
            branch_token = repo_token = ''
2346
3591
        else:
2347
3592
            branch_token = token
2348
 
            repo_token = self.repository.lock_write()
 
3593
            repo_token = self.repository.lock_write().repository_token
2349
3594
            self.repository.unlock()
2350
3595
        err_context = {'token': token}
2351
 
        response = self._call(
2352
 
            'Branch.lock_write', self._remote_path(), branch_token,
2353
 
            repo_token or '', **err_context)
 
3596
        try:
 
3597
            response = self._call(
 
3598
                'Branch.lock_write', self._remote_path(), branch_token,
 
3599
                repo_token or '', **err_context)
 
3600
        except errors.LockContention, e:
 
3601
            # The LockContention from the server doesn't have any
 
3602
            # information about the lock_url. We re-raise LockContention
 
3603
            # with valid lock_url.
 
3604
            raise errors.LockContention('(remote lock)',
 
3605
                self.repository.base.split('.bzr/')[0])
2354
3606
        if response[0] != 'ok':
2355
3607
            raise errors.UnexpectedSmartServerResponse(response)
2356
3608
        ok, branch_token, repo_token = response
2377
3629
            self._lock_mode = 'w'
2378
3630
            self._lock_count = 1
2379
3631
        elif self._lock_mode == 'r':
2380
 
            raise errors.ReadOnlyTransaction
 
3632
            raise errors.ReadOnlyError(self)
2381
3633
        else:
2382
3634
            if token is not None:
2383
3635
                # A token was given to lock_write, and we're relocking, so
2388
3640
            self._lock_count += 1
2389
3641
            # Re-lock the repository too.
2390
3642
            self.repository.lock_write(self._repo_lock_token)
2391
 
        return self._lock_token or None
 
3643
        return BranchWriteLockResult(self.unlock, self._lock_token or None)
2392
3644
 
2393
3645
    def _unlock(self, branch_token, repo_token):
2394
3646
        err_context = {'token': str((branch_token, repo_token))}
2404
3656
        try:
2405
3657
            self._lock_count -= 1
2406
3658
            if not self._lock_count:
 
3659
                if self.conf_store is not None:
 
3660
                    self.conf_store.save_changes()
2407
3661
                self._clear_cached_state()
2408
3662
                mode = self._lock_mode
2409
3663
                self._lock_mode = None
2432
3686
            self.repository.unlock()
2433
3687
 
2434
3688
    def break_lock(self):
2435
 
        self._ensure_real()
2436
 
        return self._real_branch.break_lock()
 
3689
        try:
 
3690
            response = self._call(
 
3691
                'Branch.break_lock', self._remote_path())
 
3692
        except errors.UnknownSmartMethod:
 
3693
            self._ensure_real()
 
3694
            return self._real_branch.break_lock()
 
3695
        if response != ('ok',):
 
3696
            raise errors.UnexpectedSmartServerResponse(response)
2437
3697
 
2438
3698
    def leave_lock_in_place(self):
2439
3699
        if not self._lock_token:
2463
3723
            missing_parent = parent_map[missing_parent]
2464
3724
        raise errors.RevisionNotPresent(missing_parent, self.repository)
2465
3725
 
2466
 
    def _last_revision_info(self):
 
3726
    def _read_last_revision_info(self):
2467
3727
        response = self._call('Branch.last_revision_info', self._remote_path())
2468
3728
        if response[0] != 'ok':
2469
3729
            raise SmartProtocolError('unexpected response code %s' % (response,))
2532
3792
            raise errors.UnexpectedSmartServerResponse(response)
2533
3793
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2534
3794
 
 
3795
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
2535
3796
    @needs_write_lock
2536
3797
    def set_revision_history(self, rev_history):
 
3798
        """See Branch.set_revision_history."""
 
3799
        self._set_revision_history(rev_history)
 
3800
 
 
3801
    @needs_write_lock
 
3802
    def _set_revision_history(self, rev_history):
2537
3803
        # Send just the tip revision of the history; the server will generate
2538
3804
        # the full history from that.  If the revision doesn't exist in this
2539
3805
        # branch, NoSuchRevision will be raised.
2597
3863
            _override_hook_target=self, **kwargs)
2598
3864
 
2599
3865
    @needs_read_lock
2600
 
    def push(self, target, overwrite=False, stop_revision=None):
 
3866
    def push(self, target, overwrite=False, stop_revision=None, lossy=False):
2601
3867
        self._ensure_real()
2602
3868
        return self._real_branch.push(
2603
 
            target, overwrite=overwrite, stop_revision=stop_revision,
 
3869
            target, overwrite=overwrite, stop_revision=stop_revision, lossy=lossy,
2604
3870
            _override_hook_source_branch=self)
2605
3871
 
2606
3872
    def is_locked(self):
2607
3873
        return self._lock_count >= 1
2608
3874
 
2609
3875
    @needs_read_lock
 
3876
    def revision_id_to_dotted_revno(self, revision_id):
 
3877
        """Given a revision id, return its dotted revno.
 
3878
 
 
3879
        :return: a tuple like (1,) or (400,1,3).
 
3880
        """
 
3881
        try:
 
3882
            response = self._call('Branch.revision_id_to_revno',
 
3883
                self._remote_path(), revision_id)
 
3884
        except errors.UnknownSmartMethod:
 
3885
            self._ensure_real()
 
3886
            return self._real_branch.revision_id_to_dotted_revno(revision_id)
 
3887
        if response[0] == 'ok':
 
3888
            return tuple([int(x) for x in response[1:]])
 
3889
        else:
 
3890
            raise errors.UnexpectedSmartServerResponse(response)
 
3891
 
 
3892
    @needs_read_lock
2610
3893
    def revision_id_to_revno(self, revision_id):
2611
 
        self._ensure_real()
2612
 
        return self._real_branch.revision_id_to_revno(revision_id)
 
3894
        """Given a revision id on the branch mainline, return its revno.
 
3895
 
 
3896
        :return: an integer
 
3897
        """
 
3898
        try:
 
3899
            response = self._call('Branch.revision_id_to_revno',
 
3900
                self._remote_path(), revision_id)
 
3901
        except errors.UnknownSmartMethod:
 
3902
            self._ensure_real()
 
3903
            return self._real_branch.revision_id_to_revno(revision_id)
 
3904
        if response[0] == 'ok':
 
3905
            if len(response) == 2:
 
3906
                return int(response[1])
 
3907
            raise NoSuchRevision(self, revision_id)
 
3908
        else:
 
3909
            raise errors.UnexpectedSmartServerResponse(response)
2613
3910
 
2614
3911
    @needs_write_lock
2615
3912
    def set_last_revision_info(self, revno, revision_id):
2616
3913
        # XXX: These should be returned by the set_last_revision_info verb
2617
3914
        old_revno, old_revid = self.last_revision_info()
2618
3915
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
2619
 
        revision_id = ensure_null(revision_id)
 
3916
        if not revision_id or not isinstance(revision_id, basestring):
 
3917
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2620
3918
        try:
2621
3919
            response = self._call('Branch.set_last_revision_info',
2622
3920
                self._remote_path(), self._lock_token, self._repo_lock_token,
2651
3949
            except errors.UnknownSmartMethod:
2652
3950
                medium._remember_remote_is_before((1, 6))
2653
3951
        self._clear_cached_state_of_remote_branch_only()
2654
 
        self.set_revision_history(self._lefthand_history(revision_id,
 
3952
        self._set_revision_history(self._lefthand_history(revision_id,
2655
3953
            last_rev=last_rev,other_branch=other_branch))
2656
3954
 
2657
3955
    def set_push_location(self, location):
 
3956
        self._set_config_location('push_location', location)
 
3957
 
 
3958
    def heads_to_fetch(self):
 
3959
        if self._format._use_default_local_heads_to_fetch():
 
3960
            # We recognise this format, and its heads-to-fetch implementation
 
3961
            # is the default one (tip + tags).  In this case it's cheaper to
 
3962
            # just use the default implementation rather than a special RPC as
 
3963
            # the tip and tags data is cached.
 
3964
            return branch.Branch.heads_to_fetch(self)
 
3965
        medium = self._client._medium
 
3966
        if medium._is_remote_before((2, 4)):
 
3967
            return self._vfs_heads_to_fetch()
 
3968
        try:
 
3969
            return self._rpc_heads_to_fetch()
 
3970
        except errors.UnknownSmartMethod:
 
3971
            medium._remember_remote_is_before((2, 4))
 
3972
            return self._vfs_heads_to_fetch()
 
3973
 
 
3974
    def _rpc_heads_to_fetch(self):
 
3975
        response = self._call('Branch.heads_to_fetch', self._remote_path())
 
3976
        if len(response) != 2:
 
3977
            raise errors.UnexpectedSmartServerResponse(response)
 
3978
        must_fetch, if_present_fetch = response
 
3979
        return set(must_fetch), set(if_present_fetch)
 
3980
 
 
3981
    def _vfs_heads_to_fetch(self):
2658
3982
        self._ensure_real()
2659
 
        return self._real_branch.set_push_location(location)
 
3983
        return self._real_branch.heads_to_fetch()
2660
3984
 
2661
3985
 
2662
3986
class RemoteConfig(object):
2677
4001
        """
2678
4002
        try:
2679
4003
            configobj = self._get_configobj()
 
4004
            section_obj = None
2680
4005
            if section is None:
2681
4006
                section_obj = configobj
2682
4007
            else:
2683
4008
                try:
2684
4009
                    section_obj = configobj[section]
2685
4010
                except KeyError:
2686
 
                    return default
2687
 
            return section_obj.get(name, default)
 
4011
                    pass
 
4012
            if section_obj is None:
 
4013
                value = default
 
4014
            else:
 
4015
                value = section_obj.get(name, default)
2688
4016
        except errors.UnknownSmartMethod:
2689
 
            return self._vfs_get_option(name, section, default)
 
4017
            value = self._vfs_get_option(name, section, default)
 
4018
        for hook in _mod_config.OldConfigHooks['get']:
 
4019
            hook(self, name, value)
 
4020
        return value
2690
4021
 
2691
4022
    def _response_to_configobj(self, response):
2692
4023
        if len(response[0]) and response[0][0] != 'ok':
2693
4024
            raise errors.UnexpectedSmartServerResponse(response)
2694
4025
        lines = response[1].read_body_bytes().splitlines()
2695
 
        return config.ConfigObj(lines, encoding='utf-8')
 
4026
        conf = _mod_config.ConfigObj(lines, encoding='utf-8')
 
4027
        for hook in _mod_config.OldConfigHooks['load']:
 
4028
            hook(self)
 
4029
        return conf
2696
4030
 
2697
4031
 
2698
4032
class RemoteBranchConfig(RemoteConfig):
2717
4051
        medium = self._branch._client._medium
2718
4052
        if medium._is_remote_before((1, 14)):
2719
4053
            return self._vfs_set_option(value, name, section)
 
4054
        if isinstance(value, dict):
 
4055
            if medium._is_remote_before((2, 2)):
 
4056
                return self._vfs_set_option(value, name, section)
 
4057
            return self._set_config_option_dict(value, name, section)
 
4058
        else:
 
4059
            return self._set_config_option(value, name, section)
 
4060
 
 
4061
    def _set_config_option(self, value, name, section):
2720
4062
        try:
2721
4063
            path = self._branch._remote_path()
2722
4064
            response = self._branch._client.call('Branch.set_config_option',
2723
4065
                path, self._branch._lock_token, self._branch._repo_lock_token,
2724
4066
                value.encode('utf8'), name, section or '')
2725
4067
        except errors.UnknownSmartMethod:
 
4068
            medium = self._branch._client._medium
2726
4069
            medium._remember_remote_is_before((1, 14))
2727
4070
            return self._vfs_set_option(value, name, section)
2728
4071
        if response != ():
2729
4072
            raise errors.UnexpectedSmartServerResponse(response)
2730
4073
 
 
4074
    def _serialize_option_dict(self, option_dict):
 
4075
        utf8_dict = {}
 
4076
        for key, value in option_dict.items():
 
4077
            if isinstance(key, unicode):
 
4078
                key = key.encode('utf8')
 
4079
            if isinstance(value, unicode):
 
4080
                value = value.encode('utf8')
 
4081
            utf8_dict[key] = value
 
4082
        return bencode.bencode(utf8_dict)
 
4083
 
 
4084
    def _set_config_option_dict(self, value, name, section):
 
4085
        try:
 
4086
            path = self._branch._remote_path()
 
4087
            serialised_dict = self._serialize_option_dict(value)
 
4088
            response = self._branch._client.call(
 
4089
                'Branch.set_config_option_dict',
 
4090
                path, self._branch._lock_token, self._branch._repo_lock_token,
 
4091
                serialised_dict, name, section or '')
 
4092
        except errors.UnknownSmartMethod:
 
4093
            medium = self._branch._client._medium
 
4094
            medium._remember_remote_is_before((2, 2))
 
4095
            return self._vfs_set_option(value, name, section)
 
4096
        if response != ():
 
4097
            raise errors.UnexpectedSmartServerResponse(response)
 
4098
 
2731
4099
    def _real_object(self):
2732
4100
        self._branch._ensure_real()
2733
4101
        return self._branch._real_branch
2772
4140
        return self._bzrdir._real_bzrdir
2773
4141
 
2774
4142
 
2775
 
 
2776
4143
def _extract_tar(tar, to_dir):
2777
4144
    """Extract all the contents of a tarfile object.
2778
4145
 
2782
4149
        tar.extract(tarinfo, to_dir)
2783
4150
 
2784
4151
 
 
4152
error_translators = registry.Registry()
 
4153
no_context_error_translators = registry.Registry()
 
4154
 
 
4155
 
2785
4156
def _translate_error(err, **context):
2786
4157
    """Translate an ErrorFromSmartServer into a more useful error.
2787
4158
 
2816
4187
                    'Missing key %r in context %r', key_err.args[0], context)
2817
4188
                raise err
2818
4189
 
2819
 
    if err.error_verb == 'IncompatibleRepositories':
2820
 
        raise errors.IncompatibleRepositories(err.error_args[0],
2821
 
            err.error_args[1], err.error_args[2])
2822
 
    elif err.error_verb == 'NoSuchRevision':
2823
 
        raise NoSuchRevision(find('branch'), err.error_args[0])
2824
 
    elif err.error_verb == 'nosuchrevision':
2825
 
        raise NoSuchRevision(find('repository'), err.error_args[0])
2826
 
    elif err.error_tuple == ('nobranch',):
2827
 
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
2828
 
    elif err.error_verb == 'norepository':
2829
 
        raise errors.NoRepositoryPresent(find('bzrdir'))
2830
 
    elif err.error_verb == 'LockContention':
2831
 
        raise errors.LockContention('(remote lock)')
2832
 
    elif err.error_verb == 'UnlockableTransport':
2833
 
        raise errors.UnlockableTransport(find('bzrdir').root_transport)
2834
 
    elif err.error_verb == 'LockFailed':
2835
 
        raise errors.LockFailed(err.error_args[0], err.error_args[1])
2836
 
    elif err.error_verb == 'TokenMismatch':
2837
 
        raise errors.TokenMismatch(find('token'), '(remote token)')
2838
 
    elif err.error_verb == 'Diverged':
2839
 
        raise errors.DivergedBranches(find('branch'), find('other_branch'))
2840
 
    elif err.error_verb == 'TipChangeRejected':
2841
 
        raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
2842
 
    elif err.error_verb == 'UnstackableBranchFormat':
2843
 
        raise errors.UnstackableBranchFormat(*err.error_args)
2844
 
    elif err.error_verb == 'UnstackableRepositoryFormat':
2845
 
        raise errors.UnstackableRepositoryFormat(*err.error_args)
2846
 
    elif err.error_verb == 'NotStacked':
2847
 
        raise errors.NotStacked(branch=find('branch'))
2848
 
    elif err.error_verb == 'PermissionDenied':
2849
 
        path = get_path()
2850
 
        if len(err.error_args) >= 2:
2851
 
            extra = err.error_args[1]
2852
 
        else:
2853
 
            extra = None
2854
 
        raise errors.PermissionDenied(path, extra=extra)
2855
 
    elif err.error_verb == 'ReadError':
2856
 
        path = get_path()
2857
 
        raise errors.ReadError(path)
2858
 
    elif err.error_verb == 'NoSuchFile':
2859
 
        path = get_path()
2860
 
        raise errors.NoSuchFile(path)
2861
 
    elif err.error_verb == 'FileExists':
2862
 
        raise errors.FileExists(err.error_args[0])
2863
 
    elif err.error_verb == 'DirectoryNotEmpty':
2864
 
        raise errors.DirectoryNotEmpty(err.error_args[0])
2865
 
    elif err.error_verb == 'ShortReadvError':
2866
 
        args = err.error_args
2867
 
        raise errors.ShortReadvError(
2868
 
            args[0], int(args[1]), int(args[2]), int(args[3]))
2869
 
    elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
 
4190
    try:
 
4191
        translator = error_translators.get(err.error_verb)
 
4192
    except KeyError:
 
4193
        pass
 
4194
    else:
 
4195
        raise translator(err, find, get_path)
 
4196
    try:
 
4197
        translator = no_context_error_translators.get(err.error_verb)
 
4198
    except KeyError:
 
4199
        raise errors.UnknownErrorFromSmartServer(err)
 
4200
    else:
 
4201
        raise translator(err)
 
4202
 
 
4203
 
 
4204
error_translators.register('NoSuchRevision',
 
4205
    lambda err, find, get_path: NoSuchRevision(
 
4206
        find('branch'), err.error_args[0]))
 
4207
error_translators.register('nosuchrevision',
 
4208
    lambda err, find, get_path: NoSuchRevision(
 
4209
        find('repository'), err.error_args[0]))
 
4210
 
 
4211
def _translate_nobranch_error(err, find, get_path):
 
4212
    if len(err.error_args) >= 1:
 
4213
        extra = err.error_args[0]
 
4214
    else:
 
4215
        extra = None
 
4216
    return errors.NotBranchError(path=find('bzrdir').root_transport.base,
 
4217
        detail=extra)
 
4218
 
 
4219
error_translators.register('nobranch', _translate_nobranch_error)
 
4220
error_translators.register('norepository',
 
4221
    lambda err, find, get_path: errors.NoRepositoryPresent(
 
4222
        find('bzrdir')))
 
4223
error_translators.register('UnlockableTransport',
 
4224
    lambda err, find, get_path: errors.UnlockableTransport(
 
4225
        find('bzrdir').root_transport))
 
4226
error_translators.register('TokenMismatch',
 
4227
    lambda err, find, get_path: errors.TokenMismatch(
 
4228
        find('token'), '(remote token)'))
 
4229
error_translators.register('Diverged',
 
4230
    lambda err, find, get_path: errors.DivergedBranches(
 
4231
        find('branch'), find('other_branch')))
 
4232
error_translators.register('NotStacked',
 
4233
    lambda err, find, get_path: errors.NotStacked(branch=find('branch')))
 
4234
 
 
4235
def _translate_PermissionDenied(err, find, get_path):
 
4236
    path = get_path()
 
4237
    if len(err.error_args) >= 2:
 
4238
        extra = err.error_args[1]
 
4239
    else:
 
4240
        extra = None
 
4241
    return errors.PermissionDenied(path, extra=extra)
 
4242
 
 
4243
error_translators.register('PermissionDenied', _translate_PermissionDenied)
 
4244
error_translators.register('ReadError',
 
4245
    lambda err, find, get_path: errors.ReadError(get_path()))
 
4246
error_translators.register('NoSuchFile',
 
4247
    lambda err, find, get_path: errors.NoSuchFile(get_path()))
 
4248
error_translators.register('TokenLockingNotSupported',
 
4249
    lambda err, find, get_path: errors.TokenLockingNotSupported(
 
4250
        find('repository')))
 
4251
error_translators.register('UnsuspendableWriteGroup',
 
4252
    lambda err, find, get_path: errors.UnsuspendableWriteGroup(
 
4253
        repository=find('repository')))
 
4254
error_translators.register('UnresumableWriteGroup',
 
4255
    lambda err, find, get_path: errors.UnresumableWriteGroup(
 
4256
        repository=find('repository'), write_groups=err.error_args[0],
 
4257
        reason=err.error_args[1]))
 
4258
no_context_error_translators.register('IncompatibleRepositories',
 
4259
    lambda err: errors.IncompatibleRepositories(
 
4260
        err.error_args[0], err.error_args[1], err.error_args[2]))
 
4261
no_context_error_translators.register('LockContention',
 
4262
    lambda err: errors.LockContention('(remote lock)'))
 
4263
no_context_error_translators.register('LockFailed',
 
4264
    lambda err: errors.LockFailed(err.error_args[0], err.error_args[1]))
 
4265
no_context_error_translators.register('TipChangeRejected',
 
4266
    lambda err: errors.TipChangeRejected(err.error_args[0].decode('utf8')))
 
4267
no_context_error_translators.register('UnstackableBranchFormat',
 
4268
    lambda err: errors.UnstackableBranchFormat(*err.error_args))
 
4269
no_context_error_translators.register('UnstackableRepositoryFormat',
 
4270
    lambda err: errors.UnstackableRepositoryFormat(*err.error_args))
 
4271
no_context_error_translators.register('FileExists',
 
4272
    lambda err: errors.FileExists(err.error_args[0]))
 
4273
no_context_error_translators.register('DirectoryNotEmpty',
 
4274
    lambda err: errors.DirectoryNotEmpty(err.error_args[0]))
 
4275
 
 
4276
def _translate_short_readv_error(err):
 
4277
    args = err.error_args
 
4278
    return errors.ShortReadvError(args[0], int(args[1]), int(args[2]),
 
4279
        int(args[3]))
 
4280
 
 
4281
no_context_error_translators.register('ShortReadvError',
 
4282
    _translate_short_readv_error)
 
4283
 
 
4284
def _translate_unicode_error(err):
2870
4285
        encoding = str(err.error_args[0]) # encoding must always be a string
2871
4286
        val = err.error_args[1]
2872
4287
        start = int(err.error_args[2])
2880
4295
            raise UnicodeDecodeError(encoding, val, start, end, reason)
2881
4296
        elif err.error_verb == 'UnicodeEncodeError':
2882
4297
            raise UnicodeEncodeError(encoding, val, start, end, reason)
2883
 
    elif err.error_verb == 'ReadOnlyError':
2884
 
        raise errors.TransportNotPossible('readonly transport')
2885
 
    raise errors.UnknownErrorFromSmartServer(err)
 
4298
 
 
4299
no_context_error_translators.register('UnicodeEncodeError',
 
4300
    _translate_unicode_error)
 
4301
no_context_error_translators.register('UnicodeDecodeError',
 
4302
    _translate_unicode_error)
 
4303
no_context_error_translators.register('ReadOnlyError',
 
4304
    lambda err: errors.TransportNotPossible('readonly transport'))
 
4305
no_context_error_translators.register('MemoryError',
 
4306
    lambda err: errors.BzrError("remote server out of memory\n"
 
4307
        "Retry non-remotely, or contact the server admin for details."))
 
4308
no_context_error_translators.register('RevisionNotPresent',
 
4309
    lambda err: errors.RevisionNotPresent(err.error_args[0], err.error_args[1]))
 
4310
 
 
4311
no_context_error_translators.register('BzrCheckError',
 
4312
    lambda err: errors.BzrCheckError(msg=err.error_args[0]))
 
4313