~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Robert Collins
  • Date: 2006-03-02 03:12:34 UTC
  • mto: (1594.2.4 integration)
  • mto: This revision was merged to the branch mainline in revision 1596.
  • Revision ID: robertc@robertcollins.net-20060302031234-cf6b75961f27c5df
InterVersionedFile implemented.

Show diffs side-by-side

added added

removed removed

Lines of Context:
21
21
 
22
22
"""Weave - storage of related text file versions"""
23
23
 
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
24
 
56
25
# XXX: If we do weaves this way, will a merge still behave the same
57
26
# way if it's done in a different order?  That's a pretty desirable
74
43
 
75
44
# TODO: Parallel-extract that passes back each line along with a
76
45
# description of which revisions include it.  Nice for checking all
77
 
# shas in parallel.
 
46
# shas or calculating stats in parallel.
78
47
 
79
48
# TODO: Using a single _extract routine and then processing the output
80
49
# is probably inefficient.  It's simple enough that we can afford to
81
50
# have slight specializations for different ways its used: annotate,
82
51
# basis for add, get, etc.
83
52
 
84
 
# TODO: Perhaps the API should work only in names to hide the integer
85
 
# indexes from the user?
86
 
 
87
 
 
88
 
 
 
53
# TODO: Probably the API should work only in names to hide the integer
 
54
# indexes from the user.
 
55
 
 
56
# TODO: Is there any potential performance win by having an add()
 
57
# variant that is passed a pre-cooked version of the single basis
 
58
# version?
 
59
 
 
60
# TODO: Reweave can possibly be made faster by remembering diffs
 
61
# where the basis and destination are unchanged.
 
62
 
 
63
# FIXME: Sometimes we will be given a parents list for a revision
 
64
# that includes some redundant parents (i.e. already a parent of 
 
65
# something in the list.)  We should eliminate them.  This can 
 
66
# be done fairly efficiently because the sequence numbers constrain
 
67
# the possible relationships.
 
68
 
 
69
 
 
70
from cStringIO import StringIO
 
71
from difflib import SequenceMatcher
 
72
import os
89
73
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):
 
74
import time
 
75
 
 
76
from bzrlib.trace import mutter
 
77
from bzrlib.errors import (WeaveError, WeaveFormatError, WeaveParentMismatch,
 
78
        RevisionAlreadyPresent,
 
79
        RevisionNotPresent,
 
80
        WeaveRevisionAlreadyPresent,
 
81
        WeaveRevisionNotPresent,
 
82
        )
 
83
import bzrlib.errors as errors
 
84
from bzrlib.osutils import sha_strings
 
85
from bzrlib.symbol_versioning import *
 
86
from bzrlib.tsort import topo_sort
 
87
from bzrlib.versionedfile import VersionedFile, InterVersionedFile
 
88
from bzrlib.weavefile import _read_weave_v5, write_weave_v5
 
89
 
 
90
 
 
91
class Weave(VersionedFile):
102
92
    """weave - versioned text file storage.
103
93
    
104
94
    A Weave manages versions of line-based text files, keeping track
113
103
 
114
104
    * a nonnegative index number.
115
105
 
116
 
    * a version-id string. (not implemented yet)
 
106
    * a version-id string.
117
107
 
118
108
    Typically the index number will be valid only inside this weave and
119
109
    the version-id is used to reference it in the larger world.
181
171
 
182
172
    _name_map
183
173
        For each name, the version number.
 
174
 
 
175
    _weave_name
 
176
        Descriptive name of this weave; typically the filename if known.
 
177
        Set by read_weave.
184
178
    """
185
179
 
186
 
    __slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map']
 
180
    __slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map',
 
181
                 '_weave_name']
187
182
    
188
 
    def __init__(self):
 
183
    def __init__(self, weave_name=None):
189
184
        self._weave = []
190
185
        self._parents = []
191
186
        self._sha1s = []
192
187
        self._names = []
193
188
        self._name_map = {}
194
 
 
 
189
        self._weave_name = weave_name
 
190
 
 
191
    def __repr__(self):
 
192
        return "Weave(%r)" % self._weave_name
 
193
 
 
194
    def copy(self):
 
195
        """Return a deep copy of self.
 
196
        
 
197
        The copy can be modified without affecting the original weave."""
 
198
        other = Weave()
 
199
        other._weave = self._weave[:]
 
200
        other._parents = self._parents[:]
 
201
        other._sha1s = self._sha1s[:]
 
202
        other._names = self._names[:]
 
203
        other._name_map = self._name_map.copy()
 
204
        other._weave_name = self._weave_name
 
205
        return other
195
206
 
196
207
    def __eq__(self, other):
197
208
        if not isinstance(other, Weave):
199
210
        return self._parents == other._parents \
200
211
               and self._weave == other._weave \
201
212
               and self._sha1s == other._sha1s 
202
 
 
203
213
    
204
214
    def __ne__(self, other):
205
215
        return not self.__eq__(other)
206
216
 
207
 
 
 
217
    @deprecated_method(zero_eight)
 
218
    def idx_to_name(self, index):
 
219
        """Old public interface, the public interface is all names now."""
 
220
        return index
 
221
 
 
222
    def _idx_to_name(self, version):
 
223
        return self._names[version]
 
224
 
 
225
    @deprecated_method(zero_eight)
208
226
    def lookup(self, name):
 
227
        """Backwards compatability thunk:
 
228
 
 
229
        Return name, as name is valid in the api now, and spew deprecation
 
230
        warnings everywhere.
 
231
        """
 
232
        return name
 
233
 
 
234
    def _lookup(self, name):
 
235
        """Convert symbolic version name to index."""
209
236
        try:
210
237
            return self._name_map[name]
211
238
        except KeyError:
212
 
            raise WeaveError("name %s not present in weave" % name)
213
 
 
214
 
        
215
 
    def add(self, name, parents, text):
 
239
            raise RevisionNotPresent(name, self._weave_name)
 
240
 
 
241
    @deprecated_method(zero_eight)
 
242
    def iter_names(self):
 
243
        """Deprecated convenience function, please see VersionedFile.names()."""
 
244
        return iter(self.names())
 
245
 
 
246
    @deprecated_method(zero_eight)
 
247
    def names(self):
 
248
        """See Weave.versions for the current api."""
 
249
        return self.versions()
 
250
 
 
251
    def versions(self):
 
252
        """See VersionedFile.versions."""
 
253
        return self._names[:]
 
254
 
 
255
    def has_version(self, version_id):
 
256
        """See VersionedFile.has_version."""
 
257
        return self._name_map.has_key(version_id)
 
258
 
 
259
    __contains__ = has_version
 
260
 
 
261
    def get_parents(self, version_id):
 
262
        """See VersionedFile.get_parent."""
 
263
        return map(self._idx_to_name, self._parents[self._lookup(version_id)])
 
264
 
 
265
    def _check_repeated_add(self, name, parents, text, sha1):
 
266
        """Check that a duplicated add is OK.
 
267
 
 
268
        If it is, return the (old) index; otherwise raise an exception.
 
269
        """
 
270
        idx = self._lookup(name)
 
271
        if sorted(self._parents[idx]) != sorted(parents) \
 
272
            or sha1 != self._sha1s[idx]:
 
273
            raise RevisionAlreadyPresent(name, self._weave_name)
 
274
        return idx
 
275
 
 
276
    @deprecated_method(zero_eight)
 
277
    def add_identical(self, old_rev_id, new_rev_id, parents):
 
278
        """Please use Weave.clone_text now."""
 
279
        return self.clone_text(new_rev_id, old_rev_id, parents)
 
280
 
 
281
    def add_lines(self, version_id, parents, lines):
 
282
        """See VersionedFile.add_lines."""
 
283
        return self._add(version_id, lines, map(self._lookup, parents))
 
284
 
 
285
    @deprecated_method(zero_eight)
 
286
    def add(self, name, parents, text, sha1=None):
 
287
        """See VersionedFile.add_lines for the non deprecated api."""
 
288
        return self._add(name, text, map(self._maybe_lookup, parents), sha1)
 
289
 
 
290
    def _add(self, version_id, lines, parents, sha1=None):
216
291
        """Add a single text on top of the weave.
217
292
  
218
293
        Returns the index number of the newly added version.
219
294
 
220
 
        name
 
295
        version_id
221
296
            Symbolic name for this version.
222
297
            (Typically the revision-id of the revision that added it.)
223
298
 
224
299
        parents
225
300
            List or set of direct parent version numbers.
226
301
            
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
 
        
 
302
        lines
 
303
            Sequence of lines to be added in the new version.
 
304
        """
 
305
 
 
306
        assert isinstance(version_id, basestring)
 
307
        if not sha1:
 
308
            sha1 = sha_strings(lines)
 
309
        if version_id in self._name_map:
 
310
            return self._check_repeated_add(version_id, parents, lines, sha1)
 
311
 
234
312
        self._check_versions(parents)
235
 
        ## self._check_lines(text)
 
313
        ## self._check_lines(lines)
236
314
        new_version = len(self._parents)
237
315
 
238
 
        s = sha.new()
239
 
        map(s.update, text)
240
 
        sha1 = s.hexdigest()
241
 
        del s
242
 
 
243
316
        # if we abort after here the (in-memory) weave will be corrupt because only
244
317
        # some fields are updated
245
318
        self._parents.append(parents[:])
246
319
        self._sha1s.append(sha1)
247
 
        self._names.append(name)
248
 
        self._name_map[name] = new_version
 
320
        self._names.append(version_id)
 
321
        self._name_map[version_id] = new_version
249
322
 
250
323
            
251
324
        if not parents:
253
326
            # this more quickly by just appending unconditionally.
254
327
            # even more specially, if we're adding an empty text we
255
328
            # need do nothing at all.
256
 
            if text:
 
329
            if lines:
257
330
                self._weave.append(('{', new_version))
258
 
                self._weave.extend(text)
 
331
                self._weave.extend(lines)
259
332
                self._weave.append(('}', None))
260
 
        
261
333
            return new_version
262
334
 
263
335
        if len(parents) == 1:
267
339
                return new_version
268
340
            
269
341
 
270
 
        ancestors = self.inclusions(parents)
 
342
        ancestors = self._inclusions(parents)
271
343
 
272
344
        l = self._weave
273
345
 
280
352
 
281
353
        # another small special case: a merge, producing the same text
282
354
        # as auto-merge
283
 
        if text == basis_lines:
 
355
        if lines == basis_lines:
284
356
            return new_version            
285
357
 
286
358
        # add a sentinal, because we can also match against the final line
293
365
        #print 'basis_lines:', basis_lines
294
366
        #print 'new_lines:  ', lines
295
367
 
296
 
        from difflib import SequenceMatcher
297
 
        s = SequenceMatcher(None, basis_lines, text)
 
368
        s = SequenceMatcher(None, basis_lines, lines)
298
369
 
299
370
        # offset gives the number of lines that have been inserted
300
371
        # into the weave up to the current point; if the original edit instruction
311
382
            i1 = basis_lineno[i1]
312
383
            i2 = basis_lineno[i2]
313
384
 
314
 
            assert 0 <= j1 <= j2 <= len(text)
 
385
            assert 0 <= j1 <= j2 <= len(lines)
315
386
 
316
387
            #print tag, i1, i2, j1, j2
317
388
 
328
399
                # we don't destroy ourselves
329
400
                i = i2 + offset
330
401
                self._weave[i:i] = ([('{', new_version)] 
331
 
                                    + text[j1:j2] 
 
402
                                    + lines[j1:j2] 
332
403
                                    + [('}', None)])
333
404
                offset += 2 + (j2 - j1)
334
 
 
335
405
        return new_version
336
406
 
 
407
    def clone_text(self, new_version_id, old_version_id, parents):
 
408
        """See VersionedFile.clone_text."""
 
409
        old_lines = self.get_text(old_version_id)
 
410
        self.add_lines(new_version_id, parents, old_lines)
337
411
 
338
 
    def inclusions(self, versions):
 
412
    def _inclusions(self, versions):
339
413
        """Return set of all ancestors of given version(s)."""
340
414
        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:
 
415
        for v in xrange(max(versions), 0, -1):
 
416
            if v in i:
 
417
                # include all its parents
 
418
                i.update(self._parents[v])
 
419
        return i
 
420
        ## except IndexError:
 
421
        ##     raise ValueError("version %d not present in weave" % v)
 
422
 
 
423
    @deprecated_method(zero_eight)
 
424
    def inclusions(self, version_ids):
 
425
        """Deprecated - see VersionedFile.get_ancestry for the replacement."""
 
426
        if not version_ids:
357
427
            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
 
 
 
428
        if isinstance(version_ids[0], int):
 
429
            return [self._idx_to_name(v) for v in self._inclusions(version_ids)]
 
430
        else:
 
431
            return self.get_ancestry(version_ids)
 
432
 
 
433
    def get_ancestry(self, version_ids):
 
434
        """See VersionedFile.get_ancestry."""
 
435
        if isinstance(version_ids, basestring):
 
436
            version_ids = [version_ids]
 
437
        i = self._inclusions([self._lookup(v) for v in version_ids])
 
438
        return [self._idx_to_name(v) for v in i]
375
439
 
376
440
    def _check_lines(self, text):
377
441
        if not isinstance(text, list):
392
456
            except IndexError:
393
457
                raise IndexError("invalid version number %r" % i)
394
458
 
 
459
    def annotate(self, version_id):
 
460
        if isinstance(version_id, int):
 
461
            warn('Weave.annotate(int) is deprecated. Please use version names'
 
462
                 ' in all circumstances as of 0.8',
 
463
                 DeprecationWarning,
 
464
                 stacklevel=2
 
465
                 )
 
466
            result = []
 
467
            for origin, lineno, text in self._extract([version_id]):
 
468
                result.append((origin, text))
 
469
            return result
 
470
        else:
 
471
            return super(Weave, self).annotate(version_id)
395
472
    
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.
 
473
    def annotate_iter(self, version_id):
 
474
        """Yield list of (version-id, line) pairs for the specified version.
402
475
 
403
476
        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
 
 
 
477
        incls = [self._lookup(version_id)]
 
478
        for origin, lineno, text in self._extract(incls):
 
479
            yield self._idx_to_name(origin), text
 
480
 
 
481
    @deprecated_method(zero_eight)
408
482
    def _walk(self):
409
 
        """Walk the weave.
 
483
        """_walk has become walk, a supported api."""
 
484
        return self.walk()
410
485
 
411
 
        Yields sequence of
412
 
        (lineno, insert, deletes, text)
413
 
        for each literal line.
414
 
        """
 
486
    def walk(self, version_ids=None):
 
487
        """See VersionedFile.walk."""
415
488
        
416
489
        istack = []
417
490
        dset = set()
423
496
                c, v = l
424
497
                isactive = None
425
498
                if c == '{':
426
 
                    istack.append(v)
 
499
                    istack.append(self._idx_to_name(v))
427
500
                elif c == '}':
428
501
                    istack.pop()
429
502
                elif c == '[':
430
 
                    assert v not in dset
431
 
                    dset.add(v)
 
503
                    assert self._idx_to_name(v) not in dset
 
504
                    dset.add(self._idx_to_name(v))
432
505
                elif c == ']':
433
 
                    dset.remove(v)
 
506
                    dset.remove(self._idx_to_name(v))
434
507
                else:
435
 
                    raise WeaveFormatError('unexpected instruction %r'
436
 
                                           % v)
 
508
                    raise WeaveFormatError('unexpected instruction %r' % v)
437
509
            else:
438
510
                assert isinstance(l, basestring)
439
511
                assert istack
440
 
                yield lineno, istack[-1], dset, l
 
512
                yield lineno, istack[-1], dset.copy(), l
441
513
            lineno += 1
442
514
 
443
 
 
 
515
        if istack:
 
516
            raise WeaveFormatError("unclosed insertion blocks "
 
517
                    "at end of weave: %s" % istack)
 
518
        if dset:
 
519
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
 
520
                                   % dset)
444
521
 
445
522
    def _extract(self, versions):
446
523
        """Yield annotation of lines in included set.
451
528
 
452
529
        The set typically but not necessarily corresponds to a version.
453
530
        """
454
 
        included = self.inclusions(versions)
 
531
        for i in versions:
 
532
            if not isinstance(i, int):
 
533
                raise ValueError(i)
 
534
            
 
535
        included = self._inclusions(versions)
455
536
 
456
537
        istack = []
457
538
        dset = set()
489
570
                if isactive:
490
571
                    result.append((istack[-1], lineno, l))
491
572
            lineno += 1
492
 
 
493
573
        if istack:
494
 
            raise WFE("unclosed insertion blocks at end of weave",
495
 
                                   istack)
 
574
            raise WeaveFormatError("unclosed insertion blocks "
 
575
                    "at end of weave: %s" % istack)
496
576
        if dset:
497
 
            raise WFE("unclosed deletion blocks at end of weave",
498
 
                                   dset)
499
 
 
 
577
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
 
578
                                   % dset)
500
579
        return result
501
 
    
502
 
 
503
 
 
504
 
    def get_iter(self, version):
 
580
 
 
581
    @deprecated_method(zero_eight)
 
582
    def get_iter(self, name_or_index):
 
583
        """Deprecated, please do not use. Lookups are not not needed.
 
584
        
 
585
        Please use get_lines now.
 
586
        """
 
587
        return self._get_iter(self._maybe_lookup(name_or_index))
 
588
 
 
589
    @deprecated_method(zero_eight)
 
590
    def maybe_lookup(self, name_or_index):
 
591
        """Deprecated, please do not use. Lookups are not not needed."""
 
592
        return self._maybe_lookup(name_or_index)
 
593
 
 
594
    def _maybe_lookup(self, name_or_index):
 
595
        """Convert possible symbolic name to index, or pass through indexes.
 
596
        
 
597
        NOT FOR PUBLIC USE.
 
598
        """
 
599
        if isinstance(name_or_index, (int, long)):
 
600
            return name_or_index
 
601
        else:
 
602
            return self._lookup(name_or_index)
 
603
 
 
604
    def _get_iter(self, version_id):
505
605
        """Yield lines for the specified version."""
506
 
        for origin, lineno, line in self._extract([version]):
 
606
        incls = [self._maybe_lookup(version_id)]
 
607
        if len(incls) == 1:
 
608
            index = incls[0]
 
609
            cur_sha = sha.new()
 
610
        else:
 
611
            # We don't have sha1 sums for multiple entries
 
612
            cur_sha = None
 
613
        for origin, lineno, line in self._extract(incls):
 
614
            if cur_sha:
 
615
                cur_sha.update(line)
507
616
            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
 
 
 
617
        if cur_sha:
 
618
            expected_sha1 = self._sha1s[index]
 
619
            measured_sha1 = cur_sha.hexdigest() 
 
620
            if measured_sha1 != expected_sha1:
 
621
                raise errors.WeaveInvalidChecksum(
 
622
                        'file %s, revision %s, expected: %s, measured %s' 
 
623
                        % (self._weave_name, self._names[index],
 
624
                           expected_sha1, measured_sha1))
 
625
 
 
626
    @deprecated_method(zero_eight)
 
627
    def get(self, version_id):
 
628
        """Please use either Weave.get_text or Weave.get_lines as desired."""
 
629
        return self.get_lines(version_id)
 
630
 
 
631
    def get_lines(self, version_id):
 
632
        """See VersionedFile.get_lines()."""
 
633
        return list(self._get_iter(version_id))
 
634
 
 
635
    def get_sha1(self, name):
 
636
        """Get the stored sha1 sum for the given revision.
 
637
        
 
638
        :param name: The name of the version to lookup
 
639
        """
 
640
        return self._sha1s[self._lookup(name)]
528
641
 
529
642
    def numversions(self):
530
643
        l = len(self._parents)
531
644
        assert l == len(self._sha1s)
532
645
        return l
533
646
 
534
 
 
535
 
    def __len__(self):
536
 
        return self.numversions()
537
 
 
 
647
    __len__ = numversions
538
648
 
539
649
    def check(self, progress_bar=None):
 
650
        # TODO evaluate performance hit of using string sets in this routine.
540
651
        # check no circular inclusions
541
652
        for version in range(self.numversions()):
542
653
            inclusions = list(self._parents[version])
546
657
                    raise WeaveFormatError("invalid included version %d for index %d"
547
658
                                           % (inclusions[-1], version))
548
659
 
549
 
        # try extracting all versions; this is a bit slow and parallel
550
 
        # extraction could be used
 
660
        # try extracting all versions; parallel extraction is used
551
661
        nv = self.numversions()
552
 
        for version in range(nv):
 
662
        sha1s = {}
 
663
        texts = {}
 
664
        inclusions = {}
 
665
        for i in range(nv):
 
666
            # For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
 
667
            # The problem is that set membership is much more expensive
 
668
            name = self._idx_to_name(i)
 
669
            sha1s[name] = sha.new()
 
670
            texts[name] = []
 
671
            new_inc = set([name])
 
672
            for p in self._parents[i]:
 
673
                new_inc.update(inclusions[self._idx_to_name(p)])
 
674
 
 
675
            assert set(new_inc) == set(self.get_ancestry(name)), \
 
676
                'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
 
677
            inclusions[name] = new_inc
 
678
 
 
679
        nlines = len(self._weave)
 
680
 
 
681
        update_text = 'checking weave'
 
682
        if self._weave_name:
 
683
            short_name = os.path.basename(self._weave_name)
 
684
            update_text = 'checking %s' % (short_name,)
 
685
            update_text = update_text[:25]
 
686
 
 
687
        for lineno, insert, deleteset, line in self.walk():
553
688
            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]
 
689
                progress_bar.update(update_text, lineno, nlines)
 
690
 
 
691
            for name, name_inclusions in inclusions.items():
 
692
                # The active inclusion must be an ancestor,
 
693
                # and no ancestors must have deleted this line,
 
694
                # because we don't support resurrection.
 
695
                if (insert in name_inclusions) and not (deleteset & name_inclusions):
 
696
                    sha1s[name].update(line)
 
697
 
 
698
        for i in range(nv):
 
699
            version = self._idx_to_name(i)
 
700
            hd = sha1s[version].hexdigest()
 
701
            expected = self._sha1s[i]
560
702
            if hd != expected:
561
 
                raise WeaveError("mismatched sha1 for version %d; "
562
 
                                 "got %s, expected %s"
563
 
                                 % (version, hd, expected))
 
703
                raise errors.WeaveInvalidChecksum(
 
704
                        "mismatched sha1 for version %s: "
 
705
                        "got %s, expected %s"
 
706
                        % (version, hd, expected))
564
707
 
565
708
        # TODO: check insertions are properly nested, that there are
566
709
        # no lines outside of insertion blocks, that deletions are
567
710
        # properly paired, etc.
568
711
 
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
 
            
610
 
    def plan_merge(self, ver_a, ver_b):
611
 
        """Return pseudo-annotation indicating how the two versions merge.
612
 
 
613
 
        This is computed between versions a and b and their common
614
 
        base.
615
 
 
616
 
        Weave lines present in none of them are skipped entirely.
617
 
        """
618
 
        inc_a = self.inclusions([ver_a])
619
 
        inc_b = self.inclusions([ver_b])
620
 
        inc_c = inc_a & inc_b
621
 
 
622
 
        for lineno, insert, deleteset, line in self._walk():
623
 
            if deleteset & inc_c:
624
 
                # killed in parent; can't be in either a or b
625
 
                # not relevant to our work
626
 
                yield 'killed-base', line
627
 
            elif insert in inc_c:
628
 
                # was inserted in base
629
 
                killed_a = bool(deleteset & inc_a)
630
 
                killed_b = bool(deleteset & inc_b)
631
 
                if killed_a and killed_b:
632
 
                    yield 'killed-both', line
633
 
                elif killed_a:
634
 
                    yield 'killed-a', line
635
 
                elif killed_b:
636
 
                    yield 'killed-b', line
637
 
                else:
638
 
                    yield 'unchanged', line
639
 
            elif insert in inc_a:
640
 
                if deleteset & inc_a:
641
 
                    yield 'ghost-a', line
642
 
                else:
643
 
                    # new in A; not in B
644
 
                    yield 'new-a', line
645
 
            elif insert in inc_b:
646
 
                if deleteset & inc_b:
647
 
                    yield 'ghost-b', line
648
 
                else:
649
 
                    yield 'new-b', line
650
 
            else:
651
 
                # not in either revision
652
 
                yield 'irrelevant', line
653
 
 
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
675
 
                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
 
 
 
712
    def _join(self, other, pb, msg, version_ids):
 
713
        """Worker routine for join()."""
 
714
        if not other.versions():
 
715
            return          # nothing to update, easy
 
716
 
 
717
        if version_ids:
 
718
            for version_id in version_ids:
 
719
                if not self.has_version(version_id):
 
720
                    raise RevisionNotPresent(version_id, self._weave_name)
 
721
        assert version_ids == None
 
722
 
 
723
        # two loops so that we do not change ourselves before verifying it
 
724
        # will be ok
 
725
        # work through in index order to make sure we get all dependencies
 
726
        names_to_join = []
 
727
        processed = 0
 
728
        for other_idx, name in enumerate(other._names):
 
729
            self._check_version_consistent(other, other_idx, name)
 
730
            sha1 = other._sha1s[other_idx]
 
731
 
 
732
            processed += 1
 
733
 
 
734
            if name in self._name_map:
 
735
                idx = self._lookup(name)
 
736
                n1 = set(map(other._idx_to_name, other._parents[other_idx]))
 
737
                n2 = set(map(self._idx_to_name, self._parents[idx]))
 
738
                if sha1 ==  self._sha1s[idx] and n1 == n2:
 
739
                        continue
 
740
 
 
741
            names_to_join.append((other_idx, name))
 
742
 
 
743
        if pb and not msg:
 
744
            msg = 'weave join'
 
745
 
 
746
        merged = 0
 
747
        time0 = time.time()
 
748
        for other_idx, name in names_to_join:
 
749
            # TODO: If all the parents of the other version are already
 
750
            # present then we can avoid some work by just taking the delta
 
751
            # and adjusting the offsets.
 
752
            new_parents = self._imported_parents(other, other_idx)
 
753
            sha1 = other._sha1s[other_idx]
 
754
 
 
755
            merged += 1
 
756
 
 
757
            if pb:
 
758
                pb.update(msg, merged, len(names_to_join))
 
759
           
 
760
            lines = other.get_lines(other_idx)
 
761
            self._add(name, lines, new_parents, sha1)
 
762
 
 
763
        mutter("merged = %d, processed = %d, file_id=%s; deltat=%d"%(
 
764
                merged, processed, self._weave_name, time.time()-time0))
 
765
 
 
766
    def _imported_parents(self, other, other_idx):
 
767
        """Return list of parents in self corresponding to indexes in other."""
 
768
        new_parents = []
 
769
        for parent_idx in other._parents[other_idx]:
 
770
            parent_name = other._names[parent_idx]
 
771
            if parent_name not in self._names:
 
772
                # should not be possible
 
773
                raise WeaveError("missing parent {%s} of {%s} in %r" 
 
774
                                 % (parent_name, other._name_map[other_idx], self))
 
775
            new_parents.append(self._name_map[parent_name])
 
776
        return new_parents
 
777
 
 
778
    def _check_version_consistent(self, other, other_idx, name):
 
779
        """Check if a version in consistent in this and other.
 
780
 
 
781
        To be consistent it must have:
 
782
 
 
783
         * the same text
 
784
         * the same direct parents (by name, not index, and disregarding
 
785
           order)
 
786
        
 
787
        If present & correct return True;
 
788
        if not present in self return False; 
 
789
        if inconsistent raise error."""
 
790
        this_idx = self._name_map.get(name, -1)
 
791
        if this_idx != -1:
 
792
            if self._sha1s[this_idx] != other._sha1s[other_idx]:
 
793
                raise errors.WeaveTextDiffers(name, self, other)
 
794
            self_parents = self._parents[this_idx]
 
795
            other_parents = other._parents[other_idx]
 
796
            n1 = set([self._names[i] for i in self_parents])
 
797
            n2 = set([other._names[i] for i in other_parents])
 
798
            if n1 != n2:
 
799
                raise WeaveParentMismatch("inconsistent parents "
 
800
                    "for version {%s}: %s vs %s" % (name, n1, n2))
 
801
            else:
 
802
                return True         # ok!
 
803
        else:
 
804
            return False
 
805
 
 
806
    @deprecated_method(zero_eight)
 
807
    def reweave(self, other, pb=None, msg=None):
 
808
        """reweave has been superceded by plain use of join."""
 
809
        return self.join(other, pb, msg)
 
810
 
 
811
    def _reweave(self, other, pb, msg):
 
812
        """Reweave self with other - internal helper for join().
 
813
 
 
814
        :param other: The other weave to merge
 
815
        :param pb: An optional progress bar, indicating how far done we are
 
816
        :param msg: An optional message for the progress
 
817
        """
 
818
        new_weave = _reweave(self, other, pb=pb, msg=msg)
 
819
        for attr in self.__slots__:
 
820
            if attr != '_weave_name':
 
821
                setattr(self, attr, getattr(new_weave, attr))
 
822
 
 
823
 
 
824
class WeaveFile(Weave):
 
825
    """A WeaveFile represents a Weave on disk and writes on change."""
 
826
 
 
827
    def __init__(self, name, transport, mode=None):
 
828
        super(WeaveFile, self).__init__(name)
 
829
        self._transport = transport
 
830
        self._mode = mode
 
831
        try:
 
832
            _read_weave_v5(self._transport.get(name), self)
 
833
        except errors.NoSuchFile:
 
834
            # new file, no-op.
 
835
            pass
 
836
 
 
837
    def add_lines(self, version_id, parents, lines):
 
838
        """Add a version and save the weave."""
 
839
        super(WeaveFile, self).add_lines(version_id, parents, lines)
 
840
        self._save()
 
841
 
 
842
    def create_empty(self, name, transport, mode=None):
 
843
        return WeaveFile(name, transport, mode)
 
844
 
 
845
    def _save(self):
 
846
        """Save the weave."""
 
847
        sio = StringIO()
 
848
        write_weave_v5(self, sio)
 
849
        sio.seek(0)
 
850
        self._transport.put(self._weave_name, sio, self._mode)
 
851
 
 
852
    def join(self, other, pb=None, msg=None, version_ids=None):
 
853
        """Join other into self and save."""
 
854
        super(WeaveFile, self).join(other, pb, msg, version_ids)
 
855
        self._save()
 
856
 
 
857
 
 
858
@deprecated_function(zero_eight)
 
859
def reweave(wa, wb, pb=None, msg=None):
 
860
    """reweaving is deprecation, please just use weave.join()."""
 
861
    _reweave(wa, wb, pb, msg)
 
862
 
 
863
def _reweave(wa, wb, pb=None, msg=None):
 
864
    """Combine two weaves and return the result.
 
865
 
 
866
    This works even if a revision R has different parents in 
 
867
    wa and wb.  In the resulting weave all the parents are given.
 
868
 
 
869
    This is done by just building up a new weave, maintaining ordering 
 
870
    of the versions in the two inputs.  More efficient approaches
 
871
    might be possible but it should only be necessary to do 
 
872
    this operation rarely, when a new previously ghost version is 
 
873
    inserted.
 
874
 
 
875
    :param pb: An optional progress bar, indicating how far done we are
 
876
    :param msg: An optional message for the progress
 
877
    """
 
878
    wr = Weave()
 
879
    ia = ib = 0
 
880
    queue_a = range(wa.numversions())
 
881
    queue_b = range(wb.numversions())
 
882
    # first determine combined parents of all versions
 
883
    # map from version name -> all parent names
 
884
    combined_parents = _reweave_parent_graphs(wa, wb)
 
885
    mutter("combined parents: %r", combined_parents)
 
886
    order = topo_sort(combined_parents.iteritems())
 
887
    mutter("order to reweave: %r", order)
 
888
 
 
889
    if pb and not msg:
 
890
        msg = 'reweave'
 
891
 
 
892
    for idx, name in enumerate(order):
 
893
        if pb:
 
894
            pb.update(msg, idx, len(order))
 
895
        if name in wa._name_map:
 
896
            lines = wa.get_lines(name)
 
897
            if name in wb._name_map:
 
898
                lines_b = wb.get_lines(name)
 
899
                if lines != lines_b:
 
900
                    mutter('Weaves differ on content. rev_id {%s}', name)
 
901
                    mutter('weaves: %s, %s', wa._weave_name, wb._weave_name)
 
902
                    import difflib
 
903
                    lines = list(difflib.unified_diff(lines, lines_b,
 
904
                            wa._weave_name, wb._weave_name))
 
905
                    mutter('lines:\n%s', ''.join(lines))
 
906
                    raise errors.WeaveTextDiffers(name, wa, wb)
 
907
        else:
 
908
            lines = wb.get_lines(name)
 
909
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
 
910
    return wr
 
911
 
 
912
def _reweave_parent_graphs(wa, wb):
 
913
    """Return combined parent ancestry for two weaves.
 
914
    
 
915
    Returned as a list of (version_name, set(parent_names))"""
 
916
    combined = {}
 
917
    for weave in [wa, wb]:
 
918
        for idx, name in enumerate(weave._names):
 
919
            p = combined.setdefault(name, set())
 
920
            p.update(map(weave._idx_to_name, weave._parents[idx]))
 
921
    return combined
710
922
 
711
923
 
712
924
def weave_toc(w):
723
935
 
724
936
 
725
937
 
726
 
def weave_stats(weave_file):
727
 
    from bzrlib.progress import ProgressBar
 
938
def weave_stats(weave_file, pb):
728
939
    from bzrlib.weavefile import read_weave
729
940
 
730
 
    pb = ProgressBar()
731
 
 
732
941
    wf = file(weave_file, 'rb')
733
 
    w = read_weave(wf)
 
942
    w = read_weave(wf, WeaveVersionedFile)
734
943
    # FIXME: doesn't work on pipes
735
944
    weave_size = wf.tell()
736
945
 
738
947
    vers = len(w)
739
948
    for i in range(vers):
740
949
        pb.update('checking sizes', i, vers)
741
 
        for line in w.get_iter(i):
 
950
        for origin, lineno, line in w._extract([i]):
742
951
            total += len(line)
743
952
 
744
953
    pb.clear()
771
980
        Add NEWTEXT, with specified parent versions.
772
981
    weave annotate WEAVEFILE VERSION
773
982
        Display origin of each line.
774
 
    weave mash WEAVEFILE VERSION...
775
 
        Display composite of all selected versions.
776
983
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
777
984
        Auto-merge two versions and display conflicts.
 
985
    weave diff WEAVEFILE VERSION1 VERSION2 
 
986
        Show differences between two versions.
778
987
 
779
988
example:
780
989
 
805
1014
def main(argv):
806
1015
    import sys
807
1016
    import os
808
 
    from weavefile import write_weave, read_weave
 
1017
    try:
 
1018
        import bzrlib
 
1019
    except ImportError:
 
1020
        # in case we're run directly from the subdirectory
 
1021
        sys.path.append('..')
 
1022
        import bzrlib
 
1023
    from bzrlib.weavefile import write_weave, read_weave
809
1024
    from bzrlib.progress import ProgressBar
810
1025
 
811
1026
    try:
844
1059
        w = readit()
845
1060
        sys.stdout.writelines(w.get_iter(int(argv[3])))
846
1061
        
847
 
    elif cmd == 'mash': # get composite
 
1062
    elif cmd == 'diff':
 
1063
        from difflib import unified_diff
848
1064
        w = readit()
849
 
        sys.stdout.writelines(w.mash_iter(map(int, argv[3:])))
850
 
 
 
1065
        fn = argv[2]
 
1066
        v1, v2 = map(int, argv[3:5])
 
1067
        lines1 = w.get(v1)
 
1068
        lines2 = w.get(v2)
 
1069
        diff_gen = unified_diff(lines1, lines2,
 
1070
                                '%s version %d' % (fn, v1),
 
1071
                                '%s version %d' % (fn, v2))
 
1072
        sys.stdout.writelines(diff_gen)
 
1073
            
851
1074
    elif cmd == 'annotate':
852
1075
        w = readit()
853
1076
        # newline is added to all lines regardless; too hard to get
865
1088
        weave_toc(readit())
866
1089
 
867
1090
    elif cmd == 'stats':
868
 
        weave_stats(argv[2])
 
1091
        weave_stats(argv[2], ProgressBar())
869
1092
        
870
1093
    elif cmd == 'check':
871
1094
        w = readit()
893
1116
        p = w.plan_merge(int(argv[3]), int(argv[4]))
894
1117
        sys.stdout.writelines(w.weave_merge(p))
895
1118
            
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
1119
    else:
917
1120
        raise ValueError('unknown command %r' % cmd)
918
1121
    
938
1141
    return ret
939
1142
 
940
1143
 
 
1144
def lsprofile_main(argv): 
 
1145
    from bzrlib.lsprof import profile
 
1146
    ret,stats = profile(main, argv)
 
1147
    stats.sort()
 
1148
    stats.pprint()
 
1149
    return ret
 
1150
 
 
1151
 
941
1152
if __name__ == '__main__':
942
1153
    import sys
943
1154
    if '--profile' in sys.argv:
944
1155
        args = sys.argv[:]
945
1156
        args.remove('--profile')
946
1157
        sys.exit(profile_main(args))
 
1158
    elif '--lsprof' in sys.argv:
 
1159
        args = sys.argv[:]
 
1160
        args.remove('--lsprof')
 
1161
        sys.exit(lsprofile_main(args))
947
1162
    else:
948
1163
        sys.exit(main(sys.argv))
949
1164
 
 
1165
 
 
1166
class InterWeave(InterVersionedFile):
 
1167
    """Optimised code paths for weave to weave operations."""
 
1168
    
 
1169
    _matching_file_factory = staticmethod(WeaveFile)
 
1170
    
 
1171
    @staticmethod
 
1172
    def is_compatible(source, target):
 
1173
        """Be compatible with weaves."""
 
1174
        try:
 
1175
            return (isinstance(source, Weave) and
 
1176
                    isinstance(target, Weave))
 
1177
        except AttributeError:
 
1178
            return False
 
1179
 
 
1180
    def join(self, pb=None, msg=None, version_ids=None):
 
1181
        """See InterVersionedFile.join."""
 
1182
        try:
 
1183
            self.target._join(self.source, pb, msg, version_ids)
 
1184
        except errors.WeaveParentMismatch:
 
1185
            self.target._reweave(self.source, pb, msg)
 
1186
 
 
1187
 
 
1188
InterVersionedFile.register_optimiser(InterWeave)