← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Patch Queue Manager
  • Date: 2016-04-21 04:10:52 UTC
  • mfrom: (6616.1.1 fix-en-user-guide)
  • Revision ID: pqm@pqm.ubuntu.com-20160421041052-clcye7ns1qcl2n7w
(richard-wilbur) Ensure build of English use guide always uses English text
 even when user's locale specifies a different language. (Jelmer Vernooij)

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
 
21
 
 
22
19
"""Weave - storage of related text file versions"""
23
20
 
 
21
from __future__ import absolute_import
24
22
 
25
23
# XXX: If we do weaves this way, will a merge still behave the same
26
24
# way if it's done in a different order?  That's a pretty desirable
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
 
71
69
from copy import copy
72
70
from cStringIO import StringIO
73
71
import os
74
 
import sha
75
 
import time
76
 
import warnings
77
72
 
 
73
from bzrlib.lazy_import import lazy_import
 
74
lazy_import(globals(), """
 
75
from bzrlib import tsort
 
76
""")
78
77
from bzrlib import (
79
 
    progress,
 
78
    errors,
 
79
    osutils,
80
80
    )
81
 
from bzrlib.trace import mutter
82
81
from bzrlib.errors import (WeaveError, WeaveFormatError, WeaveParentMismatch,
83
82
        RevisionAlreadyPresent,
84
83
        RevisionNotPresent,
85
 
        WeaveRevisionAlreadyPresent,
86
 
        WeaveRevisionNotPresent,
 
84
        UnavailableRepresentation,
87
85
        )
88
 
import bzrlib.errors as errors
89
 
from bzrlib.osutils import sha_strings
 
86
from bzrlib.osutils import dirname, sha, sha_strings, split_lines
90
87
import bzrlib.patiencediff
91
 
from bzrlib.tsort import topo_sort
92
 
from bzrlib.versionedfile import VersionedFile, InterVersionedFile
 
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
    )
93
98
from bzrlib.weavefile import _read_weave_v5, write_weave_v5
94
99
 
95
100
 
 
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
 
96
126
class Weave(VersionedFile):
97
127
    """weave - versioned text file storage.
98
 
    
 
128
 
99
129
    A Weave manages versions of line-based text files, keeping track
100
130
    of the originating version for each line.
101
131
 
147
177
 
148
178
    * It doesn't seem very useful to have an active insertion
149
179
      inside an inactive insertion, but it might happen.
150
 
      
 
180
 
151
181
    * Therefore, all instructions are always"considered"; that
152
182
      is passed onto and off the stack.  An outer inactive block
153
183
      doesn't disable an inner block.
183
213
    """
184
214
 
185
215
    __slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map',
186
 
                 '_weave_name', '_matcher']
187
 
    
188
 
    def __init__(self, weave_name=None, access_mode='w', matcher=None):
189
 
        super(Weave, self).__init__(access_mode)
 
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__()
190
227
        self._weave = []
191
228
        self._parents = []
192
229
        self._sha1s = []
197
234
            self._matcher = bzrlib.patiencediff.PatienceSequenceMatcher
198
235
        else:
199
236
            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
200
243
 
201
244
    def __repr__(self):
202
245
        return "Weave(%r)" % self._weave_name
203
246
 
 
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
 
204
254
    def copy(self):
205
255
        """Return a deep copy of self.
206
 
        
 
256
 
207
257
        The copy can be modified without affecting the original weave."""
208
258
        other = Weave()
209
259
        other._weave = self._weave[:]
219
269
            return False
220
270
        return self._parents == other._parents \
221
271
               and self._weave == other._weave \
222
 
               and self._sha1s == other._sha1s 
223
 
    
 
272
               and self._sha1s == other._sha1s
 
273
 
224
274
    def __ne__(self, other):
225
275
        return not self.__eq__(other)
226
276
 
229
279
 
230
280
    def _lookup(self, name):
231
281
        """Convert symbolic version name to index."""
232
 
        self.check_not_reserved_id(name)
 
282
        if not self._allow_reserved:
 
283
            self.check_not_reserved_id(name)
233
284
        try:
234
285
            return self._name_map[name]
235
286
        except KeyError:
245
296
 
246
297
    __contains__ = has_version
247
298
 
248
 
    def get_parents(self, version_id):
249
 
        """See VersionedFile.get_parent."""
250
 
        return map(self._idx_to_name, self._parents[self._lookup(version_id)])
 
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
    def get_parent_map(self, version_ids):
 
330
        """See VersionedFile.get_parent_map."""
 
331
        result = {}
 
332
        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
 
343
        return result
 
344
 
 
345
    def get_parents_with_ghosts(self, version_id):
 
346
        raise NotImplementedError(self.get_parents_with_ghosts)
 
347
 
 
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
251
379
 
252
380
    def _check_repeated_add(self, name, parents, text, sha1):
253
381
        """Check that a duplicated add is OK.
269
397
 
270
398
    def _add(self, version_id, lines, parents, sha1=None, nostore_sha=None):
271
399
        """Add a single text on top of the weave.
272
 
  
 
400
 
273
401
        Returns the index number of the newly added version.
274
402
 
275
403
        version_id
276
404
            Symbolic name for this version.
277
405
            (Typically the revision-id of the revision that added it.)
 
406
            If None, a name will be allocated based on the hash. (sha1:SHAHASH)
278
407
 
279
408
        parents
280
409
            List or set of direct parent version numbers.
281
 
            
 
410
 
282
411
        lines
283
412
            Sequence of lines to be added in the new version.
284
413
 
285
414
        :param nostore_sha: See VersionedFile.add_lines.
286
415
        """
287
 
        assert isinstance(version_id, basestring)
288
416
        self._check_lines_not_unicode(lines)
289
417
        self._check_lines_are_lines(lines)
290
418
        if not sha1:
291
419
            sha1 = sha_strings(lines)
292
420
        if sha1 == nostore_sha:
293
421
            raise errors.ExistingContent
 
422
        if version_id is None:
 
423
            version_id = "sha1:" + sha1
294
424
        if version_id in self._name_map:
295
425
            return self._check_repeated_add(version_id, parents, lines, sha1)
296
426
 
307
437
        self._names.append(version_id)
308
438
        self._name_map[version_id] = new_version
309
439
 
310
 
            
 
440
 
311
441
        if not parents:
312
442
            # special case; adding with no parents revision; can do
313
443
            # this more quickly by just appending unconditionally.
324
454
            if sha1 == self._sha1s[pv]:
325
455
                # special case: same as the single parent
326
456
                return new_version
327
 
            
 
457
 
328
458
 
329
459
        ancestors = self._inclusions(parents)
330
460
 
365
495
            #print 'raw match', tag, i1, i2, j1, j2
366
496
            if tag == 'equal':
367
497
                continue
368
 
 
369
498
            i1 = basis_lineno[i1]
370
499
            i2 = basis_lineno[i2]
371
 
 
372
 
            assert 0 <= j1 <= j2 <= len(lines)
373
 
 
374
 
            #print tag, i1, i2, j1, j2
375
 
 
376
500
            # the deletion and insertion are handled separately.
377
501
            # first delete the region.
378
502
            if i1 != i2:
385
509
                # i2; we want to insert after this region to make sure
386
510
                # we don't destroy ourselves
387
511
                i = i2 + offset
388
 
                self._weave[i:i] = ([('{', new_version)] 
389
 
                                    + lines[j1:j2] 
 
512
                self._weave[i:i] = ([('{', new_version)]
 
513
                                    + lines[j1:j2]
390
514
                                    + [('}', None)])
391
515
                offset += 2 + (j2 - j1)
392
516
        return new_version
393
517
 
394
 
    def _clone_text(self, new_version_id, old_version_id, parents):
395
 
        """See VersionedFile.clone_text."""
396
 
        old_lines = self.get_text(old_version_id)
397
 
        self.add_lines(new_version_id, parents, old_lines)
398
 
 
399
518
    def _inclusions(self, versions):
400
519
        """Return set of all ancestors of given version(s)."""
401
520
        if not len(versions):
424
543
            if not isinstance(l, basestring):
425
544
                raise ValueError("text line should be a string or unicode, not %s"
426
545
                                 % type(l))
427
 
        
 
546
 
428
547
 
429
548
 
430
549
    def _check_versions(self, indexes):
438
557
    def _compatible_parents(self, my_parents, other_parents):
439
558
        """During join check that other_parents are joinable with my_parents.
440
559
 
441
 
        Joinable is defined as 'is a subset of' - supersets may require 
 
560
        Joinable is defined as 'is a subset of' - supersets may require
442
561
        regeneration of diffs, but subsets do not.
443
562
        """
444
563
        return len(other_parents.difference(my_parents)) == 0
445
564
 
446
 
    def annotate_iter(self, version_id):
447
 
        """Yield list of (version-id, line) pairs for the specified version.
 
565
    def annotate(self, version_id):
 
566
        """Return a list of (version-id, line) tuples for version_id.
448
567
 
449
568
        The index indicates when the line originated in the weave."""
450
569
        incls = [self._lookup(version_id)]
451
 
        for origin, lineno, text in self._extract(incls):
452
 
            yield self._idx_to_name(origin), text
 
570
        return [(self._idx_to_name(origin), text) for origin, lineno, text in
 
571
            self._extract(incls)]
453
572
 
454
573
    def iter_lines_added_or_present_in_versions(self, version_ids=None,
455
574
                                                pb=None):
458
577
            version_ids = self.versions()
459
578
        version_ids = set(version_ids)
460
579
        for lineno, inserted, deletes, line in self._walk_internal(version_ids):
461
 
            # if inserted not in version_ids then it was inserted before the
462
 
            # versions we care about, but because weaves cannot represent ghosts
463
 
            # properly, we do not filter down to that
464
 
            # if inserted not in version_ids: continue
 
580
            if inserted not in version_ids: continue
465
581
            if line[-1] != '\n':
466
582
                yield line + '\n', inserted
467
583
            else:
469
585
 
470
586
    def _walk_internal(self, version_ids=None):
471
587
        """Helper method for weave actions."""
472
 
        
 
588
 
473
589
        istack = []
474
590
        dset = set()
475
591
 
484
600
                elif c == '}':
485
601
                    istack.pop()
486
602
                elif c == '[':
487
 
                    assert self._names[v] not in dset
488
603
                    dset.add(self._names[v])
489
604
                elif c == ']':
490
605
                    dset.remove(self._names[v])
491
606
                else:
492
607
                    raise WeaveFormatError('unexpected instruction %r' % v)
493
608
            else:
494
 
                assert l.__class__ in (str, unicode)
495
 
                assert istack
496
609
                yield lineno, istack[-1], frozenset(dset), l
497
610
            lineno += 1
498
611
 
547
660
                # not in either revision
548
661
                yield 'irrelevant', line
549
662
 
550
 
        yield 'unchanged', ''           # terminator
551
 
 
552
663
    def _extract(self, versions):
553
664
        """Yield annotation of lines in included set.
554
665
 
561
672
        for i in versions:
562
673
            if not isinstance(i, int):
563
674
                raise ValueError(i)
564
 
            
 
675
 
565
676
        included = self._inclusions(versions)
566
677
 
567
678
        istack = []
576
687
 
577
688
        WFE = WeaveFormatError
578
689
 
579
 
        # wow. 
 
690
        # wow.
580
691
        #  449       0   4474.6820   2356.5590   bzrlib.weave:556(_extract)
581
692
        #  +285282   0   1676.8040   1676.8040   +<isinstance>
582
693
        # 1.6 seconds in 'isinstance'.
588
699
        # we're still spending ~1/4 of the method in isinstance though.
589
700
        # so lets hard code the acceptable string classes we expect:
590
701
        #  449       0   1202.9420    786.2930   bzrlib.weave:556(_extract)
591
 
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list' 
 
702
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list'
592
703
        #                                          objects>
593
704
        # yay, down to ~1/4 the initial extract time, and our inline time
594
705
        # has shrunk again, with isinstance no longer dominating.
595
706
        # tweaking the stack inclusion test to use a set gives:
596
707
        #  449       0   1122.8030    713.0080   bzrlib.weave:556(_extract)
597
 
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list' 
 
708
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list'
598
709
        #                                          objects>
599
710
        # - a 5% win, or possibly just noise. However with large istacks that
600
711
        # 'in' test could dominate, so I'm leaving this change in place -
601
712
        # when its fast enough to consider profiling big datasets we can review.
602
713
 
603
 
              
604
 
             
 
714
 
 
715
 
605
716
 
606
717
        for l in self._weave:
607
718
            if l.__class__ == tuple:
608
719
                c, v = l
609
720
                isactive = None
610
721
                if c == '{':
611
 
                    assert v not in iset
612
722
                    istack.append(v)
613
723
                    iset.add(v)
614
724
                elif c == '}':
615
725
                    iset.remove(istack.pop())
616
726
                elif c == '[':
617
727
                    if v in included:
618
 
                        assert v not in dset
619
728
                        dset.add(v)
620
 
                else:
621
 
                    assert c == ']'
 
729
                elif c == ']':
622
730
                    if v in included:
623
 
                        assert v in dset
624
731
                        dset.remove(v)
 
732
                else:
 
733
                    raise AssertionError()
625
734
            else:
626
 
                assert l.__class__ in (str, unicode)
627
735
                if isactive is None:
628
736
                    isactive = (not dset) and istack and (istack[-1] in included)
629
737
                if isactive:
639
747
 
640
748
    def _maybe_lookup(self, name_or_index):
641
749
        """Convert possible symbolic name to index, or pass through indexes.
642
 
        
 
750
 
643
751
        NOT FOR PUBLIC USE.
644
752
        """
645
753
        if isinstance(name_or_index, (int, long)):
655
763
        measured_sha1 = sha_strings(result)
656
764
        if measured_sha1 != expected_sha1:
657
765
            raise errors.WeaveInvalidChecksum(
658
 
                    'file %s, revision %s, expected: %s, measured %s' 
 
766
                    'file %s, revision %s, expected: %s, measured %s'
659
767
                    % (self._weave_name, version_id,
660
768
                       expected_sha1, measured_sha1))
661
769
        return result
662
770
 
663
 
    def get_sha1(self, version_id):
664
 
        """See VersionedFile.get_sha1()."""
665
 
        return self._sha1s[self._lookup(version_id)]
666
 
 
667
771
    def get_sha1s(self, version_ids):
668
772
        """See VersionedFile.get_sha1s()."""
669
 
        return [self._sha1s[self._lookup(v)] for v in version_ids]
 
773
        result = {}
 
774
        for v in version_ids:
 
775
            result[v] = self._sha1s[self._lookup(v)]
 
776
        return result
670
777
 
671
778
    def num_versions(self):
672
779
        """How many versions are in this weave?"""
673
780
        l = len(self._parents)
674
 
        assert l == len(self._sha1s)
675
781
        return l
676
782
 
677
783
    __len__ = num_versions
697
803
            # For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
698
804
            # The problem is that set membership is much more expensive
699
805
            name = self._idx_to_name(i)
700
 
            sha1s[name] = sha.new()
 
806
            sha1s[name] = sha()
701
807
            texts[name] = []
702
808
            new_inc = set([name])
703
809
            for p in self._parents[i]:
704
810
                new_inc.update(inclusions[self._idx_to_name(p)])
705
811
 
706
 
            assert set(new_inc) == set(self.get_ancestry(name)), \
707
 
                'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
 
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))))
708
816
            inclusions[name] = new_inc
709
817
 
710
818
        nlines = len(self._weave)
740
848
        # no lines outside of insertion blocks, that deletions are
741
849
        # properly paired, etc.
742
850
 
743
 
    def _join(self, other, pb, msg, version_ids, ignore_missing):
744
 
        """Worker routine for join()."""
745
 
        if not other.versions():
746
 
            return          # nothing to update, easy
747
 
 
748
 
        if not version_ids:
749
 
            # versions is never none, InterWeave checks this.
750
 
            return 0
751
 
 
752
 
        # two loops so that we do not change ourselves before verifying it
753
 
        # will be ok
754
 
        # work through in index order to make sure we get all dependencies
755
 
        names_to_join = []
756
 
        processed = 0
757
 
        # get the selected versions only that are in other.versions.
758
 
        version_ids = set(other.versions()).intersection(set(version_ids))
759
 
        # pull in the referenced graph.
760
 
        version_ids = other.get_ancestry(version_ids)
761
 
        pending_graph = [(version, other.get_parents(version)) for
762
 
                         version in version_ids]
763
 
        for name in topo_sort(pending_graph):
764
 
            other_idx = other._name_map[name]
765
 
            # returns True if we have it, False if we need it.
766
 
            if not self._check_version_consistent(other, other_idx, name):
767
 
                names_to_join.append((other_idx, name))
768
 
            processed += 1
769
 
 
770
 
 
771
 
        if pb and not msg:
772
 
            msg = 'weave join'
773
 
 
774
 
        merged = 0
775
 
        time0 = time.time()
776
 
        for other_idx, name in names_to_join:
777
 
            # TODO: If all the parents of the other version are already
778
 
            # present then we can avoid some work by just taking the delta
779
 
            # and adjusting the offsets.
780
 
            new_parents = self._imported_parents(other, other_idx)
781
 
            sha1 = other._sha1s[other_idx]
782
 
 
783
 
            merged += 1
784
 
 
785
 
            if pb:
786
 
                pb.update(msg, merged, len(names_to_join))
787
 
           
788
 
            lines = other.get_lines(other_idx)
789
 
            self._add(name, lines, new_parents, sha1)
790
 
 
791
 
        mutter("merged = %d, processed = %d, file_id=%s; deltat=%d"%(
792
 
                merged, processed, self._weave_name, time.time()-time0))
793
 
 
794
851
    def _imported_parents(self, other, other_idx):
795
852
        """Return list of parents in self corresponding to indexes in other."""
796
853
        new_parents = []
798
855
            parent_name = other._names[parent_idx]
799
856
            if parent_name not in self._name_map:
800
857
                # should not be possible
801
 
                raise WeaveError("missing parent {%s} of {%s} in %r" 
 
858
                raise WeaveError("missing parent {%s} of {%s} in %r"
802
859
                                 % (parent_name, other._name_map[other_idx], self))
803
860
            new_parents.append(self._name_map[parent_name])
804
861
        return new_parents
811
868
         * the same text
812
869
         * the same direct parents (by name, not index, and disregarding
813
870
           order)
814
 
        
 
871
 
815
872
        If present & correct return True;
816
 
        if not present in self return False; 
 
873
        if not present in self return False;
817
874
        if inconsistent raise error."""
818
875
        this_idx = self._name_map.get(name, -1)
819
876
        if this_idx != -1:
852
909
    """A WeaveFile represents a Weave on disk and writes on change."""
853
910
 
854
911
    WEAVE_SUFFIX = '.weave'
855
 
    
856
 
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w'):
 
912
 
 
913
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w', get_scope=None):
857
914
        """Create a WeaveFile.
858
 
        
 
915
 
859
916
        :param create: If not True, only open an existing knit.
860
917
        """
861
 
        super(WeaveFile, self).__init__(name, access_mode)
 
918
        super(WeaveFile, self).__init__(name, access_mode, get_scope=get_scope,
 
919
            allow_reserved=False)
862
920
        self._transport = transport
863
921
        self._filemode = filemode
864
922
        try:
865
 
            _read_weave_v5(self._transport.get(name + WeaveFile.WEAVE_SUFFIX), self)
 
923
            f = self._transport.get(name + WeaveFile.WEAVE_SUFFIX)
 
924
            _read_weave_v5(StringIO(f.read()), self)
866
925
        except errors.NoSuchFile:
867
926
            if not create:
868
927
                raise
879
938
        self._save()
880
939
        return result
881
940
 
882
 
    def _clone_text(self, new_version_id, old_version_id, parents):
883
 
        """See VersionedFile.clone_text."""
884
 
        super(WeaveFile, self)._clone_text(new_version_id, old_version_id, parents)
885
 
        self._save
886
 
 
887
941
    def copy_to(self, name, transport):
888
942
        """See VersionedFile.copy_to()."""
889
943
        # as we are all in memory always, just serialise to the new place.
892
946
        sio.seek(0)
893
947
        transport.put_file(name + WeaveFile.WEAVE_SUFFIX, sio, self._filemode)
894
948
 
895
 
    def create_empty(self, name, transport, filemode=None):
896
 
        return WeaveFile(name, transport, filemode, create=True)
897
 
 
898
949
    def _save(self):
899
950
        """Save the weave."""
900
951
        self._check_write_ok()
901
952
        sio = StringIO()
902
953
        write_weave_v5(self, sio)
903
954
        sio.seek(0)
904
 
        self._transport.put_file(self._weave_name + WeaveFile.WEAVE_SUFFIX,
905
 
                                 sio,
906
 
                                 self._filemode)
 
955
        bytes = sio.getvalue()
 
956
        path = self._weave_name + WeaveFile.WEAVE_SUFFIX
 
957
        try:
 
958
            self._transport.put_bytes(path, bytes, self._filemode)
 
959
        except errors.NoSuchFile:
 
960
            self._transport.mkdir(dirname(path))
 
961
            self._transport.put_bytes(path, bytes, self._filemode)
907
962
 
908
963
    @staticmethod
909
964
    def get_suffixes():
910
965
        """See VersionedFile.get_suffixes()."""
911
966
        return [WeaveFile.WEAVE_SUFFIX]
912
967
 
913
 
    def join(self, other, pb=None, msg=None, version_ids=None,
914
 
             ignore_missing=False):
915
 
        """Join other into self and save."""
916
 
        super(WeaveFile, self).join(other, pb, msg, version_ids, ignore_missing)
 
968
    def insert_record_stream(self, stream):
 
969
        super(WeaveFile, self).insert_record_stream(stream)
917
970
        self._save()
918
971
 
919
972
 
920
973
def _reweave(wa, wb, pb=None, msg=None):
921
974
    """Combine two weaves and return the result.
922
975
 
923
 
    This works even if a revision R has different parents in 
 
976
    This works even if a revision R has different parents in
924
977
    wa and wb.  In the resulting weave all the parents are given.
925
978
 
926
 
    This is done by just building up a new weave, maintaining ordering 
 
979
    This is done by just building up a new weave, maintaining ordering
927
980
    of the versions in the two inputs.  More efficient approaches
928
 
    might be possible but it should only be necessary to do 
929
 
    this operation rarely, when a new previously ghost version is 
 
981
    might be possible but it should only be necessary to do
 
982
    this operation rarely, when a new previously ghost version is
930
983
    inserted.
931
984
 
932
985
    :param pb: An optional progress bar, indicating how far done we are
940
993
    # map from version name -> all parent names
941
994
    combined_parents = _reweave_parent_graphs(wa, wb)
942
995
    mutter("combined parents: %r", combined_parents)
943
 
    order = topo_sort(combined_parents.iteritems())
 
996
    order = tsort.topo_sort(combined_parents.iteritems())
944
997
    mutter("order to reweave: %r", order)
945
998
 
946
999
    if pb and not msg:
966
1019
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
967
1020
    return wr
968
1021
 
 
1022
 
969
1023
def _reweave_parent_graphs(wa, wb):
970
1024
    """Return combined parent ancestry for two weaves.
971
 
    
 
1025
 
972
1026
    Returned as a list of (version_name, set(parent_names))"""
973
1027
    combined = {}
974
1028
    for weave in [wa, wb]:
976
1030
            p = combined.setdefault(name, set())
977
1031
            p.update(map(weave._idx_to_name, weave._parents[idx]))
978
1032
    return combined
979
 
 
980
 
 
981
 
def weave_toc(w):
982
 
    """Show the weave's table-of-contents"""
983
 
    print '%6s %50s %10s %10s' % ('ver', 'name', 'sha1', 'parents')
984
 
    for i in (6, 50, 10, 10):
985
 
        print '-' * i,
986
 
    print
987
 
    for i in range(w.num_versions()):
988
 
        sha1 = w._sha1s[i]
989
 
        name = w._names[i]
990
 
        parent_str = ' '.join(map(str, w._parents[i]))
991
 
        print '%6d %-50.50s %10.10s %s' % (i, name, sha1, parent_str)
992
 
 
993
 
 
994
 
 
995
 
def weave_stats(weave_file, pb):
996
 
    from bzrlib.weavefile import read_weave
997
 
 
998
 
    wf = file(weave_file, 'rb')
999
 
    w = read_weave(wf)
1000
 
    # FIXME: doesn't work on pipes
1001
 
    weave_size = wf.tell()
1002
 
 
1003
 
    total = 0
1004
 
    vers = len(w)
1005
 
    for i in range(vers):
1006
 
        pb.update('checking sizes', i, vers)
1007
 
        for origin, lineno, line in w._extract([i]):
1008
 
            total += len(line)
1009
 
 
1010
 
    pb.clear()
1011
 
 
1012
 
    print 'versions          %9d' % vers
1013
 
    print 'weave file        %9d bytes' % weave_size
1014
 
    print 'total contents    %9d bytes' % total
1015
 
    print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
1016
 
    if vers:
1017
 
        avg = total/vers
1018
 
        print 'average size      %9d bytes' % avg
1019
 
        print 'relative size     %9.2fx' % (float(weave_size) / float(avg))
1020
 
 
1021
 
 
1022
 
def usage():
1023
 
    print """bzr weave tool
1024
 
 
1025
 
Experimental tool for weave algorithm.
1026
 
 
1027
 
usage:
1028
 
    weave init WEAVEFILE
1029
 
        Create an empty weave file
1030
 
    weave get WEAVEFILE VERSION
1031
 
        Write out specified version.
1032
 
    weave check WEAVEFILE
1033
 
        Check consistency of all versions.
1034
 
    weave toc WEAVEFILE
1035
 
        Display table of contents.
1036
 
    weave add WEAVEFILE NAME [BASE...] < NEWTEXT
1037
 
        Add NEWTEXT, with specified parent versions.
1038
 
    weave annotate WEAVEFILE VERSION
1039
 
        Display origin of each line.
1040
 
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
1041
 
        Auto-merge two versions and display conflicts.
1042
 
    weave diff WEAVEFILE VERSION1 VERSION2 
1043
 
        Show differences between two versions.
1044
 
 
1045
 
example:
1046
 
 
1047
 
    % weave init foo.weave
1048
 
    % vi foo.txt
1049
 
    % weave add foo.weave ver0 < foo.txt
1050
 
    added version 0
1051
 
 
1052
 
    (create updated version)
1053
 
    % vi foo.txt
1054
 
    % weave get foo.weave 0 | diff -u - foo.txt
1055
 
    % weave add foo.weave ver1 0 < foo.txt
1056
 
    added version 1
1057
 
 
1058
 
    % weave get foo.weave 0 > foo.txt       (create forked version)
1059
 
    % vi foo.txt
1060
 
    % weave add foo.weave ver2 0 < foo.txt
1061
 
    added version 2
1062
 
 
1063
 
    % weave merge foo.weave 1 2 > foo.txt   (merge them)
1064
 
    % vi foo.txt                            (resolve conflicts)
1065
 
    % weave add foo.weave merged 1 2 < foo.txt     (commit merged version)     
1066
 
    
1067
 
"""
1068
 
    
1069
 
 
1070
 
 
1071
 
def main(argv):
1072
 
    import sys
1073
 
    import os
1074
 
    try:
1075
 
        import bzrlib
1076
 
    except ImportError:
1077
 
        # in case we're run directly from the subdirectory
1078
 
        sys.path.append('..')
1079
 
        import bzrlib
1080
 
    from bzrlib.weavefile import write_weave, read_weave
1081
 
    from bzrlib.progress import ProgressBar
1082
 
 
1083
 
    try:
1084
 
        import psyco
1085
 
        psyco.full()
1086
 
    except ImportError:
1087
 
        pass
1088
 
 
1089
 
    if len(argv) < 2:
1090
 
        usage()
1091
 
        return 0
1092
 
 
1093
 
    cmd = argv[1]
1094
 
 
1095
 
    def readit():
1096
 
        return read_weave(file(argv[2], 'rb'))
1097
 
    
1098
 
    if cmd == 'help':
1099
 
        usage()
1100
 
    elif cmd == 'add':
1101
 
        w = readit()
1102
 
        # at the moment, based on everything in the file
1103
 
        name = argv[3]
1104
 
        parents = map(int, argv[4:])
1105
 
        lines = sys.stdin.readlines()
1106
 
        ver = w.add(name, parents, lines)
1107
 
        write_weave(w, file(argv[2], 'wb'))
1108
 
        print 'added version %r %d' % (name, ver)
1109
 
    elif cmd == 'init':
1110
 
        fn = argv[2]
1111
 
        if os.path.exists(fn):
1112
 
            raise IOError("file exists")
1113
 
        w = Weave()
1114
 
        write_weave(w, file(fn, 'wb'))
1115
 
    elif cmd == 'get': # get one version
1116
 
        w = readit()
1117
 
        sys.stdout.writelines(w.get_iter(int(argv[3])))
1118
 
        
1119
 
    elif cmd == 'diff':
1120
 
        w = readit()
1121
 
        fn = argv[2]
1122
 
        v1, v2 = map(int, argv[3:5])
1123
 
        lines1 = w.get(v1)
1124
 
        lines2 = w.get(v2)
1125
 
        diff_gen = bzrlib.patiencediff.unified_diff(lines1, lines2,
1126
 
                                '%s version %d' % (fn, v1),
1127
 
                                '%s version %d' % (fn, v2))
1128
 
        sys.stdout.writelines(diff_gen)
1129
 
            
1130
 
    elif cmd == 'annotate':
1131
 
        w = readit()
1132
 
        # newline is added to all lines regardless; too hard to get
1133
 
        # reasonable formatting otherwise
1134
 
        lasto = None
1135
 
        for origin, text in w.annotate(int(argv[3])):
1136
 
            text = text.rstrip('\r\n')
1137
 
            if origin == lasto:
1138
 
                print '      | %s' % (text)
1139
 
            else:
1140
 
                print '%5d | %s' % (origin, text)
1141
 
                lasto = origin
1142
 
                
1143
 
    elif cmd == 'toc':
1144
 
        weave_toc(readit())
1145
 
 
1146
 
    elif cmd == 'stats':
1147
 
        weave_stats(argv[2], ProgressBar())
1148
 
        
1149
 
    elif cmd == 'check':
1150
 
        w = readit()
1151
 
        pb = ProgressBar()
1152
 
        w.check(pb)
1153
 
        pb.clear()
1154
 
        print '%d versions ok' % w.num_versions()
1155
 
 
1156
 
    elif cmd == 'inclusions':
1157
 
        w = readit()
1158
 
        print ' '.join(map(str, w.inclusions([int(argv[3])])))
1159
 
 
1160
 
    elif cmd == 'parents':
1161
 
        w = readit()
1162
 
        print ' '.join(map(str, w._parents[int(argv[3])]))
1163
 
 
1164
 
    elif cmd == 'plan-merge':
1165
 
        # replaced by 'bzr weave-plan-merge'
1166
 
        w = readit()
1167
 
        for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
1168
 
            if line:
1169
 
                print '%14s | %s' % (state, line),
1170
 
    elif cmd == 'merge':
1171
 
        # replaced by 'bzr weave-merge-text'
1172
 
        w = readit()
1173
 
        p = w.plan_merge(int(argv[3]), int(argv[4]))
1174
 
        sys.stdout.writelines(w.weave_merge(p))
1175
 
    else:
1176
 
        raise ValueError('unknown command %r' % cmd)
1177
 
    
1178
 
 
1179
 
if __name__ == '__main__':
1180
 
    import sys
1181
 
    sys.exit(main(sys.argv))
1182
 
 
1183
 
 
1184
 
class InterWeave(InterVersionedFile):
1185
 
    """Optimised code paths for weave to weave operations."""
1186
 
    
1187
 
    _matching_file_from_factory = staticmethod(WeaveFile)
1188
 
    _matching_file_to_factory = staticmethod(WeaveFile)
1189
 
    
1190
 
    @staticmethod
1191
 
    def is_compatible(source, target):
1192
 
        """Be compatible with weaves."""
1193
 
        try:
1194
 
            return (isinstance(source, Weave) and
1195
 
                    isinstance(target, Weave))
1196
 
        except AttributeError:
1197
 
            return False
1198
 
 
1199
 
    def join(self, pb=None, msg=None, version_ids=None, ignore_missing=False):
1200
 
        """See InterVersionedFile.join."""
1201
 
        version_ids = self._get_source_version_ids(version_ids, ignore_missing)
1202
 
        if self.target.versions() == [] and version_ids is None:
1203
 
            self.target._copy_weave_content(self.source)
1204
 
            return
1205
 
        self.target._join(self.source, pb, msg, version_ids, ignore_missing)
1206
 
 
1207
 
 
1208
 
InterVersionedFile.register_optimiser(InterWeave)