/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

Deprecate VersionedFile.join.

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