/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/bzr/knit.py

  • Committer: Breezy landing bot
  • Author(s): Jelmer Vernooij
  • Date: 2020-01-30 17:30:52 UTC
  • mfrom: (7464.3.2 drop-roundtripping)
  • Revision ID: breezy.the.bot@gmail.com-20200130173052-fedd479i21ci93dr
Drop more roundtripping support in Git.

Merged from https://code.launchpad.net/~jelmer/brz/drop-roundtripping/+merge/378336

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006-2011 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
51
51
 
52
52
"""
53
53
 
 
54
from __future__ import absolute_import
54
55
 
55
 
from cStringIO import StringIO
56
 
from itertools import izip
57
56
import operator
58
57
import os
59
 
import sys
60
58
 
61
 
from bzrlib.lazy_import import lazy_import
 
59
from ..lazy_import import lazy_import
62
60
lazy_import(globals(), """
63
 
from bzrlib import (
64
 
    annotate,
 
61
import patiencediff
 
62
import gzip
 
63
 
 
64
from breezy import (
65
65
    debug,
66
66
    diff,
67
 
    graph as _mod_graph,
68
 
    index as _mod_index,
69
 
    lru_cache,
70
 
    pack,
71
 
    progress,
72
67
    static_tuple,
73
68
    trace,
74
69
    tsort,
75
70
    tuned_gzip,
76
71
    ui,
77
72
    )
 
73
from breezy.bzr import (
 
74
    index as _mod_index,
 
75
    pack,
 
76
    )
 
77
 
 
78
from breezy.bzr import pack_repo
 
79
from breezy.i18n import gettext
78
80
""")
79
 
from bzrlib import (
 
81
from .. import (
 
82
    annotate,
80
83
    errors,
81
84
    osutils,
82
 
    patiencediff,
83
85
    )
84
 
from bzrlib.errors import (
85
 
    FileExists,
 
86
from ..errors import (
 
87
    InternalBzrError,
 
88
    InvalidRevisionId,
86
89
    NoSuchFile,
87
 
    KnitError,
88
 
    InvalidRevisionId,
89
 
    KnitCorrupt,
90
 
    KnitHeaderError,
91
90
    RevisionNotPresent,
92
 
    RevisionAlreadyPresent,
93
 
    SHA1KnitCorrupt,
94
91
    )
95
 
from bzrlib.osutils import (
 
92
from ..osutils import (
96
93
    contains_whitespace,
97
 
    contains_linebreaks,
98
94
    sha_string,
99
95
    sha_strings,
100
96
    split_lines,
101
97
    )
102
 
from bzrlib.versionedfile import (
 
98
from ..sixish import (
 
99
    BytesIO,
 
100
    range,
 
101
    viewitems,
 
102
    viewvalues,
 
103
    )
 
104
from ..bzr.versionedfile import (
 
105
    _KeyRefs,
103
106
    AbsentContentFactory,
104
107
    adapter_registry,
105
108
    ConstantMapper,
106
109
    ContentFactory,
107
 
    ChunkedContentFactory,
108
110
    sort_groupcompress,
109
 
    VersionedFile,
110
 
    VersionedFiles,
 
111
    VersionedFilesWithFallbacks,
111
112
    )
112
113
 
113
114
 
126
127
 
127
128
DATA_SUFFIX = '.knit'
128
129
INDEX_SUFFIX = '.kndx'
129
 
_STREAM_MIN_BUFFER_SIZE = 5*1024*1024
 
130
_STREAM_MIN_BUFFER_SIZE = 5 * 1024 * 1024
 
131
 
 
132
 
 
133
class KnitError(InternalBzrError):
 
134
 
 
135
    _fmt = "Knit error"
 
136
 
 
137
 
 
138
class KnitCorrupt(KnitError):
 
139
 
 
140
    _fmt = "Knit %(filename)s corrupt: %(how)s"
 
141
 
 
142
    def __init__(self, filename, how):
 
143
        KnitError.__init__(self)
 
144
        self.filename = filename
 
145
        self.how = how
 
146
 
 
147
 
 
148
class SHA1KnitCorrupt(KnitCorrupt):
 
149
 
 
150
    _fmt = ("Knit %(filename)s corrupt: sha-1 of reconstructed text does not "
 
151
            "match expected sha-1. key %(key)s expected sha %(expected)s actual "
 
152
            "sha %(actual)s")
 
153
 
 
154
    def __init__(self, filename, actual, expected, key, content):
 
155
        KnitError.__init__(self)
 
156
        self.filename = filename
 
157
        self.actual = actual
 
158
        self.expected = expected
 
159
        self.key = key
 
160
        self.content = content
 
161
 
 
162
 
 
163
class KnitDataStreamIncompatible(KnitError):
 
164
    # Not raised anymore, as we can convert data streams.  In future we may
 
165
    # need it again for more exotic cases, so we're keeping it around for now.
 
166
 
 
167
    _fmt = "Cannot insert knit data stream of format \"%(stream_format)s\" into knit of format \"%(target_format)s\"."
 
168
 
 
169
    def __init__(self, stream_format, target_format):
 
170
        self.stream_format = stream_format
 
171
        self.target_format = target_format
 
172
 
 
173
 
 
174
class KnitDataStreamUnknown(KnitError):
 
175
    # Indicates a data stream we don't know how to handle.
 
176
 
 
177
    _fmt = "Cannot parse knit data stream of format \"%(stream_format)s\"."
 
178
 
 
179
    def __init__(self, stream_format):
 
180
        self.stream_format = stream_format
 
181
 
 
182
 
 
183
class KnitHeaderError(KnitError):
 
184
 
 
185
    _fmt = 'Knit header error: %(badline)r unexpected for file "%(filename)s".'
 
186
 
 
187
    def __init__(self, badline, filename):
 
188
        KnitError.__init__(self)
 
189
        self.badline = badline
 
190
        self.filename = filename
 
191
 
 
192
 
 
193
class KnitIndexUnknownMethod(KnitError):
 
194
    """Raised when we don't understand the storage method.
 
195
 
 
196
    Currently only 'fulltext' and 'line-delta' are supported.
 
197
    """
 
198
 
 
199
    _fmt = ("Knit index %(filename)s does not have a known method"
 
200
            " in options: %(options)r")
 
201
 
 
202
    def __init__(self, filename, options):
 
203
        KnitError.__init__(self)
 
204
        self.filename = filename
 
205
        self.options = options
130
206
 
131
207
 
132
208
class KnitAdapter(object):
147
223
class FTAnnotatedToUnannotated(KnitAdapter):
148
224
    """An adapter from FT annotated knits to unannotated ones."""
149
225
 
150
 
    def get_bytes(self, factory):
 
226
    def get_bytes(self, factory, target_storage_kind):
 
227
        if target_storage_kind != 'knit-ft-gz':
 
228
            raise errors.UnavailableRepresentation(
 
229
                factory.key, target_storage_kind, factory.storage_kind)
151
230
        annotated_compressed_bytes = factory._raw_record
152
231
        rec, contents = \
153
232
            self._data._parse_record_unchecked(annotated_compressed_bytes)
154
233
        content = self._annotate_factory.parse_fulltext(contents, rec[1])
155
 
        size, bytes = self._data._record_to_data((rec[1],), rec[3], content.text())
156
 
        return bytes
 
234
        size, chunks = self._data._record_to_data(
 
235
            (rec[1],), rec[3], content.text())
 
236
        return b''.join(chunks)
157
237
 
158
238
 
159
239
class DeltaAnnotatedToUnannotated(KnitAdapter):
160
240
    """An adapter for deltas from annotated to unannotated."""
161
241
 
162
 
    def get_bytes(self, factory):
 
242
    def get_bytes(self, factory, target_storage_kind):
 
243
        if target_storage_kind != 'knit-delta-gz':
 
244
            raise errors.UnavailableRepresentation(
 
245
                factory.key, target_storage_kind, factory.storage_kind)
163
246
        annotated_compressed_bytes = factory._raw_record
164
247
        rec, contents = \
165
248
            self._data._parse_record_unchecked(annotated_compressed_bytes)
166
249
        delta = self._annotate_factory.parse_line_delta(contents, rec[1],
167
 
            plain=True)
 
250
                                                        plain=True)
168
251
        contents = self._plain_factory.lower_line_delta(delta)
169
 
        size, bytes = self._data._record_to_data((rec[1],), rec[3], contents)
170
 
        return bytes
 
252
        size, chunks = self._data._record_to_data((rec[1],), rec[3], contents)
 
253
        return b''.join(chunks)
171
254
 
172
255
 
173
256
class FTAnnotatedToFullText(KnitAdapter):
174
257
    """An adapter from FT annotated knits to unannotated ones."""
175
258
 
176
 
    def get_bytes(self, factory):
 
259
    def get_bytes(self, factory, target_storage_kind):
177
260
        annotated_compressed_bytes = factory._raw_record
178
261
        rec, contents = \
179
262
            self._data._parse_record_unchecked(annotated_compressed_bytes)
180
263
        content, delta = self._annotate_factory.parse_record(factory.key[-1],
181
 
            contents, factory._build_details, None)
182
 
        return ''.join(content.text())
 
264
                                                             contents, factory._build_details, None)
 
265
        if target_storage_kind == 'fulltext':
 
266
            return b''.join(content.text())
 
267
        elif target_storage_kind in ('chunked', 'lines'):
 
268
            return content.text()
 
269
        raise errors.UnavailableRepresentation(
 
270
            factory.key, target_storage_kind, factory.storage_kind)
183
271
 
184
272
 
185
273
class DeltaAnnotatedToFullText(KnitAdapter):
186
274
    """An adapter for deltas from annotated to unannotated."""
187
275
 
188
 
    def get_bytes(self, factory):
 
276
    def get_bytes(self, factory, target_storage_kind):
189
277
        annotated_compressed_bytes = factory._raw_record
190
278
        rec, contents = \
191
279
            self._data._parse_record_unchecked(annotated_compressed_bytes)
192
280
        delta = self._annotate_factory.parse_line_delta(contents, rec[1],
193
 
            plain=True)
 
281
                                                        plain=True)
194
282
        compression_parent = factory.parents[0]
195
 
        basis_entry = self._basis_vf.get_record_stream(
196
 
            [compression_parent], 'unordered', True).next()
 
283
        basis_entry = next(self._basis_vf.get_record_stream(
 
284
            [compression_parent], 'unordered', True))
197
285
        if basis_entry.storage_kind == 'absent':
198
286
            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)
 
287
        basis_lines = basis_entry.get_bytes_as('lines')
201
288
        # Manually apply the delta because we have one annotated content and
202
289
        # one plain.
203
290
        basis_content = PlainKnitContent(basis_lines, compression_parent)
204
291
        basis_content.apply_delta(delta, rec[1])
205
292
        basis_content._should_strip_eol = factory._build_details[1]
206
 
        return ''.join(basis_content.text())
 
293
 
 
294
        if target_storage_kind == 'fulltext':
 
295
            return b''.join(basis_content.text())
 
296
        elif target_storage_kind in ('chunked', 'lines'):
 
297
            return basis_content.text()
 
298
        raise errors.UnavailableRepresentation(
 
299
            factory.key, target_storage_kind, factory.storage_kind)
207
300
 
208
301
 
209
302
class FTPlainToFullText(KnitAdapter):
210
303
    """An adapter from FT plain knits to unannotated ones."""
211
304
 
212
 
    def get_bytes(self, factory):
 
305
    def get_bytes(self, factory, target_storage_kind):
213
306
        compressed_bytes = factory._raw_record
214
307
        rec, contents = \
215
308
            self._data._parse_record_unchecked(compressed_bytes)
216
309
        content, delta = self._plain_factory.parse_record(factory.key[-1],
217
 
            contents, factory._build_details, None)
218
 
        return ''.join(content.text())
 
310
                                                          contents, factory._build_details, None)
 
311
        if target_storage_kind == 'fulltext':
 
312
            return b''.join(content.text())
 
313
        elif target_storage_kind in ('chunked', 'lines'):
 
314
            return content.text()
 
315
        raise errors.UnavailableRepresentation(
 
316
            factory.key, target_storage_kind, factory.storage_kind)
219
317
 
220
318
 
221
319
class DeltaPlainToFullText(KnitAdapter):
222
320
    """An adapter for deltas from annotated to unannotated."""
223
321
 
224
 
    def get_bytes(self, factory):
 
322
    def get_bytes(self, factory, target_storage_kind):
225
323
        compressed_bytes = factory._raw_record
226
324
        rec, contents = \
227
325
            self._data._parse_record_unchecked(compressed_bytes)
228
326
        delta = self._plain_factory.parse_line_delta(contents, rec[1])
229
327
        compression_parent = factory.parents[0]
230
328
        # XXX: string splitting overhead.
231
 
        basis_entry = self._basis_vf.get_record_stream(
232
 
            [compression_parent], 'unordered', True).next()
 
329
        basis_entry = next(self._basis_vf.get_record_stream(
 
330
            [compression_parent], 'unordered', True))
233
331
        if basis_entry.storage_kind == 'absent':
234
332
            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)
 
333
        basis_lines = basis_entry.get_bytes_as('lines')
237
334
        basis_content = PlainKnitContent(basis_lines, compression_parent)
238
335
        # Manually apply the delta because we have one annotated content and
239
336
        # one plain.
240
337
        content, _ = self._plain_factory.parse_record(rec[1], contents,
241
 
            factory._build_details, basis_content)
242
 
        return ''.join(content.text())
 
338
                                                      factory._build_details, basis_content)
 
339
        if target_storage_kind == 'fulltext':
 
340
            return b''.join(content.text())
 
341
        elif target_storage_kind in ('chunked', 'lines'):
 
342
            return content.text()
 
343
        raise errors.UnavailableRepresentation(
 
344
            factory.key, target_storage_kind, factory.storage_kind)
243
345
 
244
346
 
245
347
class KnitContentFactory(ContentFactory):
249
351
    """
250
352
 
251
353
    def __init__(self, key, parents, build_details, sha1, raw_record,
252
 
        annotated, knit=None, network_bytes=None):
 
354
                 annotated, knit=None, network_bytes=None):
253
355
        """Create a KnitContentFactory for key.
254
356
 
255
357
        :param key: The key.
283
385
    def _create_network_bytes(self):
284
386
        """Create a fully serialised network version for transmission."""
285
387
        # storage_kind, key, parents, Noeol, raw_record
286
 
        key_bytes = '\x00'.join(self.key)
 
388
        key_bytes = b'\x00'.join(self.key)
287
389
        if self.parents is None:
288
 
            parent_bytes = 'None:'
 
390
            parent_bytes = b'None:'
289
391
        else:
290
 
            parent_bytes = '\t'.join('\x00'.join(key) for key in self.parents)
 
392
            parent_bytes = b'\t'.join(b'\x00'.join(key)
 
393
                                      for key in self.parents)
291
394
        if self._build_details[1]:
292
 
            noeol = 'N'
 
395
            noeol = b'N'
293
396
        else:
294
 
            noeol = ' '
295
 
        network_bytes = "%s\n%s\n%s\n%s%s" % (self.storage_kind, key_bytes,
 
397
            noeol = b' '
 
398
        network_bytes = b"%s\n%s\n%s\n%s%s" % (
 
399
            self.storage_kind.encode('ascii'), key_bytes,
296
400
            parent_bytes, noeol, self._raw_record)
297
401
        self._network_bytes = network_bytes
298
402
 
301
405
            if self._network_bytes is None:
302
406
                self._create_network_bytes()
303
407
            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')
 
408
        if ('-ft-' in self.storage_kind
 
409
                and storage_kind in ('chunked', 'fulltext', 'lines')):
 
410
            adapter_key = (self.storage_kind, storage_kind)
307
411
            adapter_factory = adapter_registry.get(adapter_key)
308
412
            adapter = adapter_factory(None)
309
 
            bytes = adapter.get_bytes(self)
310
 
            if storage_kind == 'chunked':
311
 
                return [bytes]
312
 
            else:
313
 
                return bytes
 
413
            return adapter.get_bytes(self, storage_kind)
314
414
        if self._knit is not None:
315
415
            # Not redundant with direct conversion above - that only handles
316
416
            # fulltext cases.
317
 
            if storage_kind == 'chunked':
 
417
            if storage_kind in ('chunked', 'lines'):
318
418
                return self._knit.get_lines(self.key[0])
319
419
            elif storage_kind == 'fulltext':
320
420
                return self._knit.get_text(self.key[0])
321
421
        raise errors.UnavailableRepresentation(self.key, storage_kind,
322
 
            self.storage_kind)
 
422
                                               self.storage_kind)
 
423
 
 
424
    def iter_bytes_as(self, storage_kind):
 
425
        return iter(self.get_bytes_as(storage_kind))
323
426
 
324
427
 
325
428
class LazyKnitContentFactory(ContentFactory):
342
445
        self.key = key
343
446
        self.parents = parents
344
447
        self.sha1 = None
 
448
        self.size = None
345
449
        self._generator = generator
346
450
        self.storage_kind = "knit-delta-closure"
347
451
        if not first:
355
459
            else:
356
460
                # all the keys etc are contained in the bytes returned in the
357
461
                # first record.
358
 
                return ''
359
 
        if storage_kind in ('chunked', 'fulltext'):
 
462
                return b''
 
463
        if storage_kind in ('chunked', 'fulltext', 'lines'):
360
464
            chunks = self._generator._get_one_work(self.key).text()
361
 
            if storage_kind == 'chunked':
 
465
            if storage_kind in ('chunked', 'lines'):
362
466
                return chunks
363
467
            else:
364
 
                return ''.join(chunks)
365
 
        raise errors.UnavailableRepresentation(self.key, storage_kind,
366
 
            self.storage_kind)
 
468
                return b''.join(chunks)
 
469
        raise errors.UnavailableRepresentation(self.key, storage_kind,
 
470
                                               self.storage_kind)
 
471
 
 
472
    def iter_bytes_as(self, storage_kind):
 
473
        if storage_kind in ('chunked', 'lines'):
 
474
            chunks = self._generator._get_one_work(self.key).text()
 
475
            return iter(chunks)
 
476
        raise errors.UnavailableRepresentation(self.key, storage_kind,
 
477
                                               self.storage_kind)
367
478
 
368
479
 
369
480
def knit_delta_closure_to_records(storage_kind, bytes, line_end):
384
495
    :param bytes: The bytes of the record on the network.
385
496
    """
386
497
    start = line_end
387
 
    line_end = bytes.find('\n', start)
388
 
    key = tuple(bytes[start:line_end].split('\x00'))
 
498
    line_end = bytes.find(b'\n', start)
 
499
    key = tuple(bytes[start:line_end].split(b'\x00'))
389
500
    start = line_end + 1
390
 
    line_end = bytes.find('\n', start)
 
501
    line_end = bytes.find(b'\n', start)
391
502
    parent_line = bytes[start:line_end]
392
 
    if parent_line == 'None:':
 
503
    if parent_line == b'None:':
393
504
        parents = None
394
505
    else:
395
506
        parents = tuple(
396
 
            [tuple(segment.split('\x00')) for segment in parent_line.split('\t')
 
507
            [tuple(segment.split(b'\x00')) for segment in parent_line.split(b'\t')
397
508
             if segment])
398
509
    start = line_end + 1
399
 
    noeol = bytes[start] == 'N'
 
510
    noeol = bytes[start:start + 1] == b'N'
400
511
    if 'ft' in storage_kind:
401
512
        method = 'fulltext'
402
513
    else:
406
517
    raw_record = bytes[start:]
407
518
    annotated = 'annotated' in storage_kind
408
519
    return [KnitContentFactory(key, parents, build_details, None, raw_record,
409
 
        annotated, network_bytes=bytes)]
 
520
                               annotated, network_bytes=bytes)]
410
521
 
411
522
 
412
523
class KnitContent(object):
413
524
    """Content of a knit version to which deltas can be applied.
414
525
 
415
 
    This is always stored in memory as a list of lines with \n at the end,
 
526
    This is always stored in memory as a list of lines with \\n at the end,
416
527
    plus a flag saying if the final ending is really there or not, because that
417
528
    corresponds to the on-disk knit representation.
418
529
    """
450
561
            if n > 0:
451
562
                # knit deltas do not provide reliable info about whether the
452
563
                # last line of a file matches, due to eol handling.
453
 
                if source[s_pos + n -1] != target[t_pos + n -1]:
454
 
                    n-=1
 
564
                if source[s_pos + n - 1] != target[t_pos + n - 1]:
 
565
                    n -= 1
455
566
                if n > 0:
456
567
                    yield s_pos, t_pos, n
457
568
            t_pos += t_len + true_n
458
569
            s_pos = s_end
459
570
        n = target_len - t_pos
460
571
        if n > 0:
461
 
            if source[s_pos + n -1] != target[t_pos + n -1]:
462
 
                n-=1
 
572
            if source[s_pos + n - 1] != target[t_pos + n - 1]:
 
573
                n -= 1
463
574
            if n > 0:
464
575
                yield s_pos, t_pos, n
465
576
        yield s_pos + (target_len - t_pos), target_len, 0
470
581
 
471
582
    def __init__(self, lines):
472
583
        KnitContent.__init__(self)
473
 
        self._lines = lines
 
584
        self._lines = list(lines)
474
585
 
475
586
    def annotate(self):
476
587
        """Return a list of (origin, text) for each content line."""
477
588
        lines = self._lines[:]
478
589
        if self._should_strip_eol:
479
590
            origin, last_line = lines[-1]
480
 
            lines[-1] = (origin, last_line.rstrip('\n'))
 
591
            lines[-1] = (origin, last_line.rstrip(b'\n'))
481
592
        return lines
482
593
 
483
594
    def apply_delta(self, delta, new_version_id):
485
596
        offset = 0
486
597
        lines = self._lines
487
598
        for start, end, count, delta_lines in delta:
488
 
            lines[offset+start:offset+end] = delta_lines
 
599
            lines[offset + start:offset + end] = delta_lines
489
600
            offset = offset + (start - end) + count
490
601
 
491
602
    def text(self):
492
603
        try:
493
604
            lines = [text for origin, text in self._lines]
494
 
        except ValueError, e:
 
605
        except ValueError as e:
495
606
            # most commonly (only?) caused by the internal form of the knit
496
607
            # missing annotation information because of a bug - see thread
497
608
            # around 20071015
498
609
            raise KnitCorrupt(self,
499
 
                "line in annotated knit missing annotation information: %s"
500
 
                % (e,))
 
610
                              "line in annotated knit missing annotation information: %s"
 
611
                              % (e,))
501
612
        if self._should_strip_eol:
502
 
            lines[-1] = lines[-1].rstrip('\n')
 
613
            lines[-1] = lines[-1].rstrip(b'\n')
503
614
        return lines
504
615
 
505
616
    def copy(self):
506
 
        return AnnotatedKnitContent(self._lines[:])
 
617
        return AnnotatedKnitContent(self._lines)
507
618
 
508
619
 
509
620
class PlainKnitContent(KnitContent):
528
639
        offset = 0
529
640
        lines = self._lines
530
641
        for start, end, count, delta_lines in delta:
531
 
            lines[offset+start:offset+end] = delta_lines
 
642
            lines[offset + start:offset + end] = delta_lines
532
643
            offset = offset + (start - end) + count
533
644
        self._version_id = new_version_id
534
645
 
539
650
        lines = self._lines
540
651
        if self._should_strip_eol:
541
652
            lines = lines[:]
542
 
            lines[-1] = lines[-1].rstrip('\n')
 
653
            lines[-1] = lines[-1].rstrip(b'\n')
543
654
        return lines
544
655
 
545
656
 
598
709
        #       but the code itself doesn't really depend on that.
599
710
        #       Figure out a way to not require the overhead of turning the
600
711
        #       list back into tuples.
601
 
        lines = [tuple(line.split(' ', 1)) for line in content]
 
712
        lines = (tuple(line.split(b' ', 1)) for line in content)
602
713
        return AnnotatedKnitContent(lines)
603
714
 
604
 
    def parse_line_delta_iter(self, lines):
605
 
        return iter(self.parse_line_delta(lines))
606
 
 
607
715
    def parse_line_delta(self, lines, version_id, plain=False):
608
716
        """Convert a line based delta into internal representation.
609
717
 
620
728
        """
621
729
        result = []
622
730
        lines = iter(lines)
623
 
        next = lines.next
624
731
 
625
732
        cache = {}
 
733
 
626
734
        def cache_and_return(line):
627
 
            origin, text = line.split(' ', 1)
 
735
            origin, text = line.split(b' ', 1)
628
736
            return cache.setdefault(origin, origin), text
629
737
 
630
738
        # walk through the lines parsing.
632
740
        # loop to minimise any performance impact
633
741
        if plain:
634
742
            for header in lines:
635
 
                start, end, count = [int(n) for n in header.split(',')]
636
 
                contents = [next().split(' ', 1)[1] for i in xrange(count)]
 
743
                start, end, count = [int(n) for n in header.split(b',')]
 
744
                contents = [next(lines).split(b' ', 1)[1]
 
745
                            for _ in range(count)]
637
746
                result.append((start, end, count, contents))
638
747
        else:
639
748
            for header in lines:
640
 
                start, end, count = [int(n) for n in header.split(',')]
641
 
                contents = [tuple(next().split(' ', 1)) for i in xrange(count)]
 
749
                start, end, count = [int(n) for n in header.split(b',')]
 
750
                contents = [tuple(next(lines).split(b' ', 1))
 
751
                            for _ in range(count)]
642
752
                result.append((start, end, count, contents))
643
753
        return result
644
754
 
645
755
    def get_fulltext_content(self, lines):
646
756
        """Extract just the content lines from a fulltext."""
647
 
        return (line.split(' ', 1)[1] for line in lines)
 
757
        return (line.split(b' ', 1)[1] for line in lines)
648
758
 
649
759
    def get_linedelta_content(self, lines):
650
760
        """Extract just the content from a line delta.
653
763
        Only the actual content lines.
654
764
        """
655
765
        lines = iter(lines)
656
 
        next = lines.next
657
766
        for header in lines:
658
 
            header = header.split(',')
 
767
            header = header.split(b',')
659
768
            count = int(header[2])
660
 
            for i in xrange(count):
661
 
                origin, text = next().split(' ', 1)
 
769
            for _ in range(count):
 
770
                origin, text = next(lines).split(b' ', 1)
662
771
                yield text
663
772
 
664
773
    def lower_fulltext(self, content):
666
775
 
667
776
        see parse_fulltext which this inverts.
668
777
        """
669
 
        return ['%s %s' % (o, t) for o, t in content._lines]
 
778
        return [b'%s %s' % (o, t) for o, t in content._lines]
670
779
 
671
780
    def lower_line_delta(self, delta):
672
781
        """convert a delta into a serializable form.
677
786
        #       the origin is a valid utf-8 line, eventually we could remove it
678
787
        out = []
679
788
        for start, end, c, lines in delta:
680
 
            out.append('%d,%d,%d\n' % (start, end, c))
681
 
            out.extend(origin + ' ' + text
 
789
            out.append(b'%d,%d,%d\n' % (start, end, c))
 
790
            out.extend(origin + b' ' + text
682
791
                       for origin, text in lines)
683
792
        return out
684
793
 
686
795
        content = knit._get_content(key)
687
796
        # adjust for the fact that serialised annotations are only key suffixes
688
797
        # for this factory.
689
 
        if type(key) is tuple:
 
798
        if isinstance(key, tuple):
690
799
            prefix = key[:-1]
691
800
            origins = content.annotate()
692
801
            result = []
721
830
        while cur < num_lines:
722
831
            header = lines[cur]
723
832
            cur += 1
724
 
            start, end, c = [int(n) for n in header.split(',')]
725
 
            yield start, end, c, lines[cur:cur+c]
 
833
            start, end, c = [int(n) for n in header.split(b',')]
 
834
            yield start, end, c, lines[cur:cur + c]
726
835
            cur += c
727
836
 
728
837
    def parse_line_delta(self, lines, version_id):
739
848
        Only the actual content lines.
740
849
        """
741
850
        lines = iter(lines)
742
 
        next = lines.next
743
851
        for header in lines:
744
 
            header = header.split(',')
 
852
            header = header.split(b',')
745
853
            count = int(header[2])
746
 
            for i in xrange(count):
747
 
                yield next()
 
854
            for _ in range(count):
 
855
                yield next(lines)
748
856
 
749
857
    def lower_fulltext(self, content):
750
858
        return content.text()
752
860
    def lower_line_delta(self, delta):
753
861
        out = []
754
862
        for start, end, c, lines in delta:
755
 
            out.append('%d,%d,%d\n' % (start, end, c))
 
863
            out.append(b'%d,%d,%d\n' % (start, end, c))
756
864
            out.extend(lines)
757
865
        return out
758
866
 
761
869
        return annotator.annotate_flat(key)
762
870
 
763
871
 
764
 
 
765
872
def make_file_factory(annotated, mapper):
766
873
    """Create a factory for creating a file based KnitVersionedFiles.
767
874
 
772
879
    :param mapper: The mapper from keys to paths.
773
880
    """
774
881
    def factory(transport):
775
 
        index = _KndxIndex(transport, mapper, lambda:None, lambda:True, lambda:True)
 
882
        index = _KndxIndex(transport, mapper, lambda: None,
 
883
                           lambda: True, lambda: True)
776
884
        access = _KnitKeyAccess(transport, mapper)
777
885
        return KnitVersionedFiles(index, access, annotated=annotated)
778
886
    return factory
799
907
        else:
800
908
            max_delta_chain = 0
801
909
        graph_index = _mod_index.InMemoryGraphIndex(reference_lists=ref_length,
802
 
            key_elements=keylength)
 
910
                                                    key_elements=keylength)
803
911
        stream = transport.open_write_stream('newpack')
804
912
        writer = pack.ContainerWriter(stream.write)
805
913
        writer.begin()
806
 
        index = _KnitGraphIndex(graph_index, lambda:True, parents=parents,
807
 
            deltas=delta, add_callback=graph_index.add_nodes)
808
 
        access = _DirectPackAccess({})
 
914
        index = _KnitGraphIndex(graph_index, lambda: True, parents=parents,
 
915
                                deltas=delta, add_callback=graph_index.add_nodes)
 
916
        access = pack_repo._DirectPackAccess({})
809
917
        access.set_writer(writer, graph_index, (transport, 'newpack'))
810
918
        result = KnitVersionedFiles(index, access,
811
 
            max_delta_chain=max_delta_chain)
 
919
                                    max_delta_chain=max_delta_chain)
812
920
        result.stream = stream
813
921
        result.writer = writer
814
922
        return result
845
953
            if compression_parent not in all_build_index_memos:
846
954
                next_keys.add(compression_parent)
847
955
        build_keys = next_keys
848
 
    return sum([index_memo[2] for index_memo
849
 
                in all_build_index_memos.itervalues()])
850
 
 
851
 
 
852
 
class KnitVersionedFiles(VersionedFiles):
 
956
    return sum(index_memo[2]
 
957
               for index_memo in viewvalues(all_build_index_memos))
 
958
 
 
959
 
 
960
class KnitVersionedFiles(VersionedFilesWithFallbacks):
853
961
    """Storage for many versioned files using knit compression.
854
962
 
855
963
    Backend storage is managed by indices and data objects.
873
981
            stored during insertion.
874
982
        :param reload_func: An function that can be called if we think we need
875
983
            to reload the pack listing and try again. See
876
 
            'bzrlib.repofmt.pack_repo.AggregateIndex' for the signature.
 
984
            'breezy.bzr.pack_repo.AggregateIndex' for the signature.
877
985
        """
878
986
        self._index = index
879
987
        self._access = data_access
882
990
            self._factory = KnitAnnotateFactory()
883
991
        else:
884
992
            self._factory = KnitPlainFactory()
885
 
        self._fallback_vfs = []
 
993
        self._immediate_fallback_vfs = []
886
994
        self._reload_func = reload_func
887
995
 
888
996
    def __repr__(self):
891
999
            self._index,
892
1000
            self._access)
893
1001
 
 
1002
    def without_fallbacks(self):
 
1003
        """Return a clone of this object without any fallbacks configured."""
 
1004
        return KnitVersionedFiles(self._index, self._access,
 
1005
                                  self._max_delta_chain, self._factory.annotated,
 
1006
                                  self._reload_func)
 
1007
 
894
1008
    def add_fallback_versioned_files(self, a_versioned_files):
895
1009
        """Add a source of texts for texts not present in this knit.
896
1010
 
897
1011
        :param a_versioned_files: A VersionedFiles object.
898
1012
        """
899
 
        self._fallback_vfs.append(a_versioned_files)
 
1013
        self._immediate_fallback_vfs.append(a_versioned_files)
900
1014
 
901
1015
    def add_lines(self, key, parents, lines, parent_texts=None,
902
 
        left_matching_blocks=None, nostore_sha=None, random_id=False,
903
 
        check_content=True):
 
1016
                  left_matching_blocks=None, nostore_sha=None, random_id=False,
 
1017
                  check_content=True):
904
1018
        """See VersionedFiles.add_lines()."""
905
1019
        self._index._check_write_ok()
906
1020
        self._check_add(key, lines, random_id, check_content)
909
1023
            # indexes can't directly store that, so we give them
910
1024
            # an empty tuple instead.
911
1025
            parents = ()
912
 
        line_bytes = ''.join(lines)
 
1026
        line_bytes = b''.join(lines)
913
1027
        return self._add(key, lines, parents,
914
 
            parent_texts, left_matching_blocks, nostore_sha, random_id,
915
 
            line_bytes=line_bytes)
 
1028
                         parent_texts, left_matching_blocks, nostore_sha, random_id,
 
1029
                         line_bytes=line_bytes)
916
1030
 
917
 
    def _add_text(self, key, parents, text, nostore_sha=None, random_id=False):
918
 
        """See VersionedFiles._add_text()."""
 
1031
    def add_chunks(self, key, parents, chunk_iter, parent_texts=None,
 
1032
                   left_matching_blocks=None, nostore_sha=None, random_id=False):
 
1033
        """See VersionedFiles.add_chunks()."""
919
1034
        self._index._check_write_ok()
920
1035
        self._check_add(key, None, random_id, check_content=False)
921
 
        if text.__class__ is not str:
922
 
            raise errors.BzrBadParameterUnicode("text")
923
1036
        if parents is None:
924
1037
            # The caller might pass None if there is no graph data, but kndx
925
1038
            # indexes can't directly store that, so we give them
926
1039
            # an empty tuple instead.
927
1040
            parents = ()
 
1041
        line_bytes = b''.join(chunk_iter)
928
1042
        return self._add(key, None, parents,
929
 
            None, None, nostore_sha, random_id,
930
 
            line_bytes=text)
 
1043
                         parent_texts, left_matching_blocks, nostore_sha, random_id,
 
1044
                         line_bytes=line_bytes)
931
1045
 
932
1046
    def _add(self, key, lines, parents, parent_texts,
933
 
        left_matching_blocks, nostore_sha, random_id,
934
 
        line_bytes):
 
1047
             left_matching_blocks, nostore_sha, random_id,
 
1048
             line_bytes):
935
1049
        """Add a set of lines on top of version specified by parents.
936
1050
 
937
1051
        Any versions not present will be converted into ghosts.
963
1077
                present_parents.append(parent)
964
1078
 
965
1079
        # Currently we can only compress against the left most present parent.
966
 
        if (len(present_parents) == 0 or
967
 
            present_parents[0] != parents[0]):
 
1080
        if (len(present_parents) == 0
 
1081
                or present_parents[0] != parents[0]):
968
1082
            delta = False
969
1083
        else:
970
1084
            # To speed the extract of texts the delta chain is limited
978
1092
        # Note: line_bytes is not modified to add a newline, that is tracked
979
1093
        #       via the no_eol flag. 'lines' *is* modified, because that is the
980
1094
        #       general values needed by the Content code.
981
 
        if line_bytes and line_bytes[-1] != '\n':
982
 
            options.append('no-eol')
 
1095
        if line_bytes and not line_bytes.endswith(b'\n'):
 
1096
            options.append(b'no-eol')
983
1097
            no_eol = True
984
1098
            # Copy the existing list, or create a new one
985
1099
            if lines is None:
987
1101
            else:
988
1102
                lines = lines[:]
989
1103
            # Replace the last line with one that ends in a final newline
990
 
            lines[-1] = lines[-1] + '\n'
 
1104
            lines[-1] = lines[-1] + b'\n'
991
1105
        if lines is None:
992
1106
            lines = osutils.split_lines(line_bytes)
993
1107
 
994
1108
        for element in key[:-1]:
995
 
            if type(element) is not str:
996
 
                raise TypeError("key contains non-strings: %r" % (key,))
 
1109
            if not isinstance(element, bytes):
 
1110
                raise TypeError("key contains non-bytestrings: %r" % (key,))
997
1111
        if key[-1] is None:
998
 
            key = key[:-1] + ('sha1:' + digest,)
999
 
        elif type(key[-1]) is not str:
1000
 
                raise TypeError("key contains non-strings: %r" % (key,))
 
1112
            key = key[:-1] + (b'sha1:' + digest,)
 
1113
        elif not isinstance(key[-1], bytes):
 
1114
            raise TypeError("key contains non-bytestrings: %r" % (key,))
1001
1115
        # Knit hunks are still last-element only
1002
1116
        version_id = key[-1]
1003
1117
        content = self._factory.make(lines, version_id)
1008
1122
        if delta or (self._factory.annotated and len(present_parents) > 0):
1009
1123
            # Merge annotations from parent texts if needed.
1010
1124
            delta_hunks = self._merge_annotations(content, present_parents,
1011
 
                parent_texts, delta, self._factory.annotated,
1012
 
                left_matching_blocks)
 
1125
                                                  parent_texts, delta, self._factory.annotated,
 
1126
                                                  left_matching_blocks)
1013
1127
 
1014
1128
        if delta:
1015
 
            options.append('line-delta')
 
1129
            options.append(b'line-delta')
1016
1130
            store_lines = self._factory.lower_line_delta(delta_hunks)
1017
 
            size, bytes = self._record_to_data(key, digest,
1018
 
                store_lines)
 
1131
            size, data = self._record_to_data(key, digest, store_lines)
1019
1132
        else:
1020
 
            options.append('fulltext')
 
1133
            options.append(b'fulltext')
1021
1134
            # isinstance is slower and we have no hierarchy.
1022
1135
            if self._factory.__class__ is KnitPlainFactory:
1023
1136
                # Use the already joined bytes saving iteration time in
1024
1137
                # _record_to_data.
1025
1138
                dense_lines = [line_bytes]
1026
1139
                if no_eol:
1027
 
                    dense_lines.append('\n')
1028
 
                size, bytes = self._record_to_data(key, digest,
1029
 
                    lines, dense_lines)
 
1140
                    dense_lines.append(b'\n')
 
1141
                size, data = self._record_to_data(key, digest,
 
1142
                                                  lines, dense_lines)
1030
1143
            else:
1031
1144
                # get mixed annotation + content and feed it into the
1032
1145
                # serialiser.
1033
1146
                store_lines = self._factory.lower_fulltext(content)
1034
 
                size, bytes = self._record_to_data(key, digest,
1035
 
                    store_lines)
 
1147
                size, data = self._record_to_data(key, digest, store_lines)
1036
1148
 
1037
 
        access_memo = self._access.add_raw_records([(key, size)], bytes)[0]
 
1149
        access_memo = self._access.add_raw_record(key, size, data)
1038
1150
        self._index.add_records(
1039
1151
            ((key, options, access_memo, parents),),
1040
1152
            random_id=random_id)
1066
1178
            if self._index.get_method(key) != 'fulltext':
1067
1179
                compression_parent = parent_map[key][0]
1068
1180
                if compression_parent not in parent_map:
1069
 
                    raise errors.KnitCorrupt(self,
1070
 
                        "Missing basis parent %s for %s" % (
1071
 
                        compression_parent, key))
1072
 
        for fallback_vfs in self._fallback_vfs:
 
1181
                    raise KnitCorrupt(self,
 
1182
                                      "Missing basis parent %s for %s" % (
 
1183
                                          compression_parent, key))
 
1184
        for fallback_vfs in self._immediate_fallback_vfs:
1073
1185
            fallback_vfs.check()
1074
1186
 
1075
1187
    def _check_add(self, key, lines, random_id, check_content):
1076
1188
        """check that version_id and lines are safe to add."""
 
1189
        if not all(isinstance(x, bytes) or x is None for x in key):
 
1190
            raise TypeError(key)
1077
1191
        version_id = key[-1]
1078
1192
        if version_id is not None:
1079
1193
            if contains_whitespace(version_id):
1099
1213
        """
1100
1214
        if rec[1] != version_id:
1101
1215
            raise KnitCorrupt(self,
1102
 
                'unexpected version, wanted %r, got %r' % (version_id, rec[1]))
 
1216
                              'unexpected version, wanted %r, got %r' % (version_id, rec[1]))
1103
1217
 
1104
1218
    def _check_should_delta(self, parent):
1105
1219
        """Iterate back through the parent listing, looking for a fulltext.
1114
1228
        """
1115
1229
        delta_size = 0
1116
1230
        fulltext_size = None
1117
 
        for count in xrange(self._max_delta_chain):
 
1231
        for count in range(self._max_delta_chain):
1118
1232
            try:
1119
1233
                # Note that this only looks in the index of this particular
1120
1234
                # KnitVersionedFiles, not in the fallbacks.  This ensures that
1122
1236
                # boundaries.
1123
1237
                build_details = self._index.get_build_details([parent])
1124
1238
                parent_details = build_details[parent]
1125
 
            except (RevisionNotPresent, KeyError), e:
 
1239
            except (RevisionNotPresent, KeyError) as e:
1126
1240
                # Some basis is not locally present: always fulltext
1127
1241
                return False
1128
1242
            index_memo, compression_parent, _, _ = parent_details
1153
1267
 
1154
1268
        A dict of key to (record_details, index_memo, next, parents) is
1155
1269
        returned.
1156
 
        method is the way referenced data should be applied.
1157
 
        index_memo is the handle to pass to the data access to actually get the
1158
 
            data
1159
 
        next is the build-parent of the version, or None for fulltexts.
1160
 
        parents is the version_ids of the parents of this version
1161
 
 
1162
 
        :param allow_missing: If True do not raise an error on a missing component,
1163
 
            just ignore it.
 
1270
 
 
1271
        * method is the way referenced data should be applied.
 
1272
        * index_memo is the handle to pass to the data access to actually get
 
1273
          the data
 
1274
        * next is the build-parent of the version, or None for fulltexts.
 
1275
        * parents is the version_ids of the parents of this version
 
1276
 
 
1277
        :param allow_missing: If True do not raise an error on a missing
 
1278
            component, just ignore it.
1164
1279
        """
1165
1280
        component_data = {}
1166
1281
        pending_components = keys
1168
1283
            build_details = self._index.get_build_details(pending_components)
1169
1284
            current_components = set(pending_components)
1170
1285
            pending_components = set()
1171
 
            for key, details in build_details.iteritems():
 
1286
            for key, details in viewitems(build_details):
1172
1287
                (index_memo, compression_parent, parents,
1173
1288
                 record_details) = details
1174
 
                method = record_details[0]
1175
1289
                if compression_parent is not None:
1176
1290
                    pending_components.add(compression_parent)
1177
 
                component_data[key] = self._build_details_to_components(details)
 
1291
                component_data[key] = self._build_details_to_components(
 
1292
                    details)
1178
1293
            missing = current_components.difference(build_details)
1179
1294
            if missing and not allow_missing:
1180
1295
                raise errors.RevisionNotPresent(missing.pop(), self)
1192
1307
        generator = _VFContentMapGenerator(self, [key])
1193
1308
        return generator._get_content(key)
1194
1309
 
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
1207
 
 
1208
1310
    def get_parent_map(self, keys):
1209
1311
        """Get a map of the graph parents of keys.
1210
1312
 
1225
1327
            and so on.
1226
1328
        """
1227
1329
        result = {}
1228
 
        sources = [self._index] + self._fallback_vfs
 
1330
        sources = [self._index] + self._immediate_fallback_vfs
1229
1331
        source_results = []
1230
1332
        missing = set(keys)
1231
1333
        for source in sources:
1241
1343
        """Produce a dictionary of knit records.
1242
1344
 
1243
1345
        :return: {key:(record, record_details, digest, next)}
1244
 
            record
1245
 
                data returned from read_records (a KnitContentobject)
1246
 
            record_details
1247
 
                opaque information to pass to parse_record
1248
 
            digest
1249
 
                SHA1 digest of the full text after all steps are done
1250
 
            next
1251
 
                build-parent of the version, i.e. the leftmost ancestor.
 
1346
 
 
1347
            * record: data returned from read_records (a KnitContentobject)
 
1348
            * record_details: opaque information to pass to parse_record
 
1349
            * digest: SHA1 digest of the full text after all steps are done
 
1350
            * next: build-parent of the version, i.e. the leftmost ancestor.
1252
1351
                Will be None if the record is not a delta.
 
1352
 
1253
1353
        :param keys: The keys to build a map for
1254
1354
        :param allow_missing: If some records are missing, rather than
1255
1355
            error, just return the data that could be generated.
1256
1356
        """
1257
1357
        raw_map = self._get_record_map_unparsed(keys,
1258
 
            allow_missing=allow_missing)
 
1358
                                                allow_missing=allow_missing)
1259
1359
        return self._raw_map_to_record_map(raw_map)
1260
1360
 
1261
1361
    def _raw_map_to_record_map(self, raw_map):
1286
1386
        while True:
1287
1387
            try:
1288
1388
                position_map = self._get_components_positions(keys,
1289
 
                    allow_missing=allow_missing)
 
1389
                                                              allow_missing=allow_missing)
1290
1390
                # key = component_id, r = record_details, i_m = index_memo,
1291
1391
                # n = next
1292
1392
                records = [(key, i_m) for key, (r, i_m, n)
1293
 
                                       in position_map.iteritems()]
 
1393
                           in viewitems(position_map)]
1294
1394
                # Sort by the index memo, so that we request records from the
1295
1395
                # same pack file together, and in forward-sorted order
1296
1396
                records.sort(key=operator.itemgetter(1))
1299
1399
                    (record_details, index_memo, next) = position_map[key]
1300
1400
                    raw_record_map[key] = data, record_details, next
1301
1401
                return raw_record_map
1302
 
            except errors.RetryWithNewPacks, e:
 
1402
            except errors.RetryWithNewPacks as e:
1303
1403
                self._access.reload_or_raise(e)
1304
1404
 
1305
1405
    @classmethod
1325
1425
        prefix_order = []
1326
1426
        for key in keys:
1327
1427
            if len(key) == 1:
1328
 
                prefix = ''
 
1428
                prefix = b''
1329
1429
            else:
1330
1430
                prefix = key[0]
1331
1431
 
1404
1504
            try:
1405
1505
                keys = set(remaining_keys)
1406
1506
                for content_factory in self._get_remaining_record_stream(keys,
1407
 
                                            ordering, include_delta_closure):
 
1507
                                                                         ordering, include_delta_closure):
1408
1508
                    remaining_keys.discard(content_factory.key)
1409
1509
                    yield content_factory
1410
1510
                return
1411
 
            except errors.RetryWithNewPacks, e:
 
1511
            except errors.RetryWithNewPacks as e:
1412
1512
                self._access.reload_or_raise(e)
1413
1513
 
1414
1514
    def _get_remaining_record_stream(self, keys, ordering,
1415
1515
                                     include_delta_closure):
1416
1516
        """This function is the 'retry' portion for get_record_stream."""
1417
1517
        if include_delta_closure:
1418
 
            positions = self._get_components_positions(keys, allow_missing=True)
 
1518
            positions = self._get_components_positions(
 
1519
                keys, allow_missing=True)
1419
1520
        else:
1420
1521
            build_details = self._index.get_build_details(keys)
1421
1522
            # map from key to
1422
1523
            # (record_details, access_memo, compression_parent_key)
1423
1524
            positions = dict((key, self._build_details_to_components(details))
1424
 
                for key, details in build_details.iteritems())
 
1525
                             for key, details in viewitems(build_details))
1425
1526
        absent_keys = keys.difference(set(positions))
1426
1527
        # There may be more absent keys : if we're missing the basis component
1427
1528
        # and are trying to include the delta closure.
1479
1580
        else:
1480
1581
            if ordering != 'unordered':
1481
1582
                raise AssertionError('valid values for ordering are:'
1482
 
                    ' "unordered", "groupcompress" or "topological" not: %r'
1483
 
                    % (ordering,))
 
1583
                                     ' "unordered", "groupcompress" or "topological" not: %r'
 
1584
                                     % (ordering,))
1484
1585
            # Just group by source; remote sources first.
1485
1586
            present_keys = []
1486
1587
            source_keys = []
1523
1624
                    for key, raw_data in self._read_records_iter_unchecked(records):
1524
1625
                        (record_details, index_memo, _) = positions[key]
1525
1626
                        yield KnitContentFactory(key, global_map[key],
1526
 
                            record_details, None, raw_data, self._factory.annotated, None)
 
1627
                                                 record_details, None, raw_data, self._factory.annotated, None)
1527
1628
                else:
1528
 
                    vf = self._fallback_vfs[parent_maps.index(source) - 1]
 
1629
                    vf = self._immediate_fallback_vfs[parent_maps.index(
 
1630
                        source) - 1]
1529
1631
                    for record in vf.get_record_stream(keys, ordering,
1530
 
                        include_delta_closure):
 
1632
                                                       include_delta_closure):
1531
1633
                        yield record
1532
1634
 
1533
1635
    def get_sha1s(self, keys):
1535
1637
        missing = set(keys)
1536
1638
        record_map = self._get_record_map(missing, allow_missing=True)
1537
1639
        result = {}
1538
 
        for key, details in record_map.iteritems():
 
1640
        for key, details in viewitems(record_map):
1539
1641
            if key not in missing:
1540
1642
                continue
1541
1643
            # record entry 2 is the 'digest'.
1542
1644
            result[key] = details[2]
1543
1645
        missing.difference_update(set(result))
1544
 
        for source in self._fallback_vfs:
 
1646
        for source in self._immediate_fallback_vfs:
1545
1647
            if not missing:
1546
1648
                break
1547
1649
            new_result = source.get_sha1s(missing)
1572
1674
        else:
1573
1675
            # self is not annotated, but we can strip annotations cheaply.
1574
1676
            annotated = ""
1575
 
            convertibles = set(["knit-annotated-ft-gz"])
 
1677
            convertibles = {"knit-annotated-ft-gz"}
1576
1678
            if self._max_delta_chain:
1577
1679
                delta_types.add("knit-annotated-delta-gz")
1578
1680
                convertibles.add("knit-annotated-delta-gz")
1616
1718
            # Raise an error when a record is missing.
1617
1719
            if record.storage_kind == 'absent':
1618
1720
                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))):
 
1721
            elif ((record.storage_kind in knit_types) and
 
1722
                  (compression_parent is None or
 
1723
                   not self._immediate_fallback_vfs or
 
1724
                   compression_parent in self._index or
 
1725
                   compression_parent not in self)):
1624
1726
                # we can insert the knit record literally if either it has no
1625
1727
                # compression parent OR we already have its basis in this kvf
1626
1728
                # OR the basis is not present even in the fallbacks.  In the
1628
1730
                # will be well, or it won't turn up at all and we'll raise an
1629
1731
                # error at the end.
1630
1732
                #
1631
 
                # TODO: self.has_key is somewhat redundant with
1632
 
                # self._index.has_key; we really want something that directly
 
1733
                # TODO: self.__contains__ is somewhat redundant with
 
1734
                # self._index.__contains__; we really want something that directly
1633
1735
                # asks if it's only present in the fallbacks. -- mbp 20081119
1634
1736
                if record.storage_kind not in native_types:
1635
1737
                    try:
1638
1740
                    except KeyError:
1639
1741
                        adapter_key = (record.storage_kind, "knit-ft-gz")
1640
1742
                        adapter = get_adapter(adapter_key)
1641
 
                    bytes = adapter.get_bytes(record)
 
1743
                    bytes = adapter.get_bytes(record, adapter_key[1])
1642
1744
                else:
1643
1745
                    # It's a knit record, it has a _raw_record field (even if
1644
1746
                    # it was reconstituted from a network stream).
1645
1747
                    bytes = record._raw_record
1646
 
                options = [record._build_details[0]]
 
1748
                options = [record._build_details[0].encode('ascii')]
1647
1749
                if record._build_details[1]:
1648
 
                    options.append('no-eol')
 
1750
                    options.append(b'no-eol')
1649
1751
                # Just blat it across.
1650
1752
                # Note: This does end up adding data on duplicate keys. As
1651
1753
                # modern repositories use atomic insertions this should not
1654
1756
                # deprecated format this is tolerable. It can be fixed if
1655
1757
                # needed by in the kndx index support raising on a duplicate
1656
1758
                # add with identical parents and options.
1657
 
                access_memo = self._access.add_raw_records(
1658
 
                    [(record.key, len(bytes))], bytes)[0]
 
1759
                access_memo = self._access.add_raw_record(
 
1760
                    record.key, len(bytes), [bytes])
1659
1761
                index_entry = (record.key, options, access_memo, parents)
1660
 
                if 'fulltext' not in options:
 
1762
                if b'fulltext' not in options:
1661
1763
                    # Not a fulltext, so we need to make sure the compression
1662
1764
                    # parent will also be present.
1663
1765
                    # Note that pack backed knits don't need to buffer here
1668
1770
                    #
1669
1771
                    # They're required to be physically in this
1670
1772
                    # KnitVersionedFiles, not in a fallback.
1671
 
                    if not self._index.has_key(compression_parent):
 
1773
                    if compression_parent not in self._index:
1672
1774
                        pending = buffered_index_entries.setdefault(
1673
1775
                            compression_parent, [])
1674
1776
                        pending.append(index_entry)
1675
1777
                        buffered = True
1676
1778
                if not buffered:
1677
1779
                    self._index.add_records([index_entry])
1678
 
            elif record.storage_kind == 'chunked':
1679
 
                self.add_lines(record.key, parents,
1680
 
                    osutils.chunks_to_lines(record.get_bytes_as('chunked')))
 
1780
            elif record.storage_kind in ('chunked', 'file'):
 
1781
                self.add_lines(record.key, parents, record.get_bytes_as('lines'))
1681
1782
            else:
1682
1783
                # Not suitable for direct insertion as a
1683
1784
                # delta, either because it's not the right format, or this
1687
1788
                self._access.flush()
1688
1789
                try:
1689
1790
                    # Try getting a fulltext directly from the record.
1690
 
                    bytes = record.get_bytes_as('fulltext')
 
1791
                    lines = record.get_bytes_as('lines')
1691
1792
                except errors.UnavailableRepresentation:
1692
 
                    adapter_key = record.storage_kind, 'fulltext'
 
1793
                    adapter_key = record.storage_kind, 'lines'
1693
1794
                    adapter = get_adapter(adapter_key)
1694
 
                    bytes = adapter.get_bytes(record)
1695
 
                lines = split_lines(bytes)
 
1795
                    lines = adapter.get_bytes(record, 'lines')
1696
1796
                try:
1697
1797
                    self.add_lines(record.key, parents, lines)
1698
1798
                except errors.RevisionAlreadyPresent:
1767
1867
                # we need key, position, length
1768
1868
                key_records = []
1769
1869
                build_details = self._index.get_build_details(keys)
1770
 
                for key, details in build_details.iteritems():
 
1870
                for key, details in viewitems(build_details):
1771
1871
                    if key in keys:
1772
1872
                        key_records.append((key, details[0]))
1773
1873
                records_iter = enumerate(self._read_records_iter(key_records))
1774
1874
                for (key_idx, (key, data, sha_value)) in records_iter:
1775
 
                    pb.update('Walking content', key_idx, total)
 
1875
                    pb.update(gettext('Walking content'), key_idx, total)
1776
1876
                    compression_parent = build_details[key][1]
1777
1877
                    if compression_parent is None:
1778
1878
                        # fulltext
1779
 
                        line_iterator = self._factory.get_fulltext_content(data)
 
1879
                        line_iterator = self._factory.get_fulltext_content(
 
1880
                            data)
1780
1881
                    else:
1781
1882
                        # Delta
1782
 
                        line_iterator = self._factory.get_linedelta_content(data)
 
1883
                        line_iterator = self._factory.get_linedelta_content(
 
1884
                            data)
1783
1885
                    # Now that we are yielding the data for this key, remove it
1784
1886
                    # from the list
1785
1887
                    keys.remove(key)
1790
1892
                    for line in line_iterator:
1791
1893
                        yield line, key
1792
1894
                done = True
1793
 
            except errors.RetryWithNewPacks, e:
 
1895
            except errors.RetryWithNewPacks as e:
1794
1896
                self._access.reload_or_raise(e)
1795
1897
        # If there are still keys we've not yet found, we look in the fallback
1796
1898
        # vfs, and hope to find them there.  Note that if the keys are found
1797
1899
        # but had no changes or no content, the fallback may not return
1798
1900
        # anything.
1799
 
        if keys and not self._fallback_vfs:
 
1901
        if keys and not self._immediate_fallback_vfs:
1800
1902
            # XXX: strictly the second parameter is meant to be the file id
1801
1903
            # but it's not easily accessible here.
1802
1904
            raise RevisionNotPresent(keys, repr(self))
1803
 
        for source in self._fallback_vfs:
 
1905
        for source in self._immediate_fallback_vfs:
1804
1906
            if not keys:
1805
1907
                break
1806
1908
            source_keys = set()
1808
1910
                source_keys.add(key)
1809
1911
                yield line, key
1810
1912
            keys.difference_update(source_keys)
1811
 
        pb.update('Walking content', total, total)
 
1913
        pb.update(gettext('Walking content'), total, total)
1812
1914
 
1813
1915
    def _make_line_delta(self, delta_seq, new_content):
1814
1916
        """Generate a line delta from delta_seq and new_content."""
1816
1918
        for op in delta_seq.get_opcodes():
1817
1919
            if op[0] == 'equal':
1818
1920
                continue
1819
 
            diff_hunks.append((op[1], op[2], op[4]-op[3], new_content._lines[op[3]:op[4]]))
 
1921
            diff_hunks.append(
 
1922
                (op[1], op[2], op[4] - op[3], new_content._lines[op[3]:op[4]]))
1820
1923
        return diff_hunks
1821
1924
 
1822
1925
    def _merge_annotations(self, content, parents, parent_texts={},
1846
1949
                    # this copies (origin, text) pairs across to the new
1847
1950
                    # content for any line that matches the last-checked
1848
1951
                    # parent.
1849
 
                    content._lines[j:j+n] = merge_content._lines[i:i+n]
 
1952
                    content._lines[j:j + n] = merge_content._lines[i:i + n]
1850
1953
            # XXX: Robert says the following block is a workaround for a
1851
1954
            # now-fixed bug and it can probably be deleted. -- mbp 20080618
1852
 
            if content._lines and content._lines[-1][1][-1] != '\n':
 
1955
            if content._lines and not content._lines[-1][1].endswith(b'\n'):
1853
1956
                # The copied annotation was from a line without a trailing EOL,
1854
1957
                # reinstate one for the content object, to ensure correct
1855
1958
                # serialization.
1856
 
                line = content._lines[-1][1] + '\n'
 
1959
                line = content._lines[-1][1] + b'\n'
1857
1960
                content._lines[-1] = (content._lines[-1][0], line)
1858
1961
        if delta:
1859
1962
            if delta_seq is None:
1861
1964
                new_texts = content.text()
1862
1965
                old_texts = reference_content.text()
1863
1966
                delta_seq = patiencediff.PatienceSequenceMatcher(
1864
 
                                                 None, old_texts, new_texts)
 
1967
                    None, old_texts, new_texts)
1865
1968
            return self._make_line_delta(delta_seq, content)
1866
1969
 
1867
1970
    def _parse_record(self, version_id, data):
1879
1982
        :return: the header and the decompressor stream.
1880
1983
                 as (stream, header_record)
1881
1984
        """
1882
 
        df = tuned_gzip.GzipFile(mode='rb', fileobj=StringIO(raw_data))
 
1985
        df = gzip.GzipFile(mode='rb', fileobj=BytesIO(raw_data))
1883
1986
        try:
1884
1987
            # Current serialise
1885
1988
            rec = self._check_header(key, df.readline())
1886
 
        except Exception, e:
 
1989
        except Exception as e:
1887
1990
            raise KnitCorrupt(self,
1888
1991
                              "While reading {%s} got %s(%s)"
1889
1992
                              % (key, e.__class__.__name__, str(e)))
1894
1997
        # 4168 calls in 2880 217 internal
1895
1998
        # 4168 calls to _parse_record_header in 2121
1896
1999
        # 4168 calls to readlines in 330
1897
 
        df = tuned_gzip.GzipFile(mode='rb', fileobj=StringIO(data))
1898
 
        try:
1899
 
            record_contents = df.readlines()
1900
 
        except Exception, e:
1901
 
            raise KnitCorrupt(self, "Corrupt compressed record %r, got %s(%s)" %
1902
 
                (data, e.__class__.__name__, str(e)))
1903
 
        header = record_contents.pop(0)
1904
 
        rec = self._split_header(header)
1905
 
        last_line = record_contents.pop()
1906
 
        if len(record_contents) != int(rec[2]):
1907
 
            raise KnitCorrupt(self,
1908
 
                              'incorrect number of lines %s != %s'
1909
 
                              ' for version {%s} %s'
1910
 
                              % (len(record_contents), int(rec[2]),
1911
 
                                 rec[1], record_contents))
1912
 
        if last_line != 'end %s\n' % rec[1]:
1913
 
            raise KnitCorrupt(self,
1914
 
                              'unexpected version end line %r, wanted %r'
1915
 
                              % (last_line, rec[1]))
1916
 
        df.close()
 
2000
        with gzip.GzipFile(mode='rb', fileobj=BytesIO(data)) as df:
 
2001
            try:
 
2002
                record_contents = df.readlines()
 
2003
            except Exception as e:
 
2004
                raise KnitCorrupt(self, "Corrupt compressed record %r, got %s(%s)" %
 
2005
                                  (data, e.__class__.__name__, str(e)))
 
2006
            header = record_contents.pop(0)
 
2007
            rec = self._split_header(header)
 
2008
            last_line = record_contents.pop()
 
2009
            if len(record_contents) != int(rec[2]):
 
2010
                raise KnitCorrupt(self,
 
2011
                                  'incorrect number of lines %s != %s'
 
2012
                                  ' for version {%s} %s'
 
2013
                                  % (len(record_contents), int(rec[2]),
 
2014
                                     rec[1], record_contents))
 
2015
            if last_line != b'end %s\n' % rec[1]:
 
2016
                raise KnitCorrupt(self,
 
2017
                                  'unexpected version end line %r, wanted %r'
 
2018
                                  % (last_line, rec[1]))
1917
2019
        return rec, record_contents
1918
2020
 
1919
2021
    def _read_records_iter(self, records):
1922
2024
        The result will be returned in whatever is the fastest to read.
1923
2025
        Not by the order requested. Also, multiple requests for the same
1924
2026
        record will only yield 1 response.
 
2027
 
1925
2028
        :param records: A list of (key, access_memo) entries
1926
2029
        :return: Yields (key, contents, digest) in the order
1927
2030
                 read, not the order requested
1939
2042
        raw_data = self._access.get_raw_records(
1940
2043
            [index_memo for key, index_memo in needed_records])
1941
2044
 
1942
 
        for (key, index_memo), data in \
1943
 
                izip(iter(needed_records), raw_data):
 
2045
        for (key, index_memo), data in zip(needed_records, raw_data):
1944
2046
            content, digest = self._parse_record(key[-1], data)
1945
2047
            yield key, content, digest
1946
2048
 
1972
2074
        if len(records):
1973
2075
            # grab the disk data needed.
1974
2076
            needed_offsets = [index_memo for key, index_memo
1975
 
                                           in records]
 
2077
                              in records]
1976
2078
            raw_records = self._access.get_raw_records(needed_offsets)
1977
2079
 
1978
2080
        for key, index_memo in records:
1979
 
            data = raw_records.next()
 
2081
            data = next(raw_records)
1980
2082
            yield key, data
1981
2083
 
1982
2084
    def _record_to_data(self, key, digest, lines, dense_lines=None):
1985
2087
        :param key: The key of the record. Currently keys are always serialised
1986
2088
            using just the trailing component.
1987
2089
        :param dense_lines: The bytes of lines but in a denser form. For
1988
 
            instance, if lines is a list of 1000 bytestrings each ending in \n,
1989
 
            dense_lines may be a list with one line in it, containing all the
1990
 
            1000's lines and their \n's. Using dense_lines if it is already
1991
 
            known is a win because the string join to create bytes in this
1992
 
            function spends less time resizing the final string.
1993
 
        :return: (len, a StringIO instance with the raw data ready to read.)
 
2090
            instance, if lines is a list of 1000 bytestrings each ending in
 
2091
            \\n, dense_lines may be a list with one line in it, containing all
 
2092
            the 1000's lines and their \\n's. Using dense_lines if it is
 
2093
            already known is a win because the string join to create bytes in
 
2094
            this function spends less time resizing the final string.
 
2095
        :return: (len, chunked bytestring with compressed data)
1994
2096
        """
1995
 
        chunks = ["version %s %d %s\n" % (key[-1], len(lines), digest)]
 
2097
        chunks = [b"version %s %d %s\n" % (key[-1], len(lines), digest)]
1996
2098
        chunks.extend(dense_lines or lines)
1997
 
        chunks.append("end %s\n" % key[-1])
 
2099
        chunks.append(b"end " + key[-1] + b"\n")
1998
2100
        for chunk in chunks:
1999
 
            if type(chunk) is not str:
 
2101
            if not isinstance(chunk, bytes):
2000
2102
                raise AssertionError(
2001
2103
                    'data must be plain bytes was %s' % type(chunk))
2002
 
        if lines and lines[-1][-1] != '\n':
 
2104
        if lines and not lines[-1].endswith(b'\n'):
2003
2105
            raise ValueError('corrupt lines value %r' % lines)
2004
 
        compressed_bytes = tuned_gzip.chunks_to_gzip(chunks)
2005
 
        return len(compressed_bytes), compressed_bytes
 
2106
        compressed_chunks = tuned_gzip.chunks_to_gzip(chunks)
 
2107
        return sum(map(len, compressed_chunks)), compressed_chunks
2006
2108
 
2007
2109
    def _split_header(self, line):
2008
2110
        rec = line.split()
2015
2117
        """See VersionedFiles.keys."""
2016
2118
        if 'evil' in debug.debug_flags:
2017
2119
            trace.mutter_callsite(2, "keys scales with size of history")
2018
 
        sources = [self._index] + self._fallback_vfs
 
2120
        sources = [self._index] + self._immediate_fallback_vfs
2019
2121
        result = set()
2020
2122
        for source in sources:
2021
2123
            result.update(source.keys())
2033
2135
        # Note that _get_content is only called when the _ContentMapGenerator
2034
2136
        # has been constructed with just one key requested for reconstruction.
2035
2137
        if key in self.nonlocal_keys:
2036
 
            record = self.get_record_stream().next()
 
2138
            record = next(self.get_record_stream())
2037
2139
            # Create a content object on the fly
2038
 
            lines = osutils.chunks_to_lines(record.get_bytes_as('chunked'))
 
2140
            lines = record.get_bytes_as('lines')
2039
2141
            return PlainKnitContent(lines, record.key)
2040
2142
        else:
2041
2143
            # local keys we can ask for directly
2061
2163
 
2062
2164
        missing_keys = set(nonlocal_keys)
2063
2165
        # Read from remote versioned file instances and provide to our caller.
2064
 
        for source in self.vf._fallback_vfs:
 
2166
        for source in self.vf._immediate_fallback_vfs:
2065
2167
            if not missing_keys:
2066
2168
                break
2067
2169
            # Loop over fallback repositories asking them for texts - ignore
2068
2170
            # any missing from a particular fallback.
2069
2171
            for record in source.get_record_stream(missing_keys,
2070
 
                self._ordering, True):
 
2172
                                                   self._ordering, True):
2071
2173
                if record.storage_kind == 'absent':
2072
2174
                    # Not in thie particular stream, may be in one of the
2073
2175
                    # other fallback vfs objects.
2126
2228
                if component_id in self._contents_map:
2127
2229
                    content = self._contents_map[component_id]
2128
2230
                else:
2129
 
                    content, delta = self._factory.parse_record(key[-1],
2130
 
                        record, record_details, content,
 
2231
                    content, delta = self._factory.parse_record(
 
2232
                        key[-1], record, record_details, content,
2131
2233
                        copy_base_content=multiple_versions)
2132
2234
                    if multiple_versions:
2133
2235
                        self._contents_map[component_id] = content
2156
2258
        """
2157
2259
        lines = []
2158
2260
        # kind marker for dispatch on the far side,
2159
 
        lines.append('knit-delta-closure')
 
2261
        lines.append(b'knit-delta-closure')
2160
2262
        # Annotated or not
2161
2263
        if self.vf._factory.annotated:
2162
 
            lines.append('annotated')
 
2264
            lines.append(b'annotated')
2163
2265
        else:
2164
 
            lines.append('')
 
2266
            lines.append(b'')
2165
2267
        # 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]))
 
2268
        lines.append(b'\t'.join(b'\x00'.join(key) for key in self.keys
 
2269
                                if key not in self.nonlocal_keys))
2168
2270
        # then the _raw_record_map in serialised form:
2169
2271
        map_byte_list = []
2170
2272
        # for each item in the map:
2175
2277
        # one line with next ('' for None)
2176
2278
        # one line with byte count of the record bytes
2177
2279
        # the record bytes
2178
 
        for key, (record_bytes, (method, noeol), next) in \
2179
 
            self._raw_record_map.iteritems():
2180
 
            key_bytes = '\x00'.join(key)
 
2280
        for key, (record_bytes, (method, noeol), next) in viewitems(
 
2281
                self._raw_record_map):
 
2282
            key_bytes = b'\x00'.join(key)
2181
2283
            parents = self.global_map.get(key, None)
2182
2284
            if parents is None:
2183
 
                parent_bytes = 'None:'
 
2285
                parent_bytes = b'None:'
2184
2286
            else:
2185
 
                parent_bytes = '\t'.join('\x00'.join(key) for key in parents)
2186
 
            method_bytes = method
 
2287
                parent_bytes = b'\t'.join(b'\x00'.join(key) for key in parents)
 
2288
            method_bytes = method.encode('ascii')
2187
2289
            if noeol:
2188
 
                noeol_bytes = "T"
 
2290
                noeol_bytes = b"T"
2189
2291
            else:
2190
 
                noeol_bytes = "F"
 
2292
                noeol_bytes = b"F"
2191
2293
            if next:
2192
 
                next_bytes = '\x00'.join(next)
 
2294
                next_bytes = b'\x00'.join(next)
2193
2295
            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)
 
2296
                next_bytes = b''
 
2297
            map_byte_list.append(b'\n'.join(
 
2298
                [key_bytes, parent_bytes, method_bytes, noeol_bytes, next_bytes,
 
2299
                 b'%d' % len(record_bytes), record_bytes]))
 
2300
        map_bytes = b''.join(map_byte_list)
2199
2301
        lines.append(map_bytes)
2200
 
        bytes = '\n'.join(lines)
 
2302
        bytes = b'\n'.join(lines)
2201
2303
        return bytes
2202
2304
 
2203
2305
 
2205
2307
    """Content map generator reading from a VersionedFiles object."""
2206
2308
 
2207
2309
    def __init__(self, versioned_files, keys, nonlocal_keys=None,
2208
 
        global_map=None, raw_record_map=None, ordering='unordered'):
 
2310
                 global_map=None, raw_record_map=None, ordering='unordered'):
2209
2311
        """Create a _ContentMapGenerator.
2210
2312
 
2211
2313
        :param versioned_files: The versioned files that the texts are being
2240
2342
        self._record_map = None
2241
2343
        if raw_record_map is None:
2242
2344
            self._raw_record_map = self.vf._get_record_map_unparsed(keys,
2243
 
                allow_missing=True)
 
2345
                                                                    allow_missing=True)
2244
2346
        else:
2245
2347
            self._raw_record_map = raw_record_map
2246
2348
        # the factory for parsing records
2262
2364
        self.vf = KnitVersionedFiles(None, None)
2263
2365
        start = line_end
2264
2366
        # Annotated or not
2265
 
        line_end = bytes.find('\n', start)
 
2367
        line_end = bytes.find(b'\n', start)
2266
2368
        line = bytes[start:line_end]
2267
2369
        start = line_end + 1
2268
 
        if line == 'annotated':
 
2370
        if line == b'annotated':
2269
2371
            self._factory = KnitAnnotateFactory()
2270
2372
        else:
2271
2373
            self._factory = KnitPlainFactory()
2272
2374
        # list of keys to emit in get_record_stream
2273
 
        line_end = bytes.find('\n', start)
 
2375
        line_end = bytes.find(b'\n', start)
2274
2376
        line = bytes[start:line_end]
2275
2377
        start = line_end + 1
2276
2378
        self.keys = [
2277
 
            tuple(segment.split('\x00')) for segment in line.split('\t')
 
2379
            tuple(segment.split(b'\x00')) for segment in line.split(b'\t')
2278
2380
            if segment]
2279
2381
        # now a loop until the end. XXX: It would be nice if this was just a
2280
2382
        # bunch of the same records as get_record_stream(..., False) gives, but
2282
2384
        end = len(bytes)
2283
2385
        while start < end:
2284
2386
            # 1 line with key
2285
 
            line_end = bytes.find('\n', start)
2286
 
            key = tuple(bytes[start:line_end].split('\x00'))
 
2387
            line_end = bytes.find(b'\n', start)
 
2388
            key = tuple(bytes[start:line_end].split(b'\x00'))
2287
2389
            start = line_end + 1
2288
2390
            # 1 line with parents (None: for None, '' for ())
2289
 
            line_end = bytes.find('\n', start)
 
2391
            line_end = bytes.find(b'\n', start)
2290
2392
            line = bytes[start:line_end]
2291
 
            if line == 'None:':
 
2393
            if line == b'None:':
2292
2394
                parents = None
2293
2395
            else:
2294
2396
                parents = tuple(
2295
 
                    [tuple(segment.split('\x00')) for segment in line.split('\t')
2296
 
                     if segment])
 
2397
                    tuple(segment.split(b'\x00')) for segment in line.split(b'\t')
 
2398
                    if segment)
2297
2399
            self.global_map[key] = parents
2298
2400
            start = line_end + 1
2299
2401
            # one line with method
2300
 
            line_end = bytes.find('\n', start)
 
2402
            line_end = bytes.find(b'\n', start)
2301
2403
            line = bytes[start:line_end]
2302
 
            method = line
 
2404
            method = line.decode('ascii')
2303
2405
            start = line_end + 1
2304
2406
            # one line with noeol
2305
 
            line_end = bytes.find('\n', start)
 
2407
            line_end = bytes.find(b'\n', start)
2306
2408
            line = bytes[start:line_end]
2307
 
            noeol = line == "T"
 
2409
            noeol = line == b"T"
2308
2410
            start = line_end + 1
2309
 
            # one line with next ('' for None)
2310
 
            line_end = bytes.find('\n', start)
 
2411
            # one line with next (b'' for None)
 
2412
            line_end = bytes.find(b'\n', start)
2311
2413
            line = bytes[start:line_end]
2312
2414
            if not line:
2313
2415
                next = None
2314
2416
            else:
2315
 
                next = tuple(bytes[start:line_end].split('\x00'))
 
2417
                next = tuple(bytes[start:line_end].split(b'\x00'))
2316
2418
            start = line_end + 1
2317
2419
            # one line with byte count of the record bytes
2318
 
            line_end = bytes.find('\n', start)
 
2420
            line_end = bytes.find(b'\n', start)
2319
2421
            line = bytes[start:line_end]
2320
2422
            count = int(line)
2321
2423
            start = line_end + 1
2322
2424
            # the record bytes
2323
 
            record_bytes = bytes[start:start+count]
 
2425
            record_bytes = bytes[start:start + count]
2324
2426
            start = start + count
2325
2427
            # put it in the map
2326
2428
            self._raw_record_map[key] = (record_bytes, (method, noeol), next)
2395
2497
        ABI change with the C extension that reads .kndx files.
2396
2498
    """
2397
2499
 
2398
 
    HEADER = "# bzr knit index 8\n"
 
2500
    HEADER = b"# bzr knit index 8\n"
2399
2501
 
2400
2502
    def __init__(self, transport, mapper, get_scope, allow_writes, is_locked):
2401
2503
        """Create a _KndxIndex on transport using mapper."""
2440
2542
 
2441
2543
            try:
2442
2544
                for key, options, (_, pos, size), parents in path_keys:
 
2545
                    if not all(isinstance(option, bytes) for option in options):
 
2546
                        raise TypeError(options)
2443
2547
                    if parents is None:
2444
2548
                        # kndx indices cannot be parentless.
2445
2549
                        parents = ()
2446
 
                    line = "\n%s %s %s %s %s :" % (
2447
 
                        key[-1], ','.join(options), pos, size,
2448
 
                        self._dictionary_compress(parents))
2449
 
                    if type(line) is not str:
 
2550
                    line = b' '.join([
 
2551
                        b'\n'
 
2552
                        + key[-1], b','.join(options), b'%d' % pos, b'%d' % size,
 
2553
                        self._dictionary_compress(parents), b':'])
 
2554
                    if not isinstance(line, bytes):
2450
2555
                        raise AssertionError(
2451
2556
                            'data must be utf8 was %s' % type(line))
2452
2557
                    lines.append(line)
2453
2558
                    self._cache_key(key, options, pos, size, parents)
2454
2559
                if len(orig_history):
2455
 
                    self._transport.append_bytes(path, ''.join(lines))
 
2560
                    self._transport.append_bytes(path, b''.join(lines))
2456
2561
                else:
2457
2562
                    self._init_index(path, lines)
2458
2563
            except:
2496
2601
        else:
2497
2602
            index = cache[version_id][5]
2498
2603
        cache[version_id] = (version_id,
2499
 
                                   options,
2500
 
                                   pos,
2501
 
                                   size,
2502
 
                                   parents,
2503
 
                                   index)
 
2604
                             options,
 
2605
                             pos,
 
2606
                             size,
 
2607
                             parents,
 
2608
                             index)
2504
2609
 
2505
2610
    def check_header(self, fp):
2506
2611
        line = fp.readline()
2507
 
        if line == '':
 
2612
        if line == b'':
2508
2613
            # An empty file can actually be treated as though the file doesn't
2509
2614
            # exist yet.
2510
2615
            raise errors.NoSuchFile(self)
2549
2654
        result = {}
2550
2655
        for key in keys:
2551
2656
            if key not in parent_map:
2552
 
                continue # Ghost
 
2657
                continue  # Ghost
2553
2658
            method = self.get_method(key)
 
2659
            if not isinstance(method, str):
 
2660
                raise TypeError(method)
2554
2661
            parents = parent_map[key]
2555
2662
            if method == 'fulltext':
2556
2663
                compression_parent = None
2557
2664
            else:
2558
2665
                compression_parent = parents[0]
2559
 
            noeol = 'no-eol' in self.get_options(key)
 
2666
            noeol = b'no-eol' in self.get_options(key)
2560
2667
            index_memo = self.get_position(key)
2561
2668
            result[key] = (index_memo, compression_parent,
2562
 
                                  parents, (method, noeol))
 
2669
                           parents, (method, noeol))
2563
2670
        return result
2564
2671
 
2565
2672
    def get_method(self, key):
2566
2673
        """Return compression method of specified key."""
2567
2674
        options = self.get_options(key)
2568
 
        if 'fulltext' in options:
 
2675
        if b'fulltext' in options:
2569
2676
            return 'fulltext'
2570
 
        elif 'line-delta' in options:
 
2677
        elif b'line-delta' in options:
2571
2678
            return 'line-delta'
2572
2679
        else:
2573
 
            raise errors.KnitIndexUnknownMethod(self, options)
 
2680
            raise KnitIndexUnknownMethod(self, options)
2574
2681
 
2575
2682
    def get_options(self, key):
2576
2683
        """Return a list representing options.
2608
2715
                                     for suffix in suffix_parents])
2609
2716
                parent_map[key] = parent_keys
2610
2717
                pending_keys.extend([p for p in parent_keys
2611
 
                                        if p not in parent_map])
 
2718
                                     if p not in parent_map])
2612
2719
        return parent_map, missing_keys
2613
2720
 
2614
2721
    def get_parent_map(self, keys):
2632
2739
                pass
2633
2740
            else:
2634
2741
                result[key] = tuple(prefix + (suffix,) for
2635
 
                    suffix in suffix_parents)
 
2742
                                    suffix in suffix_parents)
2636
2743
        return result
2637
2744
 
2638
2745
    def get_position(self, key):
2646
2753
        entry = self._kndx_cache[prefix][0][suffix]
2647
2754
        return key, entry[2], entry[3]
2648
2755
 
2649
 
    has_key = _mod_index._has_key_from_parent_map
 
2756
    __contains__ = _mod_index._has_key_from_parent_map
2650
2757
 
2651
2758
    def _init_index(self, path, extra_lines=[]):
2652
2759
        """Initialize an index."""
2653
 
        sio = StringIO()
 
2760
        sio = BytesIO()
2654
2761
        sio.write(self.HEADER)
2655
2762
        sio.writelines(extra_lines)
2656
2763
        sio.seek(0)
2657
2764
        self._transport.put_file_non_atomic(path, sio,
2658
 
                            create_parent_dir=True)
2659
 
                           # self._create_parent_dir)
2660
 
                           # mode=self._file_mode,
2661
 
                           # dir_mode=self._dir_mode)
 
2765
                                            create_parent_dir=True)
 
2766
        # self._create_parent_dir)
 
2767
        # mode=self._file_mode,
 
2768
        # dir_mode=self._dir_mode)
2662
2769
 
2663
2770
    def keys(self):
2664
2771
        """Get all the keys in the collection.
2668
2775
        result = set()
2669
2776
        # Identify all key prefixes.
2670
2777
        # XXX: A bit hacky, needs polish.
2671
 
        if type(self._mapper) is ConstantMapper:
 
2778
        if isinstance(self._mapper, ConstantMapper):
2672
2779
            prefixes = [()]
2673
2780
        else:
2674
2781
            relpaths = set()
2693
2800
                self._filename = prefix
2694
2801
                try:
2695
2802
                    path = self._mapper.map(prefix) + '.kndx'
2696
 
                    fp = self._transport.get(path)
2697
 
                    try:
 
2803
                    with self._transport.get(path) as fp:
2698
2804
                        # _load_data may raise NoSuchFile if the target knit is
2699
2805
                        # completely empty.
2700
2806
                        _load_data(self, fp)
2701
 
                    finally:
2702
 
                        fp.close()
2703
2807
                    self._kndx_cache[prefix] = (self._cache, self._history)
2704
2808
                    del self._cache
2705
2809
                    del self._filename
2706
2810
                    del self._history
2707
2811
                except NoSuchFile:
2708
2812
                    self._kndx_cache[prefix] = ({}, [])
2709
 
                    if type(self._mapper) is ConstantMapper:
 
2813
                    if isinstance(self._mapper, ConstantMapper):
2710
2814
                        # preserve behaviour for revisions.kndx etc.
2711
2815
                        self._init_index(path)
2712
2816
                    del self._cache
2732
2836
            '.' prefix.
2733
2837
        """
2734
2838
        if not keys:
2735
 
            return ''
 
2839
            return b''
2736
2840
        result_list = []
2737
2841
        prefix = keys[0][:-1]
2738
2842
        cache = self._kndx_cache[prefix][0]
2742
2846
                raise ValueError("mismatched prefixes for %r" % keys)
2743
2847
            if key[-1] in cache:
2744
2848
                # -- inlined lookup() --
2745
 
                result_list.append(str(cache[key[-1]][5]))
 
2849
                result_list.append(b'%d' % cache[key[-1]][5])
2746
2850
                # -- end lookup () --
2747
2851
            else:
2748
 
                result_list.append('.' + key[-1])
2749
 
        return ' '.join(result_list)
 
2852
                result_list.append(b'.' + key[-1])
 
2853
        return b' '.join(result_list)
2750
2854
 
2751
2855
    def _reset_cache(self):
2752
2856
        # Possibly this should be a LRU cache. A dictionary from key_prefix to
2783
2887
 
2784
2888
    def _split_key(self, key):
2785
2889
        """Split key into a prefix and suffix."""
 
2890
        # GZ 2018-07-03: This is intentionally either a sequence or bytes?
 
2891
        if isinstance(key, bytes):
 
2892
            return key[:-1], key[-1:]
2786
2893
        return key[:-1], key[-1]
2787
2894
 
2788
2895
 
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
2896
class _KnitGraphIndex(object):
2848
2897
    """A KnitVersionedFiles index layered on GraphIndex."""
2849
2898
 
2850
2899
    def __init__(self, graph_index, is_locked, deltas=False, parents=True,
2851
 
        add_callback=None, track_external_parent_refs=False):
 
2900
                 add_callback=None, track_external_parent_refs=False):
2852
2901
        """Construct a KnitGraphIndex on a graph_index.
2853
2902
 
2854
 
        :param graph_index: An implementation of bzrlib.index.GraphIndex.
 
2903
        :param graph_index: An implementation of breezy.index.GraphIndex.
2855
2904
        :param is_locked: A callback to check whether the object should answer
2856
2905
            queries.
2857
2906
        :param deltas: Allow delta-compressed records.
2874
2923
            # XXX: TODO: Delta tree and parent graph should be conceptually
2875
2924
            # separate.
2876
2925
            raise KnitCorrupt(self, "Cannot do delta compression without "
2877
 
                "parent tracking.")
 
2926
                              "parent tracking.")
2878
2927
        self.has_graph = parents
2879
2928
        self._is_locked = is_locked
2880
2929
        self._missing_compression_parents = set()
2887
2936
        return "%s(%r)" % (self.__class__.__name__, self._graph_index)
2888
2937
 
2889
2938
    def add_records(self, records, random_id=False,
2890
 
        missing_compression_parents=False):
 
2939
                    missing_compression_parents=False):
2891
2940
        """Add multiple records to the index.
2892
2941
 
2893
2942
        This function does not insert data into the Immutable GraphIndex
2918
2967
                if key_dependencies is not None:
2919
2968
                    key_dependencies.add_references(key, parents)
2920
2969
            index, pos, size = access_memo
2921
 
            if 'no-eol' in options:
2922
 
                value = 'N'
 
2970
            if b'no-eol' in options:
 
2971
                value = b'N'
2923
2972
            else:
2924
 
                value = ' '
2925
 
            value += "%d %d" % (pos, size)
 
2973
                value = b' '
 
2974
            value += b"%d %d" % (pos, size)
2926
2975
            if not self._deltas:
2927
 
                if 'line-delta' in options:
2928
 
                    raise KnitCorrupt(self, "attempt to add line-delta in non-delta knit")
 
2976
                if b'line-delta' in options:
 
2977
                    raise KnitCorrupt(
 
2978
                        self, "attempt to add line-delta in non-delta knit")
2929
2979
            if self._parents:
2930
2980
                if self._deltas:
2931
 
                    if 'line-delta' in options:
 
2981
                    if b'line-delta' in options:
2932
2982
                        node_refs = (parents, (parents[0],))
2933
2983
                        if missing_compression_parents:
2934
2984
                            compression_parents.add(parents[0])
2939
2989
            else:
2940
2990
                if parents:
2941
2991
                    raise KnitCorrupt(self, "attempt to add node with parents "
2942
 
                        "in parentless index.")
 
2992
                                      "in parentless index.")
2943
2993
                node_refs = ()
2944
2994
            keys[key] = (value, node_refs)
2945
2995
        # check for dups
2950
3000
                # Sometimes these are passed as a list rather than a tuple
2951
3001
                passed = static_tuple.as_tuples(keys[key])
2952
3002
                passed_parents = passed[1][:1]
2953
 
                if (value[0] != keys[key][0][0] or
2954
 
                    parents != passed_parents):
 
3003
                if (value[0:1] != keys[key][0][0:1]
 
3004
                        or parents != passed_parents):
2955
3005
                    node_refs = static_tuple.as_tuples(node_refs)
2956
3006
                    raise KnitCorrupt(self, "inconsistent details in add_records"
2957
 
                        ": %s %s" % ((value, node_refs), passed))
 
3007
                                      ": %s %s" % ((value, node_refs), passed))
2958
3008
                del keys[key]
2959
3009
        result = []
2960
3010
        if self._parents:
2961
 
            for key, (value, node_refs) in keys.iteritems():
 
3011
            for key, (value, node_refs) in viewitems(keys):
2962
3012
                result.append((key, value, node_refs))
2963
3013
        else:
2964
 
            for key, (value, node_refs) in keys.iteritems():
 
3014
            for key, (value, node_refs) in viewitems(keys):
2965
3015
                result.append((key, value))
2966
3016
        self._add_callback(result)
2967
3017
        if missing_compression_parents:
3065
3115
                compression_parent_key = None
3066
3116
            else:
3067
3117
                compression_parent_key = self._compression_parent(entry)
3068
 
            noeol = (entry[2][0] == 'N')
 
3118
            noeol = (entry[2][0:1] == b'N')
3069
3119
            if compression_parent_key:
3070
3120
                method = 'line-delta'
3071
3121
            else:
3072
3122
                method = 'fulltext'
3073
3123
            result[key] = (self._node_to_position(entry),
3074
 
                                  compression_parent_key, parents,
3075
 
                                  (method, noeol))
 
3124
                           compression_parent_key, parents,
 
3125
                           (method, noeol))
3076
3126
        return result
3077
3127
 
3078
3128
    def _get_entries(self, keys, check_present=False):
3120
3170
        e.g. ['foo', 'bar']
3121
3171
        """
3122
3172
        node = self._get_node(key)
3123
 
        options = [self._get_method(node)]
3124
 
        if node[2][0] == 'N':
3125
 
            options.append('no-eol')
 
3173
        options = [self._get_method(node).encode('ascii')]
 
3174
        if node[2][0:1] == b'N':
 
3175
            options.append(b'no-eol')
3126
3176
        return options
3127
3177
 
3128
3178
    def find_ancestry(self, keys):
3156
3206
        node = self._get_node(key)
3157
3207
        return self._node_to_position(node)
3158
3208
 
3159
 
    has_key = _mod_index._has_key_from_parent_map
 
3209
    __contains__ = _mod_index._has_key_from_parent_map
3160
3210
 
3161
3211
    def keys(self):
3162
3212
        """Get all the keys in the collection.
3170
3220
 
3171
3221
    def _node_to_position(self, node):
3172
3222
        """Convert an index value to position details."""
3173
 
        bits = node[2][1:].split(' ')
 
3223
        bits = node[2][1:].split(b' ')
3174
3224
        return node[0], int(bits[0]), int(bits[1])
3175
3225
 
3176
3226
    def _sort_keys_by_io(self, keys, positions):
3208
3258
        self._transport = transport
3209
3259
        self._mapper = mapper
3210
3260
 
 
3261
    def add_raw_record(self, key, size, raw_data):
 
3262
        """Add raw knit bytes to a storage area.
 
3263
 
 
3264
        The data is spooled to the container writer in one bytes-record per
 
3265
        raw data item.
 
3266
 
 
3267
        :param key: The key of the raw data segment
 
3268
        :param size: The size of the raw data segment
 
3269
        :param raw_data: A chunked bytestring containing the data.
 
3270
        :return: opaque index memo to retrieve the record later.
 
3271
            For _KnitKeyAccess the memo is (key, pos, length), where the key is
 
3272
            the record key.
 
3273
        """
 
3274
        path = self._mapper.map(key)
 
3275
        try:
 
3276
            base = self._transport.append_bytes(path + '.knit', b''.join(raw_data))
 
3277
        except errors.NoSuchFile:
 
3278
            self._transport.mkdir(osutils.dirname(path))
 
3279
            base = self._transport.append_bytes(path + '.knit', b''.join(raw_data))
 
3280
        # if base == 0:
 
3281
        # chmod.
 
3282
        return (key, base, size)
 
3283
 
3211
3284
    def add_raw_records(self, key_sizes, raw_data):
3212
3285
        """Add raw knit bytes to a storage area.
3213
3286
 
3216
3289
 
3217
3290
        :param sizes: An iterable of tuples containing the key and size of each
3218
3291
            raw data segment.
3219
 
        :param raw_data: A bytestring containing the data.
 
3292
        :param raw_data: A chunked bytestring containing the data.
3220
3293
        :return: A list of memos to retrieve the record later. Each memo is an
3221
3294
            opaque index memo. For _KnitKeyAccess the memo is (key, pos,
3222
3295
            length), where the key is the record key.
3223
3296
        """
3224
 
        if type(raw_data) is not str:
 
3297
        raw_data = b''.join(raw_data)
 
3298
        if not isinstance(raw_data, bytes):
3225
3299
            raise AssertionError(
3226
3300
                'data must be plain bytes was %s' % type(raw_data))
3227
3301
        result = []
3230
3304
        # append() is relatively expensive by grouping the writes to each key
3231
3305
        # prefix.
3232
3306
        for key, size in key_sizes:
3233
 
            path = self._mapper.map(key)
3234
 
            try:
3235
 
                base = self._transport.append_bytes(path + '.knit',
3236
 
                    raw_data[offset:offset+size])
3237
 
            except errors.NoSuchFile:
3238
 
                self._transport.mkdir(osutils.dirname(path))
3239
 
                base = self._transport.append_bytes(path + '.knit',
3240
 
                    raw_data[offset:offset+size])
3241
 
            # if base == 0:
3242
 
            # chmod.
 
3307
            record_bytes = [raw_data[offset:offset + size]]
 
3308
            result.append(self.add_raw_record(key, size, record_bytes))
3243
3309
            offset += size
3244
 
            result.append((key, base, size))
3245
3310
        return result
3246
3311
 
3247
3312
    def flush(self):
3248
3313
        """Flush pending writes on this access object.
3249
 
        
 
3314
 
3250
3315
        For .knit files this is a no-op.
3251
3316
        """
3252
3317
        pass
3278
3343
                yield data
3279
3344
 
3280
3345
 
3281
 
class _DirectPackAccess(object):
3282
 
    """Access to data in one or more packs with less translation."""
3283
 
 
3284
 
    def __init__(self, index_to_packs, reload_func=None, flush_func=None):
3285
 
        """Create a _DirectPackAccess object.
3286
 
 
3287
 
        :param index_to_packs: A dict mapping index objects to the transport
3288
 
            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
 
        """
3293
 
        self._container_writer = None
3294
 
        self._write_index = None
3295
 
        self._indices = index_to_packs
3296
 
        self._reload_func = reload_func
3297
 
        self._flush_func = flush_func
3298
 
 
3299
 
    def add_raw_records(self, key_sizes, raw_data):
3300
 
        """Add raw knit bytes to a storage area.
3301
 
 
3302
 
        The data is spooled to the container writer in one bytes-record per
3303
 
        raw data item.
3304
 
 
3305
 
        :param sizes: An iterable of tuples containing the key and size of each
3306
 
            raw data segment.
3307
 
        :param raw_data: A bytestring containing the data.
3308
 
        :return: A list of memos to retrieve the record later. Each memo is an
3309
 
            opaque index memo. For _DirectPackAccess the memo is (index, pos,
3310
 
            length), where the index field is the write_index object supplied
3311
 
            to the PackAccess object.
3312
 
        """
3313
 
        if type(raw_data) is not str:
3314
 
            raise AssertionError(
3315
 
                'data must be plain bytes was %s' % type(raw_data))
3316
 
        result = []
3317
 
        offset = 0
3318
 
        for key, size in key_sizes:
3319
 
            p_offset, p_length = self._container_writer.add_bytes_record(
3320
 
                raw_data[offset:offset+size], [])
3321
 
            offset += size
3322
 
            result.append((self._write_index, p_offset, p_length))
3323
 
        return result
3324
 
 
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
 
    def get_raw_records(self, memos_for_retrieval):
3334
 
        """Get the raw bytes for a records.
3335
 
 
3336
 
        :param memos_for_retrieval: An iterable containing the (index, pos,
3337
 
            length) memo for retrieving the bytes. The Pack access method
3338
 
            looks up the pack to use for a given record in its index_to_pack
3339
 
            map.
3340
 
        :return: An iterator over the bytes of the records.
3341
 
        """
3342
 
        # first pass, group into same-index requests
3343
 
        request_lists = []
3344
 
        current_index = None
3345
 
        for (index, offset, length) in memos_for_retrieval:
3346
 
            if current_index == index:
3347
 
                current_list.append((offset, length))
3348
 
            else:
3349
 
                if current_index is not None:
3350
 
                    request_lists.append((current_index, current_list))
3351
 
                current_index = index
3352
 
                current_list = [(offset, length)]
3353
 
        # handle the last entry
3354
 
        if current_index is not None:
3355
 
            request_lists.append((current_index, current_list))
3356
 
        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())
3382
 
 
3383
 
    def set_writer(self, writer, index, transport_packname):
3384
 
        """Set a writer to use for adding data."""
3385
 
        if index is not None:
3386
 
            self._indices[index] = transport_packname
3387
 
        self._container_writer = writer
3388
 
        self._write_index = index
3389
 
 
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
 
 
3420
 
# Deprecated, use PatienceSequenceMatcher instead
3421
 
KnitSequenceMatcher = patiencediff.PatienceSequenceMatcher
3422
 
 
3423
 
 
3424
3346
def annotate_knit(knit, revision_id):
3425
3347
    """Annotate a knit with no cached annotations.
3426
3348
 
3469
3391
            passing to read_records_iter to start reading in the raw data from
3470
3392
            the pack file.
3471
3393
        """
3472
 
        pending = set([key])
 
3394
        pending = {key}
3473
3395
        records = []
3474
3396
        ann_keys = set()
3475
3397
        self._num_needed_children[key] = 1
3480
3402
            self._all_build_details.update(build_details)
3481
3403
            # new_nodes = self._vf._index._get_entries(this_iteration)
3482
3404
            pending = set()
3483
 
            for key, details in build_details.iteritems():
 
3405
            for key, details in viewitems(build_details):
3484
3406
                (index_memo, compression_parent, parent_keys,
3485
3407
                 record_details) = details
3486
3408
                self._parent_map[key] = parent_keys
3488
3410
                records.append((key, index_memo))
3489
3411
                # Do we actually need to check _annotated_lines?
3490
3412
                pending.update([p for p in parent_keys
3491
 
                                   if p not in self._all_build_details])
 
3413
                                if p not in self._all_build_details])
3492
3414
                if parent_keys:
3493
3415
                    for parent_key in parent_keys:
3494
3416
                        if parent_key in self._num_needed_children:
3501
3423
                    else:
3502
3424
                        self._num_compression_children[compression_parent] = 1
3503
3425
 
3504
 
            missing_versions = this_iteration.difference(build_details.keys())
 
3426
            missing_versions = this_iteration.difference(build_details)
3505
3427
            if missing_versions:
3506
3428
                for key in missing_versions:
3507
3429
                    if key in self._parent_map and key in self._text_cache:
3515
3437
                            else:
3516
3438
                                self._num_needed_children[parent_key] = 1
3517
3439
                        pending.update([p for p in parent_keys
3518
 
                                           if p not in self._all_build_details])
 
3440
                                        if p not in self._all_build_details])
3519
3441
                    else:
3520
3442
                        raise errors.RevisionNotPresent(key, self._vf)
3521
3443
        # Generally we will want to read the records in reverse order, because
3524
3446
        return records, ann_keys
3525
3447
 
3526
3448
    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:
 
3449
        # if True or len(self._vf._immediate_fallback_vfs) > 0:
 
3450
        if len(self._vf._immediate_fallback_vfs) > 0:
3529
3451
            # If we have fallbacks, go to the generic path
3530
3452
            for v in annotate.Annotator._get_needed_texts(self, key, pb=pb):
3531
3453
                yield v
3534
3456
            try:
3535
3457
                records, ann_keys = self._get_build_graph(key)
3536
3458
                for idx, (sub_key, text, num_lines) in enumerate(
3537
 
                                                self._extract_texts(records)):
 
3459
                        self._extract_texts(records)):
3538
3460
                    if pb is not None:
3539
 
                        pb.update('annotating', idx, len(records))
 
3461
                        pb.update(gettext('annotating'), idx, len(records))
3540
3462
                    yield sub_key, text, num_lines
3541
3463
                for sub_key in ann_keys:
3542
3464
                    text = self._text_cache[sub_key]
3543
 
                    num_lines = len(text) # bad assumption
 
3465
                    num_lines = len(text)  # bad assumption
3544
3466
                    yield sub_key, text, num_lines
3545
3467
                return
3546
 
            except errors.RetryWithNewPacks, e:
 
3468
            except errors.RetryWithNewPacks as e:
3547
3469
                self._vf._access.reload_or_raise(e)
3548
3470
                # The cached build_details are no longer valid
3549
3471
                self._all_build_details.clear()
3550
3472
 
3551
3473
    def _cache_delta_blocks(self, key, compression_parent, delta, lines):
3552
3474
        parent_lines = self._text_cache[compression_parent]
3553
 
        blocks = list(KnitContent.get_line_delta_blocks(delta, parent_lines, lines))
 
3475
        blocks = list(KnitContent.get_line_delta_blocks(
 
3476
            delta, parent_lines, lines))
3554
3477
        self._matching_blocks[(key, compression_parent)] = blocks
3555
3478
 
3556
3479
    def _expand_record(self, key, parent_keys, compression_parent, record,
3609
3532
            parent_annotations = self._annotations_cache[parent_key]
3610
3533
            return parent_annotations, blocks
3611
3534
        return annotate.Annotator._get_parent_annotations_and_matches(self,
3612
 
            key, text, parent_key)
 
3535
                                                                      key, text, parent_key)
3613
3536
 
3614
3537
    def _process_pending(self, key):
3615
3538
        """The content for 'key' was just processed.
3646
3569
                # Note that if there are multiple parents, we need to wait
3647
3570
                # for all of them.
3648
3571
                self._pending_annotation.setdefault(parent_key,
3649
 
                    []).append((key, parent_keys))
 
3572
                                                    []).append((key, parent_keys))
3650
3573
                return False
3651
3574
        return True
3652
3575
 
3707
3630
                    yield key, lines, len(lines)
3708
3631
                    to_process.extend(self._process_pending(key))
3709
3632
 
 
3633
 
3710
3634
try:
3711
 
    from bzrlib._knit_load_data_pyx import _load_data_c as _load_data
3712
 
except ImportError, e:
 
3635
    from ._knit_load_data_pyx import _load_data_c as _load_data
 
3636
except ImportError as e:
3713
3637
    osutils.failed_to_load_extension(e)
3714
 
    from bzrlib._knit_load_data_py import _load_data_py as _load_data
 
3638
    from ._knit_load_data_py import _load_data_py as _load_data