1
# Copyright (C) 2006, 2007 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
"""Server-side repository related request implmentations."""
33
from bzrlib.bzrdir import BzrDir
34
from bzrlib.smart.request import (
35
FailedSmartServerResponse,
37
SuccessfulSmartServerResponse,
39
from bzrlib.repository import _strip_NULL_ghosts, network_format_registry
40
from bzrlib import revision as _mod_revision
41
from bzrlib.util import bencode
42
from bzrlib.versionedfile import NetworkRecordStream, record_to_fulltext_bytes
45
class SmartServerRepositoryRequest(SmartServerRequest):
46
"""Common base class for Repository requests."""
48
def do(self, path, *args):
49
"""Execute a repository request.
51
All Repository requests take a path to the repository as their first
52
argument. The repository must be at the exact path given by the
53
client - no searching is done.
55
The actual logic is delegated to self.do_repository_request.
57
:param client_path: The path for the repository as received from the
59
:return: A SmartServerResponse from self.do_repository_request().
61
transport = self.transport_from_client_path(path)
62
bzrdir = BzrDir.open_from_transport(transport)
63
# Save the repository for use with do_body.
64
self._repository = bzrdir.open_repository()
65
return self.do_repository_request(self._repository, *args)
67
def do_repository_request(self, repository, *args):
68
"""Override to provide an implementation for a verb."""
69
# No-op for verbs that take bodies (None as a result indicates a body
73
def recreate_search(self, repository, recipe_bytes):
74
lines = recipe_bytes.split('\n')
75
start_keys = set(lines[0].split(' '))
76
exclude_keys = set(lines[1].split(' '))
77
revision_count = int(lines[2])
78
repository.lock_read()
80
search = repository.get_graph()._make_breadth_first_searcher(
84
next_revs = search.next()
87
search.stop_searching_any(exclude_keys.intersection(next_revs))
88
search_result = search.get_result()
89
if search_result.get_recipe()[2] != revision_count:
90
# we got back a different amount of data than expected, this
91
# gets reported as NoSuchRevision, because less revisions
92
# indicates missing revisions, and more should never happen as
93
# the excludes list considers ghosts and ensures that ghost
94
# filling races are not a problem.
95
return (None, FailedSmartServerResponse(('NoSuchRevision',)))
101
class SmartServerRepositoryReadLocked(SmartServerRepositoryRequest):
102
"""Calls self.do_readlocked_repository_request."""
104
def do_repository_request(self, repository, *args):
105
"""Read lock a repository for do_readlocked_repository_request."""
106
repository.lock_read()
108
return self.do_readlocked_repository_request(repository, *args)
113
class SmartServerRepositoryGetParentMap(SmartServerRepositoryRequest):
114
"""Bzr 1.2+ - get parent data for revisions during a graph search."""
116
no_extra_results = False
118
def do_repository_request(self, repository, *revision_ids):
119
"""Get parent details for some revisions.
121
All the parents for revision_ids are returned. Additionally up to 64KB
122
of additional parent data found by performing a breadth first search
123
from revision_ids is returned. The verb takes a body containing the
124
current search state, see do_body for details.
126
:param repository: The repository to query in.
127
:param revision_ids: The utf8 encoded revision_id to answer for.
129
self._revision_ids = revision_ids
130
return None # Signal that we want a body.
132
def do_body(self, body_bytes):
133
"""Process the current search state and perform the parent lookup.
135
:return: A smart server response where the body contains an utf8
136
encoded flattened list of the parents of the revisions (the same
137
format as Repository.get_revision_graph) which has been bz2
140
repository = self._repository
141
repository.lock_read()
143
return self._do_repository_request(body_bytes)
147
def _do_repository_request(self, body_bytes):
148
repository = self._repository
149
revision_ids = set(self._revision_ids)
150
search, error = self.recreate_search(repository, body_bytes)
151
if error is not None:
153
# TODO might be nice to start up the search again; but thats not
154
# written or tested yet.
155
client_seen_revs = set(search.get_result().get_keys())
156
# Always include the requested ids.
157
client_seen_revs.difference_update(revision_ids)
159
repo_graph = repository.get_graph()
163
next_revs = revision_ids
164
first_loop_done = False
166
queried_revs.update(next_revs)
167
parent_map = repo_graph.get_parent_map(next_revs)
169
for revision_id, parents in parent_map.iteritems():
170
# adjust for the wire
171
if parents == (_mod_revision.NULL_REVISION,):
173
# prepare the next query
174
next_revs.update(parents)
175
if revision_id not in client_seen_revs:
176
# Client does not have this revision, give it to it.
177
# add parents to the result
178
result[revision_id] = parents
179
# Approximate the serialized cost of this revision_id.
180
size_so_far += 2 + len(revision_id) + sum(map(len, parents))
181
# get all the directly asked for parents, and then flesh out to
182
# 64K (compressed) or so. We do one level of depth at a time to
183
# stay in sync with the client. The 250000 magic number is
184
# estimated compression ratio taken from bzr.dev itself.
185
if self.no_extra_results or (
186
first_loop_done and size_so_far > 250000):
189
# don't query things we've already queried
190
next_revs.difference_update(queried_revs)
191
first_loop_done = True
193
# sorting trivially puts lexographically similar revision ids together.
195
for revision, parents in sorted(result.items()):
196
lines.append(' '.join((revision, ) + tuple(parents)))
198
return SuccessfulSmartServerResponse(
199
('ok', ), bz2.compress('\n'.join(lines)))
202
class SmartServerRepositoryGetRevisionGraph(SmartServerRepositoryReadLocked):
204
def do_readlocked_repository_request(self, repository, revision_id):
205
"""Return the result of repository.get_revision_graph(revision_id).
207
Deprecated as of bzr 1.4, but supported for older clients.
209
:param repository: The repository to query in.
210
:param revision_id: The utf8 encoded revision_id to get a graph from.
211
:return: A smart server response where the body contains an utf8
212
encoded flattened list of the revision graph.
218
graph = repository.get_graph()
220
search_ids = [revision_id]
222
search_ids = repository.all_revision_ids()
223
search = graph._make_breadth_first_searcher(search_ids)
224
transitive_ids = set()
225
map(transitive_ids.update, list(search))
226
parent_map = graph.get_parent_map(transitive_ids)
227
revision_graph = _strip_NULL_ghosts(parent_map)
228
if revision_id and revision_id not in revision_graph:
229
# Note that we return an empty body, rather than omitting the body.
230
# This way the client knows that it can always expect to find a body
231
# in the response for this method, even in the error case.
232
return FailedSmartServerResponse(('nosuchrevision', revision_id), '')
234
for revision, parents in revision_graph.items():
235
lines.append(' '.join((revision, ) + tuple(parents)))
237
return SuccessfulSmartServerResponse(('ok', ), '\n'.join(lines))
240
class SmartServerRequestHasRevision(SmartServerRepositoryRequest):
242
def do_repository_request(self, repository, revision_id):
243
"""Return ok if a specific revision is in the repository at path.
245
:param repository: The repository to query in.
246
:param revision_id: The utf8 encoded revision_id to lookup.
247
:return: A smart server response of ('ok', ) if the revision is
250
if repository.has_revision(revision_id):
251
return SuccessfulSmartServerResponse(('yes', ))
253
return SuccessfulSmartServerResponse(('no', ))
256
class SmartServerRepositoryGatherStats(SmartServerRepositoryRequest):
258
def do_repository_request(self, repository, revid, committers):
259
"""Return the result of repository.gather_stats().
261
:param repository: The repository to query in.
262
:param revid: utf8 encoded rev id or an empty string to indicate None
263
:param committers: 'yes' or 'no'.
265
:return: A SmartServerResponse ('ok',), a encoded body looking like
268
latestrev: 345.700 3600
271
But containing only fields returned by the gather_stats() call
274
decoded_revision_id = None
276
decoded_revision_id = revid
277
if committers == 'yes':
278
decoded_committers = True
280
decoded_committers = None
281
stats = repository.gather_stats(decoded_revision_id, decoded_committers)
284
if stats.has_key('committers'):
285
body += 'committers: %d\n' % stats['committers']
286
if stats.has_key('firstrev'):
287
body += 'firstrev: %.3f %d\n' % stats['firstrev']
288
if stats.has_key('latestrev'):
289
body += 'latestrev: %.3f %d\n' % stats['latestrev']
290
if stats.has_key('revisions'):
291
body += 'revisions: %d\n' % stats['revisions']
292
if stats.has_key('size'):
293
body += 'size: %d\n' % stats['size']
295
return SuccessfulSmartServerResponse(('ok', ), body)
298
class SmartServerRepositoryIsShared(SmartServerRepositoryRequest):
300
def do_repository_request(self, repository):
301
"""Return the result of repository.is_shared().
303
:param repository: The repository to query in.
304
:return: A smart server response of ('yes', ) if the repository is
305
shared, and ('no', ) if it is not.
307
if repository.is_shared():
308
return SuccessfulSmartServerResponse(('yes', ))
310
return SuccessfulSmartServerResponse(('no', ))
313
class SmartServerRepositoryLockWrite(SmartServerRepositoryRequest):
315
def do_repository_request(self, repository, token=''):
316
# XXX: this probably should not have a token.
320
token = repository.lock_write(token=token)
321
except errors.LockContention, e:
322
return FailedSmartServerResponse(('LockContention',))
323
except errors.UnlockableTransport:
324
return FailedSmartServerResponse(('UnlockableTransport',))
325
except errors.LockFailed, e:
326
return FailedSmartServerResponse(('LockFailed',
327
str(e.lock), str(e.why)))
328
if token is not None:
329
repository.leave_lock_in_place()
333
return SuccessfulSmartServerResponse(('ok', token))
336
class SmartServerRepositoryGetStream(SmartServerRepositoryRequest):
338
def do_repository_request(self, repository, to_network_name):
339
"""Get a stream for inserting into a to_format repository.
341
:param repository: The repository to stream from.
342
:param to_network_name: The network name of the format of the target
345
self._to_format = network_format_registry.get(to_network_name)
346
return None # Signal that we want a body.
348
def do_body(self, body_bytes):
349
repository = self._repository
350
repository.lock_read()
352
search, error = self.recreate_search(repository, body_bytes)
353
if error is not None:
356
search = search.get_result()
357
source = repository._get_source(self._to_format)
358
stream = source.get_stream(search)
360
exc_info = sys.exc_info()
362
# On non-error, unlocking is done by the body stream handler.
365
raise exc_info[0], exc_info[1], exc_info[2]
366
return SuccessfulSmartServerResponse(('ok',),
367
body_stream=self.body_stream(stream, repository))
369
def body_stream(self, stream, repository):
370
byte_stream = _stream_to_byte_stream(stream, repository._format)
372
for bytes in byte_stream:
374
except errors.RevisionNotPresent, e:
375
# This shouldn't be able to happen, but as we don't buffer
376
# everything it can in theory happen.
378
yield FailedSmartServerResponse(('NoSuchRevision', e.revision_id))
383
def _stream_to_byte_stream(stream, src_format):
384
"""Convert a record stream to a self delimited byte stream."""
385
pack_writer = pack.ContainerSerialiser()
386
yield pack_writer.begin()
387
yield pack_writer.bytes_record(src_format.network_name(), '')
388
for substream_type, substream in stream:
389
for record in substream:
390
if record.storage_kind in ('chunked', 'fulltext'):
391
serialised = record_to_fulltext_bytes(record)
393
serialised = record.get_bytes_as(record.storage_kind)
395
# Some streams embed the whole stream into the wire
396
# representation of the first record, which means that
397
# later records have no wire representation: we skip them.
398
yield pack_writer.bytes_record(serialised, [(substream_type,)])
399
yield pack_writer.end()
402
def _byte_stream_to_stream(byte_stream):
403
"""Convert a byte stream into a format and a stream.
405
:param byte_stream: A bytes iterator, as output by _stream_to_byte_stream.
406
:return: (RepositoryFormat, stream_generator)
408
stream_decoder = pack.ContainerPushParser()
410
"""Closure to return the substreams."""
411
# May have fully parsed records already.
412
for record in stream_decoder.read_pending_records():
413
record_names, record_bytes = record
414
record_name, = record_names
415
substream_type = record_name[0]
416
substream = NetworkRecordStream([record_bytes])
417
yield substream_type, substream.read()
418
for bytes in byte_stream:
419
stream_decoder.accept_bytes(bytes)
420
for record in stream_decoder.read_pending_records():
421
record_names, record_bytes = record
422
record_name, = record_names
423
substream_type = record_name[0]
424
substream = NetworkRecordStream([record_bytes])
425
yield substream_type, substream.read()
426
for bytes in byte_stream:
427
stream_decoder.accept_bytes(bytes)
428
for record in stream_decoder.read_pending_records(max=1):
429
record_names, src_format_name = record
430
src_format = network_format_registry.get(src_format_name)
431
return src_format, record_stream()
434
class SmartServerRepositoryUnlock(SmartServerRepositoryRequest):
436
def do_repository_request(self, repository, token):
438
repository.lock_write(token=token)
439
except errors.TokenMismatch, e:
440
return FailedSmartServerResponse(('TokenMismatch',))
441
repository.dont_leave_lock_in_place()
443
return SuccessfulSmartServerResponse(('ok',))
446
class SmartServerRepositorySetMakeWorkingTrees(SmartServerRepositoryRequest):
448
def do_repository_request(self, repository, str_bool_new_value):
449
if str_bool_new_value == 'True':
453
repository.set_make_working_trees(new_value)
454
return SuccessfulSmartServerResponse(('ok',))
457
class SmartServerRepositoryTarball(SmartServerRepositoryRequest):
458
"""Get the raw repository files as a tarball.
460
The returned tarball contains a .bzr control directory which in turn
461
contains a repository.
463
This takes one parameter, compression, which currently must be
466
This is used to implement the Repository.copy_content_into operation.
469
def do_repository_request(self, repository, compression):
470
tmp_dirname, tmp_repo = self._copy_to_tempdir(repository)
472
controldir_name = tmp_dirname + '/.bzr'
473
return self._tarfile_response(controldir_name, compression)
475
osutils.rmtree(tmp_dirname)
477
def _copy_to_tempdir(self, from_repo):
478
tmp_dirname = osutils.mkdtemp(prefix='tmpbzrclone')
479
tmp_bzrdir = from_repo.bzrdir._format.initialize(tmp_dirname)
480
tmp_repo = from_repo._format.initialize(tmp_bzrdir)
481
from_repo.copy_content_into(tmp_repo)
482
return tmp_dirname, tmp_repo
484
def _tarfile_response(self, tmp_dirname, compression):
485
temp = tempfile.NamedTemporaryFile()
487
self._tarball_of_dir(tmp_dirname, compression, temp.file)
488
# all finished; write the tempfile out to the network
490
return SuccessfulSmartServerResponse(('ok',), temp.read())
491
# FIXME: Don't read the whole thing into memory here; rather stream
492
# it out from the file onto the network. mbp 20070411
496
def _tarball_of_dir(self, dirname, compression, ofile):
497
filename = os.path.basename(ofile.name)
498
tarball = tarfile.open(fileobj=ofile, name=filename,
499
mode='w|' + compression)
501
# The tarball module only accepts ascii names, and (i guess)
502
# packs them with their 8bit names. We know all the files
503
# within the repository have ASCII names so the should be safe
505
dirname = dirname.encode(sys.getfilesystemencoding())
506
# python's tarball module includes the whole path by default so
508
if not dirname.endswith('.bzr'):
509
raise ValueError(dirname)
510
tarball.add(dirname, '.bzr') # recursive by default
515
class SmartServerRepositoryInsertStream(SmartServerRepositoryRequest):
516
"""Insert a record stream from a RemoteSink into a repository.
518
This gets bytes pushed to it by the network infrastructure and turns that
519
into a bytes iterator using a thread. That is then processed by
520
_byte_stream_to_stream.
523
def do_repository_request(self, repository, resume_tokens):
524
"""StreamSink.insert_stream for a remote repository."""
525
repository.lock_write()
526
tokens = [token for token in resume_tokens.split(' ') if token]
528
self.repository = repository
529
self.queue = Queue.Queue()
530
self.insert_thread = threading.Thread(target=self._inserter_thread)
531
self.insert_thread.start()
533
def do_chunk(self, body_stream_chunk):
534
self.queue.put(body_stream_chunk)
536
def _inserter_thread(self):
538
src_format, stream = _byte_stream_to_stream(
539
self.blocking_byte_stream())
540
self.insert_result = self.repository._get_sink().insert_stream(
541
stream, src_format, self.tokens)
542
self.insert_ok = True
544
self.insert_exception = sys.exc_info()
545
self.insert_ok = False
547
def blocking_byte_stream(self):
549
bytes = self.queue.get()
550
if bytes is StopIteration:
556
self.queue.put(StopIteration)
557
if self.insert_thread is not None:
558
self.insert_thread.join()
559
if not self.insert_ok:
560
exc_info = self.insert_exception
561
raise exc_info[0], exc_info[1], exc_info[2]
562
write_group_tokens, missing_keys = self.insert_result
563
if write_group_tokens or missing_keys:
564
# bzip needed? missing keys should typically be a small set.
565
# Should this be a streaming body response ?
566
missing_keys = sorted(missing_keys)
567
bytes = bencode.bencode((write_group_tokens, missing_keys))
568
self.repository.unlock()
569
return SuccessfulSmartServerResponse(('missing-basis', bytes))
571
self.repository.unlock()
572
return SuccessfulSmartServerResponse(('ok', ))
added
removed
bzrlib/smart/repository.py
