~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/knit.py

  • Committer: Martin von Gagern
  • Date: 2008-06-26 17:18:55 UTC
  • mto: (3517.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 3518.
  • Revision ID: martin.vgagern@gmx.net-20080626171855-qqok6tbgkouo409t
Hand-selected minimalistic set of changes from my setlocale branch.
This introduces a call to setlocale without changing the behaviour of bzr.
Day of the week formatting is handled in Python to avoid locale dependency.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""Knit versionedfile implementation.
18
18
 
20
20
updates.
21
21
 
22
22
Knit file layout:
23
 
lifeless: the data file is made up of "delta records".  each delta record has a delta header
24
 
that contains; (1) a version id, (2) the size of the delta (in lines), and (3)  the digest of
25
 
the -expanded data- (ie, the delta applied to the parent).  the delta also ends with a
 
23
lifeless: the data file is made up of "delta records".  each delta record has a delta header 
 
24
that contains; (1) a version id, (2) the size of the delta (in lines), and (3)  the digest of 
 
25
the -expanded data- (ie, the delta applied to the parent).  the delta also ends with a 
26
26
end-marker; simply "end VERSION"
27
27
 
28
28
delta can be line or full contents.a
35
35
130,130,2
36
36
8         if elt.get('executable') == 'yes':
37
37
8             ie.executable = True
38
 
end robertc@robertcollins.net-20051003014215-ee2990904cc4c7ad
 
38
end robertc@robertcollins.net-20051003014215-ee2990904cc4c7ad 
39
39
 
40
40
 
41
41
whats in an index:
51
51
 
52
52
"""
53
53
 
 
54
# TODOS:
 
55
# 10:16 < lifeless> make partial index writes safe
 
56
# 10:16 < lifeless> implement 'knit.check()' like weave.check()
 
57
# 10:17 < lifeless> record known ghosts so we can detect when they are filled in rather than the current 'reweave 
 
58
#                    always' approach.
 
59
# move sha1 out of the content so that join is faster at verifying parents
 
60
# record content length ?
 
61
                  
54
62
 
55
63
from cStringIO import StringIO
56
 
from itertools import izip
 
64
from itertools import izip, chain
57
65
import operator
58
66
import os
 
67
import urllib
59
68
import sys
 
69
import warnings
 
70
from zlib import Z_DEFAULT_COMPRESSION
60
71
 
 
72
import bzrlib
61
73
from bzrlib.lazy_import import lazy_import
62
74
lazy_import(globals(), """
63
75
from bzrlib import (
64
76
    annotate,
65
 
    debug,
66
 
    diff,
67
77
    graph as _mod_graph,
68
78
    index as _mod_index,
69
79
    lru_cache,
70
80
    pack,
71
 
    progress,
72
 
    static_tuple,
73
81
    trace,
74
 
    tsort,
75
 
    tuned_gzip,
76
 
    ui,
77
82
    )
78
83
""")
79
84
from bzrlib import (
 
85
    cache_utf8,
 
86
    debug,
 
87
    diff,
80
88
    errors,
81
89
    osutils,
82
90
    patiencediff,
 
91
    progress,
 
92
    merge,
 
93
    ui,
83
94
    )
84
95
from bzrlib.errors import (
85
96
    FileExists,
90
101
    KnitHeaderError,
91
102
    RevisionNotPresent,
92
103
    RevisionAlreadyPresent,
93
 
    SHA1KnitCorrupt,
94
104
    )
 
105
from bzrlib.graph import Graph
95
106
from bzrlib.osutils import (
96
107
    contains_whitespace,
97
108
    contains_linebreaks,
99
110
    sha_strings,
100
111
    split_lines,
101
112
    )
 
113
from bzrlib.tsort import topo_sort
 
114
from bzrlib.tuned_gzip import GzipFile, bytes_to_gzip
 
115
import bzrlib.ui
102
116
from bzrlib.versionedfile import (
103
117
    AbsentContentFactory,
104
118
    adapter_registry,
105
119
    ConstantMapper,
106
120
    ContentFactory,
107
 
    ChunkedContentFactory,
108
 
    sort_groupcompress,
 
121
    FulltextContentFactory,
109
122
    VersionedFile,
110
123
    VersionedFiles,
111
124
    )
 
125
import bzrlib.weave
112
126
 
113
127
 
114
128
# TODO: Split out code specific to this format into an associated object.
126
140
 
127
141
DATA_SUFFIX = '.knit'
128
142
INDEX_SUFFIX = '.kndx'
129
 
_STREAM_MIN_BUFFER_SIZE = 5*1024*1024
130
143
 
131
144
 
132
145
class KnitAdapter(object):
134
147
 
135
148
    def __init__(self, basis_vf):
136
149
        """Create an adapter which accesses full texts from basis_vf.
137
 
 
 
150
        
138
151
        :param basis_vf: A versioned file to access basis texts of deltas from.
139
152
            May be None for adapters that do not need to access basis texts.
140
153
        """
147
160
class FTAnnotatedToUnannotated(KnitAdapter):
148
161
    """An adapter from FT annotated knits to unannotated ones."""
149
162
 
150
 
    def get_bytes(self, factory):
151
 
        annotated_compressed_bytes = factory._raw_record
 
163
    def get_bytes(self, factory, annotated_compressed_bytes):
152
164
        rec, contents = \
153
165
            self._data._parse_record_unchecked(annotated_compressed_bytes)
154
166
        content = self._annotate_factory.parse_fulltext(contents, rec[1])
159
171
class DeltaAnnotatedToUnannotated(KnitAdapter):
160
172
    """An adapter for deltas from annotated to unannotated."""
161
173
 
162
 
    def get_bytes(self, factory):
163
 
        annotated_compressed_bytes = factory._raw_record
 
174
    def get_bytes(self, factory, annotated_compressed_bytes):
164
175
        rec, contents = \
165
176
            self._data._parse_record_unchecked(annotated_compressed_bytes)
166
177
        delta = self._annotate_factory.parse_line_delta(contents, rec[1],
173
184
class FTAnnotatedToFullText(KnitAdapter):
174
185
    """An adapter from FT annotated knits to unannotated ones."""
175
186
 
176
 
    def get_bytes(self, factory):
177
 
        annotated_compressed_bytes = factory._raw_record
 
187
    def get_bytes(self, factory, annotated_compressed_bytes):
178
188
        rec, contents = \
179
189
            self._data._parse_record_unchecked(annotated_compressed_bytes)
180
190
        content, delta = self._annotate_factory.parse_record(factory.key[-1],
185
195
class DeltaAnnotatedToFullText(KnitAdapter):
186
196
    """An adapter for deltas from annotated to unannotated."""
187
197
 
188
 
    def get_bytes(self, factory):
189
 
        annotated_compressed_bytes = factory._raw_record
 
198
    def get_bytes(self, factory, annotated_compressed_bytes):
190
199
        rec, contents = \
191
200
            self._data._parse_record_unchecked(annotated_compressed_bytes)
192
201
        delta = self._annotate_factory.parse_line_delta(contents, rec[1],
196
205
            [compression_parent], 'unordered', True).next()
197
206
        if basis_entry.storage_kind == 'absent':
198
207
            raise errors.RevisionNotPresent(compression_parent, self._basis_vf)
199
 
        basis_chunks = basis_entry.get_bytes_as('chunked')
200
 
        basis_lines = osutils.chunks_to_lines(basis_chunks)
 
208
        basis_lines = split_lines(basis_entry.get_bytes_as('fulltext'))
201
209
        # Manually apply the delta because we have one annotated content and
202
210
        # one plain.
203
211
        basis_content = PlainKnitContent(basis_lines, compression_parent)
209
217
class FTPlainToFullText(KnitAdapter):
210
218
    """An adapter from FT plain knits to unannotated ones."""
211
219
 
212
 
    def get_bytes(self, factory):
213
 
        compressed_bytes = factory._raw_record
 
220
    def get_bytes(self, factory, compressed_bytes):
214
221
        rec, contents = \
215
222
            self._data._parse_record_unchecked(compressed_bytes)
216
223
        content, delta = self._plain_factory.parse_record(factory.key[-1],
221
228
class DeltaPlainToFullText(KnitAdapter):
222
229
    """An adapter for deltas from annotated to unannotated."""
223
230
 
224
 
    def get_bytes(self, factory):
225
 
        compressed_bytes = factory._raw_record
 
231
    def get_bytes(self, factory, compressed_bytes):
226
232
        rec, contents = \
227
233
            self._data._parse_record_unchecked(compressed_bytes)
228
234
        delta = self._plain_factory.parse_line_delta(contents, rec[1])
232
238
            [compression_parent], 'unordered', True).next()
233
239
        if basis_entry.storage_kind == 'absent':
234
240
            raise errors.RevisionNotPresent(compression_parent, self._basis_vf)
235
 
        basis_chunks = basis_entry.get_bytes_as('chunked')
236
 
        basis_lines = osutils.chunks_to_lines(basis_chunks)
 
241
        basis_lines = split_lines(basis_entry.get_bytes_as('fulltext'))
237
242
        basis_content = PlainKnitContent(basis_lines, compression_parent)
238
243
        # Manually apply the delta because we have one annotated content and
239
244
        # one plain.
244
249
 
245
250
class KnitContentFactory(ContentFactory):
246
251
    """Content factory for streaming from knits.
247
 
 
 
252
    
248
253
    :seealso ContentFactory:
249
254
    """
250
255
 
251
256
    def __init__(self, key, parents, build_details, sha1, raw_record,
252
 
        annotated, knit=None, network_bytes=None):
 
257
        annotated, knit=None):
253
258
        """Create a KnitContentFactory for key.
254
 
 
 
259
        
255
260
        :param key: The key.
256
261
        :param parents: The parents.
257
262
        :param build_details: The build details as returned from
259
264
        :param sha1: The sha1 expected from the full text of this object.
260
265
        :param raw_record: The bytes of the knit data from disk.
261
266
        :param annotated: True if the raw data is annotated.
262
 
        :param network_bytes: None to calculate the network bytes on demand,
263
 
            not-none if they are already known.
264
267
        """
265
268
        ContentFactory.__init__(self)
266
269
        self.sha1 = sha1
276
279
            annotated_kind = ''
277
280
        self.storage_kind = 'knit-%s%s-gz' % (annotated_kind, kind)
278
281
        self._raw_record = raw_record
279
 
        self._network_bytes = network_bytes
280
282
        self._build_details = build_details
281
283
        self._knit = knit
282
284
 
283
 
    def _create_network_bytes(self):
284
 
        """Create a fully serialised network version for transmission."""
285
 
        # storage_kind, key, parents, Noeol, raw_record
286
 
        key_bytes = '\x00'.join(self.key)
287
 
        if self.parents is None:
288
 
            parent_bytes = 'None:'
289
 
        else:
290
 
            parent_bytes = '\t'.join('\x00'.join(key) for key in self.parents)
291
 
        if self._build_details[1]:
292
 
            noeol = 'N'
293
 
        else:
294
 
            noeol = ' '
295
 
        network_bytes = "%s\n%s\n%s\n%s%s" % (self.storage_kind, key_bytes,
296
 
            parent_bytes, noeol, self._raw_record)
297
 
        self._network_bytes = network_bytes
298
 
 
299
 
    def get_bytes_as(self, storage_kind):
300
 
        if storage_kind == self.storage_kind:
301
 
            if self._network_bytes is None:
302
 
                self._create_network_bytes()
303
 
            return self._network_bytes
304
 
        if ('-ft-' in self.storage_kind and
305
 
            storage_kind in ('chunked', 'fulltext')):
306
 
            adapter_key = (self.storage_kind, 'fulltext')
307
 
            adapter_factory = adapter_registry.get(adapter_key)
308
 
            adapter = adapter_factory(None)
309
 
            bytes = adapter.get_bytes(self)
310
 
            if storage_kind == 'chunked':
311
 
                return [bytes]
312
 
            else:
313
 
                return bytes
314
 
        if self._knit is not None:
315
 
            # Not redundant with direct conversion above - that only handles
316
 
            # fulltext cases.
317
 
            if storage_kind == 'chunked':
318
 
                return self._knit.get_lines(self.key[0])
319
 
            elif storage_kind == 'fulltext':
320
 
                return self._knit.get_text(self.key[0])
321
 
        raise errors.UnavailableRepresentation(self.key, storage_kind,
322
 
            self.storage_kind)
323
 
 
324
 
 
325
 
class LazyKnitContentFactory(ContentFactory):
326
 
    """A ContentFactory which can either generate full text or a wire form.
327
 
 
328
 
    :seealso ContentFactory:
329
 
    """
330
 
 
331
 
    def __init__(self, key, parents, generator, first):
332
 
        """Create a LazyKnitContentFactory.
333
 
 
334
 
        :param key: The key of the record.
335
 
        :param parents: The parents of the record.
336
 
        :param generator: A _ContentMapGenerator containing the record for this
337
 
            key.
338
 
        :param first: Is this the first content object returned from generator?
339
 
            if it is, its storage kind is knit-delta-closure, otherwise it is
340
 
            knit-delta-closure-ref
341
 
        """
342
 
        self.key = key
343
 
        self.parents = parents
344
 
        self.sha1 = None
345
 
        self._generator = generator
346
 
        self.storage_kind = "knit-delta-closure"
347
 
        if not first:
348
 
            self.storage_kind = self.storage_kind + "-ref"
349
 
        self._first = first
350
 
 
351
 
    def get_bytes_as(self, storage_kind):
352
 
        if storage_kind == self.storage_kind:
353
 
            if self._first:
354
 
                return self._generator._wire_bytes()
355
 
            else:
356
 
                # all the keys etc are contained in the bytes returned in the
357
 
                # first record.
358
 
                return ''
359
 
        if storage_kind in ('chunked', 'fulltext'):
360
 
            chunks = self._generator._get_one_work(self.key).text()
361
 
            if storage_kind == 'chunked':
362
 
                return chunks
363
 
            else:
364
 
                return ''.join(chunks)
365
 
        raise errors.UnavailableRepresentation(self.key, storage_kind,
366
 
            self.storage_kind)
367
 
 
368
 
 
369
 
def knit_delta_closure_to_records(storage_kind, bytes, line_end):
370
 
    """Convert a network record to a iterator over stream records.
371
 
 
372
 
    :param storage_kind: The storage kind of the record.
373
 
        Must be 'knit-delta-closure'.
374
 
    :param bytes: The bytes of the record on the network.
375
 
    """
376
 
    generator = _NetworkContentMapGenerator(bytes, line_end)
377
 
    return generator.get_record_stream()
378
 
 
379
 
 
380
 
def knit_network_to_record(storage_kind, bytes, line_end):
381
 
    """Convert a network record to a record object.
382
 
 
383
 
    :param storage_kind: The storage kind of the record.
384
 
    :param bytes: The bytes of the record on the network.
385
 
    """
386
 
    start = line_end
387
 
    line_end = bytes.find('\n', start)
388
 
    key = tuple(bytes[start:line_end].split('\x00'))
389
 
    start = line_end + 1
390
 
    line_end = bytes.find('\n', start)
391
 
    parent_line = bytes[start:line_end]
392
 
    if parent_line == 'None:':
393
 
        parents = None
394
 
    else:
395
 
        parents = tuple(
396
 
            [tuple(segment.split('\x00')) for segment in parent_line.split('\t')
397
 
             if segment])
398
 
    start = line_end + 1
399
 
    noeol = bytes[start] == 'N'
400
 
    if 'ft' in storage_kind:
401
 
        method = 'fulltext'
402
 
    else:
403
 
        method = 'line-delta'
404
 
    build_details = (method, noeol)
405
 
    start = start + 1
406
 
    raw_record = bytes[start:]
407
 
    annotated = 'annotated' in storage_kind
408
 
    return [KnitContentFactory(key, parents, build_details, None, raw_record,
409
 
        annotated, network_bytes=bytes)]
 
285
    def get_bytes_as(self, storage_kind):
 
286
        if storage_kind == self.storage_kind:
 
287
            return self._raw_record
 
288
        if storage_kind == 'fulltext' and self._knit is not None:
 
289
            return self._knit.get_text(self.key[0])
 
290
        else:
 
291
            raise errors.UnavailableRepresentation(self.key, storage_kind,
 
292
                self.storage_kind)
410
293
 
411
294
 
412
295
class KnitContent(object):
413
296
    """Content of a knit version to which deltas can be applied.
414
 
 
 
297
    
415
298
    This is always stored in memory as a list of lines with \n at the end,
416
 
    plus a flag saying if the final ending is really there or not, because that
 
299
    plus a flag saying if the final ending is really there or not, because that 
417
300
    corresponds to the on-disk knit representation.
418
301
    """
419
302
 
508
391
 
509
392
class PlainKnitContent(KnitContent):
510
393
    """Unannotated content.
511
 
 
 
394
    
512
395
    When annotate[_iter] is called on this content, the same version is reported
513
396
    for all lines. Generally, annotate[_iter] is not useful on PlainKnitContent
514
397
    objects.
666
549
 
667
550
        see parse_fulltext which this inverts.
668
551
        """
 
552
        # TODO: jam 20070209 We only do the caching thing to make sure that
 
553
        #       the origin is a valid utf-8 line, eventually we could remove it
669
554
        return ['%s %s' % (o, t) for o, t in content._lines]
670
555
 
671
556
    def lower_line_delta(self, delta):
686
571
        content = knit._get_content(key)
687
572
        # adjust for the fact that serialised annotations are only key suffixes
688
573
        # for this factory.
689
 
        if type(key) is tuple:
 
574
        if type(key) == tuple:
690
575
            prefix = key[:-1]
691
576
            origins = content.annotate()
692
577
            result = []
758
643
 
759
644
    def annotate(self, knit, key):
760
645
        annotator = _KnitAnnotator(knit)
761
 
        return annotator.annotate_flat(key)
 
646
        return annotator.annotate(key)
762
647
 
763
648
 
764
649
 
767
652
 
768
653
    This is only functional enough to run interface tests, it doesn't try to
769
654
    provide a full pack environment.
770
 
 
 
655
    
771
656
    :param annotated: knit annotations are wanted.
772
657
    :param mapper: The mapper from keys to paths.
773
658
    """
783
668
 
784
669
    This is only functional enough to run interface tests, it doesn't try to
785
670
    provide a full pack environment.
786
 
 
 
671
    
787
672
    :param graph: Store a graph.
788
673
    :param delta: Delta compress contents.
789
674
    :param keylength: How long should keys be.
820
705
    versioned_files.writer.end()
821
706
 
822
707
 
823
 
def _get_total_build_size(self, keys, positions):
824
 
    """Determine the total bytes to build these keys.
825
 
 
826
 
    (helper function because _KnitGraphIndex and _KndxIndex work the same, but
827
 
    don't inherit from a common base.)
828
 
 
829
 
    :param keys: Keys that we want to build
830
 
    :param positions: dict of {key, (info, index_memo, comp_parent)} (such
831
 
        as returned by _get_components_positions)
832
 
    :return: Number of bytes to build those keys
833
 
    """
834
 
    all_build_index_memos = {}
835
 
    build_keys = keys
836
 
    while build_keys:
837
 
        next_keys = set()
838
 
        for key in build_keys:
839
 
            # This is mostly for the 'stacked' case
840
 
            # Where we will be getting the data from a fallback
841
 
            if key not in positions:
842
 
                continue
843
 
            _, index_memo, compression_parent = positions[key]
844
 
            all_build_index_memos[key] = index_memo
845
 
            if compression_parent not in all_build_index_memos:
846
 
                next_keys.add(compression_parent)
847
 
        build_keys = next_keys
848
 
    return sum([index_memo[2] for index_memo
849
 
                in all_build_index_memos.itervalues()])
850
 
 
851
 
 
852
708
class KnitVersionedFiles(VersionedFiles):
853
709
    """Storage for many versioned files using knit compression.
854
710
 
855
711
    Backend storage is managed by indices and data objects.
856
 
 
857
 
    :ivar _index: A _KnitGraphIndex or similar that can describe the
858
 
        parents, graph, compression and data location of entries in this
859
 
        KnitVersionedFiles.  Note that this is only the index for
860
 
        *this* vfs; if there are fallbacks they must be queried separately.
861
712
    """
862
713
 
863
714
    def __init__(self, index, data_access, max_delta_chain=200,
864
 
                 annotated=False, reload_func=None):
 
715
        annotated=False):
865
716
        """Create a KnitVersionedFiles with index and data_access.
866
717
 
867
718
        :param index: The index for the knit data.
871
722
            insertion. Set to 0 to prohibit the use of deltas.
872
723
        :param annotated: Set to True to cause annotations to be calculated and
873
724
            stored during insertion.
874
 
        :param reload_func: An function that can be called if we think we need
875
 
            to reload the pack listing and try again. See
876
 
            'bzrlib.repofmt.pack_repo.AggregateIndex' for the signature.
877
725
        """
878
726
        self._index = index
879
727
        self._access = data_access
882
730
            self._factory = KnitAnnotateFactory()
883
731
        else:
884
732
            self._factory = KnitPlainFactory()
885
 
        self._fallback_vfs = []
886
 
        self._reload_func = reload_func
887
 
 
888
 
    def __repr__(self):
889
 
        return "%s(%r, %r)" % (
890
 
            self.__class__.__name__,
891
 
            self._index,
892
 
            self._access)
893
 
 
894
 
    def add_fallback_versioned_files(self, a_versioned_files):
895
 
        """Add a source of texts for texts not present in this knit.
896
 
 
897
 
        :param a_versioned_files: A VersionedFiles object.
898
 
        """
899
 
        self._fallback_vfs.append(a_versioned_files)
900
733
 
901
734
    def add_lines(self, key, parents, lines, parent_texts=None,
902
735
        left_matching_blocks=None, nostore_sha=None, random_id=False,
909
742
            # indexes can't directly store that, so we give them
910
743
            # an empty tuple instead.
911
744
            parents = ()
912
 
        line_bytes = ''.join(lines)
913
745
        return self._add(key, lines, parents,
914
 
            parent_texts, left_matching_blocks, nostore_sha, random_id,
915
 
            line_bytes=line_bytes)
916
 
 
917
 
    def _add_text(self, key, parents, text, nostore_sha=None, random_id=False):
918
 
        """See VersionedFiles._add_text()."""
919
 
        self._index._check_write_ok()
920
 
        self._check_add(key, None, random_id, check_content=False)
921
 
        if text.__class__ is not str:
922
 
            raise errors.BzrBadParameterUnicode("text")
923
 
        if parents is None:
924
 
            # The caller might pass None if there is no graph data, but kndx
925
 
            # indexes can't directly store that, so we give them
926
 
            # an empty tuple instead.
927
 
            parents = ()
928
 
        return self._add(key, None, parents,
929
 
            None, None, nostore_sha, random_id,
930
 
            line_bytes=text)
 
746
            parent_texts, left_matching_blocks, nostore_sha, random_id)
931
747
 
932
748
    def _add(self, key, lines, parents, parent_texts,
933
 
        left_matching_blocks, nostore_sha, random_id,
934
 
        line_bytes):
 
749
        left_matching_blocks, nostore_sha, random_id):
935
750
        """Add a set of lines on top of version specified by parents.
936
751
 
937
752
        Any versions not present will be converted into ghosts.
938
 
 
939
 
        :param lines: A list of strings where each one is a single line (has a
940
 
            single newline at the end of the string) This is now optional
941
 
            (callers can pass None). It is left in its location for backwards
942
 
            compatibility. It should ''.join(lines) must == line_bytes
943
 
        :param line_bytes: A single string containing the content
944
 
 
945
 
        We pass both lines and line_bytes because different routes bring the
946
 
        values to this function. And for memory efficiency, we don't want to
947
 
        have to split/join on-demand.
948
753
        """
949
754
        # first thing, if the content is something we don't need to store, find
950
755
        # that out.
 
756
        line_bytes = ''.join(lines)
951
757
        digest = sha_string(line_bytes)
952
758
        if nostore_sha == digest:
953
759
            raise errors.ExistingContent
955
761
        present_parents = []
956
762
        if parent_texts is None:
957
763
            parent_texts = {}
958
 
        # Do a single query to ascertain parent presence; we only compress
959
 
        # against parents in the same kvf.
960
 
        present_parent_map = self._index.get_parent_map(parents)
 
764
        # Do a single query to ascertain parent presence.
 
765
        present_parent_map = self.get_parent_map(parents)
961
766
        for parent in parents:
962
767
            if parent in present_parent_map:
963
768
                present_parents.append(parent)
974
779
 
975
780
        text_length = len(line_bytes)
976
781
        options = []
977
 
        no_eol = False
978
 
        # Note: line_bytes is not modified to add a newline, that is tracked
979
 
        #       via the no_eol flag. 'lines' *is* modified, because that is the
980
 
        #       general values needed by the Content code.
981
 
        if line_bytes and line_bytes[-1] != '\n':
982
 
            options.append('no-eol')
983
 
            no_eol = True
984
 
            # Copy the existing list, or create a new one
985
 
            if lines is None:
986
 
                lines = osutils.split_lines(line_bytes)
987
 
            else:
 
782
        if lines:
 
783
            if lines[-1][-1] != '\n':
 
784
                # copy the contents of lines.
988
785
                lines = lines[:]
989
 
            # Replace the last line with one that ends in a final newline
990
 
            lines[-1] = lines[-1] + '\n'
991
 
        if lines is None:
992
 
            lines = osutils.split_lines(line_bytes)
 
786
                options.append('no-eol')
 
787
                lines[-1] = lines[-1] + '\n'
 
788
                line_bytes += '\n'
993
789
 
994
 
        for element in key[:-1]:
995
 
            if type(element) is not str:
996
 
                raise TypeError("key contains non-strings: %r" % (key,))
997
 
        if key[-1] is None:
998
 
            key = key[:-1] + ('sha1:' + digest,)
999
 
        elif type(key[-1]) is not str:
 
790
        for element in key:
 
791
            if type(element) != str:
1000
792
                raise TypeError("key contains non-strings: %r" % (key,))
1001
793
        # Knit hunks are still last-element only
1002
794
        version_id = key[-1]
1003
795
        content = self._factory.make(lines, version_id)
1004
 
        if no_eol:
 
796
        if 'no-eol' in options:
1005
797
            # Hint to the content object that its text() call should strip the
1006
798
            # EOL.
1007
799
            content._should_strip_eol = True
1019
811
        else:
1020
812
            options.append('fulltext')
1021
813
            # isinstance is slower and we have no hierarchy.
1022
 
            if self._factory.__class__ is KnitPlainFactory:
 
814
            if self._factory.__class__ == KnitPlainFactory:
1023
815
                # Use the already joined bytes saving iteration time in
1024
816
                # _record_to_data.
1025
 
                dense_lines = [line_bytes]
1026
 
                if no_eol:
1027
 
                    dense_lines.append('\n')
1028
817
                size, bytes = self._record_to_data(key, digest,
1029
 
                    lines, dense_lines)
 
818
                    lines, [line_bytes])
1030
819
            else:
1031
820
                # get mixed annotation + content and feed it into the
1032
821
                # serialiser.
1044
833
        """See VersionedFiles.annotate."""
1045
834
        return self._factory.annotate(self, key)
1046
835
 
1047
 
    def get_annotator(self):
1048
 
        return _KnitAnnotator(self)
1049
 
 
1050
 
    def check(self, progress_bar=None, keys=None):
 
836
    def check(self, progress_bar=None):
1051
837
        """See VersionedFiles.check()."""
1052
 
        if keys is None:
1053
 
            return self._logical_check()
1054
 
        else:
1055
 
            # At the moment, check does not extra work over get_record_stream
1056
 
            return self.get_record_stream(keys, 'unordered', True)
1057
 
 
1058
 
    def _logical_check(self):
1059
838
        # This doesn't actually test extraction of everything, but that will
1060
839
        # impact 'bzr check' substantially, and needs to be integrated with
1061
840
        # care. However, it does check for the obvious problem of a delta with
1062
841
        # no basis.
1063
 
        keys = self._index.keys()
 
842
        keys = self.keys()
1064
843
        parent_map = self.get_parent_map(keys)
1065
844
        for key in keys:
1066
845
            if self._index.get_method(key) != 'fulltext':
1069
848
                    raise errors.KnitCorrupt(self,
1070
849
                        "Missing basis parent %s for %s" % (
1071
850
                        compression_parent, key))
1072
 
        for fallback_vfs in self._fallback_vfs:
1073
 
            fallback_vfs.check()
1074
851
 
1075
852
    def _check_add(self, key, lines, random_id, check_content):
1076
853
        """check that version_id and lines are safe to add."""
1077
854
        version_id = key[-1]
1078
 
        if version_id is not None:
1079
 
            if contains_whitespace(version_id):
1080
 
                raise InvalidRevisionId(version_id, self)
1081
 
            self.check_not_reserved_id(version_id)
 
855
        if contains_whitespace(version_id):
 
856
            raise InvalidRevisionId(version_id, self.filename)
 
857
        self.check_not_reserved_id(version_id)
1082
858
        # TODO: If random_id==False and the key is already present, we should
1083
859
        # probably check that the existing content is identical to what is
1084
860
        # being inserted, and otherwise raise an exception.  This would make
1094
870
 
1095
871
    def _check_header_version(self, rec, version_id):
1096
872
        """Checks the header version on original format knit records.
1097
 
 
 
873
        
1098
874
        These have the last component of the key embedded in the record.
1099
875
        """
1100
876
        if rec[1] != version_id:
1115
891
        delta_size = 0
1116
892
        fulltext_size = None
1117
893
        for count in xrange(self._max_delta_chain):
1118
 
            try:
1119
 
                # Note that this only looks in the index of this particular
1120
 
                # KnitVersionedFiles, not in the fallbacks.  This ensures that
1121
 
                # we won't store a delta spanning physical repository
1122
 
                # boundaries.
1123
 
                build_details = self._index.get_build_details([parent])
1124
 
                parent_details = build_details[parent]
1125
 
            except (RevisionNotPresent, KeyError), e:
1126
 
                # Some basis is not locally present: always fulltext
1127
 
                return False
1128
 
            index_memo, compression_parent, _, _ = parent_details
1129
 
            _, _, size = index_memo
1130
 
            if compression_parent is None:
 
894
            # XXX: Collapse these two queries:
 
895
            method = self._index.get_method(parent)
 
896
            index, pos, size = self._index.get_position(parent)
 
897
            if method == 'fulltext':
1131
898
                fulltext_size = size
1132
899
                break
1133
900
            delta_size += size
1134
901
            # We don't explicitly check for presence because this is in an
1135
902
            # inner loop, and if it's missing it'll fail anyhow.
1136
 
            parent = compression_parent
 
903
            # TODO: This should be asking for compression parent, not graph
 
904
            # parent.
 
905
            parent = self._index.get_parent_map([parent])[parent][0]
1137
906
        else:
1138
907
            # We couldn't find a fulltext, so we must create a new one
1139
908
            return False
1179
948
            if missing and not allow_missing:
1180
949
                raise errors.RevisionNotPresent(missing.pop(), self)
1181
950
        return component_data
1182
 
 
 
951
       
1183
952
    def _get_content(self, key, parent_texts={}):
1184
953
        """Returns a content object that makes up the specified
1185
954
        version."""
1189
958
            if not self.get_parent_map([key]):
1190
959
                raise RevisionNotPresent(key, self)
1191
960
            return cached_version
1192
 
        generator = _VFContentMapGenerator(self, [key])
1193
 
        return generator._get_content(key)
1194
 
 
1195
 
    def get_known_graph_ancestry(self, keys):
1196
 
        """Get a KnownGraph instance with the ancestry of keys."""
1197
 
        parent_map, missing_keys = self._index.find_ancestry(keys)
1198
 
        for fallback in self._fallback_vfs:
1199
 
            if not missing_keys:
1200
 
                break
1201
 
            (f_parent_map, f_missing_keys) = fallback._index.find_ancestry(
1202
 
                                                missing_keys)
1203
 
            parent_map.update(f_parent_map)
1204
 
            missing_keys = f_missing_keys
1205
 
        kg = _mod_graph.KnownGraph(parent_map)
1206
 
        return kg
 
961
        text_map, contents_map = self._get_content_maps([key])
 
962
        return contents_map[key]
 
963
 
 
964
    def _get_content_maps(self, keys):
 
965
        """Produce maps of text and KnitContents
 
966
        
 
967
        :return: (text_map, content_map) where text_map contains the texts for
 
968
            the requested versions and content_map contains the KnitContents.
 
969
        """
 
970
        # FUTURE: This function could be improved for the 'extract many' case
 
971
        # by tracking each component and only doing the copy when the number of
 
972
        # children than need to apply delta's to it is > 1 or it is part of the
 
973
        # final output.
 
974
        keys = list(keys)
 
975
        multiple_versions = len(keys) != 1
 
976
        record_map = self._get_record_map(keys)
 
977
 
 
978
        text_map = {}
 
979
        content_map = {}
 
980
        final_content = {}
 
981
        for key in keys:
 
982
            components = []
 
983
            cursor = key
 
984
            while cursor is not None:
 
985
                record, record_details, digest, next = record_map[cursor]
 
986
                components.append((cursor, record, record_details, digest))
 
987
                if cursor in content_map:
 
988
                    break
 
989
                cursor = next
 
990
 
 
991
            content = None
 
992
            for (component_id, record, record_details,
 
993
                 digest) in reversed(components):
 
994
                if component_id in content_map:
 
995
                    content = content_map[component_id]
 
996
                else:
 
997
                    content, delta = self._factory.parse_record(key[-1],
 
998
                        record, record_details, content,
 
999
                        copy_base_content=multiple_versions)
 
1000
                    if multiple_versions:
 
1001
                        content_map[component_id] = content
 
1002
 
 
1003
            final_content[key] = content
 
1004
 
 
1005
            # digest here is the digest from the last applied component.
 
1006
            text = content.text()
 
1007
            actual_sha = sha_strings(text)
 
1008
            if actual_sha != digest:
 
1009
                raise KnitCorrupt(self,
 
1010
                    '\n  sha-1 %s'
 
1011
                    '\n  of reconstructed text does not match'
 
1012
                    '\n  expected %s'
 
1013
                    '\n  for version %s' %
 
1014
                    (actual_sha, digest, key))
 
1015
            text_map[key] = text
 
1016
        return text_map, final_content
1207
1017
 
1208
1018
    def get_parent_map(self, keys):
1209
 
        """Get a map of the graph parents of keys.
 
1019
        """Get a map of the parents of keys.
1210
1020
 
1211
1021
        :param keys: The keys to look up parents for.
1212
1022
        :return: A mapping from keys to parents. Absent keys are absent from
1213
1023
            the mapping.
1214
1024
        """
1215
 
        return self._get_parent_map_with_sources(keys)[0]
1216
 
 
1217
 
    def _get_parent_map_with_sources(self, keys):
1218
 
        """Get a map of the parents of keys.
1219
 
 
1220
 
        :param keys: The keys to look up parents for.
1221
 
        :return: A tuple. The first element is a mapping from keys to parents.
1222
 
            Absent keys are absent from the mapping. The second element is a
1223
 
            list with the locations each key was found in. The first element
1224
 
            is the in-this-knit parents, the second the first fallback source,
1225
 
            and so on.
1226
 
        """
1227
 
        result = {}
1228
 
        sources = [self._index] + self._fallback_vfs
1229
 
        source_results = []
1230
 
        missing = set(keys)
1231
 
        for source in sources:
1232
 
            if not missing:
1233
 
                break
1234
 
            new_result = source.get_parent_map(missing)
1235
 
            source_results.append(new_result)
1236
 
            result.update(new_result)
1237
 
            missing.difference_update(set(new_result))
1238
 
        return result, source_results
1239
 
 
1240
 
    def _get_record_map(self, keys, allow_missing=False):
 
1025
        return self._index.get_parent_map(keys)
 
1026
 
 
1027
    def _get_record_map(self, keys):
1241
1028
        """Produce a dictionary of knit records.
1242
 
 
 
1029
        
1243
1030
        :return: {key:(record, record_details, digest, next)}
1244
1031
            record
1245
 
                data returned from read_records (a KnitContentobject)
 
1032
                data returned from read_records
1246
1033
            record_details
1247
1034
                opaque information to pass to parse_record
1248
1035
            digest
1250
1037
            next
1251
1038
                build-parent of the version, i.e. the leftmost ancestor.
1252
1039
                Will be None if the record is not a delta.
1253
 
        :param keys: The keys to build a map for
1254
 
        :param allow_missing: If some records are missing, rather than
1255
 
            error, just return the data that could be generated.
1256
 
        """
1257
 
        raw_map = self._get_record_map_unparsed(keys,
1258
 
            allow_missing=allow_missing)
1259
 
        return self._raw_map_to_record_map(raw_map)
1260
 
 
1261
 
    def _raw_map_to_record_map(self, raw_map):
1262
 
        """Parse the contents of _get_record_map_unparsed.
1263
 
 
1264
 
        :return: see _get_record_map.
1265
 
        """
1266
 
        result = {}
1267
 
        for key in raw_map:
1268
 
            data, record_details, next = raw_map[key]
1269
 
            content, digest = self._parse_record(key[-1], data)
1270
 
            result[key] = content, record_details, digest, next
1271
 
        return result
1272
 
 
1273
 
    def _get_record_map_unparsed(self, keys, allow_missing=False):
1274
 
        """Get the raw data for reconstructing keys without parsing it.
1275
 
 
1276
 
        :return: A dict suitable for parsing via _raw_map_to_record_map.
1277
 
            key-> raw_bytes, (method, noeol), compression_parent
1278
 
        """
1279
 
        # This retries the whole request if anything fails. Potentially we
1280
 
        # could be a bit more selective. We could track the keys whose records
1281
 
        # we have successfully found, and then only request the new records
1282
 
        # from there. However, _get_components_positions grabs the whole build
1283
 
        # chain, which means we'll likely try to grab the same records again
1284
 
        # anyway. Also, can the build chains change as part of a pack
1285
 
        # operation? We wouldn't want to end up with a broken chain.
1286
 
        while True:
1287
 
            try:
1288
 
                position_map = self._get_components_positions(keys,
1289
 
                    allow_missing=allow_missing)
1290
 
                # key = component_id, r = record_details, i_m = index_memo,
1291
 
                # n = next
1292
 
                records = [(key, i_m) for key, (r, i_m, n)
1293
 
                                       in position_map.iteritems()]
1294
 
                # Sort by the index memo, so that we request records from the
1295
 
                # same pack file together, and in forward-sorted order
1296
 
                records.sort(key=operator.itemgetter(1))
1297
 
                raw_record_map = {}
1298
 
                for key, data in self._read_records_iter_unchecked(records):
1299
 
                    (record_details, index_memo, next) = position_map[key]
1300
 
                    raw_record_map[key] = data, record_details, next
1301
 
                return raw_record_map
1302
 
            except errors.RetryWithNewPacks, e:
1303
 
                self._access.reload_or_raise(e)
1304
 
 
1305
 
    @classmethod
1306
 
    def _split_by_prefix(cls, keys):
1307
 
        """For the given keys, split them up based on their prefix.
1308
 
 
1309
 
        To keep memory pressure somewhat under control, split the
1310
 
        requests back into per-file-id requests, otherwise "bzr co"
1311
 
        extracts the full tree into memory before writing it to disk.
1312
 
        This should be revisited if _get_content_maps() can ever cross
1313
 
        file-id boundaries.
1314
 
 
1315
 
        The keys for a given file_id are kept in the same relative order.
1316
 
        Ordering between file_ids is not, though prefix_order will return the
1317
 
        order that the key was first seen.
1318
 
 
1319
 
        :param keys: An iterable of key tuples
1320
 
        :return: (split_map, prefix_order)
1321
 
            split_map       A dictionary mapping prefix => keys
1322
 
            prefix_order    The order that we saw the various prefixes
1323
 
        """
1324
 
        split_by_prefix = {}
1325
 
        prefix_order = []
1326
 
        for key in keys:
1327
 
            if len(key) == 1:
1328
 
                prefix = ''
1329
 
            else:
1330
 
                prefix = key[0]
1331
 
 
1332
 
            if prefix in split_by_prefix:
1333
 
                split_by_prefix[prefix].append(key)
1334
 
            else:
1335
 
                split_by_prefix[prefix] = [key]
1336
 
                prefix_order.append(prefix)
1337
 
        return split_by_prefix, prefix_order
1338
 
 
1339
 
    def _group_keys_for_io(self, keys, non_local_keys, positions,
1340
 
                           _min_buffer_size=_STREAM_MIN_BUFFER_SIZE):
1341
 
        """For the given keys, group them into 'best-sized' requests.
1342
 
 
1343
 
        The idea is to avoid making 1 request per file, but to never try to
1344
 
        unpack an entire 1.5GB source tree in a single pass. Also when
1345
 
        possible, we should try to group requests to the same pack file
1346
 
        together.
1347
 
 
1348
 
        :return: list of (keys, non_local) tuples that indicate what keys
1349
 
            should be fetched next.
1350
 
        """
1351
 
        # TODO: Ideally we would group on 2 factors. We want to extract texts
1352
 
        #       from the same pack file together, and we want to extract all
1353
 
        #       the texts for a given build-chain together. Ultimately it
1354
 
        #       probably needs a better global view.
1355
 
        total_keys = len(keys)
1356
 
        prefix_split_keys, prefix_order = self._split_by_prefix(keys)
1357
 
        prefix_split_non_local_keys, _ = self._split_by_prefix(non_local_keys)
1358
 
        cur_keys = []
1359
 
        cur_non_local = set()
1360
 
        cur_size = 0
1361
 
        result = []
1362
 
        sizes = []
1363
 
        for prefix in prefix_order:
1364
 
            keys = prefix_split_keys[prefix]
1365
 
            non_local = prefix_split_non_local_keys.get(prefix, [])
1366
 
 
1367
 
            this_size = self._index._get_total_build_size(keys, positions)
1368
 
            cur_size += this_size
1369
 
            cur_keys.extend(keys)
1370
 
            cur_non_local.update(non_local)
1371
 
            if cur_size > _min_buffer_size:
1372
 
                result.append((cur_keys, cur_non_local))
1373
 
                sizes.append(cur_size)
1374
 
                cur_keys = []
1375
 
                cur_non_local = set()
1376
 
                cur_size = 0
1377
 
        if cur_keys:
1378
 
            result.append((cur_keys, cur_non_local))
1379
 
            sizes.append(cur_size)
1380
 
        return result
 
1040
        """
 
1041
        position_map = self._get_components_positions(keys)
 
1042
        # key = component_id, r = record_details, i_m = index_memo, n = next
 
1043
        records = [(key, i_m) for key, (r, i_m, n)
 
1044
                             in position_map.iteritems()]
 
1045
        record_map = {}
 
1046
        for key, record, digest in \
 
1047
                self._read_records_iter(records):
 
1048
            (record_details, index_memo, next) = position_map[key]
 
1049
            record_map[key] = record, record_details, digest, next
 
1050
        return record_map
1381
1051
 
1382
1052
    def get_record_stream(self, keys, ordering, include_delta_closure):
1383
1053
        """Get a stream of records for keys.
1393
1063
        """
1394
1064
        # keys might be a generator
1395
1065
        keys = set(keys)
1396
 
        if not keys:
1397
 
            return
1398
1066
        if not self._index.has_graph:
1399
 
            # Cannot sort when no graph has been stored.
 
1067
            # Cannot topological order when no graph has been stored.
1400
1068
            ordering = 'unordered'
1401
 
 
1402
 
        remaining_keys = keys
1403
 
        while True:
1404
 
            try:
1405
 
                keys = set(remaining_keys)
1406
 
                for content_factory in self._get_remaining_record_stream(keys,
1407
 
                                            ordering, include_delta_closure):
1408
 
                    remaining_keys.discard(content_factory.key)
1409
 
                    yield content_factory
1410
 
                return
1411
 
            except errors.RetryWithNewPacks, e:
1412
 
                self._access.reload_or_raise(e)
1413
 
 
1414
 
    def _get_remaining_record_stream(self, keys, ordering,
1415
 
                                     include_delta_closure):
1416
 
        """This function is the 'retry' portion for get_record_stream."""
1417
1069
        if include_delta_closure:
1418
1070
            positions = self._get_components_positions(keys, allow_missing=True)
1419
1071
        else:
1425
1077
        absent_keys = keys.difference(set(positions))
1426
1078
        # There may be more absent keys : if we're missing the basis component
1427
1079
        # and are trying to include the delta closure.
1428
 
        # XXX: We should not ever need to examine remote sources because we do
1429
 
        # not permit deltas across versioned files boundaries.
1430
1080
        if include_delta_closure:
1431
 
            needed_from_fallback = set()
1432
1081
            # Build up reconstructable_keys dict.  key:True in this dict means
1433
1082
            # the key can be reconstructed.
1434
1083
            reconstructable_keys = {}
1437
1086
                try:
1438
1087
                    chain = [key, positions[key][2]]
1439
1088
                except KeyError:
1440
 
                    needed_from_fallback.add(key)
 
1089
                    absent_keys.add(key)
1441
1090
                    continue
1442
1091
                result = True
1443
1092
                while chain[-1] is not None:
1449
1098
                            chain.append(positions[chain[-1]][2])
1450
1099
                        except KeyError:
1451
1100
                            # missing basis component
1452
 
                            needed_from_fallback.add(chain[-1])
1453
 
                            result = True
 
1101
                            result = False
1454
1102
                            break
1455
1103
                for chain_key in chain[:-1]:
1456
1104
                    reconstructable_keys[chain_key] = result
1457
1105
                if not result:
1458
 
                    needed_from_fallback.add(key)
1459
 
        # Double index lookups here : need a unified api ?
1460
 
        global_map, parent_maps = self._get_parent_map_with_sources(keys)
1461
 
        if ordering in ('topological', 'groupcompress'):
1462
 
            if ordering == 'topological':
1463
 
                # Global topological sort
1464
 
                present_keys = tsort.topo_sort(global_map)
1465
 
            else:
1466
 
                present_keys = sort_groupcompress(global_map)
1467
 
            # Now group by source:
1468
 
            source_keys = []
1469
 
            current_source = None
1470
 
            for key in present_keys:
1471
 
                for parent_map in parent_maps:
1472
 
                    if key in parent_map:
1473
 
                        key_source = parent_map
1474
 
                        break
1475
 
                if current_source is not key_source:
1476
 
                    source_keys.append((key_source, []))
1477
 
                    current_source = key_source
1478
 
                source_keys[-1][1].append(key)
1479
 
        else:
1480
 
            if ordering != 'unordered':
1481
 
                raise AssertionError('valid values for ordering are:'
1482
 
                    ' "unordered", "groupcompress" or "topological" not: %r'
1483
 
                    % (ordering,))
1484
 
            # Just group by source; remote sources first.
1485
 
            present_keys = []
1486
 
            source_keys = []
1487
 
            for parent_map in reversed(parent_maps):
1488
 
                source_keys.append((parent_map, []))
1489
 
                for key in parent_map:
1490
 
                    present_keys.append(key)
1491
 
                    source_keys[-1][1].append(key)
1492
 
            # We have been requested to return these records in an order that
1493
 
            # suits us. So we ask the index to give us an optimally sorted
1494
 
            # order.
1495
 
            for source, sub_keys in source_keys:
1496
 
                if source is parent_maps[0]:
1497
 
                    # Only sort the keys for this VF
1498
 
                    self._index._sort_keys_by_io(sub_keys, positions)
1499
 
        absent_keys = keys - set(global_map)
 
1106
                    absent_keys.add(key)
1500
1107
        for key in absent_keys:
1501
1108
            yield AbsentContentFactory(key)
1502
1109
        # restrict our view to the keys we can answer.
 
1110
        keys = keys - absent_keys
 
1111
        # Double index lookups here : need a unified api ?
 
1112
        parent_map = self.get_parent_map(keys)
 
1113
        if ordering == 'topological':
 
1114
            present_keys = topo_sort(parent_map)
 
1115
        else:
 
1116
            present_keys = keys
1503
1117
        # XXX: Memory: TODO: batch data here to cap buffered data at (say) 1MB.
1504
 
        # XXX: At that point we need to consider the impact of double reads by
1505
 
        # utilising components multiple times.
 
1118
        # XXX: At that point we need to consider double reads by utilising
 
1119
        # components multiple times.
1506
1120
        if include_delta_closure:
1507
1121
            # XXX: get_content_maps performs its own index queries; allow state
1508
1122
            # to be passed in.
1509
 
            non_local_keys = needed_from_fallback - absent_keys
1510
 
            for keys, non_local_keys in self._group_keys_for_io(present_keys,
1511
 
                                                                non_local_keys,
1512
 
                                                                positions):
1513
 
                generator = _VFContentMapGenerator(self, keys, non_local_keys,
1514
 
                                                   global_map,
1515
 
                                                   ordering=ordering)
1516
 
                for record in generator.get_record_stream():
1517
 
                    yield record
 
1123
            text_map, _ = self._get_content_maps(present_keys)
 
1124
            for key in present_keys:
 
1125
                yield FulltextContentFactory(key, parent_map[key], None,
 
1126
                    ''.join(text_map[key]))
1518
1127
        else:
1519
 
            for source, keys in source_keys:
1520
 
                if source is parent_maps[0]:
1521
 
                    # this KnitVersionedFiles
1522
 
                    records = [(key, positions[key][1]) for key in keys]
1523
 
                    for key, raw_data in self._read_records_iter_unchecked(records):
1524
 
                        (record_details, index_memo, _) = positions[key]
1525
 
                        yield KnitContentFactory(key, global_map[key],
1526
 
                            record_details, None, raw_data, self._factory.annotated, None)
1527
 
                else:
1528
 
                    vf = self._fallback_vfs[parent_maps.index(source) - 1]
1529
 
                    for record in vf.get_record_stream(keys, ordering,
1530
 
                        include_delta_closure):
1531
 
                        yield record
 
1128
            records = [(key, positions[key][1]) for key in present_keys]
 
1129
            for key, raw_data, sha1 in self._read_records_iter_raw(records):
 
1130
                (record_details, index_memo, _) = positions[key]
 
1131
                yield KnitContentFactory(key, parent_map[key],
 
1132
                    record_details, sha1, raw_data, self._factory.annotated, None)
1532
1133
 
1533
1134
    def get_sha1s(self, keys):
1534
1135
        """See VersionedFiles.get_sha1s()."""
1535
 
        missing = set(keys)
1536
 
        record_map = self._get_record_map(missing, allow_missing=True)
1537
 
        result = {}
1538
 
        for key, details in record_map.iteritems():
1539
 
            if key not in missing:
1540
 
                continue
1541
 
            # record entry 2 is the 'digest'.
1542
 
            result[key] = details[2]
1543
 
        missing.difference_update(set(result))
1544
 
        for source in self._fallback_vfs:
1545
 
            if not missing:
1546
 
                break
1547
 
            new_result = source.get_sha1s(missing)
1548
 
            result.update(new_result)
1549
 
            missing.difference_update(set(new_result))
1550
 
        return result
 
1136
        record_map = self._get_record_map(keys)
 
1137
        # record entry 2 is the 'digest'.
 
1138
        return [record_map[key][2] for key in keys]
1551
1139
 
1552
1140
    def insert_record_stream(self, stream):
1553
1141
        """Insert a record stream into this container.
1554
1142
 
1555
 
        :param stream: A stream of records to insert.
 
1143
        :param stream: A stream of records to insert. 
1556
1144
        :return: None
1557
1145
        :seealso VersionedFiles.get_record_stream:
1558
1146
        """
1564
1152
                adapter = adapter_factory(self)
1565
1153
                adapters[adapter_key] = adapter
1566
1154
                return adapter
1567
 
        delta_types = set()
1568
1155
        if self._factory.annotated:
1569
1156
            # self is annotated, we need annotated knits to use directly.
1570
1157
            annotated = "annotated-"
1574
1161
            annotated = ""
1575
1162
            convertibles = set(["knit-annotated-ft-gz"])
1576
1163
            if self._max_delta_chain:
1577
 
                delta_types.add("knit-annotated-delta-gz")
1578
1164
                convertibles.add("knit-annotated-delta-gz")
1579
1165
        # The set of types we can cheaply adapt without needing basis texts.
1580
1166
        native_types = set()
1581
1167
        if self._max_delta_chain:
1582
1168
            native_types.add("knit-%sdelta-gz" % annotated)
1583
 
            delta_types.add("knit-%sdelta-gz" % annotated)
1584
1169
        native_types.add("knit-%sft-gz" % annotated)
1585
1170
        knit_types = native_types.union(convertibles)
1586
1171
        adapters = {}
1590
1175
        # can't generate annotations from new deltas until their basis parent
1591
1176
        # is present anyway, so we get away with not needing an index that
1592
1177
        # includes the new keys.
1593
 
        #
1594
 
        # See <http://launchpad.net/bugs/300177> about ordering of compression
1595
 
        # parents in the records - to be conservative, we insist that all
1596
 
        # parents must be present to avoid expanding to a fulltext.
1597
 
        #
1598
1178
        # key = basis_parent, value = index entry to add
1599
1179
        buffered_index_entries = {}
1600
1180
        for record in stream:
1601
 
            kind = record.storage_kind
1602
 
            if kind.startswith('knit-') and kind.endswith('-gz'):
1603
 
                # Check that the ID in the header of the raw knit bytes matches
1604
 
                # the record metadata.
1605
 
                raw_data = record._raw_record
1606
 
                df, rec = self._parse_record_header(record.key, raw_data)
1607
 
                df.close()
1608
 
            buffered = False
1609
1181
            parents = record.parents
1610
 
            if record.storage_kind in delta_types:
1611
 
                # TODO: eventually the record itself should track
1612
 
                #       compression_parent
1613
 
                compression_parent = parents[0]
1614
 
            else:
1615
 
                compression_parent = None
1616
1182
            # Raise an error when a record is missing.
1617
1183
            if record.storage_kind == 'absent':
1618
1184
                raise RevisionNotPresent([record.key], self)
1619
 
            elif ((record.storage_kind in knit_types)
1620
 
                  and (compression_parent is None
1621
 
                       or not self._fallback_vfs
1622
 
                       or self._index.has_key(compression_parent)
1623
 
                       or not self.has_key(compression_parent))):
1624
 
                # we can insert the knit record literally if either it has no
1625
 
                # compression parent OR we already have its basis in this kvf
1626
 
                # OR the basis is not present even in the fallbacks.  In the
1627
 
                # last case it will either turn up later in the stream and all
1628
 
                # will be well, or it won't turn up at all and we'll raise an
1629
 
                # error at the end.
1630
 
                #
1631
 
                # TODO: self.has_key is somewhat redundant with
1632
 
                # self._index.has_key; we really want something that directly
1633
 
                # asks if it's only present in the fallbacks. -- mbp 20081119
 
1185
            if record.storage_kind in knit_types:
1634
1186
                if record.storage_kind not in native_types:
1635
1187
                    try:
1636
1188
                        adapter_key = (record.storage_kind, "knit-delta-gz")
1638
1190
                    except KeyError:
1639
1191
                        adapter_key = (record.storage_kind, "knit-ft-gz")
1640
1192
                        adapter = get_adapter(adapter_key)
1641
 
                    bytes = adapter.get_bytes(record)
 
1193
                    bytes = adapter.get_bytes(
 
1194
                        record, record.get_bytes_as(record.storage_kind))
1642
1195
                else:
1643
 
                    # It's a knit record, it has a _raw_record field (even if
1644
 
                    # it was reconstituted from a network stream).
1645
 
                    bytes = record._raw_record
 
1196
                    bytes = record.get_bytes_as(record.storage_kind)
1646
1197
                options = [record._build_details[0]]
1647
1198
                if record._build_details[1]:
1648
1199
                    options.append('no-eol')
1657
1208
                access_memo = self._access.add_raw_records(
1658
1209
                    [(record.key, len(bytes))], bytes)[0]
1659
1210
                index_entry = (record.key, options, access_memo, parents)
 
1211
                buffered = False
1660
1212
                if 'fulltext' not in options:
1661
 
                    # Not a fulltext, so we need to make sure the compression
1662
 
                    # parent will also be present.
 
1213
                    basis_parent = parents[0]
1663
1214
                    # Note that pack backed knits don't need to buffer here
1664
1215
                    # because they buffer all writes to the transaction level,
1665
1216
                    # but we don't expose that difference at the index level. If
1666
1217
                    # the query here has sufficient cost to show up in
1667
1218
                    # profiling we should do that.
1668
 
                    #
1669
 
                    # They're required to be physically in this
1670
 
                    # KnitVersionedFiles, not in a fallback.
1671
 
                    if not self._index.has_key(compression_parent):
 
1219
                    if basis_parent not in self.get_parent_map([basis_parent]):
1672
1220
                        pending = buffered_index_entries.setdefault(
1673
 
                            compression_parent, [])
 
1221
                            basis_parent, [])
1674
1222
                        pending.append(index_entry)
1675
1223
                        buffered = True
1676
1224
                if not buffered:
1677
1225
                    self._index.add_records([index_entry])
1678
 
            elif record.storage_kind == 'chunked':
 
1226
            elif record.storage_kind == 'fulltext':
1679
1227
                self.add_lines(record.key, parents,
1680
 
                    osutils.chunks_to_lines(record.get_bytes_as('chunked')))
 
1228
                    split_lines(record.get_bytes_as('fulltext')))
1681
1229
            else:
1682
 
                # Not suitable for direct insertion as a
1683
 
                # delta, either because it's not the right format, or this
1684
 
                # KnitVersionedFiles doesn't permit deltas (_max_delta_chain ==
1685
 
                # 0) or because it depends on a base only present in the
1686
 
                # fallback kvfs.
1687
 
                self._access.flush()
1688
 
                try:
1689
 
                    # Try getting a fulltext directly from the record.
1690
 
                    bytes = record.get_bytes_as('fulltext')
1691
 
                except errors.UnavailableRepresentation:
1692
 
                    adapter_key = record.storage_kind, 'fulltext'
1693
 
                    adapter = get_adapter(adapter_key)
1694
 
                    bytes = adapter.get_bytes(record)
1695
 
                lines = split_lines(bytes)
 
1230
                adapter_key = record.storage_kind, 'fulltext'
 
1231
                adapter = get_adapter(adapter_key)
 
1232
                lines = split_lines(adapter.get_bytes(
 
1233
                    record, record.get_bytes_as(record.storage_kind)))
1696
1234
                try:
1697
1235
                    self.add_lines(record.key, parents, lines)
1698
1236
                except errors.RevisionAlreadyPresent:
1699
1237
                    pass
1700
1238
            # Add any records whose basis parent is now available.
1701
 
            if not buffered:
1702
 
                added_keys = [record.key]
1703
 
                while added_keys:
1704
 
                    key = added_keys.pop(0)
1705
 
                    if key in buffered_index_entries:
1706
 
                        index_entries = buffered_index_entries[key]
1707
 
                        self._index.add_records(index_entries)
1708
 
                        added_keys.extend(
1709
 
                            [index_entry[0] for index_entry in index_entries])
1710
 
                        del buffered_index_entries[key]
 
1239
            added_keys = [record.key]
 
1240
            while added_keys:
 
1241
                key = added_keys.pop(0)
 
1242
                if key in buffered_index_entries:
 
1243
                    index_entries = buffered_index_entries[key]
 
1244
                    self._index.add_records(index_entries)
 
1245
                    added_keys.extend(
 
1246
                        [index_entry[0] for index_entry in index_entries])
 
1247
                    del buffered_index_entries[key]
 
1248
        # If there were any deltas which had a missing basis parent, error.
1711
1249
        if buffered_index_entries:
1712
 
            # There were index entries buffered at the end of the stream,
1713
 
            # So these need to be added (if the index supports holding such
1714
 
            # entries for later insertion)
1715
 
            all_entries = []
1716
 
            for key in buffered_index_entries:
1717
 
                index_entries = buffered_index_entries[key]
1718
 
                all_entries.extend(index_entries)
1719
 
            self._index.add_records(
1720
 
                all_entries, missing_compression_parents=True)
1721
 
 
1722
 
    def get_missing_compression_parent_keys(self):
1723
 
        """Return an iterable of keys of missing compression parents.
1724
 
 
1725
 
        Check this after calling insert_record_stream to find out if there are
1726
 
        any missing compression parents.  If there are, the records that
1727
 
        depend on them are not able to be inserted safely. For atomic
1728
 
        KnitVersionedFiles built on packs, the transaction should be aborted or
1729
 
        suspended - commit will fail at this point. Nonatomic knits will error
1730
 
        earlier because they have no staging area to put pending entries into.
1731
 
        """
1732
 
        return self._index.get_missing_compression_parents()
 
1250
            raise errors.RevisionNotPresent(buffered_index_entries.keys()[0],
 
1251
                self)
1733
1252
 
1734
1253
    def iter_lines_added_or_present_in_keys(self, keys, pb=None):
1735
1254
        """Iterate over the lines in the versioned files from keys.
1746
1265
        is an iterator).
1747
1266
 
1748
1267
        NOTES:
1749
 
         * Lines are normalised by the underlying store: they will all have \\n
 
1268
         * Lines are normalised by the underlying store: they will all have \n
1750
1269
           terminators.
1751
1270
         * Lines are returned in arbitrary order.
1752
 
         * If a requested key did not change any lines (or didn't have any
1753
 
           lines), it may not be mentioned at all in the result.
1754
1271
 
1755
 
        :param pb: Progress bar supplied by caller.
1756
1272
        :return: An iterator over (line, key).
1757
1273
        """
1758
1274
        if pb is None:
1759
 
            pb = ui.ui_factory.nested_progress_bar()
 
1275
            pb = progress.DummyProgress()
1760
1276
        keys = set(keys)
1761
 
        total = len(keys)
1762
 
        done = False
1763
 
        while not done:
1764
 
            try:
1765
 
                # we don't care about inclusions, the caller cares.
1766
 
                # but we need to setup a list of records to visit.
1767
 
                # we need key, position, length
1768
 
                key_records = []
1769
 
                build_details = self._index.get_build_details(keys)
1770
 
                for key, details in build_details.iteritems():
1771
 
                    if key in keys:
1772
 
                        key_records.append((key, details[0]))
1773
 
                records_iter = enumerate(self._read_records_iter(key_records))
1774
 
                for (key_idx, (key, data, sha_value)) in records_iter:
1775
 
                    pb.update('Walking content', key_idx, total)
1776
 
                    compression_parent = build_details[key][1]
1777
 
                    if compression_parent is None:
1778
 
                        # fulltext
1779
 
                        line_iterator = self._factory.get_fulltext_content(data)
1780
 
                    else:
1781
 
                        # Delta
1782
 
                        line_iterator = self._factory.get_linedelta_content(data)
1783
 
                    # Now that we are yielding the data for this key, remove it
1784
 
                    # from the list
1785
 
                    keys.remove(key)
1786
 
                    # XXX: It might be more efficient to yield (key,
1787
 
                    # line_iterator) in the future. However for now, this is a
1788
 
                    # simpler change to integrate into the rest of the
1789
 
                    # codebase. RBC 20071110
1790
 
                    for line in line_iterator:
1791
 
                        yield line, key
1792
 
                done = True
1793
 
            except errors.RetryWithNewPacks, e:
1794
 
                self._access.reload_or_raise(e)
1795
 
        # If there are still keys we've not yet found, we look in the fallback
1796
 
        # vfs, and hope to find them there.  Note that if the keys are found
1797
 
        # but had no changes or no content, the fallback may not return
1798
 
        # anything.
1799
 
        if keys and not self._fallback_vfs:
1800
 
            # XXX: strictly the second parameter is meant to be the file id
1801
 
            # but it's not easily accessible here.
1802
 
            raise RevisionNotPresent(keys, repr(self))
1803
 
        for source in self._fallback_vfs:
1804
 
            if not keys:
1805
 
                break
1806
 
            source_keys = set()
1807
 
            for line, key in source.iter_lines_added_or_present_in_keys(keys):
1808
 
                source_keys.add(key)
 
1277
        # filter for available keys
 
1278
        parent_map = self.get_parent_map(keys)
 
1279
        if len(parent_map) != len(keys):
 
1280
            missing = set(parent_map) - requested_keys
 
1281
            raise RevisionNotPresent(key, self.filename)
 
1282
        # we don't care about inclusions, the caller cares.
 
1283
        # but we need to setup a list of records to visit.
 
1284
        # we need key, position, length
 
1285
        key_records = []
 
1286
        build_details = self._index.get_build_details(keys)
 
1287
        for key in keys:
 
1288
            # [0] is index_memo
 
1289
            key_records.append((key, build_details[key][0]))
 
1290
        total = len(key_records)
 
1291
        records_iter = enumerate(self._read_records_iter(key_records))
 
1292
        for (key_idx, (key, data, sha_value)) in records_iter:
 
1293
            pb.update('Walking content.', key_idx, total)
 
1294
            compression_parent = build_details[key][1]
 
1295
            if compression_parent is None:
 
1296
                # fulltext
 
1297
                line_iterator = self._factory.get_fulltext_content(data)
 
1298
            else:
 
1299
                # Delta 
 
1300
                line_iterator = self._factory.get_linedelta_content(data)
 
1301
            # XXX: It might be more efficient to yield (key,
 
1302
            # line_iterator) in the future. However for now, this is a simpler
 
1303
            # change to integrate into the rest of the codebase. RBC 20071110
 
1304
            for line in line_iterator:
1809
1305
                yield line, key
1810
 
            keys.difference_update(source_keys)
1811
 
        pb.update('Walking content', total, total)
 
1306
        pb.update('Walking content.', total, total)
1812
1307
 
1813
1308
    def _make_line_delta(self, delta_seq, new_content):
1814
1309
        """Generate a line delta from delta_seq and new_content."""
1823
1318
                           delta=None, annotated=None,
1824
1319
                           left_matching_blocks=None):
1825
1320
        """Merge annotations for content and generate deltas.
1826
 
 
 
1321
        
1827
1322
        This is done by comparing the annotations based on changes to the text
1828
1323
        and generating a delta on the resulting full texts. If annotations are
1829
1324
        not being created then a simple delta is created.
1879
1374
        :return: the header and the decompressor stream.
1880
1375
                 as (stream, header_record)
1881
1376
        """
1882
 
        df = tuned_gzip.GzipFile(mode='rb', fileobj=StringIO(raw_data))
 
1377
        df = GzipFile(mode='rb', fileobj=StringIO(raw_data))
1883
1378
        try:
1884
1379
            # Current serialise
1885
1380
            rec = self._check_header(key, df.readline())
1894
1389
        # 4168 calls in 2880 217 internal
1895
1390
        # 4168 calls to _parse_record_header in 2121
1896
1391
        # 4168 calls to readlines in 330
1897
 
        df = tuned_gzip.GzipFile(mode='rb', fileobj=StringIO(data))
 
1392
        df = GzipFile(mode='rb', fileobj=StringIO(data))
1898
1393
        try:
1899
1394
            record_contents = df.readlines()
1900
1395
        except Exception, e:
1911
1406
                                 rec[1], record_contents))
1912
1407
        if last_line != 'end %s\n' % rec[1]:
1913
1408
            raise KnitCorrupt(self,
1914
 
                              'unexpected version end line %r, wanted %r'
 
1409
                              'unexpected version end line %r, wanted %r' 
1915
1410
                              % (last_line, rec[1]))
1916
1411
        df.close()
1917
1412
        return rec, record_contents
1934
1429
        if not needed_records:
1935
1430
            return
1936
1431
 
1937
 
        # The transport optimizes the fetching as well
 
1432
        # The transport optimizes the fetching as well 
1938
1433
        # (ie, reads continuous ranges.)
1939
1434
        raw_data = self._access.get_raw_records(
1940
1435
            [index_memo for key, index_memo in needed_records])
1950
1445
        This unpacks enough of the text record to validate the id is
1951
1446
        as expected but thats all.
1952
1447
 
1953
 
        Each item the iterator yields is (key, bytes,
1954
 
            expected_sha1_of_full_text).
1955
 
        """
1956
 
        for key, data in self._read_records_iter_unchecked(records):
1957
 
            # validate the header (note that we can only use the suffix in
1958
 
            # current knit records).
1959
 
            df, rec = self._parse_record_header(key, data)
1960
 
            df.close()
1961
 
            yield key, data, rec[3]
1962
 
 
1963
 
    def _read_records_iter_unchecked(self, records):
1964
 
        """Read text records from data file and yield raw data.
1965
 
 
1966
 
        No validation is done.
1967
 
 
1968
 
        Yields tuples of (key, data).
 
1448
        Each item the iterator yields is (key, bytes, sha1_of_full_text).
1969
1449
        """
1970
1450
        # setup an iterator of the external records:
1971
1451
        # uses readv so nice and fast we hope.
1977
1457
 
1978
1458
        for key, index_memo in records:
1979
1459
            data = raw_records.next()
1980
 
            yield key, data
 
1460
            # validate the header (note that we can only use the suffix in
 
1461
            # current knit records).
 
1462
            df, rec = self._parse_record_header(key, data)
 
1463
            df.close()
 
1464
            yield key, data, rec[3]
1981
1465
 
1982
1466
    def _record_to_data(self, key, digest, lines, dense_lines=None):
1983
1467
        """Convert key, digest, lines into a raw data block.
1984
 
 
 
1468
        
1985
1469
        :param key: The key of the record. Currently keys are always serialised
1986
1470
            using just the trailing component.
1987
1471
        :param dense_lines: The bytes of lines but in a denser form. For
1992
1476
            function spends less time resizing the final string.
1993
1477
        :return: (len, a StringIO instance with the raw data ready to read.)
1994
1478
        """
1995
 
        chunks = ["version %s %d %s\n" % (key[-1], len(lines), digest)]
1996
 
        chunks.extend(dense_lines or lines)
1997
 
        chunks.append("end %s\n" % key[-1])
1998
 
        for chunk in chunks:
1999
 
            if type(chunk) is not str:
2000
 
                raise AssertionError(
2001
 
                    'data must be plain bytes was %s' % type(chunk))
 
1479
        # Note: using a string copy here increases memory pressure with e.g.
 
1480
        # ISO's, but it is about 3 seconds faster on a 1.2Ghz intel machine
 
1481
        # when doing the initial commit of a mozilla tree. RBC 20070921
 
1482
        bytes = ''.join(chain(
 
1483
            ["version %s %d %s\n" % (key[-1],
 
1484
                                     len(lines),
 
1485
                                     digest)],
 
1486
            dense_lines or lines,
 
1487
            ["end %s\n" % key[-1]]))
 
1488
        if type(bytes) != str:
 
1489
            raise AssertionError(
 
1490
                'data must be plain bytes was %s' % type(bytes))
2002
1491
        if lines and lines[-1][-1] != '\n':
2003
1492
            raise ValueError('corrupt lines value %r' % lines)
2004
 
        compressed_bytes = tuned_gzip.chunks_to_gzip(chunks)
 
1493
        compressed_bytes = bytes_to_gzip(bytes)
2005
1494
        return len(compressed_bytes), compressed_bytes
2006
1495
 
2007
1496
    def _split_header(self, line):
2015
1504
        """See VersionedFiles.keys."""
2016
1505
        if 'evil' in debug.debug_flags:
2017
1506
            trace.mutter_callsite(2, "keys scales with size of history")
2018
 
        sources = [self._index] + self._fallback_vfs
2019
 
        result = set()
2020
 
        for source in sources:
2021
 
            result.update(source.keys())
2022
 
        return result
2023
 
 
2024
 
 
2025
 
class _ContentMapGenerator(object):
2026
 
    """Generate texts or expose raw deltas for a set of texts."""
2027
 
 
2028
 
    def __init__(self, ordering='unordered'):
2029
 
        self._ordering = ordering
2030
 
 
2031
 
    def _get_content(self, key):
2032
 
        """Get the content object for key."""
2033
 
        # Note that _get_content is only called when the _ContentMapGenerator
2034
 
        # has been constructed with just one key requested for reconstruction.
2035
 
        if key in self.nonlocal_keys:
2036
 
            record = self.get_record_stream().next()
2037
 
            # Create a content object on the fly
2038
 
            lines = osutils.chunks_to_lines(record.get_bytes_as('chunked'))
2039
 
            return PlainKnitContent(lines, record.key)
2040
 
        else:
2041
 
            # local keys we can ask for directly
2042
 
            return self._get_one_work(key)
2043
 
 
2044
 
    def get_record_stream(self):
2045
 
        """Get a record stream for the keys requested during __init__."""
2046
 
        for record in self._work():
2047
 
            yield record
2048
 
 
2049
 
    def _work(self):
2050
 
        """Produce maps of text and KnitContents as dicts.
2051
 
 
2052
 
        :return: (text_map, content_map) where text_map contains the texts for
2053
 
            the requested versions and content_map contains the KnitContents.
2054
 
        """
2055
 
        # NB: By definition we never need to read remote sources unless texts
2056
 
        # are requested from them: we don't delta across stores - and we
2057
 
        # explicitly do not want to to prevent data loss situations.
2058
 
        if self.global_map is None:
2059
 
            self.global_map = self.vf.get_parent_map(self.keys)
2060
 
        nonlocal_keys = self.nonlocal_keys
2061
 
 
2062
 
        missing_keys = set(nonlocal_keys)
2063
 
        # Read from remote versioned file instances and provide to our caller.
2064
 
        for source in self.vf._fallback_vfs:
2065
 
            if not missing_keys:
2066
 
                break
2067
 
            # Loop over fallback repositories asking them for texts - ignore
2068
 
            # any missing from a particular fallback.
2069
 
            for record in source.get_record_stream(missing_keys,
2070
 
                self._ordering, True):
2071
 
                if record.storage_kind == 'absent':
2072
 
                    # Not in thie particular stream, may be in one of the
2073
 
                    # other fallback vfs objects.
2074
 
                    continue
2075
 
                missing_keys.remove(record.key)
2076
 
                yield record
2077
 
 
2078
 
        if self._raw_record_map is None:
2079
 
            raise AssertionError('_raw_record_map should have been filled')
2080
 
        first = True
2081
 
        for key in self.keys:
2082
 
            if key in self.nonlocal_keys:
2083
 
                continue
2084
 
            yield LazyKnitContentFactory(key, self.global_map[key], self, first)
2085
 
            first = False
2086
 
 
2087
 
    def _get_one_work(self, requested_key):
2088
 
        # Now, if we have calculated everything already, just return the
2089
 
        # desired text.
2090
 
        if requested_key in self._contents_map:
2091
 
            return self._contents_map[requested_key]
2092
 
        # To simplify things, parse everything at once - code that wants one text
2093
 
        # probably wants them all.
2094
 
        # FUTURE: This function could be improved for the 'extract many' case
2095
 
        # by tracking each component and only doing the copy when the number of
2096
 
        # children than need to apply delta's to it is > 1 or it is part of the
2097
 
        # final output.
2098
 
        multiple_versions = len(self.keys) != 1
2099
 
        if self._record_map is None:
2100
 
            self._record_map = self.vf._raw_map_to_record_map(
2101
 
                self._raw_record_map)
2102
 
        record_map = self._record_map
2103
 
        # raw_record_map is key:
2104
 
        # Have read and parsed records at this point.
2105
 
        for key in self.keys:
2106
 
            if key in self.nonlocal_keys:
2107
 
                # already handled
2108
 
                continue
2109
 
            components = []
2110
 
            cursor = key
2111
 
            while cursor is not None:
2112
 
                try:
2113
 
                    record, record_details, digest, next = record_map[cursor]
2114
 
                except KeyError:
2115
 
                    raise RevisionNotPresent(cursor, self)
2116
 
                components.append((cursor, record, record_details, digest))
2117
 
                cursor = next
2118
 
                if cursor in self._contents_map:
2119
 
                    # no need to plan further back
2120
 
                    components.append((cursor, None, None, None))
2121
 
                    break
2122
 
 
2123
 
            content = None
2124
 
            for (component_id, record, record_details,
2125
 
                 digest) in reversed(components):
2126
 
                if component_id in self._contents_map:
2127
 
                    content = self._contents_map[component_id]
2128
 
                else:
2129
 
                    content, delta = self._factory.parse_record(key[-1],
2130
 
                        record, record_details, content,
2131
 
                        copy_base_content=multiple_versions)
2132
 
                    if multiple_versions:
2133
 
                        self._contents_map[component_id] = content
2134
 
 
2135
 
            # digest here is the digest from the last applied component.
2136
 
            text = content.text()
2137
 
            actual_sha = sha_strings(text)
2138
 
            if actual_sha != digest:
2139
 
                raise SHA1KnitCorrupt(self, actual_sha, digest, key, text)
2140
 
        if multiple_versions:
2141
 
            return self._contents_map[requested_key]
2142
 
        else:
2143
 
            return content
2144
 
 
2145
 
    def _wire_bytes(self):
2146
 
        """Get the bytes to put on the wire for 'key'.
2147
 
 
2148
 
        The first collection of bytes asked for returns the serialised
2149
 
        raw_record_map and the additional details (key, parent) for key.
2150
 
        Subsequent calls return just the additional details (key, parent).
2151
 
        The wire storage_kind given for the first key is 'knit-delta-closure',
2152
 
        For subsequent keys it is 'knit-delta-closure-ref'.
2153
 
 
2154
 
        :param key: A key from the content generator.
2155
 
        :return: Bytes to put on the wire.
2156
 
        """
2157
 
        lines = []
2158
 
        # kind marker for dispatch on the far side,
2159
 
        lines.append('knit-delta-closure')
2160
 
        # Annotated or not
2161
 
        if self.vf._factory.annotated:
2162
 
            lines.append('annotated')
2163
 
        else:
2164
 
            lines.append('')
2165
 
        # then the list of keys
2166
 
        lines.append('\t'.join(['\x00'.join(key) for key in self.keys
2167
 
            if key not in self.nonlocal_keys]))
2168
 
        # then the _raw_record_map in serialised form:
2169
 
        map_byte_list = []
2170
 
        # for each item in the map:
2171
 
        # 1 line with key
2172
 
        # 1 line with parents if the key is to be yielded (None: for None, '' for ())
2173
 
        # one line with method
2174
 
        # one line with noeol
2175
 
        # one line with next ('' for None)
2176
 
        # one line with byte count of the record bytes
2177
 
        # the record bytes
2178
 
        for key, (record_bytes, (method, noeol), next) in \
2179
 
            self._raw_record_map.iteritems():
2180
 
            key_bytes = '\x00'.join(key)
2181
 
            parents = self.global_map.get(key, None)
2182
 
            if parents is None:
2183
 
                parent_bytes = 'None:'
2184
 
            else:
2185
 
                parent_bytes = '\t'.join('\x00'.join(key) for key in parents)
2186
 
            method_bytes = method
2187
 
            if noeol:
2188
 
                noeol_bytes = "T"
2189
 
            else:
2190
 
                noeol_bytes = "F"
2191
 
            if next:
2192
 
                next_bytes = '\x00'.join(next)
2193
 
            else:
2194
 
                next_bytes = ''
2195
 
            map_byte_list.append('%s\n%s\n%s\n%s\n%s\n%d\n%s' % (
2196
 
                key_bytes, parent_bytes, method_bytes, noeol_bytes, next_bytes,
2197
 
                len(record_bytes), record_bytes))
2198
 
        map_bytes = ''.join(map_byte_list)
2199
 
        lines.append(map_bytes)
2200
 
        bytes = '\n'.join(lines)
2201
 
        return bytes
2202
 
 
2203
 
 
2204
 
class _VFContentMapGenerator(_ContentMapGenerator):
2205
 
    """Content map generator reading from a VersionedFiles object."""
2206
 
 
2207
 
    def __init__(self, versioned_files, keys, nonlocal_keys=None,
2208
 
        global_map=None, raw_record_map=None, ordering='unordered'):
2209
 
        """Create a _ContentMapGenerator.
2210
 
 
2211
 
        :param versioned_files: The versioned files that the texts are being
2212
 
            extracted from.
2213
 
        :param keys: The keys to produce content maps for.
2214
 
        :param nonlocal_keys: An iterable of keys(possibly intersecting keys)
2215
 
            which are known to not be in this knit, but rather in one of the
2216
 
            fallback knits.
2217
 
        :param global_map: The result of get_parent_map(keys) (or a supermap).
2218
 
            This is required if get_record_stream() is to be used.
2219
 
        :param raw_record_map: A unparsed raw record map to use for answering
2220
 
            contents.
2221
 
        """
2222
 
        _ContentMapGenerator.__init__(self, ordering=ordering)
2223
 
        # The vf to source data from
2224
 
        self.vf = versioned_files
2225
 
        # The keys desired
2226
 
        self.keys = list(keys)
2227
 
        # Keys known to be in fallback vfs objects
2228
 
        if nonlocal_keys is None:
2229
 
            self.nonlocal_keys = set()
2230
 
        else:
2231
 
            self.nonlocal_keys = frozenset(nonlocal_keys)
2232
 
        # Parents data for keys to be returned in get_record_stream
2233
 
        self.global_map = global_map
2234
 
        # The chunked lists for self.keys in text form
2235
 
        self._text_map = {}
2236
 
        # A cache of KnitContent objects used in extracting texts.
2237
 
        self._contents_map = {}
2238
 
        # All the knit records needed to assemble the requested keys as full
2239
 
        # texts.
2240
 
        self._record_map = None
2241
 
        if raw_record_map is None:
2242
 
            self._raw_record_map = self.vf._get_record_map_unparsed(keys,
2243
 
                allow_missing=True)
2244
 
        else:
2245
 
            self._raw_record_map = raw_record_map
2246
 
        # the factory for parsing records
2247
 
        self._factory = self.vf._factory
2248
 
 
2249
 
 
2250
 
class _NetworkContentMapGenerator(_ContentMapGenerator):
2251
 
    """Content map generator sourced from a network stream."""
2252
 
 
2253
 
    def __init__(self, bytes, line_end):
2254
 
        """Construct a _NetworkContentMapGenerator from a bytes block."""
2255
 
        self._bytes = bytes
2256
 
        self.global_map = {}
2257
 
        self._raw_record_map = {}
2258
 
        self._contents_map = {}
2259
 
        self._record_map = None
2260
 
        self.nonlocal_keys = []
2261
 
        # Get access to record parsing facilities
2262
 
        self.vf = KnitVersionedFiles(None, None)
2263
 
        start = line_end
2264
 
        # Annotated or not
2265
 
        line_end = bytes.find('\n', start)
2266
 
        line = bytes[start:line_end]
2267
 
        start = line_end + 1
2268
 
        if line == 'annotated':
2269
 
            self._factory = KnitAnnotateFactory()
2270
 
        else:
2271
 
            self._factory = KnitPlainFactory()
2272
 
        # list of keys to emit in get_record_stream
2273
 
        line_end = bytes.find('\n', start)
2274
 
        line = bytes[start:line_end]
2275
 
        start = line_end + 1
2276
 
        self.keys = [
2277
 
            tuple(segment.split('\x00')) for segment in line.split('\t')
2278
 
            if segment]
2279
 
        # now a loop until the end. XXX: It would be nice if this was just a
2280
 
        # bunch of the same records as get_record_stream(..., False) gives, but
2281
 
        # there is a decent sized gap stopping that at the moment.
2282
 
        end = len(bytes)
2283
 
        while start < end:
2284
 
            # 1 line with key
2285
 
            line_end = bytes.find('\n', start)
2286
 
            key = tuple(bytes[start:line_end].split('\x00'))
2287
 
            start = line_end + 1
2288
 
            # 1 line with parents (None: for None, '' for ())
2289
 
            line_end = bytes.find('\n', start)
2290
 
            line = bytes[start:line_end]
2291
 
            if line == 'None:':
2292
 
                parents = None
2293
 
            else:
2294
 
                parents = tuple(
2295
 
                    [tuple(segment.split('\x00')) for segment in line.split('\t')
2296
 
                     if segment])
2297
 
            self.global_map[key] = parents
2298
 
            start = line_end + 1
2299
 
            # one line with method
2300
 
            line_end = bytes.find('\n', start)
2301
 
            line = bytes[start:line_end]
2302
 
            method = line
2303
 
            start = line_end + 1
2304
 
            # one line with noeol
2305
 
            line_end = bytes.find('\n', start)
2306
 
            line = bytes[start:line_end]
2307
 
            noeol = line == "T"
2308
 
            start = line_end + 1
2309
 
            # one line with next ('' for None)
2310
 
            line_end = bytes.find('\n', start)
2311
 
            line = bytes[start:line_end]
2312
 
            if not line:
2313
 
                next = None
2314
 
            else:
2315
 
                next = tuple(bytes[start:line_end].split('\x00'))
2316
 
            start = line_end + 1
2317
 
            # one line with byte count of the record bytes
2318
 
            line_end = bytes.find('\n', start)
2319
 
            line = bytes[start:line_end]
2320
 
            count = int(line)
2321
 
            start = line_end + 1
2322
 
            # the record bytes
2323
 
            record_bytes = bytes[start:start+count]
2324
 
            start = start + count
2325
 
            # put it in the map
2326
 
            self._raw_record_map[key] = (record_bytes, (method, noeol), next)
2327
 
 
2328
 
    def get_record_stream(self):
2329
 
        """Get a record stream for for keys requested by the bytestream."""
2330
 
        first = True
2331
 
        for key in self.keys:
2332
 
            yield LazyKnitContentFactory(key, self.global_map[key], self, first)
2333
 
            first = False
2334
 
 
2335
 
    def _wire_bytes(self):
2336
 
        return self._bytes
 
1507
        return self._index.keys()
2337
1508
 
2338
1509
 
2339
1510
class _KndxIndex(object):
2355
1526
 
2356
1527
    Duplicate entries may be written to the index for a single version id
2357
1528
    if this is done then the latter one completely replaces the former:
2358
 
    this allows updates to correct version and parent information.
 
1529
    this allows updates to correct version and parent information. 
2359
1530
    Note that the two entries may share the delta, and that successive
2360
1531
    annotations and references MUST point to the first entry.
2361
1532
 
2362
1533
    The index file on disc contains a header, followed by one line per knit
2363
1534
    record. The same revision can be present in an index file more than once.
2364
 
    The first occurrence gets assigned a sequence number starting from 0.
2365
 
 
 
1535
    The first occurrence gets assigned a sequence number starting from 0. 
 
1536
    
2366
1537
    The format of a single line is
2367
1538
    REVISION_ID FLAGS BYTE_OFFSET LENGTH( PARENT_ID|PARENT_SEQUENCE_ID)* :\n
2368
1539
    REVISION_ID is a utf8-encoded revision id
2369
 
    FLAGS is a comma separated list of flags about the record. Values include
 
1540
    FLAGS is a comma separated list of flags about the record. Values include 
2370
1541
        no-eol, line-delta, fulltext.
2371
1542
    BYTE_OFFSET is the ascii representation of the byte offset in the data file
2372
 
        that the compressed data starts at.
 
1543
        that the the compressed data starts at.
2373
1544
    LENGTH is the ascii representation of the length of the data file.
2374
1545
    PARENT_ID a utf-8 revision id prefixed by a '.' that is a parent of
2375
1546
        REVISION_ID.
2376
1547
    PARENT_SEQUENCE_ID the ascii representation of the sequence number of a
2377
1548
        revision id already in the knit that is a parent of REVISION_ID.
2378
1549
    The ' :' marker is the end of record marker.
2379
 
 
 
1550
    
2380
1551
    partial writes:
2381
1552
    when a write is interrupted to the index file, it will result in a line
2382
1553
    that does not end in ' :'. If the ' :' is not present at the end of a line,
2407
1578
        self._reset_cache()
2408
1579
        self.has_graph = True
2409
1580
 
2410
 
    def add_records(self, records, random_id=False, missing_compression_parents=False):
 
1581
    def add_records(self, records, random_id=False):
2411
1582
        """Add multiple records to the index.
2412
 
 
 
1583
        
2413
1584
        :param records: a list of tuples:
2414
1585
                         (key, options, access_memo, parents).
2415
1586
        :param random_id: If True the ids being added were randomly generated
2416
1587
            and no check for existence will be performed.
2417
 
        :param missing_compression_parents: If True the records being added are
2418
 
            only compressed against texts already in the index (or inside
2419
 
            records). If False the records all refer to unavailable texts (or
2420
 
            texts inside records) as compression parents.
2421
1588
        """
2422
 
        if missing_compression_parents:
2423
 
            # It might be nice to get the edge of the records. But keys isn't
2424
 
            # _wrong_.
2425
 
            keys = sorted(record[0] for record in records)
2426
 
            raise errors.RevisionNotPresent(keys, self)
2427
1589
        paths = {}
2428
1590
        for record in records:
2429
1591
            key = record[0]
2446
1608
                    line = "\n%s %s %s %s %s :" % (
2447
1609
                        key[-1], ','.join(options), pos, size,
2448
1610
                        self._dictionary_compress(parents))
2449
 
                    if type(line) is not str:
 
1611
                    if type(line) != str:
2450
1612
                        raise AssertionError(
2451
1613
                            'data must be utf8 was %s' % type(line))
2452
1614
                    lines.append(line)
2460
1622
                self._kndx_cache[prefix] = (orig_cache, orig_history)
2461
1623
                raise
2462
1624
 
2463
 
    def scan_unvalidated_index(self, graph_index):
2464
 
        """See _KnitGraphIndex.scan_unvalidated_index."""
2465
 
        # Because kndx files do not support atomic insertion via separate index
2466
 
        # files, they do not support this method.
2467
 
        raise NotImplementedError(self.scan_unvalidated_index)
2468
 
 
2469
 
    def get_missing_compression_parents(self):
2470
 
        """See _KnitGraphIndex.get_missing_compression_parents."""
2471
 
        # Because kndx files do not support atomic insertion via separate index
2472
 
        # files, they do not support this method.
2473
 
        raise NotImplementedError(self.get_missing_compression_parents)
2474
 
 
2475
1625
    def _cache_key(self, key, options, pos, size, parent_keys):
2476
1626
        """Cache a version record in the history array and index cache.
2477
1627
 
2545
1695
                extra information about the content which needs to be passed to
2546
1696
                Factory.parse_record
2547
1697
        """
 
1698
        prefixes = self._partition_keys(keys)
2548
1699
        parent_map = self.get_parent_map(keys)
2549
1700
        result = {}
2550
1701
        for key in keys:
2579
1730
        """
2580
1731
        prefix, suffix = self._split_key(key)
2581
1732
        self._load_prefixes([prefix])
2582
 
        try:
2583
 
            return self._kndx_cache[prefix][0][suffix][1]
2584
 
        except KeyError:
2585
 
            raise RevisionNotPresent(key, self)
2586
 
 
2587
 
    def find_ancestry(self, keys):
2588
 
        """See CombinedGraphIndex.find_ancestry()"""
2589
 
        prefixes = set(key[:-1] for key in keys)
2590
 
        self._load_prefixes(prefixes)
2591
 
        result = {}
2592
 
        parent_map = {}
2593
 
        missing_keys = set()
2594
 
        pending_keys = list(keys)
2595
 
        # This assumes that keys will not reference parents in a different
2596
 
        # prefix, which is accurate so far.
2597
 
        while pending_keys:
2598
 
            key = pending_keys.pop()
2599
 
            if key in parent_map:
2600
 
                continue
2601
 
            prefix = key[:-1]
2602
 
            try:
2603
 
                suffix_parents = self._kndx_cache[prefix][0][key[-1]][4]
2604
 
            except KeyError:
2605
 
                missing_keys.add(key)
2606
 
            else:
2607
 
                parent_keys = tuple([prefix + (suffix,)
2608
 
                                     for suffix in suffix_parents])
2609
 
                parent_map[key] = parent_keys
2610
 
                pending_keys.extend([p for p in parent_keys
2611
 
                                        if p not in parent_map])
2612
 
        return parent_map, missing_keys
 
1733
        return self._kndx_cache[prefix][0][suffix][1]
2613
1734
 
2614
1735
    def get_parent_map(self, keys):
2615
1736
        """Get a map of the parents of keys.
2637
1758
 
2638
1759
    def get_position(self, key):
2639
1760
        """Return details needed to access the version.
2640
 
 
 
1761
        
2641
1762
        :return: a tuple (key, data position, size) to hand to the access
2642
1763
            logic to get the record.
2643
1764
        """
2646
1767
        entry = self._kndx_cache[prefix][0][suffix]
2647
1768
        return key, entry[2], entry[3]
2648
1769
 
2649
 
    has_key = _mod_index._has_key_from_parent_map
2650
 
 
2651
1770
    def _init_index(self, path, extra_lines=[]):
2652
1771
        """Initialize an index."""
2653
1772
        sio = StringIO()
2662
1781
 
2663
1782
    def keys(self):
2664
1783
        """Get all the keys in the collection.
2665
 
 
 
1784
        
2666
1785
        The keys are not ordered.
2667
1786
        """
2668
1787
        result = set()
2669
1788
        # Identify all key prefixes.
2670
1789
        # XXX: A bit hacky, needs polish.
2671
 
        if type(self._mapper) is ConstantMapper:
 
1790
        if type(self._mapper) == ConstantMapper:
2672
1791
            prefixes = [()]
2673
1792
        else:
2674
1793
            relpaths = set()
2681
1800
            for suffix in self._kndx_cache[prefix][1]:
2682
1801
                result.add(prefix + (suffix,))
2683
1802
        return result
2684
 
 
 
1803
    
2685
1804
    def _load_prefixes(self, prefixes):
2686
1805
        """Load the indices for prefixes."""
2687
1806
        self._check_read()
2706
1825
                    del self._history
2707
1826
                except NoSuchFile:
2708
1827
                    self._kndx_cache[prefix] = ({}, [])
2709
 
                    if type(self._mapper) is ConstantMapper:
 
1828
                    if type(self._mapper) == ConstantMapper:
2710
1829
                        # preserve behaviour for revisions.kndx etc.
2711
1830
                        self._init_index(path)
2712
1831
                    del self._cache
2713
1832
                    del self._filename
2714
1833
                    del self._history
2715
1834
 
2716
 
    missing_keys = _mod_index._missing_keys_from_parent_map
2717
 
 
2718
1835
    def _partition_keys(self, keys):
2719
1836
        """Turn keys into a dict of prefix:suffix_list."""
2720
1837
        result = {}
2725
1842
 
2726
1843
    def _dictionary_compress(self, keys):
2727
1844
        """Dictionary compress keys.
2728
 
 
 
1845
        
2729
1846
        :param keys: The keys to generate references to.
2730
1847
        :return: A string representation of keys. keys which are present are
2731
1848
            dictionary compressed, and others are emitted as fulltext with a
2759
1876
        else:
2760
1877
            self._mode = 'r'
2761
1878
 
2762
 
    def _sort_keys_by_io(self, keys, positions):
2763
 
        """Figure out an optimal order to read the records for the given keys.
2764
 
 
2765
 
        Sort keys, grouped by index and sorted by position.
2766
 
 
2767
 
        :param keys: A list of keys whose records we want to read. This will be
2768
 
            sorted 'in-place'.
2769
 
        :param positions: A dict, such as the one returned by
2770
 
            _get_components_positions()
2771
 
        :return: None
2772
 
        """
2773
 
        def get_sort_key(key):
2774
 
            index_memo = positions[key][1]
2775
 
            # Group by prefix and position. index_memo[0] is the key, so it is
2776
 
            # (file_id, revision_id) and we don't want to sort on revision_id,
2777
 
            # index_memo[1] is the position, and index_memo[2] is the size,
2778
 
            # which doesn't matter for the sort
2779
 
            return index_memo[0][:-1], index_memo[1]
2780
 
        return keys.sort(key=get_sort_key)
2781
 
 
2782
 
    _get_total_build_size = _get_total_build_size
2783
 
 
2784
1879
    def _split_key(self, key):
2785
1880
        """Split key into a prefix and suffix."""
2786
1881
        return key[:-1], key[-1]
2787
1882
 
2788
1883
 
2789
 
class _KeyRefs(object):
2790
 
 
2791
 
    def __init__(self, track_new_keys=False):
2792
 
        # dict mapping 'key' to 'set of keys referring to that key'
2793
 
        self.refs = {}
2794
 
        if track_new_keys:
2795
 
            # set remembering all new keys
2796
 
            self.new_keys = set()
2797
 
        else:
2798
 
            self.new_keys = None
2799
 
 
2800
 
    def clear(self):
2801
 
        if self.refs:
2802
 
            self.refs.clear()
2803
 
        if self.new_keys:
2804
 
            self.new_keys.clear()
2805
 
 
2806
 
    def add_references(self, key, refs):
2807
 
        # Record the new references
2808
 
        for referenced in refs:
2809
 
            try:
2810
 
                needed_by = self.refs[referenced]
2811
 
            except KeyError:
2812
 
                needed_by = self.refs[referenced] = set()
2813
 
            needed_by.add(key)
2814
 
        # Discard references satisfied by the new key
2815
 
        self.add_key(key)
2816
 
 
2817
 
    def get_new_keys(self):
2818
 
        return self.new_keys
2819
 
    
2820
 
    def get_unsatisfied_refs(self):
2821
 
        return self.refs.iterkeys()
2822
 
 
2823
 
    def _satisfy_refs_for_key(self, key):
2824
 
        try:
2825
 
            del self.refs[key]
2826
 
        except KeyError:
2827
 
            # No keys depended on this key.  That's ok.
2828
 
            pass
2829
 
 
2830
 
    def add_key(self, key):
2831
 
        # satisfy refs for key, and remember that we've seen this key.
2832
 
        self._satisfy_refs_for_key(key)
2833
 
        if self.new_keys is not None:
2834
 
            self.new_keys.add(key)
2835
 
 
2836
 
    def satisfy_refs_for_keys(self, keys):
2837
 
        for key in keys:
2838
 
            self._satisfy_refs_for_key(key)
2839
 
 
2840
 
    def get_referrers(self):
2841
 
        result = set()
2842
 
        for referrers in self.refs.itervalues():
2843
 
            result.update(referrers)
2844
 
        return result
2845
 
 
2846
 
 
2847
1884
class _KnitGraphIndex(object):
2848
1885
    """A KnitVersionedFiles index layered on GraphIndex."""
2849
1886
 
2850
1887
    def __init__(self, graph_index, is_locked, deltas=False, parents=True,
2851
 
        add_callback=None, track_external_parent_refs=False):
 
1888
        add_callback=None):
2852
1889
        """Construct a KnitGraphIndex on a graph_index.
2853
1890
 
2854
1891
        :param graph_index: An implementation of bzrlib.index.GraphIndex.
2855
1892
        :param is_locked: A callback to check whether the object should answer
2856
1893
            queries.
2857
1894
        :param deltas: Allow delta-compressed records.
2858
 
        :param parents: If True, record knits parents, if not do not record
 
1895
        :param parents: If True, record knits parents, if not do not record 
2859
1896
            parents.
2860
1897
        :param add_callback: If not None, allow additions to the index and call
2861
1898
            this callback with a list of added GraphIndex nodes:
2862
1899
            [(node, value, node_refs), ...]
2863
1900
        :param is_locked: A callback, returns True if the index is locked and
2864
1901
            thus usable.
2865
 
        :param track_external_parent_refs: If True, record all external parent
2866
 
            references parents from added records.  These can be retrieved
2867
 
            later by calling get_missing_parents().
2868
1902
        """
2869
1903
        self._add_callback = add_callback
2870
1904
        self._graph_index = graph_index
2877
1911
                "parent tracking.")
2878
1912
        self.has_graph = parents
2879
1913
        self._is_locked = is_locked
2880
 
        self._missing_compression_parents = set()
2881
 
        if track_external_parent_refs:
2882
 
            self._key_dependencies = _KeyRefs()
2883
 
        else:
2884
 
            self._key_dependencies = None
2885
 
 
2886
 
    def __repr__(self):
2887
 
        return "%s(%r)" % (self.__class__.__name__, self._graph_index)
2888
 
 
2889
 
    def add_records(self, records, random_id=False,
2890
 
        missing_compression_parents=False):
 
1914
 
 
1915
    def add_records(self, records, random_id=False):
2891
1916
        """Add multiple records to the index.
2892
 
 
 
1917
        
2893
1918
        This function does not insert data into the Immutable GraphIndex
2894
1919
        backing the KnitGraphIndex, instead it prepares data for insertion by
2895
1920
        the caller and checks that it is safe to insert then calls
2899
1924
                         (key, options, access_memo, parents).
2900
1925
        :param random_id: If True the ids being added were randomly generated
2901
1926
            and no check for existence will be performed.
2902
 
        :param missing_compression_parents: If True the records being added are
2903
 
            only compressed against texts already in the index (or inside
2904
 
            records). If False the records all refer to unavailable texts (or
2905
 
            texts inside records) as compression parents.
2906
1927
        """
2907
1928
        if not self._add_callback:
2908
1929
            raise errors.ReadOnlyError(self)
2910
1931
        # anymore.
2911
1932
 
2912
1933
        keys = {}
2913
 
        compression_parents = set()
2914
 
        key_dependencies = self._key_dependencies
2915
1934
        for (key, options, access_memo, parents) in records:
2916
1935
            if self._parents:
2917
1936
                parents = tuple(parents)
2918
 
                if key_dependencies is not None:
2919
 
                    key_dependencies.add_references(key, parents)
2920
1937
            index, pos, size = access_memo
2921
1938
            if 'no-eol' in options:
2922
1939
                value = 'N'
2930
1947
                if self._deltas:
2931
1948
                    if 'line-delta' in options:
2932
1949
                        node_refs = (parents, (parents[0],))
2933
 
                        if missing_compression_parents:
2934
 
                            compression_parents.add(parents[0])
2935
1950
                    else:
2936
1951
                        node_refs = (parents, ())
2937
1952
                else:
2946
1961
        if not random_id:
2947
1962
            present_nodes = self._get_entries(keys)
2948
1963
            for (index, key, value, node_refs) in present_nodes:
2949
 
                parents = node_refs[:1]
2950
 
                # Sometimes these are passed as a list rather than a tuple
2951
 
                passed = static_tuple.as_tuples(keys[key])
2952
 
                passed_parents = passed[1][:1]
2953
1964
                if (value[0] != keys[key][0][0] or
2954
 
                    parents != passed_parents):
2955
 
                    node_refs = static_tuple.as_tuples(node_refs)
 
1965
                    node_refs != keys[key][1]):
2956
1966
                    raise KnitCorrupt(self, "inconsistent details in add_records"
2957
 
                        ": %s %s" % ((value, node_refs), passed))
 
1967
                        ": %s %s" % ((value, node_refs), keys[key]))
2958
1968
                del keys[key]
2959
1969
        result = []
2960
1970
        if self._parents:
2964
1974
            for key, (value, node_refs) in keys.iteritems():
2965
1975
                result.append((key, value))
2966
1976
        self._add_callback(result)
2967
 
        if missing_compression_parents:
2968
 
            # This may appear to be incorrect (it does not check for
2969
 
            # compression parents that are in the existing graph index),
2970
 
            # but such records won't have been buffered, so this is
2971
 
            # actually correct: every entry when
2972
 
            # missing_compression_parents==True either has a missing parent, or
2973
 
            # a parent that is one of the keys in records.
2974
 
            compression_parents.difference_update(keys)
2975
 
            self._missing_compression_parents.update(compression_parents)
2976
 
        # Adding records may have satisfied missing compression parents.
2977
 
        self._missing_compression_parents.difference_update(keys)
2978
 
 
2979
 
    def scan_unvalidated_index(self, graph_index):
2980
 
        """Inform this _KnitGraphIndex that there is an unvalidated index.
2981
 
 
2982
 
        This allows this _KnitGraphIndex to keep track of any missing
2983
 
        compression parents we may want to have filled in to make those
2984
 
        indices valid.
2985
 
 
2986
 
        :param graph_index: A GraphIndex
2987
 
        """
2988
 
        if self._deltas:
2989
 
            new_missing = graph_index.external_references(ref_list_num=1)
2990
 
            new_missing.difference_update(self.get_parent_map(new_missing))
2991
 
            self._missing_compression_parents.update(new_missing)
2992
 
        if self._key_dependencies is not None:
2993
 
            # Add parent refs from graph_index (and discard parent refs that
2994
 
            # the graph_index has).
2995
 
            for node in graph_index.iter_all_entries():
2996
 
                self._key_dependencies.add_references(node[1], node[3][0])
2997
 
 
2998
 
    def get_missing_compression_parents(self):
2999
 
        """Return the keys of missing compression parents.
3000
 
 
3001
 
        Missing compression parents occur when a record stream was missing
3002
 
        basis texts, or a index was scanned that had missing basis texts.
3003
 
        """
3004
 
        return frozenset(self._missing_compression_parents)
3005
 
 
3006
 
    def get_missing_parents(self):
3007
 
        """Return the keys of missing parents."""
3008
 
        # If updating this, you should also update
3009
 
        # groupcompress._GCGraphIndex.get_missing_parents
3010
 
        # We may have false positives, so filter those out.
3011
 
        self._key_dependencies.satisfy_refs_for_keys(
3012
 
            self.get_parent_map(self._key_dependencies.get_unsatisfied_refs()))
3013
 
        return frozenset(self._key_dependencies.get_unsatisfied_refs())
3014
 
 
 
1977
        
3015
1978
    def _check_read(self):
3016
1979
        """raise if reads are not permitted."""
3017
1980
        if not self._is_locked():
3077
2040
 
3078
2041
    def _get_entries(self, keys, check_present=False):
3079
2042
        """Get the entries for keys.
3080
 
 
 
2043
        
3081
2044
        :param keys: An iterable of index key tuples.
3082
2045
        """
3083
2046
        keys = set(keys)
3125
2088
            options.append('no-eol')
3126
2089
        return options
3127
2090
 
3128
 
    def find_ancestry(self, keys):
3129
 
        """See CombinedGraphIndex.find_ancestry()"""
3130
 
        return self._graph_index.find_ancestry(keys, 0)
3131
 
 
3132
2091
    def get_parent_map(self, keys):
3133
2092
        """Get a map of the parents of keys.
3134
2093
 
3149
2108
 
3150
2109
    def get_position(self, key):
3151
2110
        """Return details needed to access the version.
3152
 
 
 
2111
        
3153
2112
        :return: a tuple (index, data position, size) to hand to the access
3154
2113
            logic to get the record.
3155
2114
        """
3156
2115
        node = self._get_node(key)
3157
2116
        return self._node_to_position(node)
3158
2117
 
3159
 
    has_key = _mod_index._has_key_from_parent_map
3160
 
 
3161
2118
    def keys(self):
3162
2119
        """Get all the keys in the collection.
3163
 
 
 
2120
        
3164
2121
        The keys are not ordered.
3165
2122
        """
3166
2123
        self._check_read()
3167
2124
        return [node[1] for node in self._graph_index.iter_all_entries()]
3168
 
 
3169
 
    missing_keys = _mod_index._missing_keys_from_parent_map
3170
 
 
 
2125
    
3171
2126
    def _node_to_position(self, node):
3172
2127
        """Convert an index value to position details."""
3173
2128
        bits = node[2][1:].split(' ')
3174
2129
        return node[0], int(bits[0]), int(bits[1])
3175
2130
 
3176
 
    def _sort_keys_by_io(self, keys, positions):
3177
 
        """Figure out an optimal order to read the records for the given keys.
3178
 
 
3179
 
        Sort keys, grouped by index and sorted by position.
3180
 
 
3181
 
        :param keys: A list of keys whose records we want to read. This will be
3182
 
            sorted 'in-place'.
3183
 
        :param positions: A dict, such as the one returned by
3184
 
            _get_components_positions()
3185
 
        :return: None
3186
 
        """
3187
 
        def get_index_memo(key):
3188
 
            # index_memo is at offset [1]. It is made up of (GraphIndex,
3189
 
            # position, size). GI is an object, which will be unique for each
3190
 
            # pack file. This causes us to group by pack file, then sort by
3191
 
            # position. Size doesn't matter, but it isn't worth breaking up the
3192
 
            # tuple.
3193
 
            return positions[key][1]
3194
 
        return keys.sort(key=get_index_memo)
3195
 
 
3196
 
    _get_total_build_size = _get_total_build_size
3197
 
 
3198
2131
 
3199
2132
class _KnitKeyAccess(object):
3200
2133
    """Access to records in .knit files."""
3221
2154
            opaque index memo. For _KnitKeyAccess the memo is (key, pos,
3222
2155
            length), where the key is the record key.
3223
2156
        """
3224
 
        if type(raw_data) is not str:
 
2157
        if type(raw_data) != str:
3225
2158
            raise AssertionError(
3226
2159
                'data must be plain bytes was %s' % type(raw_data))
3227
2160
        result = []
3244
2177
            result.append((key, base, size))
3245
2178
        return result
3246
2179
 
3247
 
    def flush(self):
3248
 
        """Flush pending writes on this access object.
3249
 
        
3250
 
        For .knit files this is a no-op.
3251
 
        """
3252
 
        pass
3253
 
 
3254
2180
    def get_raw_records(self, memos_for_retrieval):
3255
2181
        """Get the raw bytes for a records.
3256
2182
 
3281
2207
class _DirectPackAccess(object):
3282
2208
    """Access to data in one or more packs with less translation."""
3283
2209
 
3284
 
    def __init__(self, index_to_packs, reload_func=None, flush_func=None):
 
2210
    def __init__(self, index_to_packs):
3285
2211
        """Create a _DirectPackAccess object.
3286
2212
 
3287
2213
        :param index_to_packs: A dict mapping index objects to the transport
3288
2214
            and file names for obtaining data.
3289
 
        :param reload_func: A function to call if we determine that the pack
3290
 
            files have moved and we need to reload our caches. See
3291
 
            bzrlib.repo_fmt.pack_repo.AggregateIndex for more details.
3292
2215
        """
3293
2216
        self._container_writer = None
3294
2217
        self._write_index = None
3295
2218
        self._indices = index_to_packs
3296
 
        self._reload_func = reload_func
3297
 
        self._flush_func = flush_func
3298
2219
 
3299
2220
    def add_raw_records(self, key_sizes, raw_data):
3300
2221
        """Add raw knit bytes to a storage area.
3310
2231
            length), where the index field is the write_index object supplied
3311
2232
            to the PackAccess object.
3312
2233
        """
3313
 
        if type(raw_data) is not str:
 
2234
        if type(raw_data) != str:
3314
2235
            raise AssertionError(
3315
2236
                'data must be plain bytes was %s' % type(raw_data))
3316
2237
        result = []
3322
2243
            result.append((self._write_index, p_offset, p_length))
3323
2244
        return result
3324
2245
 
3325
 
    def flush(self):
3326
 
        """Flush pending writes on this access object.
3327
 
 
3328
 
        This will flush any buffered writes to a NewPack.
3329
 
        """
3330
 
        if self._flush_func is not None:
3331
 
            self._flush_func()
3332
 
            
3333
2246
    def get_raw_records(self, memos_for_retrieval):
3334
2247
        """Get the raw bytes for a records.
3335
2248
 
3336
 
        :param memos_for_retrieval: An iterable containing the (index, pos,
 
2249
        :param memos_for_retrieval: An iterable containing the (index, pos, 
3337
2250
            length) memo for retrieving the bytes. The Pack access method
3338
2251
            looks up the pack to use for a given record in its index_to_pack
3339
2252
            map.
3354
2267
        if current_index is not None:
3355
2268
            request_lists.append((current_index, current_list))
3356
2269
        for index, offsets in request_lists:
3357
 
            try:
3358
 
                transport, path = self._indices[index]
3359
 
            except KeyError:
3360
 
                # A KeyError here indicates that someone has triggered an index
3361
 
                # reload, and this index has gone missing, we need to start
3362
 
                # over.
3363
 
                if self._reload_func is None:
3364
 
                    # If we don't have a _reload_func there is nothing that can
3365
 
                    # be done
3366
 
                    raise
3367
 
                raise errors.RetryWithNewPacks(index,
3368
 
                                               reload_occurred=True,
3369
 
                                               exc_info=sys.exc_info())
3370
 
            try:
3371
 
                reader = pack.make_readv_reader(transport, path, offsets)
3372
 
                for names, read_func in reader.iter_records():
3373
 
                    yield read_func(None)
3374
 
            except errors.NoSuchFile:
3375
 
                # A NoSuchFile error indicates that a pack file has gone
3376
 
                # missing on disk, we need to trigger a reload, and start over.
3377
 
                if self._reload_func is None:
3378
 
                    raise
3379
 
                raise errors.RetryWithNewPacks(transport.abspath(path),
3380
 
                                               reload_occurred=False,
3381
 
                                               exc_info=sys.exc_info())
 
2270
            transport, path = self._indices[index]
 
2271
            reader = pack.make_readv_reader(transport, path, offsets)
 
2272
            for names, read_func in reader.iter_records():
 
2273
                yield read_func(None)
3382
2274
 
3383
2275
    def set_writer(self, writer, index, transport_packname):
3384
2276
        """Set a writer to use for adding data."""
3387
2279
        self._container_writer = writer
3388
2280
        self._write_index = index
3389
2281
 
3390
 
    def reload_or_raise(self, retry_exc):
3391
 
        """Try calling the reload function, or re-raise the original exception.
3392
 
 
3393
 
        This should be called after _DirectPackAccess raises a
3394
 
        RetryWithNewPacks exception. This function will handle the common logic
3395
 
        of determining when the error is fatal versus being temporary.
3396
 
        It will also make sure that the original exception is raised, rather
3397
 
        than the RetryWithNewPacks exception.
3398
 
 
3399
 
        If this function returns, then the calling function should retry
3400
 
        whatever operation was being performed. Otherwise an exception will
3401
 
        be raised.
3402
 
 
3403
 
        :param retry_exc: A RetryWithNewPacks exception.
3404
 
        """
3405
 
        is_error = False
3406
 
        if self._reload_func is None:
3407
 
            is_error = True
3408
 
        elif not self._reload_func():
3409
 
            # The reload claimed that nothing changed
3410
 
            if not retry_exc.reload_occurred:
3411
 
                # If there wasn't an earlier reload, then we really were
3412
 
                # expecting to find changes. We didn't find them, so this is a
3413
 
                # hard error
3414
 
                is_error = True
3415
 
        if is_error:
3416
 
            exc_class, exc_value, exc_traceback = retry_exc.exc_info
3417
 
            raise exc_class, exc_value, exc_traceback
3418
 
 
3419
2282
 
3420
2283
# Deprecated, use PatienceSequenceMatcher instead
3421
2284
KnitSequenceMatcher = patiencediff.PatienceSequenceMatcher
3429
2292
    recommended.
3430
2293
    """
3431
2294
    annotator = _KnitAnnotator(knit)
3432
 
    return iter(annotator.annotate_flat(revision_id))
3433
 
 
3434
 
 
3435
 
class _KnitAnnotator(annotate.Annotator):
 
2295
    return iter(annotator.annotate(revision_id))
 
2296
 
 
2297
 
 
2298
class _KnitAnnotator(object):
3436
2299
    """Build up the annotations for a text."""
3437
2300
 
3438
 
    def __init__(self, vf):
3439
 
        annotate.Annotator.__init__(self, vf)
3440
 
 
3441
 
        # TODO: handle Nodes which cannot be extracted
3442
 
        # self._ghosts = set()
3443
 
 
3444
 
        # Map from (key, parent_key) => matching_blocks, should be 'use once'
3445
 
        self._matching_blocks = {}
3446
 
 
3447
 
        # KnitContent objects
3448
 
        self._content_objects = {}
3449
 
        # The number of children that depend on this fulltext content object
3450
 
        self._num_compression_children = {}
3451
 
        # Delta records that need their compression parent before they can be
3452
 
        # expanded
3453
 
        self._pending_deltas = {}
3454
 
        # Fulltext records that are waiting for their parents fulltexts before
3455
 
        # they can be yielded for annotation
3456
 
        self._pending_annotation = {}
 
2301
    def __init__(self, knit):
 
2302
        self._knit = knit
 
2303
 
 
2304
        # Content objects, differs from fulltexts because of how final newlines
 
2305
        # are treated by knits. the content objects here will always have a
 
2306
        # final newline
 
2307
        self._fulltext_contents = {}
 
2308
 
 
2309
        # Annotated lines of specific revisions
 
2310
        self._annotated_lines = {}
 
2311
 
 
2312
        # Track the raw data for nodes that we could not process yet.
 
2313
        # This maps the revision_id of the base to a list of children that will
 
2314
        # annotated from it.
 
2315
        self._pending_children = {}
 
2316
 
 
2317
        # Nodes which cannot be extracted
 
2318
        self._ghosts = set()
 
2319
 
 
2320
        # Track how many children this node has, so we know if we need to keep
 
2321
        # it
 
2322
        self._annotate_children = {}
 
2323
        self._compression_children = {}
3457
2324
 
3458
2325
        self._all_build_details = {}
 
2326
        # The children => parent revision_id graph
 
2327
        self._revision_id_graph = {}
 
2328
 
 
2329
        self._heads_provider = None
 
2330
 
 
2331
        self._nodes_to_keep_annotations = set()
 
2332
        self._generations_until_keep = 100
 
2333
 
 
2334
    def set_generations_until_keep(self, value):
 
2335
        """Set the number of generations before caching a node.
 
2336
 
 
2337
        Setting this to -1 will cache every merge node, setting this higher
 
2338
        will cache fewer nodes.
 
2339
        """
 
2340
        self._generations_until_keep = value
 
2341
 
 
2342
    def _add_fulltext_content(self, revision_id, content_obj):
 
2343
        self._fulltext_contents[revision_id] = content_obj
 
2344
        # TODO: jam 20080305 It might be good to check the sha1digest here
 
2345
        return content_obj.text()
 
2346
 
 
2347
    def _check_parents(self, child, nodes_to_annotate):
 
2348
        """Check if all parents have been processed.
 
2349
 
 
2350
        :param child: A tuple of (rev_id, parents, raw_content)
 
2351
        :param nodes_to_annotate: If child is ready, add it to
 
2352
            nodes_to_annotate, otherwise put it back in self._pending_children
 
2353
        """
 
2354
        for parent_id in child[1]:
 
2355
            if (parent_id not in self._annotated_lines):
 
2356
                # This parent is present, but another parent is missing
 
2357
                self._pending_children.setdefault(parent_id,
 
2358
                                                  []).append(child)
 
2359
                break
 
2360
        else:
 
2361
            # This one is ready to be processed
 
2362
            nodes_to_annotate.append(child)
 
2363
 
 
2364
    def _add_annotation(self, revision_id, fulltext, parent_ids,
 
2365
                        left_matching_blocks=None):
 
2366
        """Add an annotation entry.
 
2367
 
 
2368
        All parents should already have been annotated.
 
2369
        :return: A list of children that now have their parents satisfied.
 
2370
        """
 
2371
        a = self._annotated_lines
 
2372
        annotated_parent_lines = [a[p] for p in parent_ids]
 
2373
        annotated_lines = list(annotate.reannotate(annotated_parent_lines,
 
2374
            fulltext, revision_id, left_matching_blocks,
 
2375
            heads_provider=self._get_heads_provider()))
 
2376
        self._annotated_lines[revision_id] = annotated_lines
 
2377
        for p in parent_ids:
 
2378
            ann_children = self._annotate_children[p]
 
2379
            ann_children.remove(revision_id)
 
2380
            if (not ann_children
 
2381
                and p not in self._nodes_to_keep_annotations):
 
2382
                del self._annotated_lines[p]
 
2383
                del self._all_build_details[p]
 
2384
                if p in self._fulltext_contents:
 
2385
                    del self._fulltext_contents[p]
 
2386
        # Now that we've added this one, see if there are any pending
 
2387
        # deltas to be done, certainly this parent is finished
 
2388
        nodes_to_annotate = []
 
2389
        for child in self._pending_children.pop(revision_id, []):
 
2390
            self._check_parents(child, nodes_to_annotate)
 
2391
        return nodes_to_annotate
3459
2392
 
3460
2393
    def _get_build_graph(self, key):
3461
2394
        """Get the graphs for building texts and annotations.
3466
2399
        fulltext.)
3467
2400
 
3468
2401
        :return: A list of (key, index_memo) records, suitable for
3469
 
            passing to read_records_iter to start reading in the raw data from
 
2402
            passing to read_records_iter to start reading in the raw data fro/
3470
2403
            the pack file.
3471
2404
        """
 
2405
        if key in self._annotated_lines:
 
2406
            # Nothing to do
 
2407
            return []
3472
2408
        pending = set([key])
3473
2409
        records = []
3474
 
        ann_keys = set()
3475
 
        self._num_needed_children[key] = 1
 
2410
        generation = 0
 
2411
        kept_generation = 0
3476
2412
        while pending:
3477
2413
            # get all pending nodes
 
2414
            generation += 1
3478
2415
            this_iteration = pending
3479
 
            build_details = self._vf._index.get_build_details(this_iteration)
 
2416
            build_details = self._knit._index.get_build_details(this_iteration)
3480
2417
            self._all_build_details.update(build_details)
3481
 
            # new_nodes = self._vf._index._get_entries(this_iteration)
 
2418
            # new_nodes = self._knit._index._get_entries(this_iteration)
3482
2419
            pending = set()
3483
2420
            for key, details in build_details.iteritems():
3484
 
                (index_memo, compression_parent, parent_keys,
 
2421
                (index_memo, compression_parent, parents,
3485
2422
                 record_details) = details
3486
 
                self._parent_map[key] = parent_keys
3487
 
                self._heads_provider = None
 
2423
                self._revision_id_graph[key] = parents
3488
2424
                records.append((key, index_memo))
3489
2425
                # Do we actually need to check _annotated_lines?
3490
 
                pending.update([p for p in parent_keys
3491
 
                                   if p not in self._all_build_details])
3492
 
                if parent_keys:
3493
 
                    for parent_key in parent_keys:
3494
 
                        if parent_key in self._num_needed_children:
3495
 
                            self._num_needed_children[parent_key] += 1
3496
 
                        else:
3497
 
                            self._num_needed_children[parent_key] = 1
 
2426
                pending.update(p for p in parents
 
2427
                                 if p not in self._all_build_details)
3498
2428
                if compression_parent:
3499
 
                    if compression_parent in self._num_compression_children:
3500
 
                        self._num_compression_children[compression_parent] += 1
3501
 
                    else:
3502
 
                        self._num_compression_children[compression_parent] = 1
 
2429
                    self._compression_children.setdefault(compression_parent,
 
2430
                        []).append(key)
 
2431
                if parents:
 
2432
                    for parent in parents:
 
2433
                        self._annotate_children.setdefault(parent,
 
2434
                            []).append(key)
 
2435
                    num_gens = generation - kept_generation
 
2436
                    if ((num_gens >= self._generations_until_keep)
 
2437
                        and len(parents) > 1):
 
2438
                        kept_generation = generation
 
2439
                        self._nodes_to_keep_annotations.add(key)
3503
2440
 
3504
2441
            missing_versions = this_iteration.difference(build_details.keys())
3505
 
            if missing_versions:
3506
 
                for key in missing_versions:
3507
 
                    if key in self._parent_map and key in self._text_cache:
3508
 
                        # We already have this text ready, we just need to
3509
 
                        # yield it later so we get it annotated
3510
 
                        ann_keys.add(key)
3511
 
                        parent_keys = self._parent_map[key]
3512
 
                        for parent_key in parent_keys:
3513
 
                            if parent_key in self._num_needed_children:
3514
 
                                self._num_needed_children[parent_key] += 1
3515
 
                            else:
3516
 
                                self._num_needed_children[parent_key] = 1
3517
 
                        pending.update([p for p in parent_keys
3518
 
                                           if p not in self._all_build_details])
3519
 
                    else:
3520
 
                        raise errors.RevisionNotPresent(key, self._vf)
 
2442
            self._ghosts.update(missing_versions)
 
2443
            for missing_version in missing_versions:
 
2444
                # add a key, no parents
 
2445
                self._revision_id_graph[missing_version] = ()
 
2446
                pending.discard(missing_version) # don't look for it
 
2447
        if self._ghosts.intersection(self._compression_children):
 
2448
            raise KnitCorrupt(
 
2449
                "We cannot have nodes which have a ghost compression parent:\n"
 
2450
                "ghosts: %r\n"
 
2451
                "compression children: %r"
 
2452
                % (self._ghosts, self._compression_children))
 
2453
        # Cleanout anything that depends on a ghost so that we don't wait for
 
2454
        # the ghost to show up
 
2455
        for node in self._ghosts:
 
2456
            if node in self._annotate_children:
 
2457
                # We won't be building this node
 
2458
                del self._annotate_children[node]
3521
2459
        # Generally we will want to read the records in reverse order, because
3522
2460
        # we find the parent nodes after the children
3523
2461
        records.reverse()
3524
 
        return records, ann_keys
3525
 
 
3526
 
    def _get_needed_texts(self, key, pb=None):
3527
 
        # if True or len(self._vf._fallback_vfs) > 0:
3528
 
        if len(self._vf._fallback_vfs) > 0:
3529
 
            # If we have fallbacks, go to the generic path
3530
 
            for v in annotate.Annotator._get_needed_texts(self, key, pb=pb):
3531
 
                yield v
3532
 
            return
3533
 
        while True:
3534
 
            try:
3535
 
                records, ann_keys = self._get_build_graph(key)
3536
 
                for idx, (sub_key, text, num_lines) in enumerate(
3537
 
                                                self._extract_texts(records)):
3538
 
                    if pb is not None:
3539
 
                        pb.update('annotating', idx, len(records))
3540
 
                    yield sub_key, text, num_lines
3541
 
                for sub_key in ann_keys:
3542
 
                    text = self._text_cache[sub_key]
3543
 
                    num_lines = len(text) # bad assumption
3544
 
                    yield sub_key, text, num_lines
3545
 
                return
3546
 
            except errors.RetryWithNewPacks, e:
3547
 
                self._vf._access.reload_or_raise(e)
3548
 
                # The cached build_details are no longer valid
3549
 
                self._all_build_details.clear()
3550
 
 
3551
 
    def _cache_delta_blocks(self, key, compression_parent, delta, lines):
3552
 
        parent_lines = self._text_cache[compression_parent]
3553
 
        blocks = list(KnitContent.get_line_delta_blocks(delta, parent_lines, lines))
3554
 
        self._matching_blocks[(key, compression_parent)] = blocks
3555
 
 
3556
 
    def _expand_record(self, key, parent_keys, compression_parent, record,
3557
 
                       record_details):
3558
 
        delta = None
3559
 
        if compression_parent:
3560
 
            if compression_parent not in self._content_objects:
3561
 
                # Waiting for the parent
3562
 
                self._pending_deltas.setdefault(compression_parent, []).append(
3563
 
                    (key, parent_keys, record, record_details))
3564
 
                return None
3565
 
            # We have the basis parent, so expand the delta
3566
 
            num = self._num_compression_children[compression_parent]
3567
 
            num -= 1
3568
 
            if num == 0:
3569
 
                base_content = self._content_objects.pop(compression_parent)
3570
 
                self._num_compression_children.pop(compression_parent)
3571
 
            else:
3572
 
                self._num_compression_children[compression_parent] = num
3573
 
                base_content = self._content_objects[compression_parent]
3574
 
            # It is tempting to want to copy_base_content=False for the last
3575
 
            # child object. However, whenever noeol=False,
3576
 
            # self._text_cache[parent_key] is content._lines. So mutating it
3577
 
            # gives very bad results.
3578
 
            # The alternative is to copy the lines into text cache, but then we
3579
 
            # are copying anyway, so just do it here.
3580
 
            content, delta = self._vf._factory.parse_record(
3581
 
                key, record, record_details, base_content,
3582
 
                copy_base_content=True)
3583
 
        else:
3584
 
            # Fulltext record
3585
 
            content, _ = self._vf._factory.parse_record(
3586
 
                key, record, record_details, None)
3587
 
        if self._num_compression_children.get(key, 0) > 0:
3588
 
            self._content_objects[key] = content
3589
 
        lines = content.text()
3590
 
        self._text_cache[key] = lines
3591
 
        if delta is not None:
3592
 
            self._cache_delta_blocks(key, compression_parent, delta, lines)
3593
 
        return lines
3594
 
 
3595
 
    def _get_parent_annotations_and_matches(self, key, text, parent_key):
3596
 
        """Get the list of annotations for the parent, and the matching lines.
3597
 
 
3598
 
        :param text: The opaque value given by _get_needed_texts
3599
 
        :param parent_key: The key for the parent text
3600
 
        :return: (parent_annotations, matching_blocks)
3601
 
            parent_annotations is a list as long as the number of lines in
3602
 
                parent
3603
 
            matching_blocks is a list of (parent_idx, text_idx, len) tuples
3604
 
                indicating which lines match between the two texts
3605
 
        """
3606
 
        block_key = (key, parent_key)
3607
 
        if block_key in self._matching_blocks:
3608
 
            blocks = self._matching_blocks.pop(block_key)
3609
 
            parent_annotations = self._annotations_cache[parent_key]
3610
 
            return parent_annotations, blocks
3611
 
        return annotate.Annotator._get_parent_annotations_and_matches(self,
3612
 
            key, text, parent_key)
3613
 
 
3614
 
    def _process_pending(self, key):
3615
 
        """The content for 'key' was just processed.
3616
 
 
3617
 
        Determine if there is any more pending work to be processed.
3618
 
        """
3619
 
        to_return = []
3620
 
        if key in self._pending_deltas:
3621
 
            compression_parent = key
3622
 
            children = self._pending_deltas.pop(key)
3623
 
            for child_key, parent_keys, record, record_details in children:
3624
 
                lines = self._expand_record(child_key, parent_keys,
3625
 
                                            compression_parent,
3626
 
                                            record, record_details)
3627
 
                if self._check_ready_for_annotations(child_key, parent_keys):
3628
 
                    to_return.append(child_key)
3629
 
        # Also check any children that are waiting for this parent to be
3630
 
        # annotation ready
3631
 
        if key in self._pending_annotation:
3632
 
            children = self._pending_annotation.pop(key)
3633
 
            to_return.extend([c for c, p_keys in children
3634
 
                              if self._check_ready_for_annotations(c, p_keys)])
3635
 
        return to_return
3636
 
 
3637
 
    def _check_ready_for_annotations(self, key, parent_keys):
3638
 
        """return true if this text is ready to be yielded.
3639
 
 
3640
 
        Otherwise, this will return False, and queue the text into
3641
 
        self._pending_annotation
3642
 
        """
3643
 
        for parent_key in parent_keys:
3644
 
            if parent_key not in self._annotations_cache:
3645
 
                # still waiting on at least one parent text, so queue it up
3646
 
                # Note that if there are multiple parents, we need to wait
3647
 
                # for all of them.
3648
 
                self._pending_annotation.setdefault(parent_key,
3649
 
                    []).append((key, parent_keys))
3650
 
                return False
3651
 
        return True
3652
 
 
3653
 
    def _extract_texts(self, records):
3654
 
        """Extract the various texts needed based on records"""
 
2462
        return records
 
2463
 
 
2464
    def _annotate_records(self, records):
 
2465
        """Build the annotations for the listed records."""
3655
2466
        # We iterate in the order read, rather than a strict order requested
3656
2467
        # However, process what we can, and put off to the side things that
3657
2468
        # still need parents, cleaning them up when those parents are
3658
2469
        # processed.
3659
 
        # Basic data flow:
3660
 
        #   1) As 'records' are read, see if we can expand these records into
3661
 
        #      Content objects (and thus lines)
3662
 
        #   2) If a given line-delta is waiting on its compression parent, it
3663
 
        #      gets queued up into self._pending_deltas, otherwise we expand
3664
 
        #      it, and put it into self._text_cache and self._content_objects
3665
 
        #   3) If we expanded the text, we will then check to see if all
3666
 
        #      parents have also been processed. If so, this text gets yielded,
3667
 
        #      else this record gets set aside into pending_annotation
3668
 
        #   4) Further, if we expanded the text in (2), we will then check to
3669
 
        #      see if there are any children in self._pending_deltas waiting to
3670
 
        #      also be processed. If so, we go back to (2) for those
3671
 
        #   5) Further again, if we yielded the text, we can then check if that
3672
 
        #      'unlocks' any of the texts in pending_annotations, which should
3673
 
        #      then get yielded as well
3674
 
        # Note that both steps 4 and 5 are 'recursive' in that unlocking one
3675
 
        # compression child could unlock yet another, and yielding a fulltext
3676
 
        # will also 'unlock' the children that are waiting on that annotation.
3677
 
        # (Though also, unlocking 1 parent's fulltext, does not unlock a child
3678
 
        # if other parents are also waiting.)
3679
 
        # We want to yield content before expanding child content objects, so
3680
 
        # that we know when we can re-use the content lines, and the annotation
3681
 
        # code can know when it can stop caching fulltexts, as well.
3682
 
 
3683
 
        # Children that are missing their compression parent
3684
 
        pending_deltas = {}
3685
 
        for (key, record, digest) in self._vf._read_records_iter(records):
3686
 
            # ghosts?
3687
 
            details = self._all_build_details[key]
3688
 
            (_, compression_parent, parent_keys, record_details) = details
3689
 
            lines = self._expand_record(key, parent_keys, compression_parent,
3690
 
                                        record, record_details)
3691
 
            if lines is None:
3692
 
                # Pending delta should be queued up
 
2470
        for (rev_id, record,
 
2471
             digest) in self._knit._read_records_iter(records):
 
2472
            if rev_id in self._annotated_lines:
3693
2473
                continue
3694
 
            # At this point, we may be able to yield this content, if all
3695
 
            # parents are also finished
3696
 
            yield_this_text = self._check_ready_for_annotations(key,
3697
 
                                                                parent_keys)
3698
 
            if yield_this_text:
3699
 
                # All parents present
3700
 
                yield key, lines, len(lines)
3701
 
            to_process = self._process_pending(key)
3702
 
            while to_process:
3703
 
                this_process = to_process
3704
 
                to_process = []
3705
 
                for key in this_process:
3706
 
                    lines = self._text_cache[key]
3707
 
                    yield key, lines, len(lines)
3708
 
                    to_process.extend(self._process_pending(key))
 
2474
            parent_ids = self._revision_id_graph[rev_id]
 
2475
            parent_ids = [p for p in parent_ids if p not in self._ghosts]
 
2476
            details = self._all_build_details[rev_id]
 
2477
            (index_memo, compression_parent, parents,
 
2478
             record_details) = details
 
2479
            nodes_to_annotate = []
 
2480
            # TODO: Remove the punning between compression parents, and
 
2481
            #       parent_ids, we should be able to do this without assuming
 
2482
            #       the build order
 
2483
            if len(parent_ids) == 0:
 
2484
                # There are no parents for this node, so just add it
 
2485
                # TODO: This probably needs to be decoupled
 
2486
                fulltext_content, delta = self._knit._factory.parse_record(
 
2487
                    rev_id, record, record_details, None)
 
2488
                fulltext = self._add_fulltext_content(rev_id, fulltext_content)
 
2489
                nodes_to_annotate.extend(self._add_annotation(rev_id, fulltext,
 
2490
                    parent_ids, left_matching_blocks=None))
 
2491
            else:
 
2492
                child = (rev_id, parent_ids, record)
 
2493
                # Check if all the parents are present
 
2494
                self._check_parents(child, nodes_to_annotate)
 
2495
            while nodes_to_annotate:
 
2496
                # Should we use a queue here instead of a stack?
 
2497
                (rev_id, parent_ids, record) = nodes_to_annotate.pop()
 
2498
                (index_memo, compression_parent, parents,
 
2499
                 record_details) = self._all_build_details[rev_id]
 
2500
                if compression_parent is not None:
 
2501
                    comp_children = self._compression_children[compression_parent]
 
2502
                    if rev_id not in comp_children:
 
2503
                        raise AssertionError("%r not in compression children %r"
 
2504
                            % (rev_id, comp_children))
 
2505
                    # If there is only 1 child, it is safe to reuse this
 
2506
                    # content
 
2507
                    reuse_content = (len(comp_children) == 1
 
2508
                        and compression_parent not in
 
2509
                            self._nodes_to_keep_annotations)
 
2510
                    if reuse_content:
 
2511
                        # Remove it from the cache since it will be changing
 
2512
                        parent_fulltext_content = self._fulltext_contents.pop(compression_parent)
 
2513
                        # Make sure to copy the fulltext since it might be
 
2514
                        # modified
 
2515
                        parent_fulltext = list(parent_fulltext_content.text())
 
2516
                    else:
 
2517
                        parent_fulltext_content = self._fulltext_contents[compression_parent]
 
2518
                        parent_fulltext = parent_fulltext_content.text()
 
2519
                    comp_children.remove(rev_id)
 
2520
                    fulltext_content, delta = self._knit._factory.parse_record(
 
2521
                        rev_id, record, record_details,
 
2522
                        parent_fulltext_content,
 
2523
                        copy_base_content=(not reuse_content))
 
2524
                    fulltext = self._add_fulltext_content(rev_id,
 
2525
                                                          fulltext_content)
 
2526
                    blocks = KnitContent.get_line_delta_blocks(delta,
 
2527
                            parent_fulltext, fulltext)
 
2528
                else:
 
2529
                    fulltext_content = self._knit._factory.parse_fulltext(
 
2530
                        record, rev_id)
 
2531
                    fulltext = self._add_fulltext_content(rev_id,
 
2532
                        fulltext_content)
 
2533
                    blocks = None
 
2534
                nodes_to_annotate.extend(
 
2535
                    self._add_annotation(rev_id, fulltext, parent_ids,
 
2536
                                     left_matching_blocks=blocks))
 
2537
 
 
2538
    def _get_heads_provider(self):
 
2539
        """Create a heads provider for resolving ancestry issues."""
 
2540
        if self._heads_provider is not None:
 
2541
            return self._heads_provider
 
2542
        parent_provider = _mod_graph.DictParentsProvider(
 
2543
            self._revision_id_graph)
 
2544
        graph_obj = _mod_graph.Graph(parent_provider)
 
2545
        head_cache = _mod_graph.FrozenHeadsCache(graph_obj)
 
2546
        self._heads_provider = head_cache
 
2547
        return head_cache
 
2548
 
 
2549
    def annotate(self, key):
 
2550
        """Return the annotated fulltext at the given key.
 
2551
 
 
2552
        :param key: The key to annotate.
 
2553
        """
 
2554
        records = self._get_build_graph(key)
 
2555
        if key in self._ghosts:
 
2556
            raise errors.RevisionNotPresent(key, self._knit)
 
2557
        self._annotate_records(records)
 
2558
        return self._annotated_lines[key]
 
2559
 
3709
2560
 
3710
2561
try:
3711
 
    from bzrlib._knit_load_data_pyx import _load_data_c as _load_data
3712
 
except ImportError, e:
3713
 
    osutils.failed_to_load_extension(e)
 
2562
    from bzrlib._knit_load_data_c import _load_data_c as _load_data
 
2563
except ImportError:
3714
2564
    from bzrlib._knit_load_data_py import _load_data_py as _load_data