~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

Fixed as per Ian's review.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2009 Canonical Ltd
 
1
#! /usr/bin/python
 
2
 
 
3
# Copyright (C) 2005 Canonical Ltd
2
4
#
3
5
# This program is free software; you can redistribute it and/or modify
4
6
# it under the terms of the GNU General Public License as published by
12
14
#
13
15
# You should have received a copy of the GNU General Public License
14
16
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
18
 
17
19
# Author: Martin Pool <mbp@canonical.com>
18
20
 
 
21
 
19
22
"""Weave - storage of related text file versions"""
20
23
 
21
 
from __future__ import absolute_import
22
24
 
23
25
# XXX: If we do weaves this way, will a merge still behave the same
24
26
# way if it's done in a different order?  That's a pretty desirable
59
61
# where the basis and destination are unchanged.
60
62
 
61
63
# FIXME: Sometimes we will be given a parents list for a revision
62
 
# that includes some redundant parents (i.e. already a parent of
63
 
# something in the list.)  We should eliminate them.  This can
 
64
# that includes some redundant parents (i.e. already a parent of 
 
65
# something in the list.)  We should eliminate them.  This can 
64
66
# be done fairly efficiently because the sequence numbers constrain
65
67
# the possible relationships.
66
68
 
69
71
from copy import copy
70
72
from cStringIO import StringIO
71
73
import os
 
74
import sha
 
75
import time
 
76
import warnings
72
77
 
73
 
from bzrlib.lazy_import import lazy_import
74
 
lazy_import(globals(), """
75
 
from bzrlib import tsort
76
 
""")
77
78
from bzrlib import (
78
 
    errors,
79
 
    osutils,
 
79
    progress,
80
80
    )
 
81
from bzrlib.trace import mutter
81
82
from bzrlib.errors import (WeaveError, WeaveFormatError, WeaveParentMismatch,
82
83
        RevisionAlreadyPresent,
83
84
        RevisionNotPresent,
84
 
        UnavailableRepresentation,
 
85
        WeaveRevisionAlreadyPresent,
 
86
        WeaveRevisionNotPresent,
85
87
        )
86
 
from bzrlib.osutils import dirname, sha, sha_strings, split_lines
 
88
import bzrlib.errors as errors
 
89
from bzrlib.osutils import sha_strings
87
90
import bzrlib.patiencediff
88
 
from bzrlib.revision import NULL_REVISION
89
 
from bzrlib.symbol_versioning import *
90
 
from bzrlib.trace import mutter
91
 
from bzrlib.versionedfile import (
92
 
    AbsentContentFactory,
93
 
    adapter_registry,
94
 
    ContentFactory,
95
 
    sort_groupcompress,
96
 
    VersionedFile,
97
 
    )
 
91
from bzrlib.tsort import topo_sort
 
92
from bzrlib.versionedfile import VersionedFile, InterVersionedFile
98
93
from bzrlib.weavefile import _read_weave_v5, write_weave_v5
99
94
 
100
95
 
101
 
class WeaveContentFactory(ContentFactory):
102
 
    """Content factory for streaming from weaves.
103
 
 
104
 
    :seealso ContentFactory:
105
 
    """
106
 
 
107
 
    def __init__(self, version, weave):
108
 
        """Create a WeaveContentFactory for version from weave."""
109
 
        ContentFactory.__init__(self)
110
 
        self.sha1 = weave.get_sha1s([version])[version]
111
 
        self.key = (version,)
112
 
        parents = weave.get_parent_map([version])[version]
113
 
        self.parents = tuple((parent,) for parent in parents)
114
 
        self.storage_kind = 'fulltext'
115
 
        self._weave = weave
116
 
 
117
 
    def get_bytes_as(self, storage_kind):
118
 
        if storage_kind == 'fulltext':
119
 
            return self._weave.get_text(self.key[-1])
120
 
        elif storage_kind == 'chunked':
121
 
            return self._weave.get_lines(self.key[-1])
122
 
        else:
123
 
            raise UnavailableRepresentation(self.key, storage_kind, 'fulltext')
124
 
 
125
 
 
126
96
class Weave(VersionedFile):
127
97
    """weave - versioned text file storage.
128
 
 
 
98
    
129
99
    A Weave manages versions of line-based text files, keeping track
130
100
    of the originating version for each line.
131
101
 
177
147
 
178
148
    * It doesn't seem very useful to have an active insertion
179
149
      inside an inactive insertion, but it might happen.
180
 
 
 
150
      
181
151
    * Therefore, all instructions are always"considered"; that
182
152
      is passed onto and off the stack.  An outer inactive block
183
153
      doesn't disable an inner block.
213
183
    """
214
184
 
215
185
    __slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map',
216
 
                 '_weave_name', '_matcher', '_allow_reserved']
217
 
 
218
 
    def __init__(self, weave_name=None, access_mode='w', matcher=None,
219
 
                 get_scope=None, allow_reserved=False):
 
186
                 '_weave_name', '_matcher']
 
187
    
 
188
    def __init__(self, weave_name=None, access_mode='w', matcher=None, get_scope=None):
220
189
        """Create a weave.
221
190
 
222
191
        :param get_scope: A callable that returns an opaque object to be used
223
192
            for detecting when this weave goes out of scope (should stop
224
193
            answering requests or allowing mutation).
225
194
        """
226
 
        super(Weave, self).__init__()
 
195
        super(Weave, self).__init__(access_mode)
227
196
        self._weave = []
228
197
        self._parents = []
229
198
        self._sha1s = []
239
208
        self._get_scope = get_scope
240
209
        self._scope = get_scope()
241
210
        self._access_mode = access_mode
242
 
        self._allow_reserved = allow_reserved
243
211
 
244
212
    def __repr__(self):
245
213
        return "Weave(%r)" % self._weave_name
253
221
 
254
222
    def copy(self):
255
223
        """Return a deep copy of self.
256
 
 
 
224
        
257
225
        The copy can be modified without affecting the original weave."""
258
226
        other = Weave()
259
227
        other._weave = self._weave[:]
269
237
            return False
270
238
        return self._parents == other._parents \
271
239
               and self._weave == other._weave \
272
 
               and self._sha1s == other._sha1s
273
 
 
 
240
               and self._sha1s == other._sha1s 
 
241
    
274
242
    def __ne__(self, other):
275
243
        return not self.__eq__(other)
276
244
 
279
247
 
280
248
    def _lookup(self, name):
281
249
        """Convert symbolic version name to index."""
282
 
        if not self._allow_reserved:
283
 
            self.check_not_reserved_id(name)
 
250
        self.check_not_reserved_id(name)
284
251
        try:
285
252
            return self._name_map[name]
286
253
        except KeyError:
296
263
 
297
264
    __contains__ = has_version
298
265
 
299
 
    def get_record_stream(self, versions, ordering, include_delta_closure):
300
 
        """Get a stream of records for versions.
301
 
 
302
 
        :param versions: The versions to include. Each version is a tuple
303
 
            (version,).
304
 
        :param ordering: Either 'unordered' or 'topological'. A topologically
305
 
            sorted stream has compression parents strictly before their
306
 
            children.
307
 
        :param include_delta_closure: If True then the closure across any
308
 
            compression parents will be included (in the opaque data).
309
 
        :return: An iterator of ContentFactory objects, each of which is only
310
 
            valid until the iterator is advanced.
311
 
        """
312
 
        versions = [version[-1] for version in versions]
313
 
        if ordering == 'topological':
314
 
            parents = self.get_parent_map(versions)
315
 
            new_versions = tsort.topo_sort(parents)
316
 
            new_versions.extend(set(versions).difference(set(parents)))
317
 
            versions = new_versions
318
 
        elif ordering == 'groupcompress':
319
 
            parents = self.get_parent_map(versions)
320
 
            new_versions = sort_groupcompress(parents)
321
 
            new_versions.extend(set(versions).difference(set(parents)))
322
 
            versions = new_versions
323
 
        for version in versions:
324
 
            if version in self:
325
 
                yield WeaveContentFactory(version, self)
326
 
            else:
327
 
                yield AbsentContentFactory((version,))
328
 
 
329
266
    def get_parent_map(self, version_ids):
330
267
        """See VersionedFile.get_parent_map."""
331
268
        result = {}
332
269
        for version_id in version_ids:
333
 
            if version_id == NULL_REVISION:
334
 
                parents = ()
335
 
            else:
336
 
                try:
337
 
                    parents = tuple(
338
 
                        map(self._idx_to_name,
339
 
                            self._parents[self._lookup(version_id)]))
340
 
                except RevisionNotPresent:
341
 
                    continue
342
 
            result[version_id] = parents
 
270
            try:
 
271
                result[version_id] = tuple(
 
272
                    map(self._idx_to_name, self._parents[self._lookup(version_id)]))
 
273
            except RevisionNotPresent:
 
274
                pass
343
275
        return result
344
276
 
345
277
    def get_parents_with_ghosts(self, version_id):
346
278
        raise NotImplementedError(self.get_parents_with_ghosts)
347
279
 
348
 
    def insert_record_stream(self, stream):
349
 
        """Insert a record stream into this versioned file.
350
 
 
351
 
        :param stream: A stream of records to insert.
352
 
        :return: None
353
 
        :seealso VersionedFile.get_record_stream:
354
 
        """
355
 
        adapters = {}
356
 
        for record in stream:
357
 
            # Raise an error when a record is missing.
358
 
            if record.storage_kind == 'absent':
359
 
                raise RevisionNotPresent([record.key[0]], self)
360
 
            # adapt to non-tuple interface
361
 
            parents = [parent[0] for parent in record.parents]
362
 
            if (record.storage_kind == 'fulltext'
363
 
                or record.storage_kind == 'chunked'):
364
 
                self.add_lines(record.key[0], parents,
365
 
                    osutils.chunks_to_lines(record.get_bytes_as('chunked')))
366
 
            else:
367
 
                adapter_key = record.storage_kind, 'fulltext'
368
 
                try:
369
 
                    adapter = adapters[adapter_key]
370
 
                except KeyError:
371
 
                    adapter_factory = adapter_registry.get(adapter_key)
372
 
                    adapter = adapter_factory(self)
373
 
                    adapters[adapter_key] = adapter
374
 
                lines = split_lines(adapter.get_bytes(record))
375
 
                try:
376
 
                    self.add_lines(record.key[0], parents, lines)
377
 
                except RevisionAlreadyPresent:
378
 
                    pass
379
 
 
380
280
    def _check_repeated_add(self, name, parents, text, sha1):
381
281
        """Check that a duplicated add is OK.
382
282
 
397
297
 
398
298
    def _add(self, version_id, lines, parents, sha1=None, nostore_sha=None):
399
299
        """Add a single text on top of the weave.
400
 
 
 
300
  
401
301
        Returns the index number of the newly added version.
402
302
 
403
303
        version_id
404
304
            Symbolic name for this version.
405
305
            (Typically the revision-id of the revision that added it.)
406
 
            If None, a name will be allocated based on the hash. (sha1:SHAHASH)
407
306
 
408
307
        parents
409
308
            List or set of direct parent version numbers.
410
 
 
 
309
            
411
310
        lines
412
311
            Sequence of lines to be added in the new version.
413
312
 
414
313
        :param nostore_sha: See VersionedFile.add_lines.
415
314
        """
 
315
        assert isinstance(version_id, basestring)
416
316
        self._check_lines_not_unicode(lines)
417
317
        self._check_lines_are_lines(lines)
418
318
        if not sha1:
419
319
            sha1 = sha_strings(lines)
420
320
        if sha1 == nostore_sha:
421
321
            raise errors.ExistingContent
422
 
        if version_id is None:
423
 
            version_id = "sha1:" + sha1
424
322
        if version_id in self._name_map:
425
323
            return self._check_repeated_add(version_id, parents, lines, sha1)
426
324
 
437
335
        self._names.append(version_id)
438
336
        self._name_map[version_id] = new_version
439
337
 
440
 
 
 
338
            
441
339
        if not parents:
442
340
            # special case; adding with no parents revision; can do
443
341
            # this more quickly by just appending unconditionally.
454
352
            if sha1 == self._sha1s[pv]:
455
353
                # special case: same as the single parent
456
354
                return new_version
457
 
 
 
355
            
458
356
 
459
357
        ancestors = self._inclusions(parents)
460
358
 
495
393
            #print 'raw match', tag, i1, i2, j1, j2
496
394
            if tag == 'equal':
497
395
                continue
 
396
 
498
397
            i1 = basis_lineno[i1]
499
398
            i2 = basis_lineno[i2]
 
399
 
 
400
            assert 0 <= j1 <= j2 <= len(lines)
 
401
 
 
402
            #print tag, i1, i2, j1, j2
 
403
 
500
404
            # the deletion and insertion are handled separately.
501
405
            # first delete the region.
502
406
            if i1 != i2:
509
413
                # i2; we want to insert after this region to make sure
510
414
                # we don't destroy ourselves
511
415
                i = i2 + offset
512
 
                self._weave[i:i] = ([('{', new_version)]
513
 
                                    + lines[j1:j2]
 
416
                self._weave[i:i] = ([('{', new_version)] 
 
417
                                    + lines[j1:j2] 
514
418
                                    + [('}', None)])
515
419
                offset += 2 + (j2 - j1)
516
420
        return new_version
543
447
            if not isinstance(l, basestring):
544
448
                raise ValueError("text line should be a string or unicode, not %s"
545
449
                                 % type(l))
546
 
 
 
450
        
547
451
 
548
452
 
549
453
    def _check_versions(self, indexes):
557
461
    def _compatible_parents(self, my_parents, other_parents):
558
462
        """During join check that other_parents are joinable with my_parents.
559
463
 
560
 
        Joinable is defined as 'is a subset of' - supersets may require
 
464
        Joinable is defined as 'is a subset of' - supersets may require 
561
465
        regeneration of diffs, but subsets do not.
562
466
        """
563
467
        return len(other_parents.difference(my_parents)) == 0
577
481
            version_ids = self.versions()
578
482
        version_ids = set(version_ids)
579
483
        for lineno, inserted, deletes, line in self._walk_internal(version_ids):
580
 
            if inserted not in version_ids: continue
 
484
            # if inserted not in version_ids then it was inserted before the
 
485
            # versions we care about, but because weaves cannot represent ghosts
 
486
            # properly, we do not filter down to that
 
487
            # if inserted not in version_ids: continue
581
488
            if line[-1] != '\n':
582
489
                yield line + '\n', inserted
583
490
            else:
585
492
 
586
493
    def _walk_internal(self, version_ids=None):
587
494
        """Helper method for weave actions."""
588
 
 
 
495
        
589
496
        istack = []
590
497
        dset = set()
591
498
 
600
507
                elif c == '}':
601
508
                    istack.pop()
602
509
                elif c == '[':
 
510
                    assert self._names[v] not in dset
603
511
                    dset.add(self._names[v])
604
512
                elif c == ']':
605
513
                    dset.remove(self._names[v])
606
514
                else:
607
515
                    raise WeaveFormatError('unexpected instruction %r' % v)
608
516
            else:
 
517
                assert l.__class__ in (str, unicode)
 
518
                assert istack
609
519
                yield lineno, istack[-1], frozenset(dset), l
610
520
            lineno += 1
611
521
 
660
570
                # not in either revision
661
571
                yield 'irrelevant', line
662
572
 
 
573
        yield 'unchanged', ''           # terminator
 
574
 
663
575
    def _extract(self, versions):
664
576
        """Yield annotation of lines in included set.
665
577
 
672
584
        for i in versions:
673
585
            if not isinstance(i, int):
674
586
                raise ValueError(i)
675
 
 
 
587
            
676
588
        included = self._inclusions(versions)
677
589
 
678
590
        istack = []
687
599
 
688
600
        WFE = WeaveFormatError
689
601
 
690
 
        # wow.
 
602
        # wow. 
691
603
        #  449       0   4474.6820   2356.5590   bzrlib.weave:556(_extract)
692
604
        #  +285282   0   1676.8040   1676.8040   +<isinstance>
693
605
        # 1.6 seconds in 'isinstance'.
699
611
        # we're still spending ~1/4 of the method in isinstance though.
700
612
        # so lets hard code the acceptable string classes we expect:
701
613
        #  449       0   1202.9420    786.2930   bzrlib.weave:556(_extract)
702
 
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list'
 
614
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list' 
703
615
        #                                          objects>
704
616
        # yay, down to ~1/4 the initial extract time, and our inline time
705
617
        # has shrunk again, with isinstance no longer dominating.
706
618
        # tweaking the stack inclusion test to use a set gives:
707
619
        #  449       0   1122.8030    713.0080   bzrlib.weave:556(_extract)
708
 
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list'
 
620
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list' 
709
621
        #                                          objects>
710
622
        # - a 5% win, or possibly just noise. However with large istacks that
711
623
        # 'in' test could dominate, so I'm leaving this change in place -
712
624
        # when its fast enough to consider profiling big datasets we can review.
713
625
 
714
 
 
715
 
 
 
626
              
 
627
             
716
628
 
717
629
        for l in self._weave:
718
630
            if l.__class__ == tuple:
719
631
                c, v = l
720
632
                isactive = None
721
633
                if c == '{':
 
634
                    assert v not in iset
722
635
                    istack.append(v)
723
636
                    iset.add(v)
724
637
                elif c == '}':
725
638
                    iset.remove(istack.pop())
726
639
                elif c == '[':
727
640
                    if v in included:
 
641
                        assert v not in dset
728
642
                        dset.add(v)
729
 
                elif c == ']':
 
643
                else:
 
644
                    assert c == ']'
730
645
                    if v in included:
 
646
                        assert v in dset
731
647
                        dset.remove(v)
732
 
                else:
733
 
                    raise AssertionError()
734
648
            else:
 
649
                assert l.__class__ in (str, unicode)
735
650
                if isactive is None:
736
651
                    isactive = (not dset) and istack and (istack[-1] in included)
737
652
                if isactive:
747
662
 
748
663
    def _maybe_lookup(self, name_or_index):
749
664
        """Convert possible symbolic name to index, or pass through indexes.
750
 
 
 
665
        
751
666
        NOT FOR PUBLIC USE.
752
667
        """
753
668
        if isinstance(name_or_index, (int, long)):
763
678
        measured_sha1 = sha_strings(result)
764
679
        if measured_sha1 != expected_sha1:
765
680
            raise errors.WeaveInvalidChecksum(
766
 
                    'file %s, revision %s, expected: %s, measured %s'
 
681
                    'file %s, revision %s, expected: %s, measured %s' 
767
682
                    % (self._weave_name, version_id,
768
683
                       expected_sha1, measured_sha1))
769
684
        return result
770
685
 
771
686
    def get_sha1s(self, version_ids):
772
687
        """See VersionedFile.get_sha1s()."""
773
 
        result = {}
774
 
        for v in version_ids:
775
 
            result[v] = self._sha1s[self._lookup(v)]
776
 
        return result
 
688
        return [self._sha1s[self._lookup(v)] for v in version_ids]
777
689
 
778
690
    def num_versions(self):
779
691
        """How many versions are in this weave?"""
780
692
        l = len(self._parents)
 
693
        assert l == len(self._sha1s)
781
694
        return l
782
695
 
783
696
    __len__ = num_versions
803
716
            # For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
804
717
            # The problem is that set membership is much more expensive
805
718
            name = self._idx_to_name(i)
806
 
            sha1s[name] = sha()
 
719
            sha1s[name] = sha.new()
807
720
            texts[name] = []
808
721
            new_inc = set([name])
809
722
            for p in self._parents[i]:
810
723
                new_inc.update(inclusions[self._idx_to_name(p)])
811
724
 
812
 
            if set(new_inc) != set(self.get_ancestry(name)):
813
 
                raise AssertionError(
814
 
                    'failed %s != %s'
815
 
                    % (set(new_inc), set(self.get_ancestry(name))))
 
725
            assert set(new_inc) == set(self.get_ancestry(name)), \
 
726
                'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
816
727
            inclusions[name] = new_inc
817
728
 
818
729
        nlines = len(self._weave)
848
759
        # no lines outside of insertion blocks, that deletions are
849
760
        # properly paired, etc.
850
761
 
 
762
    def _join(self, other, pb, msg, version_ids, ignore_missing):
 
763
        """Worker routine for join()."""
 
764
        if not other.versions():
 
765
            return          # nothing to update, easy
 
766
 
 
767
        if not version_ids:
 
768
            # versions is never none, InterWeave checks this.
 
769
            return 0
 
770
 
 
771
        # two loops so that we do not change ourselves before verifying it
 
772
        # will be ok
 
773
        # work through in index order to make sure we get all dependencies
 
774
        names_to_join = []
 
775
        processed = 0
 
776
        # get the selected versions only that are in other.versions.
 
777
        version_ids = set(other.versions()).intersection(set(version_ids))
 
778
        # pull in the referenced graph.
 
779
        version_ids = other.get_ancestry(version_ids)
 
780
        pending_parents = other.get_parent_map(version_ids)
 
781
        pending_graph = pending_parents.items()
 
782
        if len(pending_graph) != len(version_ids):
 
783
            raise RevisionNotPresent(
 
784
                set(version_ids) - set(pending_parents.keys()), self)
 
785
        for name in topo_sort(pending_graph):
 
786
            other_idx = other._name_map[name]
 
787
            # returns True if we have it, False if we need it.
 
788
            if not self._check_version_consistent(other, other_idx, name):
 
789
                names_to_join.append((other_idx, name))
 
790
            processed += 1
 
791
 
 
792
        if pb and not msg:
 
793
            msg = 'weave join'
 
794
 
 
795
        merged = 0
 
796
        time0 = time.time()
 
797
        for other_idx, name in names_to_join:
 
798
            # TODO: If all the parents of the other version are already
 
799
            # present then we can avoid some work by just taking the delta
 
800
            # and adjusting the offsets.
 
801
            new_parents = self._imported_parents(other, other_idx)
 
802
            sha1 = other._sha1s[other_idx]
 
803
 
 
804
            merged += 1
 
805
 
 
806
            if pb:
 
807
                pb.update(msg, merged, len(names_to_join))
 
808
           
 
809
            lines = other.get_lines(other_idx)
 
810
            self._add(name, lines, new_parents, sha1)
 
811
 
 
812
        mutter("merged = %d, processed = %d, file_id=%s; deltat=%d"%(
 
813
                merged, processed, self._weave_name, time.time()-time0))
 
814
 
851
815
    def _imported_parents(self, other, other_idx):
852
816
        """Return list of parents in self corresponding to indexes in other."""
853
817
        new_parents = []
855
819
            parent_name = other._names[parent_idx]
856
820
            if parent_name not in self._name_map:
857
821
                # should not be possible
858
 
                raise WeaveError("missing parent {%s} of {%s} in %r"
 
822
                raise WeaveError("missing parent {%s} of {%s} in %r" 
859
823
                                 % (parent_name, other._name_map[other_idx], self))
860
824
            new_parents.append(self._name_map[parent_name])
861
825
        return new_parents
868
832
         * the same text
869
833
         * the same direct parents (by name, not index, and disregarding
870
834
           order)
871
 
 
 
835
        
872
836
        If present & correct return True;
873
 
        if not present in self return False;
 
837
        if not present in self return False; 
874
838
        if inconsistent raise error."""
875
839
        this_idx = self._name_map.get(name, -1)
876
840
        if this_idx != -1:
909
873
    """A WeaveFile represents a Weave on disk and writes on change."""
910
874
 
911
875
    WEAVE_SUFFIX = '.weave'
912
 
 
 
876
    
913
877
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w', get_scope=None):
914
878
        """Create a WeaveFile.
915
 
 
 
879
        
916
880
        :param create: If not True, only open an existing knit.
917
881
        """
918
 
        super(WeaveFile, self).__init__(name, access_mode, get_scope=get_scope,
919
 
            allow_reserved=False)
 
882
        super(WeaveFile, self).__init__(name, access_mode, get_scope=get_scope)
920
883
        self._transport = transport
921
884
        self._filemode = filemode
922
885
        try:
923
 
            f = self._transport.get(name + WeaveFile.WEAVE_SUFFIX)
924
 
            _read_weave_v5(StringIO(f.read()), self)
 
886
            _read_weave_v5(self._transport.get(name + WeaveFile.WEAVE_SUFFIX), self)
925
887
        except errors.NoSuchFile:
926
888
            if not create:
927
889
                raise
952
914
        sio = StringIO()
953
915
        write_weave_v5(self, sio)
954
916
        sio.seek(0)
955
 
        bytes = sio.getvalue()
956
 
        path = self._weave_name + WeaveFile.WEAVE_SUFFIX
957
 
        try:
958
 
            self._transport.put_bytes(path, bytes, self._filemode)
959
 
        except errors.NoSuchFile:
960
 
            self._transport.mkdir(dirname(path))
961
 
            self._transport.put_bytes(path, bytes, self._filemode)
 
917
        self._transport.put_file(self._weave_name + WeaveFile.WEAVE_SUFFIX,
 
918
                                 sio,
 
919
                                 self._filemode)
962
920
 
963
921
    @staticmethod
964
922
    def get_suffixes():
965
923
        """See VersionedFile.get_suffixes()."""
966
924
        return [WeaveFile.WEAVE_SUFFIX]
967
925
 
968
 
    def insert_record_stream(self, stream):
969
 
        super(WeaveFile, self).insert_record_stream(stream)
 
926
    def join(self, other, pb=None, msg=None, version_ids=None,
 
927
             ignore_missing=False):
 
928
        """Join other into self and save."""
 
929
        super(WeaveFile, self).join(other, pb, msg, version_ids, ignore_missing)
970
930
        self._save()
971
931
 
972
932
 
973
933
def _reweave(wa, wb, pb=None, msg=None):
974
934
    """Combine two weaves and return the result.
975
935
 
976
 
    This works even if a revision R has different parents in
 
936
    This works even if a revision R has different parents in 
977
937
    wa and wb.  In the resulting weave all the parents are given.
978
938
 
979
 
    This is done by just building up a new weave, maintaining ordering
 
939
    This is done by just building up a new weave, maintaining ordering 
980
940
    of the versions in the two inputs.  More efficient approaches
981
 
    might be possible but it should only be necessary to do
982
 
    this operation rarely, when a new previously ghost version is
 
941
    might be possible but it should only be necessary to do 
 
942
    this operation rarely, when a new previously ghost version is 
983
943
    inserted.
984
944
 
985
945
    :param pb: An optional progress bar, indicating how far done we are
993
953
    # map from version name -> all parent names
994
954
    combined_parents = _reweave_parent_graphs(wa, wb)
995
955
    mutter("combined parents: %r", combined_parents)
996
 
    order = tsort.topo_sort(combined_parents.iteritems())
 
956
    order = topo_sort(combined_parents.iteritems())
997
957
    mutter("order to reweave: %r", order)
998
958
 
999
959
    if pb and not msg:
1019
979
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
1020
980
    return wr
1021
981
 
1022
 
 
1023
982
def _reweave_parent_graphs(wa, wb):
1024
983
    """Return combined parent ancestry for two weaves.
1025
 
 
 
984
    
1026
985
    Returned as a list of (version_name, set(parent_names))"""
1027
986
    combined = {}
1028
987
    for weave in [wa, wb]:
1030
989
            p = combined.setdefault(name, set())
1031
990
            p.update(map(weave._idx_to_name, weave._parents[idx]))
1032
991
    return combined
 
992
 
 
993
 
 
994
def weave_toc(w):
 
995
    """Show the weave's table-of-contents"""
 
996
    print '%6s %50s %10s %10s' % ('ver', 'name', 'sha1', 'parents')
 
997
    for i in (6, 50, 10, 10):
 
998
        print '-' * i,
 
999
    print
 
1000
    for i in range(w.num_versions()):
 
1001
        sha1 = w._sha1s[i]
 
1002
        name = w._names[i]
 
1003
        parent_str = ' '.join(map(str, w._parents[i]))
 
1004
        print '%6d %-50.50s %10.10s %s' % (i, name, sha1, parent_str)
 
1005
 
 
1006
 
 
1007
 
 
1008
def weave_stats(weave_file, pb):
 
1009
    from bzrlib.weavefile import read_weave
 
1010
 
 
1011
    wf = file(weave_file, 'rb')
 
1012
    w = read_weave(wf)
 
1013
    # FIXME: doesn't work on pipes
 
1014
    weave_size = wf.tell()
 
1015
 
 
1016
    total = 0
 
1017
    vers = len(w)
 
1018
    for i in range(vers):
 
1019
        pb.update('checking sizes', i, vers)
 
1020
        for origin, lineno, line in w._extract([i]):
 
1021
            total += len(line)
 
1022
 
 
1023
    pb.clear()
 
1024
 
 
1025
    print 'versions          %9d' % vers
 
1026
    print 'weave file        %9d bytes' % weave_size
 
1027
    print 'total contents    %9d bytes' % total
 
1028
    print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
 
1029
    if vers:
 
1030
        avg = total/vers
 
1031
        print 'average size      %9d bytes' % avg
 
1032
        print 'relative size     %9.2fx' % (float(weave_size) / float(avg))
 
1033
 
 
1034
 
 
1035
def usage():
 
1036
    print """bzr weave tool
 
1037
 
 
1038
Experimental tool for weave algorithm.
 
1039
 
 
1040
usage:
 
1041
    weave init WEAVEFILE
 
1042
        Create an empty weave file
 
1043
    weave get WEAVEFILE VERSION
 
1044
        Write out specified version.
 
1045
    weave check WEAVEFILE
 
1046
        Check consistency of all versions.
 
1047
    weave toc WEAVEFILE
 
1048
        Display table of contents.
 
1049
    weave add WEAVEFILE NAME [BASE...] < NEWTEXT
 
1050
        Add NEWTEXT, with specified parent versions.
 
1051
    weave annotate WEAVEFILE VERSION
 
1052
        Display origin of each line.
 
1053
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
 
1054
        Auto-merge two versions and display conflicts.
 
1055
    weave diff WEAVEFILE VERSION1 VERSION2 
 
1056
        Show differences between two versions.
 
1057
 
 
1058
example:
 
1059
 
 
1060
    % weave init foo.weave
 
1061
    % vi foo.txt
 
1062
    % weave add foo.weave ver0 < foo.txt
 
1063
    added version 0
 
1064
 
 
1065
    (create updated version)
 
1066
    % vi foo.txt
 
1067
    % weave get foo.weave 0 | diff -u - foo.txt
 
1068
    % weave add foo.weave ver1 0 < foo.txt
 
1069
    added version 1
 
1070
 
 
1071
    % weave get foo.weave 0 > foo.txt       (create forked version)
 
1072
    % vi foo.txt
 
1073
    % weave add foo.weave ver2 0 < foo.txt
 
1074
    added version 2
 
1075
 
 
1076
    % weave merge foo.weave 1 2 > foo.txt   (merge them)
 
1077
    % vi foo.txt                            (resolve conflicts)
 
1078
    % weave add foo.weave merged 1 2 < foo.txt     (commit merged version)     
 
1079
    
 
1080
"""
 
1081
    
 
1082
 
 
1083
 
 
1084
def main(argv):
 
1085
    import sys
 
1086
    import os
 
1087
    try:
 
1088
        import bzrlib
 
1089
    except ImportError:
 
1090
        # in case we're run directly from the subdirectory
 
1091
        sys.path.append('..')
 
1092
        import bzrlib
 
1093
    from bzrlib.weavefile import write_weave, read_weave
 
1094
    from bzrlib.progress import ProgressBar
 
1095
 
 
1096
    try:
 
1097
        import psyco
 
1098
        psyco.full()
 
1099
    except ImportError:
 
1100
        pass
 
1101
 
 
1102
    if len(argv) < 2:
 
1103
        usage()
 
1104
        return 0
 
1105
 
 
1106
    cmd = argv[1]
 
1107
 
 
1108
    def readit():
 
1109
        return read_weave(file(argv[2], 'rb'))
 
1110
    
 
1111
    if cmd == 'help':
 
1112
        usage()
 
1113
    elif cmd == 'add':
 
1114
        w = readit()
 
1115
        # at the moment, based on everything in the file
 
1116
        name = argv[3]
 
1117
        parents = map(int, argv[4:])
 
1118
        lines = sys.stdin.readlines()
 
1119
        ver = w.add(name, parents, lines)
 
1120
        write_weave(w, file(argv[2], 'wb'))
 
1121
        print 'added version %r %d' % (name, ver)
 
1122
    elif cmd == 'init':
 
1123
        fn = argv[2]
 
1124
        if os.path.exists(fn):
 
1125
            raise IOError("file exists")
 
1126
        w = Weave()
 
1127
        write_weave(w, file(fn, 'wb'))
 
1128
    elif cmd == 'get': # get one version
 
1129
        w = readit()
 
1130
        sys.stdout.writelines(w.get_iter(int(argv[3])))
 
1131
        
 
1132
    elif cmd == 'diff':
 
1133
        w = readit()
 
1134
        fn = argv[2]
 
1135
        v1, v2 = map(int, argv[3:5])
 
1136
        lines1 = w.get(v1)
 
1137
        lines2 = w.get(v2)
 
1138
        diff_gen = bzrlib.patiencediff.unified_diff(lines1, lines2,
 
1139
                                '%s version %d' % (fn, v1),
 
1140
                                '%s version %d' % (fn, v2))
 
1141
        sys.stdout.writelines(diff_gen)
 
1142
            
 
1143
    elif cmd == 'annotate':
 
1144
        w = readit()
 
1145
        # newline is added to all lines regardless; too hard to get
 
1146
        # reasonable formatting otherwise
 
1147
        lasto = None
 
1148
        for origin, text in w.annotate(int(argv[3])):
 
1149
            text = text.rstrip('\r\n')
 
1150
            if origin == lasto:
 
1151
                print '      | %s' % (text)
 
1152
            else:
 
1153
                print '%5d | %s' % (origin, text)
 
1154
                lasto = origin
 
1155
                
 
1156
    elif cmd == 'toc':
 
1157
        weave_toc(readit())
 
1158
 
 
1159
    elif cmd == 'stats':
 
1160
        weave_stats(argv[2], ProgressBar())
 
1161
        
 
1162
    elif cmd == 'check':
 
1163
        w = readit()
 
1164
        pb = ProgressBar()
 
1165
        w.check(pb)
 
1166
        pb.clear()
 
1167
        print '%d versions ok' % w.num_versions()
 
1168
 
 
1169
    elif cmd == 'inclusions':
 
1170
        w = readit()
 
1171
        print ' '.join(map(str, w.inclusions([int(argv[3])])))
 
1172
 
 
1173
    elif cmd == 'parents':
 
1174
        w = readit()
 
1175
        print ' '.join(map(str, w._parents[int(argv[3])]))
 
1176
 
 
1177
    elif cmd == 'plan-merge':
 
1178
        # replaced by 'bzr weave-plan-merge'
 
1179
        w = readit()
 
1180
        for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
 
1181
            if line:
 
1182
                print '%14s | %s' % (state, line),
 
1183
    elif cmd == 'merge':
 
1184
        # replaced by 'bzr weave-merge-text'
 
1185
        w = readit()
 
1186
        p = w.plan_merge(int(argv[3]), int(argv[4]))
 
1187
        sys.stdout.writelines(w.weave_merge(p))
 
1188
    else:
 
1189
        raise ValueError('unknown command %r' % cmd)
 
1190
    
 
1191
 
 
1192
if __name__ == '__main__':
 
1193
    import sys
 
1194
    sys.exit(main(sys.argv))
 
1195
 
 
1196
 
 
1197
class InterWeave(InterVersionedFile):
 
1198
    """Optimised code paths for weave to weave operations."""
 
1199
    
 
1200
    _matching_file_from_factory = staticmethod(WeaveFile)
 
1201
    _matching_file_to_factory = staticmethod(WeaveFile)
 
1202
    
 
1203
    @staticmethod
 
1204
    def is_compatible(source, target):
 
1205
        """Be compatible with weaves."""
 
1206
        try:
 
1207
            return (isinstance(source, Weave) and
 
1208
                    isinstance(target, Weave))
 
1209
        except AttributeError:
 
1210
            return False
 
1211
 
 
1212
    def join(self, pb=None, msg=None, version_ids=None, ignore_missing=False):
 
1213
        """See InterVersionedFile.join."""
 
1214
        version_ids = self._get_source_version_ids(version_ids, ignore_missing)
 
1215
        if self.target.versions() == [] and version_ids is None:
 
1216
            self.target._copy_weave_content(self.source)
 
1217
            return
 
1218
        self.target._join(self.source, pb, msg, version_ids, ignore_missing)
 
1219
 
 
1220
 
 
1221
InterVersionedFile.register_optimiser(InterWeave)