/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/knit.py

  • Committer: Robert Collins
  • Date: 2006-04-03 02:25:38 UTC
  • mto: (1641.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 1642.
  • Revision ID: robertc@robertcollins.net-20060403022538-b10dd26e1c549ad2
Tune get_revision_graph_with_ghosts for Knit repositories.

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>
 
5
#
 
6
# This program is free software; you can redistribute it and/or modify
 
7
# it under the terms of the GNU General Public License as published by
 
8
# the Free Software Foundation; either version 2 of the License, or
 
9
# (at your option) any later version.
 
10
#
 
11
# This program is distributed in the hope that it will be useful,
 
12
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
13
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
14
# GNU General Public License for more details.
 
15
#
 
16
# You should have received a copy of the GNU General Public License
 
17
# along with this program; if not, write to the Free Software
 
18
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
19
 
 
20
"""Knit versionedfile implementation.
 
21
 
 
22
A knit is a versioned file implementation that supports efficient append only
 
23
updates.
 
24
 
 
25
Knit file layout:
 
26
lifeless: the data file is made up of "delta records".  each delta record has a delta header 
 
27
that contains; (1) a version id, (2) the size of the delta (in lines), and (3)  the digest of 
 
28
the -expanded data- (ie, the delta applied to the parent).  the delta also ends with a 
 
29
end-marker; simply "end VERSION"
 
30
 
 
31
delta can be line or full contents.a
 
32
... the 8's there are the index number of the annotation.
 
33
version robertc@robertcollins.net-20051003014215-ee2990904cc4c7ad 7 c7d23b2a5bd6ca00e8e266cec0ec228158ee9f9e
 
34
59,59,3
 
35
8
 
36
8         if ie.executable:
 
37
8             e.set('executable', 'yes')
 
38
130,130,2
 
39
8         if elt.get('executable') == 'yes':
 
40
8             ie.executable = True
 
41
end robertc@robertcollins.net-20051003014215-ee2990904cc4c7ad 
 
42
 
 
43
 
 
44
whats in an index:
 
45
09:33 < jrydberg> lifeless: each index is made up of a tuple of; version id, options, position, size, parents
 
46
09:33 < jrydberg> lifeless: the parents are currently dictionary compressed
 
47
09:33 < jrydberg> lifeless: (meaning it currently does not support ghosts)
 
48
09:33 < lifeless> right
 
49
09:33 < jrydberg> lifeless: the position and size is the range in the data file
 
50
 
 
51
 
 
52
so the index sequence is the dictionary compressed sequence number used
 
53
in the deltas to provide line annotation
 
54
 
 
55
"""
 
56
 
 
57
# TODOS:
 
58
# 10:16 < lifeless> make partial index writes safe
 
59
# 10:16 < lifeless> implement 'knit.check()' like weave.check()
 
60
# 10:17 < lifeless> record known ghosts so we can detect when they are filled in rather than the current 'reweave 
 
61
#                    always' approach.
 
62
# move sha1 out of the content so that join is faster at verifying parents
 
63
# record content length ?
 
64
                  
 
65
 
 
66
from copy import copy
 
67
from cStringIO import StringIO
 
68
import difflib
 
69
import gzip
 
70
from itertools import izip, chain
 
71
import os
 
72
import sys
 
73
 
 
74
import bzrlib
 
75
import bzrlib.errors as errors
 
76
from bzrlib.errors import FileExists, NoSuchFile, KnitError, \
 
77
        InvalidRevisionId, KnitCorrupt, KnitHeaderError, \
 
78
        RevisionNotPresent, RevisionAlreadyPresent
 
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
 
 
85
 
 
86
# TODO: Split out code specific to this format into an associated object.
 
87
 
 
88
# TODO: Can we put in some kind of value to check that the index and data
 
89
# files belong together?
 
90
 
 
91
# TODO: accomodate binaries, perhaps by storing a byte count
 
92
 
 
93
# TODO: function to check whole file
 
94
 
 
95
# TODO: atomically append data, then measure backwards from the cursor
 
96
# position after writing to work out where it was located.  we may need to
 
97
# bypass python file buffering.
 
98
 
 
99
DATA_SUFFIX = '.knit'
 
100
INDEX_SUFFIX = '.kndx'
 
101
 
 
102
 
 
103
class KnitContent(object):
 
104
    """Content of a knit version to which deltas can be applied."""
 
105
 
 
106
    def __init__(self, lines):
 
107
        self._lines = lines
 
108
 
 
109
    def annotate_iter(self):
 
110
        """Yield tuples of (origin, text) for each content line."""
 
111
        for origin, text in self._lines:
 
112
            yield origin, text
 
113
 
 
114
    def annotate(self):
 
115
        """Return a list of (origin, text) tuples."""
 
116
        return list(self.annotate_iter())
 
117
 
 
118
    def line_delta_iter(self, new_lines):
 
119
        """Generate line-based delta from this content to new_lines."""
 
120
        new_texts = [text for origin, text in new_lines._lines]
 
121
        old_texts = [text for origin, text in self._lines]
 
122
        s = SequenceMatcher(None, old_texts, new_texts)
 
123
        for op in s.get_opcodes():
 
124
            if op[0] == 'equal':
 
125
                continue
 
126
            #     ofrom   oto   length        data
 
127
            yield (op[1], op[2], op[4]-op[3], new_lines._lines[op[3]:op[4]])
 
128
 
 
129
    def line_delta(self, new_lines):
 
130
        return list(self.line_delta_iter(new_lines))
 
131
 
 
132
    def text(self):
 
133
        return [text for origin, text in self._lines]
 
134
 
 
135
 
 
136
class _KnitFactory(object):
 
137
    """Base factory for creating content objects."""
 
138
 
 
139
    def make(self, lines, version):
 
140
        num_lines = len(lines)
 
141
        return KnitContent(zip([version] * num_lines, lines))
 
142
 
 
143
 
 
144
class KnitAnnotateFactory(_KnitFactory):
 
145
    """Factory for creating annotated Content objects."""
 
146
 
 
147
    annotated = True
 
148
 
 
149
    def parse_fulltext(self, content, version):
 
150
        """Convert fulltext to internal representation
 
151
 
 
152
        fulltext content is of the format
 
153
        revid(utf8) plaintext\n
 
154
        internal representation is of the format:
 
155
        (revid, plaintext)
 
156
        """
 
157
        lines = []
 
158
        for line in content:
 
159
            origin, text = line.split(' ', 1)
 
160
            lines.append((origin.decode('utf-8'), text))
 
161
        return KnitContent(lines)
 
162
 
 
163
    def parse_line_delta_iter(self, lines):
 
164
        for result_item in self.parse_line_delta[lines]:
 
165
            yield result_item
 
166
 
 
167
    def parse_line_delta(self, lines, version):
 
168
        """Convert a line based delta into internal representation.
 
169
 
 
170
        line delta is in the form of:
 
171
        intstart intend intcount
 
172
        1..count lines:
 
173
        revid(utf8) newline\n
 
174
        internal represnetation is
 
175
        (start, end, count, [1..count tuples (revid, newline)])
 
176
        """
 
177
        result = []
 
178
        lines = iter(lines)
 
179
        next = lines.next
 
180
        # walk through the lines parsing.
 
181
        for header in lines:
 
182
            start, end, count = [int(n) for n in header.split(',')]
 
183
            contents = []
 
184
            remaining = count
 
185
            while remaining:
 
186
                origin, text = next().split(' ', 1)
 
187
                remaining -= 1
 
188
                contents.append((origin.decode('utf-8'), text))
 
189
            result.append((start, end, count, contents))
 
190
        return result
 
191
 
 
192
    def lower_fulltext(self, content):
 
193
        """convert a fulltext content record into a serializable form.
 
194
 
 
195
        see parse_fulltext which this inverts.
 
196
        """
 
197
        return ['%s %s' % (o.encode('utf-8'), t) for o, t in content._lines]
 
198
 
 
199
    def lower_line_delta(self, delta):
 
200
        """convert a delta into a serializable form.
 
201
 
 
202
        See parse_line_delta which this inverts.
 
203
        """
 
204
        out = []
 
205
        for start, end, c, lines in delta:
 
206
            out.append('%d,%d,%d\n' % (start, end, c))
 
207
            for origin, text in lines:
 
208
                out.append('%s %s' % (origin.encode('utf-8'), text))
 
209
        return out
 
210
 
 
211
 
 
212
class KnitPlainFactory(_KnitFactory):
 
213
    """Factory for creating plain Content objects."""
 
214
 
 
215
    annotated = False
 
216
 
 
217
    def parse_fulltext(self, content, version):
 
218
        """This parses an unannotated fulltext.
 
219
 
 
220
        Note that this is not a noop - the internal representation
 
221
        has (versionid, line) - its just a constant versionid.
 
222
        """
 
223
        return self.make(content, version)
 
224
 
 
225
    def parse_line_delta_iter(self, lines, version):
 
226
        while lines:
 
227
            header = lines.pop(0)
 
228
            start, end, c = [int(n) for n in header.split(',')]
 
229
            yield start, end, c, zip([version] * c, lines[:c])
 
230
            del lines[:c]
 
231
 
 
232
    def parse_line_delta(self, lines, version):
 
233
        return list(self.parse_line_delta_iter(lines, version))
 
234
    
 
235
    def lower_fulltext(self, content):
 
236
        return content.text()
 
237
 
 
238
    def lower_line_delta(self, delta):
 
239
        out = []
 
240
        for start, end, c, lines in delta:
 
241
            out.append('%d,%d,%d\n' % (start, end, c))
 
242
            out.extend([text for origin, text in lines])
 
243
        return out
 
244
 
 
245
 
 
246
def make_empty_knit(transport, relpath):
 
247
    """Construct a empty knit at the specified location."""
 
248
    k = KnitVersionedFile(transport, relpath, 'w', KnitPlainFactory)
 
249
    k._data._open_file()
 
250
 
 
251
 
 
252
class KnitVersionedFile(VersionedFile):
 
253
    """Weave-like structure with faster random access.
 
254
 
 
255
    A knit stores a number of texts and a summary of the relationships
 
256
    between them.  Texts are identified by a string version-id.  Texts
 
257
    are normally stored and retrieved as a series of lines, but can
 
258
    also be passed as single strings.
 
259
 
 
260
    Lines are stored with the trailing newline (if any) included, to
 
261
    avoid special cases for files with no final newline.  Lines are
 
262
    composed of 8-bit characters, not unicode.  The combination of
 
263
    these approaches should mean any 'binary' file can be safely
 
264
    stored and retrieved.
 
265
    """
 
266
 
 
267
    def __init__(self, relpath, transport, file_mode=None, access_mode=None, factory=None,
 
268
                 basis_knit=None, delta=True, create=False):
 
269
        """Construct a knit at location specified by relpath.
 
270
        
 
271
        :param create: If not True, only open an existing knit.
 
272
        """
 
273
        if access_mode is None:
 
274
            access_mode = 'w'
 
275
        super(KnitVersionedFile, self).__init__(access_mode)
 
276
        assert access_mode in ('r', 'w'), "invalid mode specified %r" % access_mode
 
277
        assert not basis_knit or isinstance(basis_knit, KnitVersionedFile), \
 
278
            type(basis_knit)
 
279
 
 
280
        self.transport = transport
 
281
        self.filename = relpath
 
282
        self.basis_knit = basis_knit
 
283
        self.factory = factory or KnitAnnotateFactory()
 
284
        self.writable = (access_mode == 'w')
 
285
        self.delta = delta
 
286
 
 
287
        self._index = _KnitIndex(transport, relpath + INDEX_SUFFIX,
 
288
            access_mode, create=create)
 
289
        self._data = _KnitData(transport, relpath + DATA_SUFFIX,
 
290
            access_mode, create=not len(self.versions()))
 
291
 
 
292
    def _add_delta(self, version_id, parents, delta_parent, sha1, noeol, delta):
 
293
        """See VersionedFile._add_delta()."""
 
294
        self._check_add(version_id, []) # should we check the lines ?
 
295
        self._check_versions_present(parents)
 
296
        present_parents = []
 
297
        ghosts = []
 
298
        parent_texts = {}
 
299
        for parent in parents:
 
300
            if not self.has_version(parent):
 
301
                ghosts.append(parent)
 
302
            else:
 
303
                present_parents.append(parent)
 
304
 
 
305
        if delta_parent is None:
 
306
            # reconstitute as full text.
 
307
            assert len(delta) == 1 or len(delta) == 0
 
308
            if len(delta):
 
309
                assert delta[0][0] == 0
 
310
                assert delta[0][1] == 0, delta[0][1]
 
311
            return super(KnitVersionedFile, self)._add_delta(version_id,
 
312
                                                             parents,
 
313
                                                             delta_parent,
 
314
                                                             sha1,
 
315
                                                             noeol,
 
316
                                                             delta)
 
317
 
 
318
        digest = sha1
 
319
 
 
320
        options = []
 
321
        if noeol:
 
322
            options.append('no-eol')
 
323
 
 
324
        if delta_parent is not None:
 
325
            # determine the current delta chain length.
 
326
            # To speed the extract of texts the delta chain is limited
 
327
            # to a fixed number of deltas.  This should minimize both
 
328
            # I/O and the time spend applying deltas.
 
329
            count = 0
 
330
            delta_parents = [delta_parent]
 
331
            while count < 25:
 
332
                parent = delta_parents[0]
 
333
                method = self._index.get_method(parent)
 
334
                if method == 'fulltext':
 
335
                    break
 
336
                delta_parents = self._index.get_parents(parent)
 
337
                count = count + 1
 
338
            if method == 'line-delta':
 
339
                # did not find a fulltext in the delta limit.
 
340
                # just do a normal insertion.
 
341
                return super(KnitVersionedFile, self)._add_delta(version_id,
 
342
                                                                 parents,
 
343
                                                                 delta_parent,
 
344
                                                                 sha1,
 
345
                                                                 noeol,
 
346
                                                                 delta)
 
347
 
 
348
        options.append('line-delta')
 
349
        store_lines = self.factory.lower_line_delta(delta)
 
350
 
 
351
        where, size = self._data.add_record(version_id, digest, store_lines)
 
352
        self._index.add_version(version_id, options, where, size, parents)
 
353
 
 
354
    def clear_cache(self):
 
355
        """Clear the data cache only."""
 
356
        self._data.clear_cache()
 
357
 
 
358
    def copy_to(self, name, transport):
 
359
        """See VersionedFile.copy_to()."""
 
360
        # copy the current index to a temp index to avoid racing with local
 
361
        # writes
 
362
        transport.put(name + INDEX_SUFFIX + '.tmp', self.transport.get(self._index._filename))
 
363
        # copy the data file
 
364
        transport.put(name + DATA_SUFFIX, self._data._open_file())
 
365
        # rename the copied index into place
 
366
        transport.rename(name + INDEX_SUFFIX + '.tmp', name + INDEX_SUFFIX)
 
367
 
 
368
    def create_empty(self, name, transport, mode=None):
 
369
        return KnitVersionedFile(name, transport, factory=self.factory, delta=self.delta, create=True)
 
370
    
 
371
    def _fix_parents(self, version, new_parents):
 
372
        """Fix the parents list for version.
 
373
        
 
374
        This is done by appending a new version to the index
 
375
        with identical data except for the parents list.
 
376
        the parents list must be a superset of the current
 
377
        list.
 
378
        """
 
379
        current_values = self._index._cache[version]
 
380
        assert set(current_values[4]).difference(set(new_parents)) == set()
 
381
        self._index.add_version(version,
 
382
                                current_values[1], 
 
383
                                current_values[2],
 
384
                                current_values[3],
 
385
                                new_parents)
 
386
 
 
387
    def get_delta(self, version_id):
 
388
        """Get a delta for constructing version from some other version."""
 
389
        if not self.has_version(version_id):
 
390
            raise RevisionNotPresent(version_id, self.filename)
 
391
        
 
392
        parents = self.get_parents(version_id)
 
393
        if len(parents):
 
394
            parent = parents[0]
 
395
        else:
 
396
            parent = None
 
397
        data_pos, data_size = self._index.get_position(version_id)
 
398
        data, sha1 = self._data.read_records(((version_id, data_pos, data_size),))[version_id]
 
399
        version_idx = self._index.lookup(version_id)
 
400
        noeol = 'no-eol' in self._index.get_options(version_id)
 
401
        if 'fulltext' == self._index.get_method(version_id):
 
402
            new_content = self.factory.parse_fulltext(data, version_idx)
 
403
            if parent is not None:
 
404
                reference_content = self._get_content(parent)
 
405
                old_texts = reference_content.text()
 
406
            else:
 
407
                old_texts = []
 
408
            new_texts = new_content.text()
 
409
            delta_seq = SequenceMatcher(None, old_texts, new_texts)
 
410
            return parent, sha1, noeol, self._make_line_delta(delta_seq, new_content)
 
411
        else:
 
412
            delta = self.factory.parse_line_delta(data, version_idx)
 
413
            return parent, sha1, noeol, delta
 
414
        
 
415
    def get_graph_with_ghosts(self):
 
416
        """See VersionedFile.get_graph_with_ghosts()."""
 
417
        graph_items = self._index.get_graph()
 
418
        return dict(graph_items)
 
419
 
 
420
    @staticmethod
 
421
    def get_suffixes():
 
422
        """See VersionedFile.get_suffixes()."""
 
423
        return [DATA_SUFFIX, INDEX_SUFFIX]
 
424
 
 
425
    def has_ghost(self, version_id):
 
426
        """True if there is a ghost reference in the file to version_id."""
 
427
        # maybe we have it
 
428
        if self.has_version(version_id):
 
429
            return False
 
430
        # optimisable if needed by memoising the _ghosts set.
 
431
        items = self._index.get_graph()
 
432
        for node, parents in items:
 
433
            for parent in parents:
 
434
                if parent not in self._index._cache:
 
435
                    if parent == version_id:
 
436
                        return True
 
437
        return False
 
438
 
 
439
    def versions(self):
 
440
        """See VersionedFile.versions."""
 
441
        return self._index.get_versions()
 
442
 
 
443
    def has_version(self, version_id):
 
444
        """See VersionedFile.has_version."""
 
445
        return self._index.has_version(version_id)
 
446
 
 
447
    __contains__ = has_version
 
448
 
 
449
    def _merge_annotations(self, content, parents, parent_texts={},
 
450
                           delta=None, annotated=None):
 
451
        """Merge annotations for content.  This is done by comparing
 
452
        the annotations based on changed to the text.
 
453
        """
 
454
        if annotated:
 
455
            delta_seq = None
 
456
            for parent_id in parents:
 
457
                merge_content = self._get_content(parent_id, parent_texts)
 
458
                seq = SequenceMatcher(None, merge_content.text(), content.text())
 
459
                if delta_seq is None:
 
460
                    # setup a delta seq to reuse.
 
461
                    delta_seq = seq
 
462
                for i, j, n in seq.get_matching_blocks():
 
463
                    if n == 0:
 
464
                        continue
 
465
                    # this appears to copy (origin, text) pairs across to the new
 
466
                    # content for any line that matches the last-checked parent.
 
467
                    # FIXME: save the sequence control data for delta compression
 
468
                    # against the most relevant parent rather than rediffing.
 
469
                    content._lines[j:j+n] = merge_content._lines[i:i+n]
 
470
        if delta:
 
471
            if not annotated:
 
472
                reference_content = self._get_content(parents[0], parent_texts)
 
473
                new_texts = content.text()
 
474
                old_texts = reference_content.text()
 
475
                delta_seq = SequenceMatcher(None, old_texts, new_texts)
 
476
            return self._make_line_delta(delta_seq, content)
 
477
 
 
478
    def _make_line_delta(self, delta_seq, new_content):
 
479
        """Generate a line delta from delta_seq and new_content."""
 
480
        diff_hunks = []
 
481
        for op in delta_seq.get_opcodes():
 
482
            if op[0] == 'equal':
 
483
                continue
 
484
            diff_hunks.append((op[1], op[2], op[4]-op[3], new_content._lines[op[3]:op[4]]))
 
485
        return diff_hunks
 
486
 
 
487
    def _get_components(self, version_id):
 
488
        """Return a list of (version_id, method, data) tuples that
 
489
        makes up version specified by version_id of the knit.
 
490
 
 
491
        The components should be applied in the order of the returned
 
492
        list.
 
493
 
 
494
        The basis knit will be used to the largest extent possible
 
495
        since it is assumed that accesses to it is faster.
 
496
        """
 
497
        #profile notes:
 
498
        # 4168 calls in 14912, 2289 internal
 
499
        # 4168 in 9711 to read_records
 
500
        # 52554 in 1250 to get_parents
 
501
        # 170166 in 865 to list.append
 
502
        
 
503
        # needed_revisions holds a list of (method, version_id) of
 
504
        # versions that is needed to be fetched to construct the final
 
505
        # version of the file.
 
506
        #
 
507
        # basis_revisions is a list of versions that needs to be
 
508
        # fetched but exists in the basis knit.
 
509
 
 
510
        basis = self.basis_knit
 
511
        needed_versions = []
 
512
        basis_versions = []
 
513
        cursor = version_id
 
514
 
 
515
        while 1:
 
516
            picked_knit = self
 
517
            if basis and basis._index.has_version(cursor):
 
518
                picked_knit = basis
 
519
                basis_versions.append(cursor)
 
520
            method = picked_knit._index.get_method(cursor)
 
521
            needed_versions.append((method, cursor))
 
522
            if method == 'fulltext':
 
523
                break
 
524
            cursor = picked_knit.get_parents(cursor)[0]
 
525
 
 
526
        components = {}
 
527
        if basis_versions:
 
528
            records = []
 
529
            for comp_id in basis_versions:
 
530
                data_pos, data_size = basis._index.get_data_position(comp_id)
 
531
                records.append((piece_id, data_pos, data_size))
 
532
            components.update(basis._data.read_records(records))
 
533
 
 
534
        records = []
 
535
        for comp_id in [vid for method, vid in needed_versions
 
536
                        if vid not in basis_versions]:
 
537
            data_pos, data_size = self._index.get_position(comp_id)
 
538
            records.append((comp_id, data_pos, data_size))
 
539
        components.update(self._data.read_records(records))
 
540
 
 
541
        # get_data_records returns a mapping with the version id as
 
542
        # index and the value as data.  The order the components need
 
543
        # to be applied is held by needed_versions (reversed).
 
544
        out = []
 
545
        for method, comp_id in reversed(needed_versions):
 
546
            out.append((comp_id, method, components[comp_id]))
 
547
 
 
548
        return out
 
549
 
 
550
    def _get_content(self, version_id, parent_texts={}):
 
551
        """Returns a content object that makes up the specified
 
552
        version."""
 
553
        if not self.has_version(version_id):
 
554
            raise RevisionNotPresent(version_id, self.filename)
 
555
 
 
556
        cached_version = parent_texts.get(version_id, None)
 
557
        if cached_version is not None:
 
558
            return cached_version
 
559
 
 
560
        if self.basis_knit and version_id in self.basis_knit:
 
561
            return self.basis_knit._get_content(version_id)
 
562
 
 
563
        content = None
 
564
        components = self._get_components(version_id)
 
565
        for component_id, method, (data, digest) in components:
 
566
            version_idx = self._index.lookup(component_id)
 
567
            if method == 'fulltext':
 
568
                assert content is None
 
569
                content = self.factory.parse_fulltext(data, version_idx)
 
570
            elif method == 'line-delta':
 
571
                delta = self.factory.parse_line_delta(data, version_idx)
 
572
                content._lines = self._apply_delta(content._lines, delta)
 
573
 
 
574
        if 'no-eol' in self._index.get_options(version_id):
 
575
            line = content._lines[-1][1].rstrip('\n')
 
576
            content._lines[-1] = (content._lines[-1][0], line)
 
577
 
 
578
        if sha_strings(content.text()) != digest:
 
579
            import pdb;pdb.set_trace()
 
580
            raise KnitCorrupt(self.filename, 'sha-1 does not match %s' % version_id)
 
581
 
 
582
        return content
 
583
 
 
584
    def _check_versions_present(self, version_ids):
 
585
        """Check that all specified versions are present."""
 
586
        version_ids = set(version_ids)
 
587
        for r in list(version_ids):
 
588
            if self._index.has_version(r):
 
589
                version_ids.remove(r)
 
590
        if version_ids:
 
591
            raise RevisionNotPresent(list(version_ids)[0], self.filename)
 
592
 
 
593
    def _add_lines_with_ghosts(self, version_id, parents, lines, parent_texts):
 
594
        """See VersionedFile.add_lines_with_ghosts()."""
 
595
        self._check_add(version_id, lines)
 
596
        return self._add(version_id, lines[:], parents, self.delta, parent_texts)
 
597
 
 
598
    def _add_lines(self, version_id, parents, lines, parent_texts):
 
599
        """See VersionedFile.add_lines."""
 
600
        self._check_add(version_id, lines)
 
601
        self._check_versions_present(parents)
 
602
        return self._add(version_id, lines[:], parents, self.delta, parent_texts)
 
603
 
 
604
    def _check_add(self, version_id, lines):
 
605
        """check that version_id and lines are safe to add."""
 
606
        assert self.writable, "knit is not opened for write"
 
607
        ### FIXME escape. RBC 20060228
 
608
        if contains_whitespace(version_id):
 
609
            raise InvalidRevisionId(version_id)
 
610
        if self.has_version(version_id):
 
611
            raise RevisionAlreadyPresent(version_id, self.filename)
 
612
 
 
613
        if False or __debug__:
 
614
            for l in lines:
 
615
                assert '\n' not in l[:-1]
 
616
 
 
617
    def _add(self, version_id, lines, parents, delta, parent_texts):
 
618
        """Add a set of lines on top of version specified by parents.
 
619
 
 
620
        If delta is true, compress the text as a line-delta against
 
621
        the first parent.
 
622
 
 
623
        Any versions not present will be converted into ghosts.
 
624
        """
 
625
        #  461    0   6546.0390     43.9100   bzrlib.knit:489(_add)
 
626
        # +400    0    889.4890    418.9790   +bzrlib.knit:192(lower_fulltext)
 
627
        # +461    0   1364.8070    108.8030   +bzrlib.knit:996(add_record)
 
628
        # +461    0    193.3940     41.5720   +bzrlib.knit:898(add_version)
 
629
        # +461    0    134.0590     18.3810   +bzrlib.osutils:361(sha_strings)
 
630
        # +461    0     36.3420     15.4540   +bzrlib.knit:146(make)
 
631
        # +1383   0      8.0370      8.0370   +<len>
 
632
        # +61     0     13.5770      7.9190   +bzrlib.knit:199(lower_line_delta)
 
633
        # +61     0    963.3470      7.8740   +bzrlib.knit:427(_get_content)
 
634
        # +61     0    973.9950      5.2950   +bzrlib.knit:136(line_delta)
 
635
        # +61     0   1918.1800      5.2640   +bzrlib.knit:359(_merge_annotations)
 
636
 
 
637
        present_parents = []
 
638
        ghosts = []
 
639
        if parent_texts is None:
 
640
            parent_texts = {}
 
641
        for parent in parents:
 
642
            if not self.has_version(parent):
 
643
                ghosts.append(parent)
 
644
            else:
 
645
                present_parents.append(parent)
 
646
 
 
647
        if delta and not len(present_parents):
 
648
            delta = False
 
649
 
 
650
        digest = sha_strings(lines)
 
651
        options = []
 
652
        if lines:
 
653
            if lines[-1][-1] != '\n':
 
654
                options.append('no-eol')
 
655
                lines[-1] = lines[-1] + '\n'
 
656
 
 
657
        if len(present_parents) and delta:
 
658
            # To speed the extract of texts the delta chain is limited
 
659
            # to a fixed number of deltas.  This should minimize both
 
660
            # I/O and the time spend applying deltas.
 
661
            count = 0
 
662
            delta_parents = present_parents
 
663
            while count < 25:
 
664
                parent = delta_parents[0]
 
665
                method = self._index.get_method(parent)
 
666
                if method == 'fulltext':
 
667
                    break
 
668
                delta_parents = self._index.get_parents(parent)
 
669
                count = count + 1
 
670
            if method == 'line-delta':
 
671
                delta = False
 
672
 
 
673
        lines = self.factory.make(lines, version_id)
 
674
        if delta or (self.factory.annotated and len(present_parents) > 0):
 
675
            # Merge annotations from parent texts if so is needed.
 
676
            delta_hunks = self._merge_annotations(lines, present_parents, parent_texts,
 
677
                                                  delta, self.factory.annotated)
 
678
 
 
679
        if delta:
 
680
            options.append('line-delta')
 
681
            store_lines = self.factory.lower_line_delta(delta_hunks)
 
682
        else:
 
683
            options.append('fulltext')
 
684
            store_lines = self.factory.lower_fulltext(lines)
 
685
 
 
686
        where, size = self._data.add_record(version_id, digest, store_lines)
 
687
        self._index.add_version(version_id, options, where, size, parents)
 
688
        return lines
 
689
 
 
690
    def check(self, progress_bar=None):
 
691
        """See VersionedFile.check()."""
 
692
 
 
693
    def _clone_text(self, new_version_id, old_version_id, parents):
 
694
        """See VersionedFile.clone_text()."""
 
695
        # FIXME RBC 20060228 make fast by only inserting an index with null delta.
 
696
        self.add_lines(new_version_id, parents, self.get_lines(old_version_id))
 
697
 
 
698
    def get_lines(self, version_id):
 
699
        """See VersionedFile.get_lines()."""
 
700
        return self._get_content(version_id).text()
 
701
 
 
702
    def iter_lines_added_or_present_in_versions(self, version_ids=None):
 
703
        """See VersionedFile.iter_lines_added_or_present_in_versions()."""
 
704
        if version_ids is None:
 
705
            version_ids = self.versions()
 
706
        # we dont care about inclusions, the caller cares.
 
707
        # but we need to setup a list of records to visit.
 
708
        # we need version_id, position, length
 
709
        version_id_records = []
 
710
        requested_versions = list(version_ids)
 
711
        # filter for available versions
 
712
        for version_id in requested_versions:
 
713
            if not self.has_version(version_id):
 
714
                raise RevisionNotPresent(version_id, self.filename)
 
715
        # get a in-component-order queue:
 
716
        version_ids = []
 
717
        for version_id in self.versions():
 
718
            if version_id in requested_versions:
 
719
                version_ids.append(version_id)
 
720
                data_pos, length = self._index.get_position(version_id)
 
721
                version_id_records.append((version_id, data_pos, length))
 
722
 
 
723
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
724
        count = 0
 
725
        total = len(version_id_records)
 
726
        try:
 
727
            pb.update('Walking content.', count, total)
 
728
            for version_id, data, sha_value in \
 
729
                self._data.read_records_iter(version_id_records):
 
730
                pb.update('Walking content.', count, total)
 
731
                method = self._index.get_method(version_id)
 
732
                version_idx = self._index.lookup(version_id)
 
733
                assert method in ('fulltext', 'line-delta')
 
734
                if method == 'fulltext':
 
735
                    content = self.factory.parse_fulltext(data, version_idx)
 
736
                    for line in content.text():
 
737
                        yield line
 
738
                else:
 
739
                    delta = self.factory.parse_line_delta(data, version_idx)
 
740
                    for start, end, count, lines in delta:
 
741
                        for origin, line in lines:
 
742
                            yield line
 
743
                count +=1
 
744
            pb.update('Walking content.', total, total)
 
745
            pb.finished()
 
746
        except:
 
747
            pb.update('Walking content.', total, total)
 
748
            pb.finished()
 
749
            raise
 
750
        
 
751
    def num_versions(self):
 
752
        """See VersionedFile.num_versions()."""
 
753
        return self._index.num_versions()
 
754
 
 
755
    __len__ = num_versions
 
756
 
 
757
    def annotate_iter(self, version_id):
 
758
        """See VersionedFile.annotate_iter."""
 
759
        content = self._get_content(version_id)
 
760
        for origin, text in content.annotate_iter():
 
761
            yield origin, text
 
762
 
 
763
    def get_parents(self, version_id):
 
764
        """See VersionedFile.get_parents."""
 
765
        # perf notes:
 
766
        # optimism counts!
 
767
        # 52554 calls in 1264 872 internal down from 3674
 
768
        try:
 
769
            return self._index.get_parents(version_id)
 
770
        except KeyError:
 
771
            raise RevisionNotPresent(version_id, self.filename)
 
772
 
 
773
    def get_parents_with_ghosts(self, version_id):
 
774
        """See VersionedFile.get_parents."""
 
775
        try:
 
776
            return self._index.get_parents_with_ghosts(version_id)
 
777
        except KeyError:
 
778
            raise RevisionNotPresent(version_id, self.filename)
 
779
 
 
780
    def get_ancestry(self, versions):
 
781
        """See VersionedFile.get_ancestry."""
 
782
        if isinstance(versions, basestring):
 
783
            versions = [versions]
 
784
        if not versions:
 
785
            return []
 
786
        self._check_versions_present(versions)
 
787
        return self._index.get_ancestry(versions)
 
788
 
 
789
    def get_ancestry_with_ghosts(self, versions):
 
790
        """See VersionedFile.get_ancestry_with_ghosts."""
 
791
        if isinstance(versions, basestring):
 
792
            versions = [versions]
 
793
        if not versions:
 
794
            return []
 
795
        self._check_versions_present(versions)
 
796
        return self._index.get_ancestry_with_ghosts(versions)
 
797
 
 
798
    #@deprecated_method(zero_eight)
 
799
    def walk(self, version_ids):
 
800
        """See VersionedFile.walk."""
 
801
        # We take the short path here, and extract all relevant texts
 
802
        # and put them in a weave and let that do all the work.  Far
 
803
        # from optimal, but is much simpler.
 
804
        # FIXME RB 20060228 this really is inefficient!
 
805
        from bzrlib.weave import Weave
 
806
 
 
807
        w = Weave(self.filename)
 
808
        ancestry = self.get_ancestry(version_ids)
 
809
        sorted_graph = topo_sort(self._index.get_graph())
 
810
        version_list = [vid for vid in sorted_graph if vid in ancestry]
 
811
        
 
812
        for version_id in version_list:
 
813
            lines = self.get_lines(version_id)
 
814
            w.add_lines(version_id, self.get_parents(version_id), lines)
 
815
 
 
816
        for lineno, insert_id, dset, line in w.walk(version_ids):
 
817
            yield lineno, insert_id, dset, line
 
818
 
 
819
 
 
820
class _KnitComponentFile(object):
 
821
    """One of the files used to implement a knit database"""
 
822
 
 
823
    def __init__(self, transport, filename, mode):
 
824
        self._transport = transport
 
825
        self._filename = filename
 
826
        self._mode = mode
 
827
 
 
828
    def write_header(self):
 
829
        if self._transport.append(self._filename, StringIO(self.HEADER)):
 
830
            raise KnitCorrupt(self._filename, 'misaligned after writing header')
 
831
 
 
832
    def check_header(self, fp):
 
833
        line = fp.read(len(self.HEADER))
 
834
        if line != self.HEADER:
 
835
            raise KnitHeaderError(badline=line)
 
836
 
 
837
    def commit(self):
 
838
        """Commit is a nop."""
 
839
 
 
840
    def __repr__(self):
 
841
        return '%s(%s)' % (self.__class__.__name__, self._filename)
 
842
 
 
843
 
 
844
class _KnitIndex(_KnitComponentFile):
 
845
    """Manages knit index file.
 
846
 
 
847
    The index is already kept in memory and read on startup, to enable
 
848
    fast lookups of revision information.  The cursor of the index
 
849
    file is always pointing to the end, making it easy to append
 
850
    entries.
 
851
 
 
852
    _cache is a cache for fast mapping from version id to a Index
 
853
    object.
 
854
 
 
855
    _history is a cache for fast mapping from indexes to version ids.
 
856
 
 
857
    The index data format is dictionary compressed when it comes to
 
858
    parent references; a index entry may only have parents that with a
 
859
    lover index number.  As a result, the index is topological sorted.
 
860
 
 
861
    Duplicate entries may be written to the index for a single version id
 
862
    if this is done then the latter one completely replaces the former:
 
863
    this allows updates to correct version and parent information. 
 
864
    Note that the two entries may share the delta, and that successive
 
865
    annotations and references MUST point to the first entry.
 
866
    """
 
867
 
 
868
    HEADER = "# bzr knit index 7\n"
 
869
 
 
870
    # speed of knit parsing went from 280 ms to 280 ms with slots addition.
 
871
    # __slots__ = ['_cache', '_history', '_transport', '_filename']
 
872
 
 
873
    def _cache_version(self, version_id, options, pos, size, parents):
 
874
        """Cache a version record in the history array and index cache.
 
875
        
 
876
        This is inlined into __init__ for performance. KEEP IN SYNC.
 
877
        (It saves 60ms, 25% of the __init__ overhead on local 4000 record
 
878
         indexes).
 
879
        """
 
880
        # only want the _history index to reference the 1st index entry
 
881
        # for version_id
 
882
        if version_id not in self._cache:
 
883
            index = len(self._history)
 
884
            self._history.append(version_id)
 
885
        else:
 
886
            index = self._cache[version_id][5]
 
887
        self._cache[version_id] = (version_id, 
 
888
                                   options,
 
889
                                   pos,
 
890
                                   size,
 
891
                                   parents,
 
892
                                   index)
 
893
 
 
894
    def __init__(self, transport, filename, mode, create=False):
 
895
        _KnitComponentFile.__init__(self, transport, filename, mode)
 
896
        self._cache = {}
 
897
        # position in _history is the 'official' index for a revision
 
898
        # but the values may have come from a newer entry.
 
899
        # so - wc -l of a knit index is != the number of uniqe names
 
900
        # in the weave.
 
901
        self._history = []
 
902
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
903
        try:
 
904
            count = 0
 
905
            total = 1
 
906
            try:
 
907
                pb.update('read knit index', count, total)
 
908
                fp = self._transport.get(self._filename)
 
909
                self.check_header(fp)
 
910
                # readlines reads the whole file at once:
 
911
                # bad for transports like http, good for local disk
 
912
                # we save 60 ms doing this one change (
 
913
                # from calling readline each time to calling
 
914
                # readlines once.
 
915
                # probably what we want for nice behaviour on
 
916
                # http is a incremental readlines that yields, or
 
917
                # a check for local vs non local indexes,
 
918
                for l in fp.readlines():
 
919
                    rec = l.split()
 
920
                    count += 1
 
921
                    total += 1
 
922
                    #pb.update('read knit index', count, total)
 
923
                    # See self._parse_parents
 
924
                    parents = []
 
925
                    for value in rec[4:]:
 
926
                        if '.' == value[0]:
 
927
                            # uncompressed reference
 
928
                            parents.append(value[1:])
 
929
                        else:
 
930
                            # this is 15/4000ms faster than isinstance,
 
931
                            # (in lsprof)
 
932
                            # this function is called thousands of times a 
 
933
                            # second so small variations add up.
 
934
                            assert value.__class__ is str
 
935
                            parents.append(self._history[int(value)])
 
936
                    # end self._parse_parents
 
937
                    # self._cache_version(rec[0], 
 
938
                    #                     rec[1].split(','),
 
939
                    #                     int(rec[2]),
 
940
                    #                     int(rec[3]),
 
941
                    #                     parents)
 
942
                    # --- self._cache_version
 
943
                    # only want the _history index to reference the 1st 
 
944
                    # index entry for version_id
 
945
                    version_id = rec[0]
 
946
                    if version_id not in self._cache:
 
947
                        index = len(self._history)
 
948
                        self._history.append(version_id)
 
949
                    else:
 
950
                        index = self._cache[version_id][5]
 
951
                    self._cache[version_id] = (version_id,
 
952
                                               rec[1].split(','),
 
953
                                               int(rec[2]),
 
954
                                               int(rec[3]),
 
955
                                               parents,
 
956
                                               index)
 
957
                    # --- self._cache_version 
 
958
            except NoSuchFile, e:
 
959
                if mode != 'w' or not create:
 
960
                    raise
 
961
                self.write_header()
 
962
        finally:
 
963
            pb.update('read knit index', total, total)
 
964
            pb.finished()
 
965
 
 
966
    def _parse_parents(self, compressed_parents):
 
967
        """convert a list of string parent values into version ids.
 
968
 
 
969
        ints are looked up in the index.
 
970
        .FOO values are ghosts and converted in to FOO.
 
971
 
 
972
        NOTE: the function is retained here for clarity, and for possible
 
973
              use in partial index reads. However bulk processing now has
 
974
              it inlined in __init__ for inner-loop optimisation.
 
975
        """
 
976
        result = []
 
977
        for value in compressed_parents:
 
978
            if value[-1] == '.':
 
979
                # uncompressed reference
 
980
                result.append(value[1:])
 
981
            else:
 
982
                # this is 15/4000ms faster than isinstance,
 
983
                # this function is called thousands of times a 
 
984
                # second so small variations add up.
 
985
                assert value.__class__ is str
 
986
                result.append(self._history[int(value)])
 
987
        return result
 
988
 
 
989
    def get_graph(self):
 
990
        graph = []
 
991
        for version_id, index in self._cache.iteritems():
 
992
            graph.append((version_id, index[4]))
 
993
        return graph
 
994
 
 
995
    def get_ancestry(self, versions):
 
996
        """See VersionedFile.get_ancestry."""
 
997
        # get a graph of all the mentioned versions:
 
998
        graph = {}
 
999
        pending = set(versions)
 
1000
        while len(pending):
 
1001
            version = pending.pop()
 
1002
            parents = self._cache[version][4]
 
1003
            # got the parents ok
 
1004
            # trim ghosts
 
1005
            parents = [parent for parent in parents if parent in self._cache]
 
1006
            for parent in parents:
 
1007
                # if not completed and not a ghost
 
1008
                if parent not in graph:
 
1009
                    pending.add(parent)
 
1010
            graph[version] = parents
 
1011
        return topo_sort(graph.items())
 
1012
 
 
1013
    def get_ancestry_with_ghosts(self, versions):
 
1014
        """See VersionedFile.get_ancestry_with_ghosts."""
 
1015
        # get a graph of all the mentioned versions:
 
1016
        graph = {}
 
1017
        pending = set(versions)
 
1018
        while len(pending):
 
1019
            version = pending.pop()
 
1020
            try:
 
1021
                parents = self._cache[version][4]
 
1022
            except KeyError:
 
1023
                # ghost, fake it
 
1024
                graph[version] = []
 
1025
                pass
 
1026
            else:
 
1027
                # got the parents ok
 
1028
                for parent in parents:
 
1029
                    if parent not in graph:
 
1030
                        pending.add(parent)
 
1031
                graph[version] = parents
 
1032
        return topo_sort(graph.items())
 
1033
 
 
1034
    def num_versions(self):
 
1035
        return len(self._history)
 
1036
 
 
1037
    __len__ = num_versions
 
1038
 
 
1039
    def get_versions(self):
 
1040
        return self._history
 
1041
 
 
1042
    def idx_to_name(self, idx):
 
1043
        return self._history[idx]
 
1044
 
 
1045
    def lookup(self, version_id):
 
1046
        assert version_id in self._cache
 
1047
        return self._cache[version_id][5]
 
1048
 
 
1049
    def _version_list_to_index(self, versions):
 
1050
        result_list = []
 
1051
        for version in versions:
 
1052
            if version in self._cache:
 
1053
                # -- inlined lookup() --
 
1054
                result_list.append(str(self._cache[version][5]))
 
1055
                # -- end lookup () --
 
1056
            else:
 
1057
                result_list.append('.' + version.encode('utf-8'))
 
1058
        return ' '.join(result_list)
 
1059
 
 
1060
    def add_version(self, version_id, options, pos, size, parents):
 
1061
        """Add a version record to the index."""
 
1062
        self._cache_version(version_id, options, pos, size, parents)
 
1063
 
 
1064
        content = "%s %s %s %s %s\n" % (version_id.encode('utf-8'),
 
1065
                                        ','.join(options),
 
1066
                                        pos,
 
1067
                                        size,
 
1068
                                        self._version_list_to_index(parents))
 
1069
        assert isinstance(content, str), 'content must be utf-8 encoded'
 
1070
        self._transport.append(self._filename, StringIO(content))
 
1071
 
 
1072
    def has_version(self, version_id):
 
1073
        """True if the version is in the index."""
 
1074
        return self._cache.has_key(version_id)
 
1075
 
 
1076
    def get_position(self, version_id):
 
1077
        """Return data position and size of specified version."""
 
1078
        return (self._cache[version_id][2], \
 
1079
                self._cache[version_id][3])
 
1080
 
 
1081
    def get_method(self, version_id):
 
1082
        """Return compression method of specified version."""
 
1083
        options = self._cache[version_id][1]
 
1084
        if 'fulltext' in options:
 
1085
            return 'fulltext'
 
1086
        else:
 
1087
            assert 'line-delta' in options
 
1088
            return 'line-delta'
 
1089
 
 
1090
    def get_options(self, version_id):
 
1091
        return self._cache[version_id][1]
 
1092
 
 
1093
    def get_parents(self, version_id):
 
1094
        """Return parents of specified version ignoring ghosts."""
 
1095
        return [parent for parent in self._cache[version_id][4] 
 
1096
                if parent in self._cache]
 
1097
 
 
1098
    def get_parents_with_ghosts(self, version_id):
 
1099
        """Return parents of specified version wth ghosts."""
 
1100
        return self._cache[version_id][4] 
 
1101
 
 
1102
    def check_versions_present(self, version_ids):
 
1103
        """Check that all specified versions are present."""
 
1104
        version_ids = set(version_ids)
 
1105
        for version_id in list(version_ids):
 
1106
            if version_id in self._cache:
 
1107
                version_ids.remove(version_id)
 
1108
        if version_ids:
 
1109
            raise RevisionNotPresent(list(version_ids)[0], self.filename)
 
1110
 
 
1111
 
 
1112
class _KnitData(_KnitComponentFile):
 
1113
    """Contents of the knit data file"""
 
1114
 
 
1115
    HEADER = "# bzr knit data 7\n"
 
1116
 
 
1117
    def __init__(self, transport, filename, mode, create=False):
 
1118
        _KnitComponentFile.__init__(self, transport, filename, mode)
 
1119
        self._file = None
 
1120
        self._checked = False
 
1121
        if create:
 
1122
            self._transport.put(self._filename, StringIO(''))
 
1123
        self._records = {}
 
1124
 
 
1125
    def clear_cache(self):
 
1126
        """Clear the record cache."""
 
1127
        self._records = {}
 
1128
 
 
1129
    def _open_file(self):
 
1130
        if self._file is None:
 
1131
            try:
 
1132
                self._file = self._transport.get(self._filename)
 
1133
            except NoSuchFile:
 
1134
                pass
 
1135
        return self._file
 
1136
 
 
1137
    def _record_to_data(self, version_id, digest, lines):
 
1138
        """Convert version_id, digest, lines into a raw data block.
 
1139
        
 
1140
        :return: (len, a StringIO instance with the raw data ready to read.)
 
1141
        """
 
1142
        sio = StringIO()
 
1143
        data_file = GzipFile(None, mode='wb', fileobj=sio)
 
1144
        data_file.writelines(chain(
 
1145
            ["version %s %d %s\n" % (version_id.encode('utf-8'), 
 
1146
                                     len(lines),
 
1147
                                     digest)],
 
1148
            lines,
 
1149
            ["end %s\n" % version_id.encode('utf-8')]))
 
1150
        data_file.close()
 
1151
        length= sio.tell()
 
1152
 
 
1153
        sio.seek(0)
 
1154
        return length, sio
 
1155
 
 
1156
    def add_raw_record(self, raw_data):
 
1157
        """Append a prepared record to the data file."""
 
1158
        assert isinstance(raw_data, str), 'data must be plain bytes'
 
1159
        start_pos = self._transport.append(self._filename, StringIO(raw_data))
 
1160
        return start_pos, len(raw_data)
 
1161
        
 
1162
    def add_record(self, version_id, digest, lines):
 
1163
        """Write new text record to disk.  Returns the position in the
 
1164
        file where it was written."""
 
1165
        size, sio = self._record_to_data(version_id, digest, lines)
 
1166
        # cache
 
1167
        self._records[version_id] = (digest, lines)
 
1168
        # write to disk
 
1169
        start_pos = self._transport.append(self._filename, sio)
 
1170
        return start_pos, size
 
1171
 
 
1172
    def _parse_record_header(self, version_id, raw_data):
 
1173
        """Parse a record header for consistency.
 
1174
 
 
1175
        :return: the header and the decompressor stream.
 
1176
                 as (stream, header_record)
 
1177
        """
 
1178
        df = GzipFile(mode='rb', fileobj=StringIO(raw_data))
 
1179
        rec = df.readline().split()
 
1180
        if len(rec) != 4:
 
1181
            raise KnitCorrupt(self._filename, 'unexpected number of elements in record header')
 
1182
        if rec[1].decode('utf-8')!= version_id:
 
1183
            raise KnitCorrupt(self._filename, 
 
1184
                              'unexpected version, wanted %r, got %r' % (
 
1185
                                version_id, rec[1]))
 
1186
        return df, rec
 
1187
 
 
1188
    def _parse_record(self, version_id, data):
 
1189
        # profiling notes:
 
1190
        # 4168 calls in 2880 217 internal
 
1191
        # 4168 calls to _parse_record_header in 2121
 
1192
        # 4168 calls to readlines in 330
 
1193
        df, rec = self._parse_record_header(version_id, data)
 
1194
        record_contents = df.readlines()
 
1195
        l = record_contents.pop()
 
1196
        assert len(record_contents) == int(rec[2])
 
1197
        if l.decode('utf-8') != 'end %s\n' % version_id:
 
1198
            raise KnitCorrupt(self._filename, 'unexpected version end line %r, wanted %r' 
 
1199
                        % (l, version_id))
 
1200
        df.close()
 
1201
        return record_contents, rec[3]
 
1202
 
 
1203
    def read_records_iter_raw(self, records):
 
1204
        """Read text records from data file and yield raw data.
 
1205
 
 
1206
        This unpacks enough of the text record to validate the id is
 
1207
        as expected but thats all.
 
1208
 
 
1209
        It will actively recompress currently cached records on the
 
1210
        basis that that is cheaper than I/O activity.
 
1211
        """
 
1212
        needed_records = []
 
1213
        for version_id, pos, size in records:
 
1214
            if version_id not in self._records:
 
1215
                needed_records.append((version_id, pos, size))
 
1216
 
 
1217
        # setup an iterator of the external records:
 
1218
        # uses readv so nice and fast we hope.
 
1219
        if len(needed_records):
 
1220
            # grab the disk data needed.
 
1221
            raw_records = self._transport.readv(self._filename,
 
1222
                [(pos, size) for version_id, pos, size in needed_records])
 
1223
 
 
1224
        for version_id, pos, size in records:
 
1225
            if version_id in self._records:
 
1226
                # compress a new version
 
1227
                size, sio = self._record_to_data(version_id,
 
1228
                                                 self._records[version_id][0],
 
1229
                                                 self._records[version_id][1])
 
1230
                yield version_id, sio.getvalue()
 
1231
            else:
 
1232
                pos, data = raw_records.next()
 
1233
                # validate the header
 
1234
                df, rec = self._parse_record_header(version_id, data)
 
1235
                df.close()
 
1236
                yield version_id, data
 
1237
 
 
1238
 
 
1239
    def read_records_iter(self, records):
 
1240
        """Read text records from data file and yield result.
 
1241
 
 
1242
        Each passed record is a tuple of (version_id, pos, len) and
 
1243
        will be read in the given order.  Yields (version_id,
 
1244
        contents, digest).
 
1245
        """
 
1246
        # profiling notes:
 
1247
        # 60890  calls for 4168 extractions in 5045, 683 internal.
 
1248
        # 4168   calls to readv              in 1411
 
1249
        # 4168   calls to parse_record       in 2880
 
1250
 
 
1251
        needed_records = []
 
1252
        for version_id, pos, size in records:
 
1253
            if version_id not in self._records:
 
1254
                needed_records.append((version_id, pos, size))
 
1255
 
 
1256
        if len(needed_records):
 
1257
            # We take it that the transport optimizes the fetching as good
 
1258
            # as possible (ie, reads continous ranges.)
 
1259
            response = self._transport.readv(self._filename,
 
1260
                [(pos, size) for version_id, pos, size in needed_records])
 
1261
 
 
1262
            for (record_id, pos, size), (pos, data) in izip(iter(needed_records), response):
 
1263
                content, digest = self._parse_record(record_id, data)
 
1264
                self._records[record_id] = (digest, content)
 
1265
    
 
1266
        for version_id, pos, size in records:
 
1267
            yield version_id, list(self._records[version_id][1]), self._records[version_id][0]
 
1268
 
 
1269
    def read_records(self, records):
 
1270
        """Read records into a dictionary."""
 
1271
        components = {}
 
1272
        for record_id, content, digest in self.read_records_iter(records):
 
1273
            components[record_id] = (content, digest)
 
1274
        return components
 
1275
 
 
1276
 
 
1277
class InterKnit(InterVersionedFile):
 
1278
    """Optimised code paths for knit to knit operations."""
 
1279
    
 
1280
    _matching_file_factory = KnitVersionedFile
 
1281
    
 
1282
    @staticmethod
 
1283
    def is_compatible(source, target):
 
1284
        """Be compatible with knits.  """
 
1285
        try:
 
1286
            return (isinstance(source, KnitVersionedFile) and
 
1287
                    isinstance(target, KnitVersionedFile))
 
1288
        except AttributeError:
 
1289
            return False
 
1290
 
 
1291
    def join(self, pb=None, msg=None, version_ids=None, ignore_missing=False):
 
1292
        """See InterVersionedFile.join."""
 
1293
        assert isinstance(self.source, KnitVersionedFile)
 
1294
        assert isinstance(self.target, KnitVersionedFile)
 
1295
 
 
1296
        if version_ids is None:
 
1297
            version_ids = self.source.versions()
 
1298
        else:
 
1299
            if not ignore_missing:
 
1300
                self.source._check_versions_present(version_ids)
 
1301
            else:
 
1302
                version_ids = set(self.source.versions()).intersection(
 
1303
                    set(version_ids))
 
1304
 
 
1305
        if not version_ids:
 
1306
            return 0
 
1307
 
 
1308
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1309
        try:
 
1310
            version_ids = list(version_ids)
 
1311
            if None in version_ids:
 
1312
                version_ids.remove(None)
 
1313
    
 
1314
            self.source_ancestry = set(self.source.get_ancestry(version_ids))
 
1315
            this_versions = set(self.target._index.get_versions())
 
1316
            needed_versions = self.source_ancestry - this_versions
 
1317
            cross_check_versions = self.source_ancestry.intersection(this_versions)
 
1318
            mismatched_versions = set()
 
1319
            for version in cross_check_versions:
 
1320
                # scan to include needed parents.
 
1321
                n1 = set(self.target.get_parents_with_ghosts(version))
 
1322
                n2 = set(self.source.get_parents_with_ghosts(version))
 
1323
                if n1 != n2:
 
1324
                    # FIXME TEST this check for cycles being introduced works
 
1325
                    # the logic is we have a cycle if in our graph we are an
 
1326
                    # ancestor of any of the n2 revisions.
 
1327
                    for parent in n2:
 
1328
                        if parent in n1:
 
1329
                            # safe
 
1330
                            continue
 
1331
                        else:
 
1332
                            parent_ancestors = self.source.get_ancestry(parent)
 
1333
                            if version in parent_ancestors:
 
1334
                                raise errors.GraphCycleError([parent, version])
 
1335
                    # ensure this parent will be available later.
 
1336
                    new_parents = n2.difference(n1)
 
1337
                    needed_versions.update(new_parents.difference(this_versions))
 
1338
                    mismatched_versions.add(version)
 
1339
    
 
1340
            if not needed_versions and not cross_check_versions:
 
1341
                return 0
 
1342
            full_list = topo_sort(self.source.get_graph())
 
1343
    
 
1344
            version_list = [i for i in full_list if (not self.target.has_version(i)
 
1345
                            and i in needed_versions)]
 
1346
    
 
1347
            # plan the join:
 
1348
            copy_queue = []
 
1349
            copy_queue_records = []
 
1350
            copy_set = set()
 
1351
            for version_id in version_list:
 
1352
                options = self.source._index.get_options(version_id)
 
1353
                parents = self.source._index.get_parents_with_ghosts(version_id)
 
1354
                # check that its will be a consistent copy:
 
1355
                for parent in parents:
 
1356
                    # if source has the parent, we must :
 
1357
                    # * already have it or
 
1358
                    # * have it scheduled already
 
1359
                    # otherwise we dont care
 
1360
                    assert (self.target.has_version(parent) or
 
1361
                            parent in copy_set or
 
1362
                            not self.source.has_version(parent))
 
1363
                data_pos, data_size = self.source._index.get_position(version_id)
 
1364
                copy_queue_records.append((version_id, data_pos, data_size))
 
1365
                copy_queue.append((version_id, options, parents))
 
1366
                copy_set.add(version_id)
 
1367
 
 
1368
            # data suck the join:
 
1369
            count = 0
 
1370
            total = len(version_list)
 
1371
            # we want the raw gzip for bulk copying, but the record validated
 
1372
            # just enough to be sure its the right one.
 
1373
            # TODO: consider writev or write combining to reduce 
 
1374
            # death of a thousand cuts feeling.
 
1375
            for (version_id, raw_data), \
 
1376
                (version_id2, options, parents) in \
 
1377
                izip(self.source._data.read_records_iter_raw(copy_queue_records),
 
1378
                     copy_queue):
 
1379
                assert version_id == version_id2, 'logic error, inconsistent results'
 
1380
                count = count + 1
 
1381
                pb.update("Joining knit", count, total)
 
1382
                pos, size = self.target._data.add_raw_record(raw_data)
 
1383
                self.target._index.add_version(version_id, options, pos, size, parents)
 
1384
 
 
1385
            for version in mismatched_versions:
 
1386
                # FIXME RBC 20060309 is this needed?
 
1387
                n1 = set(self.target.get_parents_with_ghosts(version))
 
1388
                n2 = set(self.source.get_parents_with_ghosts(version))
 
1389
                # write a combined record to our history preserving the current 
 
1390
                # parents as first in the list
 
1391
                new_parents = self.target.get_parents_with_ghosts(version) + list(n2.difference(n1))
 
1392
                self.target.fix_parents(version, new_parents)
 
1393
            return count
 
1394
        finally:
 
1395
            pb.finished()
 
1396
 
 
1397
 
 
1398
InterVersionedFile.register_optimiser(InterKnit)
 
1399
 
 
1400
 
 
1401
# make GzipFile faster:
 
1402
import struct
 
1403
import zlib
 
1404
from gzip import U32, LOWU32, FEXTRA, FCOMMENT, FNAME, FHCRC
 
1405
class GzipFile(gzip.GzipFile):
 
1406
    """Knit tuned version of GzipFile.
 
1407
 
 
1408
    This is based on the following lsprof stats:
 
1409
    python 2.4 stock GzipFile write:
 
1410
    58971      0   5644.3090   2721.4730   gzip:193(write)
 
1411
    +58971     0   1159.5530   1159.5530   +<built-in method compress>
 
1412
    +176913    0    987.0320    987.0320   +<len>
 
1413
    +58971     0    423.1450    423.1450   +<zlib.crc32>
 
1414
    +58971     0    353.1060    353.1060   +<method 'write' of 'cStringIO.
 
1415
                                            StringO' objects>
 
1416
    tuned GzipFile write:
 
1417
    58971      0   4477.2590   2103.1120   bzrlib.knit:1250(write)
 
1418
    +58971     0   1297.7620   1297.7620   +<built-in method compress>
 
1419
    +58971     0    406.2160    406.2160   +<zlib.crc32>
 
1420
    +58971     0    341.9020    341.9020   +<method 'write' of 'cStringIO.
 
1421
                                            StringO' objects>
 
1422
    +58971     0    328.2670    328.2670   +<len>
 
1423
 
 
1424
 
 
1425
    Yes, its only 1.6 seconds, but they add up.
 
1426
    """
 
1427
 
 
1428
    def _add_read_data(self, data):
 
1429
        # 4169 calls in 183
 
1430
        # temp var for len(data) and switch to +='s.
 
1431
        # 4169 in 139
 
1432
        len_data = len(data)
 
1433
        self.crc = zlib.crc32(data, self.crc)
 
1434
        self.extrabuf += data
 
1435
        self.extrasize += len_data
 
1436
        self.size += len_data
 
1437
 
 
1438
    def _read(self, size=1024):
 
1439
        # various optimisations:
 
1440
        # reduces lsprof count from 2500 to 
 
1441
        # 8337 calls in 1272, 365 internal
 
1442
        if self.fileobj is None:
 
1443
            raise EOFError, "Reached EOF"
 
1444
 
 
1445
        if self._new_member:
 
1446
            # If the _new_member flag is set, we have to
 
1447
            # jump to the next member, if there is one.
 
1448
            #
 
1449
            # First, check if we're at the end of the file;
 
1450
            # if so, it's time to stop; no more members to read.
 
1451
            next_header_bytes = self.fileobj.read(10)
 
1452
            if next_header_bytes == '':
 
1453
                raise EOFError, "Reached EOF"
 
1454
 
 
1455
            self._init_read()
 
1456
            self._read_gzip_header(next_header_bytes)
 
1457
            self.decompress = zlib.decompressobj(-zlib.MAX_WBITS)
 
1458
            self._new_member = False
 
1459
 
 
1460
        # Read a chunk of data from the file
 
1461
        buf = self.fileobj.read(size)
 
1462
 
 
1463
        # If the EOF has been reached, flush the decompression object
 
1464
        # and mark this object as finished.
 
1465
 
 
1466
        if buf == "":
 
1467
            self._add_read_data(self.decompress.flush())
 
1468
            assert len(self.decompress.unused_data) >= 8, "what does flush do?"
 
1469
            self._read_eof()
 
1470
            # tell the driving read() call we have stuffed all the data
 
1471
            # in self.extrabuf
 
1472
            raise EOFError, 'Reached EOF'
 
1473
 
 
1474
        self._add_read_data(self.decompress.decompress(buf))
 
1475
 
 
1476
        if self.decompress.unused_data != "":
 
1477
            # Ending case: we've come to the end of a member in the file,
 
1478
            # so seek back to the start of the data for the next member which
 
1479
            # is the length of the decompress objects unused data - the first
 
1480
            # 8 bytes for the end crc and size records.
 
1481
            #
 
1482
            # so seek back to the start of the unused data, finish up
 
1483
            # this member, and read a new gzip header.
 
1484
            # (The number of bytes to seek back is the length of the unused
 
1485
            # data, minus 8 because those 8 bytes are part of this member.
 
1486
            seek_length = len (self.decompress.unused_data) - 8
 
1487
            if seek_length:
 
1488
                assert seek_length > 0
 
1489
                self.fileobj.seek(-seek_length, 1)
 
1490
 
 
1491
            # Check the CRC and file size, and set the flag so we read
 
1492
            # a new member on the next call
 
1493
            self._read_eof()
 
1494
            self._new_member = True
 
1495
 
 
1496
    def _read_eof(self):
 
1497
        """tuned to reduce function calls and eliminate file seeking:
 
1498
        pass 1:
 
1499
        reduces lsprof count from 800 to 288
 
1500
        4168 in 296 
 
1501
        avoid U32 call by using struct format L
 
1502
        4168 in 200
 
1503
        """
 
1504
        # We've read to the end of the file, so we should have 8 bytes of 
 
1505
        # unused data in the decompressor. If we dont, there is a corrupt file.
 
1506
        # We use these 8 bytes to calculate the CRC and the recorded file size.
 
1507
        # We then check the that the computed CRC and size of the
 
1508
        # uncompressed data matches the stored values.  Note that the size
 
1509
        # stored is the true file size mod 2**32.
 
1510
        crc32, isize = struct.unpack("<LL", self.decompress.unused_data[0:8])
 
1511
        # note that isize is unsigned - it can exceed 2GB
 
1512
        if crc32 != U32(self.crc):
 
1513
            raise IOError, "CRC check failed"
 
1514
        elif isize != LOWU32(self.size):
 
1515
            raise IOError, "Incorrect length of data produced"
 
1516
 
 
1517
    def _read_gzip_header(self, bytes=None):
 
1518
        """Supply bytes if the minimum header size is already read.
 
1519
        
 
1520
        :param bytes: 10 bytes of header data.
 
1521
        """
 
1522
        """starting cost: 300 in 3998
 
1523
        15998 reads from 3998 calls
 
1524
        final cost 168
 
1525
        """
 
1526
        if bytes is None:
 
1527
            bytes = self.fileobj.read(10)
 
1528
        magic = bytes[0:2]
 
1529
        if magic != '\037\213':
 
1530
            raise IOError, 'Not a gzipped file'
 
1531
        method = ord(bytes[2:3])
 
1532
        if method != 8:
 
1533
            raise IOError, 'Unknown compression method'
 
1534
        flag = ord(bytes[3:4])
 
1535
        # modtime = self.fileobj.read(4) (bytes [4:8])
 
1536
        # extraflag = self.fileobj.read(1) (bytes[8:9])
 
1537
        # os = self.fileobj.read(1) (bytes[9:10])
 
1538
        # self.fileobj.read(6)
 
1539
 
 
1540
        if flag & FEXTRA:
 
1541
            # Read & discard the extra field, if present
 
1542
            xlen = ord(self.fileobj.read(1))
 
1543
            xlen = xlen + 256*ord(self.fileobj.read(1))
 
1544
            self.fileobj.read(xlen)
 
1545
        if flag & FNAME:
 
1546
            # Read and discard a null-terminated string containing the filename
 
1547
            while True:
 
1548
                s = self.fileobj.read(1)
 
1549
                if not s or s=='\000':
 
1550
                    break
 
1551
        if flag & FCOMMENT:
 
1552
            # Read and discard a null-terminated string containing a comment
 
1553
            while True:
 
1554
                s = self.fileobj.read(1)
 
1555
                if not s or s=='\000':
 
1556
                    break
 
1557
        if flag & FHCRC:
 
1558
            self.fileobj.read(2)     # Read & discard the 16-bit header CRC
 
1559
 
 
1560
    def readline(self, size=-1):
 
1561
        """Tuned to remove buffer length calls in _unread and...
 
1562
        
 
1563
        also removes multiple len(c) calls, inlines _unread,
 
1564
        total savings - lsprof 5800 to 5300
 
1565
        phase 2:
 
1566
        4168 calls in 2233
 
1567
        8176 calls to read() in 1684
 
1568
        changing the min chunk size to 200 halved all the cache misses
 
1569
        leading to a drop to:
 
1570
        4168 calls in 1977
 
1571
        4168 call to read() in 1646
 
1572
        - i.e. just reduced the function call overhead. May be worth 
 
1573
          keeping.
 
1574
        """
 
1575
        if size < 0: size = sys.maxint
 
1576
        bufs = []
 
1577
        readsize = min(200, size)    # Read from the file in small chunks
 
1578
        while True:
 
1579
            if size == 0:
 
1580
                return "".join(bufs) # Return resulting line
 
1581
 
 
1582
            # c is the chunk
 
1583
            c = self.read(readsize)
 
1584
            # number of bytes read
 
1585
            len_c = len(c)
 
1586
            i = c.find('\n')
 
1587
            if size is not None:
 
1588
                # We set i=size to break out of the loop under two
 
1589
                # conditions: 1) there's no newline, and the chunk is
 
1590
                # larger than size, or 2) there is a newline, but the
 
1591
                # resulting line would be longer than 'size'.
 
1592
                if i==-1 and len_c > size: i=size-1
 
1593
                elif size <= i: i = size -1
 
1594
 
 
1595
            if i >= 0 or c == '':
 
1596
                # if i>= 0 we have a newline or have triggered the above
 
1597
                # if size is not None condition.
 
1598
                # if c == '' its EOF.
 
1599
                bufs.append(c[:i+1])    # Add portion of last chunk
 
1600
                # -- inlined self._unread --
 
1601
                ## self._unread(c[i+1:], len_c - i)   # Push back rest of chunk
 
1602
                self.extrabuf = c[i+1:] + self.extrabuf
 
1603
                self.extrasize = len_c - i + self.extrasize
 
1604
                self.offset -= len_c - i
 
1605
                # -- end inlined self._unread --
 
1606
                return ''.join(bufs)    # Return resulting line
 
1607
 
 
1608
            # Append chunk to list, decrease 'size',
 
1609
            bufs.append(c)
 
1610
            size = size - len_c
 
1611
            readsize = min(size, readsize * 2)
 
1612
 
 
1613
    def readlines(self, sizehint=0):
 
1614
        # optimise to avoid all the buffer manipulation
 
1615
        # lsprof changed from:
 
1616
        # 4168 calls in 5472 with 32000 calls to readline()
 
1617
        # to :
 
1618
        # 4168 calls in 417.
 
1619
        # Negative numbers result in reading all the lines
 
1620
        if sizehint <= 0:
 
1621
            sizehint = -1
 
1622
        content = self.read(sizehint)
 
1623
        return content.splitlines(True)
 
1624
 
 
1625
    def _unread(self, buf, len_buf=None):
 
1626
        """tuned to remove unneeded len calls.
 
1627
        
 
1628
        because this is such an inner routine in readline, and readline is
 
1629
        in many inner loops, this has been inlined into readline().
 
1630
 
 
1631
        The len_buf parameter combined with the reduction in len calls dropped
 
1632
        the lsprof ms count for this routine on my test data from 800 to 200 - 
 
1633
        a 75% saving.
 
1634
        """
 
1635
        if len_buf is None:
 
1636
            len_buf = len(buf)
 
1637
        self.extrabuf = buf + self.extrabuf
 
1638
        self.extrasize = len_buf + self.extrasize
 
1639
        self.offset -= len_buf
 
1640
 
 
1641
    def write(self, data):
 
1642
        if self.mode != gzip.WRITE:
 
1643
            import errno
 
1644
            raise IOError(errno.EBADF, "write() on read-only GzipFile object")
 
1645
 
 
1646
        if self.fileobj is None:
 
1647
            raise ValueError, "write() on closed GzipFile object"
 
1648
        data_len = len(data)
 
1649
        if data_len > 0:
 
1650
            self.size = self.size + data_len
 
1651
            self.crc = zlib.crc32(data, self.crc)
 
1652
            self.fileobj.write( self.compress.compress(data) )
 
1653
            self.offset += data_len
 
1654
 
 
1655
    def writelines(self, lines):
 
1656
        # profiling indicated a significant overhead 
 
1657
        # calling write for each line.
 
1658
        # this batch call is a lot faster :).
 
1659
        # (4 seconds to 1 seconds for the sample upgrades I was testing).
 
1660
        self.write(''.join(lines))
 
1661
 
 
1662
 
 
1663
class SequenceMatcher(difflib.SequenceMatcher):
 
1664
    """Knit tuned sequence matcher.
 
1665
 
 
1666
    This is based on profiling of difflib which indicated some improvements
 
1667
    for our usage pattern.
 
1668
    """
 
1669
 
 
1670
    def find_longest_match(self, alo, ahi, blo, bhi):
 
1671
        """Find longest matching block in a[alo:ahi] and b[blo:bhi].
 
1672
 
 
1673
        If isjunk is not defined:
 
1674
 
 
1675
        Return (i,j,k) such that a[i:i+k] is equal to b[j:j+k], where
 
1676
            alo <= i <= i+k <= ahi
 
1677
            blo <= j <= j+k <= bhi
 
1678
        and for all (i',j',k') meeting those conditions,
 
1679
            k >= k'
 
1680
            i <= i'
 
1681
            and if i == i', j <= j'
 
1682
 
 
1683
        In other words, of all maximal matching blocks, return one that
 
1684
        starts earliest in a, and of all those maximal matching blocks that
 
1685
        start earliest in a, return the one that starts earliest in b.
 
1686
 
 
1687
        >>> s = SequenceMatcher(None, " abcd", "abcd abcd")
 
1688
        >>> s.find_longest_match(0, 5, 0, 9)
 
1689
        (0, 4, 5)
 
1690
 
 
1691
        If isjunk is defined, first the longest matching block is
 
1692
        determined as above, but with the additional restriction that no
 
1693
        junk element appears in the block.  Then that block is extended as
 
1694
        far as possible by matching (only) junk elements on both sides.  So
 
1695
        the resulting block never matches on junk except as identical junk
 
1696
        happens to be adjacent to an "interesting" match.
 
1697
 
 
1698
        Here's the same example as before, but considering blanks to be
 
1699
        junk.  That prevents " abcd" from matching the " abcd" at the tail
 
1700
        end of the second sequence directly.  Instead only the "abcd" can
 
1701
        match, and matches the leftmost "abcd" in the second sequence:
 
1702
 
 
1703
        >>> s = SequenceMatcher(lambda x: x==" ", " abcd", "abcd abcd")
 
1704
        >>> s.find_longest_match(0, 5, 0, 9)
 
1705
        (1, 0, 4)
 
1706
 
 
1707
        If no blocks match, return (alo, blo, 0).
 
1708
 
 
1709
        >>> s = SequenceMatcher(None, "ab", "c")
 
1710
        >>> s.find_longest_match(0, 2, 0, 1)
 
1711
        (0, 0, 0)
 
1712
        """
 
1713
 
 
1714
        # CAUTION:  stripping common prefix or suffix would be incorrect.
 
1715
        # E.g.,
 
1716
        #    ab
 
1717
        #    acab
 
1718
        # Longest matching block is "ab", but if common prefix is
 
1719
        # stripped, it's "a" (tied with "b").  UNIX(tm) diff does so
 
1720
        # strip, so ends up claiming that ab is changed to acab by
 
1721
        # inserting "ca" in the middle.  That's minimal but unintuitive:
 
1722
        # "it's obvious" that someone inserted "ac" at the front.
 
1723
        # Windiff ends up at the same place as diff, but by pairing up
 
1724
        # the unique 'b's and then matching the first two 'a's.
 
1725
 
 
1726
        a, b, b2j, isbjunk = self.a, self.b, self.b2j, self.isbjunk
 
1727
        besti, bestj, bestsize = alo, blo, 0
 
1728
        # find longest junk-free match
 
1729
        # during an iteration of the loop, j2len[j] = length of longest
 
1730
        # junk-free match ending with a[i-1] and b[j]
 
1731
        j2len = {}
 
1732
        # nothing = []
 
1733
        b2jget = b2j.get
 
1734
        for i in xrange(alo, ahi):
 
1735
            # look at all instances of a[i] in b; note that because
 
1736
            # b2j has no junk keys, the loop is skipped if a[i] is junk
 
1737
            j2lenget = j2len.get
 
1738
            newj2len = {}
 
1739
            
 
1740
            # changing b2j.get(a[i], nothing) to a try:Keyerror pair produced the
 
1741
            # following improvement
 
1742
            #     704  0   4650.5320   2620.7410   bzrlib.knit:1336(find_longest_match)
 
1743
            # +326674  0   1655.1210   1655.1210   +<method 'get' of 'dict' objects>
 
1744
            #  +76519  0    374.6700    374.6700   +<method 'has_key' of 'dict' objects>
 
1745
            # to 
 
1746
            #     704  0   3733.2820   2209.6520   bzrlib.knit:1336(find_longest_match)
 
1747
            #  +211400 0   1147.3520   1147.3520   +<method 'get' of 'dict' objects>
 
1748
            #  +76519  0    376.2780    376.2780   +<method 'has_key' of 'dict' objects>
 
1749
 
 
1750
            try:
 
1751
                js = b2j[a[i]]
 
1752
            except KeyError:
 
1753
                pass
 
1754
            else:
 
1755
                for j in js:
 
1756
                    # a[i] matches b[j]
 
1757
                    if j >= blo:
 
1758
                        if j >= bhi:
 
1759
                            break
 
1760
                        k = newj2len[j] = 1 + j2lenget(-1 + j, 0)
 
1761
                        if k > bestsize:
 
1762
                            besti, bestj, bestsize = 1 + i-k, 1 + j-k, k
 
1763
            j2len = newj2len
 
1764
 
 
1765
        # Extend the best by non-junk elements on each end.  In particular,
 
1766
        # "popular" non-junk elements aren't in b2j, which greatly speeds
 
1767
        # the inner loop above, but also means "the best" match so far
 
1768
        # doesn't contain any junk *or* popular non-junk elements.
 
1769
        while besti > alo and bestj > blo and \
 
1770
              not isbjunk(b[bestj-1]) and \
 
1771
              a[besti-1] == b[bestj-1]:
 
1772
            besti, bestj, bestsize = besti-1, bestj-1, bestsize+1
 
1773
        while besti+bestsize < ahi and bestj+bestsize < bhi and \
 
1774
              not isbjunk(b[bestj+bestsize]) and \
 
1775
              a[besti+bestsize] == b[bestj+bestsize]:
 
1776
            bestsize += 1
 
1777
 
 
1778
        # Now that we have a wholly interesting match (albeit possibly
 
1779
        # empty!), we may as well suck up the matching junk on each
 
1780
        # side of it too.  Can't think of a good reason not to, and it
 
1781
        # saves post-processing the (possibly considerable) expense of
 
1782
        # figuring out what to do with it.  In the case of an empty
 
1783
        # interesting match, this is clearly the right thing to do,
 
1784
        # because no other kind of match is possible in the regions.
 
1785
        while besti > alo and bestj > blo and \
 
1786
              isbjunk(b[bestj-1]) and \
 
1787
              a[besti-1] == b[bestj-1]:
 
1788
            besti, bestj, bestsize = besti-1, bestj-1, bestsize+1
 
1789
        while besti+bestsize < ahi and bestj+bestsize < bhi and \
 
1790
              isbjunk(b[bestj+bestsize]) and \
 
1791
              a[besti+bestsize] == b[bestj+bestsize]:
 
1792
            bestsize = bestsize + 1
 
1793
 
 
1794
        return besti, bestj, bestsize
 
1795