← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Vincent Ladeuil
  • Date: 2010-04-23 08:51:52 UTC
  • mfrom: (5131.2.6 support_OO_flag)
  • mto: This revision was merged to the branch mainline in revision 5179.
  • Revision ID: v.ladeuil+lp@free.fr-20100423085152-uoewc1vnkwqhw0pj
Manually assign docstrings to command objects, so that they work with python -OO

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