~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

(gz) Remove bzrlib/util/elementtree/ package (Martin Packman)

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
25
    bzrdir as _mod_bzrdir,
23
 
    config,
 
26
    config as _mod_config,
24
27
    controldir,
25
28
    debug,
26
29
    errors,
 
30
    gpg,
27
31
    graph,
 
32
    inventory_delta,
28
33
    lock,
29
34
    lockdir,
 
35
    osutils,
 
36
    registry,
30
37
    repository as _mod_repository,
31
38
    revision as _mod_revision,
32
39
    static_tuple,
33
40
    symbol_versioning,
 
41
    testament as _mod_testament,
34
42
    urlutils,
35
 
    versionedfile,
36
43
    vf_repository,
 
44
    vf_search,
37
45
    )
38
46
from bzrlib.branch import BranchReferenceFormat, BranchWriteLockResult
39
47
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
41
49
    NoSuchRevision,
42
50
    SmartProtocolError,
43
51
    )
 
52
from bzrlib.i18n import gettext
 
53
from bzrlib.inventory import Inventory
44
54
from bzrlib.lockable_files import LockableFiles
45
55
from bzrlib.smart import client, vfs, repository as smart_repo
46
56
from bzrlib.smart.client import _SmartClient
47
57
from bzrlib.revision import NULL_REVISION
 
58
from bzrlib.revisiontree import InventoryRevisionTree
48
59
from bzrlib.repository import RepositoryWriteLockResult, _LazyListJoin
49
 
from bzrlib.trace import mutter, note, warning
 
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 ChunkedContentFactory, FulltextContentFactory
 
63
 
 
64
 
 
65
_DEFAULT_SEARCH_DEPTH = 100
50
66
 
51
67
 
52
68
class _RpcHelper(object):
111
127
 
112
128
    def get_format_description(self):
113
129
        if self._network_name:
114
 
            real_format = controldir.network_format_registry.get(self._network_name)
115
 
            return 'Remote: ' + real_format.get_format_description()
 
130
            try:
 
131
                real_format = controldir.network_format_registry.get(
 
132
                        self._network_name)
 
133
            except KeyError:
 
134
                pass
 
135
            else:
 
136
                return 'Remote: ' + real_format.get_format_description()
116
137
        return 'bzr remote bzrdir'
117
138
 
118
139
    def get_format_string(self):
328
349
        _mod_bzrdir.BzrDirMetaFormat1._set_repository_format) #.im_func)
329
350
 
330
351
 
 
352
class RemoteControlStore(_mod_config.IniFileStore):
 
353
    """Control store which attempts to use HPSS calls to retrieve control store.
 
354
 
 
355
    Note that this is specific to bzr-based formats.
 
356
    """
 
357
 
 
358
    def __init__(self, bzrdir):
 
359
        super(RemoteControlStore, self).__init__()
 
360
        self.bzrdir = bzrdir
 
361
        self._real_store = None
 
362
 
 
363
    def lock_write(self, token=None):
 
364
        self._ensure_real()
 
365
        return self._real_store.lock_write(token)
 
366
 
 
367
    def unlock(self):
 
368
        self._ensure_real()
 
369
        return self._real_store.unlock()
 
370
 
 
371
    @needs_write_lock
 
372
    def save(self):
 
373
        # We need to be able to override the undecorated implementation
 
374
        self.save_without_locking()
 
375
 
 
376
    def save_without_locking(self):
 
377
        super(RemoteControlStore, self).save()
 
378
 
 
379
    def _ensure_real(self):
 
380
        self.bzrdir._ensure_real()
 
381
        if self._real_store is None:
 
382
            self._real_store = _mod_config.ControlStore(self.bzrdir)
 
383
 
 
384
    def external_url(self):
 
385
        return self.bzrdir.user_url
 
386
 
 
387
    def _load_content(self):
 
388
        medium = self.bzrdir._client._medium
 
389
        path = self.bzrdir._path_for_remote_call(self.bzrdir._client)
 
390
        try:
 
391
            response, handler = self.bzrdir._call_expecting_body(
 
392
                'BzrDir.get_config_file', path)
 
393
        except errors.UnknownSmartMethod:
 
394
            self._ensure_real()
 
395
            return self._real_store._load_content()
 
396
        if len(response) and response[0] != 'ok':
 
397
            raise errors.UnexpectedSmartServerResponse(response)
 
398
        return handler.read_body_bytes()
 
399
 
 
400
    def _save_content(self, content):
 
401
        # FIXME JRV 2011-11-22: Ideally this should use a
 
402
        # HPSS call too, but at the moment it is not possible
 
403
        # to write lock control directories.
 
404
        self._ensure_real()
 
405
        return self._real_store._save_content(content)
 
406
 
 
407
 
331
408
class RemoteBzrDir(_mod_bzrdir.BzrDir, _RpcHelper):
332
409
    """Control directory on a remote server, accessed via bzr:// or similar."""
333
410
 
404
481
                warning('VFS BzrDir access triggered\n%s',
405
482
                    ''.join(traceback.format_stack()))
406
483
            self._real_bzrdir = _mod_bzrdir.BzrDir.open_from_transport(
407
 
                self.root_transport, _server_formats=False)
 
484
                self.root_transport, probers=[_mod_bzrdir.BzrProber])
408
485
            self._format._network_name = \
409
486
                self._real_bzrdir._format.network_name()
410
487
 
417
494
        self._next_open_branch_result = None
418
495
        return _mod_bzrdir.BzrDir.break_lock(self)
419
496
 
 
497
    def _vfs_checkout_metadir(self):
 
498
        self._ensure_real()
 
499
        return self._real_bzrdir.checkout_metadir()
 
500
 
 
501
    def checkout_metadir(self):
 
502
        """Retrieve the controldir format to use for checkouts of this one.
 
503
        """
 
504
        medium = self._client._medium
 
505
        if medium._is_remote_before((2, 5)):
 
506
            return self._vfs_checkout_metadir()
 
507
        path = self._path_for_remote_call(self._client)
 
508
        try:
 
509
            response = self._client.call('BzrDir.checkout_metadir',
 
510
                path)
 
511
        except errors.UnknownSmartMethod:
 
512
            medium._remember_remote_is_before((2, 5))
 
513
            return self._vfs_checkout_metadir()
 
514
        if len(response) != 3:
 
515
            raise errors.UnexpectedSmartServerResponse(response)
 
516
        control_name, repo_name, branch_name = response
 
517
        try:
 
518
            format = controldir.network_format_registry.get(control_name)
 
519
        except KeyError:
 
520
            raise errors.UnknownFormatError(kind='control',
 
521
                format=control_name)
 
522
        if repo_name:
 
523
            try:
 
524
                repo_format = _mod_repository.network_format_registry.get(
 
525
                    repo_name)
 
526
            except KeyError:
 
527
                raise errors.UnknownFormatError(kind='repository',
 
528
                    format=repo_name)
 
529
            format.repository_format = repo_format
 
530
        if branch_name:
 
531
            try:
 
532
                format.set_branch_format(
 
533
                    branch.network_format_registry.get(branch_name))
 
534
            except KeyError:
 
535
                raise errors.UnknownFormatError(kind='branch',
 
536
                    format=branch_name)
 
537
        return format
 
538
 
420
539
    def _vfs_cloning_metadir(self, require_stacking=False):
421
540
        self._ensure_real()
422
541
        return self._real_bzrdir.cloning_metadir(
452
571
        if len(branch_info) != 2:
453
572
            raise errors.UnexpectedSmartServerResponse(response)
454
573
        branch_ref, branch_name = branch_info
455
 
        format = controldir.network_format_registry.get(control_name)
 
574
        try:
 
575
            format = controldir.network_format_registry.get(control_name)
 
576
        except KeyError:
 
577
            raise errors.UnknownFormatError(kind='control', format=control_name)
 
578
 
456
579
        if repo_name:
457
 
            format.repository_format = _mod_repository.network_format_registry.get(
458
 
                repo_name)
 
580
            try:
 
581
                format.repository_format = _mod_repository.network_format_registry.get(
 
582
                    repo_name)
 
583
            except KeyError:
 
584
                raise errors.UnknownFormatError(kind='repository',
 
585
                    format=repo_name)
459
586
        if branch_ref == 'ref':
460
587
            # XXX: we need possible_transports here to avoid reopening the
461
588
            # connection to the referenced location
464
591
            format.set_branch_format(branch_format)
465
592
        elif branch_ref == 'branch':
466
593
            if branch_name:
467
 
                format.set_branch_format(
468
 
                    branch.network_format_registry.get(branch_name))
 
594
                try:
 
595
                    branch_format = branch.network_format_registry.get(
 
596
                        branch_name)
 
597
                except KeyError:
 
598
                    raise errors.UnknownFormatError(kind='branch',
 
599
                        format=branch_name)
 
600
                format.set_branch_format(branch_format)
469
601
        else:
470
602
            raise errors.UnexpectedSmartServerResponse(response)
471
603
        return format
481
613
 
482
614
    def destroy_repository(self):
483
615
        """See BzrDir.destroy_repository"""
484
 
        self._ensure_real()
485
 
        self._real_bzrdir.destroy_repository()
 
616
        path = self._path_for_remote_call(self._client)
 
617
        try:
 
618
            response = self._call('BzrDir.destroy_repository', path)
 
619
        except errors.UnknownSmartMethod:
 
620
            self._ensure_real()
 
621
            self._real_bzrdir.destroy_repository()
 
622
            return
 
623
        if response[0] != 'ok':
 
624
            raise SmartProtocolError('unexpected response code %s' % (response,))
486
625
 
487
 
    def create_branch(self, name=None, repository=None):
 
626
    def create_branch(self, name=None, repository=None,
 
627
                      append_revisions_only=None):
488
628
        # as per meta1 formats - just delegate to the format object which may
489
629
        # be parameterised.
490
630
        real_branch = self._format.get_branch_format().initialize(self,
491
 
            name=name, repository=repository)
 
631
            name=name, repository=repository,
 
632
            append_revisions_only=append_revisions_only)
492
633
        if not isinstance(real_branch, RemoteBranch):
493
634
            if not isinstance(repository, RemoteRepository):
494
635
                raise AssertionError(
508
649
 
509
650
    def destroy_branch(self, name=None):
510
651
        """See BzrDir.destroy_branch"""
511
 
        self._ensure_real()
512
 
        self._real_bzrdir.destroy_branch(name=name)
 
652
        path = self._path_for_remote_call(self._client)
 
653
        try:
 
654
            if name is not None:
 
655
                args = (name, )
 
656
            else:
 
657
                args = ()
 
658
            response = self._call('BzrDir.destroy_branch', path, *args)
 
659
        except errors.UnknownSmartMethod:
 
660
            self._ensure_real()
 
661
            self._real_bzrdir.destroy_branch(name=name)
 
662
            self._next_open_branch_result = None
 
663
            return
513
664
        self._next_open_branch_result = None
 
665
        if response[0] != 'ok':
 
666
            raise SmartProtocolError('unexpected response code %s' % (response,))
514
667
 
515
668
    def create_workingtree(self, revision_id=None, from_branch=None,
516
669
        accelerator_tree=None, hardlink=False):
570
723
        return None, self.open_branch(name=name)
571
724
 
572
725
    def open_branch(self, name=None, unsupported=False,
573
 
                    ignore_fallbacks=False):
 
726
                    ignore_fallbacks=False, possible_transports=None):
574
727
        if unsupported:
575
728
            raise NotImplementedError('unsupported flag support not implemented yet.')
576
729
        if self._next_open_branch_result is not None:
583
736
            # a branch reference, use the existing BranchReference logic.
584
737
            format = BranchReferenceFormat()
585
738
            return format.open(self, name=name, _found=True,
586
 
                location=response[1], ignore_fallbacks=ignore_fallbacks)
 
739
                location=response[1], ignore_fallbacks=ignore_fallbacks,
 
740
                possible_transports=possible_transports)
587
741
        branch_format_name = response[1]
588
742
        if not branch_format_name:
589
743
            branch_format_name = None
590
744
        format = RemoteBranchFormat(network_name=branch_format_name)
591
745
        return RemoteBranch(self, self.find_repository(), format=format,
592
 
            setup_stacking=not ignore_fallbacks, name=name)
 
746
            setup_stacking=not ignore_fallbacks, name=name,
 
747
            possible_transports=possible_transports)
593
748
 
594
749
    def _open_repo_v1(self, path):
595
750
        verb = 'BzrDir.find_repository'
658
813
 
659
814
    def has_workingtree(self):
660
815
        if self._has_working_tree is None:
661
 
            self._ensure_real()
662
 
            self._has_working_tree = self._real_bzrdir.has_workingtree()
 
816
            path = self._path_for_remote_call(self._client)
 
817
            try:
 
818
                response = self._call('BzrDir.has_workingtree', path)
 
819
            except errors.UnknownSmartMethod:
 
820
                self._ensure_real()
 
821
                self._has_working_tree = self._real_bzrdir.has_workingtree()
 
822
            else:
 
823
                if response[0] not in ('yes', 'no'):
 
824
                    raise SmartProtocolError('unexpected response code %s' % (response,))
 
825
                self._has_working_tree = (response[0] == 'yes')
663
826
        return self._has_working_tree
664
827
 
665
828
    def open_workingtree(self, recommend_upgrade=True):
670
833
 
671
834
    def _path_for_remote_call(self, client):
672
835
        """Return the path to be used for this bzrdir in a remote call."""
673
 
        return client.remote_path_from_transport(self.root_transport)
 
836
        return urlutils.split_segment_parameters_raw(
 
837
            client.remote_path_from_transport(self.root_transport))[0]
674
838
 
675
839
    def get_branch_transport(self, branch_format, name=None):
676
840
        self._ensure_real()
692
856
        """Upgrading of remote bzrdirs is not supported yet."""
693
857
        return False
694
858
 
695
 
    def clone(self, url, revision_id=None, force_new_repo=False,
696
 
              preserve_stacking=False):
697
 
        self._ensure_real()
698
 
        return self._real_bzrdir.clone(url, revision_id=revision_id,
699
 
            force_new_repo=force_new_repo, preserve_stacking=preserve_stacking)
700
 
 
701
859
    def _get_config(self):
702
860
        return RemoteBzrDirConfig(self)
703
861
 
 
862
    def _get_config_store(self):
 
863
        return RemoteControlStore(self)
 
864
 
704
865
 
705
866
class RemoteRepositoryFormat(vf_repository.VersionedFileRepositoryFormat):
706
867
    """Format for repositories accessed over a _SmartClient.
736
897
        self._supports_external_lookups = None
737
898
        self._supports_tree_reference = None
738
899
        self._supports_funky_characters = None
 
900
        self._supports_nesting_repositories = None
739
901
        self._rich_root_data = None
740
902
 
741
903
    def __repr__(self):
778
940
        return self._supports_funky_characters
779
941
 
780
942
    @property
 
943
    def supports_nesting_repositories(self):
 
944
        if self._supports_nesting_repositories is None:
 
945
            self._ensure_real()
 
946
            self._supports_nesting_repositories = \
 
947
                self._custom_format.supports_nesting_repositories
 
948
        return self._supports_nesting_repositories
 
949
 
 
950
    @property
781
951
    def supports_tree_reference(self):
782
952
        if self._supports_tree_reference is None:
783
953
            self._ensure_real()
865
1035
 
866
1036
    def _ensure_real(self):
867
1037
        if self._custom_format is None:
868
 
            self._custom_format = _mod_repository.network_format_registry.get(
869
 
                self._network_name)
 
1038
            try:
 
1039
                self._custom_format = _mod_repository.network_format_registry.get(
 
1040
                    self._network_name)
 
1041
            except KeyError:
 
1042
                raise errors.UnknownFormatError(kind='repository',
 
1043
                    format=self._network_name)
870
1044
 
871
1045
    @property
872
1046
    def _fetch_order(self):
907
1081
        return self._custom_format._serializer
908
1082
 
909
1083
 
910
 
class RemoteRepository(_RpcHelper, lock._RelockDebugMixin,
911
 
    controldir.ControlComponent):
 
1084
class RemoteRepository(_mod_repository.Repository, _RpcHelper,
 
1085
        lock._RelockDebugMixin):
912
1086
    """Repository accessed over rpc.
913
1087
 
914
1088
    For the moment most operations are performed using local transport-backed
938
1112
        self._format = format
939
1113
        self._lock_mode = None
940
1114
        self._lock_token = None
 
1115
        self._write_group_tokens = None
941
1116
        self._lock_count = 0
942
1117
        self._leave_lock = False
943
1118
        # Cache of revision parents; misses are cached during read locks, and
983
1158
 
984
1159
        :param suppress_errors: see Repository.abort_write_group.
985
1160
        """
986
 
        self._ensure_real()
987
 
        return self._real_repository.abort_write_group(
988
 
            suppress_errors=suppress_errors)
 
1161
        if self._real_repository:
 
1162
            self._ensure_real()
 
1163
            return self._real_repository.abort_write_group(
 
1164
                suppress_errors=suppress_errors)
 
1165
        if not self.is_in_write_group():
 
1166
            if suppress_errors:
 
1167
                mutter('(suppressed) not in write group')
 
1168
                return
 
1169
            raise errors.BzrError("not in write group")
 
1170
        path = self.bzrdir._path_for_remote_call(self._client)
 
1171
        try:
 
1172
            response = self._call('Repository.abort_write_group', path,
 
1173
                self._lock_token, self._write_group_tokens)
 
1174
        except Exception, exc:
 
1175
            self._write_group = None
 
1176
            if not suppress_errors:
 
1177
                raise
 
1178
            mutter('abort_write_group failed')
 
1179
            log_exception_quietly()
 
1180
            note(gettext('bzr: ERROR (ignored): %s'), exc)
 
1181
        else:
 
1182
            if response != ('ok', ):
 
1183
                raise errors.UnexpectedSmartServerResponse(response)
 
1184
            self._write_group_tokens = None
989
1185
 
990
1186
    @property
991
1187
    def chk_bytes(self):
1005
1201
        for older plugins that don't use e.g. the CommitBuilder
1006
1202
        facility.
1007
1203
        """
1008
 
        self._ensure_real()
1009
 
        return self._real_repository.commit_write_group()
 
1204
        if self._real_repository:
 
1205
            self._ensure_real()
 
1206
            return self._real_repository.commit_write_group()
 
1207
        if not self.is_in_write_group():
 
1208
            raise errors.BzrError("not in write group")
 
1209
        path = self.bzrdir._path_for_remote_call(self._client)
 
1210
        response = self._call('Repository.commit_write_group', path,
 
1211
            self._lock_token, self._write_group_tokens)
 
1212
        if response != ('ok', ):
 
1213
            raise errors.UnexpectedSmartServerResponse(response)
 
1214
        self._write_group_tokens = None
 
1215
        # Refresh data after writing to the repository.
 
1216
        self.refresh_data()
1010
1217
 
1011
1218
    def resume_write_group(self, tokens):
1012
 
        self._ensure_real()
1013
 
        return self._real_repository.resume_write_group(tokens)
 
1219
        if self._real_repository:
 
1220
            return self._real_repository.resume_write_group(tokens)
 
1221
        path = self.bzrdir._path_for_remote_call(self._client)
 
1222
        try:
 
1223
            response = self._call('Repository.check_write_group', path,
 
1224
               self._lock_token, tokens)
 
1225
        except errors.UnknownSmartMethod:
 
1226
            self._ensure_real()
 
1227
            return self._real_repository.resume_write_group(tokens)
 
1228
        if response != ('ok', ):
 
1229
            raise errors.UnexpectedSmartServerResponse(response)
 
1230
        self._write_group_tokens = tokens
1014
1231
 
1015
1232
    def suspend_write_group(self):
1016
 
        self._ensure_real()
1017
 
        return self._real_repository.suspend_write_group()
 
1233
        if self._real_repository:
 
1234
            return self._real_repository.suspend_write_group()
 
1235
        ret = self._write_group_tokens or []
 
1236
        self._write_group_tokens = None
 
1237
        return ret
1018
1238
 
1019
1239
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
1020
1240
        self._ensure_real()
1230
1450
 
1231
1451
    def get_physical_lock_status(self):
1232
1452
        """See Repository.get_physical_lock_status()."""
1233
 
        # should be an API call to the server.
1234
 
        self._ensure_real()
1235
 
        return self._real_repository.get_physical_lock_status()
 
1453
        path = self.bzrdir._path_for_remote_call(self._client)
 
1454
        try:
 
1455
            response = self._call('Repository.get_physical_lock_status', path)
 
1456
        except errors.UnknownSmartMethod:
 
1457
            self._ensure_real()
 
1458
            return self._real_repository.get_physical_lock_status()
 
1459
        if response[0] not in ('yes', 'no'):
 
1460
            raise errors.UnexpectedSmartServerResponse(response)
 
1461
        return (response[0] == 'yes')
1236
1462
 
1237
1463
    def is_in_write_group(self):
1238
1464
        """Return True if there is an open write group.
1239
1465
 
1240
1466
        write groups are only applicable locally for the smart server..
1241
1467
        """
 
1468
        if self._write_group_tokens is not None:
 
1469
            return True
1242
1470
        if self._real_repository:
1243
1471
            return self._real_repository.is_in_write_group()
1244
1472
 
1379
1607
            self._real_repository.lock_write(self._lock_token)
1380
1608
        elif self._lock_mode == 'r':
1381
1609
            self._real_repository.lock_read()
 
1610
        if self._write_group_tokens is not None:
 
1611
            # if we are already in a write group, resume it
 
1612
            self._real_repository.resume_write_group(self._write_group_tokens)
 
1613
            self._write_group_tokens = None
1382
1614
 
1383
1615
    def start_write_group(self):
1384
1616
        """Start a write group on the decorated repository.
1388
1620
        for older plugins that don't use e.g. the CommitBuilder
1389
1621
        facility.
1390
1622
        """
1391
 
        self._ensure_real()
1392
 
        return self._real_repository.start_write_group()
 
1623
        if self._real_repository:
 
1624
            self._ensure_real()
 
1625
            return self._real_repository.start_write_group()
 
1626
        if not self.is_write_locked():
 
1627
            raise errors.NotWriteLocked(self)
 
1628
        if self._write_group_tokens is not None:
 
1629
            raise errors.BzrError('already in a write group')
 
1630
        path = self.bzrdir._path_for_remote_call(self._client)
 
1631
        try:
 
1632
            response = self._call('Repository.start_write_group', path,
 
1633
                self._lock_token)
 
1634
        except (errors.UnknownSmartMethod, errors.UnsuspendableWriteGroup):
 
1635
            self._ensure_real()
 
1636
            return self._real_repository.start_write_group()
 
1637
        if response[0] != 'ok':
 
1638
            raise errors.UnexpectedSmartServerResponse(response)
 
1639
        self._write_group_tokens = response[1]
1393
1640
 
1394
1641
    def _unlock(self, token):
1395
1642
        path = self.bzrdir._path_for_remote_call(self._client)
1422
1669
            # This is just to let the _real_repository stay up to date.
1423
1670
            if self._real_repository is not None:
1424
1671
                self._real_repository.unlock()
 
1672
            elif self._write_group_tokens is not None:
 
1673
                self.abort_write_group()
1425
1674
        finally:
1426
1675
            # The rpc-level lock should be released even if there was a
1427
1676
            # problem releasing the vfs-based lock.
1439
1688
 
1440
1689
    def break_lock(self):
1441
1690
        # should hand off to the network
1442
 
        self._ensure_real()
1443
 
        return self._real_repository.break_lock()
 
1691
        path = self.bzrdir._path_for_remote_call(self._client)
 
1692
        try:
 
1693
            response = self._call("Repository.break_lock", path)
 
1694
        except errors.UnknownSmartMethod:
 
1695
            self._ensure_real()
 
1696
            return self._real_repository.break_lock()
 
1697
        if response != ('ok',):
 
1698
            raise errors.UnexpectedSmartServerResponse(response)
1444
1699
 
1445
1700
    def _get_tarball(self, compression):
1446
1701
        """Return a TemporaryFile containing a repository tarball.
1464
1719
            return t
1465
1720
        raise errors.UnexpectedSmartServerResponse(response)
1466
1721
 
 
1722
    @needs_read_lock
1467
1723
    def sprout(self, to_bzrdir, revision_id=None):
1468
 
        # TODO: Option to control what format is created?
1469
 
        self._ensure_real()
1470
 
        dest_repo = self._real_repository._format.initialize(to_bzrdir,
1471
 
                                                             shared=False)
 
1724
        """Create a descendent repository for new development.
 
1725
 
 
1726
        Unlike clone, this does not copy the settings of the repository.
 
1727
        """
 
1728
        dest_repo = self._create_sprouting_repo(to_bzrdir, shared=False)
1472
1729
        dest_repo.fetch(self, revision_id=revision_id)
1473
1730
        return dest_repo
1474
1731
 
 
1732
    def _create_sprouting_repo(self, a_bzrdir, shared):
 
1733
        if not isinstance(a_bzrdir._format, self.bzrdir._format.__class__):
 
1734
            # use target default format.
 
1735
            dest_repo = a_bzrdir.create_repository()
 
1736
        else:
 
1737
            # Most control formats need the repository to be specifically
 
1738
            # created, but on some old all-in-one formats it's not needed
 
1739
            try:
 
1740
                dest_repo = self._format.initialize(a_bzrdir, shared=shared)
 
1741
            except errors.UninitializableFormat:
 
1742
                dest_repo = a_bzrdir.open_repository()
 
1743
        return dest_repo
 
1744
 
1475
1745
    ### These methods are just thin shims to the VFS object for now.
1476
1746
 
 
1747
    @needs_read_lock
1477
1748
    def revision_tree(self, revision_id):
1478
 
        self._ensure_real()
1479
 
        return self._real_repository.revision_tree(revision_id)
 
1749
        revision_id = _mod_revision.ensure_null(revision_id)
 
1750
        if revision_id == _mod_revision.NULL_REVISION:
 
1751
            return InventoryRevisionTree(self,
 
1752
                Inventory(root_id=None), _mod_revision.NULL_REVISION)
 
1753
        else:
 
1754
            return list(self.revision_trees([revision_id]))[0]
1480
1755
 
1481
1756
    def get_serializer_format(self):
1482
 
        self._ensure_real()
1483
 
        return self._real_repository.get_serializer_format()
 
1757
        path = self.bzrdir._path_for_remote_call(self._client)
 
1758
        try:
 
1759
            response = self._call('VersionedFileRepository.get_serializer_format',
 
1760
                path)
 
1761
        except errors.UnknownSmartMethod:
 
1762
            self._ensure_real()
 
1763
            return self._real_repository.get_serializer_format()
 
1764
        if response[0] != 'ok':
 
1765
            raise errors.UnexpectedSmartServerResponse(response)
 
1766
        return response[1]
1484
1767
 
1485
1768
    def get_commit_builder(self, branch, parents, config, timestamp=None,
1486
1769
                           timezone=None, committer=None, revprops=None,
1487
1770
                           revision_id=None, lossy=False):
1488
 
        # FIXME: It ought to be possible to call this without immediately
1489
 
        # triggering _ensure_real.  For now it's the easiest thing to do.
1490
 
        self._ensure_real()
1491
 
        real_repo = self._real_repository
1492
 
        builder = real_repo.get_commit_builder(branch, parents,
1493
 
                config, timestamp=timestamp, timezone=timezone,
1494
 
                committer=committer, revprops=revprops,
1495
 
                revision_id=revision_id, lossy=lossy)
1496
 
        return builder
 
1771
        """Obtain a CommitBuilder for this repository.
 
1772
 
 
1773
        :param branch: Branch to commit to.
 
1774
        :param parents: Revision ids of the parents of the new revision.
 
1775
        :param config: Configuration to use.
 
1776
        :param timestamp: Optional timestamp recorded for commit.
 
1777
        :param timezone: Optional timezone for timestamp.
 
1778
        :param committer: Optional committer to set for commit.
 
1779
        :param revprops: Optional dictionary of revision properties.
 
1780
        :param revision_id: Optional revision id.
 
1781
        :param lossy: Whether to discard data that can not be natively
 
1782
            represented, when pushing to a foreign VCS
 
1783
        """
 
1784
        if self._fallback_repositories and not self._format.supports_chks:
 
1785
            raise errors.BzrError("Cannot commit directly to a stacked branch"
 
1786
                " in pre-2a formats. See "
 
1787
                "https://bugs.launchpad.net/bzr/+bug/375013 for details.")
 
1788
        if self._format.rich_root_data:
 
1789
            commit_builder_kls = vf_repository.VersionedFileRootCommitBuilder
 
1790
        else:
 
1791
            commit_builder_kls = vf_repository.VersionedFileCommitBuilder
 
1792
        result = commit_builder_kls(self, parents, config,
 
1793
            timestamp, timezone, committer, revprops, revision_id,
 
1794
            lossy)
 
1795
        self.start_write_group()
 
1796
        return result
1497
1797
 
1498
1798
    def add_fallback_repository(self, repository):
1499
1799
        """Add a repository to use for looking up data not held locally.
1506
1806
        # We need to accumulate additional repositories here, to pass them in
1507
1807
        # on various RPC's.
1508
1808
        #
 
1809
        # Make the check before we lock: this raises an exception.
 
1810
        self._check_fallback_repository(repository)
1509
1811
        if self.is_locked():
1510
1812
            # We will call fallback.unlock() when we transition to the unlocked
1511
1813
            # state, so always add a lock here. If a caller passes us a locked
1512
1814
            # repository, they are responsible for unlocking it later.
1513
1815
            repository.lock_read()
1514
 
        self._check_fallback_repository(repository)
1515
1816
        self._fallback_repositories.append(repository)
1516
1817
        # If self._real_repository was parameterised already (e.g. because a
1517
1818
        # _real_branch had its get_stacked_on_url method called), then the
1543
1844
            delta, new_revision_id, parents, basis_inv=basis_inv,
1544
1845
            propagate_caches=propagate_caches)
1545
1846
 
1546
 
    def add_revision(self, rev_id, rev, inv=None, config=None):
1547
 
        self._ensure_real()
1548
 
        return self._real_repository.add_revision(
1549
 
            rev_id, rev, inv=inv, config=config)
 
1847
    def add_revision(self, revision_id, rev, inv=None):
 
1848
        _mod_revision.check_not_reserved_id(revision_id)
 
1849
        key = (revision_id,)
 
1850
        # check inventory present
 
1851
        if not self.inventories.get_parent_map([key]):
 
1852
            if inv is None:
 
1853
                raise errors.WeaveRevisionNotPresent(revision_id,
 
1854
                                                     self.inventories)
 
1855
            else:
 
1856
                # yes, this is not suitable for adding with ghosts.
 
1857
                rev.inventory_sha1 = self.add_inventory(revision_id, inv,
 
1858
                                                        rev.parent_ids)
 
1859
        else:
 
1860
            rev.inventory_sha1 = self.inventories.get_sha1s([key])[key]
 
1861
        self._add_revision(rev)
 
1862
 
 
1863
    def _add_revision(self, rev):
 
1864
        if self._real_repository is not None:
 
1865
            return self._real_repository._add_revision(rev)
 
1866
        text = self._serializer.write_revision_to_string(rev)
 
1867
        key = (rev.revision_id,)
 
1868
        parents = tuple((parent,) for parent in rev.parent_ids)
 
1869
        self._write_group_tokens, missing_keys = self._get_sink().insert_stream(
 
1870
            [('revisions', [FulltextContentFactory(key, parents, None, text)])],
 
1871
            self._format, self._write_group_tokens)
1550
1872
 
1551
1873
    @needs_read_lock
1552
1874
    def get_inventory(self, revision_id):
 
1875
        return list(self.iter_inventories([revision_id]))[0]
 
1876
 
 
1877
    def _iter_inventories_rpc(self, revision_ids, ordering):
 
1878
        if ordering is None:
 
1879
            ordering = 'unordered'
 
1880
        path = self.bzrdir._path_for_remote_call(self._client)
 
1881
        body = "\n".join(revision_ids)
 
1882
        response_tuple, response_handler = (
 
1883
            self._call_with_body_bytes_expecting_body(
 
1884
                "VersionedFileRepository.get_inventories",
 
1885
                (path, ordering), body))
 
1886
        if response_tuple[0] != "ok":
 
1887
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
1888
        deserializer = inventory_delta.InventoryDeltaDeserializer()
 
1889
        byte_stream = response_handler.read_streamed_body()
 
1890
        decoded = smart_repo._byte_stream_to_stream(byte_stream)
 
1891
        if decoded is None:
 
1892
            # no results whatsoever
 
1893
            return
 
1894
        src_format, stream = decoded
 
1895
        if src_format.network_name() != self._format.network_name():
 
1896
            raise AssertionError(
 
1897
                "Mismatched RemoteRepository and stream src %r, %r" % (
 
1898
                src_format.network_name(), self._format.network_name()))
 
1899
        # ignore the src format, it's not really relevant
 
1900
        prev_inv = Inventory(root_id=None,
 
1901
            revision_id=_mod_revision.NULL_REVISION)
 
1902
        # there should be just one substream, with inventory deltas
 
1903
        substream_kind, substream = stream.next()
 
1904
        if substream_kind != "inventory-deltas":
 
1905
            raise AssertionError(
 
1906
                 "Unexpected stream %r received" % substream_kind)
 
1907
        for record in substream:
 
1908
            (parent_id, new_id, versioned_root, tree_references, invdelta) = (
 
1909
                deserializer.parse_text_bytes(record.get_bytes_as("fulltext")))
 
1910
            if parent_id != prev_inv.revision_id:
 
1911
                raise AssertionError("invalid base %r != %r" % (parent_id,
 
1912
                    prev_inv.revision_id))
 
1913
            inv = prev_inv.create_by_apply_delta(invdelta, new_id)
 
1914
            yield inv, inv.revision_id
 
1915
            prev_inv = inv
 
1916
 
 
1917
    def _iter_inventories_vfs(self, revision_ids, ordering=None):
1553
1918
        self._ensure_real()
1554
 
        return self._real_repository.get_inventory(revision_id)
 
1919
        return self._real_repository._iter_inventories(revision_ids, ordering)
1555
1920
 
1556
1921
    def iter_inventories(self, revision_ids, ordering=None):
1557
 
        self._ensure_real()
1558
 
        return self._real_repository.iter_inventories(revision_ids, ordering)
 
1922
        """Get many inventories by revision_ids.
 
1923
 
 
1924
        This will buffer some or all of the texts used in constructing the
 
1925
        inventories in memory, but will only parse a single inventory at a
 
1926
        time.
 
1927
 
 
1928
        :param revision_ids: The expected revision ids of the inventories.
 
1929
        :param ordering: optional ordering, e.g. 'topological'.  If not
 
1930
            specified, the order of revision_ids will be preserved (by
 
1931
            buffering if necessary).
 
1932
        :return: An iterator of inventories.
 
1933
        """
 
1934
        if ((None in revision_ids)
 
1935
            or (_mod_revision.NULL_REVISION in revision_ids)):
 
1936
            raise ValueError('cannot get null revision inventory')
 
1937
        for inv, revid in self._iter_inventories(revision_ids, ordering):
 
1938
            if inv is None:
 
1939
                raise errors.NoSuchRevision(self, revid)
 
1940
            yield inv
 
1941
 
 
1942
    def _iter_inventories(self, revision_ids, ordering=None):
 
1943
        if len(revision_ids) == 0:
 
1944
            return
 
1945
        missing = set(revision_ids)
 
1946
        if ordering is None:
 
1947
            order_as_requested = True
 
1948
            invs = {}
 
1949
            order = list(revision_ids)
 
1950
            order.reverse()
 
1951
            next_revid = order.pop()
 
1952
        else:
 
1953
            order_as_requested = False
 
1954
            if ordering != 'unordered' and self._fallback_repositories:
 
1955
                raise ValueError('unsupported ordering %r' % ordering)
 
1956
        iter_inv_fns = [self._iter_inventories_rpc] + [
 
1957
            fallback._iter_inventories for fallback in
 
1958
            self._fallback_repositories]
 
1959
        try:
 
1960
            for iter_inv in iter_inv_fns:
 
1961
                request = [revid for revid in revision_ids if revid in missing]
 
1962
                for inv, revid in iter_inv(request, ordering):
 
1963
                    if inv is None:
 
1964
                        continue
 
1965
                    missing.remove(inv.revision_id)
 
1966
                    if ordering != 'unordered':
 
1967
                        invs[revid] = inv
 
1968
                    else:
 
1969
                        yield inv, revid
 
1970
                if order_as_requested:
 
1971
                    # Yield as many results as we can while preserving order.
 
1972
                    while next_revid in invs:
 
1973
                        inv = invs.pop(next_revid)
 
1974
                        yield inv, inv.revision_id
 
1975
                        try:
 
1976
                            next_revid = order.pop()
 
1977
                        except IndexError:
 
1978
                            # We still want to fully consume the stream, just
 
1979
                            # in case it is not actually finished at this point
 
1980
                            next_revid = None
 
1981
                            break
 
1982
        except errors.UnknownSmartMethod:
 
1983
            for inv, revid in self._iter_inventories_vfs(revision_ids, ordering):
 
1984
                yield inv, revid
 
1985
            return
 
1986
        # Report missing
 
1987
        if order_as_requested:
 
1988
            if next_revid is not None:
 
1989
                yield None, next_revid
 
1990
            while order:
 
1991
                revid = order.pop()
 
1992
                yield invs.get(revid), revid
 
1993
        else:
 
1994
            while missing:
 
1995
                yield None, missing.pop()
1559
1996
 
1560
1997
    @needs_read_lock
1561
1998
    def get_revision(self, revision_id):
1562
 
        self._ensure_real()
1563
 
        return self._real_repository.get_revision(revision_id)
 
1999
        return self.get_revisions([revision_id])[0]
1564
2000
 
1565
2001
    def get_transaction(self):
1566
2002
        self._ensure_real()
1568
2004
 
1569
2005
    @needs_read_lock
1570
2006
    def clone(self, a_bzrdir, revision_id=None):
1571
 
        self._ensure_real()
1572
 
        return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
 
2007
        dest_repo = self._create_sprouting_repo(
 
2008
            a_bzrdir, shared=self.is_shared())
 
2009
        self.copy_content_into(dest_repo, revision_id)
 
2010
        return dest_repo
1573
2011
 
1574
2012
    def make_working_trees(self):
1575
2013
        """See Repository.make_working_trees"""
1576
 
        self._ensure_real()
1577
 
        return self._real_repository.make_working_trees()
 
2014
        path = self.bzrdir._path_for_remote_call(self._client)
 
2015
        try:
 
2016
            response = self._call('Repository.make_working_trees', path)
 
2017
        except errors.UnknownSmartMethod:
 
2018
            self._ensure_real()
 
2019
            return self._real_repository.make_working_trees()
 
2020
        if response[0] not in ('yes', 'no'):
 
2021
            raise SmartProtocolError('unexpected response code %s' % (response,))
 
2022
        return response[0] == 'yes'
1578
2023
 
1579
2024
    def refresh_data(self):
1580
2025
        """Re-read any data needed to synchronise with disk.
1589
2034
        """
1590
2035
        if self._real_repository is not None:
1591
2036
            self._real_repository.refresh_data()
 
2037
        # Refresh the parents cache for this object
 
2038
        self._unstacked_provider.disable_cache()
 
2039
        self._unstacked_provider.enable_cache()
1592
2040
 
1593
2041
    def revision_ids_to_search_result(self, result_set):
1594
2042
        """Convert a set of revision ids to a graph SearchResult."""
1599
2047
        included_keys = result_set.intersection(result_parents)
1600
2048
        start_keys = result_set.difference(included_keys)
1601
2049
        exclude_keys = result_parents.difference(result_set)
1602
 
        result = graph.SearchResult(start_keys, exclude_keys,
 
2050
        result = vf_search.SearchResult(start_keys, exclude_keys,
1603
2051
            len(result_set), result_set)
1604
2052
        return result
1605
2053
 
1653
2101
        # the InterRepository base class, which raises an
1654
2102
        # IncompatibleRepositories when asked to fetch.
1655
2103
        inter = _mod_repository.InterRepository.get(source, self)
 
2104
        if (fetch_spec is not None and
 
2105
            not getattr(inter, "supports_fetch_spec", False)):
 
2106
            raise errors.UnsupportedOperation(
 
2107
                "fetch_spec not supported for %r" % inter)
1656
2108
        return inter.fetch(revision_id=revision_id,
1657
2109
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
1658
2110
 
1661
2113
        self._real_repository.create_bundle(target, base, fileobj, format)
1662
2114
 
1663
2115
    @needs_read_lock
 
2116
    @symbol_versioning.deprecated_method(
 
2117
        symbol_versioning.deprecated_in((2, 4, 0)))
1664
2118
    def get_ancestry(self, revision_id, topo_sorted=True):
1665
2119
        self._ensure_real()
1666
2120
        return self._real_repository.get_ancestry(revision_id, topo_sorted)
1674
2128
        return self._real_repository._get_versioned_file_checker(
1675
2129
            revisions, revision_versions_cache)
1676
2130
 
 
2131
    def _iter_files_bytes_rpc(self, desired_files, absent):
 
2132
        path = self.bzrdir._path_for_remote_call(self._client)
 
2133
        lines = []
 
2134
        identifiers = []
 
2135
        for (file_id, revid, identifier) in desired_files:
 
2136
            lines.append("%s\0%s" % (
 
2137
                osutils.safe_file_id(file_id),
 
2138
                osutils.safe_revision_id(revid)))
 
2139
            identifiers.append(identifier)
 
2140
        (response_tuple, response_handler) = (
 
2141
            self._call_with_body_bytes_expecting_body(
 
2142
            "Repository.iter_files_bytes", (path, ), "\n".join(lines)))
 
2143
        if response_tuple != ('ok', ):
 
2144
            response_handler.cancel_read_body()
 
2145
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
2146
        byte_stream = response_handler.read_streamed_body()
 
2147
        def decompress_stream(start, byte_stream, unused):
 
2148
            decompressor = zlib.decompressobj()
 
2149
            yield decompressor.decompress(start)
 
2150
            while decompressor.unused_data == "":
 
2151
                try:
 
2152
                    data = byte_stream.next()
 
2153
                except StopIteration:
 
2154
                    break
 
2155
                yield decompressor.decompress(data)
 
2156
            yield decompressor.flush()
 
2157
            unused.append(decompressor.unused_data)
 
2158
        unused = ""
 
2159
        while True:
 
2160
            while not "\n" in unused:
 
2161
                unused += byte_stream.next()
 
2162
            header, rest = unused.split("\n", 1)
 
2163
            args = header.split("\0")
 
2164
            if args[0] == "absent":
 
2165
                absent[identifiers[int(args[3])]] = (args[1], args[2])
 
2166
                unused = rest
 
2167
                continue
 
2168
            elif args[0] == "ok":
 
2169
                idx = int(args[1])
 
2170
            else:
 
2171
                raise errors.UnexpectedSmartServerResponse(args)
 
2172
            unused_chunks = []
 
2173
            yield (identifiers[idx],
 
2174
                decompress_stream(rest, byte_stream, unused_chunks))
 
2175
            unused = "".join(unused_chunks)
 
2176
 
1677
2177
    def iter_files_bytes(self, desired_files):
1678
2178
        """See Repository.iter_file_bytes.
1679
2179
        """
1680
 
        self._ensure_real()
1681
 
        return self._real_repository.iter_files_bytes(desired_files)
 
2180
        try:
 
2181
            absent = {}
 
2182
            for (identifier, bytes_iterator) in self._iter_files_bytes_rpc(
 
2183
                    desired_files, absent):
 
2184
                yield identifier, bytes_iterator
 
2185
            for fallback in self._fallback_repositories:
 
2186
                if not absent:
 
2187
                    break
 
2188
                desired_files = [(key[0], key[1], identifier) for
 
2189
                    (identifier, key) in absent.iteritems()]
 
2190
                for (identifier, bytes_iterator) in fallback.iter_files_bytes(desired_files):
 
2191
                    del absent[identifier]
 
2192
                    yield identifier, bytes_iterator
 
2193
            if absent:
 
2194
                # There may be more missing items, but raise an exception
 
2195
                # for just one.
 
2196
                missing_identifier = absent.keys()[0]
 
2197
                missing_key = absent[missing_identifier]
 
2198
                raise errors.RevisionNotPresent(revision_id=missing_key[1],
 
2199
                    file_id=missing_key[0])
 
2200
        except errors.UnknownSmartMethod:
 
2201
            self._ensure_real()
 
2202
            for (identifier, bytes_iterator) in (
 
2203
                self._real_repository.iter_files_bytes(desired_files)):
 
2204
                yield identifier, bytes_iterator
 
2205
 
 
2206
    def get_cached_parent_map(self, revision_ids):
 
2207
        """See bzrlib.CachingParentsProvider.get_cached_parent_map"""
 
2208
        return self._unstacked_provider.get_cached_parent_map(revision_ids)
1682
2209
 
1683
2210
    def get_parent_map(self, revision_ids):
1684
2211
        """See bzrlib.Graph.get_parent_map()."""
1743
2270
        if parents_map is None:
1744
2271
            # Repository is not locked, so there's no cache.
1745
2272
            parents_map = {}
1746
 
        # start_set is all the keys in the cache
1747
 
        start_set = set(parents_map)
1748
 
        # result set is all the references to keys in the cache
1749
 
        result_parents = set()
1750
 
        for parents in parents_map.itervalues():
1751
 
            result_parents.update(parents)
1752
 
        stop_keys = result_parents.difference(start_set)
1753
 
        # We don't need to send ghosts back to the server as a position to
1754
 
        # stop either.
1755
 
        stop_keys.difference_update(self._unstacked_provider.missing_keys)
1756
 
        key_count = len(parents_map)
1757
 
        if (NULL_REVISION in result_parents
1758
 
            and NULL_REVISION in self._unstacked_provider.missing_keys):
1759
 
            # If we pruned NULL_REVISION from the stop_keys because it's also
1760
 
            # in our cache of "missing" keys we need to increment our key count
1761
 
            # by 1, because the reconsitituted SearchResult on the server will
1762
 
            # still consider NULL_REVISION to be an included key.
1763
 
            key_count += 1
1764
 
        included_keys = start_set.intersection(result_parents)
1765
 
        start_set.difference_update(included_keys)
 
2273
        if _DEFAULT_SEARCH_DEPTH <= 0:
 
2274
            (start_set, stop_keys,
 
2275
             key_count) = vf_search.search_result_from_parent_map(
 
2276
                parents_map, self._unstacked_provider.missing_keys)
 
2277
        else:
 
2278
            (start_set, stop_keys,
 
2279
             key_count) = vf_search.limited_search_result_from_parent_map(
 
2280
                parents_map, self._unstacked_provider.missing_keys,
 
2281
                keys, depth=_DEFAULT_SEARCH_DEPTH)
1766
2282
        recipe = ('manual', start_set, stop_keys, key_count)
1767
2283
        body = self._serialise_search_recipe(recipe)
1768
2284
        path = self.bzrdir._path_for_remote_call(self._client)
1817
2333
 
1818
2334
    @needs_read_lock
1819
2335
    def get_signature_text(self, revision_id):
1820
 
        self._ensure_real()
1821
 
        return self._real_repository.get_signature_text(revision_id)
 
2336
        path = self.bzrdir._path_for_remote_call(self._client)
 
2337
        try:
 
2338
            response_tuple, response_handler = self._call_expecting_body(
 
2339
                'Repository.get_revision_signature_text', path, revision_id)
 
2340
        except errors.UnknownSmartMethod:
 
2341
            self._ensure_real()
 
2342
            return self._real_repository.get_signature_text(revision_id)
 
2343
        except errors.NoSuchRevision, err:
 
2344
            for fallback in self._fallback_repositories:
 
2345
                try:
 
2346
                    return fallback.get_signature_text(revision_id)
 
2347
                except errors.NoSuchRevision:
 
2348
                    pass
 
2349
            raise err
 
2350
        else:
 
2351
            if response_tuple[0] != 'ok':
 
2352
                raise errors.UnexpectedSmartServerResponse(response_tuple)
 
2353
            return response_handler.read_body_bytes()
1822
2354
 
1823
2355
    @needs_read_lock
1824
2356
    def _get_inventory_xml(self, revision_id):
 
2357
        # This call is used by older working tree formats,
 
2358
        # which stored a serialized basis inventory.
1825
2359
        self._ensure_real()
1826
2360
        return self._real_repository._get_inventory_xml(revision_id)
1827
2361
 
 
2362
    @needs_write_lock
1828
2363
    def reconcile(self, other=None, thorough=False):
1829
 
        self._ensure_real()
1830
 
        return self._real_repository.reconcile(other=other, thorough=thorough)
 
2364
        from bzrlib.reconcile import RepoReconciler
 
2365
        path = self.bzrdir._path_for_remote_call(self._client)
 
2366
        try:
 
2367
            response, handler = self._call_expecting_body(
 
2368
                'Repository.reconcile', path, self._lock_token)
 
2369
        except (errors.UnknownSmartMethod, errors.TokenLockingNotSupported):
 
2370
            self._ensure_real()
 
2371
            return self._real_repository.reconcile(other=other, thorough=thorough)
 
2372
        if response != ('ok', ):
 
2373
            raise errors.UnexpectedSmartServerResponse(response)
 
2374
        body = handler.read_body_bytes()
 
2375
        result = RepoReconciler(self)
 
2376
        for line in body.split('\n'):
 
2377
            if not line:
 
2378
                continue
 
2379
            key, val_text = line.split(':')
 
2380
            if key == "garbage_inventories":
 
2381
                result.garbage_inventories = int(val_text)
 
2382
            elif key == "inconsistent_parents":
 
2383
                result.inconsistent_parents = int(val_text)
 
2384
            else:
 
2385
                mutter("unknown reconcile key %r" % key)
 
2386
        return result
1831
2387
 
1832
2388
    def all_revision_ids(self):
1833
 
        self._ensure_real()
1834
 
        return self._real_repository.all_revision_ids()
 
2389
        path = self.bzrdir._path_for_remote_call(self._client)
 
2390
        try:
 
2391
            response_tuple, response_handler = self._call_expecting_body(
 
2392
                "Repository.all_revision_ids", path)
 
2393
        except errors.UnknownSmartMethod:
 
2394
            self._ensure_real()
 
2395
            return self._real_repository.all_revision_ids()
 
2396
        if response_tuple != ("ok", ):
 
2397
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
2398
        revids = set(response_handler.read_body_bytes().splitlines())
 
2399
        for fallback in self._fallback_repositories:
 
2400
            revids.update(set(fallback.all_revision_ids()))
 
2401
        return list(revids)
 
2402
 
 
2403
    def _filtered_revision_trees(self, revision_ids, file_ids):
 
2404
        """Return Tree for a revision on this branch with only some files.
 
2405
 
 
2406
        :param revision_ids: a sequence of revision-ids;
 
2407
          a revision-id may not be None or 'null:'
 
2408
        :param file_ids: if not None, the result is filtered
 
2409
          so that only those file-ids, their parents and their
 
2410
          children are included.
 
2411
        """
 
2412
        inventories = self.iter_inventories(revision_ids)
 
2413
        for inv in inventories:
 
2414
            # Should we introduce a FilteredRevisionTree class rather
 
2415
            # than pre-filter the inventory here?
 
2416
            filtered_inv = inv.filter(file_ids)
 
2417
            yield InventoryRevisionTree(self, filtered_inv, filtered_inv.revision_id)
1835
2418
 
1836
2419
    @needs_read_lock
1837
2420
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1838
 
        self._ensure_real()
1839
 
        return self._real_repository.get_deltas_for_revisions(revisions,
1840
 
            specific_fileids=specific_fileids)
 
2421
        medium = self._client._medium
 
2422
        if medium._is_remote_before((1, 2)):
 
2423
            self._ensure_real()
 
2424
            for delta in self._real_repository.get_deltas_for_revisions(
 
2425
                    revisions, specific_fileids):
 
2426
                yield delta
 
2427
            return
 
2428
        # Get the revision-ids of interest
 
2429
        required_trees = set()
 
2430
        for revision in revisions:
 
2431
            required_trees.add(revision.revision_id)
 
2432
            required_trees.update(revision.parent_ids[:1])
 
2433
 
 
2434
        # Get the matching filtered trees. Note that it's more
 
2435
        # efficient to pass filtered trees to changes_from() rather
 
2436
        # than doing the filtering afterwards. changes_from() could
 
2437
        # arguably do the filtering itself but it's path-based, not
 
2438
        # file-id based, so filtering before or afterwards is
 
2439
        # currently easier.
 
2440
        if specific_fileids is None:
 
2441
            trees = dict((t.get_revision_id(), t) for
 
2442
                t in self.revision_trees(required_trees))
 
2443
        else:
 
2444
            trees = dict((t.get_revision_id(), t) for
 
2445
                t in self._filtered_revision_trees(required_trees,
 
2446
                specific_fileids))
 
2447
 
 
2448
        # Calculate the deltas
 
2449
        for revision in revisions:
 
2450
            if not revision.parent_ids:
 
2451
                old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
 
2452
            else:
 
2453
                old_tree = trees[revision.parent_ids[0]]
 
2454
            yield trees[revision.revision_id].changes_from(old_tree)
1841
2455
 
1842
2456
    @needs_read_lock
1843
2457
    def get_revision_delta(self, revision_id, specific_fileids=None):
1844
 
        self._ensure_real()
1845
 
        return self._real_repository.get_revision_delta(revision_id,
1846
 
            specific_fileids=specific_fileids)
 
2458
        r = self.get_revision(revision_id)
 
2459
        return list(self.get_deltas_for_revisions([r],
 
2460
            specific_fileids=specific_fileids))[0]
1847
2461
 
1848
2462
    @needs_read_lock
1849
2463
    def revision_trees(self, revision_ids):
1850
 
        self._ensure_real()
1851
 
        return self._real_repository.revision_trees(revision_ids)
 
2464
        inventories = self.iter_inventories(revision_ids)
 
2465
        for inv in inventories:
 
2466
            yield InventoryRevisionTree(self, inv, inv.revision_id)
1852
2467
 
1853
2468
    @needs_read_lock
1854
2469
    def get_revision_reconcile(self, revision_id):
1862
2477
            callback_refs=callback_refs, check_repo=check_repo)
1863
2478
 
1864
2479
    def copy_content_into(self, destination, revision_id=None):
1865
 
        self._ensure_real()
1866
 
        return self._real_repository.copy_content_into(
1867
 
            destination, revision_id=revision_id)
 
2480
        """Make a complete copy of the content in self into destination.
 
2481
 
 
2482
        This is a destructive operation! Do not use it on existing
 
2483
        repositories.
 
2484
        """
 
2485
        interrepo = _mod_repository.InterRepository.get(self, destination)
 
2486
        return interrepo.copy_content(revision_id)
1868
2487
 
1869
2488
    def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
1870
2489
        # get a tarball of the remote repository, and copy from that into the
1871
2490
        # destination
1872
 
        from bzrlib import osutils
1873
2491
        import tarfile
1874
2492
        # TODO: Maybe a progress bar while streaming the tarball?
1875
 
        note("Copying repository content as tarball...")
 
2493
        note(gettext("Copying repository content as tarball..."))
1876
2494
        tar_file = self._get_tarball('bz2')
1877
2495
        if tar_file is None:
1878
2496
            return None
1907
2525
    @needs_write_lock
1908
2526
    def pack(self, hint=None, clean_obsolete_packs=False):
1909
2527
        """Compress the data within the repository.
1910
 
 
1911
 
        This is not currently implemented within the smart server.
1912
2528
        """
1913
 
        self._ensure_real()
1914
 
        return self._real_repository.pack(hint=hint, clean_obsolete_packs=clean_obsolete_packs)
 
2529
        if hint is None:
 
2530
            body = ""
 
2531
        else:
 
2532
            body = "".join([l+"\n" for l in hint])
 
2533
        path = self.bzrdir._path_for_remote_call(self._client)
 
2534
        try:
 
2535
            response, handler = self._call_with_body_bytes_expecting_body(
 
2536
                'Repository.pack', (path, self._lock_token,
 
2537
                    str(clean_obsolete_packs)), body)
 
2538
        except errors.UnknownSmartMethod:
 
2539
            self._ensure_real()
 
2540
            return self._real_repository.pack(hint=hint,
 
2541
                clean_obsolete_packs=clean_obsolete_packs)
 
2542
        handler.cancel_read_body()
 
2543
        if response != ('ok', ):
 
2544
            raise errors.UnexpectedSmartServerResponse(response)
1915
2545
 
1916
2546
    @property
1917
2547
    def revisions(self):
1918
2548
        """Decorate the real repository for now.
1919
2549
 
1920
 
        In the short term this should become a real object to intercept graph
1921
 
        lookups.
1922
 
 
1923
2550
        In the long term a full blown network facility is needed.
1924
2551
        """
1925
2552
        self._ensure_real()
1953
2580
 
1954
2581
    @needs_write_lock
1955
2582
    def sign_revision(self, revision_id, gpg_strategy):
1956
 
        self._ensure_real()
1957
 
        return self._real_repository.sign_revision(revision_id, gpg_strategy)
 
2583
        testament = _mod_testament.Testament.from_revision(self, revision_id)
 
2584
        plaintext = testament.as_short_text()
 
2585
        self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1958
2586
 
1959
2587
    @property
1960
2588
    def texts(self):
1966
2594
        self._ensure_real()
1967
2595
        return self._real_repository.texts
1968
2596
 
 
2597
    def _iter_revisions_rpc(self, revision_ids):
 
2598
        body = "\n".join(revision_ids)
 
2599
        path = self.bzrdir._path_for_remote_call(self._client)
 
2600
        response_tuple, response_handler = (
 
2601
            self._call_with_body_bytes_expecting_body(
 
2602
            "Repository.iter_revisions", (path, ), body))
 
2603
        if response_tuple[0] != "ok":
 
2604
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
2605
        serializer_format = response_tuple[1]
 
2606
        serializer = serializer_format_registry.get(serializer_format)
 
2607
        byte_stream = response_handler.read_streamed_body()
 
2608
        decompressor = zlib.decompressobj()
 
2609
        chunks = []
 
2610
        for bytes in byte_stream:
 
2611
            chunks.append(decompressor.decompress(bytes))
 
2612
            if decompressor.unused_data != "":
 
2613
                chunks.append(decompressor.flush())
 
2614
                yield serializer.read_revision_from_string("".join(chunks))
 
2615
                unused = decompressor.unused_data
 
2616
                decompressor = zlib.decompressobj()
 
2617
                chunks = [decompressor.decompress(unused)]
 
2618
        chunks.append(decompressor.flush())
 
2619
        text = "".join(chunks)
 
2620
        if text != "":
 
2621
            yield serializer.read_revision_from_string("".join(chunks))
 
2622
 
1969
2623
    @needs_read_lock
1970
2624
    def get_revisions(self, revision_ids):
1971
 
        self._ensure_real()
1972
 
        return self._real_repository.get_revisions(revision_ids)
 
2625
        if revision_ids is None:
 
2626
            revision_ids = self.all_revision_ids()
 
2627
        else:
 
2628
            for rev_id in revision_ids:
 
2629
                if not rev_id or not isinstance(rev_id, basestring):
 
2630
                    raise errors.InvalidRevisionId(
 
2631
                        revision_id=rev_id, branch=self)
 
2632
        try:
 
2633
            missing = set(revision_ids)
 
2634
            revs = {}
 
2635
            for rev in self._iter_revisions_rpc(revision_ids):
 
2636
                missing.remove(rev.revision_id)
 
2637
                revs[rev.revision_id] = rev
 
2638
        except errors.UnknownSmartMethod:
 
2639
            self._ensure_real()
 
2640
            return self._real_repository.get_revisions(revision_ids)
 
2641
        for fallback in self._fallback_repositories:
 
2642
            if not missing:
 
2643
                break
 
2644
            for revid in list(missing):
 
2645
                # XXX JRV 2011-11-20: It would be nice if there was a
 
2646
                # public method on Repository that could be used to query
 
2647
                # for revision objects *without* failing completely if one
 
2648
                # was missing. There is VersionedFileRepository._iter_revisions,
 
2649
                # but unfortunately that's private and not provided by
 
2650
                # all repository implementations.
 
2651
                try:
 
2652
                    revs[revid] = fallback.get_revision(revid)
 
2653
                except errors.NoSuchRevision:
 
2654
                    pass
 
2655
                else:
 
2656
                    missing.remove(revid)
 
2657
        if missing:
 
2658
            raise errors.NoSuchRevision(self, list(missing)[0])
 
2659
        return [revs[revid] for revid in revision_ids]
1973
2660
 
1974
2661
    def supports_rich_root(self):
1975
2662
        return self._format.rich_root_data
1976
2663
 
 
2664
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1977
2665
    def iter_reverse_revision_history(self, revision_id):
1978
2666
        self._ensure_real()
1979
2667
        return self._real_repository.iter_reverse_revision_history(revision_id)
1982
2670
    def _serializer(self):
1983
2671
        return self._format._serializer
1984
2672
 
 
2673
    @needs_write_lock
1985
2674
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1986
 
        self._ensure_real()
1987
 
        return self._real_repository.store_revision_signature(
1988
 
            gpg_strategy, plaintext, revision_id)
 
2675
        signature = gpg_strategy.sign(plaintext)
 
2676
        self.add_signature_text(revision_id, signature)
1989
2677
 
1990
2678
    def add_signature_text(self, revision_id, signature):
1991
 
        self._ensure_real()
1992
 
        return self._real_repository.add_signature_text(revision_id, signature)
 
2679
        if self._real_repository:
 
2680
            # If there is a real repository the write group will
 
2681
            # be in the real repository as well, so use that:
 
2682
            self._ensure_real()
 
2683
            return self._real_repository.add_signature_text(
 
2684
                revision_id, signature)
 
2685
        path = self.bzrdir._path_for_remote_call(self._client)
 
2686
        response, handler = self._call_with_body_bytes_expecting_body(
 
2687
            'Repository.add_signature_text', (path, self._lock_token,
 
2688
                revision_id) + tuple(self._write_group_tokens), signature)
 
2689
        handler.cancel_read_body()
 
2690
        self.refresh_data()
 
2691
        if response[0] != 'ok':
 
2692
            raise errors.UnexpectedSmartServerResponse(response)
 
2693
        self._write_group_tokens = response[1:]
1993
2694
 
1994
2695
    def has_signature_for_revision_id(self, revision_id):
1995
 
        self._ensure_real()
1996
 
        return self._real_repository.has_signature_for_revision_id(revision_id)
 
2696
        path = self.bzrdir._path_for_remote_call(self._client)
 
2697
        try:
 
2698
            response = self._call('Repository.has_signature_for_revision_id',
 
2699
                path, revision_id)
 
2700
        except errors.UnknownSmartMethod:
 
2701
            self._ensure_real()
 
2702
            return self._real_repository.has_signature_for_revision_id(
 
2703
                revision_id)
 
2704
        if response[0] not in ('yes', 'no'):
 
2705
            raise SmartProtocolError('unexpected response code %s' % (response,))
 
2706
        if response[0] == 'yes':
 
2707
            return True
 
2708
        for fallback in self._fallback_repositories:
 
2709
            if fallback.has_signature_for_revision_id(revision_id):
 
2710
                return True
 
2711
        return False
 
2712
 
 
2713
    @needs_read_lock
 
2714
    def verify_revision_signature(self, revision_id, gpg_strategy):
 
2715
        if not self.has_signature_for_revision_id(revision_id):
 
2716
            return gpg.SIGNATURE_NOT_SIGNED, None
 
2717
        signature = self.get_signature_text(revision_id)
 
2718
 
 
2719
        testament = _mod_testament.Testament.from_revision(self, revision_id)
 
2720
        plaintext = testament.as_short_text()
 
2721
 
 
2722
        return gpg_strategy.verify(signature, plaintext)
1997
2723
 
1998
2724
    def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1999
2725
        self._ensure_real()
2189
2915
 
2190
2916
    def _real_stream(self, repo, search):
2191
2917
        """Get a stream for search from repo.
2192
 
        
2193
 
        This never called RemoteStreamSource.get_stream, and is a heler
2194
 
        for RemoteStreamSource._get_stream to allow getting a stream 
 
2918
 
 
2919
        This never called RemoteStreamSource.get_stream, and is a helper
 
2920
        for RemoteStreamSource._get_stream to allow getting a stream
2195
2921
        reliably whether fallback back because of old servers or trying
2196
2922
        to stream from a non-RemoteRepository (which the stacked support
2197
2923
        code will do).
2239
2965
            except errors.UnknownSmartMethod:
2240
2966
                medium._remember_remote_is_before(version)
2241
2967
            except errors.UnknownErrorFromSmartServer, e:
2242
 
                if isinstance(search, graph.EverythingResult):
 
2968
                if isinstance(search, vf_search.EverythingResult):
2243
2969
                    error_verb = e.error_from_smart_server.error_verb
2244
2970
                    if error_verb == 'BadSearch':
2245
2971
                        # Pre-2.4 servers don't support this sort of search.
2337
3063
 
2338
3064
    def _ensure_real(self):
2339
3065
        if self._custom_format is None:
2340
 
            self._custom_format = branch.network_format_registry.get(
2341
 
                self._network_name)
 
3066
            try:
 
3067
                self._custom_format = branch.network_format_registry.get(
 
3068
                    self._network_name)
 
3069
            except KeyError:
 
3070
                raise errors.UnknownFormatError(kind='branch',
 
3071
                    format=self._network_name)
2342
3072
 
2343
3073
    def get_format_description(self):
2344
3074
        self._ensure_real()
2351
3081
        return a_bzrdir.open_branch(name=name, 
2352
3082
            ignore_fallbacks=ignore_fallbacks)
2353
3083
 
2354
 
    def _vfs_initialize(self, a_bzrdir, name):
 
3084
    def _vfs_initialize(self, a_bzrdir, name, append_revisions_only):
2355
3085
        # Initialisation when using a local bzrdir object, or a non-vfs init
2356
3086
        # method is not available on the server.
2357
3087
        # self._custom_format is always set - the start of initialize ensures
2359
3089
        if isinstance(a_bzrdir, RemoteBzrDir):
2360
3090
            a_bzrdir._ensure_real()
2361
3091
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
2362
 
                name)
 
3092
                name, append_revisions_only=append_revisions_only)
2363
3093
        else:
2364
3094
            # We assume the bzrdir is parameterised; it may not be.
2365
 
            result = self._custom_format.initialize(a_bzrdir, name)
 
3095
            result = self._custom_format.initialize(a_bzrdir, name,
 
3096
                append_revisions_only=append_revisions_only)
2366
3097
        if (isinstance(a_bzrdir, RemoteBzrDir) and
2367
3098
            not isinstance(result, RemoteBranch)):
2368
3099
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
2369
3100
                                  name=name)
2370
3101
        return result
2371
3102
 
2372
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
3103
    def initialize(self, a_bzrdir, name=None, repository=None,
 
3104
                   append_revisions_only=None):
2373
3105
        # 1) get the network name to use.
2374
3106
        if self._custom_format:
2375
3107
            network_name = self._custom_format.network_name()
2381
3113
            network_name = reference_format.network_name()
2382
3114
        # Being asked to create on a non RemoteBzrDir:
2383
3115
        if not isinstance(a_bzrdir, RemoteBzrDir):
2384
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
3116
            return self._vfs_initialize(a_bzrdir, name=name,
 
3117
                append_revisions_only=append_revisions_only)
2385
3118
        medium = a_bzrdir._client._medium
2386
3119
        if medium._is_remote_before((1, 13)):
2387
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
3120
            return self._vfs_initialize(a_bzrdir, name=name,
 
3121
                append_revisions_only=append_revisions_only)
2388
3122
        # Creating on a remote bzr dir.
2389
3123
        # 2) try direct creation via RPC
2390
3124
        path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
2397
3131
        except errors.UnknownSmartMethod:
2398
3132
            # Fallback - use vfs methods
2399
3133
            medium._remember_remote_is_before((1, 13))
2400
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
3134
            return self._vfs_initialize(a_bzrdir, name=name,
 
3135
                    append_revisions_only=append_revisions_only)
2401
3136
        if response[0] != 'ok':
2402
3137
            raise errors.UnexpectedSmartServerResponse(response)
2403
3138
        # Turn the response into a RemoteRepository object.
2424
3159
            remote_repo = RemoteRepository(repo_bzrdir, repo_format)
2425
3160
        remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2426
3161
            format=format, setup_stacking=False, name=name)
 
3162
        if append_revisions_only:
 
3163
            remote_branch.set_append_revisions_only(append_revisions_only)
2427
3164
        # XXX: We know this is a new branch, so it must have revno 0, revid
2428
3165
        # NULL_REVISION. Creating the branch locked would make this be unable
2429
3166
        # to be wrong; here its simply very unlikely to be wrong. RBC 20090225
2462
3199
                return True
2463
3200
        return False
2464
3201
 
 
3202
 
 
3203
class RemoteBranchStore(_mod_config.IniFileStore):
 
3204
    """Branch store which attempts to use HPSS calls to retrieve branch store.
 
3205
 
 
3206
    Note that this is specific to bzr-based formats.
 
3207
    """
 
3208
 
 
3209
    def __init__(self, branch):
 
3210
        super(RemoteBranchStore, self).__init__()
 
3211
        self.branch = branch
 
3212
        self.id = "branch"
 
3213
        self._real_store = None
 
3214
 
 
3215
    def lock_write(self, token=None):
 
3216
        return self.branch.lock_write(token)
 
3217
 
 
3218
    def unlock(self):
 
3219
        return self.branch.unlock()
 
3220
 
 
3221
    @needs_write_lock
 
3222
    def save(self):
 
3223
        # We need to be able to override the undecorated implementation
 
3224
        self.save_without_locking()
 
3225
 
 
3226
    def save_without_locking(self):
 
3227
        super(RemoteBranchStore, self).save()
 
3228
 
 
3229
    def external_url(self):
 
3230
        return self.branch.user_url
 
3231
 
 
3232
    def _load_content(self):
 
3233
        path = self.branch._remote_path()
 
3234
        try:
 
3235
            response, handler = self.branch._call_expecting_body(
 
3236
                'Branch.get_config_file', path)
 
3237
        except errors.UnknownSmartMethod:
 
3238
            self._ensure_real()
 
3239
            return self._real_store._load_content()
 
3240
        if len(response) and response[0] != 'ok':
 
3241
            raise errors.UnexpectedSmartServerResponse(response)
 
3242
        return handler.read_body_bytes()
 
3243
 
 
3244
    def _save_content(self, content):
 
3245
        path = self.branch._remote_path()
 
3246
        try:
 
3247
            response, handler = self.branch._call_with_body_bytes_expecting_body(
 
3248
                'Branch.put_config_file', (path,
 
3249
                    self.branch._lock_token, self.branch._repo_lock_token),
 
3250
                content)
 
3251
        except errors.UnknownSmartMethod:
 
3252
            self._ensure_real()
 
3253
            return self._real_store._save_content(content)
 
3254
        handler.cancel_read_body()
 
3255
        if response != ('ok', ):
 
3256
            raise errors.UnexpectedSmartServerResponse(response)
 
3257
 
 
3258
    def _ensure_real(self):
 
3259
        self.branch._ensure_real()
 
3260
        if self._real_store is None:
 
3261
            self._real_store = _mod_config.BranchStore(self.branch)
 
3262
 
 
3263
 
2465
3264
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
2466
3265
    """Branch stored on a server accessed by HPSS RPC.
2467
3266
 
2469
3268
    """
2470
3269
 
2471
3270
    def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
2472
 
        _client=None, format=None, setup_stacking=True, name=None):
 
3271
        _client=None, format=None, setup_stacking=True, name=None,
 
3272
        possible_transports=None):
2473
3273
        """Create a RemoteBranch instance.
2474
3274
 
2475
3275
        :param real_branch: An optional local implementation of the branch
2540
3340
            hook(self)
2541
3341
        self._is_stacked = False
2542
3342
        if setup_stacking:
2543
 
            self._setup_stacking()
 
3343
            self._setup_stacking(possible_transports)
2544
3344
 
2545
 
    def _setup_stacking(self):
 
3345
    def _setup_stacking(self, possible_transports):
2546
3346
        # configure stacking into the remote repository, by reading it from
2547
3347
        # the vfs branch.
2548
3348
        try:
2551
3351
            errors.UnstackableRepositoryFormat), e:
2552
3352
            return
2553
3353
        self._is_stacked = True
2554
 
        self._activate_fallback_location(fallback_url)
 
3354
        if possible_transports is None:
 
3355
            possible_transports = []
 
3356
        else:
 
3357
            possible_transports = list(possible_transports)
 
3358
        possible_transports.append(self.bzrdir.root_transport)
 
3359
        self._activate_fallback_location(fallback_url,
 
3360
            possible_transports=possible_transports)
2555
3361
 
2556
3362
    def _get_config(self):
2557
3363
        return RemoteBranchConfig(self)
2558
3364
 
 
3365
    def _get_config_store(self):
 
3366
        return RemoteBranchStore(self)
 
3367
 
2559
3368
    def _get_real_transport(self):
2560
3369
        # if we try vfs access, return the real branch's vfs transport
2561
3370
        self._ensure_real()
2624
3433
                self.bzrdir, self._client)
2625
3434
        return self._control_files
2626
3435
 
2627
 
    def _get_checkout_format(self):
2628
 
        self._ensure_real()
2629
 
        return self._real_branch._get_checkout_format()
2630
 
 
2631
3436
    def get_physical_lock_status(self):
2632
3437
        """See Branch.get_physical_lock_status()."""
2633
 
        # should be an API call to the server, as branches must be lockable.
2634
 
        self._ensure_real()
2635
 
        return self._real_branch.get_physical_lock_status()
 
3438
        try:
 
3439
            response = self._client.call('Branch.get_physical_lock_status',
 
3440
                self._remote_path())
 
3441
        except errors.UnknownSmartMethod:
 
3442
            self._ensure_real()
 
3443
            return self._real_branch.get_physical_lock_status()
 
3444
        if response[0] not in ('yes', 'no'):
 
3445
            raise errors.UnexpectedSmartServerResponse(response)
 
3446
        return (response[0] == 'yes')
2636
3447
 
2637
3448
    def get_stacked_on_url(self):
2638
3449
        """Get the URL this branch is stacked against.
2822
3633
            self.repository.unlock()
2823
3634
 
2824
3635
    def break_lock(self):
2825
 
        self._ensure_real()
2826
 
        return self._real_branch.break_lock()
 
3636
        try:
 
3637
            response = self._call(
 
3638
                'Branch.break_lock', self._remote_path())
 
3639
        except errors.UnknownSmartMethod:
 
3640
            self._ensure_real()
 
3641
            return self._real_branch.break_lock()
 
3642
        if response != ('ok',):
 
3643
            raise errors.UnexpectedSmartServerResponse(response)
2827
3644
 
2828
3645
    def leave_lock_in_place(self):
2829
3646
        if not self._lock_token:
3003
3820
        return self._lock_count >= 1
3004
3821
 
3005
3822
    @needs_read_lock
 
3823
    def revision_id_to_dotted_revno(self, revision_id):
 
3824
        """Given a revision id, return its dotted revno.
 
3825
 
 
3826
        :return: a tuple like (1,) or (400,1,3).
 
3827
        """
 
3828
        try:
 
3829
            response = self._call('Branch.revision_id_to_revno',
 
3830
                self._remote_path(), revision_id)
 
3831
        except errors.UnknownSmartMethod:
 
3832
            self._ensure_real()
 
3833
            return self._real_branch.revision_id_to_dotted_revno(revision_id)
 
3834
        if response[0] == 'ok':
 
3835
            return tuple([int(x) for x in response[1:]])
 
3836
        else:
 
3837
            raise errors.UnexpectedSmartServerResponse(response)
 
3838
 
 
3839
    @needs_read_lock
3006
3840
    def revision_id_to_revno(self, revision_id):
3007
 
        self._ensure_real()
3008
 
        return self._real_branch.revision_id_to_revno(revision_id)
 
3841
        """Given a revision id on the branch mainline, return its revno.
 
3842
 
 
3843
        :return: an integer
 
3844
        """
 
3845
        try:
 
3846
            response = self._call('Branch.revision_id_to_revno',
 
3847
                self._remote_path(), revision_id)
 
3848
        except errors.UnknownSmartMethod:
 
3849
            self._ensure_real()
 
3850
            return self._real_branch.revision_id_to_revno(revision_id)
 
3851
        if response[0] == 'ok':
 
3852
            if len(response) == 2:
 
3853
                return int(response[1])
 
3854
            raise NoSuchRevision(self, revision_id)
 
3855
        else:
 
3856
            raise errors.UnexpectedSmartServerResponse(response)
3009
3857
 
3010
3858
    @needs_write_lock
3011
3859
    def set_last_revision_info(self, revno, revision_id):
3101
3949
        """
3102
3950
        try:
3103
3951
            configobj = self._get_configobj()
 
3952
            section_obj = None
3104
3953
            if section is None:
3105
3954
                section_obj = configobj
3106
3955
            else:
3107
3956
                try:
3108
3957
                    section_obj = configobj[section]
3109
3958
                except KeyError:
3110
 
                    return default
3111
 
            return section_obj.get(name, default)
 
3959
                    pass
 
3960
            if section_obj is None:
 
3961
                value = default
 
3962
            else:
 
3963
                value = section_obj.get(name, default)
3112
3964
        except errors.UnknownSmartMethod:
3113
 
            return self._vfs_get_option(name, section, default)
 
3965
            value = self._vfs_get_option(name, section, default)
 
3966
        for hook in _mod_config.OldConfigHooks['get']:
 
3967
            hook(self, name, value)
 
3968
        return value
3114
3969
 
3115
3970
    def _response_to_configobj(self, response):
3116
3971
        if len(response[0]) and response[0][0] != 'ok':
3117
3972
            raise errors.UnexpectedSmartServerResponse(response)
3118
3973
        lines = response[1].read_body_bytes().splitlines()
3119
 
        return config.ConfigObj(lines, encoding='utf-8')
 
3974
        conf = _mod_config.ConfigObj(lines, encoding='utf-8')
 
3975
        for hook in _mod_config.OldConfigHooks['load']:
 
3976
            hook(self)
 
3977
        return conf
3120
3978
 
3121
3979
 
3122
3980
class RemoteBranchConfig(RemoteConfig):
3230
4088
        return self._bzrdir._real_bzrdir
3231
4089
 
3232
4090
 
3233
 
 
3234
4091
def _extract_tar(tar, to_dir):
3235
4092
    """Extract all the contents of a tarfile object.
3236
4093
 
3240
4097
        tar.extract(tarinfo, to_dir)
3241
4098
 
3242
4099
 
 
4100
error_translators = registry.Registry()
 
4101
no_context_error_translators = registry.Registry()
 
4102
 
 
4103
 
3243
4104
def _translate_error(err, **context):
3244
4105
    """Translate an ErrorFromSmartServer into a more useful error.
3245
4106
 
3274
4135
                    'Missing key %r in context %r', key_err.args[0], context)
3275
4136
                raise err
3276
4137
 
3277
 
    if err.error_verb == 'NoSuchRevision':
3278
 
        raise NoSuchRevision(find('branch'), err.error_args[0])
3279
 
    elif err.error_verb == 'nosuchrevision':
3280
 
        raise NoSuchRevision(find('repository'), err.error_args[0])
3281
 
    elif err.error_verb == 'nobranch':
3282
 
        if len(err.error_args) >= 1:
3283
 
            extra = err.error_args[0]
3284
 
        else:
3285
 
            extra = None
3286
 
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base,
3287
 
            detail=extra)
3288
 
    elif err.error_verb == 'norepository':
3289
 
        raise errors.NoRepositoryPresent(find('bzrdir'))
3290
 
    elif err.error_verb == 'UnlockableTransport':
3291
 
        raise errors.UnlockableTransport(find('bzrdir').root_transport)
3292
 
    elif err.error_verb == 'TokenMismatch':
3293
 
        raise errors.TokenMismatch(find('token'), '(remote token)')
3294
 
    elif err.error_verb == 'Diverged':
3295
 
        raise errors.DivergedBranches(find('branch'), find('other_branch'))
3296
 
    elif err.error_verb == 'NotStacked':
3297
 
        raise errors.NotStacked(branch=find('branch'))
3298
 
    elif err.error_verb == 'PermissionDenied':
3299
 
        path = get_path()
3300
 
        if len(err.error_args) >= 2:
3301
 
            extra = err.error_args[1]
3302
 
        else:
3303
 
            extra = None
3304
 
        raise errors.PermissionDenied(path, extra=extra)
3305
 
    elif err.error_verb == 'ReadError':
3306
 
        path = get_path()
3307
 
        raise errors.ReadError(path)
3308
 
    elif err.error_verb == 'NoSuchFile':
3309
 
        path = get_path()
3310
 
        raise errors.NoSuchFile(path)
3311
 
    _translate_error_without_context(err)
3312
 
 
3313
 
 
3314
 
def _translate_error_without_context(err):
3315
 
    """Translate any ErrorFromSmartServer values that don't require context"""
3316
 
    if err.error_verb == 'IncompatibleRepositories':
3317
 
        raise errors.IncompatibleRepositories(err.error_args[0],
3318
 
            err.error_args[1], err.error_args[2])
3319
 
    elif err.error_verb == 'LockContention':
3320
 
        raise errors.LockContention('(remote lock)')
3321
 
    elif err.error_verb == 'LockFailed':
3322
 
        raise errors.LockFailed(err.error_args[0], err.error_args[1])
3323
 
    elif err.error_verb == 'TipChangeRejected':
3324
 
        raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
3325
 
    elif err.error_verb == 'UnstackableBranchFormat':
3326
 
        raise errors.UnstackableBranchFormat(*err.error_args)
3327
 
    elif err.error_verb == 'UnstackableRepositoryFormat':
3328
 
        raise errors.UnstackableRepositoryFormat(*err.error_args)
3329
 
    elif err.error_verb == 'FileExists':
3330
 
        raise errors.FileExists(err.error_args[0])
3331
 
    elif err.error_verb == 'DirectoryNotEmpty':
3332
 
        raise errors.DirectoryNotEmpty(err.error_args[0])
3333
 
    elif err.error_verb == 'ShortReadvError':
3334
 
        args = err.error_args
3335
 
        raise errors.ShortReadvError(
3336
 
            args[0], int(args[1]), int(args[2]), int(args[3]))
3337
 
    elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
 
4138
    try:
 
4139
        translator = error_translators.get(err.error_verb)
 
4140
    except KeyError:
 
4141
        pass
 
4142
    else:
 
4143
        raise translator(err, find, get_path)
 
4144
    try:
 
4145
        translator = no_context_error_translators.get(err.error_verb)
 
4146
    except KeyError:
 
4147
        raise errors.UnknownErrorFromSmartServer(err)
 
4148
    else:
 
4149
        raise translator(err)
 
4150
 
 
4151
 
 
4152
error_translators.register('NoSuchRevision',
 
4153
    lambda err, find, get_path: NoSuchRevision(
 
4154
        find('branch'), err.error_args[0]))
 
4155
error_translators.register('nosuchrevision',
 
4156
    lambda err, find, get_path: NoSuchRevision(
 
4157
        find('repository'), err.error_args[0]))
 
4158
 
 
4159
def _translate_nobranch_error(err, find, get_path):
 
4160
    if len(err.error_args) >= 1:
 
4161
        extra = err.error_args[0]
 
4162
    else:
 
4163
        extra = None
 
4164
    return errors.NotBranchError(path=find('bzrdir').root_transport.base,
 
4165
        detail=extra)
 
4166
 
 
4167
error_translators.register('nobranch', _translate_nobranch_error)
 
4168
error_translators.register('norepository',
 
4169
    lambda err, find, get_path: errors.NoRepositoryPresent(
 
4170
        find('bzrdir')))
 
4171
error_translators.register('UnlockableTransport',
 
4172
    lambda err, find, get_path: errors.UnlockableTransport(
 
4173
        find('bzrdir').root_transport))
 
4174
error_translators.register('TokenMismatch',
 
4175
    lambda err, find, get_path: errors.TokenMismatch(
 
4176
        find('token'), '(remote token)'))
 
4177
error_translators.register('Diverged',
 
4178
    lambda err, find, get_path: errors.DivergedBranches(
 
4179
        find('branch'), find('other_branch')))
 
4180
error_translators.register('NotStacked',
 
4181
    lambda err, find, get_path: errors.NotStacked(branch=find('branch')))
 
4182
 
 
4183
def _translate_PermissionDenied(err, find, get_path):
 
4184
    path = get_path()
 
4185
    if len(err.error_args) >= 2:
 
4186
        extra = err.error_args[1]
 
4187
    else:
 
4188
        extra = None
 
4189
    return errors.PermissionDenied(path, extra=extra)
 
4190
 
 
4191
error_translators.register('PermissionDenied', _translate_PermissionDenied)
 
4192
error_translators.register('ReadError',
 
4193
    lambda err, find, get_path: errors.ReadError(get_path()))
 
4194
error_translators.register('NoSuchFile',
 
4195
    lambda err, find, get_path: errors.NoSuchFile(get_path()))
 
4196
error_translators.register('TokenLockingNotSupported',
 
4197
    lambda err, find, get_path: errors.TokenLockingNotSupported(
 
4198
        find('repository')))
 
4199
error_translators.register('UnsuspendableWriteGroup',
 
4200
    lambda err, find, get_path: errors.UnsuspendableWriteGroup(
 
4201
        repository=find('repository')))
 
4202
error_translators.register('UnresumableWriteGroup',
 
4203
    lambda err, find, get_path: errors.UnresumableWriteGroup(
 
4204
        repository=find('repository'), write_groups=err.error_args[0],
 
4205
        reason=err.error_args[1]))
 
4206
no_context_error_translators.register('IncompatibleRepositories',
 
4207
    lambda err: errors.IncompatibleRepositories(
 
4208
        err.error_args[0], err.error_args[1], err.error_args[2]))
 
4209
no_context_error_translators.register('LockContention',
 
4210
    lambda err: errors.LockContention('(remote lock)'))
 
4211
no_context_error_translators.register('LockFailed',
 
4212
    lambda err: errors.LockFailed(err.error_args[0], err.error_args[1]))
 
4213
no_context_error_translators.register('TipChangeRejected',
 
4214
    lambda err: errors.TipChangeRejected(err.error_args[0].decode('utf8')))
 
4215
no_context_error_translators.register('UnstackableBranchFormat',
 
4216
    lambda err: errors.UnstackableBranchFormat(*err.error_args))
 
4217
no_context_error_translators.register('UnstackableRepositoryFormat',
 
4218
    lambda err: errors.UnstackableRepositoryFormat(*err.error_args))
 
4219
no_context_error_translators.register('FileExists',
 
4220
    lambda err: errors.FileExists(err.error_args[0]))
 
4221
no_context_error_translators.register('DirectoryNotEmpty',
 
4222
    lambda err: errors.DirectoryNotEmpty(err.error_args[0]))
 
4223
 
 
4224
def _translate_short_readv_error(err):
 
4225
    args = err.error_args
 
4226
    return errors.ShortReadvError(args[0], int(args[1]), int(args[2]),
 
4227
        int(args[3]))
 
4228
 
 
4229
no_context_error_translators.register('ShortReadvError',
 
4230
    _translate_short_readv_error)
 
4231
 
 
4232
def _translate_unicode_error(err):
3338
4233
        encoding = str(err.error_args[0]) # encoding must always be a string
3339
4234
        val = err.error_args[1]
3340
4235
        start = int(err.error_args[2])
3348
4243
            raise UnicodeDecodeError(encoding, val, start, end, reason)
3349
4244
        elif err.error_verb == 'UnicodeEncodeError':
3350
4245
            raise UnicodeEncodeError(encoding, val, start, end, reason)
3351
 
    elif err.error_verb == 'ReadOnlyError':
3352
 
        raise errors.TransportNotPossible('readonly transport')
3353
 
    elif err.error_verb == 'MemoryError':
3354
 
        raise errors.BzrError("remote server out of memory\n"
3355
 
            "Retry non-remotely, or contact the server admin for details.")
3356
 
    raise errors.UnknownErrorFromSmartServer(err)
 
4246
 
 
4247
no_context_error_translators.register('UnicodeEncodeError',
 
4248
    _translate_unicode_error)
 
4249
no_context_error_translators.register('UnicodeDecodeError',
 
4250
    _translate_unicode_error)
 
4251
no_context_error_translators.register('ReadOnlyError',
 
4252
    lambda err: errors.TransportNotPossible('readonly transport'))
 
4253
no_context_error_translators.register('MemoryError',
 
4254
    lambda err: errors.BzrError("remote server out of memory\n"
 
4255
        "Retry non-remotely, or contact the server admin for details."))
 
4256
no_context_error_translators.register('RevisionNotPresent',
 
4257
    lambda err: errors.RevisionNotPresent(err.error_args[0], err.error_args[1]))
 
4258
 
 
4259
no_context_error_translators.register('BzrCheckError',
 
4260
    lambda err: errors.BzrCheckError(msg=err.error_args[0]))
 
4261