← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/knit.py

  • Committer: Andrew Bennetts
  • Date: 2008-09-05 10:48:03 UTC
  • mto: This revision was merged to the branch mainline in revision 3693.
  • Revision ID: andrew.bennetts@canonical.com-20080905104803-6g72dz6wcldosfs2
Remove monkey-patching of branch._ensure_real from test_remote.py.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/knit.py
1
 
# Copyright (C) 2005, 2006 by Canonical Ltd
2
 
# Written by Martin Pool.
3
 
# Modified by Johan Rydberg <jrydberg@gnu.org>
4
 
# Modified by Robert Collins <robert.collins@canonical.com>
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
5
2
#
6
3
# This program is free software; you can redistribute it and/or modify
7
4
# it under the terms of the GNU General Public License as published by
63
60
# record content length ?
64
61
                  
65
62
 
66
 
from copy import copy
67
63
from cStringIO import StringIO
68
 
import difflib
69
64
from itertools import izip, chain
 
65
import operator
70
66
import os
71
 
import sys
72
67
 
73
 
import bzrlib
74
 
import bzrlib.errors as errors
75
 
from bzrlib.errors import FileExists, NoSuchFile, KnitError, \
76
 
        InvalidRevisionId, KnitCorrupt, KnitHeaderError, \
77
 
        RevisionNotPresent, RevisionAlreadyPresent
78
 
from bzrlib.tuned_gzip import *
79
 
from bzrlib.trace import mutter
80
 
from bzrlib.osutils import contains_whitespace, contains_linebreaks, \
81
 
     sha_strings
82
 
from bzrlib.versionedfile import VersionedFile, InterVersionedFile
83
 
from bzrlib.tsort import topo_sort
84
 
import bzrlib.weave
 
68
from bzrlib.lazy_import import lazy_import
 
69
lazy_import(globals(), """
 
70
from bzrlib import (
 
71
    annotate,
 
72
    debug,
 
73
    diff,
 
74
    graph as _mod_graph,
 
75
    index as _mod_index,
 
76
    lru_cache,
 
77
    pack,
 
78
    progress,
 
79
    trace,
 
80
    tsort,
 
81
    tuned_gzip,
 
82
    )
 
83
""")
 
84
from bzrlib import (
 
85
    errors,
 
86
    osutils,
 
87
    patiencediff,
 
88
    )
 
89
from bzrlib.errors import (
 
90
    FileExists,
 
91
    NoSuchFile,
 
92
    KnitError,
 
93
    InvalidRevisionId,
 
94
    KnitCorrupt,
 
95
    KnitHeaderError,
 
96
    RevisionNotPresent,
 
97
    RevisionAlreadyPresent,
 
98
    )
 
99
from bzrlib.osutils import (
 
100
    contains_whitespace,
 
101
    contains_linebreaks,
 
102
    sha_string,
 
103
    sha_strings,
 
104
    split_lines,
 
105
    )
 
106
from bzrlib.versionedfile import (
 
107
    AbsentContentFactory,
 
108
    adapter_registry,
 
109
    ConstantMapper,
 
110
    ContentFactory,
 
111
    FulltextContentFactory,
 
112
    VersionedFile,
 
113
    VersionedFiles,
 
114
    )
85
115
 
86
116
 
87
117
# TODO: Split out code specific to this format into an associated object.
101
131
INDEX_SUFFIX = '.kndx'
102
132
 
103
133
 
 
134
class KnitAdapter(object):
 
135
    """Base class for knit record adaption."""
 
136
 
 
137
    def __init__(self, basis_vf):
 
138
        """Create an adapter which accesses full texts from basis_vf.
 
139
        
 
140
        :param basis_vf: A versioned file to access basis texts of deltas from.
 
141
            May be None for adapters that do not need to access basis texts.
 
142
        """
 
143
        self._data = KnitVersionedFiles(None, None)
 
144
        self._annotate_factory = KnitAnnotateFactory()
 
145
        self._plain_factory = KnitPlainFactory()
 
146
        self._basis_vf = basis_vf
 
147
 
 
148
 
 
149
class FTAnnotatedToUnannotated(KnitAdapter):
 
150
    """An adapter from FT annotated knits to unannotated ones."""
 
151
 
 
152
    def get_bytes(self, factory, annotated_compressed_bytes):
 
153
        rec, contents = \
 
154
            self._data._parse_record_unchecked(annotated_compressed_bytes)
 
155
        content = self._annotate_factory.parse_fulltext(contents, rec[1])
 
156
        size, bytes = self._data._record_to_data((rec[1],), rec[3], content.text())
 
157
        return bytes
 
158
 
 
159
 
 
160
class DeltaAnnotatedToUnannotated(KnitAdapter):
 
161
    """An adapter for deltas from annotated to unannotated."""
 
162
 
 
163
    def get_bytes(self, factory, annotated_compressed_bytes):
 
164
        rec, contents = \
 
165
            self._data._parse_record_unchecked(annotated_compressed_bytes)
 
166
        delta = self._annotate_factory.parse_line_delta(contents, rec[1],
 
167
            plain=True)
 
168
        contents = self._plain_factory.lower_line_delta(delta)
 
169
        size, bytes = self._data._record_to_data((rec[1],), rec[3], contents)
 
170
        return bytes
 
171
 
 
172
 
 
173
class FTAnnotatedToFullText(KnitAdapter):
 
174
    """An adapter from FT annotated knits to unannotated ones."""
 
175
 
 
176
    def get_bytes(self, factory, annotated_compressed_bytes):
 
177
        rec, contents = \
 
178
            self._data._parse_record_unchecked(annotated_compressed_bytes)
 
179
        content, delta = self._annotate_factory.parse_record(factory.key[-1],
 
180
            contents, factory._build_details, None)
 
181
        return ''.join(content.text())
 
182
 
 
183
 
 
184
class DeltaAnnotatedToFullText(KnitAdapter):
 
185
    """An adapter for deltas from annotated to unannotated."""
 
186
 
 
187
    def get_bytes(self, factory, annotated_compressed_bytes):
 
188
        rec, contents = \
 
189
            self._data._parse_record_unchecked(annotated_compressed_bytes)
 
190
        delta = self._annotate_factory.parse_line_delta(contents, rec[1],
 
191
            plain=True)
 
192
        compression_parent = factory.parents[0]
 
193
        basis_entry = self._basis_vf.get_record_stream(
 
194
            [compression_parent], 'unordered', True).next()
 
195
        if basis_entry.storage_kind == 'absent':
 
196
            raise errors.RevisionNotPresent(compression_parent, self._basis_vf)
 
197
        basis_lines = split_lines(basis_entry.get_bytes_as('fulltext'))
 
198
        # Manually apply the delta because we have one annotated content and
 
199
        # one plain.
 
200
        basis_content = PlainKnitContent(basis_lines, compression_parent)
 
201
        basis_content.apply_delta(delta, rec[1])
 
202
        basis_content._should_strip_eol = factory._build_details[1]
 
203
        return ''.join(basis_content.text())
 
204
 
 
205
 
 
206
class FTPlainToFullText(KnitAdapter):
 
207
    """An adapter from FT plain knits to unannotated ones."""
 
208
 
 
209
    def get_bytes(self, factory, compressed_bytes):
 
210
        rec, contents = \
 
211
            self._data._parse_record_unchecked(compressed_bytes)
 
212
        content, delta = self._plain_factory.parse_record(factory.key[-1],
 
213
            contents, factory._build_details, None)
 
214
        return ''.join(content.text())
 
215
 
 
216
 
 
217
class DeltaPlainToFullText(KnitAdapter):
 
218
    """An adapter for deltas from annotated to unannotated."""
 
219
 
 
220
    def get_bytes(self, factory, compressed_bytes):
 
221
        rec, contents = \
 
222
            self._data._parse_record_unchecked(compressed_bytes)
 
223
        delta = self._plain_factory.parse_line_delta(contents, rec[1])
 
224
        compression_parent = factory.parents[0]
 
225
        # XXX: string splitting overhead.
 
226
        basis_entry = self._basis_vf.get_record_stream(
 
227
            [compression_parent], 'unordered', True).next()
 
228
        if basis_entry.storage_kind == 'absent':
 
229
            raise errors.RevisionNotPresent(compression_parent, self._basis_vf)
 
230
        basis_lines = split_lines(basis_entry.get_bytes_as('fulltext'))
 
231
        basis_content = PlainKnitContent(basis_lines, compression_parent)
 
232
        # Manually apply the delta because we have one annotated content and
 
233
        # one plain.
 
234
        content, _ = self._plain_factory.parse_record(rec[1], contents,
 
235
            factory._build_details, basis_content)
 
236
        return ''.join(content.text())
 
237
 
 
238
 
 
239
class KnitContentFactory(ContentFactory):
 
240
    """Content factory for streaming from knits.
 
241
    
 
242
    :seealso ContentFactory:
 
243
    """
 
244
 
 
245
    def __init__(self, key, parents, build_details, sha1, raw_record,
 
246
        annotated, knit=None):
 
247
        """Create a KnitContentFactory for key.
 
248
        
 
249
        :param key: The key.
 
250
        :param parents: The parents.
 
251
        :param build_details: The build details as returned from
 
252
            get_build_details.
 
253
        :param sha1: The sha1 expected from the full text of this object.
 
254
        :param raw_record: The bytes of the knit data from disk.
 
255
        :param annotated: True if the raw data is annotated.
 
256
        """
 
257
        ContentFactory.__init__(self)
 
258
        self.sha1 = sha1
 
259
        self.key = key
 
260
        self.parents = parents
 
261
        if build_details[0] == 'line-delta':
 
262
            kind = 'delta'
 
263
        else:
 
264
            kind = 'ft'
 
265
        if annotated:
 
266
            annotated_kind = 'annotated-'
 
267
        else:
 
268
            annotated_kind = ''
 
269
        self.storage_kind = 'knit-%s%s-gz' % (annotated_kind, kind)
 
270
        self._raw_record = raw_record
 
271
        self._build_details = build_details
 
272
        self._knit = knit
 
273
 
 
274
    def get_bytes_as(self, storage_kind):
 
275
        if storage_kind == self.storage_kind:
 
276
            return self._raw_record
 
277
        if storage_kind == 'fulltext' and self._knit is not None:
 
278
            return self._knit.get_text(self.key[0])
 
279
        else:
 
280
            raise errors.UnavailableRepresentation(self.key, storage_kind,
 
281
                self.storage_kind)
 
282
 
 
283
 
104
284
class KnitContent(object):
105
 
    """Content of a knit version to which deltas can be applied."""
106
 
 
107
 
    def __init__(self, lines):
108
 
        self._lines = lines
109
 
 
110
 
    def annotate_iter(self):
111
 
        """Yield tuples of (origin, text) for each content line."""
112
 
        for origin, text in self._lines:
113
 
            yield origin, text
114
 
 
115
 
    def annotate(self):
116
 
        """Return a list of (origin, text) tuples."""
117
 
        return list(self.annotate_iter())
 
285
    """Content of a knit version to which deltas can be applied.
 
286
    
 
287
    This is always stored in memory as a list of lines with \n at the end,
 
288
    plus a flag saying if the final ending is really there or not, because that 
 
289
    corresponds to the on-disk knit representation.
 
290
    """
 
291
 
 
292
    def __init__(self):
 
293
        self._should_strip_eol = False
 
294
 
 
295
    def apply_delta(self, delta, new_version_id):
 
296
        """Apply delta to this object to become new_version_id."""
 
297
        raise NotImplementedError(self.apply_delta)
118
298
 
119
299
    def line_delta_iter(self, new_lines):
120
300
        """Generate line-based delta from this content to new_lines."""
121
 
        new_texts = [text for origin, text in new_lines._lines]
122
 
        old_texts = [text for origin, text in self._lines]
123
 
        s = KnitSequenceMatcher(None, old_texts, new_texts)
124
 
        for op in s.get_opcodes():
125
 
            if op[0] == 'equal':
 
301
        new_texts = new_lines.text()
 
302
        old_texts = self.text()
 
303
        s = patiencediff.PatienceSequenceMatcher(None, old_texts, new_texts)
 
304
        for tag, i1, i2, j1, j2 in s.get_opcodes():
 
305
            if tag == 'equal':
126
306
                continue
127
 
            #     ofrom   oto   length        data
128
 
            yield (op[1], op[2], op[4]-op[3], new_lines._lines[op[3]:op[4]])
 
307
            # ofrom, oto, length, data
 
308
            yield i1, i2, j2 - j1, new_lines._lines[j1:j2]
129
309
 
130
310
    def line_delta(self, new_lines):
131
311
        return list(self.line_delta_iter(new_lines))
132
312
 
133
 
    def text(self):
134
 
        return [text for origin, text in self._lines]
 
313
    @staticmethod
 
314
    def get_line_delta_blocks(knit_delta, source, target):
 
315
        """Extract SequenceMatcher.get_matching_blocks() from a knit delta"""
 
316
        target_len = len(target)
 
317
        s_pos = 0
 
318
        t_pos = 0
 
319
        for s_begin, s_end, t_len, new_text in knit_delta:
 
320
            true_n = s_begin - s_pos
 
321
            n = true_n
 
322
            if n > 0:
 
323
                # knit deltas do not provide reliable info about whether the
 
324
                # last line of a file matches, due to eol handling.
 
325
                if source[s_pos + n -1] != target[t_pos + n -1]:
 
326
                    n-=1
 
327
                if n > 0:
 
328
                    yield s_pos, t_pos, n
 
329
            t_pos += t_len + true_n
 
330
            s_pos = s_end
 
331
        n = target_len - t_pos
 
332
        if n > 0:
 
333
            if source[s_pos + n -1] != target[t_pos + n -1]:
 
334
                n-=1
 
335
            if n > 0:
 
336
                yield s_pos, t_pos, n
 
337
        yield s_pos + (target_len - t_pos), target_len, 0
 
338
 
 
339
 
 
340
class AnnotatedKnitContent(KnitContent):
 
341
    """Annotated content."""
 
342
 
 
343
    def __init__(self, lines):
 
344
        KnitContent.__init__(self)
 
345
        self._lines = lines
 
346
 
 
347
    def annotate(self):
 
348
        """Return a list of (origin, text) for each content line."""
 
349
        lines = self._lines[:]
 
350
        if self._should_strip_eol:
 
351
            origin, last_line = lines[-1]
 
352
            lines[-1] = (origin, last_line.rstrip('\n'))
 
353
        return lines
 
354
 
 
355
    def apply_delta(self, delta, new_version_id):
 
356
        """Apply delta to this object to become new_version_id."""
 
357
        offset = 0
 
358
        lines = self._lines
 
359
        for start, end, count, delta_lines in delta:
 
360
            lines[offset+start:offset+end] = delta_lines
 
361
            offset = offset + (start - end) + count
 
362
 
 
363
    def text(self):
 
364
        try:
 
365
            lines = [text for origin, text in self._lines]
 
366
        except ValueError, e:
 
367
            # most commonly (only?) caused by the internal form of the knit
 
368
            # missing annotation information because of a bug - see thread
 
369
            # around 20071015
 
370
            raise KnitCorrupt(self,
 
371
                "line in annotated knit missing annotation information: %s"
 
372
                % (e,))
 
373
        if self._should_strip_eol:
 
374
            lines[-1] = lines[-1].rstrip('\n')
 
375
        return lines
 
376
 
 
377
    def copy(self):
 
378
        return AnnotatedKnitContent(self._lines[:])
 
379
 
 
380
 
 
381
class PlainKnitContent(KnitContent):
 
382
    """Unannotated content.
 
383
    
 
384
    When annotate[_iter] is called on this content, the same version is reported
 
385
    for all lines. Generally, annotate[_iter] is not useful on PlainKnitContent
 
386
    objects.
 
387
    """
 
388
 
 
389
    def __init__(self, lines, version_id):
 
390
        KnitContent.__init__(self)
 
391
        self._lines = lines
 
392
        self._version_id = version_id
 
393
 
 
394
    def annotate(self):
 
395
        """Return a list of (origin, text) for each content line."""
 
396
        return [(self._version_id, line) for line in self._lines]
 
397
 
 
398
    def apply_delta(self, delta, new_version_id):
 
399
        """Apply delta to this object to become new_version_id."""
 
400
        offset = 0
 
401
        lines = self._lines
 
402
        for start, end, count, delta_lines in delta:
 
403
            lines[offset+start:offset+end] = delta_lines
 
404
            offset = offset + (start - end) + count
 
405
        self._version_id = new_version_id
 
406
 
 
407
    def copy(self):
 
408
        return PlainKnitContent(self._lines[:], self._version_id)
 
409
 
 
410
    def text(self):
 
411
        lines = self._lines
 
412
        if self._should_strip_eol:
 
413
            lines = lines[:]
 
414
            lines[-1] = lines[-1].rstrip('\n')
 
415
        return lines
135
416
 
136
417
 
137
418
class _KnitFactory(object):
138
 
    """Base factory for creating content objects."""
139
 
 
140
 
    def make(self, lines, version):
141
 
        num_lines = len(lines)
142
 
        return KnitContent(zip([version] * num_lines, lines))
 
419
    """Base class for common Factory functions."""
 
420
 
 
421
    def parse_record(self, version_id, record, record_details,
 
422
                     base_content, copy_base_content=True):
 
423
        """Parse a record into a full content object.
 
424
 
 
425
        :param version_id: The official version id for this content
 
426
        :param record: The data returned by read_records_iter()
 
427
        :param record_details: Details about the record returned by
 
428
            get_build_details
 
429
        :param base_content: If get_build_details returns a compression_parent,
 
430
            you must return a base_content here, else use None
 
431
        :param copy_base_content: When building from the base_content, decide
 
432
            you can either copy it and return a new object, or modify it in
 
433
            place.
 
434
        :return: (content, delta) A Content object and possibly a line-delta,
 
435
            delta may be None
 
436
        """
 
437
        method, noeol = record_details
 
438
        if method == 'line-delta':
 
439
            if copy_base_content:
 
440
                content = base_content.copy()
 
441
            else:
 
442
                content = base_content
 
443
            delta = self.parse_line_delta(record, version_id)
 
444
            content.apply_delta(delta, version_id)
 
445
        else:
 
446
            content = self.parse_fulltext(record, version_id)
 
447
            delta = None
 
448
        content._should_strip_eol = noeol
 
449
        return (content, delta)
143
450
 
144
451
 
145
452
class KnitAnnotateFactory(_KnitFactory):
147
454
 
148
455
    annotated = True
149
456
 
150
 
    def parse_fulltext(self, content, version):
 
457
    def make(self, lines, version_id):
 
458
        num_lines = len(lines)
 
459
        return AnnotatedKnitContent(zip([version_id] * num_lines, lines))
 
460
 
 
461
    def parse_fulltext(self, content, version_id):
151
462
        """Convert fulltext to internal representation
152
463
 
153
464
        fulltext content is of the format
155
466
        internal representation is of the format:
156
467
        (revid, plaintext)
157
468
        """
158
 
        lines = []
159
 
        for line in content:
160
 
            origin, text = line.split(' ', 1)
161
 
            lines.append((origin.decode('utf-8'), text))
162
 
        return KnitContent(lines)
 
469
        # TODO: jam 20070209 The tests expect this to be returned as tuples,
 
470
        #       but the code itself doesn't really depend on that.
 
471
        #       Figure out a way to not require the overhead of turning the
 
472
        #       list back into tuples.
 
473
        lines = [tuple(line.split(' ', 1)) for line in content]
 
474
        return AnnotatedKnitContent(lines)
163
475
 
164
476
    def parse_line_delta_iter(self, lines):
165
 
        for result_item in self.parse_line_delta[lines]:
166
 
            yield result_item
 
477
        return iter(self.parse_line_delta(lines))
167
478
 
168
 
    def parse_line_delta(self, lines, version):
 
479
    def parse_line_delta(self, lines, version_id, plain=False):
169
480
        """Convert a line based delta into internal representation.
170
481
 
171
482
        line delta is in the form of:
174
485
        revid(utf8) newline\n
175
486
        internal representation is
176
487
        (start, end, count, [1..count tuples (revid, newline)])
 
488
 
 
489
        :param plain: If True, the lines are returned as a plain
 
490
            list without annotations, not as a list of (origin, content) tuples, i.e.
 
491
            (start, end, count, [1..count newline])
177
492
        """
178
493
        result = []
179
494
        lines = iter(lines)
180
495
        next = lines.next
 
496
 
 
497
        cache = {}
 
498
        def cache_and_return(line):
 
499
            origin, text = line.split(' ', 1)
 
500
            return cache.setdefault(origin, origin), text
 
501
 
181
502
        # walk through the lines parsing.
 
503
        # Note that the plain test is explicitly pulled out of the
 
504
        # loop to minimise any performance impact
 
505
        if plain:
 
506
            for header in lines:
 
507
                start, end, count = [int(n) for n in header.split(',')]
 
508
                contents = [next().split(' ', 1)[1] for i in xrange(count)]
 
509
                result.append((start, end, count, contents))
 
510
        else:
 
511
            for header in lines:
 
512
                start, end, count = [int(n) for n in header.split(',')]
 
513
                contents = [tuple(next().split(' ', 1)) for i in xrange(count)]
 
514
                result.append((start, end, count, contents))
 
515
        return result
 
516
 
 
517
    def get_fulltext_content(self, lines):
 
518
        """Extract just the content lines from a fulltext."""
 
519
        return (line.split(' ', 1)[1] for line in lines)
 
520
 
 
521
    def get_linedelta_content(self, lines):
 
522
        """Extract just the content from a line delta.
 
523
 
 
524
        This doesn't return all of the extra information stored in a delta.
 
525
        Only the actual content lines.
 
526
        """
 
527
        lines = iter(lines)
 
528
        next = lines.next
182
529
        for header in lines:
183
 
            start, end, count = [int(n) for n in header.split(',')]
184
 
            contents = []
185
 
            remaining = count
186
 
            while remaining:
 
530
            header = header.split(',')
 
531
            count = int(header[2])
 
532
            for i in xrange(count):
187
533
                origin, text = next().split(' ', 1)
188
 
                remaining -= 1
189
 
                contents.append((origin.decode('utf-8'), text))
190
 
            result.append((start, end, count, contents))
191
 
        return result
 
534
                yield text
192
535
 
193
536
    def lower_fulltext(self, content):
194
537
        """convert a fulltext content record into a serializable form.
195
538
 
196
539
        see parse_fulltext which this inverts.
197
540
        """
198
 
        return ['%s %s' % (o.encode('utf-8'), t) for o, t in content._lines]
 
541
        # TODO: jam 20070209 We only do the caching thing to make sure that
 
542
        #       the origin is a valid utf-8 line, eventually we could remove it
 
543
        return ['%s %s' % (o, t) for o, t in content._lines]
199
544
 
200
545
    def lower_line_delta(self, delta):
201
546
        """convert a delta into a serializable form.
202
547
 
203
548
        See parse_line_delta which this inverts.
204
549
        """
 
550
        # TODO: jam 20070209 We only do the caching thing to make sure that
 
551
        #       the origin is a valid utf-8 line, eventually we could remove it
205
552
        out = []
206
553
        for start, end, c, lines in delta:
207
554
            out.append('%d,%d,%d\n' % (start, end, c))
208
 
            for origin, text in lines:
209
 
                out.append('%s %s' % (origin.encode('utf-8'), text))
 
555
            out.extend(origin + ' ' + text
 
556
                       for origin, text in lines)
210
557
        return out
211
558
 
 
559
    def annotate(self, knit, key):
 
560
        content = knit._get_content(key)
 
561
        # adjust for the fact that serialised annotations are only key suffixes
 
562
        # for this factory.
 
563
        if type(key) == tuple:
 
564
            prefix = key[:-1]
 
565
            origins = content.annotate()
 
566
            result = []
 
567
            for origin, line in origins:
 
568
                result.append((prefix + (origin,), line))
 
569
            return result
 
570
        else:
 
571
            # XXX: This smells a bit.  Why would key ever be a non-tuple here?
 
572
            # Aren't keys defined to be tuples?  -- spiv 20080618
 
573
            return content.annotate()
 
574
 
212
575
 
213
576
class KnitPlainFactory(_KnitFactory):
214
577
    """Factory for creating plain Content objects."""
215
578
 
216
579
    annotated = False
217
580
 
218
 
    def parse_fulltext(self, content, version):
 
581
    def make(self, lines, version_id):
 
582
        return PlainKnitContent(lines, version_id)
 
583
 
 
584
    def parse_fulltext(self, content, version_id):
219
585
        """This parses an unannotated fulltext.
220
586
 
221
587
        Note that this is not a noop - the internal representation
222
588
        has (versionid, line) - its just a constant versionid.
223
589
        """
224
 
        return self.make(content, version)
 
590
        return self.make(content, version_id)
225
591
 
226
 
    def parse_line_delta_iter(self, lines, version):
227
 
        while lines:
228
 
            header = lines.pop(0)
 
592
    def parse_line_delta_iter(self, lines, version_id):
 
593
        cur = 0
 
594
        num_lines = len(lines)
 
595
        while cur < num_lines:
 
596
            header = lines[cur]
 
597
            cur += 1
229
598
            start, end, c = [int(n) for n in header.split(',')]
230
 
            yield start, end, c, zip([version] * c, lines[:c])
231
 
            del lines[:c]
232
 
 
233
 
    def parse_line_delta(self, lines, version):
234
 
        return list(self.parse_line_delta_iter(lines, version))
235
 
    
 
599
            yield start, end, c, lines[cur:cur+c]
 
600
            cur += c
 
601
 
 
602
    def parse_line_delta(self, lines, version_id):
 
603
        return list(self.parse_line_delta_iter(lines, version_id))
 
604
 
 
605
    def get_fulltext_content(self, lines):
 
606
        """Extract just the content lines from a fulltext."""
 
607
        return iter(lines)
 
608
 
 
609
    def get_linedelta_content(self, lines):
 
610
        """Extract just the content from a line delta.
 
611
 
 
612
        This doesn't return all of the extra information stored in a delta.
 
613
        Only the actual content lines.
 
614
        """
 
615
        lines = iter(lines)
 
616
        next = lines.next
 
617
        for header in lines:
 
618
            header = header.split(',')
 
619
            count = int(header[2])
 
620
            for i in xrange(count):
 
621
                yield next()
 
622
 
236
623
    def lower_fulltext(self, content):
237
624
        return content.text()
238
625
 
240
627
        out = []
241
628
        for start, end, c, lines in delta:
242
629
            out.append('%d,%d,%d\n' % (start, end, c))
243
 
            out.extend([text for origin, text in lines])
 
630
            out.extend(lines)
244
631
        return out
245
632
 
246
 
 
247
 
def make_empty_knit(transport, relpath):
248
 
    """Construct a empty knit at the specified location."""
249
 
    k = KnitVersionedFile(transport, relpath, 'w', KnitPlainFactory)
250
 
    k._data._open_file()
251
 
 
252
 
 
253
 
class KnitVersionedFile(VersionedFile):
254
 
    """Weave-like structure with faster random access.
255
 
 
256
 
    A knit stores a number of texts and a summary of the relationships
257
 
    between them.  Texts are identified by a string version-id.  Texts
258
 
    are normally stored and retrieved as a series of lines, but can
259
 
    also be passed as single strings.
260
 
 
261
 
    Lines are stored with the trailing newline (if any) included, to
262
 
    avoid special cases for files with no final newline.  Lines are
263
 
    composed of 8-bit characters, not unicode.  The combination of
264
 
    these approaches should mean any 'binary' file can be safely
265
 
    stored and retrieved.
266
 
    """
267
 
 
268
 
    def __init__(self, relpath, transport, file_mode=None, access_mode=None, factory=None,
269
 
                 basis_knit=None, delta=True, create=False):
270
 
        """Construct a knit at location specified by relpath.
271
 
        
272
 
        :param create: If not True, only open an existing knit.
273
 
        """
274
 
        if access_mode is None:
275
 
            access_mode = 'w'
276
 
        super(KnitVersionedFile, self).__init__(access_mode)
277
 
        assert access_mode in ('r', 'w'), "invalid mode specified %r" % access_mode
278
 
        assert not basis_knit or isinstance(basis_knit, KnitVersionedFile), \
279
 
            type(basis_knit)
280
 
 
281
 
        self.transport = transport
282
 
        self.filename = relpath
283
 
        self.basis_knit = basis_knit
284
 
        self.factory = factory or KnitAnnotateFactory()
285
 
        self.writable = (access_mode == 'w')
286
 
        self.delta = delta
287
 
 
288
 
        self._index = _KnitIndex(transport, relpath + INDEX_SUFFIX,
289
 
            access_mode, create=create, file_mode=file_mode)
290
 
        self._data = _KnitData(transport, relpath + DATA_SUFFIX,
291
 
            access_mode, create=create and not len(self), file_mode=file_mode)
292
 
 
293
 
    def __repr__(self):
294
 
        return '%s(%s)' % (self.__class__.__name__, 
295
 
                           self.transport.abspath(self.filename))
296
 
    
297
 
    def _add_delta(self, version_id, parents, delta_parent, sha1, noeol, delta):
298
 
        """See VersionedFile._add_delta()."""
299
 
        self._check_add(version_id, []) # should we check the lines ?
300
 
        self._check_versions_present(parents)
301
 
        present_parents = []
302
 
        ghosts = []
303
 
        parent_texts = {}
304
 
        for parent in parents:
305
 
            if not self.has_version(parent):
306
 
                ghosts.append(parent)
307
 
            else:
308
 
                present_parents.append(parent)
309
 
 
310
 
        if delta_parent is None:
311
 
            # reconstitute as full text.
312
 
            assert len(delta) == 1 or len(delta) == 0
313
 
            if len(delta):
314
 
                assert delta[0][0] == 0
315
 
                assert delta[0][1] == 0, delta[0][1]
316
 
            return super(KnitVersionedFile, self)._add_delta(version_id,
317
 
                                                             parents,
318
 
                                                             delta_parent,
319
 
                                                             sha1,
320
 
                                                             noeol,
321
 
                                                             delta)
322
 
 
323
 
        digest = sha1
324
 
 
325
 
        options = []
326
 
        if noeol:
327
 
            options.append('no-eol')
328
 
 
329
 
        if delta_parent is not None:
330
 
            # determine the current delta chain length.
331
 
            # To speed the extract of texts the delta chain is limited
332
 
            # to a fixed number of deltas.  This should minimize both
333
 
            # I/O and the time spend applying deltas.
334
 
            count = 0
335
 
            delta_parents = [delta_parent]
336
 
            while count < 25:
337
 
                parent = delta_parents[0]
338
 
                method = self._index.get_method(parent)
339
 
                if method == 'fulltext':
340
 
                    break
341
 
                delta_parents = self._index.get_parents(parent)
342
 
                count = count + 1
343
 
            if method == 'line-delta':
344
 
                # did not find a fulltext in the delta limit.
345
 
                # just do a normal insertion.
346
 
                return super(KnitVersionedFile, self)._add_delta(version_id,
347
 
                                                                 parents,
348
 
                                                                 delta_parent,
349
 
                                                                 sha1,
350
 
                                                                 noeol,
351
 
                                                                 delta)
352
 
 
353
 
        options.append('line-delta')
354
 
        store_lines = self.factory.lower_line_delta(delta)
355
 
 
356
 
        where, size = self._data.add_record(version_id, digest, store_lines)
357
 
        self._index.add_version(version_id, options, where, size, parents)
358
 
 
359
 
    def _add_raw_records(self, records, data):
360
 
        """Add all the records 'records' with data pre-joined in 'data'.
361
 
 
362
 
        :param records: A list of tuples(version_id, options, parents, size).
363
 
        :param data: The data for the records. When it is written, the records
364
 
                     are adjusted to have pos pointing into data by the sum of
365
 
                     the preceding records sizes.
366
 
        """
367
 
        # write all the data
368
 
        pos = self._data.add_raw_record(data)
369
 
        index_entries = []
370
 
        for (version_id, options, parents, size) in records:
371
 
            index_entries.append((version_id, options, pos, size, parents))
372
 
            pos += size
373
 
        self._index.add_versions(index_entries)
374
 
 
375
 
    def clear_cache(self):
376
 
        """Clear the data cache only."""
377
 
        self._data.clear_cache()
378
 
 
379
 
    def copy_to(self, name, transport):
380
 
        """See VersionedFile.copy_to()."""
381
 
        # copy the current index to a temp index to avoid racing with local
382
 
        # writes
383
 
        transport.put(name + INDEX_SUFFIX + '.tmp', self.transport.get(self._index._filename),)
384
 
        # copy the data file
385
 
        transport.put(name + DATA_SUFFIX, self._data._open_file())
386
 
        # rename the copied index into place
387
 
        transport.rename(name + INDEX_SUFFIX + '.tmp', name + INDEX_SUFFIX)
388
 
 
389
 
    def create_empty(self, name, transport, mode=None):
390
 
        return KnitVersionedFile(name, transport, factory=self.factory, delta=self.delta, create=True)
391
 
    
392
 
    def _fix_parents(self, version, new_parents):
393
 
        """Fix the parents list for version.
394
 
        
395
 
        This is done by appending a new version to the index
396
 
        with identical data except for the parents list.
397
 
        the parents list must be a superset of the current
398
 
        list.
399
 
        """
400
 
        current_values = self._index._cache[version]
401
 
        assert set(current_values[4]).difference(set(new_parents)) == set()
402
 
        self._index.add_version(version,
403
 
                                current_values[1], 
404
 
                                current_values[2],
405
 
                                current_values[3],
406
 
                                new_parents)
407
 
 
408
 
    def get_delta(self, version_id):
409
 
        """Get a delta for constructing version from some other version."""
410
 
        if not self.has_version(version_id):
411
 
            raise RevisionNotPresent(version_id, self.filename)
412
 
        
413
 
        parents = self.get_parents(version_id)
414
 
        if len(parents):
415
 
            parent = parents[0]
416
 
        else:
417
 
            parent = None
418
 
        data_pos, data_size = self._index.get_position(version_id)
419
 
        data, sha1 = self._data.read_records(((version_id, data_pos, data_size),))[version_id]
420
 
        version_idx = self._index.lookup(version_id)
421
 
        noeol = 'no-eol' in self._index.get_options(version_id)
422
 
        if 'fulltext' == self._index.get_method(version_id):
423
 
            new_content = self.factory.parse_fulltext(data, version_idx)
424
 
            if parent is not None:
425
 
                reference_content = self._get_content(parent)
426
 
                old_texts = reference_content.text()
427
 
            else:
428
 
                old_texts = []
429
 
            new_texts = new_content.text()
430
 
            delta_seq = KnitSequenceMatcher(None, old_texts, new_texts)
431
 
            return parent, sha1, noeol, self._make_line_delta(delta_seq, new_content)
432
 
        else:
433
 
            delta = self.factory.parse_line_delta(data, version_idx)
434
 
            return parent, sha1, noeol, delta
435
 
        
436
 
    def get_graph_with_ghosts(self):
437
 
        """See VersionedFile.get_graph_with_ghosts()."""
438
 
        graph_items = self._index.get_graph()
439
 
        return dict(graph_items)
440
 
 
441
 
    def get_sha1(self, version_id):
442
 
        """See VersionedFile.get_sha1()."""
443
 
        components = self._get_components(version_id)
444
 
        return components[-1][-1][-1]
445
 
 
446
 
    @staticmethod
447
 
    def get_suffixes():
448
 
        """See VersionedFile.get_suffixes()."""
449
 
        return [DATA_SUFFIX, INDEX_SUFFIX]
450
 
 
451
 
    def has_ghost(self, version_id):
452
 
        """True if there is a ghost reference in the file to version_id."""
453
 
        # maybe we have it
454
 
        if self.has_version(version_id):
455
 
            return False
456
 
        # optimisable if needed by memoising the _ghosts set.
457
 
        items = self._index.get_graph()
458
 
        for node, parents in items:
459
 
            for parent in parents:
460
 
                if parent not in self._index._cache:
461
 
                    if parent == version_id:
462
 
                        return True
463
 
        return False
464
 
 
465
 
    def versions(self):
466
 
        """See VersionedFile.versions."""
467
 
        return self._index.get_versions()
468
 
 
469
 
    def has_version(self, version_id):
470
 
        """See VersionedFile.has_version."""
471
 
        return self._index.has_version(version_id)
472
 
 
473
 
    __contains__ = has_version
474
 
 
475
 
    def _merge_annotations(self, content, parents, parent_texts={},
476
 
                           delta=None, annotated=None):
477
 
        """Merge annotations for content.  This is done by comparing
478
 
        the annotations based on changed to the text.
479
 
        """
 
633
    def annotate(self, knit, key):
 
634
        annotator = _KnitAnnotator(knit)
 
635
        return annotator.annotate(key)
 
636
 
 
637
 
 
638
 
 
639
def make_file_factory(annotated, mapper):
 
640
    """Create a factory for creating a file based KnitVersionedFiles.
 
641
 
 
642
    This is only functional enough to run interface tests, it doesn't try to
 
643
    provide a full pack environment.
 
644
    
 
645
    :param annotated: knit annotations are wanted.
 
646
    :param mapper: The mapper from keys to paths.
 
647
    """
 
648
    def factory(transport):
 
649
        index = _KndxIndex(transport, mapper, lambda:None, lambda:True, lambda:True)
 
650
        access = _KnitKeyAccess(transport, mapper)
 
651
        return KnitVersionedFiles(index, access, annotated=annotated)
 
652
    return factory
 
653
 
 
654
 
 
655
def make_pack_factory(graph, delta, keylength):
 
656
    """Create a factory for creating a pack based VersionedFiles.
 
657
 
 
658
    This is only functional enough to run interface tests, it doesn't try to
 
659
    provide a full pack environment.
 
660
    
 
661
    :param graph: Store a graph.
 
662
    :param delta: Delta compress contents.
 
663
    :param keylength: How long should keys be.
 
664
    """
 
665
    def factory(transport):
 
666
        parents = graph or delta
 
667
        ref_length = 0
 
668
        if graph:
 
669
            ref_length += 1
 
670
        if delta:
 
671
            ref_length += 1
 
672
            max_delta_chain = 200
 
673
        else:
 
674
            max_delta_chain = 0
 
675
        graph_index = _mod_index.InMemoryGraphIndex(reference_lists=ref_length,
 
676
            key_elements=keylength)
 
677
        stream = transport.open_write_stream('newpack')
 
678
        writer = pack.ContainerWriter(stream.write)
 
679
        writer.begin()
 
680
        index = _KnitGraphIndex(graph_index, lambda:True, parents=parents,
 
681
            deltas=delta, add_callback=graph_index.add_nodes)
 
682
        access = _DirectPackAccess({})
 
683
        access.set_writer(writer, graph_index, (transport, 'newpack'))
 
684
        result = KnitVersionedFiles(index, access,
 
685
            max_delta_chain=max_delta_chain)
 
686
        result.stream = stream
 
687
        result.writer = writer
 
688
        return result
 
689
    return factory
 
690
 
 
691
 
 
692
def cleanup_pack_knit(versioned_files):
 
693
    versioned_files.stream.close()
 
694
    versioned_files.writer.end()
 
695
 
 
696
 
 
697
class KnitVersionedFiles(VersionedFiles):
 
698
    """Storage for many versioned files using knit compression.
 
699
 
 
700
    Backend storage is managed by indices and data objects.
 
701
 
 
702
    :ivar _index: A _KnitGraphIndex or similar that can describe the 
 
703
        parents, graph, compression and data location of entries in this 
 
704
        KnitVersionedFiles.  Note that this is only the index for 
 
705
        *this* vfs; if there are fallbacks they must be queried separately.
 
706
    """
 
707
 
 
708
    def __init__(self, index, data_access, max_delta_chain=200,
 
709
        annotated=False):
 
710
        """Create a KnitVersionedFiles with index and data_access.
 
711
 
 
712
        :param index: The index for the knit data.
 
713
        :param data_access: The access object to store and retrieve knit
 
714
            records.
 
715
        :param max_delta_chain: The maximum number of deltas to permit during
 
716
            insertion. Set to 0 to prohibit the use of deltas.
 
717
        :param annotated: Set to True to cause annotations to be calculated and
 
718
            stored during insertion.
 
719
        """
 
720
        self._index = index
 
721
        self._access = data_access
 
722
        self._max_delta_chain = max_delta_chain
480
723
        if annotated:
481
 
            delta_seq = None
482
 
            for parent_id in parents:
483
 
                merge_content = self._get_content(parent_id, parent_texts)
484
 
                seq = KnitSequenceMatcher(None, merge_content.text(), content.text())
485
 
                if delta_seq is None:
486
 
                    # setup a delta seq to reuse.
487
 
                    delta_seq = seq
488
 
                for i, j, n in seq.get_matching_blocks():
489
 
                    if n == 0:
490
 
                        continue
491
 
                    # this appears to copy (origin, text) pairs across to the new
492
 
                    # content for any line that matches the last-checked parent.
493
 
                    # FIXME: save the sequence control data for delta compression
494
 
                    # against the most relevant parent rather than rediffing.
495
 
                    content._lines[j:j+n] = merge_content._lines[i:i+n]
496
 
        if delta:
497
 
            if not annotated:
498
 
                reference_content = self._get_content(parents[0], parent_texts)
499
 
                new_texts = content.text()
500
 
                old_texts = reference_content.text()
501
 
                delta_seq = KnitSequenceMatcher(None, old_texts, new_texts)
502
 
            return self._make_line_delta(delta_seq, content)
503
 
 
504
 
    def _make_line_delta(self, delta_seq, new_content):
505
 
        """Generate a line delta from delta_seq and new_content."""
506
 
        diff_hunks = []
507
 
        for op in delta_seq.get_opcodes():
508
 
            if op[0] == 'equal':
509
 
                continue
510
 
            diff_hunks.append((op[1], op[2], op[4]-op[3], new_content._lines[op[3]:op[4]]))
511
 
        return diff_hunks
512
 
 
513
 
    def _get_components(self, version_id):
514
 
        """Return a list of (version_id, method, data) tuples that
515
 
        makes up version specified by version_id of the knit.
516
 
 
517
 
        The components should be applied in the order of the returned
518
 
        list.
519
 
 
520
 
        The basis knit will be used to the largest extent possible
521
 
        since it is assumed that accesses to it is faster.
 
724
            self._factory = KnitAnnotateFactory()
 
725
        else:
 
726
            self._factory = KnitPlainFactory()
 
727
        self._fallback_vfs = []
 
728
 
 
729
    def add_fallback_versioned_files(self, a_versioned_files):
 
730
        """Add a source of texts for texts not present in this knit.
 
731
 
 
732
        :param a_versioned_files: A VersionedFiles object.
522
733
        """
523
 
        #profile notes:
524
 
        # 4168 calls in 14912, 2289 internal
525
 
        # 4168 in 9711 to read_records
526
 
        # 52554 in 1250 to get_parents
527
 
        # 170166 in 865 to list.append
528
 
        
529
 
        # needed_revisions holds a list of (method, version_id) of
530
 
        # versions that is needed to be fetched to construct the final
531
 
        # version of the file.
532
 
        #
533
 
        # basis_revisions is a list of versions that needs to be
534
 
        # fetched but exists in the basis knit.
535
 
 
536
 
        basis = self.basis_knit
537
 
        needed_versions = []
538
 
        basis_versions = []
539
 
        cursor = version_id
540
 
 
541
 
        while 1:
542
 
            picked_knit = self
543
 
            if basis and basis._index.has_version(cursor):
544
 
                picked_knit = basis
545
 
                basis_versions.append(cursor)
546
 
            method = picked_knit._index.get_method(cursor)
547
 
            needed_versions.append((method, cursor))
548
 
            if method == 'fulltext':
549
 
                break
550
 
            cursor = picked_knit.get_parents(cursor)[0]
551
 
 
552
 
        components = {}
553
 
        if basis_versions:
554
 
            records = []
555
 
            for comp_id in basis_versions:
556
 
                data_pos, data_size = basis._index.get_data_position(comp_id)
557
 
                records.append((piece_id, data_pos, data_size))
558
 
            components.update(basis._data.read_records(records))
559
 
 
560
 
        records = []
561
 
        for comp_id in [vid for method, vid in needed_versions
562
 
                        if vid not in basis_versions]:
563
 
            data_pos, data_size = self._index.get_position(comp_id)
564
 
            records.append((comp_id, data_pos, data_size))
565
 
        components.update(self._data.read_records(records))
566
 
 
567
 
        # get_data_records returns a mapping with the version id as
568
 
        # index and the value as data.  The order the components need
569
 
        # to be applied is held by needed_versions (reversed).
570
 
        out = []
571
 
        for method, comp_id in reversed(needed_versions):
572
 
            out.append((comp_id, method, components[comp_id]))
573
 
 
574
 
        return out
575
 
 
576
 
    def _get_content(self, version_id, parent_texts={}):
577
 
        """Returns a content object that makes up the specified
578
 
        version."""
579
 
        if not self.has_version(version_id):
580
 
            raise RevisionNotPresent(version_id, self.filename)
581
 
 
582
 
        cached_version = parent_texts.get(version_id, None)
583
 
        if cached_version is not None:
584
 
            return cached_version
585
 
 
586
 
        if self.basis_knit and version_id in self.basis_knit:
587
 
            return self.basis_knit._get_content(version_id)
588
 
 
589
 
        content = None
590
 
        components = self._get_components(version_id)
591
 
        for component_id, method, (data, digest) in components:
592
 
            version_idx = self._index.lookup(component_id)
593
 
            if method == 'fulltext':
594
 
                assert content is None
595
 
                content = self.factory.parse_fulltext(data, version_idx)
596
 
            elif method == 'line-delta':
597
 
                delta = self.factory.parse_line_delta(data, version_idx)
598
 
                content._lines = self._apply_delta(content._lines, delta)
599
 
 
600
 
        if 'no-eol' in self._index.get_options(version_id):
601
 
            line = content._lines[-1][1].rstrip('\n')
602
 
            content._lines[-1] = (content._lines[-1][0], line)
603
 
 
604
 
        # digest here is the digest from the last applied component.
605
 
        if sha_strings(content.text()) != digest:
606
 
            import pdb;pdb.set_trace()
607
 
            raise KnitCorrupt(self.filename, 'sha-1 does not match %s' % version_id)
608
 
 
609
 
        return content
610
 
 
611
 
    def _check_versions_present(self, version_ids):
612
 
        """Check that all specified versions are present."""
613
 
        version_ids = set(version_ids)
614
 
        for r in list(version_ids):
615
 
            if self._index.has_version(r):
616
 
                version_ids.remove(r)
617
 
        if version_ids:
618
 
            raise RevisionNotPresent(list(version_ids)[0], self.filename)
619
 
 
620
 
    def _add_lines_with_ghosts(self, version_id, parents, lines, parent_texts):
621
 
        """See VersionedFile.add_lines_with_ghosts()."""
622
 
        self._check_add(version_id, lines)
623
 
        return self._add(version_id, lines[:], parents, self.delta, parent_texts)
624
 
 
625
 
    def _add_lines(self, version_id, parents, lines, parent_texts):
626
 
        """See VersionedFile.add_lines."""
627
 
        self._check_add(version_id, lines)
628
 
        self._check_versions_present(parents)
629
 
        return self._add(version_id, lines[:], parents, self.delta, parent_texts)
630
 
 
631
 
    def _check_add(self, version_id, lines):
632
 
        """check that version_id and lines are safe to add."""
633
 
        assert self.writable, "knit is not opened for write"
634
 
        ### FIXME escape. RBC 20060228
635
 
        if contains_whitespace(version_id):
636
 
            raise InvalidRevisionId(version_id, self.filename)
637
 
        if self.has_version(version_id):
638
 
            raise RevisionAlreadyPresent(version_id, self.filename)
639
 
        self._check_lines_not_unicode(lines)
640
 
        self._check_lines_are_lines(lines)
641
 
 
642
 
    def _add(self, version_id, lines, parents, delta, parent_texts):
 
734
        self._fallback_vfs.append(a_versioned_files)
 
735
 
 
736
    def add_lines(self, key, parents, lines, parent_texts=None,
 
737
        left_matching_blocks=None, nostore_sha=None, random_id=False,
 
738
        check_content=True):
 
739
        """See VersionedFiles.add_lines()."""
 
740
        self._index._check_write_ok()
 
741
        self._check_add(key, lines, random_id, check_content)
 
742
        if parents is None:
 
743
            # The caller might pass None if there is no graph data, but kndx
 
744
            # indexes can't directly store that, so we give them
 
745
            # an empty tuple instead.
 
746
            parents = ()
 
747
        return self._add(key, lines, parents,
 
748
            parent_texts, left_matching_blocks, nostore_sha, random_id)
 
749
 
 
750
    def _add(self, key, lines, parents, parent_texts,
 
751
        left_matching_blocks, nostore_sha, random_id):
643
752
        """Add a set of lines on top of version specified by parents.
644
753
 
645
 
        If delta is true, compress the text as a line-delta against
646
 
        the first parent.
647
 
 
648
754
        Any versions not present will be converted into ghosts.
649
755
        """
650
 
        #  461    0   6546.0390     43.9100   bzrlib.knit:489(_add)
651
 
        # +400    0    889.4890    418.9790   +bzrlib.knit:192(lower_fulltext)
652
 
        # +461    0   1364.8070    108.8030   +bzrlib.knit:996(add_record)
653
 
        # +461    0    193.3940     41.5720   +bzrlib.knit:898(add_version)
654
 
        # +461    0    134.0590     18.3810   +bzrlib.osutils:361(sha_strings)
655
 
        # +461    0     36.3420     15.4540   +bzrlib.knit:146(make)
656
 
        # +1383   0      8.0370      8.0370   +<len>
657
 
        # +61     0     13.5770      7.9190   +bzrlib.knit:199(lower_line_delta)
658
 
        # +61     0    963.3470      7.8740   +bzrlib.knit:427(_get_content)
659
 
        # +61     0    973.9950      5.2950   +bzrlib.knit:136(line_delta)
660
 
        # +61     0   1918.1800      5.2640   +bzrlib.knit:359(_merge_annotations)
 
756
        # first thing, if the content is something we don't need to store, find
 
757
        # that out.
 
758
        line_bytes = ''.join(lines)
 
759
        digest = sha_string(line_bytes)
 
760
        if nostore_sha == digest:
 
761
            raise errors.ExistingContent
661
762
 
662
763
        present_parents = []
663
 
        ghosts = []
664
764
        if parent_texts is None:
665
765
            parent_texts = {}
 
766
        # Do a single query to ascertain parent presence.
 
767
        present_parent_map = self.get_parent_map(parents)
666
768
        for parent in parents:
667
 
            if not self.has_version(parent):
668
 
                ghosts.append(parent)
669
 
            else:
 
769
            if parent in present_parent_map:
670
770
                present_parents.append(parent)
671
771
 
672
 
        if delta and not len(present_parents):
 
772
        # Currently we can only compress against the left most present parent.
 
773
        if (len(present_parents) == 0 or
 
774
            present_parents[0] != parents[0]):
673
775
            delta = False
 
776
        else:
 
777
            # To speed the extract of texts the delta chain is limited
 
778
            # to a fixed number of deltas.  This should minimize both
 
779
            # I/O and the time spend applying deltas.
 
780
            delta = self._check_should_delta(present_parents[0])
674
781
 
675
 
        digest = sha_strings(lines)
 
782
        text_length = len(line_bytes)
676
783
        options = []
677
784
        if lines:
678
785
            if lines[-1][-1] != '\n':
 
786
                # copy the contents of lines.
 
787
                lines = lines[:]
679
788
                options.append('no-eol')
680
789
                lines[-1] = lines[-1] + '\n'
681
 
 
682
 
        if len(present_parents) and delta:
683
 
            # To speed the extract of texts the delta chain is limited
684
 
            # to a fixed number of deltas.  This should minimize both
685
 
            # I/O and the time spend applying deltas.
686
 
            count = 0
687
 
            delta_parents = present_parents
688
 
            while count < 25:
689
 
                parent = delta_parents[0]
690
 
                method = self._index.get_method(parent)
691
 
                if method == 'fulltext':
692
 
                    break
693
 
                delta_parents = self._index.get_parents(parent)
694
 
                count = count + 1
695
 
            if method == 'line-delta':
696
 
                delta = False
697
 
 
698
 
        lines = self.factory.make(lines, version_id)
699
 
        if delta or (self.factory.annotated and len(present_parents) > 0):
700
 
            # Merge annotations from parent texts if so is needed.
701
 
            delta_hunks = self._merge_annotations(lines, present_parents, parent_texts,
702
 
                                                  delta, self.factory.annotated)
 
790
                line_bytes += '\n'
 
791
 
 
792
        for element in key:
 
793
            if type(element) != str:
 
794
                raise TypeError("key contains non-strings: %r" % (key,))
 
795
        # Knit hunks are still last-element only
 
796
        version_id = key[-1]
 
797
        content = self._factory.make(lines, version_id)
 
798
        if 'no-eol' in options:
 
799
            # Hint to the content object that its text() call should strip the
 
800
            # EOL.
 
801
            content._should_strip_eol = True
 
802
        if delta or (self._factory.annotated and len(present_parents) > 0):
 
803
            # Merge annotations from parent texts if needed.
 
804
            delta_hunks = self._merge_annotations(content, present_parents,
 
805
                parent_texts, delta, self._factory.annotated,
 
806
                left_matching_blocks)
703
807
 
704
808
        if delta:
705
809
            options.append('line-delta')
706
 
            store_lines = self.factory.lower_line_delta(delta_hunks)
 
810
            store_lines = self._factory.lower_line_delta(delta_hunks)
 
811
            size, bytes = self._record_to_data(key, digest,
 
812
                store_lines)
707
813
        else:
708
814
            options.append('fulltext')
709
 
            store_lines = self.factory.lower_fulltext(lines)
710
 
 
711
 
        where, size = self._data.add_record(version_id, digest, store_lines)
712
 
        self._index.add_version(version_id, options, where, size, parents)
713
 
        return lines
 
815
            # isinstance is slower and we have no hierarchy.
 
816
            if self._factory.__class__ == KnitPlainFactory:
 
817
                # Use the already joined bytes saving iteration time in
 
818
                # _record_to_data.
 
819
                size, bytes = self._record_to_data(key, digest,
 
820
                    lines, [line_bytes])
 
821
            else:
 
822
                # get mixed annotation + content and feed it into the
 
823
                # serialiser.
 
824
                store_lines = self._factory.lower_fulltext(content)
 
825
                size, bytes = self._record_to_data(key, digest,
 
826
                    store_lines)
 
827
 
 
828
        access_memo = self._access.add_raw_records([(key, size)], bytes)[0]
 
829
        self._index.add_records(
 
830
            ((key, options, access_memo, parents),),
 
831
            random_id=random_id)
 
832
        return digest, text_length, content
 
833
 
 
834
    def annotate(self, key):
 
835
        """See VersionedFiles.annotate."""
 
836
        return self._factory.annotate(self, key)
714
837
 
715
838
    def check(self, progress_bar=None):
716
 
        """See VersionedFile.check()."""
717
 
 
718
 
    def _clone_text(self, new_version_id, old_version_id, parents):
719
 
        """See VersionedFile.clone_text()."""
720
 
        # FIXME RBC 20060228 make fast by only inserting an index with null delta.
721
 
        self.add_lines(new_version_id, parents, self.get_lines(old_version_id))
722
 
 
723
 
    def get_lines(self, version_id):
724
 
        """See VersionedFile.get_lines()."""
725
 
        return self._get_content(version_id).text()
726
 
 
727
 
    def iter_lines_added_or_present_in_versions(self, version_ids=None):
728
 
        """See VersionedFile.iter_lines_added_or_present_in_versions()."""
729
 
        if version_ids is None:
730
 
            version_ids = self.versions()
 
839
        """See VersionedFiles.check()."""
 
840
        # This doesn't actually test extraction of everything, but that will
 
841
        # impact 'bzr check' substantially, and needs to be integrated with
 
842
        # care. However, it does check for the obvious problem of a delta with
 
843
        # no basis.
 
844
        keys = self._index.keys()
 
845
        parent_map = self.get_parent_map(keys)
 
846
        for key in keys:
 
847
            if self._index.get_method(key) != 'fulltext':
 
848
                compression_parent = parent_map[key][0]
 
849
                if compression_parent not in parent_map:
 
850
                    raise errors.KnitCorrupt(self,
 
851
                        "Missing basis parent %s for %s" % (
 
852
                        compression_parent, key))
 
853
        for fallback_vfs in self._fallback_vfs:
 
854
            fallback_vfs.check()
 
855
 
 
856
    def _check_add(self, key, lines, random_id, check_content):
 
857
        """check that version_id and lines are safe to add."""
 
858
        version_id = key[-1]
 
859
        if contains_whitespace(version_id):
 
860
            raise InvalidRevisionId(version_id, self)
 
861
        self.check_not_reserved_id(version_id)
 
862
        # TODO: If random_id==False and the key is already present, we should
 
863
        # probably check that the existing content is identical to what is
 
864
        # being inserted, and otherwise raise an exception.  This would make
 
865
        # the bundle code simpler.
 
866
        if check_content:
 
867
            self._check_lines_not_unicode(lines)
 
868
            self._check_lines_are_lines(lines)
 
869
 
 
870
    def _check_header(self, key, line):
 
871
        rec = self._split_header(line)
 
872
        self._check_header_version(rec, key[-1])
 
873
        return rec
 
874
 
 
875
    def _check_header_version(self, rec, version_id):
 
876
        """Checks the header version on original format knit records.
 
877
        
 
878
        These have the last component of the key embedded in the record.
 
879
        """
 
880
        if rec[1] != version_id:
 
881
            raise KnitCorrupt(self,
 
882
                'unexpected version, wanted %r, got %r' % (version_id, rec[1]))
 
883
 
 
884
    def _check_should_delta(self, parent):
 
885
        """Iterate back through the parent listing, looking for a fulltext.
 
886
 
 
887
        This is used when we want to decide whether to add a delta or a new
 
888
        fulltext. It searches for _max_delta_chain parents. When it finds a
 
889
        fulltext parent, it sees if the total size of the deltas leading up to
 
890
        it is large enough to indicate that we want a new full text anyway.
 
891
 
 
892
        Return True if we should create a new delta, False if we should use a
 
893
        full text.
 
894
        """
 
895
        delta_size = 0
 
896
        fulltext_size = None
 
897
        for count in xrange(self._max_delta_chain):
 
898
            # XXX: Collapse these two queries:
 
899
            try:
 
900
                # Note that this only looks in the index of this particular
 
901
                # KnitVersionedFiles, not in the fallbacks.  This ensures that
 
902
                # we won't store a delta spanning physical repository
 
903
                # boundaries.
 
904
                method = self._index.get_method(parent)
 
905
            except RevisionNotPresent:
 
906
                # Some basis is not locally present: always delta
 
907
                return False
 
908
            index, pos, size = self._index.get_position(parent)
 
909
            if method == 'fulltext':
 
910
                fulltext_size = size
 
911
                break
 
912
            delta_size += size
 
913
            # We don't explicitly check for presence because this is in an
 
914
            # inner loop, and if it's missing it'll fail anyhow.
 
915
            # TODO: This should be asking for compression parent, not graph
 
916
            # parent.
 
917
            parent = self._index.get_parent_map([parent])[parent][0]
 
918
        else:
 
919
            # We couldn't find a fulltext, so we must create a new one
 
920
            return False
 
921
        # Simple heuristic - if the total I/O wold be greater as a delta than
 
922
        # the originally installed fulltext, we create a new fulltext.
 
923
        return fulltext_size > delta_size
 
924
 
 
925
    def _build_details_to_components(self, build_details):
 
926
        """Convert a build_details tuple to a position tuple."""
 
927
        # record_details, access_memo, compression_parent
 
928
        return build_details[3], build_details[0], build_details[1]
 
929
 
 
930
    def _get_components_positions(self, keys, allow_missing=False):
 
931
        """Produce a map of position data for the components of keys.
 
932
 
 
933
        This data is intended to be used for retrieving the knit records.
 
934
 
 
935
        A dict of key to (record_details, index_memo, next, parents) is
 
936
        returned.
 
937
        method is the way referenced data should be applied.
 
938
        index_memo is the handle to pass to the data access to actually get the
 
939
            data
 
940
        next is the build-parent of the version, or None for fulltexts.
 
941
        parents is the version_ids of the parents of this version
 
942
 
 
943
        :param allow_missing: If True do not raise an error on a missing component,
 
944
            just ignore it.
 
945
        """
 
946
        component_data = {}
 
947
        pending_components = keys
 
948
        while pending_components:
 
949
            build_details = self._index.get_build_details(pending_components)
 
950
            current_components = set(pending_components)
 
951
            pending_components = set()
 
952
            for key, details in build_details.iteritems():
 
953
                (index_memo, compression_parent, parents,
 
954
                 record_details) = details
 
955
                method = record_details[0]
 
956
                if compression_parent is not None:
 
957
                    pending_components.add(compression_parent)
 
958
                component_data[key] = self._build_details_to_components(details)
 
959
            missing = current_components.difference(build_details)
 
960
            if missing and not allow_missing:
 
961
                raise errors.RevisionNotPresent(missing.pop(), self)
 
962
        return component_data
 
963
       
 
964
    def _get_content(self, key, parent_texts={}):
 
965
        """Returns a content object that makes up the specified
 
966
        version."""
 
967
        cached_version = parent_texts.get(key, None)
 
968
        if cached_version is not None:
 
969
            # Ensure the cache dict is valid.
 
970
            if not self.get_parent_map([key]):
 
971
                raise RevisionNotPresent(key, self)
 
972
            return cached_version
 
973
        text_map, contents_map = self._get_content_maps([key])
 
974
        return contents_map[key]
 
975
 
 
976
    def _get_content_maps(self, keys, nonlocal_keys=None):
 
977
        """Produce maps of text and KnitContents
 
978
        
 
979
        :param keys: The keys to produce content maps for.
 
980
        :param nonlocal_keys: An iterable of keys(possibly intersecting keys)
 
981
            which are known to not be in this knit, but rather in one of the
 
982
            fallback knits.
 
983
        :return: (text_map, content_map) where text_map contains the texts for
 
984
            the requested versions and content_map contains the KnitContents.
 
985
        """
 
986
        # FUTURE: This function could be improved for the 'extract many' case
 
987
        # by tracking each component and only doing the copy when the number of
 
988
        # children than need to apply delta's to it is > 1 or it is part of the
 
989
        # final output.
 
990
        keys = list(keys)
 
991
        multiple_versions = len(keys) != 1
 
992
        record_map = self._get_record_map(keys, allow_missing=True)
 
993
 
 
994
        text_map = {}
 
995
        content_map = {}
 
996
        final_content = {}
 
997
        if nonlocal_keys is None:
 
998
            nonlocal_keys = set()
 
999
        else:
 
1000
            nonlocal_keys = frozenset(nonlocal_keys)
 
1001
        missing_keys = set(nonlocal_keys)
 
1002
        for source in self._fallback_vfs:
 
1003
            if not missing_keys:
 
1004
                break
 
1005
            for record in source.get_record_stream(missing_keys,
 
1006
                'unordered', True):
 
1007
                if record.storage_kind == 'absent':
 
1008
                    continue
 
1009
                missing_keys.remove(record.key)
 
1010
                lines = split_lines(record.get_bytes_as('fulltext'))
 
1011
                text_map[record.key] = lines
 
1012
                content_map[record.key] = PlainKnitContent(lines, record.key)
 
1013
                if record.key in keys:
 
1014
                    final_content[record.key] = content_map[record.key]
 
1015
        for key in keys:
 
1016
            if key in nonlocal_keys:
 
1017
                # already handled
 
1018
                continue
 
1019
            components = []
 
1020
            cursor = key
 
1021
            while cursor is not None:
 
1022
                try:
 
1023
                    record, record_details, digest, next = record_map[cursor]
 
1024
                except KeyError:
 
1025
                    raise RevisionNotPresent(cursor, self)
 
1026
                components.append((cursor, record, record_details, digest))
 
1027
                cursor = next
 
1028
                if cursor in content_map:
 
1029
                    # no need to plan further back
 
1030
                    components.append((cursor, None, None, None))
 
1031
                    break
 
1032
 
 
1033
            content = None
 
1034
            for (component_id, record, record_details,
 
1035
                 digest) in reversed(components):
 
1036
                if component_id in content_map:
 
1037
                    content = content_map[component_id]
 
1038
                else:
 
1039
                    content, delta = self._factory.parse_record(key[-1],
 
1040
                        record, record_details, content,
 
1041
                        copy_base_content=multiple_versions)
 
1042
                    if multiple_versions:
 
1043
                        content_map[component_id] = content
 
1044
 
 
1045
            final_content[key] = content
 
1046
 
 
1047
            # digest here is the digest from the last applied component.
 
1048
            text = content.text()
 
1049
            actual_sha = sha_strings(text)
 
1050
            if actual_sha != digest:
 
1051
                raise KnitCorrupt(self,
 
1052
                    '\n  sha-1 %s'
 
1053
                    '\n  of reconstructed text does not match'
 
1054
                    '\n  expected %s'
 
1055
                    '\n  for version %s' %
 
1056
                    (actual_sha, digest, key))
 
1057
            text_map[key] = text
 
1058
        return text_map, final_content
 
1059
 
 
1060
    def get_parent_map(self, keys):
 
1061
        """Get a map of the graph parents of keys.
 
1062
 
 
1063
        :param keys: The keys to look up parents for.
 
1064
        :return: A mapping from keys to parents. Absent keys are absent from
 
1065
            the mapping.
 
1066
        """
 
1067
        return self._get_parent_map_with_sources(keys)[0]
 
1068
 
 
1069
    def _get_parent_map_with_sources(self, keys):
 
1070
        """Get a map of the parents of keys.
 
1071
 
 
1072
        :param keys: The keys to look up parents for.
 
1073
        :return: A tuple. The first element is a mapping from keys to parents.
 
1074
            Absent keys are absent from the mapping. The second element is a
 
1075
            list with the locations each key was found in. The first element
 
1076
            is the in-this-knit parents, the second the first fallback source,
 
1077
            and so on.
 
1078
        """
 
1079
        result = {}
 
1080
        sources = [self._index] + self._fallback_vfs
 
1081
        source_results = []
 
1082
        missing = set(keys)
 
1083
        for source in sources:
 
1084
            if not missing:
 
1085
                break
 
1086
            new_result = source.get_parent_map(missing)
 
1087
            source_results.append(new_result)
 
1088
            result.update(new_result)
 
1089
            missing.difference_update(set(new_result))
 
1090
        return result, source_results
 
1091
 
 
1092
    def _get_record_map(self, keys, allow_missing=False):
 
1093
        """Produce a dictionary of knit records.
 
1094
        
 
1095
        :return: {key:(record, record_details, digest, next)}
 
1096
            record
 
1097
                data returned from read_records
 
1098
            record_details
 
1099
                opaque information to pass to parse_record
 
1100
            digest
 
1101
                SHA1 digest of the full text after all steps are done
 
1102
            next
 
1103
                build-parent of the version, i.e. the leftmost ancestor.
 
1104
                Will be None if the record is not a delta.
 
1105
        :param keys: The keys to build a map for
 
1106
        :param allow_missing: If some records are missing, rather than 
 
1107
            error, just return the data that could be generated.
 
1108
        """
 
1109
        position_map = self._get_components_positions(keys,
 
1110
            allow_missing=allow_missing)
 
1111
        # key = component_id, r = record_details, i_m = index_memo, n = next
 
1112
        records = [(key, i_m) for key, (r, i_m, n)
 
1113
                             in position_map.iteritems()]
 
1114
        record_map = {}
 
1115
        for key, record, digest in \
 
1116
                self._read_records_iter(records):
 
1117
            (record_details, index_memo, next) = position_map[key]
 
1118
            record_map[key] = record, record_details, digest, next
 
1119
        return record_map
 
1120
 
 
1121
    def get_record_stream(self, keys, ordering, include_delta_closure):
 
1122
        """Get a stream of records for keys.
 
1123
 
 
1124
        :param keys: The keys to include.
 
1125
        :param ordering: Either 'unordered' or 'topological'. A topologically
 
1126
            sorted stream has compression parents strictly before their
 
1127
            children.
 
1128
        :param include_delta_closure: If True then the closure across any
 
1129
            compression parents will be included (in the opaque data).
 
1130
        :return: An iterator of ContentFactory objects, each of which is only
 
1131
            valid until the iterator is advanced.
 
1132
        """
 
1133
        # keys might be a generator
 
1134
        keys = set(keys)
 
1135
        if not keys:
 
1136
            return
 
1137
        if not self._index.has_graph:
 
1138
            # Cannot topological order when no graph has been stored.
 
1139
            ordering = 'unordered'
 
1140
        if include_delta_closure:
 
1141
            positions = self._get_components_positions(keys, allow_missing=True)
 
1142
        else:
 
1143
            build_details = self._index.get_build_details(keys)
 
1144
            # map from key to
 
1145
            # (record_details, access_memo, compression_parent_key)
 
1146
            positions = dict((key, self._build_details_to_components(details))
 
1147
                for key, details in build_details.iteritems())
 
1148
        absent_keys = keys.difference(set(positions))
 
1149
        # There may be more absent keys : if we're missing the basis component
 
1150
        # and are trying to include the delta closure.
 
1151
        if include_delta_closure:
 
1152
            needed_from_fallback = set()
 
1153
            # Build up reconstructable_keys dict.  key:True in this dict means
 
1154
            # the key can be reconstructed.
 
1155
            reconstructable_keys = {}
 
1156
            for key in keys:
 
1157
                # the delta chain
 
1158
                try:
 
1159
                    chain = [key, positions[key][2]]
 
1160
                except KeyError:
 
1161
                    needed_from_fallback.add(key)
 
1162
                    continue
 
1163
                result = True
 
1164
                while chain[-1] is not None:
 
1165
                    if chain[-1] in reconstructable_keys:
 
1166
                        result = reconstructable_keys[chain[-1]]
 
1167
                        break
 
1168
                    else:
 
1169
                        try:
 
1170
                            chain.append(positions[chain[-1]][2])
 
1171
                        except KeyError:
 
1172
                            # missing basis component
 
1173
                            needed_from_fallback.add(chain[-1])
 
1174
                            result = True
 
1175
                            break
 
1176
                for chain_key in chain[:-1]:
 
1177
                    reconstructable_keys[chain_key] = result
 
1178
                if not result:
 
1179
                    needed_from_fallback.add(key)
 
1180
        # Double index lookups here : need a unified api ?
 
1181
        global_map, parent_maps = self._get_parent_map_with_sources(keys)
 
1182
        if ordering == 'topological':
 
1183
            # Global topological sort
 
1184
            present_keys = tsort.topo_sort(global_map)
 
1185
            # Now group by source:
 
1186
            source_keys = []
 
1187
            current_source = None
 
1188
            for key in present_keys:
 
1189
                for parent_map in parent_maps:
 
1190
                    if key in parent_map:
 
1191
                        key_source = parent_map
 
1192
                        break
 
1193
                if current_source is not key_source:
 
1194
                    source_keys.append((key_source, []))
 
1195
                    current_source = key_source
 
1196
                source_keys[-1][1].append(key)
 
1197
        else:
 
1198
            if ordering != 'unordered':
 
1199
                raise AssertionError('valid values for ordering are:'
 
1200
                    ' "unordered" or "topological" not: %r'
 
1201
                    % (ordering,))
 
1202
            # Just group by source; remote sources first.
 
1203
            present_keys = []
 
1204
            source_keys = []
 
1205
            for parent_map in reversed(parent_maps):
 
1206
                source_keys.append((parent_map, []))
 
1207
                for key in parent_map:
 
1208
                    present_keys.append(key)
 
1209
                    source_keys[-1][1].append(key)
 
1210
        absent_keys = keys - set(global_map)
 
1211
        for key in absent_keys:
 
1212
            yield AbsentContentFactory(key)
 
1213
        # restrict our view to the keys we can answer.
 
1214
        # XXX: Memory: TODO: batch data here to cap buffered data at (say) 1MB.
 
1215
        # XXX: At that point we need to consider the impact of double reads by
 
1216
        # utilising components multiple times.
 
1217
        if include_delta_closure:
 
1218
            # XXX: get_content_maps performs its own index queries; allow state
 
1219
            # to be passed in.
 
1220
            text_map, _ = self._get_content_maps(present_keys,
 
1221
                needed_from_fallback - absent_keys)
 
1222
            for key in present_keys:
 
1223
                yield FulltextContentFactory(key, global_map[key], None,
 
1224
                    ''.join(text_map[key]))
 
1225
        else:
 
1226
            for source, keys in source_keys:
 
1227
                if source is parent_maps[0]:
 
1228
                    # this KnitVersionedFiles
 
1229
                    records = [(key, positions[key][1]) for key in keys]
 
1230
                    for key, raw_data, sha1 in self._read_records_iter_raw(records):
 
1231
                        (record_details, index_memo, _) = positions[key]
 
1232
                        yield KnitContentFactory(key, global_map[key],
 
1233
                            record_details, sha1, raw_data, self._factory.annotated, None)
 
1234
                else:
 
1235
                    vf = self._fallback_vfs[parent_maps.index(source) - 1]
 
1236
                    for record in vf.get_record_stream(keys, ordering,
 
1237
                        include_delta_closure):
 
1238
                        yield record
 
1239
 
 
1240
    def get_sha1s(self, keys):
 
1241
        """See VersionedFiles.get_sha1s()."""
 
1242
        missing = set(keys)
 
1243
        record_map = self._get_record_map(missing, allow_missing=True)
 
1244
        result = {}
 
1245
        for key, details in record_map.iteritems():
 
1246
            if key not in missing:
 
1247
                continue
 
1248
            # record entry 2 is the 'digest'.
 
1249
            result[key] = details[2]
 
1250
        missing.difference_update(set(result))
 
1251
        for source in self._fallback_vfs:
 
1252
            if not missing:
 
1253
                break
 
1254
            new_result = source.get_sha1s(missing)
 
1255
            result.update(new_result)
 
1256
            missing.difference_update(set(new_result))
 
1257
        return result
 
1258
 
 
1259
    def insert_record_stream(self, stream):
 
1260
        """Insert a record stream into this container.
 
1261
 
 
1262
        :param stream: A stream of records to insert. 
 
1263
        :return: None
 
1264
        :seealso VersionedFiles.get_record_stream:
 
1265
        """
 
1266
        def get_adapter(adapter_key):
 
1267
            try:
 
1268
                return adapters[adapter_key]
 
1269
            except KeyError:
 
1270
                adapter_factory = adapter_registry.get(adapter_key)
 
1271
                adapter = adapter_factory(self)
 
1272
                adapters[adapter_key] = adapter
 
1273
                return adapter
 
1274
        if self._factory.annotated:
 
1275
            # self is annotated, we need annotated knits to use directly.
 
1276
            annotated = "annotated-"
 
1277
            convertibles = []
 
1278
        else:
 
1279
            # self is not annotated, but we can strip annotations cheaply.
 
1280
            annotated = ""
 
1281
            convertibles = set(["knit-annotated-ft-gz"])
 
1282
            if self._max_delta_chain:
 
1283
                convertibles.add("knit-annotated-delta-gz")
 
1284
        # The set of types we can cheaply adapt without needing basis texts.
 
1285
        native_types = set()
 
1286
        if self._max_delta_chain:
 
1287
            native_types.add("knit-%sdelta-gz" % annotated)
 
1288
        native_types.add("knit-%sft-gz" % annotated)
 
1289
        knit_types = native_types.union(convertibles)
 
1290
        adapters = {}
 
1291
        # Buffer all index entries that we can't add immediately because their
 
1292
        # basis parent is missing. We don't buffer all because generating
 
1293
        # annotations may require access to some of the new records. However we
 
1294
        # can't generate annotations from new deltas until their basis parent
 
1295
        # is present anyway, so we get away with not needing an index that
 
1296
        # includes the new keys.
 
1297
        # key = basis_parent, value = index entry to add
 
1298
        buffered_index_entries = {}
 
1299
        for record in stream:
 
1300
            parents = record.parents
 
1301
            # Raise an error when a record is missing.
 
1302
            if record.storage_kind == 'absent':
 
1303
                raise RevisionNotPresent([record.key], self)
 
1304
            if record.storage_kind in knit_types:
 
1305
                if record.storage_kind not in native_types:
 
1306
                    try:
 
1307
                        adapter_key = (record.storage_kind, "knit-delta-gz")
 
1308
                        adapter = get_adapter(adapter_key)
 
1309
                    except KeyError:
 
1310
                        adapter_key = (record.storage_kind, "knit-ft-gz")
 
1311
                        adapter = get_adapter(adapter_key)
 
1312
                    bytes = adapter.get_bytes(
 
1313
                        record, record.get_bytes_as(record.storage_kind))
 
1314
                else:
 
1315
                    bytes = record.get_bytes_as(record.storage_kind)
 
1316
                options = [record._build_details[0]]
 
1317
                if record._build_details[1]:
 
1318
                    options.append('no-eol')
 
1319
                # Just blat it across.
 
1320
                # Note: This does end up adding data on duplicate keys. As
 
1321
                # modern repositories use atomic insertions this should not
 
1322
                # lead to excessive growth in the event of interrupted fetches.
 
1323
                # 'knit' repositories may suffer excessive growth, but as a
 
1324
                # deprecated format this is tolerable. It can be fixed if
 
1325
                # needed by in the kndx index support raising on a duplicate
 
1326
                # add with identical parents and options.
 
1327
                access_memo = self._access.add_raw_records(
 
1328
                    [(record.key, len(bytes))], bytes)[0]
 
1329
                index_entry = (record.key, options, access_memo, parents)
 
1330
                buffered = False
 
1331
                if 'fulltext' not in options:
 
1332
                    basis_parent = parents[0]
 
1333
                    # Note that pack backed knits don't need to buffer here
 
1334
                    # because they buffer all writes to the transaction level,
 
1335
                    # but we don't expose that difference at the index level. If
 
1336
                    # the query here has sufficient cost to show up in
 
1337
                    # profiling we should do that.
 
1338
                    if basis_parent not in self.get_parent_map([basis_parent]):
 
1339
                        pending = buffered_index_entries.setdefault(
 
1340
                            basis_parent, [])
 
1341
                        pending.append(index_entry)
 
1342
                        buffered = True
 
1343
                if not buffered:
 
1344
                    self._index.add_records([index_entry])
 
1345
            elif record.storage_kind == 'fulltext':
 
1346
                self.add_lines(record.key, parents,
 
1347
                    split_lines(record.get_bytes_as('fulltext')))
 
1348
            else:
 
1349
                adapter_key = record.storage_kind, 'fulltext'
 
1350
                adapter = get_adapter(adapter_key)
 
1351
                lines = split_lines(adapter.get_bytes(
 
1352
                    record, record.get_bytes_as(record.storage_kind)))
 
1353
                try:
 
1354
                    self.add_lines(record.key, parents, lines)
 
1355
                except errors.RevisionAlreadyPresent:
 
1356
                    pass
 
1357
            # Add any records whose basis parent is now available.
 
1358
            added_keys = [record.key]
 
1359
            while added_keys:
 
1360
                key = added_keys.pop(0)
 
1361
                if key in buffered_index_entries:
 
1362
                    index_entries = buffered_index_entries[key]
 
1363
                    self._index.add_records(index_entries)
 
1364
                    added_keys.extend(
 
1365
                        [index_entry[0] for index_entry in index_entries])
 
1366
                    del buffered_index_entries[key]
 
1367
        # If there were any deltas which had a missing basis parent, error.
 
1368
        if buffered_index_entries:
 
1369
            raise errors.RevisionNotPresent(buffered_index_entries.keys()[0],
 
1370
                self)
 
1371
 
 
1372
    def iter_lines_added_or_present_in_keys(self, keys, pb=None):
 
1373
        """Iterate over the lines in the versioned files from keys.
 
1374
 
 
1375
        This may return lines from other keys. Each item the returned
 
1376
        iterator yields is a tuple of a line and a text version that that line
 
1377
        is present in (not introduced in).
 
1378
 
 
1379
        Ordering of results is in whatever order is most suitable for the
 
1380
        underlying storage format.
 
1381
 
 
1382
        If a progress bar is supplied, it may be used to indicate progress.
 
1383
        The caller is responsible for cleaning up progress bars (because this
 
1384
        is an iterator).
 
1385
 
 
1386
        NOTES:
 
1387
         * Lines are normalised by the underlying store: they will all have \n
 
1388
           terminators.
 
1389
         * Lines are returned in arbitrary order.
 
1390
 
 
1391
        :return: An iterator over (line, key).
 
1392
        """
 
1393
        if pb is None:
 
1394
            pb = progress.DummyProgress()
 
1395
        keys = set(keys)
 
1396
        total = len(keys)
731
1397
        # we don't care about inclusions, the caller cares.
732
1398
        # but we need to setup a list of records to visit.
733
 
        # we need version_id, position, length
734
 
        version_id_records = []
735
 
        requested_versions = list(version_ids)
736
 
        # filter for available versions
737
 
        for version_id in requested_versions:
738
 
            if not self.has_version(version_id):
739
 
                raise RevisionNotPresent(version_id, self.filename)
740
 
        # get a in-component-order queue:
741
 
        version_ids = []
742
 
        for version_id in self.versions():
743
 
            if version_id in requested_versions:
744
 
                version_ids.append(version_id)
745
 
                data_pos, length = self._index.get_position(version_id)
746
 
                version_id_records.append((version_id, data_pos, length))
747
 
 
748
 
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
749
 
        count = 0
750
 
        total = len(version_id_records)
751
 
        try:
752
 
            pb.update('Walking content.', count, total)
753
 
            for version_id, data, sha_value in \
754
 
                self._data.read_records_iter(version_id_records):
755
 
                pb.update('Walking content.', count, total)
756
 
                method = self._index.get_method(version_id)
757
 
                version_idx = self._index.lookup(version_id)
758
 
                assert method in ('fulltext', 'line-delta')
759
 
                if method == 'fulltext':
760
 
                    content = self.factory.parse_fulltext(data, version_idx)
761
 
                    for line in content.text():
762
 
                        yield line
 
1399
        # we need key, position, length
 
1400
        key_records = []
 
1401
        build_details = self._index.get_build_details(keys)
 
1402
        for key, details in build_details.iteritems():
 
1403
            if key in keys:
 
1404
                key_records.append((key, details[0]))
 
1405
                keys.remove(key)
 
1406
        records_iter = enumerate(self._read_records_iter(key_records))
 
1407
        for (key_idx, (key, data, sha_value)) in records_iter:
 
1408
            pb.update('Walking content.', key_idx, total)
 
1409
            compression_parent = build_details[key][1]
 
1410
            if compression_parent is None:
 
1411
                # fulltext
 
1412
                line_iterator = self._factory.get_fulltext_content(data)
 
1413
            else:
 
1414
                # Delta 
 
1415
                line_iterator = self._factory.get_linedelta_content(data)
 
1416
            # XXX: It might be more efficient to yield (key,
 
1417
            # line_iterator) in the future. However for now, this is a simpler
 
1418
            # change to integrate into the rest of the codebase. RBC 20071110
 
1419
            for line in line_iterator:
 
1420
                yield line, key
 
1421
        for source in self._fallback_vfs:
 
1422
            if not keys:
 
1423
                break
 
1424
            source_keys = set()
 
1425
            for line, key in source.iter_lines_added_or_present_in_keys(keys):
 
1426
                source_keys.add(key)
 
1427
                yield line, key
 
1428
            keys.difference_update(source_keys)
 
1429
        if keys:
 
1430
            raise RevisionNotPresent(keys, self.filename)
 
1431
        pb.update('Walking content.', total, total)
 
1432
 
 
1433
    def _make_line_delta(self, delta_seq, new_content):
 
1434
        """Generate a line delta from delta_seq and new_content."""
 
1435
        diff_hunks = []
 
1436
        for op in delta_seq.get_opcodes():
 
1437
            if op[0] == 'equal':
 
1438
                continue
 
1439
            diff_hunks.append((op[1], op[2], op[4]-op[3], new_content._lines[op[3]:op[4]]))
 
1440
        return diff_hunks
 
1441
 
 
1442
    def _merge_annotations(self, content, parents, parent_texts={},
 
1443
                           delta=None, annotated=None,
 
1444
                           left_matching_blocks=None):
 
1445
        """Merge annotations for content and generate deltas.
 
1446
        
 
1447
        This is done by comparing the annotations based on changes to the text
 
1448
        and generating a delta on the resulting full texts. If annotations are
 
1449
        not being created then a simple delta is created.
 
1450
        """
 
1451
        if left_matching_blocks is not None:
 
1452
            delta_seq = diff._PrematchedMatcher(left_matching_blocks)
 
1453
        else:
 
1454
            delta_seq = None
 
1455
        if annotated:
 
1456
            for parent_key in parents:
 
1457
                merge_content = self._get_content(parent_key, parent_texts)
 
1458
                if (parent_key == parents[0] and delta_seq is not None):
 
1459
                    seq = delta_seq
763
1460
                else:
764
 
                    delta = self.factory.parse_line_delta(data, version_idx)
765
 
                    for start, end, count, lines in delta:
766
 
                        for origin, line in lines:
767
 
                            yield line
768
 
                count +=1
769
 
            pb.update('Walking content.', total, total)
770
 
            pb.finished()
771
 
        except:
772
 
            pb.update('Walking content.', total, total)
773
 
            pb.finished()
774
 
            raise
775
 
        
776
 
    def num_versions(self):
777
 
        """See VersionedFile.num_versions()."""
778
 
        return self._index.num_versions()
779
 
 
780
 
    __len__ = num_versions
781
 
 
782
 
    def annotate_iter(self, version_id):
783
 
        """See VersionedFile.annotate_iter."""
784
 
        content = self._get_content(version_id)
785
 
        for origin, text in content.annotate_iter():
786
 
            yield origin, text
787
 
 
788
 
    def get_parents(self, version_id):
789
 
        """See VersionedFile.get_parents."""
790
 
        # perf notes:
791
 
        # optimism counts!
792
 
        # 52554 calls in 1264 872 internal down from 3674
793
 
        try:
794
 
            return self._index.get_parents(version_id)
795
 
        except KeyError:
796
 
            raise RevisionNotPresent(version_id, self.filename)
797
 
 
798
 
    def get_parents_with_ghosts(self, version_id):
799
 
        """See VersionedFile.get_parents."""
800
 
        try:
801
 
            return self._index.get_parents_with_ghosts(version_id)
802
 
        except KeyError:
803
 
            raise RevisionNotPresent(version_id, self.filename)
804
 
 
805
 
    def get_ancestry(self, versions):
806
 
        """See VersionedFile.get_ancestry."""
807
 
        if isinstance(versions, basestring):
808
 
            versions = [versions]
809
 
        if not versions:
810
 
            return []
811
 
        self._check_versions_present(versions)
812
 
        return self._index.get_ancestry(versions)
813
 
 
814
 
    def get_ancestry_with_ghosts(self, versions):
815
 
        """See VersionedFile.get_ancestry_with_ghosts."""
816
 
        if isinstance(versions, basestring):
817
 
            versions = [versions]
818
 
        if not versions:
819
 
            return []
820
 
        self._check_versions_present(versions)
821
 
        return self._index.get_ancestry_with_ghosts(versions)
822
 
 
823
 
    #@deprecated_method(zero_eight)
824
 
    def walk(self, version_ids):
825
 
        """See VersionedFile.walk."""
826
 
        # We take the short path here, and extract all relevant texts
827
 
        # and put them in a weave and let that do all the work.  Far
828
 
        # from optimal, but is much simpler.
829
 
        # FIXME RB 20060228 this really is inefficient!
830
 
        from bzrlib.weave import Weave
831
 
 
832
 
        w = Weave(self.filename)
833
 
        ancestry = self.get_ancestry(version_ids)
834
 
        sorted_graph = topo_sort(self._index.get_graph())
835
 
        version_list = [vid for vid in sorted_graph if vid in ancestry]
836
 
        
837
 
        for version_id in version_list:
838
 
            lines = self.get_lines(version_id)
839
 
            w.add_lines(version_id, self.get_parents(version_id), lines)
840
 
 
841
 
        for lineno, insert_id, dset, line in w.walk(version_ids):
842
 
            yield lineno, insert_id, dset, line
843
 
 
844
 
    def plan_merge(self, ver_a, ver_b):
845
 
        """See VersionedFile.plan_merge."""
846
 
        ancestors_b = set(self.get_ancestry(ver_b))
847
 
        def status_a(revision, text):
848
 
            if revision in ancestors_b:
849
 
                return 'killed-b', text
850
 
            else:
851
 
                return 'new-a', text
852
 
        
853
 
        ancestors_a = set(self.get_ancestry(ver_a))
854
 
        def status_b(revision, text):
855
 
            if revision in ancestors_a:
856
 
                return 'killed-a', text
857
 
            else:
858
 
                return 'new-b', text
859
 
 
860
 
        annotated_a = self.annotate(ver_a)
861
 
        annotated_b = self.annotate(ver_b)
862
 
        plain_a = [t for (a, t) in annotated_a]
863
 
        plain_b = [t for (a, t) in annotated_b]
864
 
        blocks = KnitSequenceMatcher(None, plain_a, plain_b).get_matching_blocks()
865
 
        a_cur = 0
866
 
        b_cur = 0
867
 
        for ai, bi, l in blocks:
868
 
            # process all mismatched sections
869
 
            # (last mismatched section is handled because blocks always
870
 
            # includes a 0-length last block)
871
 
            for revision, text in annotated_a[a_cur:ai]:
872
 
                yield status_a(revision, text)
873
 
            for revision, text in annotated_b[b_cur:bi]:
874
 
                yield status_b(revision, text)
875
 
 
876
 
            # and now the matched section
877
 
            a_cur = ai + l
878
 
            b_cur = bi + l
879
 
            for text_a, text_b in zip(plain_a[ai:a_cur], plain_b[bi:b_cur]):
880
 
                assert text_a == text_b
881
 
                yield "unchanged", text_a
882
 
 
883
 
 
884
 
class _KnitComponentFile(object):
885
 
    """One of the files used to implement a knit database"""
886
 
 
887
 
    def __init__(self, transport, filename, mode, file_mode=None):
888
 
        self._transport = transport
889
 
        self._filename = filename
890
 
        self._mode = mode
891
 
        self._file_mode=file_mode
892
 
 
893
 
    def write_header(self):
894
 
        if self._transport.append(self._filename, StringIO(self.HEADER),
895
 
            mode=self._file_mode):
896
 
            raise KnitCorrupt(self._filename, 'misaligned after writing header')
897
 
 
898
 
    def check_header(self, fp):
899
 
        line = fp.readline()
900
 
        if line != self.HEADER:
901
 
            raise KnitHeaderError(badline=line)
902
 
 
903
 
    def commit(self):
904
 
        """Commit is a nop."""
905
 
 
906
 
    def __repr__(self):
907
 
        return '%s(%s)' % (self.__class__.__name__, self._filename)
908
 
 
909
 
 
910
 
class _KnitIndex(_KnitComponentFile):
911
 
    """Manages knit index file.
912
 
 
913
 
    The index is already kept in memory and read on startup, to enable
 
1461
                    seq = patiencediff.PatienceSequenceMatcher(
 
1462
                        None, merge_content.text(), content.text())
 
1463
                for i, j, n in seq.get_matching_blocks():
 
1464
                    if n == 0:
 
1465
                        continue
 
1466
                    # this copies (origin, text) pairs across to the new
 
1467
                    # content for any line that matches the last-checked
 
1468
                    # parent.
 
1469
                    content._lines[j:j+n] = merge_content._lines[i:i+n]
 
1470
            # XXX: Robert says the following block is a workaround for a
 
1471
            # now-fixed bug and it can probably be deleted. -- mbp 20080618
 
1472
            if content._lines and content._lines[-1][1][-1] != '\n':
 
1473
                # The copied annotation was from a line without a trailing EOL,
 
1474
                # reinstate one for the content object, to ensure correct
 
1475
                # serialization.
 
1476
                line = content._lines[-1][1] + '\n'
 
1477
                content._lines[-1] = (content._lines[-1][0], line)
 
1478
        if delta:
 
1479
            if delta_seq is None:
 
1480
                reference_content = self._get_content(parents[0], parent_texts)
 
1481
                new_texts = content.text()
 
1482
                old_texts = reference_content.text()
 
1483
                delta_seq = patiencediff.PatienceSequenceMatcher(
 
1484
                                                 None, old_texts, new_texts)
 
1485
            return self._make_line_delta(delta_seq, content)
 
1486
 
 
1487
    def _parse_record(self, version_id, data):
 
1488
        """Parse an original format knit record.
 
1489
 
 
1490
        These have the last element of the key only present in the stored data.
 
1491
        """
 
1492
        rec, record_contents = self._parse_record_unchecked(data)
 
1493
        self._check_header_version(rec, version_id)
 
1494
        return record_contents, rec[3]
 
1495
 
 
1496
    def _parse_record_header(self, key, raw_data):
 
1497
        """Parse a record header for consistency.
 
1498
 
 
1499
        :return: the header and the decompressor stream.
 
1500
                 as (stream, header_record)
 
1501
        """
 
1502
        df = tuned_gzip.GzipFile(mode='rb', fileobj=StringIO(raw_data))
 
1503
        try:
 
1504
            # Current serialise
 
1505
            rec = self._check_header(key, df.readline())
 
1506
        except Exception, e:
 
1507
            raise KnitCorrupt(self,
 
1508
                              "While reading {%s} got %s(%s)"
 
1509
                              % (key, e.__class__.__name__, str(e)))
 
1510
        return df, rec
 
1511
 
 
1512
    def _parse_record_unchecked(self, data):
 
1513
        # profiling notes:
 
1514
        # 4168 calls in 2880 217 internal
 
1515
        # 4168 calls to _parse_record_header in 2121
 
1516
        # 4168 calls to readlines in 330
 
1517
        df = tuned_gzip.GzipFile(mode='rb', fileobj=StringIO(data))
 
1518
        try:
 
1519
            record_contents = df.readlines()
 
1520
        except Exception, e:
 
1521
            raise KnitCorrupt(self, "Corrupt compressed record %r, got %s(%s)" %
 
1522
                (data, e.__class__.__name__, str(e)))
 
1523
        header = record_contents.pop(0)
 
1524
        rec = self._split_header(header)
 
1525
        last_line = record_contents.pop()
 
1526
        if len(record_contents) != int(rec[2]):
 
1527
            raise KnitCorrupt(self,
 
1528
                              'incorrect number of lines %s != %s'
 
1529
                              ' for version {%s} %s'
 
1530
                              % (len(record_contents), int(rec[2]),
 
1531
                                 rec[1], record_contents))
 
1532
        if last_line != 'end %s\n' % rec[1]:
 
1533
            raise KnitCorrupt(self,
 
1534
                              'unexpected version end line %r, wanted %r' 
 
1535
                              % (last_line, rec[1]))
 
1536
        df.close()
 
1537
        return rec, record_contents
 
1538
 
 
1539
    def _read_records_iter(self, records):
 
1540
        """Read text records from data file and yield result.
 
1541
 
 
1542
        The result will be returned in whatever is the fastest to read.
 
1543
        Not by the order requested. Also, multiple requests for the same
 
1544
        record will only yield 1 response.
 
1545
        :param records: A list of (key, access_memo) entries
 
1546
        :return: Yields (key, contents, digest) in the order
 
1547
                 read, not the order requested
 
1548
        """
 
1549
        if not records:
 
1550
            return
 
1551
 
 
1552
        # XXX: This smells wrong, IO may not be getting ordered right.
 
1553
        needed_records = sorted(set(records), key=operator.itemgetter(1))
 
1554
        if not needed_records:
 
1555
            return
 
1556
 
 
1557
        # The transport optimizes the fetching as well 
 
1558
        # (ie, reads continuous ranges.)
 
1559
        raw_data = self._access.get_raw_records(
 
1560
            [index_memo for key, index_memo in needed_records])
 
1561
 
 
1562
        for (key, index_memo), data in \
 
1563
                izip(iter(needed_records), raw_data):
 
1564
            content, digest = self._parse_record(key[-1], data)
 
1565
            yield key, content, digest
 
1566
 
 
1567
    def _read_records_iter_raw(self, records):
 
1568
        """Read text records from data file and yield raw data.
 
1569
 
 
1570
        This unpacks enough of the text record to validate the id is
 
1571
        as expected but thats all.
 
1572
 
 
1573
        Each item the iterator yields is (key, bytes, sha1_of_full_text).
 
1574
        """
 
1575
        # setup an iterator of the external records:
 
1576
        # uses readv so nice and fast we hope.
 
1577
        if len(records):
 
1578
            # grab the disk data needed.
 
1579
            needed_offsets = [index_memo for key, index_memo
 
1580
                                           in records]
 
1581
            raw_records = self._access.get_raw_records(needed_offsets)
 
1582
 
 
1583
        for key, index_memo in records:
 
1584
            data = raw_records.next()
 
1585
            # validate the header (note that we can only use the suffix in
 
1586
            # current knit records).
 
1587
            df, rec = self._parse_record_header(key, data)
 
1588
            df.close()
 
1589
            yield key, data, rec[3]
 
1590
 
 
1591
    def _record_to_data(self, key, digest, lines, dense_lines=None):
 
1592
        """Convert key, digest, lines into a raw data block.
 
1593
        
 
1594
        :param key: The key of the record. Currently keys are always serialised
 
1595
            using just the trailing component.
 
1596
        :param dense_lines: The bytes of lines but in a denser form. For
 
1597
            instance, if lines is a list of 1000 bytestrings each ending in \n,
 
1598
            dense_lines may be a list with one line in it, containing all the
 
1599
            1000's lines and their \n's. Using dense_lines if it is already
 
1600
            known is a win because the string join to create bytes in this
 
1601
            function spends less time resizing the final string.
 
1602
        :return: (len, a StringIO instance with the raw data ready to read.)
 
1603
        """
 
1604
        # Note: using a string copy here increases memory pressure with e.g.
 
1605
        # ISO's, but it is about 3 seconds faster on a 1.2Ghz intel machine
 
1606
        # when doing the initial commit of a mozilla tree. RBC 20070921
 
1607
        bytes = ''.join(chain(
 
1608
            ["version %s %d %s\n" % (key[-1],
 
1609
                                     len(lines),
 
1610
                                     digest)],
 
1611
            dense_lines or lines,
 
1612
            ["end %s\n" % key[-1]]))
 
1613
        if type(bytes) != str:
 
1614
            raise AssertionError(
 
1615
                'data must be plain bytes was %s' % type(bytes))
 
1616
        if lines and lines[-1][-1] != '\n':
 
1617
            raise ValueError('corrupt lines value %r' % lines)
 
1618
        compressed_bytes = tuned_gzip.bytes_to_gzip(bytes)
 
1619
        return len(compressed_bytes), compressed_bytes
 
1620
 
 
1621
    def _split_header(self, line):
 
1622
        rec = line.split()
 
1623
        if len(rec) != 4:
 
1624
            raise KnitCorrupt(self,
 
1625
                              'unexpected number of elements in record header')
 
1626
        return rec
 
1627
 
 
1628
    def keys(self):
 
1629
        """See VersionedFiles.keys."""
 
1630
        if 'evil' in debug.debug_flags:
 
1631
            trace.mutter_callsite(2, "keys scales with size of history")
 
1632
        sources = [self._index] + self._fallback_vfs
 
1633
        result = set()
 
1634
        for source in sources:
 
1635
            result.update(source.keys())
 
1636
        return result
 
1637
 
 
1638
 
 
1639
 
 
1640
class _KndxIndex(object):
 
1641
    """Manages knit index files
 
1642
 
 
1643
    The index is kept in memory and read on startup, to enable
914
1644
    fast lookups of revision information.  The cursor of the index
915
1645
    file is always pointing to the end, making it easy to append
916
1646
    entries.
949
1679
    The ' :' marker is the end of record marker.
950
1680
    
951
1681
    partial writes:
952
 
    when a write is interrupted to the index file, it will result in a line that
953
 
    does not end in ' :'. If the ' :' is not present at the end of a line, or at
954
 
    the end of the file, then the record that is missing it will be ignored by
955
 
    the parser.
 
1682
    when a write is interrupted to the index file, it will result in a line
 
1683
    that does not end in ' :'. If the ' :' is not present at the end of a line,
 
1684
    or at the end of the file, then the record that is missing it will be
 
1685
    ignored by the parser.
956
1686
 
957
1687
    When writing new records to the index file, the data is preceded by '\n'
958
1688
    to ensure that records always start on new lines even if the last write was
959
1689
    interrupted. As a result its normal for the last line in the index to be
960
1690
    missing a trailing newline. One can be added with no harmful effects.
 
1691
 
 
1692
    :ivar _kndx_cache: dict from prefix to the old state of KnitIndex objects,
 
1693
        where prefix is e.g. the (fileid,) for .texts instances or () for
 
1694
        constant-mapped things like .revisions, and the old state is
 
1695
        tuple(history_vector, cache_dict).  This is used to prevent having an
 
1696
        ABI change with the C extension that reads .kndx files.
961
1697
    """
962
1698
 
963
1699
    HEADER = "# bzr knit index 8\n"
964
1700
 
965
 
    # speed of knit parsing went from 280 ms to 280 ms with slots addition.
966
 
    # __slots__ = ['_cache', '_history', '_transport', '_filename']
967
 
 
968
 
    def _cache_version(self, version_id, options, pos, size, parents):
 
1701
    def __init__(self, transport, mapper, get_scope, allow_writes, is_locked):
 
1702
        """Create a _KndxIndex on transport using mapper."""
 
1703
        self._transport = transport
 
1704
        self._mapper = mapper
 
1705
        self._get_scope = get_scope
 
1706
        self._allow_writes = allow_writes
 
1707
        self._is_locked = is_locked
 
1708
        self._reset_cache()
 
1709
        self.has_graph = True
 
1710
 
 
1711
    def add_records(self, records, random_id=False):
 
1712
        """Add multiple records to the index.
 
1713
        
 
1714
        :param records: a list of tuples:
 
1715
                         (key, options, access_memo, parents).
 
1716
        :param random_id: If True the ids being added were randomly generated
 
1717
            and no check for existence will be performed.
 
1718
        """
 
1719
        paths = {}
 
1720
        for record in records:
 
1721
            key = record[0]
 
1722
            prefix = key[:-1]
 
1723
            path = self._mapper.map(key) + '.kndx'
 
1724
            path_keys = paths.setdefault(path, (prefix, []))
 
1725
            path_keys[1].append(record)
 
1726
        for path in sorted(paths):
 
1727
            prefix, path_keys = paths[path]
 
1728
            self._load_prefixes([prefix])
 
1729
            lines = []
 
1730
            orig_history = self._kndx_cache[prefix][1][:]
 
1731
            orig_cache = self._kndx_cache[prefix][0].copy()
 
1732
 
 
1733
            try:
 
1734
                for key, options, (_, pos, size), parents in path_keys:
 
1735
                    if parents is None:
 
1736
                        # kndx indices cannot be parentless.
 
1737
                        parents = ()
 
1738
                    line = "\n%s %s %s %s %s :" % (
 
1739
                        key[-1], ','.join(options), pos, size,
 
1740
                        self._dictionary_compress(parents))
 
1741
                    if type(line) != str:
 
1742
                        raise AssertionError(
 
1743
                            'data must be utf8 was %s' % type(line))
 
1744
                    lines.append(line)
 
1745
                    self._cache_key(key, options, pos, size, parents)
 
1746
                if len(orig_history):
 
1747
                    self._transport.append_bytes(path, ''.join(lines))
 
1748
                else:
 
1749
                    self._init_index(path, lines)
 
1750
            except:
 
1751
                # If any problems happen, restore the original values and re-raise
 
1752
                self._kndx_cache[prefix] = (orig_cache, orig_history)
 
1753
                raise
 
1754
 
 
1755
    def _cache_key(self, key, options, pos, size, parent_keys):
969
1756
        """Cache a version record in the history array and index cache.
970
 
        
971
 
        This is inlined into __init__ for performance. KEEP IN SYNC.
 
1757
 
 
1758
        This is inlined into _load_data for performance. KEEP IN SYNC.
972
1759
        (It saves 60ms, 25% of the __init__ overhead on local 4000 record
973
1760
         indexes).
974
1761
        """
 
1762
        prefix = key[:-1]
 
1763
        version_id = key[-1]
 
1764
        # last-element only for compatibilty with the C load_data.
 
1765
        parents = tuple(parent[-1] for parent in parent_keys)
 
1766
        for parent in parent_keys:
 
1767
            if parent[:-1] != prefix:
 
1768
                raise ValueError("mismatched prefixes for %r, %r" % (
 
1769
                    key, parent_keys))
 
1770
        cache, history = self._kndx_cache[prefix]
975
1771
        # only want the _history index to reference the 1st index entry
976
1772
        # for version_id
977
 
        if version_id not in self._cache:
978
 
            index = len(self._history)
979
 
            self._history.append(version_id)
 
1773
        if version_id not in cache:
 
1774
            index = len(history)
 
1775
            history.append(version_id)
980
1776
        else:
981
 
            index = self._cache[version_id][5]
982
 
        self._cache[version_id] = (version_id, 
 
1777
            index = cache[version_id][5]
 
1778
        cache[version_id] = (version_id,
983
1779
                                   options,
984
1780
                                   pos,
985
1781
                                   size,
986
1782
                                   parents,
987
1783
                                   index)
988
1784
 
989
 
    def __init__(self, transport, filename, mode, create=False, file_mode=None):
990
 
        _KnitComponentFile.__init__(self, transport, filename, mode, file_mode)
991
 
        self._cache = {}
992
 
        # position in _history is the 'official' index for a revision
993
 
        # but the values may have come from a newer entry.
994
 
        # so - wc -l of a knit index is != the number of unique names
995
 
        # in the weave.
996
 
        self._history = []
997
 
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1785
    def check_header(self, fp):
 
1786
        line = fp.readline()
 
1787
        if line == '':
 
1788
            # An empty file can actually be treated as though the file doesn't
 
1789
            # exist yet.
 
1790
            raise errors.NoSuchFile(self)
 
1791
        if line != self.HEADER:
 
1792
            raise KnitHeaderError(badline=line, filename=self)
 
1793
 
 
1794
    def _check_read(self):
 
1795
        if not self._is_locked():
 
1796
            raise errors.ObjectNotLocked(self)
 
1797
        if self._get_scope() != self._scope:
 
1798
            self._reset_cache()
 
1799
 
 
1800
    def _check_write_ok(self):
 
1801
        """Assert if not writes are permitted."""
 
1802
        if not self._is_locked():
 
1803
            raise errors.ObjectNotLocked(self)
 
1804
        if self._get_scope() != self._scope:
 
1805
            self._reset_cache()
 
1806
        if self._mode != 'w':
 
1807
            raise errors.ReadOnlyObjectDirtiedError(self)
 
1808
 
 
1809
    def get_build_details(self, keys):
 
1810
        """Get the method, index_memo and compression parent for keys.
 
1811
 
 
1812
        Ghosts are omitted from the result.
 
1813
 
 
1814
        :param keys: An iterable of keys.
 
1815
        :return: A dict of key:(index_memo, compression_parent, parents,
 
1816
            record_details).
 
1817
            index_memo
 
1818
                opaque structure to pass to read_records to extract the raw
 
1819
                data
 
1820
            compression_parent
 
1821
                Content that this record is built upon, may be None
 
1822
            parents
 
1823
                Logical parents of this node
 
1824
            record_details
 
1825
                extra information about the content which needs to be passed to
 
1826
                Factory.parse_record
 
1827
        """
 
1828
        prefixes = self._partition_keys(keys)
 
1829
        parent_map = self.get_parent_map(keys)
 
1830
        result = {}
 
1831
        for key in keys:
 
1832
            if key not in parent_map:
 
1833
                continue # Ghost
 
1834
            method = self.get_method(key)
 
1835
            parents = parent_map[key]
 
1836
            if method == 'fulltext':
 
1837
                compression_parent = None
 
1838
            else:
 
1839
                compression_parent = parents[0]
 
1840
            noeol = 'no-eol' in self.get_options(key)
 
1841
            index_memo = self.get_position(key)
 
1842
            result[key] = (index_memo, compression_parent,
 
1843
                                  parents, (method, noeol))
 
1844
        return result
 
1845
 
 
1846
    def get_method(self, key):
 
1847
        """Return compression method of specified key."""
 
1848
        options = self.get_options(key)
 
1849
        if 'fulltext' in options:
 
1850
            return 'fulltext'
 
1851
        elif 'line-delta' in options:
 
1852
            return 'line-delta'
 
1853
        else:
 
1854
            raise errors.KnitIndexUnknownMethod(self, options)
 
1855
 
 
1856
    def get_options(self, key):
 
1857
        """Return a list representing options.
 
1858
 
 
1859
        e.g. ['foo', 'bar']
 
1860
        """
 
1861
        prefix, suffix = self._split_key(key)
 
1862
        self._load_prefixes([prefix])
998
1863
        try:
999
 
            count = 0
1000
 
            total = 1
1001
 
            try:
1002
 
                pb.update('read knit index', count, total)
1003
 
                fp = self._transport.get(self._filename)
1004
 
                self.check_header(fp)
1005
 
                # readlines reads the whole file at once:
1006
 
                # bad for transports like http, good for local disk
1007
 
                # we save 60 ms doing this one change (
1008
 
                # from calling readline each time to calling
1009
 
                # readlines once.
1010
 
                # probably what we want for nice behaviour on
1011
 
                # http is a incremental readlines that yields, or
1012
 
                # a check for local vs non local indexes,
1013
 
                for l in fp.readlines():
1014
 
                    rec = l.split()
1015
 
                    if len(rec) < 5 or rec[-1] != ':':
1016
 
                        # corrupt line.
1017
 
                        # FIXME: in the future we should determine if its a
1018
 
                        # short write - and ignore it 
1019
 
                        # or a different failure, and raise. RBC 20060407
1020
 
                        continue
1021
 
                    count += 1
1022
 
                    total += 1
1023
 
                    #pb.update('read knit index', count, total)
1024
 
                    # See self._parse_parents
1025
 
                    parents = []
1026
 
                    for value in rec[4:-1]:
1027
 
                        if '.' == value[0]:
1028
 
                            # uncompressed reference
1029
 
                            parents.append(value[1:])
1030
 
                        else:
1031
 
                            # this is 15/4000ms faster than isinstance,
1032
 
                            # (in lsprof)
1033
 
                            # this function is called thousands of times a 
1034
 
                            # second so small variations add up.
1035
 
                            assert value.__class__ is str
1036
 
                            parents.append(self._history[int(value)])
1037
 
                    # end self._parse_parents
1038
 
                    # self._cache_version(rec[0], 
1039
 
                    #                     rec[1].split(','),
1040
 
                    #                     int(rec[2]),
1041
 
                    #                     int(rec[3]),
1042
 
                    #                     parents)
1043
 
                    # --- self._cache_version
1044
 
                    # only want the _history index to reference the 1st 
1045
 
                    # index entry for version_id
1046
 
                    version_id = rec[0]
1047
 
                    if version_id not in self._cache:
1048
 
                        index = len(self._history)
1049
 
                        self._history.append(version_id)
1050
 
                    else:
1051
 
                        index = self._cache[version_id][5]
1052
 
                    self._cache[version_id] = (version_id,
1053
 
                                               rec[1].split(','),
1054
 
                                               int(rec[2]),
1055
 
                                               int(rec[3]),
1056
 
                                               parents,
1057
 
                                               index)
1058
 
                    # --- self._cache_version 
1059
 
            except NoSuchFile, e:
1060
 
                if mode != 'w' or not create:
1061
 
                    raise
1062
 
                self.write_header()
1063
 
        finally:
1064
 
            pb.update('read knit index', total, total)
1065
 
            pb.finished()
1066
 
 
1067
 
    def _parse_parents(self, compressed_parents):
1068
 
        """convert a list of string parent values into version ids.
1069
 
 
1070
 
        ints are looked up in the index.
1071
 
        .FOO values are ghosts and converted in to FOO.
1072
 
 
1073
 
        NOTE: the function is retained here for clarity, and for possible
1074
 
              use in partial index reads. However bulk processing now has
1075
 
              it inlined in __init__ for inner-loop optimisation.
 
1864
            return self._kndx_cache[prefix][0][suffix][1]
 
1865
        except KeyError:
 
1866
            raise RevisionNotPresent(key, self)
 
1867
 
 
1868
    def get_parent_map(self, keys):
 
1869
        """Get a map of the parents of keys.
 
1870
 
 
1871
        :param keys: The keys to look up parents for.
 
1872
        :return: A mapping from keys to parents. Absent keys are absent from
 
1873
            the mapping.
1076
1874
        """
1077
 
        result = []
1078
 
        for value in compressed_parents:
1079
 
            if value[-1] == '.':
1080
 
                # uncompressed reference
1081
 
                result.append(value[1:])
1082
 
            else:
1083
 
                # this is 15/4000ms faster than isinstance,
1084
 
                # this function is called thousands of times a 
1085
 
                # second so small variations add up.
1086
 
                assert value.__class__ is str
1087
 
                result.append(self._history[int(value)])
1088
 
        return result
1089
 
 
1090
 
    def get_graph(self):
1091
 
        graph = []
1092
 
        for version_id, index in self._cache.iteritems():
1093
 
            graph.append((version_id, index[4]))
1094
 
        return graph
1095
 
 
1096
 
    def get_ancestry(self, versions):
1097
 
        """See VersionedFile.get_ancestry."""
1098
 
        # get a graph of all the mentioned versions:
1099
 
        graph = {}
1100
 
        pending = set(versions)
1101
 
        while len(pending):
1102
 
            version = pending.pop()
1103
 
            parents = self._cache[version][4]
1104
 
            # got the parents ok
1105
 
            # trim ghosts
1106
 
            parents = [parent for parent in parents if parent in self._cache]
1107
 
            for parent in parents:
1108
 
                # if not completed and not a ghost
1109
 
                if parent not in graph:
1110
 
                    pending.add(parent)
1111
 
            graph[version] = parents
1112
 
        return topo_sort(graph.items())
1113
 
 
1114
 
    def get_ancestry_with_ghosts(self, versions):
1115
 
        """See VersionedFile.get_ancestry_with_ghosts."""
1116
 
        # get a graph of all the mentioned versions:
1117
 
        graph = {}
1118
 
        pending = set(versions)
1119
 
        while len(pending):
1120
 
            version = pending.pop()
 
1875
        # Parse what we need to up front, this potentially trades off I/O
 
1876
        # locality (.kndx and .knit in the same block group for the same file
 
1877
        # id) for less checking in inner loops.
 
1878
        prefixes = set(key[:-1] for key in keys)
 
1879
        self._load_prefixes(prefixes)
 
1880
        result = {}
 
1881
        for key in keys:
 
1882
            prefix = key[:-1]
1121
1883
            try:
1122
 
                parents = self._cache[version][4]
 
1884
                suffix_parents = self._kndx_cache[prefix][0][key[-1]][4]
1123
1885
            except KeyError:
1124
 
                # ghost, fake it
1125
 
                graph[version] = []
1126
1886
                pass
1127
1887
            else:
1128
 
                # got the parents ok
1129
 
                for parent in parents:
1130
 
                    if parent not in graph:
1131
 
                        pending.add(parent)
1132
 
                graph[version] = parents
1133
 
        return topo_sort(graph.items())
1134
 
 
1135
 
    def num_versions(self):
1136
 
        return len(self._history)
1137
 
 
1138
 
    __len__ = num_versions
1139
 
 
1140
 
    def get_versions(self):
1141
 
        return self._history
1142
 
 
1143
 
    def idx_to_name(self, idx):
1144
 
        return self._history[idx]
1145
 
 
1146
 
    def lookup(self, version_id):
1147
 
        assert version_id in self._cache
1148
 
        return self._cache[version_id][5]
1149
 
 
1150
 
    def _version_list_to_index(self, versions):
 
1888
                result[key] = tuple(prefix + (suffix,) for
 
1889
                    suffix in suffix_parents)
 
1890
        return result
 
1891
 
 
1892
    def get_position(self, key):
 
1893
        """Return details needed to access the version.
 
1894
        
 
1895
        :return: a tuple (key, data position, size) to hand to the access
 
1896
            logic to get the record.
 
1897
        """
 
1898
        prefix, suffix = self._split_key(key)
 
1899
        self._load_prefixes([prefix])
 
1900
        entry = self._kndx_cache[prefix][0][suffix]
 
1901
        return key, entry[2], entry[3]
 
1902
 
 
1903
    def _init_index(self, path, extra_lines=[]):
 
1904
        """Initialize an index."""
 
1905
        sio = StringIO()
 
1906
        sio.write(self.HEADER)
 
1907
        sio.writelines(extra_lines)
 
1908
        sio.seek(0)
 
1909
        self._transport.put_file_non_atomic(path, sio,
 
1910
                            create_parent_dir=True)
 
1911
                           # self._create_parent_dir)
 
1912
                           # mode=self._file_mode,
 
1913
                           # dir_mode=self._dir_mode)
 
1914
 
 
1915
    def keys(self):
 
1916
        """Get all the keys in the collection.
 
1917
        
 
1918
        The keys are not ordered.
 
1919
        """
 
1920
        result = set()
 
1921
        # Identify all key prefixes.
 
1922
        # XXX: A bit hacky, needs polish.
 
1923
        if type(self._mapper) == ConstantMapper:
 
1924
            prefixes = [()]
 
1925
        else:
 
1926
            relpaths = set()
 
1927
            for quoted_relpath in self._transport.iter_files_recursive():
 
1928
                path, ext = os.path.splitext(quoted_relpath)
 
1929
                relpaths.add(path)
 
1930
            prefixes = [self._mapper.unmap(path) for path in relpaths]
 
1931
        self._load_prefixes(prefixes)
 
1932
        for prefix in prefixes:
 
1933
            for suffix in self._kndx_cache[prefix][1]:
 
1934
                result.add(prefix + (suffix,))
 
1935
        return result
 
1936
    
 
1937
    def _load_prefixes(self, prefixes):
 
1938
        """Load the indices for prefixes."""
 
1939
        self._check_read()
 
1940
        for prefix in prefixes:
 
1941
            if prefix not in self._kndx_cache:
 
1942
                # the load_data interface writes to these variables.
 
1943
                self._cache = {}
 
1944
                self._history = []
 
1945
                self._filename = prefix
 
1946
                try:
 
1947
                    path = self._mapper.map(prefix) + '.kndx'
 
1948
                    fp = self._transport.get(path)
 
1949
                    try:
 
1950
                        # _load_data may raise NoSuchFile if the target knit is
 
1951
                        # completely empty.
 
1952
                        _load_data(self, fp)
 
1953
                    finally:
 
1954
                        fp.close()
 
1955
                    self._kndx_cache[prefix] = (self._cache, self._history)
 
1956
                    del self._cache
 
1957
                    del self._filename
 
1958
                    del self._history
 
1959
                except NoSuchFile:
 
1960
                    self._kndx_cache[prefix] = ({}, [])
 
1961
                    if type(self._mapper) == ConstantMapper:
 
1962
                        # preserve behaviour for revisions.kndx etc.
 
1963
                        self._init_index(path)
 
1964
                    del self._cache
 
1965
                    del self._filename
 
1966
                    del self._history
 
1967
 
 
1968
    def _partition_keys(self, keys):
 
1969
        """Turn keys into a dict of prefix:suffix_list."""
 
1970
        result = {}
 
1971
        for key in keys:
 
1972
            prefix_keys = result.setdefault(key[:-1], [])
 
1973
            prefix_keys.append(key[-1])
 
1974
        return result
 
1975
 
 
1976
    def _dictionary_compress(self, keys):
 
1977
        """Dictionary compress keys.
 
1978
        
 
1979
        :param keys: The keys to generate references to.
 
1980
        :return: A string representation of keys. keys which are present are
 
1981
            dictionary compressed, and others are emitted as fulltext with a
 
1982
            '.' prefix.
 
1983
        """
 
1984
        if not keys:
 
1985
            return ''
1151
1986
        result_list = []
1152
 
        for version in versions:
1153
 
            if version in self._cache:
 
1987
        prefix = keys[0][:-1]
 
1988
        cache = self._kndx_cache[prefix][0]
 
1989
        for key in keys:
 
1990
            if key[:-1] != prefix:
 
1991
                # kndx indices cannot refer across partitioned storage.
 
1992
                raise ValueError("mismatched prefixes for %r" % keys)
 
1993
            if key[-1] in cache:
1154
1994
                # -- inlined lookup() --
1155
 
                result_list.append(str(self._cache[version][5]))
 
1995
                result_list.append(str(cache[key[-1]][5]))
1156
1996
                # -- end lookup () --
1157
1997
            else:
1158
 
                result_list.append('.' + version.encode('utf-8'))
 
1998
                result_list.append('.' + key[-1])
1159
1999
        return ' '.join(result_list)
1160
2000
 
1161
 
    def add_version(self, version_id, options, pos, size, parents):
1162
 
        """Add a version record to the index."""
1163
 
        self.add_versions(((version_id, options, pos, size, parents),))
1164
 
 
1165
 
    def add_versions(self, versions):
1166
 
        """Add multiple versions to the index.
1167
 
        
1168
 
        :param versions: a list of tuples:
1169
 
                         (version_id, options, pos, size, parents).
1170
 
        """
1171
 
        lines = []
1172
 
        for version_id, options, pos, size, parents in versions:
1173
 
            line = "\n%s %s %s %s %s :" % (version_id.encode('utf-8'),
1174
 
                                           ','.join(options),
1175
 
                                           pos,
1176
 
                                           size,
1177
 
                                           self._version_list_to_index(parents))
1178
 
            assert isinstance(line, str), \
1179
 
                'content must be utf-8 encoded: %r' % (line,)
1180
 
            lines.append(line)
1181
 
        self._transport.append(self._filename, StringIO(''.join(lines)))
1182
 
        # cache after writing, so that a failed write leads to missing cache
1183
 
        # entries not extra ones. XXX TODO: RBC 20060502 in the event of a 
1184
 
        # failure, reload the index or flush it or some such, to prevent
1185
 
        # writing records that did complete twice.
1186
 
        for version_id, options, pos, size, parents in versions:
1187
 
            self._cache_version(version_id, options, pos, size, parents)
1188
 
        
1189
 
    def has_version(self, version_id):
1190
 
        """True if the version is in the index."""
1191
 
        return self._cache.has_key(version_id)
1192
 
 
1193
 
    def get_position(self, version_id):
1194
 
        """Return data position and size of specified version."""
1195
 
        return (self._cache[version_id][2], \
1196
 
                self._cache[version_id][3])
1197
 
 
1198
 
    def get_method(self, version_id):
1199
 
        """Return compression method of specified version."""
1200
 
        options = self._cache[version_id][1]
1201
 
        if 'fulltext' in options:
 
2001
    def _reset_cache(self):
 
2002
        # Possibly this should be a LRU cache. A dictionary from key_prefix to
 
2003
        # (cache_dict, history_vector) for parsed kndx files.
 
2004
        self._kndx_cache = {}
 
2005
        self._scope = self._get_scope()
 
2006
        allow_writes = self._allow_writes()
 
2007
        if allow_writes:
 
2008
            self._mode = 'w'
 
2009
        else:
 
2010
            self._mode = 'r'
 
2011
 
 
2012
    def _split_key(self, key):
 
2013
        """Split key into a prefix and suffix."""
 
2014
        return key[:-1], key[-1]
 
2015
 
 
2016
 
 
2017
class _KnitGraphIndex(object):
 
2018
    """A KnitVersionedFiles index layered on GraphIndex."""
 
2019
 
 
2020
    def __init__(self, graph_index, is_locked, deltas=False, parents=True,
 
2021
        add_callback=None):
 
2022
        """Construct a KnitGraphIndex on a graph_index.
 
2023
 
 
2024
        :param graph_index: An implementation of bzrlib.index.GraphIndex.
 
2025
        :param is_locked: A callback to check whether the object should answer
 
2026
            queries.
 
2027
        :param deltas: Allow delta-compressed records.
 
2028
        :param parents: If True, record knits parents, if not do not record 
 
2029
            parents.
 
2030
        :param add_callback: If not None, allow additions to the index and call
 
2031
            this callback with a list of added GraphIndex nodes:
 
2032
            [(node, value, node_refs), ...]
 
2033
        :param is_locked: A callback, returns True if the index is locked and
 
2034
            thus usable.
 
2035
        """
 
2036
        self._add_callback = add_callback
 
2037
        self._graph_index = graph_index
 
2038
        self._deltas = deltas
 
2039
        self._parents = parents
 
2040
        if deltas and not parents:
 
2041
            # XXX: TODO: Delta tree and parent graph should be conceptually
 
2042
            # separate.
 
2043
            raise KnitCorrupt(self, "Cannot do delta compression without "
 
2044
                "parent tracking.")
 
2045
        self.has_graph = parents
 
2046
        self._is_locked = is_locked
 
2047
 
 
2048
    def __repr__(self):
 
2049
        return "%s(%r)" % (self.__class__.__name__, self._graph_index)
 
2050
 
 
2051
    def add_records(self, records, random_id=False):
 
2052
        """Add multiple records to the index.
 
2053
        
 
2054
        This function does not insert data into the Immutable GraphIndex
 
2055
        backing the KnitGraphIndex, instead it prepares data for insertion by
 
2056
        the caller and checks that it is safe to insert then calls
 
2057
        self._add_callback with the prepared GraphIndex nodes.
 
2058
 
 
2059
        :param records: a list of tuples:
 
2060
                         (key, options, access_memo, parents).
 
2061
        :param random_id: If True the ids being added were randomly generated
 
2062
            and no check for existence will be performed.
 
2063
        """
 
2064
        if not self._add_callback:
 
2065
            raise errors.ReadOnlyError(self)
 
2066
        # we hope there are no repositories with inconsistent parentage
 
2067
        # anymore.
 
2068
 
 
2069
        keys = {}
 
2070
        for (key, options, access_memo, parents) in records:
 
2071
            if self._parents:
 
2072
                parents = tuple(parents)
 
2073
            index, pos, size = access_memo
 
2074
            if 'no-eol' in options:
 
2075
                value = 'N'
 
2076
            else:
 
2077
                value = ' '
 
2078
            value += "%d %d" % (pos, size)
 
2079
            if not self._deltas:
 
2080
                if 'line-delta' in options:
 
2081
                    raise KnitCorrupt(self, "attempt to add line-delta in non-delta knit")
 
2082
            if self._parents:
 
2083
                if self._deltas:
 
2084
                    if 'line-delta' in options:
 
2085
                        node_refs = (parents, (parents[0],))
 
2086
                    else:
 
2087
                        node_refs = (parents, ())
 
2088
                else:
 
2089
                    node_refs = (parents, )
 
2090
            else:
 
2091
                if parents:
 
2092
                    raise KnitCorrupt(self, "attempt to add node with parents "
 
2093
                        "in parentless index.")
 
2094
                node_refs = ()
 
2095
            keys[key] = (value, node_refs)
 
2096
        # check for dups
 
2097
        if not random_id:
 
2098
            present_nodes = self._get_entries(keys)
 
2099
            for (index, key, value, node_refs) in present_nodes:
 
2100
                if (value[0] != keys[key][0][0] or
 
2101
                    node_refs != keys[key][1]):
 
2102
                    raise KnitCorrupt(self, "inconsistent details in add_records"
 
2103
                        ": %s %s" % ((value, node_refs), keys[key]))
 
2104
                del keys[key]
 
2105
        result = []
 
2106
        if self._parents:
 
2107
            for key, (value, node_refs) in keys.iteritems():
 
2108
                result.append((key, value, node_refs))
 
2109
        else:
 
2110
            for key, (value, node_refs) in keys.iteritems():
 
2111
                result.append((key, value))
 
2112
        self._add_callback(result)
 
2113
        
 
2114
    def _check_read(self):
 
2115
        """raise if reads are not permitted."""
 
2116
        if not self._is_locked():
 
2117
            raise errors.ObjectNotLocked(self)
 
2118
 
 
2119
    def _check_write_ok(self):
 
2120
        """Assert if writes are not permitted."""
 
2121
        if not self._is_locked():
 
2122
            raise errors.ObjectNotLocked(self)
 
2123
 
 
2124
    def _compression_parent(self, an_entry):
 
2125
        # return the key that an_entry is compressed against, or None
 
2126
        # Grab the second parent list (as deltas implies parents currently)
 
2127
        compression_parents = an_entry[3][1]
 
2128
        if not compression_parents:
 
2129
            return None
 
2130
        if len(compression_parents) != 1:
 
2131
            raise AssertionError(
 
2132
                "Too many compression parents: %r" % compression_parents)
 
2133
        return compression_parents[0]
 
2134
 
 
2135
    def get_build_details(self, keys):
 
2136
        """Get the method, index_memo and compression parent for version_ids.
 
2137
 
 
2138
        Ghosts are omitted from the result.
 
2139
 
 
2140
        :param keys: An iterable of keys.
 
2141
        :return: A dict of key:
 
2142
            (index_memo, compression_parent, parents, record_details).
 
2143
            index_memo
 
2144
                opaque structure to pass to read_records to extract the raw
 
2145
                data
 
2146
            compression_parent
 
2147
                Content that this record is built upon, may be None
 
2148
            parents
 
2149
                Logical parents of this node
 
2150
            record_details
 
2151
                extra information about the content which needs to be passed to
 
2152
                Factory.parse_record
 
2153
        """
 
2154
        self._check_read()
 
2155
        result = {}
 
2156
        entries = self._get_entries(keys, False)
 
2157
        for entry in entries:
 
2158
            key = entry[1]
 
2159
            if not self._parents:
 
2160
                parents = ()
 
2161
            else:
 
2162
                parents = entry[3][0]
 
2163
            if not self._deltas:
 
2164
                compression_parent_key = None
 
2165
            else:
 
2166
                compression_parent_key = self._compression_parent(entry)
 
2167
            noeol = (entry[2][0] == 'N')
 
2168
            if compression_parent_key:
 
2169
                method = 'line-delta'
 
2170
            else:
 
2171
                method = 'fulltext'
 
2172
            result[key] = (self._node_to_position(entry),
 
2173
                                  compression_parent_key, parents,
 
2174
                                  (method, noeol))
 
2175
        return result
 
2176
 
 
2177
    def _get_entries(self, keys, check_present=False):
 
2178
        """Get the entries for keys.
 
2179
        
 
2180
        :param keys: An iterable of index key tuples.
 
2181
        """
 
2182
        keys = set(keys)
 
2183
        found_keys = set()
 
2184
        if self._parents:
 
2185
            for node in self._graph_index.iter_entries(keys):
 
2186
                yield node
 
2187
                found_keys.add(node[1])
 
2188
        else:
 
2189
            # adapt parentless index to the rest of the code.
 
2190
            for node in self._graph_index.iter_entries(keys):
 
2191
                yield node[0], node[1], node[2], ()
 
2192
                found_keys.add(node[1])
 
2193
        if check_present:
 
2194
            missing_keys = keys.difference(found_keys)
 
2195
            if missing_keys:
 
2196
                raise RevisionNotPresent(missing_keys.pop(), self)
 
2197
 
 
2198
    def get_method(self, key):
 
2199
        """Return compression method of specified key."""
 
2200
        return self._get_method(self._get_node(key))
 
2201
 
 
2202
    def _get_method(self, node):
 
2203
        if not self._deltas:
1202
2204
            return 'fulltext'
1203
 
        else:
1204
 
            assert 'line-delta' in options
 
2205
        if self._compression_parent(node):
1205
2206
            return 'line-delta'
1206
 
 
1207
 
    def get_options(self, version_id):
1208
 
        return self._cache[version_id][1]
1209
 
 
1210
 
    def get_parents(self, version_id):
1211
 
        """Return parents of specified version ignoring ghosts."""
1212
 
        return [parent for parent in self._cache[version_id][4] 
1213
 
                if parent in self._cache]
1214
 
 
1215
 
    def get_parents_with_ghosts(self, version_id):
1216
 
        """Return parents of specified version with ghosts."""
1217
 
        return self._cache[version_id][4] 
1218
 
 
1219
 
    def check_versions_present(self, version_ids):
1220
 
        """Check that all specified versions are present."""
1221
 
        version_ids = set(version_ids)
1222
 
        for version_id in list(version_ids):
1223
 
            if version_id in self._cache:
1224
 
                version_ids.remove(version_id)
1225
 
        if version_ids:
1226
 
            raise RevisionNotPresent(list(version_ids)[0], self.filename)
1227
 
 
1228
 
 
1229
 
class _KnitData(_KnitComponentFile):
1230
 
    """Contents of the knit data file"""
1231
 
 
1232
 
    HEADER = "# bzr knit data 8\n"
1233
 
 
1234
 
    def __init__(self, transport, filename, mode, create=False, file_mode=None):
1235
 
        _KnitComponentFile.__init__(self, transport, filename, mode)
1236
 
        self._file = None
1237
 
        self._checked = False
1238
 
        if create:
1239
 
            self._transport.put(self._filename, StringIO(''), mode=file_mode)
1240
 
        self._records = {}
1241
 
 
1242
 
    def clear_cache(self):
1243
 
        """Clear the record cache."""
1244
 
        self._records = {}
1245
 
 
1246
 
    def _open_file(self):
1247
 
        if self._file is None:
 
2207
        else:
 
2208
            return 'fulltext'
 
2209
 
 
2210
    def _get_node(self, key):
 
2211
        try:
 
2212
            return list(self._get_entries([key]))[0]
 
2213
        except IndexError:
 
2214
            raise RevisionNotPresent(key, self)
 
2215
 
 
2216
    def get_options(self, key):
 
2217
        """Return a list representing options.
 
2218
 
 
2219
        e.g. ['foo', 'bar']
 
2220
        """
 
2221
        node = self._get_node(key)
 
2222
        options = [self._get_method(node)]
 
2223
        if node[2][0] == 'N':
 
2224
            options.append('no-eol')
 
2225
        return options
 
2226
 
 
2227
    def get_parent_map(self, keys):
 
2228
        """Get a map of the parents of keys.
 
2229
 
 
2230
        :param keys: The keys to look up parents for.
 
2231
        :return: A mapping from keys to parents. Absent keys are absent from
 
2232
            the mapping.
 
2233
        """
 
2234
        self._check_read()
 
2235
        nodes = self._get_entries(keys)
 
2236
        result = {}
 
2237
        if self._parents:
 
2238
            for node in nodes:
 
2239
                result[node[1]] = node[3][0]
 
2240
        else:
 
2241
            for node in nodes:
 
2242
                result[node[1]] = None
 
2243
        return result
 
2244
 
 
2245
    def get_position(self, key):
 
2246
        """Return details needed to access the version.
 
2247
        
 
2248
        :return: a tuple (index, data position, size) to hand to the access
 
2249
            logic to get the record.
 
2250
        """
 
2251
        node = self._get_node(key)
 
2252
        return self._node_to_position(node)
 
2253
 
 
2254
    def keys(self):
 
2255
        """Get all the keys in the collection.
 
2256
        
 
2257
        The keys are not ordered.
 
2258
        """
 
2259
        self._check_read()
 
2260
        return [node[1] for node in self._graph_index.iter_all_entries()]
 
2261
    
 
2262
    def _node_to_position(self, node):
 
2263
        """Convert an index value to position details."""
 
2264
        bits = node[2][1:].split(' ')
 
2265
        return node[0], int(bits[0]), int(bits[1])
 
2266
 
 
2267
 
 
2268
class _KnitKeyAccess(object):
 
2269
    """Access to records in .knit files."""
 
2270
 
 
2271
    def __init__(self, transport, mapper):
 
2272
        """Create a _KnitKeyAccess with transport and mapper.
 
2273
 
 
2274
        :param transport: The transport the access object is rooted at.
 
2275
        :param mapper: The mapper used to map keys to .knit files.
 
2276
        """
 
2277
        self._transport = transport
 
2278
        self._mapper = mapper
 
2279
 
 
2280
    def add_raw_records(self, key_sizes, raw_data):
 
2281
        """Add raw knit bytes to a storage area.
 
2282
 
 
2283
        The data is spooled to the container writer in one bytes-record per
 
2284
        raw data item.
 
2285
 
 
2286
        :param sizes: An iterable of tuples containing the key and size of each
 
2287
            raw data segment.
 
2288
        :param raw_data: A bytestring containing the data.
 
2289
        :return: A list of memos to retrieve the record later. Each memo is an
 
2290
            opaque index memo. For _KnitKeyAccess the memo is (key, pos,
 
2291
            length), where the key is the record key.
 
2292
        """
 
2293
        if type(raw_data) != str:
 
2294
            raise AssertionError(
 
2295
                'data must be plain bytes was %s' % type(raw_data))
 
2296
        result = []
 
2297
        offset = 0
 
2298
        # TODO: This can be tuned for writing to sftp and other servers where
 
2299
        # append() is relatively expensive by grouping the writes to each key
 
2300
        # prefix.
 
2301
        for key, size in key_sizes:
 
2302
            path = self._mapper.map(key)
1248
2303
            try:
1249
 
                self._file = self._transport.get(self._filename)
1250
 
            except NoSuchFile:
1251
 
                pass
1252
 
        return self._file
1253
 
 
1254
 
    def _record_to_data(self, version_id, digest, lines):
1255
 
        """Convert version_id, digest, lines into a raw data block.
1256
 
        
1257
 
        :return: (len, a StringIO instance with the raw data ready to read.)
1258
 
        """
1259
 
        sio = StringIO()
1260
 
        data_file = GzipFile(None, mode='wb', fileobj=sio)
1261
 
        data_file.writelines(chain(
1262
 
            ["version %s %d %s\n" % (version_id.encode('utf-8'), 
1263
 
                                     len(lines),
1264
 
                                     digest)],
1265
 
            lines,
1266
 
            ["end %s\n" % version_id.encode('utf-8')]))
1267
 
        data_file.close()
1268
 
        length= sio.tell()
1269
 
 
1270
 
        sio.seek(0)
1271
 
        return length, sio
1272
 
 
1273
 
    def add_raw_record(self, raw_data):
1274
 
        """Append a prepared record to the data file.
1275
 
        
1276
 
        :return: the offset in the data file raw_data was written.
1277
 
        """
1278
 
        assert isinstance(raw_data, str), 'data must be plain bytes'
1279
 
        return self._transport.append(self._filename, StringIO(raw_data))
1280
 
        
1281
 
    def add_record(self, version_id, digest, lines):
1282
 
        """Write new text record to disk.  Returns the position in the
1283
 
        file where it was written."""
1284
 
        size, sio = self._record_to_data(version_id, digest, lines)
1285
 
        # cache
1286
 
        self._records[version_id] = (digest, lines)
1287
 
        # write to disk
1288
 
        start_pos = self._transport.append(self._filename, sio)
1289
 
        return start_pos, size
1290
 
 
1291
 
    def _parse_record_header(self, version_id, raw_data):
1292
 
        """Parse a record header for consistency.
1293
 
 
1294
 
        :return: the header and the decompressor stream.
1295
 
                 as (stream, header_record)
1296
 
        """
1297
 
        df = GzipFile(mode='rb', fileobj=StringIO(raw_data))
1298
 
        rec = df.readline().split()
1299
 
        if len(rec) != 4:
1300
 
            raise KnitCorrupt(self._filename, 'unexpected number of elements in record header')
1301
 
        if rec[1].decode('utf-8')!= version_id:
1302
 
            raise KnitCorrupt(self._filename, 
1303
 
                              'unexpected version, wanted %r, got %r' % (
1304
 
                                version_id, rec[1]))
1305
 
        return df, rec
1306
 
 
1307
 
    def _parse_record(self, version_id, data):
1308
 
        # profiling notes:
1309
 
        # 4168 calls in 2880 217 internal
1310
 
        # 4168 calls to _parse_record_header in 2121
1311
 
        # 4168 calls to readlines in 330
1312
 
        df, rec = self._parse_record_header(version_id, data)
1313
 
        record_contents = df.readlines()
1314
 
        l = record_contents.pop()
1315
 
        assert len(record_contents) == int(rec[2])
1316
 
        if l.decode('utf-8') != 'end %s\n' % version_id:
1317
 
            raise KnitCorrupt(self._filename, 'unexpected version end line %r, wanted %r' 
1318
 
                        % (l, version_id))
1319
 
        df.close()
1320
 
        return record_contents, rec[3]
1321
 
 
1322
 
    def read_records_iter_raw(self, records):
1323
 
        """Read text records from data file and yield raw data.
1324
 
 
1325
 
        This unpacks enough of the text record to validate the id is
1326
 
        as expected but thats all.
1327
 
 
1328
 
        It will actively recompress currently cached records on the
1329
 
        basis that that is cheaper than I/O activity.
1330
 
        """
1331
 
        needed_records = []
1332
 
        for version_id, pos, size in records:
1333
 
            if version_id not in self._records:
1334
 
                needed_records.append((version_id, pos, size))
1335
 
 
1336
 
        # setup an iterator of the external records:
1337
 
        # uses readv so nice and fast we hope.
1338
 
        if len(needed_records):
1339
 
            # grab the disk data needed.
1340
 
            raw_records = self._transport.readv(self._filename,
1341
 
                [(pos, size) for version_id, pos, size in needed_records])
1342
 
 
1343
 
        for version_id, pos, size in records:
1344
 
            if version_id in self._records:
1345
 
                # compress a new version
1346
 
                size, sio = self._record_to_data(version_id,
1347
 
                                                 self._records[version_id][0],
1348
 
                                                 self._records[version_id][1])
1349
 
                yield version_id, sio.getvalue()
1350
 
            else:
1351
 
                pos, data = raw_records.next()
1352
 
                # validate the header
1353
 
                df, rec = self._parse_record_header(version_id, data)
1354
 
                df.close()
1355
 
                yield version_id, data
1356
 
 
1357
 
 
1358
 
    def read_records_iter(self, records):
1359
 
        """Read text records from data file and yield result.
1360
 
 
1361
 
        Each passed record is a tuple of (version_id, pos, len) and
1362
 
        will be read in the given order.  Yields (version_id,
1363
 
        contents, digest).
1364
 
        """
1365
 
        # profiling notes:
1366
 
        # 60890  calls for 4168 extractions in 5045, 683 internal.
1367
 
        # 4168   calls to readv              in 1411
1368
 
        # 4168   calls to parse_record       in 2880
1369
 
 
1370
 
        needed_records = []
1371
 
        for version_id, pos, size in records:
1372
 
            if version_id not in self._records:
1373
 
                needed_records.append((version_id, pos, size))
1374
 
 
1375
 
        if len(needed_records):
1376
 
            # We take it that the transport optimizes the fetching as good
1377
 
            # as possible (ie, reads continuous ranges.)
1378
 
            response = self._transport.readv(self._filename,
1379
 
                [(pos, size) for version_id, pos, size in needed_records])
1380
 
 
1381
 
            for (record_id, pos, size), (pos, data) in izip(iter(needed_records), response):
1382
 
                content, digest = self._parse_record(record_id, data)
1383
 
                self._records[record_id] = (digest, content)
1384
 
    
1385
 
        for version_id, pos, size in records:
1386
 
            yield version_id, list(self._records[version_id][1]), self._records[version_id][0]
1387
 
 
1388
 
    def read_records(self, records):
1389
 
        """Read records into a dictionary."""
1390
 
        components = {}
1391
 
        for record_id, content, digest in self.read_records_iter(records):
1392
 
            components[record_id] = (content, digest)
1393
 
        return components
1394
 
 
1395
 
 
1396
 
class InterKnit(InterVersionedFile):
1397
 
    """Optimised code paths for knit to knit operations."""
1398
 
    
1399
 
    _matching_file_from_factory = KnitVersionedFile
1400
 
    _matching_file_to_factory = KnitVersionedFile
1401
 
    
1402
 
    @staticmethod
1403
 
    def is_compatible(source, target):
1404
 
        """Be compatible with knits.  """
1405
 
        try:
1406
 
            return (isinstance(source, KnitVersionedFile) and
1407
 
                    isinstance(target, KnitVersionedFile))
1408
 
        except AttributeError:
1409
 
            return False
1410
 
 
1411
 
    def join(self, pb=None, msg=None, version_ids=None, ignore_missing=False):
1412
 
        """See InterVersionedFile.join."""
1413
 
        assert isinstance(self.source, KnitVersionedFile)
1414
 
        assert isinstance(self.target, KnitVersionedFile)
1415
 
 
1416
 
        version_ids = self._get_source_version_ids(version_ids, ignore_missing)
1417
 
 
1418
 
        if not version_ids:
1419
 
            return 0
1420
 
 
1421
 
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
1422
 
        try:
1423
 
            version_ids = list(version_ids)
1424
 
            if None in version_ids:
1425
 
                version_ids.remove(None)
1426
 
    
1427
 
            self.source_ancestry = set(self.source.get_ancestry(version_ids))
1428
 
            this_versions = set(self.target._index.get_versions())
1429
 
            needed_versions = self.source_ancestry - this_versions
1430
 
            cross_check_versions = self.source_ancestry.intersection(this_versions)
1431
 
            mismatched_versions = set()
1432
 
            for version in cross_check_versions:
1433
 
                # scan to include needed parents.
1434
 
                n1 = set(self.target.get_parents_with_ghosts(version))
1435
 
                n2 = set(self.source.get_parents_with_ghosts(version))
1436
 
                if n1 != n2:
1437
 
                    # FIXME TEST this check for cycles being introduced works
1438
 
                    # the logic is we have a cycle if in our graph we are an
1439
 
                    # ancestor of any of the n2 revisions.
1440
 
                    for parent in n2:
1441
 
                        if parent in n1:
1442
 
                            # safe
1443
 
                            continue
1444
 
                        else:
1445
 
                            parent_ancestors = self.source.get_ancestry(parent)
1446
 
                            if version in parent_ancestors:
1447
 
                                raise errors.GraphCycleError([parent, version])
1448
 
                    # ensure this parent will be available later.
1449
 
                    new_parents = n2.difference(n1)
1450
 
                    needed_versions.update(new_parents.difference(this_versions))
1451
 
                    mismatched_versions.add(version)
1452
 
    
1453
 
            if not needed_versions and not mismatched_versions:
1454
 
                return 0
1455
 
            full_list = topo_sort(self.source.get_graph())
1456
 
    
1457
 
            version_list = [i for i in full_list if (not self.target.has_version(i)
1458
 
                            and i in needed_versions)]
1459
 
    
1460
 
            # plan the join:
1461
 
            copy_queue = []
1462
 
            copy_queue_records = []
1463
 
            copy_set = set()
1464
 
            for version_id in version_list:
1465
 
                options = self.source._index.get_options(version_id)
1466
 
                parents = self.source._index.get_parents_with_ghosts(version_id)
1467
 
                # check that its will be a consistent copy:
1468
 
                for parent in parents:
1469
 
                    # if source has the parent, we must :
1470
 
                    # * already have it or
1471
 
                    # * have it scheduled already
1472
 
                    # otherwise we don't care
1473
 
                    assert (self.target.has_version(parent) or
1474
 
                            parent in copy_set or
1475
 
                            not self.source.has_version(parent))
1476
 
                data_pos, data_size = self.source._index.get_position(version_id)
1477
 
                copy_queue_records.append((version_id, data_pos, data_size))
1478
 
                copy_queue.append((version_id, options, parents))
1479
 
                copy_set.add(version_id)
1480
 
 
1481
 
            # data suck the join:
1482
 
            count = 0
1483
 
            total = len(version_list)
1484
 
            raw_datum = []
1485
 
            raw_records = []
1486
 
            for (version_id, raw_data), \
1487
 
                (version_id2, options, parents) in \
1488
 
                izip(self.source._data.read_records_iter_raw(copy_queue_records),
1489
 
                     copy_queue):
1490
 
                assert version_id == version_id2, 'logic error, inconsistent results'
1491
 
                count = count + 1
1492
 
                pb.update("Joining knit", count, total)
1493
 
                raw_records.append((version_id, options, parents, len(raw_data)))
1494
 
                raw_datum.append(raw_data)
1495
 
            self.target._add_raw_records(raw_records, ''.join(raw_datum))
1496
 
 
1497
 
            for version in mismatched_versions:
1498
 
                # FIXME RBC 20060309 is this needed?
1499
 
                n1 = set(self.target.get_parents_with_ghosts(version))
1500
 
                n2 = set(self.source.get_parents_with_ghosts(version))
1501
 
                # write a combined record to our history preserving the current 
1502
 
                # parents as first in the list
1503
 
                new_parents = self.target.get_parents_with_ghosts(version) + list(n2.difference(n1))
1504
 
                self.target.fix_parents(version, new_parents)
1505
 
            return count
1506
 
        finally:
1507
 
            pb.finished()
1508
 
 
1509
 
 
1510
 
InterVersionedFile.register_optimiser(InterKnit)
1511
 
 
1512
 
 
1513
 
class WeaveToKnit(InterVersionedFile):
1514
 
    """Optimised code paths for weave to knit operations."""
1515
 
    
1516
 
    _matching_file_from_factory = bzrlib.weave.WeaveFile
1517
 
    _matching_file_to_factory = KnitVersionedFile
1518
 
    
1519
 
    @staticmethod
1520
 
    def is_compatible(source, target):
1521
 
        """Be compatible with weaves to knits."""
1522
 
        try:
1523
 
            return (isinstance(source, bzrlib.weave.Weave) and
1524
 
                    isinstance(target, KnitVersionedFile))
1525
 
        except AttributeError:
1526
 
            return False
1527
 
 
1528
 
    def join(self, pb=None, msg=None, version_ids=None, ignore_missing=False):
1529
 
        """See InterVersionedFile.join."""
1530
 
        assert isinstance(self.source, bzrlib.weave.Weave)
1531
 
        assert isinstance(self.target, KnitVersionedFile)
1532
 
 
1533
 
        version_ids = self._get_source_version_ids(version_ids, ignore_missing)
1534
 
 
1535
 
        if not version_ids:
1536
 
            return 0
1537
 
 
1538
 
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
1539
 
        try:
1540
 
            version_ids = list(version_ids)
1541
 
    
1542
 
            self.source_ancestry = set(self.source.get_ancestry(version_ids))
1543
 
            this_versions = set(self.target._index.get_versions())
1544
 
            needed_versions = self.source_ancestry - this_versions
1545
 
            cross_check_versions = self.source_ancestry.intersection(this_versions)
1546
 
            mismatched_versions = set()
1547
 
            for version in cross_check_versions:
1548
 
                # scan to include needed parents.
1549
 
                n1 = set(self.target.get_parents_with_ghosts(version))
1550
 
                n2 = set(self.source.get_parents(version))
1551
 
                # if all of n2's parents are in n1, then its fine.
1552
 
                if n2.difference(n1):
1553
 
                    # FIXME TEST this check for cycles being introduced works
1554
 
                    # the logic is we have a cycle if in our graph we are an
1555
 
                    # ancestor of any of the n2 revisions.
1556
 
                    for parent in n2:
1557
 
                        if parent in n1:
1558
 
                            # safe
1559
 
                            continue
1560
 
                        else:
1561
 
                            parent_ancestors = self.source.get_ancestry(parent)
1562
 
                            if version in parent_ancestors:
1563
 
                                raise errors.GraphCycleError([parent, version])
1564
 
                    # ensure this parent will be available later.
1565
 
                    new_parents = n2.difference(n1)
1566
 
                    needed_versions.update(new_parents.difference(this_versions))
1567
 
                    mismatched_versions.add(version)
1568
 
    
1569
 
            if not needed_versions and not mismatched_versions:
1570
 
                return 0
1571
 
            full_list = topo_sort(self.source.get_graph())
1572
 
    
1573
 
            version_list = [i for i in full_list if (not self.target.has_version(i)
1574
 
                            and i in needed_versions)]
1575
 
    
1576
 
            # do the join:
1577
 
            count = 0
1578
 
            total = len(version_list)
1579
 
            for version_id in version_list:
1580
 
                pb.update("Converting to knit", count, total)
1581
 
                parents = self.source.get_parents(version_id)
1582
 
                # check that its will be a consistent copy:
1583
 
                for parent in parents:
1584
 
                    # if source has the parent, we must already have it
1585
 
                    assert (self.target.has_version(parent))
1586
 
                self.target.add_lines(
1587
 
                    version_id, parents, self.source.get_lines(version_id))
1588
 
                count = count + 1
1589
 
 
1590
 
            for version in mismatched_versions:
1591
 
                # FIXME RBC 20060309 is this needed?
1592
 
                n1 = set(self.target.get_parents_with_ghosts(version))
1593
 
                n2 = set(self.source.get_parents(version))
1594
 
                # write a combined record to our history preserving the current 
1595
 
                # parents as first in the list
1596
 
                new_parents = self.target.get_parents_with_ghosts(version) + list(n2.difference(n1))
1597
 
                self.target.fix_parents(version, new_parents)
1598
 
            return count
1599
 
        finally:
1600
 
            pb.finished()
1601
 
 
1602
 
 
1603
 
InterVersionedFile.register_optimiser(WeaveToKnit)
1604
 
 
1605
 
 
1606
 
class KnitSequenceMatcher(difflib.SequenceMatcher):
1607
 
    """Knit tuned sequence matcher.
1608
 
 
1609
 
    This is based on profiling of difflib which indicated some improvements
1610
 
    for our usage pattern.
 
2304
                base = self._transport.append_bytes(path + '.knit',
 
2305
                    raw_data[offset:offset+size])
 
2306
            except errors.NoSuchFile:
 
2307
                self._transport.mkdir(osutils.dirname(path))
 
2308
                base = self._transport.append_bytes(path + '.knit',
 
2309
                    raw_data[offset:offset+size])
 
2310
            # if base == 0:
 
2311
            # chmod.
 
2312
            offset += size
 
2313
            result.append((key, base, size))
 
2314
        return result
 
2315
 
 
2316
    def get_raw_records(self, memos_for_retrieval):
 
2317
        """Get the raw bytes for a records.
 
2318
 
 
2319
        :param memos_for_retrieval: An iterable containing the access memo for
 
2320
            retrieving the bytes.
 
2321
        :return: An iterator over the bytes of the records.
 
2322
        """
 
2323
        # first pass, group into same-index request to minimise readv's issued.
 
2324
        request_lists = []
 
2325
        current_prefix = None
 
2326
        for (key, offset, length) in memos_for_retrieval:
 
2327
            if current_prefix == key[:-1]:
 
2328
                current_list.append((offset, length))
 
2329
            else:
 
2330
                if current_prefix is not None:
 
2331
                    request_lists.append((current_prefix, current_list))
 
2332
                current_prefix = key[:-1]
 
2333
                current_list = [(offset, length)]
 
2334
        # handle the last entry
 
2335
        if current_prefix is not None:
 
2336
            request_lists.append((current_prefix, current_list))
 
2337
        for prefix, read_vector in request_lists:
 
2338
            path = self._mapper.map(prefix) + '.knit'
 
2339
            for pos, data in self._transport.readv(path, read_vector):
 
2340
                yield data
 
2341
 
 
2342
 
 
2343
class _DirectPackAccess(object):
 
2344
    """Access to data in one or more packs with less translation."""
 
2345
 
 
2346
    def __init__(self, index_to_packs):
 
2347
        """Create a _DirectPackAccess object.
 
2348
 
 
2349
        :param index_to_packs: A dict mapping index objects to the transport
 
2350
            and file names for obtaining data.
 
2351
        """
 
2352
        self._container_writer = None
 
2353
        self._write_index = None
 
2354
        self._indices = index_to_packs
 
2355
 
 
2356
    def add_raw_records(self, key_sizes, raw_data):
 
2357
        """Add raw knit bytes to a storage area.
 
2358
 
 
2359
        The data is spooled to the container writer in one bytes-record per
 
2360
        raw data item.
 
2361
 
 
2362
        :param sizes: An iterable of tuples containing the key and size of each
 
2363
            raw data segment.
 
2364
        :param raw_data: A bytestring containing the data.
 
2365
        :return: A list of memos to retrieve the record later. Each memo is an
 
2366
            opaque index memo. For _DirectPackAccess the memo is (index, pos,
 
2367
            length), where the index field is the write_index object supplied
 
2368
            to the PackAccess object.
 
2369
        """
 
2370
        if type(raw_data) != str:
 
2371
            raise AssertionError(
 
2372
                'data must be plain bytes was %s' % type(raw_data))
 
2373
        result = []
 
2374
        offset = 0
 
2375
        for key, size in key_sizes:
 
2376
            p_offset, p_length = self._container_writer.add_bytes_record(
 
2377
                raw_data[offset:offset+size], [])
 
2378
            offset += size
 
2379
            result.append((self._write_index, p_offset, p_length))
 
2380
        return result
 
2381
 
 
2382
    def get_raw_records(self, memos_for_retrieval):
 
2383
        """Get the raw bytes for a records.
 
2384
 
 
2385
        :param memos_for_retrieval: An iterable containing the (index, pos, 
 
2386
            length) memo for retrieving the bytes. The Pack access method
 
2387
            looks up the pack to use for a given record in its index_to_pack
 
2388
            map.
 
2389
        :return: An iterator over the bytes of the records.
 
2390
        """
 
2391
        # first pass, group into same-index requests
 
2392
        request_lists = []
 
2393
        current_index = None
 
2394
        for (index, offset, length) in memos_for_retrieval:
 
2395
            if current_index == index:
 
2396
                current_list.append((offset, length))
 
2397
            else:
 
2398
                if current_index is not None:
 
2399
                    request_lists.append((current_index, current_list))
 
2400
                current_index = index
 
2401
                current_list = [(offset, length)]
 
2402
        # handle the last entry
 
2403
        if current_index is not None:
 
2404
            request_lists.append((current_index, current_list))
 
2405
        for index, offsets in request_lists:
 
2406
            transport, path = self._indices[index]
 
2407
            reader = pack.make_readv_reader(transport, path, offsets)
 
2408
            for names, read_func in reader.iter_records():
 
2409
                yield read_func(None)
 
2410
 
 
2411
    def set_writer(self, writer, index, transport_packname):
 
2412
        """Set a writer to use for adding data."""
 
2413
        if index is not None:
 
2414
            self._indices[index] = transport_packname
 
2415
        self._container_writer = writer
 
2416
        self._write_index = index
 
2417
 
 
2418
 
 
2419
# Deprecated, use PatienceSequenceMatcher instead
 
2420
KnitSequenceMatcher = patiencediff.PatienceSequenceMatcher
 
2421
 
 
2422
 
 
2423
def annotate_knit(knit, revision_id):
 
2424
    """Annotate a knit with no cached annotations.
 
2425
 
 
2426
    This implementation is for knits with no cached annotations.
 
2427
    It will work for knits with cached annotations, but this is not
 
2428
    recommended.
1611
2429
    """
1612
 
 
1613
 
    def find_longest_match(self, alo, ahi, blo, bhi):
1614
 
        """Find longest matching block in a[alo:ahi] and b[blo:bhi].
1615
 
 
1616
 
        If isjunk is not defined:
1617
 
 
1618
 
        Return (i,j,k) such that a[i:i+k] is equal to b[j:j+k], where
1619
 
            alo <= i <= i+k <= ahi
1620
 
            blo <= j <= j+k <= bhi
1621
 
        and for all (i',j',k') meeting those conditions,
1622
 
            k >= k'
1623
 
            i <= i'
1624
 
            and if i == i', j <= j'
1625
 
 
1626
 
        In other words, of all maximal matching blocks, return one that
1627
 
        starts earliest in a, and of all those maximal matching blocks that
1628
 
        start earliest in a, return the one that starts earliest in b.
1629
 
 
1630
 
        >>> s = SequenceMatcher(None, " abcd", "abcd abcd")
1631
 
        >>> s.find_longest_match(0, 5, 0, 9)
1632
 
        (0, 4, 5)
1633
 
 
1634
 
        If isjunk is defined, first the longest matching block is
1635
 
        determined as above, but with the additional restriction that no
1636
 
        junk element appears in the block.  Then that block is extended as
1637
 
        far as possible by matching (only) junk elements on both sides.  So
1638
 
        the resulting block never matches on junk except as identical junk
1639
 
        happens to be adjacent to an "interesting" match.
1640
 
 
1641
 
        Here's the same example as before, but considering blanks to be
1642
 
        junk.  That prevents " abcd" from matching the " abcd" at the tail
1643
 
        end of the second sequence directly.  Instead only the "abcd" can
1644
 
        match, and matches the leftmost "abcd" in the second sequence:
1645
 
 
1646
 
        >>> s = SequenceMatcher(lambda x: x==" ", " abcd", "abcd abcd")
1647
 
        >>> s.find_longest_match(0, 5, 0, 9)
1648
 
        (1, 0, 4)
1649
 
 
1650
 
        If no blocks match, return (alo, blo, 0).
1651
 
 
1652
 
        >>> s = SequenceMatcher(None, "ab", "c")
1653
 
        >>> s.find_longest_match(0, 2, 0, 1)
1654
 
        (0, 0, 0)
1655
 
        """
1656
 
 
1657
 
        # CAUTION:  stripping common prefix or suffix would be incorrect.
1658
 
        # E.g.,
1659
 
        #    ab
1660
 
        #    acab
1661
 
        # Longest matching block is "ab", but if common prefix is
1662
 
        # stripped, it's "a" (tied with "b").  UNIX(tm) diff does so
1663
 
        # strip, so ends up claiming that ab is changed to acab by
1664
 
        # inserting "ca" in the middle.  That's minimal but unintuitive:
1665
 
        # "it's obvious" that someone inserted "ac" at the front.
1666
 
        # Windiff ends up at the same place as diff, but by pairing up
1667
 
        # the unique 'b's and then matching the first two 'a's.
1668
 
 
1669
 
        a, b, b2j, isbjunk = self.a, self.b, self.b2j, self.isbjunk
1670
 
        besti, bestj, bestsize = alo, blo, 0
1671
 
        # find longest junk-free match
1672
 
        # during an iteration of the loop, j2len[j] = length of longest
1673
 
        # junk-free match ending with a[i-1] and b[j]
1674
 
        j2len = {}
1675
 
        # nothing = []
1676
 
        b2jget = b2j.get
1677
 
        for i in xrange(alo, ahi):
1678
 
            # look at all instances of a[i] in b; note that because
1679
 
            # b2j has no junk keys, the loop is skipped if a[i] is junk
1680
 
            j2lenget = j2len.get
1681
 
            newj2len = {}
1682
 
            
1683
 
            # changing b2j.get(a[i], nothing) to a try:KeyError pair produced the
1684
 
            # following improvement
1685
 
            #     704  0   4650.5320   2620.7410   bzrlib.knit:1336(find_longest_match)
1686
 
            # +326674  0   1655.1210   1655.1210   +<method 'get' of 'dict' objects>
1687
 
            #  +76519  0    374.6700    374.6700   +<method 'has_key' of 'dict' objects>
1688
 
            # to 
1689
 
            #     704  0   3733.2820   2209.6520   bzrlib.knit:1336(find_longest_match)
1690
 
            #  +211400 0   1147.3520   1147.3520   +<method 'get' of 'dict' objects>
1691
 
            #  +76519  0    376.2780    376.2780   +<method 'has_key' of 'dict' objects>
1692
 
 
 
2430
    annotator = _KnitAnnotator(knit)
 
2431
    return iter(annotator.annotate(revision_id))
 
2432
 
 
2433
 
 
2434
class _KnitAnnotator(object):
 
2435
    """Build up the annotations for a text."""
 
2436
 
 
2437
    def __init__(self, knit):
 
2438
        self._knit = knit
 
2439
 
 
2440
        # Content objects, differs from fulltexts because of how final newlines
 
2441
        # are treated by knits. the content objects here will always have a
 
2442
        # final newline
 
2443
        self._fulltext_contents = {}
 
2444
 
 
2445
        # Annotated lines of specific revisions
 
2446
        self._annotated_lines = {}
 
2447
 
 
2448
        # Track the raw data for nodes that we could not process yet.
 
2449
        # This maps the revision_id of the base to a list of children that will
 
2450
        # annotated from it.
 
2451
        self._pending_children = {}
 
2452
 
 
2453
        # Nodes which cannot be extracted
 
2454
        self._ghosts = set()
 
2455
 
 
2456
        # Track how many children this node has, so we know if we need to keep
 
2457
        # it
 
2458
        self._annotate_children = {}
 
2459
        self._compression_children = {}
 
2460
 
 
2461
        self._all_build_details = {}
 
2462
        # The children => parent revision_id graph
 
2463
        self._revision_id_graph = {}
 
2464
 
 
2465
        self._heads_provider = None
 
2466
 
 
2467
        self._nodes_to_keep_annotations = set()
 
2468
        self._generations_until_keep = 100
 
2469
 
 
2470
    def set_generations_until_keep(self, value):
 
2471
        """Set the number of generations before caching a node.
 
2472
 
 
2473
        Setting this to -1 will cache every merge node, setting this higher
 
2474
        will cache fewer nodes.
 
2475
        """
 
2476
        self._generations_until_keep = value
 
2477
 
 
2478
    def _add_fulltext_content(self, revision_id, content_obj):
 
2479
        self._fulltext_contents[revision_id] = content_obj
 
2480
        # TODO: jam 20080305 It might be good to check the sha1digest here
 
2481
        return content_obj.text()
 
2482
 
 
2483
    def _check_parents(self, child, nodes_to_annotate):
 
2484
        """Check if all parents have been processed.
 
2485
 
 
2486
        :param child: A tuple of (rev_id, parents, raw_content)
 
2487
        :param nodes_to_annotate: If child is ready, add it to
 
2488
            nodes_to_annotate, otherwise put it back in self._pending_children
 
2489
        """
 
2490
        for parent_id in child[1]:
 
2491
            if (parent_id not in self._annotated_lines):
 
2492
                # This parent is present, but another parent is missing
 
2493
                self._pending_children.setdefault(parent_id,
 
2494
                                                  []).append(child)
 
2495
                break
 
2496
        else:
 
2497
            # This one is ready to be processed
 
2498
            nodes_to_annotate.append(child)
 
2499
 
 
2500
    def _add_annotation(self, revision_id, fulltext, parent_ids,
 
2501
                        left_matching_blocks=None):
 
2502
        """Add an annotation entry.
 
2503
 
 
2504
        All parents should already have been annotated.
 
2505
        :return: A list of children that now have their parents satisfied.
 
2506
        """
 
2507
        a = self._annotated_lines
 
2508
        annotated_parent_lines = [a[p] for p in parent_ids]
 
2509
        annotated_lines = list(annotate.reannotate(annotated_parent_lines,
 
2510
            fulltext, revision_id, left_matching_blocks,
 
2511
            heads_provider=self._get_heads_provider()))
 
2512
        self._annotated_lines[revision_id] = annotated_lines
 
2513
        for p in parent_ids:
 
2514
            ann_children = self._annotate_children[p]
 
2515
            ann_children.remove(revision_id)
 
2516
            if (not ann_children
 
2517
                and p not in self._nodes_to_keep_annotations):
 
2518
                del self._annotated_lines[p]
 
2519
                del self._all_build_details[p]
 
2520
                if p in self._fulltext_contents:
 
2521
                    del self._fulltext_contents[p]
 
2522
        # Now that we've added this one, see if there are any pending
 
2523
        # deltas to be done, certainly this parent is finished
 
2524
        nodes_to_annotate = []
 
2525
        for child in self._pending_children.pop(revision_id, []):
 
2526
            self._check_parents(child, nodes_to_annotate)
 
2527
        return nodes_to_annotate
 
2528
 
 
2529
    def _get_build_graph(self, key):
 
2530
        """Get the graphs for building texts and annotations.
 
2531
 
 
2532
        The data you need for creating a full text may be different than the
 
2533
        data you need to annotate that text. (At a minimum, you need both
 
2534
        parents to create an annotation, but only need 1 parent to generate the
 
2535
        fulltext.)
 
2536
 
 
2537
        :return: A list of (key, index_memo) records, suitable for
 
2538
            passing to read_records_iter to start reading in the raw data fro/
 
2539
            the pack file.
 
2540
        """
 
2541
        if key in self._annotated_lines:
 
2542
            # Nothing to do
 
2543
            return []
 
2544
        pending = set([key])
 
2545
        records = []
 
2546
        generation = 0
 
2547
        kept_generation = 0
 
2548
        while pending:
 
2549
            # get all pending nodes
 
2550
            generation += 1
 
2551
            this_iteration = pending
 
2552
            build_details = self._knit._index.get_build_details(this_iteration)
 
2553
            self._all_build_details.update(build_details)
 
2554
            # new_nodes = self._knit._index._get_entries(this_iteration)
 
2555
            pending = set()
 
2556
            for key, details in build_details.iteritems():
 
2557
                (index_memo, compression_parent, parents,
 
2558
                 record_details) = details
 
2559
                self._revision_id_graph[key] = parents
 
2560
                records.append((key, index_memo))
 
2561
                # Do we actually need to check _annotated_lines?
 
2562
                pending.update(p for p in parents
 
2563
                                 if p not in self._all_build_details)
 
2564
                if compression_parent:
 
2565
                    self._compression_children.setdefault(compression_parent,
 
2566
                        []).append(key)
 
2567
                if parents:
 
2568
                    for parent in parents:
 
2569
                        self._annotate_children.setdefault(parent,
 
2570
                            []).append(key)
 
2571
                    num_gens = generation - kept_generation
 
2572
                    if ((num_gens >= self._generations_until_keep)
 
2573
                        and len(parents) > 1):
 
2574
                        kept_generation = generation
 
2575
                        self._nodes_to_keep_annotations.add(key)
 
2576
 
 
2577
            missing_versions = this_iteration.difference(build_details.keys())
 
2578
            self._ghosts.update(missing_versions)
 
2579
            for missing_version in missing_versions:
 
2580
                # add a key, no parents
 
2581
                self._revision_id_graph[missing_version] = ()
 
2582
                pending.discard(missing_version) # don't look for it
 
2583
        if self._ghosts.intersection(self._compression_children):
 
2584
            raise KnitCorrupt(
 
2585
                "We cannot have nodes which have a ghost compression parent:\n"
 
2586
                "ghosts: %r\n"
 
2587
                "compression children: %r"
 
2588
                % (self._ghosts, self._compression_children))
 
2589
        # Cleanout anything that depends on a ghost so that we don't wait for
 
2590
        # the ghost to show up
 
2591
        for node in self._ghosts:
 
2592
            if node in self._annotate_children:
 
2593
                # We won't be building this node
 
2594
                del self._annotate_children[node]
 
2595
        # Generally we will want to read the records in reverse order, because
 
2596
        # we find the parent nodes after the children
 
2597
        records.reverse()
 
2598
        return records
 
2599
 
 
2600
    def _annotate_records(self, records):
 
2601
        """Build the annotations for the listed records."""
 
2602
        # We iterate in the order read, rather than a strict order requested
 
2603
        # However, process what we can, and put off to the side things that
 
2604
        # still need parents, cleaning them up when those parents are
 
2605
        # processed.
 
2606
        for (rev_id, record,
 
2607
             digest) in self._knit._read_records_iter(records):
 
2608
            if rev_id in self._annotated_lines:
 
2609
                continue
 
2610
            parent_ids = self._revision_id_graph[rev_id]
 
2611
            parent_ids = [p for p in parent_ids if p not in self._ghosts]
 
2612
            details = self._all_build_details[rev_id]
 
2613
            (index_memo, compression_parent, parents,
 
2614
             record_details) = details
 
2615
            nodes_to_annotate = []
 
2616
            # TODO: Remove the punning between compression parents, and
 
2617
            #       parent_ids, we should be able to do this without assuming
 
2618
            #       the build order
 
2619
            if len(parent_ids) == 0:
 
2620
                # There are no parents for this node, so just add it
 
2621
                # TODO: This probably needs to be decoupled
 
2622
                fulltext_content, delta = self._knit._factory.parse_record(
 
2623
                    rev_id, record, record_details, None)
 
2624
                fulltext = self._add_fulltext_content(rev_id, fulltext_content)
 
2625
                nodes_to_annotate.extend(self._add_annotation(rev_id, fulltext,
 
2626
                    parent_ids, left_matching_blocks=None))
 
2627
            else:
 
2628
                child = (rev_id, parent_ids, record)
 
2629
                # Check if all the parents are present
 
2630
                self._check_parents(child, nodes_to_annotate)
 
2631
            while nodes_to_annotate:
 
2632
                # Should we use a queue here instead of a stack?
 
2633
                (rev_id, parent_ids, record) = nodes_to_annotate.pop()
 
2634
                (index_memo, compression_parent, parents,
 
2635
                 record_details) = self._all_build_details[rev_id]
 
2636
                if compression_parent is not None:
 
2637
                    comp_children = self._compression_children[compression_parent]
 
2638
                    if rev_id not in comp_children:
 
2639
                        raise AssertionError("%r not in compression children %r"
 
2640
                            % (rev_id, comp_children))
 
2641
                    # If there is only 1 child, it is safe to reuse this
 
2642
                    # content
 
2643
                    reuse_content = (len(comp_children) == 1
 
2644
                        and compression_parent not in
 
2645
                            self._nodes_to_keep_annotations)
 
2646
                    if reuse_content:
 
2647
                        # Remove it from the cache since it will be changing
 
2648
                        parent_fulltext_content = self._fulltext_contents.pop(compression_parent)
 
2649
                        # Make sure to copy the fulltext since it might be
 
2650
                        # modified
 
2651
                        parent_fulltext = list(parent_fulltext_content.text())
 
2652
                    else:
 
2653
                        parent_fulltext_content = self._fulltext_contents[compression_parent]
 
2654
                        parent_fulltext = parent_fulltext_content.text()
 
2655
                    comp_children.remove(rev_id)
 
2656
                    fulltext_content, delta = self._knit._factory.parse_record(
 
2657
                        rev_id, record, record_details,
 
2658
                        parent_fulltext_content,
 
2659
                        copy_base_content=(not reuse_content))
 
2660
                    fulltext = self._add_fulltext_content(rev_id,
 
2661
                                                          fulltext_content)
 
2662
                    blocks = KnitContent.get_line_delta_blocks(delta,
 
2663
                            parent_fulltext, fulltext)
 
2664
                else:
 
2665
                    fulltext_content = self._knit._factory.parse_fulltext(
 
2666
                        record, rev_id)
 
2667
                    fulltext = self._add_fulltext_content(rev_id,
 
2668
                        fulltext_content)
 
2669
                    blocks = None
 
2670
                nodes_to_annotate.extend(
 
2671
                    self._add_annotation(rev_id, fulltext, parent_ids,
 
2672
                                     left_matching_blocks=blocks))
 
2673
 
 
2674
    def _get_heads_provider(self):
 
2675
        """Create a heads provider for resolving ancestry issues."""
 
2676
        if self._heads_provider is not None:
 
2677
            return self._heads_provider
 
2678
        parent_provider = _mod_graph.DictParentsProvider(
 
2679
            self._revision_id_graph)
 
2680
        graph_obj = _mod_graph.Graph(parent_provider)
 
2681
        head_cache = _mod_graph.FrozenHeadsCache(graph_obj)
 
2682
        self._heads_provider = head_cache
 
2683
        return head_cache
 
2684
 
 
2685
    def annotate(self, key):
 
2686
        """Return the annotated fulltext at the given key.
 
2687
 
 
2688
        :param key: The key to annotate.
 
2689
        """
 
2690
        if True or len(self._knit._fallback_vfs) > 0:
 
2691
            # stacked knits can't use the fast path at present.
 
2692
            return self._simple_annotate(key)
 
2693
        records = self._get_build_graph(key)
 
2694
        if key in self._ghosts:
 
2695
            raise errors.RevisionNotPresent(key, self._knit)
 
2696
        self._annotate_records(records)
 
2697
        return self._annotated_lines[key]
 
2698
 
 
2699
    def _simple_annotate(self, key):
 
2700
        """Return annotated fulltext, rediffing from the full texts.
 
2701
 
 
2702
        This is slow but makes no assumptions about the repository
 
2703
        being able to produce line deltas.
 
2704
        """
 
2705
        # TODO: this code generates a parent maps of present ancestors; it
 
2706
        # could be split out into a separate method, and probably should use
 
2707
        # iter_ancestry instead. -- mbp and robertc 20080704
 
2708
        graph = _mod_graph.Graph(self._knit)
 
2709
        head_cache = _mod_graph.FrozenHeadsCache(graph)
 
2710
        search = graph._make_breadth_first_searcher([key])
 
2711
        keys = set()
 
2712
        while True:
1693
2713
            try:
1694
 
                js = b2j[a[i]]
1695
 
            except KeyError:
1696
 
                pass
 
2714
                present, ghosts = search.next_with_ghosts()
 
2715
            except StopIteration:
 
2716
                break
 
2717
            keys.update(present)
 
2718
        parent_map = self._knit.get_parent_map(keys)
 
2719
        parent_cache = {}
 
2720
        reannotate = annotate.reannotate
 
2721
        for record in self._knit.get_record_stream(keys, 'topological', True):
 
2722
            key = record.key
 
2723
            fulltext = split_lines(record.get_bytes_as('fulltext'))
 
2724
            parents = parent_map[key]
 
2725
            if parents is not None:
 
2726
                parent_lines = [parent_cache[parent] for parent in parent_map[key]]
1697
2727
            else:
1698
 
                for j in js:
1699
 
                    # a[i] matches b[j]
1700
 
                    if j >= blo:
1701
 
                        if j >= bhi:
1702
 
                            break
1703
 
                        k = newj2len[j] = 1 + j2lenget(-1 + j, 0)
1704
 
                        if k > bestsize:
1705
 
                            besti, bestj, bestsize = 1 + i-k, 1 + j-k, k
1706
 
            j2len = newj2len
1707
 
 
1708
 
        # Extend the best by non-junk elements on each end.  In particular,
1709
 
        # "popular" non-junk elements aren't in b2j, which greatly speeds
1710
 
        # the inner loop above, but also means "the best" match so far
1711
 
        # doesn't contain any junk *or* popular non-junk elements.
1712
 
        while besti > alo and bestj > blo and \
1713
 
              not isbjunk(b[bestj-1]) and \
1714
 
              a[besti-1] == b[bestj-1]:
1715
 
            besti, bestj, bestsize = besti-1, bestj-1, bestsize+1
1716
 
        while besti+bestsize < ahi and bestj+bestsize < bhi and \
1717
 
              not isbjunk(b[bestj+bestsize]) and \
1718
 
              a[besti+bestsize] == b[bestj+bestsize]:
1719
 
            bestsize += 1
1720
 
 
1721
 
        # Now that we have a wholly interesting match (albeit possibly
1722
 
        # empty!), we may as well suck up the matching junk on each
1723
 
        # side of it too.  Can't think of a good reason not to, and it
1724
 
        # saves post-processing the (possibly considerable) expense of
1725
 
        # figuring out what to do with it.  In the case of an empty
1726
 
        # interesting match, this is clearly the right thing to do,
1727
 
        # because no other kind of match is possible in the regions.
1728
 
        while besti > alo and bestj > blo and \
1729
 
              isbjunk(b[bestj-1]) and \
1730
 
              a[besti-1] == b[bestj-1]:
1731
 
            besti, bestj, bestsize = besti-1, bestj-1, bestsize+1
1732
 
        while besti+bestsize < ahi and bestj+bestsize < bhi and \
1733
 
              isbjunk(b[bestj+bestsize]) and \
1734
 
              a[besti+bestsize] == b[bestj+bestsize]:
1735
 
            bestsize = bestsize + 1
1736
 
 
1737
 
        return besti, bestj, bestsize
1738
 
 
 
2728
                parent_lines = []
 
2729
            parent_cache[key] = list(
 
2730
                reannotate(parent_lines, fulltext, key, None, head_cache))
 
2731
        try:
 
2732
            return parent_cache[key]
 
2733
        except KeyError, e:
 
2734
            raise errors.RevisionNotPresent(key, self._knit)
 
2735
 
 
2736
 
 
2737
try:
 
2738
    from bzrlib._knit_load_data_c import _load_data_c as _load_data
 
2739
except ImportError:
 
2740
    from bzrlib._knit_load_data_py import _load_data_py as _load_data