/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

  • Committer: Andrew Bennetts
  • Date: 2010-04-13 04:33:55 UTC
  • mfrom: (5147 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5149.
  • Revision ID: andrew.bennetts@canonical.com-20100413043355-lg3id0uwtju0k3zs
Merge lp:bzr.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/weave.py
1
 
#! /usr/bin/python
2
 
 
3
 
# Copyright (C) 2005 Canonical Ltd
 
1
# Copyright (C) 2005, 2009 Canonical Ltd
4
2
#
5
3
# This program is free software; you can redistribute it and/or modify
6
4
# it under the terms of the GNU General Public License as published by
14
12
#
15
13
# You should have received a copy of the GNU General Public License
16
14
# along with this program; if not, write to the Free Software
17
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
16
 
19
17
# Author: Martin Pool <mbp@canonical.com>
20
18
 
61
59
# where the basis and destination are unchanged.
62
60
 
63
61
# FIXME: Sometimes we will be given a parents list for a revision
64
 
# that includes some redundant parents (i.e. already a parent of 
65
 
# something in the list.)  We should eliminate them.  This can 
 
62
# that includes some redundant parents (i.e. already a parent of
 
63
# something in the list.)  We should eliminate them.  This can
66
64
# be done fairly efficiently because the sequence numbers constrain
67
65
# the possible relationships.
68
66
 
79
77
from bzrlib import tsort
80
78
""")
81
79
from bzrlib import (
 
80
    errors,
 
81
    osutils,
82
82
    progress,
83
83
    )
84
84
from bzrlib.errors import (WeaveError, WeaveFormatError, WeaveParentMismatch,
88
88
        WeaveRevisionAlreadyPresent,
89
89
        WeaveRevisionNotPresent,
90
90
        )
91
 
import bzrlib.errors as errors
92
91
from bzrlib.osutils import dirname, sha, sha_strings, split_lines
93
92
import bzrlib.patiencediff
94
93
from bzrlib.revision import NULL_REVISION
98
97
    AbsentContentFactory,
99
98
    adapter_registry,
100
99
    ContentFactory,
 
100
    sort_groupcompress,
101
101
    VersionedFile,
102
102
    )
103
103
from bzrlib.weavefile import _read_weave_v5, write_weave_v5
122
122
    def get_bytes_as(self, storage_kind):
123
123
        if storage_kind == 'fulltext':
124
124
            return self._weave.get_text(self.key[-1])
 
125
        elif storage_kind == 'chunked':
 
126
            return self._weave.get_lines(self.key[-1])
125
127
        else:
126
128
            raise UnavailableRepresentation(self.key, storage_kind, 'fulltext')
127
129
 
128
130
 
129
131
class Weave(VersionedFile):
130
132
    """weave - versioned text file storage.
131
 
    
 
133
 
132
134
    A Weave manages versions of line-based text files, keeping track
133
135
    of the originating version for each line.
134
136
 
180
182
 
181
183
    * It doesn't seem very useful to have an active insertion
182
184
      inside an inactive insertion, but it might happen.
183
 
      
 
185
 
184
186
    * Therefore, all instructions are always"considered"; that
185
187
      is passed onto and off the stack.  An outer inactive block
186
188
      doesn't disable an inner block.
256
258
 
257
259
    def copy(self):
258
260
        """Return a deep copy of self.
259
 
        
 
261
 
260
262
        The copy can be modified without affecting the original weave."""
261
263
        other = Weave()
262
264
        other._weave = self._weave[:]
272
274
            return False
273
275
        return self._parents == other._parents \
274
276
               and self._weave == other._weave \
275
 
               and self._sha1s == other._sha1s 
276
 
    
 
277
               and self._sha1s == other._sha1s
 
278
 
277
279
    def __ne__(self, other):
278
280
        return not self.__eq__(other)
279
281
 
318
320
            new_versions = tsort.topo_sort(parents)
319
321
            new_versions.extend(set(versions).difference(set(parents)))
320
322
            versions = new_versions
 
323
        elif ordering == 'groupcompress':
 
324
            parents = self.get_parent_map(versions)
 
325
            new_versions = sort_groupcompress(parents)
 
326
            new_versions.extend(set(versions).difference(set(parents)))
 
327
            versions = new_versions
321
328
        for version in versions:
322
329
            if version in self:
323
330
                yield WeaveContentFactory(version, self)
346
353
    def insert_record_stream(self, stream):
347
354
        """Insert a record stream into this versioned file.
348
355
 
349
 
        :param stream: A stream of records to insert. 
 
356
        :param stream: A stream of records to insert.
350
357
        :return: None
351
358
        :seealso VersionedFile.get_record_stream:
352
359
        """
357
364
                raise RevisionNotPresent([record.key[0]], self)
358
365
            # adapt to non-tuple interface
359
366
            parents = [parent[0] for parent in record.parents]
360
 
            if record.storage_kind == 'fulltext':
 
367
            if (record.storage_kind == 'fulltext'
 
368
                or record.storage_kind == 'chunked'):
361
369
                self.add_lines(record.key[0], parents,
362
 
                    split_lines(record.get_bytes_as('fulltext')))
 
370
                    osutils.chunks_to_lines(record.get_bytes_as('chunked')))
363
371
            else:
364
372
                adapter_key = record.storage_kind, 'fulltext'
365
373
                try:
368
376
                    adapter_factory = adapter_registry.get(adapter_key)
369
377
                    adapter = adapter_factory(self)
370
378
                    adapters[adapter_key] = adapter
371
 
                lines = split_lines(adapter.get_bytes(
372
 
                    record, record.get_bytes_as(record.storage_kind)))
 
379
                lines = split_lines(adapter.get_bytes(record))
373
380
                try:
374
381
                    self.add_lines(record.key[0], parents, lines)
375
382
                except RevisionAlreadyPresent:
395
402
 
396
403
    def _add(self, version_id, lines, parents, sha1=None, nostore_sha=None):
397
404
        """Add a single text on top of the weave.
398
 
  
 
405
 
399
406
        Returns the index number of the newly added version.
400
407
 
401
408
        version_id
402
409
            Symbolic name for this version.
403
410
            (Typically the revision-id of the revision that added it.)
 
411
            If None, a name will be allocated based on the hash. (sha1:SHAHASH)
404
412
 
405
413
        parents
406
414
            List or set of direct parent version numbers.
407
 
            
 
415
 
408
416
        lines
409
417
            Sequence of lines to be added in the new version.
410
418
 
416
424
            sha1 = sha_strings(lines)
417
425
        if sha1 == nostore_sha:
418
426
            raise errors.ExistingContent
 
427
        if version_id is None:
 
428
            version_id = "sha1:" + sha1
419
429
        if version_id in self._name_map:
420
430
            return self._check_repeated_add(version_id, parents, lines, sha1)
421
431
 
432
442
        self._names.append(version_id)
433
443
        self._name_map[version_id] = new_version
434
444
 
435
 
            
 
445
 
436
446
        if not parents:
437
447
            # special case; adding with no parents revision; can do
438
448
            # this more quickly by just appending unconditionally.
449
459
            if sha1 == self._sha1s[pv]:
450
460
                # special case: same as the single parent
451
461
                return new_version
452
 
            
 
462
 
453
463
 
454
464
        ancestors = self._inclusions(parents)
455
465
 
504
514
                # i2; we want to insert after this region to make sure
505
515
                # we don't destroy ourselves
506
516
                i = i2 + offset
507
 
                self._weave[i:i] = ([('{', new_version)] 
508
 
                                    + lines[j1:j2] 
 
517
                self._weave[i:i] = ([('{', new_version)]
 
518
                                    + lines[j1:j2]
509
519
                                    + [('}', None)])
510
520
                offset += 2 + (j2 - j1)
511
521
        return new_version
538
548
            if not isinstance(l, basestring):
539
549
                raise ValueError("text line should be a string or unicode, not %s"
540
550
                                 % type(l))
541
 
        
 
551
 
542
552
 
543
553
 
544
554
    def _check_versions(self, indexes):
552
562
    def _compatible_parents(self, my_parents, other_parents):
553
563
        """During join check that other_parents are joinable with my_parents.
554
564
 
555
 
        Joinable is defined as 'is a subset of' - supersets may require 
 
565
        Joinable is defined as 'is a subset of' - supersets may require
556
566
        regeneration of diffs, but subsets do not.
557
567
        """
558
568
        return len(other_parents.difference(my_parents)) == 0
572
582
            version_ids = self.versions()
573
583
        version_ids = set(version_ids)
574
584
        for lineno, inserted, deletes, line in self._walk_internal(version_ids):
575
 
            # if inserted not in version_ids then it was inserted before the
576
 
            # versions we care about, but because weaves cannot represent ghosts
577
 
            # properly, we do not filter down to that
578
 
            # if inserted not in version_ids: continue
 
585
            if inserted not in version_ids: continue
579
586
            if line[-1] != '\n':
580
587
                yield line + '\n', inserted
581
588
            else:
583
590
 
584
591
    def _walk_internal(self, version_ids=None):
585
592
        """Helper method for weave actions."""
586
 
        
 
593
 
587
594
        istack = []
588
595
        dset = set()
589
596
 
670
677
        for i in versions:
671
678
            if not isinstance(i, int):
672
679
                raise ValueError(i)
673
 
            
 
680
 
674
681
        included = self._inclusions(versions)
675
682
 
676
683
        istack = []
685
692
 
686
693
        WFE = WeaveFormatError
687
694
 
688
 
        # wow. 
 
695
        # wow.
689
696
        #  449       0   4474.6820   2356.5590   bzrlib.weave:556(_extract)
690
697
        #  +285282   0   1676.8040   1676.8040   +<isinstance>
691
698
        # 1.6 seconds in 'isinstance'.
697
704
        # we're still spending ~1/4 of the method in isinstance though.
698
705
        # so lets hard code the acceptable string classes we expect:
699
706
        #  449       0   1202.9420    786.2930   bzrlib.weave:556(_extract)
700
 
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list' 
 
707
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list'
701
708
        #                                          objects>
702
709
        # yay, down to ~1/4 the initial extract time, and our inline time
703
710
        # has shrunk again, with isinstance no longer dominating.
704
711
        # tweaking the stack inclusion test to use a set gives:
705
712
        #  449       0   1122.8030    713.0080   bzrlib.weave:556(_extract)
706
 
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list' 
 
713
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list'
707
714
        #                                          objects>
708
715
        # - a 5% win, or possibly just noise. However with large istacks that
709
716
        # 'in' test could dominate, so I'm leaving this change in place -
710
717
        # when its fast enough to consider profiling big datasets we can review.
711
718
 
712
 
              
713
 
             
 
719
 
 
720
 
714
721
 
715
722
        for l in self._weave:
716
723
            if l.__class__ == tuple:
745
752
 
746
753
    def _maybe_lookup(self, name_or_index):
747
754
        """Convert possible symbolic name to index, or pass through indexes.
748
 
        
 
755
 
749
756
        NOT FOR PUBLIC USE.
750
757
        """
751
758
        if isinstance(name_or_index, (int, long)):
761
768
        measured_sha1 = sha_strings(result)
762
769
        if measured_sha1 != expected_sha1:
763
770
            raise errors.WeaveInvalidChecksum(
764
 
                    'file %s, revision %s, expected: %s, measured %s' 
 
771
                    'file %s, revision %s, expected: %s, measured %s'
765
772
                    % (self._weave_name, version_id,
766
773
                       expected_sha1, measured_sha1))
767
774
        return result
809
816
 
810
817
            if set(new_inc) != set(self.get_ancestry(name)):
811
818
                raise AssertionError(
812
 
                    'failed %s != %s' 
 
819
                    'failed %s != %s'
813
820
                    % (set(new_inc), set(self.get_ancestry(name))))
814
821
            inclusions[name] = new_inc
815
822
 
853
860
            parent_name = other._names[parent_idx]
854
861
            if parent_name not in self._name_map:
855
862
                # should not be possible
856
 
                raise WeaveError("missing parent {%s} of {%s} in %r" 
 
863
                raise WeaveError("missing parent {%s} of {%s} in %r"
857
864
                                 % (parent_name, other._name_map[other_idx], self))
858
865
            new_parents.append(self._name_map[parent_name])
859
866
        return new_parents
866
873
         * the same text
867
874
         * the same direct parents (by name, not index, and disregarding
868
875
           order)
869
 
        
 
876
 
870
877
        If present & correct return True;
871
 
        if not present in self return False; 
 
878
        if not present in self return False;
872
879
        if inconsistent raise error."""
873
880
        this_idx = self._name_map.get(name, -1)
874
881
        if this_idx != -1:
907
914
    """A WeaveFile represents a Weave on disk and writes on change."""
908
915
 
909
916
    WEAVE_SUFFIX = '.weave'
910
 
    
 
917
 
911
918
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w', get_scope=None):
912
919
        """Create a WeaveFile.
913
 
        
 
920
 
914
921
        :param create: If not True, only open an existing knit.
915
922
        """
916
923
        super(WeaveFile, self).__init__(name, access_mode, get_scope=get_scope,
966
973
        super(WeaveFile, self).insert_record_stream(stream)
967
974
        self._save()
968
975
 
969
 
    @deprecated_method(one_five)
970
 
    def join(self, other, pb=None, msg=None, version_ids=None,
971
 
             ignore_missing=False):
972
 
        """Join other into self and save."""
973
 
        super(WeaveFile, self).join(other, pb, msg, version_ids, ignore_missing)
974
 
        self._save()
975
 
 
976
976
 
977
977
def _reweave(wa, wb, pb=None, msg=None):
978
978
    """Combine two weaves and return the result.
979
979
 
980
 
    This works even if a revision R has different parents in 
 
980
    This works even if a revision R has different parents in
981
981
    wa and wb.  In the resulting weave all the parents are given.
982
982
 
983
 
    This is done by just building up a new weave, maintaining ordering 
 
983
    This is done by just building up a new weave, maintaining ordering
984
984
    of the versions in the two inputs.  More efficient approaches
985
 
    might be possible but it should only be necessary to do 
986
 
    this operation rarely, when a new previously ghost version is 
 
985
    might be possible but it should only be necessary to do
 
986
    this operation rarely, when a new previously ghost version is
987
987
    inserted.
988
988
 
989
989
    :param pb: An optional progress bar, indicating how far done we are
1023
1023
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
1024
1024
    return wr
1025
1025
 
 
1026
 
1026
1027
def _reweave_parent_graphs(wa, wb):
1027
1028
    """Return combined parent ancestry for two weaves.
1028
 
    
 
1029
 
1029
1030
    Returned as a list of (version_name, set(parent_names))"""
1030
1031
    combined = {}
1031
1032
    for weave in [wa, wb]:
1033
1034
            p = combined.setdefault(name, set())
1034
1035
            p.update(map(weave._idx_to_name, weave._parents[idx]))
1035
1036
    return combined
1036
 
 
1037
 
 
1038
 
def weave_toc(w):
1039
 
    """Show the weave's table-of-contents"""
1040
 
    print '%6s %50s %10s %10s' % ('ver', 'name', 'sha1', 'parents')
1041
 
    for i in (6, 50, 10, 10):
1042
 
        print '-' * i,
1043
 
    print
1044
 
    for i in range(w.num_versions()):
1045
 
        sha1 = w._sha1s[i]
1046
 
        name = w._names[i]
1047
 
        parent_str = ' '.join(map(str, w._parents[i]))
1048
 
        print '%6d %-50.50s %10.10s %s' % (i, name, sha1, parent_str)
1049
 
 
1050
 
 
1051
 
 
1052
 
def weave_stats(weave_file, pb):
1053
 
    from bzrlib.weavefile import read_weave
1054
 
 
1055
 
    wf = file(weave_file, 'rb')
1056
 
    w = read_weave(wf)
1057
 
    # FIXME: doesn't work on pipes
1058
 
    weave_size = wf.tell()
1059
 
 
1060
 
    total = 0
1061
 
    vers = len(w)
1062
 
    for i in range(vers):
1063
 
        pb.update('checking sizes', i, vers)
1064
 
        for origin, lineno, line in w._extract([i]):
1065
 
            total += len(line)
1066
 
 
1067
 
    pb.clear()
1068
 
 
1069
 
    print 'versions          %9d' % vers
1070
 
    print 'weave file        %9d bytes' % weave_size
1071
 
    print 'total contents    %9d bytes' % total
1072
 
    print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
1073
 
    if vers:
1074
 
        avg = total/vers
1075
 
        print 'average size      %9d bytes' % avg
1076
 
        print 'relative size     %9.2fx' % (float(weave_size) / float(avg))
1077
 
 
1078
 
 
1079
 
def usage():
1080
 
    print """bzr weave tool
1081
 
 
1082
 
Experimental tool for weave algorithm.
1083
 
 
1084
 
usage:
1085
 
    weave init WEAVEFILE
1086
 
        Create an empty weave file
1087
 
    weave get WEAVEFILE VERSION
1088
 
        Write out specified version.
1089
 
    weave check WEAVEFILE
1090
 
        Check consistency of all versions.
1091
 
    weave toc WEAVEFILE
1092
 
        Display table of contents.
1093
 
    weave add WEAVEFILE NAME [BASE...] < NEWTEXT
1094
 
        Add NEWTEXT, with specified parent versions.
1095
 
    weave annotate WEAVEFILE VERSION
1096
 
        Display origin of each line.
1097
 
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
1098
 
        Auto-merge two versions and display conflicts.
1099
 
    weave diff WEAVEFILE VERSION1 VERSION2 
1100
 
        Show differences between two versions.
1101
 
 
1102
 
example:
1103
 
 
1104
 
    % weave init foo.weave
1105
 
    % vi foo.txt
1106
 
    % weave add foo.weave ver0 < foo.txt
1107
 
    added version 0
1108
 
 
1109
 
    (create updated version)
1110
 
    % vi foo.txt
1111
 
    % weave get foo.weave 0 | diff -u - foo.txt
1112
 
    % weave add foo.weave ver1 0 < foo.txt
1113
 
    added version 1
1114
 
 
1115
 
    % weave get foo.weave 0 > foo.txt       (create forked version)
1116
 
    % vi foo.txt
1117
 
    % weave add foo.weave ver2 0 < foo.txt
1118
 
    added version 2
1119
 
 
1120
 
    % weave merge foo.weave 1 2 > foo.txt   (merge them)
1121
 
    % vi foo.txt                            (resolve conflicts)
1122
 
    % weave add foo.weave merged 1 2 < foo.txt     (commit merged version)     
1123
 
    
1124
 
"""
1125
 
    
1126
 
 
1127
 
 
1128
 
def main(argv):
1129
 
    import sys
1130
 
    import os
1131
 
    try:
1132
 
        import bzrlib
1133
 
    except ImportError:
1134
 
        # in case we're run directly from the subdirectory
1135
 
        sys.path.append('..')
1136
 
        import bzrlib
1137
 
    from bzrlib.weavefile import write_weave, read_weave
1138
 
    from bzrlib.progress import ProgressBar
1139
 
 
1140
 
    try:
1141
 
        import psyco
1142
 
        psyco.full()
1143
 
    except ImportError:
1144
 
        pass
1145
 
 
1146
 
    if len(argv) < 2:
1147
 
        usage()
1148
 
        return 0
1149
 
 
1150
 
    cmd = argv[1]
1151
 
 
1152
 
    def readit():
1153
 
        return read_weave(file(argv[2], 'rb'))
1154
 
    
1155
 
    if cmd == 'help':
1156
 
        usage()
1157
 
    elif cmd == 'add':
1158
 
        w = readit()
1159
 
        # at the moment, based on everything in the file
1160
 
        name = argv[3]
1161
 
        parents = map(int, argv[4:])
1162
 
        lines = sys.stdin.readlines()
1163
 
        ver = w.add(name, parents, lines)
1164
 
        write_weave(w, file(argv[2], 'wb'))
1165
 
        print 'added version %r %d' % (name, ver)
1166
 
    elif cmd == 'init':
1167
 
        fn = argv[2]
1168
 
        if os.path.exists(fn):
1169
 
            raise IOError("file exists")
1170
 
        w = Weave()
1171
 
        write_weave(w, file(fn, 'wb'))
1172
 
    elif cmd == 'get': # get one version
1173
 
        w = readit()
1174
 
        sys.stdout.writelines(w.get_iter(int(argv[3])))
1175
 
        
1176
 
    elif cmd == 'diff':
1177
 
        w = readit()
1178
 
        fn = argv[2]
1179
 
        v1, v2 = map(int, argv[3:5])
1180
 
        lines1 = w.get(v1)
1181
 
        lines2 = w.get(v2)
1182
 
        diff_gen = bzrlib.patiencediff.unified_diff(lines1, lines2,
1183
 
                                '%s version %d' % (fn, v1),
1184
 
                                '%s version %d' % (fn, v2))
1185
 
        sys.stdout.writelines(diff_gen)
1186
 
            
1187
 
    elif cmd == 'annotate':
1188
 
        w = readit()
1189
 
        # newline is added to all lines regardless; too hard to get
1190
 
        # reasonable formatting otherwise
1191
 
        lasto = None
1192
 
        for origin, text in w.annotate(int(argv[3])):
1193
 
            text = text.rstrip('\r\n')
1194
 
            if origin == lasto:
1195
 
                print '      | %s' % (text)
1196
 
            else:
1197
 
                print '%5d | %s' % (origin, text)
1198
 
                lasto = origin
1199
 
                
1200
 
    elif cmd == 'toc':
1201
 
        weave_toc(readit())
1202
 
 
1203
 
    elif cmd == 'stats':
1204
 
        weave_stats(argv[2], ProgressBar())
1205
 
        
1206
 
    elif cmd == 'check':
1207
 
        w = readit()
1208
 
        pb = ProgressBar()
1209
 
        w.check(pb)
1210
 
        pb.clear()
1211
 
        print '%d versions ok' % w.num_versions()
1212
 
 
1213
 
    elif cmd == 'inclusions':
1214
 
        w = readit()
1215
 
        print ' '.join(map(str, w.inclusions([int(argv[3])])))
1216
 
 
1217
 
    elif cmd == 'parents':
1218
 
        w = readit()
1219
 
        print ' '.join(map(str, w._parents[int(argv[3])]))
1220
 
 
1221
 
    elif cmd == 'plan-merge':
1222
 
        # replaced by 'bzr weave-plan-merge'
1223
 
        w = readit()
1224
 
        for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
1225
 
            if line:
1226
 
                print '%14s | %s' % (state, line),
1227
 
    elif cmd == 'merge':
1228
 
        # replaced by 'bzr weave-merge-text'
1229
 
        w = readit()
1230
 
        p = w.plan_merge(int(argv[3]), int(argv[4]))
1231
 
        sys.stdout.writelines(w.weave_merge(p))
1232
 
    else:
1233
 
        raise ValueError('unknown command %r' % cmd)
1234
 
    
1235
 
 
1236
 
if __name__ == '__main__':
1237
 
    import sys
1238
 
    sys.exit(main(sys.argv))