1
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
 
 
3
# This program is free software; you can redistribute it and/or modify
 
 
4
# it under the terms of the GNU General Public License as published by
 
 
5
# the Free Software Foundation; either version 2 of the License, or
 
 
6
# (at your option) any later version.
 
 
8
# This program is distributed in the hope that it will be useful,
 
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
 
11
# GNU General Public License for more details.
 
 
13
# You should have received a copy of the GNU General Public License
 
 
14
# along with this program; if not, write to the Free Software
 
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 
17
# TODO: At some point, handle upgrades by just passing the whole request
 
 
18
# across to run on the server.
 
 
33
from bzrlib.branch import BranchReferenceFormat
 
 
34
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
 
 
35
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
 
36
from bzrlib.errors import (
 
 
40
from bzrlib.lockable_files import LockableFiles
 
 
41
from bzrlib.smart import client, vfs
 
 
42
from bzrlib.revision import ensure_null, NULL_REVISION
 
 
43
from bzrlib.trace import mutter, note, warning
 
 
46
class _RpcHelper(object):
 
 
47
    """Mixin class that helps with issuing RPCs."""
 
 
49
    def _call(self, method, *args, **err_context):
 
 
51
            return self._client.call(method, *args)
 
 
52
        except errors.ErrorFromSmartServer, err:
 
 
53
            self._translate_error(err, **err_context)
 
 
55
    def _call_expecting_body(self, method, *args, **err_context):
 
 
57
            return self._client.call_expecting_body(method, *args)
 
 
58
        except errors.ErrorFromSmartServer, err:
 
 
59
            self._translate_error(err, **err_context)
 
 
61
    def _call_with_body_bytes_expecting_body(self, method, args, body_bytes,
 
 
64
            return self._client.call_with_body_bytes_expecting_body(
 
 
65
                method, args, body_bytes)
 
 
66
        except errors.ErrorFromSmartServer, err:
 
 
67
            self._translate_error(err, **err_context)
 
 
69
# Note: RemoteBzrDirFormat is in bzrdir.py
 
 
71
class RemoteBzrDir(BzrDir, _RpcHelper):
 
 
72
    """Control directory on a remote server, accessed via bzr:// or similar."""
 
 
74
    def __init__(self, transport, _client=None):
 
 
75
        """Construct a RemoteBzrDir.
 
 
77
        :param _client: Private parameter for testing. Disables probing and the
 
 
80
        BzrDir.__init__(self, transport, RemoteBzrDirFormat())
 
 
81
        # this object holds a delegated bzrdir that uses file-level operations
 
 
82
        # to talk to the other side
 
 
83
        self._real_bzrdir = None
 
 
86
            medium = transport.get_smart_medium()
 
 
87
            self._client = client._SmartClient(medium)
 
 
89
            self._client = _client
 
 
92
        path = self._path_for_remote_call(self._client)
 
 
93
        response = self._call('BzrDir.open', path)
 
 
94
        if response not in [('yes',), ('no',)]:
 
 
95
            raise errors.UnexpectedSmartServerResponse(response)
 
 
96
        if response == ('no',):
 
 
97
            raise errors.NotBranchError(path=transport.base)
 
 
99
    def _ensure_real(self):
 
 
100
        """Ensure that there is a _real_bzrdir set.
 
 
102
        Used before calls to self._real_bzrdir.
 
 
104
        if not self._real_bzrdir:
 
 
105
            self._real_bzrdir = BzrDir.open_from_transport(
 
 
106
                self.root_transport, _server_formats=False)
 
 
108
    def _translate_error(self, err, **context):
 
 
109
        _translate_error(err, bzrdir=self, **context)
 
 
111
    def cloning_metadir(self, stacked=False):
 
 
113
        return self._real_bzrdir.cloning_metadir(stacked)
 
 
115
    def create_repository(self, shared=False):
 
 
117
        self._real_bzrdir.create_repository(shared=shared)
 
 
118
        return self.open_repository()
 
 
120
    def destroy_repository(self):
 
 
121
        """See BzrDir.destroy_repository"""
 
 
123
        self._real_bzrdir.destroy_repository()
 
 
125
    def create_branch(self):
 
 
127
        real_branch = self._real_bzrdir.create_branch()
 
 
128
        return RemoteBranch(self, self.find_repository(), real_branch)
 
 
130
    def destroy_branch(self):
 
 
131
        """See BzrDir.destroy_branch"""
 
 
133
        self._real_bzrdir.destroy_branch()
 
 
135
    def create_workingtree(self, revision_id=None, from_branch=None):
 
 
136
        raise errors.NotLocalUrl(self.transport.base)
 
 
138
    def find_branch_format(self):
 
 
139
        """Find the branch 'format' for this bzrdir.
 
 
141
        This might be a synthetic object for e.g. RemoteBranch and SVN.
 
 
143
        b = self.open_branch()
 
 
146
    def get_branch_reference(self):
 
 
147
        """See BzrDir.get_branch_reference()."""
 
 
148
        path = self._path_for_remote_call(self._client)
 
 
149
        response = self._call('BzrDir.open_branch', path)
 
 
150
        if response[0] == 'ok':
 
 
151
            if response[1] == '':
 
 
152
                # branch at this location.
 
 
155
                # a branch reference, use the existing BranchReference logic.
 
 
158
            raise errors.UnexpectedSmartServerResponse(response)
 
 
160
    def _get_tree_branch(self):
 
 
161
        """See BzrDir._get_tree_branch()."""
 
 
162
        return None, self.open_branch()
 
 
164
    def open_branch(self, _unsupported=False):
 
 
166
            raise NotImplementedError('unsupported flag support not implemented yet.')
 
 
167
        reference_url = self.get_branch_reference()
 
 
168
        if reference_url is None:
 
 
169
            # branch at this location.
 
 
170
            return RemoteBranch(self, self.find_repository())
 
 
172
            # a branch reference, use the existing BranchReference logic.
 
 
173
            format = BranchReferenceFormat()
 
 
174
            return format.open(self, _found=True, location=reference_url)
 
 
176
    def open_repository(self):
 
 
177
        path = self._path_for_remote_call(self._client)
 
 
178
        verb = 'BzrDir.find_repositoryV2'
 
 
180
            response = self._call(verb, path)
 
 
181
        except errors.UnknownSmartMethod:
 
 
182
            verb = 'BzrDir.find_repository'
 
 
183
            response = self._call(verb, path)
 
 
184
        if response[0] != 'ok':
 
 
185
            raise errors.UnexpectedSmartServerResponse(response)
 
 
186
        if verb == 'BzrDir.find_repository':
 
 
187
            # servers that don't support the V2 method don't support external
 
 
189
            response = response + ('no', )
 
 
190
        if not (len(response) == 5):
 
 
191
            raise SmartProtocolError('incorrect response length %s' % (response,))
 
 
192
        if response[1] == '':
 
 
193
            format = RemoteRepositoryFormat()
 
 
194
            format.rich_root_data = (response[2] == 'yes')
 
 
195
            format.supports_tree_reference = (response[3] == 'yes')
 
 
196
            # No wire format to check this yet.
 
 
197
            format.supports_external_lookups = (response[4] == 'yes')
 
 
198
            # Used to support creating a real format instance when needed.
 
 
199
            format._creating_bzrdir = self
 
 
200
            return RemoteRepository(self, format)
 
 
202
            raise errors.NoRepositoryPresent(self)
 
 
204
    def open_workingtree(self, recommend_upgrade=True):
 
 
206
        if self._real_bzrdir.has_workingtree():
 
 
207
            raise errors.NotLocalUrl(self.root_transport)
 
 
209
            raise errors.NoWorkingTree(self.root_transport.base)
 
 
211
    def _path_for_remote_call(self, client):
 
 
212
        """Return the path to be used for this bzrdir in a remote call."""
 
 
213
        return client.remote_path_from_transport(self.root_transport)
 
 
215
    def get_branch_transport(self, branch_format):
 
 
217
        return self._real_bzrdir.get_branch_transport(branch_format)
 
 
219
    def get_repository_transport(self, repository_format):
 
 
221
        return self._real_bzrdir.get_repository_transport(repository_format)
 
 
223
    def get_workingtree_transport(self, workingtree_format):
 
 
225
        return self._real_bzrdir.get_workingtree_transport(workingtree_format)
 
 
227
    def can_convert_format(self):
 
 
228
        """Upgrading of remote bzrdirs is not supported yet."""
 
 
231
    def needs_format_conversion(self, format=None):
 
 
232
        """Upgrading of remote bzrdirs is not supported yet."""
 
 
235
    def clone(self, url, revision_id=None, force_new_repo=False,
 
 
236
              preserve_stacking=False):
 
 
238
        return self._real_bzrdir.clone(url, revision_id=revision_id,
 
 
239
            force_new_repo=force_new_repo, preserve_stacking=preserve_stacking)
 
 
241
    def get_config(self):
 
 
243
        return self._real_bzrdir.get_config()
 
 
246
class RemoteRepositoryFormat(repository.RepositoryFormat):
 
 
247
    """Format for repositories accessed over a _SmartClient.
 
 
249
    Instances of this repository are represented by RemoteRepository
 
 
252
    The RemoteRepositoryFormat is parameterized during construction
 
 
253
    to reflect the capabilities of the real, remote format. Specifically
 
 
254
    the attributes rich_root_data and supports_tree_reference are set
 
 
255
    on a per instance basis, and are not set (and should not be) at
 
 
259
    _matchingbzrdir = RemoteBzrDirFormat()
 
 
261
    def initialize(self, a_bzrdir, shared=False):
 
 
262
        if not isinstance(a_bzrdir, RemoteBzrDir):
 
 
263
            prior_repo = self._creating_bzrdir.open_repository()
 
 
264
            prior_repo._ensure_real()
 
 
265
            return prior_repo._real_repository._format.initialize(
 
 
266
                a_bzrdir, shared=shared)
 
 
267
        return a_bzrdir.create_repository(shared=shared)
 
 
269
    def open(self, a_bzrdir):
 
 
270
        if not isinstance(a_bzrdir, RemoteBzrDir):
 
 
271
            raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
 
 
272
        return a_bzrdir.open_repository()
 
 
274
    def get_format_description(self):
 
 
275
        return 'bzr remote repository'
 
 
277
    def __eq__(self, other):
 
 
278
        return self.__class__ == other.__class__
 
 
280
    def check_conversion_target(self, target_format):
 
 
281
        if self.rich_root_data and not target_format.rich_root_data:
 
 
282
            raise errors.BadConversionTarget(
 
 
283
                'Does not support rich root data.', target_format)
 
 
284
        if (self.supports_tree_reference and
 
 
285
            not getattr(target_format, 'supports_tree_reference', False)):
 
 
286
            raise errors.BadConversionTarget(
 
 
287
                'Does not support nested trees', target_format)
 
 
290
class RemoteRepository(_RpcHelper):
 
 
291
    """Repository accessed over rpc.
 
 
293
    For the moment most operations are performed using local transport-backed
 
 
297
    def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
 
 
298
        """Create a RemoteRepository instance.
 
 
300
        :param remote_bzrdir: The bzrdir hosting this repository.
 
 
301
        :param format: The RemoteFormat object to use.
 
 
302
        :param real_repository: If not None, a local implementation of the
 
 
303
            repository logic for the repository, usually accessing the data
 
 
305
        :param _client: Private testing parameter - override the smart client
 
 
306
            to be used by the repository.
 
 
309
            self._real_repository = real_repository
 
 
311
            self._real_repository = None
 
 
312
        self.bzrdir = remote_bzrdir
 
 
314
            self._client = remote_bzrdir._client
 
 
316
            self._client = _client
 
 
317
        self._format = format
 
 
318
        self._lock_mode = None
 
 
319
        self._lock_token = None
 
 
321
        self._leave_lock = False
 
 
322
        # A cache of looked up revision parent data; reset at unlock time.
 
 
323
        self._parents_map = None
 
 
324
        if 'hpss' in debug.debug_flags:
 
 
325
            self._requested_parents = None
 
 
327
        # These depend on the actual remote format, so force them off for
 
 
328
        # maximum compatibility. XXX: In future these should depend on the
 
 
329
        # remote repository instance, but this is irrelevant until we perform
 
 
330
        # reconcile via an RPC call.
 
 
331
        self._reconcile_does_inventory_gc = False
 
 
332
        self._reconcile_fixes_text_parents = False
 
 
333
        self._reconcile_backsup_inventory = False
 
 
334
        self.base = self.bzrdir.transport.base
 
 
335
        # Additional places to query for data.
 
 
336
        self._fallback_repositories = []
 
 
339
        return "%s(%s)" % (self.__class__.__name__, self.base)
 
 
343
    def abort_write_group(self, suppress_errors=False):
 
 
344
        """Complete a write group on the decorated repository.
 
 
346
        Smart methods peform operations in a single step so this api
 
 
347
        is not really applicable except as a compatibility thunk
 
 
348
        for older plugins that don't use e.g. the CommitBuilder
 
 
351
        :param suppress_errors: see Repository.abort_write_group.
 
 
354
        return self._real_repository.abort_write_group(
 
 
355
            suppress_errors=suppress_errors)
 
 
357
    def commit_write_group(self):
 
 
358
        """Complete a write group on the decorated repository.
 
 
360
        Smart methods peform operations in a single step so this api
 
 
361
        is not really applicable except as a compatibility thunk
 
 
362
        for older plugins that don't use e.g. the CommitBuilder
 
 
366
        return self._real_repository.commit_write_group()
 
 
368
    def _ensure_real(self):
 
 
369
        """Ensure that there is a _real_repository set.
 
 
371
        Used before calls to self._real_repository.
 
 
373
        if self._real_repository is None:
 
 
374
            self.bzrdir._ensure_real()
 
 
375
            self._set_real_repository(
 
 
376
                self.bzrdir._real_bzrdir.open_repository())
 
 
378
    def _translate_error(self, err, **context):
 
 
379
        self.bzrdir._translate_error(err, repository=self, **context)
 
 
381
    def find_text_key_references(self):
 
 
382
        """Find the text key references within the repository.
 
 
384
        :return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
 
 
385
        revision_ids. Each altered file-ids has the exact revision_ids that
 
 
386
        altered it listed explicitly.
 
 
387
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
 
 
388
            to whether they were referred to by the inventory of the
 
 
389
            revision_id that they contain. The inventory texts from all present
 
 
390
            revision ids are assessed to generate this report.
 
 
393
        return self._real_repository.find_text_key_references()
 
 
395
    def _generate_text_key_index(self):
 
 
396
        """Generate a new text key index for the repository.
 
 
398
        This is an expensive function that will take considerable time to run.
 
 
400
        :return: A dict mapping (file_id, revision_id) tuples to a list of
 
 
401
            parents, also (file_id, revision_id) tuples.
 
 
404
        return self._real_repository._generate_text_key_index()
 
 
406
    @symbol_versioning.deprecated_method(symbol_versioning.one_four)
 
 
407
    def get_revision_graph(self, revision_id=None):
 
 
408
        """See Repository.get_revision_graph()."""
 
 
409
        return self._get_revision_graph(revision_id)
 
 
411
    def _get_revision_graph(self, revision_id):
 
 
412
        """Private method for using with old (< 1.2) servers to fallback."""
 
 
413
        if revision_id is None:
 
 
415
        elif revision.is_null(revision_id):
 
 
418
        path = self.bzrdir._path_for_remote_call(self._client)
 
 
419
        response = self._call_expecting_body(
 
 
420
            'Repository.get_revision_graph', path, revision_id)
 
 
421
        response_tuple, response_handler = response
 
 
422
        if response_tuple[0] != 'ok':
 
 
423
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
 
424
        coded = response_handler.read_body_bytes()
 
 
426
            # no revisions in this repository!
 
 
428
        lines = coded.split('\n')
 
 
431
            d = tuple(line.split())
 
 
432
            revision_graph[d[0]] = d[1:]
 
 
434
        return revision_graph
 
 
436
    def has_revision(self, revision_id):
 
 
437
        """See Repository.has_revision()."""
 
 
438
        if revision_id == NULL_REVISION:
 
 
439
            # The null revision is always present.
 
 
441
        path = self.bzrdir._path_for_remote_call(self._client)
 
 
442
        response = self._call('Repository.has_revision', path, revision_id)
 
 
443
        if response[0] not in ('yes', 'no'):
 
 
444
            raise errors.UnexpectedSmartServerResponse(response)
 
 
445
        if response[0] == 'yes':
 
 
447
        for fallback_repo in self._fallback_repositories:
 
 
448
            if fallback_repo.has_revision(revision_id):
 
 
452
    def has_revisions(self, revision_ids):
 
 
453
        """See Repository.has_revisions()."""
 
 
454
        # FIXME: This does many roundtrips, particularly when there are
 
 
455
        # fallback repositories.  -- mbp 20080905
 
 
457
        for revision_id in revision_ids:
 
 
458
            if self.has_revision(revision_id):
 
 
459
                result.add(revision_id)
 
 
462
    def has_same_location(self, other):
 
 
463
        return (self.__class__ == other.__class__ and
 
 
464
                self.bzrdir.transport.base == other.bzrdir.transport.base)
 
 
466
    def get_graph(self, other_repository=None):
 
 
467
        """Return the graph for this repository format"""
 
 
468
        parents_provider = self
 
 
469
        if (other_repository is not None and
 
 
470
            other_repository.bzrdir.transport.base !=
 
 
471
            self.bzrdir.transport.base):
 
 
472
            parents_provider = graph._StackedParentsProvider(
 
 
473
                [parents_provider, other_repository._make_parents_provider()])
 
 
474
        return graph.Graph(parents_provider)
 
 
476
    def gather_stats(self, revid=None, committers=None):
 
 
477
        """See Repository.gather_stats()."""
 
 
478
        path = self.bzrdir._path_for_remote_call(self._client)
 
 
479
        # revid can be None to indicate no revisions, not just NULL_REVISION
 
 
480
        if revid is None or revision.is_null(revid):
 
 
484
        if committers is None or not committers:
 
 
485
            fmt_committers = 'no'
 
 
487
            fmt_committers = 'yes'
 
 
488
        response_tuple, response_handler = self._call_expecting_body(
 
 
489
            'Repository.gather_stats', path, fmt_revid, fmt_committers)
 
 
490
        if response_tuple[0] != 'ok':
 
 
491
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
 
493
        body = response_handler.read_body_bytes()
 
 
495
        for line in body.split('\n'):
 
 
498
            key, val_text = line.split(':')
 
 
499
            if key in ('revisions', 'size', 'committers'):
 
 
500
                result[key] = int(val_text)
 
 
501
            elif key in ('firstrev', 'latestrev'):
 
 
502
                values = val_text.split(' ')[1:]
 
 
503
                result[key] = (float(values[0]), long(values[1]))
 
 
507
    def find_branches(self, using=False):
 
 
508
        """See Repository.find_branches()."""
 
 
509
        # should be an API call to the server.
 
 
511
        return self._real_repository.find_branches(using=using)
 
 
513
    def get_physical_lock_status(self):
 
 
514
        """See Repository.get_physical_lock_status()."""
 
 
515
        # should be an API call to the server.
 
 
517
        return self._real_repository.get_physical_lock_status()
 
 
519
    def is_in_write_group(self):
 
 
520
        """Return True if there is an open write group.
 
 
522
        write groups are only applicable locally for the smart server..
 
 
524
        if self._real_repository:
 
 
525
            return self._real_repository.is_in_write_group()
 
 
528
        return self._lock_count >= 1
 
 
531
        """See Repository.is_shared()."""
 
 
532
        path = self.bzrdir._path_for_remote_call(self._client)
 
 
533
        response = self._call('Repository.is_shared', path)
 
 
534
        if response[0] not in ('yes', 'no'):
 
 
535
            raise SmartProtocolError('unexpected response code %s' % (response,))
 
 
536
        return response[0] == 'yes'
 
 
538
    def is_write_locked(self):
 
 
539
        return self._lock_mode == 'w'
 
 
542
        # wrong eventually - want a local lock cache context
 
 
543
        if not self._lock_mode:
 
 
544
            self._lock_mode = 'r'
 
 
546
            self._parents_map = {}
 
 
547
            if 'hpss' in debug.debug_flags:
 
 
548
                self._requested_parents = set()
 
 
549
            if self._real_repository is not None:
 
 
550
                self._real_repository.lock_read()
 
 
552
            self._lock_count += 1
 
 
554
    def _remote_lock_write(self, token):
 
 
555
        path = self.bzrdir._path_for_remote_call(self._client)
 
 
558
        err_context = {'token': token}
 
 
559
        response = self._call('Repository.lock_write', path, token,
 
 
561
        if response[0] == 'ok':
 
 
565
            raise errors.UnexpectedSmartServerResponse(response)
 
 
567
    def lock_write(self, token=None, _skip_rpc=False):
 
 
568
        if not self._lock_mode:
 
 
570
                if self._lock_token is not None:
 
 
571
                    if token != self._lock_token:
 
 
572
                        raise errors.TokenMismatch(token, self._lock_token)
 
 
573
                self._lock_token = token
 
 
575
                self._lock_token = self._remote_lock_write(token)
 
 
576
            # if self._lock_token is None, then this is something like packs or
 
 
577
            # svn where we don't get to lock the repo, or a weave style repository
 
 
578
            # where we cannot lock it over the wire and attempts to do so will
 
 
580
            if self._real_repository is not None:
 
 
581
                self._real_repository.lock_write(token=self._lock_token)
 
 
582
            if token is not None:
 
 
583
                self._leave_lock = True
 
 
585
                self._leave_lock = False
 
 
586
            self._lock_mode = 'w'
 
 
588
            self._parents_map = {}
 
 
589
            if 'hpss' in debug.debug_flags:
 
 
590
                self._requested_parents = set()
 
 
591
        elif self._lock_mode == 'r':
 
 
592
            raise errors.ReadOnlyError(self)
 
 
594
            self._lock_count += 1
 
 
595
        return self._lock_token or None
 
 
597
    def leave_lock_in_place(self):
 
 
598
        if not self._lock_token:
 
 
599
            raise NotImplementedError(self.leave_lock_in_place)
 
 
600
        self._leave_lock = True
 
 
602
    def dont_leave_lock_in_place(self):
 
 
603
        if not self._lock_token:
 
 
604
            raise NotImplementedError(self.dont_leave_lock_in_place)
 
 
605
        self._leave_lock = False
 
 
607
    def _set_real_repository(self, repository):
 
 
608
        """Set the _real_repository for this repository.
 
 
610
        :param repository: The repository to fallback to for non-hpss
 
 
611
            implemented operations.
 
 
613
        if self._real_repository is not None:
 
 
614
            raise AssertionError('_real_repository is already set')
 
 
615
        if isinstance(repository, RemoteRepository):
 
 
616
            raise AssertionError()
 
 
617
        self._real_repository = repository
 
 
618
        for fb in self._fallback_repositories:
 
 
619
            self._real_repository.add_fallback_repository(fb)
 
 
620
        if self._lock_mode == 'w':
 
 
621
            # if we are already locked, the real repository must be able to
 
 
622
            # acquire the lock with our token.
 
 
623
            self._real_repository.lock_write(self._lock_token)
 
 
624
        elif self._lock_mode == 'r':
 
 
625
            self._real_repository.lock_read()
 
 
627
    def start_write_group(self):
 
 
628
        """Start a write group on the decorated repository.
 
 
630
        Smart methods peform operations in a single step so this api
 
 
631
        is not really applicable except as a compatibility thunk
 
 
632
        for older plugins that don't use e.g. the CommitBuilder
 
 
636
        return self._real_repository.start_write_group()
 
 
638
    def _unlock(self, token):
 
 
639
        path = self.bzrdir._path_for_remote_call(self._client)
 
 
641
            # with no token the remote repository is not persistently locked.
 
 
643
        err_context = {'token': token}
 
 
644
        response = self._call('Repository.unlock', path, token,
 
 
646
        if response == ('ok',):
 
 
649
            raise errors.UnexpectedSmartServerResponse(response)
 
 
652
        self._lock_count -= 1
 
 
653
        if self._lock_count > 0:
 
 
655
        self._parents_map = None
 
 
656
        if 'hpss' in debug.debug_flags:
 
 
657
            self._requested_parents = None
 
 
658
        old_mode = self._lock_mode
 
 
659
        self._lock_mode = None
 
 
661
            # The real repository is responsible at present for raising an
 
 
662
            # exception if it's in an unfinished write group.  However, it
 
 
663
            # normally will *not* actually remove the lock from disk - that's
 
 
664
            # done by the server on receiving the Repository.unlock call.
 
 
665
            # This is just to let the _real_repository stay up to date.
 
 
666
            if self._real_repository is not None:
 
 
667
                self._real_repository.unlock()
 
 
669
            # The rpc-level lock should be released even if there was a
 
 
670
            # problem releasing the vfs-based lock.
 
 
672
                # Only write-locked repositories need to make a remote method
 
 
673
                # call to perfom the unlock.
 
 
674
                old_token = self._lock_token
 
 
675
                self._lock_token = None
 
 
676
                if not self._leave_lock:
 
 
677
                    self._unlock(old_token)
 
 
679
    def break_lock(self):
 
 
680
        # should hand off to the network
 
 
682
        return self._real_repository.break_lock()
 
 
684
    def _get_tarball(self, compression):
 
 
685
        """Return a TemporaryFile containing a repository tarball.
 
 
687
        Returns None if the server does not support sending tarballs.
 
 
690
        path = self.bzrdir._path_for_remote_call(self._client)
 
 
692
            response, protocol = self._call_expecting_body(
 
 
693
                'Repository.tarball', path, compression)
 
 
694
        except errors.UnknownSmartMethod:
 
 
695
            protocol.cancel_read_body()
 
 
697
        if response[0] == 'ok':
 
 
698
            # Extract the tarball and return it
 
 
699
            t = tempfile.NamedTemporaryFile()
 
 
700
            # TODO: rpc layer should read directly into it...
 
 
701
            t.write(protocol.read_body_bytes())
 
 
704
        raise errors.UnexpectedSmartServerResponse(response)
 
 
706
    def sprout(self, to_bzrdir, revision_id=None):
 
 
707
        # TODO: Option to control what format is created?
 
 
709
        dest_repo = self._real_repository._format.initialize(to_bzrdir,
 
 
711
        dest_repo.fetch(self, revision_id=revision_id)
 
 
714
    ### These methods are just thin shims to the VFS object for now.
 
 
716
    def revision_tree(self, revision_id):
 
 
718
        return self._real_repository.revision_tree(revision_id)
 
 
720
    def get_serializer_format(self):
 
 
722
        return self._real_repository.get_serializer_format()
 
 
724
    def get_commit_builder(self, branch, parents, config, timestamp=None,
 
 
725
                           timezone=None, committer=None, revprops=None,
 
 
727
        # FIXME: It ought to be possible to call this without immediately
 
 
728
        # triggering _ensure_real.  For now it's the easiest thing to do.
 
 
730
        real_repo = self._real_repository
 
 
731
        builder = real_repo.get_commit_builder(branch, parents,
 
 
732
                config, timestamp=timestamp, timezone=timezone,
 
 
733
                committer=committer, revprops=revprops, revision_id=revision_id)
 
 
736
    def add_fallback_repository(self, repository):
 
 
737
        """Add a repository to use for looking up data not held locally.
 
 
739
        :param repository: A repository.
 
 
741
        # XXX: At the moment the RemoteRepository will allow fallbacks
 
 
742
        # unconditionally - however, a _real_repository will usually exist,
 
 
743
        # and may raise an error if it's not accommodated by the underlying
 
 
744
        # format.  Eventually we should check when opening the repository
 
 
745
        # whether it's willing to allow them or not.
 
 
747
        # We need to accumulate additional repositories here, to pass them in
 
 
749
        self._fallback_repositories.append(repository)
 
 
750
        # They are also seen by the fallback repository.  If it doesn't exist
 
 
751
        # yet they'll be added then.  This implicitly copies them.
 
 
754
    def add_inventory(self, revid, inv, parents):
 
 
756
        return self._real_repository.add_inventory(revid, inv, parents)
 
 
758
    def add_revision(self, rev_id, rev, inv=None, config=None):
 
 
760
        return self._real_repository.add_revision(
 
 
761
            rev_id, rev, inv=inv, config=config)
 
 
764
    def get_inventory(self, revision_id):
 
 
766
        return self._real_repository.get_inventory(revision_id)
 
 
768
    def iter_inventories(self, revision_ids):
 
 
770
        return self._real_repository.iter_inventories(revision_ids)
 
 
773
    def get_revision(self, revision_id):
 
 
775
        return self._real_repository.get_revision(revision_id)
 
 
777
    def get_transaction(self):
 
 
779
        return self._real_repository.get_transaction()
 
 
782
    def clone(self, a_bzrdir, revision_id=None):
 
 
784
        return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
 
 
786
    def make_working_trees(self):
 
 
787
        """See Repository.make_working_trees"""
 
 
789
        return self._real_repository.make_working_trees()
 
 
791
    def revision_ids_to_search_result(self, result_set):
 
 
792
        """Convert a set of revision ids to a graph SearchResult."""
 
 
793
        result_parents = set()
 
 
794
        for parents in self.get_graph().get_parent_map(
 
 
795
            result_set).itervalues():
 
 
796
            result_parents.update(parents)
 
 
797
        included_keys = result_set.intersection(result_parents)
 
 
798
        start_keys = result_set.difference(included_keys)
 
 
799
        exclude_keys = result_parents.difference(result_set)
 
 
800
        result = graph.SearchResult(start_keys, exclude_keys,
 
 
801
            len(result_set), result_set)
 
 
805
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
 
 
806
        """Return the revision ids that other has that this does not.
 
 
808
        These are returned in topological order.
 
 
810
        revision_id: only return revision ids included by revision_id.
 
 
812
        return repository.InterRepository.get(
 
 
813
            other, self).search_missing_revision_ids(revision_id, find_ghosts)
 
 
815
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False):
 
 
816
        # Not delegated to _real_repository so that InterRepository.get has a
 
 
817
        # chance to find an InterRepository specialised for RemoteRepository.
 
 
818
        if self.has_same_location(source):
 
 
819
            # check that last_revision is in 'from' and then return a
 
 
821
            if (revision_id is not None and
 
 
822
                not revision.is_null(revision_id)):
 
 
823
                self.get_revision(revision_id)
 
 
825
        inter = repository.InterRepository.get(source, self)
 
 
827
            return inter.fetch(revision_id=revision_id, pb=pb, find_ghosts=find_ghosts)
 
 
828
        except NotImplementedError:
 
 
829
            raise errors.IncompatibleRepositories(source, self)
 
 
831
    def create_bundle(self, target, base, fileobj, format=None):
 
 
833
        self._real_repository.create_bundle(target, base, fileobj, format)
 
 
836
    def get_ancestry(self, revision_id, topo_sorted=True):
 
 
838
        return self._real_repository.get_ancestry(revision_id, topo_sorted)
 
 
840
    def fileids_altered_by_revision_ids(self, revision_ids):
 
 
842
        return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
 
 
844
    def _get_versioned_file_checker(self, revisions, revision_versions_cache):
 
 
846
        return self._real_repository._get_versioned_file_checker(
 
 
847
            revisions, revision_versions_cache)
 
 
849
    def iter_files_bytes(self, desired_files):
 
 
850
        """See Repository.iter_file_bytes.
 
 
853
        return self._real_repository.iter_files_bytes(desired_files)
 
 
856
    def _fetch_order(self):
 
 
857
        """Decorate the real repository for now.
 
 
859
        In the long term getting this back from the remote repository as part
 
 
860
        of open would be more efficient.
 
 
863
        return self._real_repository._fetch_order
 
 
866
    def _fetch_uses_deltas(self):
 
 
867
        """Decorate the real repository for now.
 
 
869
        In the long term getting this back from the remote repository as part
 
 
870
        of open would be more efficient.
 
 
873
        return self._real_repository._fetch_uses_deltas
 
 
876
    def _fetch_reconcile(self):
 
 
877
        """Decorate the real repository for now.
 
 
879
        In the long term getting this back from the remote repository as part
 
 
880
        of open would be more efficient.
 
 
883
        return self._real_repository._fetch_reconcile
 
 
885
    def get_parent_map(self, keys):
 
 
886
        """See bzrlib.Graph.get_parent_map()."""
 
 
887
        # Hack to build up the caching logic.
 
 
888
        ancestry = self._parents_map
 
 
890
            # Repository is not locked, so there's no cache.
 
 
891
            missing_revisions = set(keys)
 
 
894
            missing_revisions = set(key for key in keys if key not in ancestry)
 
 
895
        if missing_revisions:
 
 
896
            parent_map = self._get_parent_map(missing_revisions)
 
 
897
            if 'hpss' in debug.debug_flags:
 
 
898
                mutter('retransmitted revisions: %d of %d',
 
 
899
                        len(set(ancestry).intersection(parent_map)),
 
 
901
            ancestry.update(parent_map)
 
 
902
        present_keys = [k for k in keys if k in ancestry]
 
 
903
        if 'hpss' in debug.debug_flags:
 
 
904
            if self._requested_parents is not None and len(ancestry) != 0:
 
 
905
                self._requested_parents.update(present_keys)
 
 
906
                mutter('Current RemoteRepository graph hit rate: %d%%',
 
 
907
                    100.0 * len(self._requested_parents) / len(ancestry))
 
 
908
        return dict((k, ancestry[k]) for k in present_keys)
 
 
910
    def _get_parent_map(self, keys):
 
 
911
        """Helper for get_parent_map that performs the RPC."""
 
 
912
        medium = self._client._medium
 
 
913
        if medium._is_remote_before((1, 2)):
 
 
914
            # We already found out that the server can't understand
 
 
915
            # Repository.get_parent_map requests, so just fetch the whole
 
 
917
            # XXX: Note that this will issue a deprecation warning. This is ok
 
 
918
            # :- its because we're working with a deprecated server anyway, and
 
 
919
            # the user will almost certainly have seen a warning about the
 
 
920
            # server version already.
 
 
921
            rg = self.get_revision_graph()
 
 
922
            # There is an api discrepency between get_parent_map and
 
 
923
            # get_revision_graph. Specifically, a "key:()" pair in
 
 
924
            # get_revision_graph just means a node has no parents. For
 
 
925
            # "get_parent_map" it means the node is a ghost. So fix up the
 
 
926
            # graph to correct this.
 
 
927
            #   https://bugs.launchpad.net/bzr/+bug/214894
 
 
928
            # There is one other "bug" which is that ghosts in
 
 
929
            # get_revision_graph() are not returned at all. But we won't worry
 
 
930
            # about that for now.
 
 
931
            for node_id, parent_ids in rg.iteritems():
 
 
933
                    rg[node_id] = (NULL_REVISION,)
 
 
934
            rg[NULL_REVISION] = ()
 
 
939
            raise ValueError('get_parent_map(None) is not valid')
 
 
940
        if NULL_REVISION in keys:
 
 
941
            keys.discard(NULL_REVISION)
 
 
942
            found_parents = {NULL_REVISION:()}
 
 
947
        # TODO(Needs analysis): We could assume that the keys being requested
 
 
948
        # from get_parent_map are in a breadth first search, so typically they
 
 
949
        # will all be depth N from some common parent, and we don't have to
 
 
950
        # have the server iterate from the root parent, but rather from the
 
 
951
        # keys we're searching; and just tell the server the keyspace we
 
 
952
        # already have; but this may be more traffic again.
 
 
954
        # Transform self._parents_map into a search request recipe.
 
 
955
        # TODO: Manage this incrementally to avoid covering the same path
 
 
956
        # repeatedly. (The server will have to on each request, but the less
 
 
957
        # work done the better).
 
 
958
        parents_map = self._parents_map
 
 
959
        if parents_map is None:
 
 
960
            # Repository is not locked, so there's no cache.
 
 
962
        start_set = set(parents_map)
 
 
963
        result_parents = set()
 
 
964
        for parents in parents_map.itervalues():
 
 
965
            result_parents.update(parents)
 
 
966
        stop_keys = result_parents.difference(start_set)
 
 
967
        included_keys = start_set.intersection(result_parents)
 
 
968
        start_set.difference_update(included_keys)
 
 
969
        recipe = (start_set, stop_keys, len(parents_map))
 
 
970
        body = self._serialise_search_recipe(recipe)
 
 
971
        path = self.bzrdir._path_for_remote_call(self._client)
 
 
973
            if type(key) is not str:
 
 
975
                    "key %r not a plain string" % (key,))
 
 
976
        verb = 'Repository.get_parent_map'
 
 
977
        args = (path,) + tuple(keys)
 
 
979
            response = self._call_with_body_bytes_expecting_body(
 
 
981
        except errors.UnknownSmartMethod:
 
 
982
            # Server does not support this method, so get the whole graph.
 
 
983
            # Worse, we have to force a disconnection, because the server now
 
 
984
            # doesn't realise it has a body on the wire to consume, so the
 
 
985
            # only way to recover is to abandon the connection.
 
 
987
                'Server is too old for fast get_parent_map, reconnecting.  '
 
 
988
                '(Upgrade the server to Bazaar 1.2 to avoid this)')
 
 
990
            # To avoid having to disconnect repeatedly, we keep track of the
 
 
991
            # fact the server doesn't understand remote methods added in 1.2.
 
 
992
            medium._remember_remote_is_before((1, 2))
 
 
993
            return self.get_revision_graph(None)
 
 
994
        response_tuple, response_handler = response
 
 
995
        if response_tuple[0] not in ['ok']:
 
 
996
            response_handler.cancel_read_body()
 
 
997
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
 
998
        if response_tuple[0] == 'ok':
 
 
999
            coded = bz2.decompress(response_handler.read_body_bytes())
 
 
1001
                # no revisions found
 
 
1003
            lines = coded.split('\n')
 
 
1006
                d = tuple(line.split())
 
 
1008
                    revision_graph[d[0]] = d[1:]
 
 
1010
                    # No parents - so give the Graph result (NULL_REVISION,).
 
 
1011
                    revision_graph[d[0]] = (NULL_REVISION,)
 
 
1012
            return revision_graph
 
 
1015
    def get_signature_text(self, revision_id):
 
 
1017
        return self._real_repository.get_signature_text(revision_id)
 
 
1020
    @symbol_versioning.deprecated_method(symbol_versioning.one_three)
 
 
1021
    def get_revision_graph_with_ghosts(self, revision_ids=None):
 
 
1023
        return self._real_repository.get_revision_graph_with_ghosts(
 
 
1024
            revision_ids=revision_ids)
 
 
1027
    def get_inventory_xml(self, revision_id):
 
 
1029
        return self._real_repository.get_inventory_xml(revision_id)
 
 
1031
    def deserialise_inventory(self, revision_id, xml):
 
 
1033
        return self._real_repository.deserialise_inventory(revision_id, xml)
 
 
1035
    def reconcile(self, other=None, thorough=False):
 
 
1037
        return self._real_repository.reconcile(other=other, thorough=thorough)
 
 
1039
    def all_revision_ids(self):
 
 
1041
        return self._real_repository.all_revision_ids()
 
 
1044
    def get_deltas_for_revisions(self, revisions):
 
 
1046
        return self._real_repository.get_deltas_for_revisions(revisions)
 
 
1049
    def get_revision_delta(self, revision_id):
 
 
1051
        return self._real_repository.get_revision_delta(revision_id)
 
 
1054
    def revision_trees(self, revision_ids):
 
 
1056
        return self._real_repository.revision_trees(revision_ids)
 
 
1059
    def get_revision_reconcile(self, revision_id):
 
 
1061
        return self._real_repository.get_revision_reconcile(revision_id)
 
 
1064
    def check(self, revision_ids=None):
 
 
1066
        return self._real_repository.check(revision_ids=revision_ids)
 
 
1068
    def copy_content_into(self, destination, revision_id=None):
 
 
1070
        return self._real_repository.copy_content_into(
 
 
1071
            destination, revision_id=revision_id)
 
 
1073
    def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
 
 
1074
        # get a tarball of the remote repository, and copy from that into the
 
 
1076
        from bzrlib import osutils
 
 
1078
        # TODO: Maybe a progress bar while streaming the tarball?
 
 
1079
        note("Copying repository content as tarball...")
 
 
1080
        tar_file = self._get_tarball('bz2')
 
 
1081
        if tar_file is None:
 
 
1083
        destination = to_bzrdir.create_repository()
 
 
1085
            tar = tarfile.open('repository', fileobj=tar_file,
 
 
1087
            tmpdir = osutils.mkdtemp()
 
 
1089
                _extract_tar(tar, tmpdir)
 
 
1090
                tmp_bzrdir = BzrDir.open(tmpdir)
 
 
1091
                tmp_repo = tmp_bzrdir.open_repository()
 
 
1092
                tmp_repo.copy_content_into(destination, revision_id)
 
 
1094
                osutils.rmtree(tmpdir)
 
 
1098
        # TODO: Suggestion from john: using external tar is much faster than
 
 
1099
        # python's tarfile library, but it may not work on windows.
 
 
1102
    def inventories(self):
 
 
1103
        """Decorate the real repository for now.
 
 
1105
        In the long term a full blown network facility is needed to
 
 
1106
        avoid creating a real repository object locally.
 
 
1109
        return self._real_repository.inventories
 
 
1113
        """Compress the data within the repository.
 
 
1115
        This is not currently implemented within the smart server.
 
 
1118
        return self._real_repository.pack()
 
 
1121
    def revisions(self):
 
 
1122
        """Decorate the real repository for now.
 
 
1124
        In the short term this should become a real object to intercept graph
 
 
1127
        In the long term a full blown network facility is needed.
 
 
1130
        return self._real_repository.revisions
 
 
1132
    def set_make_working_trees(self, new_value):
 
 
1134
        self._real_repository.set_make_working_trees(new_value)
 
 
1137
    def signatures(self):
 
 
1138
        """Decorate the real repository for now.
 
 
1140
        In the long term a full blown network facility is needed to avoid
 
 
1141
        creating a real repository object locally.
 
 
1144
        return self._real_repository.signatures
 
 
1147
    def sign_revision(self, revision_id, gpg_strategy):
 
 
1149
        return self._real_repository.sign_revision(revision_id, gpg_strategy)
 
 
1153
        """Decorate the real repository for now.
 
 
1155
        In the long term a full blown network facility is needed to avoid
 
 
1156
        creating a real repository object locally.
 
 
1159
        return self._real_repository.texts
 
 
1162
    def get_revisions(self, revision_ids):
 
 
1164
        return self._real_repository.get_revisions(revision_ids)
 
 
1166
    def supports_rich_root(self):
 
 
1168
        return self._real_repository.supports_rich_root()
 
 
1170
    def iter_reverse_revision_history(self, revision_id):
 
 
1172
        return self._real_repository.iter_reverse_revision_history(revision_id)
 
 
1175
    def _serializer(self):
 
 
1177
        return self._real_repository._serializer
 
 
1179
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
 
 
1181
        return self._real_repository.store_revision_signature(
 
 
1182
            gpg_strategy, plaintext, revision_id)
 
 
1184
    def add_signature_text(self, revision_id, signature):
 
 
1186
        return self._real_repository.add_signature_text(revision_id, signature)
 
 
1188
    def has_signature_for_revision_id(self, revision_id):
 
 
1190
        return self._real_repository.has_signature_for_revision_id(revision_id)
 
 
1192
    def item_keys_introduced_by(self, revision_ids, _files_pb=None):
 
 
1194
        return self._real_repository.item_keys_introduced_by(revision_ids,
 
 
1195
            _files_pb=_files_pb)
 
 
1197
    def revision_graph_can_have_wrong_parents(self):
 
 
1198
        # The answer depends on the remote repo format.
 
 
1200
        return self._real_repository.revision_graph_can_have_wrong_parents()
 
 
1202
    def _find_inconsistent_revision_parents(self):
 
 
1204
        return self._real_repository._find_inconsistent_revision_parents()
 
 
1206
    def _check_for_inconsistent_revision_parents(self):
 
 
1208
        return self._real_repository._check_for_inconsistent_revision_parents()
 
 
1210
    def _make_parents_provider(self):
 
 
1213
    def _serialise_search_recipe(self, recipe):
 
 
1214
        """Serialise a graph search recipe.
 
 
1216
        :param recipe: A search recipe (start, stop, count).
 
 
1217
        :return: Serialised bytes.
 
 
1219
        start_keys = ' '.join(recipe[0])
 
 
1220
        stop_keys = ' '.join(recipe[1])
 
 
1221
        count = str(recipe[2])
 
 
1222
        return '\n'.join((start_keys, stop_keys, count))
 
 
1225
        path = self.bzrdir._path_for_remote_call(self._client)
 
 
1227
            response = self._call('PackRepository.autopack', path)
 
 
1228
        except errors.UnknownSmartMethod:
 
 
1230
            self._real_repository._pack_collection.autopack()
 
 
1232
        if self._real_repository is not None:
 
 
1233
            # Reset the real repository's cache of pack names.
 
 
1234
            # XXX: At some point we may be able to skip this and just rely on
 
 
1235
            # the automatic retry logic to do the right thing, but for now we
 
 
1236
            # err on the side of being correct rather than being optimal.
 
 
1237
            self._real_repository._pack_collection.reload_pack_names()
 
 
1238
        if response[0] != 'ok':
 
 
1239
            raise errors.UnexpectedSmartServerResponse(response)
 
 
1242
class RemoteBranchLockableFiles(LockableFiles):
 
 
1243
    """A 'LockableFiles' implementation that talks to a smart server.
 
 
1245
    This is not a public interface class.
 
 
1248
    def __init__(self, bzrdir, _client):
 
 
1249
        self.bzrdir = bzrdir
 
 
1250
        self._client = _client
 
 
1251
        self._need_find_modes = True
 
 
1252
        LockableFiles.__init__(
 
 
1253
            self, bzrdir.get_branch_transport(None),
 
 
1254
            'lock', lockdir.LockDir)
 
 
1256
    def _find_modes(self):
 
 
1257
        # RemoteBranches don't let the client set the mode of control files.
 
 
1258
        self._dir_mode = None
 
 
1259
        self._file_mode = None
 
 
1262
class RemoteBranchFormat(branch.BranchFormat):
 
 
1264
    def __eq__(self, other):
 
 
1265
        return (isinstance(other, RemoteBranchFormat) and 
 
 
1266
            self.__dict__ == other.__dict__)
 
 
1268
    def get_format_description(self):
 
 
1269
        return 'Remote BZR Branch'
 
 
1271
    def get_format_string(self):
 
 
1272
        return 'Remote BZR Branch'
 
 
1274
    def open(self, a_bzrdir):
 
 
1275
        return a_bzrdir.open_branch()
 
 
1277
    def initialize(self, a_bzrdir):
 
 
1278
        return a_bzrdir.create_branch()
 
 
1280
    def supports_tags(self):
 
 
1281
        # Remote branches might support tags, but we won't know until we
 
 
1282
        # access the real remote branch.
 
 
1286
class RemoteBranch(branch.Branch, _RpcHelper):
 
 
1287
    """Branch stored on a server accessed by HPSS RPC.
 
 
1289
    At the moment most operations are mapped down to simple file operations.
 
 
1292
    def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
 
 
1294
        """Create a RemoteBranch instance.
 
 
1296
        :param real_branch: An optional local implementation of the branch
 
 
1297
            format, usually accessing the data via the VFS.
 
 
1298
        :param _client: Private parameter for testing.
 
 
1300
        # We intentionally don't call the parent class's __init__, because it
 
 
1301
        # will try to assign to self.tags, which is a property in this subclass.
 
 
1302
        # And the parent's __init__ doesn't do much anyway.
 
 
1303
        self._revision_id_to_revno_cache = None
 
 
1304
        self._revision_history_cache = None
 
 
1305
        self._last_revision_info_cache = None
 
 
1306
        self.bzrdir = remote_bzrdir
 
 
1307
        if _client is not None:
 
 
1308
            self._client = _client
 
 
1310
            self._client = remote_bzrdir._client
 
 
1311
        self.repository = remote_repository
 
 
1312
        if real_branch is not None:
 
 
1313
            self._real_branch = real_branch
 
 
1314
            # Give the remote repository the matching real repo.
 
 
1315
            real_repo = self._real_branch.repository
 
 
1316
            if isinstance(real_repo, RemoteRepository):
 
 
1317
                real_repo._ensure_real()
 
 
1318
                real_repo = real_repo._real_repository
 
 
1319
            self.repository._set_real_repository(real_repo)
 
 
1320
            # Give the branch the remote repository to let fast-pathing happen.
 
 
1321
            self._real_branch.repository = self.repository
 
 
1323
            self._real_branch = None
 
 
1324
        # Fill out expected attributes of branch for bzrlib api users.
 
 
1325
        self._format = RemoteBranchFormat()
 
 
1326
        self.base = self.bzrdir.root_transport.base
 
 
1327
        self._control_files = None
 
 
1328
        self._lock_mode = None
 
 
1329
        self._lock_token = None
 
 
1330
        self._repo_lock_token = None
 
 
1331
        self._lock_count = 0
 
 
1332
        self._leave_lock = False
 
 
1333
        # The base class init is not called, so we duplicate this:
 
 
1334
        hooks = branch.Branch.hooks['open']
 
 
1337
        self._setup_stacking()
 
 
1339
    def _setup_stacking(self):
 
 
1340
        # configure stacking into the remote repository, by reading it from
 
 
1343
            fallback_url = self.get_stacked_on_url()
 
 
1344
        except (errors.NotStacked, errors.UnstackableBranchFormat,
 
 
1345
            errors.UnstackableRepositoryFormat), e:
 
 
1347
        # it's relative to this branch...
 
 
1348
        fallback_url = urlutils.join(self.base, fallback_url)
 
 
1349
        transports = [self.bzrdir.root_transport]
 
 
1350
        if self._real_branch is not None:
 
 
1351
            transports.append(self._real_branch._transport)
 
 
1352
        stacked_on = branch.Branch.open(fallback_url,
 
 
1353
                                        possible_transports=transports)
 
 
1354
        self.repository.add_fallback_repository(stacked_on.repository)
 
 
1356
    def _get_real_transport(self):
 
 
1357
        # if we try vfs access, return the real branch's vfs transport
 
 
1359
        return self._real_branch._transport
 
 
1361
    _transport = property(_get_real_transport)
 
 
1364
        return "%s(%s)" % (self.__class__.__name__, self.base)
 
 
1368
    def _ensure_real(self):
 
 
1369
        """Ensure that there is a _real_branch set.
 
 
1371
        Used before calls to self._real_branch.
 
 
1373
        if self._real_branch is None:
 
 
1374
            if not vfs.vfs_enabled():
 
 
1375
                raise AssertionError('smart server vfs must be enabled '
 
 
1376
                    'to use vfs implementation')
 
 
1377
            self.bzrdir._ensure_real()
 
 
1378
            self._real_branch = self.bzrdir._real_bzrdir.open_branch()
 
 
1379
            if self.repository._real_repository is None:
 
 
1380
                # Give the remote repository the matching real repo.
 
 
1381
                real_repo = self._real_branch.repository
 
 
1382
                if isinstance(real_repo, RemoteRepository):
 
 
1383
                    real_repo._ensure_real()
 
 
1384
                    real_repo = real_repo._real_repository
 
 
1385
                self.repository._set_real_repository(real_repo)
 
 
1386
            # Give the real branch the remote repository to let fast-pathing
 
 
1388
            self._real_branch.repository = self.repository
 
 
1389
            if self._lock_mode == 'r':
 
 
1390
                self._real_branch.lock_read()
 
 
1391
            elif self._lock_mode == 'w':
 
 
1392
                self._real_branch.lock_write(token=self._lock_token)
 
 
1394
    def _translate_error(self, err, **context):
 
 
1395
        self.repository._translate_error(err, branch=self, **context)
 
 
1397
    def _clear_cached_state(self):
 
 
1398
        super(RemoteBranch, self)._clear_cached_state()
 
 
1399
        if self._real_branch is not None:
 
 
1400
            self._real_branch._clear_cached_state()
 
 
1402
    def _clear_cached_state_of_remote_branch_only(self):
 
 
1403
        """Like _clear_cached_state, but doesn't clear the cache of
 
 
1406
        This is useful when falling back to calling a method of
 
 
1407
        self._real_branch that changes state.  In that case the underlying
 
 
1408
        branch changes, so we need to invalidate this RemoteBranch's cache of
 
 
1409
        it.  However, there's no need to invalidate the _real_branch's cache
 
 
1410
        too, in fact doing so might harm performance.
 
 
1412
        super(RemoteBranch, self)._clear_cached_state()
 
 
1415
    def control_files(self):
 
 
1416
        # Defer actually creating RemoteBranchLockableFiles until its needed,
 
 
1417
        # because it triggers an _ensure_real that we otherwise might not need.
 
 
1418
        if self._control_files is None:
 
 
1419
            self._control_files = RemoteBranchLockableFiles(
 
 
1420
                self.bzrdir, self._client)
 
 
1421
        return self._control_files
 
 
1423
    def _get_checkout_format(self):
 
 
1425
        return self._real_branch._get_checkout_format()
 
 
1427
    def get_physical_lock_status(self):
 
 
1428
        """See Branch.get_physical_lock_status()."""
 
 
1429
        # should be an API call to the server, as branches must be lockable.
 
 
1431
        return self._real_branch.get_physical_lock_status()
 
 
1433
    def get_stacked_on_url(self):
 
 
1434
        """Get the URL this branch is stacked against.
 
 
1436
        :raises NotStacked: If the branch is not stacked.
 
 
1437
        :raises UnstackableBranchFormat: If the branch does not support
 
 
1439
        :raises UnstackableRepositoryFormat: If the repository does not support
 
 
1443
            # there may not be a repository yet, so we can't use
 
 
1444
            # self._translate_error, so we can't use self._call either.
 
 
1445
            response = self._client.call('Branch.get_stacked_on_url',
 
 
1446
                self._remote_path())
 
 
1447
        except errors.ErrorFromSmartServer, err:
 
 
1448
            # there may not be a repository yet, so we can't call through
 
 
1449
            # its _translate_error
 
 
1450
            _translate_error(err, branch=self)
 
 
1451
        except errors.UnknownSmartMethod, err:
 
 
1453
            return self._real_branch.get_stacked_on_url()
 
 
1454
        if response[0] != 'ok':
 
 
1455
            raise errors.UnexpectedSmartServerResponse(response)
 
 
1458
    def lock_read(self):
 
 
1459
        self.repository.lock_read()
 
 
1460
        if not self._lock_mode:
 
 
1461
            self._lock_mode = 'r'
 
 
1462
            self._lock_count = 1
 
 
1463
            if self._real_branch is not None:
 
 
1464
                self._real_branch.lock_read()
 
 
1466
            self._lock_count += 1
 
 
1468
    def _remote_lock_write(self, token):
 
 
1470
            branch_token = repo_token = ''
 
 
1472
            branch_token = token
 
 
1473
            repo_token = self.repository.lock_write()
 
 
1474
            self.repository.unlock()
 
 
1475
        err_context = {'token': token}
 
 
1476
        response = self._call(
 
 
1477
            'Branch.lock_write', self._remote_path(), branch_token,
 
 
1478
            repo_token or '', **err_context)
 
 
1479
        if response[0] != 'ok':
 
 
1480
            raise errors.UnexpectedSmartServerResponse(response)
 
 
1481
        ok, branch_token, repo_token = response
 
 
1482
        return branch_token, repo_token
 
 
1484
    def lock_write(self, token=None):
 
 
1485
        if not self._lock_mode:
 
 
1486
            # Lock the branch and repo in one remote call.
 
 
1487
            remote_tokens = self._remote_lock_write(token)
 
 
1488
            self._lock_token, self._repo_lock_token = remote_tokens
 
 
1489
            if not self._lock_token:
 
 
1490
                raise SmartProtocolError('Remote server did not return a token!')
 
 
1491
            # Tell the self.repository object that it is locked.
 
 
1492
            self.repository.lock_write(
 
 
1493
                self._repo_lock_token, _skip_rpc=True)
 
 
1495
            if self._real_branch is not None:
 
 
1496
                self._real_branch.lock_write(token=self._lock_token)
 
 
1497
            if token is not None:
 
 
1498
                self._leave_lock = True
 
 
1500
                self._leave_lock = False
 
 
1501
            self._lock_mode = 'w'
 
 
1502
            self._lock_count = 1
 
 
1503
        elif self._lock_mode == 'r':
 
 
1504
            raise errors.ReadOnlyTransaction
 
 
1506
            if token is not None:
 
 
1507
                # A token was given to lock_write, and we're relocking, so
 
 
1508
                # check that the given token actually matches the one we
 
 
1510
                if token != self._lock_token:
 
 
1511
                    raise errors.TokenMismatch(token, self._lock_token)
 
 
1512
            self._lock_count += 1
 
 
1513
            # Re-lock the repository too.
 
 
1514
            self.repository.lock_write(self._repo_lock_token)
 
 
1515
        return self._lock_token or None
 
 
1517
    def _unlock(self, branch_token, repo_token):
 
 
1518
        err_context = {'token': str((branch_token, repo_token))}
 
 
1519
        response = self._call(
 
 
1520
            'Branch.unlock', self._remote_path(), branch_token,
 
 
1521
            repo_token or '', **err_context)
 
 
1522
        if response == ('ok',):
 
 
1524
        raise errors.UnexpectedSmartServerResponse(response)
 
 
1528
            self._lock_count -= 1
 
 
1529
            if not self._lock_count:
 
 
1530
                self._clear_cached_state()
 
 
1531
                mode = self._lock_mode
 
 
1532
                self._lock_mode = None
 
 
1533
                if self._real_branch is not None:
 
 
1534
                    if (not self._leave_lock and mode == 'w' and
 
 
1535
                        self._repo_lock_token):
 
 
1536
                        # If this RemoteBranch will remove the physical lock
 
 
1537
                        # for the repository, make sure the _real_branch
 
 
1538
                        # doesn't do it first.  (Because the _real_branch's
 
 
1539
                        # repository is set to be the RemoteRepository.)
 
 
1540
                        self._real_branch.repository.leave_lock_in_place()
 
 
1541
                    self._real_branch.unlock()
 
 
1543
                    # Only write-locked branched need to make a remote method
 
 
1544
                    # call to perfom the unlock.
 
 
1546
                if not self._lock_token:
 
 
1547
                    raise AssertionError('Locked, but no token!')
 
 
1548
                branch_token = self._lock_token
 
 
1549
                repo_token = self._repo_lock_token
 
 
1550
                self._lock_token = None
 
 
1551
                self._repo_lock_token = None
 
 
1552
                if not self._leave_lock:
 
 
1553
                    self._unlock(branch_token, repo_token)
 
 
1555
            self.repository.unlock()
 
 
1557
    def break_lock(self):
 
 
1559
        return self._real_branch.break_lock()
 
 
1561
    def leave_lock_in_place(self):
 
 
1562
        if not self._lock_token:
 
 
1563
            raise NotImplementedError(self.leave_lock_in_place)
 
 
1564
        self._leave_lock = True
 
 
1566
    def dont_leave_lock_in_place(self):
 
 
1567
        if not self._lock_token:
 
 
1568
            raise NotImplementedError(self.dont_leave_lock_in_place)
 
 
1569
        self._leave_lock = False
 
 
1571
    def _last_revision_info(self):
 
 
1572
        response = self._call('Branch.last_revision_info', self._remote_path())
 
 
1573
        if response[0] != 'ok':
 
 
1574
            raise SmartProtocolError('unexpected response code %s' % (response,))
 
 
1575
        revno = int(response[1])
 
 
1576
        last_revision = response[2]
 
 
1577
        return (revno, last_revision)
 
 
1579
    def _gen_revision_history(self):
 
 
1580
        """See Branch._gen_revision_history()."""
 
 
1581
        response_tuple, response_handler = self._call_expecting_body(
 
 
1582
            'Branch.revision_history', self._remote_path())
 
 
1583
        if response_tuple[0] != 'ok':
 
 
1584
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
 
1585
        result = response_handler.read_body_bytes().split('\x00')
 
 
1590
    def _remote_path(self):
 
 
1591
        return self.bzrdir._path_for_remote_call(self._client)
 
 
1593
    def _set_last_revision_descendant(self, revision_id, other_branch,
 
 
1594
            allow_diverged=False, allow_overwrite_descendant=False):
 
 
1595
        err_context = {'other_branch': other_branch}
 
 
1596
        response = self._call('Branch.set_last_revision_ex',
 
 
1597
            self._remote_path(), self._lock_token, self._repo_lock_token,
 
 
1598
            revision_id, int(allow_diverged), int(allow_overwrite_descendant),
 
 
1600
        self._clear_cached_state()
 
 
1601
        if len(response) != 3 and response[0] != 'ok':
 
 
1602
            raise errors.UnexpectedSmartServerResponse(response)
 
 
1603
        new_revno, new_revision_id = response[1:]
 
 
1604
        self._last_revision_info_cache = new_revno, new_revision_id
 
 
1605
        if self._real_branch is not None:
 
 
1606
            cache = new_revno, new_revision_id
 
 
1607
            self._real_branch._last_revision_info_cache = cache
 
 
1609
    def _set_last_revision(self, revision_id):
 
 
1610
        self._clear_cached_state()
 
 
1611
        response = self._call('Branch.set_last_revision',
 
 
1612
            self._remote_path(), self._lock_token, self._repo_lock_token,
 
 
1614
        if response != ('ok',):
 
 
1615
            raise errors.UnexpectedSmartServerResponse(response)
 
 
1618
    def set_revision_history(self, rev_history):
 
 
1619
        # Send just the tip revision of the history; the server will generate
 
 
1620
        # the full history from that.  If the revision doesn't exist in this
 
 
1621
        # branch, NoSuchRevision will be raised.
 
 
1622
        if rev_history == []:
 
 
1625
            rev_id = rev_history[-1]
 
 
1626
        self._set_last_revision(rev_id)
 
 
1627
        self._cache_revision_history(rev_history)
 
 
1629
    def get_parent(self):
 
 
1631
        return self._real_branch.get_parent()
 
 
1633
    def set_parent(self, url):
 
 
1635
        return self._real_branch.set_parent(url)
 
 
1637
    def set_stacked_on_url(self, stacked_location):
 
 
1638
        """Set the URL this branch is stacked against.
 
 
1640
        :raises UnstackableBranchFormat: If the branch does not support
 
 
1642
        :raises UnstackableRepositoryFormat: If the repository does not support
 
 
1646
        return self._real_branch.set_stacked_on_url(stacked_location)
 
 
1648
    def sprout(self, to_bzrdir, revision_id=None):
 
 
1649
        branch_format = to_bzrdir._format._branch_format
 
 
1650
        if (branch_format is None or
 
 
1651
            isinstance(branch_format, RemoteBranchFormat)):
 
 
1652
            # The to_bzrdir specifies RemoteBranchFormat (or no format, which
 
 
1653
            # implies the same thing), but RemoteBranches can't be created at
 
 
1654
            # arbitrary URLs.  So create a branch in the same format as
 
 
1655
            # _real_branch instead.
 
 
1656
            # XXX: if to_bzrdir is a RemoteBzrDir, this should perhaps do
 
 
1657
            # to_bzrdir.create_branch to create a RemoteBranch after all...
 
 
1659
            result = self._real_branch._format.initialize(to_bzrdir)
 
 
1660
            self.copy_content_into(result, revision_id=revision_id)
 
 
1661
            result.set_parent(self.bzrdir.root_transport.base)
 
 
1663
            result = branch.Branch.sprout(
 
 
1664
                self, to_bzrdir, revision_id=revision_id)
 
 
1668
    def pull(self, source, overwrite=False, stop_revision=None,
 
 
1670
        self._clear_cached_state_of_remote_branch_only()
 
 
1672
        return self._real_branch.pull(
 
 
1673
            source, overwrite=overwrite, stop_revision=stop_revision,
 
 
1674
            _override_hook_target=self, **kwargs)
 
 
1677
    def push(self, target, overwrite=False, stop_revision=None):
 
 
1679
        return self._real_branch.push(
 
 
1680
            target, overwrite=overwrite, stop_revision=stop_revision,
 
 
1681
            _override_hook_source_branch=self)
 
 
1683
    def is_locked(self):
 
 
1684
        return self._lock_count >= 1
 
 
1687
    def revision_id_to_revno(self, revision_id):
 
 
1689
        return self._real_branch.revision_id_to_revno(revision_id)
 
 
1692
    def set_last_revision_info(self, revno, revision_id):
 
 
1693
        revision_id = ensure_null(revision_id)
 
 
1695
            response = self._call('Branch.set_last_revision_info',
 
 
1696
                self._remote_path(), self._lock_token, self._repo_lock_token,
 
 
1697
                str(revno), revision_id)
 
 
1698
        except errors.UnknownSmartMethod:
 
 
1700
            self._clear_cached_state_of_remote_branch_only()
 
 
1701
            self._real_branch.set_last_revision_info(revno, revision_id)
 
 
1702
            self._last_revision_info_cache = revno, revision_id
 
 
1704
        if response == ('ok',):
 
 
1705
            self._clear_cached_state()
 
 
1706
            self._last_revision_info_cache = revno, revision_id
 
 
1707
            # Update the _real_branch's cache too.
 
 
1708
            if self._real_branch is not None:
 
 
1709
                cache = self._last_revision_info_cache
 
 
1710
                self._real_branch._last_revision_info_cache = cache
 
 
1712
            raise errors.UnexpectedSmartServerResponse(response)
 
 
1715
    def generate_revision_history(self, revision_id, last_rev=None,
 
 
1717
        medium = self._client._medium
 
 
1718
        if not medium._is_remote_before((1, 6)):
 
 
1720
                self._set_last_revision_descendant(revision_id, other_branch,
 
 
1721
                    allow_diverged=True, allow_overwrite_descendant=True)
 
 
1723
            except errors.UnknownSmartMethod:
 
 
1724
                medium._remember_remote_is_before((1, 6))
 
 
1725
        self._clear_cached_state_of_remote_branch_only()
 
 
1727
        self._real_branch.generate_revision_history(
 
 
1728
            revision_id, last_rev=last_rev, other_branch=other_branch)
 
 
1733
        return self._real_branch.tags
 
 
1735
    def set_push_location(self, location):
 
 
1737
        return self._real_branch.set_push_location(location)
 
 
1740
    def update_revisions(self, other, stop_revision=None, overwrite=False,
 
 
1742
        """See Branch.update_revisions."""
 
 
1745
            if stop_revision is None:
 
 
1746
                stop_revision = other.last_revision()
 
 
1747
                if revision.is_null(stop_revision):
 
 
1748
                    # if there are no commits, we're done.
 
 
1750
            self.fetch(other, stop_revision)
 
 
1753
                # Just unconditionally set the new revision.  We don't care if
 
 
1754
                # the branches have diverged.
 
 
1755
                self._set_last_revision(stop_revision)
 
 
1757
                medium = self._client._medium
 
 
1758
                if not medium._is_remote_before((1, 6)):
 
 
1760
                        self._set_last_revision_descendant(stop_revision, other)
 
 
1762
                    except errors.UnknownSmartMethod:
 
 
1763
                        medium._remember_remote_is_before((1, 6))
 
 
1764
                # Fallback for pre-1.6 servers: check for divergence
 
 
1765
                # client-side, then do _set_last_revision.
 
 
1766
                last_rev = revision.ensure_null(self.last_revision())
 
 
1768
                    graph = self.repository.get_graph()
 
 
1769
                if self._check_if_descendant_or_diverged(
 
 
1770
                        stop_revision, last_rev, graph, other):
 
 
1771
                    # stop_revision is a descendant of last_rev, but we aren't
 
 
1772
                    # overwriting, so we're done.
 
 
1774
                self._set_last_revision(stop_revision)
 
 
1779
def _extract_tar(tar, to_dir):
 
 
1780
    """Extract all the contents of a tarfile object.
 
 
1782
    A replacement for extractall, which is not present in python2.4
 
 
1785
        tar.extract(tarinfo, to_dir)
 
 
1788
def _translate_error(err, **context):
 
 
1789
    """Translate an ErrorFromSmartServer into a more useful error.
 
 
1791
    Possible context keys:
 
 
1799
    If the error from the server doesn't match a known pattern, then
 
 
1800
    UnknownErrorFromSmartServer is raised.
 
 
1804
            return context[name]
 
 
1805
        except KeyError, key_err:
 
 
1806
            mutter('Missing key %r in context %r', key_err.args[0], context)
 
 
1809
        """Get the path from the context if present, otherwise use first error
 
 
1813
            return context['path']
 
 
1814
        except KeyError, key_err:
 
 
1816
                return err.error_args[0]
 
 
1817
            except IndexError, idx_err:
 
 
1819
                    'Missing key %r in context %r', key_err.args[0], context)
 
 
1822
    if err.error_verb == 'NoSuchRevision':
 
 
1823
        raise NoSuchRevision(find('branch'), err.error_args[0])
 
 
1824
    elif err.error_verb == 'nosuchrevision':
 
 
1825
        raise NoSuchRevision(find('repository'), err.error_args[0])
 
 
1826
    elif err.error_tuple == ('nobranch',):
 
 
1827
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
 
 
1828
    elif err.error_verb == 'norepository':
 
 
1829
        raise errors.NoRepositoryPresent(find('bzrdir'))
 
 
1830
    elif err.error_verb == 'LockContention':
 
 
1831
        raise errors.LockContention('(remote lock)')
 
 
1832
    elif err.error_verb == 'UnlockableTransport':
 
 
1833
        raise errors.UnlockableTransport(find('bzrdir').root_transport)
 
 
1834
    elif err.error_verb == 'LockFailed':
 
 
1835
        raise errors.LockFailed(err.error_args[0], err.error_args[1])
 
 
1836
    elif err.error_verb == 'TokenMismatch':
 
 
1837
        raise errors.TokenMismatch(find('token'), '(remote token)')
 
 
1838
    elif err.error_verb == 'Diverged':
 
 
1839
        raise errors.DivergedBranches(find('branch'), find('other_branch'))
 
 
1840
    elif err.error_verb == 'TipChangeRejected':
 
 
1841
        raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
 
 
1842
    elif err.error_verb == 'UnstackableBranchFormat':
 
 
1843
        raise errors.UnstackableBranchFormat(*err.error_args)
 
 
1844
    elif err.error_verb == 'UnstackableRepositoryFormat':
 
 
1845
        raise errors.UnstackableRepositoryFormat(*err.error_args)
 
 
1846
    elif err.error_verb == 'NotStacked':
 
 
1847
        raise errors.NotStacked(branch=find('branch'))
 
 
1848
    elif err.error_verb == 'PermissionDenied':
 
 
1850
        if len(err.error_args) >= 2:
 
 
1851
            extra = err.error_args[1]
 
 
1854
        raise errors.PermissionDenied(path, extra=extra)
 
 
1855
    elif err.error_verb == 'ReadError':
 
 
1857
        raise errors.ReadError(path)
 
 
1858
    elif err.error_verb == 'NoSuchFile':
 
 
1860
        raise errors.NoSuchFile(path)
 
 
1861
    elif err.error_verb == 'FileExists':
 
 
1862
        raise errors.FileExists(err.error_args[0])
 
 
1863
    elif err.error_verb == 'DirectoryNotEmpty':
 
 
1864
        raise errors.DirectoryNotEmpty(err.error_args[0])
 
 
1865
    elif err.error_verb == 'ShortReadvError':
 
 
1866
        args = err.error_args
 
 
1867
        raise errors.ShortReadvError(
 
 
1868
            args[0], int(args[1]), int(args[2]), int(args[3]))
 
 
1869
    elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
 
 
1870
        encoding = str(err.error_args[0]) # encoding must always be a string
 
 
1871
        val = err.error_args[1]
 
 
1872
        start = int(err.error_args[2])
 
 
1873
        end = int(err.error_args[3])
 
 
1874
        reason = str(err.error_args[4]) # reason must always be a string
 
 
1875
        if val.startswith('u:'):
 
 
1876
            val = val[2:].decode('utf-8')
 
 
1877
        elif val.startswith('s:'):
 
 
1878
            val = val[2:].decode('base64')
 
 
1879
        if err.error_verb == 'UnicodeDecodeError':
 
 
1880
            raise UnicodeDecodeError(encoding, val, start, end, reason)
 
 
1881
        elif err.error_verb == 'UnicodeEncodeError':
 
 
1882
            raise UnicodeEncodeError(encoding, val, start, end, reason)
 
 
1883
    elif err.error_verb == 'ReadOnlyError':
 
 
1884
        raise errors.TransportNotPossible('readonly transport')
 
 
1885
    raise errors.UnknownErrorFromSmartServer(err)