← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Martin Pool
  • Date: 2009-06-19 06:21:13 UTC
  • mto: This revision was merged to the branch mainline in revision 4558.
  • Revision ID: mbp@sourcefrog.net-20090619062113-019bp0a3bl2y4nkx
Un-soft-deprecate _supports_progress - still useful

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
 
 
52
 
 
53
 
 
54
 
# TODO: Perhaps have copy method for Weave instances?
55
22
 
56
23
# XXX: If we do weaves this way, will a merge still behave the same
57
24
# way if it's done in a different order?  That's a pretty desirable
58
25
# property.
59
26
 
60
27
# TODO: Nothing here so far assumes the lines are really \n newlines,
61
 
# 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
62
29
# binaries, perhaps by naively splitting on \n or perhaps using
63
30
# something like a rolling checksum.
64
31
 
74
41
 
75
42
# TODO: Parallel-extract that passes back each line along with a
76
43
# description of which revisions include it.  Nice for checking all
77
 
# shas in parallel.
 
44
# shas or calculating stats in parallel.
78
45
 
79
46
# TODO: Using a single _extract routine and then processing the output
80
47
# is probably inefficient.  It's simple enough that we can afford to
81
48
# have slight specializations for different ways its used: annotate,
82
49
# basis for add, get, etc.
83
50
 
84
 
# TODO: Perhaps the API should work only in names to hide the integer
85
 
# indexes from the user?
86
 
 
87
 
 
88
 
 
89
 
import sha
90
 
 
91
 
 
92
 
 
93
 
class WeaveError(Exception):
94
 
    """Exception in processing weave"""
95
 
 
96
 
 
97
 
class WeaveFormatError(WeaveError):
98
 
    """Weave invariant violated"""
99
 
    
100
 
 
101
 
class Weave(object):
 
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):
102
132
    """weave - versioned text file storage.
103
 
    
 
133
 
104
134
    A Weave manages versions of line-based text files, keeping track
105
135
    of the originating version for each line.
106
136
 
113
143
 
114
144
    * a nonnegative index number.
115
145
 
116
 
    * a version-id string. (not implemented yet)
 
146
    * a version-id string.
117
147
 
118
148
    Typically the index number will be valid only inside this weave and
119
149
    the version-id is used to reference it in the larger world.
152
182
 
153
183
    * It doesn't seem very useful to have an active insertion
154
184
      inside an inactive insertion, but it might happen.
155
 
      
 
185
 
156
186
    * Therefore, all instructions are always"considered"; that
157
187
      is passed onto and off the stack.  An outer inactive block
158
188
      doesn't disable an inner block.
181
211
 
182
212
    _name_map
183
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.
184
218
    """
185
219
 
186
 
    __slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map']
187
 
    
188
 
    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__()
189
232
        self._weave = []
190
233
        self._parents = []
191
234
        self._sha1s = []
192
235
        self._names = []
193
236
        self._name_map = {}
194
 
 
 
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
195
271
 
196
272
    def __eq__(self, other):
197
273
        if not isinstance(other, Weave):
198
274
            return False
199
275
        return self._parents == other._parents \
200
276
               and self._weave == other._weave \
201
 
               and self._sha1s == other._sha1s 
 
277
               and self._sha1s == other._sha1s
202
278
 
203
 
    
204
279
    def __ne__(self, other):
205
280
        return not self.__eq__(other)
206
281
 
 
282
    def _idx_to_name(self, version):
 
283
        return self._names[version]
207
284
 
208
 
    def lookup(self, name):
 
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)
209
289
        try:
210
290
            return self._name_map[name]
211
291
        except KeyError:
212
 
            raise WeaveError("name %s not present in weave" % name)
213
 
 
214
 
        
215
 
    def add(self, name, parents, text):
 
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):
216
404
        """Add a single text on top of the weave.
217
 
  
 
405
 
218
406
        Returns the index number of the newly added version.
219
407
 
220
 
        name
 
408
        version_id
221
409
            Symbolic name for this version.
222
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)
223
412
 
224
413
        parents
225
414
            List or set of direct parent version numbers.
226
 
            
227
 
        text
228
 
            Sequence of lines to be added in the new version."""
229
 
 
230
 
        assert isinstance(name, basestring)
231
 
        if name in self._name_map:
232
 
            raise WeaveError("name %r already present in weave" % name)
233
 
        
 
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)
 
431
 
234
432
        self._check_versions(parents)
235
 
        ## self._check_lines(text)
 
433
        ## self._check_lines(lines)
236
434
        new_version = len(self._parents)
237
435
 
238
 
        s = sha.new()
239
 
        map(s.update, text)
240
 
        sha1 = s.hexdigest()
241
 
        del s
242
 
 
243
436
        # if we abort after here the (in-memory) weave will be corrupt because only
244
437
        # some fields are updated
 
438
        # XXX: FIXME implement a succeed-or-fail of the rest of this routine.
 
439
        #      - Robert Collins 20060226
245
440
        self._parents.append(parents[:])
246
441
        self._sha1s.append(sha1)
247
 
        self._names.append(name)
248
 
        self._name_map[name] = new_version
249
 
 
250
 
            
 
442
        self._names.append(version_id)
 
443
        self._name_map[version_id] = new_version
 
444
 
 
445
 
251
446
        if not parents:
252
447
            # special case; adding with no parents revision; can do
253
448
            # this more quickly by just appending unconditionally.
254
449
            # even more specially, if we're adding an empty text we
255
450
            # need do nothing at all.
256
 
            if text:
 
451
            if lines:
257
452
                self._weave.append(('{', new_version))
258
 
                self._weave.extend(text)
 
453
                self._weave.extend(lines)
259
454
                self._weave.append(('}', None))
260
 
        
261
455
            return new_version
262
456
 
263
457
        if len(parents) == 1:
265
459
            if sha1 == self._sha1s[pv]:
266
460
                # special case: same as the single parent
267
461
                return new_version
268
 
            
269
 
 
270
 
        ancestors = self.inclusions(parents)
 
462
 
 
463
 
 
464
        ancestors = self._inclusions(parents)
271
465
 
272
466
        l = self._weave
273
467
 
280
474
 
281
475
        # another small special case: a merge, producing the same text
282
476
        # as auto-merge
283
 
        if text == basis_lines:
284
 
            return new_version            
 
477
        if lines == basis_lines:
 
478
            return new_version
285
479
 
286
 
        # 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
287
481
        basis_lineno.append(len(self._weave))
288
482
 
289
483
        # XXX: which line of the weave should we really consider
293
487
        #print 'basis_lines:', basis_lines
294
488
        #print 'new_lines:  ', lines
295
489
 
296
 
        from difflib import SequenceMatcher
297
 
        s = SequenceMatcher(None, basis_lines, text)
 
490
        s = self._matcher(None, basis_lines, lines)
298
491
 
299
492
        # offset gives the number of lines that have been inserted
300
493
        # into the weave up to the current point; if the original edit instruction
307
500
            #print 'raw match', tag, i1, i2, j1, j2
308
501
            if tag == 'equal':
309
502
                continue
310
 
 
311
503
            i1 = basis_lineno[i1]
312
504
            i2 = basis_lineno[i2]
313
 
 
314
 
            assert 0 <= j1 <= j2 <= len(text)
315
 
 
316
 
            #print tag, i1, i2, j1, j2
317
 
 
318
505
            # the deletion and insertion are handled separately.
319
506
            # first delete the region.
320
507
            if i1 != i2:
327
514
                # i2; we want to insert after this region to make sure
328
515
                # we don't destroy ourselves
329
516
                i = i2 + offset
330
 
                self._weave[i:i] = ([('{', new_version)] 
331
 
                                    + text[j1:j2] 
 
517
                self._weave[i:i] = ([('{', new_version)]
 
518
                                    + lines[j1:j2]
332
519
                                    + [('}', None)])
333
520
                offset += 2 + (j2 - j1)
334
 
 
335
521
        return new_version
336
522
 
337
 
 
338
 
    def inclusions(self, versions):
 
523
    def _inclusions(self, versions):
339
524
        """Return set of all ancestors of given version(s)."""
 
525
        if not len(versions):
 
526
            return []
340
527
        i = set(versions)
341
 
        v = max(versions)
342
 
        try:
343
 
            while v >= 0:
344
 
                if v in i:
345
 
                    # include all its parents
346
 
                    i.update(self._parents[v])
347
 
                v -= 1
348
 
            return i
349
 
        except IndexError:
350
 
            raise ValueError("version %d not present in weave" % v)
351
 
 
352
 
 
353
 
    def minimal_parents(self, version):
354
 
        """Find the minimal set of parents for the version."""
355
 
        included = self._parents[version]
356
 
        if not included:
357
 
            return []
358
 
        
359
 
        li = list(included)
360
 
        li.sort(reverse=True)
361
 
 
362
 
        mininc = []
363
 
        gotit = set()
364
 
 
365
 
        for pv in li:
366
 
            if pv not in gotit:
367
 
                mininc.append(pv)
368
 
                gotit.update(self.inclusions(pv))
369
 
 
370
 
        assert mininc[0] >= 0
371
 
        assert mininc[-1] < version
372
 
        return mininc
373
 
 
374
 
 
 
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]
375
542
 
376
543
    def _check_lines(self, text):
377
544
        if not isinstance(text, list):
381
548
            if not isinstance(l, basestring):
382
549
                raise ValueError("text line should be a string or unicode, not %s"
383
550
                                 % type(l))
384
 
        
 
551
 
385
552
 
386
553
 
387
554
    def _check_versions(self, indexes):
392
559
            except IndexError:
393
560
                raise IndexError("invalid version number %r" % i)
394
561
 
395
 
    
396
 
    def annotate(self, index):
397
 
        return list(self.annotate_iter(index))
398
 
 
399
 
 
400
 
    def annotate_iter(self, version):
401
 
        """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.
402
572
 
403
573
        The index indicates when the line originated in the weave."""
404
 
        for origin, lineno, text in self._extract([version]):
405
 
            yield origin, text
406
 
 
407
 
 
408
 
    def _walk(self):
409
 
        """Walk the weave.
410
 
 
411
 
        Yields sequence of
412
 
        (lineno, insert, deletes, text)
413
 
        for each literal line.
414
 
        """
415
 
        
 
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
 
416
594
        istack = []
417
595
        dset = set()
418
596
 
419
597
        lineno = 0         # line of weave, 0-based
420
598
 
421
599
        for l in self._weave:
422
 
            if isinstance(l, tuple):
 
600
            if l.__class__ == tuple:
423
601
                c, v = l
424
602
                isactive = None
425
603
                if c == '{':
426
 
                    istack.append(v)
 
604
                    istack.append(self._names[v])
427
605
                elif c == '}':
428
606
                    istack.pop()
429
607
                elif c == '[':
430
 
                    assert v not in dset
431
 
                    dset.add(v)
 
608
                    dset.add(self._names[v])
432
609
                elif c == ']':
433
 
                    dset.remove(v)
434
 
                else:
435
 
                    raise WeaveFormatError('unexpected instruction %r'
436
 
                                           % v)
437
 
            else:
438
 
                assert isinstance(l, basestring)
439
 
                assert istack
440
 
                yield lineno, istack[-1], dset, l
441
 
            lineno += 1
442
 
 
443
 
 
444
 
 
445
 
    def _extract(self, versions):
446
 
        """Yield annotation of lines in included set.
447
 
 
448
 
        Yields a sequence of tuples (origin, lineno, text), where
449
 
        origin is the origin version, lineno the index in the weave,
450
 
        and text the text of the line.
451
 
 
452
 
        The set typically but not necessarily corresponds to a version.
453
 
        """
454
 
        included = self.inclusions(versions)
455
 
 
456
 
        istack = []
457
 
        dset = set()
458
 
 
459
 
        lineno = 0         # line of weave, 0-based
460
 
 
461
 
        isactive = None
462
 
 
463
 
        result = []
464
 
 
465
 
        WFE = WeaveFormatError
466
 
 
467
 
        for l in self._weave:
468
 
            if isinstance(l, tuple):
469
 
                c, v = l
470
 
                isactive = None
471
 
                if c == '{':
472
 
                    assert v not in istack
473
 
                    istack.append(v)
474
 
                elif c == '}':
475
 
                    istack.pop()
476
 
                elif c == '[':
477
 
                    if v in included:
478
 
                        assert v not in dset
479
 
                        dset.add(v)
480
 
                else:
481
 
                    assert c == ']'
482
 
                    if v in included:
483
 
                        assert v in dset
484
 
                        dset.remove(v)
485
 
            else:
486
 
                assert isinstance(l, basestring)
487
 
                if isactive is None:
488
 
                    isactive = (not dset) and istack and (istack[-1] in included)
489
 
                if isactive:
490
 
                    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
491
615
            lineno += 1
492
616
 
493
617
        if istack:
494
 
            raise WFE("unclosed insertion blocks at end of weave",
495
 
                                   istack)
 
618
            raise WeaveFormatError("unclosed insertion blocks "
 
619
                    "at end of weave: %s" % istack)
496
620
        if dset:
497
 
            raise WFE("unclosed deletion blocks at end of weave",
498
 
                                   dset)
499
 
 
500
 
        return result
501
 
    
502
 
 
503
 
 
504
 
    def get_iter(self, version):
505
 
        """Yield lines for the specified version."""
506
 
        for origin, lineno, line in self._extract([version]):
507
 
            yield line
508
 
 
509
 
 
510
 
    def get(self, index):
511
 
        return list(self.get_iter(index))
512
 
 
513
 
 
514
 
    def mash_iter(self, included):
515
 
        """Return composed version of multiple included versions."""
516
 
        for origin, lineno, text in self._extract(included):
517
 
            yield text
518
 
 
519
 
 
520
 
    def dump(self, to_file):
521
 
        from pprint import pprint
522
 
        print >>to_file, "Weave._weave = ",
523
 
        pprint(self._weave, to_file)
524
 
        print >>to_file, "Weave._parents = ",
525
 
        pprint(self._parents, to_file)
526
 
 
527
 
 
528
 
 
529
 
    def numversions(self):
530
 
        l = len(self._parents)
531
 
        assert l == len(self._sha1s)
532
 
        return l
533
 
 
534
 
 
535
 
    def __len__(self):
536
 
        return self.numversions()
537
 
 
538
 
 
539
 
    def check(self, progress_bar=None):
540
 
        # check no circular inclusions
541
 
        for version in range(self.numversions()):
542
 
            inclusions = list(self._parents[version])
543
 
            if inclusions:
544
 
                inclusions.sort()
545
 
                if inclusions[-1] >= version:
546
 
                    raise WeaveFormatError("invalid included version %d for index %d"
547
 
                                           % (inclusions[-1], version))
548
 
 
549
 
        # try extracting all versions; this is a bit slow and parallel
550
 
        # extraction could be used
551
 
        nv = self.numversions()
552
 
        for version in range(nv):
553
 
            if progress_bar:
554
 
                progress_bar.update('checking text', version, nv)
555
 
            s = sha.new()
556
 
            for l in self.get_iter(version):
557
 
                s.update(l)
558
 
            hd = s.hexdigest()
559
 
            expected = self._sha1s[version]
560
 
            if hd != expected:
561
 
                raise WeaveError("mismatched sha1 for version %d; "
562
 
                                 "got %s, expected %s"
563
 
                                 % (version, hd, expected))
564
 
 
565
 
        # TODO: check insertions are properly nested, that there are
566
 
        # no lines outside of insertion blocks, that deletions are
567
 
        # properly paired, etc.
568
 
 
569
 
 
570
 
 
571
 
    def merge(self, merge_versions):
572
 
        """Automerge and mark conflicts between versions.
573
 
 
574
 
        This returns a sequence, each entry describing alternatives
575
 
        for a chunk of the file.  Each of the alternatives is given as
576
 
        a list of lines.
577
 
 
578
 
        If there is a chunk of the file where there's no diagreement,
579
 
        only one alternative is given.
580
 
        """
581
 
 
582
 
        # approach: find the included versions common to all the
583
 
        # merged versions
584
 
        raise NotImplementedError()
585
 
 
586
 
 
587
 
 
588
 
    def _delta(self, included, lines):
589
 
        """Return changes from basis to new revision.
590
 
 
591
 
        The old text for comparison is the union of included revisions.
592
 
 
593
 
        This is used in inserting a new text.
594
 
 
595
 
        Delta is returned as a sequence of
596
 
        (weave1, weave2, newlines).
597
 
 
598
 
        This indicates that weave1:weave2 of the old weave should be
599
 
        replaced by the sequence of lines in newlines.  Note that
600
 
        these line numbers are positions in the total weave and don't
601
 
        correspond to the lines in any extracted version, or even the
602
 
        extracted union of included versions.
603
 
 
604
 
        If line1=line2, this is a pure insert; if newlines=[] this is a
605
 
        pure delete.  (Similar to difflib.)
606
 
        """
607
 
 
608
 
 
609
 
            
 
621
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
 
622
                                   % dset)
 
623
 
610
624
    def plan_merge(self, ver_a, ver_b):
611
625
        """Return pseudo-annotation indicating how the two versions merge.
612
626
 
615
629
 
616
630
        Weave lines present in none of them are skipped entirely.
617
631
        """
618
 
        inc_a = self.inclusions([ver_a])
619
 
        inc_b = self.inclusions([ver_b])
 
632
        inc_a = set(self.get_ancestry([ver_a]))
 
633
        inc_b = set(self.get_ancestry([ver_b]))
620
634
        inc_c = inc_a & inc_b
621
635
 
622
 
        for lineno, insert, deleteset, line in self._walk():
 
636
        for lineno, insert, deleteset, line in self._walk_internal([ver_a, ver_b]):
623
637
            if deleteset & inc_c:
624
638
                # killed in parent; can't be in either a or b
625
639
                # not relevant to our work
651
665
                # not in either revision
652
666
                yield 'irrelevant', line
653
667
 
654
 
        yield 'unchanged', ''           # terminator
655
 
 
656
 
 
657
 
 
658
 
    def weave_merge(self, plan):
659
 
        lines_a = []
660
 
        lines_b = []
661
 
        ch_a = ch_b = False
662
 
 
663
 
        for state, line in plan:
664
 
            if state == 'unchanged' or state == 'killed-both':
665
 
                # resync and flush queued conflicts changes if any
666
 
                if not lines_a and not lines_b:
667
 
                    pass
668
 
                elif ch_a and not ch_b:
669
 
                    # one-sided change:                    
670
 
                    for l in lines_a: yield l
671
 
                elif ch_b and not ch_a:
672
 
                    for l in lines_b: yield l
673
 
                elif lines_a == lines_b:
674
 
                    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)
675
737
                else:
676
 
                    yield '<<<<\n'
677
 
                    for l in lines_a: yield l
678
 
                    yield '====\n'
679
 
                    for l in lines_b: yield l
680
 
                    yield '>>>>\n'
681
 
 
682
 
                del lines_a[:]
683
 
                del lines_b[:]
684
 
                ch_a = ch_b = False
685
 
                
686
 
            if state == 'unchanged':
687
 
                if line:
688
 
                    yield line
689
 
            elif state == 'killed-a':
690
 
                ch_a = True
691
 
                lines_b.append(line)
692
 
            elif state == 'killed-b':
693
 
                ch_b = True
694
 
                lines_a.append(line)
695
 
            elif state == 'new-a':
696
 
                ch_a = True
697
 
                lines_a.append(line)
698
 
            elif state == 'new-b':
699
 
                ch_b = True
700
 
                lines_b.append(line)
701
 
            else:
702
 
                assert state in ('irrelevant', 'ghost-a', 'ghost-b', 'killed-base',
703
 
                                 'killed-both'), \
704
 
                       state
705
 
 
706
 
                
707
 
 
708
 
 
709
 
 
710
 
 
711
 
 
712
 
def weave_toc(w):
713
 
    """Show the weave's table-of-contents"""
714
 
    print '%6s %50s %10s %10s' % ('ver', 'name', 'sha1', 'parents')
715
 
    for i in (6, 50, 10, 10):
716
 
        print '-' * i,
717
 
    print
718
 
    for i in range(w.numversions()):
719
 
        sha1 = w._sha1s[i]
720
 
        name = w._names[i]
721
 
        parent_str = ' '.join(map(str, w._parents[i]))
722
 
        print '%6d %-50.50s %10.10s %s' % (i, name, sha1, parent_str)
723
 
 
724
 
 
725
 
 
726
 
def weave_stats(weave_file):
727
 
    from bzrlib.progress import ProgressBar
728
 
    from bzrlib.weavefile import read_weave
729
 
 
730
 
    pb = ProgressBar()
731
 
 
732
 
    wf = file(weave_file, 'rb')
733
 
    w = read_weave(wf)
734
 
    # FIXME: doesn't work on pipes
735
 
    weave_size = wf.tell()
736
 
 
737
 
    total = 0
738
 
    vers = len(w)
739
 
    for i in range(vers):
740
 
        pb.update('checking sizes', i, vers)
741
 
        for line in w.get_iter(i):
742
 
            total += len(line)
743
 
 
744
 
    pb.clear()
745
 
 
746
 
    print 'versions          %9d' % vers
747
 
    print 'weave file        %9d bytes' % weave_size
748
 
    print 'total contents    %9d bytes' % total
749
 
    print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
750
 
    if vers:
751
 
        avg = total/vers
752
 
        print 'average size      %9d bytes' % avg
753
 
        print 'relative size     %9.2fx' % (float(weave_size) / float(avg))
754
 
 
755
 
 
756
 
def usage():
757
 
    print """bzr weave tool
758
 
 
759
 
Experimental tool for weave algorithm.
760
 
 
761
 
usage:
762
 
    weave init WEAVEFILE
763
 
        Create an empty weave file
764
 
    weave get WEAVEFILE VERSION
765
 
        Write out specified version.
766
 
    weave check WEAVEFILE
767
 
        Check consistency of all versions.
768
 
    weave toc WEAVEFILE
769
 
        Display table of contents.
770
 
    weave add WEAVEFILE NAME [BASE...] < NEWTEXT
771
 
        Add NEWTEXT, with specified parent versions.
772
 
    weave annotate WEAVEFILE VERSION
773
 
        Display origin of each line.
774
 
    weave mash WEAVEFILE VERSION...
775
 
        Display composite of all selected versions.
776
 
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
777
 
        Auto-merge two versions and display conflicts.
778
 
 
779
 
example:
780
 
 
781
 
    % weave init foo.weave
782
 
    % vi foo.txt
783
 
    % weave add foo.weave ver0 < foo.txt
784
 
    added version 0
785
 
 
786
 
    (create updated version)
787
 
    % vi foo.txt
788
 
    % weave get foo.weave 0 | diff -u - foo.txt
789
 
    % weave add foo.weave ver1 0 < foo.txt
790
 
    added version 1
791
 
 
792
 
    % weave get foo.weave 0 > foo.txt       (create forked version)
793
 
    % vi foo.txt
794
 
    % weave add foo.weave ver2 0 < foo.txt
795
 
    added version 2
796
 
 
797
 
    % weave merge foo.weave 1 2 > foo.txt   (merge them)
798
 
    % vi foo.txt                            (resolve conflicts)
799
 
    % weave add foo.weave merged 1 2 < foo.txt     (commit merged version)     
800
 
    
801
 
"""
802
 
    
803
 
 
804
 
 
805
 
def main(argv):
806
 
    import sys
807
 
    import os
808
 
    from weavefile import write_weave, read_weave
809
 
    from bzrlib.progress import ProgressBar
810
 
 
811
 
    try:
812
 
        import psyco
813
 
        psyco.full()
814
 
    except ImportError:
815
 
        pass
816
 
 
817
 
    if len(argv) < 2:
818
 
        usage()
819
 
        return 0
820
 
 
821
 
    cmd = argv[1]
822
 
 
823
 
    def readit():
824
 
        return read_weave(file(argv[2], 'rb'))
825
 
    
826
 
    if cmd == 'help':
827
 
        usage()
828
 
    elif cmd == 'add':
829
 
        w = readit()
830
 
        # at the moment, based on everything in the file
831
 
        name = argv[3]
832
 
        parents = map(int, argv[4:])
833
 
        lines = sys.stdin.readlines()
834
 
        ver = w.add(name, parents, lines)
835
 
        write_weave(w, file(argv[2], 'wb'))
836
 
        print 'added version %r %d' % (name, ver)
837
 
    elif cmd == 'init':
838
 
        fn = argv[2]
839
 
        if os.path.exists(fn):
840
 
            raise IOError("file exists")
841
 
        w = Weave()
842
 
        write_weave(w, file(fn, 'wb'))
843
 
    elif cmd == 'get': # get one version
844
 
        w = readit()
845
 
        sys.stdout.writelines(w.get_iter(int(argv[3])))
846
 
        
847
 
    elif cmd == 'mash': # get composite
848
 
        w = readit()
849
 
        sys.stdout.writelines(w.mash_iter(map(int, argv[3:])))
850
 
 
851
 
    elif cmd == 'annotate':
852
 
        w = readit()
853
 
        # newline is added to all lines regardless; too hard to get
854
 
        # reasonable formatting otherwise
855
 
        lasto = None
856
 
        for origin, text in w.annotate(int(argv[3])):
857
 
            text = text.rstrip('\r\n')
858
 
            if origin == lasto:
859
 
                print '      | %s' % (text)
860
 
            else:
861
 
                print '%5d | %s' % (origin, text)
862
 
                lasto = origin
863
 
                
864
 
    elif cmd == 'toc':
865
 
        weave_toc(readit())
866
 
 
867
 
    elif cmd == 'stats':
868
 
        weave_stats(argv[2])
869
 
        
870
 
    elif cmd == 'check':
871
 
        w = readit()
872
 
        pb = ProgressBar()
873
 
        w.check(pb)
874
 
        pb.clear()
875
 
        print '%d versions ok' % w.numversions()
876
 
 
877
 
    elif cmd == 'inclusions':
878
 
        w = readit()
879
 
        print ' '.join(map(str, w.inclusions([int(argv[3])])))
880
 
 
881
 
    elif cmd == 'parents':
882
 
        w = readit()
883
 
        print ' '.join(map(str, w._parents[int(argv[3])]))
884
 
 
885
 
    elif cmd == 'plan-merge':
886
 
        w = readit()
887
 
        for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
888
 
            if line:
889
 
                print '%14s | %s' % (state, line),
890
 
 
891
 
    elif cmd == 'merge':
892
 
        w = readit()
893
 
        p = w.plan_merge(int(argv[3]), int(argv[4]))
894
 
        sys.stdout.writelines(w.weave_merge(p))
895
 
            
896
 
    elif cmd == 'mash-merge':
897
 
        if len(argv) != 5:
898
 
            usage()
899
 
            return 1
900
 
 
901
 
        w = readit()
902
 
        v1, v2 = map(int, argv[3:5])
903
 
 
904
 
        basis = w.inclusions([v1]).intersection(w.inclusions([v2]))
905
 
 
906
 
        base_lines = list(w.mash_iter(basis))
907
 
        a_lines = list(w.get(v1))
908
 
        b_lines = list(w.get(v2))
909
 
 
910
 
        from bzrlib.merge3 import Merge3
911
 
        m3 = Merge3(base_lines, a_lines, b_lines)
912
 
 
913
 
        name_a = 'version %d' % v1
914
 
        name_b = 'version %d' % v2
915
 
        sys.stdout.writelines(m3.merge_lines(name_a=name_a, name_b=name_b))
916
 
    else:
917
 
        raise ValueError('unknown command %r' % cmd)
918
 
    
919
 
 
920
 
 
921
 
def profile_main(argv): 
922
 
    import tempfile, hotshot, hotshot.stats
923
 
 
924
 
    prof_f = tempfile.NamedTemporaryFile()
925
 
 
926
 
    prof = hotshot.Profile(prof_f.name)
927
 
 
928
 
    ret = prof.runcall(main, argv)
929
 
    prof.close()
930
 
 
931
 
    stats = hotshot.stats.load(prof_f.name)
932
 
    #stats.strip_dirs()
933
 
    stats.sort_stats('cumulative')
934
 
    ## XXX: Might like to write to stderr or the trace file instead but
935
 
    ## print_stats seems hardcoded to stdout
936
 
    stats.print_stats(20)
937
 
            
938
 
    return ret
939
 
 
940
 
 
941
 
if __name__ == '__main__':
942
 
    import sys
943
 
    if '--profile' in sys.argv:
944
 
        args = sys.argv[:]
945
 
        args.remove('--profile')
946
 
        sys.exit(profile_main(args))
947
 
    else:
948
 
        sys.exit(main(sys.argv))
949
 
 
 
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