/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: Aaron Bentley
  • Date: 2006-04-18 23:42:34 UTC
  • mto: This revision was merged to the branch mainline in revision 1672.
  • Revision ID: aaron.bentley@utoronto.ca-20060418234234-d3d230b99ba70b9f
Ported weave merge test to versionedfile

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
from itertools import izip, chain
 
70
import os
 
71
import sys
 
72
 
 
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
 
 
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
    def plan_merge(self, ver_a, ver_b):
 
820
        ancestors_b = set(self.get_ancestry(ver_b))
 
821
        def status_a(revision, text):
 
822
            if revision in ancestors_b:
 
823
                return 'killed-b', text
 
824
            else:
 
825
                return 'new-a', text
 
826
        
 
827
        ancestors_a = set(self.get_ancestry(ver_a))
 
828
        def status_b(revision, text):
 
829
            if revision in ancestors_a:
 
830
                return 'killed-a', text
 
831
            else:
 
832
                return 'new-b', text
 
833
 
 
834
        annotated_a = self.annotate(ver_a)
 
835
        annotated_b = self.annotate(ver_b)
 
836
        plain_a = [t for a, t in annotated_a]
 
837
        plain_b = [t for a, t in annotated_b]
 
838
        blocks = SequenceMatcher(None, plain_a, plain_b).get_matching_blocks()
 
839
        a_cur = 0
 
840
        b_cur = 0
 
841
        a_iter = iter(annotated_a)
 
842
        b_iter = iter(annotated_b)
 
843
        for ai, bi, l in blocks:
 
844
            for a_num, (revision, text) in xenumerate(a_iter, ai, a_cur):
 
845
                yield status_a(revision, text)
 
846
            for b_num, (revision, text) in xenumerate(b_iter, bi, b_cur):
 
847
                yield status_b(revision, text)
 
848
            for num, ((revision_a, text_a), (revision_b, text_b)) in \
 
849
                xenumerate(izip(a_iter, b_iter), l):
 
850
                assert text_a == text_b
 
851
                yield "unchanged", text_a
 
852
            a_cur = ai + l
 
853
            b_cur = bi + l
 
854
        # handle a final conflicting region
 
855
        for a_num, (revision, text) in xenumerate(a_iter, start=a_cur):
 
856
            yield status_a(revision, text)
 
857
        for b_num, (revision, text) in xenumerate(b_iter, start=b_cur):
 
858
            yield status_b(revision, text)
 
859
 
 
860
def xenumerate(iter, stop=None, start=0, step=1):
 
861
    count = start
 
862
    if start == stop:
 
863
        return
 
864
    for result in iter:
 
865
        yield count, result
 
866
        count += step
 
867
        if count == stop:
 
868
            return
 
869
 
 
870
 
 
871
class _KnitComponentFile(object):
 
872
    """One of the files used to implement a knit database"""
 
873
 
 
874
    def __init__(self, transport, filename, mode):
 
875
        self._transport = transport
 
876
        self._filename = filename
 
877
        self._mode = mode
 
878
 
 
879
    def write_header(self):
 
880
        if self._transport.append(self._filename, StringIO(self.HEADER)):
 
881
            raise KnitCorrupt(self._filename, 'misaligned after writing header')
 
882
 
 
883
    def check_header(self, fp):
 
884
        line = fp.readline()
 
885
        if line != self.HEADER:
 
886
            raise KnitHeaderError(badline=line)
 
887
 
 
888
    def commit(self):
 
889
        """Commit is a nop."""
 
890
 
 
891
    def __repr__(self):
 
892
        return '%s(%s)' % (self.__class__.__name__, self._filename)
 
893
 
 
894
 
 
895
class _KnitIndex(_KnitComponentFile):
 
896
    """Manages knit index file.
 
897
 
 
898
    The index is already kept in memory and read on startup, to enable
 
899
    fast lookups of revision information.  The cursor of the index
 
900
    file is always pointing to the end, making it easy to append
 
901
    entries.
 
902
 
 
903
    _cache is a cache for fast mapping from version id to a Index
 
904
    object.
 
905
 
 
906
    _history is a cache for fast mapping from indexes to version ids.
 
907
 
 
908
    The index data format is dictionary compressed when it comes to
 
909
    parent references; a index entry may only have parents that with a
 
910
    lover index number.  As a result, the index is topological sorted.
 
911
 
 
912
    Duplicate entries may be written to the index for a single version id
 
913
    if this is done then the latter one completely replaces the former:
 
914
    this allows updates to correct version and parent information. 
 
915
    Note that the two entries may share the delta, and that successive
 
916
    annotations and references MUST point to the first entry.
 
917
 
 
918
    The index file on disc contains a header, followed by one line per knit
 
919
    record. The same revision can be present in an index file more than once.
 
920
    The first occurence gets assigned a sequence number starting from 0. 
 
921
    
 
922
    The format of a single line is
 
923
    REVISION_ID FLAGS BYTE_OFFSET LENGTH( PARENT_ID|PARENT_SEQUENCE_ID)* :\n
 
924
    REVISION_ID is a utf8-encoded revision id
 
925
    FLAGS is a comma separated list of flags about the record. Values include 
 
926
        no-eol, line-delta, fulltext.
 
927
    BYTE_OFFSET is the ascii representation of the byte offset in the data file
 
928
        that the the compressed data starts at.
 
929
    LENGTH is the ascii representation of the length of the data file.
 
930
    PARENT_ID a utf-8 revision id prefixed by a '.' that is a parent of
 
931
        REVISION_ID.
 
932
    PARENT_SEQUENCE_ID the ascii representation of the sequence number of a
 
933
        revision id already in the knit that is a parent of REVISION_ID.
 
934
    The ' :' marker is the end of record marker.
 
935
    
 
936
    partial writes:
 
937
    when a write is interrupted to the index file, it will result in a line that
 
938
    does not end in ' :'. If the ' :' is not present at the end of a line, or at
 
939
    the end of the file, then the record that is missing it will be ignored by
 
940
    the parser.
 
941
 
 
942
    When writing new records to the index file, the data is preceeded by '\n'
 
943
    to ensure that records always start on new lines even if the last write was
 
944
    interrupted. As a result its normal for the last line in the index to be
 
945
    missing a trailing newline. One can be added with no harmful effects.
 
946
    """
 
947
 
 
948
    HEADER = "# bzr knit index 7\n"
 
949
 
 
950
    # speed of knit parsing went from 280 ms to 280 ms with slots addition.
 
951
    # __slots__ = ['_cache', '_history', '_transport', '_filename']
 
952
 
 
953
    def _cache_version(self, version_id, options, pos, size, parents):
 
954
        """Cache a version record in the history array and index cache.
 
955
        
 
956
        This is inlined into __init__ for performance. KEEP IN SYNC.
 
957
        (It saves 60ms, 25% of the __init__ overhead on local 4000 record
 
958
         indexes).
 
959
        """
 
960
        # only want the _history index to reference the 1st index entry
 
961
        # for version_id
 
962
        if version_id not in self._cache:
 
963
            index = len(self._history)
 
964
            self._history.append(version_id)
 
965
        else:
 
966
            index = self._cache[version_id][5]
 
967
        self._cache[version_id] = (version_id, 
 
968
                                   options,
 
969
                                   pos,
 
970
                                   size,
 
971
                                   parents,
 
972
                                   index)
 
973
 
 
974
    def __init__(self, transport, filename, mode, create=False):
 
975
        _KnitComponentFile.__init__(self, transport, filename, mode)
 
976
        self._cache = {}
 
977
        # position in _history is the 'official' index for a revision
 
978
        # but the values may have come from a newer entry.
 
979
        # so - wc -l of a knit index is != the number of uniqe names
 
980
        # in the weave.
 
981
        self._history = []
 
982
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
983
        try:
 
984
            count = 0
 
985
            total = 1
 
986
            try:
 
987
                pb.update('read knit index', count, total)
 
988
                fp = self._transport.get(self._filename)
 
989
                self.check_header(fp)
 
990
                # readlines reads the whole file at once:
 
991
                # bad for transports like http, good for local disk
 
992
                # we save 60 ms doing this one change (
 
993
                # from calling readline each time to calling
 
994
                # readlines once.
 
995
                # probably what we want for nice behaviour on
 
996
                # http is a incremental readlines that yields, or
 
997
                # a check for local vs non local indexes,
 
998
                for l in fp.readlines():
 
999
                    rec = l.split()
 
1000
                    if len(rec) < 5 or rec[-1] != ':':
 
1001
                        # corrupt line.
 
1002
                        # FIXME: in the future we should determine if its a
 
1003
                        # short write - and ignore it 
 
1004
                        # or a different failure, and raise. RBC 20060407
 
1005
                        continue
 
1006
                    count += 1
 
1007
                    total += 1
 
1008
                    #pb.update('read knit index', count, total)
 
1009
                    # See self._parse_parents
 
1010
                    parents = []
 
1011
                    for value in rec[4:-1]:
 
1012
                        if '.' == value[0]:
 
1013
                            # uncompressed reference
 
1014
                            parents.append(value[1:])
 
1015
                        else:
 
1016
                            # this is 15/4000ms faster than isinstance,
 
1017
                            # (in lsprof)
 
1018
                            # this function is called thousands of times a 
 
1019
                            # second so small variations add up.
 
1020
                            assert value.__class__ is str
 
1021
                            parents.append(self._history[int(value)])
 
1022
                    # end self._parse_parents
 
1023
                    # self._cache_version(rec[0], 
 
1024
                    #                     rec[1].split(','),
 
1025
                    #                     int(rec[2]),
 
1026
                    #                     int(rec[3]),
 
1027
                    #                     parents)
 
1028
                    # --- self._cache_version
 
1029
                    # only want the _history index to reference the 1st 
 
1030
                    # index entry for version_id
 
1031
                    version_id = rec[0]
 
1032
                    if version_id not in self._cache:
 
1033
                        index = len(self._history)
 
1034
                        self._history.append(version_id)
 
1035
                    else:
 
1036
                        index = self._cache[version_id][5]
 
1037
                    self._cache[version_id] = (version_id,
 
1038
                                               rec[1].split(','),
 
1039
                                               int(rec[2]),
 
1040
                                               int(rec[3]),
 
1041
                                               parents,
 
1042
                                               index)
 
1043
                    # --- self._cache_version 
 
1044
            except NoSuchFile, e:
 
1045
                if mode != 'w' or not create:
 
1046
                    raise
 
1047
                self.write_header()
 
1048
        finally:
 
1049
            pb.update('read knit index', total, total)
 
1050
            pb.finished()
 
1051
 
 
1052
    def _parse_parents(self, compressed_parents):
 
1053
        """convert a list of string parent values into version ids.
 
1054
 
 
1055
        ints are looked up in the index.
 
1056
        .FOO values are ghosts and converted in to FOO.
 
1057
 
 
1058
        NOTE: the function is retained here for clarity, and for possible
 
1059
              use in partial index reads. However bulk processing now has
 
1060
              it inlined in __init__ for inner-loop optimisation.
 
1061
        """
 
1062
        result = []
 
1063
        for value in compressed_parents:
 
1064
            if value[-1] == '.':
 
1065
                # uncompressed reference
 
1066
                result.append(value[1:])
 
1067
            else:
 
1068
                # this is 15/4000ms faster than isinstance,
 
1069
                # this function is called thousands of times a 
 
1070
                # second so small variations add up.
 
1071
                assert value.__class__ is str
 
1072
                result.append(self._history[int(value)])
 
1073
        return result
 
1074
 
 
1075
    def get_graph(self):
 
1076
        graph = []
 
1077
        for version_id, index in self._cache.iteritems():
 
1078
            graph.append((version_id, index[4]))
 
1079
        return graph
 
1080
 
 
1081
    def get_ancestry(self, versions):
 
1082
        """See VersionedFile.get_ancestry."""
 
1083
        # get a graph of all the mentioned versions:
 
1084
        graph = {}
 
1085
        pending = set(versions)
 
1086
        while len(pending):
 
1087
            version = pending.pop()
 
1088
            parents = self._cache[version][4]
 
1089
            # got the parents ok
 
1090
            # trim ghosts
 
1091
            parents = [parent for parent in parents if parent in self._cache]
 
1092
            for parent in parents:
 
1093
                # if not completed and not a ghost
 
1094
                if parent not in graph:
 
1095
                    pending.add(parent)
 
1096
            graph[version] = parents
 
1097
        return topo_sort(graph.items())
 
1098
 
 
1099
    def get_ancestry_with_ghosts(self, versions):
 
1100
        """See VersionedFile.get_ancestry_with_ghosts."""
 
1101
        # get a graph of all the mentioned versions:
 
1102
        graph = {}
 
1103
        pending = set(versions)
 
1104
        while len(pending):
 
1105
            version = pending.pop()
 
1106
            try:
 
1107
                parents = self._cache[version][4]
 
1108
            except KeyError:
 
1109
                # ghost, fake it
 
1110
                graph[version] = []
 
1111
                pass
 
1112
            else:
 
1113
                # got the parents ok
 
1114
                for parent in parents:
 
1115
                    if parent not in graph:
 
1116
                        pending.add(parent)
 
1117
                graph[version] = parents
 
1118
        return topo_sort(graph.items())
 
1119
 
 
1120
    def num_versions(self):
 
1121
        return len(self._history)
 
1122
 
 
1123
    __len__ = num_versions
 
1124
 
 
1125
    def get_versions(self):
 
1126
        return self._history
 
1127
 
 
1128
    def idx_to_name(self, idx):
 
1129
        return self._history[idx]
 
1130
 
 
1131
    def lookup(self, version_id):
 
1132
        assert version_id in self._cache
 
1133
        return self._cache[version_id][5]
 
1134
 
 
1135
    def _version_list_to_index(self, versions):
 
1136
        result_list = []
 
1137
        for version in versions:
 
1138
            if version in self._cache:
 
1139
                # -- inlined lookup() --
 
1140
                result_list.append(str(self._cache[version][5]))
 
1141
                # -- end lookup () --
 
1142
            else:
 
1143
                result_list.append('.' + version.encode('utf-8'))
 
1144
        return ' '.join(result_list)
 
1145
 
 
1146
    def add_version(self, version_id, options, pos, size, parents):
 
1147
        """Add a version record to the index."""
 
1148
        self._cache_version(version_id, options, pos, size, parents)
 
1149
 
 
1150
        content = "\n%s %s %s %s %s :" % (version_id.encode('utf-8'),
 
1151
                                        ','.join(options),
 
1152
                                        pos,
 
1153
                                        size,
 
1154
                                        self._version_list_to_index(parents))
 
1155
        assert isinstance(content, str), 'content must be utf-8 encoded'
 
1156
        self._transport.append(self._filename, StringIO(content))
 
1157
 
 
1158
    def has_version(self, version_id):
 
1159
        """True if the version is in the index."""
 
1160
        return self._cache.has_key(version_id)
 
1161
 
 
1162
    def get_position(self, version_id):
 
1163
        """Return data position and size of specified version."""
 
1164
        return (self._cache[version_id][2], \
 
1165
                self._cache[version_id][3])
 
1166
 
 
1167
    def get_method(self, version_id):
 
1168
        """Return compression method of specified version."""
 
1169
        options = self._cache[version_id][1]
 
1170
        if 'fulltext' in options:
 
1171
            return 'fulltext'
 
1172
        else:
 
1173
            assert 'line-delta' in options
 
1174
            return 'line-delta'
 
1175
 
 
1176
    def get_options(self, version_id):
 
1177
        return self._cache[version_id][1]
 
1178
 
 
1179
    def get_parents(self, version_id):
 
1180
        """Return parents of specified version ignoring ghosts."""
 
1181
        return [parent for parent in self._cache[version_id][4] 
 
1182
                if parent in self._cache]
 
1183
 
 
1184
    def get_parents_with_ghosts(self, version_id):
 
1185
        """Return parents of specified version wth ghosts."""
 
1186
        return self._cache[version_id][4] 
 
1187
 
 
1188
    def check_versions_present(self, version_ids):
 
1189
        """Check that all specified versions are present."""
 
1190
        version_ids = set(version_ids)
 
1191
        for version_id in list(version_ids):
 
1192
            if version_id in self._cache:
 
1193
                version_ids.remove(version_id)
 
1194
        if version_ids:
 
1195
            raise RevisionNotPresent(list(version_ids)[0], self.filename)
 
1196
 
 
1197
 
 
1198
class _KnitData(_KnitComponentFile):
 
1199
    """Contents of the knit data file"""
 
1200
 
 
1201
    HEADER = "# bzr knit data 7\n"
 
1202
 
 
1203
    def __init__(self, transport, filename, mode, create=False):
 
1204
        _KnitComponentFile.__init__(self, transport, filename, mode)
 
1205
        self._file = None
 
1206
        self._checked = False
 
1207
        if create:
 
1208
            self._transport.put(self._filename, StringIO(''))
 
1209
        self._records = {}
 
1210
 
 
1211
    def clear_cache(self):
 
1212
        """Clear the record cache."""
 
1213
        self._records = {}
 
1214
 
 
1215
    def _open_file(self):
 
1216
        if self._file is None:
 
1217
            try:
 
1218
                self._file = self._transport.get(self._filename)
 
1219
            except NoSuchFile:
 
1220
                pass
 
1221
        return self._file
 
1222
 
 
1223
    def _record_to_data(self, version_id, digest, lines):
 
1224
        """Convert version_id, digest, lines into a raw data block.
 
1225
        
 
1226
        :return: (len, a StringIO instance with the raw data ready to read.)
 
1227
        """
 
1228
        sio = StringIO()
 
1229
        data_file = GzipFile(None, mode='wb', fileobj=sio)
 
1230
        data_file.writelines(chain(
 
1231
            ["version %s %d %s\n" % (version_id.encode('utf-8'), 
 
1232
                                     len(lines),
 
1233
                                     digest)],
 
1234
            lines,
 
1235
            ["end %s\n" % version_id.encode('utf-8')]))
 
1236
        data_file.close()
 
1237
        length= sio.tell()
 
1238
 
 
1239
        sio.seek(0)
 
1240
        return length, sio
 
1241
 
 
1242
    def add_raw_record(self, raw_data):
 
1243
        """Append a prepared record to the data file."""
 
1244
        assert isinstance(raw_data, str), 'data must be plain bytes'
 
1245
        start_pos = self._transport.append(self._filename, StringIO(raw_data))
 
1246
        return start_pos, len(raw_data)
 
1247
        
 
1248
    def add_record(self, version_id, digest, lines):
 
1249
        """Write new text record to disk.  Returns the position in the
 
1250
        file where it was written."""
 
1251
        size, sio = self._record_to_data(version_id, digest, lines)
 
1252
        # cache
 
1253
        self._records[version_id] = (digest, lines)
 
1254
        # write to disk
 
1255
        start_pos = self._transport.append(self._filename, sio)
 
1256
        return start_pos, size
 
1257
 
 
1258
    def _parse_record_header(self, version_id, raw_data):
 
1259
        """Parse a record header for consistency.
 
1260
 
 
1261
        :return: the header and the decompressor stream.
 
1262
                 as (stream, header_record)
 
1263
        """
 
1264
        df = GzipFile(mode='rb', fileobj=StringIO(raw_data))
 
1265
        rec = df.readline().split()
 
1266
        if len(rec) != 4:
 
1267
            raise KnitCorrupt(self._filename, 'unexpected number of elements in record header')
 
1268
        if rec[1].decode('utf-8')!= version_id:
 
1269
            raise KnitCorrupt(self._filename, 
 
1270
                              'unexpected version, wanted %r, got %r' % (
 
1271
                                version_id, rec[1]))
 
1272
        return df, rec
 
1273
 
 
1274
    def _parse_record(self, version_id, data):
 
1275
        # profiling notes:
 
1276
        # 4168 calls in 2880 217 internal
 
1277
        # 4168 calls to _parse_record_header in 2121
 
1278
        # 4168 calls to readlines in 330
 
1279
        df, rec = self._parse_record_header(version_id, data)
 
1280
        record_contents = df.readlines()
 
1281
        l = record_contents.pop()
 
1282
        assert len(record_contents) == int(rec[2])
 
1283
        if l.decode('utf-8') != 'end %s\n' % version_id:
 
1284
            raise KnitCorrupt(self._filename, 'unexpected version end line %r, wanted %r' 
 
1285
                        % (l, version_id))
 
1286
        df.close()
 
1287
        return record_contents, rec[3]
 
1288
 
 
1289
    def read_records_iter_raw(self, records):
 
1290
        """Read text records from data file and yield raw data.
 
1291
 
 
1292
        This unpacks enough of the text record to validate the id is
 
1293
        as expected but thats all.
 
1294
 
 
1295
        It will actively recompress currently cached records on the
 
1296
        basis that that is cheaper than I/O activity.
 
1297
        """
 
1298
        needed_records = []
 
1299
        for version_id, pos, size in records:
 
1300
            if version_id not in self._records:
 
1301
                needed_records.append((version_id, pos, size))
 
1302
 
 
1303
        # setup an iterator of the external records:
 
1304
        # uses readv so nice and fast we hope.
 
1305
        if len(needed_records):
 
1306
            # grab the disk data needed.
 
1307
            raw_records = self._transport.readv(self._filename,
 
1308
                [(pos, size) for version_id, pos, size in needed_records])
 
1309
 
 
1310
        for version_id, pos, size in records:
 
1311
            if version_id in self._records:
 
1312
                # compress a new version
 
1313
                size, sio = self._record_to_data(version_id,
 
1314
                                                 self._records[version_id][0],
 
1315
                                                 self._records[version_id][1])
 
1316
                yield version_id, sio.getvalue()
 
1317
            else:
 
1318
                pos, data = raw_records.next()
 
1319
                # validate the header
 
1320
                df, rec = self._parse_record_header(version_id, data)
 
1321
                df.close()
 
1322
                yield version_id, data
 
1323
 
 
1324
 
 
1325
    def read_records_iter(self, records):
 
1326
        """Read text records from data file and yield result.
 
1327
 
 
1328
        Each passed record is a tuple of (version_id, pos, len) and
 
1329
        will be read in the given order.  Yields (version_id,
 
1330
        contents, digest).
 
1331
        """
 
1332
        # profiling notes:
 
1333
        # 60890  calls for 4168 extractions in 5045, 683 internal.
 
1334
        # 4168   calls to readv              in 1411
 
1335
        # 4168   calls to parse_record       in 2880
 
1336
 
 
1337
        needed_records = []
 
1338
        for version_id, pos, size in records:
 
1339
            if version_id not in self._records:
 
1340
                needed_records.append((version_id, pos, size))
 
1341
 
 
1342
        if len(needed_records):
 
1343
            # We take it that the transport optimizes the fetching as good
 
1344
            # as possible (ie, reads continous ranges.)
 
1345
            response = self._transport.readv(self._filename,
 
1346
                [(pos, size) for version_id, pos, size in needed_records])
 
1347
 
 
1348
            for (record_id, pos, size), (pos, data) in izip(iter(needed_records), response):
 
1349
                content, digest = self._parse_record(record_id, data)
 
1350
                self._records[record_id] = (digest, content)
 
1351
    
 
1352
        for version_id, pos, size in records:
 
1353
            yield version_id, list(self._records[version_id][1]), self._records[version_id][0]
 
1354
 
 
1355
    def read_records(self, records):
 
1356
        """Read records into a dictionary."""
 
1357
        components = {}
 
1358
        for record_id, content, digest in self.read_records_iter(records):
 
1359
            components[record_id] = (content, digest)
 
1360
        return components
 
1361
 
 
1362
 
 
1363
class InterKnit(InterVersionedFile):
 
1364
    """Optimised code paths for knit to knit operations."""
 
1365
    
 
1366
    _matching_file_factory = KnitVersionedFile
 
1367
    
 
1368
    @staticmethod
 
1369
    def is_compatible(source, target):
 
1370
        """Be compatible with knits.  """
 
1371
        try:
 
1372
            return (isinstance(source, KnitVersionedFile) and
 
1373
                    isinstance(target, KnitVersionedFile))
 
1374
        except AttributeError:
 
1375
            return False
 
1376
 
 
1377
    def join(self, pb=None, msg=None, version_ids=None, ignore_missing=False):
 
1378
        """See InterVersionedFile.join."""
 
1379
        assert isinstance(self.source, KnitVersionedFile)
 
1380
        assert isinstance(self.target, KnitVersionedFile)
 
1381
 
 
1382
        if version_ids is None:
 
1383
            version_ids = self.source.versions()
 
1384
        else:
 
1385
            if not ignore_missing:
 
1386
                self.source._check_versions_present(version_ids)
 
1387
            else:
 
1388
                version_ids = set(self.source.versions()).intersection(
 
1389
                    set(version_ids))
 
1390
 
 
1391
        if not version_ids:
 
1392
            return 0
 
1393
 
 
1394
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1395
        try:
 
1396
            version_ids = list(version_ids)
 
1397
            if None in version_ids:
 
1398
                version_ids.remove(None)
 
1399
    
 
1400
            self.source_ancestry = set(self.source.get_ancestry(version_ids))
 
1401
            this_versions = set(self.target._index.get_versions())
 
1402
            needed_versions = self.source_ancestry - this_versions
 
1403
            cross_check_versions = self.source_ancestry.intersection(this_versions)
 
1404
            mismatched_versions = set()
 
1405
            for version in cross_check_versions:
 
1406
                # scan to include needed parents.
 
1407
                n1 = set(self.target.get_parents_with_ghosts(version))
 
1408
                n2 = set(self.source.get_parents_with_ghosts(version))
 
1409
                if n1 != n2:
 
1410
                    # FIXME TEST this check for cycles being introduced works
 
1411
                    # the logic is we have a cycle if in our graph we are an
 
1412
                    # ancestor of any of the n2 revisions.
 
1413
                    for parent in n2:
 
1414
                        if parent in n1:
 
1415
                            # safe
 
1416
                            continue
 
1417
                        else:
 
1418
                            parent_ancestors = self.source.get_ancestry(parent)
 
1419
                            if version in parent_ancestors:
 
1420
                                raise errors.GraphCycleError([parent, version])
 
1421
                    # ensure this parent will be available later.
 
1422
                    new_parents = n2.difference(n1)
 
1423
                    needed_versions.update(new_parents.difference(this_versions))
 
1424
                    mismatched_versions.add(version)
 
1425
    
 
1426
            if not needed_versions and not cross_check_versions:
 
1427
                return 0
 
1428
            full_list = topo_sort(self.source.get_graph())
 
1429
    
 
1430
            version_list = [i for i in full_list if (not self.target.has_version(i)
 
1431
                            and i in needed_versions)]
 
1432
    
 
1433
            # plan the join:
 
1434
            copy_queue = []
 
1435
            copy_queue_records = []
 
1436
            copy_set = set()
 
1437
            for version_id in version_list:
 
1438
                options = self.source._index.get_options(version_id)
 
1439
                parents = self.source._index.get_parents_with_ghosts(version_id)
 
1440
                # check that its will be a consistent copy:
 
1441
                for parent in parents:
 
1442
                    # if source has the parent, we must :
 
1443
                    # * already have it or
 
1444
                    # * have it scheduled already
 
1445
                    # otherwise we dont care
 
1446
                    assert (self.target.has_version(parent) or
 
1447
                            parent in copy_set or
 
1448
                            not self.source.has_version(parent))
 
1449
                data_pos, data_size = self.source._index.get_position(version_id)
 
1450
                copy_queue_records.append((version_id, data_pos, data_size))
 
1451
                copy_queue.append((version_id, options, parents))
 
1452
                copy_set.add(version_id)
 
1453
 
 
1454
            # data suck the join:
 
1455
            count = 0
 
1456
            total = len(version_list)
 
1457
            # we want the raw gzip for bulk copying, but the record validated
 
1458
            # just enough to be sure its the right one.
 
1459
            # TODO: consider writev or write combining to reduce 
 
1460
            # death of a thousand cuts feeling.
 
1461
            for (version_id, raw_data), \
 
1462
                (version_id2, options, parents) in \
 
1463
                izip(self.source._data.read_records_iter_raw(copy_queue_records),
 
1464
                     copy_queue):
 
1465
                assert version_id == version_id2, 'logic error, inconsistent results'
 
1466
                count = count + 1
 
1467
                pb.update("Joining knit", count, total)
 
1468
                pos, size = self.target._data.add_raw_record(raw_data)
 
1469
                self.target._index.add_version(version_id, options, pos, size, parents)
 
1470
 
 
1471
            for version in mismatched_versions:
 
1472
                # FIXME RBC 20060309 is this needed?
 
1473
                n1 = set(self.target.get_parents_with_ghosts(version))
 
1474
                n2 = set(self.source.get_parents_with_ghosts(version))
 
1475
                # write a combined record to our history preserving the current 
 
1476
                # parents as first in the list
 
1477
                new_parents = self.target.get_parents_with_ghosts(version) + list(n2.difference(n1))
 
1478
                self.target.fix_parents(version, new_parents)
 
1479
            return count
 
1480
        finally:
 
1481
            pb.finished()
 
1482
 
 
1483
 
 
1484
InterVersionedFile.register_optimiser(InterKnit)
 
1485
 
 
1486
 
 
1487
class SequenceMatcher(difflib.SequenceMatcher):
 
1488
    """Knit tuned sequence matcher.
 
1489
 
 
1490
    This is based on profiling of difflib which indicated some improvements
 
1491
    for our usage pattern.
 
1492
    """
 
1493
 
 
1494
    def find_longest_match(self, alo, ahi, blo, bhi):
 
1495
        """Find longest matching block in a[alo:ahi] and b[blo:bhi].
 
1496
 
 
1497
        If isjunk is not defined:
 
1498
 
 
1499
        Return (i,j,k) such that a[i:i+k] is equal to b[j:j+k], where
 
1500
            alo <= i <= i+k <= ahi
 
1501
            blo <= j <= j+k <= bhi
 
1502
        and for all (i',j',k') meeting those conditions,
 
1503
            k >= k'
 
1504
            i <= i'
 
1505
            and if i == i', j <= j'
 
1506
 
 
1507
        In other words, of all maximal matching blocks, return one that
 
1508
        starts earliest in a, and of all those maximal matching blocks that
 
1509
        start earliest in a, return the one that starts earliest in b.
 
1510
 
 
1511
        >>> s = SequenceMatcher(None, " abcd", "abcd abcd")
 
1512
        >>> s.find_longest_match(0, 5, 0, 9)
 
1513
        (0, 4, 5)
 
1514
 
 
1515
        If isjunk is defined, first the longest matching block is
 
1516
        determined as above, but with the additional restriction that no
 
1517
        junk element appears in the block.  Then that block is extended as
 
1518
        far as possible by matching (only) junk elements on both sides.  So
 
1519
        the resulting block never matches on junk except as identical junk
 
1520
        happens to be adjacent to an "interesting" match.
 
1521
 
 
1522
        Here's the same example as before, but considering blanks to be
 
1523
        junk.  That prevents " abcd" from matching the " abcd" at the tail
 
1524
        end of the second sequence directly.  Instead only the "abcd" can
 
1525
        match, and matches the leftmost "abcd" in the second sequence:
 
1526
 
 
1527
        >>> s = SequenceMatcher(lambda x: x==" ", " abcd", "abcd abcd")
 
1528
        >>> s.find_longest_match(0, 5, 0, 9)
 
1529
        (1, 0, 4)
 
1530
 
 
1531
        If no blocks match, return (alo, blo, 0).
 
1532
 
 
1533
        >>> s = SequenceMatcher(None, "ab", "c")
 
1534
        >>> s.find_longest_match(0, 2, 0, 1)
 
1535
        (0, 0, 0)
 
1536
        """
 
1537
 
 
1538
        # CAUTION:  stripping common prefix or suffix would be incorrect.
 
1539
        # E.g.,
 
1540
        #    ab
 
1541
        #    acab
 
1542
        # Longest matching block is "ab", but if common prefix is
 
1543
        # stripped, it's "a" (tied with "b").  UNIX(tm) diff does so
 
1544
        # strip, so ends up claiming that ab is changed to acab by
 
1545
        # inserting "ca" in the middle.  That's minimal but unintuitive:
 
1546
        # "it's obvious" that someone inserted "ac" at the front.
 
1547
        # Windiff ends up at the same place as diff, but by pairing up
 
1548
        # the unique 'b's and then matching the first two 'a's.
 
1549
 
 
1550
        a, b, b2j, isbjunk = self.a, self.b, self.b2j, self.isbjunk
 
1551
        besti, bestj, bestsize = alo, blo, 0
 
1552
        # find longest junk-free match
 
1553
        # during an iteration of the loop, j2len[j] = length of longest
 
1554
        # junk-free match ending with a[i-1] and b[j]
 
1555
        j2len = {}
 
1556
        # nothing = []
 
1557
        b2jget = b2j.get
 
1558
        for i in xrange(alo, ahi):
 
1559
            # look at all instances of a[i] in b; note that because
 
1560
            # b2j has no junk keys, the loop is skipped if a[i] is junk
 
1561
            j2lenget = j2len.get
 
1562
            newj2len = {}
 
1563
            
 
1564
            # changing b2j.get(a[i], nothing) to a try:Keyerror pair produced the
 
1565
            # following improvement
 
1566
            #     704  0   4650.5320   2620.7410   bzrlib.knit:1336(find_longest_match)
 
1567
            # +326674  0   1655.1210   1655.1210   +<method 'get' of 'dict' objects>
 
1568
            #  +76519  0    374.6700    374.6700   +<method 'has_key' of 'dict' objects>
 
1569
            # to 
 
1570
            #     704  0   3733.2820   2209.6520   bzrlib.knit:1336(find_longest_match)
 
1571
            #  +211400 0   1147.3520   1147.3520   +<method 'get' of 'dict' objects>
 
1572
            #  +76519  0    376.2780    376.2780   +<method 'has_key' of 'dict' objects>
 
1573
 
 
1574
            try:
 
1575
                js = b2j[a[i]]
 
1576
            except KeyError:
 
1577
                pass
 
1578
            else:
 
1579
                for j in js:
 
1580
                    # a[i] matches b[j]
 
1581
                    if j >= blo:
 
1582
                        if j >= bhi:
 
1583
                            break
 
1584
                        k = newj2len[j] = 1 + j2lenget(-1 + j, 0)
 
1585
                        if k > bestsize:
 
1586
                            besti, bestj, bestsize = 1 + i-k, 1 + j-k, k
 
1587
            j2len = newj2len
 
1588
 
 
1589
        # Extend the best by non-junk elements on each end.  In particular,
 
1590
        # "popular" non-junk elements aren't in b2j, which greatly speeds
 
1591
        # the inner loop above, but also means "the best" match so far
 
1592
        # doesn't contain any junk *or* popular non-junk elements.
 
1593
        while besti > alo and bestj > blo and \
 
1594
              not isbjunk(b[bestj-1]) and \
 
1595
              a[besti-1] == b[bestj-1]:
 
1596
            besti, bestj, bestsize = besti-1, bestj-1, bestsize+1
 
1597
        while besti+bestsize < ahi and bestj+bestsize < bhi and \
 
1598
              not isbjunk(b[bestj+bestsize]) and \
 
1599
              a[besti+bestsize] == b[bestj+bestsize]:
 
1600
            bestsize += 1
 
1601
 
 
1602
        # Now that we have a wholly interesting match (albeit possibly
 
1603
        # empty!), we may as well suck up the matching junk on each
 
1604
        # side of it too.  Can't think of a good reason not to, and it
 
1605
        # saves post-processing the (possibly considerable) expense of
 
1606
        # figuring out what to do with it.  In the case of an empty
 
1607
        # interesting match, this is clearly the right thing to do,
 
1608
        # because no other kind of match is possible in the regions.
 
1609
        while besti > alo and bestj > blo and \
 
1610
              isbjunk(b[bestj-1]) and \
 
1611
              a[besti-1] == b[bestj-1]:
 
1612
            besti, bestj, bestsize = besti-1, bestj-1, bestsize+1
 
1613
        while besti+bestsize < ahi and bestj+bestsize < bhi and \
 
1614
              isbjunk(b[bestj+bestsize]) and \
 
1615
              a[besti+bestsize] == b[bestj+bestsize]:
 
1616
            bestsize = bestsize + 1
 
1617
 
 
1618
        return besti, bestj, bestsize
 
1619