~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

(jameinel) Allow 'bzr serve' to interpret SIGHUP as a graceful shutdown.
 (bug #795025) (John A Meinel)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2012 Canonical Ltd
 
1
# Copyright (C) 2006-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
from __future__ import absolute_import
18
 
 
19
17
import bz2
20
 
import zlib
21
18
 
22
19
from bzrlib import (
23
20
    bencode,
24
21
    branch,
25
22
    bzrdir as _mod_bzrdir,
26
 
    config as _mod_config,
 
23
    config,
27
24
    controldir,
28
25
    debug,
29
26
    errors,
30
 
    gpg,
31
27
    graph,
32
 
    inventory_delta,
33
28
    lock,
34
29
    lockdir,
35
 
    osutils,
36
 
    registry,
37
30
    repository as _mod_repository,
38
31
    revision as _mod_revision,
39
32
    static_tuple,
40
33
    symbol_versioning,
41
 
    testament as _mod_testament,
42
34
    urlutils,
43
35
    vf_repository,
44
 
    vf_search,
45
36
    )
46
37
from bzrlib.branch import BranchReferenceFormat, BranchWriteLockResult
47
38
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
41
    SmartProtocolError,
51
42
    )
52
43
from bzrlib.i18n import gettext
53
 
from bzrlib.inventory import Inventory
54
44
from bzrlib.lockable_files import LockableFiles
55
45
from bzrlib.smart import client, vfs, repository as smart_repo
56
46
from bzrlib.smart.client import _SmartClient
57
47
from bzrlib.revision import NULL_REVISION
58
 
from bzrlib.revisiontree import InventoryRevisionTree
59
48
from bzrlib.repository import RepositoryWriteLockResult, _LazyListJoin
60
 
from bzrlib.serializer import format_registry as serializer_format_registry
61
 
from bzrlib.trace import mutter, note, warning, log_exception_quietly
62
 
from bzrlib.versionedfile import FulltextContentFactory
 
49
from bzrlib.trace import mutter, note, warning
63
50
 
64
51
 
65
52
_DEFAULT_SEARCH_DEPTH = 100
113
100
 
114
101
    supports_workingtrees = False
115
102
 
116
 
    colocated_branches = False
117
 
 
118
103
    def __init__(self):
119
104
        _mod_bzrdir.BzrDirMetaFormat1.__init__(self)
120
105
        # XXX: It's a bit ugly that the network name is here, because we'd
129
114
 
130
115
    def get_format_description(self):
131
116
        if self._network_name:
132
 
            try:
133
 
                real_format = controldir.network_format_registry.get(
134
 
                        self._network_name)
135
 
            except KeyError:
136
 
                pass
137
 
            else:
138
 
                return 'Remote: ' + real_format.get_format_description()
 
117
            real_format = controldir.network_format_registry.get(self._network_name)
 
118
            return 'Remote: ' + real_format.get_format_description()
139
119
        return 'bzr remote bzrdir'
140
120
 
141
121
    def get_format_string(self):
351
331
        _mod_bzrdir.BzrDirMetaFormat1._set_repository_format) #.im_func)
352
332
 
353
333
 
354
 
class RemoteControlStore(_mod_config.IniFileStore):
355
 
    """Control store which attempts to use HPSS calls to retrieve control store.
356
 
 
357
 
    Note that this is specific to bzr-based formats.
358
 
    """
359
 
 
360
 
    def __init__(self, bzrdir):
361
 
        super(RemoteControlStore, self).__init__()
362
 
        self.bzrdir = bzrdir
363
 
        self._real_store = None
364
 
 
365
 
    def lock_write(self, token=None):
366
 
        self._ensure_real()
367
 
        return self._real_store.lock_write(token)
368
 
 
369
 
    def unlock(self):
370
 
        self._ensure_real()
371
 
        return self._real_store.unlock()
372
 
 
373
 
    @needs_write_lock
374
 
    def save(self):
375
 
        # We need to be able to override the undecorated implementation
376
 
        self.save_without_locking()
377
 
 
378
 
    def save_without_locking(self):
379
 
        super(RemoteControlStore, self).save()
380
 
 
381
 
    def _ensure_real(self):
382
 
        self.bzrdir._ensure_real()
383
 
        if self._real_store is None:
384
 
            self._real_store = _mod_config.ControlStore(self.bzrdir)
385
 
 
386
 
    def external_url(self):
387
 
        return urlutils.join(self.branch.user_url, 'control.conf')
388
 
 
389
 
    def _load_content(self):
390
 
        medium = self.bzrdir._client._medium
391
 
        path = self.bzrdir._path_for_remote_call(self.bzrdir._client)
392
 
        try:
393
 
            response, handler = self.bzrdir._call_expecting_body(
394
 
                'BzrDir.get_config_file', path)
395
 
        except errors.UnknownSmartMethod:
396
 
            self._ensure_real()
397
 
            return self._real_store._load_content()
398
 
        if len(response) and response[0] != 'ok':
399
 
            raise errors.UnexpectedSmartServerResponse(response)
400
 
        return handler.read_body_bytes()
401
 
 
402
 
    def _save_content(self, content):
403
 
        # FIXME JRV 2011-11-22: Ideally this should use a
404
 
        # HPSS call too, but at the moment it is not possible
405
 
        # to write lock control directories.
406
 
        self._ensure_real()
407
 
        return self._real_store._save_content(content)
408
 
 
409
 
 
410
334
class RemoteBzrDir(_mod_bzrdir.BzrDir, _RpcHelper):
411
335
    """Control directory on a remote server, accessed via bzr:// or similar."""
412
336
 
483
407
                warning('VFS BzrDir access triggered\n%s',
484
408
                    ''.join(traceback.format_stack()))
485
409
            self._real_bzrdir = _mod_bzrdir.BzrDir.open_from_transport(
486
 
                self.root_transport, probers=[_mod_bzrdir.BzrProber])
 
410
                self.root_transport, _server_formats=False)
487
411
            self._format._network_name = \
488
412
                self._real_bzrdir._format.network_name()
489
413
 
496
420
        self._next_open_branch_result = None
497
421
        return _mod_bzrdir.BzrDir.break_lock(self)
498
422
 
499
 
    def _vfs_checkout_metadir(self):
500
 
        self._ensure_real()
501
 
        return self._real_bzrdir.checkout_metadir()
502
 
 
503
 
    def checkout_metadir(self):
504
 
        """Retrieve the controldir format to use for checkouts of this one.
505
 
        """
506
 
        medium = self._client._medium
507
 
        if medium._is_remote_before((2, 5)):
508
 
            return self._vfs_checkout_metadir()
509
 
        path = self._path_for_remote_call(self._client)
510
 
        try:
511
 
            response = self._client.call('BzrDir.checkout_metadir',
512
 
                path)
513
 
        except errors.UnknownSmartMethod:
514
 
            medium._remember_remote_is_before((2, 5))
515
 
            return self._vfs_checkout_metadir()
516
 
        if len(response) != 3:
517
 
            raise errors.UnexpectedSmartServerResponse(response)
518
 
        control_name, repo_name, branch_name = response
519
 
        try:
520
 
            format = controldir.network_format_registry.get(control_name)
521
 
        except KeyError:
522
 
            raise errors.UnknownFormatError(kind='control',
523
 
                format=control_name)
524
 
        if repo_name:
525
 
            try:
526
 
                repo_format = _mod_repository.network_format_registry.get(
527
 
                    repo_name)
528
 
            except KeyError:
529
 
                raise errors.UnknownFormatError(kind='repository',
530
 
                    format=repo_name)
531
 
            format.repository_format = repo_format
532
 
        if branch_name:
533
 
            try:
534
 
                format.set_branch_format(
535
 
                    branch.network_format_registry.get(branch_name))
536
 
            except KeyError:
537
 
                raise errors.UnknownFormatError(kind='branch',
538
 
                    format=branch_name)
539
 
        return format
540
 
 
541
423
    def _vfs_cloning_metadir(self, require_stacking=False):
542
424
        self._ensure_real()
543
425
        return self._real_bzrdir.cloning_metadir(
573
455
        if len(branch_info) != 2:
574
456
            raise errors.UnexpectedSmartServerResponse(response)
575
457
        branch_ref, branch_name = branch_info
576
 
        try:
577
 
            format = controldir.network_format_registry.get(control_name)
578
 
        except KeyError:
579
 
            raise errors.UnknownFormatError(kind='control', format=control_name)
580
 
 
 
458
        format = controldir.network_format_registry.get(control_name)
581
459
        if repo_name:
582
 
            try:
583
 
                format.repository_format = _mod_repository.network_format_registry.get(
584
 
                    repo_name)
585
 
            except KeyError:
586
 
                raise errors.UnknownFormatError(kind='repository',
587
 
                    format=repo_name)
 
460
            format.repository_format = _mod_repository.network_format_registry.get(
 
461
                repo_name)
588
462
        if branch_ref == 'ref':
589
463
            # XXX: we need possible_transports here to avoid reopening the
590
464
            # connection to the referenced location
593
467
            format.set_branch_format(branch_format)
594
468
        elif branch_ref == 'branch':
595
469
            if branch_name:
596
 
                try:
597
 
                    branch_format = branch.network_format_registry.get(
598
 
                        branch_name)
599
 
                except KeyError:
600
 
                    raise errors.UnknownFormatError(kind='branch',
601
 
                        format=branch_name)
602
 
                format.set_branch_format(branch_format)
 
470
                format.set_branch_format(
 
471
                    branch.network_format_registry.get(branch_name))
603
472
        else:
604
473
            raise errors.UnexpectedSmartServerResponse(response)
605
474
        return format
615
484
 
616
485
    def destroy_repository(self):
617
486
        """See BzrDir.destroy_repository"""
618
 
        path = self._path_for_remote_call(self._client)
619
 
        try:
620
 
            response = self._call('BzrDir.destroy_repository', path)
621
 
        except errors.UnknownSmartMethod:
622
 
            self._ensure_real()
623
 
            self._real_bzrdir.destroy_repository()
624
 
            return
625
 
        if response[0] != 'ok':
626
 
            raise SmartProtocolError('unexpected response code %s' % (response,))
 
487
        self._ensure_real()
 
488
        self._real_bzrdir.destroy_repository()
627
489
 
628
490
    def create_branch(self, name=None, repository=None,
629
491
                      append_revisions_only=None):
630
 
        if name is None:
631
 
            name = self._get_selected_branch()
632
 
        if name != "":
633
 
            raise errors.NoColocatedBranchSupport(self)
634
492
        # as per meta1 formats - just delegate to the format object which may
635
493
        # be parameterised.
636
494
        real_branch = self._format.get_branch_format().initialize(self,
655
513
 
656
514
    def destroy_branch(self, name=None):
657
515
        """See BzrDir.destroy_branch"""
658
 
        if name is None:
659
 
            name = self._get_selected_branch()
660
 
        if name != "":
661
 
            raise errors.NoColocatedBranchSupport(self)
662
 
        path = self._path_for_remote_call(self._client)
663
 
        try:
664
 
            if name != "":
665
 
                args = (name, )
666
 
            else:
667
 
                args = ()
668
 
            response = self._call('BzrDir.destroy_branch', path, *args)
669
 
        except errors.UnknownSmartMethod:
670
 
            self._ensure_real()
671
 
            self._real_bzrdir.destroy_branch(name=name)
672
 
            self._next_open_branch_result = None
673
 
            return
 
516
        self._ensure_real()
 
517
        self._real_bzrdir.destroy_branch(name=name)
674
518
        self._next_open_branch_result = None
675
 
        if response[0] != 'ok':
676
 
            raise SmartProtocolError('unexpected response code %s' % (response,))
677
519
 
678
520
    def create_workingtree(self, revision_id=None, from_branch=None,
679
521
        accelerator_tree=None, hardlink=False):
687
529
        b = self.open_branch(name=name)
688
530
        return b._format
689
531
 
690
 
    def get_branches(self, possible_transports=None, ignore_fallbacks=False):
691
 
        path = self._path_for_remote_call(self._client)
692
 
        try:
693
 
            response, handler = self._call_expecting_body(
694
 
                'BzrDir.get_branches', path)
695
 
        except errors.UnknownSmartMethod:
696
 
            self._ensure_real()
697
 
            return self._real_bzrdir.get_branches()
698
 
        if response[0] != "success":
699
 
            raise errors.UnexpectedSmartServerResponse(response)
700
 
        body = bencode.bdecode(handler.read_body_bytes())
701
 
        ret = {}
702
 
        for (name, value) in body.iteritems():
703
 
            ret[name] = self._open_branch(name, value[0], value[1],
704
 
                possible_transports=possible_transports,
705
 
                ignore_fallbacks=ignore_fallbacks)
706
 
        return ret
707
 
 
708
 
    def set_branch_reference(self, target_branch, name=None):
709
 
        """See BzrDir.set_branch_reference()."""
710
 
        if name is None:
711
 
            name = self._get_selected_branch()
712
 
        if name != "":
713
 
            raise errors.NoColocatedBranchSupport(self)
714
 
        self._ensure_real()
715
 
        return self._real_bzrdir.set_branch_reference(target_branch, name=name)
716
 
 
717
532
    def get_branch_reference(self, name=None):
718
533
        """See BzrDir.get_branch_reference()."""
719
 
        if name is None:
720
 
            name = self._get_selected_branch()
721
 
        if name != "":
 
534
        if name is not None:
 
535
            # XXX JRV20100304: Support opening colocated branches
722
536
            raise errors.NoColocatedBranchSupport(self)
723
537
        response = self._get_branch_reference()
724
538
        if response[0] == 'ref':
760
574
        """See BzrDir._get_tree_branch()."""
761
575
        return None, self.open_branch(name=name)
762
576
 
763
 
    def _open_branch(self, name, kind, location_or_format,
764
 
                     ignore_fallbacks=False, possible_transports=None):
765
 
        if kind == 'ref':
 
577
    def open_branch(self, name=None, unsupported=False,
 
578
                    ignore_fallbacks=False):
 
579
        if unsupported:
 
580
            raise NotImplementedError('unsupported flag support not implemented yet.')
 
581
        if self._next_open_branch_result is not None:
 
582
            # See create_branch for details.
 
583
            result = self._next_open_branch_result
 
584
            self._next_open_branch_result = None
 
585
            return result
 
586
        response = self._get_branch_reference()
 
587
        if response[0] == 'ref':
766
588
            # a branch reference, use the existing BranchReference logic.
767
589
            format = BranchReferenceFormat()
768
590
            return format.open(self, name=name, _found=True,
769
 
                location=location_or_format, ignore_fallbacks=ignore_fallbacks,
770
 
                possible_transports=possible_transports)
771
 
        branch_format_name = location_or_format
 
591
                location=response[1], ignore_fallbacks=ignore_fallbacks)
 
592
        branch_format_name = response[1]
772
593
        if not branch_format_name:
773
594
            branch_format_name = None
774
595
        format = RemoteBranchFormat(network_name=branch_format_name)
775
596
        return RemoteBranch(self, self.find_repository(), format=format,
776
 
            setup_stacking=not ignore_fallbacks, name=name,
777
 
            possible_transports=possible_transports)
778
 
 
779
 
    def open_branch(self, name=None, unsupported=False,
780
 
                    ignore_fallbacks=False, possible_transports=None):
781
 
        if name is None:
782
 
            name = self._get_selected_branch()
783
 
        if name != "":
784
 
            raise errors.NoColocatedBranchSupport(self)
785
 
        if unsupported:
786
 
            raise NotImplementedError('unsupported flag support not implemented yet.')
787
 
        if self._next_open_branch_result is not None:
788
 
            # See create_branch for details.
789
 
            result = self._next_open_branch_result
790
 
            self._next_open_branch_result = None
791
 
            return result
792
 
        response = self._get_branch_reference()
793
 
        return self._open_branch(name, response[0], response[1],
794
 
            possible_transports=possible_transports,
795
 
            ignore_fallbacks=ignore_fallbacks)
 
597
            setup_stacking=not ignore_fallbacks, name=name)
796
598
 
797
599
    def _open_repo_v1(self, path):
798
600
        verb = 'BzrDir.find_repository'
861
663
 
862
664
    def has_workingtree(self):
863
665
        if self._has_working_tree is None:
864
 
            path = self._path_for_remote_call(self._client)
865
 
            try:
866
 
                response = self._call('BzrDir.has_workingtree', path)
867
 
            except errors.UnknownSmartMethod:
868
 
                self._ensure_real()
869
 
                self._has_working_tree = self._real_bzrdir.has_workingtree()
870
 
            else:
871
 
                if response[0] not in ('yes', 'no'):
872
 
                    raise SmartProtocolError('unexpected response code %s' % (response,))
873
 
                self._has_working_tree = (response[0] == 'yes')
 
666
            self._ensure_real()
 
667
            self._has_working_tree = self._real_bzrdir.has_workingtree()
874
668
        return self._has_working_tree
875
669
 
876
670
    def open_workingtree(self, recommend_upgrade=True):
904
698
        """Upgrading of remote bzrdirs is not supported yet."""
905
699
        return False
906
700
 
 
701
    def clone(self, url, revision_id=None, force_new_repo=False,
 
702
              preserve_stacking=False):
 
703
        self._ensure_real()
 
704
        return self._real_bzrdir.clone(url, revision_id=revision_id,
 
705
            force_new_repo=force_new_repo, preserve_stacking=preserve_stacking)
 
706
 
907
707
    def _get_config(self):
908
708
        return RemoteBzrDirConfig(self)
909
709
 
910
 
    def _get_config_store(self):
911
 
        return RemoteControlStore(self)
912
 
 
913
710
 
914
711
class RemoteRepositoryFormat(vf_repository.VersionedFileRepositoryFormat):
915
712
    """Format for repositories accessed over a _SmartClient.
1051
848
            network_name = self._network_name
1052
849
        else:
1053
850
            # Select the current bzrlib default and ask for that.
1054
 
            reference_bzrdir_format = controldir.format_registry.get('default')()
 
851
            reference_bzrdir_format = _mod_bzrdir.format_registry.get('default')()
1055
852
            reference_format = reference_bzrdir_format.repository_format
1056
853
            network_name = reference_format.network_name()
1057
854
        # 2) try direct creation via RPC
1083
880
 
1084
881
    def _ensure_real(self):
1085
882
        if self._custom_format is None:
1086
 
            try:
1087
 
                self._custom_format = _mod_repository.network_format_registry.get(
1088
 
                    self._network_name)
1089
 
            except KeyError:
1090
 
                raise errors.UnknownFormatError(kind='repository',
1091
 
                    format=self._network_name)
 
883
            self._custom_format = _mod_repository.network_format_registry.get(
 
884
                self._network_name)
1092
885
 
1093
886
    @property
1094
887
    def _fetch_order(self):
1129
922
        return self._custom_format._serializer
1130
923
 
1131
924
 
1132
 
class RemoteRepository(_mod_repository.Repository, _RpcHelper,
1133
 
        lock._RelockDebugMixin):
 
925
class RemoteRepository(_RpcHelper, lock._RelockDebugMixin,
 
926
    controldir.ControlComponent):
1134
927
    """Repository accessed over rpc.
1135
928
 
1136
929
    For the moment most operations are performed using local transport-backed
1160
953
        self._format = format
1161
954
        self._lock_mode = None
1162
955
        self._lock_token = None
1163
 
        self._write_group_tokens = None
1164
956
        self._lock_count = 0
1165
957
        self._leave_lock = False
1166
958
        # Cache of revision parents; misses are cached during read locks, and
1206
998
 
1207
999
        :param suppress_errors: see Repository.abort_write_group.
1208
1000
        """
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
 
1001
        self._ensure_real()
 
1002
        return self._real_repository.abort_write_group(
 
1003
            suppress_errors=suppress_errors)
1233
1004
 
1234
1005
    @property
1235
1006
    def chk_bytes(self):
1249
1020
        for older plugins that don't use e.g. the CommitBuilder
1250
1021
        facility.
1251
1022
        """
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()
 
1023
        self._ensure_real()
 
1024
        return self._real_repository.commit_write_group()
1265
1025
 
1266
1026
    def resume_write_group(self, tokens):
1267
 
        if self._real_repository:
1268
 
            return self._real_repository.resume_write_group(tokens)
1269
 
        path = self.bzrdir._path_for_remote_call(self._client)
1270
 
        try:
1271
 
            response = self._call('Repository.check_write_group', path,
1272
 
               self._lock_token, tokens)
1273
 
        except errors.UnknownSmartMethod:
1274
 
            self._ensure_real()
1275
 
            return self._real_repository.resume_write_group(tokens)
1276
 
        if response != ('ok', ):
1277
 
            raise errors.UnexpectedSmartServerResponse(response)
1278
 
        self._write_group_tokens = tokens
 
1027
        self._ensure_real()
 
1028
        return self._real_repository.resume_write_group(tokens)
1279
1029
 
1280
1030
    def suspend_write_group(self):
1281
 
        if self._real_repository:
1282
 
            return self._real_repository.suspend_write_group()
1283
 
        ret = self._write_group_tokens or []
1284
 
        self._write_group_tokens = None
1285
 
        return ret
 
1031
        self._ensure_real()
 
1032
        return self._real_repository.suspend_write_group()
1286
1033
 
1287
1034
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
1288
1035
        self._ensure_real()
1498
1245
 
1499
1246
    def get_physical_lock_status(self):
1500
1247
        """See Repository.get_physical_lock_status()."""
1501
 
        path = self.bzrdir._path_for_remote_call(self._client)
1502
 
        try:
1503
 
            response = self._call('Repository.get_physical_lock_status', path)
1504
 
        except errors.UnknownSmartMethod:
1505
 
            self._ensure_real()
1506
 
            return self._real_repository.get_physical_lock_status()
1507
 
        if response[0] not in ('yes', 'no'):
1508
 
            raise errors.UnexpectedSmartServerResponse(response)
1509
 
        return (response[0] == 'yes')
 
1248
        # should be an API call to the server.
 
1249
        self._ensure_real()
 
1250
        return self._real_repository.get_physical_lock_status()
1510
1251
 
1511
1252
    def is_in_write_group(self):
1512
1253
        """Return True if there is an open write group.
1513
1254
 
1514
1255
        write groups are only applicable locally for the smart server..
1515
1256
        """
1516
 
        if self._write_group_tokens is not None:
1517
 
            return True
1518
1257
        if self._real_repository:
1519
1258
            return self._real_repository.is_in_write_group()
1520
1259
 
1655
1394
            self._real_repository.lock_write(self._lock_token)
1656
1395
        elif self._lock_mode == 'r':
1657
1396
            self._real_repository.lock_read()
1658
 
        if self._write_group_tokens is not None:
1659
 
            # if we are already in a write group, resume it
1660
 
            self._real_repository.resume_write_group(self._write_group_tokens)
1661
 
            self._write_group_tokens = None
1662
1397
 
1663
1398
    def start_write_group(self):
1664
1399
        """Start a write group on the decorated repository.
1668
1403
        for older plugins that don't use e.g. the CommitBuilder
1669
1404
        facility.
1670
1405
        """
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]
 
1406
        self._ensure_real()
 
1407
        return self._real_repository.start_write_group()
1688
1408
 
1689
1409
    def _unlock(self, token):
1690
1410
        path = self.bzrdir._path_for_remote_call(self._client)
1717
1437
            # This is just to let the _real_repository stay up to date.
1718
1438
            if self._real_repository is not None:
1719
1439
                self._real_repository.unlock()
1720
 
            elif self._write_group_tokens is not None:
1721
 
                self.abort_write_group()
1722
1440
        finally:
1723
1441
            # The rpc-level lock should be released even if there was a
1724
1442
            # problem releasing the vfs-based lock.
1736
1454
 
1737
1455
    def break_lock(self):
1738
1456
        # should hand off to the network
1739
 
        path = self.bzrdir._path_for_remote_call(self._client)
1740
 
        try:
1741
 
            response = self._call("Repository.break_lock", path)
1742
 
        except errors.UnknownSmartMethod:
1743
 
            self._ensure_real()
1744
 
            return self._real_repository.break_lock()
1745
 
        if response != ('ok',):
1746
 
            raise errors.UnexpectedSmartServerResponse(response)
 
1457
        self._ensure_real()
 
1458
        return self._real_repository.break_lock()
1747
1459
 
1748
1460
    def _get_tarball(self, compression):
1749
1461
        """Return a TemporaryFile containing a repository tarball.
1767
1479
            return t
1768
1480
        raise errors.UnexpectedSmartServerResponse(response)
1769
1481
 
1770
 
    @needs_read_lock
1771
1482
    def sprout(self, to_bzrdir, revision_id=None):
1772
 
        """Create a descendent repository for new development.
1773
 
 
1774
 
        Unlike clone, this does not copy the settings of the repository.
1775
 
        """
1776
 
        dest_repo = self._create_sprouting_repo(to_bzrdir, shared=False)
 
1483
        # TODO: Option to control what format is created?
 
1484
        self._ensure_real()
 
1485
        dest_repo = self._real_repository._format.initialize(to_bzrdir,
 
1486
                                                             shared=False)
1777
1487
        dest_repo.fetch(self, revision_id=revision_id)
1778
1488
        return dest_repo
1779
1489
 
1780
 
    def _create_sprouting_repo(self, a_bzrdir, shared):
1781
 
        if not isinstance(a_bzrdir._format, self.bzrdir._format.__class__):
1782
 
            # use target default format.
1783
 
            dest_repo = a_bzrdir.create_repository()
1784
 
        else:
1785
 
            # Most control formats need the repository to be specifically
1786
 
            # created, but on some old all-in-one formats it's not needed
1787
 
            try:
1788
 
                dest_repo = self._format.initialize(a_bzrdir, shared=shared)
1789
 
            except errors.UninitializableFormat:
1790
 
                dest_repo = a_bzrdir.open_repository()
1791
 
        return dest_repo
1792
 
 
1793
1490
    ### These methods are just thin shims to the VFS object for now.
1794
1491
 
1795
 
    @needs_read_lock
1796
1492
    def revision_tree(self, revision_id):
1797
 
        revision_id = _mod_revision.ensure_null(revision_id)
1798
 
        if revision_id == _mod_revision.NULL_REVISION:
1799
 
            return InventoryRevisionTree(self,
1800
 
                Inventory(root_id=None), _mod_revision.NULL_REVISION)
1801
 
        else:
1802
 
            return list(self.revision_trees([revision_id]))[0]
 
1493
        self._ensure_real()
 
1494
        return self._real_repository.revision_tree(revision_id)
1803
1495
 
1804
1496
    def get_serializer_format(self):
1805
 
        path = self.bzrdir._path_for_remote_call(self._client)
1806
 
        try:
1807
 
            response = self._call('VersionedFileRepository.get_serializer_format',
1808
 
                path)
1809
 
        except errors.UnknownSmartMethod:
1810
 
            self._ensure_real()
1811
 
            return self._real_repository.get_serializer_format()
1812
 
        if response[0] != 'ok':
1813
 
            raise errors.UnexpectedSmartServerResponse(response)
1814
 
        return response[1]
 
1497
        self._ensure_real()
 
1498
        return self._real_repository.get_serializer_format()
1815
1499
 
1816
1500
    def get_commit_builder(self, branch, parents, config, timestamp=None,
1817
1501
                           timezone=None, committer=None, revprops=None,
1818
1502
                           revision_id=None, lossy=False):
1819
 
        """Obtain a CommitBuilder for this repository.
1820
 
 
1821
 
        :param branch: Branch to commit to.
1822
 
        :param parents: Revision ids of the parents of the new revision.
1823
 
        :param config: Configuration to use.
1824
 
        :param timestamp: Optional timestamp recorded for commit.
1825
 
        :param timezone: Optional timezone for timestamp.
1826
 
        :param committer: Optional committer to set for commit.
1827
 
        :param revprops: Optional dictionary of revision properties.
1828
 
        :param revision_id: Optional revision id.
1829
 
        :param lossy: Whether to discard data that can not be natively
1830
 
            represented, when pushing to a foreign VCS
1831
 
        """
1832
 
        if self._fallback_repositories and not self._format.supports_chks:
1833
 
            raise errors.BzrError("Cannot commit directly to a stacked branch"
1834
 
                " in pre-2a formats. See "
1835
 
                "https://bugs.launchpad.net/bzr/+bug/375013 for details.")
1836
 
        if self._format.rich_root_data:
1837
 
            commit_builder_kls = vf_repository.VersionedFileRootCommitBuilder
1838
 
        else:
1839
 
            commit_builder_kls = vf_repository.VersionedFileCommitBuilder
1840
 
        result = commit_builder_kls(self, parents, config,
1841
 
            timestamp, timezone, committer, revprops, revision_id,
1842
 
            lossy)
1843
 
        self.start_write_group()
1844
 
        return result
 
1503
        # FIXME: It ought to be possible to call this without immediately
 
1504
        # triggering _ensure_real.  For now it's the easiest thing to do.
 
1505
        self._ensure_real()
 
1506
        real_repo = self._real_repository
 
1507
        builder = real_repo.get_commit_builder(branch, parents,
 
1508
                config, timestamp=timestamp, timezone=timezone,
 
1509
                committer=committer, revprops=revprops,
 
1510
                revision_id=revision_id, lossy=lossy)
 
1511
        return builder
1845
1512
 
1846
1513
    def add_fallback_repository(self, repository):
1847
1514
        """Add a repository to use for looking up data not held locally.
1892
1559
            delta, new_revision_id, parents, basis_inv=basis_inv,
1893
1560
            propagate_caches=propagate_caches)
1894
1561
 
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)
 
1562
    def add_revision(self, rev_id, rev, inv=None, config=None):
 
1563
        self._ensure_real()
 
1564
        return self._real_repository.add_revision(
 
1565
            rev_id, rev, inv=inv, config=config)
1920
1566
 
1921
1567
    @needs_read_lock
1922
1568
    def get_inventory(self, revision_id):
1923
 
        return list(self.iter_inventories([revision_id]))[0]
1924
 
 
1925
 
    def _iter_inventories_rpc(self, revision_ids, ordering):
1926
 
        if ordering is None:
1927
 
            ordering = 'unordered'
1928
 
        path = self.bzrdir._path_for_remote_call(self._client)
1929
 
        body = "\n".join(revision_ids)
1930
 
        response_tuple, response_handler = (
1931
 
            self._call_with_body_bytes_expecting_body(
1932
 
                "VersionedFileRepository.get_inventories",
1933
 
                (path, ordering), body))
1934
 
        if response_tuple[0] != "ok":
1935
 
            raise errors.UnexpectedSmartServerResponse(response_tuple)
1936
 
        deserializer = inventory_delta.InventoryDeltaDeserializer()
1937
 
        byte_stream = response_handler.read_streamed_body()
1938
 
        decoded = smart_repo._byte_stream_to_stream(byte_stream)
1939
 
        if decoded is None:
1940
 
            # no results whatsoever
1941
 
            return
1942
 
        src_format, stream = decoded
1943
 
        if src_format.network_name() != self._format.network_name():
1944
 
            raise AssertionError(
1945
 
                "Mismatched RemoteRepository and stream src %r, %r" % (
1946
 
                src_format.network_name(), self._format.network_name()))
1947
 
        # ignore the src format, it's not really relevant
1948
 
        prev_inv = Inventory(root_id=None,
1949
 
            revision_id=_mod_revision.NULL_REVISION)
1950
 
        # there should be just one substream, with inventory deltas
1951
 
        substream_kind, substream = stream.next()
1952
 
        if substream_kind != "inventory-deltas":
1953
 
            raise AssertionError(
1954
 
                 "Unexpected stream %r received" % substream_kind)
1955
 
        for record in substream:
1956
 
            (parent_id, new_id, versioned_root, tree_references, invdelta) = (
1957
 
                deserializer.parse_text_bytes(record.get_bytes_as("fulltext")))
1958
 
            if parent_id != prev_inv.revision_id:
1959
 
                raise AssertionError("invalid base %r != %r" % (parent_id,
1960
 
                    prev_inv.revision_id))
1961
 
            inv = prev_inv.create_by_apply_delta(invdelta, new_id)
1962
 
            yield inv, inv.revision_id
1963
 
            prev_inv = inv
1964
 
 
1965
 
    def _iter_inventories_vfs(self, revision_ids, ordering=None):
1966
1569
        self._ensure_real()
1967
 
        return self._real_repository._iter_inventories(revision_ids, ordering)
 
1570
        return self._real_repository.get_inventory(revision_id)
1968
1571
 
1969
1572
    def iter_inventories(self, revision_ids, ordering=None):
1970
 
        """Get many inventories by revision_ids.
1971
 
 
1972
 
        This will buffer some or all of the texts used in constructing the
1973
 
        inventories in memory, but will only parse a single inventory at a
1974
 
        time.
1975
 
 
1976
 
        :param revision_ids: The expected revision ids of the inventories.
1977
 
        :param ordering: optional ordering, e.g. 'topological'.  If not
1978
 
            specified, the order of revision_ids will be preserved (by
1979
 
            buffering if necessary).
1980
 
        :return: An iterator of inventories.
1981
 
        """
1982
 
        if ((None in revision_ids)
1983
 
            or (_mod_revision.NULL_REVISION in revision_ids)):
1984
 
            raise ValueError('cannot get null revision inventory')
1985
 
        for inv, revid in self._iter_inventories(revision_ids, ordering):
1986
 
            if inv is None:
1987
 
                raise errors.NoSuchRevision(self, revid)
1988
 
            yield inv
1989
 
 
1990
 
    def _iter_inventories(self, revision_ids, ordering=None):
1991
 
        if len(revision_ids) == 0:
1992
 
            return
1993
 
        missing = set(revision_ids)
1994
 
        if ordering is None:
1995
 
            order_as_requested = True
1996
 
            invs = {}
1997
 
            order = list(revision_ids)
1998
 
            order.reverse()
1999
 
            next_revid = order.pop()
2000
 
        else:
2001
 
            order_as_requested = False
2002
 
            if ordering != 'unordered' and self._fallback_repositories:
2003
 
                raise ValueError('unsupported ordering %r' % ordering)
2004
 
        iter_inv_fns = [self._iter_inventories_rpc] + [
2005
 
            fallback._iter_inventories for fallback in
2006
 
            self._fallback_repositories]
2007
 
        try:
2008
 
            for iter_inv in iter_inv_fns:
2009
 
                request = [revid for revid in revision_ids if revid in missing]
2010
 
                for inv, revid in iter_inv(request, ordering):
2011
 
                    if inv is None:
2012
 
                        continue
2013
 
                    missing.remove(inv.revision_id)
2014
 
                    if ordering != 'unordered':
2015
 
                        invs[revid] = inv
2016
 
                    else:
2017
 
                        yield inv, revid
2018
 
                if order_as_requested:
2019
 
                    # Yield as many results as we can while preserving order.
2020
 
                    while next_revid in invs:
2021
 
                        inv = invs.pop(next_revid)
2022
 
                        yield inv, inv.revision_id
2023
 
                        try:
2024
 
                            next_revid = order.pop()
2025
 
                        except IndexError:
2026
 
                            # We still want to fully consume the stream, just
2027
 
                            # in case it is not actually finished at this point
2028
 
                            next_revid = None
2029
 
                            break
2030
 
        except errors.UnknownSmartMethod:
2031
 
            for inv, revid in self._iter_inventories_vfs(revision_ids, ordering):
2032
 
                yield inv, revid
2033
 
            return
2034
 
        # Report missing
2035
 
        if order_as_requested:
2036
 
            if next_revid is not None:
2037
 
                yield None, next_revid
2038
 
            while order:
2039
 
                revid = order.pop()
2040
 
                yield invs.get(revid), revid
2041
 
        else:
2042
 
            while missing:
2043
 
                yield None, missing.pop()
 
1573
        self._ensure_real()
 
1574
        return self._real_repository.iter_inventories(revision_ids, ordering)
2044
1575
 
2045
1576
    @needs_read_lock
2046
1577
    def get_revision(self, revision_id):
2047
 
        return self.get_revisions([revision_id])[0]
 
1578
        self._ensure_real()
 
1579
        return self._real_repository.get_revision(revision_id)
2048
1580
 
2049
1581
    def get_transaction(self):
2050
1582
        self._ensure_real()
2052
1584
 
2053
1585
    @needs_read_lock
2054
1586
    def clone(self, a_bzrdir, revision_id=None):
2055
 
        dest_repo = self._create_sprouting_repo(
2056
 
            a_bzrdir, shared=self.is_shared())
2057
 
        self.copy_content_into(dest_repo, revision_id)
2058
 
        return dest_repo
 
1587
        self._ensure_real()
 
1588
        return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
2059
1589
 
2060
1590
    def make_working_trees(self):
2061
1591
        """See Repository.make_working_trees"""
2062
 
        path = self.bzrdir._path_for_remote_call(self._client)
2063
 
        try:
2064
 
            response = self._call('Repository.make_working_trees', path)
2065
 
        except errors.UnknownSmartMethod:
2066
 
            self._ensure_real()
2067
 
            return self._real_repository.make_working_trees()
2068
 
        if response[0] not in ('yes', 'no'):
2069
 
            raise SmartProtocolError('unexpected response code %s' % (response,))
2070
 
        return response[0] == 'yes'
 
1592
        self._ensure_real()
 
1593
        return self._real_repository.make_working_trees()
2071
1594
 
2072
1595
    def refresh_data(self):
2073
1596
        """Re-read any data needed to synchronise with disk.
2082
1605
        """
2083
1606
        if self._real_repository is not None:
2084
1607
            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()
2088
1608
 
2089
1609
    def revision_ids_to_search_result(self, result_set):
2090
1610
        """Convert a set of revision ids to a graph SearchResult."""
2095
1615
        included_keys = result_set.intersection(result_parents)
2096
1616
        start_keys = result_set.difference(included_keys)
2097
1617
        exclude_keys = result_parents.difference(result_set)
2098
 
        result = vf_search.SearchResult(start_keys, exclude_keys,
 
1618
        result = graph.SearchResult(start_keys, exclude_keys,
2099
1619
            len(result_set), result_set)
2100
1620
        return result
2101
1621
 
2149
1669
        # the InterRepository base class, which raises an
2150
1670
        # IncompatibleRepositories when asked to fetch.
2151
1671
        inter = _mod_repository.InterRepository.get(source, self)
2152
 
        if (fetch_spec is not None and
2153
 
            not getattr(inter, "supports_fetch_spec", False)):
2154
 
            raise errors.UnsupportedOperation(
2155
 
                "fetch_spec not supported for %r" % inter)
2156
1672
        return inter.fetch(revision_id=revision_id,
2157
1673
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
2158
1674
 
2160
1676
        self._ensure_real()
2161
1677
        self._real_repository.create_bundle(target, base, fileobj, format)
2162
1678
 
 
1679
    @needs_read_lock
 
1680
    @symbol_versioning.deprecated_method(
 
1681
        symbol_versioning.deprecated_in((2, 4, 0)))
 
1682
    def get_ancestry(self, revision_id, topo_sorted=True):
 
1683
        self._ensure_real()
 
1684
        return self._real_repository.get_ancestry(revision_id, topo_sorted)
 
1685
 
2163
1686
    def fileids_altered_by_revision_ids(self, revision_ids):
2164
1687
        self._ensure_real()
2165
1688
        return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
2169
1692
        return self._real_repository._get_versioned_file_checker(
2170
1693
            revisions, revision_versions_cache)
2171
1694
 
2172
 
    def _iter_files_bytes_rpc(self, desired_files, absent):
2173
 
        path = self.bzrdir._path_for_remote_call(self._client)
2174
 
        lines = []
2175
 
        identifiers = []
2176
 
        for (file_id, revid, identifier) in desired_files:
2177
 
            lines.append("%s\0%s" % (
2178
 
                osutils.safe_file_id(file_id),
2179
 
                osutils.safe_revision_id(revid)))
2180
 
            identifiers.append(identifier)
2181
 
        (response_tuple, response_handler) = (
2182
 
            self._call_with_body_bytes_expecting_body(
2183
 
            "Repository.iter_files_bytes", (path, ), "\n".join(lines)))
2184
 
        if response_tuple != ('ok', ):
2185
 
            response_handler.cancel_read_body()
2186
 
            raise errors.UnexpectedSmartServerResponse(response_tuple)
2187
 
        byte_stream = response_handler.read_streamed_body()
2188
 
        def decompress_stream(start, byte_stream, unused):
2189
 
            decompressor = zlib.decompressobj()
2190
 
            yield decompressor.decompress(start)
2191
 
            while decompressor.unused_data == "":
2192
 
                try:
2193
 
                    data = byte_stream.next()
2194
 
                except StopIteration:
2195
 
                    break
2196
 
                yield decompressor.decompress(data)
2197
 
            yield decompressor.flush()
2198
 
            unused.append(decompressor.unused_data)
2199
 
        unused = ""
2200
 
        while True:
2201
 
            while not "\n" in unused:
2202
 
                unused += byte_stream.next()
2203
 
            header, rest = unused.split("\n", 1)
2204
 
            args = header.split("\0")
2205
 
            if args[0] == "absent":
2206
 
                absent[identifiers[int(args[3])]] = (args[1], args[2])
2207
 
                unused = rest
2208
 
                continue
2209
 
            elif args[0] == "ok":
2210
 
                idx = int(args[1])
2211
 
            else:
2212
 
                raise errors.UnexpectedSmartServerResponse(args)
2213
 
            unused_chunks = []
2214
 
            yield (identifiers[idx],
2215
 
                decompress_stream(rest, byte_stream, unused_chunks))
2216
 
            unused = "".join(unused_chunks)
2217
 
 
2218
1695
    def iter_files_bytes(self, desired_files):
2219
1696
        """See Repository.iter_file_bytes.
2220
1697
        """
2221
 
        try:
2222
 
            absent = {}
2223
 
            for (identifier, bytes_iterator) in self._iter_files_bytes_rpc(
2224
 
                    desired_files, absent):
2225
 
                yield identifier, bytes_iterator
2226
 
            for fallback in self._fallback_repositories:
2227
 
                if not absent:
2228
 
                    break
2229
 
                desired_files = [(key[0], key[1], identifier) for
2230
 
                    (identifier, key) in absent.iteritems()]
2231
 
                for (identifier, bytes_iterator) in fallback.iter_files_bytes(desired_files):
2232
 
                    del absent[identifier]
2233
 
                    yield identifier, bytes_iterator
2234
 
            if absent:
2235
 
                # There may be more missing items, but raise an exception
2236
 
                # for just one.
2237
 
                missing_identifier = absent.keys()[0]
2238
 
                missing_key = absent[missing_identifier]
2239
 
                raise errors.RevisionNotPresent(revision_id=missing_key[1],
2240
 
                    file_id=missing_key[0])
2241
 
        except errors.UnknownSmartMethod:
2242
 
            self._ensure_real()
2243
 
            for (identifier, bytes_iterator) in (
2244
 
                self._real_repository.iter_files_bytes(desired_files)):
2245
 
                yield identifier, bytes_iterator
 
1698
        self._ensure_real()
 
1699
        return self._real_repository.iter_files_bytes(desired_files)
2246
1700
 
2247
1701
    def get_cached_parent_map(self, revision_ids):
2248
1702
        """See bzrlib.CachingParentsProvider.get_cached_parent_map"""
2313
1767
            parents_map = {}
2314
1768
        if _DEFAULT_SEARCH_DEPTH <= 0:
2315
1769
            (start_set, stop_keys,
2316
 
             key_count) = vf_search.search_result_from_parent_map(
 
1770
             key_count) = graph.search_result_from_parent_map(
2317
1771
                parents_map, self._unstacked_provider.missing_keys)
2318
1772
        else:
2319
1773
            (start_set, stop_keys,
2320
 
             key_count) = vf_search.limited_search_result_from_parent_map(
 
1774
             key_count) = graph.limited_search_result_from_parent_map(
2321
1775
                parents_map, self._unstacked_provider.missing_keys,
2322
1776
                keys, depth=_DEFAULT_SEARCH_DEPTH)
2323
1777
        recipe = ('manual', start_set, stop_keys, key_count)
2374
1828
 
2375
1829
    @needs_read_lock
2376
1830
    def get_signature_text(self, revision_id):
2377
 
        path = self.bzrdir._path_for_remote_call(self._client)
2378
 
        try:
2379
 
            response_tuple, response_handler = self._call_expecting_body(
2380
 
                'Repository.get_revision_signature_text', path, revision_id)
2381
 
        except errors.UnknownSmartMethod:
2382
 
            self._ensure_real()
2383
 
            return self._real_repository.get_signature_text(revision_id)
2384
 
        except errors.NoSuchRevision, err:
2385
 
            for fallback in self._fallback_repositories:
2386
 
                try:
2387
 
                    return fallback.get_signature_text(revision_id)
2388
 
                except errors.NoSuchRevision:
2389
 
                    pass
2390
 
            raise err
2391
 
        else:
2392
 
            if response_tuple[0] != 'ok':
2393
 
                raise errors.UnexpectedSmartServerResponse(response_tuple)
2394
 
            return response_handler.read_body_bytes()
 
1831
        self._ensure_real()
 
1832
        return self._real_repository.get_signature_text(revision_id)
2395
1833
 
2396
1834
    @needs_read_lock
2397
1835
    def _get_inventory_xml(self, revision_id):
2398
 
        # This call is used by older working tree formats,
2399
 
        # which stored a serialized basis inventory.
2400
1836
        self._ensure_real()
2401
1837
        return self._real_repository._get_inventory_xml(revision_id)
2402
1838
 
2403
 
    @needs_write_lock
2404
1839
    def reconcile(self, other=None, thorough=False):
2405
 
        from bzrlib.reconcile import RepoReconciler
2406
 
        path = self.bzrdir._path_for_remote_call(self._client)
2407
 
        try:
2408
 
            response, handler = self._call_expecting_body(
2409
 
                'Repository.reconcile', path, self._lock_token)
2410
 
        except (errors.UnknownSmartMethod, errors.TokenLockingNotSupported):
2411
 
            self._ensure_real()
2412
 
            return self._real_repository.reconcile(other=other, thorough=thorough)
2413
 
        if response != ('ok', ):
2414
 
            raise errors.UnexpectedSmartServerResponse(response)
2415
 
        body = handler.read_body_bytes()
2416
 
        result = RepoReconciler(self)
2417
 
        for line in body.split('\n'):
2418
 
            if not line:
2419
 
                continue
2420
 
            key, val_text = line.split(':')
2421
 
            if key == "garbage_inventories":
2422
 
                result.garbage_inventories = int(val_text)
2423
 
            elif key == "inconsistent_parents":
2424
 
                result.inconsistent_parents = int(val_text)
2425
 
            else:
2426
 
                mutter("unknown reconcile key %r" % key)
2427
 
        return result
 
1840
        self._ensure_real()
 
1841
        return self._real_repository.reconcile(other=other, thorough=thorough)
2428
1842
 
2429
1843
    def all_revision_ids(self):
2430
 
        path = self.bzrdir._path_for_remote_call(self._client)
2431
 
        try:
2432
 
            response_tuple, response_handler = self._call_expecting_body(
2433
 
                "Repository.all_revision_ids", path)
2434
 
        except errors.UnknownSmartMethod:
2435
 
            self._ensure_real()
2436
 
            return self._real_repository.all_revision_ids()
2437
 
        if response_tuple != ("ok", ):
2438
 
            raise errors.UnexpectedSmartServerResponse(response_tuple)
2439
 
        revids = set(response_handler.read_body_bytes().splitlines())
2440
 
        for fallback in self._fallback_repositories:
2441
 
            revids.update(set(fallback.all_revision_ids()))
2442
 
        return list(revids)
2443
 
 
2444
 
    def _filtered_revision_trees(self, revision_ids, file_ids):
2445
 
        """Return Tree for a revision on this branch with only some files.
2446
 
 
2447
 
        :param revision_ids: a sequence of revision-ids;
2448
 
          a revision-id may not be None or 'null:'
2449
 
        :param file_ids: if not None, the result is filtered
2450
 
          so that only those file-ids, their parents and their
2451
 
          children are included.
2452
 
        """
2453
 
        inventories = self.iter_inventories(revision_ids)
2454
 
        for inv in inventories:
2455
 
            # Should we introduce a FilteredRevisionTree class rather
2456
 
            # than pre-filter the inventory here?
2457
 
            filtered_inv = inv.filter(file_ids)
2458
 
            yield InventoryRevisionTree(self, filtered_inv, filtered_inv.revision_id)
 
1844
        self._ensure_real()
 
1845
        return self._real_repository.all_revision_ids()
2459
1846
 
2460
1847
    @needs_read_lock
2461
1848
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
2462
 
        medium = self._client._medium
2463
 
        if medium._is_remote_before((1, 2)):
2464
 
            self._ensure_real()
2465
 
            for delta in self._real_repository.get_deltas_for_revisions(
2466
 
                    revisions, specific_fileids):
2467
 
                yield delta
2468
 
            return
2469
 
        # Get the revision-ids of interest
2470
 
        required_trees = set()
2471
 
        for revision in revisions:
2472
 
            required_trees.add(revision.revision_id)
2473
 
            required_trees.update(revision.parent_ids[:1])
2474
 
 
2475
 
        # Get the matching filtered trees. Note that it's more
2476
 
        # efficient to pass filtered trees to changes_from() rather
2477
 
        # than doing the filtering afterwards. changes_from() could
2478
 
        # arguably do the filtering itself but it's path-based, not
2479
 
        # file-id based, so filtering before or afterwards is
2480
 
        # currently easier.
2481
 
        if specific_fileids is None:
2482
 
            trees = dict((t.get_revision_id(), t) for
2483
 
                t in self.revision_trees(required_trees))
2484
 
        else:
2485
 
            trees = dict((t.get_revision_id(), t) for
2486
 
                t in self._filtered_revision_trees(required_trees,
2487
 
                specific_fileids))
2488
 
 
2489
 
        # Calculate the deltas
2490
 
        for revision in revisions:
2491
 
            if not revision.parent_ids:
2492
 
                old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
2493
 
            else:
2494
 
                old_tree = trees[revision.parent_ids[0]]
2495
 
            yield trees[revision.revision_id].changes_from(old_tree)
 
1849
        self._ensure_real()
 
1850
        return self._real_repository.get_deltas_for_revisions(revisions,
 
1851
            specific_fileids=specific_fileids)
2496
1852
 
2497
1853
    @needs_read_lock
2498
1854
    def get_revision_delta(self, revision_id, specific_fileids=None):
2499
 
        r = self.get_revision(revision_id)
2500
 
        return list(self.get_deltas_for_revisions([r],
2501
 
            specific_fileids=specific_fileids))[0]
 
1855
        self._ensure_real()
 
1856
        return self._real_repository.get_revision_delta(revision_id,
 
1857
            specific_fileids=specific_fileids)
2502
1858
 
2503
1859
    @needs_read_lock
2504
1860
    def revision_trees(self, revision_ids):
2505
 
        inventories = self.iter_inventories(revision_ids)
2506
 
        for inv in inventories:
2507
 
            yield InventoryRevisionTree(self, inv, inv.revision_id)
 
1861
        self._ensure_real()
 
1862
        return self._real_repository.revision_trees(revision_ids)
2508
1863
 
2509
1864
    @needs_read_lock
2510
1865
    def get_revision_reconcile(self, revision_id):
2518
1873
            callback_refs=callback_refs, check_repo=check_repo)
2519
1874
 
2520
1875
    def copy_content_into(self, destination, revision_id=None):
2521
 
        """Make a complete copy of the content in self into destination.
2522
 
 
2523
 
        This is a destructive operation! Do not use it on existing
2524
 
        repositories.
2525
 
        """
2526
 
        interrepo = _mod_repository.InterRepository.get(self, destination)
2527
 
        return interrepo.copy_content(revision_id)
 
1876
        self._ensure_real()
 
1877
        return self._real_repository.copy_content_into(
 
1878
            destination, revision_id=revision_id)
2528
1879
 
2529
1880
    def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
2530
1881
        # get a tarball of the remote repository, and copy from that into the
2531
1882
        # destination
 
1883
        from bzrlib import osutils
2532
1884
        import tarfile
2533
1885
        # TODO: Maybe a progress bar while streaming the tarball?
2534
1886
        note(gettext("Copying repository content as tarball..."))
2566
1918
    @needs_write_lock
2567
1919
    def pack(self, hint=None, clean_obsolete_packs=False):
2568
1920
        """Compress the data within the repository.
 
1921
 
 
1922
        This is not currently implemented within the smart server.
2569
1923
        """
2570
 
        if hint is None:
2571
 
            body = ""
2572
 
        else:
2573
 
            body = "".join([l+"\n" for l in hint])
2574
 
        path = self.bzrdir._path_for_remote_call(self._client)
2575
 
        try:
2576
 
            response, handler = self._call_with_body_bytes_expecting_body(
2577
 
                'Repository.pack', (path, self._lock_token,
2578
 
                    str(clean_obsolete_packs)), body)
2579
 
        except errors.UnknownSmartMethod:
2580
 
            self._ensure_real()
2581
 
            return self._real_repository.pack(hint=hint,
2582
 
                clean_obsolete_packs=clean_obsolete_packs)
2583
 
        handler.cancel_read_body()
2584
 
        if response != ('ok', ):
2585
 
            raise errors.UnexpectedSmartServerResponse(response)
 
1924
        self._ensure_real()
 
1925
        return self._real_repository.pack(hint=hint, clean_obsolete_packs=clean_obsolete_packs)
2586
1926
 
2587
1927
    @property
2588
1928
    def revisions(self):
2589
1929
        """Decorate the real repository for now.
2590
1930
 
 
1931
        In the short term this should become a real object to intercept graph
 
1932
        lookups.
 
1933
 
2591
1934
        In the long term a full blown network facility is needed.
2592
1935
        """
2593
1936
        self._ensure_real()
2621
1964
 
2622
1965
    @needs_write_lock
2623
1966
    def sign_revision(self, revision_id, gpg_strategy):
2624
 
        testament = _mod_testament.Testament.from_revision(self, revision_id)
2625
 
        plaintext = testament.as_short_text()
2626
 
        self.store_revision_signature(gpg_strategy, plaintext, revision_id)
 
1967
        self._ensure_real()
 
1968
        return self._real_repository.sign_revision(revision_id, gpg_strategy)
2627
1969
 
2628
1970
    @property
2629
1971
    def texts(self):
2635
1977
        self._ensure_real()
2636
1978
        return self._real_repository.texts
2637
1979
 
2638
 
    def _iter_revisions_rpc(self, revision_ids):
2639
 
        body = "\n".join(revision_ids)
2640
 
        path = self.bzrdir._path_for_remote_call(self._client)
2641
 
        response_tuple, response_handler = (
2642
 
            self._call_with_body_bytes_expecting_body(
2643
 
            "Repository.iter_revisions", (path, ), body))
2644
 
        if response_tuple[0] != "ok":
2645
 
            raise errors.UnexpectedSmartServerResponse(response_tuple)
2646
 
        serializer_format = response_tuple[1]
2647
 
        serializer = serializer_format_registry.get(serializer_format)
2648
 
        byte_stream = response_handler.read_streamed_body()
2649
 
        decompressor = zlib.decompressobj()
2650
 
        chunks = []
2651
 
        for bytes in byte_stream:
2652
 
            chunks.append(decompressor.decompress(bytes))
2653
 
            if decompressor.unused_data != "":
2654
 
                chunks.append(decompressor.flush())
2655
 
                yield serializer.read_revision_from_string("".join(chunks))
2656
 
                unused = decompressor.unused_data
2657
 
                decompressor = zlib.decompressobj()
2658
 
                chunks = [decompressor.decompress(unused)]
2659
 
        chunks.append(decompressor.flush())
2660
 
        text = "".join(chunks)
2661
 
        if text != "":
2662
 
            yield serializer.read_revision_from_string("".join(chunks))
2663
 
 
2664
1980
    @needs_read_lock
2665
1981
    def get_revisions(self, revision_ids):
2666
 
        if revision_ids is None:
2667
 
            revision_ids = self.all_revision_ids()
2668
 
        else:
2669
 
            for rev_id in revision_ids:
2670
 
                if not rev_id or not isinstance(rev_id, basestring):
2671
 
                    raise errors.InvalidRevisionId(
2672
 
                        revision_id=rev_id, branch=self)
2673
 
        try:
2674
 
            missing = set(revision_ids)
2675
 
            revs = {}
2676
 
            for rev in self._iter_revisions_rpc(revision_ids):
2677
 
                missing.remove(rev.revision_id)
2678
 
                revs[rev.revision_id] = rev
2679
 
        except errors.UnknownSmartMethod:
2680
 
            self._ensure_real()
2681
 
            return self._real_repository.get_revisions(revision_ids)
2682
 
        for fallback in self._fallback_repositories:
2683
 
            if not missing:
2684
 
                break
2685
 
            for revid in list(missing):
2686
 
                # XXX JRV 2011-11-20: It would be nice if there was a
2687
 
                # public method on Repository that could be used to query
2688
 
                # for revision objects *without* failing completely if one
2689
 
                # was missing. There is VersionedFileRepository._iter_revisions,
2690
 
                # but unfortunately that's private and not provided by
2691
 
                # all repository implementations.
2692
 
                try:
2693
 
                    revs[revid] = fallback.get_revision(revid)
2694
 
                except errors.NoSuchRevision:
2695
 
                    pass
2696
 
                else:
2697
 
                    missing.remove(revid)
2698
 
        if missing:
2699
 
            raise errors.NoSuchRevision(self, list(missing)[0])
2700
 
        return [revs[revid] for revid in revision_ids]
 
1982
        self._ensure_real()
 
1983
        return self._real_repository.get_revisions(revision_ids)
2701
1984
 
2702
1985
    def supports_rich_root(self):
2703
1986
        return self._format.rich_root_data
2704
1987
 
 
1988
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
 
1989
    def iter_reverse_revision_history(self, revision_id):
 
1990
        self._ensure_real()
 
1991
        return self._real_repository.iter_reverse_revision_history(revision_id)
 
1992
 
2705
1993
    @property
2706
1994
    def _serializer(self):
2707
1995
        return self._format._serializer
2708
1996
 
2709
 
    @needs_write_lock
2710
1997
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
2711
 
        signature = gpg_strategy.sign(plaintext)
2712
 
        self.add_signature_text(revision_id, signature)
 
1998
        self._ensure_real()
 
1999
        return self._real_repository.store_revision_signature(
 
2000
            gpg_strategy, plaintext, revision_id)
2713
2001
 
2714
2002
    def add_signature_text(self, revision_id, signature):
2715
 
        if self._real_repository:
2716
 
            # If there is a real repository the write group will
2717
 
            # be in the real repository as well, so use that:
2718
 
            self._ensure_real()
2719
 
            return self._real_repository.add_signature_text(
2720
 
                revision_id, signature)
2721
 
        path = self.bzrdir._path_for_remote_call(self._client)
2722
 
        response, handler = self._call_with_body_bytes_expecting_body(
2723
 
            'Repository.add_signature_text', (path, self._lock_token,
2724
 
                revision_id) + tuple(self._write_group_tokens), signature)
2725
 
        handler.cancel_read_body()
2726
 
        self.refresh_data()
2727
 
        if response[0] != 'ok':
2728
 
            raise errors.UnexpectedSmartServerResponse(response)
2729
 
        self._write_group_tokens = response[1:]
 
2003
        self._ensure_real()
 
2004
        return self._real_repository.add_signature_text(revision_id, signature)
2730
2005
 
2731
2006
    def has_signature_for_revision_id(self, revision_id):
2732
 
        path = self.bzrdir._path_for_remote_call(self._client)
2733
 
        try:
2734
 
            response = self._call('Repository.has_signature_for_revision_id',
2735
 
                path, revision_id)
2736
 
        except errors.UnknownSmartMethod:
2737
 
            self._ensure_real()
2738
 
            return self._real_repository.has_signature_for_revision_id(
2739
 
                revision_id)
2740
 
        if response[0] not in ('yes', 'no'):
2741
 
            raise SmartProtocolError('unexpected response code %s' % (response,))
2742
 
        if response[0] == 'yes':
2743
 
            return True
2744
 
        for fallback in self._fallback_repositories:
2745
 
            if fallback.has_signature_for_revision_id(revision_id):
2746
 
                return True
2747
 
        return False
2748
 
 
2749
 
    @needs_read_lock
2750
 
    def verify_revision_signature(self, revision_id, gpg_strategy):
2751
 
        if not self.has_signature_for_revision_id(revision_id):
2752
 
            return gpg.SIGNATURE_NOT_SIGNED, None
2753
 
        signature = self.get_signature_text(revision_id)
2754
 
 
2755
 
        testament = _mod_testament.Testament.from_revision(self, revision_id)
2756
 
        plaintext = testament.as_short_text()
2757
 
 
2758
 
        return gpg_strategy.verify(signature, plaintext)
 
2007
        self._ensure_real()
 
2008
        return self._real_repository.has_signature_for_revision_id(revision_id)
2759
2009
 
2760
2010
    def item_keys_introduced_by(self, revision_ids, _files_pb=None):
2761
2011
        self._ensure_real()
2951
2201
 
2952
2202
    def _real_stream(self, repo, search):
2953
2203
        """Get a stream for search from repo.
2954
 
 
2955
 
        This never called RemoteStreamSource.get_stream, and is a helper
2956
 
        for RemoteStreamSource._get_stream to allow getting a stream
 
2204
        
 
2205
        This never called RemoteStreamSource.get_stream, and is a heler
 
2206
        for RemoteStreamSource._get_stream to allow getting a stream 
2957
2207
        reliably whether fallback back because of old servers or trying
2958
2208
        to stream from a non-RemoteRepository (which the stacked support
2959
2209
        code will do).
3001
2251
            except errors.UnknownSmartMethod:
3002
2252
                medium._remember_remote_is_before(version)
3003
2253
            except errors.UnknownErrorFromSmartServer, e:
3004
 
                if isinstance(search, vf_search.EverythingResult):
 
2254
                if isinstance(search, graph.EverythingResult):
3005
2255
                    error_verb = e.error_from_smart_server.error_verb
3006
2256
                    if error_verb == 'BadSearch':
3007
2257
                        # Pre-2.4 servers don't support this sort of search.
3099
2349
 
3100
2350
    def _ensure_real(self):
3101
2351
        if self._custom_format is None:
3102
 
            try:
3103
 
                self._custom_format = branch.network_format_registry.get(
3104
 
                    self._network_name)
3105
 
            except KeyError:
3106
 
                raise errors.UnknownFormatError(kind='branch',
3107
 
                    format=self._network_name)
 
2352
            self._custom_format = branch.network_format_registry.get(
 
2353
                self._network_name)
3108
2354
 
3109
2355
    def get_format_description(self):
3110
2356
        self._ensure_real()
3117
2363
        return a_bzrdir.open_branch(name=name, 
3118
2364
            ignore_fallbacks=ignore_fallbacks)
3119
2365
 
3120
 
    def _vfs_initialize(self, a_bzrdir, name, append_revisions_only,
3121
 
                        repository=None):
 
2366
    def _vfs_initialize(self, a_bzrdir, name, append_revisions_only):
3122
2367
        # Initialisation when using a local bzrdir object, or a non-vfs init
3123
2368
        # method is not available on the server.
3124
2369
        # self._custom_format is always set - the start of initialize ensures
3126
2371
        if isinstance(a_bzrdir, RemoteBzrDir):
3127
2372
            a_bzrdir._ensure_real()
3128
2373
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
3129
 
                name=name, append_revisions_only=append_revisions_only,
3130
 
                repository=repository)
 
2374
                name, append_revisions_only=append_revisions_only)
3131
2375
        else:
3132
2376
            # We assume the bzrdir is parameterised; it may not be.
3133
 
            result = self._custom_format.initialize(a_bzrdir, name=name,
3134
 
                append_revisions_only=append_revisions_only,
3135
 
                repository=repository)
 
2377
            result = self._custom_format.initialize(a_bzrdir, name,
 
2378
                append_revisions_only=append_revisions_only)
3136
2379
        if (isinstance(a_bzrdir, RemoteBzrDir) and
3137
2380
            not isinstance(result, RemoteBranch)):
3138
2381
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
3141
2384
 
3142
2385
    def initialize(self, a_bzrdir, name=None, repository=None,
3143
2386
                   append_revisions_only=None):
3144
 
        if name is None:
3145
 
            name = a_bzrdir._get_selected_branch()
3146
2387
        # 1) get the network name to use.
3147
2388
        if self._custom_format:
3148
2389
            network_name = self._custom_format.network_name()
3149
2390
        else:
3150
2391
            # Select the current bzrlib default and ask for that.
3151
 
            reference_bzrdir_format = controldir.format_registry.get('default')()
 
2392
            reference_bzrdir_format = _mod_bzrdir.format_registry.get('default')()
3152
2393
            reference_format = reference_bzrdir_format.get_branch_format()
3153
2394
            self._custom_format = reference_format
3154
2395
            network_name = reference_format.network_name()
3155
2396
        # Being asked to create on a non RemoteBzrDir:
3156
2397
        if not isinstance(a_bzrdir, RemoteBzrDir):
3157
2398
            return self._vfs_initialize(a_bzrdir, name=name,
3158
 
                append_revisions_only=append_revisions_only,
3159
 
                repository=repository)
 
2399
                append_revisions_only=append_revisions_only)
3160
2400
        medium = a_bzrdir._client._medium
3161
2401
        if medium._is_remote_before((1, 13)):
3162
2402
            return self._vfs_initialize(a_bzrdir, name=name,
3163
 
                append_revisions_only=append_revisions_only,
3164
 
                repository=repository)
 
2403
                append_revisions_only=append_revisions_only)
3165
2404
        # Creating on a remote bzr dir.
3166
2405
        # 2) try direct creation via RPC
3167
2406
        path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
3168
 
        if name != "":
 
2407
        if name is not None:
3169
2408
            # XXX JRV20100304: Support creating colocated branches
3170
2409
            raise errors.NoColocatedBranchSupport(self)
3171
2410
        verb = 'BzrDir.create_branch'
3175
2414
            # Fallback - use vfs methods
3176
2415
            medium._remember_remote_is_before((1, 13))
3177
2416
            return self._vfs_initialize(a_bzrdir, name=name,
3178
 
                    append_revisions_only=append_revisions_only,
3179
 
                    repository=repository)
 
2417
                    append_revisions_only=append_revisions_only)
3180
2418
        if response[0] != 'ok':
3181
2419
            raise errors.UnexpectedSmartServerResponse(response)
3182
2420
        # Turn the response into a RemoteRepository object.
3243
2481
                return True
3244
2482
        return False
3245
2483
 
3246
 
 
3247
 
class RemoteBranchStore(_mod_config.IniFileStore):
3248
 
    """Branch store which attempts to use HPSS calls to retrieve branch store.
3249
 
 
3250
 
    Note that this is specific to bzr-based formats.
3251
 
    """
3252
 
 
3253
 
    def __init__(self, branch):
3254
 
        super(RemoteBranchStore, self).__init__()
3255
 
        self.branch = branch
3256
 
        self.id = "branch"
3257
 
        self._real_store = None
3258
 
 
3259
 
    def external_url(self):
3260
 
        return urlutils.join(self.branch.user_url, 'branch.conf')
3261
 
 
3262
 
    def _load_content(self):
3263
 
        path = self.branch._remote_path()
3264
 
        try:
3265
 
            response, handler = self.branch._call_expecting_body(
3266
 
                'Branch.get_config_file', path)
3267
 
        except errors.UnknownSmartMethod:
3268
 
            self._ensure_real()
3269
 
            return self._real_store._load_content()
3270
 
        if len(response) and response[0] != 'ok':
3271
 
            raise errors.UnexpectedSmartServerResponse(response)
3272
 
        return handler.read_body_bytes()
3273
 
 
3274
 
    def _save_content(self, content):
3275
 
        path = self.branch._remote_path()
3276
 
        try:
3277
 
            response, handler = self.branch._call_with_body_bytes_expecting_body(
3278
 
                'Branch.put_config_file', (path,
3279
 
                    self.branch._lock_token, self.branch._repo_lock_token),
3280
 
                content)
3281
 
        except errors.UnknownSmartMethod:
3282
 
            self._ensure_real()
3283
 
            return self._real_store._save_content(content)
3284
 
        handler.cancel_read_body()
3285
 
        if response != ('ok', ):
3286
 
            raise errors.UnexpectedSmartServerResponse(response)
3287
 
 
3288
 
    def _ensure_real(self):
3289
 
        self.branch._ensure_real()
3290
 
        if self._real_store is None:
3291
 
            self._real_store = _mod_config.BranchStore(self.branch)
3292
 
 
3293
 
 
3294
2484
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
3295
2485
    """Branch stored on a server accessed by HPSS RPC.
3296
2486
 
3298
2488
    """
3299
2489
 
3300
2490
    def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
3301
 
        _client=None, format=None, setup_stacking=True, name=None,
3302
 
        possible_transports=None):
 
2491
        _client=None, format=None, setup_stacking=True, name=None):
3303
2492
        """Create a RemoteBranch instance.
3304
2493
 
3305
2494
        :param real_branch: An optional local implementation of the branch
3317
2506
        # will try to assign to self.tags, which is a property in this subclass.
3318
2507
        # And the parent's __init__ doesn't do much anyway.
3319
2508
        self.bzrdir = remote_bzrdir
3320
 
        self.name = name
3321
2509
        if _client is not None:
3322
2510
            self._client = _client
3323
2511
        else:
3346
2534
        self._repo_lock_token = None
3347
2535
        self._lock_count = 0
3348
2536
        self._leave_lock = False
3349
 
        self.conf_store = None
3350
2537
        # Setup a format: note that we cannot call _ensure_real until all the
3351
2538
        # attributes above are set: This code cannot be moved higher up in this
3352
2539
        # function.
3372
2559
            hook(self)
3373
2560
        self._is_stacked = False
3374
2561
        if setup_stacking:
3375
 
            self._setup_stacking(possible_transports)
 
2562
            self._setup_stacking()
3376
2563
 
3377
 
    def _setup_stacking(self, possible_transports):
 
2564
    def _setup_stacking(self):
3378
2565
        # configure stacking into the remote repository, by reading it from
3379
2566
        # the vfs branch.
3380
2567
        try:
3383
2570
            errors.UnstackableRepositoryFormat), e:
3384
2571
            return
3385
2572
        self._is_stacked = True
3386
 
        if possible_transports is None:
3387
 
            possible_transports = []
3388
 
        else:
3389
 
            possible_transports = list(possible_transports)
3390
 
        possible_transports.append(self.bzrdir.root_transport)
3391
 
        self._activate_fallback_location(fallback_url,
3392
 
            possible_transports=possible_transports)
 
2573
        self._activate_fallback_location(fallback_url)
3393
2574
 
3394
2575
    def _get_config(self):
3395
2576
        return RemoteBranchConfig(self)
3396
2577
 
3397
 
    def _get_config_store(self):
3398
 
        if self.conf_store is None:
3399
 
            self.conf_store =  RemoteBranchStore(self)
3400
 
        return self.conf_store
3401
 
 
3402
 
    def store_uncommitted(self, creator):
3403
 
        self._ensure_real()
3404
 
        return self._real_branch.store_uncommitted(creator)
3405
 
 
3406
 
    def get_unshelver(self, tree):
3407
 
        self._ensure_real()
3408
 
        return self._real_branch.get_unshelver(tree)
3409
 
 
3410
2578
    def _get_real_transport(self):
3411
2579
        # if we try vfs access, return the real branch's vfs transport
3412
2580
        self._ensure_real()
3431
2599
            self.bzrdir._ensure_real()
3432
2600
            self._real_branch = self.bzrdir._real_bzrdir.open_branch(
3433
2601
                ignore_fallbacks=self._real_ignore_fallbacks, name=self._name)
3434
 
            # The remote branch and the real branch shares the same store. If
3435
 
            # we don't, there will always be cases where one of the stores
3436
 
            # doesn't see an update made on the other.
3437
 
            self._real_branch.conf_store = self.conf_store
3438
2602
            if self.repository._real_repository is None:
3439
2603
                # Give the remote repository the matching real repo.
3440
2604
                real_repo = self._real_branch.repository
3479
2643
                self.bzrdir, self._client)
3480
2644
        return self._control_files
3481
2645
 
 
2646
    def _get_checkout_format(self, lightweight=False):
 
2647
        self._ensure_real()
 
2648
        if lightweight:
 
2649
            format = RemoteBzrDirFormat()
 
2650
            self.bzrdir._format._supply_sub_formats_to(format)
 
2651
            format.workingtree_format = self._real_branch._get_checkout_format(
 
2652
                lightweight=lightweight).workingtree_format
 
2653
            return format
 
2654
        else:
 
2655
            return self._real_branch._get_checkout_format(lightweight=False)
 
2656
 
3482
2657
    def get_physical_lock_status(self):
3483
2658
        """See Branch.get_physical_lock_status()."""
3484
 
        try:
3485
 
            response = self._client.call('Branch.get_physical_lock_status',
3486
 
                self._remote_path())
3487
 
        except errors.UnknownSmartMethod:
3488
 
            self._ensure_real()
3489
 
            return self._real_branch.get_physical_lock_status()
3490
 
        if response[0] not in ('yes', 'no'):
3491
 
            raise errors.UnexpectedSmartServerResponse(response)
3492
 
        return (response[0] == 'yes')
 
2659
        # should be an API call to the server, as branches must be lockable.
 
2660
        self._ensure_real()
 
2661
        return self._real_branch.get_physical_lock_status()
3493
2662
 
3494
2663
    def get_stacked_on_url(self):
3495
2664
        """Get the URL this branch is stacked against.
3518
2687
 
3519
2688
    def set_stacked_on_url(self, url):
3520
2689
        branch.Branch.set_stacked_on_url(self, url)
3521
 
        # We need the stacked_on_url to be visible both locally (to not query
3522
 
        # it repeatedly) and remotely (so smart verbs can get it server side)
3523
 
        # Without the following line,
3524
 
        # bzrlib.tests.per_branch.test_create_clone.TestCreateClone
3525
 
        # .test_create_clone_on_transport_stacked_hooks_get_stacked_branch
3526
 
        # fails for remote branches -- vila 2012-01-04
3527
 
        self.conf_store.save_changes()
3528
2690
        if not url:
3529
2691
            self._is_stacked = False
3530
2692
        else:
3658
2820
        try:
3659
2821
            self._lock_count -= 1
3660
2822
            if not self._lock_count:
3661
 
                if self.conf_store is not None:
3662
 
                    self.conf_store.save_changes()
3663
2823
                self._clear_cached_state()
3664
2824
                mode = self._lock_mode
3665
2825
                self._lock_mode = None
3688
2848
            self.repository.unlock()
3689
2849
 
3690
2850
    def break_lock(self):
3691
 
        try:
3692
 
            response = self._call(
3693
 
                'Branch.break_lock', self._remote_path())
3694
 
        except errors.UnknownSmartMethod:
3695
 
            self._ensure_real()
3696
 
            return self._real_branch.break_lock()
3697
 
        if response != ('ok',):
3698
 
            raise errors.UnexpectedSmartServerResponse(response)
 
2851
        self._ensure_real()
 
2852
        return self._real_branch.break_lock()
3699
2853
 
3700
2854
    def leave_lock_in_place(self):
3701
2855
        if not self._lock_token:
3794
2948
            raise errors.UnexpectedSmartServerResponse(response)
3795
2949
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
3796
2950
 
 
2951
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
 
2952
    @needs_write_lock
 
2953
    def set_revision_history(self, rev_history):
 
2954
        """See Branch.set_revision_history."""
 
2955
        self._set_revision_history(rev_history)
 
2956
 
 
2957
    @needs_write_lock
 
2958
    def _set_revision_history(self, rev_history):
 
2959
        # Send just the tip revision of the history; the server will generate
 
2960
        # the full history from that.  If the revision doesn't exist in this
 
2961
        # branch, NoSuchRevision will be raised.
 
2962
        if rev_history == []:
 
2963
            rev_id = 'null:'
 
2964
        else:
 
2965
            rev_id = rev_history[-1]
 
2966
        self._set_last_revision(rev_id)
 
2967
        for hook in branch.Branch.hooks['set_rh']:
 
2968
            hook(self, rev_history)
 
2969
        self._cache_revision_history(rev_history)
 
2970
 
3797
2971
    def _get_parent_location(self):
3798
2972
        medium = self._client._medium
3799
2973
        if medium._is_remote_before((1, 13)):
3851
3025
            target, overwrite=overwrite, stop_revision=stop_revision, lossy=lossy,
3852
3026
            _override_hook_source_branch=self)
3853
3027
 
3854
 
    def peek_lock_mode(self):
3855
 
        return self._lock_mode
3856
 
 
3857
3028
    def is_locked(self):
3858
3029
        return self._lock_count >= 1
3859
3030
 
3860
3031
    @needs_read_lock
3861
 
    def revision_id_to_dotted_revno(self, revision_id):
3862
 
        """Given a revision id, return its dotted revno.
3863
 
 
3864
 
        :return: a tuple like (1,) or (400,1,3).
3865
 
        """
3866
 
        try:
3867
 
            response = self._call('Branch.revision_id_to_revno',
3868
 
                self._remote_path(), revision_id)
3869
 
        except errors.UnknownSmartMethod:
3870
 
            self._ensure_real()
3871
 
            return self._real_branch.revision_id_to_dotted_revno(revision_id)
3872
 
        if response[0] == 'ok':
3873
 
            return tuple([int(x) for x in response[1:]])
3874
 
        else:
3875
 
            raise errors.UnexpectedSmartServerResponse(response)
3876
 
 
3877
 
    @needs_read_lock
3878
3032
    def revision_id_to_revno(self, revision_id):
3879
 
        """Given a revision id on the branch mainline, return its revno.
3880
 
 
3881
 
        :return: an integer
3882
 
        """
3883
 
        try:
3884
 
            response = self._call('Branch.revision_id_to_revno',
3885
 
                self._remote_path(), revision_id)
3886
 
        except errors.UnknownSmartMethod:
3887
 
            self._ensure_real()
3888
 
            return self._real_branch.revision_id_to_revno(revision_id)
3889
 
        if response[0] == 'ok':
3890
 
            if len(response) == 2:
3891
 
                return int(response[1])
3892
 
            raise NoSuchRevision(self, revision_id)
3893
 
        else:
3894
 
            raise errors.UnexpectedSmartServerResponse(response)
 
3033
        self._ensure_real()
 
3034
        return self._real_branch.revision_id_to_revno(revision_id)
3895
3035
 
3896
3036
    @needs_write_lock
3897
3037
    def set_last_revision_info(self, revno, revision_id):
3934
3074
            except errors.UnknownSmartMethod:
3935
3075
                medium._remember_remote_is_before((1, 6))
3936
3076
        self._clear_cached_state_of_remote_branch_only()
3937
 
        graph = self.repository.get_graph()
3938
 
        (last_revno, last_revid) = self.last_revision_info()
3939
 
        known_revision_ids = [
3940
 
            (last_revid, last_revno),
3941
 
            (_mod_revision.NULL_REVISION, 0),
3942
 
            ]
3943
 
        if last_rev is not None:
3944
 
            if not graph.is_ancestor(last_rev, revision_id):
3945
 
                # our previous tip is not merged into stop_revision
3946
 
                raise errors.DivergedBranches(self, other_branch)
3947
 
        revno = graph.find_distance_to_null(revision_id, known_revision_ids)
3948
 
        self.set_last_revision_info(revno, revision_id)
 
3077
        self._set_revision_history(self._lefthand_history(revision_id,
 
3078
            last_rev=last_rev,other_branch=other_branch))
3949
3079
 
3950
3080
    def set_push_location(self, location):
3951
 
        self._set_config_location('push_location', location)
 
3081
        self._ensure_real()
 
3082
        return self._real_branch.set_push_location(location)
3952
3083
 
3953
3084
    def heads_to_fetch(self):
3954
3085
        if self._format._use_default_local_heads_to_fetch():
4010
3141
                value = section_obj.get(name, default)
4011
3142
        except errors.UnknownSmartMethod:
4012
3143
            value = self._vfs_get_option(name, section, default)
4013
 
        for hook in _mod_config.OldConfigHooks['get']:
 
3144
        for hook in config.OldConfigHooks['get']:
4014
3145
            hook(self, name, value)
4015
3146
        return value
4016
3147
 
4018
3149
        if len(response[0]) and response[0][0] != 'ok':
4019
3150
            raise errors.UnexpectedSmartServerResponse(response)
4020
3151
        lines = response[1].read_body_bytes().splitlines()
4021
 
        conf = _mod_config.ConfigObj(lines, encoding='utf-8')
4022
 
        for hook in _mod_config.OldConfigHooks['load']:
 
3152
        conf = config.ConfigObj(lines, encoding='utf-8')
 
3153
        for hook in config.OldConfigHooks['load']:
4023
3154
            hook(self)
4024
3155
        return conf
4025
3156
 
4135
3266
        return self._bzrdir._real_bzrdir
4136
3267
 
4137
3268
 
 
3269
 
4138
3270
def _extract_tar(tar, to_dir):
4139
3271
    """Extract all the contents of a tarfile object.
4140
3272
 
4144
3276
        tar.extract(tarinfo, to_dir)
4145
3277
 
4146
3278
 
4147
 
error_translators = registry.Registry()
4148
 
no_context_error_translators = registry.Registry()
4149
 
 
4150
 
 
4151
3279
def _translate_error(err, **context):
4152
3280
    """Translate an ErrorFromSmartServer into a more useful error.
4153
3281
 
4182
3310
                    'Missing key %r in context %r', key_err.args[0], context)
4183
3311
                raise err
4184
3312
 
4185
 
    try:
4186
 
        translator = error_translators.get(err.error_verb)
4187
 
    except KeyError:
4188
 
        pass
4189
 
    else:
4190
 
        raise translator(err, find, get_path)
4191
 
    try:
4192
 
        translator = no_context_error_translators.get(err.error_verb)
4193
 
    except KeyError:
4194
 
        raise errors.UnknownErrorFromSmartServer(err)
4195
 
    else:
4196
 
        raise translator(err)
4197
 
 
4198
 
 
4199
 
error_translators.register('NoSuchRevision',
4200
 
    lambda err, find, get_path: NoSuchRevision(
4201
 
        find('branch'), err.error_args[0]))
4202
 
error_translators.register('nosuchrevision',
4203
 
    lambda err, find, get_path: NoSuchRevision(
4204
 
        find('repository'), err.error_args[0]))
4205
 
 
4206
 
def _translate_nobranch_error(err, find, get_path):
4207
 
    if len(err.error_args) >= 1:
4208
 
        extra = err.error_args[0]
4209
 
    else:
4210
 
        extra = None
4211
 
    return errors.NotBranchError(path=find('bzrdir').root_transport.base,
4212
 
        detail=extra)
4213
 
 
4214
 
error_translators.register('nobranch', _translate_nobranch_error)
4215
 
error_translators.register('norepository',
4216
 
    lambda err, find, get_path: errors.NoRepositoryPresent(
4217
 
        find('bzrdir')))
4218
 
error_translators.register('UnlockableTransport',
4219
 
    lambda err, find, get_path: errors.UnlockableTransport(
4220
 
        find('bzrdir').root_transport))
4221
 
error_translators.register('TokenMismatch',
4222
 
    lambda err, find, get_path: errors.TokenMismatch(
4223
 
        find('token'), '(remote token)'))
4224
 
error_translators.register('Diverged',
4225
 
    lambda err, find, get_path: errors.DivergedBranches(
4226
 
        find('branch'), find('other_branch')))
4227
 
error_translators.register('NotStacked',
4228
 
    lambda err, find, get_path: errors.NotStacked(branch=find('branch')))
4229
 
 
4230
 
def _translate_PermissionDenied(err, find, get_path):
4231
 
    path = get_path()
4232
 
    if len(err.error_args) >= 2:
4233
 
        extra = err.error_args[1]
4234
 
    else:
4235
 
        extra = None
4236
 
    return errors.PermissionDenied(path, extra=extra)
4237
 
 
4238
 
error_translators.register('PermissionDenied', _translate_PermissionDenied)
4239
 
error_translators.register('ReadError',
4240
 
    lambda err, find, get_path: errors.ReadError(get_path()))
4241
 
error_translators.register('NoSuchFile',
4242
 
    lambda err, find, get_path: errors.NoSuchFile(get_path()))
4243
 
error_translators.register('TokenLockingNotSupported',
4244
 
    lambda err, find, get_path: errors.TokenLockingNotSupported(
4245
 
        find('repository')))
4246
 
error_translators.register('UnsuspendableWriteGroup',
4247
 
    lambda err, find, get_path: errors.UnsuspendableWriteGroup(
4248
 
        repository=find('repository')))
4249
 
error_translators.register('UnresumableWriteGroup',
4250
 
    lambda err, find, get_path: errors.UnresumableWriteGroup(
4251
 
        repository=find('repository'), write_groups=err.error_args[0],
4252
 
        reason=err.error_args[1]))
4253
 
no_context_error_translators.register('IncompatibleRepositories',
4254
 
    lambda err: errors.IncompatibleRepositories(
4255
 
        err.error_args[0], err.error_args[1], err.error_args[2]))
4256
 
no_context_error_translators.register('LockContention',
4257
 
    lambda err: errors.LockContention('(remote lock)'))
4258
 
no_context_error_translators.register('LockFailed',
4259
 
    lambda err: errors.LockFailed(err.error_args[0], err.error_args[1]))
4260
 
no_context_error_translators.register('TipChangeRejected',
4261
 
    lambda err: errors.TipChangeRejected(err.error_args[0].decode('utf8')))
4262
 
no_context_error_translators.register('UnstackableBranchFormat',
4263
 
    lambda err: errors.UnstackableBranchFormat(*err.error_args))
4264
 
no_context_error_translators.register('UnstackableRepositoryFormat',
4265
 
    lambda err: errors.UnstackableRepositoryFormat(*err.error_args))
4266
 
no_context_error_translators.register('FileExists',
4267
 
    lambda err: errors.FileExists(err.error_args[0]))
4268
 
no_context_error_translators.register('DirectoryNotEmpty',
4269
 
    lambda err: errors.DirectoryNotEmpty(err.error_args[0]))
4270
 
 
4271
 
def _translate_short_readv_error(err):
4272
 
    args = err.error_args
4273
 
    return errors.ShortReadvError(args[0], int(args[1]), int(args[2]),
4274
 
        int(args[3]))
4275
 
 
4276
 
no_context_error_translators.register('ShortReadvError',
4277
 
    _translate_short_readv_error)
4278
 
 
4279
 
def _translate_unicode_error(err):
 
3313
    if err.error_verb == 'NoSuchRevision':
 
3314
        raise NoSuchRevision(find('branch'), err.error_args[0])
 
3315
    elif err.error_verb == 'nosuchrevision':
 
3316
        raise NoSuchRevision(find('repository'), err.error_args[0])
 
3317
    elif err.error_verb == 'nobranch':
 
3318
        if len(err.error_args) >= 1:
 
3319
            extra = err.error_args[0]
 
3320
        else:
 
3321
            extra = None
 
3322
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base,
 
3323
            detail=extra)
 
3324
    elif err.error_verb == 'norepository':
 
3325
        raise errors.NoRepositoryPresent(find('bzrdir'))
 
3326
    elif err.error_verb == 'UnlockableTransport':
 
3327
        raise errors.UnlockableTransport(find('bzrdir').root_transport)
 
3328
    elif err.error_verb == 'TokenMismatch':
 
3329
        raise errors.TokenMismatch(find('token'), '(remote token)')
 
3330
    elif err.error_verb == 'Diverged':
 
3331
        raise errors.DivergedBranches(find('branch'), find('other_branch'))
 
3332
    elif err.error_verb == 'NotStacked':
 
3333
        raise errors.NotStacked(branch=find('branch'))
 
3334
    elif err.error_verb == 'PermissionDenied':
 
3335
        path = get_path()
 
3336
        if len(err.error_args) >= 2:
 
3337
            extra = err.error_args[1]
 
3338
        else:
 
3339
            extra = None
 
3340
        raise errors.PermissionDenied(path, extra=extra)
 
3341
    elif err.error_verb == 'ReadError':
 
3342
        path = get_path()
 
3343
        raise errors.ReadError(path)
 
3344
    elif err.error_verb == 'NoSuchFile':
 
3345
        path = get_path()
 
3346
        raise errors.NoSuchFile(path)
 
3347
    _translate_error_without_context(err)
 
3348
 
 
3349
 
 
3350
def _translate_error_without_context(err):
 
3351
    """Translate any ErrorFromSmartServer values that don't require context"""
 
3352
    if err.error_verb == 'IncompatibleRepositories':
 
3353
        raise errors.IncompatibleRepositories(err.error_args[0],
 
3354
            err.error_args[1], err.error_args[2])
 
3355
    elif err.error_verb == 'LockContention':
 
3356
        raise errors.LockContention('(remote lock)')
 
3357
    elif err.error_verb == 'LockFailed':
 
3358
        raise errors.LockFailed(err.error_args[0], err.error_args[1])
 
3359
    elif err.error_verb == 'TipChangeRejected':
 
3360
        raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
 
3361
    elif err.error_verb == 'UnstackableBranchFormat':
 
3362
        raise errors.UnstackableBranchFormat(*err.error_args)
 
3363
    elif err.error_verb == 'UnstackableRepositoryFormat':
 
3364
        raise errors.UnstackableRepositoryFormat(*err.error_args)
 
3365
    elif err.error_verb == 'FileExists':
 
3366
        raise errors.FileExists(err.error_args[0])
 
3367
    elif err.error_verb == 'DirectoryNotEmpty':
 
3368
        raise errors.DirectoryNotEmpty(err.error_args[0])
 
3369
    elif err.error_verb == 'ShortReadvError':
 
3370
        args = err.error_args
 
3371
        raise errors.ShortReadvError(
 
3372
            args[0], int(args[1]), int(args[2]), int(args[3]))
 
3373
    elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
4280
3374
        encoding = str(err.error_args[0]) # encoding must always be a string
4281
3375
        val = err.error_args[1]
4282
3376
        start = int(err.error_args[2])
4290
3384
            raise UnicodeDecodeError(encoding, val, start, end, reason)
4291
3385
        elif err.error_verb == 'UnicodeEncodeError':
4292
3386
            raise UnicodeEncodeError(encoding, val, start, end, reason)
4293
 
 
4294
 
no_context_error_translators.register('UnicodeEncodeError',
4295
 
    _translate_unicode_error)
4296
 
no_context_error_translators.register('UnicodeDecodeError',
4297
 
    _translate_unicode_error)
4298
 
no_context_error_translators.register('ReadOnlyError',
4299
 
    lambda err: errors.TransportNotPossible('readonly transport'))
4300
 
no_context_error_translators.register('MemoryError',
4301
 
    lambda err: errors.BzrError("remote server out of memory\n"
4302
 
        "Retry non-remotely, or contact the server admin for details."))
4303
 
no_context_error_translators.register('RevisionNotPresent',
4304
 
    lambda err: errors.RevisionNotPresent(err.error_args[0], err.error_args[1]))
4305
 
 
4306
 
no_context_error_translators.register('BzrCheckError',
4307
 
    lambda err: errors.BzrCheckError(msg=err.error_args[0]))
4308
 
 
 
3387
    elif err.error_verb == 'ReadOnlyError':
 
3388
        raise errors.TransportNotPossible('readonly transport')
 
3389
    elif err.error_verb == 'MemoryError':
 
3390
        raise errors.BzrError("remote server out of memory\n"
 
3391
            "Retry non-remotely, or contact the server admin for details.")
 
3392
    raise errors.UnknownErrorFromSmartServer(err)