~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Martin Pool
  • Date: 2006-03-09 03:28:52 UTC
  • mto: This revision was merged to the branch mainline in revision 1602.
  • Revision ID: mbp@sourcefrog.net-20060309032852-1097eb1947d9bceb
doc

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
import os
 
71
import sha
 
72
from difflib import SequenceMatcher
 
73
 
 
74
from bzrlib.trace import mutter
 
75
from bzrlib.errors import (WeaveError, WeaveFormatError, WeaveParentMismatch,
 
76
        WeaveRevisionNotPresent, WeaveRevisionAlreadyPresent)
 
77
import bzrlib.errors as errors
 
78
from bzrlib.tsort import topo_sort
 
79
 
 
80
 
 
81
class Weave(object):
 
82
    """weave - versioned text file storage.
 
83
    
 
84
    A Weave manages versions of line-based text files, keeping track
 
85
    of the originating version for each line.
 
86
 
 
87
    To clients the "lines" of the file are represented as a list of strings.
 
88
    These strings  will typically have terminal newline characters, but
 
89
    this is not required.  In particular files commonly do not have a newline
 
90
    at the end of the file.
 
91
 
 
92
    Texts can be identified in either of two ways:
 
93
 
 
94
    * a nonnegative index number.
 
95
 
 
96
    * a version-id string.
 
97
 
 
98
    Typically the index number will be valid only inside this weave and
 
99
    the version-id is used to reference it in the larger world.
 
100
 
 
101
    The weave is represented as a list mixing edit instructions and
 
102
    literal text.  Each entry in _weave can be either a string (or
 
103
    unicode), or a tuple.  If a string, it means that the given line
 
104
    should be output in the currently active revisions.
 
105
 
 
106
    If a tuple, it gives a processing instruction saying in which
 
107
    revisions the enclosed lines are active.  The tuple has the form
 
108
    (instruction, version).
 
109
 
 
110
    The instruction can be '{' or '}' for an insertion block, and '['
 
111
    and ']' for a deletion block respectively.  The version is the
 
112
    integer version index.  There is no replace operator, only deletes
 
113
    and inserts.  For '}', the end of an insertion, there is no
 
114
    version parameter because it always closes the most recently
 
115
    opened insertion.
 
116
 
 
117
    Constraints/notes:
 
118
 
 
119
    * A later version can delete lines that were introduced by any
 
120
      number of ancestor versions; this implies that deletion
 
121
      instructions can span insertion blocks without regard to the
 
122
      insertion block's nesting.
 
123
 
 
124
    * Similarly, deletions need not be properly nested with regard to
 
125
      each other, because they might have been generated by
 
126
      independent revisions.
 
127
 
 
128
    * Insertions are always made by inserting a new bracketed block
 
129
      into a single point in the previous weave.  This implies they
 
130
      can nest but not overlap, and the nesting must always have later
 
131
      insertions on the inside.
 
132
 
 
133
    * It doesn't seem very useful to have an active insertion
 
134
      inside an inactive insertion, but it might happen.
 
135
      
 
136
    * Therefore, all instructions are always"considered"; that
 
137
      is passed onto and off the stack.  An outer inactive block
 
138
      doesn't disable an inner block.
 
139
 
 
140
    * Lines are enabled if the most recent enclosing insertion is
 
141
      active and none of the enclosing deletions are active.
 
142
 
 
143
    * There is no point having a deletion directly inside its own
 
144
      insertion; you might as well just not write it.  And there
 
145
      should be no way to get an earlier version deleting a later
 
146
      version.
 
147
 
 
148
    _weave
 
149
        Text of the weave; list of control instruction tuples and strings.
 
150
 
 
151
    _parents
 
152
        List of parents, indexed by version number.
 
153
        It is only necessary to store the minimal set of parents for
 
154
        each version; the parent's parents are implied.
 
155
 
 
156
    _sha1s
 
157
        List of hex SHA-1 of each version.
 
158
 
 
159
    _names
 
160
        List of symbolic names for each version.  Each should be unique.
 
161
 
 
162
    _name_map
 
163
        For each name, the version number.
 
164
 
 
165
    _weave_name
 
166
        Descriptive name of this weave; typically the filename if known.
 
167
        Set by read_weave.
 
168
    """
 
169
 
 
170
    __slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map',
 
171
                 '_weave_name']
 
172
    
 
173
    def __init__(self, weave_name=None):
 
174
        self._weave = []
 
175
        self._parents = []
 
176
        self._sha1s = []
 
177
        self._names = []
 
178
        self._name_map = {}
 
179
        self._weave_name = weave_name
 
180
 
 
181
    def __repr__(self):
 
182
        return "Weave(%r)" % self._weave_name
 
183
 
 
184
 
 
185
    def copy(self):
 
186
        """Return a deep copy of self.
 
187
        
 
188
        The copy can be modified without affecting the original weave."""
 
189
        other = Weave()
 
190
        other._weave = self._weave[:]
 
191
        other._parents = self._parents[:]
 
192
        other._sha1s = self._sha1s[:]
 
193
        other._names = self._names[:]
 
194
        other._name_map = self._name_map.copy()
 
195
        other._weave_name = self._weave_name
 
196
        return other
 
197
 
 
198
    def __eq__(self, other):
 
199
        if not isinstance(other, Weave):
 
200
            return False
 
201
        return self._parents == other._parents \
 
202
               and self._weave == other._weave \
 
203
               and self._sha1s == other._sha1s 
 
204
 
 
205
    
 
206
    def __ne__(self, other):
 
207
        return not self.__eq__(other)
 
208
 
 
209
    def __contains__(self, name):
 
210
        return self._name_map.has_key(name)
 
211
 
 
212
    def maybe_lookup(self, name_or_index):
 
213
        """Convert possible symbolic name to index, or pass through indexes."""
 
214
        if isinstance(name_or_index, (int, long)):
 
215
            return name_or_index
 
216
        else:
 
217
            return self.lookup(name_or_index)
 
218
 
 
219
        
 
220
    def lookup(self, name):
 
221
        """Convert symbolic version name to index."""
 
222
        try:
 
223
            return self._name_map[name]
 
224
        except KeyError:
 
225
            raise WeaveRevisionNotPresent(name, self)
 
226
 
 
227
    def names(self):
 
228
        return self._names[:]
 
229
 
 
230
    def iter_names(self):
 
231
        """Yield a list of all names in this weave."""
 
232
        return iter(self._names)
 
233
 
 
234
    def idx_to_name(self, version):
 
235
        return self._names[version]
 
236
 
 
237
    def _check_repeated_add(self, name, parents, text, sha1):
 
238
        """Check that a duplicated add is OK.
 
239
 
 
240
        If it is, return the (old) index; otherwise raise an exception.
 
241
        """
 
242
        idx = self.lookup(name)
 
243
        if sorted(self._parents[idx]) != sorted(parents) \
 
244
            or sha1 != self._sha1s[idx]:
 
245
            raise WeaveRevisionAlreadyPresent(name, self)
 
246
        return idx
 
247
        
 
248
    def add(self, name, parents, text, sha1=None):
 
249
        """Add a single text on top of the weave.
 
250
  
 
251
        Returns the index number of the newly added version.
 
252
 
 
253
        name
 
254
            Symbolic name for this version.
 
255
            (Typically the revision-id of the revision that added it.)
 
256
 
 
257
        parents
 
258
            List or set of direct parent version numbers.
 
259
            
 
260
        text
 
261
            Sequence of lines to be added in the new version.
 
262
 
 
263
        sha -- SHA-1 of the file, if known.  This is trusted to be
 
264
            correct if supplied.
 
265
        """
 
266
        from bzrlib.osutils import sha_strings
 
267
 
 
268
        assert isinstance(name, basestring)
 
269
        if sha1 is None:
 
270
            sha1 = sha_strings(text)
 
271
        if name in self._name_map:
 
272
            return self._check_repeated_add(name, parents, text, sha1)
 
273
 
 
274
        parents = map(self.maybe_lookup, parents)
 
275
        self._check_versions(parents)
 
276
        ## self._check_lines(text)
 
277
        new_version = len(self._parents)
 
278
 
 
279
 
 
280
        # if we abort after here the (in-memory) weave will be corrupt because only
 
281
        # some fields are updated
 
282
        # XXX: FIXME implement a succeed-or-fail of the rest of this routine.
 
283
        #      - Robert Collins 20060226
 
284
        self._parents.append(parents[:])
 
285
        self._sha1s.append(sha1)
 
286
        self._names.append(name)
 
287
        self._name_map[name] = new_version
 
288
 
 
289
            
 
290
        if not parents:
 
291
            # special case; adding with no parents revision; can do
 
292
            # this more quickly by just appending unconditionally.
 
293
            # even more specially, if we're adding an empty text we
 
294
            # need do nothing at all.
 
295
            if text:
 
296
                self._weave.append(('{', new_version))
 
297
                self._weave.extend(text)
 
298
                self._weave.append(('}', None))
 
299
        
 
300
            return new_version
 
301
 
 
302
        if len(parents) == 1:
 
303
            pv = list(parents)[0]
 
304
            if sha1 == self._sha1s[pv]:
 
305
                # special case: same as the single parent
 
306
                return new_version
 
307
            
 
308
 
 
309
        ancestors = self.inclusions(parents)
 
310
 
 
311
        l = self._weave
 
312
 
 
313
        # basis a list of (origin, lineno, line)
 
314
        basis_lineno = []
 
315
        basis_lines = []
 
316
        for origin, lineno, line in self._extract(ancestors):
 
317
            basis_lineno.append(lineno)
 
318
            basis_lines.append(line)
 
319
 
 
320
        # another small special case: a merge, producing the same text
 
321
        # as auto-merge
 
322
        if text == basis_lines:
 
323
            return new_version
 
324
 
 
325
        # add a sentinal, because we can also match against the final line
 
326
        basis_lineno.append(len(self._weave))
 
327
 
 
328
        # XXX: which line of the weave should we really consider
 
329
        # matches the end of the file?  the current code says it's the
 
330
        # last line of the weave?
 
331
 
 
332
        #print 'basis_lines:', basis_lines
 
333
        #print 'new_lines:  ', lines
 
334
 
 
335
        s = SequenceMatcher(None, basis_lines, text)
 
336
 
 
337
        # offset gives the number of lines that have been inserted
 
338
        # into the weave up to the current point; if the original edit instruction
 
339
        # says to change line A then we actually change (A+offset)
 
340
        offset = 0
 
341
 
 
342
        for tag, i1, i2, j1, j2 in s.get_opcodes():
 
343
            # i1,i2 are given in offsets within basis_lines; we need to map them
 
344
            # back to offsets within the entire weave
 
345
            #print 'raw match', tag, i1, i2, j1, j2
 
346
            if tag == 'equal':
 
347
                continue
 
348
 
 
349
            i1 = basis_lineno[i1]
 
350
            i2 = basis_lineno[i2]
 
351
 
 
352
            assert 0 <= j1 <= j2 <= len(text)
 
353
 
 
354
            #print tag, i1, i2, j1, j2
 
355
 
 
356
            # the deletion and insertion are handled separately.
 
357
            # first delete the region.
 
358
            if i1 != i2:
 
359
                self._weave.insert(i1+offset, ('[', new_version))
 
360
                self._weave.insert(i2+offset+1, (']', new_version))
 
361
                offset += 2
 
362
 
 
363
            if j1 != j2:
 
364
                # there may have been a deletion spanning up to
 
365
                # i2; we want to insert after this region to make sure
 
366
                # we don't destroy ourselves
 
367
                i = i2 + offset
 
368
                self._weave[i:i] = ([('{', new_version)] 
 
369
                                    + text[j1:j2] 
 
370
                                    + [('}', None)])
 
371
                offset += 2 + (j2 - j1)
 
372
 
 
373
        return new_version
 
374
 
 
375
    def add_identical(self, old_rev_id, new_rev_id, parents):
 
376
        """Add an identical text to old_rev_id as new_rev_id."""
 
377
        old_lines = self.get(self.lookup(old_rev_id))
 
378
        self.add(new_rev_id, parents, old_lines)
 
379
 
 
380
    def inclusions(self, versions):
 
381
        """Return set of all ancestors of given version(s)."""
 
382
        i = set(versions)
 
383
        for v in xrange(max(versions), 0, -1):
 
384
            if v in i:
 
385
                # include all its parents
 
386
                i.update(self._parents[v])
 
387
        return i
 
388
        ## except IndexError:
 
389
        ##     raise ValueError("version %d not present in weave" % v)
 
390
 
 
391
 
 
392
    def parents(self, version):
 
393
        return self._parents[version]
 
394
 
 
395
 
 
396
    def parent_names(self, version):
 
397
        """Return version names for parents of a version."""
 
398
        return map(self.idx_to_name, self._parents[self.lookup(version)])
 
399
 
 
400
 
 
401
    def minimal_parents(self, version):
 
402
        """Find the minimal set of parents for the version."""
 
403
        included = self._parents[version]
 
404
        if not included:
 
405
            return []
 
406
        
 
407
        li = list(included)
 
408
        li.sort(reverse=True)
 
409
 
 
410
        mininc = []
 
411
        gotit = set()
 
412
 
 
413
        for pv in li:
 
414
            if pv not in gotit:
 
415
                mininc.append(pv)
 
416
                gotit.update(self.inclusions(pv))
 
417
 
 
418
        assert mininc[0] >= 0
 
419
        assert mininc[-1] < version
 
420
        return mininc
 
421
 
 
422
 
 
423
 
 
424
    def _check_lines(self, text):
 
425
        if not isinstance(text, list):
 
426
            raise ValueError("text should be a list, not %s" % type(text))
 
427
 
 
428
        for l in text:
 
429
            if not isinstance(l, basestring):
 
430
                raise ValueError("text line should be a string or unicode, not %s"
 
431
                                 % type(l))
 
432
        
 
433
 
 
434
 
 
435
    def _check_versions(self, indexes):
 
436
        """Check everything in the sequence of indexes is valid"""
 
437
        for i in indexes:
 
438
            try:
 
439
                self._parents[i]
 
440
            except IndexError:
 
441
                raise IndexError("invalid version number %r" % i)
 
442
 
 
443
    
 
444
    def annotate(self, name_or_index):
 
445
        return list(self.annotate_iter(name_or_index))
 
446
 
 
447
 
 
448
    def annotate_iter(self, name_or_index):
 
449
        """Yield list of (index-id, line) pairs for the specified version.
 
450
 
 
451
        The index indicates when the line originated in the weave."""
 
452
        incls = [self.maybe_lookup(name_or_index)]
 
453
        for origin, lineno, text in self._extract(incls):
 
454
            yield origin, text
 
455
 
 
456
    def _walk(self):
 
457
        """Walk the weave.
 
458
 
 
459
        Yields sequence of
 
460
        (lineno, insert, deletes, text)
 
461
        for each literal line.
 
462
        """
 
463
        
 
464
        istack = []
 
465
        dset = set()
 
466
 
 
467
        lineno = 0         # line of weave, 0-based
 
468
 
 
469
        for l in self._weave:
 
470
            if isinstance(l, tuple):
 
471
                c, v = l
 
472
                isactive = None
 
473
                if c == '{':
 
474
                    istack.append(v)
 
475
                elif c == '}':
 
476
                    istack.pop()
 
477
                elif c == '[':
 
478
                    assert v not in dset
 
479
                    dset.add(v)
 
480
                elif c == ']':
 
481
                    dset.remove(v)
 
482
                else:
 
483
                    raise WeaveFormatError('unexpected instruction %r' % v)
 
484
            else:
 
485
                assert isinstance(l, basestring)
 
486
                assert istack
 
487
                yield lineno, istack[-1], dset, l
 
488
            lineno += 1
 
489
 
 
490
        if istack:
 
491
            raise WeaveFormatError("unclosed insertion blocks "
 
492
                    "at end of weave: %s" % istack)
 
493
        if dset:
 
494
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
 
495
                                   % dset)
 
496
 
 
497
    def _extract(self, versions):
 
498
        """Yield annotation of lines in included set.
 
499
 
 
500
        Yields a sequence of tuples (origin, lineno, text), where
 
501
        origin is the origin version, lineno the index in the weave,
 
502
        and text the text of the line.
 
503
 
 
504
        The set typically but not necessarily corresponds to a version.
 
505
        """
 
506
        for i in versions:
 
507
            if not isinstance(i, int):
 
508
                raise ValueError(i)
 
509
            
 
510
        included = self.inclusions(versions)
 
511
 
 
512
        istack = []
 
513
        dset = set()
 
514
 
 
515
        lineno = 0         # line of weave, 0-based
 
516
 
 
517
        isactive = None
 
518
 
 
519
        result = []
 
520
 
 
521
        WFE = WeaveFormatError
 
522
 
 
523
        for l in self._weave:
 
524
            if isinstance(l, tuple):
 
525
                c, v = l
 
526
                isactive = None
 
527
                if c == '{':
 
528
                    assert v not in istack
 
529
                    istack.append(v)
 
530
                elif c == '}':
 
531
                    istack.pop()
 
532
                elif c == '[':
 
533
                    if v in included:
 
534
                        assert v not in dset
 
535
                        dset.add(v)
 
536
                else:
 
537
                    assert c == ']'
 
538
                    if v in included:
 
539
                        assert v in dset
 
540
                        dset.remove(v)
 
541
            else:
 
542
                assert isinstance(l, basestring)
 
543
                if isactive is None:
 
544
                    isactive = (not dset) and istack and (istack[-1] in included)
 
545
                if isactive:
 
546
                    result.append((istack[-1], lineno, l))
 
547
            lineno += 1
 
548
        if istack:
 
549
            raise WeaveFormatError("unclosed insertion blocks "
 
550
                    "at end of weave: %s" % istack)
 
551
        if dset:
 
552
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
 
553
                                   % dset)
 
554
        return result
 
555
 
 
556
 
 
557
    def get_iter(self, name_or_index):
 
558
        """Yield lines for the specified version."""
 
559
        incls = [self.maybe_lookup(name_or_index)]
 
560
        if len(incls) == 1:
 
561
            index = incls[0]
 
562
            cur_sha = sha.new()
 
563
        else:
 
564
            # We don't have sha1 sums for multiple entries
 
565
            cur_sha = None
 
566
        for origin, lineno, line in self._extract(incls):
 
567
            if cur_sha:
 
568
                cur_sha.update(line)
 
569
            yield line
 
570
        if cur_sha:
 
571
            expected_sha1 = self._sha1s[index]
 
572
            measured_sha1 = cur_sha.hexdigest() 
 
573
            if measured_sha1 != expected_sha1:
 
574
                raise errors.WeaveInvalidChecksum(
 
575
                        'file %s, revision %s, expected: %s, measured %s' 
 
576
                        % (self._weave_name, self._names[index],
 
577
                           expected_sha1, measured_sha1))
 
578
 
 
579
 
 
580
    def get_text(self, name_or_index):
 
581
        return ''.join(self.get_iter(name_or_index))
 
582
        assert isinstance(version, int)
 
583
 
 
584
 
 
585
    def get_lines(self, name_or_index):
 
586
        return list(self.get_iter(name_or_index))
 
587
 
 
588
 
 
589
    get = get_lines
 
590
 
 
591
 
 
592
    def get_sha1(self, name):
 
593
        """Get the stored sha1 sum for the given revision.
 
594
        
 
595
        :param name: The name of the version to lookup
 
596
        """
 
597
        return self._sha1s[self.lookup(name)]
 
598
 
 
599
    def mash_iter(self, included):
 
600
        """Return composed version of multiple included versions."""
 
601
        included = map(self.maybe_lookup, included)
 
602
        for origin, lineno, text in self._extract(included):
 
603
            yield text
 
604
 
 
605
 
 
606
    def dump(self, to_file):
 
607
        from pprint import pprint
 
608
        print >>to_file, "Weave._weave = ",
 
609
        pprint(self._weave, to_file)
 
610
        print >>to_file, "Weave._parents = ",
 
611
        pprint(self._parents, to_file)
 
612
 
 
613
 
 
614
 
 
615
    def numversions(self):
 
616
        l = len(self._parents)
 
617
        assert l == len(self._sha1s)
 
618
        return l
 
619
 
 
620
 
 
621
    def __len__(self):
 
622
        return self.numversions()
 
623
 
 
624
    def check(self, progress_bar=None):
 
625
        # check no circular inclusions
 
626
        for version in range(self.numversions()):
 
627
            inclusions = list(self._parents[version])
 
628
            if inclusions:
 
629
                inclusions.sort()
 
630
                if inclusions[-1] >= version:
 
631
                    raise WeaveFormatError("invalid included version %d for index %d"
 
632
                                           % (inclusions[-1], version))
 
633
 
 
634
        # try extracting all versions; parallel extraction is used
 
635
        nv = self.numversions()
 
636
        sha1s = [sha.new() for i in range(nv)]
 
637
        texts = [[] for i in range(nv)]
 
638
        inclusions = []
 
639
        for i in range(nv):
 
640
            # For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
 
641
            # The problem is that set membership is much more expensive
 
642
            new_inc = set([i])
 
643
            for p in self._parents[i]:
 
644
                new_inc.update(inclusions[p])
 
645
 
 
646
            #assert set(new_inc) == self.inclusions([i]), 'failed %s != %s' % (new_inc, self.inclusions([i]))
 
647
            inclusions.append(new_inc)
 
648
 
 
649
        nlines = len(self._weave)
 
650
 
 
651
        update_text = 'checking weave'
 
652
        if self._weave_name:
 
653
            short_name = os.path.basename(self._weave_name)
 
654
            update_text = 'checking %s' % (short_name,)
 
655
            update_text = update_text[:25]
 
656
 
 
657
        for lineno, insert, deleteset, line in self._walk():
 
658
            if progress_bar:
 
659
                progress_bar.update(update_text, lineno, nlines)
 
660
 
 
661
            for j, j_inc in enumerate(inclusions):
 
662
                # The active inclusion must be an ancestor,
 
663
                # and no ancestors must have deleted this line,
 
664
                # because we don't support resurrection.
 
665
                if (insert in j_inc) and not (deleteset & j_inc):
 
666
                    sha1s[j].update(line)
 
667
 
 
668
        for version in range(nv):
 
669
            hd = sha1s[version].hexdigest()
 
670
            expected = self._sha1s[version]
 
671
            if hd != expected:
 
672
                raise errors.WeaveInvalidChecksum(
 
673
                        "mismatched sha1 for version %s: "
 
674
                        "got %s, expected %s"
 
675
                        % (self._names[version], hd, expected))
 
676
 
 
677
        # TODO: check insertions are properly nested, that there are
 
678
        # no lines outside of insertion blocks, that deletions are
 
679
        # properly paired, etc.
 
680
 
 
681
    def _delta(self, included, lines):
 
682
        """Return changes from basis to new revision.
 
683
 
 
684
        The old text for comparison is the union of included revisions.
 
685
 
 
686
        This is used in inserting a new text.
 
687
 
 
688
        Delta is returned as a sequence of
 
689
        (weave1, weave2, newlines).
 
690
 
 
691
        This indicates that weave1:weave2 of the old weave should be
 
692
        replaced by the sequence of lines in newlines.  Note that
 
693
        these line numbers are positions in the total weave and don't
 
694
        correspond to the lines in any extracted version, or even the
 
695
        extracted union of included versions.
 
696
 
 
697
        If line1=line2, this is a pure insert; if newlines=[] this is a
 
698
        pure delete.  (Similar to difflib.)
 
699
        """
 
700
        raise NotImplementedError()
 
701
 
 
702
            
 
703
    def plan_merge(self, ver_a, ver_b):
 
704
        """Return pseudo-annotation indicating how the two versions merge.
 
705
 
 
706
        This is computed between versions a and b and their common
 
707
        base.
 
708
 
 
709
        Weave lines present in none of them are skipped entirely.
 
710
        """
 
711
        inc_a = self.inclusions([ver_a])
 
712
        inc_b = self.inclusions([ver_b])
 
713
        inc_c = inc_a & inc_b
 
714
 
 
715
        for lineno, insert, deleteset, line in self._walk():
 
716
            if deleteset & inc_c:
 
717
                # killed in parent; can't be in either a or b
 
718
                # not relevant to our work
 
719
                yield 'killed-base', line
 
720
            elif insert in inc_c:
 
721
                # was inserted in base
 
722
                killed_a = bool(deleteset & inc_a)
 
723
                killed_b = bool(deleteset & inc_b)
 
724
                if killed_a and killed_b:
 
725
                    yield 'killed-both', line
 
726
                elif killed_a:
 
727
                    yield 'killed-a', line
 
728
                elif killed_b:
 
729
                    yield 'killed-b', line
 
730
                else:
 
731
                    yield 'unchanged', line
 
732
            elif insert in inc_a:
 
733
                if deleteset & inc_a:
 
734
                    yield 'ghost-a', line
 
735
                else:
 
736
                    # new in A; not in B
 
737
                    yield 'new-a', line
 
738
            elif insert in inc_b:
 
739
                if deleteset & inc_b:
 
740
                    yield 'ghost-b', line
 
741
                else:
 
742
                    yield 'new-b', line
 
743
            else:
 
744
                # not in either revision
 
745
                yield 'irrelevant', line
 
746
 
 
747
        yield 'unchanged', ''           # terminator
 
748
 
 
749
 
 
750
 
 
751
    def weave_merge(self, plan, a_marker='<<<<<<< \n', b_marker='>>>>>>> \n'):
 
752
        lines_a = []
 
753
        lines_b = []
 
754
        ch_a = ch_b = False
 
755
        # TODO: Return a structured form of the conflicts (e.g. 2-tuples for
 
756
        # conflicted regions), rather than just inserting the markers.
 
757
        # 
 
758
        # TODO: Show some version information (e.g. author, date) on 
 
759
        # conflicted regions.
 
760
        for state, line in plan:
 
761
            if state == 'unchanged' or state == 'killed-both':
 
762
                # resync and flush queued conflicts changes if any
 
763
                if not lines_a and not lines_b:
 
764
                    pass
 
765
                elif ch_a and not ch_b:
 
766
                    # one-sided change:                    
 
767
                    for l in lines_a: yield l
 
768
                elif ch_b and not ch_a:
 
769
                    for l in lines_b: yield l
 
770
                elif lines_a == lines_b:
 
771
                    for l in lines_a: yield l
 
772
                else:
 
773
                    yield a_marker
 
774
                    for l in lines_a: yield l
 
775
                    yield '=======\n'
 
776
                    for l in lines_b: yield l
 
777
                    yield b_marker
 
778
 
 
779
                del lines_a[:]
 
780
                del lines_b[:]
 
781
                ch_a = ch_b = False
 
782
                
 
783
            if state == 'unchanged':
 
784
                if line:
 
785
                    yield line
 
786
            elif state == 'killed-a':
 
787
                ch_a = True
 
788
                lines_b.append(line)
 
789
            elif state == 'killed-b':
 
790
                ch_b = True
 
791
                lines_a.append(line)
 
792
            elif state == 'new-a':
 
793
                ch_a = True
 
794
                lines_a.append(line)
 
795
            elif state == 'new-b':
 
796
                ch_b = True
 
797
                lines_b.append(line)
 
798
            else:
 
799
                assert state in ('irrelevant', 'ghost-a', 'ghost-b', 'killed-base',
 
800
                                 'killed-both'), \
 
801
                       state
 
802
 
 
803
 
 
804
    def join(self, other, pb=None, msg=None):
 
805
        import sys, time
 
806
        """Integrate versions from other into this weave.
 
807
 
 
808
        The resulting weave contains all the history of both weaves; 
 
809
        any version you could retrieve from either self or other can be 
 
810
        retrieved from self after this call.
 
811
 
 
812
        It is illegal for the two weaves to contain different values 
 
813
        or different parents for any version.  See also reweave().
 
814
 
 
815
        :param other: The other weave to pull into this one
 
816
        :param pb: An optional progress bar
 
817
        :param msg: An optional message to display for progress
 
818
        """
 
819
        if other.numversions() == 0:
 
820
            return          # nothing to update, easy
 
821
        # two loops so that we do not change ourselves before verifying it
 
822
        # will be ok
 
823
        # work through in index order to make sure we get all dependencies
 
824
        names_to_join = []
 
825
        processed = 0
 
826
        for other_idx, name in enumerate(other._names):
 
827
            self._check_version_consistent(other, other_idx, name)
 
828
            sha1 = other._sha1s[other_idx]
 
829
 
 
830
            processed += 1
 
831
 
 
832
            if name in self._name_map:
 
833
                idx = self.lookup(name)
 
834
                n1 = set(map(other.idx_to_name, other._parents[other_idx]))
 
835
                n2 = set(map(self.idx_to_name, self._parents[idx]))
 
836
                if sha1 ==  self._sha1s[idx] and n1 == n2:
 
837
                        continue
 
838
 
 
839
            names_to_join.append((other_idx, name))
 
840
 
 
841
        if pb and not msg:
 
842
            msg = 'weave join'
 
843
 
 
844
        merged = 0
 
845
        time0 = time.time( )
 
846
        for other_idx, name in names_to_join:
 
847
            # TODO: If all the parents of the other version are already
 
848
            # present then we can avoid some work by just taking the delta
 
849
            # and adjusting the offsets.
 
850
            new_parents = self._imported_parents(other, other_idx)
 
851
            sha1 = other._sha1s[other_idx]
 
852
 
 
853
            merged += 1
 
854
 
 
855
            if pb:
 
856
                pb.update(msg, merged, len(names_to_join))
 
857
           
 
858
            lines = other.get_lines(other_idx)
 
859
            self.add(name, new_parents, lines, sha1)
 
860
 
 
861
        mutter("merged = %d, processed = %d, file_id=%s; deltat=%d"%(
 
862
                merged, processed, self._weave_name, time.time( )-time0))
 
863
 
 
864
    def _imported_parents(self, other, other_idx):
 
865
        """Return list of parents in self corresponding to indexes in other."""
 
866
        new_parents = []
 
867
        for parent_idx in other._parents[other_idx]:
 
868
            parent_name = other._names[parent_idx]
 
869
            if parent_name not in self._names:
 
870
                # should not be possible
 
871
                raise WeaveError("missing parent {%s} of {%s} in %r" 
 
872
                                 % (parent_name, other._name_map[other_idx], self))
 
873
            new_parents.append(self._name_map[parent_name])
 
874
        return new_parents
 
875
 
 
876
    def _check_version_consistent(self, other, other_idx, name):
 
877
        """Check if a version in consistent in this and other.
 
878
 
 
879
        To be consistent it must have:
 
880
 
 
881
         * the same text
 
882
         * the same direct parents (by name, not index, and disregarding
 
883
           order)
 
884
        
 
885
        If present & correct return True;
 
886
        if not present in self return False; 
 
887
        if inconsistent raise error."""
 
888
        this_idx = self._name_map.get(name, -1)
 
889
        if this_idx != -1:
 
890
            if self._sha1s[this_idx] != other._sha1s[other_idx]:
 
891
                raise WeaveError("inconsistent texts for version {%s} "
 
892
                                 "when joining weaves"
 
893
                                 % (name))
 
894
            self_parents = self._parents[this_idx]
 
895
            other_parents = other._parents[other_idx]
 
896
            n1 = set([self._names[i] for i in self_parents])
 
897
            n2 = set([other._names[i] for i in other_parents])
 
898
            if n1 != n2:
 
899
                raise WeaveParentMismatch("inconsistent parents "
 
900
                    "for version {%s}: %s vs %s" % (name, n1, n2))
 
901
            else:
 
902
                return True         # ok!
 
903
        else:
 
904
            return False
 
905
 
 
906
    def reweave(self, other, pb=None, msg=None):
 
907
        """Reweave self with other.
 
908
 
 
909
        :param other: The other weave to merge
 
910
        :param pb: An optional progress bar, indicating how far done we are
 
911
        :param msg: An optional message for the progress
 
912
        """
 
913
        new_weave = reweave(self, other, pb=pb, msg=msg)
 
914
        for attr in self.__slots__:
 
915
            setattr(self, attr, getattr(new_weave, attr))
 
916
 
 
917
 
 
918
def reweave(wa, wb, pb=None, msg=None):
 
919
    """Combine two weaves and return the result.
 
920
 
 
921
    This works even if a revision R has different parents in 
 
922
    wa and wb.  In the resulting weave all the parents are given.
 
923
 
 
924
    This is done by just building up a new weave, maintaining ordering 
 
925
    of the versions in the two inputs.  More efficient approaches
 
926
    might be possible but it should only be necessary to do 
 
927
    this operation rarely, when a new previously ghost version is 
 
928
    inserted.
 
929
 
 
930
    :param pb: An optional progress bar, indicating how far done we are
 
931
    :param msg: An optional message for the progress
 
932
    """
 
933
    wr = Weave()
 
934
    ia = ib = 0
 
935
    queue_a = range(wa.numversions())
 
936
    queue_b = range(wb.numversions())
 
937
    # first determine combined parents of all versions
 
938
    # map from version name -> all parent names
 
939
    combined_parents = _reweave_parent_graphs(wa, wb)
 
940
    mutter("combined parents: %r", combined_parents)
 
941
    order = topo_sort(combined_parents.iteritems())
 
942
    mutter("order to reweave: %r", order)
 
943
 
 
944
    if pb and not msg:
 
945
        msg = 'reweave'
 
946
 
 
947
    for idx, name in enumerate(order):
 
948
        if pb:
 
949
            pb.update(msg, idx, len(order))
 
950
        if name in wa._name_map:
 
951
            lines = wa.get_lines(name)
 
952
            if name in wb._name_map:
 
953
                lines_b = wb.get_lines(name)
 
954
                if lines != lines_b:
 
955
                    mutter('Weaves differ on content. rev_id {%s}', name)
 
956
                    mutter('weaves: %s, %s', wa._weave_name, wb._weave_name)
 
957
                    import difflib
 
958
                    lines = list(difflib.unified_diff(lines, lines_b,
 
959
                            wa._weave_name, wb._weave_name))
 
960
                    mutter('lines:\n%s', ''.join(lines))
 
961
                    raise errors.WeaveTextDiffers(name, wa, wb)
 
962
        else:
 
963
            lines = wb.get_lines(name)
 
964
        wr.add(name, combined_parents[name], lines)
 
965
    return wr
 
966
 
 
967
 
 
968
def _reweave_parent_graphs(wa, wb):
 
969
    """Return combined parent ancestry for two weaves.
 
970
    
 
971
    Returned as a list of (version_name, set(parent_names))"""
 
972
    combined = {}
 
973
    for weave in [wa, wb]:
 
974
        for idx, name in enumerate(weave._names):
 
975
            p = combined.setdefault(name, set())
 
976
            p.update(map(weave.idx_to_name, weave._parents[idx]))
 
977
    return combined
 
978
 
 
979
 
 
980
def weave_toc(w):
 
981
    """Show the weave's table-of-contents"""
 
982
    print '%6s %50s %10s %10s' % ('ver', 'name', 'sha1', 'parents')
 
983
    for i in (6, 50, 10, 10):
 
984
        print '-' * i,
 
985
    print
 
986
    for i in range(w.numversions()):
 
987
        sha1 = w._sha1s[i]
 
988
        name = w._names[i]
 
989
        parent_str = ' '.join(map(str, w._parents[i]))
 
990
        print '%6d %-50.50s %10.10s %s' % (i, name, sha1, parent_str)
 
991
 
 
992
 
 
993
 
 
994
def weave_stats(weave_file, pb):
 
995
    from bzrlib.weavefile import read_weave
 
996
 
 
997
    wf = file(weave_file, 'rb')
 
998
    w = read_weave(wf)
 
999
    # FIXME: doesn't work on pipes
 
1000
    weave_size = wf.tell()
 
1001
 
 
1002
    total = 0
 
1003
    vers = len(w)
 
1004
    for i in range(vers):
 
1005
        pb.update('checking sizes', i, vers)
 
1006
        for origin, lineno, line in w._extract([i]):
 
1007
            total += len(line)
 
1008
 
 
1009
    pb.clear()
 
1010
 
 
1011
    print 'versions          %9d' % vers
 
1012
    print 'weave file        %9d bytes' % weave_size
 
1013
    print 'total contents    %9d bytes' % total
 
1014
    print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
 
1015
    if vers:
 
1016
        avg = total/vers
 
1017
        print 'average size      %9d bytes' % avg
 
1018
        print 'relative size     %9.2fx' % (float(weave_size) / float(avg))
 
1019
 
 
1020
 
 
1021
def usage():
 
1022
    print """bzr weave tool
 
1023
 
 
1024
Experimental tool for weave algorithm.
 
1025
 
 
1026
usage:
 
1027
    weave init WEAVEFILE
 
1028
        Create an empty weave file
 
1029
    weave get WEAVEFILE VERSION
 
1030
        Write out specified version.
 
1031
    weave check WEAVEFILE
 
1032
        Check consistency of all versions.
 
1033
    weave toc WEAVEFILE
 
1034
        Display table of contents.
 
1035
    weave add WEAVEFILE NAME [BASE...] < NEWTEXT
 
1036
        Add NEWTEXT, with specified parent versions.
 
1037
    weave annotate WEAVEFILE VERSION
 
1038
        Display origin of each line.
 
1039
    weave mash WEAVEFILE VERSION...
 
1040
        Display composite of all selected versions.
 
1041
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
 
1042
        Auto-merge two versions and display conflicts.
 
1043
    weave diff WEAVEFILE VERSION1 VERSION2 
 
1044
        Show differences between two versions.
 
1045
 
 
1046
example:
 
1047
 
 
1048
    % weave init foo.weave
 
1049
    % vi foo.txt
 
1050
    % weave add foo.weave ver0 < foo.txt
 
1051
    added version 0
 
1052
 
 
1053
    (create updated version)
 
1054
    % vi foo.txt
 
1055
    % weave get foo.weave 0 | diff -u - foo.txt
 
1056
    % weave add foo.weave ver1 0 < foo.txt
 
1057
    added version 1
 
1058
 
 
1059
    % weave get foo.weave 0 > foo.txt       (create forked version)
 
1060
    % vi foo.txt
 
1061
    % weave add foo.weave ver2 0 < foo.txt
 
1062
    added version 2
 
1063
 
 
1064
    % weave merge foo.weave 1 2 > foo.txt   (merge them)
 
1065
    % vi foo.txt                            (resolve conflicts)
 
1066
    % weave add foo.weave merged 1 2 < foo.txt     (commit merged version)     
 
1067
    
 
1068
"""
 
1069
    
 
1070
 
 
1071
 
 
1072
def main(argv):
 
1073
    import sys
 
1074
    import os
 
1075
    try:
 
1076
        import bzrlib
 
1077
    except ImportError:
 
1078
        # in case we're run directly from the subdirectory
 
1079
        sys.path.append('..')
 
1080
        import bzrlib
 
1081
    from bzrlib.weavefile import write_weave, read_weave
 
1082
    from bzrlib.progress import ProgressBar
 
1083
 
 
1084
    try:
 
1085
        import psyco
 
1086
        psyco.full()
 
1087
    except ImportError:
 
1088
        pass
 
1089
 
 
1090
    if len(argv) < 2:
 
1091
        usage()
 
1092
        return 0
 
1093
 
 
1094
    cmd = argv[1]
 
1095
 
 
1096
    def readit():
 
1097
        return read_weave(file(argv[2], 'rb'))
 
1098
    
 
1099
    if cmd == 'help':
 
1100
        usage()
 
1101
    elif cmd == 'add':
 
1102
        w = readit()
 
1103
        # at the moment, based on everything in the file
 
1104
        name = argv[3]
 
1105
        parents = map(int, argv[4:])
 
1106
        lines = sys.stdin.readlines()
 
1107
        ver = w.add(name, parents, lines)
 
1108
        write_weave(w, file(argv[2], 'wb'))
 
1109
        print 'added version %r %d' % (name, ver)
 
1110
    elif cmd == 'init':
 
1111
        fn = argv[2]
 
1112
        if os.path.exists(fn):
 
1113
            raise IOError("file exists")
 
1114
        w = Weave()
 
1115
        write_weave(w, file(fn, 'wb'))
 
1116
    elif cmd == 'get': # get one version
 
1117
        w = readit()
 
1118
        sys.stdout.writelines(w.get_iter(int(argv[3])))
 
1119
        
 
1120
    elif cmd == 'mash': # get composite
 
1121
        w = readit()
 
1122
        sys.stdout.writelines(w.mash_iter(map(int, argv[3:])))
 
1123
 
 
1124
    elif cmd == 'diff':
 
1125
        from difflib import unified_diff
 
1126
        w = readit()
 
1127
        fn = argv[2]
 
1128
        v1, v2 = map(int, argv[3:5])
 
1129
        lines1 = w.get(v1)
 
1130
        lines2 = w.get(v2)
 
1131
        diff_gen = unified_diff(lines1, lines2,
 
1132
                                '%s version %d' % (fn, v1),
 
1133
                                '%s version %d' % (fn, v2))
 
1134
        sys.stdout.writelines(diff_gen)
 
1135
            
 
1136
    elif cmd == 'annotate':
 
1137
        w = readit()
 
1138
        # newline is added to all lines regardless; too hard to get
 
1139
        # reasonable formatting otherwise
 
1140
        lasto = None
 
1141
        for origin, text in w.annotate(int(argv[3])):
 
1142
            text = text.rstrip('\r\n')
 
1143
            if origin == lasto:
 
1144
                print '      | %s' % (text)
 
1145
            else:
 
1146
                print '%5d | %s' % (origin, text)
 
1147
                lasto = origin
 
1148
                
 
1149
    elif cmd == 'toc':
 
1150
        weave_toc(readit())
 
1151
 
 
1152
    elif cmd == 'stats':
 
1153
        weave_stats(argv[2], ProgressBar())
 
1154
        
 
1155
    elif cmd == 'check':
 
1156
        w = readit()
 
1157
        pb = ProgressBar()
 
1158
        w.check(pb)
 
1159
        pb.clear()
 
1160
        print '%d versions ok' % w.numversions()
 
1161
 
 
1162
    elif cmd == 'inclusions':
 
1163
        w = readit()
 
1164
        print ' '.join(map(str, w.inclusions([int(argv[3])])))
 
1165
 
 
1166
    elif cmd == 'parents':
 
1167
        w = readit()
 
1168
        print ' '.join(map(str, w._parents[int(argv[3])]))
 
1169
 
 
1170
    elif cmd == 'plan-merge':
 
1171
        w = readit()
 
1172
        for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
 
1173
            if line:
 
1174
                print '%14s | %s' % (state, line),
 
1175
 
 
1176
    elif cmd == 'merge':
 
1177
        w = readit()
 
1178
        p = w.plan_merge(int(argv[3]), int(argv[4]))
 
1179
        sys.stdout.writelines(w.weave_merge(p))
 
1180
            
 
1181
    elif cmd == 'mash-merge':
 
1182
        if len(argv) != 5:
 
1183
            usage()
 
1184
            return 1
 
1185
 
 
1186
        w = readit()
 
1187
        v1, v2 = map(int, argv[3:5])
 
1188
 
 
1189
        basis = w.inclusions([v1]).intersection(w.inclusions([v2]))
 
1190
 
 
1191
        base_lines = list(w.mash_iter(basis))
 
1192
        a_lines = list(w.get(v1))
 
1193
        b_lines = list(w.get(v2))
 
1194
 
 
1195
        from bzrlib.merge3 import Merge3
 
1196
        m3 = Merge3(base_lines, a_lines, b_lines)
 
1197
 
 
1198
        name_a = 'version %d' % v1
 
1199
        name_b = 'version %d' % v2
 
1200
        sys.stdout.writelines(m3.merge_lines(name_a=name_a, name_b=name_b))
 
1201
    else:
 
1202
        raise ValueError('unknown command %r' % cmd)
 
1203
    
 
1204
 
 
1205
 
 
1206
def profile_main(argv): 
 
1207
    import tempfile, hotshot, hotshot.stats
 
1208
 
 
1209
    prof_f = tempfile.NamedTemporaryFile()
 
1210
 
 
1211
    prof = hotshot.Profile(prof_f.name)
 
1212
 
 
1213
    ret = prof.runcall(main, argv)
 
1214
    prof.close()
 
1215
 
 
1216
    stats = hotshot.stats.load(prof_f.name)
 
1217
    #stats.strip_dirs()
 
1218
    stats.sort_stats('cumulative')
 
1219
    ## XXX: Might like to write to stderr or the trace file instead but
 
1220
    ## print_stats seems hardcoded to stdout
 
1221
    stats.print_stats(20)
 
1222
            
 
1223
    return ret
 
1224
 
 
1225
 
 
1226
def lsprofile_main(argv): 
 
1227
    from bzrlib.lsprof import profile
 
1228
    ret,stats = profile(main, argv)
 
1229
    stats.sort()
 
1230
    stats.pprint()
 
1231
    return ret
 
1232
 
 
1233
 
 
1234
if __name__ == '__main__':
 
1235
    import sys
 
1236
    if '--profile' in sys.argv:
 
1237
        args = sys.argv[:]
 
1238
        args.remove('--profile')
 
1239
        sys.exit(profile_main(args))
 
1240
    elif '--lsprof' in sys.argv:
 
1241
        args = sys.argv[:]
 
1242
        args.remove('--lsprof')
 
1243
        sys.exit(lsprofile_main(args))
 
1244
    else:
 
1245
        sys.exit(main(sys.argv))
 
1246