~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/knit.py

  • Committer: Mark Hammond
  • Date: 2009-01-12 01:55:34 UTC
  • mto: (3995.8.2 prepare-1.12)
  • mto: This revision was merged to the branch mainline in revision 4007.
  • Revision ID: mhammond@skippinet.com.au-20090112015534-yfxg50p7mpds9j4v
Include all .html files from the tortoise doc directory.

Show diffs side-by-side

added added

removed removed

Lines of Context:
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""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
103
111
    ConstantMapper,
104
112
    ContentFactory,
105
113
    ChunkedContentFactory,
106
 
    sort_groupcompress,
107
114
    VersionedFile,
108
115
    VersionedFiles,
109
116
    )
124
131
 
125
132
DATA_SUFFIX = '.knit'
126
133
INDEX_SUFFIX = '.kndx'
127
 
_STREAM_MIN_BUFFER_SIZE = 5*1024*1024
128
134
 
129
135
 
130
136
class KnitAdapter(object):
132
138
 
133
139
    def __init__(self, basis_vf):
134
140
        """Create an adapter which accesses full texts from basis_vf.
135
 
 
 
141
        
136
142
        :param basis_vf: A versioned file to access basis texts of deltas from.
137
143
            May be None for adapters that do not need to access basis texts.
138
144
        """
145
151
class FTAnnotatedToUnannotated(KnitAdapter):
146
152
    """An adapter from FT annotated knits to unannotated ones."""
147
153
 
148
 
    def get_bytes(self, factory):
149
 
        annotated_compressed_bytes = factory._raw_record
 
154
    def get_bytes(self, factory, annotated_compressed_bytes):
150
155
        rec, contents = \
151
156
            self._data._parse_record_unchecked(annotated_compressed_bytes)
152
157
        content = self._annotate_factory.parse_fulltext(contents, rec[1])
157
162
class DeltaAnnotatedToUnannotated(KnitAdapter):
158
163
    """An adapter for deltas from annotated to unannotated."""
159
164
 
160
 
    def get_bytes(self, factory):
161
 
        annotated_compressed_bytes = factory._raw_record
 
165
    def get_bytes(self, factory, annotated_compressed_bytes):
162
166
        rec, contents = \
163
167
            self._data._parse_record_unchecked(annotated_compressed_bytes)
164
168
        delta = self._annotate_factory.parse_line_delta(contents, rec[1],
171
175
class FTAnnotatedToFullText(KnitAdapter):
172
176
    """An adapter from FT annotated knits to unannotated ones."""
173
177
 
174
 
    def get_bytes(self, factory):
175
 
        annotated_compressed_bytes = factory._raw_record
 
178
    def get_bytes(self, factory, annotated_compressed_bytes):
176
179
        rec, contents = \
177
180
            self._data._parse_record_unchecked(annotated_compressed_bytes)
178
181
        content, delta = self._annotate_factory.parse_record(factory.key[-1],
183
186
class DeltaAnnotatedToFullText(KnitAdapter):
184
187
    """An adapter for deltas from annotated to unannotated."""
185
188
 
186
 
    def get_bytes(self, factory):
187
 
        annotated_compressed_bytes = factory._raw_record
 
189
    def get_bytes(self, factory, annotated_compressed_bytes):
188
190
        rec, contents = \
189
191
            self._data._parse_record_unchecked(annotated_compressed_bytes)
190
192
        delta = self._annotate_factory.parse_line_delta(contents, rec[1],
207
209
class FTPlainToFullText(KnitAdapter):
208
210
    """An adapter from FT plain knits to unannotated ones."""
209
211
 
210
 
    def get_bytes(self, factory):
211
 
        compressed_bytes = factory._raw_record
 
212
    def get_bytes(self, factory, compressed_bytes):
212
213
        rec, contents = \
213
214
            self._data._parse_record_unchecked(compressed_bytes)
214
215
        content, delta = self._plain_factory.parse_record(factory.key[-1],
219
220
class DeltaPlainToFullText(KnitAdapter):
220
221
    """An adapter for deltas from annotated to unannotated."""
221
222
 
222
 
    def get_bytes(self, factory):
223
 
        compressed_bytes = factory._raw_record
 
223
    def get_bytes(self, factory, compressed_bytes):
224
224
        rec, contents = \
225
225
            self._data._parse_record_unchecked(compressed_bytes)
226
226
        delta = self._plain_factory.parse_line_delta(contents, rec[1])
242
242
 
243
243
class KnitContentFactory(ContentFactory):
244
244
    """Content factory for streaming from knits.
245
 
 
 
245
    
246
246
    :seealso ContentFactory:
247
247
    """
248
248
 
249
249
    def __init__(self, key, parents, build_details, sha1, raw_record,
250
 
        annotated, knit=None, network_bytes=None):
 
250
        annotated, knit=None):
251
251
        """Create a KnitContentFactory for key.
252
 
 
 
252
        
253
253
        :param key: The key.
254
254
        :param parents: The parents.
255
255
        :param build_details: The build details as returned from
257
257
        :param sha1: The sha1 expected from the full text of this object.
258
258
        :param raw_record: The bytes of the knit data from disk.
259
259
        :param annotated: True if the raw data is annotated.
260
 
        :param network_bytes: None to calculate the network bytes on demand,
261
 
            not-none if they are already known.
262
260
        """
263
261
        ContentFactory.__init__(self)
264
262
        self.sha1 = sha1
274
272
            annotated_kind = ''
275
273
        self.storage_kind = 'knit-%s%s-gz' % (annotated_kind, kind)
276
274
        self._raw_record = raw_record
277
 
        self._network_bytes = network_bytes
278
275
        self._build_details = build_details
279
276
        self._knit = knit
280
277
 
281
 
    def _create_network_bytes(self):
282
 
        """Create a fully serialised network version for transmission."""
283
 
        # storage_kind, key, parents, Noeol, raw_record
284
 
        key_bytes = '\x00'.join(self.key)
285
 
        if self.parents is None:
286
 
            parent_bytes = 'None:'
287
 
        else:
288
 
            parent_bytes = '\t'.join('\x00'.join(key) for key in self.parents)
289
 
        if self._build_details[1]:
290
 
            noeol = 'N'
291
 
        else:
292
 
            noeol = ' '
293
 
        network_bytes = "%s\n%s\n%s\n%s%s" % (self.storage_kind, key_bytes,
294
 
            parent_bytes, noeol, self._raw_record)
295
 
        self._network_bytes = network_bytes
296
 
 
297
278
    def get_bytes_as(self, storage_kind):
298
279
        if storage_kind == self.storage_kind:
299
 
            if self._network_bytes is None:
300
 
                self._create_network_bytes()
301
 
            return self._network_bytes
302
 
        if ('-ft-' in self.storage_kind and
303
 
            storage_kind in ('chunked', 'fulltext')):
304
 
            adapter_key = (self.storage_kind, 'fulltext')
305
 
            adapter_factory = adapter_registry.get(adapter_key)
306
 
            adapter = adapter_factory(None)
307
 
            bytes = adapter.get_bytes(self)
308
 
            if storage_kind == 'chunked':
309
 
                return [bytes]
310
 
            else:
311
 
                return bytes
 
280
            return self._raw_record
312
281
        if self._knit is not None:
313
 
            # Not redundant with direct conversion above - that only handles
314
 
            # fulltext cases.
315
282
            if storage_kind == 'chunked':
316
283
                return self._knit.get_lines(self.key[0])
317
284
            elif storage_kind == 'fulltext':
320
287
            self.storage_kind)
321
288
 
322
289
 
323
 
class LazyKnitContentFactory(ContentFactory):
324
 
    """A ContentFactory which can either generate full text or a wire form.
325
 
 
326
 
    :seealso ContentFactory:
327
 
    """
328
 
 
329
 
    def __init__(self, key, parents, generator, first):
330
 
        """Create a LazyKnitContentFactory.
331
 
 
332
 
        :param key: The key of the record.
333
 
        :param parents: The parents of the record.
334
 
        :param generator: A _ContentMapGenerator containing the record for this
335
 
            key.
336
 
        :param first: Is this the first content object returned from generator?
337
 
            if it is, its storage kind is knit-delta-closure, otherwise it is
338
 
            knit-delta-closure-ref
339
 
        """
340
 
        self.key = key
341
 
        self.parents = parents
342
 
        self.sha1 = None
343
 
        self._generator = generator
344
 
        self.storage_kind = "knit-delta-closure"
345
 
        if not first:
346
 
            self.storage_kind = self.storage_kind + "-ref"
347
 
        self._first = first
348
 
 
349
 
    def get_bytes_as(self, storage_kind):
350
 
        if storage_kind == self.storage_kind:
351
 
            if self._first:
352
 
                return self._generator._wire_bytes()
353
 
            else:
354
 
                # all the keys etc are contained in the bytes returned in the
355
 
                # first record.
356
 
                return ''
357
 
        if storage_kind in ('chunked', 'fulltext'):
358
 
            chunks = self._generator._get_one_work(self.key).text()
359
 
            if storage_kind == 'chunked':
360
 
                return chunks
361
 
            else:
362
 
                return ''.join(chunks)
363
 
        raise errors.UnavailableRepresentation(self.key, storage_kind,
364
 
            self.storage_kind)
365
 
 
366
 
 
367
 
def knit_delta_closure_to_records(storage_kind, bytes, line_end):
368
 
    """Convert a network record to a iterator over stream records.
369
 
 
370
 
    :param storage_kind: The storage kind of the record.
371
 
        Must be 'knit-delta-closure'.
372
 
    :param bytes: The bytes of the record on the network.
373
 
    """
374
 
    generator = _NetworkContentMapGenerator(bytes, line_end)
375
 
    return generator.get_record_stream()
376
 
 
377
 
 
378
 
def knit_network_to_record(storage_kind, bytes, line_end):
379
 
    """Convert a network record to a record object.
380
 
 
381
 
    :param storage_kind: The storage kind of the record.
382
 
    :param bytes: The bytes of the record on the network.
383
 
    """
384
 
    start = line_end
385
 
    line_end = bytes.find('\n', start)
386
 
    key = tuple(bytes[start:line_end].split('\x00'))
387
 
    start = line_end + 1
388
 
    line_end = bytes.find('\n', start)
389
 
    parent_line = bytes[start:line_end]
390
 
    if parent_line == 'None:':
391
 
        parents = None
392
 
    else:
393
 
        parents = tuple(
394
 
            [tuple(segment.split('\x00')) for segment in parent_line.split('\t')
395
 
             if segment])
396
 
    start = line_end + 1
397
 
    noeol = bytes[start] == 'N'
398
 
    if 'ft' in storage_kind:
399
 
        method = 'fulltext'
400
 
    else:
401
 
        method = 'line-delta'
402
 
    build_details = (method, noeol)
403
 
    start = start + 1
404
 
    raw_record = bytes[start:]
405
 
    annotated = 'annotated' in storage_kind
406
 
    return [KnitContentFactory(key, parents, build_details, None, raw_record,
407
 
        annotated, network_bytes=bytes)]
408
 
 
409
 
 
410
290
class KnitContent(object):
411
291
    """Content of a knit version to which deltas can be applied.
412
 
 
 
292
    
413
293
    This is always stored in memory as a list of lines with \n at the end,
414
 
    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 
415
295
    corresponds to the on-disk knit representation.
416
296
    """
417
297
 
506
386
 
507
387
class PlainKnitContent(KnitContent):
508
388
    """Unannotated content.
509
 
 
 
389
    
510
390
    When annotate[_iter] is called on this content, the same version is reported
511
391
    for all lines. Generally, annotate[_iter] is not useful on PlainKnitContent
512
392
    objects.
664
544
 
665
545
        see parse_fulltext which this inverts.
666
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
667
549
        return ['%s %s' % (o, t) for o, t in content._lines]
668
550
 
669
551
    def lower_line_delta(self, delta):
684
566
        content = knit._get_content(key)
685
567
        # adjust for the fact that serialised annotations are only key suffixes
686
568
        # for this factory.
687
 
        if type(key) is tuple:
 
569
        if type(key) == tuple:
688
570
            prefix = key[:-1]
689
571
            origins = content.annotate()
690
572
            result = []
756
638
 
757
639
    def annotate(self, knit, key):
758
640
        annotator = _KnitAnnotator(knit)
759
 
        return annotator.annotate_flat(key)
 
641
        return annotator.annotate(key)
760
642
 
761
643
 
762
644
 
765
647
 
766
648
    This is only functional enough to run interface tests, it doesn't try to
767
649
    provide a full pack environment.
768
 
 
 
650
    
769
651
    :param annotated: knit annotations are wanted.
770
652
    :param mapper: The mapper from keys to paths.
771
653
    """
781
663
 
782
664
    This is only functional enough to run interface tests, it doesn't try to
783
665
    provide a full pack environment.
784
 
 
 
666
    
785
667
    :param graph: Store a graph.
786
668
    :param delta: Delta compress contents.
787
669
    :param keylength: How long should keys be.
818
700
    versioned_files.writer.end()
819
701
 
820
702
 
821
 
def _get_total_build_size(self, keys, positions):
822
 
    """Determine the total bytes to build these keys.
823
 
 
824
 
    (helper function because _KnitGraphIndex and _KndxIndex work the same, but
825
 
    don't inherit from a common base.)
826
 
 
827
 
    :param keys: Keys that we want to build
828
 
    :param positions: dict of {key, (info, index_memo, comp_parent)} (such
829
 
        as returned by _get_components_positions)
830
 
    :return: Number of bytes to build those keys
831
 
    """
832
 
    all_build_index_memos = {}
833
 
    build_keys = keys
834
 
    while build_keys:
835
 
        next_keys = set()
836
 
        for key in build_keys:
837
 
            # This is mostly for the 'stacked' case
838
 
            # Where we will be getting the data from a fallback
839
 
            if key not in positions:
840
 
                continue
841
 
            _, index_memo, compression_parent = positions[key]
842
 
            all_build_index_memos[key] = index_memo
843
 
            if compression_parent not in all_build_index_memos:
844
 
                next_keys.add(compression_parent)
845
 
        build_keys = next_keys
846
 
    return sum([index_memo[2] for index_memo
847
 
                in all_build_index_memos.itervalues()])
848
 
 
849
 
 
850
703
class KnitVersionedFiles(VersionedFiles):
851
704
    """Storage for many versioned files using knit compression.
852
705
 
853
706
    Backend storage is managed by indices and data objects.
854
707
 
855
 
    :ivar _index: A _KnitGraphIndex or similar that can describe the
856
 
        parents, graph, compression and data location of entries in this
857
 
        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 
858
711
        *this* vfs; if there are fallbacks they must be queried separately.
859
712
    """
860
713
 
907
760
            # indexes can't directly store that, so we give them
908
761
            # an empty tuple instead.
909
762
            parents = ()
910
 
        line_bytes = ''.join(lines)
911
763
        return self._add(key, lines, parents,
912
 
            parent_texts, left_matching_blocks, nostore_sha, random_id,
913
 
            line_bytes=line_bytes)
914
 
 
915
 
    def _add_text(self, key, parents, text, nostore_sha=None, random_id=False):
916
 
        """See VersionedFiles._add_text()."""
917
 
        self._index._check_write_ok()
918
 
        self._check_add(key, None, random_id, check_content=False)
919
 
        if text.__class__ is not str:
920
 
            raise errors.BzrBadParameterUnicode("text")
921
 
        if parents is None:
922
 
            # The caller might pass None if there is no graph data, but kndx
923
 
            # indexes can't directly store that, so we give them
924
 
            # an empty tuple instead.
925
 
            parents = ()
926
 
        return self._add(key, None, parents,
927
 
            None, None, nostore_sha, random_id,
928
 
            line_bytes=text)
 
764
            parent_texts, left_matching_blocks, nostore_sha, random_id)
929
765
 
930
766
    def _add(self, key, lines, parents, parent_texts,
931
 
        left_matching_blocks, nostore_sha, random_id,
932
 
        line_bytes):
 
767
        left_matching_blocks, nostore_sha, random_id):
933
768
        """Add a set of lines on top of version specified by parents.
934
769
 
935
770
        Any versions not present will be converted into ghosts.
936
 
 
937
 
        :param lines: A list of strings where each one is a single line (has a
938
 
            single newline at the end of the string) This is now optional
939
 
            (callers can pass None). It is left in its location for backwards
940
 
            compatibility. It should ''.join(lines) must == line_bytes
941
 
        :param line_bytes: A single string containing the content
942
 
 
943
 
        We pass both lines and line_bytes because different routes bring the
944
 
        values to this function. And for memory efficiency, we don't want to
945
 
        have to split/join on-demand.
946
771
        """
947
772
        # first thing, if the content is something we don't need to store, find
948
773
        # that out.
 
774
        line_bytes = ''.join(lines)
949
775
        digest = sha_string(line_bytes)
950
776
        if nostore_sha == digest:
951
777
            raise errors.ExistingContent
972
798
 
973
799
        text_length = len(line_bytes)
974
800
        options = []
975
 
        no_eol = False
976
 
        # Note: line_bytes is not modified to add a newline, that is tracked
977
 
        #       via the no_eol flag. 'lines' *is* modified, because that is the
978
 
        #       general values needed by the Content code.
979
 
        if line_bytes and line_bytes[-1] != '\n':
980
 
            options.append('no-eol')
981
 
            no_eol = True
982
 
            # Copy the existing list, or create a new one
983
 
            if lines is None:
984
 
                lines = osutils.split_lines(line_bytes)
985
 
            else:
 
801
        if lines:
 
802
            if lines[-1][-1] != '\n':
 
803
                # copy the contents of lines.
986
804
                lines = lines[:]
987
 
            # Replace the last line with one that ends in a final newline
988
 
            lines[-1] = lines[-1] + '\n'
989
 
        if lines is None:
990
 
            lines = osutils.split_lines(line_bytes)
 
805
                options.append('no-eol')
 
806
                lines[-1] = lines[-1] + '\n'
 
807
                line_bytes += '\n'
991
808
 
992
 
        for element in key[:-1]:
993
 
            if type(element) is not str:
994
 
                raise TypeError("key contains non-strings: %r" % (key,))
995
 
        if key[-1] is None:
996
 
            key = key[:-1] + ('sha1:' + digest,)
997
 
        elif type(key[-1]) is not str:
 
809
        for element in key:
 
810
            if type(element) != str:
998
811
                raise TypeError("key contains non-strings: %r" % (key,))
999
812
        # Knit hunks are still last-element only
1000
813
        version_id = key[-1]
1001
814
        content = self._factory.make(lines, version_id)
1002
 
        if no_eol:
 
815
        if 'no-eol' in options:
1003
816
            # Hint to the content object that its text() call should strip the
1004
817
            # EOL.
1005
818
            content._should_strip_eol = True
1017
830
        else:
1018
831
            options.append('fulltext')
1019
832
            # isinstance is slower and we have no hierarchy.
1020
 
            if self._factory.__class__ is KnitPlainFactory:
 
833
            if self._factory.__class__ == KnitPlainFactory:
1021
834
                # Use the already joined bytes saving iteration time in
1022
835
                # _record_to_data.
1023
 
                dense_lines = [line_bytes]
1024
 
                if no_eol:
1025
 
                    dense_lines.append('\n')
1026
836
                size, bytes = self._record_to_data(key, digest,
1027
 
                    lines, dense_lines)
 
837
                    lines, [line_bytes])
1028
838
            else:
1029
839
                # get mixed annotation + content and feed it into the
1030
840
                # serialiser.
1042
852
        """See VersionedFiles.annotate."""
1043
853
        return self._factory.annotate(self, key)
1044
854
 
1045
 
    def get_annotator(self):
1046
 
        return _KnitAnnotator(self)
1047
 
 
1048
855
    def check(self, progress_bar=None):
1049
856
        """See VersionedFiles.check()."""
1050
857
        # This doesn't actually test extraction of everything, but that will
1066
873
    def _check_add(self, key, lines, random_id, check_content):
1067
874
        """check that version_id and lines are safe to add."""
1068
875
        version_id = key[-1]
1069
 
        if version_id is not None:
1070
 
            if contains_whitespace(version_id):
1071
 
                raise InvalidRevisionId(version_id, self)
1072
 
            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)
1073
879
        # TODO: If random_id==False and the key is already present, we should
1074
880
        # probably check that the existing content is identical to what is
1075
881
        # being inserted, and otherwise raise an exception.  This would make
1085
891
 
1086
892
    def _check_header_version(self, rec, version_id):
1087
893
        """Checks the header version on original format knit records.
1088
 
 
 
894
        
1089
895
        These have the last component of the key embedded in the record.
1090
896
        """
1091
897
        if rec[1] != version_id:
1113
919
                # boundaries.
1114
920
                build_details = self._index.get_build_details([parent])
1115
921
                parent_details = build_details[parent]
1116
 
            except (RevisionNotPresent, KeyError), e:
 
922
            except RevisionNotPresent, KeyError:
1117
923
                # Some basis is not locally present: always fulltext
1118
924
                return False
1119
925
            index_memo, compression_parent, _, _ = parent_details
1170
976
            if missing and not allow_missing:
1171
977
                raise errors.RevisionNotPresent(missing.pop(), self)
1172
978
        return component_data
1173
 
 
 
979
       
1174
980
    def _get_content(self, key, parent_texts={}):
1175
981
        """Returns a content object that makes up the specified
1176
982
        version."""
1180
986
            if not self.get_parent_map([key]):
1181
987
                raise RevisionNotPresent(key, self)
1182
988
            return cached_version
1183
 
        generator = _VFContentMapGenerator(self, [key])
1184
 
        return generator._get_content(key)
 
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:
 
1019
            if not missing_keys:
 
1020
                break
 
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
1185
1070
 
1186
1071
    def get_parent_map(self, keys):
1187
1072
        """Get a map of the graph parents of keys.
1217
1102
 
1218
1103
    def _get_record_map(self, keys, allow_missing=False):
1219
1104
        """Produce a dictionary of knit records.
1220
 
 
 
1105
        
1221
1106
        :return: {key:(record, record_details, digest, next)}
1222
1107
            record
1223
 
                data returned from read_records (a KnitContentobject)
 
1108
                data returned from read_records
1224
1109
            record_details
1225
1110
                opaque information to pass to parse_record
1226
1111
            digest
1229
1114
                build-parent of the version, i.e. the leftmost ancestor.
1230
1115
                Will be None if the record is not a delta.
1231
1116
        :param keys: The keys to build a map for
1232
 
        :param allow_missing: If some records are missing, rather than
 
1117
        :param allow_missing: If some records are missing, rather than 
1233
1118
            error, just return the data that could be generated.
1234
1119
        """
1235
 
        raw_map = self._get_record_map_unparsed(keys,
1236
 
            allow_missing=allow_missing)
1237
 
        return self._raw_map_to_record_map(raw_map)
1238
 
 
1239
 
    def _raw_map_to_record_map(self, raw_map):
1240
 
        """Parse the contents of _get_record_map_unparsed.
1241
 
 
1242
 
        :return: see _get_record_map.
1243
 
        """
1244
 
        result = {}
1245
 
        for key in raw_map:
1246
 
            data, record_details, next = raw_map[key]
1247
 
            content, digest = self._parse_record(key[-1], data)
1248
 
            result[key] = content, record_details, digest, next
1249
 
        return result
1250
 
 
1251
 
    def _get_record_map_unparsed(self, keys, allow_missing=False):
1252
 
        """Get the raw data for reconstructing keys without parsing it.
1253
 
 
1254
 
        :return: A dict suitable for parsing via _raw_map_to_record_map.
1255
 
            key-> raw_bytes, (method, noeol), compression_parent
1256
 
        """
1257
1120
        # This retries the whole request if anything fails. Potentially we
1258
1121
        # could be a bit more selective. We could track the keys whose records
1259
1122
        # we have successfully found, and then only request the new records
1269
1132
                # n = next
1270
1133
                records = [(key, i_m) for key, (r, i_m, n)
1271
1134
                                       in position_map.iteritems()]
1272
 
                # Sort by the index memo, so that we request records from the
1273
 
                # same pack file together, and in forward-sorted order
1274
 
                records.sort(key=operator.itemgetter(1))
1275
 
                raw_record_map = {}
1276
 
                for key, data in self._read_records_iter_unchecked(records):
 
1135
                record_map = {}
 
1136
                for key, record, digest in self._read_records_iter(records):
1277
1137
                    (record_details, index_memo, next) = position_map[key]
1278
 
                    raw_record_map[key] = data, record_details, next
1279
 
                return raw_record_map
 
1138
                    record_map[key] = record, record_details, digest, next
 
1139
                return record_map
1280
1140
            except errors.RetryWithNewPacks, e:
1281
1141
                self._access.reload_or_raise(e)
1282
1142
 
1283
 
    @classmethod
1284
 
    def _split_by_prefix(cls, keys):
 
1143
    def _split_by_prefix(self, keys):
1285
1144
        """For the given keys, split them up based on their prefix.
1286
1145
 
1287
1146
        To keep memory pressure somewhat under control, split the
1290
1149
        This should be revisited if _get_content_maps() can ever cross
1291
1150
        file-id boundaries.
1292
1151
 
1293
 
        The keys for a given file_id are kept in the same relative order.
1294
 
        Ordering between file_ids is not, though prefix_order will return the
1295
 
        order that the key was first seen.
1296
 
 
1297
1152
        :param keys: An iterable of key tuples
1298
 
        :return: (split_map, prefix_order)
1299
 
            split_map       A dictionary mapping prefix => keys
1300
 
            prefix_order    The order that we saw the various prefixes
 
1153
        :return: A dict of {prefix: [key_list]}
1301
1154
        """
1302
1155
        split_by_prefix = {}
1303
 
        prefix_order = []
1304
1156
        for key in keys:
1305
1157
            if len(key) == 1:
1306
 
                prefix = ''
1307
 
            else:
1308
 
                prefix = key[0]
1309
 
 
1310
 
            if prefix in split_by_prefix:
1311
 
                split_by_prefix[prefix].append(key)
1312
 
            else:
1313
 
                split_by_prefix[prefix] = [key]
1314
 
                prefix_order.append(prefix)
1315
 
        return split_by_prefix, prefix_order
1316
 
 
1317
 
    def _group_keys_for_io(self, keys, non_local_keys, positions,
1318
 
                           _min_buffer_size=_STREAM_MIN_BUFFER_SIZE):
1319
 
        """For the given keys, group them into 'best-sized' requests.
1320
 
 
1321
 
        The idea is to avoid making 1 request per file, but to never try to
1322
 
        unpack an entire 1.5GB source tree in a single pass. Also when
1323
 
        possible, we should try to group requests to the same pack file
1324
 
        together.
1325
 
 
1326
 
        :return: list of (keys, non_local) tuples that indicate what keys
1327
 
            should be fetched next.
1328
 
        """
1329
 
        # TODO: Ideally we would group on 2 factors. We want to extract texts
1330
 
        #       from the same pack file together, and we want to extract all
1331
 
        #       the texts for a given build-chain together. Ultimately it
1332
 
        #       probably needs a better global view.
1333
 
        total_keys = len(keys)
1334
 
        prefix_split_keys, prefix_order = self._split_by_prefix(keys)
1335
 
        prefix_split_non_local_keys, _ = self._split_by_prefix(non_local_keys)
1336
 
        cur_keys = []
1337
 
        cur_non_local = set()
1338
 
        cur_size = 0
1339
 
        result = []
1340
 
        sizes = []
1341
 
        for prefix in prefix_order:
1342
 
            keys = prefix_split_keys[prefix]
1343
 
            non_local = prefix_split_non_local_keys.get(prefix, [])
1344
 
 
1345
 
            this_size = self._index._get_total_build_size(keys, positions)
1346
 
            cur_size += this_size
1347
 
            cur_keys.extend(keys)
1348
 
            cur_non_local.update(non_local)
1349
 
            if cur_size > _min_buffer_size:
1350
 
                result.append((cur_keys, cur_non_local))
1351
 
                sizes.append(cur_size)
1352
 
                cur_keys = []
1353
 
                cur_non_local = set()
1354
 
                cur_size = 0
1355
 
        if cur_keys:
1356
 
            result.append((cur_keys, cur_non_local))
1357
 
            sizes.append(cur_size)
1358
 
        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
1359
1162
 
1360
1163
    def get_record_stream(self, keys, ordering, include_delta_closure):
1361
1164
        """Get a stream of records for keys.
1374
1177
        if not keys:
1375
1178
            return
1376
1179
        if not self._index.has_graph:
1377
 
            # Cannot sort when no graph has been stored.
 
1180
            # Cannot topological order when no graph has been stored.
1378
1181
            ordering = 'unordered'
1379
1182
 
1380
1183
        remaining_keys = keys
1403
1206
        absent_keys = keys.difference(set(positions))
1404
1207
        # There may be more absent keys : if we're missing the basis component
1405
1208
        # and are trying to include the delta closure.
1406
 
        # XXX: We should not ever need to examine remote sources because we do
1407
 
        # not permit deltas across versioned files boundaries.
1408
1209
        if include_delta_closure:
1409
1210
            needed_from_fallback = set()
1410
1211
            # Build up reconstructable_keys dict.  key:True in this dict means
1436
1237
                    needed_from_fallback.add(key)
1437
1238
        # Double index lookups here : need a unified api ?
1438
1239
        global_map, parent_maps = self._get_parent_map_with_sources(keys)
1439
 
        if ordering in ('topological', 'groupcompress'):
1440
 
            if ordering == 'topological':
1441
 
                # Global topological sort
1442
 
                present_keys = tsort.topo_sort(global_map)
1443
 
            else:
1444
 
                present_keys = sort_groupcompress(global_map)
 
1240
        if ordering == 'topological':
 
1241
            # Global topological sort
 
1242
            present_keys = tsort.topo_sort(global_map)
1445
1243
            # Now group by source:
1446
1244
            source_keys = []
1447
1245
            current_source = None
1457
1255
        else:
1458
1256
            if ordering != 'unordered':
1459
1257
                raise AssertionError('valid values for ordering are:'
1460
 
                    ' "unordered", "groupcompress" or "topological" not: %r'
 
1258
                    ' "unordered" or "topological" not: %r'
1461
1259
                    % (ordering,))
1462
1260
            # Just group by source; remote sources first.
1463
1261
            present_keys = []
1485
1283
            # XXX: get_content_maps performs its own index queries; allow state
1486
1284
            # to be passed in.
1487
1285
            non_local_keys = needed_from_fallback - absent_keys
1488
 
            for keys, non_local_keys in self._group_keys_for_io(present_keys,
1489
 
                                                                non_local_keys,
1490
 
                                                                positions):
1491
 
                generator = _VFContentMapGenerator(self, keys, non_local_keys,
1492
 
                                                   global_map)
1493
 
                for record in generator.get_record_stream():
1494
 
                    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)
1495
1296
        else:
1496
1297
            for source, keys in source_keys:
1497
1298
                if source is parent_maps[0]:
1529
1330
    def insert_record_stream(self, stream):
1530
1331
        """Insert a record stream into this container.
1531
1332
 
1532
 
        :param stream: A stream of records to insert.
 
1333
        :param stream: A stream of records to insert. 
1533
1334
        :return: None
1534
1335
        :seealso VersionedFiles.get_record_stream:
1535
1336
        """
1575
1376
        # key = basis_parent, value = index entry to add
1576
1377
        buffered_index_entries = {}
1577
1378
        for record in stream:
1578
 
            buffered = False
1579
1379
            parents = record.parents
1580
1380
            if record.storage_kind in delta_types:
1581
1381
                # TODO: eventually the record itself should track
1608
1408
                    except KeyError:
1609
1409
                        adapter_key = (record.storage_kind, "knit-ft-gz")
1610
1410
                        adapter = get_adapter(adapter_key)
1611
 
                    bytes = adapter.get_bytes(record)
 
1411
                    bytes = adapter.get_bytes(
 
1412
                        record, record.get_bytes_as(record.storage_kind))
1612
1413
                else:
1613
 
                    # It's a knit record, it has a _raw_record field (even if
1614
 
                    # it was reconstituted from a network stream).
1615
 
                    bytes = record._raw_record
 
1414
                    bytes = record.get_bytes_as(record.storage_kind)
1616
1415
                options = [record._build_details[0]]
1617
1416
                if record._build_details[1]:
1618
1417
                    options.append('no-eol')
1627
1426
                access_memo = self._access.add_raw_records(
1628
1427
                    [(record.key, len(bytes))], bytes)[0]
1629
1428
                index_entry = (record.key, options, access_memo, parents)
 
1429
                buffered = False
1630
1430
                if 'fulltext' not in options:
1631
1431
                    # Not a fulltext, so we need to make sure the compression
1632
1432
                    # parent will also be present.
1648
1448
            elif record.storage_kind == 'chunked':
1649
1449
                self.add_lines(record.key, parents,
1650
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')))
1651
1454
            else:
1652
 
                # Not suitable for direct insertion as a
 
1455
                # Not a fulltext, and not suitable for direct insertion as a
1653
1456
                # delta, either because it's not the right format, or this
1654
1457
                # KnitVersionedFiles doesn't permit deltas (_max_delta_chain ==
1655
1458
                # 0) or because it depends on a base only present in the
1656
1459
                # fallback kvfs.
1657
 
                self._access.flush()
1658
 
                try:
1659
 
                    # Try getting a fulltext directly from the record.
1660
 
                    bytes = record.get_bytes_as('fulltext')
1661
 
                except errors.UnavailableRepresentation:
1662
 
                    adapter_key = record.storage_kind, 'fulltext'
1663
 
                    adapter = get_adapter(adapter_key)
1664
 
                    bytes = adapter.get_bytes(record)
1665
 
                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)))
1666
1464
                try:
1667
1465
                    self.add_lines(record.key, parents, lines)
1668
1466
                except errors.RevisionAlreadyPresent:
1669
1467
                    pass
1670
1468
            # Add any records whose basis parent is now available.
1671
 
            if not buffered:
1672
 
                added_keys = [record.key]
1673
 
                while added_keys:
1674
 
                    key = added_keys.pop(0)
1675
 
                    if key in buffered_index_entries:
1676
 
                        index_entries = buffered_index_entries[key]
1677
 
                        self._index.add_records(index_entries)
1678
 
                        added_keys.extend(
1679
 
                            [index_entry[0] for index_entry in index_entries])
1680
 
                        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.
1681
1479
        if buffered_index_entries:
1682
 
            # There were index entries buffered at the end of the stream,
1683
 
            # So these need to be added (if the index supports holding such
1684
 
            # entries for later insertion)
1685
 
            for key in buffered_index_entries:
1686
 
                index_entries = buffered_index_entries[key]
1687
 
                self._index.add_records(index_entries,
1688
 
                    missing_compression_parents=True)
1689
 
 
1690
 
    def get_missing_compression_parent_keys(self):
1691
 
        """Return an iterable of keys of missing compression parents.
1692
 
 
1693
 
        Check this after calling insert_record_stream to find out if there are
1694
 
        any missing compression parents.  If there are, the records that
1695
 
        depend on them are not able to be inserted safely. For atomic
1696
 
        KnitVersionedFiles built on packs, the transaction should be aborted or
1697
 
        suspended - commit will fail at this point. Nonatomic knits will error
1698
 
        earlier because they have no staging area to put pending entries into.
1699
 
        """
1700
 
        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()))))
1701
1484
 
1702
1485
    def iter_lines_added_or_present_in_keys(self, keys, pb=None):
1703
1486
        """Iterate over the lines in the versioned files from keys.
1720
1503
         * If a requested key did not change any lines (or didn't have any
1721
1504
           lines), it may not be mentioned at all in the result.
1722
1505
 
1723
 
        :param pb: Progress bar supplied by caller.
1724
1506
        :return: An iterator over (line, key).
1725
1507
        """
1726
1508
        if pb is None:
1740
1522
                        key_records.append((key, details[0]))
1741
1523
                records_iter = enumerate(self._read_records_iter(key_records))
1742
1524
                for (key_idx, (key, data, sha_value)) in records_iter:
1743
 
                    pb.update('Walking content', key_idx, total)
 
1525
                    pb.update('Walking content.', key_idx, total)
1744
1526
                    compression_parent = build_details[key][1]
1745
1527
                    if compression_parent is None:
1746
1528
                        # fulltext
1747
1529
                        line_iterator = self._factory.get_fulltext_content(data)
1748
1530
                    else:
1749
 
                        # Delta
 
1531
                        # Delta 
1750
1532
                        line_iterator = self._factory.get_linedelta_content(data)
1751
1533
                    # Now that we are yielding the data for this key, remove it
1752
1534
                    # from the list
1763
1545
        # If there are still keys we've not yet found, we look in the fallback
1764
1546
        # vfs, and hope to find them there.  Note that if the keys are found
1765
1547
        # but had no changes or no content, the fallback may not return
1766
 
        # anything.
 
1548
        # anything.  
1767
1549
        if keys and not self._fallback_vfs:
1768
1550
            # XXX: strictly the second parameter is meant to be the file id
1769
1551
            # but it's not easily accessible here.
1776
1558
                source_keys.add(key)
1777
1559
                yield line, key
1778
1560
            keys.difference_update(source_keys)
1779
 
        pb.update('Walking content', total, total)
 
1561
        pb.update('Walking content.', total, total)
1780
1562
 
1781
1563
    def _make_line_delta(self, delta_seq, new_content):
1782
1564
        """Generate a line delta from delta_seq and new_content."""
1791
1573
                           delta=None, annotated=None,
1792
1574
                           left_matching_blocks=None):
1793
1575
        """Merge annotations for content and generate deltas.
1794
 
 
 
1576
        
1795
1577
        This is done by comparing the annotations based on changes to the text
1796
1578
        and generating a delta on the resulting full texts. If annotations are
1797
1579
        not being created then a simple delta is created.
1879
1661
                                 rec[1], record_contents))
1880
1662
        if last_line != 'end %s\n' % rec[1]:
1881
1663
            raise KnitCorrupt(self,
1882
 
                              'unexpected version end line %r, wanted %r'
 
1664
                              'unexpected version end line %r, wanted %r' 
1883
1665
                              % (last_line, rec[1]))
1884
1666
        df.close()
1885
1667
        return rec, record_contents
1902
1684
        if not needed_records:
1903
1685
            return
1904
1686
 
1905
 
        # The transport optimizes the fetching as well
 
1687
        # The transport optimizes the fetching as well 
1906
1688
        # (ie, reads continuous ranges.)
1907
1689
        raw_data = self._access.get_raw_records(
1908
1690
            [index_memo for key, index_memo in needed_records])
1918
1700
        This unpacks enough of the text record to validate the id is
1919
1701
        as expected but thats all.
1920
1702
 
1921
 
        Each item the iterator yields is (key, bytes,
1922
 
            expected_sha1_of_full_text).
1923
 
        """
1924
 
        for key, data in self._read_records_iter_unchecked(records):
1925
 
            # validate the header (note that we can only use the suffix in
1926
 
            # current knit records).
1927
 
            df, rec = self._parse_record_header(key, data)
1928
 
            df.close()
1929
 
            yield key, data, rec[3]
1930
 
 
1931
 
    def _read_records_iter_unchecked(self, records):
1932
 
        """Read text records from data file and yield raw data.
1933
 
 
1934
 
        No validation is done.
1935
 
 
1936
 
        Yields tuples of (key, data).
 
1703
        Each item the iterator yields is (key, bytes, sha1_of_full_text).
1937
1704
        """
1938
1705
        # setup an iterator of the external records:
1939
1706
        # uses readv so nice and fast we hope.
1945
1712
 
1946
1713
        for key, index_memo in records:
1947
1714
            data = raw_records.next()
1948
 
            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]
1949
1720
 
1950
1721
    def _record_to_data(self, key, digest, lines, dense_lines=None):
1951
1722
        """Convert key, digest, lines into a raw data block.
1952
 
 
 
1723
        
1953
1724
        :param key: The key of the record. Currently keys are always serialised
1954
1725
            using just the trailing component.
1955
1726
        :param dense_lines: The bytes of lines but in a denser form. For
1960
1731
            function spends less time resizing the final string.
1961
1732
        :return: (len, a StringIO instance with the raw data ready to read.)
1962
1733
        """
1963
 
        chunks = ["version %s %d %s\n" % (key[-1], len(lines), digest)]
1964
 
        chunks.extend(dense_lines or lines)
1965
 
        chunks.append("end %s\n" % key[-1])
1966
 
        for chunk in chunks:
1967
 
            if type(chunk) is not str:
1968
 
                raise AssertionError(
1969
 
                    '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))
1970
1746
        if lines and lines[-1][-1] != '\n':
1971
1747
            raise ValueError('corrupt lines value %r' % lines)
1972
 
        compressed_bytes = tuned_gzip.chunks_to_gzip(chunks)
 
1748
        compressed_bytes = tuned_gzip.bytes_to_gzip(bytes)
1973
1749
        return len(compressed_bytes), compressed_bytes
1974
1750
 
1975
1751
    def _split_header(self, line):
1990
1766
        return result
1991
1767
 
1992
1768
 
1993
 
class _ContentMapGenerator(object):
1994
 
    """Generate texts or expose raw deltas for a set of texts."""
1995
 
 
1996
 
    def _get_content(self, key):
1997
 
        """Get the content object for key."""
1998
 
        # Note that _get_content is only called when the _ContentMapGenerator
1999
 
        # has been constructed with just one key requested for reconstruction.
2000
 
        if key in self.nonlocal_keys:
2001
 
            record = self.get_record_stream().next()
2002
 
            # Create a content object on the fly
2003
 
            lines = osutils.chunks_to_lines(record.get_bytes_as('chunked'))
2004
 
            return PlainKnitContent(lines, record.key)
2005
 
        else:
2006
 
            # local keys we can ask for directly
2007
 
            return self._get_one_work(key)
2008
 
 
2009
 
    def get_record_stream(self):
2010
 
        """Get a record stream for the keys requested during __init__."""
2011
 
        for record in self._work():
2012
 
            yield record
2013
 
 
2014
 
    def _work(self):
2015
 
        """Produce maps of text and KnitContents as dicts.
2016
 
 
2017
 
        :return: (text_map, content_map) where text_map contains the texts for
2018
 
            the requested versions and content_map contains the KnitContents.
2019
 
        """
2020
 
        # NB: By definition we never need to read remote sources unless texts
2021
 
        # are requested from them: we don't delta across stores - and we
2022
 
        # explicitly do not want to to prevent data loss situations.
2023
 
        if self.global_map is None:
2024
 
            self.global_map = self.vf.get_parent_map(self.keys)
2025
 
        nonlocal_keys = self.nonlocal_keys
2026
 
 
2027
 
        missing_keys = set(nonlocal_keys)
2028
 
        # Read from remote versioned file instances and provide to our caller.
2029
 
        for source in self.vf._fallback_vfs:
2030
 
            if not missing_keys:
2031
 
                break
2032
 
            # Loop over fallback repositories asking them for texts - ignore
2033
 
            # any missing from a particular fallback.
2034
 
            for record in source.get_record_stream(missing_keys,
2035
 
                'unordered', True):
2036
 
                if record.storage_kind == 'absent':
2037
 
                    # Not in thie particular stream, may be in one of the
2038
 
                    # other fallback vfs objects.
2039
 
                    continue
2040
 
                missing_keys.remove(record.key)
2041
 
                yield record
2042
 
 
2043
 
        if self._raw_record_map is None:
2044
 
            raise AssertionError('_raw_record_map should have been filled')
2045
 
        first = True
2046
 
        for key in self.keys:
2047
 
            if key in self.nonlocal_keys:
2048
 
                continue
2049
 
            yield LazyKnitContentFactory(key, self.global_map[key], self, first)
2050
 
            first = False
2051
 
 
2052
 
    def _get_one_work(self, requested_key):
2053
 
        # Now, if we have calculated everything already, just return the
2054
 
        # desired text.
2055
 
        if requested_key in self._contents_map:
2056
 
            return self._contents_map[requested_key]
2057
 
        # To simplify things, parse everything at once - code that wants one text
2058
 
        # probably wants them all.
2059
 
        # FUTURE: This function could be improved for the 'extract many' case
2060
 
        # by tracking each component and only doing the copy when the number of
2061
 
        # children than need to apply delta's to it is > 1 or it is part of the
2062
 
        # final output.
2063
 
        multiple_versions = len(self.keys) != 1
2064
 
        if self._record_map is None:
2065
 
            self._record_map = self.vf._raw_map_to_record_map(
2066
 
                self._raw_record_map)
2067
 
        record_map = self._record_map
2068
 
        # raw_record_map is key:
2069
 
        # Have read and parsed records at this point.
2070
 
        for key in self.keys:
2071
 
            if key in self.nonlocal_keys:
2072
 
                # already handled
2073
 
                continue
2074
 
            components = []
2075
 
            cursor = key
2076
 
            while cursor is not None:
2077
 
                try:
2078
 
                    record, record_details, digest, next = record_map[cursor]
2079
 
                except KeyError:
2080
 
                    raise RevisionNotPresent(cursor, self)
2081
 
                components.append((cursor, record, record_details, digest))
2082
 
                cursor = next
2083
 
                if cursor in self._contents_map:
2084
 
                    # no need to plan further back
2085
 
                    components.append((cursor, None, None, None))
2086
 
                    break
2087
 
 
2088
 
            content = None
2089
 
            for (component_id, record, record_details,
2090
 
                 digest) in reversed(components):
2091
 
                if component_id in self._contents_map:
2092
 
                    content = self._contents_map[component_id]
2093
 
                else:
2094
 
                    content, delta = self._factory.parse_record(key[-1],
2095
 
                        record, record_details, content,
2096
 
                        copy_base_content=multiple_versions)
2097
 
                    if multiple_versions:
2098
 
                        self._contents_map[component_id] = content
2099
 
 
2100
 
            # digest here is the digest from the last applied component.
2101
 
            text = content.text()
2102
 
            actual_sha = sha_strings(text)
2103
 
            if actual_sha != digest:
2104
 
                raise SHA1KnitCorrupt(self, actual_sha, digest, key, text)
2105
 
        if multiple_versions:
2106
 
            return self._contents_map[requested_key]
2107
 
        else:
2108
 
            return content
2109
 
 
2110
 
    def _wire_bytes(self):
2111
 
        """Get the bytes to put on the wire for 'key'.
2112
 
 
2113
 
        The first collection of bytes asked for returns the serialised
2114
 
        raw_record_map and the additional details (key, parent) for key.
2115
 
        Subsequent calls return just the additional details (key, parent).
2116
 
        The wire storage_kind given for the first key is 'knit-delta-closure',
2117
 
        For subsequent keys it is 'knit-delta-closure-ref'.
2118
 
 
2119
 
        :param key: A key from the content generator.
2120
 
        :return: Bytes to put on the wire.
2121
 
        """
2122
 
        lines = []
2123
 
        # kind marker for dispatch on the far side,
2124
 
        lines.append('knit-delta-closure')
2125
 
        # Annotated or not
2126
 
        if self.vf._factory.annotated:
2127
 
            lines.append('annotated')
2128
 
        else:
2129
 
            lines.append('')
2130
 
        # then the list of keys
2131
 
        lines.append('\t'.join(['\x00'.join(key) for key in self.keys
2132
 
            if key not in self.nonlocal_keys]))
2133
 
        # then the _raw_record_map in serialised form:
2134
 
        map_byte_list = []
2135
 
        # for each item in the map:
2136
 
        # 1 line with key
2137
 
        # 1 line with parents if the key is to be yielded (None: for None, '' for ())
2138
 
        # one line with method
2139
 
        # one line with noeol
2140
 
        # one line with next ('' for None)
2141
 
        # one line with byte count of the record bytes
2142
 
        # the record bytes
2143
 
        for key, (record_bytes, (method, noeol), next) in \
2144
 
            self._raw_record_map.iteritems():
2145
 
            key_bytes = '\x00'.join(key)
2146
 
            parents = self.global_map.get(key, None)
2147
 
            if parents is None:
2148
 
                parent_bytes = 'None:'
2149
 
            else:
2150
 
                parent_bytes = '\t'.join('\x00'.join(key) for key in parents)
2151
 
            method_bytes = method
2152
 
            if noeol:
2153
 
                noeol_bytes = "T"
2154
 
            else:
2155
 
                noeol_bytes = "F"
2156
 
            if next:
2157
 
                next_bytes = '\x00'.join(next)
2158
 
            else:
2159
 
                next_bytes = ''
2160
 
            map_byte_list.append('%s\n%s\n%s\n%s\n%s\n%d\n%s' % (
2161
 
                key_bytes, parent_bytes, method_bytes, noeol_bytes, next_bytes,
2162
 
                len(record_bytes), record_bytes))
2163
 
        map_bytes = ''.join(map_byte_list)
2164
 
        lines.append(map_bytes)
2165
 
        bytes = '\n'.join(lines)
2166
 
        return bytes
2167
 
 
2168
 
 
2169
 
class _VFContentMapGenerator(_ContentMapGenerator):
2170
 
    """Content map generator reading from a VersionedFiles object."""
2171
 
 
2172
 
    def __init__(self, versioned_files, keys, nonlocal_keys=None,
2173
 
        global_map=None, raw_record_map=None):
2174
 
        """Create a _ContentMapGenerator.
2175
 
 
2176
 
        :param versioned_files: The versioned files that the texts are being
2177
 
            extracted from.
2178
 
        :param keys: The keys to produce content maps for.
2179
 
        :param nonlocal_keys: An iterable of keys(possibly intersecting keys)
2180
 
            which are known to not be in this knit, but rather in one of the
2181
 
            fallback knits.
2182
 
        :param global_map: The result of get_parent_map(keys) (or a supermap).
2183
 
            This is required if get_record_stream() is to be used.
2184
 
        :param raw_record_map: A unparsed raw record map to use for answering
2185
 
            contents.
2186
 
        """
2187
 
        # The vf to source data from
2188
 
        self.vf = versioned_files
2189
 
        # The keys desired
2190
 
        self.keys = list(keys)
2191
 
        # Keys known to be in fallback vfs objects
2192
 
        if nonlocal_keys is None:
2193
 
            self.nonlocal_keys = set()
2194
 
        else:
2195
 
            self.nonlocal_keys = frozenset(nonlocal_keys)
2196
 
        # Parents data for keys to be returned in get_record_stream
2197
 
        self.global_map = global_map
2198
 
        # The chunked lists for self.keys in text form
2199
 
        self._text_map = {}
2200
 
        # A cache of KnitContent objects used in extracting texts.
2201
 
        self._contents_map = {}
2202
 
        # All the knit records needed to assemble the requested keys as full
2203
 
        # texts.
2204
 
        self._record_map = None
2205
 
        if raw_record_map is None:
2206
 
            self._raw_record_map = self.vf._get_record_map_unparsed(keys,
2207
 
                allow_missing=True)
2208
 
        else:
2209
 
            self._raw_record_map = raw_record_map
2210
 
        # the factory for parsing records
2211
 
        self._factory = self.vf._factory
2212
 
 
2213
 
 
2214
 
class _NetworkContentMapGenerator(_ContentMapGenerator):
2215
 
    """Content map generator sourced from a network stream."""
2216
 
 
2217
 
    def __init__(self, bytes, line_end):
2218
 
        """Construct a _NetworkContentMapGenerator from a bytes block."""
2219
 
        self._bytes = bytes
2220
 
        self.global_map = {}
2221
 
        self._raw_record_map = {}
2222
 
        self._contents_map = {}
2223
 
        self._record_map = None
2224
 
        self.nonlocal_keys = []
2225
 
        # Get access to record parsing facilities
2226
 
        self.vf = KnitVersionedFiles(None, None)
2227
 
        start = line_end
2228
 
        # Annotated or not
2229
 
        line_end = bytes.find('\n', start)
2230
 
        line = bytes[start:line_end]
2231
 
        start = line_end + 1
2232
 
        if line == 'annotated':
2233
 
            self._factory = KnitAnnotateFactory()
2234
 
        else:
2235
 
            self._factory = KnitPlainFactory()
2236
 
        # list of keys to emit in get_record_stream
2237
 
        line_end = bytes.find('\n', start)
2238
 
        line = bytes[start:line_end]
2239
 
        start = line_end + 1
2240
 
        self.keys = [
2241
 
            tuple(segment.split('\x00')) for segment in line.split('\t')
2242
 
            if segment]
2243
 
        # now a loop until the end. XXX: It would be nice if this was just a
2244
 
        # bunch of the same records as get_record_stream(..., False) gives, but
2245
 
        # there is a decent sized gap stopping that at the moment.
2246
 
        end = len(bytes)
2247
 
        while start < end:
2248
 
            # 1 line with key
2249
 
            line_end = bytes.find('\n', start)
2250
 
            key = tuple(bytes[start:line_end].split('\x00'))
2251
 
            start = line_end + 1
2252
 
            # 1 line with parents (None: for None, '' for ())
2253
 
            line_end = bytes.find('\n', start)
2254
 
            line = bytes[start:line_end]
2255
 
            if line == 'None:':
2256
 
                parents = None
2257
 
            else:
2258
 
                parents = tuple(
2259
 
                    [tuple(segment.split('\x00')) for segment in line.split('\t')
2260
 
                     if segment])
2261
 
            self.global_map[key] = parents
2262
 
            start = line_end + 1
2263
 
            # one line with method
2264
 
            line_end = bytes.find('\n', start)
2265
 
            line = bytes[start:line_end]
2266
 
            method = line
2267
 
            start = line_end + 1
2268
 
            # one line with noeol
2269
 
            line_end = bytes.find('\n', start)
2270
 
            line = bytes[start:line_end]
2271
 
            noeol = line == "T"
2272
 
            start = line_end + 1
2273
 
            # one line with next ('' for None)
2274
 
            line_end = bytes.find('\n', start)
2275
 
            line = bytes[start:line_end]
2276
 
            if not line:
2277
 
                next = None
2278
 
            else:
2279
 
                next = tuple(bytes[start:line_end].split('\x00'))
2280
 
            start = line_end + 1
2281
 
            # one line with byte count of the record bytes
2282
 
            line_end = bytes.find('\n', start)
2283
 
            line = bytes[start:line_end]
2284
 
            count = int(line)
2285
 
            start = line_end + 1
2286
 
            # the record bytes
2287
 
            record_bytes = bytes[start:start+count]
2288
 
            start = start + count
2289
 
            # put it in the map
2290
 
            self._raw_record_map[key] = (record_bytes, (method, noeol), next)
2291
 
 
2292
 
    def get_record_stream(self):
2293
 
        """Get a record stream for for keys requested by the bytestream."""
2294
 
        first = True
2295
 
        for key in self.keys:
2296
 
            yield LazyKnitContentFactory(key, self.global_map[key], self, first)
2297
 
            first = False
2298
 
 
2299
 
    def _wire_bytes(self):
2300
 
        return self._bytes
2301
 
 
2302
 
 
2303
1769
class _KndxIndex(object):
2304
1770
    """Manages knit index files
2305
1771
 
2319
1785
 
2320
1786
    Duplicate entries may be written to the index for a single version id
2321
1787
    if this is done then the latter one completely replaces the former:
2322
 
    this allows updates to correct version and parent information.
 
1788
    this allows updates to correct version and parent information. 
2323
1789
    Note that the two entries may share the delta, and that successive
2324
1790
    annotations and references MUST point to the first entry.
2325
1791
 
2326
1792
    The index file on disc contains a header, followed by one line per knit
2327
1793
    record. The same revision can be present in an index file more than once.
2328
 
    The first occurrence gets assigned a sequence number starting from 0.
2329
 
 
 
1794
    The first occurrence gets assigned a sequence number starting from 0. 
 
1795
    
2330
1796
    The format of a single line is
2331
1797
    REVISION_ID FLAGS BYTE_OFFSET LENGTH( PARENT_ID|PARENT_SEQUENCE_ID)* :\n
2332
1798
    REVISION_ID is a utf8-encoded revision id
2333
 
    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 
2334
1800
        no-eol, line-delta, fulltext.
2335
1801
    BYTE_OFFSET is the ascii representation of the byte offset in the data file
2336
1802
        that the the compressed data starts at.
2340
1806
    PARENT_SEQUENCE_ID the ascii representation of the sequence number of a
2341
1807
        revision id already in the knit that is a parent of REVISION_ID.
2342
1808
    The ' :' marker is the end of record marker.
2343
 
 
 
1809
    
2344
1810
    partial writes:
2345
1811
    when a write is interrupted to the index file, it will result in a line
2346
1812
    that does not end in ' :'. If the ' :' is not present at the end of a line,
2371
1837
        self._reset_cache()
2372
1838
        self.has_graph = True
2373
1839
 
2374
 
    def add_records(self, records, random_id=False, missing_compression_parents=False):
 
1840
    def add_records(self, records, random_id=False):
2375
1841
        """Add multiple records to the index.
2376
 
 
 
1842
        
2377
1843
        :param records: a list of tuples:
2378
1844
                         (key, options, access_memo, parents).
2379
1845
        :param random_id: If True the ids being added were randomly generated
2380
1846
            and no check for existence will be performed.
2381
 
        :param missing_compression_parents: If True the records being added are
2382
 
            only compressed against texts already in the index (or inside
2383
 
            records). If False the records all refer to unavailable texts (or
2384
 
            texts inside records) as compression parents.
2385
1847
        """
2386
 
        if missing_compression_parents:
2387
 
            # It might be nice to get the edge of the records. But keys isn't
2388
 
            # _wrong_.
2389
 
            keys = sorted(record[0] for record in records)
2390
 
            raise errors.RevisionNotPresent(keys, self)
2391
1848
        paths = {}
2392
1849
        for record in records:
2393
1850
            key = record[0]
2410
1867
                    line = "\n%s %s %s %s %s :" % (
2411
1868
                        key[-1], ','.join(options), pos, size,
2412
1869
                        self._dictionary_compress(parents))
2413
 
                    if type(line) is not str:
 
1870
                    if type(line) != str:
2414
1871
                        raise AssertionError(
2415
1872
                            'data must be utf8 was %s' % type(line))
2416
1873
                    lines.append(line)
2424
1881
                self._kndx_cache[prefix] = (orig_cache, orig_history)
2425
1882
                raise
2426
1883
 
2427
 
    def scan_unvalidated_index(self, graph_index):
2428
 
        """See _KnitGraphIndex.scan_unvalidated_index."""
2429
 
        # Because kndx files do not support atomic insertion via separate index
2430
 
        # files, they do not support this method.
2431
 
        raise NotImplementedError(self.scan_unvalidated_index)
2432
 
 
2433
 
    def get_missing_compression_parents(self):
2434
 
        """See _KnitGraphIndex.get_missing_compression_parents."""
2435
 
        # Because kndx files do not support atomic insertion via separate index
2436
 
        # files, they do not support this method.
2437
 
        raise NotImplementedError(self.get_missing_compression_parents)
2438
 
 
2439
1884
    def _cache_key(self, key, options, pos, size, parent_keys):
2440
1885
        """Cache a version record in the history array and index cache.
2441
1886
 
2574
2019
 
2575
2020
    def get_position(self, key):
2576
2021
        """Return details needed to access the version.
2577
 
 
 
2022
        
2578
2023
        :return: a tuple (key, data position, size) to hand to the access
2579
2024
            logic to get the record.
2580
2025
        """
2584
2029
        return key, entry[2], entry[3]
2585
2030
 
2586
2031
    has_key = _mod_index._has_key_from_parent_map
2587
 
 
 
2032
    
2588
2033
    def _init_index(self, path, extra_lines=[]):
2589
2034
        """Initialize an index."""
2590
2035
        sio = StringIO()
2599
2044
 
2600
2045
    def keys(self):
2601
2046
        """Get all the keys in the collection.
2602
 
 
 
2047
        
2603
2048
        The keys are not ordered.
2604
2049
        """
2605
2050
        result = set()
2606
2051
        # Identify all key prefixes.
2607
2052
        # XXX: A bit hacky, needs polish.
2608
 
        if type(self._mapper) is ConstantMapper:
 
2053
        if type(self._mapper) == ConstantMapper:
2609
2054
            prefixes = [()]
2610
2055
        else:
2611
2056
            relpaths = set()
2618
2063
            for suffix in self._kndx_cache[prefix][1]:
2619
2064
                result.add(prefix + (suffix,))
2620
2065
        return result
2621
 
 
 
2066
    
2622
2067
    def _load_prefixes(self, prefixes):
2623
2068
        """Load the indices for prefixes."""
2624
2069
        self._check_read()
2643
2088
                    del self._history
2644
2089
                except NoSuchFile:
2645
2090
                    self._kndx_cache[prefix] = ({}, [])
2646
 
                    if type(self._mapper) is ConstantMapper:
 
2091
                    if type(self._mapper) == ConstantMapper:
2647
2092
                        # preserve behaviour for revisions.kndx etc.
2648
2093
                        self._init_index(path)
2649
2094
                    del self._cache
2662
2107
 
2663
2108
    def _dictionary_compress(self, keys):
2664
2109
        """Dictionary compress keys.
2665
 
 
 
2110
        
2666
2111
        :param keys: The keys to generate references to.
2667
2112
        :return: A string representation of keys. keys which are present are
2668
2113
            dictionary compressed, and others are emitted as fulltext with a
2716
2161
            return index_memo[0][:-1], index_memo[1]
2717
2162
        return keys.sort(key=get_sort_key)
2718
2163
 
2719
 
    _get_total_build_size = _get_total_build_size
2720
 
 
2721
2164
    def _split_key(self, key):
2722
2165
        """Split key into a prefix and suffix."""
2723
2166
        return key[:-1], key[-1]
2724
2167
 
2725
2168
 
2726
 
class _KeyRefs(object):
2727
 
 
2728
 
    def __init__(self):
2729
 
        # dict mapping 'key' to 'set of keys referring to that key'
2730
 
        self.refs = {}
2731
 
 
2732
 
    def add_references(self, key, refs):
2733
 
        # Record the new references
2734
 
        for referenced in refs:
2735
 
            try:
2736
 
                needed_by = self.refs[referenced]
2737
 
            except KeyError:
2738
 
                needed_by = self.refs[referenced] = set()
2739
 
            needed_by.add(key)
2740
 
        # Discard references satisfied by the new key
2741
 
        self.add_key(key)
2742
 
 
2743
 
    def get_unsatisfied_refs(self):
2744
 
        return self.refs.iterkeys()
2745
 
 
2746
 
    def add_key(self, key):
2747
 
        try:
2748
 
            del self.refs[key]
2749
 
        except KeyError:
2750
 
            # No keys depended on this key.  That's ok.
2751
 
            pass
2752
 
 
2753
 
    def add_keys(self, keys):
2754
 
        for key in keys:
2755
 
            self.add_key(key)
2756
 
 
2757
 
    def get_referrers(self):
2758
 
        result = set()
2759
 
        for referrers in self.refs.itervalues():
2760
 
            result.update(referrers)
2761
 
        return result
2762
 
 
2763
 
 
2764
2169
class _KnitGraphIndex(object):
2765
2170
    """A KnitVersionedFiles index layered on GraphIndex."""
2766
2171
 
2767
2172
    def __init__(self, graph_index, is_locked, deltas=False, parents=True,
2768
 
        add_callback=None, track_external_parent_refs=False):
 
2173
        add_callback=None):
2769
2174
        """Construct a KnitGraphIndex on a graph_index.
2770
2175
 
2771
2176
        :param graph_index: An implementation of bzrlib.index.GraphIndex.
2772
2177
        :param is_locked: A callback to check whether the object should answer
2773
2178
            queries.
2774
2179
        :param deltas: Allow delta-compressed records.
2775
 
        :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 
2776
2181
            parents.
2777
2182
        :param add_callback: If not None, allow additions to the index and call
2778
2183
            this callback with a list of added GraphIndex nodes:
2779
2184
            [(node, value, node_refs), ...]
2780
2185
        :param is_locked: A callback, returns True if the index is locked and
2781
2186
            thus usable.
2782
 
        :param track_external_parent_refs: If True, record all external parent
2783
 
            references parents from added records.  These can be retrieved
2784
 
            later by calling get_missing_parents().
2785
2187
        """
2786
2188
        self._add_callback = add_callback
2787
2189
        self._graph_index = graph_index
2794
2196
                "parent tracking.")
2795
2197
        self.has_graph = parents
2796
2198
        self._is_locked = is_locked
2797
 
        self._missing_compression_parents = set()
2798
 
        if track_external_parent_refs:
2799
 
            self._key_dependencies = _KeyRefs()
2800
 
        else:
2801
 
            self._key_dependencies = None
2802
2199
 
2803
2200
    def __repr__(self):
2804
2201
        return "%s(%r)" % (self.__class__.__name__, self._graph_index)
2805
2202
 
2806
 
    def add_records(self, records, random_id=False,
2807
 
        missing_compression_parents=False):
 
2203
    def add_records(self, records, random_id=False):
2808
2204
        """Add multiple records to the index.
2809
 
 
 
2205
        
2810
2206
        This function does not insert data into the Immutable GraphIndex
2811
2207
        backing the KnitGraphIndex, instead it prepares data for insertion by
2812
2208
        the caller and checks that it is safe to insert then calls
2816
2212
                         (key, options, access_memo, parents).
2817
2213
        :param random_id: If True the ids being added were randomly generated
2818
2214
            and no check for existence will be performed.
2819
 
        :param missing_compression_parents: If True the records being added are
2820
 
            only compressed against texts already in the index (or inside
2821
 
            records). If False the records all refer to unavailable texts (or
2822
 
            texts inside records) as compression parents.
2823
2215
        """
2824
2216
        if not self._add_callback:
2825
2217
            raise errors.ReadOnlyError(self)
2827
2219
        # anymore.
2828
2220
 
2829
2221
        keys = {}
2830
 
        compression_parents = set()
2831
 
        key_dependencies = self._key_dependencies
2832
2222
        for (key, options, access_memo, parents) in records:
2833
2223
            if self._parents:
2834
2224
                parents = tuple(parents)
2835
 
                if key_dependencies is not None:
2836
 
                    key_dependencies.add_references(key, parents)
2837
2225
            index, pos, size = access_memo
2838
2226
            if 'no-eol' in options:
2839
2227
                value = 'N'
2847
2235
                if self._deltas:
2848
2236
                    if 'line-delta' in options:
2849
2237
                        node_refs = (parents, (parents[0],))
2850
 
                        if missing_compression_parents:
2851
 
                            compression_parents.add(parents[0])
2852
2238
                    else:
2853
2239
                        node_refs = (parents, ())
2854
2240
                else:
2864
2250
            present_nodes = self._get_entries(keys)
2865
2251
            for (index, key, value, node_refs) in present_nodes:
2866
2252
                if (value[0] != keys[key][0][0] or
2867
 
                    node_refs[:1] != keys[key][1][:1]):
 
2253
                    node_refs != keys[key][1]):
2868
2254
                    raise KnitCorrupt(self, "inconsistent details in add_records"
2869
2255
                        ": %s %s" % ((value, node_refs), keys[key]))
2870
2256
                del keys[key]
2876
2262
            for key, (value, node_refs) in keys.iteritems():
2877
2263
                result.append((key, value))
2878
2264
        self._add_callback(result)
2879
 
        if missing_compression_parents:
2880
 
            # This may appear to be incorrect (it does not check for
2881
 
            # compression parents that are in the existing graph index),
2882
 
            # but such records won't have been buffered, so this is
2883
 
            # actually correct: every entry when
2884
 
            # missing_compression_parents==True either has a missing parent, or
2885
 
            # a parent that is one of the keys in records.
2886
 
            compression_parents.difference_update(keys)
2887
 
            self._missing_compression_parents.update(compression_parents)
2888
 
        # Adding records may have satisfied missing compression parents.
2889
 
        self._missing_compression_parents.difference_update(keys)
2890
 
 
2891
 
    def scan_unvalidated_index(self, graph_index):
2892
 
        """Inform this _KnitGraphIndex that there is an unvalidated index.
2893
 
 
2894
 
        This allows this _KnitGraphIndex to keep track of any missing
2895
 
        compression parents we may want to have filled in to make those
2896
 
        indices valid.
2897
 
 
2898
 
        :param graph_index: A GraphIndex
2899
 
        """
2900
 
        if self._deltas:
2901
 
            new_missing = graph_index.external_references(ref_list_num=1)
2902
 
            new_missing.difference_update(self.get_parent_map(new_missing))
2903
 
            self._missing_compression_parents.update(new_missing)
2904
 
        if self._key_dependencies is not None:
2905
 
            # Add parent refs from graph_index (and discard parent refs that
2906
 
            # the graph_index has).
2907
 
            for node in graph_index.iter_all_entries():
2908
 
                self._key_dependencies.add_references(node[1], node[3][0])
2909
 
 
2910
 
    def get_missing_compression_parents(self):
2911
 
        """Return the keys of missing compression parents.
2912
 
 
2913
 
        Missing compression parents occur when a record stream was missing
2914
 
        basis texts, or a index was scanned that had missing basis texts.
2915
 
        """
2916
 
        return frozenset(self._missing_compression_parents)
2917
 
 
2918
 
    def get_missing_parents(self):
2919
 
        """Return the keys of missing parents."""
2920
 
        # If updating this, you should also update
2921
 
        # groupcompress._GCGraphIndex.get_missing_parents
2922
 
        # We may have false positives, so filter those out.
2923
 
        self._key_dependencies.add_keys(
2924
 
            self.get_parent_map(self._key_dependencies.get_unsatisfied_refs()))
2925
 
        return frozenset(self._key_dependencies.get_unsatisfied_refs())
2926
 
 
 
2265
        
2927
2266
    def _check_read(self):
2928
2267
        """raise if reads are not permitted."""
2929
2268
        if not self._is_locked():
2989
2328
 
2990
2329
    def _get_entries(self, keys, check_present=False):
2991
2330
        """Get the entries for keys.
2992
 
 
 
2331
        
2993
2332
        :param keys: An iterable of index key tuples.
2994
2333
        """
2995
2334
        keys = set(keys)
3057
2396
 
3058
2397
    def get_position(self, key):
3059
2398
        """Return details needed to access the version.
3060
 
 
 
2399
        
3061
2400
        :return: a tuple (index, data position, size) to hand to the access
3062
2401
            logic to get the record.
3063
2402
        """
3068
2407
 
3069
2408
    def keys(self):
3070
2409
        """Get all the keys in the collection.
3071
 
 
 
2410
        
3072
2411
        The keys are not ordered.
3073
2412
        """
3074
2413
        self._check_read()
3075
2414
        return [node[1] for node in self._graph_index.iter_all_entries()]
3076
 
 
 
2415
    
3077
2416
    missing_keys = _mod_index._missing_keys_from_parent_map
3078
2417
 
3079
2418
    def _node_to_position(self, node):
3101
2440
            return positions[key][1]
3102
2441
        return keys.sort(key=get_index_memo)
3103
2442
 
3104
 
    _get_total_build_size = _get_total_build_size
3105
 
 
3106
2443
 
3107
2444
class _KnitKeyAccess(object):
3108
2445
    """Access to records in .knit files."""
3129
2466
            opaque index memo. For _KnitKeyAccess the memo is (key, pos,
3130
2467
            length), where the key is the record key.
3131
2468
        """
3132
 
        if type(raw_data) is not str:
 
2469
        if type(raw_data) != str:
3133
2470
            raise AssertionError(
3134
2471
                'data must be plain bytes was %s' % type(raw_data))
3135
2472
        result = []
3152
2489
            result.append((key, base, size))
3153
2490
        return result
3154
2491
 
3155
 
    def flush(self):
3156
 
        """Flush pending writes on this access object.
3157
 
        
3158
 
        For .knit files this is a no-op.
3159
 
        """
3160
 
        pass
3161
 
 
3162
2492
    def get_raw_records(self, memos_for_retrieval):
3163
2493
        """Get the raw bytes for a records.
3164
2494
 
3189
2519
class _DirectPackAccess(object):
3190
2520
    """Access to data in one or more packs with less translation."""
3191
2521
 
3192
 
    def __init__(self, index_to_packs, reload_func=None, flush_func=None):
 
2522
    def __init__(self, index_to_packs, reload_func=None):
3193
2523
        """Create a _DirectPackAccess object.
3194
2524
 
3195
2525
        :param index_to_packs: A dict mapping index objects to the transport
3202
2532
        self._write_index = None
3203
2533
        self._indices = index_to_packs
3204
2534
        self._reload_func = reload_func
3205
 
        self._flush_func = flush_func
3206
2535
 
3207
2536
    def add_raw_records(self, key_sizes, raw_data):
3208
2537
        """Add raw knit bytes to a storage area.
3218
2547
            length), where the index field is the write_index object supplied
3219
2548
            to the PackAccess object.
3220
2549
        """
3221
 
        if type(raw_data) is not str:
 
2550
        if type(raw_data) != str:
3222
2551
            raise AssertionError(
3223
2552
                'data must be plain bytes was %s' % type(raw_data))
3224
2553
        result = []
3230
2559
            result.append((self._write_index, p_offset, p_length))
3231
2560
        return result
3232
2561
 
3233
 
    def flush(self):
3234
 
        """Flush pending writes on this access object.
3235
 
 
3236
 
        This will flush any buffered writes to a NewPack.
3237
 
        """
3238
 
        if self._flush_func is not None:
3239
 
            self._flush_func()
3240
 
            
3241
2562
    def get_raw_records(self, memos_for_retrieval):
3242
2563
        """Get the raw bytes for a records.
3243
2564
 
3244
 
        :param memos_for_retrieval: An iterable containing the (index, pos,
 
2565
        :param memos_for_retrieval: An iterable containing the (index, pos, 
3245
2566
            length) memo for retrieving the bytes. The Pack access method
3246
2567
            looks up the pack to use for a given record in its index_to_pack
3247
2568
            map.
3337
2658
    recommended.
3338
2659
    """
3339
2660
    annotator = _KnitAnnotator(knit)
3340
 
    return iter(annotator.annotate_flat(revision_id))
3341
 
 
3342
 
 
3343
 
class _KnitAnnotator(annotate.Annotator):
 
2661
    return iter(annotator.annotate(revision_id))
 
2662
 
 
2663
 
 
2664
class _KnitAnnotator(object):
3344
2665
    """Build up the annotations for a text."""
3345
2666
 
3346
 
    def __init__(self, vf):
3347
 
        annotate.Annotator.__init__(self, vf)
3348
 
 
3349
 
        # TODO: handle Nodes which cannot be extracted
3350
 
        # self._ghosts = set()
3351
 
 
3352
 
        # Map from (key, parent_key) => matching_blocks, should be 'use once'
3353
 
        self._matching_blocks = {}
3354
 
 
3355
 
        # KnitContent objects
3356
 
        self._content_objects = {}
3357
 
        # The number of children that depend on this fulltext content object
3358
 
        self._num_compression_children = {}
3359
 
        # Delta records that need their compression parent before they can be
3360
 
        # expanded
3361
 
        self._pending_deltas = {}
3362
 
        # Fulltext records that are waiting for their parents fulltexts before
3363
 
        # they can be yielded for annotation
3364
 
        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 = {}
3365
2690
 
3366
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
3367
2758
 
3368
2759
    def _get_build_graph(self, key):
3369
2760
        """Get the graphs for building texts and annotations.
3374
2765
        fulltext.)
3375
2766
 
3376
2767
        :return: A list of (key, index_memo) records, suitable for
3377
 
            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/
3378
2769
            the pack file.
3379
2770
        """
 
2771
        if key in self._annotated_lines:
 
2772
            # Nothing to do
 
2773
            return []
3380
2774
        pending = set([key])
3381
2775
        records = []
3382
 
        ann_keys = set()
3383
 
        self._num_needed_children[key] = 1
 
2776
        generation = 0
 
2777
        kept_generation = 0
3384
2778
        while pending:
3385
2779
            # get all pending nodes
 
2780
            generation += 1
3386
2781
            this_iteration = pending
3387
 
            build_details = self._vf._index.get_build_details(this_iteration)
 
2782
            build_details = self._knit._index.get_build_details(this_iteration)
3388
2783
            self._all_build_details.update(build_details)
3389
 
            # new_nodes = self._vf._index._get_entries(this_iteration)
 
2784
            # new_nodes = self._knit._index._get_entries(this_iteration)
3390
2785
            pending = set()
3391
2786
            for key, details in build_details.iteritems():
3392
 
                (index_memo, compression_parent, parent_keys,
 
2787
                (index_memo, compression_parent, parents,
3393
2788
                 record_details) = details
3394
 
                self._parent_map[key] = parent_keys
3395
 
                self._heads_provider = None
 
2789
                self._revision_id_graph[key] = parents
3396
2790
                records.append((key, index_memo))
3397
2791
                # Do we actually need to check _annotated_lines?
3398
 
                pending.update([p for p in parent_keys
3399
 
                                   if p not in self._all_build_details])
3400
 
                if parent_keys:
3401
 
                    for parent_key in parent_keys:
3402
 
                        if parent_key in self._num_needed_children:
3403
 
                            self._num_needed_children[parent_key] += 1
3404
 
                        else:
3405
 
                            self._num_needed_children[parent_key] = 1
 
2792
                pending.update(p for p in parents
 
2793
                                 if p not in self._all_build_details)
3406
2794
                if compression_parent:
3407
 
                    if compression_parent in self._num_compression_children:
3408
 
                        self._num_compression_children[compression_parent] += 1
3409
 
                    else:
3410
 
                        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)
3411
2806
 
3412
2807
            missing_versions = this_iteration.difference(build_details.keys())
3413
 
            if missing_versions:
3414
 
                for key in missing_versions:
3415
 
                    if key in self._parent_map and key in self._text_cache:
3416
 
                        # We already have this text ready, we just need to
3417
 
                        # yield it later so we get it annotated
3418
 
                        ann_keys.add(key)
3419
 
                        parent_keys = self._parent_map[key]
3420
 
                        for parent_key in parent_keys:
3421
 
                            if parent_key in self._num_needed_children:
3422
 
                                self._num_needed_children[parent_key] += 1
3423
 
                            else:
3424
 
                                self._num_needed_children[parent_key] = 1
3425
 
                        pending.update([p for p in parent_keys
3426
 
                                           if p not in self._all_build_details])
3427
 
                    else:
3428
 
                        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]
3429
2825
        # Generally we will want to read the records in reverse order, because
3430
2826
        # we find the parent nodes after the children
3431
2827
        records.reverse()
3432
 
        return records, ann_keys
3433
 
 
3434
 
    def _get_needed_texts(self, key, pb=None):
3435
 
        # if True or len(self._vf._fallback_vfs) > 0:
3436
 
        if len(self._vf._fallback_vfs) > 0:
3437
 
            # If we have fallbacks, go to the generic path
3438
 
            for v in annotate.Annotator._get_needed_texts(self, key, pb=pb):
3439
 
                yield v
3440
 
            return
3441
 
        while True:
3442
 
            try:
3443
 
                records, ann_keys = self._get_build_graph(key)
3444
 
                for idx, (sub_key, text, num_lines) in enumerate(
3445
 
                                                self._extract_texts(records)):
3446
 
                    if pb is not None:
3447
 
                        pb.update('annotating', idx, len(records))
3448
 
                    yield sub_key, text, num_lines
3449
 
                for sub_key in ann_keys:
3450
 
                    text = self._text_cache[sub_key]
3451
 
                    num_lines = len(text) # bad assumption
3452
 
                    yield sub_key, text, num_lines
3453
 
                return
3454
 
            except errors.RetryWithNewPacks, e:
3455
 
                self._vf._access.reload_or_raise(e)
3456
 
                # The cached build_details are no longer valid
3457
 
                self._all_build_details.clear()
3458
 
 
3459
 
    def _cache_delta_blocks(self, key, compression_parent, delta, lines):
3460
 
        parent_lines = self._text_cache[compression_parent]
3461
 
        blocks = list(KnitContent.get_line_delta_blocks(delta, parent_lines, lines))
3462
 
        self._matching_blocks[(key, compression_parent)] = blocks
3463
 
 
3464
 
    def _expand_record(self, key, parent_keys, compression_parent, record,
3465
 
                       record_details):
3466
 
        delta = None
3467
 
        if compression_parent:
3468
 
            if compression_parent not in self._content_objects:
3469
 
                # Waiting for the parent
3470
 
                self._pending_deltas.setdefault(compression_parent, []).append(
3471
 
                    (key, parent_keys, record, record_details))
3472
 
                return None
3473
 
            # We have the basis parent, so expand the delta
3474
 
            num = self._num_compression_children[compression_parent]
3475
 
            num -= 1
3476
 
            if num == 0:
3477
 
                base_content = self._content_objects.pop(compression_parent)
3478
 
                self._num_compression_children.pop(compression_parent)
3479
 
            else:
3480
 
                self._num_compression_children[compression_parent] = num
3481
 
                base_content = self._content_objects[compression_parent]
3482
 
            # It is tempting to want to copy_base_content=False for the last
3483
 
            # child object. However, whenever noeol=False,
3484
 
            # self._text_cache[parent_key] is content._lines. So mutating it
3485
 
            # gives very bad results.
3486
 
            # The alternative is to copy the lines into text cache, but then we
3487
 
            # are copying anyway, so just do it here.
3488
 
            content, delta = self._vf._factory.parse_record(
3489
 
                key, record, record_details, base_content,
3490
 
                copy_base_content=True)
3491
 
        else:
3492
 
            # Fulltext record
3493
 
            content, _ = self._vf._factory.parse_record(
3494
 
                key, record, record_details, None)
3495
 
        if self._num_compression_children.get(key, 0) > 0:
3496
 
            self._content_objects[key] = content
3497
 
        lines = content.text()
3498
 
        self._text_cache[key] = lines
3499
 
        if delta is not None:
3500
 
            self._cache_delta_blocks(key, compression_parent, delta, lines)
3501
 
        return lines
3502
 
 
3503
 
    def _get_parent_annotations_and_matches(self, key, text, parent_key):
3504
 
        """Get the list of annotations for the parent, and the matching lines.
3505
 
 
3506
 
        :param text: The opaque value given by _get_needed_texts
3507
 
        :param parent_key: The key for the parent text
3508
 
        :return: (parent_annotations, matching_blocks)
3509
 
            parent_annotations is a list as long as the number of lines in
3510
 
                parent
3511
 
            matching_blocks is a list of (parent_idx, text_idx, len) tuples
3512
 
                indicating which lines match between the two texts
3513
 
        """
3514
 
        block_key = (key, parent_key)
3515
 
        if block_key in self._matching_blocks:
3516
 
            blocks = self._matching_blocks.pop(block_key)
3517
 
            parent_annotations = self._annotations_cache[parent_key]
3518
 
            return parent_annotations, blocks
3519
 
        return annotate.Annotator._get_parent_annotations_and_matches(self,
3520
 
            key, text, parent_key)
3521
 
 
3522
 
    def _process_pending(self, key):
3523
 
        """The content for 'key' was just processed.
3524
 
 
3525
 
        Determine if there is any more pending work to be processed.
3526
 
        """
3527
 
        to_return = []
3528
 
        if key in self._pending_deltas:
3529
 
            compression_parent = key
3530
 
            children = self._pending_deltas.pop(key)
3531
 
            for child_key, parent_keys, record, record_details in children:
3532
 
                lines = self._expand_record(child_key, parent_keys,
3533
 
                                            compression_parent,
3534
 
                                            record, record_details)
3535
 
                if self._check_ready_for_annotations(child_key, parent_keys):
3536
 
                    to_return.append(child_key)
3537
 
        # Also check any children that are waiting for this parent to be
3538
 
        # annotation ready
3539
 
        if key in self._pending_annotation:
3540
 
            children = self._pending_annotation.pop(key)
3541
 
            to_return.extend([c for c, p_keys in children
3542
 
                              if self._check_ready_for_annotations(c, p_keys)])
3543
 
        return to_return
3544
 
 
3545
 
    def _check_ready_for_annotations(self, key, parent_keys):
3546
 
        """return true if this text is ready to be yielded.
3547
 
 
3548
 
        Otherwise, this will return False, and queue the text into
3549
 
        self._pending_annotation
3550
 
        """
3551
 
        for parent_key in parent_keys:
3552
 
            if parent_key not in self._annotations_cache:
3553
 
                # still waiting on at least one parent text, so queue it up
3554
 
                # Note that if there are multiple parents, we need to wait
3555
 
                # for all of them.
3556
 
                self._pending_annotation.setdefault(parent_key,
3557
 
                    []).append((key, parent_keys))
3558
 
                return False
3559
 
        return True
3560
 
 
3561
 
    def _extract_texts(self, records):
3562
 
        """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."""
3563
2832
        # We iterate in the order read, rather than a strict order requested
3564
2833
        # However, process what we can, and put off to the side things that
3565
2834
        # still need parents, cleaning them up when those parents are
3566
2835
        # processed.
3567
 
        # Basic data flow:
3568
 
        #   1) As 'records' are read, see if we can expand these records into
3569
 
        #      Content objects (and thus lines)
3570
 
        #   2) If a given line-delta is waiting on its compression parent, it
3571
 
        #      gets queued up into self._pending_deltas, otherwise we expand
3572
 
        #      it, and put it into self._text_cache and self._content_objects
3573
 
        #   3) If we expanded the text, we will then check to see if all
3574
 
        #      parents have also been processed. If so, this text gets yielded,
3575
 
        #      else this record gets set aside into pending_annotation
3576
 
        #   4) Further, if we expanded the text in (2), we will then check to
3577
 
        #      see if there are any children in self._pending_deltas waiting to
3578
 
        #      also be processed. If so, we go back to (2) for those
3579
 
        #   5) Further again, if we yielded the text, we can then check if that
3580
 
        #      'unlocks' any of the texts in pending_annotations, which should
3581
 
        #      then get yielded as well
3582
 
        # Note that both steps 4 and 5 are 'recursive' in that unlocking one
3583
 
        # compression child could unlock yet another, and yielding a fulltext
3584
 
        # will also 'unlock' the children that are waiting on that annotation.
3585
 
        # (Though also, unlocking 1 parent's fulltext, does not unlock a child
3586
 
        # if other parents are also waiting.)
3587
 
        # We want to yield content before expanding child content objects, so
3588
 
        # that we know when we can re-use the content lines, and the annotation
3589
 
        # code can know when it can stop caching fulltexts, as well.
3590
 
 
3591
 
        # Children that are missing their compression parent
3592
 
        pending_deltas = {}
3593
 
        for (key, record, digest) in self._vf._read_records_iter(records):
3594
 
            # ghosts?
3595
 
            details = self._all_build_details[key]
3596
 
            (_, compression_parent, parent_keys, record_details) = details
3597
 
            lines = self._expand_record(key, parent_keys, compression_parent,
3598
 
                                        record, record_details)
3599
 
            if lines is None:
3600
 
                # 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:
3601
2839
                continue
3602
 
            # At this point, we may be able to yield this content, if all
3603
 
            # parents are also finished
3604
 
            yield_this_text = self._check_ready_for_annotations(key,
3605
 
                                                                parent_keys)
3606
 
            if yield_this_text:
3607
 
                # All parents present
3608
 
                yield key, lines, len(lines)
3609
 
            to_process = self._process_pending(key)
3610
 
            while to_process:
3611
 
                this_process = to_process
3612
 
                to_process = []
3613
 
                for key in this_process:
3614
 
                    lines = self._text_cache[key]
3615
 
                    yield key, lines, len(lines)
3616
 
                    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
 
3617
2975
 
3618
2976
try:
3619
2977
    from bzrlib._knit_load_data_c import _load_data_c as _load_data