~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/smart/repository.py

  • Committer: John Arbash Meinel
  • Date: 2008-09-09 15:09:12 UTC
  • mto: This revision was merged to the branch mainline in revision 3699.
  • Revision ID: john@arbash-meinel.com-20080909150912-wyttm8he1zsls2ck
Use the right timing function on win32

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
import Queue
22
21
import sys
 
22
import tempfile
23
23
import tarfile
24
 
import tempfile
25
 
import threading
26
24
 
27
25
from bzrlib import (
28
 
    bencode,
29
26
    errors,
30
 
    graph,
31
27
    osutils,
32
 
    pack,
33
 
    versionedfile,
34
28
    )
35
29
from bzrlib.bzrdir import BzrDir
36
30
from bzrlib.smart.request import (
38
32
    SmartServerRequest,
39
33
    SuccessfulSmartServerResponse,
40
34
    )
41
 
from bzrlib.repository import _strip_NULL_ghosts, network_format_registry
 
35
from bzrlib.repository import _strip_NULL_ghosts
42
36
from bzrlib import revision as _mod_revision
43
 
from bzrlib.versionedfile import (
44
 
    NetworkRecordStream,
45
 
    record_to_fulltext_bytes,
46
 
    )
47
37
 
48
38
 
49
39
class SmartServerRepositoryRequest(SmartServerRequest):
51
41
 
52
42
    def do(self, path, *args):
53
43
        """Execute a repository request.
54
 
 
 
44
        
55
45
        All Repository requests take a path to the repository as their first
56
46
        argument.  The repository must be at the exact path given by the
57
47
        client - no searching is done.
74
64
        # is expected)
75
65
        return None
76
66
 
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
 
        """
85
 
        lines = search_bytes.split('\n')
86
 
        if lines[0] == 'ancestry-of':
87
 
            heads = lines[1:]
88
 
            search_result = graph.PendingAncestryResult(heads, repository)
89
 
            return search_result, None
90
 
        elif lines[0] == 'search':
91
 
            return self.recreate_search_from_recipe(repository, lines[1:],
92
 
                discard_excess=discard_excess)
93
 
        else:
94
 
            return (None, FailedSmartServerResponse(('BadSearch',)))
95
 
 
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
 
        """
 
67
    def recreate_search(self, repository, recipe_bytes):
 
68
        lines = recipe_bytes.split('\n')
105
69
        start_keys = set(lines[0].split(' '))
106
70
        exclude_keys = set(lines[1].split(' '))
107
71
        revision_count = int(lines[2])
116
80
                    break
117
81
                search.stop_searching_any(exclude_keys.intersection(next_revs))
118
82
            search_result = search.get_result()
119
 
            if (not discard_excess and
120
 
                search_result.get_recipe()[3] != revision_count):
 
83
            if search_result.get_recipe()[2] != revision_count:
121
84
                # we got back a different amount of data than expected, this
122
85
                # gets reported as NoSuchRevision, because less revisions
123
86
                # indicates missing revisions, and more should never happen as
124
87
                # the excludes list considers ghosts and ensures that ghost
125
88
                # filling races are not a problem.
126
89
                return (None, FailedSmartServerResponse(('NoSuchRevision',)))
127
 
            return (search_result, None)
 
90
            return (search, None)
128
91
        finally:
129
92
            repository.unlock()
130
93
 
143
106
 
144
107
class SmartServerRepositoryGetParentMap(SmartServerRepositoryRequest):
145
108
    """Bzr 1.2+ - get parent data for revisions during a graph search."""
146
 
 
147
 
    no_extra_results = False
148
 
 
 
109
    
149
110
    def do_repository_request(self, repository, *revision_ids):
150
111
        """Get parent details for some revisions.
151
 
 
 
112
        
152
113
        All the parents for revision_ids are returned. Additionally up to 64KB
153
114
        of additional parent data found by performing a breadth first search
154
115
        from revision_ids is returned. The verb takes a body containing the
155
116
        current search state, see do_body for details.
156
117
 
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
118
        :param repository: The repository to query in.
162
119
        :param revision_ids: The utf8 encoded revision_id to answer for.
163
120
        """
182
139
    def _do_repository_request(self, body_bytes):
183
140
        repository = self._repository
184
141
        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
 
        body_lines = body_bytes.split('\n')
189
 
        search_result, error = self.recreate_search_from_recipe(
190
 
            repository, body_lines)
 
142
        search, error = self.recreate_search(repository, body_bytes)
191
143
        if error is not None:
192
144
            return error
193
145
        # TODO might be nice to start up the search again; but thats not
194
146
        # written or tested yet.
195
 
        client_seen_revs = set(search_result.get_keys())
 
147
        client_seen_revs = set(search.get_result().get_keys())
196
148
        # Always include the requested ids.
197
149
        client_seen_revs.difference_update(revision_ids)
198
150
        lines = []
205
157
        while next_revs:
206
158
            queried_revs.update(next_revs)
207
159
            parent_map = repo_graph.get_parent_map(next_revs)
208
 
            current_revs = next_revs
209
160
            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)):
 
161
            for revision_id, parents in parent_map.iteritems():
 
162
                # adjust for the wire
 
163
                if parents == (_mod_revision.NULL_REVISION,):
 
164
                    parents = ()
 
165
                # prepare the next query
 
166
                next_revs.update(parents)
 
167
                if revision_id not in client_seen_revs:
226
168
                    # Client does not have this revision, give it to it.
227
169
                    # add parents to the result
228
 
                    result[encoded_id] = parents
 
170
                    result[revision_id] = parents
229
171
                    # Approximate the serialized cost of this revision_id.
230
 
                    size_so_far += 2 + len(encoded_id) + sum(map(len, parents))
 
172
                    size_so_far += 2 + len(revision_id) + sum(map(len, parents))
231
173
            # get all the directly asked for parents, and then flesh out to
232
174
            # 64K (compressed) or so. We do one level of depth at a time to
233
175
            # stay in sync with the client. The 250000 magic number is
234
176
            # estimated compression ratio taken from bzr.dev itself.
235
 
            if self.no_extra_results or (
236
 
                first_loop_done and size_so_far > 250000):
 
177
            if first_loop_done and size_so_far > 250000:
237
178
                next_revs = set()
238
179
                break
239
180
            # don't query things we've already queried
250
191
 
251
192
 
252
193
class SmartServerRepositoryGetRevisionGraph(SmartServerRepositoryReadLocked):
253
 
 
 
194
    
254
195
    def do_readlocked_repository_request(self, repository, revision_id):
255
196
        """Return the result of repository.get_revision_graph(revision_id).
256
197
 
257
198
        Deprecated as of bzr 1.4, but supported for older clients.
258
 
 
 
199
        
259
200
        :param repository: The repository to query in.
260
201
        :param revision_id: The utf8 encoded revision_id to get a graph from.
261
202
        :return: A smart server response where the body contains an utf8
287
228
        return SuccessfulSmartServerResponse(('ok', ), '\n'.join(lines))
288
229
 
289
230
 
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
231
class SmartServerRequestHasRevision(SmartServerRepositoryRequest):
316
232
 
317
233
    def do_repository_request(self, repository, revision_id):
408
324
        return SuccessfulSmartServerResponse(('ok', token))
409
325
 
410
326
 
411
 
class SmartServerRepositoryGetStream(SmartServerRepositoryRequest):
412
 
 
413
 
    def do_repository_request(self, repository, to_network_name):
414
 
        """Get a stream for inserting into a to_format repository.
415
 
 
416
 
        :param repository: The repository to stream from.
417
 
        :param to_network_name: The network name of the format of the target
418
 
            repository.
419
 
        """
420
 
        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
 
        return None # Signal that we want a body.
425
 
 
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
 
    def do_body(self, body_bytes):
458
 
        repository = self._repository
459
 
        repository.lock_read()
460
 
        try:
461
 
            search_result, error = self.recreate_search(repository, body_bytes,
462
 
                discard_excess=True)
463
 
            if error is not None:
464
 
                repository.unlock()
465
 
                return error
466
 
            source = repository._get_source(self._to_format)
467
 
            stream = source.get_stream(search_result)
468
 
        except Exception:
469
 
            exc_info = sys.exc_info()
470
 
            try:
471
 
                # On non-error, unlocking is done by the body stream handler.
472
 
                repository.unlock()
473
 
            finally:
474
 
                raise exc_info[0], exc_info[1], exc_info[2]
475
 
        return SuccessfulSmartServerResponse(('ok',),
476
 
            body_stream=self.body_stream(stream, repository))
477
 
 
478
 
    def body_stream(self, stream, repository):
479
 
        byte_stream = _stream_to_byte_stream(stream, repository._format)
480
 
        try:
481
 
            for bytes in byte_stream:
482
 
                yield bytes
483
 
        except errors.RevisionNotPresent, e:
484
 
            # This shouldn't be able to happen, but as we don't buffer
485
 
            # everything it can in theory happen.
486
 
            repository.unlock()
487
 
            yield FailedSmartServerResponse(('NoSuchRevision', e.revision_id))
488
 
        else:
489
 
            repository.unlock()
490
 
 
491
 
 
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
 
def _stream_to_byte_stream(stream, src_format):
500
 
    """Convert a record stream to a self delimited byte stream."""
501
 
    pack_writer = pack.ContainerSerialiser()
502
 
    yield pack_writer.begin()
503
 
    yield pack_writer.bytes_record(src_format.network_name(), '')
504
 
    for substream_type, substream in stream:
505
 
        for record in substream:
506
 
            if record.storage_kind in ('chunked', 'fulltext'):
507
 
                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
 
            else:
513
 
                serialised = record.get_bytes_as(record.storage_kind)
514
 
            if serialised:
515
 
                # Some streams embed the whole stream into the wire
516
 
                # representation of the first record, which means that
517
 
                # later records have no wire representation: we skip them.
518
 
                yield pack_writer.bytes_record(serialised, [(substream_type,)])
519
 
    yield pack_writer.end()
520
 
 
521
 
 
522
 
def _byte_stream_to_stream(byte_stream):
523
 
    """Convert a byte stream into a format and a stream.
524
 
 
525
 
    :param byte_stream: A bytes iterator, as output by _stream_to_byte_stream.
526
 
    :return: (RepositoryFormat, stream_generator)
527
 
    """
528
 
    stream_decoder = pack.ContainerPushParser()
529
 
    def record_stream():
530
 
        """Closure to return the substreams."""
531
 
        # May have fully parsed records already.
532
 
        for record in stream_decoder.read_pending_records():
533
 
            record_names, record_bytes = record
534
 
            record_name, = record_names
535
 
            substream_type = record_name[0]
536
 
            substream = NetworkRecordStream([record_bytes])
537
 
            yield substream_type, substream.read()
538
 
        for bytes in byte_stream:
539
 
            stream_decoder.accept_bytes(bytes)
540
 
            for record in stream_decoder.read_pending_records():
541
 
                record_names, record_bytes = record
542
 
                record_name, = record_names
543
 
                substream_type = record_name[0]
544
 
                substream = NetworkRecordStream([record_bytes])
545
 
                yield substream_type, substream.read()
546
 
    for bytes in byte_stream:
547
 
        stream_decoder.accept_bytes(bytes)
548
 
        for record in stream_decoder.read_pending_records(max=1):
549
 
            record_names, src_format_name = record
550
 
            src_format = network_format_registry.get(src_format_name)
551
 
            return src_format, record_stream()
552
 
 
553
 
 
554
327
class SmartServerRepositoryUnlock(SmartServerRepositoryRequest):
555
328
 
556
329
    def do_repository_request(self, repository, token):
563
336
        return SuccessfulSmartServerResponse(('ok',))
564
337
 
565
338
 
566
 
class SmartServerRepositorySetMakeWorkingTrees(SmartServerRepositoryRequest):
567
 
 
568
 
    def do_repository_request(self, repository, str_bool_new_value):
569
 
        if str_bool_new_value == 'True':
570
 
            new_value = True
571
 
        else:
572
 
            new_value = False
573
 
        repository.set_make_working_trees(new_value)
574
 
        return SuccessfulSmartServerResponse(('ok',))
575
 
 
576
 
 
577
339
class SmartServerRepositoryTarball(SmartServerRepositoryRequest):
578
340
    """Get the raw repository files as a tarball.
579
341
 
580
342
    The returned tarball contains a .bzr control directory which in turn
581
343
    contains a repository.
582
 
 
583
 
    This takes one parameter, compression, which currently must be
 
344
    
 
345
    This takes one parameter, compression, which currently must be 
584
346
    "", "gz", or "bz2".
585
347
 
586
348
    This is used to implement the Repository.copy_content_into operation.
630
392
            tarball.add(dirname, '.bzr') # recursive by default
631
393
        finally:
632
394
            tarball.close()
633
 
 
634
 
 
635
 
class SmartServerRepositoryInsertStreamLocked(SmartServerRepositoryRequest):
636
 
    """Insert a record stream from a RemoteSink into a repository.
637
 
 
638
 
    This gets bytes pushed to it by the network infrastructure and turns that
639
 
    into a bytes iterator using a thread. That is then processed by
640
 
    _byte_stream_to_stream.
641
 
 
642
 
    New in 1.14.
643
 
    """
644
 
 
645
 
    def do_repository_request(self, repository, resume_tokens, lock_token):
646
 
        """StreamSink.insert_stream for a remote repository."""
647
 
        repository.lock_write(token=lock_token)
648
 
        self.do_insert_stream_request(repository, resume_tokens)
649
 
 
650
 
    def do_insert_stream_request(self, repository, resume_tokens):
651
 
        tokens = [token for token in resume_tokens.split(' ') if token]
652
 
        self.tokens = tokens
653
 
        self.repository = repository
654
 
        self.queue = Queue.Queue()
655
 
        self.insert_thread = threading.Thread(target=self._inserter_thread)
656
 
        self.insert_thread.start()
657
 
 
658
 
    def do_chunk(self, body_stream_chunk):
659
 
        self.queue.put(body_stream_chunk)
660
 
 
661
 
    def _inserter_thread(self):
662
 
        try:
663
 
            src_format, stream = _byte_stream_to_stream(
664
 
                self.blocking_byte_stream())
665
 
            self.insert_result = self.repository._get_sink().insert_stream(
666
 
                stream, src_format, self.tokens)
667
 
            self.insert_ok = True
668
 
        except:
669
 
            self.insert_exception = sys.exc_info()
670
 
            self.insert_ok = False
671
 
 
672
 
    def blocking_byte_stream(self):
673
 
        while True:
674
 
            bytes = self.queue.get()
675
 
            if bytes is StopIteration:
676
 
                return
677
 
            else:
678
 
                yield bytes
679
 
 
680
 
    def do_end(self):
681
 
        self.queue.put(StopIteration)
682
 
        if self.insert_thread is not None:
683
 
            self.insert_thread.join()
684
 
        if not self.insert_ok:
685
 
            exc_info = self.insert_exception
686
 
            raise exc_info[0], exc_info[1], exc_info[2]
687
 
        write_group_tokens, missing_keys = self.insert_result
688
 
        if write_group_tokens or missing_keys:
689
 
            # bzip needed? missing keys should typically be a small set.
690
 
            # Should this be a streaming body response ?
691
 
            missing_keys = sorted(missing_keys)
692
 
            bytes = bencode.bencode((write_group_tokens, missing_keys))
693
 
            self.repository.unlock()
694
 
            return SuccessfulSmartServerResponse(('missing-basis', bytes))
695
 
        else:
696
 
            self.repository.unlock()
697
 
            return SuccessfulSmartServerResponse(('ok', ))
698
 
 
699
 
 
700
 
class SmartServerRepositoryInsertStream_1_19(SmartServerRepositoryInsertStreamLocked):
701
 
    """Insert a record stream from a RemoteSink into a repository.
702
 
 
703
 
    Same as SmartServerRepositoryInsertStreamLocked, except:
704
 
     - the lock token argument is optional
705
 
     - servers that implement this verb accept 'inventory-delta' records in the
706
 
       stream.
707
 
 
708
 
    New in 1.19.
709
 
    """
710
 
 
711
 
    def do_repository_request(self, repository, resume_tokens, lock_token=None):
712
 
        """StreamSink.insert_stream for a remote repository."""
713
 
        SmartServerRepositoryInsertStreamLocked.do_repository_request(
714
 
            self, repository, resume_tokens, lock_token)
715
 
 
716
 
 
717
 
class SmartServerRepositoryInsertStream(SmartServerRepositoryInsertStreamLocked):
718
 
    """Insert a record stream from a RemoteSink into an unlocked repository.
719
 
 
720
 
    This is the same as SmartServerRepositoryInsertStreamLocked, except it
721
 
    takes no lock_tokens; i.e. it works with an unlocked (or lock-free, e.g.
722
 
    like pack format) repository.
723
 
 
724
 
    New in 1.13.
725
 
    """
726
 
 
727
 
    def do_repository_request(self, repository, resume_tokens):
728
 
        """StreamSink.insert_stream for a remote repository."""
729
 
        repository.lock_write()
730
 
        self.do_insert_stream_request(repository, resume_tokens)
731
 
 
732