~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

  • Committer: Jelmer Vernooij
  • Date: 2012-02-20 12:19:29 UTC
  • mfrom: (6437.23.11 2.5)
  • mto: (6581.1.1 trunk)
  • mto: This revision was merged to the branch mainline in revision 6582.
  • Revision ID: jelmer@samba.org-20120220121929-7ni2psvjoatm1yp4
Merge bzr/2.5.

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
43
    vf_repository,
 
44
    vf_search,
36
45
    )
37
46
from bzrlib.branch import BranchReferenceFormat, BranchWriteLockResult
38
47
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
40
49
    NoSuchRevision,
41
50
    SmartProtocolError,
42
51
    )
 
52
from bzrlib.i18n import gettext
 
53
from bzrlib.inventory import Inventory
43
54
from bzrlib.lockable_files import LockableFiles
44
55
from bzrlib.smart import client, vfs, repository as smart_repo
45
56
from bzrlib.smart.client import _SmartClient
46
57
from bzrlib.revision import NULL_REVISION
 
58
from bzrlib.revisiontree import InventoryRevisionTree
47
59
from bzrlib.repository import RepositoryWriteLockResult, _LazyListJoin
48
 
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 FulltextContentFactory
 
63
 
 
64
 
 
65
_DEFAULT_SEARCH_DEPTH = 100
49
66
 
50
67
 
51
68
class _RpcHelper(object):
96
113
 
97
114
    supports_workingtrees = False
98
115
 
 
116
    colocated_branches = False
 
117
 
99
118
    def __init__(self):
100
119
        _mod_bzrdir.BzrDirMetaFormat1.__init__(self)
101
120
        # XXX: It's a bit ugly that the network name is here, because we'd
110
129
 
111
130
    def get_format_description(self):
112
131
        if self._network_name:
113
 
            real_format = controldir.network_format_registry.get(self._network_name)
114
 
            return 'Remote: ' + real_format.get_format_description()
 
132
            try:
 
133
                real_format = controldir.network_format_registry.get(
 
134
                        self._network_name)
 
135
            except KeyError:
 
136
                pass
 
137
            else:
 
138
                return 'Remote: ' + real_format.get_format_description()
115
139
        return 'bzr remote bzrdir'
116
140
 
117
141
    def get_format_string(self):
327
351
        _mod_bzrdir.BzrDirMetaFormat1._set_repository_format) #.im_func)
328
352
 
329
353
 
 
354
class RemoteControlStore(_mod_config.IniFileStore):
 
355
    """Control store which attempts to use HPSS calls to retrieve control store.
 
356
 
 
357
    Note that this is specific to bzr-based formats.
 
358
    """
 
359
 
 
360
    def __init__(self, bzrdir):
 
361
        super(RemoteControlStore, self).__init__()
 
362
        self.bzrdir = bzrdir
 
363
        self._real_store = None
 
364
 
 
365
    def lock_write(self, token=None):
 
366
        self._ensure_real()
 
367
        return self._real_store.lock_write(token)
 
368
 
 
369
    def unlock(self):
 
370
        self._ensure_real()
 
371
        return self._real_store.unlock()
 
372
 
 
373
    @needs_write_lock
 
374
    def save(self):
 
375
        # We need to be able to override the undecorated implementation
 
376
        self.save_without_locking()
 
377
 
 
378
    def save_without_locking(self):
 
379
        super(RemoteControlStore, self).save()
 
380
 
 
381
    def _ensure_real(self):
 
382
        self.bzrdir._ensure_real()
 
383
        if self._real_store is None:
 
384
            self._real_store = _mod_config.ControlStore(self.bzrdir)
 
385
 
 
386
    def external_url(self):
 
387
        return self.bzrdir.user_url
 
388
 
 
389
    def _load_content(self):
 
390
        medium = self.bzrdir._client._medium
 
391
        path = self.bzrdir._path_for_remote_call(self.bzrdir._client)
 
392
        try:
 
393
            response, handler = self.bzrdir._call_expecting_body(
 
394
                'BzrDir.get_config_file', path)
 
395
        except errors.UnknownSmartMethod:
 
396
            self._ensure_real()
 
397
            return self._real_store._load_content()
 
398
        if len(response) and response[0] != 'ok':
 
399
            raise errors.UnexpectedSmartServerResponse(response)
 
400
        return handler.read_body_bytes()
 
401
 
 
402
    def _save_content(self, content):
 
403
        # FIXME JRV 2011-11-22: Ideally this should use a
 
404
        # HPSS call too, but at the moment it is not possible
 
405
        # to write lock control directories.
 
406
        self._ensure_real()
 
407
        return self._real_store._save_content(content)
 
408
 
 
409
 
330
410
class RemoteBzrDir(_mod_bzrdir.BzrDir, _RpcHelper):
331
411
    """Control directory on a remote server, accessed via bzr:// or similar."""
332
412
 
403
483
                warning('VFS BzrDir access triggered\n%s',
404
484
                    ''.join(traceback.format_stack()))
405
485
            self._real_bzrdir = _mod_bzrdir.BzrDir.open_from_transport(
406
 
                self.root_transport, _server_formats=False)
 
486
                self.root_transport, probers=[_mod_bzrdir.BzrProber])
407
487
            self._format._network_name = \
408
488
                self._real_bzrdir._format.network_name()
409
489
 
416
496
        self._next_open_branch_result = None
417
497
        return _mod_bzrdir.BzrDir.break_lock(self)
418
498
 
 
499
    def _vfs_checkout_metadir(self):
 
500
        self._ensure_real()
 
501
        return self._real_bzrdir.checkout_metadir()
 
502
 
 
503
    def checkout_metadir(self):
 
504
        """Retrieve the controldir format to use for checkouts of this one.
 
505
        """
 
506
        medium = self._client._medium
 
507
        if medium._is_remote_before((2, 5)):
 
508
            return self._vfs_checkout_metadir()
 
509
        path = self._path_for_remote_call(self._client)
 
510
        try:
 
511
            response = self._client.call('BzrDir.checkout_metadir',
 
512
                path)
 
513
        except errors.UnknownSmartMethod:
 
514
            medium._remember_remote_is_before((2, 5))
 
515
            return self._vfs_checkout_metadir()
 
516
        if len(response) != 3:
 
517
            raise errors.UnexpectedSmartServerResponse(response)
 
518
        control_name, repo_name, branch_name = response
 
519
        try:
 
520
            format = controldir.network_format_registry.get(control_name)
 
521
        except KeyError:
 
522
            raise errors.UnknownFormatError(kind='control',
 
523
                format=control_name)
 
524
        if repo_name:
 
525
            try:
 
526
                repo_format = _mod_repository.network_format_registry.get(
 
527
                    repo_name)
 
528
            except KeyError:
 
529
                raise errors.UnknownFormatError(kind='repository',
 
530
                    format=repo_name)
 
531
            format.repository_format = repo_format
 
532
        if branch_name:
 
533
            try:
 
534
                format.set_branch_format(
 
535
                    branch.network_format_registry.get(branch_name))
 
536
            except KeyError:
 
537
                raise errors.UnknownFormatError(kind='branch',
 
538
                    format=branch_name)
 
539
        return format
 
540
 
419
541
    def _vfs_cloning_metadir(self, require_stacking=False):
420
542
        self._ensure_real()
421
543
        return self._real_bzrdir.cloning_metadir(
451
573
        if len(branch_info) != 2:
452
574
            raise errors.UnexpectedSmartServerResponse(response)
453
575
        branch_ref, branch_name = branch_info
454
 
        format = controldir.network_format_registry.get(control_name)
 
576
        try:
 
577
            format = controldir.network_format_registry.get(control_name)
 
578
        except KeyError:
 
579
            raise errors.UnknownFormatError(kind='control', format=control_name)
 
580
 
455
581
        if repo_name:
456
 
            format.repository_format = _mod_repository.network_format_registry.get(
457
 
                repo_name)
 
582
            try:
 
583
                format.repository_format = _mod_repository.network_format_registry.get(
 
584
                    repo_name)
 
585
            except KeyError:
 
586
                raise errors.UnknownFormatError(kind='repository',
 
587
                    format=repo_name)
458
588
        if branch_ref == 'ref':
459
589
            # XXX: we need possible_transports here to avoid reopening the
460
590
            # connection to the referenced location
463
593
            format.set_branch_format(branch_format)
464
594
        elif branch_ref == 'branch':
465
595
            if branch_name:
466
 
                format.set_branch_format(
467
 
                    branch.network_format_registry.get(branch_name))
 
596
                try:
 
597
                    branch_format = branch.network_format_registry.get(
 
598
                        branch_name)
 
599
                except KeyError:
 
600
                    raise errors.UnknownFormatError(kind='branch',
 
601
                        format=branch_name)
 
602
                format.set_branch_format(branch_format)
468
603
        else:
469
604
            raise errors.UnexpectedSmartServerResponse(response)
470
605
        return format
480
615
 
481
616
    def destroy_repository(self):
482
617
        """See BzrDir.destroy_repository"""
483
 
        self._ensure_real()
484
 
        self._real_bzrdir.destroy_repository()
 
618
        path = self._path_for_remote_call(self._client)
 
619
        try:
 
620
            response = self._call('BzrDir.destroy_repository', path)
 
621
        except errors.UnknownSmartMethod:
 
622
            self._ensure_real()
 
623
            self._real_bzrdir.destroy_repository()
 
624
            return
 
625
        if response[0] != 'ok':
 
626
            raise SmartProtocolError('unexpected response code %s' % (response,))
485
627
 
486
 
    def create_branch(self, name=None, repository=None):
 
628
    def create_branch(self, name=None, repository=None,
 
629
                      append_revisions_only=None):
 
630
        if name is None:
 
631
            name = self._get_selected_branch()
 
632
        if name != "":
 
633
            raise errors.NoColocatedBranchSupport(self)
487
634
        # as per meta1 formats - just delegate to the format object which may
488
635
        # be parameterised.
489
636
        real_branch = self._format.get_branch_format().initialize(self,
490
 
            name=name, repository=repository)
 
637
            name=name, repository=repository,
 
638
            append_revisions_only=append_revisions_only)
491
639
        if not isinstance(real_branch, RemoteBranch):
492
640
            if not isinstance(repository, RemoteRepository):
493
641
                raise AssertionError(
507
655
 
508
656
    def destroy_branch(self, name=None):
509
657
        """See BzrDir.destroy_branch"""
510
 
        self._ensure_real()
511
 
        self._real_bzrdir.destroy_branch(name=name)
 
658
        if name is None:
 
659
            name = self._get_selected_branch()
 
660
        if name != "":
 
661
            raise errors.NoColocatedBranchSupport(self)
 
662
        path = self._path_for_remote_call(self._client)
 
663
        try:
 
664
            if name != "":
 
665
                args = (name, )
 
666
            else:
 
667
                args = ()
 
668
            response = self._call('BzrDir.destroy_branch', path, *args)
 
669
        except errors.UnknownSmartMethod:
 
670
            self._ensure_real()
 
671
            self._real_bzrdir.destroy_branch(name=name)
 
672
            self._next_open_branch_result = None
 
673
            return
512
674
        self._next_open_branch_result = None
 
675
        if response[0] != 'ok':
 
676
            raise SmartProtocolError('unexpected response code %s' % (response,))
513
677
 
514
678
    def create_workingtree(self, revision_id=None, from_branch=None,
515
679
        accelerator_tree=None, hardlink=False):
523
687
        b = self.open_branch(name=name)
524
688
        return b._format
525
689
 
 
690
    def get_branches(self, possible_transports=None, ignore_fallbacks=False):
 
691
        path = self._path_for_remote_call(self._client)
 
692
        try:
 
693
            response, handler = self._call_expecting_body(
 
694
                'BzrDir.get_branches', path)
 
695
        except errors.UnknownSmartMethod:
 
696
            self._ensure_real()
 
697
            return self._real_bzrdir.get_branches()
 
698
        if response[0] != "success":
 
699
            raise errors.UnexpectedSmartServerResponse(response)
 
700
        body = bencode.bdecode(handler.read_body_bytes())
 
701
        ret = {}
 
702
        for (name, value) in body.iteritems():
 
703
            ret[name] = self._open_branch(name, value[0], value[1],
 
704
                possible_transports=possible_transports,
 
705
                ignore_fallbacks=ignore_fallbacks)
 
706
        return ret
 
707
 
 
708
    def set_branch_reference(self, target_branch, name=None):
 
709
        """See BzrDir.set_branch_reference()."""
 
710
        if name is None:
 
711
            name = self._get_selected_branch()
 
712
        if name != "":
 
713
            raise errors.NoColocatedBranchSupport(self)
 
714
        self._ensure_real()
 
715
        return self._real_bzrdir.set_branch_reference(target_branch, name=name)
 
716
 
526
717
    def get_branch_reference(self, name=None):
527
718
        """See BzrDir.get_branch_reference()."""
528
 
        if name is not None:
529
 
            # XXX JRV20100304: Support opening colocated branches
 
719
        if name is None:
 
720
            name = self._get_selected_branch()
 
721
        if name != "":
530
722
            raise errors.NoColocatedBranchSupport(self)
531
723
        response = self._get_branch_reference()
532
724
        if response[0] == 'ref':
568
760
        """See BzrDir._get_tree_branch()."""
569
761
        return None, self.open_branch(name=name)
570
762
 
571
 
    def open_branch(self, name=None, unsupported=False,
572
 
                    ignore_fallbacks=False):
573
 
        if unsupported:
574
 
            raise NotImplementedError('unsupported flag support not implemented yet.')
575
 
        if self._next_open_branch_result is not None:
576
 
            # See create_branch for details.
577
 
            result = self._next_open_branch_result
578
 
            self._next_open_branch_result = None
579
 
            return result
580
 
        response = self._get_branch_reference()
581
 
        if response[0] == 'ref':
 
763
    def _open_branch(self, name, kind, location_or_format,
 
764
                     ignore_fallbacks=False, possible_transports=None):
 
765
        if kind == 'ref':
582
766
            # a branch reference, use the existing BranchReference logic.
583
767
            format = BranchReferenceFormat()
584
768
            return format.open(self, name=name, _found=True,
585
 
                location=response[1], ignore_fallbacks=ignore_fallbacks)
586
 
        branch_format_name = response[1]
 
769
                location=location_or_format, ignore_fallbacks=ignore_fallbacks,
 
770
                possible_transports=possible_transports)
 
771
        branch_format_name = location_or_format
587
772
        if not branch_format_name:
588
773
            branch_format_name = None
589
774
        format = RemoteBranchFormat(network_name=branch_format_name)
590
775
        return RemoteBranch(self, self.find_repository(), format=format,
591
 
            setup_stacking=not ignore_fallbacks, name=name)
 
776
            setup_stacking=not ignore_fallbacks, name=name,
 
777
            possible_transports=possible_transports)
 
778
 
 
779
    def open_branch(self, name=None, unsupported=False,
 
780
                    ignore_fallbacks=False, possible_transports=None):
 
781
        if name is None:
 
782
            name = self._get_selected_branch()
 
783
        if name != "":
 
784
            raise errors.NoColocatedBranchSupport(self)
 
785
        if unsupported:
 
786
            raise NotImplementedError('unsupported flag support not implemented yet.')
 
787
        if self._next_open_branch_result is not None:
 
788
            # See create_branch for details.
 
789
            result = self._next_open_branch_result
 
790
            self._next_open_branch_result = None
 
791
            return result
 
792
        response = self._get_branch_reference()
 
793
        return self._open_branch(name, response[0], response[1],
 
794
            possible_transports=possible_transports,
 
795
            ignore_fallbacks=ignore_fallbacks)
592
796
 
593
797
    def _open_repo_v1(self, path):
594
798
        verb = 'BzrDir.find_repository'
657
861
 
658
862
    def has_workingtree(self):
659
863
        if self._has_working_tree is None:
660
 
            self._ensure_real()
661
 
            self._has_working_tree = self._real_bzrdir.has_workingtree()
 
864
            path = self._path_for_remote_call(self._client)
 
865
            try:
 
866
                response = self._call('BzrDir.has_workingtree', path)
 
867
            except errors.UnknownSmartMethod:
 
868
                self._ensure_real()
 
869
                self._has_working_tree = self._real_bzrdir.has_workingtree()
 
870
            else:
 
871
                if response[0] not in ('yes', 'no'):
 
872
                    raise SmartProtocolError('unexpected response code %s' % (response,))
 
873
                self._has_working_tree = (response[0] == 'yes')
662
874
        return self._has_working_tree
663
875
 
664
876
    def open_workingtree(self, recommend_upgrade=True):
692
904
        """Upgrading of remote bzrdirs is not supported yet."""
693
905
        return False
694
906
 
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
907
    def _get_config(self):
702
908
        return RemoteBzrDirConfig(self)
703
909
 
 
910
    def _get_config_store(self):
 
911
        return RemoteControlStore(self)
 
912
 
704
913
 
705
914
class RemoteRepositoryFormat(vf_repository.VersionedFileRepositoryFormat):
706
915
    """Format for repositories accessed over a _SmartClient.
736
945
        self._supports_external_lookups = None
737
946
        self._supports_tree_reference = None
738
947
        self._supports_funky_characters = None
 
948
        self._supports_nesting_repositories = None
739
949
        self._rich_root_data = None
740
950
 
741
951
    def __repr__(self):
778
988
        return self._supports_funky_characters
779
989
 
780
990
    @property
 
991
    def supports_nesting_repositories(self):
 
992
        if self._supports_nesting_repositories is None:
 
993
            self._ensure_real()
 
994
            self._supports_nesting_repositories = \
 
995
                self._custom_format.supports_nesting_repositories
 
996
        return self._supports_nesting_repositories
 
997
 
 
998
    @property
781
999
    def supports_tree_reference(self):
782
1000
        if self._supports_tree_reference is None:
783
1001
            self._ensure_real()
865
1083
 
866
1084
    def _ensure_real(self):
867
1085
        if self._custom_format is None:
868
 
            self._custom_format = _mod_repository.network_format_registry.get(
869
 
                self._network_name)
 
1086
            try:
 
1087
                self._custom_format = _mod_repository.network_format_registry.get(
 
1088
                    self._network_name)
 
1089
            except KeyError:
 
1090
                raise errors.UnknownFormatError(kind='repository',
 
1091
                    format=self._network_name)
870
1092
 
871
1093
    @property
872
1094
    def _fetch_order(self):
907
1129
        return self._custom_format._serializer
908
1130
 
909
1131
 
910
 
class RemoteRepository(_RpcHelper, lock._RelockDebugMixin,
911
 
    controldir.ControlComponent):
 
1132
class RemoteRepository(_mod_repository.Repository, _RpcHelper,
 
1133
        lock._RelockDebugMixin):
912
1134
    """Repository accessed over rpc.
913
1135
 
914
1136
    For the moment most operations are performed using local transport-backed
938
1160
        self._format = format
939
1161
        self._lock_mode = None
940
1162
        self._lock_token = None
 
1163
        self._write_group_tokens = None
941
1164
        self._lock_count = 0
942
1165
        self._leave_lock = False
943
1166
        # Cache of revision parents; misses are cached during read locks, and
983
1206
 
984
1207
        :param suppress_errors: see Repository.abort_write_group.
985
1208
        """
986
 
        self._ensure_real()
987
 
        return self._real_repository.abort_write_group(
988
 
            suppress_errors=suppress_errors)
 
1209
        if self._real_repository:
 
1210
            self._ensure_real()
 
1211
            return self._real_repository.abort_write_group(
 
1212
                suppress_errors=suppress_errors)
 
1213
        if not self.is_in_write_group():
 
1214
            if suppress_errors:
 
1215
                mutter('(suppressed) not in write group')
 
1216
                return
 
1217
            raise errors.BzrError("not in write group")
 
1218
        path = self.bzrdir._path_for_remote_call(self._client)
 
1219
        try:
 
1220
            response = self._call('Repository.abort_write_group', path,
 
1221
                self._lock_token, self._write_group_tokens)
 
1222
        except Exception, exc:
 
1223
            self._write_group = None
 
1224
            if not suppress_errors:
 
1225
                raise
 
1226
            mutter('abort_write_group failed')
 
1227
            log_exception_quietly()
 
1228
            note(gettext('bzr: ERROR (ignored): %s'), exc)
 
1229
        else:
 
1230
            if response != ('ok', ):
 
1231
                raise errors.UnexpectedSmartServerResponse(response)
 
1232
            self._write_group_tokens = None
989
1233
 
990
1234
    @property
991
1235
    def chk_bytes(self):
1005
1249
        for older plugins that don't use e.g. the CommitBuilder
1006
1250
        facility.
1007
1251
        """
1008
 
        self._ensure_real()
1009
 
        return self._real_repository.commit_write_group()
 
1252
        if self._real_repository:
 
1253
            self._ensure_real()
 
1254
            return self._real_repository.commit_write_group()
 
1255
        if not self.is_in_write_group():
 
1256
            raise errors.BzrError("not in write group")
 
1257
        path = self.bzrdir._path_for_remote_call(self._client)
 
1258
        response = self._call('Repository.commit_write_group', path,
 
1259
            self._lock_token, self._write_group_tokens)
 
1260
        if response != ('ok', ):
 
1261
            raise errors.UnexpectedSmartServerResponse(response)
 
1262
        self._write_group_tokens = None
 
1263
        # Refresh data after writing to the repository.
 
1264
        self.refresh_data()
1010
1265
 
1011
1266
    def resume_write_group(self, tokens):
1012
 
        self._ensure_real()
1013
 
        return self._real_repository.resume_write_group(tokens)
 
1267
        if self._real_repository:
 
1268
            return self._real_repository.resume_write_group(tokens)
 
1269
        path = self.bzrdir._path_for_remote_call(self._client)
 
1270
        try:
 
1271
            response = self._call('Repository.check_write_group', path,
 
1272
               self._lock_token, tokens)
 
1273
        except errors.UnknownSmartMethod:
 
1274
            self._ensure_real()
 
1275
            return self._real_repository.resume_write_group(tokens)
 
1276
        if response != ('ok', ):
 
1277
            raise errors.UnexpectedSmartServerResponse(response)
 
1278
        self._write_group_tokens = tokens
1014
1279
 
1015
1280
    def suspend_write_group(self):
1016
 
        self._ensure_real()
1017
 
        return self._real_repository.suspend_write_group()
 
1281
        if self._real_repository:
 
1282
            return self._real_repository.suspend_write_group()
 
1283
        ret = self._write_group_tokens or []
 
1284
        self._write_group_tokens = None
 
1285
        return ret
1018
1286
 
1019
1287
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
1020
1288
        self._ensure_real()
1230
1498
 
1231
1499
    def get_physical_lock_status(self):
1232
1500
        """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()
 
1501
        path = self.bzrdir._path_for_remote_call(self._client)
 
1502
        try:
 
1503
            response = self._call('Repository.get_physical_lock_status', path)
 
1504
        except errors.UnknownSmartMethod:
 
1505
            self._ensure_real()
 
1506
            return self._real_repository.get_physical_lock_status()
 
1507
        if response[0] not in ('yes', 'no'):
 
1508
            raise errors.UnexpectedSmartServerResponse(response)
 
1509
        return (response[0] == 'yes')
1236
1510
 
1237
1511
    def is_in_write_group(self):
1238
1512
        """Return True if there is an open write group.
1239
1513
 
1240
1514
        write groups are only applicable locally for the smart server..
1241
1515
        """
 
1516
        if self._write_group_tokens is not None:
 
1517
            return True
1242
1518
        if self._real_repository:
1243
1519
            return self._real_repository.is_in_write_group()
1244
1520
 
1379
1655
            self._real_repository.lock_write(self._lock_token)
1380
1656
        elif self._lock_mode == 'r':
1381
1657
            self._real_repository.lock_read()
 
1658
        if self._write_group_tokens is not None:
 
1659
            # if we are already in a write group, resume it
 
1660
            self._real_repository.resume_write_group(self._write_group_tokens)
 
1661
            self._write_group_tokens = None
1382
1662
 
1383
1663
    def start_write_group(self):
1384
1664
        """Start a write group on the decorated repository.
1388
1668
        for older plugins that don't use e.g. the CommitBuilder
1389
1669
        facility.
1390
1670
        """
1391
 
        self._ensure_real()
1392
 
        return self._real_repository.start_write_group()
 
1671
        if self._real_repository:
 
1672
            self._ensure_real()
 
1673
            return self._real_repository.start_write_group()
 
1674
        if not self.is_write_locked():
 
1675
            raise errors.NotWriteLocked(self)
 
1676
        if self._write_group_tokens is not None:
 
1677
            raise errors.BzrError('already in a write group')
 
1678
        path = self.bzrdir._path_for_remote_call(self._client)
 
1679
        try:
 
1680
            response = self._call('Repository.start_write_group', path,
 
1681
                self._lock_token)
 
1682
        except (errors.UnknownSmartMethod, errors.UnsuspendableWriteGroup):
 
1683
            self._ensure_real()
 
1684
            return self._real_repository.start_write_group()
 
1685
        if response[0] != 'ok':
 
1686
            raise errors.UnexpectedSmartServerResponse(response)
 
1687
        self._write_group_tokens = response[1]
1393
1688
 
1394
1689
    def _unlock(self, token):
1395
1690
        path = self.bzrdir._path_for_remote_call(self._client)
1422
1717
            # This is just to let the _real_repository stay up to date.
1423
1718
            if self._real_repository is not None:
1424
1719
                self._real_repository.unlock()
 
1720
            elif self._write_group_tokens is not None:
 
1721
                self.abort_write_group()
1425
1722
        finally:
1426
1723
            # The rpc-level lock should be released even if there was a
1427
1724
            # problem releasing the vfs-based lock.
1439
1736
 
1440
1737
    def break_lock(self):
1441
1738
        # should hand off to the network
1442
 
        self._ensure_real()
1443
 
        return self._real_repository.break_lock()
 
1739
        path = self.bzrdir._path_for_remote_call(self._client)
 
1740
        try:
 
1741
            response = self._call("Repository.break_lock", path)
 
1742
        except errors.UnknownSmartMethod:
 
1743
            self._ensure_real()
 
1744
            return self._real_repository.break_lock()
 
1745
        if response != ('ok',):
 
1746
            raise errors.UnexpectedSmartServerResponse(response)
1444
1747
 
1445
1748
    def _get_tarball(self, compression):
1446
1749
        """Return a TemporaryFile containing a repository tarball.
1464
1767
            return t
1465
1768
        raise errors.UnexpectedSmartServerResponse(response)
1466
1769
 
 
1770
    @needs_read_lock
1467
1771
    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)
 
1772
        """Create a descendent repository for new development.
 
1773
 
 
1774
        Unlike clone, this does not copy the settings of the repository.
 
1775
        """
 
1776
        dest_repo = self._create_sprouting_repo(to_bzrdir, shared=False)
1472
1777
        dest_repo.fetch(self, revision_id=revision_id)
1473
1778
        return dest_repo
1474
1779
 
 
1780
    def _create_sprouting_repo(self, a_bzrdir, shared):
 
1781
        if not isinstance(a_bzrdir._format, self.bzrdir._format.__class__):
 
1782
            # use target default format.
 
1783
            dest_repo = a_bzrdir.create_repository()
 
1784
        else:
 
1785
            # Most control formats need the repository to be specifically
 
1786
            # created, but on some old all-in-one formats it's not needed
 
1787
            try:
 
1788
                dest_repo = self._format.initialize(a_bzrdir, shared=shared)
 
1789
            except errors.UninitializableFormat:
 
1790
                dest_repo = a_bzrdir.open_repository()
 
1791
        return dest_repo
 
1792
 
1475
1793
    ### These methods are just thin shims to the VFS object for now.
1476
1794
 
 
1795
    @needs_read_lock
1477
1796
    def revision_tree(self, revision_id):
1478
 
        self._ensure_real()
1479
 
        return self._real_repository.revision_tree(revision_id)
 
1797
        revision_id = _mod_revision.ensure_null(revision_id)
 
1798
        if revision_id == _mod_revision.NULL_REVISION:
 
1799
            return InventoryRevisionTree(self,
 
1800
                Inventory(root_id=None), _mod_revision.NULL_REVISION)
 
1801
        else:
 
1802
            return list(self.revision_trees([revision_id]))[0]
1480
1803
 
1481
1804
    def get_serializer_format(self):
1482
 
        self._ensure_real()
1483
 
        return self._real_repository.get_serializer_format()
 
1805
        path = self.bzrdir._path_for_remote_call(self._client)
 
1806
        try:
 
1807
            response = self._call('VersionedFileRepository.get_serializer_format',
 
1808
                path)
 
1809
        except errors.UnknownSmartMethod:
 
1810
            self._ensure_real()
 
1811
            return self._real_repository.get_serializer_format()
 
1812
        if response[0] != 'ok':
 
1813
            raise errors.UnexpectedSmartServerResponse(response)
 
1814
        return response[1]
1484
1815
 
1485
1816
    def get_commit_builder(self, branch, parents, config, timestamp=None,
1486
1817
                           timezone=None, committer=None, revprops=None,
1487
1818
                           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
 
1819
        """Obtain a CommitBuilder for this repository.
 
1820
 
 
1821
        :param branch: Branch to commit to.
 
1822
        :param parents: Revision ids of the parents of the new revision.
 
1823
        :param config: Configuration to use.
 
1824
        :param timestamp: Optional timestamp recorded for commit.
 
1825
        :param timezone: Optional timezone for timestamp.
 
1826
        :param committer: Optional committer to set for commit.
 
1827
        :param revprops: Optional dictionary of revision properties.
 
1828
        :param revision_id: Optional revision id.
 
1829
        :param lossy: Whether to discard data that can not be natively
 
1830
            represented, when pushing to a foreign VCS
 
1831
        """
 
1832
        if self._fallback_repositories and not self._format.supports_chks:
 
1833
            raise errors.BzrError("Cannot commit directly to a stacked branch"
 
1834
                " in pre-2a formats. See "
 
1835
                "https://bugs.launchpad.net/bzr/+bug/375013 for details.")
 
1836
        if self._format.rich_root_data:
 
1837
            commit_builder_kls = vf_repository.VersionedFileRootCommitBuilder
 
1838
        else:
 
1839
            commit_builder_kls = vf_repository.VersionedFileCommitBuilder
 
1840
        result = commit_builder_kls(self, parents, config,
 
1841
            timestamp, timezone, committer, revprops, revision_id,
 
1842
            lossy)
 
1843
        self.start_write_group()
 
1844
        return result
1497
1845
 
1498
1846
    def add_fallback_repository(self, repository):
1499
1847
        """Add a repository to use for looking up data not held locally.
1506
1854
        # We need to accumulate additional repositories here, to pass them in
1507
1855
        # on various RPC's.
1508
1856
        #
 
1857
        # Make the check before we lock: this raises an exception.
 
1858
        self._check_fallback_repository(repository)
1509
1859
        if self.is_locked():
1510
1860
            # We will call fallback.unlock() when we transition to the unlocked
1511
1861
            # state, so always add a lock here. If a caller passes us a locked
1512
1862
            # repository, they are responsible for unlocking it later.
1513
1863
            repository.lock_read()
1514
 
        self._check_fallback_repository(repository)
1515
1864
        self._fallback_repositories.append(repository)
1516
1865
        # If self._real_repository was parameterised already (e.g. because a
1517
1866
        # _real_branch had its get_stacked_on_url method called), then the
1543
1892
            delta, new_revision_id, parents, basis_inv=basis_inv,
1544
1893
            propagate_caches=propagate_caches)
1545
1894
 
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)
 
1895
    def add_revision(self, revision_id, rev, inv=None):
 
1896
        _mod_revision.check_not_reserved_id(revision_id)
 
1897
        key = (revision_id,)
 
1898
        # check inventory present
 
1899
        if not self.inventories.get_parent_map([key]):
 
1900
            if inv is None:
 
1901
                raise errors.WeaveRevisionNotPresent(revision_id,
 
1902
                                                     self.inventories)
 
1903
            else:
 
1904
                # yes, this is not suitable for adding with ghosts.
 
1905
                rev.inventory_sha1 = self.add_inventory(revision_id, inv,
 
1906
                                                        rev.parent_ids)
 
1907
        else:
 
1908
            rev.inventory_sha1 = self.inventories.get_sha1s([key])[key]
 
1909
        self._add_revision(rev)
 
1910
 
 
1911
    def _add_revision(self, rev):
 
1912
        if self._real_repository is not None:
 
1913
            return self._real_repository._add_revision(rev)
 
1914
        text = self._serializer.write_revision_to_string(rev)
 
1915
        key = (rev.revision_id,)
 
1916
        parents = tuple((parent,) for parent in rev.parent_ids)
 
1917
        self._write_group_tokens, missing_keys = self._get_sink().insert_stream(
 
1918
            [('revisions', [FulltextContentFactory(key, parents, None, text)])],
 
1919
            self._format, self._write_group_tokens)
1550
1920
 
1551
1921
    @needs_read_lock
1552
1922
    def get_inventory(self, revision_id):
 
1923
        return list(self.iter_inventories([revision_id]))[0]
 
1924
 
 
1925
    def _iter_inventories_rpc(self, revision_ids, ordering):
 
1926
        if ordering is None:
 
1927
            ordering = 'unordered'
 
1928
        path = self.bzrdir._path_for_remote_call(self._client)
 
1929
        body = "\n".join(revision_ids)
 
1930
        response_tuple, response_handler = (
 
1931
            self._call_with_body_bytes_expecting_body(
 
1932
                "VersionedFileRepository.get_inventories",
 
1933
                (path, ordering), body))
 
1934
        if response_tuple[0] != "ok":
 
1935
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
1936
        deserializer = inventory_delta.InventoryDeltaDeserializer()
 
1937
        byte_stream = response_handler.read_streamed_body()
 
1938
        decoded = smart_repo._byte_stream_to_stream(byte_stream)
 
1939
        if decoded is None:
 
1940
            # no results whatsoever
 
1941
            return
 
1942
        src_format, stream = decoded
 
1943
        if src_format.network_name() != self._format.network_name():
 
1944
            raise AssertionError(
 
1945
                "Mismatched RemoteRepository and stream src %r, %r" % (
 
1946
                src_format.network_name(), self._format.network_name()))
 
1947
        # ignore the src format, it's not really relevant
 
1948
        prev_inv = Inventory(root_id=None,
 
1949
            revision_id=_mod_revision.NULL_REVISION)
 
1950
        # there should be just one substream, with inventory deltas
 
1951
        substream_kind, substream = stream.next()
 
1952
        if substream_kind != "inventory-deltas":
 
1953
            raise AssertionError(
 
1954
                 "Unexpected stream %r received" % substream_kind)
 
1955
        for record in substream:
 
1956
            (parent_id, new_id, versioned_root, tree_references, invdelta) = (
 
1957
                deserializer.parse_text_bytes(record.get_bytes_as("fulltext")))
 
1958
            if parent_id != prev_inv.revision_id:
 
1959
                raise AssertionError("invalid base %r != %r" % (parent_id,
 
1960
                    prev_inv.revision_id))
 
1961
            inv = prev_inv.create_by_apply_delta(invdelta, new_id)
 
1962
            yield inv, inv.revision_id
 
1963
            prev_inv = inv
 
1964
 
 
1965
    def _iter_inventories_vfs(self, revision_ids, ordering=None):
1553
1966
        self._ensure_real()
1554
 
        return self._real_repository.get_inventory(revision_id)
 
1967
        return self._real_repository._iter_inventories(revision_ids, ordering)
1555
1968
 
1556
1969
    def iter_inventories(self, revision_ids, ordering=None):
1557
 
        self._ensure_real()
1558
 
        return self._real_repository.iter_inventories(revision_ids, ordering)
 
1970
        """Get many inventories by revision_ids.
 
1971
 
 
1972
        This will buffer some or all of the texts used in constructing the
 
1973
        inventories in memory, but will only parse a single inventory at a
 
1974
        time.
 
1975
 
 
1976
        :param revision_ids: The expected revision ids of the inventories.
 
1977
        :param ordering: optional ordering, e.g. 'topological'.  If not
 
1978
            specified, the order of revision_ids will be preserved (by
 
1979
            buffering if necessary).
 
1980
        :return: An iterator of inventories.
 
1981
        """
 
1982
        if ((None in revision_ids)
 
1983
            or (_mod_revision.NULL_REVISION in revision_ids)):
 
1984
            raise ValueError('cannot get null revision inventory')
 
1985
        for inv, revid in self._iter_inventories(revision_ids, ordering):
 
1986
            if inv is None:
 
1987
                raise errors.NoSuchRevision(self, revid)
 
1988
            yield inv
 
1989
 
 
1990
    def _iter_inventories(self, revision_ids, ordering=None):
 
1991
        if len(revision_ids) == 0:
 
1992
            return
 
1993
        missing = set(revision_ids)
 
1994
        if ordering is None:
 
1995
            order_as_requested = True
 
1996
            invs = {}
 
1997
            order = list(revision_ids)
 
1998
            order.reverse()
 
1999
            next_revid = order.pop()
 
2000
        else:
 
2001
            order_as_requested = False
 
2002
            if ordering != 'unordered' and self._fallback_repositories:
 
2003
                raise ValueError('unsupported ordering %r' % ordering)
 
2004
        iter_inv_fns = [self._iter_inventories_rpc] + [
 
2005
            fallback._iter_inventories for fallback in
 
2006
            self._fallback_repositories]
 
2007
        try:
 
2008
            for iter_inv in iter_inv_fns:
 
2009
                request = [revid for revid in revision_ids if revid in missing]
 
2010
                for inv, revid in iter_inv(request, ordering):
 
2011
                    if inv is None:
 
2012
                        continue
 
2013
                    missing.remove(inv.revision_id)
 
2014
                    if ordering != 'unordered':
 
2015
                        invs[revid] = inv
 
2016
                    else:
 
2017
                        yield inv, revid
 
2018
                if order_as_requested:
 
2019
                    # Yield as many results as we can while preserving order.
 
2020
                    while next_revid in invs:
 
2021
                        inv = invs.pop(next_revid)
 
2022
                        yield inv, inv.revision_id
 
2023
                        try:
 
2024
                            next_revid = order.pop()
 
2025
                        except IndexError:
 
2026
                            # We still want to fully consume the stream, just
 
2027
                            # in case it is not actually finished at this point
 
2028
                            next_revid = None
 
2029
                            break
 
2030
        except errors.UnknownSmartMethod:
 
2031
            for inv, revid in self._iter_inventories_vfs(revision_ids, ordering):
 
2032
                yield inv, revid
 
2033
            return
 
2034
        # Report missing
 
2035
        if order_as_requested:
 
2036
            if next_revid is not None:
 
2037
                yield None, next_revid
 
2038
            while order:
 
2039
                revid = order.pop()
 
2040
                yield invs.get(revid), revid
 
2041
        else:
 
2042
            while missing:
 
2043
                yield None, missing.pop()
1559
2044
 
1560
2045
    @needs_read_lock
1561
2046
    def get_revision(self, revision_id):
1562
 
        self._ensure_real()
1563
 
        return self._real_repository.get_revision(revision_id)
 
2047
        return self.get_revisions([revision_id])[0]
1564
2048
 
1565
2049
    def get_transaction(self):
1566
2050
        self._ensure_real()
1568
2052
 
1569
2053
    @needs_read_lock
1570
2054
    def clone(self, a_bzrdir, revision_id=None):
1571
 
        self._ensure_real()
1572
 
        return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
 
2055
        dest_repo = self._create_sprouting_repo(
 
2056
            a_bzrdir, shared=self.is_shared())
 
2057
        self.copy_content_into(dest_repo, revision_id)
 
2058
        return dest_repo
1573
2059
 
1574
2060
    def make_working_trees(self):
1575
2061
        """See Repository.make_working_trees"""
1576
 
        self._ensure_real()
1577
 
        return self._real_repository.make_working_trees()
 
2062
        path = self.bzrdir._path_for_remote_call(self._client)
 
2063
        try:
 
2064
            response = self._call('Repository.make_working_trees', path)
 
2065
        except errors.UnknownSmartMethod:
 
2066
            self._ensure_real()
 
2067
            return self._real_repository.make_working_trees()
 
2068
        if response[0] not in ('yes', 'no'):
 
2069
            raise SmartProtocolError('unexpected response code %s' % (response,))
 
2070
        return response[0] == 'yes'
1578
2071
 
1579
2072
    def refresh_data(self):
1580
2073
        """Re-read any data needed to synchronise with disk.
1589
2082
        """
1590
2083
        if self._real_repository is not None:
1591
2084
            self._real_repository.refresh_data()
 
2085
        # Refresh the parents cache for this object
 
2086
        self._unstacked_provider.disable_cache()
 
2087
        self._unstacked_provider.enable_cache()
1592
2088
 
1593
2089
    def revision_ids_to_search_result(self, result_set):
1594
2090
        """Convert a set of revision ids to a graph SearchResult."""
1599
2095
        included_keys = result_set.intersection(result_parents)
1600
2096
        start_keys = result_set.difference(included_keys)
1601
2097
        exclude_keys = result_parents.difference(result_set)
1602
 
        result = graph.SearchResult(start_keys, exclude_keys,
 
2098
        result = vf_search.SearchResult(start_keys, exclude_keys,
1603
2099
            len(result_set), result_set)
1604
2100
        return result
1605
2101
 
1653
2149
        # the InterRepository base class, which raises an
1654
2150
        # IncompatibleRepositories when asked to fetch.
1655
2151
        inter = _mod_repository.InterRepository.get(source, self)
 
2152
        if (fetch_spec is not None and
 
2153
            not getattr(inter, "supports_fetch_spec", False)):
 
2154
            raise errors.UnsupportedOperation(
 
2155
                "fetch_spec not supported for %r" % inter)
1656
2156
        return inter.fetch(revision_id=revision_id,
1657
2157
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
1658
2158
 
1676
2176
        return self._real_repository._get_versioned_file_checker(
1677
2177
            revisions, revision_versions_cache)
1678
2178
 
 
2179
    def _iter_files_bytes_rpc(self, desired_files, absent):
 
2180
        path = self.bzrdir._path_for_remote_call(self._client)
 
2181
        lines = []
 
2182
        identifiers = []
 
2183
        for (file_id, revid, identifier) in desired_files:
 
2184
            lines.append("%s\0%s" % (
 
2185
                osutils.safe_file_id(file_id),
 
2186
                osutils.safe_revision_id(revid)))
 
2187
            identifiers.append(identifier)
 
2188
        (response_tuple, response_handler) = (
 
2189
            self._call_with_body_bytes_expecting_body(
 
2190
            "Repository.iter_files_bytes", (path, ), "\n".join(lines)))
 
2191
        if response_tuple != ('ok', ):
 
2192
            response_handler.cancel_read_body()
 
2193
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
2194
        byte_stream = response_handler.read_streamed_body()
 
2195
        def decompress_stream(start, byte_stream, unused):
 
2196
            decompressor = zlib.decompressobj()
 
2197
            yield decompressor.decompress(start)
 
2198
            while decompressor.unused_data == "":
 
2199
                try:
 
2200
                    data = byte_stream.next()
 
2201
                except StopIteration:
 
2202
                    break
 
2203
                yield decompressor.decompress(data)
 
2204
            yield decompressor.flush()
 
2205
            unused.append(decompressor.unused_data)
 
2206
        unused = ""
 
2207
        while True:
 
2208
            while not "\n" in unused:
 
2209
                unused += byte_stream.next()
 
2210
            header, rest = unused.split("\n", 1)
 
2211
            args = header.split("\0")
 
2212
            if args[0] == "absent":
 
2213
                absent[identifiers[int(args[3])]] = (args[1], args[2])
 
2214
                unused = rest
 
2215
                continue
 
2216
            elif args[0] == "ok":
 
2217
                idx = int(args[1])
 
2218
            else:
 
2219
                raise errors.UnexpectedSmartServerResponse(args)
 
2220
            unused_chunks = []
 
2221
            yield (identifiers[idx],
 
2222
                decompress_stream(rest, byte_stream, unused_chunks))
 
2223
            unused = "".join(unused_chunks)
 
2224
 
1679
2225
    def iter_files_bytes(self, desired_files):
1680
2226
        """See Repository.iter_file_bytes.
1681
2227
        """
1682
 
        self._ensure_real()
1683
 
        return self._real_repository.iter_files_bytes(desired_files)
 
2228
        try:
 
2229
            absent = {}
 
2230
            for (identifier, bytes_iterator) in self._iter_files_bytes_rpc(
 
2231
                    desired_files, absent):
 
2232
                yield identifier, bytes_iterator
 
2233
            for fallback in self._fallback_repositories:
 
2234
                if not absent:
 
2235
                    break
 
2236
                desired_files = [(key[0], key[1], identifier) for
 
2237
                    (identifier, key) in absent.iteritems()]
 
2238
                for (identifier, bytes_iterator) in fallback.iter_files_bytes(desired_files):
 
2239
                    del absent[identifier]
 
2240
                    yield identifier, bytes_iterator
 
2241
            if absent:
 
2242
                # There may be more missing items, but raise an exception
 
2243
                # for just one.
 
2244
                missing_identifier = absent.keys()[0]
 
2245
                missing_key = absent[missing_identifier]
 
2246
                raise errors.RevisionNotPresent(revision_id=missing_key[1],
 
2247
                    file_id=missing_key[0])
 
2248
        except errors.UnknownSmartMethod:
 
2249
            self._ensure_real()
 
2250
            for (identifier, bytes_iterator) in (
 
2251
                self._real_repository.iter_files_bytes(desired_files)):
 
2252
                yield identifier, bytes_iterator
 
2253
 
 
2254
    def get_cached_parent_map(self, revision_ids):
 
2255
        """See bzrlib.CachingParentsProvider.get_cached_parent_map"""
 
2256
        return self._unstacked_provider.get_cached_parent_map(revision_ids)
1684
2257
 
1685
2258
    def get_parent_map(self, revision_ids):
1686
2259
        """See bzrlib.Graph.get_parent_map()."""
1745
2318
        if parents_map is None:
1746
2319
            # Repository is not locked, so there's no cache.
1747
2320
            parents_map = {}
1748
 
        # start_set is all the keys in the cache
1749
 
        start_set = set(parents_map)
1750
 
        # result set is all the references to keys in the cache
1751
 
        result_parents = set()
1752
 
        for parents in parents_map.itervalues():
1753
 
            result_parents.update(parents)
1754
 
        stop_keys = result_parents.difference(start_set)
1755
 
        # We don't need to send ghosts back to the server as a position to
1756
 
        # stop either.
1757
 
        stop_keys.difference_update(self._unstacked_provider.missing_keys)
1758
 
        key_count = len(parents_map)
1759
 
        if (NULL_REVISION in result_parents
1760
 
            and NULL_REVISION in self._unstacked_provider.missing_keys):
1761
 
            # If we pruned NULL_REVISION from the stop_keys because it's also
1762
 
            # in our cache of "missing" keys we need to increment our key count
1763
 
            # by 1, because the reconsitituted SearchResult on the server will
1764
 
            # still consider NULL_REVISION to be an included key.
1765
 
            key_count += 1
1766
 
        included_keys = start_set.intersection(result_parents)
1767
 
        start_set.difference_update(included_keys)
 
2321
        if _DEFAULT_SEARCH_DEPTH <= 0:
 
2322
            (start_set, stop_keys,
 
2323
             key_count) = vf_search.search_result_from_parent_map(
 
2324
                parents_map, self._unstacked_provider.missing_keys)
 
2325
        else:
 
2326
            (start_set, stop_keys,
 
2327
             key_count) = vf_search.limited_search_result_from_parent_map(
 
2328
                parents_map, self._unstacked_provider.missing_keys,
 
2329
                keys, depth=_DEFAULT_SEARCH_DEPTH)
1768
2330
        recipe = ('manual', start_set, stop_keys, key_count)
1769
2331
        body = self._serialise_search_recipe(recipe)
1770
2332
        path = self.bzrdir._path_for_remote_call(self._client)
1819
2381
 
1820
2382
    @needs_read_lock
1821
2383
    def get_signature_text(self, revision_id):
1822
 
        self._ensure_real()
1823
 
        return self._real_repository.get_signature_text(revision_id)
 
2384
        path = self.bzrdir._path_for_remote_call(self._client)
 
2385
        try:
 
2386
            response_tuple, response_handler = self._call_expecting_body(
 
2387
                'Repository.get_revision_signature_text', path, revision_id)
 
2388
        except errors.UnknownSmartMethod:
 
2389
            self._ensure_real()
 
2390
            return self._real_repository.get_signature_text(revision_id)
 
2391
        except errors.NoSuchRevision, err:
 
2392
            for fallback in self._fallback_repositories:
 
2393
                try:
 
2394
                    return fallback.get_signature_text(revision_id)
 
2395
                except errors.NoSuchRevision:
 
2396
                    pass
 
2397
            raise err
 
2398
        else:
 
2399
            if response_tuple[0] != 'ok':
 
2400
                raise errors.UnexpectedSmartServerResponse(response_tuple)
 
2401
            return response_handler.read_body_bytes()
1824
2402
 
1825
2403
    @needs_read_lock
1826
2404
    def _get_inventory_xml(self, revision_id):
 
2405
        # This call is used by older working tree formats,
 
2406
        # which stored a serialized basis inventory.
1827
2407
        self._ensure_real()
1828
2408
        return self._real_repository._get_inventory_xml(revision_id)
1829
2409
 
 
2410
    @needs_write_lock
1830
2411
    def reconcile(self, other=None, thorough=False):
1831
 
        self._ensure_real()
1832
 
        return self._real_repository.reconcile(other=other, thorough=thorough)
 
2412
        from bzrlib.reconcile import RepoReconciler
 
2413
        path = self.bzrdir._path_for_remote_call(self._client)
 
2414
        try:
 
2415
            response, handler = self._call_expecting_body(
 
2416
                'Repository.reconcile', path, self._lock_token)
 
2417
        except (errors.UnknownSmartMethod, errors.TokenLockingNotSupported):
 
2418
            self._ensure_real()
 
2419
            return self._real_repository.reconcile(other=other, thorough=thorough)
 
2420
        if response != ('ok', ):
 
2421
            raise errors.UnexpectedSmartServerResponse(response)
 
2422
        body = handler.read_body_bytes()
 
2423
        result = RepoReconciler(self)
 
2424
        for line in body.split('\n'):
 
2425
            if not line:
 
2426
                continue
 
2427
            key, val_text = line.split(':')
 
2428
            if key == "garbage_inventories":
 
2429
                result.garbage_inventories = int(val_text)
 
2430
            elif key == "inconsistent_parents":
 
2431
                result.inconsistent_parents = int(val_text)
 
2432
            else:
 
2433
                mutter("unknown reconcile key %r" % key)
 
2434
        return result
1833
2435
 
1834
2436
    def all_revision_ids(self):
1835
 
        self._ensure_real()
1836
 
        return self._real_repository.all_revision_ids()
 
2437
        path = self.bzrdir._path_for_remote_call(self._client)
 
2438
        try:
 
2439
            response_tuple, response_handler = self._call_expecting_body(
 
2440
                "Repository.all_revision_ids", path)
 
2441
        except errors.UnknownSmartMethod:
 
2442
            self._ensure_real()
 
2443
            return self._real_repository.all_revision_ids()
 
2444
        if response_tuple != ("ok", ):
 
2445
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
2446
        revids = set(response_handler.read_body_bytes().splitlines())
 
2447
        for fallback in self._fallback_repositories:
 
2448
            revids.update(set(fallback.all_revision_ids()))
 
2449
        return list(revids)
 
2450
 
 
2451
    def _filtered_revision_trees(self, revision_ids, file_ids):
 
2452
        """Return Tree for a revision on this branch with only some files.
 
2453
 
 
2454
        :param revision_ids: a sequence of revision-ids;
 
2455
          a revision-id may not be None or 'null:'
 
2456
        :param file_ids: if not None, the result is filtered
 
2457
          so that only those file-ids, their parents and their
 
2458
          children are included.
 
2459
        """
 
2460
        inventories = self.iter_inventories(revision_ids)
 
2461
        for inv in inventories:
 
2462
            # Should we introduce a FilteredRevisionTree class rather
 
2463
            # than pre-filter the inventory here?
 
2464
            filtered_inv = inv.filter(file_ids)
 
2465
            yield InventoryRevisionTree(self, filtered_inv, filtered_inv.revision_id)
1837
2466
 
1838
2467
    @needs_read_lock
1839
2468
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1840
 
        self._ensure_real()
1841
 
        return self._real_repository.get_deltas_for_revisions(revisions,
1842
 
            specific_fileids=specific_fileids)
 
2469
        medium = self._client._medium
 
2470
        if medium._is_remote_before((1, 2)):
 
2471
            self._ensure_real()
 
2472
            for delta in self._real_repository.get_deltas_for_revisions(
 
2473
                    revisions, specific_fileids):
 
2474
                yield delta
 
2475
            return
 
2476
        # Get the revision-ids of interest
 
2477
        required_trees = set()
 
2478
        for revision in revisions:
 
2479
            required_trees.add(revision.revision_id)
 
2480
            required_trees.update(revision.parent_ids[:1])
 
2481
 
 
2482
        # Get the matching filtered trees. Note that it's more
 
2483
        # efficient to pass filtered trees to changes_from() rather
 
2484
        # than doing the filtering afterwards. changes_from() could
 
2485
        # arguably do the filtering itself but it's path-based, not
 
2486
        # file-id based, so filtering before or afterwards is
 
2487
        # currently easier.
 
2488
        if specific_fileids is None:
 
2489
            trees = dict((t.get_revision_id(), t) for
 
2490
                t in self.revision_trees(required_trees))
 
2491
        else:
 
2492
            trees = dict((t.get_revision_id(), t) for
 
2493
                t in self._filtered_revision_trees(required_trees,
 
2494
                specific_fileids))
 
2495
 
 
2496
        # Calculate the deltas
 
2497
        for revision in revisions:
 
2498
            if not revision.parent_ids:
 
2499
                old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
 
2500
            else:
 
2501
                old_tree = trees[revision.parent_ids[0]]
 
2502
            yield trees[revision.revision_id].changes_from(old_tree)
1843
2503
 
1844
2504
    @needs_read_lock
1845
2505
    def get_revision_delta(self, revision_id, specific_fileids=None):
1846
 
        self._ensure_real()
1847
 
        return self._real_repository.get_revision_delta(revision_id,
1848
 
            specific_fileids=specific_fileids)
 
2506
        r = self.get_revision(revision_id)
 
2507
        return list(self.get_deltas_for_revisions([r],
 
2508
            specific_fileids=specific_fileids))[0]
1849
2509
 
1850
2510
    @needs_read_lock
1851
2511
    def revision_trees(self, revision_ids):
1852
 
        self._ensure_real()
1853
 
        return self._real_repository.revision_trees(revision_ids)
 
2512
        inventories = self.iter_inventories(revision_ids)
 
2513
        for inv in inventories:
 
2514
            yield InventoryRevisionTree(self, inv, inv.revision_id)
1854
2515
 
1855
2516
    @needs_read_lock
1856
2517
    def get_revision_reconcile(self, revision_id):
1864
2525
            callback_refs=callback_refs, check_repo=check_repo)
1865
2526
 
1866
2527
    def copy_content_into(self, destination, revision_id=None):
1867
 
        self._ensure_real()
1868
 
        return self._real_repository.copy_content_into(
1869
 
            destination, revision_id=revision_id)
 
2528
        """Make a complete copy of the content in self into destination.
 
2529
 
 
2530
        This is a destructive operation! Do not use it on existing
 
2531
        repositories.
 
2532
        """
 
2533
        interrepo = _mod_repository.InterRepository.get(self, destination)
 
2534
        return interrepo.copy_content(revision_id)
1870
2535
 
1871
2536
    def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
1872
2537
        # get a tarball of the remote repository, and copy from that into the
1873
2538
        # destination
1874
 
        from bzrlib import osutils
1875
2539
        import tarfile
1876
2540
        # TODO: Maybe a progress bar while streaming the tarball?
1877
 
        note("Copying repository content as tarball...")
 
2541
        note(gettext("Copying repository content as tarball..."))
1878
2542
        tar_file = self._get_tarball('bz2')
1879
2543
        if tar_file is None:
1880
2544
            return None
1909
2573
    @needs_write_lock
1910
2574
    def pack(self, hint=None, clean_obsolete_packs=False):
1911
2575
        """Compress the data within the repository.
1912
 
 
1913
 
        This is not currently implemented within the smart server.
1914
2576
        """
1915
 
        self._ensure_real()
1916
 
        return self._real_repository.pack(hint=hint, clean_obsolete_packs=clean_obsolete_packs)
 
2577
        if hint is None:
 
2578
            body = ""
 
2579
        else:
 
2580
            body = "".join([l+"\n" for l in hint])
 
2581
        path = self.bzrdir._path_for_remote_call(self._client)
 
2582
        try:
 
2583
            response, handler = self._call_with_body_bytes_expecting_body(
 
2584
                'Repository.pack', (path, self._lock_token,
 
2585
                    str(clean_obsolete_packs)), body)
 
2586
        except errors.UnknownSmartMethod:
 
2587
            self._ensure_real()
 
2588
            return self._real_repository.pack(hint=hint,
 
2589
                clean_obsolete_packs=clean_obsolete_packs)
 
2590
        handler.cancel_read_body()
 
2591
        if response != ('ok', ):
 
2592
            raise errors.UnexpectedSmartServerResponse(response)
1917
2593
 
1918
2594
    @property
1919
2595
    def revisions(self):
1920
2596
        """Decorate the real repository for now.
1921
2597
 
1922
 
        In the short term this should become a real object to intercept graph
1923
 
        lookups.
1924
 
 
1925
2598
        In the long term a full blown network facility is needed.
1926
2599
        """
1927
2600
        self._ensure_real()
1955
2628
 
1956
2629
    @needs_write_lock
1957
2630
    def sign_revision(self, revision_id, gpg_strategy):
1958
 
        self._ensure_real()
1959
 
        return self._real_repository.sign_revision(revision_id, gpg_strategy)
 
2631
        testament = _mod_testament.Testament.from_revision(self, revision_id)
 
2632
        plaintext = testament.as_short_text()
 
2633
        self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1960
2634
 
1961
2635
    @property
1962
2636
    def texts(self):
1968
2642
        self._ensure_real()
1969
2643
        return self._real_repository.texts
1970
2644
 
 
2645
    def _iter_revisions_rpc(self, revision_ids):
 
2646
        body = "\n".join(revision_ids)
 
2647
        path = self.bzrdir._path_for_remote_call(self._client)
 
2648
        response_tuple, response_handler = (
 
2649
            self._call_with_body_bytes_expecting_body(
 
2650
            "Repository.iter_revisions", (path, ), body))
 
2651
        if response_tuple[0] != "ok":
 
2652
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
2653
        serializer_format = response_tuple[1]
 
2654
        serializer = serializer_format_registry.get(serializer_format)
 
2655
        byte_stream = response_handler.read_streamed_body()
 
2656
        decompressor = zlib.decompressobj()
 
2657
        chunks = []
 
2658
        for bytes in byte_stream:
 
2659
            chunks.append(decompressor.decompress(bytes))
 
2660
            if decompressor.unused_data != "":
 
2661
                chunks.append(decompressor.flush())
 
2662
                yield serializer.read_revision_from_string("".join(chunks))
 
2663
                unused = decompressor.unused_data
 
2664
                decompressor = zlib.decompressobj()
 
2665
                chunks = [decompressor.decompress(unused)]
 
2666
        chunks.append(decompressor.flush())
 
2667
        text = "".join(chunks)
 
2668
        if text != "":
 
2669
            yield serializer.read_revision_from_string("".join(chunks))
 
2670
 
1971
2671
    @needs_read_lock
1972
2672
    def get_revisions(self, revision_ids):
1973
 
        self._ensure_real()
1974
 
        return self._real_repository.get_revisions(revision_ids)
 
2673
        if revision_ids is None:
 
2674
            revision_ids = self.all_revision_ids()
 
2675
        else:
 
2676
            for rev_id in revision_ids:
 
2677
                if not rev_id or not isinstance(rev_id, basestring):
 
2678
                    raise errors.InvalidRevisionId(
 
2679
                        revision_id=rev_id, branch=self)
 
2680
        try:
 
2681
            missing = set(revision_ids)
 
2682
            revs = {}
 
2683
            for rev in self._iter_revisions_rpc(revision_ids):
 
2684
                missing.remove(rev.revision_id)
 
2685
                revs[rev.revision_id] = rev
 
2686
        except errors.UnknownSmartMethod:
 
2687
            self._ensure_real()
 
2688
            return self._real_repository.get_revisions(revision_ids)
 
2689
        for fallback in self._fallback_repositories:
 
2690
            if not missing:
 
2691
                break
 
2692
            for revid in list(missing):
 
2693
                # XXX JRV 2011-11-20: It would be nice if there was a
 
2694
                # public method on Repository that could be used to query
 
2695
                # for revision objects *without* failing completely if one
 
2696
                # was missing. There is VersionedFileRepository._iter_revisions,
 
2697
                # but unfortunately that's private and not provided by
 
2698
                # all repository implementations.
 
2699
                try:
 
2700
                    revs[revid] = fallback.get_revision(revid)
 
2701
                except errors.NoSuchRevision:
 
2702
                    pass
 
2703
                else:
 
2704
                    missing.remove(revid)
 
2705
        if missing:
 
2706
            raise errors.NoSuchRevision(self, list(missing)[0])
 
2707
        return [revs[revid] for revid in revision_ids]
1975
2708
 
1976
2709
    def supports_rich_root(self):
1977
2710
        return self._format.rich_root_data
1985
2718
    def _serializer(self):
1986
2719
        return self._format._serializer
1987
2720
 
 
2721
    @needs_write_lock
1988
2722
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1989
 
        self._ensure_real()
1990
 
        return self._real_repository.store_revision_signature(
1991
 
            gpg_strategy, plaintext, revision_id)
 
2723
        signature = gpg_strategy.sign(plaintext)
 
2724
        self.add_signature_text(revision_id, signature)
1992
2725
 
1993
2726
    def add_signature_text(self, revision_id, signature):
1994
 
        self._ensure_real()
1995
 
        return self._real_repository.add_signature_text(revision_id, signature)
 
2727
        if self._real_repository:
 
2728
            # If there is a real repository the write group will
 
2729
            # be in the real repository as well, so use that:
 
2730
            self._ensure_real()
 
2731
            return self._real_repository.add_signature_text(
 
2732
                revision_id, signature)
 
2733
        path = self.bzrdir._path_for_remote_call(self._client)
 
2734
        response, handler = self._call_with_body_bytes_expecting_body(
 
2735
            'Repository.add_signature_text', (path, self._lock_token,
 
2736
                revision_id) + tuple(self._write_group_tokens), signature)
 
2737
        handler.cancel_read_body()
 
2738
        self.refresh_data()
 
2739
        if response[0] != 'ok':
 
2740
            raise errors.UnexpectedSmartServerResponse(response)
 
2741
        self._write_group_tokens = response[1:]
1996
2742
 
1997
2743
    def has_signature_for_revision_id(self, revision_id):
1998
 
        self._ensure_real()
1999
 
        return self._real_repository.has_signature_for_revision_id(revision_id)
 
2744
        path = self.bzrdir._path_for_remote_call(self._client)
 
2745
        try:
 
2746
            response = self._call('Repository.has_signature_for_revision_id',
 
2747
                path, revision_id)
 
2748
        except errors.UnknownSmartMethod:
 
2749
            self._ensure_real()
 
2750
            return self._real_repository.has_signature_for_revision_id(
 
2751
                revision_id)
 
2752
        if response[0] not in ('yes', 'no'):
 
2753
            raise SmartProtocolError('unexpected response code %s' % (response,))
 
2754
        if response[0] == 'yes':
 
2755
            return True
 
2756
        for fallback in self._fallback_repositories:
 
2757
            if fallback.has_signature_for_revision_id(revision_id):
 
2758
                return True
 
2759
        return False
 
2760
 
 
2761
    @needs_read_lock
 
2762
    def verify_revision_signature(self, revision_id, gpg_strategy):
 
2763
        if not self.has_signature_for_revision_id(revision_id):
 
2764
            return gpg.SIGNATURE_NOT_SIGNED, None
 
2765
        signature = self.get_signature_text(revision_id)
 
2766
 
 
2767
        testament = _mod_testament.Testament.from_revision(self, revision_id)
 
2768
        plaintext = testament.as_short_text()
 
2769
 
 
2770
        return gpg_strategy.verify(signature, plaintext)
2000
2771
 
2001
2772
    def item_keys_introduced_by(self, revision_ids, _files_pb=None):
2002
2773
        self._ensure_real()
2192
2963
 
2193
2964
    def _real_stream(self, repo, search):
2194
2965
        """Get a stream for search from repo.
2195
 
        
2196
 
        This never called RemoteStreamSource.get_stream, and is a heler
2197
 
        for RemoteStreamSource._get_stream to allow getting a stream 
 
2966
 
 
2967
        This never called RemoteStreamSource.get_stream, and is a helper
 
2968
        for RemoteStreamSource._get_stream to allow getting a stream
2198
2969
        reliably whether fallback back because of old servers or trying
2199
2970
        to stream from a non-RemoteRepository (which the stacked support
2200
2971
        code will do).
2242
3013
            except errors.UnknownSmartMethod:
2243
3014
                medium._remember_remote_is_before(version)
2244
3015
            except errors.UnknownErrorFromSmartServer, e:
2245
 
                if isinstance(search, graph.EverythingResult):
 
3016
                if isinstance(search, vf_search.EverythingResult):
2246
3017
                    error_verb = e.error_from_smart_server.error_verb
2247
3018
                    if error_verb == 'BadSearch':
2248
3019
                        # Pre-2.4 servers don't support this sort of search.
2340
3111
 
2341
3112
    def _ensure_real(self):
2342
3113
        if self._custom_format is None:
2343
 
            self._custom_format = branch.network_format_registry.get(
2344
 
                self._network_name)
 
3114
            try:
 
3115
                self._custom_format = branch.network_format_registry.get(
 
3116
                    self._network_name)
 
3117
            except KeyError:
 
3118
                raise errors.UnknownFormatError(kind='branch',
 
3119
                    format=self._network_name)
2345
3120
 
2346
3121
    def get_format_description(self):
2347
3122
        self._ensure_real()
2354
3129
        return a_bzrdir.open_branch(name=name, 
2355
3130
            ignore_fallbacks=ignore_fallbacks)
2356
3131
 
2357
 
    def _vfs_initialize(self, a_bzrdir, name):
 
3132
    def _vfs_initialize(self, a_bzrdir, name, append_revisions_only):
2358
3133
        # Initialisation when using a local bzrdir object, or a non-vfs init
2359
3134
        # method is not available on the server.
2360
3135
        # self._custom_format is always set - the start of initialize ensures
2362
3137
        if isinstance(a_bzrdir, RemoteBzrDir):
2363
3138
            a_bzrdir._ensure_real()
2364
3139
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
2365
 
                name)
 
3140
                name=name, append_revisions_only=append_revisions_only)
2366
3141
        else:
2367
3142
            # We assume the bzrdir is parameterised; it may not be.
2368
 
            result = self._custom_format.initialize(a_bzrdir, name)
 
3143
            result = self._custom_format.initialize(a_bzrdir, name=name,
 
3144
                append_revisions_only=append_revisions_only)
2369
3145
        if (isinstance(a_bzrdir, RemoteBzrDir) and
2370
3146
            not isinstance(result, RemoteBranch)):
2371
3147
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
2372
3148
                                  name=name)
2373
3149
        return result
2374
3150
 
2375
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
3151
    def initialize(self, a_bzrdir, name=None, repository=None,
 
3152
                   append_revisions_only=None):
 
3153
        if name is None:
 
3154
            name = a_bzrdir._get_selected_branch()
2376
3155
        # 1) get the network name to use.
2377
3156
        if self._custom_format:
2378
3157
            network_name = self._custom_format.network_name()
2384
3163
            network_name = reference_format.network_name()
2385
3164
        # Being asked to create on a non RemoteBzrDir:
2386
3165
        if not isinstance(a_bzrdir, RemoteBzrDir):
2387
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
3166
            return self._vfs_initialize(a_bzrdir, name=name,
 
3167
                append_revisions_only=append_revisions_only)
2388
3168
        medium = a_bzrdir._client._medium
2389
3169
        if medium._is_remote_before((1, 13)):
2390
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
3170
            return self._vfs_initialize(a_bzrdir, name=name,
 
3171
                append_revisions_only=append_revisions_only)
2391
3172
        # Creating on a remote bzr dir.
2392
3173
        # 2) try direct creation via RPC
2393
3174
        path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
2394
 
        if name is not None:
 
3175
        if name != "":
2395
3176
            # XXX JRV20100304: Support creating colocated branches
2396
3177
            raise errors.NoColocatedBranchSupport(self)
2397
3178
        verb = 'BzrDir.create_branch'
2400
3181
        except errors.UnknownSmartMethod:
2401
3182
            # Fallback - use vfs methods
2402
3183
            medium._remember_remote_is_before((1, 13))
2403
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
3184
            return self._vfs_initialize(a_bzrdir, name=name,
 
3185
                    append_revisions_only=append_revisions_only)
2404
3186
        if response[0] != 'ok':
2405
3187
            raise errors.UnexpectedSmartServerResponse(response)
2406
3188
        # Turn the response into a RemoteRepository object.
2427
3209
            remote_repo = RemoteRepository(repo_bzrdir, repo_format)
2428
3210
        remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2429
3211
            format=format, setup_stacking=False, name=name)
 
3212
        if append_revisions_only:
 
3213
            remote_branch.set_append_revisions_only(append_revisions_only)
2430
3214
        # XXX: We know this is a new branch, so it must have revno 0, revid
2431
3215
        # NULL_REVISION. Creating the branch locked would make this be unable
2432
3216
        # to be wrong; here its simply very unlikely to be wrong. RBC 20090225
2465
3249
                return True
2466
3250
        return False
2467
3251
 
 
3252
 
 
3253
class RemoteBranchStore(_mod_config.IniFileStore):
 
3254
    """Branch store which attempts to use HPSS calls to retrieve branch store.
 
3255
 
 
3256
    Note that this is specific to bzr-based formats.
 
3257
    """
 
3258
 
 
3259
    def __init__(self, branch):
 
3260
        super(RemoteBranchStore, self).__init__()
 
3261
        self.branch = branch
 
3262
        self.id = "branch"
 
3263
        self._real_store = None
 
3264
 
 
3265
    def lock_write(self, token=None):
 
3266
        return self.branch.lock_write(token)
 
3267
 
 
3268
    def unlock(self):
 
3269
        return self.branch.unlock()
 
3270
 
 
3271
    @needs_write_lock
 
3272
    def save(self):
 
3273
        # We need to be able to override the undecorated implementation
 
3274
        self.save_without_locking()
 
3275
 
 
3276
    def save_without_locking(self):
 
3277
        super(RemoteBranchStore, self).save()
 
3278
 
 
3279
    def external_url(self):
 
3280
        return self.branch.user_url
 
3281
 
 
3282
    def _load_content(self):
 
3283
        path = self.branch._remote_path()
 
3284
        try:
 
3285
            response, handler = self.branch._call_expecting_body(
 
3286
                'Branch.get_config_file', path)
 
3287
        except errors.UnknownSmartMethod:
 
3288
            self._ensure_real()
 
3289
            return self._real_store._load_content()
 
3290
        if len(response) and response[0] != 'ok':
 
3291
            raise errors.UnexpectedSmartServerResponse(response)
 
3292
        return handler.read_body_bytes()
 
3293
 
 
3294
    def _save_content(self, content):
 
3295
        path = self.branch._remote_path()
 
3296
        try:
 
3297
            response, handler = self.branch._call_with_body_bytes_expecting_body(
 
3298
                'Branch.put_config_file', (path,
 
3299
                    self.branch._lock_token, self.branch._repo_lock_token),
 
3300
                content)
 
3301
        except errors.UnknownSmartMethod:
 
3302
            self._ensure_real()
 
3303
            return self._real_store._save_content(content)
 
3304
        handler.cancel_read_body()
 
3305
        if response != ('ok', ):
 
3306
            raise errors.UnexpectedSmartServerResponse(response)
 
3307
 
 
3308
    def _ensure_real(self):
 
3309
        self.branch._ensure_real()
 
3310
        if self._real_store is None:
 
3311
            self._real_store = _mod_config.BranchStore(self.branch)
 
3312
 
 
3313
 
2468
3314
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
2469
3315
    """Branch stored on a server accessed by HPSS RPC.
2470
3316
 
2472
3318
    """
2473
3319
 
2474
3320
    def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
2475
 
        _client=None, format=None, setup_stacking=True, name=None):
 
3321
        _client=None, format=None, setup_stacking=True, name=None,
 
3322
        possible_transports=None):
2476
3323
        """Create a RemoteBranch instance.
2477
3324
 
2478
3325
        :param real_branch: An optional local implementation of the branch
2490
3337
        # will try to assign to self.tags, which is a property in this subclass.
2491
3338
        # And the parent's __init__ doesn't do much anyway.
2492
3339
        self.bzrdir = remote_bzrdir
 
3340
        self.name = name
2493
3341
        if _client is not None:
2494
3342
            self._client = _client
2495
3343
        else:
2543
3391
            hook(self)
2544
3392
        self._is_stacked = False
2545
3393
        if setup_stacking:
2546
 
            self._setup_stacking()
 
3394
            self._setup_stacking(possible_transports)
2547
3395
 
2548
 
    def _setup_stacking(self):
 
3396
    def _setup_stacking(self, possible_transports):
2549
3397
        # configure stacking into the remote repository, by reading it from
2550
3398
        # the vfs branch.
2551
3399
        try:
2554
3402
            errors.UnstackableRepositoryFormat), e:
2555
3403
            return
2556
3404
        self._is_stacked = True
2557
 
        self._activate_fallback_location(fallback_url)
 
3405
        if possible_transports is None:
 
3406
            possible_transports = []
 
3407
        else:
 
3408
            possible_transports = list(possible_transports)
 
3409
        possible_transports.append(self.bzrdir.root_transport)
 
3410
        self._activate_fallback_location(fallback_url,
 
3411
            possible_transports=possible_transports)
2558
3412
 
2559
3413
    def _get_config(self):
2560
3414
        return RemoteBranchConfig(self)
2561
3415
 
 
3416
    def _get_config_store(self):
 
3417
        return RemoteBranchStore(self)
 
3418
 
2562
3419
    def _get_real_transport(self):
2563
3420
        # if we try vfs access, return the real branch's vfs transport
2564
3421
        self._ensure_real()
2627
3484
                self.bzrdir, self._client)
2628
3485
        return self._control_files
2629
3486
 
2630
 
    def _get_checkout_format(self):
2631
 
        self._ensure_real()
2632
 
        return self._real_branch._get_checkout_format()
2633
 
 
2634
3487
    def get_physical_lock_status(self):
2635
3488
        """See Branch.get_physical_lock_status()."""
2636
 
        # should be an API call to the server, as branches must be lockable.
2637
 
        self._ensure_real()
2638
 
        return self._real_branch.get_physical_lock_status()
 
3489
        try:
 
3490
            response = self._client.call('Branch.get_physical_lock_status',
 
3491
                self._remote_path())
 
3492
        except errors.UnknownSmartMethod:
 
3493
            self._ensure_real()
 
3494
            return self._real_branch.get_physical_lock_status()
 
3495
        if response[0] not in ('yes', 'no'):
 
3496
            raise errors.UnexpectedSmartServerResponse(response)
 
3497
        return (response[0] == 'yes')
2639
3498
 
2640
3499
    def get_stacked_on_url(self):
2641
3500
        """Get the URL this branch is stacked against.
2825
3684
            self.repository.unlock()
2826
3685
 
2827
3686
    def break_lock(self):
2828
 
        self._ensure_real()
2829
 
        return self._real_branch.break_lock()
 
3687
        try:
 
3688
            response = self._call(
 
3689
                'Branch.break_lock', self._remote_path())
 
3690
        except errors.UnknownSmartMethod:
 
3691
            self._ensure_real()
 
3692
            return self._real_branch.break_lock()
 
3693
        if response != ('ok',):
 
3694
            raise errors.UnexpectedSmartServerResponse(response)
2830
3695
 
2831
3696
    def leave_lock_in_place(self):
2832
3697
        if not self._lock_token:
3006
3871
        return self._lock_count >= 1
3007
3872
 
3008
3873
    @needs_read_lock
 
3874
    def revision_id_to_dotted_revno(self, revision_id):
 
3875
        """Given a revision id, return its dotted revno.
 
3876
 
 
3877
        :return: a tuple like (1,) or (400,1,3).
 
3878
        """
 
3879
        try:
 
3880
            response = self._call('Branch.revision_id_to_revno',
 
3881
                self._remote_path(), revision_id)
 
3882
        except errors.UnknownSmartMethod:
 
3883
            self._ensure_real()
 
3884
            return self._real_branch.revision_id_to_dotted_revno(revision_id)
 
3885
        if response[0] == 'ok':
 
3886
            return tuple([int(x) for x in response[1:]])
 
3887
        else:
 
3888
            raise errors.UnexpectedSmartServerResponse(response)
 
3889
 
 
3890
    @needs_read_lock
3009
3891
    def revision_id_to_revno(self, revision_id):
3010
 
        self._ensure_real()
3011
 
        return self._real_branch.revision_id_to_revno(revision_id)
 
3892
        """Given a revision id on the branch mainline, return its revno.
 
3893
 
 
3894
        :return: an integer
 
3895
        """
 
3896
        try:
 
3897
            response = self._call('Branch.revision_id_to_revno',
 
3898
                self._remote_path(), revision_id)
 
3899
        except errors.UnknownSmartMethod:
 
3900
            self._ensure_real()
 
3901
            return self._real_branch.revision_id_to_revno(revision_id)
 
3902
        if response[0] == 'ok':
 
3903
            if len(response) == 2:
 
3904
                return int(response[1])
 
3905
            raise NoSuchRevision(self, revision_id)
 
3906
        else:
 
3907
            raise errors.UnexpectedSmartServerResponse(response)
3012
3908
 
3013
3909
    @needs_write_lock
3014
3910
    def set_last_revision_info(self, revno, revision_id):
3118
4014
                value = section_obj.get(name, default)
3119
4015
        except errors.UnknownSmartMethod:
3120
4016
            value = self._vfs_get_option(name, section, default)
3121
 
        for hook in config.OldConfigHooks['get']:
 
4017
        for hook in _mod_config.OldConfigHooks['get']:
3122
4018
            hook(self, name, value)
3123
4019
        return value
3124
4020
 
3126
4022
        if len(response[0]) and response[0][0] != 'ok':
3127
4023
            raise errors.UnexpectedSmartServerResponse(response)
3128
4024
        lines = response[1].read_body_bytes().splitlines()
3129
 
        conf = config.ConfigObj(lines, encoding='utf-8')
3130
 
        for hook in config.OldConfigHooks['load']:
 
4025
        conf = _mod_config.ConfigObj(lines, encoding='utf-8')
 
4026
        for hook in _mod_config.OldConfigHooks['load']:
3131
4027
            hook(self)
3132
4028
        return conf
3133
4029
 
3243
4139
        return self._bzrdir._real_bzrdir
3244
4140
 
3245
4141
 
3246
 
 
3247
4142
def _extract_tar(tar, to_dir):
3248
4143
    """Extract all the contents of a tarfile object.
3249
4144
 
3253
4148
        tar.extract(tarinfo, to_dir)
3254
4149
 
3255
4150
 
 
4151
error_translators = registry.Registry()
 
4152
no_context_error_translators = registry.Registry()
 
4153
 
 
4154
 
3256
4155
def _translate_error(err, **context):
3257
4156
    """Translate an ErrorFromSmartServer into a more useful error.
3258
4157
 
3287
4186
                    'Missing key %r in context %r', key_err.args[0], context)
3288
4187
                raise err
3289
4188
 
3290
 
    if err.error_verb == 'NoSuchRevision':
3291
 
        raise NoSuchRevision(find('branch'), err.error_args[0])
3292
 
    elif err.error_verb == 'nosuchrevision':
3293
 
        raise NoSuchRevision(find('repository'), err.error_args[0])
3294
 
    elif err.error_verb == 'nobranch':
3295
 
        if len(err.error_args) >= 1:
3296
 
            extra = err.error_args[0]
3297
 
        else:
3298
 
            extra = None
3299
 
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base,
3300
 
            detail=extra)
3301
 
    elif err.error_verb == 'norepository':
3302
 
        raise errors.NoRepositoryPresent(find('bzrdir'))
3303
 
    elif err.error_verb == 'UnlockableTransport':
3304
 
        raise errors.UnlockableTransport(find('bzrdir').root_transport)
3305
 
    elif err.error_verb == 'TokenMismatch':
3306
 
        raise errors.TokenMismatch(find('token'), '(remote token)')
3307
 
    elif err.error_verb == 'Diverged':
3308
 
        raise errors.DivergedBranches(find('branch'), find('other_branch'))
3309
 
    elif err.error_verb == 'NotStacked':
3310
 
        raise errors.NotStacked(branch=find('branch'))
3311
 
    elif err.error_verb == 'PermissionDenied':
3312
 
        path = get_path()
3313
 
        if len(err.error_args) >= 2:
3314
 
            extra = err.error_args[1]
3315
 
        else:
3316
 
            extra = None
3317
 
        raise errors.PermissionDenied(path, extra=extra)
3318
 
    elif err.error_verb == 'ReadError':
3319
 
        path = get_path()
3320
 
        raise errors.ReadError(path)
3321
 
    elif err.error_verb == 'NoSuchFile':
3322
 
        path = get_path()
3323
 
        raise errors.NoSuchFile(path)
3324
 
    _translate_error_without_context(err)
3325
 
 
3326
 
 
3327
 
def _translate_error_without_context(err):
3328
 
    """Translate any ErrorFromSmartServer values that don't require context"""
3329
 
    if err.error_verb == 'IncompatibleRepositories':
3330
 
        raise errors.IncompatibleRepositories(err.error_args[0],
3331
 
            err.error_args[1], err.error_args[2])
3332
 
    elif err.error_verb == 'LockContention':
3333
 
        raise errors.LockContention('(remote lock)')
3334
 
    elif err.error_verb == 'LockFailed':
3335
 
        raise errors.LockFailed(err.error_args[0], err.error_args[1])
3336
 
    elif err.error_verb == 'TipChangeRejected':
3337
 
        raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
3338
 
    elif err.error_verb == 'UnstackableBranchFormat':
3339
 
        raise errors.UnstackableBranchFormat(*err.error_args)
3340
 
    elif err.error_verb == 'UnstackableRepositoryFormat':
3341
 
        raise errors.UnstackableRepositoryFormat(*err.error_args)
3342
 
    elif err.error_verb == 'FileExists':
3343
 
        raise errors.FileExists(err.error_args[0])
3344
 
    elif err.error_verb == 'DirectoryNotEmpty':
3345
 
        raise errors.DirectoryNotEmpty(err.error_args[0])
3346
 
    elif err.error_verb == 'ShortReadvError':
3347
 
        args = err.error_args
3348
 
        raise errors.ShortReadvError(
3349
 
            args[0], int(args[1]), int(args[2]), int(args[3]))
3350
 
    elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
 
4189
    try:
 
4190
        translator = error_translators.get(err.error_verb)
 
4191
    except KeyError:
 
4192
        pass
 
4193
    else:
 
4194
        raise translator(err, find, get_path)
 
4195
    try:
 
4196
        translator = no_context_error_translators.get(err.error_verb)
 
4197
    except KeyError:
 
4198
        raise errors.UnknownErrorFromSmartServer(err)
 
4199
    else:
 
4200
        raise translator(err)
 
4201
 
 
4202
 
 
4203
error_translators.register('NoSuchRevision',
 
4204
    lambda err, find, get_path: NoSuchRevision(
 
4205
        find('branch'), err.error_args[0]))
 
4206
error_translators.register('nosuchrevision',
 
4207
    lambda err, find, get_path: NoSuchRevision(
 
4208
        find('repository'), err.error_args[0]))
 
4209
 
 
4210
def _translate_nobranch_error(err, find, get_path):
 
4211
    if len(err.error_args) >= 1:
 
4212
        extra = err.error_args[0]
 
4213
    else:
 
4214
        extra = None
 
4215
    return errors.NotBranchError(path=find('bzrdir').root_transport.base,
 
4216
        detail=extra)
 
4217
 
 
4218
error_translators.register('nobranch', _translate_nobranch_error)
 
4219
error_translators.register('norepository',
 
4220
    lambda err, find, get_path: errors.NoRepositoryPresent(
 
4221
        find('bzrdir')))
 
4222
error_translators.register('UnlockableTransport',
 
4223
    lambda err, find, get_path: errors.UnlockableTransport(
 
4224
        find('bzrdir').root_transport))
 
4225
error_translators.register('TokenMismatch',
 
4226
    lambda err, find, get_path: errors.TokenMismatch(
 
4227
        find('token'), '(remote token)'))
 
4228
error_translators.register('Diverged',
 
4229
    lambda err, find, get_path: errors.DivergedBranches(
 
4230
        find('branch'), find('other_branch')))
 
4231
error_translators.register('NotStacked',
 
4232
    lambda err, find, get_path: errors.NotStacked(branch=find('branch')))
 
4233
 
 
4234
def _translate_PermissionDenied(err, find, get_path):
 
4235
    path = get_path()
 
4236
    if len(err.error_args) >= 2:
 
4237
        extra = err.error_args[1]
 
4238
    else:
 
4239
        extra = None
 
4240
    return errors.PermissionDenied(path, extra=extra)
 
4241
 
 
4242
error_translators.register('PermissionDenied', _translate_PermissionDenied)
 
4243
error_translators.register('ReadError',
 
4244
    lambda err, find, get_path: errors.ReadError(get_path()))
 
4245
error_translators.register('NoSuchFile',
 
4246
    lambda err, find, get_path: errors.NoSuchFile(get_path()))
 
4247
error_translators.register('TokenLockingNotSupported',
 
4248
    lambda err, find, get_path: errors.TokenLockingNotSupported(
 
4249
        find('repository')))
 
4250
error_translators.register('UnsuspendableWriteGroup',
 
4251
    lambda err, find, get_path: errors.UnsuspendableWriteGroup(
 
4252
        repository=find('repository')))
 
4253
error_translators.register('UnresumableWriteGroup',
 
4254
    lambda err, find, get_path: errors.UnresumableWriteGroup(
 
4255
        repository=find('repository'), write_groups=err.error_args[0],
 
4256
        reason=err.error_args[1]))
 
4257
no_context_error_translators.register('IncompatibleRepositories',
 
4258
    lambda err: errors.IncompatibleRepositories(
 
4259
        err.error_args[0], err.error_args[1], err.error_args[2]))
 
4260
no_context_error_translators.register('LockContention',
 
4261
    lambda err: errors.LockContention('(remote lock)'))
 
4262
no_context_error_translators.register('LockFailed',
 
4263
    lambda err: errors.LockFailed(err.error_args[0], err.error_args[1]))
 
4264
no_context_error_translators.register('TipChangeRejected',
 
4265
    lambda err: errors.TipChangeRejected(err.error_args[0].decode('utf8')))
 
4266
no_context_error_translators.register('UnstackableBranchFormat',
 
4267
    lambda err: errors.UnstackableBranchFormat(*err.error_args))
 
4268
no_context_error_translators.register('UnstackableRepositoryFormat',
 
4269
    lambda err: errors.UnstackableRepositoryFormat(*err.error_args))
 
4270
no_context_error_translators.register('FileExists',
 
4271
    lambda err: errors.FileExists(err.error_args[0]))
 
4272
no_context_error_translators.register('DirectoryNotEmpty',
 
4273
    lambda err: errors.DirectoryNotEmpty(err.error_args[0]))
 
4274
 
 
4275
def _translate_short_readv_error(err):
 
4276
    args = err.error_args
 
4277
    return errors.ShortReadvError(args[0], int(args[1]), int(args[2]),
 
4278
        int(args[3]))
 
4279
 
 
4280
no_context_error_translators.register('ShortReadvError',
 
4281
    _translate_short_readv_error)
 
4282
 
 
4283
def _translate_unicode_error(err):
3351
4284
        encoding = str(err.error_args[0]) # encoding must always be a string
3352
4285
        val = err.error_args[1]
3353
4286
        start = int(err.error_args[2])
3361
4294
            raise UnicodeDecodeError(encoding, val, start, end, reason)
3362
4295
        elif err.error_verb == 'UnicodeEncodeError':
3363
4296
            raise UnicodeEncodeError(encoding, val, start, end, reason)
3364
 
    elif err.error_verb == 'ReadOnlyError':
3365
 
        raise errors.TransportNotPossible('readonly transport')
3366
 
    elif err.error_verb == 'MemoryError':
3367
 
        raise errors.BzrError("remote server out of memory\n"
3368
 
            "Retry non-remotely, or contact the server admin for details.")
3369
 
    raise errors.UnknownErrorFromSmartServer(err)
 
4297
 
 
4298
no_context_error_translators.register('UnicodeEncodeError',
 
4299
    _translate_unicode_error)
 
4300
no_context_error_translators.register('UnicodeDecodeError',
 
4301
    _translate_unicode_error)
 
4302
no_context_error_translators.register('ReadOnlyError',
 
4303
    lambda err: errors.TransportNotPossible('readonly transport'))
 
4304
no_context_error_translators.register('MemoryError',
 
4305
    lambda err: errors.BzrError("remote server out of memory\n"
 
4306
        "Retry non-remotely, or contact the server admin for details."))
 
4307
no_context_error_translators.register('RevisionNotPresent',
 
4308
    lambda err: errors.RevisionNotPresent(err.error_args[0], err.error_args[1]))
 
4309
 
 
4310
no_context_error_translators.register('BzrCheckError',
 
4311
    lambda err: errors.BzrCheckError(msg=err.error_args[0]))
 
4312