~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/knit.py

  • Committer: Andrew Bennetts
  • Date: 2009-02-11 09:45:27 UTC
  • mto: This revision was merged to the branch mainline in revision 4002.
  • Revision ID: andrew.bennetts@canonical.com-20090211094527-pdtj25e4748c2h67
Fix the do_body NotImplementedError log spam.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 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
"""Knit versionedfile implementation.
18
18
 
20
20
updates.
21
21
 
22
22
Knit file layout:
23
 
lifeless: the data file is made up of "delta records".  each delta record has a delta header
24
 
that contains; (1) a version id, (2) the size of the delta (in lines), and (3)  the digest of
25
 
the -expanded data- (ie, the delta applied to the parent).  the delta also ends with a
 
23
lifeless: the data file is made up of "delta records".  each delta record has a delta header 
 
24
that contains; (1) a version id, (2) the size of the delta (in lines), and (3)  the digest of 
 
25
the -expanded data- (ie, the delta applied to the parent).  the delta also ends with a 
26
26
end-marker; simply "end VERSION"
27
27
 
28
28
delta can be line or full contents.a
35
35
130,130,2
36
36
8         if elt.get('executable') == 'yes':
37
37
8             ie.executable = True
38
 
end robertc@robertcollins.net-20051003014215-ee2990904cc4c7ad
 
38
end robertc@robertcollins.net-20051003014215-ee2990904cc4c7ad 
39
39
 
40
40
 
41
41
whats in an index:
51
51
 
52
52
"""
53
53
 
 
54
# TODOS:
 
55
# 10:16 < lifeless> make partial index writes safe
 
56
# 10:16 < lifeless> implement 'knit.check()' like weave.check()
 
57
# 10:17 < lifeless> record known ghosts so we can detect when they are filled in rather than the current 'reweave 
 
58
#                    always' approach.
 
59
# move sha1 out of the content so that join is faster at verifying parents
 
60
# record content length ?
 
61
                  
54
62
 
55
63
from cStringIO import StringIO
56
 
from itertools import izip
 
64
from itertools import izip, chain
57
65
import operator
58
66
import os
59
67
import sys
69
77
    lru_cache,
70
78
    pack,
71
79
    progress,
72
 
    static_tuple,
73
80
    trace,
74
81
    tsort,
75
82
    tuned_gzip,
76
 
    ui,
77
83
    )
78
84
""")
79
85
from bzrlib import (
105
111
    ConstantMapper,
106
112
    ContentFactory,
107
113
    ChunkedContentFactory,
108
 
    sort_groupcompress,
109
114
    VersionedFile,
110
115
    VersionedFiles,
111
116
    )
126
131
 
127
132
DATA_SUFFIX = '.knit'
128
133
INDEX_SUFFIX = '.kndx'
129
 
_STREAM_MIN_BUFFER_SIZE = 5*1024*1024
130
134
 
131
135
 
132
136
class KnitAdapter(object):
134
138
 
135
139
    def __init__(self, basis_vf):
136
140
        """Create an adapter which accesses full texts from basis_vf.
137
 
 
 
141
        
138
142
        :param basis_vf: A versioned file to access basis texts of deltas from.
139
143
            May be None for adapters that do not need to access basis texts.
140
144
        """
147
151
class FTAnnotatedToUnannotated(KnitAdapter):
148
152
    """An adapter from FT annotated knits to unannotated ones."""
149
153
 
150
 
    def get_bytes(self, factory):
151
 
        annotated_compressed_bytes = factory._raw_record
 
154
    def get_bytes(self, factory, annotated_compressed_bytes):
152
155
        rec, contents = \
153
156
            self._data._parse_record_unchecked(annotated_compressed_bytes)
154
157
        content = self._annotate_factory.parse_fulltext(contents, rec[1])
159
162
class DeltaAnnotatedToUnannotated(KnitAdapter):
160
163
    """An adapter for deltas from annotated to unannotated."""
161
164
 
162
 
    def get_bytes(self, factory):
163
 
        annotated_compressed_bytes = factory._raw_record
 
165
    def get_bytes(self, factory, annotated_compressed_bytes):
164
166
        rec, contents = \
165
167
            self._data._parse_record_unchecked(annotated_compressed_bytes)
166
168
        delta = self._annotate_factory.parse_line_delta(contents, rec[1],
173
175
class FTAnnotatedToFullText(KnitAdapter):
174
176
    """An adapter from FT annotated knits to unannotated ones."""
175
177
 
176
 
    def get_bytes(self, factory):
177
 
        annotated_compressed_bytes = factory._raw_record
 
178
    def get_bytes(self, factory, annotated_compressed_bytes):
178
179
        rec, contents = \
179
180
            self._data._parse_record_unchecked(annotated_compressed_bytes)
180
181
        content, delta = self._annotate_factory.parse_record(factory.key[-1],
185
186
class DeltaAnnotatedToFullText(KnitAdapter):
186
187
    """An adapter for deltas from annotated to unannotated."""
187
188
 
188
 
    def get_bytes(self, factory):
189
 
        annotated_compressed_bytes = factory._raw_record
 
189
    def get_bytes(self, factory, annotated_compressed_bytes):
190
190
        rec, contents = \
191
191
            self._data._parse_record_unchecked(annotated_compressed_bytes)
192
192
        delta = self._annotate_factory.parse_line_delta(contents, rec[1],
209
209
class FTPlainToFullText(KnitAdapter):
210
210
    """An adapter from FT plain knits to unannotated ones."""
211
211
 
212
 
    def get_bytes(self, factory):
213
 
        compressed_bytes = factory._raw_record
 
212
    def get_bytes(self, factory, compressed_bytes):
214
213
        rec, contents = \
215
214
            self._data._parse_record_unchecked(compressed_bytes)
216
215
        content, delta = self._plain_factory.parse_record(factory.key[-1],
221
220
class DeltaPlainToFullText(KnitAdapter):
222
221
    """An adapter for deltas from annotated to unannotated."""
223
222
 
224
 
    def get_bytes(self, factory):
225
 
        compressed_bytes = factory._raw_record
 
223
    def get_bytes(self, factory, compressed_bytes):
226
224
        rec, contents = \
227
225
            self._data._parse_record_unchecked(compressed_bytes)
228
226
        delta = self._plain_factory.parse_line_delta(contents, rec[1])
244
242
 
245
243
class KnitContentFactory(ContentFactory):
246
244
    """Content factory for streaming from knits.
247
 
 
 
245
    
248
246
    :seealso ContentFactory:
249
247
    """
250
248
 
251
249
    def __init__(self, key, parents, build_details, sha1, raw_record,
252
 
        annotated, knit=None, network_bytes=None):
 
250
        annotated, knit=None):
253
251
        """Create a KnitContentFactory for key.
254
 
 
 
252
        
255
253
        :param key: The key.
256
254
        :param parents: The parents.
257
255
        :param build_details: The build details as returned from
259
257
        :param sha1: The sha1 expected from the full text of this object.
260
258
        :param raw_record: The bytes of the knit data from disk.
261
259
        :param annotated: True if the raw data is annotated.
262
 
        :param network_bytes: None to calculate the network bytes on demand,
263
 
            not-none if they are already known.
264
260
        """
265
261
        ContentFactory.__init__(self)
266
262
        self.sha1 = sha1
276
272
            annotated_kind = ''
277
273
        self.storage_kind = 'knit-%s%s-gz' % (annotated_kind, kind)
278
274
        self._raw_record = raw_record
279
 
        self._network_bytes = network_bytes
280
275
        self._build_details = build_details
281
276
        self._knit = knit
282
277
 
283
 
    def _create_network_bytes(self):
284
 
        """Create a fully serialised network version for transmission."""
285
 
        # storage_kind, key, parents, Noeol, raw_record
286
 
        key_bytes = '\x00'.join(self.key)
287
 
        if self.parents is None:
288
 
            parent_bytes = 'None:'
289
 
        else:
290
 
            parent_bytes = '\t'.join('\x00'.join(key) for key in self.parents)
291
 
        if self._build_details[1]:
292
 
            noeol = 'N'
293
 
        else:
294
 
            noeol = ' '
295
 
        network_bytes = "%s\n%s\n%s\n%s%s" % (self.storage_kind, key_bytes,
296
 
            parent_bytes, noeol, self._raw_record)
297
 
        self._network_bytes = network_bytes
298
 
 
299
278
    def get_bytes_as(self, storage_kind):
300
279
        if storage_kind == self.storage_kind:
301
 
            if self._network_bytes is None:
302
 
                self._create_network_bytes()
303
 
            return self._network_bytes
304
 
        if ('-ft-' in self.storage_kind and
305
 
            storage_kind in ('chunked', 'fulltext')):
306
 
            adapter_key = (self.storage_kind, 'fulltext')
307
 
            adapter_factory = adapter_registry.get(adapter_key)
308
 
            adapter = adapter_factory(None)
309
 
            bytes = adapter.get_bytes(self)
310
 
            if storage_kind == 'chunked':
311
 
                return [bytes]
312
 
            else:
313
 
                return bytes
 
280
            return self._raw_record
314
281
        if self._knit is not None:
315
 
            # Not redundant with direct conversion above - that only handles
316
 
            # fulltext cases.
317
282
            if storage_kind == 'chunked':
318
283
                return self._knit.get_lines(self.key[0])
319
284
            elif storage_kind == 'fulltext':
322
287
            self.storage_kind)
323
288
 
324
289
 
325
 
class LazyKnitContentFactory(ContentFactory):
326
 
    """A ContentFactory which can either generate full text or a wire form.
327
 
 
328
 
    :seealso ContentFactory:
329
 
    """
330
 
 
331
 
    def __init__(self, key, parents, generator, first):
332
 
        """Create a LazyKnitContentFactory.
333
 
 
334
 
        :param key: The key of the record.
335
 
        :param parents: The parents of the record.
336
 
        :param generator: A _ContentMapGenerator containing the record for this
337
 
            key.
338
 
        :param first: Is this the first content object returned from generator?
339
 
            if it is, its storage kind is knit-delta-closure, otherwise it is
340
 
            knit-delta-closure-ref
341
 
        """
342
 
        self.key = key
343
 
        self.parents = parents
344
 
        self.sha1 = None
345
 
        self._generator = generator
346
 
        self.storage_kind = "knit-delta-closure"
347
 
        if not first:
348
 
            self.storage_kind = self.storage_kind + "-ref"
349
 
        self._first = first
350
 
 
351
 
    def get_bytes_as(self, storage_kind):
352
 
        if storage_kind == self.storage_kind:
353
 
            if self._first:
354
 
                return self._generator._wire_bytes()
355
 
            else:
356
 
                # all the keys etc are contained in the bytes returned in the
357
 
                # first record.
358
 
                return ''
359
 
        if storage_kind in ('chunked', 'fulltext'):
360
 
            chunks = self._generator._get_one_work(self.key).text()
361
 
            if storage_kind == 'chunked':
362
 
                return chunks
363
 
            else:
364
 
                return ''.join(chunks)
365
 
        raise errors.UnavailableRepresentation(self.key, storage_kind,
366
 
            self.storage_kind)
367
 
 
368
 
 
369
 
def knit_delta_closure_to_records(storage_kind, bytes, line_end):
370
 
    """Convert a network record to a iterator over stream records.
371
 
 
372
 
    :param storage_kind: The storage kind of the record.
373
 
        Must be 'knit-delta-closure'.
374
 
    :param bytes: The bytes of the record on the network.
375
 
    """
376
 
    generator = _NetworkContentMapGenerator(bytes, line_end)
377
 
    return generator.get_record_stream()
378
 
 
379
 
 
380
 
def knit_network_to_record(storage_kind, bytes, line_end):
381
 
    """Convert a network record to a record object.
382
 
 
383
 
    :param storage_kind: The storage kind of the record.
384
 
    :param bytes: The bytes of the record on the network.
385
 
    """
386
 
    start = line_end
387
 
    line_end = bytes.find('\n', start)
388
 
    key = tuple(bytes[start:line_end].split('\x00'))
389
 
    start = line_end + 1
390
 
    line_end = bytes.find('\n', start)
391
 
    parent_line = bytes[start:line_end]
392
 
    if parent_line == 'None:':
393
 
        parents = None
394
 
    else:
395
 
        parents = tuple(
396
 
            [tuple(segment.split('\x00')) for segment in parent_line.split('\t')
397
 
             if segment])
398
 
    start = line_end + 1
399
 
    noeol = bytes[start] == 'N'
400
 
    if 'ft' in storage_kind:
401
 
        method = 'fulltext'
402
 
    else:
403
 
        method = 'line-delta'
404
 
    build_details = (method, noeol)
405
 
    start = start + 1
406
 
    raw_record = bytes[start:]
407
 
    annotated = 'annotated' in storage_kind
408
 
    return [KnitContentFactory(key, parents, build_details, None, raw_record,
409
 
        annotated, network_bytes=bytes)]
410
 
 
411
 
 
412
290
class KnitContent(object):
413
291
    """Content of a knit version to which deltas can be applied.
414
 
 
 
292
    
415
293
    This is always stored in memory as a list of lines with \n at the end,
416
 
    plus a flag saying if the final ending is really there or not, because that
 
294
    plus a flag saying if the final ending is really there or not, because that 
417
295
    corresponds to the on-disk knit representation.
418
296
    """
419
297
 
508
386
 
509
387
class PlainKnitContent(KnitContent):
510
388
    """Unannotated content.
511
 
 
 
389
    
512
390
    When annotate[_iter] is called on this content, the same version is reported
513
391
    for all lines. Generally, annotate[_iter] is not useful on PlainKnitContent
514
392
    objects.
666
544
 
667
545
        see parse_fulltext which this inverts.
668
546
        """
 
547
        # TODO: jam 20070209 We only do the caching thing to make sure that
 
548
        #       the origin is a valid utf-8 line, eventually we could remove it
669
549
        return ['%s %s' % (o, t) for o, t in content._lines]
670
550
 
671
551
    def lower_line_delta(self, delta):
686
566
        content = knit._get_content(key)
687
567
        # adjust for the fact that serialised annotations are only key suffixes
688
568
        # for this factory.
689
 
        if type(key) is tuple:
 
569
        if type(key) == tuple:
690
570
            prefix = key[:-1]
691
571
            origins = content.annotate()
692
572
            result = []
758
638
 
759
639
    def annotate(self, knit, key):
760
640
        annotator = _KnitAnnotator(knit)
761
 
        return annotator.annotate_flat(key)
 
641
        return annotator.annotate(key)
762
642
 
763
643
 
764
644
 
767
647
 
768
648
    This is only functional enough to run interface tests, it doesn't try to
769
649
    provide a full pack environment.
770
 
 
 
650
    
771
651
    :param annotated: knit annotations are wanted.
772
652
    :param mapper: The mapper from keys to paths.
773
653
    """
783
663
 
784
664
    This is only functional enough to run interface tests, it doesn't try to
785
665
    provide a full pack environment.
786
 
 
 
666
    
787
667
    :param graph: Store a graph.
788
668
    :param delta: Delta compress contents.
789
669
    :param keylength: How long should keys be.
820
700
    versioned_files.writer.end()
821
701
 
822
702
 
823
 
def _get_total_build_size(self, keys, positions):
824
 
    """Determine the total bytes to build these keys.
825
 
 
826
 
    (helper function because _KnitGraphIndex and _KndxIndex work the same, but
827
 
    don't inherit from a common base.)
828
 
 
829
 
    :param keys: Keys that we want to build
830
 
    :param positions: dict of {key, (info, index_memo, comp_parent)} (such
831
 
        as returned by _get_components_positions)
832
 
    :return: Number of bytes to build those keys
833
 
    """
834
 
    all_build_index_memos = {}
835
 
    build_keys = keys
836
 
    while build_keys:
837
 
        next_keys = set()
838
 
        for key in build_keys:
839
 
            # This is mostly for the 'stacked' case
840
 
            # Where we will be getting the data from a fallback
841
 
            if key not in positions:
842
 
                continue
843
 
            _, index_memo, compression_parent = positions[key]
844
 
            all_build_index_memos[key] = index_memo
845
 
            if compression_parent not in all_build_index_memos:
846
 
                next_keys.add(compression_parent)
847
 
        build_keys = next_keys
848
 
    return sum([index_memo[2] for index_memo
849
 
                in all_build_index_memos.itervalues()])
850
 
 
851
 
 
852
703
class KnitVersionedFiles(VersionedFiles):
853
704
    """Storage for many versioned files using knit compression.
854
705
 
855
706
    Backend storage is managed by indices and data objects.
856
707
 
857
 
    :ivar _index: A _KnitGraphIndex or similar that can describe the
858
 
        parents, graph, compression and data location of entries in this
859
 
        KnitVersionedFiles.  Note that this is only the index for
 
708
    :ivar _index: A _KnitGraphIndex or similar that can describe the 
 
709
        parents, graph, compression and data location of entries in this 
 
710
        KnitVersionedFiles.  Note that this is only the index for 
860
711
        *this* vfs; if there are fallbacks they must be queried separately.
861
712
    """
862
713
 
909
760
            # indexes can't directly store that, so we give them
910
761
            # an empty tuple instead.
911
762
            parents = ()
912
 
        line_bytes = ''.join(lines)
913
763
        return self._add(key, lines, parents,
914
 
            parent_texts, left_matching_blocks, nostore_sha, random_id,
915
 
            line_bytes=line_bytes)
916
 
 
917
 
    def _add_text(self, key, parents, text, nostore_sha=None, random_id=False):
918
 
        """See VersionedFiles._add_text()."""
919
 
        self._index._check_write_ok()
920
 
        self._check_add(key, None, random_id, check_content=False)
921
 
        if text.__class__ is not str:
922
 
            raise errors.BzrBadParameterUnicode("text")
923
 
        if parents is None:
924
 
            # The caller might pass None if there is no graph data, but kndx
925
 
            # indexes can't directly store that, so we give them
926
 
            # an empty tuple instead.
927
 
            parents = ()
928
 
        return self._add(key, None, parents,
929
 
            None, None, nostore_sha, random_id,
930
 
            line_bytes=text)
 
764
            parent_texts, left_matching_blocks, nostore_sha, random_id)
931
765
 
932
766
    def _add(self, key, lines, parents, parent_texts,
933
 
        left_matching_blocks, nostore_sha, random_id,
934
 
        line_bytes):
 
767
        left_matching_blocks, nostore_sha, random_id):
935
768
        """Add a set of lines on top of version specified by parents.
936
769
 
937
770
        Any versions not present will be converted into ghosts.
938
 
 
939
 
        :param lines: A list of strings where each one is a single line (has a
940
 
            single newline at the end of the string) This is now optional
941
 
            (callers can pass None). It is left in its location for backwards
942
 
            compatibility. It should ''.join(lines) must == line_bytes
943
 
        :param line_bytes: A single string containing the content
944
 
 
945
 
        We pass both lines and line_bytes because different routes bring the
946
 
        values to this function. And for memory efficiency, we don't want to
947
 
        have to split/join on-demand.
948
771
        """
949
772
        # first thing, if the content is something we don't need to store, find
950
773
        # that out.
 
774
        line_bytes = ''.join(lines)
951
775
        digest = sha_string(line_bytes)
952
776
        if nostore_sha == digest:
953
777
            raise errors.ExistingContent
974
798
 
975
799
        text_length = len(line_bytes)
976
800
        options = []
977
 
        no_eol = False
978
 
        # Note: line_bytes is not modified to add a newline, that is tracked
979
 
        #       via the no_eol flag. 'lines' *is* modified, because that is the
980
 
        #       general values needed by the Content code.
981
 
        if line_bytes and line_bytes[-1] != '\n':
982
 
            options.append('no-eol')
983
 
            no_eol = True
984
 
            # Copy the existing list, or create a new one
985
 
            if lines is None:
986
 
                lines = osutils.split_lines(line_bytes)
987
 
            else:
 
801
        if lines:
 
802
            if lines[-1][-1] != '\n':
 
803
                # copy the contents of lines.
988
804
                lines = lines[:]
989
 
            # Replace the last line with one that ends in a final newline
990
 
            lines[-1] = lines[-1] + '\n'
991
 
        if lines is None:
992
 
            lines = osutils.split_lines(line_bytes)
 
805
                options.append('no-eol')
 
806
                lines[-1] = lines[-1] + '\n'
 
807
                line_bytes += '\n'
993
808
 
994
 
        for element in key[:-1]:
995
 
            if type(element) is not str:
996
 
                raise TypeError("key contains non-strings: %r" % (key,))
997
 
        if key[-1] is None:
998
 
            key = key[:-1] + ('sha1:' + digest,)
999
 
        elif type(key[-1]) is not str:
 
809
        for element in key:
 
810
            if type(element) != str:
1000
811
                raise TypeError("key contains non-strings: %r" % (key,))
1001
812
        # Knit hunks are still last-element only
1002
813
        version_id = key[-1]
1003
814
        content = self._factory.make(lines, version_id)
1004
 
        if no_eol:
 
815
        if 'no-eol' in options:
1005
816
            # Hint to the content object that its text() call should strip the
1006
817
            # EOL.
1007
818
            content._should_strip_eol = True
1019
830
        else:
1020
831
            options.append('fulltext')
1021
832
            # isinstance is slower and we have no hierarchy.
1022
 
            if self._factory.__class__ is KnitPlainFactory:
 
833
            if self._factory.__class__ == KnitPlainFactory:
1023
834
                # Use the already joined bytes saving iteration time in
1024
835
                # _record_to_data.
1025
 
                dense_lines = [line_bytes]
1026
 
                if no_eol:
1027
 
                    dense_lines.append('\n')
1028
836
                size, bytes = self._record_to_data(key, digest,
1029
 
                    lines, dense_lines)
 
837
                    lines, [line_bytes])
1030
838
            else:
1031
839
                # get mixed annotation + content and feed it into the
1032
840
                # serialiser.
1044
852
        """See VersionedFiles.annotate."""
1045
853
        return self._factory.annotate(self, key)
1046
854
 
1047
 
    def get_annotator(self):
1048
 
        return _KnitAnnotator(self)
1049
 
 
1050
 
    def check(self, progress_bar=None, keys=None):
 
855
    def check(self, progress_bar=None):
1051
856
        """See VersionedFiles.check()."""
1052
 
        if keys is None:
1053
 
            return self._logical_check()
1054
 
        else:
1055
 
            # At the moment, check does not extra work over get_record_stream
1056
 
            return self.get_record_stream(keys, 'unordered', True)
1057
 
 
1058
 
    def _logical_check(self):
1059
857
        # This doesn't actually test extraction of everything, but that will
1060
858
        # impact 'bzr check' substantially, and needs to be integrated with
1061
859
        # care. However, it does check for the obvious problem of a delta with
1075
873
    def _check_add(self, key, lines, random_id, check_content):
1076
874
        """check that version_id and lines are safe to add."""
1077
875
        version_id = key[-1]
1078
 
        if version_id is not None:
1079
 
            if contains_whitespace(version_id):
1080
 
                raise InvalidRevisionId(version_id, self)
1081
 
            self.check_not_reserved_id(version_id)
 
876
        if contains_whitespace(version_id):
 
877
            raise InvalidRevisionId(version_id, self)
 
878
        self.check_not_reserved_id(version_id)
1082
879
        # TODO: If random_id==False and the key is already present, we should
1083
880
        # probably check that the existing content is identical to what is
1084
881
        # being inserted, and otherwise raise an exception.  This would make
1094
891
 
1095
892
    def _check_header_version(self, rec, version_id):
1096
893
        """Checks the header version on original format knit records.
1097
 
 
 
894
        
1098
895
        These have the last component of the key embedded in the record.
1099
896
        """
1100
897
        if rec[1] != version_id:
1179
976
            if missing and not allow_missing:
1180
977
                raise errors.RevisionNotPresent(missing.pop(), self)
1181
978
        return component_data
1182
 
 
 
979
       
1183
980
    def _get_content(self, key, parent_texts={}):
1184
981
        """Returns a content object that makes up the specified
1185
982
        version."""
1189
986
            if not self.get_parent_map([key]):
1190
987
                raise RevisionNotPresent(key, self)
1191
988
            return cached_version
1192
 
        generator = _VFContentMapGenerator(self, [key])
1193
 
        return generator._get_content(key)
1194
 
 
1195
 
    def get_known_graph_ancestry(self, keys):
1196
 
        """Get a KnownGraph instance with the ancestry of keys."""
1197
 
        parent_map, missing_keys = self._index.find_ancestry(keys)
1198
 
        for fallback in self._fallback_vfs:
 
989
        text_map, contents_map = self._get_content_maps([key])
 
990
        return contents_map[key]
 
991
 
 
992
    def _get_content_maps(self, keys, nonlocal_keys=None):
 
993
        """Produce maps of text and KnitContents
 
994
        
 
995
        :param keys: The keys to produce content maps for.
 
996
        :param nonlocal_keys: An iterable of keys(possibly intersecting keys)
 
997
            which are known to not be in this knit, but rather in one of the
 
998
            fallback knits.
 
999
        :return: (text_map, content_map) where text_map contains the texts for
 
1000
            the requested versions and content_map contains the KnitContents.
 
1001
        """
 
1002
        # FUTURE: This function could be improved for the 'extract many' case
 
1003
        # by tracking each component and only doing the copy when the number of
 
1004
        # children than need to apply delta's to it is > 1 or it is part of the
 
1005
        # final output.
 
1006
        keys = list(keys)
 
1007
        multiple_versions = len(keys) != 1
 
1008
        record_map = self._get_record_map(keys, allow_missing=True)
 
1009
 
 
1010
        text_map = {}
 
1011
        content_map = {}
 
1012
        final_content = {}
 
1013
        if nonlocal_keys is None:
 
1014
            nonlocal_keys = set()
 
1015
        else:
 
1016
            nonlocal_keys = frozenset(nonlocal_keys)
 
1017
        missing_keys = set(nonlocal_keys)
 
1018
        for source in self._fallback_vfs:
1199
1019
            if not missing_keys:
1200
1020
                break
1201
 
            (f_parent_map, f_missing_keys) = fallback._index.find_ancestry(
1202
 
                                                missing_keys)
1203
 
            parent_map.update(f_parent_map)
1204
 
            missing_keys = f_missing_keys
1205
 
        kg = _mod_graph.KnownGraph(parent_map)
1206
 
        return kg
 
1021
            for record in source.get_record_stream(missing_keys,
 
1022
                'unordered', True):
 
1023
                if record.storage_kind == 'absent':
 
1024
                    continue
 
1025
                missing_keys.remove(record.key)
 
1026
                lines = osutils.chunks_to_lines(record.get_bytes_as('chunked'))
 
1027
                text_map[record.key] = lines
 
1028
                content_map[record.key] = PlainKnitContent(lines, record.key)
 
1029
                if record.key in keys:
 
1030
                    final_content[record.key] = content_map[record.key]
 
1031
        for key in keys:
 
1032
            if key in nonlocal_keys:
 
1033
                # already handled
 
1034
                continue
 
1035
            components = []
 
1036
            cursor = key
 
1037
            while cursor is not None:
 
1038
                try:
 
1039
                    record, record_details, digest, next = record_map[cursor]
 
1040
                except KeyError:
 
1041
                    raise RevisionNotPresent(cursor, self)
 
1042
                components.append((cursor, record, record_details, digest))
 
1043
                cursor = next
 
1044
                if cursor in content_map:
 
1045
                    # no need to plan further back
 
1046
                    components.append((cursor, None, None, None))
 
1047
                    break
 
1048
 
 
1049
            content = None
 
1050
            for (component_id, record, record_details,
 
1051
                 digest) in reversed(components):
 
1052
                if component_id in content_map:
 
1053
                    content = content_map[component_id]
 
1054
                else:
 
1055
                    content, delta = self._factory.parse_record(key[-1],
 
1056
                        record, record_details, content,
 
1057
                        copy_base_content=multiple_versions)
 
1058
                    if multiple_versions:
 
1059
                        content_map[component_id] = content
 
1060
 
 
1061
            final_content[key] = content
 
1062
 
 
1063
            # digest here is the digest from the last applied component.
 
1064
            text = content.text()
 
1065
            actual_sha = sha_strings(text)
 
1066
            if actual_sha != digest:
 
1067
                raise SHA1KnitCorrupt(self, actual_sha, digest, key, text)
 
1068
            text_map[key] = text
 
1069
        return text_map, final_content
1207
1070
 
1208
1071
    def get_parent_map(self, keys):
1209
1072
        """Get a map of the graph parents of keys.
1239
1102
 
1240
1103
    def _get_record_map(self, keys, allow_missing=False):
1241
1104
        """Produce a dictionary of knit records.
1242
 
 
 
1105
        
1243
1106
        :return: {key:(record, record_details, digest, next)}
1244
1107
            record
1245
 
                data returned from read_records (a KnitContentobject)
 
1108
                data returned from read_records
1246
1109
            record_details
1247
1110
                opaque information to pass to parse_record
1248
1111
            digest
1251
1114
                build-parent of the version, i.e. the leftmost ancestor.
1252
1115
                Will be None if the record is not a delta.
1253
1116
        :param keys: The keys to build a map for
1254
 
        :param allow_missing: If some records are missing, rather than
 
1117
        :param allow_missing: If some records are missing, rather than 
1255
1118
            error, just return the data that could be generated.
1256
1119
        """
1257
 
        raw_map = self._get_record_map_unparsed(keys,
1258
 
            allow_missing=allow_missing)
1259
 
        return self._raw_map_to_record_map(raw_map)
1260
 
 
1261
 
    def _raw_map_to_record_map(self, raw_map):
1262
 
        """Parse the contents of _get_record_map_unparsed.
1263
 
 
1264
 
        :return: see _get_record_map.
1265
 
        """
1266
 
        result = {}
1267
 
        for key in raw_map:
1268
 
            data, record_details, next = raw_map[key]
1269
 
            content, digest = self._parse_record(key[-1], data)
1270
 
            result[key] = content, record_details, digest, next
1271
 
        return result
1272
 
 
1273
 
    def _get_record_map_unparsed(self, keys, allow_missing=False):
1274
 
        """Get the raw data for reconstructing keys without parsing it.
1275
 
 
1276
 
        :return: A dict suitable for parsing via _raw_map_to_record_map.
1277
 
            key-> raw_bytes, (method, noeol), compression_parent
1278
 
        """
1279
1120
        # This retries the whole request if anything fails. Potentially we
1280
1121
        # could be a bit more selective. We could track the keys whose records
1281
1122
        # we have successfully found, and then only request the new records
1291
1132
                # n = next
1292
1133
                records = [(key, i_m) for key, (r, i_m, n)
1293
1134
                                       in position_map.iteritems()]
1294
 
                # Sort by the index memo, so that we request records from the
1295
 
                # same pack file together, and in forward-sorted order
1296
 
                records.sort(key=operator.itemgetter(1))
1297
 
                raw_record_map = {}
1298
 
                for key, data in self._read_records_iter_unchecked(records):
 
1135
                record_map = {}
 
1136
                for key, record, digest in self._read_records_iter(records):
1299
1137
                    (record_details, index_memo, next) = position_map[key]
1300
 
                    raw_record_map[key] = data, record_details, next
1301
 
                return raw_record_map
 
1138
                    record_map[key] = record, record_details, digest, next
 
1139
                return record_map
1302
1140
            except errors.RetryWithNewPacks, e:
1303
1141
                self._access.reload_or_raise(e)
1304
1142
 
1305
 
    @classmethod
1306
 
    def _split_by_prefix(cls, keys):
 
1143
    def _split_by_prefix(self, keys):
1307
1144
        """For the given keys, split them up based on their prefix.
1308
1145
 
1309
1146
        To keep memory pressure somewhat under control, split the
1312
1149
        This should be revisited if _get_content_maps() can ever cross
1313
1150
        file-id boundaries.
1314
1151
 
1315
 
        The keys for a given file_id are kept in the same relative order.
1316
 
        Ordering between file_ids is not, though prefix_order will return the
1317
 
        order that the key was first seen.
1318
 
 
1319
1152
        :param keys: An iterable of key tuples
1320
 
        :return: (split_map, prefix_order)
1321
 
            split_map       A dictionary mapping prefix => keys
1322
 
            prefix_order    The order that we saw the various prefixes
 
1153
        :return: A dict of {prefix: [key_list]}
1323
1154
        """
1324
1155
        split_by_prefix = {}
1325
 
        prefix_order = []
1326
1156
        for key in keys:
1327
1157
            if len(key) == 1:
1328
 
                prefix = ''
1329
 
            else:
1330
 
                prefix = key[0]
1331
 
 
1332
 
            if prefix in split_by_prefix:
1333
 
                split_by_prefix[prefix].append(key)
1334
 
            else:
1335
 
                split_by_prefix[prefix] = [key]
1336
 
                prefix_order.append(prefix)
1337
 
        return split_by_prefix, prefix_order
1338
 
 
1339
 
    def _group_keys_for_io(self, keys, non_local_keys, positions,
1340
 
                           _min_buffer_size=_STREAM_MIN_BUFFER_SIZE):
1341
 
        """For the given keys, group them into 'best-sized' requests.
1342
 
 
1343
 
        The idea is to avoid making 1 request per file, but to never try to
1344
 
        unpack an entire 1.5GB source tree in a single pass. Also when
1345
 
        possible, we should try to group requests to the same pack file
1346
 
        together.
1347
 
 
1348
 
        :return: list of (keys, non_local) tuples that indicate what keys
1349
 
            should be fetched next.
1350
 
        """
1351
 
        # TODO: Ideally we would group on 2 factors. We want to extract texts
1352
 
        #       from the same pack file together, and we want to extract all
1353
 
        #       the texts for a given build-chain together. Ultimately it
1354
 
        #       probably needs a better global view.
1355
 
        total_keys = len(keys)
1356
 
        prefix_split_keys, prefix_order = self._split_by_prefix(keys)
1357
 
        prefix_split_non_local_keys, _ = self._split_by_prefix(non_local_keys)
1358
 
        cur_keys = []
1359
 
        cur_non_local = set()
1360
 
        cur_size = 0
1361
 
        result = []
1362
 
        sizes = []
1363
 
        for prefix in prefix_order:
1364
 
            keys = prefix_split_keys[prefix]
1365
 
            non_local = prefix_split_non_local_keys.get(prefix, [])
1366
 
 
1367
 
            this_size = self._index._get_total_build_size(keys, positions)
1368
 
            cur_size += this_size
1369
 
            cur_keys.extend(keys)
1370
 
            cur_non_local.update(non_local)
1371
 
            if cur_size > _min_buffer_size:
1372
 
                result.append((cur_keys, cur_non_local))
1373
 
                sizes.append(cur_size)
1374
 
                cur_keys = []
1375
 
                cur_non_local = set()
1376
 
                cur_size = 0
1377
 
        if cur_keys:
1378
 
            result.append((cur_keys, cur_non_local))
1379
 
            sizes.append(cur_size)
1380
 
        return result
 
1158
                split_by_prefix.setdefault('', []).append(key)
 
1159
            else:
 
1160
                split_by_prefix.setdefault(key[0], []).append(key)
 
1161
        return split_by_prefix
1381
1162
 
1382
1163
    def get_record_stream(self, keys, ordering, include_delta_closure):
1383
1164
        """Get a stream of records for keys.
1396
1177
        if not keys:
1397
1178
            return
1398
1179
        if not self._index.has_graph:
1399
 
            # Cannot sort when no graph has been stored.
 
1180
            # Cannot topological order when no graph has been stored.
1400
1181
            ordering = 'unordered'
1401
1182
 
1402
1183
        remaining_keys = keys
1425
1206
        absent_keys = keys.difference(set(positions))
1426
1207
        # There may be more absent keys : if we're missing the basis component
1427
1208
        # and are trying to include the delta closure.
1428
 
        # XXX: We should not ever need to examine remote sources because we do
1429
 
        # not permit deltas across versioned files boundaries.
1430
1209
        if include_delta_closure:
1431
1210
            needed_from_fallback = set()
1432
1211
            # Build up reconstructable_keys dict.  key:True in this dict means
1458
1237
                    needed_from_fallback.add(key)
1459
1238
        # Double index lookups here : need a unified api ?
1460
1239
        global_map, parent_maps = self._get_parent_map_with_sources(keys)
1461
 
        if ordering in ('topological', 'groupcompress'):
1462
 
            if ordering == 'topological':
1463
 
                # Global topological sort
1464
 
                present_keys = tsort.topo_sort(global_map)
1465
 
            else:
1466
 
                present_keys = sort_groupcompress(global_map)
 
1240
        if ordering == 'topological':
 
1241
            # Global topological sort
 
1242
            present_keys = tsort.topo_sort(global_map)
1467
1243
            # Now group by source:
1468
1244
            source_keys = []
1469
1245
            current_source = None
1479
1255
        else:
1480
1256
            if ordering != 'unordered':
1481
1257
                raise AssertionError('valid values for ordering are:'
1482
 
                    ' "unordered", "groupcompress" or "topological" not: %r'
 
1258
                    ' "unordered" or "topological" not: %r'
1483
1259
                    % (ordering,))
1484
1260
            # Just group by source; remote sources first.
1485
1261
            present_keys = []
1507
1283
            # XXX: get_content_maps performs its own index queries; allow state
1508
1284
            # to be passed in.
1509
1285
            non_local_keys = needed_from_fallback - absent_keys
1510
 
            for keys, non_local_keys in self._group_keys_for_io(present_keys,
1511
 
                                                                non_local_keys,
1512
 
                                                                positions):
1513
 
                generator = _VFContentMapGenerator(self, keys, non_local_keys,
1514
 
                                                   global_map,
1515
 
                                                   ordering=ordering)
1516
 
                for record in generator.get_record_stream():
1517
 
                    yield record
 
1286
            prefix_split_keys = self._split_by_prefix(present_keys)
 
1287
            prefix_split_non_local_keys = self._split_by_prefix(non_local_keys)
 
1288
            for prefix, keys in prefix_split_keys.iteritems():
 
1289
                non_local = prefix_split_non_local_keys.get(prefix, [])
 
1290
                non_local = set(non_local)
 
1291
                text_map, _ = self._get_content_maps(keys, non_local)
 
1292
                for key in keys:
 
1293
                    lines = text_map.pop(key)
 
1294
                    yield ChunkedContentFactory(key, global_map[key], None,
 
1295
                                                lines)
1518
1296
        else:
1519
1297
            for source, keys in source_keys:
1520
1298
                if source is parent_maps[0]:
1521
1299
                    # this KnitVersionedFiles
1522
1300
                    records = [(key, positions[key][1]) for key in keys]
1523
 
                    for key, raw_data in self._read_records_iter_unchecked(records):
 
1301
                    for key, raw_data, sha1 in self._read_records_iter_raw(records):
1524
1302
                        (record_details, index_memo, _) = positions[key]
1525
1303
                        yield KnitContentFactory(key, global_map[key],
1526
 
                            record_details, None, raw_data, self._factory.annotated, None)
 
1304
                            record_details, sha1, raw_data, self._factory.annotated, None)
1527
1305
                else:
1528
1306
                    vf = self._fallback_vfs[parent_maps.index(source) - 1]
1529
1307
                    for record in vf.get_record_stream(keys, ordering,
1552
1330
    def insert_record_stream(self, stream):
1553
1331
        """Insert a record stream into this container.
1554
1332
 
1555
 
        :param stream: A stream of records to insert.
 
1333
        :param stream: A stream of records to insert. 
1556
1334
        :return: None
1557
1335
        :seealso VersionedFiles.get_record_stream:
1558
1336
        """
1598
1376
        # key = basis_parent, value = index entry to add
1599
1377
        buffered_index_entries = {}
1600
1378
        for record in stream:
1601
 
            kind = record.storage_kind
1602
 
            if kind.startswith('knit-') and kind.endswith('-gz'):
1603
 
                # Check that the ID in the header of the raw knit bytes matches
1604
 
                # the record metadata.
1605
 
                raw_data = record._raw_record
1606
 
                df, rec = self._parse_record_header(record.key, raw_data)
1607
 
                df.close()
1608
 
            buffered = False
1609
1379
            parents = record.parents
1610
1380
            if record.storage_kind in delta_types:
1611
1381
                # TODO: eventually the record itself should track
1638
1408
                    except KeyError:
1639
1409
                        adapter_key = (record.storage_kind, "knit-ft-gz")
1640
1410
                        adapter = get_adapter(adapter_key)
1641
 
                    bytes = adapter.get_bytes(record)
 
1411
                    bytes = adapter.get_bytes(
 
1412
                        record, record.get_bytes_as(record.storage_kind))
1642
1413
                else:
1643
 
                    # It's a knit record, it has a _raw_record field (even if
1644
 
                    # it was reconstituted from a network stream).
1645
 
                    bytes = record._raw_record
 
1414
                    bytes = record.get_bytes_as(record.storage_kind)
1646
1415
                options = [record._build_details[0]]
1647
1416
                if record._build_details[1]:
1648
1417
                    options.append('no-eol')
1657
1426
                access_memo = self._access.add_raw_records(
1658
1427
                    [(record.key, len(bytes))], bytes)[0]
1659
1428
                index_entry = (record.key, options, access_memo, parents)
 
1429
                buffered = False
1660
1430
                if 'fulltext' not in options:
1661
1431
                    # Not a fulltext, so we need to make sure the compression
1662
1432
                    # parent will also be present.
1678
1448
            elif record.storage_kind == 'chunked':
1679
1449
                self.add_lines(record.key, parents,
1680
1450
                    osutils.chunks_to_lines(record.get_bytes_as('chunked')))
 
1451
            elif record.storage_kind == 'fulltext':
 
1452
                self.add_lines(record.key, parents,
 
1453
                    split_lines(record.get_bytes_as('fulltext')))
1681
1454
            else:
1682
 
                # Not suitable for direct insertion as a
 
1455
                # Not a fulltext, and not suitable for direct insertion as a
1683
1456
                # delta, either because it's not the right format, or this
1684
1457
                # KnitVersionedFiles doesn't permit deltas (_max_delta_chain ==
1685
1458
                # 0) or because it depends on a base only present in the
1686
1459
                # fallback kvfs.
1687
 
                self._access.flush()
1688
 
                try:
1689
 
                    # Try getting a fulltext directly from the record.
1690
 
                    bytes = record.get_bytes_as('fulltext')
1691
 
                except errors.UnavailableRepresentation:
1692
 
                    adapter_key = record.storage_kind, 'fulltext'
1693
 
                    adapter = get_adapter(adapter_key)
1694
 
                    bytes = adapter.get_bytes(record)
1695
 
                lines = split_lines(bytes)
 
1460
                adapter_key = record.storage_kind, 'fulltext'
 
1461
                adapter = get_adapter(adapter_key)
 
1462
                lines = split_lines(adapter.get_bytes(
 
1463
                    record, record.get_bytes_as(record.storage_kind)))
1696
1464
                try:
1697
1465
                    self.add_lines(record.key, parents, lines)
1698
1466
                except errors.RevisionAlreadyPresent:
1699
1467
                    pass
1700
1468
            # Add any records whose basis parent is now available.
1701
 
            if not buffered:
1702
 
                added_keys = [record.key]
1703
 
                while added_keys:
1704
 
                    key = added_keys.pop(0)
1705
 
                    if key in buffered_index_entries:
1706
 
                        index_entries = buffered_index_entries[key]
1707
 
                        self._index.add_records(index_entries)
1708
 
                        added_keys.extend(
1709
 
                            [index_entry[0] for index_entry in index_entries])
1710
 
                        del buffered_index_entries[key]
 
1469
            added_keys = [record.key]
 
1470
            while added_keys:
 
1471
                key = added_keys.pop(0)
 
1472
                if key in buffered_index_entries:
 
1473
                    index_entries = buffered_index_entries[key]
 
1474
                    self._index.add_records(index_entries)
 
1475
                    added_keys.extend(
 
1476
                        [index_entry[0] for index_entry in index_entries])
 
1477
                    del buffered_index_entries[key]
 
1478
        # If there were any deltas which had a missing basis parent, error.
1711
1479
        if buffered_index_entries:
1712
 
            # There were index entries buffered at the end of the stream,
1713
 
            # So these need to be added (if the index supports holding such
1714
 
            # entries for later insertion)
1715
 
            all_entries = []
1716
 
            for key in buffered_index_entries:
1717
 
                index_entries = buffered_index_entries[key]
1718
 
                all_entries.extend(index_entries)
1719
 
            self._index.add_records(
1720
 
                all_entries, missing_compression_parents=True)
1721
 
 
1722
 
    def get_missing_compression_parent_keys(self):
1723
 
        """Return an iterable of keys of missing compression parents.
1724
 
 
1725
 
        Check this after calling insert_record_stream to find out if there are
1726
 
        any missing compression parents.  If there are, the records that
1727
 
        depend on them are not able to be inserted safely. For atomic
1728
 
        KnitVersionedFiles built on packs, the transaction should be aborted or
1729
 
        suspended - commit will fail at this point. Nonatomic knits will error
1730
 
        earlier because they have no staging area to put pending entries into.
1731
 
        """
1732
 
        return self._index.get_missing_compression_parents()
 
1480
            from pprint import pformat
 
1481
            raise errors.BzrCheckError(
 
1482
                "record_stream refers to compression parents not in %r:\n%s"
 
1483
                % (self, pformat(sorted(buffered_index_entries.keys()))))
1733
1484
 
1734
1485
    def iter_lines_added_or_present_in_keys(self, keys, pb=None):
1735
1486
        """Iterate over the lines in the versioned files from keys.
1752
1503
         * If a requested key did not change any lines (or didn't have any
1753
1504
           lines), it may not be mentioned at all in the result.
1754
1505
 
1755
 
        :param pb: Progress bar supplied by caller.
1756
1506
        :return: An iterator over (line, key).
1757
1507
        """
1758
1508
        if pb is None:
1759
 
            pb = ui.ui_factory.nested_progress_bar()
 
1509
            pb = progress.DummyProgress()
1760
1510
        keys = set(keys)
1761
1511
        total = len(keys)
1762
1512
        done = False
1772
1522
                        key_records.append((key, details[0]))
1773
1523
                records_iter = enumerate(self._read_records_iter(key_records))
1774
1524
                for (key_idx, (key, data, sha_value)) in records_iter:
1775
 
                    pb.update('Walking content', key_idx, total)
 
1525
                    pb.update('Walking content.', key_idx, total)
1776
1526
                    compression_parent = build_details[key][1]
1777
1527
                    if compression_parent is None:
1778
1528
                        # fulltext
1779
1529
                        line_iterator = self._factory.get_fulltext_content(data)
1780
1530
                    else:
1781
 
                        # Delta
 
1531
                        # Delta 
1782
1532
                        line_iterator = self._factory.get_linedelta_content(data)
1783
1533
                    # Now that we are yielding the data for this key, remove it
1784
1534
                    # from the list
1795
1545
        # If there are still keys we've not yet found, we look in the fallback
1796
1546
        # vfs, and hope to find them there.  Note that if the keys are found
1797
1547
        # but had no changes or no content, the fallback may not return
1798
 
        # anything.
 
1548
        # anything.  
1799
1549
        if keys and not self._fallback_vfs:
1800
1550
            # XXX: strictly the second parameter is meant to be the file id
1801
1551
            # but it's not easily accessible here.
1808
1558
                source_keys.add(key)
1809
1559
                yield line, key
1810
1560
            keys.difference_update(source_keys)
1811
 
        pb.update('Walking content', total, total)
 
1561
        pb.update('Walking content.', total, total)
1812
1562
 
1813
1563
    def _make_line_delta(self, delta_seq, new_content):
1814
1564
        """Generate a line delta from delta_seq and new_content."""
1823
1573
                           delta=None, annotated=None,
1824
1574
                           left_matching_blocks=None):
1825
1575
        """Merge annotations for content and generate deltas.
1826
 
 
 
1576
        
1827
1577
        This is done by comparing the annotations based on changes to the text
1828
1578
        and generating a delta on the resulting full texts. If annotations are
1829
1579
        not being created then a simple delta is created.
1911
1661
                                 rec[1], record_contents))
1912
1662
        if last_line != 'end %s\n' % rec[1]:
1913
1663
            raise KnitCorrupt(self,
1914
 
                              'unexpected version end line %r, wanted %r'
 
1664
                              'unexpected version end line %r, wanted %r' 
1915
1665
                              % (last_line, rec[1]))
1916
1666
        df.close()
1917
1667
        return rec, record_contents
1934
1684
        if not needed_records:
1935
1685
            return
1936
1686
 
1937
 
        # The transport optimizes the fetching as well
 
1687
        # The transport optimizes the fetching as well 
1938
1688
        # (ie, reads continuous ranges.)
1939
1689
        raw_data = self._access.get_raw_records(
1940
1690
            [index_memo for key, index_memo in needed_records])
1950
1700
        This unpacks enough of the text record to validate the id is
1951
1701
        as expected but thats all.
1952
1702
 
1953
 
        Each item the iterator yields is (key, bytes,
1954
 
            expected_sha1_of_full_text).
1955
 
        """
1956
 
        for key, data in self._read_records_iter_unchecked(records):
1957
 
            # validate the header (note that we can only use the suffix in
1958
 
            # current knit records).
1959
 
            df, rec = self._parse_record_header(key, data)
1960
 
            df.close()
1961
 
            yield key, data, rec[3]
1962
 
 
1963
 
    def _read_records_iter_unchecked(self, records):
1964
 
        """Read text records from data file and yield raw data.
1965
 
 
1966
 
        No validation is done.
1967
 
 
1968
 
        Yields tuples of (key, data).
 
1703
        Each item the iterator yields is (key, bytes, sha1_of_full_text).
1969
1704
        """
1970
1705
        # setup an iterator of the external records:
1971
1706
        # uses readv so nice and fast we hope.
1977
1712
 
1978
1713
        for key, index_memo in records:
1979
1714
            data = raw_records.next()
1980
 
            yield key, data
 
1715
            # validate the header (note that we can only use the suffix in
 
1716
            # current knit records).
 
1717
            df, rec = self._parse_record_header(key, data)
 
1718
            df.close()
 
1719
            yield key, data, rec[3]
1981
1720
 
1982
1721
    def _record_to_data(self, key, digest, lines, dense_lines=None):
1983
1722
        """Convert key, digest, lines into a raw data block.
1984
 
 
 
1723
        
1985
1724
        :param key: The key of the record. Currently keys are always serialised
1986
1725
            using just the trailing component.
1987
1726
        :param dense_lines: The bytes of lines but in a denser form. For
1992
1731
            function spends less time resizing the final string.
1993
1732
        :return: (len, a StringIO instance with the raw data ready to read.)
1994
1733
        """
1995
 
        chunks = ["version %s %d %s\n" % (key[-1], len(lines), digest)]
1996
 
        chunks.extend(dense_lines or lines)
1997
 
        chunks.append("end %s\n" % key[-1])
1998
 
        for chunk in chunks:
1999
 
            if type(chunk) is not str:
2000
 
                raise AssertionError(
2001
 
                    'data must be plain bytes was %s' % type(chunk))
 
1734
        # Note: using a string copy here increases memory pressure with e.g.
 
1735
        # ISO's, but it is about 3 seconds faster on a 1.2Ghz intel machine
 
1736
        # when doing the initial commit of a mozilla tree. RBC 20070921
 
1737
        bytes = ''.join(chain(
 
1738
            ["version %s %d %s\n" % (key[-1],
 
1739
                                     len(lines),
 
1740
                                     digest)],
 
1741
            dense_lines or lines,
 
1742
            ["end %s\n" % key[-1]]))
 
1743
        if type(bytes) != str:
 
1744
            raise AssertionError(
 
1745
                'data must be plain bytes was %s' % type(bytes))
2002
1746
        if lines and lines[-1][-1] != '\n':
2003
1747
            raise ValueError('corrupt lines value %r' % lines)
2004
 
        compressed_bytes = tuned_gzip.chunks_to_gzip(chunks)
 
1748
        compressed_bytes = tuned_gzip.bytes_to_gzip(bytes)
2005
1749
        return len(compressed_bytes), compressed_bytes
2006
1750
 
2007
1751
    def _split_header(self, line):
2022
1766
        return result
2023
1767
 
2024
1768
 
2025
 
class _ContentMapGenerator(object):
2026
 
    """Generate texts or expose raw deltas for a set of texts."""
2027
 
 
2028
 
    def __init__(self, ordering='unordered'):
2029
 
        self._ordering = ordering
2030
 
 
2031
 
    def _get_content(self, key):
2032
 
        """Get the content object for key."""
2033
 
        # Note that _get_content is only called when the _ContentMapGenerator
2034
 
        # has been constructed with just one key requested for reconstruction.
2035
 
        if key in self.nonlocal_keys:
2036
 
            record = self.get_record_stream().next()
2037
 
            # Create a content object on the fly
2038
 
            lines = osutils.chunks_to_lines(record.get_bytes_as('chunked'))
2039
 
            return PlainKnitContent(lines, record.key)
2040
 
        else:
2041
 
            # local keys we can ask for directly
2042
 
            return self._get_one_work(key)
2043
 
 
2044
 
    def get_record_stream(self):
2045
 
        """Get a record stream for the keys requested during __init__."""
2046
 
        for record in self._work():
2047
 
            yield record
2048
 
 
2049
 
    def _work(self):
2050
 
        """Produce maps of text and KnitContents as dicts.
2051
 
 
2052
 
        :return: (text_map, content_map) where text_map contains the texts for
2053
 
            the requested versions and content_map contains the KnitContents.
2054
 
        """
2055
 
        # NB: By definition we never need to read remote sources unless texts
2056
 
        # are requested from them: we don't delta across stores - and we
2057
 
        # explicitly do not want to to prevent data loss situations.
2058
 
        if self.global_map is None:
2059
 
            self.global_map = self.vf.get_parent_map(self.keys)
2060
 
        nonlocal_keys = self.nonlocal_keys
2061
 
 
2062
 
        missing_keys = set(nonlocal_keys)
2063
 
        # Read from remote versioned file instances and provide to our caller.
2064
 
        for source in self.vf._fallback_vfs:
2065
 
            if not missing_keys:
2066
 
                break
2067
 
            # Loop over fallback repositories asking them for texts - ignore
2068
 
            # any missing from a particular fallback.
2069
 
            for record in source.get_record_stream(missing_keys,
2070
 
                self._ordering, True):
2071
 
                if record.storage_kind == 'absent':
2072
 
                    # Not in thie particular stream, may be in one of the
2073
 
                    # other fallback vfs objects.
2074
 
                    continue
2075
 
                missing_keys.remove(record.key)
2076
 
                yield record
2077
 
 
2078
 
        if self._raw_record_map is None:
2079
 
            raise AssertionError('_raw_record_map should have been filled')
2080
 
        first = True
2081
 
        for key in self.keys:
2082
 
            if key in self.nonlocal_keys:
2083
 
                continue
2084
 
            yield LazyKnitContentFactory(key, self.global_map[key], self, first)
2085
 
            first = False
2086
 
 
2087
 
    def _get_one_work(self, requested_key):
2088
 
        # Now, if we have calculated everything already, just return the
2089
 
        # desired text.
2090
 
        if requested_key in self._contents_map:
2091
 
            return self._contents_map[requested_key]
2092
 
        # To simplify things, parse everything at once - code that wants one text
2093
 
        # probably wants them all.
2094
 
        # FUTURE: This function could be improved for the 'extract many' case
2095
 
        # by tracking each component and only doing the copy when the number of
2096
 
        # children than need to apply delta's to it is > 1 or it is part of the
2097
 
        # final output.
2098
 
        multiple_versions = len(self.keys) != 1
2099
 
        if self._record_map is None:
2100
 
            self._record_map = self.vf._raw_map_to_record_map(
2101
 
                self._raw_record_map)
2102
 
        record_map = self._record_map
2103
 
        # raw_record_map is key:
2104
 
        # Have read and parsed records at this point.
2105
 
        for key in self.keys:
2106
 
            if key in self.nonlocal_keys:
2107
 
                # already handled
2108
 
                continue
2109
 
            components = []
2110
 
            cursor = key
2111
 
            while cursor is not None:
2112
 
                try:
2113
 
                    record, record_details, digest, next = record_map[cursor]
2114
 
                except KeyError:
2115
 
                    raise RevisionNotPresent(cursor, self)
2116
 
                components.append((cursor, record, record_details, digest))
2117
 
                cursor = next
2118
 
                if cursor in self._contents_map:
2119
 
                    # no need to plan further back
2120
 
                    components.append((cursor, None, None, None))
2121
 
                    break
2122
 
 
2123
 
            content = None
2124
 
            for (component_id, record, record_details,
2125
 
                 digest) in reversed(components):
2126
 
                if component_id in self._contents_map:
2127
 
                    content = self._contents_map[component_id]
2128
 
                else:
2129
 
                    content, delta = self._factory.parse_record(key[-1],
2130
 
                        record, record_details, content,
2131
 
                        copy_base_content=multiple_versions)
2132
 
                    if multiple_versions:
2133
 
                        self._contents_map[component_id] = content
2134
 
 
2135
 
            # digest here is the digest from the last applied component.
2136
 
            text = content.text()
2137
 
            actual_sha = sha_strings(text)
2138
 
            if actual_sha != digest:
2139
 
                raise SHA1KnitCorrupt(self, actual_sha, digest, key, text)
2140
 
        if multiple_versions:
2141
 
            return self._contents_map[requested_key]
2142
 
        else:
2143
 
            return content
2144
 
 
2145
 
    def _wire_bytes(self):
2146
 
        """Get the bytes to put on the wire for 'key'.
2147
 
 
2148
 
        The first collection of bytes asked for returns the serialised
2149
 
        raw_record_map and the additional details (key, parent) for key.
2150
 
        Subsequent calls return just the additional details (key, parent).
2151
 
        The wire storage_kind given for the first key is 'knit-delta-closure',
2152
 
        For subsequent keys it is 'knit-delta-closure-ref'.
2153
 
 
2154
 
        :param key: A key from the content generator.
2155
 
        :return: Bytes to put on the wire.
2156
 
        """
2157
 
        lines = []
2158
 
        # kind marker for dispatch on the far side,
2159
 
        lines.append('knit-delta-closure')
2160
 
        # Annotated or not
2161
 
        if self.vf._factory.annotated:
2162
 
            lines.append('annotated')
2163
 
        else:
2164
 
            lines.append('')
2165
 
        # then the list of keys
2166
 
        lines.append('\t'.join(['\x00'.join(key) for key in self.keys
2167
 
            if key not in self.nonlocal_keys]))
2168
 
        # then the _raw_record_map in serialised form:
2169
 
        map_byte_list = []
2170
 
        # for each item in the map:
2171
 
        # 1 line with key
2172
 
        # 1 line with parents if the key is to be yielded (None: for None, '' for ())
2173
 
        # one line with method
2174
 
        # one line with noeol
2175
 
        # one line with next ('' for None)
2176
 
        # one line with byte count of the record bytes
2177
 
        # the record bytes
2178
 
        for key, (record_bytes, (method, noeol), next) in \
2179
 
            self._raw_record_map.iteritems():
2180
 
            key_bytes = '\x00'.join(key)
2181
 
            parents = self.global_map.get(key, None)
2182
 
            if parents is None:
2183
 
                parent_bytes = 'None:'
2184
 
            else:
2185
 
                parent_bytes = '\t'.join('\x00'.join(key) for key in parents)
2186
 
            method_bytes = method
2187
 
            if noeol:
2188
 
                noeol_bytes = "T"
2189
 
            else:
2190
 
                noeol_bytes = "F"
2191
 
            if next:
2192
 
                next_bytes = '\x00'.join(next)
2193
 
            else:
2194
 
                next_bytes = ''
2195
 
            map_byte_list.append('%s\n%s\n%s\n%s\n%s\n%d\n%s' % (
2196
 
                key_bytes, parent_bytes, method_bytes, noeol_bytes, next_bytes,
2197
 
                len(record_bytes), record_bytes))
2198
 
        map_bytes = ''.join(map_byte_list)
2199
 
        lines.append(map_bytes)
2200
 
        bytes = '\n'.join(lines)
2201
 
        return bytes
2202
 
 
2203
 
 
2204
 
class _VFContentMapGenerator(_ContentMapGenerator):
2205
 
    """Content map generator reading from a VersionedFiles object."""
2206
 
 
2207
 
    def __init__(self, versioned_files, keys, nonlocal_keys=None,
2208
 
        global_map=None, raw_record_map=None, ordering='unordered'):
2209
 
        """Create a _ContentMapGenerator.
2210
 
 
2211
 
        :param versioned_files: The versioned files that the texts are being
2212
 
            extracted from.
2213
 
        :param keys: The keys to produce content maps for.
2214
 
        :param nonlocal_keys: An iterable of keys(possibly intersecting keys)
2215
 
            which are known to not be in this knit, but rather in one of the
2216
 
            fallback knits.
2217
 
        :param global_map: The result of get_parent_map(keys) (or a supermap).
2218
 
            This is required if get_record_stream() is to be used.
2219
 
        :param raw_record_map: A unparsed raw record map to use for answering
2220
 
            contents.
2221
 
        """
2222
 
        _ContentMapGenerator.__init__(self, ordering=ordering)
2223
 
        # The vf to source data from
2224
 
        self.vf = versioned_files
2225
 
        # The keys desired
2226
 
        self.keys = list(keys)
2227
 
        # Keys known to be in fallback vfs objects
2228
 
        if nonlocal_keys is None:
2229
 
            self.nonlocal_keys = set()
2230
 
        else:
2231
 
            self.nonlocal_keys = frozenset(nonlocal_keys)
2232
 
        # Parents data for keys to be returned in get_record_stream
2233
 
        self.global_map = global_map
2234
 
        # The chunked lists for self.keys in text form
2235
 
        self._text_map = {}
2236
 
        # A cache of KnitContent objects used in extracting texts.
2237
 
        self._contents_map = {}
2238
 
        # All the knit records needed to assemble the requested keys as full
2239
 
        # texts.
2240
 
        self._record_map = None
2241
 
        if raw_record_map is None:
2242
 
            self._raw_record_map = self.vf._get_record_map_unparsed(keys,
2243
 
                allow_missing=True)
2244
 
        else:
2245
 
            self._raw_record_map = raw_record_map
2246
 
        # the factory for parsing records
2247
 
        self._factory = self.vf._factory
2248
 
 
2249
 
 
2250
 
class _NetworkContentMapGenerator(_ContentMapGenerator):
2251
 
    """Content map generator sourced from a network stream."""
2252
 
 
2253
 
    def __init__(self, bytes, line_end):
2254
 
        """Construct a _NetworkContentMapGenerator from a bytes block."""
2255
 
        self._bytes = bytes
2256
 
        self.global_map = {}
2257
 
        self._raw_record_map = {}
2258
 
        self._contents_map = {}
2259
 
        self._record_map = None
2260
 
        self.nonlocal_keys = []
2261
 
        # Get access to record parsing facilities
2262
 
        self.vf = KnitVersionedFiles(None, None)
2263
 
        start = line_end
2264
 
        # Annotated or not
2265
 
        line_end = bytes.find('\n', start)
2266
 
        line = bytes[start:line_end]
2267
 
        start = line_end + 1
2268
 
        if line == 'annotated':
2269
 
            self._factory = KnitAnnotateFactory()
2270
 
        else:
2271
 
            self._factory = KnitPlainFactory()
2272
 
        # list of keys to emit in get_record_stream
2273
 
        line_end = bytes.find('\n', start)
2274
 
        line = bytes[start:line_end]
2275
 
        start = line_end + 1
2276
 
        self.keys = [
2277
 
            tuple(segment.split('\x00')) for segment in line.split('\t')
2278
 
            if segment]
2279
 
        # now a loop until the end. XXX: It would be nice if this was just a
2280
 
        # bunch of the same records as get_record_stream(..., False) gives, but
2281
 
        # there is a decent sized gap stopping that at the moment.
2282
 
        end = len(bytes)
2283
 
        while start < end:
2284
 
            # 1 line with key
2285
 
            line_end = bytes.find('\n', start)
2286
 
            key = tuple(bytes[start:line_end].split('\x00'))
2287
 
            start = line_end + 1
2288
 
            # 1 line with parents (None: for None, '' for ())
2289
 
            line_end = bytes.find('\n', start)
2290
 
            line = bytes[start:line_end]
2291
 
            if line == 'None:':
2292
 
                parents = None
2293
 
            else:
2294
 
                parents = tuple(
2295
 
                    [tuple(segment.split('\x00')) for segment in line.split('\t')
2296
 
                     if segment])
2297
 
            self.global_map[key] = parents
2298
 
            start = line_end + 1
2299
 
            # one line with method
2300
 
            line_end = bytes.find('\n', start)
2301
 
            line = bytes[start:line_end]
2302
 
            method = line
2303
 
            start = line_end + 1
2304
 
            # one line with noeol
2305
 
            line_end = bytes.find('\n', start)
2306
 
            line = bytes[start:line_end]
2307
 
            noeol = line == "T"
2308
 
            start = line_end + 1
2309
 
            # one line with next ('' for None)
2310
 
            line_end = bytes.find('\n', start)
2311
 
            line = bytes[start:line_end]
2312
 
            if not line:
2313
 
                next = None
2314
 
            else:
2315
 
                next = tuple(bytes[start:line_end].split('\x00'))
2316
 
            start = line_end + 1
2317
 
            # one line with byte count of the record bytes
2318
 
            line_end = bytes.find('\n', start)
2319
 
            line = bytes[start:line_end]
2320
 
            count = int(line)
2321
 
            start = line_end + 1
2322
 
            # the record bytes
2323
 
            record_bytes = bytes[start:start+count]
2324
 
            start = start + count
2325
 
            # put it in the map
2326
 
            self._raw_record_map[key] = (record_bytes, (method, noeol), next)
2327
 
 
2328
 
    def get_record_stream(self):
2329
 
        """Get a record stream for for keys requested by the bytestream."""
2330
 
        first = True
2331
 
        for key in self.keys:
2332
 
            yield LazyKnitContentFactory(key, self.global_map[key], self, first)
2333
 
            first = False
2334
 
 
2335
 
    def _wire_bytes(self):
2336
 
        return self._bytes
2337
 
 
2338
 
 
2339
1769
class _KndxIndex(object):
2340
1770
    """Manages knit index files
2341
1771
 
2355
1785
 
2356
1786
    Duplicate entries may be written to the index for a single version id
2357
1787
    if this is done then the latter one completely replaces the former:
2358
 
    this allows updates to correct version and parent information.
 
1788
    this allows updates to correct version and parent information. 
2359
1789
    Note that the two entries may share the delta, and that successive
2360
1790
    annotations and references MUST point to the first entry.
2361
1791
 
2362
1792
    The index file on disc contains a header, followed by one line per knit
2363
1793
    record. The same revision can be present in an index file more than once.
2364
 
    The first occurrence gets assigned a sequence number starting from 0.
2365
 
 
 
1794
    The first occurrence gets assigned a sequence number starting from 0. 
 
1795
    
2366
1796
    The format of a single line is
2367
1797
    REVISION_ID FLAGS BYTE_OFFSET LENGTH( PARENT_ID|PARENT_SEQUENCE_ID)* :\n
2368
1798
    REVISION_ID is a utf8-encoded revision id
2369
 
    FLAGS is a comma separated list of flags about the record. Values include
 
1799
    FLAGS is a comma separated list of flags about the record. Values include 
2370
1800
        no-eol, line-delta, fulltext.
2371
1801
    BYTE_OFFSET is the ascii representation of the byte offset in the data file
2372
 
        that the compressed data starts at.
 
1802
        that the the compressed data starts at.
2373
1803
    LENGTH is the ascii representation of the length of the data file.
2374
1804
    PARENT_ID a utf-8 revision id prefixed by a '.' that is a parent of
2375
1805
        REVISION_ID.
2376
1806
    PARENT_SEQUENCE_ID the ascii representation of the sequence number of a
2377
1807
        revision id already in the knit that is a parent of REVISION_ID.
2378
1808
    The ' :' marker is the end of record marker.
2379
 
 
 
1809
    
2380
1810
    partial writes:
2381
1811
    when a write is interrupted to the index file, it will result in a line
2382
1812
    that does not end in ' :'. If the ' :' is not present at the end of a line,
2407
1837
        self._reset_cache()
2408
1838
        self.has_graph = True
2409
1839
 
2410
 
    def add_records(self, records, random_id=False, missing_compression_parents=False):
 
1840
    def add_records(self, records, random_id=False):
2411
1841
        """Add multiple records to the index.
2412
 
 
 
1842
        
2413
1843
        :param records: a list of tuples:
2414
1844
                         (key, options, access_memo, parents).
2415
1845
        :param random_id: If True the ids being added were randomly generated
2416
1846
            and no check for existence will be performed.
2417
 
        :param missing_compression_parents: If True the records being added are
2418
 
            only compressed against texts already in the index (or inside
2419
 
            records). If False the records all refer to unavailable texts (or
2420
 
            texts inside records) as compression parents.
2421
1847
        """
2422
 
        if missing_compression_parents:
2423
 
            # It might be nice to get the edge of the records. But keys isn't
2424
 
            # _wrong_.
2425
 
            keys = sorted(record[0] for record in records)
2426
 
            raise errors.RevisionNotPresent(keys, self)
2427
1848
        paths = {}
2428
1849
        for record in records:
2429
1850
            key = record[0]
2446
1867
                    line = "\n%s %s %s %s %s :" % (
2447
1868
                        key[-1], ','.join(options), pos, size,
2448
1869
                        self._dictionary_compress(parents))
2449
 
                    if type(line) is not str:
 
1870
                    if type(line) != str:
2450
1871
                        raise AssertionError(
2451
1872
                            'data must be utf8 was %s' % type(line))
2452
1873
                    lines.append(line)
2460
1881
                self._kndx_cache[prefix] = (orig_cache, orig_history)
2461
1882
                raise
2462
1883
 
2463
 
    def scan_unvalidated_index(self, graph_index):
2464
 
        """See _KnitGraphIndex.scan_unvalidated_index."""
2465
 
        # Because kndx files do not support atomic insertion via separate index
2466
 
        # files, they do not support this method.
2467
 
        raise NotImplementedError(self.scan_unvalidated_index)
2468
 
 
2469
 
    def get_missing_compression_parents(self):
2470
 
        """See _KnitGraphIndex.get_missing_compression_parents."""
2471
 
        # Because kndx files do not support atomic insertion via separate index
2472
 
        # files, they do not support this method.
2473
 
        raise NotImplementedError(self.get_missing_compression_parents)
2474
 
 
2475
1884
    def _cache_key(self, key, options, pos, size, parent_keys):
2476
1885
        """Cache a version record in the history array and index cache.
2477
1886
 
2584
1993
        except KeyError:
2585
1994
            raise RevisionNotPresent(key, self)
2586
1995
 
2587
 
    def find_ancestry(self, keys):
2588
 
        """See CombinedGraphIndex.find_ancestry()"""
2589
 
        prefixes = set(key[:-1] for key in keys)
2590
 
        self._load_prefixes(prefixes)
2591
 
        result = {}
2592
 
        parent_map = {}
2593
 
        missing_keys = set()
2594
 
        pending_keys = list(keys)
2595
 
        # This assumes that keys will not reference parents in a different
2596
 
        # prefix, which is accurate so far.
2597
 
        while pending_keys:
2598
 
            key = pending_keys.pop()
2599
 
            if key in parent_map:
2600
 
                continue
2601
 
            prefix = key[:-1]
2602
 
            try:
2603
 
                suffix_parents = self._kndx_cache[prefix][0][key[-1]][4]
2604
 
            except KeyError:
2605
 
                missing_keys.add(key)
2606
 
            else:
2607
 
                parent_keys = tuple([prefix + (suffix,)
2608
 
                                     for suffix in suffix_parents])
2609
 
                parent_map[key] = parent_keys
2610
 
                pending_keys.extend([p for p in parent_keys
2611
 
                                        if p not in parent_map])
2612
 
        return parent_map, missing_keys
2613
 
 
2614
1996
    def get_parent_map(self, keys):
2615
1997
        """Get a map of the parents of keys.
2616
1998
 
2637
2019
 
2638
2020
    def get_position(self, key):
2639
2021
        """Return details needed to access the version.
2640
 
 
 
2022
        
2641
2023
        :return: a tuple (key, data position, size) to hand to the access
2642
2024
            logic to get the record.
2643
2025
        """
2647
2029
        return key, entry[2], entry[3]
2648
2030
 
2649
2031
    has_key = _mod_index._has_key_from_parent_map
2650
 
 
 
2032
    
2651
2033
    def _init_index(self, path, extra_lines=[]):
2652
2034
        """Initialize an index."""
2653
2035
        sio = StringIO()
2662
2044
 
2663
2045
    def keys(self):
2664
2046
        """Get all the keys in the collection.
2665
 
 
 
2047
        
2666
2048
        The keys are not ordered.
2667
2049
        """
2668
2050
        result = set()
2669
2051
        # Identify all key prefixes.
2670
2052
        # XXX: A bit hacky, needs polish.
2671
 
        if type(self._mapper) is ConstantMapper:
 
2053
        if type(self._mapper) == ConstantMapper:
2672
2054
            prefixes = [()]
2673
2055
        else:
2674
2056
            relpaths = set()
2681
2063
            for suffix in self._kndx_cache[prefix][1]:
2682
2064
                result.add(prefix + (suffix,))
2683
2065
        return result
2684
 
 
 
2066
    
2685
2067
    def _load_prefixes(self, prefixes):
2686
2068
        """Load the indices for prefixes."""
2687
2069
        self._check_read()
2706
2088
                    del self._history
2707
2089
                except NoSuchFile:
2708
2090
                    self._kndx_cache[prefix] = ({}, [])
2709
 
                    if type(self._mapper) is ConstantMapper:
 
2091
                    if type(self._mapper) == ConstantMapper:
2710
2092
                        # preserve behaviour for revisions.kndx etc.
2711
2093
                        self._init_index(path)
2712
2094
                    del self._cache
2725
2107
 
2726
2108
    def _dictionary_compress(self, keys):
2727
2109
        """Dictionary compress keys.
2728
 
 
 
2110
        
2729
2111
        :param keys: The keys to generate references to.
2730
2112
        :return: A string representation of keys. keys which are present are
2731
2113
            dictionary compressed, and others are emitted as fulltext with a
2779
2161
            return index_memo[0][:-1], index_memo[1]
2780
2162
        return keys.sort(key=get_sort_key)
2781
2163
 
2782
 
    _get_total_build_size = _get_total_build_size
2783
 
 
2784
2164
    def _split_key(self, key):
2785
2165
        """Split key into a prefix and suffix."""
2786
2166
        return key[:-1], key[-1]
2787
2167
 
2788
2168
 
2789
 
class _KeyRefs(object):
2790
 
 
2791
 
    def __init__(self, track_new_keys=False):
2792
 
        # dict mapping 'key' to 'set of keys referring to that key'
2793
 
        self.refs = {}
2794
 
        if track_new_keys:
2795
 
            # set remembering all new keys
2796
 
            self.new_keys = set()
2797
 
        else:
2798
 
            self.new_keys = None
2799
 
 
2800
 
    def clear(self):
2801
 
        if self.refs:
2802
 
            self.refs.clear()
2803
 
        if self.new_keys:
2804
 
            self.new_keys.clear()
2805
 
 
2806
 
    def add_references(self, key, refs):
2807
 
        # Record the new references
2808
 
        for referenced in refs:
2809
 
            try:
2810
 
                needed_by = self.refs[referenced]
2811
 
            except KeyError:
2812
 
                needed_by = self.refs[referenced] = set()
2813
 
            needed_by.add(key)
2814
 
        # Discard references satisfied by the new key
2815
 
        self.add_key(key)
2816
 
 
2817
 
    def get_new_keys(self):
2818
 
        return self.new_keys
2819
 
    
2820
 
    def get_unsatisfied_refs(self):
2821
 
        return self.refs.iterkeys()
2822
 
 
2823
 
    def _satisfy_refs_for_key(self, key):
2824
 
        try:
2825
 
            del self.refs[key]
2826
 
        except KeyError:
2827
 
            # No keys depended on this key.  That's ok.
2828
 
            pass
2829
 
 
2830
 
    def add_key(self, key):
2831
 
        # satisfy refs for key, and remember that we've seen this key.
2832
 
        self._satisfy_refs_for_key(key)
2833
 
        if self.new_keys is not None:
2834
 
            self.new_keys.add(key)
2835
 
 
2836
 
    def satisfy_refs_for_keys(self, keys):
2837
 
        for key in keys:
2838
 
            self._satisfy_refs_for_key(key)
2839
 
 
2840
 
    def get_referrers(self):
2841
 
        result = set()
2842
 
        for referrers in self.refs.itervalues():
2843
 
            result.update(referrers)
2844
 
        return result
2845
 
 
2846
 
 
2847
2169
class _KnitGraphIndex(object):
2848
2170
    """A KnitVersionedFiles index layered on GraphIndex."""
2849
2171
 
2850
2172
    def __init__(self, graph_index, is_locked, deltas=False, parents=True,
2851
 
        add_callback=None, track_external_parent_refs=False):
 
2173
        add_callback=None):
2852
2174
        """Construct a KnitGraphIndex on a graph_index.
2853
2175
 
2854
2176
        :param graph_index: An implementation of bzrlib.index.GraphIndex.
2855
2177
        :param is_locked: A callback to check whether the object should answer
2856
2178
            queries.
2857
2179
        :param deltas: Allow delta-compressed records.
2858
 
        :param parents: If True, record knits parents, if not do not record
 
2180
        :param parents: If True, record knits parents, if not do not record 
2859
2181
            parents.
2860
2182
        :param add_callback: If not None, allow additions to the index and call
2861
2183
            this callback with a list of added GraphIndex nodes:
2862
2184
            [(node, value, node_refs), ...]
2863
2185
        :param is_locked: A callback, returns True if the index is locked and
2864
2186
            thus usable.
2865
 
        :param track_external_parent_refs: If True, record all external parent
2866
 
            references parents from added records.  These can be retrieved
2867
 
            later by calling get_missing_parents().
2868
2187
        """
2869
2188
        self._add_callback = add_callback
2870
2189
        self._graph_index = graph_index
2877
2196
                "parent tracking.")
2878
2197
        self.has_graph = parents
2879
2198
        self._is_locked = is_locked
2880
 
        self._missing_compression_parents = set()
2881
 
        if track_external_parent_refs:
2882
 
            self._key_dependencies = _KeyRefs()
2883
 
        else:
2884
 
            self._key_dependencies = None
2885
2199
 
2886
2200
    def __repr__(self):
2887
2201
        return "%s(%r)" % (self.__class__.__name__, self._graph_index)
2888
2202
 
2889
 
    def add_records(self, records, random_id=False,
2890
 
        missing_compression_parents=False):
 
2203
    def add_records(self, records, random_id=False):
2891
2204
        """Add multiple records to the index.
2892
 
 
 
2205
        
2893
2206
        This function does not insert data into the Immutable GraphIndex
2894
2207
        backing the KnitGraphIndex, instead it prepares data for insertion by
2895
2208
        the caller and checks that it is safe to insert then calls
2899
2212
                         (key, options, access_memo, parents).
2900
2213
        :param random_id: If True the ids being added were randomly generated
2901
2214
            and no check for existence will be performed.
2902
 
        :param missing_compression_parents: If True the records being added are
2903
 
            only compressed against texts already in the index (or inside
2904
 
            records). If False the records all refer to unavailable texts (or
2905
 
            texts inside records) as compression parents.
2906
2215
        """
2907
2216
        if not self._add_callback:
2908
2217
            raise errors.ReadOnlyError(self)
2910
2219
        # anymore.
2911
2220
 
2912
2221
        keys = {}
2913
 
        compression_parents = set()
2914
 
        key_dependencies = self._key_dependencies
2915
2222
        for (key, options, access_memo, parents) in records:
2916
2223
            if self._parents:
2917
2224
                parents = tuple(parents)
2918
 
                if key_dependencies is not None:
2919
 
                    key_dependencies.add_references(key, parents)
2920
2225
            index, pos, size = access_memo
2921
2226
            if 'no-eol' in options:
2922
2227
                value = 'N'
2930
2235
                if self._deltas:
2931
2236
                    if 'line-delta' in options:
2932
2237
                        node_refs = (parents, (parents[0],))
2933
 
                        if missing_compression_parents:
2934
 
                            compression_parents.add(parents[0])
2935
2238
                    else:
2936
2239
                        node_refs = (parents, ())
2937
2240
                else:
2946
2249
        if not random_id:
2947
2250
            present_nodes = self._get_entries(keys)
2948
2251
            for (index, key, value, node_refs) in present_nodes:
2949
 
                parents = node_refs[:1]
2950
 
                # Sometimes these are passed as a list rather than a tuple
2951
 
                passed = static_tuple.as_tuples(keys[key])
2952
 
                passed_parents = passed[1][:1]
2953
2252
                if (value[0] != keys[key][0][0] or
2954
 
                    parents != passed_parents):
2955
 
                    node_refs = static_tuple.as_tuples(node_refs)
 
2253
                    node_refs[:1] != keys[key][1][:1]):
2956
2254
                    raise KnitCorrupt(self, "inconsistent details in add_records"
2957
 
                        ": %s %s" % ((value, node_refs), passed))
 
2255
                        ": %s %s" % ((value, node_refs), keys[key]))
2958
2256
                del keys[key]
2959
2257
        result = []
2960
2258
        if self._parents:
2964
2262
            for key, (value, node_refs) in keys.iteritems():
2965
2263
                result.append((key, value))
2966
2264
        self._add_callback(result)
2967
 
        if missing_compression_parents:
2968
 
            # This may appear to be incorrect (it does not check for
2969
 
            # compression parents that are in the existing graph index),
2970
 
            # but such records won't have been buffered, so this is
2971
 
            # actually correct: every entry when
2972
 
            # missing_compression_parents==True either has a missing parent, or
2973
 
            # a parent that is one of the keys in records.
2974
 
            compression_parents.difference_update(keys)
2975
 
            self._missing_compression_parents.update(compression_parents)
2976
 
        # Adding records may have satisfied missing compression parents.
2977
 
        self._missing_compression_parents.difference_update(keys)
2978
 
 
2979
 
    def scan_unvalidated_index(self, graph_index):
2980
 
        """Inform this _KnitGraphIndex that there is an unvalidated index.
2981
 
 
2982
 
        This allows this _KnitGraphIndex to keep track of any missing
2983
 
        compression parents we may want to have filled in to make those
2984
 
        indices valid.
2985
 
 
2986
 
        :param graph_index: A GraphIndex
2987
 
        """
2988
 
        if self._deltas:
2989
 
            new_missing = graph_index.external_references(ref_list_num=1)
2990
 
            new_missing.difference_update(self.get_parent_map(new_missing))
2991
 
            self._missing_compression_parents.update(new_missing)
2992
 
        if self._key_dependencies is not None:
2993
 
            # Add parent refs from graph_index (and discard parent refs that
2994
 
            # the graph_index has).
2995
 
            for node in graph_index.iter_all_entries():
2996
 
                self._key_dependencies.add_references(node[1], node[3][0])
2997
 
 
2998
 
    def get_missing_compression_parents(self):
2999
 
        """Return the keys of missing compression parents.
3000
 
 
3001
 
        Missing compression parents occur when a record stream was missing
3002
 
        basis texts, or a index was scanned that had missing basis texts.
3003
 
        """
3004
 
        return frozenset(self._missing_compression_parents)
3005
 
 
3006
 
    def get_missing_parents(self):
3007
 
        """Return the keys of missing parents."""
3008
 
        # If updating this, you should also update
3009
 
        # groupcompress._GCGraphIndex.get_missing_parents
3010
 
        # We may have false positives, so filter those out.
3011
 
        self._key_dependencies.satisfy_refs_for_keys(
3012
 
            self.get_parent_map(self._key_dependencies.get_unsatisfied_refs()))
3013
 
        return frozenset(self._key_dependencies.get_unsatisfied_refs())
3014
 
 
 
2265
        
3015
2266
    def _check_read(self):
3016
2267
        """raise if reads are not permitted."""
3017
2268
        if not self._is_locked():
3077
2328
 
3078
2329
    def _get_entries(self, keys, check_present=False):
3079
2330
        """Get the entries for keys.
3080
 
 
 
2331
        
3081
2332
        :param keys: An iterable of index key tuples.
3082
2333
        """
3083
2334
        keys = set(keys)
3125
2376
            options.append('no-eol')
3126
2377
        return options
3127
2378
 
3128
 
    def find_ancestry(self, keys):
3129
 
        """See CombinedGraphIndex.find_ancestry()"""
3130
 
        return self._graph_index.find_ancestry(keys, 0)
3131
 
 
3132
2379
    def get_parent_map(self, keys):
3133
2380
        """Get a map of the parents of keys.
3134
2381
 
3149
2396
 
3150
2397
    def get_position(self, key):
3151
2398
        """Return details needed to access the version.
3152
 
 
 
2399
        
3153
2400
        :return: a tuple (index, data position, size) to hand to the access
3154
2401
            logic to get the record.
3155
2402
        """
3160
2407
 
3161
2408
    def keys(self):
3162
2409
        """Get all the keys in the collection.
3163
 
 
 
2410
        
3164
2411
        The keys are not ordered.
3165
2412
        """
3166
2413
        self._check_read()
3167
2414
        return [node[1] for node in self._graph_index.iter_all_entries()]
3168
 
 
 
2415
    
3169
2416
    missing_keys = _mod_index._missing_keys_from_parent_map
3170
2417
 
3171
2418
    def _node_to_position(self, node):
3193
2440
            return positions[key][1]
3194
2441
        return keys.sort(key=get_index_memo)
3195
2442
 
3196
 
    _get_total_build_size = _get_total_build_size
3197
 
 
3198
2443
 
3199
2444
class _KnitKeyAccess(object):
3200
2445
    """Access to records in .knit files."""
3221
2466
            opaque index memo. For _KnitKeyAccess the memo is (key, pos,
3222
2467
            length), where the key is the record key.
3223
2468
        """
3224
 
        if type(raw_data) is not str:
 
2469
        if type(raw_data) != str:
3225
2470
            raise AssertionError(
3226
2471
                'data must be plain bytes was %s' % type(raw_data))
3227
2472
        result = []
3244
2489
            result.append((key, base, size))
3245
2490
        return result
3246
2491
 
3247
 
    def flush(self):
3248
 
        """Flush pending writes on this access object.
3249
 
        
3250
 
        For .knit files this is a no-op.
3251
 
        """
3252
 
        pass
3253
 
 
3254
2492
    def get_raw_records(self, memos_for_retrieval):
3255
2493
        """Get the raw bytes for a records.
3256
2494
 
3281
2519
class _DirectPackAccess(object):
3282
2520
    """Access to data in one or more packs with less translation."""
3283
2521
 
3284
 
    def __init__(self, index_to_packs, reload_func=None, flush_func=None):
 
2522
    def __init__(self, index_to_packs, reload_func=None):
3285
2523
        """Create a _DirectPackAccess object.
3286
2524
 
3287
2525
        :param index_to_packs: A dict mapping index objects to the transport
3294
2532
        self._write_index = None
3295
2533
        self._indices = index_to_packs
3296
2534
        self._reload_func = reload_func
3297
 
        self._flush_func = flush_func
3298
2535
 
3299
2536
    def add_raw_records(self, key_sizes, raw_data):
3300
2537
        """Add raw knit bytes to a storage area.
3310
2547
            length), where the index field is the write_index object supplied
3311
2548
            to the PackAccess object.
3312
2549
        """
3313
 
        if type(raw_data) is not str:
 
2550
        if type(raw_data) != str:
3314
2551
            raise AssertionError(
3315
2552
                'data must be plain bytes was %s' % type(raw_data))
3316
2553
        result = []
3322
2559
            result.append((self._write_index, p_offset, p_length))
3323
2560
        return result
3324
2561
 
3325
 
    def flush(self):
3326
 
        """Flush pending writes on this access object.
3327
 
 
3328
 
        This will flush any buffered writes to a NewPack.
3329
 
        """
3330
 
        if self._flush_func is not None:
3331
 
            self._flush_func()
3332
 
            
3333
2562
    def get_raw_records(self, memos_for_retrieval):
3334
2563
        """Get the raw bytes for a records.
3335
2564
 
3336
 
        :param memos_for_retrieval: An iterable containing the (index, pos,
 
2565
        :param memos_for_retrieval: An iterable containing the (index, pos, 
3337
2566
            length) memo for retrieving the bytes. The Pack access method
3338
2567
            looks up the pack to use for a given record in its index_to_pack
3339
2568
            map.
3429
2658
    recommended.
3430
2659
    """
3431
2660
    annotator = _KnitAnnotator(knit)
3432
 
    return iter(annotator.annotate_flat(revision_id))
3433
 
 
3434
 
 
3435
 
class _KnitAnnotator(annotate.Annotator):
 
2661
    return iter(annotator.annotate(revision_id))
 
2662
 
 
2663
 
 
2664
class _KnitAnnotator(object):
3436
2665
    """Build up the annotations for a text."""
3437
2666
 
3438
 
    def __init__(self, vf):
3439
 
        annotate.Annotator.__init__(self, vf)
3440
 
 
3441
 
        # TODO: handle Nodes which cannot be extracted
3442
 
        # self._ghosts = set()
3443
 
 
3444
 
        # Map from (key, parent_key) => matching_blocks, should be 'use once'
3445
 
        self._matching_blocks = {}
3446
 
 
3447
 
        # KnitContent objects
3448
 
        self._content_objects = {}
3449
 
        # The number of children that depend on this fulltext content object
3450
 
        self._num_compression_children = {}
3451
 
        # Delta records that need their compression parent before they can be
3452
 
        # expanded
3453
 
        self._pending_deltas = {}
3454
 
        # Fulltext records that are waiting for their parents fulltexts before
3455
 
        # they can be yielded for annotation
3456
 
        self._pending_annotation = {}
 
2667
    def __init__(self, knit):
 
2668
        self._knit = knit
 
2669
 
 
2670
        # Content objects, differs from fulltexts because of how final newlines
 
2671
        # are treated by knits. the content objects here will always have a
 
2672
        # final newline
 
2673
        self._fulltext_contents = {}
 
2674
 
 
2675
        # Annotated lines of specific revisions
 
2676
        self._annotated_lines = {}
 
2677
 
 
2678
        # Track the raw data for nodes that we could not process yet.
 
2679
        # This maps the revision_id of the base to a list of children that will
 
2680
        # annotated from it.
 
2681
        self._pending_children = {}
 
2682
 
 
2683
        # Nodes which cannot be extracted
 
2684
        self._ghosts = set()
 
2685
 
 
2686
        # Track how many children this node has, so we know if we need to keep
 
2687
        # it
 
2688
        self._annotate_children = {}
 
2689
        self._compression_children = {}
3457
2690
 
3458
2691
        self._all_build_details = {}
 
2692
        # The children => parent revision_id graph
 
2693
        self._revision_id_graph = {}
 
2694
 
 
2695
        self._heads_provider = None
 
2696
 
 
2697
        self._nodes_to_keep_annotations = set()
 
2698
        self._generations_until_keep = 100
 
2699
 
 
2700
    def set_generations_until_keep(self, value):
 
2701
        """Set the number of generations before caching a node.
 
2702
 
 
2703
        Setting this to -1 will cache every merge node, setting this higher
 
2704
        will cache fewer nodes.
 
2705
        """
 
2706
        self._generations_until_keep = value
 
2707
 
 
2708
    def _add_fulltext_content(self, revision_id, content_obj):
 
2709
        self._fulltext_contents[revision_id] = content_obj
 
2710
        # TODO: jam 20080305 It might be good to check the sha1digest here
 
2711
        return content_obj.text()
 
2712
 
 
2713
    def _check_parents(self, child, nodes_to_annotate):
 
2714
        """Check if all parents have been processed.
 
2715
 
 
2716
        :param child: A tuple of (rev_id, parents, raw_content)
 
2717
        :param nodes_to_annotate: If child is ready, add it to
 
2718
            nodes_to_annotate, otherwise put it back in self._pending_children
 
2719
        """
 
2720
        for parent_id in child[1]:
 
2721
            if (parent_id not in self._annotated_lines):
 
2722
                # This parent is present, but another parent is missing
 
2723
                self._pending_children.setdefault(parent_id,
 
2724
                                                  []).append(child)
 
2725
                break
 
2726
        else:
 
2727
            # This one is ready to be processed
 
2728
            nodes_to_annotate.append(child)
 
2729
 
 
2730
    def _add_annotation(self, revision_id, fulltext, parent_ids,
 
2731
                        left_matching_blocks=None):
 
2732
        """Add an annotation entry.
 
2733
 
 
2734
        All parents should already have been annotated.
 
2735
        :return: A list of children that now have their parents satisfied.
 
2736
        """
 
2737
        a = self._annotated_lines
 
2738
        annotated_parent_lines = [a[p] for p in parent_ids]
 
2739
        annotated_lines = list(annotate.reannotate(annotated_parent_lines,
 
2740
            fulltext, revision_id, left_matching_blocks,
 
2741
            heads_provider=self._get_heads_provider()))
 
2742
        self._annotated_lines[revision_id] = annotated_lines
 
2743
        for p in parent_ids:
 
2744
            ann_children = self._annotate_children[p]
 
2745
            ann_children.remove(revision_id)
 
2746
            if (not ann_children
 
2747
                and p not in self._nodes_to_keep_annotations):
 
2748
                del self._annotated_lines[p]
 
2749
                del self._all_build_details[p]
 
2750
                if p in self._fulltext_contents:
 
2751
                    del self._fulltext_contents[p]
 
2752
        # Now that we've added this one, see if there are any pending
 
2753
        # deltas to be done, certainly this parent is finished
 
2754
        nodes_to_annotate = []
 
2755
        for child in self._pending_children.pop(revision_id, []):
 
2756
            self._check_parents(child, nodes_to_annotate)
 
2757
        return nodes_to_annotate
3459
2758
 
3460
2759
    def _get_build_graph(self, key):
3461
2760
        """Get the graphs for building texts and annotations.
3466
2765
        fulltext.)
3467
2766
 
3468
2767
        :return: A list of (key, index_memo) records, suitable for
3469
 
            passing to read_records_iter to start reading in the raw data from
 
2768
            passing to read_records_iter to start reading in the raw data fro/
3470
2769
            the pack file.
3471
2770
        """
 
2771
        if key in self._annotated_lines:
 
2772
            # Nothing to do
 
2773
            return []
3472
2774
        pending = set([key])
3473
2775
        records = []
3474
 
        ann_keys = set()
3475
 
        self._num_needed_children[key] = 1
 
2776
        generation = 0
 
2777
        kept_generation = 0
3476
2778
        while pending:
3477
2779
            # get all pending nodes
 
2780
            generation += 1
3478
2781
            this_iteration = pending
3479
 
            build_details = self._vf._index.get_build_details(this_iteration)
 
2782
            build_details = self._knit._index.get_build_details(this_iteration)
3480
2783
            self._all_build_details.update(build_details)
3481
 
            # new_nodes = self._vf._index._get_entries(this_iteration)
 
2784
            # new_nodes = self._knit._index._get_entries(this_iteration)
3482
2785
            pending = set()
3483
2786
            for key, details in build_details.iteritems():
3484
 
                (index_memo, compression_parent, parent_keys,
 
2787
                (index_memo, compression_parent, parents,
3485
2788
                 record_details) = details
3486
 
                self._parent_map[key] = parent_keys
3487
 
                self._heads_provider = None
 
2789
                self._revision_id_graph[key] = parents
3488
2790
                records.append((key, index_memo))
3489
2791
                # Do we actually need to check _annotated_lines?
3490
 
                pending.update([p for p in parent_keys
3491
 
                                   if p not in self._all_build_details])
3492
 
                if parent_keys:
3493
 
                    for parent_key in parent_keys:
3494
 
                        if parent_key in self._num_needed_children:
3495
 
                            self._num_needed_children[parent_key] += 1
3496
 
                        else:
3497
 
                            self._num_needed_children[parent_key] = 1
 
2792
                pending.update(p for p in parents
 
2793
                                 if p not in self._all_build_details)
3498
2794
                if compression_parent:
3499
 
                    if compression_parent in self._num_compression_children:
3500
 
                        self._num_compression_children[compression_parent] += 1
3501
 
                    else:
3502
 
                        self._num_compression_children[compression_parent] = 1
 
2795
                    self._compression_children.setdefault(compression_parent,
 
2796
                        []).append(key)
 
2797
                if parents:
 
2798
                    for parent in parents:
 
2799
                        self._annotate_children.setdefault(parent,
 
2800
                            []).append(key)
 
2801
                    num_gens = generation - kept_generation
 
2802
                    if ((num_gens >= self._generations_until_keep)
 
2803
                        and len(parents) > 1):
 
2804
                        kept_generation = generation
 
2805
                        self._nodes_to_keep_annotations.add(key)
3503
2806
 
3504
2807
            missing_versions = this_iteration.difference(build_details.keys())
3505
 
            if missing_versions:
3506
 
                for key in missing_versions:
3507
 
                    if key in self._parent_map and key in self._text_cache:
3508
 
                        # We already have this text ready, we just need to
3509
 
                        # yield it later so we get it annotated
3510
 
                        ann_keys.add(key)
3511
 
                        parent_keys = self._parent_map[key]
3512
 
                        for parent_key in parent_keys:
3513
 
                            if parent_key in self._num_needed_children:
3514
 
                                self._num_needed_children[parent_key] += 1
3515
 
                            else:
3516
 
                                self._num_needed_children[parent_key] = 1
3517
 
                        pending.update([p for p in parent_keys
3518
 
                                           if p not in self._all_build_details])
3519
 
                    else:
3520
 
                        raise errors.RevisionNotPresent(key, self._vf)
 
2808
            self._ghosts.update(missing_versions)
 
2809
            for missing_version in missing_versions:
 
2810
                # add a key, no parents
 
2811
                self._revision_id_graph[missing_version] = ()
 
2812
                pending.discard(missing_version) # don't look for it
 
2813
        if self._ghosts.intersection(self._compression_children):
 
2814
            raise KnitCorrupt(
 
2815
                "We cannot have nodes which have a ghost compression parent:\n"
 
2816
                "ghosts: %r\n"
 
2817
                "compression children: %r"
 
2818
                % (self._ghosts, self._compression_children))
 
2819
        # Cleanout anything that depends on a ghost so that we don't wait for
 
2820
        # the ghost to show up
 
2821
        for node in self._ghosts:
 
2822
            if node in self._annotate_children:
 
2823
                # We won't be building this node
 
2824
                del self._annotate_children[node]
3521
2825
        # Generally we will want to read the records in reverse order, because
3522
2826
        # we find the parent nodes after the children
3523
2827
        records.reverse()
3524
 
        return records, ann_keys
3525
 
 
3526
 
    def _get_needed_texts(self, key, pb=None):
3527
 
        # if True or len(self._vf._fallback_vfs) > 0:
3528
 
        if len(self._vf._fallback_vfs) > 0:
3529
 
            # If we have fallbacks, go to the generic path
3530
 
            for v in annotate.Annotator._get_needed_texts(self, key, pb=pb):
3531
 
                yield v
3532
 
            return
3533
 
        while True:
3534
 
            try:
3535
 
                records, ann_keys = self._get_build_graph(key)
3536
 
                for idx, (sub_key, text, num_lines) in enumerate(
3537
 
                                                self._extract_texts(records)):
3538
 
                    if pb is not None:
3539
 
                        pb.update('annotating', idx, len(records))
3540
 
                    yield sub_key, text, num_lines
3541
 
                for sub_key in ann_keys:
3542
 
                    text = self._text_cache[sub_key]
3543
 
                    num_lines = len(text) # bad assumption
3544
 
                    yield sub_key, text, num_lines
3545
 
                return
3546
 
            except errors.RetryWithNewPacks, e:
3547
 
                self._vf._access.reload_or_raise(e)
3548
 
                # The cached build_details are no longer valid
3549
 
                self._all_build_details.clear()
3550
 
 
3551
 
    def _cache_delta_blocks(self, key, compression_parent, delta, lines):
3552
 
        parent_lines = self._text_cache[compression_parent]
3553
 
        blocks = list(KnitContent.get_line_delta_blocks(delta, parent_lines, lines))
3554
 
        self._matching_blocks[(key, compression_parent)] = blocks
3555
 
 
3556
 
    def _expand_record(self, key, parent_keys, compression_parent, record,
3557
 
                       record_details):
3558
 
        delta = None
3559
 
        if compression_parent:
3560
 
            if compression_parent not in self._content_objects:
3561
 
                # Waiting for the parent
3562
 
                self._pending_deltas.setdefault(compression_parent, []).append(
3563
 
                    (key, parent_keys, record, record_details))
3564
 
                return None
3565
 
            # We have the basis parent, so expand the delta
3566
 
            num = self._num_compression_children[compression_parent]
3567
 
            num -= 1
3568
 
            if num == 0:
3569
 
                base_content = self._content_objects.pop(compression_parent)
3570
 
                self._num_compression_children.pop(compression_parent)
3571
 
            else:
3572
 
                self._num_compression_children[compression_parent] = num
3573
 
                base_content = self._content_objects[compression_parent]
3574
 
            # It is tempting to want to copy_base_content=False for the last
3575
 
            # child object. However, whenever noeol=False,
3576
 
            # self._text_cache[parent_key] is content._lines. So mutating it
3577
 
            # gives very bad results.
3578
 
            # The alternative is to copy the lines into text cache, but then we
3579
 
            # are copying anyway, so just do it here.
3580
 
            content, delta = self._vf._factory.parse_record(
3581
 
                key, record, record_details, base_content,
3582
 
                copy_base_content=True)
3583
 
        else:
3584
 
            # Fulltext record
3585
 
            content, _ = self._vf._factory.parse_record(
3586
 
                key, record, record_details, None)
3587
 
        if self._num_compression_children.get(key, 0) > 0:
3588
 
            self._content_objects[key] = content
3589
 
        lines = content.text()
3590
 
        self._text_cache[key] = lines
3591
 
        if delta is not None:
3592
 
            self._cache_delta_blocks(key, compression_parent, delta, lines)
3593
 
        return lines
3594
 
 
3595
 
    def _get_parent_annotations_and_matches(self, key, text, parent_key):
3596
 
        """Get the list of annotations for the parent, and the matching lines.
3597
 
 
3598
 
        :param text: The opaque value given by _get_needed_texts
3599
 
        :param parent_key: The key for the parent text
3600
 
        :return: (parent_annotations, matching_blocks)
3601
 
            parent_annotations is a list as long as the number of lines in
3602
 
                parent
3603
 
            matching_blocks is a list of (parent_idx, text_idx, len) tuples
3604
 
                indicating which lines match between the two texts
3605
 
        """
3606
 
        block_key = (key, parent_key)
3607
 
        if block_key in self._matching_blocks:
3608
 
            blocks = self._matching_blocks.pop(block_key)
3609
 
            parent_annotations = self._annotations_cache[parent_key]
3610
 
            return parent_annotations, blocks
3611
 
        return annotate.Annotator._get_parent_annotations_and_matches(self,
3612
 
            key, text, parent_key)
3613
 
 
3614
 
    def _process_pending(self, key):
3615
 
        """The content for 'key' was just processed.
3616
 
 
3617
 
        Determine if there is any more pending work to be processed.
3618
 
        """
3619
 
        to_return = []
3620
 
        if key in self._pending_deltas:
3621
 
            compression_parent = key
3622
 
            children = self._pending_deltas.pop(key)
3623
 
            for child_key, parent_keys, record, record_details in children:
3624
 
                lines = self._expand_record(child_key, parent_keys,
3625
 
                                            compression_parent,
3626
 
                                            record, record_details)
3627
 
                if self._check_ready_for_annotations(child_key, parent_keys):
3628
 
                    to_return.append(child_key)
3629
 
        # Also check any children that are waiting for this parent to be
3630
 
        # annotation ready
3631
 
        if key in self._pending_annotation:
3632
 
            children = self._pending_annotation.pop(key)
3633
 
            to_return.extend([c for c, p_keys in children
3634
 
                              if self._check_ready_for_annotations(c, p_keys)])
3635
 
        return to_return
3636
 
 
3637
 
    def _check_ready_for_annotations(self, key, parent_keys):
3638
 
        """return true if this text is ready to be yielded.
3639
 
 
3640
 
        Otherwise, this will return False, and queue the text into
3641
 
        self._pending_annotation
3642
 
        """
3643
 
        for parent_key in parent_keys:
3644
 
            if parent_key not in self._annotations_cache:
3645
 
                # still waiting on at least one parent text, so queue it up
3646
 
                # Note that if there are multiple parents, we need to wait
3647
 
                # for all of them.
3648
 
                self._pending_annotation.setdefault(parent_key,
3649
 
                    []).append((key, parent_keys))
3650
 
                return False
3651
 
        return True
3652
 
 
3653
 
    def _extract_texts(self, records):
3654
 
        """Extract the various texts needed based on records"""
 
2828
        return records
 
2829
 
 
2830
    def _annotate_records(self, records):
 
2831
        """Build the annotations for the listed records."""
3655
2832
        # We iterate in the order read, rather than a strict order requested
3656
2833
        # However, process what we can, and put off to the side things that
3657
2834
        # still need parents, cleaning them up when those parents are
3658
2835
        # processed.
3659
 
        # Basic data flow:
3660
 
        #   1) As 'records' are read, see if we can expand these records into
3661
 
        #      Content objects (and thus lines)
3662
 
        #   2) If a given line-delta is waiting on its compression parent, it
3663
 
        #      gets queued up into self._pending_deltas, otherwise we expand
3664
 
        #      it, and put it into self._text_cache and self._content_objects
3665
 
        #   3) If we expanded the text, we will then check to see if all
3666
 
        #      parents have also been processed. If so, this text gets yielded,
3667
 
        #      else this record gets set aside into pending_annotation
3668
 
        #   4) Further, if we expanded the text in (2), we will then check to
3669
 
        #      see if there are any children in self._pending_deltas waiting to
3670
 
        #      also be processed. If so, we go back to (2) for those
3671
 
        #   5) Further again, if we yielded the text, we can then check if that
3672
 
        #      'unlocks' any of the texts in pending_annotations, which should
3673
 
        #      then get yielded as well
3674
 
        # Note that both steps 4 and 5 are 'recursive' in that unlocking one
3675
 
        # compression child could unlock yet another, and yielding a fulltext
3676
 
        # will also 'unlock' the children that are waiting on that annotation.
3677
 
        # (Though also, unlocking 1 parent's fulltext, does not unlock a child
3678
 
        # if other parents are also waiting.)
3679
 
        # We want to yield content before expanding child content objects, so
3680
 
        # that we know when we can re-use the content lines, and the annotation
3681
 
        # code can know when it can stop caching fulltexts, as well.
3682
 
 
3683
 
        # Children that are missing their compression parent
3684
 
        pending_deltas = {}
3685
 
        for (key, record, digest) in self._vf._read_records_iter(records):
3686
 
            # ghosts?
3687
 
            details = self._all_build_details[key]
3688
 
            (_, compression_parent, parent_keys, record_details) = details
3689
 
            lines = self._expand_record(key, parent_keys, compression_parent,
3690
 
                                        record, record_details)
3691
 
            if lines is None:
3692
 
                # Pending delta should be queued up
 
2836
        for (rev_id, record,
 
2837
             digest) in self._knit._read_records_iter(records):
 
2838
            if rev_id in self._annotated_lines:
3693
2839
                continue
3694
 
            # At this point, we may be able to yield this content, if all
3695
 
            # parents are also finished
3696
 
            yield_this_text = self._check_ready_for_annotations(key,
3697
 
                                                                parent_keys)
3698
 
            if yield_this_text:
3699
 
                # All parents present
3700
 
                yield key, lines, len(lines)
3701
 
            to_process = self._process_pending(key)
3702
 
            while to_process:
3703
 
                this_process = to_process
3704
 
                to_process = []
3705
 
                for key in this_process:
3706
 
                    lines = self._text_cache[key]
3707
 
                    yield key, lines, len(lines)
3708
 
                    to_process.extend(self._process_pending(key))
 
2840
            parent_ids = self._revision_id_graph[rev_id]
 
2841
            parent_ids = [p for p in parent_ids if p not in self._ghosts]
 
2842
            details = self._all_build_details[rev_id]
 
2843
            (index_memo, compression_parent, parents,
 
2844
             record_details) = details
 
2845
            nodes_to_annotate = []
 
2846
            # TODO: Remove the punning between compression parents, and
 
2847
            #       parent_ids, we should be able to do this without assuming
 
2848
            #       the build order
 
2849
            if len(parent_ids) == 0:
 
2850
                # There are no parents for this node, so just add it
 
2851
                # TODO: This probably needs to be decoupled
 
2852
                fulltext_content, delta = self._knit._factory.parse_record(
 
2853
                    rev_id, record, record_details, None)
 
2854
                fulltext = self._add_fulltext_content(rev_id, fulltext_content)
 
2855
                nodes_to_annotate.extend(self._add_annotation(rev_id, fulltext,
 
2856
                    parent_ids, left_matching_blocks=None))
 
2857
            else:
 
2858
                child = (rev_id, parent_ids, record)
 
2859
                # Check if all the parents are present
 
2860
                self._check_parents(child, nodes_to_annotate)
 
2861
            while nodes_to_annotate:
 
2862
                # Should we use a queue here instead of a stack?
 
2863
                (rev_id, parent_ids, record) = nodes_to_annotate.pop()
 
2864
                (index_memo, compression_parent, parents,
 
2865
                 record_details) = self._all_build_details[rev_id]
 
2866
                blocks = None
 
2867
                if compression_parent is not None:
 
2868
                    comp_children = self._compression_children[compression_parent]
 
2869
                    if rev_id not in comp_children:
 
2870
                        raise AssertionError("%r not in compression children %r"
 
2871
                            % (rev_id, comp_children))
 
2872
                    # If there is only 1 child, it is safe to reuse this
 
2873
                    # content
 
2874
                    reuse_content = (len(comp_children) == 1
 
2875
                        and compression_parent not in
 
2876
                            self._nodes_to_keep_annotations)
 
2877
                    if reuse_content:
 
2878
                        # Remove it from the cache since it will be changing
 
2879
                        parent_fulltext_content = self._fulltext_contents.pop(compression_parent)
 
2880
                        # Make sure to copy the fulltext since it might be
 
2881
                        # modified
 
2882
                        parent_fulltext = list(parent_fulltext_content.text())
 
2883
                    else:
 
2884
                        parent_fulltext_content = self._fulltext_contents[compression_parent]
 
2885
                        parent_fulltext = parent_fulltext_content.text()
 
2886
                    comp_children.remove(rev_id)
 
2887
                    fulltext_content, delta = self._knit._factory.parse_record(
 
2888
                        rev_id, record, record_details,
 
2889
                        parent_fulltext_content,
 
2890
                        copy_base_content=(not reuse_content))
 
2891
                    fulltext = self._add_fulltext_content(rev_id,
 
2892
                                                          fulltext_content)
 
2893
                    if compression_parent == parent_ids[0]:
 
2894
                        # the compression_parent is the left parent, so we can
 
2895
                        # re-use the delta
 
2896
                        blocks = KnitContent.get_line_delta_blocks(delta,
 
2897
                                parent_fulltext, fulltext)
 
2898
                else:
 
2899
                    fulltext_content = self._knit._factory.parse_fulltext(
 
2900
                        record, rev_id)
 
2901
                    fulltext = self._add_fulltext_content(rev_id,
 
2902
                        fulltext_content)
 
2903
                nodes_to_annotate.extend(
 
2904
                    self._add_annotation(rev_id, fulltext, parent_ids,
 
2905
                                     left_matching_blocks=blocks))
 
2906
 
 
2907
    def _get_heads_provider(self):
 
2908
        """Create a heads provider for resolving ancestry issues."""
 
2909
        if self._heads_provider is not None:
 
2910
            return self._heads_provider
 
2911
        parent_provider = _mod_graph.DictParentsProvider(
 
2912
            self._revision_id_graph)
 
2913
        graph_obj = _mod_graph.Graph(parent_provider)
 
2914
        head_cache = _mod_graph.FrozenHeadsCache(graph_obj)
 
2915
        self._heads_provider = head_cache
 
2916
        return head_cache
 
2917
 
 
2918
    def annotate(self, key):
 
2919
        """Return the annotated fulltext at the given key.
 
2920
 
 
2921
        :param key: The key to annotate.
 
2922
        """
 
2923
        if len(self._knit._fallback_vfs) > 0:
 
2924
            # stacked knits can't use the fast path at present.
 
2925
            return self._simple_annotate(key)
 
2926
        while True:
 
2927
            try:
 
2928
                records = self._get_build_graph(key)
 
2929
                if key in self._ghosts:
 
2930
                    raise errors.RevisionNotPresent(key, self._knit)
 
2931
                self._annotate_records(records)
 
2932
                return self._annotated_lines[key]
 
2933
            except errors.RetryWithNewPacks, e:
 
2934
                self._knit._access.reload_or_raise(e)
 
2935
                # The cached build_details are no longer valid
 
2936
                self._all_build_details.clear()
 
2937
 
 
2938
    def _simple_annotate(self, key):
 
2939
        """Return annotated fulltext, rediffing from the full texts.
 
2940
 
 
2941
        This is slow but makes no assumptions about the repository
 
2942
        being able to produce line deltas.
 
2943
        """
 
2944
        # TODO: this code generates a parent maps of present ancestors; it
 
2945
        # could be split out into a separate method, and probably should use
 
2946
        # iter_ancestry instead. -- mbp and robertc 20080704
 
2947
        graph = _mod_graph.Graph(self._knit)
 
2948
        head_cache = _mod_graph.FrozenHeadsCache(graph)
 
2949
        search = graph._make_breadth_first_searcher([key])
 
2950
        keys = set()
 
2951
        while True:
 
2952
            try:
 
2953
                present, ghosts = search.next_with_ghosts()
 
2954
            except StopIteration:
 
2955
                break
 
2956
            keys.update(present)
 
2957
        parent_map = self._knit.get_parent_map(keys)
 
2958
        parent_cache = {}
 
2959
        reannotate = annotate.reannotate
 
2960
        for record in self._knit.get_record_stream(keys, 'topological', True):
 
2961
            key = record.key
 
2962
            fulltext = osutils.chunks_to_lines(record.get_bytes_as('chunked'))
 
2963
            parents = parent_map[key]
 
2964
            if parents is not None:
 
2965
                parent_lines = [parent_cache[parent] for parent in parent_map[key]]
 
2966
            else:
 
2967
                parent_lines = []
 
2968
            parent_cache[key] = list(
 
2969
                reannotate(parent_lines, fulltext, key, None, head_cache))
 
2970
        try:
 
2971
            return parent_cache[key]
 
2972
        except KeyError, e:
 
2973
            raise errors.RevisionNotPresent(key, self._knit)
 
2974
 
3709
2975
 
3710
2976
try:
3711
 
    from bzrlib._knit_load_data_pyx import _load_data_c as _load_data
3712
 
except ImportError, e:
3713
 
    osutils.failed_to_load_extension(e)
 
2977
    from bzrlib._knit_load_data_c import _load_data_c as _load_data
 
2978
except ImportError:
3714
2979
    from bzrlib._knit_load_data_py import _load_data_py as _load_data