/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: Martin Pool
  • Date: 2008-04-02 01:46:35 UTC
  • mfrom: (3287.7.3 1.3)
  • mto: This revision was merged to the branch mainline in revision 3325.
  • Revision ID: mbp@sourcefrog.net-20080402014635-sgcp5cyfwsdjkgp1
Merge 1.3final back to trunk

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):
220
 
        """Create a weave.
221
 
 
222
 
        :param get_scope: A callable that returns an opaque object to be used
223
 
            for detecting when this weave goes out of scope (should stop
224
 
            answering requests or allowing mutation).
225
 
        """
226
 
        super(Weave, self).__init__()
 
186
                 '_weave_name', '_matcher']
 
187
    
 
188
    def __init__(self, weave_name=None, access_mode='w', matcher=None):
 
189
        super(Weave, self).__init__(access_mode)
227
190
        self._weave = []
228
191
        self._parents = []
229
192
        self._sha1s = []
234
197
            self._matcher = bzrlib.patiencediff.PatienceSequenceMatcher
235
198
        else:
236
199
            self._matcher = matcher
237
 
        if get_scope is None:
238
 
            get_scope = lambda:None
239
 
        self._get_scope = get_scope
240
 
        self._scope = get_scope()
241
 
        self._access_mode = access_mode
242
 
        self._allow_reserved = allow_reserved
243
200
 
244
201
    def __repr__(self):
245
202
        return "Weave(%r)" % self._weave_name
246
203
 
247
 
    def _check_write_ok(self):
248
 
        """Is the versioned file marked as 'finished' ? Raise if it is."""
249
 
        if self._get_scope() != self._scope:
250
 
            raise errors.OutSideTransaction()
251
 
        if self._access_mode != 'w':
252
 
            raise errors.ReadOnlyObjectDirtiedError(self)
253
 
 
254
204
    def copy(self):
255
205
        """Return a deep copy of self.
256
 
 
 
206
        
257
207
        The copy can be modified without affecting the original weave."""
258
208
        other = Weave()
259
209
        other._weave = self._weave[:]
269
219
            return False
270
220
        return self._parents == other._parents \
271
221
               and self._weave == other._weave \
272
 
               and self._sha1s == other._sha1s
273
 
 
 
222
               and self._sha1s == other._sha1s 
 
223
    
274
224
    def __ne__(self, other):
275
225
        return not self.__eq__(other)
276
226
 
279
229
 
280
230
    def _lookup(self, name):
281
231
        """Convert symbolic version name to index."""
282
 
        if not self._allow_reserved:
283
 
            self.check_not_reserved_id(name)
 
232
        self.check_not_reserved_id(name)
284
233
        try:
285
234
            return self._name_map[name]
286
235
        except KeyError:
296
245
 
297
246
    __contains__ = has_version
298
247
 
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
248
    def get_parent_map(self, version_ids):
330
249
        """See VersionedFile.get_parent_map."""
331
250
        result = {}
332
251
        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
 
252
            try:
 
253
                result[version_id] = tuple(
 
254
                    map(self._idx_to_name, self._parents[self._lookup(version_id)]))
 
255
            except RevisionNotPresent:
 
256
                pass
343
257
        return result
344
258
 
345
259
    def get_parents_with_ghosts(self, version_id):
346
260
        raise NotImplementedError(self.get_parents_with_ghosts)
347
261
 
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
262
    def _check_repeated_add(self, name, parents, text, sha1):
381
263
        """Check that a duplicated add is OK.
382
264
 
397
279
 
398
280
    def _add(self, version_id, lines, parents, sha1=None, nostore_sha=None):
399
281
        """Add a single text on top of the weave.
400
 
 
 
282
  
401
283
        Returns the index number of the newly added version.
402
284
 
403
285
        version_id
404
286
            Symbolic name for this version.
405
287
            (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
288
 
408
289
        parents
409
290
            List or set of direct parent version numbers.
410
 
 
 
291
            
411
292
        lines
412
293
            Sequence of lines to be added in the new version.
413
294
 
414
295
        :param nostore_sha: See VersionedFile.add_lines.
415
296
        """
 
297
        assert isinstance(version_id, basestring)
416
298
        self._check_lines_not_unicode(lines)
417
299
        self._check_lines_are_lines(lines)
418
300
        if not sha1:
419
301
            sha1 = sha_strings(lines)
420
302
        if sha1 == nostore_sha:
421
303
            raise errors.ExistingContent
422
 
        if version_id is None:
423
 
            version_id = "sha1:" + sha1
424
304
        if version_id in self._name_map:
425
305
            return self._check_repeated_add(version_id, parents, lines, sha1)
426
306
 
437
317
        self._names.append(version_id)
438
318
        self._name_map[version_id] = new_version
439
319
 
440
 
 
 
320
            
441
321
        if not parents:
442
322
            # special case; adding with no parents revision; can do
443
323
            # this more quickly by just appending unconditionally.
454
334
            if sha1 == self._sha1s[pv]:
455
335
                # special case: same as the single parent
456
336
                return new_version
457
 
 
 
337
            
458
338
 
459
339
        ancestors = self._inclusions(parents)
460
340
 
495
375
            #print 'raw match', tag, i1, i2, j1, j2
496
376
            if tag == 'equal':
497
377
                continue
 
378
 
498
379
            i1 = basis_lineno[i1]
499
380
            i2 = basis_lineno[i2]
 
381
 
 
382
            assert 0 <= j1 <= j2 <= len(lines)
 
383
 
 
384
            #print tag, i1, i2, j1, j2
 
385
 
500
386
            # the deletion and insertion are handled separately.
501
387
            # first delete the region.
502
388
            if i1 != i2:
509
395
                # i2; we want to insert after this region to make sure
510
396
                # we don't destroy ourselves
511
397
                i = i2 + offset
512
 
                self._weave[i:i] = ([('{', new_version)]
513
 
                                    + lines[j1:j2]
 
398
                self._weave[i:i] = ([('{', new_version)] 
 
399
                                    + lines[j1:j2] 
514
400
                                    + [('}', None)])
515
401
                offset += 2 + (j2 - j1)
516
402
        return new_version
517
403
 
 
404
    def _clone_text(self, new_version_id, old_version_id, parents):
 
405
        """See VersionedFile.clone_text."""
 
406
        old_lines = self.get_text(old_version_id)
 
407
        self.add_lines(new_version_id, parents, old_lines)
 
408
 
518
409
    def _inclusions(self, versions):
519
410
        """Return set of all ancestors of given version(s)."""
520
411
        if not len(versions):
543
434
            if not isinstance(l, basestring):
544
435
                raise ValueError("text line should be a string or unicode, not %s"
545
436
                                 % type(l))
546
 
 
 
437
        
547
438
 
548
439
 
549
440
    def _check_versions(self, indexes):
557
448
    def _compatible_parents(self, my_parents, other_parents):
558
449
        """During join check that other_parents are joinable with my_parents.
559
450
 
560
 
        Joinable is defined as 'is a subset of' - supersets may require
 
451
        Joinable is defined as 'is a subset of' - supersets may require 
561
452
        regeneration of diffs, but subsets do not.
562
453
        """
563
454
        return len(other_parents.difference(my_parents)) == 0
564
455
 
565
 
    def annotate(self, version_id):
566
 
        """Return a list of (version-id, line) tuples for version_id.
 
456
    def annotate_iter(self, version_id):
 
457
        """Yield list of (version-id, line) pairs for the specified version.
567
458
 
568
459
        The index indicates when the line originated in the weave."""
569
460
        incls = [self._lookup(version_id)]
570
 
        return [(self._idx_to_name(origin), text) for origin, lineno, text in
571
 
            self._extract(incls)]
 
461
        for origin, lineno, text in self._extract(incls):
 
462
            yield self._idx_to_name(origin), text
572
463
 
573
464
    def iter_lines_added_or_present_in_versions(self, version_ids=None,
574
465
                                                pb=None):
577
468
            version_ids = self.versions()
578
469
        version_ids = set(version_ids)
579
470
        for lineno, inserted, deletes, line in self._walk_internal(version_ids):
580
 
            if inserted not in version_ids: continue
 
471
            # if inserted not in version_ids then it was inserted before the
 
472
            # versions we care about, but because weaves cannot represent ghosts
 
473
            # properly, we do not filter down to that
 
474
            # if inserted not in version_ids: continue
581
475
            if line[-1] != '\n':
582
476
                yield line + '\n', inserted
583
477
            else:
585
479
 
586
480
    def _walk_internal(self, version_ids=None):
587
481
        """Helper method for weave actions."""
588
 
 
 
482
        
589
483
        istack = []
590
484
        dset = set()
591
485
 
600
494
                elif c == '}':
601
495
                    istack.pop()
602
496
                elif c == '[':
 
497
                    assert self._names[v] not in dset
603
498
                    dset.add(self._names[v])
604
499
                elif c == ']':
605
500
                    dset.remove(self._names[v])
606
501
                else:
607
502
                    raise WeaveFormatError('unexpected instruction %r' % v)
608
503
            else:
 
504
                assert l.__class__ in (str, unicode)
 
505
                assert istack
609
506
                yield lineno, istack[-1], frozenset(dset), l
610
507
            lineno += 1
611
508
 
660
557
                # not in either revision
661
558
                yield 'irrelevant', line
662
559
 
 
560
        yield 'unchanged', ''           # terminator
 
561
 
663
562
    def _extract(self, versions):
664
563
        """Yield annotation of lines in included set.
665
564
 
672
571
        for i in versions:
673
572
            if not isinstance(i, int):
674
573
                raise ValueError(i)
675
 
 
 
574
            
676
575
        included = self._inclusions(versions)
677
576
 
678
577
        istack = []
687
586
 
688
587
        WFE = WeaveFormatError
689
588
 
690
 
        # wow.
 
589
        # wow. 
691
590
        #  449       0   4474.6820   2356.5590   bzrlib.weave:556(_extract)
692
591
        #  +285282   0   1676.8040   1676.8040   +<isinstance>
693
592
        # 1.6 seconds in 'isinstance'.
699
598
        # we're still spending ~1/4 of the method in isinstance though.
700
599
        # so lets hard code the acceptable string classes we expect:
701
600
        #  449       0   1202.9420    786.2930   bzrlib.weave:556(_extract)
702
 
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list'
 
601
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list' 
703
602
        #                                          objects>
704
603
        # yay, down to ~1/4 the initial extract time, and our inline time
705
604
        # has shrunk again, with isinstance no longer dominating.
706
605
        # tweaking the stack inclusion test to use a set gives:
707
606
        #  449       0   1122.8030    713.0080   bzrlib.weave:556(_extract)
708
 
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list'
 
607
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list' 
709
608
        #                                          objects>
710
609
        # - a 5% win, or possibly just noise. However with large istacks that
711
610
        # 'in' test could dominate, so I'm leaving this change in place -
712
611
        # when its fast enough to consider profiling big datasets we can review.
713
612
 
714
 
 
715
 
 
 
613
              
 
614
             
716
615
 
717
616
        for l in self._weave:
718
617
            if l.__class__ == tuple:
719
618
                c, v = l
720
619
                isactive = None
721
620
                if c == '{':
 
621
                    assert v not in iset
722
622
                    istack.append(v)
723
623
                    iset.add(v)
724
624
                elif c == '}':
725
625
                    iset.remove(istack.pop())
726
626
                elif c == '[':
727
627
                    if v in included:
 
628
                        assert v not in dset
728
629
                        dset.add(v)
729
 
                elif c == ']':
 
630
                else:
 
631
                    assert c == ']'
730
632
                    if v in included:
 
633
                        assert v in dset
731
634
                        dset.remove(v)
732
 
                else:
733
 
                    raise AssertionError()
734
635
            else:
 
636
                assert l.__class__ in (str, unicode)
735
637
                if isactive is None:
736
638
                    isactive = (not dset) and istack and (istack[-1] in included)
737
639
                if isactive:
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
 
 
673
    def get_sha1(self, version_id):
 
674
        """See VersionedFile.get_sha1()."""
 
675
        return self._sha1s[self._lookup(version_id)]
 
676
 
771
677
    def get_sha1s(self, version_ids):
772
678
        """See VersionedFile.get_sha1s()."""
773
 
        result = {}
774
 
        for v in version_ids:
775
 
            result[v] = self._sha1s[self._lookup(v)]
776
 
        return result
 
679
        return [self._sha1s[self._lookup(v)] for v in version_ids]
777
680
 
778
681
    def num_versions(self):
779
682
        """How many versions are in this weave?"""
780
683
        l = len(self._parents)
 
684
        assert l == len(self._sha1s)
781
685
        return l
782
686
 
783
687
    __len__ = num_versions
803
707
            # For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
804
708
            # The problem is that set membership is much more expensive
805
709
            name = self._idx_to_name(i)
806
 
            sha1s[name] = sha()
 
710
            sha1s[name] = sha.new()
807
711
            texts[name] = []
808
712
            new_inc = set([name])
809
713
            for p in self._parents[i]:
810
714
                new_inc.update(inclusions[self._idx_to_name(p)])
811
715
 
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))))
 
716
            assert set(new_inc) == set(self.get_ancestry(name)), \
 
717
                'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
816
718
            inclusions[name] = new_inc
817
719
 
818
720
        nlines = len(self._weave)
848
750
        # no lines outside of insertion blocks, that deletions are
849
751
        # properly paired, etc.
850
752
 
 
753
    def _join(self, other, pb, msg, version_ids, ignore_missing):
 
754
        """Worker routine for join()."""
 
755
        if not other.versions():
 
756
            return          # nothing to update, easy
 
757
 
 
758
        if not version_ids:
 
759
            # versions is never none, InterWeave checks this.
 
760
            return 0
 
761
 
 
762
        # two loops so that we do not change ourselves before verifying it
 
763
        # will be ok
 
764
        # work through in index order to make sure we get all dependencies
 
765
        names_to_join = []
 
766
        processed = 0
 
767
        # get the selected versions only that are in other.versions.
 
768
        version_ids = set(other.versions()).intersection(set(version_ids))
 
769
        # pull in the referenced graph.
 
770
        version_ids = other.get_ancestry(version_ids)
 
771
        pending_parents = other.get_parent_map(version_ids)
 
772
        pending_graph = pending_parents.items()
 
773
        if len(pending_graph) != len(version_ids):
 
774
            raise RevisionNotPresent(
 
775
                set(version_ids) - set(pending_parents.keys()), self)
 
776
        for name in topo_sort(pending_graph):
 
777
            other_idx = other._name_map[name]
 
778
            # returns True if we have it, False if we need it.
 
779
            if not self._check_version_consistent(other, other_idx, name):
 
780
                names_to_join.append((other_idx, name))
 
781
            processed += 1
 
782
 
 
783
        if pb and not msg:
 
784
            msg = 'weave join'
 
785
 
 
786
        merged = 0
 
787
        time0 = time.time()
 
788
        for other_idx, name in names_to_join:
 
789
            # TODO: If all the parents of the other version are already
 
790
            # present then we can avoid some work by just taking the delta
 
791
            # and adjusting the offsets.
 
792
            new_parents = self._imported_parents(other, other_idx)
 
793
            sha1 = other._sha1s[other_idx]
 
794
 
 
795
            merged += 1
 
796
 
 
797
            if pb:
 
798
                pb.update(msg, merged, len(names_to_join))
 
799
           
 
800
            lines = other.get_lines(other_idx)
 
801
            self._add(name, lines, new_parents, sha1)
 
802
 
 
803
        mutter("merged = %d, processed = %d, file_id=%s; deltat=%d"%(
 
804
                merged, processed, self._weave_name, time.time()-time0))
 
805
 
851
806
    def _imported_parents(self, other, other_idx):
852
807
        """Return list of parents in self corresponding to indexes in other."""
853
808
        new_parents = []
855
810
            parent_name = other._names[parent_idx]
856
811
            if parent_name not in self._name_map:
857
812
                # should not be possible
858
 
                raise WeaveError("missing parent {%s} of {%s} in %r"
 
813
                raise WeaveError("missing parent {%s} of {%s} in %r" 
859
814
                                 % (parent_name, other._name_map[other_idx], self))
860
815
            new_parents.append(self._name_map[parent_name])
861
816
        return new_parents
868
823
         * the same text
869
824
         * the same direct parents (by name, not index, and disregarding
870
825
           order)
871
 
 
 
826
        
872
827
        If present & correct return True;
873
 
        if not present in self return False;
 
828
        if not present in self return False; 
874
829
        if inconsistent raise error."""
875
830
        this_idx = self._name_map.get(name, -1)
876
831
        if this_idx != -1:
909
864
    """A WeaveFile represents a Weave on disk and writes on change."""
910
865
 
911
866
    WEAVE_SUFFIX = '.weave'
912
 
 
913
 
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w', get_scope=None):
 
867
    
 
868
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w'):
914
869
        """Create a WeaveFile.
915
 
 
 
870
        
916
871
        :param create: If not True, only open an existing knit.
917
872
        """
918
 
        super(WeaveFile, self).__init__(name, access_mode, get_scope=get_scope,
919
 
            allow_reserved=False)
 
873
        super(WeaveFile, self).__init__(name, access_mode)
920
874
        self._transport = transport
921
875
        self._filemode = filemode
922
876
        try:
937
891
        self._save()
938
892
        return result
939
893
 
 
894
    def _clone_text(self, new_version_id, old_version_id, parents):
 
895
        """See VersionedFile.clone_text."""
 
896
        super(WeaveFile, self)._clone_text(new_version_id, old_version_id, parents)
 
897
        self._save
 
898
 
940
899
    def copy_to(self, name, transport):
941
900
        """See VersionedFile.copy_to()."""
942
901
        # as we are all in memory always, just serialise to the new place.
945
904
        sio.seek(0)
946
905
        transport.put_file(name + WeaveFile.WEAVE_SUFFIX, sio, self._filemode)
947
906
 
 
907
    def create_empty(self, name, transport, filemode=None):
 
908
        return WeaveFile(name, transport, filemode, create=True)
 
909
 
948
910
    def _save(self):
949
911
        """Save the weave."""
950
912
        self._check_write_ok()
951
913
        sio = StringIO()
952
914
        write_weave_v5(self, sio)
953
915
        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)
 
916
        self._transport.put_file(self._weave_name + WeaveFile.WEAVE_SUFFIX,
 
917
                                 sio,
 
918
                                 self._filemode)
961
919
 
962
920
    @staticmethod
963
921
    def get_suffixes():
964
922
        """See VersionedFile.get_suffixes()."""
965
923
        return [WeaveFile.WEAVE_SUFFIX]
966
924
 
967
 
    def insert_record_stream(self, stream):
968
 
        super(WeaveFile, self).insert_record_stream(stream)
 
925
    def join(self, other, pb=None, msg=None, version_ids=None,
 
926
             ignore_missing=False):
 
927
        """Join other into self and save."""
 
928
        super(WeaveFile, self).join(other, pb, msg, version_ids, ignore_missing)
969
929
        self._save()
970
930
 
971
931
 
972
932
def _reweave(wa, wb, pb=None, msg=None):
973
933
    """Combine two weaves and return the result.
974
934
 
975
 
    This works even if a revision R has different parents in
 
935
    This works even if a revision R has different parents in 
976
936
    wa and wb.  In the resulting weave all the parents are given.
977
937
 
978
 
    This is done by just building up a new weave, maintaining ordering
 
938
    This is done by just building up a new weave, maintaining ordering 
979
939
    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
 
940
    might be possible but it should only be necessary to do 
 
941
    this operation rarely, when a new previously ghost version is 
982
942
    inserted.
983
943
 
984
944
    :param pb: An optional progress bar, indicating how far done we are
992
952
    # map from version name -> all parent names
993
953
    combined_parents = _reweave_parent_graphs(wa, wb)
994
954
    mutter("combined parents: %r", combined_parents)
995
 
    order = tsort.topo_sort(combined_parents.iteritems())
 
955
    order = topo_sort(combined_parents.iteritems())
996
956
    mutter("order to reweave: %r", order)
997
957
 
998
958
    if pb and not msg:
1018
978
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
1019
979
    return wr
1020
980
 
1021
 
 
1022
981
def _reweave_parent_graphs(wa, wb):
1023
982
    """Return combined parent ancestry for two weaves.
1024
 
 
 
983
    
1025
984
    Returned as a list of (version_name, set(parent_names))"""
1026
985
    combined = {}
1027
986
    for weave in [wa, wb]:
1029
988
            p = combined.setdefault(name, set())
1030
989
            p.update(map(weave._idx_to_name, weave._parents[idx]))
1031
990
    return combined
 
991
 
 
992
 
 
993
def weave_toc(w):
 
994
    """Show the weave's table-of-contents"""
 
995
    print '%6s %50s %10s %10s' % ('ver', 'name', 'sha1', 'parents')
 
996
    for i in (6, 50, 10, 10):
 
997
        print '-' * i,
 
998
    print
 
999
    for i in range(w.num_versions()):
 
1000
        sha1 = w._sha1s[i]
 
1001
        name = w._names[i]
 
1002
        parent_str = ' '.join(map(str, w._parents[i]))
 
1003
        print '%6d %-50.50s %10.10s %s' % (i, name, sha1, parent_str)
 
1004
 
 
1005
 
 
1006
 
 
1007
def weave_stats(weave_file, pb):
 
1008
    from bzrlib.weavefile import read_weave
 
1009
 
 
1010
    wf = file(weave_file, 'rb')
 
1011
    w = read_weave(wf)
 
1012
    # FIXME: doesn't work on pipes
 
1013
    weave_size = wf.tell()
 
1014
 
 
1015
    total = 0
 
1016
    vers = len(w)
 
1017
    for i in range(vers):
 
1018
        pb.update('checking sizes', i, vers)
 
1019
        for origin, lineno, line in w._extract([i]):
 
1020
            total += len(line)
 
1021
 
 
1022
    pb.clear()
 
1023
 
 
1024
    print 'versions          %9d' % vers
 
1025
    print 'weave file        %9d bytes' % weave_size
 
1026
    print 'total contents    %9d bytes' % total
 
1027
    print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
 
1028
    if vers:
 
1029
        avg = total/vers
 
1030
        print 'average size      %9d bytes' % avg
 
1031
        print 'relative size     %9.2fx' % (float(weave_size) / float(avg))
 
1032
 
 
1033
 
 
1034
def usage():
 
1035
    print """bzr weave tool
 
1036
 
 
1037
Experimental tool for weave algorithm.
 
1038
 
 
1039
usage:
 
1040
    weave init WEAVEFILE
 
1041
        Create an empty weave file
 
1042
    weave get WEAVEFILE VERSION
 
1043
        Write out specified version.
 
1044
    weave check WEAVEFILE
 
1045
        Check consistency of all versions.
 
1046
    weave toc WEAVEFILE
 
1047
        Display table of contents.
 
1048
    weave add WEAVEFILE NAME [BASE...] < NEWTEXT
 
1049
        Add NEWTEXT, with specified parent versions.
 
1050
    weave annotate WEAVEFILE VERSION
 
1051
        Display origin of each line.
 
1052
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
 
1053
        Auto-merge two versions and display conflicts.
 
1054
    weave diff WEAVEFILE VERSION1 VERSION2 
 
1055
        Show differences between two versions.
 
1056
 
 
1057
example:
 
1058
 
 
1059
    % weave init foo.weave
 
1060
    % vi foo.txt
 
1061
    % weave add foo.weave ver0 < foo.txt
 
1062
    added version 0
 
1063
 
 
1064
    (create updated version)
 
1065
    % vi foo.txt
 
1066
    % weave get foo.weave 0 | diff -u - foo.txt
 
1067
    % weave add foo.weave ver1 0 < foo.txt
 
1068
    added version 1
 
1069
 
 
1070
    % weave get foo.weave 0 > foo.txt       (create forked version)
 
1071
    % vi foo.txt
 
1072
    % weave add foo.weave ver2 0 < foo.txt
 
1073
    added version 2
 
1074
 
 
1075
    % weave merge foo.weave 1 2 > foo.txt   (merge them)
 
1076
    % vi foo.txt                            (resolve conflicts)
 
1077
    % weave add foo.weave merged 1 2 < foo.txt     (commit merged version)     
 
1078
    
 
1079
"""
 
1080
    
 
1081
 
 
1082
 
 
1083
def main(argv):
 
1084
    import sys
 
1085
    import os
 
1086
    try:
 
1087
        import bzrlib
 
1088
    except ImportError:
 
1089
        # in case we're run directly from the subdirectory
 
1090
        sys.path.append('..')
 
1091
        import bzrlib
 
1092
    from bzrlib.weavefile import write_weave, read_weave
 
1093
    from bzrlib.progress import ProgressBar
 
1094
 
 
1095
    try:
 
1096
        import psyco
 
1097
        psyco.full()
 
1098
    except ImportError:
 
1099
        pass
 
1100
 
 
1101
    if len(argv) < 2:
 
1102
        usage()
 
1103
        return 0
 
1104
 
 
1105
    cmd = argv[1]
 
1106
 
 
1107
    def readit():
 
1108
        return read_weave(file(argv[2], 'rb'))
 
1109
    
 
1110
    if cmd == 'help':
 
1111
        usage()
 
1112
    elif cmd == 'add':
 
1113
        w = readit()
 
1114
        # at the moment, based on everything in the file
 
1115
        name = argv[3]
 
1116
        parents = map(int, argv[4:])
 
1117
        lines = sys.stdin.readlines()
 
1118
        ver = w.add(name, parents, lines)
 
1119
        write_weave(w, file(argv[2], 'wb'))
 
1120
        print 'added version %r %d' % (name, ver)
 
1121
    elif cmd == 'init':
 
1122
        fn = argv[2]
 
1123
        if os.path.exists(fn):
 
1124
            raise IOError("file exists")
 
1125
        w = Weave()
 
1126
        write_weave(w, file(fn, 'wb'))
 
1127
    elif cmd == 'get': # get one version
 
1128
        w = readit()
 
1129
        sys.stdout.writelines(w.get_iter(int(argv[3])))
 
1130
        
 
1131
    elif cmd == 'diff':
 
1132
        w = readit()
 
1133
        fn = argv[2]
 
1134
        v1, v2 = map(int, argv[3:5])
 
1135
        lines1 = w.get(v1)
 
1136
        lines2 = w.get(v2)
 
1137
        diff_gen = bzrlib.patiencediff.unified_diff(lines1, lines2,
 
1138
                                '%s version %d' % (fn, v1),
 
1139
                                '%s version %d' % (fn, v2))
 
1140
        sys.stdout.writelines(diff_gen)
 
1141
            
 
1142
    elif cmd == 'annotate':
 
1143
        w = readit()
 
1144
        # newline is added to all lines regardless; too hard to get
 
1145
        # reasonable formatting otherwise
 
1146
        lasto = None
 
1147
        for origin, text in w.annotate(int(argv[3])):
 
1148
            text = text.rstrip('\r\n')
 
1149
            if origin == lasto:
 
1150
                print '      | %s' % (text)
 
1151
            else:
 
1152
                print '%5d | %s' % (origin, text)
 
1153
                lasto = origin
 
1154
                
 
1155
    elif cmd == 'toc':
 
1156
        weave_toc(readit())
 
1157
 
 
1158
    elif cmd == 'stats':
 
1159
        weave_stats(argv[2], ProgressBar())
 
1160
        
 
1161
    elif cmd == 'check':
 
1162
        w = readit()
 
1163
        pb = ProgressBar()
 
1164
        w.check(pb)
 
1165
        pb.clear()
 
1166
        print '%d versions ok' % w.num_versions()
 
1167
 
 
1168
    elif cmd == 'inclusions':
 
1169
        w = readit()
 
1170
        print ' '.join(map(str, w.inclusions([int(argv[3])])))
 
1171
 
 
1172
    elif cmd == 'parents':
 
1173
        w = readit()
 
1174
        print ' '.join(map(str, w._parents[int(argv[3])]))
 
1175
 
 
1176
    elif cmd == 'plan-merge':
 
1177
        # replaced by 'bzr weave-plan-merge'
 
1178
        w = readit()
 
1179
        for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
 
1180
            if line:
 
1181
                print '%14s | %s' % (state, line),
 
1182
    elif cmd == 'merge':
 
1183
        # replaced by 'bzr weave-merge-text'
 
1184
        w = readit()
 
1185
        p = w.plan_merge(int(argv[3]), int(argv[4]))
 
1186
        sys.stdout.writelines(w.weave_merge(p))
 
1187
    else:
 
1188
        raise ValueError('unknown command %r' % cmd)
 
1189
    
 
1190
 
 
1191
if __name__ == '__main__':
 
1192
    import sys
 
1193
    sys.exit(main(sys.argv))
 
1194
 
 
1195
 
 
1196
class InterWeave(InterVersionedFile):
 
1197
    """Optimised code paths for weave to weave operations."""
 
1198
    
 
1199
    _matching_file_from_factory = staticmethod(WeaveFile)
 
1200
    _matching_file_to_factory = staticmethod(WeaveFile)
 
1201
    
 
1202
    @staticmethod
 
1203
    def is_compatible(source, target):
 
1204
        """Be compatible with weaves."""
 
1205
        try:
 
1206
            return (isinstance(source, Weave) and
 
1207
                    isinstance(target, Weave))
 
1208
        except AttributeError:
 
1209
            return False
 
1210
 
 
1211
    def join(self, pb=None, msg=None, version_ids=None, ignore_missing=False):
 
1212
        """See InterVersionedFile.join."""
 
1213
        version_ids = self._get_source_version_ids(version_ids, ignore_missing)
 
1214
        if self.target.versions() == [] and version_ids is None:
 
1215
            self.target._copy_weave_content(self.source)
 
1216
            return
 
1217
        self.target._join(self.source, pb, msg, version_ids, ignore_missing)
 
1218
 
 
1219
 
 
1220
InterVersionedFile.register_optimiser(InterWeave)