← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Tarmac
  • Author(s): Vincent Ladeuil
  • Date: 2017-01-30 14:42:05 UTC
  • mfrom: (6620.1.1 trunk)
  • Revision ID: tarmac-20170130144205-r8fh2xpmiuxyozpv
Merge  2.7 into trunk including fix for bug #1657238 [r=vila]

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/weave.py
1
 
#! /usr/bin/python
2
 
 
3
 
# Copyright (C) 2005 Canonical Ltd
4
 
 
 
1
# Copyright (C) 2005, 2009 Canonical Ltd
 
2
#
5
3
# This program is free software; you can redistribute it and/or modify
6
4
# it under the terms of the GNU General Public License as published by
7
5
# the Free Software Foundation; either version 2 of the License, or
8
6
# (at your option) any later version.
9
 
 
 
7
#
10
8
# This program is distributed in the hope that it will be useful,
11
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13
11
# GNU General Public License for more details.
14
 
 
 
12
#
15
13
# You should have received a copy of the GNU General Public License
16
14
# along with this program; if not, write to the Free Software
17
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
16
 
19
17
# Author: Martin Pool <mbp@canonical.com>
20
18
 
21
 
 
22
19
"""Weave - storage of related text file versions"""
23
20
 
24
 
# before intset (r923) 2000 versions in 41.5s
25
 
# with intset (r926) 2000 versions in 93s !!!
26
 
# better to just use plain sets.
27
 
 
28
 
# making _extract build and return a list, rather than being a generator
29
 
# takes 37.94s
30
 
 
31
 
# with python -O, r923 does 2000 versions in 36.87s
32
 
 
33
 
# with optimizations to avoid mutating lists - 35.75!  I guess copying
34
 
# all the elements every time costs more than the small manipulations.
35
 
# a surprisingly small change.
36
 
 
37
 
# r931, which avoids using a generator for extract, does 36.98s
38
 
 
39
 
# with memoized inclusions, takes 41.49s; not very good
40
 
 
41
 
# with slots, takes 37.35s; without takes 39.16, a bit surprising
42
 
 
43
 
# with the delta calculation mixed in with the add method, rather than
44
 
# separated, takes 36.78s
45
 
 
46
 
# with delta folded in and mutation of the list, 36.13s
47
 
 
48
 
# with all this and simplification of add code, 33s 
49
 
 
50
 
 
51
 
# TODO: Perhaps have copy method for Weave instances?
 
21
from __future__ import absolute_import
52
22
 
53
23
# XXX: If we do weaves this way, will a merge still behave the same
54
24
# way if it's done in a different order?  That's a pretty desirable
55
25
# property.
56
26
 
57
27
# TODO: Nothing here so far assumes the lines are really \n newlines,
58
 
# rather than being split up in some other way.  We could accomodate
 
28
# rather than being split up in some other way.  We could accommodate
59
29
# binaries, perhaps by naively splitting on \n or perhaps using
60
30
# something like a rolling checksum.
61
31
 
62
 
# TODO: Track version names as well as indexes. 
63
 
 
64
32
# TODO: End marker for each version so we can stop reading?
65
33
 
66
34
# TODO: Check that no insertion occurs inside a deletion that was
73
41
 
74
42
# TODO: Parallel-extract that passes back each line along with a
75
43
# description of which revisions include it.  Nice for checking all
76
 
# shas in parallel.
77
 
 
78
 
 
79
 
 
80
 
 
81
 
class WeaveError(Exception):
82
 
    """Exception in processing weave"""
83
 
 
84
 
 
85
 
class WeaveFormatError(WeaveError):
86
 
    """Weave invariant violated"""
87
 
    
88
 
 
89
 
class Weave(object):
 
44
# shas or calculating stats in parallel.
 
45
 
 
46
# TODO: Using a single _extract routine and then processing the output
 
47
# is probably inefficient.  It's simple enough that we can afford to
 
48
# have slight specializations for different ways its used: annotate,
 
49
# basis for add, get, etc.
 
50
 
 
51
# TODO: Probably the API should work only in names to hide the integer
 
52
# indexes from the user.
 
53
 
 
54
# TODO: Is there any potential performance win by having an add()
 
55
# variant that is passed a pre-cooked version of the single basis
 
56
# version?
 
57
 
 
58
# TODO: Reweave can possibly be made faster by remembering diffs
 
59
# where the basis and destination are unchanged.
 
60
 
 
61
# FIXME: Sometimes we will be given a parents list for a revision
 
62
# that includes some redundant parents (i.e. already a parent of
 
63
# something in the list.)  We should eliminate them.  This can
 
64
# be done fairly efficiently because the sequence numbers constrain
 
65
# the possible relationships.
 
66
 
 
67
# FIXME: the conflict markers should be *7* characters
 
68
 
 
69
from copy import copy
 
70
from cStringIO import StringIO
 
71
import os
 
72
 
 
73
from bzrlib.lazy_import import lazy_import
 
74
lazy_import(globals(), """
 
75
from bzrlib import tsort
 
76
""")
 
77
from bzrlib import (
 
78
    errors,
 
79
    osutils,
 
80
    )
 
81
from bzrlib.errors import (WeaveError, WeaveFormatError, WeaveParentMismatch,
 
82
        RevisionAlreadyPresent,
 
83
        RevisionNotPresent,
 
84
        UnavailableRepresentation,
 
85
        )
 
86
from bzrlib.osutils import dirname, sha, sha_strings, split_lines
 
87
import bzrlib.patiencediff
 
88
from bzrlib.revision import NULL_REVISION
 
89
from bzrlib.symbol_versioning import *
 
90
from bzrlib.trace import mutter
 
91
from bzrlib.versionedfile import (
 
92
    AbsentContentFactory,
 
93
    adapter_registry,
 
94
    ContentFactory,
 
95
    sort_groupcompress,
 
96
    VersionedFile,
 
97
    )
 
98
from bzrlib.weavefile import _read_weave_v5, write_weave_v5
 
99
 
 
100
 
 
101
class WeaveContentFactory(ContentFactory):
 
102
    """Content factory for streaming from weaves.
 
103
 
 
104
    :seealso ContentFactory:
 
105
    """
 
106
 
 
107
    def __init__(self, version, weave):
 
108
        """Create a WeaveContentFactory for version from weave."""
 
109
        ContentFactory.__init__(self)
 
110
        self.sha1 = weave.get_sha1s([version])[version]
 
111
        self.key = (version,)
 
112
        parents = weave.get_parent_map([version])[version]
 
113
        self.parents = tuple((parent,) for parent in parents)
 
114
        self.storage_kind = 'fulltext'
 
115
        self._weave = weave
 
116
 
 
117
    def get_bytes_as(self, storage_kind):
 
118
        if storage_kind == 'fulltext':
 
119
            return self._weave.get_text(self.key[-1])
 
120
        elif storage_kind == 'chunked':
 
121
            return self._weave.get_lines(self.key[-1])
 
122
        else:
 
123
            raise UnavailableRepresentation(self.key, storage_kind, 'fulltext')
 
124
 
 
125
 
 
126
class Weave(VersionedFile):
90
127
    """weave - versioned text file storage.
91
 
    
 
128
 
92
129
    A Weave manages versions of line-based text files, keeping track
93
130
    of the originating version for each line.
94
131
 
118
155
    The instruction can be '{' or '}' for an insertion block, and '['
119
156
    and ']' for a deletion block respectively.  The version is the
120
157
    integer version index.  There is no replace operator, only deletes
121
 
    and inserts.
 
158
    and inserts.  For '}', the end of an insertion, there is no
 
159
    version parameter because it always closes the most recently
 
160
    opened insertion.
122
161
 
123
162
    Constraints/notes:
124
163
 
138
177
 
139
178
    * It doesn't seem very useful to have an active insertion
140
179
      inside an inactive insertion, but it might happen.
141
 
      
 
180
 
142
181
    * Therefore, all instructions are always"considered"; that
143
182
      is passed onto and off the stack.  An outer inactive block
144
183
      doesn't disable an inner block.
160
199
        each version; the parent's parents are implied.
161
200
 
162
201
    _sha1s
163
 
        List of hex SHA-1 of each version, or None if not recorded.
 
202
        List of hex SHA-1 of each version.
 
203
 
 
204
    _names
 
205
        List of symbolic names for each version.  Each should be unique.
 
206
 
 
207
    _name_map
 
208
        For each name, the version number.
 
209
 
 
210
    _weave_name
 
211
        Descriptive name of this weave; typically the filename if known.
 
212
        Set by read_weave.
164
213
    """
165
214
 
166
 
    __slots__ = ['_weave', '_parents', '_sha1s']
167
 
    
168
 
    def __init__(self):
 
215
    __slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map',
 
216
                 '_weave_name', '_matcher', '_allow_reserved']
 
217
 
 
218
    def __init__(self, weave_name=None, access_mode='w', matcher=None,
 
219
                 get_scope=None, allow_reserved=False):
 
220
        """Create a weave.
 
221
 
 
222
        :param get_scope: A callable that returns an opaque object to be used
 
223
            for detecting when this weave goes out of scope (should stop
 
224
            answering requests or allowing mutation).
 
225
        """
 
226
        super(Weave, self).__init__()
169
227
        self._weave = []
170
228
        self._parents = []
171
229
        self._sha1s = []
172
 
 
 
230
        self._names = []
 
231
        self._name_map = {}
 
232
        self._weave_name = weave_name
 
233
        if matcher is None:
 
234
            self._matcher = bzrlib.patiencediff.PatienceSequenceMatcher
 
235
        else:
 
236
            self._matcher = matcher
 
237
        if get_scope is None:
 
238
            get_scope = lambda:None
 
239
        self._get_scope = get_scope
 
240
        self._scope = get_scope()
 
241
        self._access_mode = access_mode
 
242
        self._allow_reserved = allow_reserved
 
243
 
 
244
    def __repr__(self):
 
245
        return "Weave(%r)" % self._weave_name
 
246
 
 
247
    def _check_write_ok(self):
 
248
        """Is the versioned file marked as 'finished' ? Raise if it is."""
 
249
        if self._get_scope() != self._scope:
 
250
            raise errors.OutSideTransaction()
 
251
        if self._access_mode != 'w':
 
252
            raise errors.ReadOnlyObjectDirtiedError(self)
 
253
 
 
254
    def copy(self):
 
255
        """Return a deep copy of self.
 
256
 
 
257
        The copy can be modified without affecting the original weave."""
 
258
        other = Weave()
 
259
        other._weave = self._weave[:]
 
260
        other._parents = self._parents[:]
 
261
        other._sha1s = self._sha1s[:]
 
262
        other._names = self._names[:]
 
263
        other._name_map = self._name_map.copy()
 
264
        other._weave_name = self._weave_name
 
265
        return other
173
266
 
174
267
    def __eq__(self, other):
175
268
        if not isinstance(other, Weave):
176
269
            return False
177
270
        return self._parents == other._parents \
178
 
               and self._weave == other._weave
179
 
    
 
271
               and self._weave == other._weave \
 
272
               and self._sha1s == other._sha1s
180
273
 
181
274
    def __ne__(self, other):
182
275
        return not self.__eq__(other)
183
276
 
184
 
        
185
 
    def add(self, parents, text):
 
277
    def _idx_to_name(self, version):
 
278
        return self._names[version]
 
279
 
 
280
    def _lookup(self, name):
 
281
        """Convert symbolic version name to index."""
 
282
        if not self._allow_reserved:
 
283
            self.check_not_reserved_id(name)
 
284
        try:
 
285
            return self._name_map[name]
 
286
        except KeyError:
 
287
            raise RevisionNotPresent(name, self._weave_name)
 
288
 
 
289
    def versions(self):
 
290
        """See VersionedFile.versions."""
 
291
        return self._names[:]
 
292
 
 
293
    def has_version(self, version_id):
 
294
        """See VersionedFile.has_version."""
 
295
        return (version_id in self._name_map)
 
296
 
 
297
    __contains__ = has_version
 
298
 
 
299
    def get_record_stream(self, versions, ordering, include_delta_closure):
 
300
        """Get a stream of records for versions.
 
301
 
 
302
        :param versions: The versions to include. Each version is a tuple
 
303
            (version,).
 
304
        :param ordering: Either 'unordered' or 'topological'. A topologically
 
305
            sorted stream has compression parents strictly before their
 
306
            children.
 
307
        :param include_delta_closure: If True then the closure across any
 
308
            compression parents will be included (in the opaque data).
 
309
        :return: An iterator of ContentFactory objects, each of which is only
 
310
            valid until the iterator is advanced.
 
311
        """
 
312
        versions = [version[-1] for version in versions]
 
313
        if ordering == 'topological':
 
314
            parents = self.get_parent_map(versions)
 
315
            new_versions = tsort.topo_sort(parents)
 
316
            new_versions.extend(set(versions).difference(set(parents)))
 
317
            versions = new_versions
 
318
        elif ordering == 'groupcompress':
 
319
            parents = self.get_parent_map(versions)
 
320
            new_versions = sort_groupcompress(parents)
 
321
            new_versions.extend(set(versions).difference(set(parents)))
 
322
            versions = new_versions
 
323
        for version in versions:
 
324
            if version in self:
 
325
                yield WeaveContentFactory(version, self)
 
326
            else:
 
327
                yield AbsentContentFactory((version,))
 
328
 
 
329
    def get_parent_map(self, version_ids):
 
330
        """See VersionedFile.get_parent_map."""
 
331
        result = {}
 
332
        for version_id in version_ids:
 
333
            if version_id == NULL_REVISION:
 
334
                parents = ()
 
335
            else:
 
336
                try:
 
337
                    parents = tuple(
 
338
                        map(self._idx_to_name,
 
339
                            self._parents[self._lookup(version_id)]))
 
340
                except RevisionNotPresent:
 
341
                    continue
 
342
            result[version_id] = parents
 
343
        return result
 
344
 
 
345
    def get_parents_with_ghosts(self, version_id):
 
346
        raise NotImplementedError(self.get_parents_with_ghosts)
 
347
 
 
348
    def insert_record_stream(self, stream):
 
349
        """Insert a record stream into this versioned file.
 
350
 
 
351
        :param stream: A stream of records to insert.
 
352
        :return: None
 
353
        :seealso VersionedFile.get_record_stream:
 
354
        """
 
355
        adapters = {}
 
356
        for record in stream:
 
357
            # Raise an error when a record is missing.
 
358
            if record.storage_kind == 'absent':
 
359
                raise RevisionNotPresent([record.key[0]], self)
 
360
            # adapt to non-tuple interface
 
361
            parents = [parent[0] for parent in record.parents]
 
362
            if (record.storage_kind == 'fulltext'
 
363
                or record.storage_kind == 'chunked'):
 
364
                self.add_lines(record.key[0], parents,
 
365
                    osutils.chunks_to_lines(record.get_bytes_as('chunked')))
 
366
            else:
 
367
                adapter_key = record.storage_kind, 'fulltext'
 
368
                try:
 
369
                    adapter = adapters[adapter_key]
 
370
                except KeyError:
 
371
                    adapter_factory = adapter_registry.get(adapter_key)
 
372
                    adapter = adapter_factory(self)
 
373
                    adapters[adapter_key] = adapter
 
374
                lines = split_lines(adapter.get_bytes(record))
 
375
                try:
 
376
                    self.add_lines(record.key[0], parents, lines)
 
377
                except RevisionAlreadyPresent:
 
378
                    pass
 
379
 
 
380
    def _check_repeated_add(self, name, parents, text, sha1):
 
381
        """Check that a duplicated add is OK.
 
382
 
 
383
        If it is, return the (old) index; otherwise raise an exception.
 
384
        """
 
385
        idx = self._lookup(name)
 
386
        if sorted(self._parents[idx]) != sorted(parents) \
 
387
            or sha1 != self._sha1s[idx]:
 
388
            raise RevisionAlreadyPresent(name, self._weave_name)
 
389
        return idx
 
390
 
 
391
    def _add_lines(self, version_id, parents, lines, parent_texts,
 
392
       left_matching_blocks, nostore_sha, random_id, check_content):
 
393
        """See VersionedFile.add_lines."""
 
394
        idx = self._add(version_id, lines, map(self._lookup, parents),
 
395
            nostore_sha=nostore_sha)
 
396
        return sha_strings(lines), sum(map(len, lines)), idx
 
397
 
 
398
    def _add(self, version_id, lines, parents, sha1=None, nostore_sha=None):
186
399
        """Add a single text on top of the weave.
187
 
  
 
400
 
188
401
        Returns the index number of the newly added version.
189
402
 
 
403
        version_id
 
404
            Symbolic name for this version.
 
405
            (Typically the revision-id of the revision that added it.)
 
406
            If None, a name will be allocated based on the hash. (sha1:SHAHASH)
 
407
 
190
408
        parents
191
409
            List or set of direct parent version numbers.
192
 
            
193
 
        text
194
 
            Sequence of lines to be added in the new version."""
 
410
 
 
411
        lines
 
412
            Sequence of lines to be added in the new version.
 
413
 
 
414
        :param nostore_sha: See VersionedFile.add_lines.
 
415
        """
 
416
        self._check_lines_not_unicode(lines)
 
417
        self._check_lines_are_lines(lines)
 
418
        if not sha1:
 
419
            sha1 = sha_strings(lines)
 
420
        if sha1 == nostore_sha:
 
421
            raise errors.ExistingContent
 
422
        if version_id is None:
 
423
            version_id = "sha1:" + sha1
 
424
        if version_id in self._name_map:
 
425
            return self._check_repeated_add(version_id, parents, lines, sha1)
195
426
 
196
427
        self._check_versions(parents)
197
 
        ## self._check_lines(text)
 
428
        ## self._check_lines(lines)
198
429
        new_version = len(self._parents)
199
430
 
200
 
        import sha
201
 
        s = sha.new()
202
 
        map(s.update, text)
203
 
        sha1 = s.hexdigest()
204
 
        del s
205
 
 
206
 
        # if we abort after here the weave will be corrupt
207
 
        self._parents.append(frozenset(parents))
 
431
        # if we abort after here the (in-memory) weave will be corrupt because only
 
432
        # some fields are updated
 
433
        # XXX: FIXME implement a succeed-or-fail of the rest of this routine.
 
434
        #      - Robert Collins 20060226
 
435
        self._parents.append(parents[:])
208
436
        self._sha1s.append(sha1)
209
 
 
210
 
            
 
437
        self._names.append(version_id)
 
438
        self._name_map[version_id] = new_version
 
439
 
 
440
 
211
441
        if not parents:
212
442
            # special case; adding with no parents revision; can do
213
443
            # this more quickly by just appending unconditionally.
214
444
            # even more specially, if we're adding an empty text we
215
445
            # need do nothing at all.
216
 
            if text:
 
446
            if lines:
217
447
                self._weave.append(('{', new_version))
218
 
                self._weave.extend(text)
219
 
                self._weave.append(('}', new_version))
220
 
        
 
448
                self._weave.extend(lines)
 
449
                self._weave.append(('}', None))
221
450
            return new_version
222
451
 
223
452
        if len(parents) == 1:
225
454
            if sha1 == self._sha1s[pv]:
226
455
                # special case: same as the single parent
227
456
                return new_version
228
 
            
229
 
 
230
 
        ancestors = self.inclusions(parents)
 
457
 
 
458
 
 
459
        ancestors = self._inclusions(parents)
231
460
 
232
461
        l = self._weave
233
462
 
240
469
 
241
470
        # another small special case: a merge, producing the same text
242
471
        # as auto-merge
243
 
        if text == basis_lines:
244
 
            return new_version            
 
472
        if lines == basis_lines:
 
473
            return new_version
245
474
 
246
 
        # add a sentinal, because we can also match against the final line
 
475
        # add a sentinel, because we can also match against the final line
247
476
        basis_lineno.append(len(self._weave))
248
477
 
249
478
        # XXX: which line of the weave should we really consider
253
482
        #print 'basis_lines:', basis_lines
254
483
        #print 'new_lines:  ', lines
255
484
 
256
 
        from difflib import SequenceMatcher
257
 
        s = SequenceMatcher(None, basis_lines, text)
 
485
        s = self._matcher(None, basis_lines, lines)
258
486
 
259
487
        # offset gives the number of lines that have been inserted
260
488
        # into the weave up to the current point; if the original edit instruction
267
495
            #print 'raw match', tag, i1, i2, j1, j2
268
496
            if tag == 'equal':
269
497
                continue
270
 
 
271
498
            i1 = basis_lineno[i1]
272
499
            i2 = basis_lineno[i2]
273
 
 
274
 
            assert 0 <= j1 <= j2 <= len(text)
275
 
 
276
 
            #print tag, i1, i2, j1, j2
277
 
 
278
500
            # the deletion and insertion are handled separately.
279
501
            # first delete the region.
280
502
            if i1 != i2:
287
509
                # i2; we want to insert after this region to make sure
288
510
                # we don't destroy ourselves
289
511
                i = i2 + offset
290
 
                self._weave[i:i] = ([('{', new_version)] 
291
 
                                + text[j1:j2] 
292
 
                                + [('}', new_version)])
 
512
                self._weave[i:i] = ([('{', new_version)]
 
513
                                    + lines[j1:j2]
 
514
                                    + [('}', None)])
293
515
                offset += 2 + (j2 - j1)
294
 
 
295
516
        return new_version
296
517
 
297
 
 
298
 
    def inclusions(self, versions):
 
518
    def _inclusions(self, versions):
299
519
        """Return set of all ancestors of given version(s)."""
 
520
        if not len(versions):
 
521
            return []
300
522
        i = set(versions)
301
 
        v = max(versions)
302
 
        try:
303
 
            while v >= 0:
304
 
                if v in i:
305
 
                    # include all its parents
306
 
                    i.update(self._parents[v])
307
 
                v -= 1
308
 
            return i
309
 
        except IndexError:
310
 
            raise ValueError("version %d not present in weave" % v)
311
 
 
312
 
 
313
 
    def minimal_parents(self, version):
314
 
        """Find the minimal set of parents for the version."""
315
 
        included = self._parents[version]
316
 
        if not included:
317
 
            return []
318
 
        
319
 
        li = list(included)
320
 
        li.sort(reverse=True)
321
 
 
322
 
        mininc = []
323
 
        gotit = set()
324
 
 
325
 
        for pv in li:
326
 
            if pv not in gotit:
327
 
                mininc.append(pv)
328
 
                gotit.update(self.inclusions(pv))
329
 
 
330
 
        assert mininc[0] >= 0
331
 
        assert mininc[-1] < version
332
 
        return mininc
333
 
 
334
 
 
 
523
        for v in xrange(max(versions), 0, -1):
 
524
            if v in i:
 
525
                # include all its parents
 
526
                i.update(self._parents[v])
 
527
        return i
 
528
        ## except IndexError:
 
529
        ##     raise ValueError("version %d not present in weave" % v)
 
530
 
 
531
    def get_ancestry(self, version_ids, topo_sorted=True):
 
532
        """See VersionedFile.get_ancestry."""
 
533
        if isinstance(version_ids, basestring):
 
534
            version_ids = [version_ids]
 
535
        i = self._inclusions([self._lookup(v) for v in version_ids])
 
536
        return [self._idx_to_name(v) for v in i]
335
537
 
336
538
    def _check_lines(self, text):
337
539
        if not isinstance(text, list):
341
543
            if not isinstance(l, basestring):
342
544
                raise ValueError("text line should be a string or unicode, not %s"
343
545
                                 % type(l))
344
 
        
 
546
 
345
547
 
346
548
 
347
549
    def _check_versions(self, indexes):
352
554
            except IndexError:
353
555
                raise IndexError("invalid version number %r" % i)
354
556
 
355
 
    
356
 
    def annotate(self, index):
357
 
        return list(self.annotate_iter(index))
358
 
 
359
 
 
360
 
    def annotate_iter(self, version):
361
 
        """Yield list of (index-id, line) pairs for the specified version.
 
557
    def _compatible_parents(self, my_parents, other_parents):
 
558
        """During join check that other_parents are joinable with my_parents.
 
559
 
 
560
        Joinable is defined as 'is a subset of' - supersets may require
 
561
        regeneration of diffs, but subsets do not.
 
562
        """
 
563
        return len(other_parents.difference(my_parents)) == 0
 
564
 
 
565
    def annotate(self, version_id):
 
566
        """Return a list of (version-id, line) tuples for version_id.
362
567
 
363
568
        The index indicates when the line originated in the weave."""
364
 
        for origin, lineno, text in self._extract([version]):
365
 
            yield origin, text
366
 
 
367
 
 
368
 
    def _walk(self):
369
 
        """Walk the weave.
370
 
 
371
 
        Yields sequence of
372
 
        (lineno, insert, deletes, text)
373
 
        for each literal line.
374
 
        """
375
 
        
 
569
        incls = [self._lookup(version_id)]
 
570
        return [(self._idx_to_name(origin), text) for origin, lineno, text in
 
571
            self._extract(incls)]
 
572
 
 
573
    def iter_lines_added_or_present_in_versions(self, version_ids=None,
 
574
                                                pb=None):
 
575
        """See VersionedFile.iter_lines_added_or_present_in_versions()."""
 
576
        if version_ids is None:
 
577
            version_ids = self.versions()
 
578
        version_ids = set(version_ids)
 
579
        for lineno, inserted, deletes, line in self._walk_internal(version_ids):
 
580
            if inserted not in version_ids: continue
 
581
            if line[-1] != '\n':
 
582
                yield line + '\n', inserted
 
583
            else:
 
584
                yield line, inserted
 
585
 
 
586
    def _walk_internal(self, version_ids=None):
 
587
        """Helper method for weave actions."""
 
588
 
376
589
        istack = []
377
590
        dset = set()
378
591
 
379
592
        lineno = 0         # line of weave, 0-based
380
593
 
381
594
        for l in self._weave:
382
 
            if isinstance(l, tuple):
 
595
            if l.__class__ == tuple:
383
596
                c, v = l
384
597
                isactive = None
385
598
                if c == '{':
386
 
                    istack.append(v)
 
599
                    istack.append(self._names[v])
387
600
                elif c == '}':
388
 
                    oldv = istack.pop()
 
601
                    istack.pop()
389
602
                elif c == '[':
390
 
                    assert v not in dset
391
 
                    dset.add(v)
 
603
                    dset.add(self._names[v])
392
604
                elif c == ']':
393
 
                    dset.remove(v)
394
 
                else:
395
 
                    raise WeaveFormatError('unexpected instruction %r'
396
 
                                           % v)
397
 
            else:
398
 
                assert isinstance(l, basestring)
399
 
                assert istack
400
 
                yield lineno, istack[-1], dset, l
401
 
            lineno += 1
402
 
 
403
 
 
404
 
 
405
 
    def _extract(self, versions):
406
 
        """Yield annotation of lines in included set.
407
 
 
408
 
        Yields a sequence of tuples (origin, lineno, text), where
409
 
        origin is the origin version, lineno the index in the weave,
410
 
        and text the text of the line.
411
 
 
412
 
        The set typically but not necessarily corresponds to a version.
413
 
        """
414
 
        included = self.inclusions(versions)
415
 
 
416
 
        istack = []
417
 
        dset = set()
418
 
 
419
 
        lineno = 0         # line of weave, 0-based
420
 
 
421
 
        isactive = None
422
 
 
423
 
        result = []
424
 
 
425
 
        WFE = WeaveFormatError
426
 
 
427
 
        for l in self._weave:
428
 
            if isinstance(l, tuple):
429
 
                c, v = l
430
 
                isactive = None
431
 
                if c == '{':
432
 
                    assert v not in istack
433
 
                    istack.append(v)
434
 
                elif c == '}':
435
 
                    oldv = istack.pop()
436
 
                    assert oldv == v
437
 
                elif c == '[':
438
 
                    if v in included:
439
 
                        assert v not in dset
440
 
                        dset.add(v)
441
 
                else:
442
 
                    assert c == ']'
443
 
                    if v in included:
444
 
                        assert v in dset
445
 
                        dset.remove(v)
446
 
            else:
447
 
                assert isinstance(l, basestring)
448
 
                if isactive is None:
449
 
                    isactive = (not dset) and istack and (istack[-1] in included)
450
 
                if isactive:
451
 
                    result.append((istack[-1], lineno, l))
 
605
                    dset.remove(self._names[v])
 
606
                else:
 
607
                    raise WeaveFormatError('unexpected instruction %r' % v)
 
608
            else:
 
609
                yield lineno, istack[-1], frozenset(dset), l
452
610
            lineno += 1
453
611
 
454
612
        if istack:
455
 
            raise WFE("unclosed insertion blocks at end of weave",
456
 
                                   istack)
 
613
            raise WeaveFormatError("unclosed insertion blocks "
 
614
                    "at end of weave: %s" % istack)
457
615
        if dset:
458
 
            raise WFE("unclosed deletion blocks at end of weave",
459
 
                                   dset)
460
 
 
461
 
        return result
462
 
    
463
 
 
464
 
 
465
 
    def get_iter(self, version):
466
 
        """Yield lines for the specified version."""
467
 
        for origin, lineno, line in self._extract([version]):
468
 
            yield line
469
 
 
470
 
 
471
 
    def get(self, index):
472
 
        return list(self.get_iter(index))
473
 
 
474
 
 
475
 
    def mash_iter(self, included):
476
 
        """Return composed version of multiple included versions."""
477
 
        for origin, lineno, text in self._extract(included):
478
 
            yield text
479
 
 
480
 
 
481
 
    def dump(self, to_file):
482
 
        from pprint import pprint
483
 
        print >>to_file, "Weave._weave = ",
484
 
        pprint(self._weave, to_file)
485
 
        print >>to_file, "Weave._parents = ",
486
 
        pprint(self._parents, to_file)
487
 
 
488
 
 
489
 
 
490
 
    def numversions(self):
491
 
        l = len(self._parents)
492
 
        assert l == len(self._sha1s)
493
 
        return l
494
 
 
495
 
 
496
 
    def __len__(self):
497
 
        return self.numversions()
498
 
 
499
 
 
500
 
    def check(self, progress_bar=None):
501
 
        # check no circular inclusions
502
 
        for version in range(self.numversions()):
503
 
            inclusions = list(self._parents[version])
504
 
            if inclusions:
505
 
                inclusions.sort()
506
 
                if inclusions[-1] >= version:
507
 
                    raise WeaveFormatError("invalid included version %d for index %d"
508
 
                                           % (inclusions[-1], version))
509
 
 
510
 
        # try extracting all versions; this is a bit slow and parallel
511
 
        # extraction could be used
512
 
        import sha
513
 
        nv = self.numversions()
514
 
        for version in range(nv):
515
 
            if progress_bar:
516
 
                progress_bar.update('checking text', version, nv)
517
 
            s = sha.new()
518
 
            for l in self.get_iter(version):
519
 
                s.update(l)
520
 
            hd = s.hexdigest()
521
 
            expected = self._sha1s[version]
522
 
            if hd != expected:
523
 
                raise WeaveError("mismatched sha1 for version %d; "
524
 
                                 "got %s, expected %s"
525
 
                                 % (version, hd, expected))
526
 
 
527
 
        # TODO: check insertions are properly nested, that there are
528
 
        # no lines outside of insertion blocks, that deletions are
529
 
        # properly paired, etc.
530
 
 
531
 
 
532
 
 
533
 
    def merge(self, merge_versions):
534
 
        """Automerge and mark conflicts between versions.
535
 
 
536
 
        This returns a sequence, each entry describing alternatives
537
 
        for a chunk of the file.  Each of the alternatives is given as
538
 
        a list of lines.
539
 
 
540
 
        If there is a chunk of the file where there's no diagreement,
541
 
        only one alternative is given.
542
 
        """
543
 
 
544
 
        # approach: find the included versions common to all the
545
 
        # merged versions
546
 
        raise NotImplementedError()
547
 
 
548
 
 
549
 
 
550
 
    def _delta(self, included, lines):
551
 
        """Return changes from basis to new revision.
552
 
 
553
 
        The old text for comparison is the union of included revisions.
554
 
 
555
 
        This is used in inserting a new text.
556
 
 
557
 
        Delta is returned as a sequence of
558
 
        (weave1, weave2, newlines).
559
 
 
560
 
        This indicates that weave1:weave2 of the old weave should be
561
 
        replaced by the sequence of lines in newlines.  Note that
562
 
        these line numbers are positions in the total weave and don't
563
 
        correspond to the lines in any extracted version, or even the
564
 
        extracted union of included versions.
565
 
 
566
 
        If line1=line2, this is a pure insert; if newlines=[] this is a
567
 
        pure delete.  (Similar to difflib.)
568
 
        """
569
 
 
570
 
 
571
 
            
 
616
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
 
617
                                   % dset)
 
618
 
572
619
    def plan_merge(self, ver_a, ver_b):
573
620
        """Return pseudo-annotation indicating how the two versions merge.
574
621
 
577
624
 
578
625
        Weave lines present in none of them are skipped entirely.
579
626
        """
580
 
        inc_a = self.inclusions([ver_a])
581
 
        inc_b = self.inclusions([ver_b])
 
627
        inc_a = set(self.get_ancestry([ver_a]))
 
628
        inc_b = set(self.get_ancestry([ver_b]))
582
629
        inc_c = inc_a & inc_b
583
630
 
584
 
        for lineno, insert, deleteset, line in self._walk():
 
631
        for lineno, insert, deleteset, line in self._walk_internal([ver_a, ver_b]):
585
632
            if deleteset & inc_c:
586
633
                # killed in parent; can't be in either a or b
587
634
                # not relevant to our work
613
660
                # not in either revision
614
661
                yield 'irrelevant', line
615
662
 
616
 
        yield 'unchanged', ''           # terminator
617
 
 
618
 
 
619
 
 
620
 
    def weave_merge(self, plan):
621
 
        lines_a = []
622
 
        lines_b = []
623
 
        ch_a = ch_b = False
624
 
 
625
 
        for state, line in plan:
626
 
            if state == 'unchanged' or state == 'killed-both':
627
 
                # resync and flush queued conflicts changes if any
628
 
                if not lines_a and not lines_b:
629
 
                    pass
630
 
                elif ch_a and not ch_b:
631
 
                    # one-sided change:                    
632
 
                    for l in lines_a: yield l
633
 
                elif ch_b and not ch_a:
634
 
                    for l in lines_b: yield l
635
 
                elif lines_a == lines_b:
636
 
                    for l in lines_a: yield l
 
663
    def _extract(self, versions):
 
664
        """Yield annotation of lines in included set.
 
665
 
 
666
        Yields a sequence of tuples (origin, lineno, text), where
 
667
        origin is the origin version, lineno the index in the weave,
 
668
        and text the text of the line.
 
669
 
 
670
        The set typically but not necessarily corresponds to a version.
 
671
        """
 
672
        for i in versions:
 
673
            if not isinstance(i, int):
 
674
                raise ValueError(i)
 
675
 
 
676
        included = self._inclusions(versions)
 
677
 
 
678
        istack = []
 
679
        iset = set()
 
680
        dset = set()
 
681
 
 
682
        lineno = 0         # line of weave, 0-based
 
683
 
 
684
        isactive = None
 
685
 
 
686
        result = []
 
687
 
 
688
        WFE = WeaveFormatError
 
689
 
 
690
        # wow.
 
691
        #  449       0   4474.6820   2356.5590   bzrlib.weave:556(_extract)
 
692
        #  +285282   0   1676.8040   1676.8040   +<isinstance>
 
693
        # 1.6 seconds in 'isinstance'.
 
694
        # changing the first isinstance:
 
695
        #  449       0   2814.2660   1577.1760   bzrlib.weave:556(_extract)
 
696
        #  +140414   0    762.8050    762.8050   +<isinstance>
 
697
        # note that the inline time actually dropped (less function calls)
 
698
        # and total processing time was halved.
 
699
        # we're still spending ~1/4 of the method in isinstance though.
 
700
        # so lets hard code the acceptable string classes we expect:
 
701
        #  449       0   1202.9420    786.2930   bzrlib.weave:556(_extract)
 
702
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list'
 
703
        #                                          objects>
 
704
        # yay, down to ~1/4 the initial extract time, and our inline time
 
705
        # has shrunk again, with isinstance no longer dominating.
 
706
        # tweaking the stack inclusion test to use a set gives:
 
707
        #  449       0   1122.8030    713.0080   bzrlib.weave:556(_extract)
 
708
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list'
 
709
        #                                          objects>
 
710
        # - a 5% win, or possibly just noise. However with large istacks that
 
711
        # 'in' test could dominate, so I'm leaving this change in place -
 
712
        # when its fast enough to consider profiling big datasets we can review.
 
713
 
 
714
 
 
715
 
 
716
 
 
717
        for l in self._weave:
 
718
            if l.__class__ == tuple:
 
719
                c, v = l
 
720
                isactive = None
 
721
                if c == '{':
 
722
                    istack.append(v)
 
723
                    iset.add(v)
 
724
                elif c == '}':
 
725
                    iset.remove(istack.pop())
 
726
                elif c == '[':
 
727
                    if v in included:
 
728
                        dset.add(v)
 
729
                elif c == ']':
 
730
                    if v in included:
 
731
                        dset.remove(v)
637
732
                else:
638
 
                    yield '<<<<\n'
639
 
                    for l in lines_a: yield l
640
 
                    yield '====\n'
641
 
                    for l in lines_b: yield l
642
 
                    yield '>>>>\n'
643
 
 
644
 
                del lines_a[:]
645
 
                del lines_b[:]
646
 
                ch_a = ch_b = False
647
 
                
648
 
            if state == 'unchanged':
649
 
                if line:
650
 
                    yield line
651
 
            elif state == 'killed-a':
652
 
                ch_a = True
653
 
                lines_b.append(line)
654
 
            elif state == 'killed-b':
655
 
                ch_b = True
656
 
                lines_a.append(line)
657
 
            elif state == 'new-a':
658
 
                ch_a = True
659
 
                lines_a.append(line)
660
 
            elif state == 'new-b':
661
 
                ch_b = True
662
 
                lines_b.append(line)
663
 
            else:
664
 
                assert state in ('irrelevant', 'ghost-a', 'ghost-b', 'killed-base',
665
 
                                 'killed-both'), \
666
 
                       state
667
 
 
668
 
                
669
 
 
670
 
 
671
 
 
672
 
 
673
 
 
674
 
def weave_info(w):
675
 
    """Show some text information about the weave."""
676
 
    print '%6s %40s %20s' % ('ver', 'sha1', 'parents')
677
 
    for i in (6, 40, 20):
678
 
        print '-' * i,
679
 
    print
680
 
    for i in range(w.numversions()):
681
 
        sha1 = w._sha1s[i]
682
 
        print '%6d %40s %s' % (i, sha1, ' '.join(map(str, w._parents[i])))
683
 
 
684
 
 
685
 
 
686
 
def weave_stats(weave_file):
687
 
    from bzrlib.progress import ProgressBar
688
 
    from bzrlib.weavefile import read_weave
689
 
 
690
 
    pb = ProgressBar()
691
 
 
692
 
    wf = file(weave_file, 'rb')
693
 
    w = read_weave(wf)
694
 
    # FIXME: doesn't work on pipes
695
 
    weave_size = wf.tell()
696
 
 
697
 
    total = 0
698
 
    vers = len(w)
699
 
    for i in range(vers):
700
 
        pb.update('checking sizes', i, vers)
701
 
        for line in w.get_iter(i):
702
 
            total += len(line)
703
 
 
704
 
    pb.clear()
705
 
 
706
 
    print 'versions          %9d' % vers
707
 
    print 'weave file        %9d bytes' % weave_size
708
 
    print 'total contents    %9d bytes' % total
709
 
    print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
710
 
    if vers:
711
 
        avg = total/vers
712
 
        print 'average size      %9d bytes' % avg
713
 
        print 'relative size     %9.2fx' % (float(weave_size) / float(avg))
714
 
 
715
 
 
716
 
def usage():
717
 
    print """bzr weave tool
718
 
 
719
 
Experimental tool for weave algorithm.
720
 
 
721
 
usage:
722
 
    weave init WEAVEFILE
723
 
        Create an empty weave file
724
 
    weave get WEAVEFILE VERSION
725
 
        Write out specified version.
726
 
    weave check WEAVEFILE
727
 
        Check consistency of all versions.
728
 
    weave info WEAVEFILE
729
 
        Display table of contents.
730
 
    weave add WEAVEFILE [BASE...] < NEWTEXT
731
 
        Add NEWTEXT, with specified parent versions.
732
 
    weave annotate WEAVEFILE VERSION
733
 
        Display origin of each line.
734
 
    weave mash WEAVEFILE VERSION...
735
 
        Display composite of all selected versions.
736
 
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
737
 
        Auto-merge two versions and display conflicts.
738
 
 
739
 
example:
740
 
 
741
 
    % weave init foo.weave
742
 
    % vi foo.txt
743
 
    % weave add foo.weave < foo.txt
744
 
    added version 0
745
 
 
746
 
    (create updated version)
747
 
    % vi foo.txt
748
 
    % weave get foo.weave 0 | diff -u - foo.txt
749
 
    % weave add foo.weave 0 < foo.txt
750
 
    added version 1
751
 
 
752
 
    % weave get foo.weave 0 > foo.txt       (create forked version)
753
 
    % vi foo.txt
754
 
    % weave add foo.weave 0 < foo.txt
755
 
    added version 2
756
 
 
757
 
    % weave merge foo.weave 1 2 > foo.txt   (merge them)
758
 
    % vi foo.txt                            (resolve conflicts)
759
 
    % weave add foo.weave 1 2 < foo.txt     (commit merged version)     
760
 
    
761
 
"""
762
 
    
763
 
 
764
 
 
765
 
def main(argv):
766
 
    import sys
767
 
    import os
768
 
    from weavefile import write_weave, read_weave
769
 
    from bzrlib.progress import ProgressBar
770
 
 
771
 
    #import psyco
772
 
    #psyco.full()
773
 
 
774
 
    cmd = argv[1]
775
 
 
776
 
    def readit():
777
 
        return read_weave(file(argv[2], 'rb'))
778
 
    
779
 
    if cmd == 'help':
780
 
        usage()
781
 
    elif cmd == 'add':
782
 
        w = readit()
783
 
        # at the moment, based on everything in the file
784
 
        parents = map(int, argv[3:])
785
 
        lines = sys.stdin.readlines()
786
 
        ver = w.add(parents, lines)
787
 
        write_weave(w, file(argv[2], 'wb'))
788
 
        print 'added version %d' % ver
789
 
    elif cmd == 'init':
790
 
        fn = argv[2]
791
 
        if os.path.exists(fn):
792
 
            raise IOError("file exists")
793
 
        w = Weave()
794
 
        write_weave(w, file(fn, 'wb'))
795
 
    elif cmd == 'get': # get one version
796
 
        w = readit()
797
 
        sys.stdout.writelines(w.get_iter(int(argv[3])))
798
 
        
799
 
    elif cmd == 'mash': # get composite
800
 
        w = readit()
801
 
        sys.stdout.writelines(w.mash_iter(map(int, argv[3:])))
802
 
 
803
 
    elif cmd == 'annotate':
804
 
        w = readit()
805
 
        # newline is added to all lines regardless; too hard to get
806
 
        # reasonable formatting otherwise
807
 
        lasto = None
808
 
        for origin, text in w.annotate(int(argv[3])):
809
 
            text = text.rstrip('\r\n')
810
 
            if origin == lasto:
811
 
                print '      | %s' % (text)
812
 
            else:
813
 
                print '%5d | %s' % (origin, text)
814
 
                lasto = origin
815
 
                
816
 
    elif cmd == 'info':
817
 
        weave_info(readit())
818
 
 
819
 
    elif cmd == 'stats':
820
 
        weave_stats(argv[2])
821
 
        
822
 
    elif cmd == 'check':
823
 
        w = readit()
824
 
        pb = ProgressBar()
825
 
        w.check(pb)
826
 
        pb.clear()
827
 
        print '%d versions ok' % w.numversions()
828
 
 
829
 
    elif cmd == 'inclusions':
830
 
        w = readit()
831
 
        print ' '.join(map(str, w.inclusions([int(argv[3])])))
832
 
 
833
 
    elif cmd == 'parents':
834
 
        w = readit()
835
 
        print ' '.join(map(str, w._parents[int(argv[3])]))
836
 
 
837
 
    elif cmd == 'plan-merge':
838
 
        w = readit()
839
 
        for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
840
 
            if line:
841
 
                print '%14s | %s' % (state, line),
842
 
 
843
 
    elif cmd == 'merge':
844
 
        w = readit()
845
 
        p = w.plan_merge(int(argv[3]), int(argv[4]))
846
 
        sys.stdout.writelines(w.weave_merge(p))
847
 
            
848
 
    elif cmd == 'mash-merge':
849
 
        if len(argv) != 5:
850
 
            usage()
851
 
            return 1
852
 
 
853
 
        w = readit()
854
 
        v1, v2 = map(int, argv[3:5])
855
 
 
856
 
        basis = w.inclusions([v1]).intersection(w.inclusions([v2]))
857
 
 
858
 
        base_lines = list(w.mash_iter(basis))
859
 
        a_lines = list(w.get(v1))
860
 
        b_lines = list(w.get(v2))
861
 
 
862
 
        from bzrlib.merge3 import Merge3
863
 
        m3 = Merge3(base_lines, a_lines, b_lines)
864
 
 
865
 
        name_a = 'version %d' % v1
866
 
        name_b = 'version %d' % v2
867
 
        sys.stdout.writelines(m3.merge_lines(name_a=name_a, name_b=name_b))
868
 
    else:
869
 
        raise ValueError('unknown command %r' % cmd)
870
 
    
871
 
 
872
 
if __name__ == '__main__':
873
 
    import sys
874
 
    sys.exit(main(sys.argv))
 
733
                    raise AssertionError()
 
734
            else:
 
735
                if isactive is None:
 
736
                    isactive = (not dset) and istack and (istack[-1] in included)
 
737
                if isactive:
 
738
                    result.append((istack[-1], lineno, l))
 
739
            lineno += 1
 
740
        if istack:
 
741
            raise WeaveFormatError("unclosed insertion blocks "
 
742
                    "at end of weave: %s" % istack)
 
743
        if dset:
 
744
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
 
745
                                   % dset)
 
746
        return result
 
747
 
 
748
    def _maybe_lookup(self, name_or_index):
 
749
        """Convert possible symbolic name to index, or pass through indexes.
 
750
 
 
751
        NOT FOR PUBLIC USE.
 
752
        """
 
753
        if isinstance(name_or_index, (int, long)):
 
754
            return name_or_index
 
755
        else:
 
756
            return self._lookup(name_or_index)
 
757
 
 
758
    def get_lines(self, version_id):
 
759
        """See VersionedFile.get_lines()."""
 
760
        int_index = self._maybe_lookup(version_id)
 
761
        result = [line for (origin, lineno, line) in self._extract([int_index])]
 
762
        expected_sha1 = self._sha1s[int_index]
 
763
        measured_sha1 = sha_strings(result)
 
764
        if measured_sha1 != expected_sha1:
 
765
            raise errors.WeaveInvalidChecksum(
 
766
                    'file %s, revision %s, expected: %s, measured %s'
 
767
                    % (self._weave_name, version_id,
 
768
                       expected_sha1, measured_sha1))
 
769
        return result
 
770
 
 
771
    def get_sha1s(self, version_ids):
 
772
        """See VersionedFile.get_sha1s()."""
 
773
        result = {}
 
774
        for v in version_ids:
 
775
            result[v] = self._sha1s[self._lookup(v)]
 
776
        return result
 
777
 
 
778
    def num_versions(self):
 
779
        """How many versions are in this weave?"""
 
780
        l = len(self._parents)
 
781
        return l
 
782
 
 
783
    __len__ = num_versions
 
784
 
 
785
    def check(self, progress_bar=None):
 
786
        # TODO evaluate performance hit of using string sets in this routine.
 
787
        # TODO: check no circular inclusions
 
788
        # TODO: create a nested progress bar
 
789
        for version in range(self.num_versions()):
 
790
            inclusions = list(self._parents[version])
 
791
            if inclusions:
 
792
                inclusions.sort()
 
793
                if inclusions[-1] >= version:
 
794
                    raise WeaveFormatError("invalid included version %d for index %d"
 
795
                                           % (inclusions[-1], version))
 
796
 
 
797
        # try extracting all versions; parallel extraction is used
 
798
        nv = self.num_versions()
 
799
        sha1s = {}
 
800
        texts = {}
 
801
        inclusions = {}
 
802
        for i in range(nv):
 
803
            # For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
 
804
            # The problem is that set membership is much more expensive
 
805
            name = self._idx_to_name(i)
 
806
            sha1s[name] = sha()
 
807
            texts[name] = []
 
808
            new_inc = set([name])
 
809
            for p in self._parents[i]:
 
810
                new_inc.update(inclusions[self._idx_to_name(p)])
 
811
 
 
812
            if set(new_inc) != set(self.get_ancestry(name)):
 
813
                raise AssertionError(
 
814
                    'failed %s != %s'
 
815
                    % (set(new_inc), set(self.get_ancestry(name))))
 
816
            inclusions[name] = new_inc
 
817
 
 
818
        nlines = len(self._weave)
 
819
 
 
820
        update_text = 'checking weave'
 
821
        if self._weave_name:
 
822
            short_name = os.path.basename(self._weave_name)
 
823
            update_text = 'checking %s' % (short_name,)
 
824
            update_text = update_text[:25]
 
825
 
 
826
        for lineno, insert, deleteset, line in self._walk_internal():
 
827
            if progress_bar:
 
828
                progress_bar.update(update_text, lineno, nlines)
 
829
 
 
830
            for name, name_inclusions in inclusions.items():
 
831
                # The active inclusion must be an ancestor,
 
832
                # and no ancestors must have deleted this line,
 
833
                # because we don't support resurrection.
 
834
                if (insert in name_inclusions) and not (deleteset & name_inclusions):
 
835
                    sha1s[name].update(line)
 
836
 
 
837
        for i in range(nv):
 
838
            version = self._idx_to_name(i)
 
839
            hd = sha1s[version].hexdigest()
 
840
            expected = self._sha1s[i]
 
841
            if hd != expected:
 
842
                raise errors.WeaveInvalidChecksum(
 
843
                        "mismatched sha1 for version %s: "
 
844
                        "got %s, expected %s"
 
845
                        % (version, hd, expected))
 
846
 
 
847
        # TODO: check insertions are properly nested, that there are
 
848
        # no lines outside of insertion blocks, that deletions are
 
849
        # properly paired, etc.
 
850
 
 
851
    def _imported_parents(self, other, other_idx):
 
852
        """Return list of parents in self corresponding to indexes in other."""
 
853
        new_parents = []
 
854
        for parent_idx in other._parents[other_idx]:
 
855
            parent_name = other._names[parent_idx]
 
856
            if parent_name not in self._name_map:
 
857
                # should not be possible
 
858
                raise WeaveError("missing parent {%s} of {%s} in %r"
 
859
                                 % (parent_name, other._name_map[other_idx], self))
 
860
            new_parents.append(self._name_map[parent_name])
 
861
        return new_parents
 
862
 
 
863
    def _check_version_consistent(self, other, other_idx, name):
 
864
        """Check if a version in consistent in this and other.
 
865
 
 
866
        To be consistent it must have:
 
867
 
 
868
         * the same text
 
869
         * the same direct parents (by name, not index, and disregarding
 
870
           order)
 
871
 
 
872
        If present & correct return True;
 
873
        if not present in self return False;
 
874
        if inconsistent raise error."""
 
875
        this_idx = self._name_map.get(name, -1)
 
876
        if this_idx != -1:
 
877
            if self._sha1s[this_idx] != other._sha1s[other_idx]:
 
878
                raise errors.WeaveTextDiffers(name, self, other)
 
879
            self_parents = self._parents[this_idx]
 
880
            other_parents = other._parents[other_idx]
 
881
            n1 = set([self._names[i] for i in self_parents])
 
882
            n2 = set([other._names[i] for i in other_parents])
 
883
            if not self._compatible_parents(n1, n2):
 
884
                raise WeaveParentMismatch("inconsistent parents "
 
885
                    "for version {%s}: %s vs %s" % (name, n1, n2))
 
886
            else:
 
887
                return True         # ok!
 
888
        else:
 
889
            return False
 
890
 
 
891
    def _reweave(self, other, pb, msg):
 
892
        """Reweave self with other - internal helper for join().
 
893
 
 
894
        :param other: The other weave to merge
 
895
        :param pb: An optional progress bar, indicating how far done we are
 
896
        :param msg: An optional message for the progress
 
897
        """
 
898
        new_weave = _reweave(self, other, pb=pb, msg=msg)
 
899
        self._copy_weave_content(new_weave)
 
900
 
 
901
    def _copy_weave_content(self, otherweave):
 
902
        """adsorb the content from otherweave."""
 
903
        for attr in self.__slots__:
 
904
            if attr != '_weave_name':
 
905
                setattr(self, attr, copy(getattr(otherweave, attr)))
 
906
 
 
907
 
 
908
class WeaveFile(Weave):
 
909
    """A WeaveFile represents a Weave on disk and writes on change."""
 
910
 
 
911
    WEAVE_SUFFIX = '.weave'
 
912
 
 
913
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w', get_scope=None):
 
914
        """Create a WeaveFile.
 
915
 
 
916
        :param create: If not True, only open an existing knit.
 
917
        """
 
918
        super(WeaveFile, self).__init__(name, access_mode, get_scope=get_scope,
 
919
            allow_reserved=False)
 
920
        self._transport = transport
 
921
        self._filemode = filemode
 
922
        try:
 
923
            f = self._transport.get(name + WeaveFile.WEAVE_SUFFIX)
 
924
            _read_weave_v5(StringIO(f.read()), self)
 
925
        except errors.NoSuchFile:
 
926
            if not create:
 
927
                raise
 
928
            # new file, save it
 
929
            self._save()
 
930
 
 
931
    def _add_lines(self, version_id, parents, lines, parent_texts,
 
932
        left_matching_blocks, nostore_sha, random_id, check_content):
 
933
        """Add a version and save the weave."""
 
934
        self.check_not_reserved_id(version_id)
 
935
        result = super(WeaveFile, self)._add_lines(version_id, parents, lines,
 
936
            parent_texts, left_matching_blocks, nostore_sha, random_id,
 
937
            check_content)
 
938
        self._save()
 
939
        return result
 
940
 
 
941
    def copy_to(self, name, transport):
 
942
        """See VersionedFile.copy_to()."""
 
943
        # as we are all in memory always, just serialise to the new place.
 
944
        sio = StringIO()
 
945
        write_weave_v5(self, sio)
 
946
        sio.seek(0)
 
947
        transport.put_file(name + WeaveFile.WEAVE_SUFFIX, sio, self._filemode)
 
948
 
 
949
    def _save(self):
 
950
        """Save the weave."""
 
951
        self._check_write_ok()
 
952
        sio = StringIO()
 
953
        write_weave_v5(self, sio)
 
954
        sio.seek(0)
 
955
        bytes = sio.getvalue()
 
956
        path = self._weave_name + WeaveFile.WEAVE_SUFFIX
 
957
        try:
 
958
            self._transport.put_bytes(path, bytes, self._filemode)
 
959
        except errors.NoSuchFile:
 
960
            self._transport.mkdir(dirname(path))
 
961
            self._transport.put_bytes(path, bytes, self._filemode)
 
962
 
 
963
    @staticmethod
 
964
    def get_suffixes():
 
965
        """See VersionedFile.get_suffixes()."""
 
966
        return [WeaveFile.WEAVE_SUFFIX]
 
967
 
 
968
    def insert_record_stream(self, stream):
 
969
        super(WeaveFile, self).insert_record_stream(stream)
 
970
        self._save()
 
971
 
 
972
 
 
973
def _reweave(wa, wb, pb=None, msg=None):
 
974
    """Combine two weaves and return the result.
 
975
 
 
976
    This works even if a revision R has different parents in
 
977
    wa and wb.  In the resulting weave all the parents are given.
 
978
 
 
979
    This is done by just building up a new weave, maintaining ordering
 
980
    of the versions in the two inputs.  More efficient approaches
 
981
    might be possible but it should only be necessary to do
 
982
    this operation rarely, when a new previously ghost version is
 
983
    inserted.
 
984
 
 
985
    :param pb: An optional progress bar, indicating how far done we are
 
986
    :param msg: An optional message for the progress
 
987
    """
 
988
    wr = Weave()
 
989
    ia = ib = 0
 
990
    queue_a = range(wa.num_versions())
 
991
    queue_b = range(wb.num_versions())
 
992
    # first determine combined parents of all versions
 
993
    # map from version name -> all parent names
 
994
    combined_parents = _reweave_parent_graphs(wa, wb)
 
995
    mutter("combined parents: %r", combined_parents)
 
996
    order = tsort.topo_sort(combined_parents.iteritems())
 
997
    mutter("order to reweave: %r", order)
 
998
 
 
999
    if pb and not msg:
 
1000
        msg = 'reweave'
 
1001
 
 
1002
    for idx, name in enumerate(order):
 
1003
        if pb:
 
1004
            pb.update(msg, idx, len(order))
 
1005
        if name in wa._name_map:
 
1006
            lines = wa.get_lines(name)
 
1007
            if name in wb._name_map:
 
1008
                lines_b = wb.get_lines(name)
 
1009
                if lines != lines_b:
 
1010
                    mutter('Weaves differ on content. rev_id {%s}', name)
 
1011
                    mutter('weaves: %s, %s', wa._weave_name, wb._weave_name)
 
1012
                    import difflib
 
1013
                    lines = list(difflib.unified_diff(lines, lines_b,
 
1014
                            wa._weave_name, wb._weave_name))
 
1015
                    mutter('lines:\n%s', ''.join(lines))
 
1016
                    raise errors.WeaveTextDiffers(name, wa, wb)
 
1017
        else:
 
1018
            lines = wb.get_lines(name)
 
1019
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
 
1020
    return wr
 
1021
 
 
1022
 
 
1023
def _reweave_parent_graphs(wa, wb):
 
1024
    """Return combined parent ancestry for two weaves.
 
1025
 
 
1026
    Returned as a list of (version_name, set(parent_names))"""
 
1027
    combined = {}
 
1028
    for weave in [wa, wb]:
 
1029
        for idx, name in enumerate(weave._names):
 
1030
            p = combined.setdefault(name, set())
 
1031
            p.update(map(weave._idx_to_name, weave._parents[idx]))
 
1032
    return combined