~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/smart/repository.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-03-16 08:26:29 UTC
  • mfrom: (4145.1.6 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20090316082629-xuzqut3b3ur5bn3b
(robertc) Add a new repository method refresh_data to allow clean
        handling of _real_repositories after inserting a stream via the
        smart server. (Robert Collins, Andrew Bennetts)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006, 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""Server-side repository related request implmentations."""
18
18
 
19
19
import bz2
20
20
import os
21
21
import Queue
 
22
import struct
22
23
import sys
 
24
import tarfile
23
25
import tempfile
24
26
import threading
25
27
 
26
28
from bzrlib import (
27
 
    bencode,
28
29
    errors,
29
30
    graph,
30
31
    osutils,
31
32
    pack,
32
 
    ui,
33
 
    versionedfile,
34
33
    )
35
34
from bzrlib.bzrdir import BzrDir
36
35
from bzrlib.smart.request import (
40
39
    )
41
40
from bzrlib.repository import _strip_NULL_ghosts, network_format_registry
42
41
from bzrlib import revision as _mod_revision
43
 
from bzrlib.versionedfile import (
44
 
    NetworkRecordStream,
45
 
    record_to_fulltext_bytes,
46
 
    )
 
42
from bzrlib.util import bencode
 
43
from bzrlib.versionedfile import NetworkRecordStream, record_to_fulltext_bytes
47
44
 
48
45
 
49
46
class SmartServerRepositoryRequest(SmartServerRequest):
74
71
        # is expected)
75
72
        return None
76
73
 
77
 
    def recreate_search(self, repository, search_bytes, discard_excess=False):
78
 
        """Recreate a search from its serialised form.
79
 
 
80
 
        :param discard_excess: If True, and the search refers to data we don't
81
 
            have, just silently accept that fact - the verb calling
82
 
            recreate_search trusts that clients will look for missing things
83
 
            they expected and get it from elsewhere.
84
 
        """
 
74
    def recreate_search(self, repository, search_bytes):
85
75
        lines = search_bytes.split('\n')
86
76
        if lines[0] == 'ancestry-of':
87
77
            heads = lines[1:]
88
78
            search_result = graph.PendingAncestryResult(heads, repository)
89
79
            return search_result, None
90
80
        elif lines[0] == 'search':
91
 
            return self.recreate_search_from_recipe(repository, lines[1:],
92
 
                discard_excess=discard_excess)
 
81
            return self.recreate_search_from_recipe(repository, lines[1:])
93
82
        else:
94
83
            return (None, FailedSmartServerResponse(('BadSearch',)))
95
84
 
96
 
    def recreate_search_from_recipe(self, repository, lines,
97
 
        discard_excess=False):
98
 
        """Recreate a specific revision search (vs a from-tip search).
99
 
 
100
 
        :param discard_excess: If True, and the search refers to data we don't
101
 
            have, just silently accept that fact - the verb calling
102
 
            recreate_search trusts that clients will look for missing things
103
 
            they expected and get it from elsewhere.
104
 
        """
 
85
    def recreate_search_from_recipe(self, repository, lines):
105
86
        start_keys = set(lines[0].split(' '))
106
87
        exclude_keys = set(lines[1].split(' '))
107
88
        revision_count = int(lines[2])
116
97
                    break
117
98
                search.stop_searching_any(exclude_keys.intersection(next_revs))
118
99
            search_result = search.get_result()
119
 
            if (not discard_excess and
120
 
                search_result.get_recipe()[3] != revision_count):
 
100
            if search_result.get_recipe()[2] != revision_count:
121
101
                # we got back a different amount of data than expected, this
122
102
                # gets reported as NoSuchRevision, because less revisions
123
103
                # indicates missing revisions, and more should never happen as
154
134
        from revision_ids is returned. The verb takes a body containing the
155
135
        current search state, see do_body for details.
156
136
 
157
 
        If 'include-missing:' is in revision_ids, ghosts encountered in the
158
 
        graph traversal for getting parent data are included in the result with
159
 
        a prefix of 'missing:'.
160
 
 
161
137
        :param repository: The repository to query in.
162
138
        :param revision_ids: The utf8 encoded revision_id to answer for.
163
139
        """
182
158
    def _do_repository_request(self, body_bytes):
183
159
        repository = self._repository
184
160
        revision_ids = set(self._revision_ids)
185
 
        include_missing = 'include-missing:' in revision_ids
186
 
        if include_missing:
187
 
            revision_ids.remove('include-missing:')
188
161
        body_lines = body_bytes.split('\n')
189
162
        search_result, error = self.recreate_search_from_recipe(
190
163
            repository, body_lines)
205
178
        while next_revs:
206
179
            queried_revs.update(next_revs)
207
180
            parent_map = repo_graph.get_parent_map(next_revs)
208
 
            current_revs = next_revs
209
181
            next_revs = set()
210
 
            for revision_id in current_revs:
211
 
                missing_rev = False
212
 
                parents = parent_map.get(revision_id)
213
 
                if parents is not None:
214
 
                    # adjust for the wire
215
 
                    if parents == (_mod_revision.NULL_REVISION,):
216
 
                        parents = ()
217
 
                    # prepare the next query
218
 
                    next_revs.update(parents)
219
 
                    encoded_id = revision_id
220
 
                else:
221
 
                    missing_rev = True
222
 
                    encoded_id = "missing:" + revision_id
223
 
                    parents = []
224
 
                if (revision_id not in client_seen_revs and
225
 
                    (not missing_rev or include_missing)):
 
182
            for revision_id, parents in parent_map.iteritems():
 
183
                # adjust for the wire
 
184
                if parents == (_mod_revision.NULL_REVISION,):
 
185
                    parents = ()
 
186
                # prepare the next query
 
187
                next_revs.update(parents)
 
188
                if revision_id not in client_seen_revs:
226
189
                    # Client does not have this revision, give it to it.
227
190
                    # add parents to the result
228
 
                    result[encoded_id] = parents
 
191
                    result[revision_id] = parents
229
192
                    # Approximate the serialized cost of this revision_id.
230
 
                    size_so_far += 2 + len(encoded_id) + sum(map(len, parents))
 
193
                    size_so_far += 2 + len(revision_id) + sum(map(len, parents))
231
194
            # get all the directly asked for parents, and then flesh out to
232
195
            # 64K (compressed) or so. We do one level of depth at a time to
233
196
            # stay in sync with the client. The 250000 magic number is
287
250
        return SuccessfulSmartServerResponse(('ok', ), '\n'.join(lines))
288
251
 
289
252
 
290
 
class SmartServerRepositoryGetRevIdForRevno(SmartServerRepositoryReadLocked):
291
 
 
292
 
    def do_readlocked_repository_request(self, repository, revno,
293
 
            known_pair):
294
 
        """Find the revid for a given revno, given a known revno/revid pair.
295
 
        
296
 
        New in 1.17.
297
 
        """
298
 
        try:
299
 
            found_flag, result = repository.get_rev_id_for_revno(revno, known_pair)
300
 
        except errors.RevisionNotPresent, err:
301
 
            if err.revision_id != known_pair[1]:
302
 
                raise AssertionError(
303
 
                    'get_rev_id_for_revno raised RevisionNotPresent for '
304
 
                    'non-initial revision: ' + err.revision_id)
305
 
            return FailedSmartServerResponse(
306
 
                ('nosuchrevision', err.revision_id))
307
 
        if found_flag:
308
 
            return SuccessfulSmartServerResponse(('ok', result))
309
 
        else:
310
 
            earliest_revno, earliest_revid = result
311
 
            return SuccessfulSmartServerResponse(
312
 
                ('history-incomplete', earliest_revno, earliest_revid))
313
 
 
314
 
 
315
253
class SmartServerRequestHasRevision(SmartServerRepositoryRequest):
316
254
 
317
255
    def do_repository_request(self, repository, revision_id):
418
356
            repository.
419
357
        """
420
358
        self._to_format = network_format_registry.get(to_network_name)
421
 
        if self._should_fake_unknown():
422
 
            return FailedSmartServerResponse(
423
 
                ('UnknownMethod', 'Repository.get_stream'))
424
359
        return None # Signal that we want a body.
425
360
 
426
 
    def _should_fake_unknown(self):
427
 
        """Return True if we should return UnknownMethod to the client.
428
 
        
429
 
        This is a workaround for bugs in pre-1.19 clients that claim to
430
 
        support receiving streams of CHK repositories.  The pre-1.19 client
431
 
        expects inventory records to be serialized in the format defined by
432
 
        to_network_name, but in pre-1.19 (at least) that format definition
433
 
        tries to use the xml5 serializer, which does not correctly handle
434
 
        rich-roots.  After 1.19 the client can also accept inventory-deltas
435
 
        (which avoids this issue), and those clients will use the
436
 
        Repository.get_stream_1.19 verb instead of this one.
437
 
        So: if this repository is CHK, and the to_format doesn't match,
438
 
        we should just fake an UnknownSmartMethod error so that the client
439
 
        will fallback to VFS, rather than sending it a stream we know it
440
 
        cannot handle.
441
 
        """
442
 
        from_format = self._repository._format
443
 
        to_format = self._to_format
444
 
        if not from_format.supports_chks:
445
 
            # Source not CHK: that's ok
446
 
            return False
447
 
        if (to_format.supports_chks and
448
 
            from_format.repository_class is to_format.repository_class and
449
 
            from_format._serializer == to_format._serializer):
450
 
            # Source is CHK, but target matches: that's ok
451
 
            # (e.g. 2a->2a, or CHK2->2a)
452
 
            return False
453
 
        # Source is CHK, and target is not CHK or incompatible CHK.  We can't
454
 
        # generate a compatible stream.
455
 
        return True
456
 
 
457
361
    def do_body(self, body_bytes):
458
362
        repository = self._repository
459
363
        repository.lock_read()
460
364
        try:
461
 
            search_result, error = self.recreate_search(repository, body_bytes,
462
 
                discard_excess=True)
 
365
            search_result, error = self.recreate_search(repository, body_bytes)
463
366
            if error is not None:
464
367
                repository.unlock()
465
368
                return error
489
392
            repository.unlock()
490
393
 
491
394
 
492
 
class SmartServerRepositoryGetStream_1_19(SmartServerRepositoryGetStream):
493
 
 
494
 
    def _should_fake_unknown(self):
495
 
        """Returns False; we don't need to workaround bugs in 1.19+ clients."""
496
 
        return False
497
 
 
498
 
 
499
395
def _stream_to_byte_stream(stream, src_format):
500
396
    """Convert a record stream to a self delimited byte stream."""
501
397
    pack_writer = pack.ContainerSerialiser()
505
401
        for record in substream:
506
402
            if record.storage_kind in ('chunked', 'fulltext'):
507
403
                serialised = record_to_fulltext_bytes(record)
508
 
            elif record.storage_kind == 'inventory-delta':
509
 
                serialised = record_to_inventory_delta_bytes(record)
510
 
            elif record.storage_kind == 'absent':
511
 
                raise ValueError("Absent factory for %s" % (record.key,))
512
404
            else:
513
405
                serialised = record.get_bytes_as(record.storage_kind)
514
406
            if serialised:
519
411
    yield pack_writer.end()
520
412
 
521
413
 
522
 
class _ByteStreamDecoder(object):
523
 
    """Helper for _byte_stream_to_stream.
524
 
 
525
 
    The expected usage of this class is via the function _byte_stream_to_stream
526
 
    which creates a _ByteStreamDecoder, pops off the stream format and then
527
 
    yields the output of record_stream(), the main entry point to
528
 
    _ByteStreamDecoder.
529
 
 
530
 
    Broadly this class has to unwrap two layers of iterators:
531
 
    (type, substream)
532
 
    (substream details)
533
 
 
534
 
    This is complicated by wishing to return type, iterator_for_type, but
535
 
    getting the data for iterator_for_type when we find out type: we can't
536
 
    simply pass a generator down to the NetworkRecordStream parser, instead
537
 
    we have a little local state to seed each NetworkRecordStream instance,
538
 
    and gather the type that we'll be yielding.
539
 
 
540
 
    :ivar byte_stream: The byte stream being decoded.
541
 
    :ivar stream_decoder: A pack parser used to decode the bytestream
542
 
    :ivar current_type: The current type, used to join adjacent records of the
543
 
        same type into a single stream.
544
 
    :ivar first_bytes: The first bytes to give the next NetworkRecordStream.
545
 
    """
546
 
 
547
 
    def __init__(self, byte_stream):
548
 
        """Create a _ByteStreamDecoder."""
549
 
        self.stream_decoder = pack.ContainerPushParser()
550
 
        self.current_type = None
551
 
        self.first_bytes = None
552
 
        self.byte_stream = byte_stream
553
 
 
554
 
    def iter_stream_decoder(self):
555
 
        """Iterate the contents of the pack from stream_decoder."""
556
 
        # dequeue pending items
557
 
        for record in self.stream_decoder.read_pending_records():
558
 
            yield record
559
 
        # Pull bytes of the wire, decode them to records, yield those records.
560
 
        for bytes in self.byte_stream:
561
 
            self.stream_decoder.accept_bytes(bytes)
562
 
            for record in self.stream_decoder.read_pending_records():
563
 
                yield record
564
 
 
565
 
    def iter_substream_bytes(self):
566
 
        if self.first_bytes is not None:
567
 
            yield self.first_bytes
568
 
            # If we run out of pack records, single the outer layer to stop.
569
 
            self.first_bytes = None
570
 
        for record in self.iter_pack_records:
571
 
            record_names, record_bytes = record
572
 
            record_name, = record_names
573
 
            substream_type = record_name[0]
574
 
            if substream_type != self.current_type:
575
 
                # end of a substream, seed the next substream.
576
 
                self.current_type = substream_type
577
 
                self.first_bytes = record_bytes
578
 
                return
579
 
            yield record_bytes
580
 
 
581
 
    def record_stream(self):
582
 
        """Yield substream_type, substream from the byte stream."""
583
 
        self.seed_state()
584
 
        # Make and consume sub generators, one per substream type:
585
 
        while self.first_bytes is not None:
586
 
            substream = NetworkRecordStream(self.iter_substream_bytes())
587
 
            # after substream is fully consumed, self.current_type is set to
588
 
            # the next type, and self.first_bytes is set to the matching bytes.
589
 
            yield self.current_type, substream.read()
590
 
 
591
 
    def seed_state(self):
592
 
        """Prepare the _ByteStreamDecoder to decode from the pack stream."""
593
 
        # Set a single generator we can use to get data from the pack stream.
594
 
        self.iter_pack_records = self.iter_stream_decoder()
595
 
        # Seed the very first subiterator with content; after this each one
596
 
        # seeds the next.
597
 
        list(self.iter_substream_bytes())
598
 
 
599
 
 
600
414
def _byte_stream_to_stream(byte_stream):
601
415
    """Convert a byte stream into a format and a stream.
602
416
 
603
417
    :param byte_stream: A bytes iterator, as output by _stream_to_byte_stream.
604
418
    :return: (RepositoryFormat, stream_generator)
605
419
    """
606
 
    decoder = _ByteStreamDecoder(byte_stream)
 
420
    stream_decoder = pack.ContainerPushParser()
 
421
    def record_stream():
 
422
        """Closure to return the substreams."""
 
423
        # May have fully parsed records already.
 
424
        for record in stream_decoder.read_pending_records():
 
425
            record_names, record_bytes = record
 
426
            record_name, = record_names
 
427
            substream_type = record_name[0]
 
428
            substream = NetworkRecordStream([record_bytes])
 
429
            yield substream_type, substream.read()
 
430
        for bytes in byte_stream:
 
431
            stream_decoder.accept_bytes(bytes)
 
432
            for record in stream_decoder.read_pending_records():
 
433
                record_names, record_bytes = record
 
434
                record_name, = record_names
 
435
                substream_type = record_name[0]
 
436
                substream = NetworkRecordStream([record_bytes])
 
437
                yield substream_type, substream.read()
607
438
    for bytes in byte_stream:
608
 
        decoder.stream_decoder.accept_bytes(bytes)
609
 
        for record in decoder.stream_decoder.read_pending_records(max=1):
 
439
        stream_decoder.accept_bytes(bytes)
 
440
        for record in stream_decoder.read_pending_records(max=1):
610
441
            record_names, src_format_name = record
611
442
            src_format = network_format_registry.get(src_format_name)
612
 
            return src_format, decoder.record_stream()
 
443
            return src_format, record_stream()
613
444
 
614
445
 
615
446
class SmartServerRepositoryUnlock(SmartServerRepositoryRequest):
675
506
            temp.close()
676
507
 
677
508
    def _tarball_of_dir(self, dirname, compression, ofile):
678
 
        import tarfile
679
509
        filename = os.path.basename(ofile.name)
680
510
        tarball = tarfile.open(fileobj=ofile, name=filename,
681
511
            mode='w|' + compression)
759
589
            return SuccessfulSmartServerResponse(('ok', ))
760
590
 
761
591
 
762
 
class SmartServerRepositoryInsertStream_1_19(SmartServerRepositoryInsertStreamLocked):
763
 
    """Insert a record stream from a RemoteSink into a repository.
764
 
 
765
 
    Same as SmartServerRepositoryInsertStreamLocked, except:
766
 
     - the lock token argument is optional
767
 
     - servers that implement this verb accept 'inventory-delta' records in the
768
 
       stream.
769
 
 
770
 
    New in 1.19.
771
 
    """
772
 
 
773
 
    def do_repository_request(self, repository, resume_tokens, lock_token=None):
774
 
        """StreamSink.insert_stream for a remote repository."""
775
 
        SmartServerRepositoryInsertStreamLocked.do_repository_request(
776
 
            self, repository, resume_tokens, lock_token)
777
 
 
778
 
 
779
592
class SmartServerRepositoryInsertStream(SmartServerRepositoryInsertStreamLocked):
780
593
    """Insert a record stream from a RemoteSink into an unlocked repository.
781
594