/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Robert Collins
  • Date: 2006-03-02 01:26:22 UTC
  • mto: (1594.2.4 integration)
  • mto: This revision was merged to the branch mainline in revision 1596.
  • Revision ID: robertc@robertcollins.net-20060302012622-6d1d0b92fe94d9be
Checkpointing: created InterObject to factor out common inter object worker code, added InterVersionedFile and tests to allow making join work between any versionedfile.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
#! /usr/bin/python
 
2
 
 
3
# Copyright (C) 2005 Canonical Ltd
 
4
 
 
5
# This program is free software; you can redistribute it and/or modify
 
6
# it under the terms of the GNU General Public License as published by
 
7
# the Free Software Foundation; either version 2 of the License, or
 
8
# (at your option) any later version.
 
9
 
 
10
# This program is distributed in the hope that it will be useful,
 
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
13
# GNU General Public License for more details.
 
14
 
 
15
# You should have received a copy of the GNU General Public License
 
16
# along with this program; if not, write to the Free Software
 
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
18
 
 
19
# Author: Martin Pool <mbp@canonical.com>
 
20
 
 
21
 
 
22
"""Weave - storage of related text file versions"""
 
23
 
 
24
 
 
25
# XXX: If we do weaves this way, will a merge still behave the same
 
26
# way if it's done in a different order?  That's a pretty desirable
 
27
# property.
 
28
 
 
29
# TODO: Nothing here so far assumes the lines are really \n newlines,
 
30
# rather than being split up in some other way.  We could accomodate
 
31
# binaries, perhaps by naively splitting on \n or perhaps using
 
32
# something like a rolling checksum.
 
33
 
 
34
# TODO: End marker for each version so we can stop reading?
 
35
 
 
36
# TODO: Check that no insertion occurs inside a deletion that was
 
37
# active in the version of the insertion.
 
38
 
 
39
# TODO: In addition to the SHA-1 check, perhaps have some code that
 
40
# checks structural constraints of the weave: ie that insertions are
 
41
# properly nested, that there is no text outside of an insertion, that
 
42
# insertions or deletions are not repeated, etc.
 
43
 
 
44
# TODO: Parallel-extract that passes back each line along with a
 
45
# description of which revisions include it.  Nice for checking all
 
46
# shas or calculating stats in parallel.
 
47
 
 
48
# TODO: Using a single _extract routine and then processing the output
 
49
# is probably inefficient.  It's simple enough that we can afford to
 
50
# have slight specializations for different ways its used: annotate,
 
51
# basis for add, get, etc.
 
52
 
 
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
 
73
import sha
 
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
 
88
from bzrlib.weavefile import _read_weave_v5, write_weave_v5
 
89
 
 
90
 
 
91
class Weave(VersionedFile):
 
92
    """weave - versioned text file storage.
 
93
    
 
94
    A Weave manages versions of line-based text files, keeping track
 
95
    of the originating version for each line.
 
96
 
 
97
    To clients the "lines" of the file are represented as a list of strings.
 
98
    These strings  will typically have terminal newline characters, but
 
99
    this is not required.  In particular files commonly do not have a newline
 
100
    at the end of the file.
 
101
 
 
102
    Texts can be identified in either of two ways:
 
103
 
 
104
    * a nonnegative index number.
 
105
 
 
106
    * a version-id string.
 
107
 
 
108
    Typically the index number will be valid only inside this weave and
 
109
    the version-id is used to reference it in the larger world.
 
110
 
 
111
    The weave is represented as a list mixing edit instructions and
 
112
    literal text.  Each entry in _weave can be either a string (or
 
113
    unicode), or a tuple.  If a string, it means that the given line
 
114
    should be output in the currently active revisions.
 
115
 
 
116
    If a tuple, it gives a processing instruction saying in which
 
117
    revisions the enclosed lines are active.  The tuple has the form
 
118
    (instruction, version).
 
119
 
 
120
    The instruction can be '{' or '}' for an insertion block, and '['
 
121
    and ']' for a deletion block respectively.  The version is the
 
122
    integer version index.  There is no replace operator, only deletes
 
123
    and inserts.  For '}', the end of an insertion, there is no
 
124
    version parameter because it always closes the most recently
 
125
    opened insertion.
 
126
 
 
127
    Constraints/notes:
 
128
 
 
129
    * A later version can delete lines that were introduced by any
 
130
      number of ancestor versions; this implies that deletion
 
131
      instructions can span insertion blocks without regard to the
 
132
      insertion block's nesting.
 
133
 
 
134
    * Similarly, deletions need not be properly nested with regard to
 
135
      each other, because they might have been generated by
 
136
      independent revisions.
 
137
 
 
138
    * Insertions are always made by inserting a new bracketed block
 
139
      into a single point in the previous weave.  This implies they
 
140
      can nest but not overlap, and the nesting must always have later
 
141
      insertions on the inside.
 
142
 
 
143
    * It doesn't seem very useful to have an active insertion
 
144
      inside an inactive insertion, but it might happen.
 
145
      
 
146
    * Therefore, all instructions are always"considered"; that
 
147
      is passed onto and off the stack.  An outer inactive block
 
148
      doesn't disable an inner block.
 
149
 
 
150
    * Lines are enabled if the most recent enclosing insertion is
 
151
      active and none of the enclosing deletions are active.
 
152
 
 
153
    * There is no point having a deletion directly inside its own
 
154
      insertion; you might as well just not write it.  And there
 
155
      should be no way to get an earlier version deleting a later
 
156
      version.
 
157
 
 
158
    _weave
 
159
        Text of the weave; list of control instruction tuples and strings.
 
160
 
 
161
    _parents
 
162
        List of parents, indexed by version number.
 
163
        It is only necessary to store the minimal set of parents for
 
164
        each version; the parent's parents are implied.
 
165
 
 
166
    _sha1s
 
167
        List of hex SHA-1 of each version.
 
168
 
 
169
    _names
 
170
        List of symbolic names for each version.  Each should be unique.
 
171
 
 
172
    _name_map
 
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.
 
178
    """
 
179
 
 
180
    __slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map',
 
181
                 '_weave_name']
 
182
    
 
183
    def __init__(self, weave_name=None):
 
184
        self._weave = []
 
185
        self._parents = []
 
186
        self._sha1s = []
 
187
        self._names = []
 
188
        self._name_map = {}
 
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
 
206
 
 
207
    def __eq__(self, other):
 
208
        if not isinstance(other, Weave):
 
209
            return False
 
210
        return self._parents == other._parents \
 
211
               and self._weave == other._weave \
 
212
               and self._sha1s == other._sha1s 
 
213
    
 
214
    def __ne__(self, other):
 
215
        return not self.__eq__(other)
 
216
 
 
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)
 
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."""
 
236
        try:
 
237
            return self._name_map[name]
 
238
        except KeyError:
 
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):
 
291
        """Add a single text on top of the weave.
 
292
  
 
293
        Returns the index number of the newly added version.
 
294
 
 
295
        version_id
 
296
            Symbolic name for this version.
 
297
            (Typically the revision-id of the revision that added it.)
 
298
 
 
299
        parents
 
300
            List or set of direct parent version numbers.
 
301
            
 
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
 
 
312
        self._check_versions(parents)
 
313
        ## self._check_lines(lines)
 
314
        new_version = len(self._parents)
 
315
 
 
316
        # if we abort after here the (in-memory) weave will be corrupt because only
 
317
        # some fields are updated
 
318
        self._parents.append(parents[:])
 
319
        self._sha1s.append(sha1)
 
320
        self._names.append(version_id)
 
321
        self._name_map[version_id] = new_version
 
322
 
 
323
            
 
324
        if not parents:
 
325
            # special case; adding with no parents revision; can do
 
326
            # this more quickly by just appending unconditionally.
 
327
            # even more specially, if we're adding an empty text we
 
328
            # need do nothing at all.
 
329
            if lines:
 
330
                self._weave.append(('{', new_version))
 
331
                self._weave.extend(lines)
 
332
                self._weave.append(('}', None))
 
333
            return new_version
 
334
 
 
335
        if len(parents) == 1:
 
336
            pv = list(parents)[0]
 
337
            if sha1 == self._sha1s[pv]:
 
338
                # special case: same as the single parent
 
339
                return new_version
 
340
            
 
341
 
 
342
        ancestors = self._inclusions(parents)
 
343
 
 
344
        l = self._weave
 
345
 
 
346
        # basis a list of (origin, lineno, line)
 
347
        basis_lineno = []
 
348
        basis_lines = []
 
349
        for origin, lineno, line in self._extract(ancestors):
 
350
            basis_lineno.append(lineno)
 
351
            basis_lines.append(line)
 
352
 
 
353
        # another small special case: a merge, producing the same text
 
354
        # as auto-merge
 
355
        if lines == basis_lines:
 
356
            return new_version            
 
357
 
 
358
        # add a sentinal, because we can also match against the final line
 
359
        basis_lineno.append(len(self._weave))
 
360
 
 
361
        # XXX: which line of the weave should we really consider
 
362
        # matches the end of the file?  the current code says it's the
 
363
        # last line of the weave?
 
364
 
 
365
        #print 'basis_lines:', basis_lines
 
366
        #print 'new_lines:  ', lines
 
367
 
 
368
        s = SequenceMatcher(None, basis_lines, lines)
 
369
 
 
370
        # offset gives the number of lines that have been inserted
 
371
        # into the weave up to the current point; if the original edit instruction
 
372
        # says to change line A then we actually change (A+offset)
 
373
        offset = 0
 
374
 
 
375
        for tag, i1, i2, j1, j2 in s.get_opcodes():
 
376
            # i1,i2 are given in offsets within basis_lines; we need to map them
 
377
            # back to offsets within the entire weave
 
378
            #print 'raw match', tag, i1, i2, j1, j2
 
379
            if tag == 'equal':
 
380
                continue
 
381
 
 
382
            i1 = basis_lineno[i1]
 
383
            i2 = basis_lineno[i2]
 
384
 
 
385
            assert 0 <= j1 <= j2 <= len(lines)
 
386
 
 
387
            #print tag, i1, i2, j1, j2
 
388
 
 
389
            # the deletion and insertion are handled separately.
 
390
            # first delete the region.
 
391
            if i1 != i2:
 
392
                self._weave.insert(i1+offset, ('[', new_version))
 
393
                self._weave.insert(i2+offset+1, (']', new_version))
 
394
                offset += 2
 
395
 
 
396
            if j1 != j2:
 
397
                # there may have been a deletion spanning up to
 
398
                # i2; we want to insert after this region to make sure
 
399
                # we don't destroy ourselves
 
400
                i = i2 + offset
 
401
                self._weave[i:i] = ([('{', new_version)] 
 
402
                                    + lines[j1:j2] 
 
403
                                    + [('}', None)])
 
404
                offset += 2 + (j2 - j1)
 
405
        return new_version
 
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)
 
411
 
 
412
    def _inclusions(self, versions):
 
413
        """Return set of all ancestors of given version(s)."""
 
414
        i = set(versions)
 
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:
 
427
            return []
 
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]
 
439
 
 
440
    def _check_lines(self, text):
 
441
        if not isinstance(text, list):
 
442
            raise ValueError("text should be a list, not %s" % type(text))
 
443
 
 
444
        for l in text:
 
445
            if not isinstance(l, basestring):
 
446
                raise ValueError("text line should be a string or unicode, not %s"
 
447
                                 % type(l))
 
448
        
 
449
 
 
450
 
 
451
    def _check_versions(self, indexes):
 
452
        """Check everything in the sequence of indexes is valid"""
 
453
        for i in indexes:
 
454
            try:
 
455
                self._parents[i]
 
456
            except IndexError:
 
457
                raise IndexError("invalid version number %r" % i)
 
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)
 
472
    
 
473
    def annotate_iter(self, version_id):
 
474
        """Yield list of (version-id, line) pairs for the specified version.
 
475
 
 
476
        The index indicates when the line originated in the weave."""
 
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)
 
482
    def _walk(self):
 
483
        """_walk has become walk, a supported api."""
 
484
        return self.walk()
 
485
 
 
486
    def walk(self, version_ids=None):
 
487
        """See VersionedFile.walk."""
 
488
        
 
489
        istack = []
 
490
        dset = set()
 
491
 
 
492
        lineno = 0         # line of weave, 0-based
 
493
 
 
494
        for l in self._weave:
 
495
            if isinstance(l, tuple):
 
496
                c, v = l
 
497
                isactive = None
 
498
                if c == '{':
 
499
                    istack.append(self._idx_to_name(v))
 
500
                elif c == '}':
 
501
                    istack.pop()
 
502
                elif c == '[':
 
503
                    assert self._idx_to_name(v) not in dset
 
504
                    dset.add(self._idx_to_name(v))
 
505
                elif c == ']':
 
506
                    dset.remove(self._idx_to_name(v))
 
507
                else:
 
508
                    raise WeaveFormatError('unexpected instruction %r' % v)
 
509
            else:
 
510
                assert isinstance(l, basestring)
 
511
                assert istack
 
512
                yield lineno, istack[-1], dset.copy(), l
 
513
            lineno += 1
 
514
 
 
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)
 
521
 
 
522
    def _extract(self, versions):
 
523
        """Yield annotation of lines in included set.
 
524
 
 
525
        Yields a sequence of tuples (origin, lineno, text), where
 
526
        origin is the origin version, lineno the index in the weave,
 
527
        and text the text of the line.
 
528
 
 
529
        The set typically but not necessarily corresponds to a version.
 
530
        """
 
531
        for i in versions:
 
532
            if not isinstance(i, int):
 
533
                raise ValueError(i)
 
534
            
 
535
        included = self._inclusions(versions)
 
536
 
 
537
        istack = []
 
538
        dset = set()
 
539
 
 
540
        lineno = 0         # line of weave, 0-based
 
541
 
 
542
        isactive = None
 
543
 
 
544
        result = []
 
545
 
 
546
        WFE = WeaveFormatError
 
547
 
 
548
        for l in self._weave:
 
549
            if isinstance(l, tuple):
 
550
                c, v = l
 
551
                isactive = None
 
552
                if c == '{':
 
553
                    assert v not in istack
 
554
                    istack.append(v)
 
555
                elif c == '}':
 
556
                    istack.pop()
 
557
                elif c == '[':
 
558
                    if v in included:
 
559
                        assert v not in dset
 
560
                        dset.add(v)
 
561
                else:
 
562
                    assert c == ']'
 
563
                    if v in included:
 
564
                        assert v in dset
 
565
                        dset.remove(v)
 
566
            else:
 
567
                assert isinstance(l, basestring)
 
568
                if isactive is None:
 
569
                    isactive = (not dset) and istack and (istack[-1] in included)
 
570
                if isactive:
 
571
                    result.append((istack[-1], lineno, l))
 
572
            lineno += 1
 
573
        if istack:
 
574
            raise WeaveFormatError("unclosed insertion blocks "
 
575
                    "at end of weave: %s" % istack)
 
576
        if dset:
 
577
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
 
578
                                   % dset)
 
579
        return result
 
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
        return self._get_iter(self._maybe_lookup(name_or_index))
 
585
 
 
586
    @deprecated_method(zero_eight)
 
587
    def maybe_lookup(self, name_or_index):
 
588
        """Deprecated, please do not use. Lookups are not not needed."""
 
589
        return self._maybe_lookup(name_or_index)
 
590
 
 
591
    def _maybe_lookup(self, name_or_index):
 
592
        """Convert possible symbolic name to index, or pass through indexes.
 
593
        
 
594
        NOT FOR PUBLIC USE.
 
595
        """
 
596
        if isinstance(name_or_index, (int, long)):
 
597
            return name_or_index
 
598
        else:
 
599
            return self._lookup(name_or_index)
 
600
 
 
601
    def _get_iter(self, version_id):
 
602
        """Yield lines for the specified version."""
 
603
        incls = [self._maybe_lookup(version_id)]
 
604
        if len(incls) == 1:
 
605
            index = incls[0]
 
606
            cur_sha = sha.new()
 
607
        else:
 
608
            # We don't have sha1 sums for multiple entries
 
609
            cur_sha = None
 
610
        for origin, lineno, line in self._extract(incls):
 
611
            if cur_sha:
 
612
                cur_sha.update(line)
 
613
            yield line
 
614
        if cur_sha:
 
615
            expected_sha1 = self._sha1s[index]
 
616
            measured_sha1 = cur_sha.hexdigest() 
 
617
            if measured_sha1 != expected_sha1:
 
618
                raise errors.WeaveInvalidChecksum(
 
619
                        'file %s, revision %s, expected: %s, measured %s' 
 
620
                        % (self._weave_name, self._names[index],
 
621
                           expected_sha1, measured_sha1))
 
622
 
 
623
    @deprecated_method(zero_eight)
 
624
    def get(self, version_id):
 
625
        """Please use either Weave.get_text or Weave.get_lines as desired."""
 
626
        return self.get_lines(version_id)
 
627
 
 
628
    def get_lines(self, version_id):
 
629
        """See VersionedFile.get_lines()."""
 
630
        return list(self._get_iter(version_id))
 
631
 
 
632
    def get_sha1(self, name):
 
633
        """Get the stored sha1 sum for the given revision.
 
634
        
 
635
        :param name: The name of the version to lookup
 
636
        """
 
637
        return self._sha1s[self._lookup(name)]
 
638
 
 
639
    def numversions(self):
 
640
        l = len(self._parents)
 
641
        assert l == len(self._sha1s)
 
642
        return l
 
643
 
 
644
    __len__ = numversions
 
645
 
 
646
    def check(self, progress_bar=None):
 
647
        # TODO evaluate performance hit of using string sets in this routine.
 
648
        # check no circular inclusions
 
649
        for version in range(self.numversions()):
 
650
            inclusions = list(self._parents[version])
 
651
            if inclusions:
 
652
                inclusions.sort()
 
653
                if inclusions[-1] >= version:
 
654
                    raise WeaveFormatError("invalid included version %d for index %d"
 
655
                                           % (inclusions[-1], version))
 
656
 
 
657
        # try extracting all versions; parallel extraction is used
 
658
        nv = self.numversions()
 
659
        sha1s = {}
 
660
        texts = {}
 
661
        inclusions = {}
 
662
        for i in range(nv):
 
663
            # For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
 
664
            # The problem is that set membership is much more expensive
 
665
            name = self._idx_to_name(i)
 
666
            sha1s[name] = sha.new()
 
667
            texts[name] = []
 
668
            new_inc = set([name])
 
669
            for p in self._parents[i]:
 
670
                new_inc.update(inclusions[self._idx_to_name(p)])
 
671
 
 
672
            assert set(new_inc) == set(self.get_ancestry(name)), \
 
673
                'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
 
674
            inclusions[name] = new_inc
 
675
 
 
676
        nlines = len(self._weave)
 
677
 
 
678
        update_text = 'checking weave'
 
679
        if self._weave_name:
 
680
            short_name = os.path.basename(self._weave_name)
 
681
            update_text = 'checking %s' % (short_name,)
 
682
            update_text = update_text[:25]
 
683
 
 
684
        for lineno, insert, deleteset, line in self.walk():
 
685
            if progress_bar:
 
686
                progress_bar.update(update_text, lineno, nlines)
 
687
 
 
688
            for name, name_inclusions in inclusions.items():
 
689
                # The active inclusion must be an ancestor,
 
690
                # and no ancestors must have deleted this line,
 
691
                # because we don't support resurrection.
 
692
                if (insert in name_inclusions) and not (deleteset & name_inclusions):
 
693
                    sha1s[name].update(line)
 
694
 
 
695
        for i in range(nv):
 
696
            version = self._idx_to_name(i)
 
697
            hd = sha1s[version].hexdigest()
 
698
            expected = self._sha1s[i]
 
699
            if hd != expected:
 
700
                raise errors.WeaveInvalidChecksum(
 
701
                        "mismatched sha1 for version %s: "
 
702
                        "got %s, expected %s"
 
703
                        % (version, hd, expected))
 
704
 
 
705
        # TODO: check insertions are properly nested, that there are
 
706
        # no lines outside of insertion blocks, that deletions are
 
707
        # properly paired, etc.
 
708
 
 
709
 
 
710
    def join(self, other, pb=None, msg=None, version_ids=None):
 
711
        import sys, time
 
712
        """Integrate versions from other into this weave.
 
713
 
 
714
        The resulting weave contains all the history of both weaves; 
 
715
        any version you could retrieve from either self or other can be 
 
716
        retrieved from self after this call.
 
717
 
 
718
        It is illegal for the two weaves to contain different values 
 
719
        or different parents for any version.  See also reweave().
 
720
 
 
721
        :param other: The other weave to pull into this one
 
722
        :param pb: An optional progress bar
 
723
        :param msg: An optional message to display for progress
 
724
        """
 
725
        try:
 
726
            self._join(other, pb, msg, version_ids)
 
727
        except errors.WeaveParentMismatch:
 
728
            self._reweave(other, pb, msg)
 
729
 
 
730
    def _join(self, other, pb, msg, version_ids):
 
731
        """Worker routine for join()."""
 
732
        if not other.versions():
 
733
            return          # nothing to update, easy
 
734
 
 
735
        if version_ids:
 
736
            for version_id in version_ids:
 
737
                if not self.has_version(version_id):
 
738
                    raise RevisionNotPresent(version_id, self._weave_name)
 
739
        assert version_ids == None
 
740
 
 
741
        # two loops so that we do not change ourselves before verifying it
 
742
        # will be ok
 
743
        # work through in index order to make sure we get all dependencies
 
744
        names_to_join = []
 
745
        processed = 0
 
746
        for other_idx, name in enumerate(other._names):
 
747
            self._check_version_consistent(other, other_idx, name)
 
748
            sha1 = other._sha1s[other_idx]
 
749
 
 
750
            processed += 1
 
751
 
 
752
            if name in self._name_map:
 
753
                idx = self._lookup(name)
 
754
                n1 = set(map(other._idx_to_name, other._parents[other_idx]))
 
755
                n2 = set(map(self._idx_to_name, self._parents[idx]))
 
756
                if sha1 ==  self._sha1s[idx] and n1 == n2:
 
757
                        continue
 
758
 
 
759
            names_to_join.append((other_idx, name))
 
760
 
 
761
        if pb and not msg:
 
762
            msg = 'weave join'
 
763
 
 
764
        merged = 0
 
765
        time0 = time.time()
 
766
        for other_idx, name in names_to_join:
 
767
            # TODO: If all the parents of the other version are already
 
768
            # present then we can avoid some work by just taking the delta
 
769
            # and adjusting the offsets.
 
770
            new_parents = self._imported_parents(other, other_idx)
 
771
            sha1 = other._sha1s[other_idx]
 
772
 
 
773
            merged += 1
 
774
 
 
775
            if pb:
 
776
                pb.update(msg, merged, len(names_to_join))
 
777
           
 
778
            lines = other.get_lines(other_idx)
 
779
            self._add(name, lines, new_parents, sha1)
 
780
 
 
781
        mutter("merged = %d, processed = %d, file_id=%s; deltat=%d"%(
 
782
                merged, processed, self._weave_name, time.time()-time0))
 
783
 
 
784
    def _imported_parents(self, other, other_idx):
 
785
        """Return list of parents in self corresponding to indexes in other."""
 
786
        new_parents = []
 
787
        for parent_idx in other._parents[other_idx]:
 
788
            parent_name = other._names[parent_idx]
 
789
            if parent_name not in self._names:
 
790
                # should not be possible
 
791
                raise WeaveError("missing parent {%s} of {%s} in %r" 
 
792
                                 % (parent_name, other._name_map[other_idx], self))
 
793
            new_parents.append(self._name_map[parent_name])
 
794
        return new_parents
 
795
 
 
796
    def _check_version_consistent(self, other, other_idx, name):
 
797
        """Check if a version in consistent in this and other.
 
798
 
 
799
        To be consistent it must have:
 
800
 
 
801
         * the same text
 
802
         * the same direct parents (by name, not index, and disregarding
 
803
           order)
 
804
        
 
805
        If present & correct return True;
 
806
        if not present in self return False; 
 
807
        if inconsistent raise error."""
 
808
        this_idx = self._name_map.get(name, -1)
 
809
        if this_idx != -1:
 
810
            if self._sha1s[this_idx] != other._sha1s[other_idx]:
 
811
                raise errors.WeaveTextDiffers(name, self, other)
 
812
            self_parents = self._parents[this_idx]
 
813
            other_parents = other._parents[other_idx]
 
814
            n1 = set([self._names[i] for i in self_parents])
 
815
            n2 = set([other._names[i] for i in other_parents])
 
816
            if n1 != n2:
 
817
                raise WeaveParentMismatch("inconsistent parents "
 
818
                    "for version {%s}: %s vs %s" % (name, n1, n2))
 
819
            else:
 
820
                return True         # ok!
 
821
        else:
 
822
            return False
 
823
 
 
824
    @deprecated_method(zero_eight)
 
825
    def reweave(self, other, pb=None, msg=None):
 
826
        """reweave has been superceded by plain use of join."""
 
827
        return self.join(other, pb, msg)
 
828
 
 
829
    def _reweave(self, other, pb, msg):
 
830
        """Reweave self with other - internal helper for join().
 
831
 
 
832
        :param other: The other weave to merge
 
833
        :param pb: An optional progress bar, indicating how far done we are
 
834
        :param msg: An optional message for the progress
 
835
        """
 
836
        new_weave = _reweave(self, other, pb=pb, msg=msg)
 
837
        for attr in self.__slots__:
 
838
            if attr != '_weave_name':
 
839
                setattr(self, attr, getattr(new_weave, attr))
 
840
 
 
841
 
 
842
class WeaveFile(Weave):
 
843
    """A WeaveFile represents a Weave on disk and writes on change."""
 
844
 
 
845
    def __init__(self, name, transport, mode=None):
 
846
        super(WeaveFile, self).__init__(name)
 
847
        self._transport = transport
 
848
        self._mode = mode
 
849
        try:
 
850
            _read_weave_v5(self._transport.get(name), self)
 
851
        except errors.NoSuchFile:
 
852
            # new file, no-op.
 
853
            pass
 
854
 
 
855
    def add_lines(self, version_id, parents, lines):
 
856
        """Add a version and save the weave."""
 
857
        super(WeaveFile, self).add_lines(version_id, parents, lines)
 
858
        self._save()
 
859
 
 
860
    def _save(self):
 
861
        """Save the weave."""
 
862
        sio = StringIO()
 
863
        write_weave_v5(self, sio)
 
864
        sio.seek(0)
 
865
        self._transport.put(self._weave_name, sio, self._mode)
 
866
 
 
867
    def join(self, other, pb=None, msg=None, version_ids=None):
 
868
        """Join other into self and save."""
 
869
        super(WeaveFile, self).join(other, pb, msg, version_ids)
 
870
        self._save()
 
871
 
 
872
 
 
873
@deprecated_function(zero_eight)
 
874
def reweave(wa, wb, pb=None, msg=None):
 
875
    """reweaving is deprecation, please just use weave.join()."""
 
876
    _reweave(wa, wb, pb, msg)
 
877
 
 
878
def _reweave(wa, wb, pb=None, msg=None):
 
879
    """Combine two weaves and return the result.
 
880
 
 
881
    This works even if a revision R has different parents in 
 
882
    wa and wb.  In the resulting weave all the parents are given.
 
883
 
 
884
    This is done by just building up a new weave, maintaining ordering 
 
885
    of the versions in the two inputs.  More efficient approaches
 
886
    might be possible but it should only be necessary to do 
 
887
    this operation rarely, when a new previously ghost version is 
 
888
    inserted.
 
889
 
 
890
    :param pb: An optional progress bar, indicating how far done we are
 
891
    :param msg: An optional message for the progress
 
892
    """
 
893
    wr = Weave()
 
894
    ia = ib = 0
 
895
    queue_a = range(wa.numversions())
 
896
    queue_b = range(wb.numversions())
 
897
    # first determine combined parents of all versions
 
898
    # map from version name -> all parent names
 
899
    combined_parents = _reweave_parent_graphs(wa, wb)
 
900
    mutter("combined parents: %r", combined_parents)
 
901
    order = topo_sort(combined_parents.iteritems())
 
902
    mutter("order to reweave: %r", order)
 
903
 
 
904
    if pb and not msg:
 
905
        msg = 'reweave'
 
906
 
 
907
    for idx, name in enumerate(order):
 
908
        if pb:
 
909
            pb.update(msg, idx, len(order))
 
910
        if name in wa._name_map:
 
911
            lines = wa.get_lines(name)
 
912
            if name in wb._name_map:
 
913
                lines_b = wb.get_lines(name)
 
914
                if lines != lines_b:
 
915
                    mutter('Weaves differ on content. rev_id {%s}', name)
 
916
                    mutter('weaves: %s, %s', wa._weave_name, wb._weave_name)
 
917
                    import difflib
 
918
                    lines = list(difflib.unified_diff(lines, lines_b,
 
919
                            wa._weave_name, wb._weave_name))
 
920
                    mutter('lines:\n%s', ''.join(lines))
 
921
                    raise errors.WeaveTextDiffers(name, wa, wb)
 
922
        else:
 
923
            lines = wb.get_lines(name)
 
924
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
 
925
    return wr
 
926
 
 
927
def _reweave_parent_graphs(wa, wb):
 
928
    """Return combined parent ancestry for two weaves.
 
929
    
 
930
    Returned as a list of (version_name, set(parent_names))"""
 
931
    combined = {}
 
932
    for weave in [wa, wb]:
 
933
        for idx, name in enumerate(weave._names):
 
934
            p = combined.setdefault(name, set())
 
935
            p.update(map(weave._idx_to_name, weave._parents[idx]))
 
936
    return combined
 
937
 
 
938
 
 
939
def weave_toc(w):
 
940
    """Show the weave's table-of-contents"""
 
941
    print '%6s %50s %10s %10s' % ('ver', 'name', 'sha1', 'parents')
 
942
    for i in (6, 50, 10, 10):
 
943
        print '-' * i,
 
944
    print
 
945
    for i in range(w.numversions()):
 
946
        sha1 = w._sha1s[i]
 
947
        name = w._names[i]
 
948
        parent_str = ' '.join(map(str, w._parents[i]))
 
949
        print '%6d %-50.50s %10.10s %s' % (i, name, sha1, parent_str)
 
950
 
 
951
 
 
952
 
 
953
def weave_stats(weave_file, pb):
 
954
    from bzrlib.weavefile import read_weave
 
955
 
 
956
    wf = file(weave_file, 'rb')
 
957
    w = read_weave(wf, WeaveVersionedFile)
 
958
    # FIXME: doesn't work on pipes
 
959
    weave_size = wf.tell()
 
960
 
 
961
    total = 0
 
962
    vers = len(w)
 
963
    for i in range(vers):
 
964
        pb.update('checking sizes', i, vers)
 
965
        for origin, lineno, line in w._extract([i]):
 
966
            total += len(line)
 
967
 
 
968
    pb.clear()
 
969
 
 
970
    print 'versions          %9d' % vers
 
971
    print 'weave file        %9d bytes' % weave_size
 
972
    print 'total contents    %9d bytes' % total
 
973
    print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
 
974
    if vers:
 
975
        avg = total/vers
 
976
        print 'average size      %9d bytes' % avg
 
977
        print 'relative size     %9.2fx' % (float(weave_size) / float(avg))
 
978
 
 
979
 
 
980
def usage():
 
981
    print """bzr weave tool
 
982
 
 
983
Experimental tool for weave algorithm.
 
984
 
 
985
usage:
 
986
    weave init WEAVEFILE
 
987
        Create an empty weave file
 
988
    weave get WEAVEFILE VERSION
 
989
        Write out specified version.
 
990
    weave check WEAVEFILE
 
991
        Check consistency of all versions.
 
992
    weave toc WEAVEFILE
 
993
        Display table of contents.
 
994
    weave add WEAVEFILE NAME [BASE...] < NEWTEXT
 
995
        Add NEWTEXT, with specified parent versions.
 
996
    weave annotate WEAVEFILE VERSION
 
997
        Display origin of each line.
 
998
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
 
999
        Auto-merge two versions and display conflicts.
 
1000
    weave diff WEAVEFILE VERSION1 VERSION2 
 
1001
        Show differences between two versions.
 
1002
 
 
1003
example:
 
1004
 
 
1005
    % weave init foo.weave
 
1006
    % vi foo.txt
 
1007
    % weave add foo.weave ver0 < foo.txt
 
1008
    added version 0
 
1009
 
 
1010
    (create updated version)
 
1011
    % vi foo.txt
 
1012
    % weave get foo.weave 0 | diff -u - foo.txt
 
1013
    % weave add foo.weave ver1 0 < foo.txt
 
1014
    added version 1
 
1015
 
 
1016
    % weave get foo.weave 0 > foo.txt       (create forked version)
 
1017
    % vi foo.txt
 
1018
    % weave add foo.weave ver2 0 < foo.txt
 
1019
    added version 2
 
1020
 
 
1021
    % weave merge foo.weave 1 2 > foo.txt   (merge them)
 
1022
    % vi foo.txt                            (resolve conflicts)
 
1023
    % weave add foo.weave merged 1 2 < foo.txt     (commit merged version)     
 
1024
    
 
1025
"""
 
1026
    
 
1027
 
 
1028
 
 
1029
def main(argv):
 
1030
    import sys
 
1031
    import os
 
1032
    try:
 
1033
        import bzrlib
 
1034
    except ImportError:
 
1035
        # in case we're run directly from the subdirectory
 
1036
        sys.path.append('..')
 
1037
        import bzrlib
 
1038
    from bzrlib.weavefile import write_weave, read_weave
 
1039
    from bzrlib.progress import ProgressBar
 
1040
 
 
1041
    try:
 
1042
        import psyco
 
1043
        psyco.full()
 
1044
    except ImportError:
 
1045
        pass
 
1046
 
 
1047
    if len(argv) < 2:
 
1048
        usage()
 
1049
        return 0
 
1050
 
 
1051
    cmd = argv[1]
 
1052
 
 
1053
    def readit():
 
1054
        return read_weave(file(argv[2], 'rb'))
 
1055
    
 
1056
    if cmd == 'help':
 
1057
        usage()
 
1058
    elif cmd == 'add':
 
1059
        w = readit()
 
1060
        # at the moment, based on everything in the file
 
1061
        name = argv[3]
 
1062
        parents = map(int, argv[4:])
 
1063
        lines = sys.stdin.readlines()
 
1064
        ver = w.add(name, parents, lines)
 
1065
        write_weave(w, file(argv[2], 'wb'))
 
1066
        print 'added version %r %d' % (name, ver)
 
1067
    elif cmd == 'init':
 
1068
        fn = argv[2]
 
1069
        if os.path.exists(fn):
 
1070
            raise IOError("file exists")
 
1071
        w = Weave()
 
1072
        write_weave(w, file(fn, 'wb'))
 
1073
    elif cmd == 'get': # get one version
 
1074
        w = readit()
 
1075
        sys.stdout.writelines(w.get_iter(int(argv[3])))
 
1076
        
 
1077
    elif cmd == 'diff':
 
1078
        from difflib import unified_diff
 
1079
        w = readit()
 
1080
        fn = argv[2]
 
1081
        v1, v2 = map(int, argv[3:5])
 
1082
        lines1 = w.get(v1)
 
1083
        lines2 = w.get(v2)
 
1084
        diff_gen = unified_diff(lines1, lines2,
 
1085
                                '%s version %d' % (fn, v1),
 
1086
                                '%s version %d' % (fn, v2))
 
1087
        sys.stdout.writelines(diff_gen)
 
1088
            
 
1089
    elif cmd == 'annotate':
 
1090
        w = readit()
 
1091
        # newline is added to all lines regardless; too hard to get
 
1092
        # reasonable formatting otherwise
 
1093
        lasto = None
 
1094
        for origin, text in w.annotate(int(argv[3])):
 
1095
            text = text.rstrip('\r\n')
 
1096
            if origin == lasto:
 
1097
                print '      | %s' % (text)
 
1098
            else:
 
1099
                print '%5d | %s' % (origin, text)
 
1100
                lasto = origin
 
1101
                
 
1102
    elif cmd == 'toc':
 
1103
        weave_toc(readit())
 
1104
 
 
1105
    elif cmd == 'stats':
 
1106
        weave_stats(argv[2], ProgressBar())
 
1107
        
 
1108
    elif cmd == 'check':
 
1109
        w = readit()
 
1110
        pb = ProgressBar()
 
1111
        w.check(pb)
 
1112
        pb.clear()
 
1113
        print '%d versions ok' % w.numversions()
 
1114
 
 
1115
    elif cmd == 'inclusions':
 
1116
        w = readit()
 
1117
        print ' '.join(map(str, w.inclusions([int(argv[3])])))
 
1118
 
 
1119
    elif cmd == 'parents':
 
1120
        w = readit()
 
1121
        print ' '.join(map(str, w._parents[int(argv[3])]))
 
1122
 
 
1123
    elif cmd == 'plan-merge':
 
1124
        w = readit()
 
1125
        for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
 
1126
            if line:
 
1127
                print '%14s | %s' % (state, line),
 
1128
 
 
1129
    elif cmd == 'merge':
 
1130
        w = readit()
 
1131
        p = w.plan_merge(int(argv[3]), int(argv[4]))
 
1132
        sys.stdout.writelines(w.weave_merge(p))
 
1133
            
 
1134
    else:
 
1135
        raise ValueError('unknown command %r' % cmd)
 
1136
    
 
1137
 
 
1138
 
 
1139
def profile_main(argv): 
 
1140
    import tempfile, hotshot, hotshot.stats
 
1141
 
 
1142
    prof_f = tempfile.NamedTemporaryFile()
 
1143
 
 
1144
    prof = hotshot.Profile(prof_f.name)
 
1145
 
 
1146
    ret = prof.runcall(main, argv)
 
1147
    prof.close()
 
1148
 
 
1149
    stats = hotshot.stats.load(prof_f.name)
 
1150
    #stats.strip_dirs()
 
1151
    stats.sort_stats('cumulative')
 
1152
    ## XXX: Might like to write to stderr or the trace file instead but
 
1153
    ## print_stats seems hardcoded to stdout
 
1154
    stats.print_stats(20)
 
1155
            
 
1156
    return ret
 
1157
 
 
1158
 
 
1159
def lsprofile_main(argv): 
 
1160
    from bzrlib.lsprof import profile
 
1161
    ret,stats = profile(main, argv)
 
1162
    stats.sort()
 
1163
    stats.pprint()
 
1164
    return ret
 
1165
 
 
1166
 
 
1167
if __name__ == '__main__':
 
1168
    import sys
 
1169
    if '--profile' in sys.argv:
 
1170
        args = sys.argv[:]
 
1171
        args.remove('--profile')
 
1172
        sys.exit(profile_main(args))
 
1173
    elif '--lsprof' in sys.argv:
 
1174
        args = sys.argv[:]
 
1175
        args.remove('--lsprof')
 
1176
        sys.exit(lsprofile_main(args))
 
1177
    else:
 
1178
        sys.exit(main(sys.argv))
 
1179