/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

  • Committer: Andrew Bennetts
  • Date: 2007-03-29 09:08:25 UTC
  • mto: (2018.18.6 hpss-faster-copy)
  • mto: This revision was merged to the branch mainline in revision 2435.
  • Revision ID: andrew.bennetts@canonical.com-20070329090825-n2imszarc27gf6ls
All TestLockableFiles_RemoteLockDir tests passing.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2006, 2007 Canonical Ltd
 
2
#
 
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.
 
7
#
 
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.
 
12
#
 
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
 
16
 
 
17
# TODO: At some point, handle upgrades by just passing the whole request
 
18
# across to run on the server.
 
19
 
 
20
from cStringIO import StringIO
 
21
from urlparse import urlparse
 
22
 
 
23
from bzrlib import branch, errors, lockdir, repository
 
24
from bzrlib.branch import BranchReferenceFormat
 
25
from bzrlib.bzrdir import BzrDir, BzrDirFormat, RemoteBzrDirFormat
 
26
from bzrlib.config import BranchConfig, TreeConfig
 
27
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
28
from bzrlib.errors import NoSuchRevision
 
29
from bzrlib.lockable_files import LockableFiles
 
30
from bzrlib.revision import NULL_REVISION
 
31
from bzrlib.smart import client, vfs
 
32
from bzrlib.urlutils import unescape
 
33
 
 
34
# Note: RemoteBzrDirFormat is in bzrdir.py
 
35
 
 
36
class RemoteBzrDir(BzrDir):
 
37
    """Control directory on a remote server, accessed by HPSS."""
 
38
 
 
39
    def __init__(self, transport, _client=None):
 
40
        """Construct a RemoteBzrDir.
 
41
 
 
42
        :param _client: Private parameter for testing. Disables probing and the
 
43
            use of a real bzrdir.
 
44
        """
 
45
        BzrDir.__init__(self, transport, RemoteBzrDirFormat())
 
46
        # this object holds a delegated bzrdir that uses file-level operations
 
47
        # to talk to the other side
 
48
        # XXX: We should go into find_format, but not allow it to find
 
49
        # RemoteBzrDirFormat and make sure it finds the real underlying format.
 
50
        self._real_bzrdir = None
 
51
 
 
52
        if _client is None:
 
53
            self._medium = transport.get_smart_client()
 
54
            self._client = client.SmartClient(self._medium)
 
55
        else:
 
56
            self._client = _client
 
57
            self._medium = None
 
58
            return
 
59
 
 
60
        self._ensure_real()
 
61
        path = self._path_for_remote_call(self._client)
 
62
        #self._real_bzrdir._format.probe_transport(transport)
 
63
        response = self._client.call('probe_dont_use', path)
 
64
        if response == ('no',):
 
65
            raise errors.NotBranchError(path=transport.base)
 
66
 
 
67
    def _ensure_real(self):
 
68
        """Ensure that there is a _real_bzrdir set.
 
69
 
 
70
        used before calls to self._real_bzrdir.
 
71
        """
 
72
        if not self._real_bzrdir:
 
73
            default_format = BzrDirFormat.get_default_format()
 
74
            self._real_bzrdir = default_format.open(self.root_transport,
 
75
                _found=True)
 
76
 
 
77
    def create_repository(self, shared=False):
 
78
        self._real_bzrdir.create_repository(shared=shared)
 
79
        return self.open_repository()
 
80
 
 
81
    def create_branch(self):
 
82
        real_branch = self._real_bzrdir.create_branch()
 
83
        return RemoteBranch(self, self.find_repository(), real_branch)
 
84
 
 
85
    def create_workingtree(self, revision_id=None):
 
86
        real_workingtree = self._real_bzrdir.create_workingtree(revision_id=revision_id)
 
87
        return RemoteWorkingTree(self, real_workingtree)
 
88
 
 
89
    def find_branch_format(self):
 
90
        """Find the branch 'format' for this bzrdir.
 
91
 
 
92
        This might be a synthetic object for e.g. RemoteBranch and SVN.
 
93
        """
 
94
        b = self.open_branch()
 
95
        return b._format
 
96
 
 
97
    def get_branch_reference(self):
 
98
        """See BzrDir.get_branch_reference()."""
 
99
        path = self._path_for_remote_call(self._client)
 
100
        response = self._client.call('BzrDir.open_branch', path)
 
101
        if response[0] == 'ok':
 
102
            if response[1] == '':
 
103
                # branch at this location.
 
104
                return None
 
105
            else:
 
106
                # a branch reference, use the existing BranchReference logic.
 
107
                return response[1]
 
108
        elif response == ('nobranch',):
 
109
            raise errors.NotBranchError(path=self.root_transport.base)
 
110
        else:
 
111
            assert False, 'unexpected response code %r' % (response,)
 
112
 
 
113
    def open_branch(self, _unsupported=False):
 
114
        assert _unsupported == False, 'unsupported flag support not implemented yet.'
 
115
        reference_url = self.get_branch_reference()
 
116
        if reference_url is None:
 
117
            # branch at this location.
 
118
            return RemoteBranch(self, self.find_repository())
 
119
        else:
 
120
            # a branch reference, use the existing BranchReference logic.
 
121
            format = BranchReferenceFormat()
 
122
            return format.open(self, _found=True, location=reference_url)
 
123
                
 
124
    def open_repository(self):
 
125
        path = self._path_for_remote_call(self._client)
 
126
        response = self._client.call('BzrDir.find_repository', path)
 
127
        assert response[0] in ('ok', 'norepository'), \
 
128
            'unexpected response code %s' % (response,)
 
129
        if response[0] == 'norepository':
 
130
            raise errors.NoRepositoryPresent(self)
 
131
        assert len(response) == 4, 'incorrect response length %s' % (response,)
 
132
        if response[1] == '':
 
133
            format = RemoteRepositoryFormat()
 
134
            format.rich_root_data = response[2] == 'True'
 
135
            format.support_tree_reference = response[3] == 'True'
 
136
            return RemoteRepository(self, format)
 
137
        else:
 
138
            raise errors.NoRepositoryPresent(self)
 
139
 
 
140
    def open_workingtree(self):
 
141
        raise errors.NotLocalUrl(self.root_transport)
 
142
 
 
143
    def _path_for_remote_call(self, client):
 
144
        """Return the path to be used for this bzrdir in a remote call."""
 
145
        return client.remote_path_from_transport(self.root_transport)
 
146
 
 
147
    def get_branch_transport(self, branch_format):
 
148
        return self._real_bzrdir.get_branch_transport(branch_format)
 
149
 
 
150
    def get_repository_transport(self, repository_format):
 
151
        return self._real_bzrdir.get_repository_transport(repository_format)
 
152
 
 
153
    def get_workingtree_transport(self, workingtree_format):
 
154
        return self._real_bzrdir.get_workingtree_transport(workingtree_format)
 
155
 
 
156
    def can_convert_format(self):
 
157
        """Upgrading of remote bzrdirs is not supported yet."""
 
158
        return False
 
159
 
 
160
    def needs_format_conversion(self, format=None):
 
161
        """Upgrading of remote bzrdirs is not supported yet."""
 
162
        return False
 
163
 
 
164
    def clone(self, url, revision_id=None, basis=None, force_new_repo=False):
 
165
        self._ensure_real()
 
166
        return self._real_bzrdir.clone(url, revision_id=revision_id,
 
167
            basis=basis, force_new_repo=force_new_repo)
 
168
 
 
169
    #def sprout(self, url, revision_id=None, basis=None, force_new_repo=False):
 
170
    #    self._ensure_real()
 
171
    #    return self._real_bzrdir.sprout(url, revision_id=revision_id,
 
172
    #        basis=basis, force_new_repo=force_new_repo)
 
173
 
 
174
 
 
175
class RemoteRepositoryFormat(repository.RepositoryFormat):
 
176
    """Format for repositories accessed over a SmartClient.
 
177
 
 
178
    Instances of this repository are represented by RemoteRepository
 
179
    instances.
 
180
 
 
181
    The RemoteRepositoryFormat is parameterised during construction
 
182
    to reflect the capabilities of the real, remote format. Specifically
 
183
    the attributes rich_root_data and support_tree_reference are set
 
184
    on a per instance basis, and are not set (and should not be) at
 
185
    the class level.
 
186
    """
 
187
 
 
188
    _matchingbzrdir = RemoteBzrDirFormat
 
189
 
 
190
    def initialize(self, a_bzrdir, shared=False):
 
191
        assert isinstance(a_bzrdir, RemoteBzrDir)
 
192
        return a_bzrdir.create_repository(shared=shared)
 
193
    
 
194
    def open(self, a_bzrdir):
 
195
        assert isinstance(a_bzrdir, RemoteBzrDir)
 
196
        return a_bzrdir.open_repository()
 
197
 
 
198
    def get_format_description(self):
 
199
        return 'bzr remote repository'
 
200
 
 
201
    def __eq__(self, other):
 
202
        return self.__class__ == other.__class__
 
203
 
 
204
    def check_conversion_target(self, target_format):
 
205
        if self.rich_root_data and not target_format.rich_root_data:
 
206
            raise errors.BadConversionTarget(
 
207
                'Does not support rich root data.', target_format)
 
208
        if (self.support_tree_reference and
 
209
            not getattr(target_format, 'support_tree_reference', False)):
 
210
            raise errors.BadConversionTarget(
 
211
                'Does not support nested trees', target_format)
 
212
 
 
213
 
 
214
class RemoteRepository(object):
 
215
    """Repository accessed over rpc.
 
216
 
 
217
    For the moment everything is delegated to IO-like operations over
 
218
    the transport.
 
219
    """
 
220
 
 
221
    def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
 
222
        """Create a RemoteRepository instance.
 
223
        
 
224
        :param remote_bzrdir: The bzrdir hosting this repository.
 
225
        :param format: The RemoteFormat object to use.
 
226
        :param real_repository: If not None, a local implementation of the
 
227
            repository logic for the repository, usually accessing the data
 
228
            via the VFS.
 
229
        :param _client: Private testing parameter - override the smart client
 
230
            to be used by the repository.
 
231
        """
 
232
        if real_repository:
 
233
            self._real_repository = real_repository
 
234
        else:
 
235
            self._real_repository = None
 
236
        self.bzrdir = remote_bzrdir
 
237
        if _client is None:
 
238
            self._client = client.SmartClient(self.bzrdir._medium)
 
239
        else:
 
240
            self._client = _client
 
241
        self._format = format
 
242
        self._lock_mode = None
 
243
        self._lock_token = None
 
244
        self._lock_count = 0
 
245
        self._leave_lock = False
 
246
 
 
247
    def _ensure_real(self):
 
248
        """Ensure that there is a _real_repository set.
 
249
 
 
250
        used before calls to self._real_repository.
 
251
        """
 
252
        if not self._real_repository:
 
253
            self.bzrdir._ensure_real()
 
254
            #self._real_repository = self.bzrdir._real_bzrdir.open_repository()
 
255
            self._set_real_repository(self.bzrdir._real_bzrdir.open_repository())
 
256
 
 
257
    def get_revision_graph(self, revision_id=None):
 
258
        """See Repository.get_revision_graph()."""
 
259
        if revision_id is None:
 
260
            revision_id = ''
 
261
        elif revision_id == NULL_REVISION:
 
262
            return {}
 
263
 
 
264
        path = self.bzrdir._path_for_remote_call(self._client)
 
265
        assert type(revision_id) is str
 
266
        response = self._client.call2(
 
267
            'Repository.get_revision_graph', path, revision_id)
 
268
        assert response[0][0] in ('ok', 'nosuchrevision'), 'unexpected response code %s' % (response[0],)
 
269
        if response[0][0] == 'ok':
 
270
            coded = response[1].read_body_bytes()
 
271
            if coded == '':
 
272
                # no revisions in this repository!
 
273
                return {}
 
274
            lines = coded.split('\n')
 
275
            revision_graph = {}
 
276
            # FIXME
 
277
            for line in lines:
 
278
                d = list(line.split())
 
279
                revision_graph[d[0]] = d[1:]
 
280
                
 
281
            return revision_graph
 
282
        else:
 
283
            response_body = response[1].read_body_bytes()
 
284
            assert response_body == ''
 
285
            raise NoSuchRevision(self, revision_id)
 
286
 
 
287
    def has_revision(self, revision_id):
 
288
        """See Repository.has_revision()."""
 
289
        if revision_id is None:
 
290
            # The null revision is always present.
 
291
            return True
 
292
        path = self.bzrdir._path_for_remote_call(self._client)
 
293
        response = self._client.call('Repository.has_revision', path, revision_id)
 
294
        assert response[0] in ('ok', 'no'), 'unexpected response code %s' % (response,)
 
295
        return response[0] == 'ok'
 
296
 
 
297
    def gather_stats(self, revid=None, committers=None):
 
298
        """See Repository.gather_stats()."""
 
299
        path = self.bzrdir._path_for_remote_call(self._client)
 
300
        if revid in (None, NULL_REVISION):
 
301
            fmt_revid = ''
 
302
        else:
 
303
            fmt_revid = revid
 
304
        if committers is None or not committers:
 
305
            fmt_committers = 'no'
 
306
        else:
 
307
            fmt_committers = 'yes'
 
308
        response = self._client.call2('Repository.gather_stats', path,
 
309
                                      fmt_revid, fmt_committers)
 
310
        assert response[0][0] == 'ok', \
 
311
            'unexpected response code %s' % (response[0],)
 
312
 
 
313
        body = response[1].read_body_bytes()
 
314
        result = {}
 
315
        for line in body.split('\n'):
 
316
            if not line:
 
317
                continue
 
318
            key, val_text = line.split(':')
 
319
            if key in ('revisions', 'size', 'committers'):
 
320
                result[key] = int(val_text)
 
321
            elif key in ('firstrev', 'latestrev'):
 
322
                values = val_text.split(' ')[1:]
 
323
                result[key] = (float(values[0]), long(values[1]))
 
324
 
 
325
        return result
 
326
 
 
327
    def get_physical_lock_status(self):
 
328
        """See Repository.get_physical_lock_status()."""
 
329
        return False
 
330
 
 
331
    def is_shared(self):
 
332
        """See Repository.is_shared()."""
 
333
        path = self.bzrdir._path_for_remote_call(self._client)
 
334
        response = self._client.call('Repository.is_shared', path)
 
335
        assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
 
336
        return response[0] == 'yes'
 
337
 
 
338
    def lock_read(self):
 
339
        # wrong eventually - want a local lock cache context
 
340
        if not self._lock_mode:
 
341
            self._lock_mode = 'r'
 
342
            self._lock_count = 1
 
343
            if self._real_repository is not None:
 
344
                self._real_repository.lock_read()
 
345
        else:
 
346
            self._lock_count += 1
 
347
 
 
348
    def _remote_lock_write(self, token):
 
349
        path = self.bzrdir._path_for_remote_call(self._client)
 
350
        if token is None:
 
351
            token = ''
 
352
        response = self._client.call('Repository.lock_write', path, token)
 
353
        if response[0] == 'ok':
 
354
            ok, token = response
 
355
            return token
 
356
        elif response[0] == 'LockContention':
 
357
            raise errors.LockContention('(remote lock)')
 
358
        elif response[0] == 'UnlockableTransport':
 
359
            raise errors.UnlockableTransport(self.bzrdir.root_transport)
 
360
        else:
 
361
            assert False, 'unexpected response code %s' % (response,)
 
362
 
 
363
    def lock_write(self, token=None):
 
364
        if not self._lock_mode:
 
365
            self._lock_token = self._remote_lock_write(token)
 
366
            assert self._lock_token, 'Remote server did not return a token!'
 
367
            if self._real_repository is not None:
 
368
                self._real_repository.lock_write(token=self._lock_token)
 
369
            if token is not None:
 
370
                self._leave_lock = True
 
371
            else:
 
372
                self._leave_lock = False
 
373
            self._lock_mode = 'w'
 
374
            self._lock_count = 1
 
375
        elif self._lock_mode == 'r':
 
376
            raise errors.ReadOnlyError(self)
 
377
        else:
 
378
            self._lock_count += 1
 
379
        return self._lock_token
 
380
 
 
381
    def leave_lock_in_place(self):
 
382
        self._leave_lock = True
 
383
 
 
384
    def dont_leave_lock_in_place(self):
 
385
        self._leave_lock = False
 
386
 
 
387
    def _set_real_repository(self, repository):
 
388
        """Set the _real_repository for this repository.
 
389
 
 
390
        :param repository: The repository to fallback to for non-hpss
 
391
            implemented operations.
 
392
        """
 
393
        assert not isinstance(repository, RemoteRepository)
 
394
        self._real_repository = repository
 
395
        if self._lock_mode == 'w':
 
396
            # if we are already locked, the real repository must be able to
 
397
            # acquire the lock with our token.
 
398
            self._real_repository.lock_write(self._lock_token)
 
399
        elif self._lock_mode == 'r':
 
400
            self._real_repository.lock_read()
 
401
 
 
402
    def _unlock(self, token):
 
403
        path = self.bzrdir._path_for_remote_call(self._client)
 
404
        response = self._client.call('Repository.unlock', path, token)
 
405
        if response == ('ok',):
 
406
            return
 
407
        elif response[0] == 'TokenMismatch':
 
408
            raise errors.TokenMismatch(token, '(remote token)')
 
409
        else:
 
410
            assert False, 'unexpected response code %s' % (response,)
 
411
 
 
412
    def unlock(self):
 
413
        self._lock_count -= 1
 
414
        if not self._lock_count:
 
415
            mode = self._lock_mode
 
416
            self._lock_mode = None
 
417
            if self._real_repository is not None:
 
418
                self._real_repository.unlock()
 
419
            if mode != 'w':
 
420
                return
 
421
            assert self._lock_token, 'Locked, but no token!'
 
422
            token = self._lock_token
 
423
            self._lock_token = None
 
424
            if not self._leave_lock:
 
425
                self._unlock(token)
 
426
 
 
427
    def break_lock(self):
 
428
        # should hand off to the network
 
429
        self._ensure_real()
 
430
        return self._real_repository.break_lock()
 
431
 
 
432
    ### These methods are just thin shims to the VFS object for now.
 
433
 
 
434
    def revision_tree(self, revision_id):
 
435
        self._ensure_real()
 
436
        return self._real_repository.revision_tree(revision_id)
 
437
 
 
438
    def get_commit_builder(self, branch, parents, config, timestamp=None,
 
439
                           timezone=None, committer=None, revprops=None,
 
440
                           revision_id=None):
 
441
        # FIXME: It ought to be possible to call this without immediately
 
442
        # triggering _ensure_real.  For now it's the easiest thing to do.
 
443
        self._ensure_real()
 
444
        builder = self._real_repository.get_commit_builder(branch, parents,
 
445
                config, timestamp=timestamp, timezone=timezone,
 
446
                committer=committer, revprops=revprops, revision_id=revision_id)
 
447
        # Make the builder use this RemoteRepository rather than the real one.
 
448
        builder.repository = self
 
449
        return builder
 
450
 
 
451
    @needs_write_lock
 
452
    def add_inventory(self, revid, inv, parents):
 
453
        self._ensure_real()
 
454
        return self._real_repository.add_inventory(revid, inv, parents)
 
455
 
 
456
    @needs_write_lock
 
457
    def add_revision(self, rev_id, rev, inv=None, config=None):
 
458
        self._ensure_real()
 
459
        return self._real_repository.add_revision(
 
460
            rev_id, rev, inv=inv, config=config)
 
461
 
 
462
    @needs_read_lock
 
463
    def get_inventory(self, revision_id):
 
464
        self._ensure_real()
 
465
        return self._real_repository.get_inventory(revision_id)
 
466
 
 
467
    @needs_read_lock
 
468
    def get_revision(self, revision_id):
 
469
        self._ensure_real()
 
470
        return self._real_repository.get_revision(revision_id)
 
471
 
 
472
    @property
 
473
    def weave_store(self):
 
474
        self._ensure_real()
 
475
        return self._real_repository.weave_store
 
476
 
 
477
    def get_transaction(self):
 
478
        self._ensure_real()
 
479
        return self._real_repository.get_transaction()
 
480
 
 
481
    @needs_read_lock
 
482
    def clone(self, a_bzrdir, revision_id=None, basis=None):
 
483
        self._ensure_real()
 
484
        return self._real_repository.clone(
 
485
            a_bzrdir, revision_id=revision_id, basis=basis)
 
486
 
 
487
    def make_working_trees(self):
 
488
        """RemoteRepositories never create working trees by default."""
 
489
        return False
 
490
 
 
491
    def fetch(self, source, revision_id=None, pb=None):
 
492
        self._ensure_real()
 
493
        return self._real_repository.fetch(
 
494
            source, revision_id=revision_id, pb=pb)
 
495
 
 
496
    @property
 
497
    def control_weaves(self):
 
498
        self._ensure_real()
 
499
        return self._real_repository.control_weaves
 
500
 
 
501
    @needs_read_lock
 
502
    def get_ancestry(self, revision_id):
 
503
        self._ensure_real()
 
504
        return self._real_repository.get_ancestry(revision_id)
 
505
 
 
506
    @needs_read_lock
 
507
    def get_inventory_weave(self):
 
508
        self._ensure_real()
 
509
        return self._real_repository.get_inventory_weave()
 
510
 
 
511
    def fileids_altered_by_revision_ids(self, revision_ids):
 
512
        self._ensure_real()
 
513
        return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
 
514
 
 
515
    @needs_read_lock
 
516
    def get_signature_text(self, revision_id):
 
517
        self._ensure_real()
 
518
        return self._real_repository.get_signature_text(revision_id)
 
519
 
 
520
    @needs_read_lock
 
521
    def get_revision_graph_with_ghosts(self, revision_ids=None):
 
522
        self._ensure_real()
 
523
        return self._real_repository.get_revision_graph_with_ghosts(
 
524
            revision_ids=revision_ids)
 
525
 
 
526
    @needs_read_lock
 
527
    def get_inventory_xml(self, revision_id):
 
528
        self._ensure_real()
 
529
        return self._real_repository.get_inventory_xml(revision_id)
 
530
 
 
531
    def deserialise_inventory(self, revision_id, xml):
 
532
        self._ensure_real()
 
533
        return self._real_repository.deserialise_inventory(revision_id, xml)
 
534
 
 
535
    def reconcile(self, other=None, thorough=False):
 
536
        self._ensure_real()
 
537
        return self._real_repository.reconcile(other=other, thorough=thorough)
 
538
        
 
539
    def all_revision_ids(self):
 
540
        self._ensure_real()
 
541
        return self._real_repository.all_revision_ids()
 
542
    
 
543
    @needs_read_lock
 
544
    def get_deltas_for_revisions(self, revisions):
 
545
        self._ensure_real()
 
546
        return self._real_repository.get_deltas_for_revisions(revisions)
 
547
 
 
548
    @needs_read_lock
 
549
    def get_revision_delta(self, revision_id):
 
550
        self._ensure_real()
 
551
        return self._real_repository.get_revision_delta(revision_id)
 
552
 
 
553
    @needs_read_lock
 
554
    def revision_trees(self, revision_ids):
 
555
        self._ensure_real()
 
556
        return self._real_repository.revision_trees(revision_ids)
 
557
 
 
558
    @needs_read_lock
 
559
    def get_revision_reconcile(self, revision_id):
 
560
        self._ensure_real()
 
561
        return self._real_repository.get_revision_reconcile(revision_id)
 
562
 
 
563
    @needs_read_lock
 
564
    def check(self, revision_ids):
 
565
        self._ensure_real()
 
566
        return self._real_repository.check(revision_ids)
 
567
 
 
568
    def copy_content_into(self, destination, revision_id=None, basis=None):
 
569
        self._ensure_real()
 
570
        return self._real_repository.copy_content_into(
 
571
            destination, revision_id=revision_id, basis=basis)
 
572
 
 
573
    def set_make_working_trees(self, new_value):
 
574
        raise NotImplementedError(self.set_make_working_trees)
 
575
 
 
576
    @needs_write_lock
 
577
    def sign_revision(self, revision_id, gpg_strategy):
 
578
        self._ensure_real()
 
579
        return self._real_repository.sign_revision(revision_id, gpg_strategy)
 
580
 
 
581
    @needs_read_lock
 
582
    def get_revisions(self, revision_ids):
 
583
        self._ensure_real()
 
584
        return self._real_repository.get_revisions(revision_ids)
 
585
 
 
586
    def supports_rich_root(self):
 
587
        self._ensure_real()
 
588
        return self._real_repository.supports_rich_root()
 
589
 
 
590
    def iter_reverse_revision_history(self, revision_id):
 
591
        self._ensure_real()
 
592
        return self._real_repository.iter_reverse_revision_history(revision_id)
 
593
 
 
594
    @property
 
595
    def _serializer(self):
 
596
        self._ensure_real()
 
597
        return self._real_repository._serializer
 
598
 
 
599
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
 
600
        self._ensure_real()
 
601
        return self._real_repository.store_revision_signature(
 
602
            gpg_strategy, plaintext, revision_id)
 
603
 
 
604
    def has_signature_for_revision_id(self, revision_id):
 
605
        self._ensure_real()
 
606
        return self._real_repository.has_signature_for_revision_id(revision_id)
 
607
 
 
608
 
 
609
class RemoteBranchLockableFiles(LockableFiles):
 
610
    """A 'LockableFiles' implementation that talks to a smart server.
 
611
    
 
612
    This is not a public interface class.
 
613
    """
 
614
 
 
615
    def __init__(self, bzrdir, _client):
 
616
        self.bzrdir = bzrdir
 
617
        self._client = _client
 
618
        # XXX: This assumes that the branch control directory is .bzr/branch,
 
619
        # which isn't necessarily true.
 
620
        LockableFiles.__init__(
 
621
            self, bzrdir.root_transport.clone('.bzr/branch'),
 
622
            'lock', lockdir.LockDir)
 
623
 
 
624
    def get(self, path):
 
625
        """'get' a remote path as per the LockableFiles interface.
 
626
 
 
627
        :param path: the file to 'get'. If this is 'branch.conf', we do not
 
628
             just retrieve a file, instead we ask the smart server to generate
 
629
             a configuration for us - which is retrieved as an INI file.
 
630
        """
 
631
        if path == 'branch.conf':
 
632
            path = self.bzrdir._path_for_remote_call(self._client)
 
633
            response = self._client.call2('Branch.get_config_file', path)
 
634
            assert response[0][0] == 'ok', \
 
635
                'unexpected response code %s' % (response[0],)
 
636
            return StringIO(response[1].read_body_bytes())
 
637
        else:
 
638
            # VFS fallback.
 
639
            return LockableFiles.get(self, path)
 
640
 
 
641
 
 
642
class RemoteBranchFormat(branch.BranchFormat):
 
643
 
 
644
    def __eq__(self, other):
 
645
        return (isinstance(other, RemoteBranchFormat) and 
 
646
            self.__dict__ == other.__dict__)
 
647
 
 
648
    def get_format_description(self):
 
649
        return 'Remote BZR Branch'
 
650
 
 
651
    def get_format_string(self):
 
652
        return 'Remote BZR Branch'
 
653
 
 
654
    def open(self, a_bzrdir):
 
655
        assert isinstance(a_bzrdir, RemoteBzrDir)
 
656
        return a_bzrdir.open_branch()
 
657
 
 
658
    def initialize(self, a_bzrdir):
 
659
        assert isinstance(a_bzrdir, RemoteBzrDir)
 
660
        return a_bzrdir.create_branch()
 
661
 
 
662
 
 
663
class RemoteBranch(branch.Branch):
 
664
    """Branch stored on a server accessed by HPSS RPC.
 
665
 
 
666
    At the moment most operations are mapped down to simple file operations.
 
667
    """
 
668
 
 
669
    def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
 
670
        _client=None):
 
671
        """Create a RemoteBranch instance.
 
672
 
 
673
        :param real_branch: An optional local implementation of the branch
 
674
            format, usually accessing the data via the VFS.
 
675
        :param _client: Private parameter for testing.
 
676
        """
 
677
        #branch.Branch.__init__(self)
 
678
        self._revision_history_cache = None
 
679
        self.bzrdir = remote_bzrdir
 
680
        if _client is not None:
 
681
            self._client = _client
 
682
        else:
 
683
            self._client = client.SmartClient(self.bzrdir._medium)
 
684
        self.repository = remote_repository
 
685
        if real_branch is not None:
 
686
            self._real_branch = real_branch
 
687
            # Give the remote repository the matching real repo.
 
688
            real_repo = self._real_branch.repository
 
689
            if isinstance(real_repo, RemoteRepository):
 
690
                real_repo._ensure_real()
 
691
                real_repo = real_repo._real_repository
 
692
            self.repository._set_real_repository(real_repo)
 
693
            # Give the branch the remote repository to let fast-pathing happen.
 
694
            self._real_branch.repository = self.repository
 
695
        else:
 
696
            self._real_branch = None
 
697
        # Fill out expected attributes of branch for bzrlib api users.
 
698
        self._format = RemoteBranchFormat()
 
699
        self.base = self.bzrdir.root_transport.base
 
700
        self.control_files = RemoteBranchLockableFiles(self.bzrdir, self._client)
 
701
        self._lock_mode = None
 
702
        self._lock_token = None
 
703
        self._lock_count = 0
 
704
        self._leave_lock = False
 
705
 
 
706
    def _ensure_real(self):
 
707
        """Ensure that there is a _real_branch set.
 
708
 
 
709
        used before calls to self._real_branch.
 
710
        """
 
711
        if not self._real_branch:
 
712
            assert vfs.vfs_enabled()
 
713
            self.bzrdir._ensure_real()
 
714
            self._real_branch = self.bzrdir._real_bzrdir.open_branch()
 
715
            # Give the remote repository the matching real repo.
 
716
            real_repo = self._real_branch.repository
 
717
            if isinstance(real_repo, RemoteRepository):
 
718
                real_repo._ensure_real()
 
719
                real_repo = real_repo._real_repository
 
720
            self.repository._set_real_repository(real_repo)
 
721
            # Give the branch the remote repository to let fast-pathing happen.
 
722
            self._real_branch.repository = self.repository
 
723
            # XXX: deal with _lock_mode == 'w'
 
724
            if self._lock_mode == 'r':
 
725
                self._real_branch.lock_read()
 
726
 
 
727
    def get_physical_lock_status(self):
 
728
        """See Branch.get_physical_lock_status()."""
 
729
        # should be an API call to the server, as branches must be lockable.
 
730
        self._ensure_real()
 
731
        return self._real_branch.get_physical_lock_status()
 
732
 
 
733
    def lock_read(self):
 
734
        if not self._lock_mode:
 
735
            self._lock_mode = 'r'
 
736
            self._lock_count = 1
 
737
            if self._real_branch is not None:
 
738
                self._real_branch.lock_read()
 
739
        else:
 
740
            self._lock_count += 1
 
741
 
 
742
    def _remote_lock_write(self, tokens):
 
743
        if tokens is None:
 
744
            branch_token = repo_token = ''
 
745
        else:
 
746
            branch_token, repo_token = tokens
 
747
        path = self.bzrdir._path_for_remote_call(self._client)
 
748
        response = self._client.call('Branch.lock_write', path, branch_token,
 
749
                                     repo_token)
 
750
        if response[0] == 'ok':
 
751
            ok, branch_token, repo_token = response
 
752
            return branch_token, repo_token
 
753
        elif response[0] == 'LockContention':
 
754
            raise errors.LockContention('(remote lock)')
 
755
        elif response[0] == 'TokenMismatch':
 
756
            raise errors.TokenMismatch(tokens, '(remote tokens)')
 
757
        elif response[0] == 'UnlockableTransport':
 
758
            raise errors.UnlockableTransport(self.bzrdir.root_transport)
 
759
        elif response[0] == 'ReadOnlyError':
 
760
            raise errors.ReadOnlyError(self)
 
761
        else:
 
762
            assert False, 'unexpected response code %r' % (response,)
 
763
            
 
764
    def lock_write(self, tokens=None):
 
765
        if not self._lock_mode:
 
766
            remote_tokens = self._remote_lock_write(tokens)
 
767
            self._lock_token, self._repo_lock_token = remote_tokens
 
768
            assert self._lock_token, 'Remote server did not return a token!'
 
769
            # TODO: We really, really, really don't want to call _ensure_real
 
770
            # here, but it's the easiest way to ensure coherency between the
 
771
            # state of the RemoteBranch and RemoteRepository objects and the
 
772
            # physical locks.  If we don't materialise the real objects here,
 
773
            # then getting everything in the right state later is complex, so
 
774
            # for now we just do it the lazy way.
 
775
            #   -- Andrew Bennetts, 2007-02-22.
 
776
            self._ensure_real()
 
777
            if self._real_branch is not None:
 
778
                self._real_branch.lock_write(tokens=remote_tokens)
 
779
            if tokens is not None:
 
780
                self._leave_lock = True
 
781
            else:
 
782
                # XXX: this case seems to be unreachable; tokens cannot be None.
 
783
                self._leave_lock = False
 
784
            self._lock_mode = 'w'
 
785
            self._lock_count = 1
 
786
        elif self._lock_mode == 'r':
 
787
            raise errors.ReadOnlyTransaction
 
788
        else:
 
789
            if tokens is not None:
 
790
                # Tokens were given to lock_write, and we're relocking, so check
 
791
                # that the given tokens actually match the ones we already have.
 
792
                held_tokens = (self._lock_token, self._repo_lock_token)
 
793
                if tokens != held_tokens:
 
794
                    raise errors.TokenMismatch(str(tokens), str(held_tokens))
 
795
            self._lock_count += 1
 
796
        return self._lock_token, self._repo_lock_token
 
797
 
 
798
    def _unlock(self, branch_token, repo_token):
 
799
        path = self.bzrdir._path_for_remote_call(self._client)
 
800
        response = self._client.call('Branch.unlock', path, branch_token,
 
801
                                     repo_token)
 
802
        if response == ('ok',):
 
803
            return
 
804
        elif response[0] == 'TokenMismatch':
 
805
            raise errors.TokenMismatch(
 
806
                str((branch_token, repo_token)), '(remote tokens)')
 
807
        else:
 
808
            assert False, 'unexpected response code %s' % (response,)
 
809
 
 
810
    def unlock(self):
 
811
        self._lock_count -= 1
 
812
        if not self._lock_count:
 
813
            self._clear_cached_state()
 
814
            mode = self._lock_mode
 
815
            self._lock_mode = None
 
816
            if self._real_branch is not None:
 
817
                if not self._leave_lock:
 
818
                    # If this RemoteBranch will remove the physical lock for the
 
819
                    # repository, make sure the _real_branch doesn't do it
 
820
                    # first.  (Because the _real_branch's repository is set to
 
821
                    # be the RemoteRepository.)
 
822
                    self._real_branch.repository.leave_lock_in_place()
 
823
                self._real_branch.unlock()
 
824
            if mode != 'w':
 
825
                return
 
826
            assert self._lock_token, 'Locked, but no token!'
 
827
            branch_token = self._lock_token
 
828
            repo_token = self._repo_lock_token
 
829
            self._lock_token = None
 
830
            self._repo_lock_token = None
 
831
            if not self._leave_lock:
 
832
                self._unlock(branch_token, repo_token)
 
833
 
 
834
    def break_lock(self):
 
835
        self._ensure_real()
 
836
        return self._real_branch.break_lock()
 
837
 
 
838
    def leave_lock_in_place(self):
 
839
        self._leave_lock = True
 
840
 
 
841
    def dont_leave_lock_in_place(self):
 
842
        self._leave_lock = False
 
843
 
 
844
    def last_revision_info(self):
 
845
        """See Branch.last_revision_info()."""
 
846
        path = self.bzrdir._path_for_remote_call(self._client)
 
847
        response = self._client.call('Branch.last_revision_info', path)
 
848
        assert response[0] == 'ok', 'unexpected response code %s' % (response,)
 
849
        revno = int(response[1])
 
850
        last_revision = response[2]
 
851
        if last_revision == '':
 
852
            last_revision = NULL_REVISION
 
853
        return (revno, last_revision)
 
854
 
 
855
    def _gen_revision_history(self):
 
856
        """See Branch._gen_revision_history()."""
 
857
        path = self.bzrdir._path_for_remote_call(self._client)
 
858
        response = self._client.call2('Branch.revision_history', path)
 
859
        assert response[0][0] == 'ok', 'unexpected response code %s' % (response[0],)
 
860
        result = response[1].read_body_bytes().split('\x00')
 
861
        if result == ['']:
 
862
            return []
 
863
        return result
 
864
 
 
865
    @needs_write_lock
 
866
    def set_revision_history(self, rev_history):
 
867
        # Send just the tip revision of the history; the server will generate
 
868
        # the full history from that.  If the revision doesn't exist in this
 
869
        # branch, NoSuchRevision will be raised.
 
870
        path = self.bzrdir._path_for_remote_call(self._client)
 
871
        if rev_history == []:
 
872
            rev_id = ''
 
873
        else:
 
874
            rev_id = rev_history[-1]
 
875
        response = self._client.call('Branch.set_last_revision',
 
876
            path, self._lock_token, self._repo_lock_token, rev_id)
 
877
        if response[0] == 'NoSuchRevision':
 
878
            raise NoSuchRevision(self, rev_id)
 
879
        else:
 
880
            assert response == ('ok',), (
 
881
                'unexpected response code %r' % (response,))
 
882
        self._cache_revision_history(rev_history)
 
883
 
 
884
    def get_parent(self):
 
885
        self._ensure_real()
 
886
        return self._real_branch.get_parent()
 
887
        
 
888
    def set_parent(self, url):
 
889
        self._ensure_real()
 
890
        return self._real_branch.set_parent(url)
 
891
        
 
892
    def get_config(self):
 
893
        return RemoteBranchConfig(self)
 
894
 
 
895
    def sprout(self, to_bzrdir, revision_id=None):
 
896
        # Like Branch.sprout, except that it sprouts a branch in the default
 
897
        # format, because RemoteBranches can't be created at arbitrary URLs.
 
898
        # XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
 
899
        # to_bzrdir.create_branch...
 
900
        self._ensure_real()
 
901
        result = branch.BranchFormat.get_default_format().initialize(to_bzrdir)
 
902
        self._real_branch.copy_content_into(result, revision_id=revision_id)
 
903
        result.set_parent(self.bzrdir.root_transport.base)
 
904
        return result
 
905
 
 
906
    @needs_write_lock
 
907
    def append_revision(self, *revision_ids):
 
908
        self._ensure_real()
 
909
        return self._real_branch.append_revision(*revision_ids)
 
910
 
 
911
    @needs_write_lock
 
912
    def pull(self, source, overwrite=False, stop_revision=None):
 
913
        self._ensure_real()
 
914
        self._real_branch.pull(
 
915
            source, overwrite=overwrite, stop_revision=stop_revision)
 
916
 
 
917
    @needs_read_lock
 
918
    def push(self, target, overwrite=False, stop_revision=None):
 
919
        self._ensure_real()
 
920
        return self._real_branch.push(
 
921
            target, overwrite=overwrite, stop_revision=stop_revision)
 
922
 
 
923
    def is_locked(self):
 
924
        return self._lock_count >= 1
 
925
 
 
926
    def set_last_revision_info(self, revno, revision_id):
 
927
        self._ensure_real()
 
928
        self._clear_cached_state()
 
929
        return self._real_branch.set_last_revision_info(revno, revision_id)
 
930
 
 
931
    def generate_revision_history(self, revision_id, last_rev=None,
 
932
                                  other_branch=None):
 
933
        self._ensure_real()
 
934
        return self._real_branch.generate_revision_history(
 
935
            revision_id, last_rev=last_rev, other_branch=other_branch)
 
936
 
 
937
    @property
 
938
    def tags(self):
 
939
        self._ensure_real()
 
940
        return self._real_branch.tags
 
941
 
 
942
    def set_push_location(self, location):
 
943
        self._ensure_real()
 
944
        return self._real_branch.set_push_location(location)
 
945
 
 
946
    def update_revisions(self, other, stop_revision=None):
 
947
        self._ensure_real()
 
948
        return self._real_branch.update_revisions(
 
949
            other, stop_revision=stop_revision)
 
950
 
 
951
 
 
952
class RemoteBranchConfig(BranchConfig):
 
953
 
 
954
    def username(self):
 
955
        self.branch._ensure_real()
 
956
        return self.branch._real_branch.get_config().username()
 
957
 
 
958
    def _get_branch_data_config(self):
 
959
        self.branch._ensure_real()
 
960
        if self._branch_data_config is None:
 
961
            self._branch_data_config = TreeConfig(self.branch._real_branch)
 
962
        return self._branch_data_config
 
963