~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Martin Pool
  • Date: 2008-05-08 04:12:06 UTC
  • mto: This revision was merged to the branch mainline in revision 3415.
  • Revision ID: mbp@sourcefrog.net-20080508041206-tkrr8ucmcyrlzkum
Some review cleanups for assertion removal

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
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
 
419
318
            sha1 = sha_strings(lines)
420
319
        if sha1 == nostore_sha:
421
320
            raise errors.ExistingContent
422
 
        if version_id is None:
423
 
            version_id = "sha1:" + sha1
424
321
        if version_id in self._name_map:
425
322
            return self._check_repeated_add(version_id, parents, lines, sha1)
426
323
 
437
334
        self._names.append(version_id)
438
335
        self._name_map[version_id] = new_version
439
336
 
440
 
 
 
337
            
441
338
        if not parents:
442
339
            # special case; adding with no parents revision; can do
443
340
            # this more quickly by just appending unconditionally.
454
351
            if sha1 == self._sha1s[pv]:
455
352
                # special case: same as the single parent
456
353
                return new_version
457
 
 
 
354
            
458
355
 
459
356
        ancestors = self._inclusions(parents)
460
357
 
509
406
                # i2; we want to insert after this region to make sure
510
407
                # we don't destroy ourselves
511
408
                i = i2 + offset
512
 
                self._weave[i:i] = ([('{', new_version)]
513
 
                                    + lines[j1:j2]
 
409
                self._weave[i:i] = ([('{', new_version)] 
 
410
                                    + lines[j1:j2] 
514
411
                                    + [('}', None)])
515
412
                offset += 2 + (j2 - j1)
516
413
        return new_version
543
440
            if not isinstance(l, basestring):
544
441
                raise ValueError("text line should be a string or unicode, not %s"
545
442
                                 % type(l))
546
 
 
 
443
        
547
444
 
548
445
 
549
446
    def _check_versions(self, indexes):
557
454
    def _compatible_parents(self, my_parents, other_parents):
558
455
        """During join check that other_parents are joinable with my_parents.
559
456
 
560
 
        Joinable is defined as 'is a subset of' - supersets may require
 
457
        Joinable is defined as 'is a subset of' - supersets may require 
561
458
        regeneration of diffs, but subsets do not.
562
459
        """
563
460
        return len(other_parents.difference(my_parents)) == 0
577
474
            version_ids = self.versions()
578
475
        version_ids = set(version_ids)
579
476
        for lineno, inserted, deletes, line in self._walk_internal(version_ids):
580
 
            if inserted not in version_ids: continue
 
477
            # if inserted not in version_ids then it was inserted before the
 
478
            # versions we care about, but because weaves cannot represent ghosts
 
479
            # properly, we do not filter down to that
 
480
            # if inserted not in version_ids: continue
581
481
            if line[-1] != '\n':
582
482
                yield line + '\n', inserted
583
483
            else:
585
485
 
586
486
    def _walk_internal(self, version_ids=None):
587
487
        """Helper method for weave actions."""
588
 
 
 
488
        
589
489
        istack = []
590
490
        dset = set()
591
491
 
660
560
                # not in either revision
661
561
                yield 'irrelevant', line
662
562
 
 
563
        yield 'unchanged', ''           # terminator
 
564
 
663
565
    def _extract(self, versions):
664
566
        """Yield annotation of lines in included set.
665
567
 
672
574
        for i in versions:
673
575
            if not isinstance(i, int):
674
576
                raise ValueError(i)
675
 
 
 
577
            
676
578
        included = self._inclusions(versions)
677
579
 
678
580
        istack = []
687
589
 
688
590
        WFE = WeaveFormatError
689
591
 
690
 
        # wow.
 
592
        # wow. 
691
593
        #  449       0   4474.6820   2356.5590   bzrlib.weave:556(_extract)
692
594
        #  +285282   0   1676.8040   1676.8040   +<isinstance>
693
595
        # 1.6 seconds in 'isinstance'.
699
601
        # we're still spending ~1/4 of the method in isinstance though.
700
602
        # so lets hard code the acceptable string classes we expect:
701
603
        #  449       0   1202.9420    786.2930   bzrlib.weave:556(_extract)
702
 
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list'
 
604
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list' 
703
605
        #                                          objects>
704
606
        # yay, down to ~1/4 the initial extract time, and our inline time
705
607
        # has shrunk again, with isinstance no longer dominating.
706
608
        # tweaking the stack inclusion test to use a set gives:
707
609
        #  449       0   1122.8030    713.0080   bzrlib.weave:556(_extract)
708
 
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list'
 
610
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list' 
709
611
        #                                          objects>
710
612
        # - a 5% win, or possibly just noise. However with large istacks that
711
613
        # 'in' test could dominate, so I'm leaving this change in place -
712
614
        # when its fast enough to consider profiling big datasets we can review.
713
615
 
714
 
 
715
 
 
 
616
              
 
617
             
716
618
 
717
619
        for l in self._weave:
718
620
            if l.__class__ == tuple:
747
649
 
748
650
    def _maybe_lookup(self, name_or_index):
749
651
        """Convert possible symbolic name to index, or pass through indexes.
750
 
 
 
652
        
751
653
        NOT FOR PUBLIC USE.
752
654
        """
753
655
        if isinstance(name_or_index, (int, long)):
763
665
        measured_sha1 = sha_strings(result)
764
666
        if measured_sha1 != expected_sha1:
765
667
            raise errors.WeaveInvalidChecksum(
766
 
                    'file %s, revision %s, expected: %s, measured %s'
 
668
                    'file %s, revision %s, expected: %s, measured %s' 
767
669
                    % (self._weave_name, version_id,
768
670
                       expected_sha1, measured_sha1))
769
671
        return result
770
672
 
771
673
    def get_sha1s(self, version_ids):
772
674
        """See VersionedFile.get_sha1s()."""
773
 
        result = {}
774
 
        for v in version_ids:
775
 
            result[v] = self._sha1s[self._lookup(v)]
776
 
        return result
 
675
        return [self._sha1s[self._lookup(v)] for v in version_ids]
777
676
 
778
677
    def num_versions(self):
779
678
        """How many versions are in this weave?"""
803
702
            # For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
804
703
            # The problem is that set membership is much more expensive
805
704
            name = self._idx_to_name(i)
806
 
            sha1s[name] = sha()
 
705
            sha1s[name] = sha.new()
807
706
            texts[name] = []
808
707
            new_inc = set([name])
809
708
            for p in self._parents[i]:
811
710
 
812
711
            if set(new_inc) != set(self.get_ancestry(name)):
813
712
                raise AssertionError(
814
 
                    'failed %s != %s'
 
713
                    'failed %s != %s' 
815
714
                    % (set(new_inc), set(self.get_ancestry(name))))
816
715
            inclusions[name] = new_inc
817
716
 
848
747
        # no lines outside of insertion blocks, that deletions are
849
748
        # properly paired, etc.
850
749
 
 
750
    def _join(self, other, pb, msg, version_ids, ignore_missing):
 
751
        """Worker routine for join()."""
 
752
        if not other.versions():
 
753
            return          # nothing to update, easy
 
754
 
 
755
        if not version_ids:
 
756
            # versions is never none, InterWeave checks this.
 
757
            return 0
 
758
 
 
759
        # two loops so that we do not change ourselves before verifying it
 
760
        # will be ok
 
761
        # work through in index order to make sure we get all dependencies
 
762
        names_to_join = []
 
763
        processed = 0
 
764
        # get the selected versions only that are in other.versions.
 
765
        version_ids = set(other.versions()).intersection(set(version_ids))
 
766
        # pull in the referenced graph.
 
767
        version_ids = other.get_ancestry(version_ids)
 
768
        pending_parents = other.get_parent_map(version_ids)
 
769
        pending_graph = pending_parents.items()
 
770
        if len(pending_graph) != len(version_ids):
 
771
            raise RevisionNotPresent(
 
772
                set(version_ids) - set(pending_parents.keys()), self)
 
773
        for name in topo_sort(pending_graph):
 
774
            other_idx = other._name_map[name]
 
775
            # returns True if we have it, False if we need it.
 
776
            if not self._check_version_consistent(other, other_idx, name):
 
777
                names_to_join.append((other_idx, name))
 
778
            processed += 1
 
779
 
 
780
        if pb and not msg:
 
781
            msg = 'weave join'
 
782
 
 
783
        merged = 0
 
784
        time0 = time.time()
 
785
        for other_idx, name in names_to_join:
 
786
            # TODO: If all the parents of the other version are already
 
787
            # present then we can avoid some work by just taking the delta
 
788
            # and adjusting the offsets.
 
789
            new_parents = self._imported_parents(other, other_idx)
 
790
            sha1 = other._sha1s[other_idx]
 
791
 
 
792
            merged += 1
 
793
 
 
794
            if pb:
 
795
                pb.update(msg, merged, len(names_to_join))
 
796
           
 
797
            lines = other.get_lines(other_idx)
 
798
            self._add(name, lines, new_parents, sha1)
 
799
 
 
800
        mutter("merged = %d, processed = %d, file_id=%s; deltat=%d"%(
 
801
                merged, processed, self._weave_name, time.time()-time0))
 
802
 
851
803
    def _imported_parents(self, other, other_idx):
852
804
        """Return list of parents in self corresponding to indexes in other."""
853
805
        new_parents = []
855
807
            parent_name = other._names[parent_idx]
856
808
            if parent_name not in self._name_map:
857
809
                # should not be possible
858
 
                raise WeaveError("missing parent {%s} of {%s} in %r"
 
810
                raise WeaveError("missing parent {%s} of {%s} in %r" 
859
811
                                 % (parent_name, other._name_map[other_idx], self))
860
812
            new_parents.append(self._name_map[parent_name])
861
813
        return new_parents
868
820
         * the same text
869
821
         * the same direct parents (by name, not index, and disregarding
870
822
           order)
871
 
 
 
823
        
872
824
        If present & correct return True;
873
 
        if not present in self return False;
 
825
        if not present in self return False; 
874
826
        if inconsistent raise error."""
875
827
        this_idx = self._name_map.get(name, -1)
876
828
        if this_idx != -1:
909
861
    """A WeaveFile represents a Weave on disk and writes on change."""
910
862
 
911
863
    WEAVE_SUFFIX = '.weave'
912
 
 
 
864
    
913
865
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w', get_scope=None):
914
866
        """Create a WeaveFile.
915
 
 
 
867
        
916
868
        :param create: If not True, only open an existing knit.
917
869
        """
918
 
        super(WeaveFile, self).__init__(name, access_mode, get_scope=get_scope,
919
 
            allow_reserved=False)
 
870
        super(WeaveFile, self).__init__(name, access_mode, get_scope=get_scope)
920
871
        self._transport = transport
921
872
        self._filemode = filemode
922
873
        try:
951
902
        sio = StringIO()
952
903
        write_weave_v5(self, sio)
953
904
        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)
 
905
        self._transport.put_file(self._weave_name + WeaveFile.WEAVE_SUFFIX,
 
906
                                 sio,
 
907
                                 self._filemode)
961
908
 
962
909
    @staticmethod
963
910
    def get_suffixes():
964
911
        """See VersionedFile.get_suffixes()."""
965
912
        return [WeaveFile.WEAVE_SUFFIX]
966
913
 
967
 
    def insert_record_stream(self, stream):
968
 
        super(WeaveFile, self).insert_record_stream(stream)
 
914
    def join(self, other, pb=None, msg=None, version_ids=None,
 
915
             ignore_missing=False):
 
916
        """Join other into self and save."""
 
917
        super(WeaveFile, self).join(other, pb, msg, version_ids, ignore_missing)
969
918
        self._save()
970
919
 
971
920
 
972
921
def _reweave(wa, wb, pb=None, msg=None):
973
922
    """Combine two weaves and return the result.
974
923
 
975
 
    This works even if a revision R has different parents in
 
924
    This works even if a revision R has different parents in 
976
925
    wa and wb.  In the resulting weave all the parents are given.
977
926
 
978
 
    This is done by just building up a new weave, maintaining ordering
 
927
    This is done by just building up a new weave, maintaining ordering 
979
928
    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
 
929
    might be possible but it should only be necessary to do 
 
930
    this operation rarely, when a new previously ghost version is 
982
931
    inserted.
983
932
 
984
933
    :param pb: An optional progress bar, indicating how far done we are
992
941
    # map from version name -> all parent names
993
942
    combined_parents = _reweave_parent_graphs(wa, wb)
994
943
    mutter("combined parents: %r", combined_parents)
995
 
    order = tsort.topo_sort(combined_parents.iteritems())
 
944
    order = topo_sort(combined_parents.iteritems())
996
945
    mutter("order to reweave: %r", order)
997
946
 
998
947
    if pb and not msg:
1018
967
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
1019
968
    return wr
1020
969
 
1021
 
 
1022
970
def _reweave_parent_graphs(wa, wb):
1023
971
    """Return combined parent ancestry for two weaves.
1024
 
 
 
972
    
1025
973
    Returned as a list of (version_name, set(parent_names))"""
1026
974
    combined = {}
1027
975
    for weave in [wa, wb]:
1029
977
            p = combined.setdefault(name, set())
1030
978
            p.update(map(weave._idx_to_name, weave._parents[idx]))
1031
979
    return combined
 
980
 
 
981
 
 
982
def weave_toc(w):
 
983
    """Show the weave's table-of-contents"""
 
984
    print '%6s %50s %10s %10s' % ('ver', 'name', 'sha1', 'parents')
 
985
    for i in (6, 50, 10, 10):
 
986
        print '-' * i,
 
987
    print
 
988
    for i in range(w.num_versions()):
 
989
        sha1 = w._sha1s[i]
 
990
        name = w._names[i]
 
991
        parent_str = ' '.join(map(str, w._parents[i]))
 
992
        print '%6d %-50.50s %10.10s %s' % (i, name, sha1, parent_str)
 
993
 
 
994
 
 
995
 
 
996
def weave_stats(weave_file, pb):
 
997
    from bzrlib.weavefile import read_weave
 
998
 
 
999
    wf = file(weave_file, 'rb')
 
1000
    w = read_weave(wf)
 
1001
    # FIXME: doesn't work on pipes
 
1002
    weave_size = wf.tell()
 
1003
 
 
1004
    total = 0
 
1005
    vers = len(w)
 
1006
    for i in range(vers):
 
1007
        pb.update('checking sizes', i, vers)
 
1008
        for origin, lineno, line in w._extract([i]):
 
1009
            total += len(line)
 
1010
 
 
1011
    pb.clear()
 
1012
 
 
1013
    print 'versions          %9d' % vers
 
1014
    print 'weave file        %9d bytes' % weave_size
 
1015
    print 'total contents    %9d bytes' % total
 
1016
    print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
 
1017
    if vers:
 
1018
        avg = total/vers
 
1019
        print 'average size      %9d bytes' % avg
 
1020
        print 'relative size     %9.2fx' % (float(weave_size) / float(avg))
 
1021
 
 
1022
 
 
1023
def usage():
 
1024
    print """bzr weave tool
 
1025
 
 
1026
Experimental tool for weave algorithm.
 
1027
 
 
1028
usage:
 
1029
    weave init WEAVEFILE
 
1030
        Create an empty weave file
 
1031
    weave get WEAVEFILE VERSION
 
1032
        Write out specified version.
 
1033
    weave check WEAVEFILE
 
1034
        Check consistency of all versions.
 
1035
    weave toc WEAVEFILE
 
1036
        Display table of contents.
 
1037
    weave add WEAVEFILE NAME [BASE...] < NEWTEXT
 
1038
        Add NEWTEXT, with specified parent versions.
 
1039
    weave annotate WEAVEFILE VERSION
 
1040
        Display origin of each line.
 
1041
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
 
1042
        Auto-merge two versions and display conflicts.
 
1043
    weave diff WEAVEFILE VERSION1 VERSION2 
 
1044
        Show differences between two versions.
 
1045
 
 
1046
example:
 
1047
 
 
1048
    % weave init foo.weave
 
1049
    % vi foo.txt
 
1050
    % weave add foo.weave ver0 < foo.txt
 
1051
    added version 0
 
1052
 
 
1053
    (create updated version)
 
1054
    % vi foo.txt
 
1055
    % weave get foo.weave 0 | diff -u - foo.txt
 
1056
    % weave add foo.weave ver1 0 < foo.txt
 
1057
    added version 1
 
1058
 
 
1059
    % weave get foo.weave 0 > foo.txt       (create forked version)
 
1060
    % vi foo.txt
 
1061
    % weave add foo.weave ver2 0 < foo.txt
 
1062
    added version 2
 
1063
 
 
1064
    % weave merge foo.weave 1 2 > foo.txt   (merge them)
 
1065
    % vi foo.txt                            (resolve conflicts)
 
1066
    % weave add foo.weave merged 1 2 < foo.txt     (commit merged version)     
 
1067
    
 
1068
"""
 
1069
    
 
1070
 
 
1071
 
 
1072
def main(argv):
 
1073
    import sys
 
1074
    import os
 
1075
    try:
 
1076
        import bzrlib
 
1077
    except ImportError:
 
1078
        # in case we're run directly from the subdirectory
 
1079
        sys.path.append('..')
 
1080
        import bzrlib
 
1081
    from bzrlib.weavefile import write_weave, read_weave
 
1082
    from bzrlib.progress import ProgressBar
 
1083
 
 
1084
    try:
 
1085
        import psyco
 
1086
        psyco.full()
 
1087
    except ImportError:
 
1088
        pass
 
1089
 
 
1090
    if len(argv) < 2:
 
1091
        usage()
 
1092
        return 0
 
1093
 
 
1094
    cmd = argv[1]
 
1095
 
 
1096
    def readit():
 
1097
        return read_weave(file(argv[2], 'rb'))
 
1098
    
 
1099
    if cmd == 'help':
 
1100
        usage()
 
1101
    elif cmd == 'add':
 
1102
        w = readit()
 
1103
        # at the moment, based on everything in the file
 
1104
        name = argv[3]
 
1105
        parents = map(int, argv[4:])
 
1106
        lines = sys.stdin.readlines()
 
1107
        ver = w.add(name, parents, lines)
 
1108
        write_weave(w, file(argv[2], 'wb'))
 
1109
        print 'added version %r %d' % (name, ver)
 
1110
    elif cmd == 'init':
 
1111
        fn = argv[2]
 
1112
        if os.path.exists(fn):
 
1113
            raise IOError("file exists")
 
1114
        w = Weave()
 
1115
        write_weave(w, file(fn, 'wb'))
 
1116
    elif cmd == 'get': # get one version
 
1117
        w = readit()
 
1118
        sys.stdout.writelines(w.get_iter(int(argv[3])))
 
1119
        
 
1120
    elif cmd == 'diff':
 
1121
        w = readit()
 
1122
        fn = argv[2]
 
1123
        v1, v2 = map(int, argv[3:5])
 
1124
        lines1 = w.get(v1)
 
1125
        lines2 = w.get(v2)
 
1126
        diff_gen = bzrlib.patiencediff.unified_diff(lines1, lines2,
 
1127
                                '%s version %d' % (fn, v1),
 
1128
                                '%s version %d' % (fn, v2))
 
1129
        sys.stdout.writelines(diff_gen)
 
1130
            
 
1131
    elif cmd == 'annotate':
 
1132
        w = readit()
 
1133
        # newline is added to all lines regardless; too hard to get
 
1134
        # reasonable formatting otherwise
 
1135
        lasto = None
 
1136
        for origin, text in w.annotate(int(argv[3])):
 
1137
            text = text.rstrip('\r\n')
 
1138
            if origin == lasto:
 
1139
                print '      | %s' % (text)
 
1140
            else:
 
1141
                print '%5d | %s' % (origin, text)
 
1142
                lasto = origin
 
1143
                
 
1144
    elif cmd == 'toc':
 
1145
        weave_toc(readit())
 
1146
 
 
1147
    elif cmd == 'stats':
 
1148
        weave_stats(argv[2], ProgressBar())
 
1149
        
 
1150
    elif cmd == 'check':
 
1151
        w = readit()
 
1152
        pb = ProgressBar()
 
1153
        w.check(pb)
 
1154
        pb.clear()
 
1155
        print '%d versions ok' % w.num_versions()
 
1156
 
 
1157
    elif cmd == 'inclusions':
 
1158
        w = readit()
 
1159
        print ' '.join(map(str, w.inclusions([int(argv[3])])))
 
1160
 
 
1161
    elif cmd == 'parents':
 
1162
        w = readit()
 
1163
        print ' '.join(map(str, w._parents[int(argv[3])]))
 
1164
 
 
1165
    elif cmd == 'plan-merge':
 
1166
        # replaced by 'bzr weave-plan-merge'
 
1167
        w = readit()
 
1168
        for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
 
1169
            if line:
 
1170
                print '%14s | %s' % (state, line),
 
1171
    elif cmd == 'merge':
 
1172
        # replaced by 'bzr weave-merge-text'
 
1173
        w = readit()
 
1174
        p = w.plan_merge(int(argv[3]), int(argv[4]))
 
1175
        sys.stdout.writelines(w.weave_merge(p))
 
1176
    else:
 
1177
        raise ValueError('unknown command %r' % cmd)
 
1178
    
 
1179
 
 
1180
if __name__ == '__main__':
 
1181
    import sys
 
1182
    sys.exit(main(sys.argv))
 
1183
 
 
1184
 
 
1185
class InterWeave(InterVersionedFile):
 
1186
    """Optimised code paths for weave to weave operations."""
 
1187
    
 
1188
    _matching_file_from_factory = staticmethod(WeaveFile)
 
1189
    _matching_file_to_factory = staticmethod(WeaveFile)
 
1190
    
 
1191
    @staticmethod
 
1192
    def is_compatible(source, target):
 
1193
        """Be compatible with weaves."""
 
1194
        try:
 
1195
            return (isinstance(source, Weave) and
 
1196
                    isinstance(target, Weave))
 
1197
        except AttributeError:
 
1198
            return False
 
1199
 
 
1200
    def join(self, pb=None, msg=None, version_ids=None, ignore_missing=False):
 
1201
        """See InterVersionedFile.join."""
 
1202
        version_ids = self._get_source_version_ids(version_ids, ignore_missing)
 
1203
        if self.target.versions() == [] and version_ids is None:
 
1204
            self.target._copy_weave_content(self.source)
 
1205
            return
 
1206
        self.target._join(self.source, pb, msg, version_ids, ignore_missing)
 
1207
 
 
1208
 
 
1209
InterVersionedFile.register_optimiser(InterWeave)