/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

 * New ``versionedfile.KeyMapper`` interface to abstract out the access to
   underyling .knit/.kndx etc files in repositories with partitioned
   storage. (Robert Collins)

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
 
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
81
from bzrlib.errors import (WeaveError, WeaveFormatError, WeaveParentMismatch,
82
82
        RevisionAlreadyPresent,
83
83
        RevisionNotPresent,
84
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, split_lines
87
90
import bzrlib.patiencediff
88
 
from bzrlib.revision import NULL_REVISION
89
 
from bzrlib.symbol_versioning import *
90
91
from bzrlib.trace import mutter
 
92
from bzrlib.tsort import topo_sort
91
93
from bzrlib.versionedfile import (
92
94
    AbsentContentFactory,
93
95
    adapter_registry,
94
96
    ContentFactory,
95
 
    sort_groupcompress,
 
97
    InterVersionedFile,
96
98
    VersionedFile,
97
99
    )
98
100
from bzrlib.weavefile import _read_weave_v5, write_weave_v5
107
109
    def __init__(self, version, weave):
108
110
        """Create a WeaveContentFactory for version from weave."""
109
111
        ContentFactory.__init__(self)
110
 
        self.sha1 = weave.get_sha1s([version])[version]
 
112
        self.sha1 = weave.get_sha1s([version])[0]
111
113
        self.key = (version,)
112
114
        parents = weave.get_parent_map([version])[version]
113
115
        self.parents = tuple((parent,) for parent in parents)
116
118
 
117
119
    def get_bytes_as(self, storage_kind):
118
120
        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])
 
121
            return self._weave.get_text(self.key[0])
122
122
        else:
123
123
            raise UnavailableRepresentation(self.key, storage_kind, 'fulltext')
124
124
 
125
125
 
126
126
class Weave(VersionedFile):
127
127
    """weave - versioned text file storage.
128
 
 
 
128
    
129
129
    A Weave manages versions of line-based text files, keeping track
130
130
    of the originating version for each line.
131
131
 
177
177
 
178
178
    * It doesn't seem very useful to have an active insertion
179
179
      inside an inactive insertion, but it might happen.
180
 
 
 
180
      
181
181
    * Therefore, all instructions are always"considered"; that
182
182
      is passed onto and off the stack.  An outer inactive block
183
183
      doesn't disable an inner block.
213
213
    """
214
214
 
215
215
    __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):
 
216
                 '_weave_name', '_matcher']
 
217
    
 
218
    def __init__(self, weave_name=None, access_mode='w', matcher=None, get_scope=None):
220
219
        """Create a weave.
221
220
 
222
221
        :param get_scope: A callable that returns an opaque object to be used
223
222
            for detecting when this weave goes out of scope (should stop
224
223
            answering requests or allowing mutation).
225
224
        """
226
 
        super(Weave, self).__init__()
 
225
        super(Weave, self).__init__(access_mode)
227
226
        self._weave = []
228
227
        self._parents = []
229
228
        self._sha1s = []
239
238
        self._get_scope = get_scope
240
239
        self._scope = get_scope()
241
240
        self._access_mode = access_mode
242
 
        self._allow_reserved = allow_reserved
243
241
 
244
242
    def __repr__(self):
245
243
        return "Weave(%r)" % self._weave_name
253
251
 
254
252
    def copy(self):
255
253
        """Return a deep copy of self.
256
 
 
 
254
        
257
255
        The copy can be modified without affecting the original weave."""
258
256
        other = Weave()
259
257
        other._weave = self._weave[:]
269
267
            return False
270
268
        return self._parents == other._parents \
271
269
               and self._weave == other._weave \
272
 
               and self._sha1s == other._sha1s
273
 
 
 
270
               and self._sha1s == other._sha1s 
 
271
    
274
272
    def __ne__(self, other):
275
273
        return not self.__eq__(other)
276
274
 
279
277
 
280
278
    def _lookup(self, name):
281
279
        """Convert symbolic version name to index."""
282
 
        if not self._allow_reserved:
283
 
            self.check_not_reserved_id(name)
 
280
        self.check_not_reserved_id(name)
284
281
        try:
285
282
            return self._name_map[name]
286
283
        except KeyError:
309
306
        :return: An iterator of ContentFactory objects, each of which is only
310
307
            valid until the iterator is advanced.
311
308
        """
312
 
        versions = [version[-1] for version in versions]
313
309
        if ordering == 'topological':
314
310
            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)
 
311
            new_versions = topo_sort(parents)
321
312
            new_versions.extend(set(versions).difference(set(parents)))
322
313
            versions = new_versions
323
314
        for version in versions:
330
321
        """See VersionedFile.get_parent_map."""
331
322
        result = {}
332
323
        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
 
324
            try:
 
325
                result[version_id] = tuple(
 
326
                    map(self._idx_to_name, self._parents[self._lookup(version_id)]))
 
327
            except RevisionNotPresent:
 
328
                pass
343
329
        return result
344
330
 
345
331
    def get_parents_with_ghosts(self, version_id):
348
334
    def insert_record_stream(self, stream):
349
335
        """Insert a record stream into this versioned file.
350
336
 
351
 
        :param stream: A stream of records to insert.
 
337
        :param stream: A stream of records to insert. 
352
338
        :return: None
353
339
        :seealso VersionedFile.get_record_stream:
354
340
        """
359
345
                raise RevisionNotPresent([record.key[0]], self)
360
346
            # adapt to non-tuple interface
361
347
            parents = [parent[0] for parent in record.parents]
362
 
            if (record.storage_kind == 'fulltext'
363
 
                or record.storage_kind == 'chunked'):
 
348
            if record.storage_kind == 'fulltext':
364
349
                self.add_lines(record.key[0], parents,
365
 
                    osutils.chunks_to_lines(record.get_bytes_as('chunked')))
 
350
                    split_lines(record.get_bytes_as('fulltext')))
366
351
            else:
367
352
                adapter_key = record.storage_kind, 'fulltext'
368
353
                try:
371
356
                    adapter_factory = adapter_registry.get(adapter_key)
372
357
                    adapter = adapter_factory(self)
373
358
                    adapters[adapter_key] = adapter
374
 
                lines = split_lines(adapter.get_bytes(record))
 
359
                lines = split_lines(adapter.get_bytes(
 
360
                    record, record.get_bytes_as(record.storage_kind)))
375
361
                try:
376
362
                    self.add_lines(record.key[0], parents, lines)
377
363
                except RevisionAlreadyPresent:
397
383
 
398
384
    def _add(self, version_id, lines, parents, sha1=None, nostore_sha=None):
399
385
        """Add a single text on top of the weave.
400
 
 
 
386
  
401
387
        Returns the index number of the newly added version.
402
388
 
403
389
        version_id
404
390
            Symbolic name for this version.
405
391
            (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
392
 
408
393
        parents
409
394
            List or set of direct parent version numbers.
410
 
 
 
395
            
411
396
        lines
412
397
            Sequence of lines to be added in the new version.
413
398
 
414
399
        :param nostore_sha: See VersionedFile.add_lines.
415
400
        """
 
401
        assert isinstance(version_id, basestring)
416
402
        self._check_lines_not_unicode(lines)
417
403
        self._check_lines_are_lines(lines)
418
404
        if not sha1:
419
405
            sha1 = sha_strings(lines)
420
406
        if sha1 == nostore_sha:
421
407
            raise errors.ExistingContent
422
 
        if version_id is None:
423
 
            version_id = "sha1:" + sha1
424
408
        if version_id in self._name_map:
425
409
            return self._check_repeated_add(version_id, parents, lines, sha1)
426
410
 
437
421
        self._names.append(version_id)
438
422
        self._name_map[version_id] = new_version
439
423
 
440
 
 
 
424
            
441
425
        if not parents:
442
426
            # special case; adding with no parents revision; can do
443
427
            # this more quickly by just appending unconditionally.
454
438
            if sha1 == self._sha1s[pv]:
455
439
                # special case: same as the single parent
456
440
                return new_version
457
 
 
 
441
            
458
442
 
459
443
        ancestors = self._inclusions(parents)
460
444
 
495
479
            #print 'raw match', tag, i1, i2, j1, j2
496
480
            if tag == 'equal':
497
481
                continue
 
482
 
498
483
            i1 = basis_lineno[i1]
499
484
            i2 = basis_lineno[i2]
 
485
 
 
486
            assert 0 <= j1 <= j2 <= len(lines)
 
487
 
 
488
            #print tag, i1, i2, j1, j2
 
489
 
500
490
            # the deletion and insertion are handled separately.
501
491
            # first delete the region.
502
492
            if i1 != i2:
509
499
                # i2; we want to insert after this region to make sure
510
500
                # we don't destroy ourselves
511
501
                i = i2 + offset
512
 
                self._weave[i:i] = ([('{', new_version)]
513
 
                                    + lines[j1:j2]
 
502
                self._weave[i:i] = ([('{', new_version)] 
 
503
                                    + lines[j1:j2] 
514
504
                                    + [('}', None)])
515
505
                offset += 2 + (j2 - j1)
516
506
        return new_version
543
533
            if not isinstance(l, basestring):
544
534
                raise ValueError("text line should be a string or unicode, not %s"
545
535
                                 % type(l))
546
 
 
 
536
        
547
537
 
548
538
 
549
539
    def _check_versions(self, indexes):
557
547
    def _compatible_parents(self, my_parents, other_parents):
558
548
        """During join check that other_parents are joinable with my_parents.
559
549
 
560
 
        Joinable is defined as 'is a subset of' - supersets may require
 
550
        Joinable is defined as 'is a subset of' - supersets may require 
561
551
        regeneration of diffs, but subsets do not.
562
552
        """
563
553
        return len(other_parents.difference(my_parents)) == 0
577
567
            version_ids = self.versions()
578
568
        version_ids = set(version_ids)
579
569
        for lineno, inserted, deletes, line in self._walk_internal(version_ids):
580
 
            if inserted not in version_ids: continue
 
570
            # if inserted not in version_ids then it was inserted before the
 
571
            # versions we care about, but because weaves cannot represent ghosts
 
572
            # properly, we do not filter down to that
 
573
            # if inserted not in version_ids: continue
581
574
            if line[-1] != '\n':
582
575
                yield line + '\n', inserted
583
576
            else:
585
578
 
586
579
    def _walk_internal(self, version_ids=None):
587
580
        """Helper method for weave actions."""
588
 
 
 
581
        
589
582
        istack = []
590
583
        dset = set()
591
584
 
600
593
                elif c == '}':
601
594
                    istack.pop()
602
595
                elif c == '[':
 
596
                    assert self._names[v] not in dset
603
597
                    dset.add(self._names[v])
604
598
                elif c == ']':
605
599
                    dset.remove(self._names[v])
606
600
                else:
607
601
                    raise WeaveFormatError('unexpected instruction %r' % v)
608
602
            else:
 
603
                assert l.__class__ in (str, unicode)
 
604
                assert istack
609
605
                yield lineno, istack[-1], frozenset(dset), l
610
606
            lineno += 1
611
607
 
660
656
                # not in either revision
661
657
                yield 'irrelevant', line
662
658
 
 
659
        yield 'unchanged', ''           # terminator
 
660
 
663
661
    def _extract(self, versions):
664
662
        """Yield annotation of lines in included set.
665
663
 
672
670
        for i in versions:
673
671
            if not isinstance(i, int):
674
672
                raise ValueError(i)
675
 
 
 
673
            
676
674
        included = self._inclusions(versions)
677
675
 
678
676
        istack = []
687
685
 
688
686
        WFE = WeaveFormatError
689
687
 
690
 
        # wow.
 
688
        # wow. 
691
689
        #  449       0   4474.6820   2356.5590   bzrlib.weave:556(_extract)
692
690
        #  +285282   0   1676.8040   1676.8040   +<isinstance>
693
691
        # 1.6 seconds in 'isinstance'.
699
697
        # we're still spending ~1/4 of the method in isinstance though.
700
698
        # so lets hard code the acceptable string classes we expect:
701
699
        #  449       0   1202.9420    786.2930   bzrlib.weave:556(_extract)
702
 
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list'
 
700
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list' 
703
701
        #                                          objects>
704
702
        # yay, down to ~1/4 the initial extract time, and our inline time
705
703
        # has shrunk again, with isinstance no longer dominating.
706
704
        # tweaking the stack inclusion test to use a set gives:
707
705
        #  449       0   1122.8030    713.0080   bzrlib.weave:556(_extract)
708
 
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list'
 
706
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list' 
709
707
        #                                          objects>
710
708
        # - a 5% win, or possibly just noise. However with large istacks that
711
709
        # 'in' test could dominate, so I'm leaving this change in place -
712
710
        # when its fast enough to consider profiling big datasets we can review.
713
711
 
714
 
 
715
 
 
 
712
              
 
713
             
716
714
 
717
715
        for l in self._weave:
718
716
            if l.__class__ == tuple:
719
717
                c, v = l
720
718
                isactive = None
721
719
                if c == '{':
 
720
                    assert v not in iset
722
721
                    istack.append(v)
723
722
                    iset.add(v)
724
723
                elif c == '}':
725
724
                    iset.remove(istack.pop())
726
725
                elif c == '[':
727
726
                    if v in included:
 
727
                        assert v not in dset
728
728
                        dset.add(v)
729
 
                elif c == ']':
 
729
                else:
 
730
                    assert c == ']'
730
731
                    if v in included:
 
732
                        assert v in dset
731
733
                        dset.remove(v)
732
 
                else:
733
 
                    raise AssertionError()
734
734
            else:
 
735
                assert l.__class__ in (str, unicode)
735
736
                if isactive is None:
736
737
                    isactive = (not dset) and istack and (istack[-1] in included)
737
738
                if isactive:
747
748
 
748
749
    def _maybe_lookup(self, name_or_index):
749
750
        """Convert possible symbolic name to index, or pass through indexes.
750
 
 
 
751
        
751
752
        NOT FOR PUBLIC USE.
752
753
        """
753
754
        if isinstance(name_or_index, (int, long)):
763
764
        measured_sha1 = sha_strings(result)
764
765
        if measured_sha1 != expected_sha1:
765
766
            raise errors.WeaveInvalidChecksum(
766
 
                    'file %s, revision %s, expected: %s, measured %s'
 
767
                    'file %s, revision %s, expected: %s, measured %s' 
767
768
                    % (self._weave_name, version_id,
768
769
                       expected_sha1, measured_sha1))
769
770
        return result
770
771
 
771
772
    def get_sha1s(self, version_ids):
772
773
        """See VersionedFile.get_sha1s()."""
773
 
        result = {}
774
 
        for v in version_ids:
775
 
            result[v] = self._sha1s[self._lookup(v)]
776
 
        return result
 
774
        return [self._sha1s[self._lookup(v)] for v in version_ids]
777
775
 
778
776
    def num_versions(self):
779
777
        """How many versions are in this weave?"""
780
778
        l = len(self._parents)
 
779
        assert l == len(self._sha1s)
781
780
        return l
782
781
 
783
782
    __len__ = num_versions
803
802
            # For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
804
803
            # The problem is that set membership is much more expensive
805
804
            name = self._idx_to_name(i)
806
 
            sha1s[name] = sha()
 
805
            sha1s[name] = sha.new()
807
806
            texts[name] = []
808
807
            new_inc = set([name])
809
808
            for p in self._parents[i]:
810
809
                new_inc.update(inclusions[self._idx_to_name(p)])
811
810
 
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))))
 
811
            assert set(new_inc) == set(self.get_ancestry(name)), \
 
812
                'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
816
813
            inclusions[name] = new_inc
817
814
 
818
815
        nlines = len(self._weave)
848
845
        # no lines outside of insertion blocks, that deletions are
849
846
        # properly paired, etc.
850
847
 
 
848
    def _join(self, other, pb, msg, version_ids, ignore_missing):
 
849
        """Worker routine for join()."""
 
850
        if not other.versions():
 
851
            return          # nothing to update, easy
 
852
 
 
853
        if not version_ids:
 
854
            # versions is never none, InterWeave checks this.
 
855
            return 0
 
856
 
 
857
        # two loops so that we do not change ourselves before verifying it
 
858
        # will be ok
 
859
        # work through in index order to make sure we get all dependencies
 
860
        names_to_join = []
 
861
        processed = 0
 
862
        # get the selected versions only that are in other.versions.
 
863
        version_ids = set(other.versions()).intersection(set(version_ids))
 
864
        # pull in the referenced graph.
 
865
        version_ids = other.get_ancestry(version_ids)
 
866
        pending_parents = other.get_parent_map(version_ids)
 
867
        pending_graph = pending_parents.items()
 
868
        if len(pending_graph) != len(version_ids):
 
869
            raise RevisionNotPresent(
 
870
                set(version_ids) - set(pending_parents.keys()), self)
 
871
        for name in topo_sort(pending_graph):
 
872
            other_idx = other._name_map[name]
 
873
            # returns True if we have it, False if we need it.
 
874
            if not self._check_version_consistent(other, other_idx, name):
 
875
                names_to_join.append((other_idx, name))
 
876
            processed += 1
 
877
 
 
878
        if pb and not msg:
 
879
            msg = 'weave join'
 
880
 
 
881
        merged = 0
 
882
        time0 = time.time()
 
883
        for other_idx, name in names_to_join:
 
884
            # TODO: If all the parents of the other version are already
 
885
            # present then we can avoid some work by just taking the delta
 
886
            # and adjusting the offsets.
 
887
            new_parents = self._imported_parents(other, other_idx)
 
888
            sha1 = other._sha1s[other_idx]
 
889
 
 
890
            merged += 1
 
891
 
 
892
            if pb:
 
893
                pb.update(msg, merged, len(names_to_join))
 
894
           
 
895
            lines = other.get_lines(other_idx)
 
896
            self._add(name, lines, new_parents, sha1)
 
897
 
 
898
        mutter("merged = %d, processed = %d, file_id=%s; deltat=%d"%(
 
899
                merged, processed, self._weave_name, time.time()-time0))
 
900
 
851
901
    def _imported_parents(self, other, other_idx):
852
902
        """Return list of parents in self corresponding to indexes in other."""
853
903
        new_parents = []
855
905
            parent_name = other._names[parent_idx]
856
906
            if parent_name not in self._name_map:
857
907
                # should not be possible
858
 
                raise WeaveError("missing parent {%s} of {%s} in %r"
 
908
                raise WeaveError("missing parent {%s} of {%s} in %r" 
859
909
                                 % (parent_name, other._name_map[other_idx], self))
860
910
            new_parents.append(self._name_map[parent_name])
861
911
        return new_parents
868
918
         * the same text
869
919
         * the same direct parents (by name, not index, and disregarding
870
920
           order)
871
 
 
 
921
        
872
922
        If present & correct return True;
873
 
        if not present in self return False;
 
923
        if not present in self return False; 
874
924
        if inconsistent raise error."""
875
925
        this_idx = self._name_map.get(name, -1)
876
926
        if this_idx != -1:
909
959
    """A WeaveFile represents a Weave on disk and writes on change."""
910
960
 
911
961
    WEAVE_SUFFIX = '.weave'
912
 
 
 
962
    
913
963
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w', get_scope=None):
914
964
        """Create a WeaveFile.
915
 
 
 
965
        
916
966
        :param create: If not True, only open an existing knit.
917
967
        """
918
 
        super(WeaveFile, self).__init__(name, access_mode, get_scope=get_scope,
919
 
            allow_reserved=False)
 
968
        super(WeaveFile, self).__init__(name, access_mode, get_scope=get_scope)
920
969
        self._transport = transport
921
970
        self._filemode = filemode
922
971
        try:
951
1000
        sio = StringIO()
952
1001
        write_weave_v5(self, sio)
953
1002
        sio.seek(0)
954
 
        bytes = sio.getvalue()
955
 
        path = self._weave_name + WeaveFile.WEAVE_SUFFIX
956
 
        try:
957
 
            self._transport.put_bytes(path, bytes, self._filemode)
958
 
        except errors.NoSuchFile:
959
 
            self._transport.mkdir(dirname(path))
960
 
            self._transport.put_bytes(path, bytes, self._filemode)
 
1003
        self._transport.put_file(self._weave_name + WeaveFile.WEAVE_SUFFIX,
 
1004
                                 sio,
 
1005
                                 self._filemode)
961
1006
 
962
1007
    @staticmethod
963
1008
    def get_suffixes():
964
1009
        """See VersionedFile.get_suffixes()."""
965
1010
        return [WeaveFile.WEAVE_SUFFIX]
966
1011
 
967
 
    def insert_record_stream(self, stream):
968
 
        super(WeaveFile, self).insert_record_stream(stream)
 
1012
    def join(self, other, pb=None, msg=None, version_ids=None,
 
1013
             ignore_missing=False):
 
1014
        """Join other into self and save."""
 
1015
        super(WeaveFile, self).join(other, pb, msg, version_ids, ignore_missing)
969
1016
        self._save()
970
1017
 
971
1018
 
972
1019
def _reweave(wa, wb, pb=None, msg=None):
973
1020
    """Combine two weaves and return the result.
974
1021
 
975
 
    This works even if a revision R has different parents in
 
1022
    This works even if a revision R has different parents in 
976
1023
    wa and wb.  In the resulting weave all the parents are given.
977
1024
 
978
 
    This is done by just building up a new weave, maintaining ordering
 
1025
    This is done by just building up a new weave, maintaining ordering 
979
1026
    of the versions in the two inputs.  More efficient approaches
980
 
    might be possible but it should only be necessary to do
981
 
    this operation rarely, when a new previously ghost version is
 
1027
    might be possible but it should only be necessary to do 
 
1028
    this operation rarely, when a new previously ghost version is 
982
1029
    inserted.
983
1030
 
984
1031
    :param pb: An optional progress bar, indicating how far done we are
992
1039
    # map from version name -> all parent names
993
1040
    combined_parents = _reweave_parent_graphs(wa, wb)
994
1041
    mutter("combined parents: %r", combined_parents)
995
 
    order = tsort.topo_sort(combined_parents.iteritems())
 
1042
    order = topo_sort(combined_parents.iteritems())
996
1043
    mutter("order to reweave: %r", order)
997
1044
 
998
1045
    if pb and not msg:
1018
1065
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
1019
1066
    return wr
1020
1067
 
1021
 
 
1022
1068
def _reweave_parent_graphs(wa, wb):
1023
1069
    """Return combined parent ancestry for two weaves.
1024
 
 
 
1070
    
1025
1071
    Returned as a list of (version_name, set(parent_names))"""
1026
1072
    combined = {}
1027
1073
    for weave in [wa, wb]:
1029
1075
            p = combined.setdefault(name, set())
1030
1076
            p.update(map(weave._idx_to_name, weave._parents[idx]))
1031
1077
    return combined
 
1078
 
 
1079
 
 
1080
def weave_toc(w):
 
1081
    """Show the weave's table-of-contents"""
 
1082
    print '%6s %50s %10s %10s' % ('ver', 'name', 'sha1', 'parents')
 
1083
    for i in (6, 50, 10, 10):
 
1084
        print '-' * i,
 
1085
    print
 
1086
    for i in range(w.num_versions()):
 
1087
        sha1 = w._sha1s[i]
 
1088
        name = w._names[i]
 
1089
        parent_str = ' '.join(map(str, w._parents[i]))
 
1090
        print '%6d %-50.50s %10.10s %s' % (i, name, sha1, parent_str)
 
1091
 
 
1092
 
 
1093
 
 
1094
def weave_stats(weave_file, pb):
 
1095
    from bzrlib.weavefile import read_weave
 
1096
 
 
1097
    wf = file(weave_file, 'rb')
 
1098
    w = read_weave(wf)
 
1099
    # FIXME: doesn't work on pipes
 
1100
    weave_size = wf.tell()
 
1101
 
 
1102
    total = 0
 
1103
    vers = len(w)
 
1104
    for i in range(vers):
 
1105
        pb.update('checking sizes', i, vers)
 
1106
        for origin, lineno, line in w._extract([i]):
 
1107
            total += len(line)
 
1108
 
 
1109
    pb.clear()
 
1110
 
 
1111
    print 'versions          %9d' % vers
 
1112
    print 'weave file        %9d bytes' % weave_size
 
1113
    print 'total contents    %9d bytes' % total
 
1114
    print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
 
1115
    if vers:
 
1116
        avg = total/vers
 
1117
        print 'average size      %9d bytes' % avg
 
1118
        print 'relative size     %9.2fx' % (float(weave_size) / float(avg))
 
1119
 
 
1120
 
 
1121
def usage():
 
1122
    print """bzr weave tool
 
1123
 
 
1124
Experimental tool for weave algorithm.
 
1125
 
 
1126
usage:
 
1127
    weave init WEAVEFILE
 
1128
        Create an empty weave file
 
1129
    weave get WEAVEFILE VERSION
 
1130
        Write out specified version.
 
1131
    weave check WEAVEFILE
 
1132
        Check consistency of all versions.
 
1133
    weave toc WEAVEFILE
 
1134
        Display table of contents.
 
1135
    weave add WEAVEFILE NAME [BASE...] < NEWTEXT
 
1136
        Add NEWTEXT, with specified parent versions.
 
1137
    weave annotate WEAVEFILE VERSION
 
1138
        Display origin of each line.
 
1139
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
 
1140
        Auto-merge two versions and display conflicts.
 
1141
    weave diff WEAVEFILE VERSION1 VERSION2 
 
1142
        Show differences between two versions.
 
1143
 
 
1144
example:
 
1145
 
 
1146
    % weave init foo.weave
 
1147
    % vi foo.txt
 
1148
    % weave add foo.weave ver0 < foo.txt
 
1149
    added version 0
 
1150
 
 
1151
    (create updated version)
 
1152
    % vi foo.txt
 
1153
    % weave get foo.weave 0 | diff -u - foo.txt
 
1154
    % weave add foo.weave ver1 0 < foo.txt
 
1155
    added version 1
 
1156
 
 
1157
    % weave get foo.weave 0 > foo.txt       (create forked version)
 
1158
    % vi foo.txt
 
1159
    % weave add foo.weave ver2 0 < foo.txt
 
1160
    added version 2
 
1161
 
 
1162
    % weave merge foo.weave 1 2 > foo.txt   (merge them)
 
1163
    % vi foo.txt                            (resolve conflicts)
 
1164
    % weave add foo.weave merged 1 2 < foo.txt     (commit merged version)     
 
1165
    
 
1166
"""
 
1167
    
 
1168
 
 
1169
 
 
1170
def main(argv):
 
1171
    import sys
 
1172
    import os
 
1173
    try:
 
1174
        import bzrlib
 
1175
    except ImportError:
 
1176
        # in case we're run directly from the subdirectory
 
1177
        sys.path.append('..')
 
1178
        import bzrlib
 
1179
    from bzrlib.weavefile import write_weave, read_weave
 
1180
    from bzrlib.progress import ProgressBar
 
1181
 
 
1182
    try:
 
1183
        import psyco
 
1184
        psyco.full()
 
1185
    except ImportError:
 
1186
        pass
 
1187
 
 
1188
    if len(argv) < 2:
 
1189
        usage()
 
1190
        return 0
 
1191
 
 
1192
    cmd = argv[1]
 
1193
 
 
1194
    def readit():
 
1195
        return read_weave(file(argv[2], 'rb'))
 
1196
    
 
1197
    if cmd == 'help':
 
1198
        usage()
 
1199
    elif cmd == 'add':
 
1200
        w = readit()
 
1201
        # at the moment, based on everything in the file
 
1202
        name = argv[3]
 
1203
        parents = map(int, argv[4:])
 
1204
        lines = sys.stdin.readlines()
 
1205
        ver = w.add(name, parents, lines)
 
1206
        write_weave(w, file(argv[2], 'wb'))
 
1207
        print 'added version %r %d' % (name, ver)
 
1208
    elif cmd == 'init':
 
1209
        fn = argv[2]
 
1210
        if os.path.exists(fn):
 
1211
            raise IOError("file exists")
 
1212
        w = Weave()
 
1213
        write_weave(w, file(fn, 'wb'))
 
1214
    elif cmd == 'get': # get one version
 
1215
        w = readit()
 
1216
        sys.stdout.writelines(w.get_iter(int(argv[3])))
 
1217
        
 
1218
    elif cmd == 'diff':
 
1219
        w = readit()
 
1220
        fn = argv[2]
 
1221
        v1, v2 = map(int, argv[3:5])
 
1222
        lines1 = w.get(v1)
 
1223
        lines2 = w.get(v2)
 
1224
        diff_gen = bzrlib.patiencediff.unified_diff(lines1, lines2,
 
1225
                                '%s version %d' % (fn, v1),
 
1226
                                '%s version %d' % (fn, v2))
 
1227
        sys.stdout.writelines(diff_gen)
 
1228
            
 
1229
    elif cmd == 'annotate':
 
1230
        w = readit()
 
1231
        # newline is added to all lines regardless; too hard to get
 
1232
        # reasonable formatting otherwise
 
1233
        lasto = None
 
1234
        for origin, text in w.annotate(int(argv[3])):
 
1235
            text = text.rstrip('\r\n')
 
1236
            if origin == lasto:
 
1237
                print '      | %s' % (text)
 
1238
            else:
 
1239
                print '%5d | %s' % (origin, text)
 
1240
                lasto = origin
 
1241
                
 
1242
    elif cmd == 'toc':
 
1243
        weave_toc(readit())
 
1244
 
 
1245
    elif cmd == 'stats':
 
1246
        weave_stats(argv[2], ProgressBar())
 
1247
        
 
1248
    elif cmd == 'check':
 
1249
        w = readit()
 
1250
        pb = ProgressBar()
 
1251
        w.check(pb)
 
1252
        pb.clear()
 
1253
        print '%d versions ok' % w.num_versions()
 
1254
 
 
1255
    elif cmd == 'inclusions':
 
1256
        w = readit()
 
1257
        print ' '.join(map(str, w.inclusions([int(argv[3])])))
 
1258
 
 
1259
    elif cmd == 'parents':
 
1260
        w = readit()
 
1261
        print ' '.join(map(str, w._parents[int(argv[3])]))
 
1262
 
 
1263
    elif cmd == 'plan-merge':
 
1264
        # replaced by 'bzr weave-plan-merge'
 
1265
        w = readit()
 
1266
        for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
 
1267
            if line:
 
1268
                print '%14s | %s' % (state, line),
 
1269
    elif cmd == 'merge':
 
1270
        # replaced by 'bzr weave-merge-text'
 
1271
        w = readit()
 
1272
        p = w.plan_merge(int(argv[3]), int(argv[4]))
 
1273
        sys.stdout.writelines(w.weave_merge(p))
 
1274
    else:
 
1275
        raise ValueError('unknown command %r' % cmd)
 
1276
    
 
1277
 
 
1278
if __name__ == '__main__':
 
1279
    import sys
 
1280
    sys.exit(main(sys.argv))
 
1281
 
 
1282
 
 
1283
class InterWeave(InterVersionedFile):
 
1284
    """Optimised code paths for weave to weave operations."""
 
1285
    
 
1286
    _matching_file_from_factory = staticmethod(WeaveFile)
 
1287
    _matching_file_to_factory = staticmethod(WeaveFile)
 
1288
    
 
1289
    @staticmethod
 
1290
    def is_compatible(source, target):
 
1291
        """Be compatible with weaves."""
 
1292
        try:
 
1293
            return (isinstance(source, Weave) and
 
1294
                    isinstance(target, Weave))
 
1295
        except AttributeError:
 
1296
            return False
 
1297
 
 
1298
    def join(self, pb=None, msg=None, version_ids=None, ignore_missing=False):
 
1299
        """See InterVersionedFile.join."""
 
1300
        version_ids = self._get_source_version_ids(version_ids, ignore_missing)
 
1301
        if self.target.versions() == [] and version_ids is None:
 
1302
            self.target._copy_weave_content(self.source)
 
1303
            return
 
1304
        self.target._join(self.source, pb, msg, version_ids, ignore_missing)
 
1305
 
 
1306
 
 
1307
InterVersionedFile.register_optimiser(InterWeave)