~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Robert Collins
  • Date: 2005-10-10 23:18:27 UTC
  • mfrom: (1437)
  • mto: This revision was merged to the branch mainline in revision 1438.
  • Revision ID: robertc@robertcollins.net-20051010231827-f9e2dda2e92bf565
mergeĀ fromĀ upstream

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2009 Canonical Ltd
2
 
#
 
1
#! /usr/bin/python
 
2
 
 
3
# Copyright (C) 2005 Canonical Ltd
 
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
5
7
# the Free Software Foundation; either version 2 of the License, or
6
8
# (at your option) any later version.
7
 
#
 
9
 
8
10
# This program is distributed in the hope that it will be useful,
9
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
13
# GNU General Public License for more details.
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
 
25
27
# property.
26
28
 
27
29
# TODO: Nothing here so far assumes the lines are really \n newlines,
28
 
# rather than being split up in some other way.  We could accommodate
 
30
# rather than being split up in some other way.  We could accomodate
29
31
# binaries, perhaps by naively splitting on \n or perhaps using
30
32
# something like a rolling checksum.
31
33
 
48
50
# have slight specializations for different ways its used: annotate,
49
51
# basis for add, get, etc.
50
52
 
51
 
# TODO: Probably the API should work only in names to hide the integer
52
 
# indexes from the user.
 
53
# TODO: Perhaps the API should work only in names to hide the integer
 
54
# indexes from the user?
53
55
 
54
56
# TODO: Is there any potential performance win by having an add()
55
57
# variant that is passed a pre-cooked version of the single basis
56
58
# version?
57
59
 
58
 
# TODO: Reweave can possibly be made faster by remembering diffs
59
 
# where the basis and destination are unchanged.
60
 
 
61
 
# 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
 
# be done fairly efficiently because the sequence numbers constrain
65
 
# the possible relationships.
66
 
 
67
 
# FIXME: the conflict markers should be *7* characters
68
 
 
69
 
from copy import copy
70
 
from cStringIO import StringIO
71
 
import os
72
 
 
73
 
from bzrlib.lazy_import import lazy_import
74
 
lazy_import(globals(), """
75
 
from bzrlib import tsort
76
 
""")
77
 
from bzrlib import (
78
 
    errors,
79
 
    osutils,
80
 
    )
81
 
from bzrlib.errors import (WeaveError, WeaveFormatError, WeaveParentMismatch,
82
 
        RevisionAlreadyPresent,
83
 
        RevisionNotPresent,
84
 
        UnavailableRepresentation,
85
 
        )
86
 
from bzrlib.osutils import dirname, sha, sha_strings, split_lines
87
 
import bzrlib.patiencediff
88
 
from bzrlib.revision import NULL_REVISION
89
 
from bzrlib.symbol_versioning import *
 
60
# TODO: Have a way to go back and insert a revision V1 that is a parent 
 
61
# of an already-stored revision V2.  This means some lines previously 
 
62
# counted as new in V2 will be discovered to have actually come from V1.  
 
63
# It is probably necessary to insert V1, then compute a whole new diff 
 
64
# from the mashed ancestors to V2.  This must be repeated for every 
 
65
# direct child of V1.  The deltas from V2 to its descendents won't change,
 
66
# although their location within the weave may change.  It may be possible
 
67
# to just adjust the location of those instructions rather than 
 
68
# re-weaving the whole thing.  This is expected to be a fairly rare
 
69
# operation, only used when inserting data that was previously a ghost.
 
70
 
 
71
 
 
72
 
 
73
 
 
74
import sha
 
75
from difflib import SequenceMatcher
 
76
 
90
77
from bzrlib.trace import mutter
91
 
from bzrlib.versionedfile import (
92
 
    AbsentContentFactory,
93
 
    adapter_registry,
94
 
    ContentFactory,
95
 
    sort_groupcompress,
96
 
    VersionedFile,
97
 
    )
98
 
from bzrlib.weavefile import _read_weave_v5, write_weave_v5
99
 
 
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
 
 
126
 
class Weave(VersionedFile):
 
78
 
 
79
 
 
80
class WeaveError(Exception):
 
81
    """Exception in processing weave"""
 
82
 
 
83
 
 
84
class WeaveFormatError(WeaveError):
 
85
    """Weave invariant violated"""
 
86
 
 
87
 
 
88
class WeaveParentMismatch(WeaveError):
 
89
    """Parents are mismatched between two revisions."""
 
90
    
 
91
 
 
92
class Weave(object):
127
93
    """weave - versioned text file storage.
128
 
 
 
94
    
129
95
    A Weave manages versions of line-based text files, keeping track
130
96
    of the originating version for each line.
131
97
 
177
143
 
178
144
    * It doesn't seem very useful to have an active insertion
179
145
      inside an inactive insertion, but it might happen.
180
 
 
 
146
      
181
147
    * Therefore, all instructions are always"considered"; that
182
148
      is passed onto and off the stack.  An outer inactive block
183
149
      doesn't disable an inner block.
213
179
    """
214
180
 
215
181
    __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__()
 
182
                 '_weave_name']
 
183
    
 
184
    def __init__(self, weave_name=None):
227
185
        self._weave = []
228
186
        self._parents = []
229
187
        self._sha1s = []
230
188
        self._names = []
231
189
        self._name_map = {}
232
190
        self._weave_name = weave_name
233
 
        if matcher is None:
234
 
            self._matcher = bzrlib.patiencediff.PatienceSequenceMatcher
235
 
        else:
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
243
 
 
244
 
    def __repr__(self):
245
 
        return "Weave(%r)" % self._weave_name
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)
 
191
 
253
192
 
254
193
    def copy(self):
255
194
        """Return a deep copy of self.
256
 
 
 
195
        
257
196
        The copy can be modified without affecting the original weave."""
258
197
        other = Weave()
259
198
        other._weave = self._weave[:]
269
208
            return False
270
209
        return self._parents == other._parents \
271
210
               and self._weave == other._weave \
272
 
               and self._sha1s == other._sha1s
 
211
               and self._sha1s == other._sha1s 
273
212
 
 
213
    
274
214
    def __ne__(self, other):
275
215
        return not self.__eq__(other)
276
216
 
277
 
    def _idx_to_name(self, version):
278
 
        return self._names[version]
279
 
 
280
 
    def _lookup(self, name):
 
217
 
 
218
    def maybe_lookup(self, name_or_index):
 
219
        """Convert possible symbolic name to index, or pass through indexes."""
 
220
        if isinstance(name_or_index, (int, long)):
 
221
            return name_or_index
 
222
        else:
 
223
            return self.lookup(name_or_index)
 
224
 
 
225
        
 
226
    def lookup(self, name):
281
227
        """Convert symbolic version name to index."""
282
 
        if not self._allow_reserved:
283
 
            self.check_not_reserved_id(name)
284
228
        try:
285
229
            return self._name_map[name]
286
230
        except KeyError:
287
 
            raise RevisionNotPresent(name, self._weave_name)
288
 
 
289
 
    def versions(self):
290
 
        """See VersionedFile.versions."""
291
 
        return self._names[:]
292
 
 
293
 
    def has_version(self, version_id):
294
 
        """See VersionedFile.has_version."""
295
 
        return (version_id in self._name_map)
296
 
 
297
 
    __contains__ = has_version
298
 
 
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
 
231
            raise WeaveError("name %r not present in weave %r" %
 
232
                             (name, self._weave_name))
 
233
 
 
234
 
 
235
    def iter_names(self):
 
236
        """Yield a list of all names in this weave."""
 
237
        return iter(self._names)
 
238
 
 
239
    def idx_to_name(self, version):
 
240
        return self._names[version]
 
241
 
379
242
 
380
243
    def _check_repeated_add(self, name, parents, text, sha1):
381
244
        """Check that a duplicated add is OK.
382
245
 
383
246
        If it is, return the (old) index; otherwise raise an exception.
384
247
        """
385
 
        idx = self._lookup(name)
386
 
        if sorted(self._parents[idx]) != sorted(parents) \
387
 
            or sha1 != self._sha1s[idx]:
388
 
            raise RevisionAlreadyPresent(name, self._weave_name)
 
248
        idx = self.lookup(name)
 
249
        if sorted(self._parents[idx]) != sorted(parents):
 
250
            raise WeaveError("name \"%s\" already present in weave "
 
251
                             "with different parents" % name)
 
252
        if sha1 != self._sha1s[idx]:
 
253
            raise WeaveError("name \"%s\" already present in weave "
 
254
                             "with different text" % name)            
389
255
        return idx
390
 
 
391
 
    def _add_lines(self, version_id, parents, lines, parent_texts,
392
 
       left_matching_blocks, nostore_sha, random_id, check_content):
393
 
        """See VersionedFile.add_lines."""
394
 
        idx = self._add(version_id, lines, map(self._lookup, parents),
395
 
            nostore_sha=nostore_sha)
396
 
        return sha_strings(lines), sum(map(len, lines)), idx
397
 
 
398
 
    def _add(self, version_id, lines, parents, sha1=None, nostore_sha=None):
 
256
        
 
257
 
 
258
        
 
259
    def add(self, name, parents, text, sha1=None):
399
260
        """Add a single text on top of the weave.
400
 
 
 
261
  
401
262
        Returns the index number of the newly added version.
402
263
 
403
 
        version_id
 
264
        name
404
265
            Symbolic name for this version.
405
266
            (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
267
 
408
268
        parents
409
269
            List or set of direct parent version numbers.
410
 
 
411
 
        lines
 
270
            
 
271
        text
412
272
            Sequence of lines to be added in the new version.
413
273
 
414
 
        :param nostore_sha: See VersionedFile.add_lines.
 
274
        sha -- SHA-1 of the file, if known.  This is trusted to be
 
275
            correct if supplied.
415
276
        """
416
 
        self._check_lines_not_unicode(lines)
417
 
        self._check_lines_are_lines(lines)
418
 
        if not sha1:
419
 
            sha1 = sha_strings(lines)
420
 
        if sha1 == nostore_sha:
421
 
            raise errors.ExistingContent
422
 
        if version_id is None:
423
 
            version_id = "sha1:" + sha1
424
 
        if version_id in self._name_map:
425
 
            return self._check_repeated_add(version_id, parents, lines, sha1)
426
 
 
 
277
        from bzrlib.osutils import sha_strings
 
278
 
 
279
        assert isinstance(name, basestring)
 
280
        if sha1 is None:
 
281
            sha1 = sha_strings(text)
 
282
        if name in self._name_map:
 
283
            return self._check_repeated_add(name, parents, text, sha1)
 
284
 
 
285
        parents = map(self.maybe_lookup, parents)
427
286
        self._check_versions(parents)
428
 
        ## self._check_lines(lines)
 
287
        ## self._check_lines(text)
429
288
        new_version = len(self._parents)
430
289
 
 
290
 
431
291
        # if we abort after here the (in-memory) weave will be corrupt because only
432
292
        # some fields are updated
433
 
        # XXX: FIXME implement a succeed-or-fail of the rest of this routine.
434
 
        #      - Robert Collins 20060226
435
293
        self._parents.append(parents[:])
436
294
        self._sha1s.append(sha1)
437
 
        self._names.append(version_id)
438
 
        self._name_map[version_id] = new_version
439
 
 
440
 
 
 
295
        self._names.append(name)
 
296
        self._name_map[name] = new_version
 
297
 
 
298
            
441
299
        if not parents:
442
300
            # special case; adding with no parents revision; can do
443
301
            # this more quickly by just appending unconditionally.
444
302
            # even more specially, if we're adding an empty text we
445
303
            # need do nothing at all.
446
 
            if lines:
 
304
            if text:
447
305
                self._weave.append(('{', new_version))
448
 
                self._weave.extend(lines)
 
306
                self._weave.extend(text)
449
307
                self._weave.append(('}', None))
 
308
        
450
309
            return new_version
451
310
 
452
311
        if len(parents) == 1:
454
313
            if sha1 == self._sha1s[pv]:
455
314
                # special case: same as the single parent
456
315
                return new_version
457
 
 
458
 
 
459
 
        ancestors = self._inclusions(parents)
 
316
            
 
317
 
 
318
        ancestors = self.inclusions(parents)
460
319
 
461
320
        l = self._weave
462
321
 
469
328
 
470
329
        # another small special case: a merge, producing the same text
471
330
        # as auto-merge
472
 
        if lines == basis_lines:
473
 
            return new_version
 
331
        if text == basis_lines:
 
332
            return new_version            
474
333
 
475
 
        # add a sentinel, because we can also match against the final line
 
334
        # add a sentinal, because we can also match against the final line
476
335
        basis_lineno.append(len(self._weave))
477
336
 
478
337
        # XXX: which line of the weave should we really consider
482
341
        #print 'basis_lines:', basis_lines
483
342
        #print 'new_lines:  ', lines
484
343
 
485
 
        s = self._matcher(None, basis_lines, lines)
 
344
        s = SequenceMatcher(None, basis_lines, text)
486
345
 
487
346
        # offset gives the number of lines that have been inserted
488
347
        # into the weave up to the current point; if the original edit instruction
495
354
            #print 'raw match', tag, i1, i2, j1, j2
496
355
            if tag == 'equal':
497
356
                continue
 
357
 
498
358
            i1 = basis_lineno[i1]
499
359
            i2 = basis_lineno[i2]
 
360
 
 
361
            assert 0 <= j1 <= j2 <= len(text)
 
362
 
 
363
            #print tag, i1, i2, j1, j2
 
364
 
500
365
            # the deletion and insertion are handled separately.
501
366
            # first delete the region.
502
367
            if i1 != i2:
509
374
                # i2; we want to insert after this region to make sure
510
375
                # we don't destroy ourselves
511
376
                i = i2 + offset
512
 
                self._weave[i:i] = ([('{', new_version)]
513
 
                                    + lines[j1:j2]
 
377
                self._weave[i:i] = ([('{', new_version)] 
 
378
                                    + text[j1:j2] 
514
379
                                    + [('}', None)])
515
380
                offset += 2 + (j2 - j1)
 
381
 
516
382
        return new_version
517
383
 
518
 
    def _inclusions(self, versions):
 
384
    def add_identical(self, old_rev_id, new_rev_id, parents):
 
385
        """Add an identical text to old_rev_id as new_rev_id."""
 
386
        old_lines = self.get(self.lookup(old_rev_id))
 
387
        self.add(new_rev_id, parents, old_lines)
 
388
 
 
389
    def inclusions(self, versions):
519
390
        """Return set of all ancestors of given version(s)."""
520
 
        if not len(versions):
521
 
            return []
522
391
        i = set(versions)
523
392
        for v in xrange(max(versions), 0, -1):
524
393
            if v in i:
528
397
        ## except IndexError:
529
398
        ##     raise ValueError("version %d not present in weave" % v)
530
399
 
531
 
    def get_ancestry(self, version_ids, topo_sorted=True):
532
 
        """See VersionedFile.get_ancestry."""
533
 
        if isinstance(version_ids, basestring):
534
 
            version_ids = [version_ids]
535
 
        i = self._inclusions([self._lookup(v) for v in version_ids])
536
 
        return [self._idx_to_name(v) for v in i]
 
400
 
 
401
    def parents(self, version):
 
402
        return self._parents[version]
 
403
 
 
404
 
 
405
    def parent_names(self, version):
 
406
        """Return version names for parents of a version."""
 
407
        return map(self.idx_to_name, self._parents[self.lookup(version)])
 
408
 
 
409
 
 
410
    def minimal_parents(self, version):
 
411
        """Find the minimal set of parents for the version."""
 
412
        included = self._parents[version]
 
413
        if not included:
 
414
            return []
 
415
        
 
416
        li = list(included)
 
417
        li.sort(reverse=True)
 
418
 
 
419
        mininc = []
 
420
        gotit = set()
 
421
 
 
422
        for pv in li:
 
423
            if pv not in gotit:
 
424
                mininc.append(pv)
 
425
                gotit.update(self.inclusions(pv))
 
426
 
 
427
        assert mininc[0] >= 0
 
428
        assert mininc[-1] < version
 
429
        return mininc
 
430
 
 
431
 
537
432
 
538
433
    def _check_lines(self, text):
539
434
        if not isinstance(text, list):
543
438
            if not isinstance(l, basestring):
544
439
                raise ValueError("text line should be a string or unicode, not %s"
545
440
                                 % type(l))
546
 
 
 
441
        
547
442
 
548
443
 
549
444
    def _check_versions(self, indexes):
554
449
            except IndexError:
555
450
                raise IndexError("invalid version number %r" % i)
556
451
 
557
 
    def _compatible_parents(self, my_parents, other_parents):
558
 
        """During join check that other_parents are joinable with my_parents.
559
 
 
560
 
        Joinable is defined as 'is a subset of' - supersets may require
561
 
        regeneration of diffs, but subsets do not.
562
 
        """
563
 
        return len(other_parents.difference(my_parents)) == 0
564
 
 
565
 
    def annotate(self, version_id):
566
 
        """Return a list of (version-id, line) tuples for version_id.
 
452
    
 
453
    def annotate(self, name_or_index):
 
454
        return list(self.annotate_iter(name_or_index))
 
455
 
 
456
 
 
457
    def annotate_iter(self, name_or_index):
 
458
        """Yield list of (index-id, line) pairs for the specified version.
567
459
 
568
460
        The index indicates when the line originated in the weave."""
569
 
        incls = [self._lookup(version_id)]
570
 
        return [(self._idx_to_name(origin), text) for origin, lineno, text in
571
 
            self._extract(incls)]
572
 
 
573
 
    def iter_lines_added_or_present_in_versions(self, version_ids=None,
574
 
                                                pb=None):
575
 
        """See VersionedFile.iter_lines_added_or_present_in_versions()."""
576
 
        if version_ids is None:
577
 
            version_ids = self.versions()
578
 
        version_ids = set(version_ids)
579
 
        for lineno, inserted, deletes, line in self._walk_internal(version_ids):
580
 
            if inserted not in version_ids: continue
581
 
            if line[-1] != '\n':
582
 
                yield line + '\n', inserted
583
 
            else:
584
 
                yield line, inserted
585
 
 
586
 
    def _walk_internal(self, version_ids=None):
587
 
        """Helper method for weave actions."""
588
 
 
 
461
        incls = [self.maybe_lookup(name_or_index)]
 
462
        for origin, lineno, text in self._extract(incls):
 
463
            yield origin, text
 
464
 
 
465
 
 
466
    def _walk(self):
 
467
        """Walk the weave.
 
468
 
 
469
        Yields sequence of
 
470
        (lineno, insert, deletes, text)
 
471
        for each literal line.
 
472
        """
 
473
        
589
474
        istack = []
590
475
        dset = set()
591
476
 
592
477
        lineno = 0         # line of weave, 0-based
593
478
 
594
479
        for l in self._weave:
595
 
            if l.__class__ == tuple:
 
480
            if isinstance(l, tuple):
596
481
                c, v = l
597
482
                isactive = None
598
483
                if c == '{':
599
 
                    istack.append(self._names[v])
 
484
                    istack.append(v)
600
485
                elif c == '}':
601
486
                    istack.pop()
602
487
                elif c == '[':
603
 
                    dset.add(self._names[v])
 
488
                    assert v not in dset
 
489
                    dset.add(v)
604
490
                elif c == ']':
605
 
                    dset.remove(self._names[v])
606
 
                else:
607
 
                    raise WeaveFormatError('unexpected instruction %r' % v)
608
 
            else:
609
 
                yield lineno, istack[-1], frozenset(dset), l
 
491
                    dset.remove(v)
 
492
                else:
 
493
                    raise WeaveFormatError('unexpected instruction %r'
 
494
                                           % v)
 
495
            else:
 
496
                assert isinstance(l, basestring)
 
497
                assert istack
 
498
                yield lineno, istack[-1], dset, l
 
499
            lineno += 1
 
500
 
 
501
 
 
502
 
 
503
    def _extract(self, versions):
 
504
        """Yield annotation of lines in included set.
 
505
 
 
506
        Yields a sequence of tuples (origin, lineno, text), where
 
507
        origin is the origin version, lineno the index in the weave,
 
508
        and text the text of the line.
 
509
 
 
510
        The set typically but not necessarily corresponds to a version.
 
511
        """
 
512
        for i in versions:
 
513
            if not isinstance(i, int):
 
514
                raise ValueError(i)
 
515
            
 
516
        included = self.inclusions(versions)
 
517
 
 
518
        istack = []
 
519
        dset = set()
 
520
 
 
521
        lineno = 0         # line of weave, 0-based
 
522
 
 
523
        isactive = None
 
524
 
 
525
        result = []
 
526
 
 
527
        WFE = WeaveFormatError
 
528
 
 
529
        for l in self._weave:
 
530
            if isinstance(l, tuple):
 
531
                c, v = l
 
532
                isactive = None
 
533
                if c == '{':
 
534
                    assert v not in istack
 
535
                    istack.append(v)
 
536
                elif c == '}':
 
537
                    istack.pop()
 
538
                elif c == '[':
 
539
                    if v in included:
 
540
                        assert v not in dset
 
541
                        dset.add(v)
 
542
                else:
 
543
                    assert c == ']'
 
544
                    if v in included:
 
545
                        assert v in dset
 
546
                        dset.remove(v)
 
547
            else:
 
548
                assert isinstance(l, basestring)
 
549
                if isactive is None:
 
550
                    isactive = (not dset) and istack and (istack[-1] in included)
 
551
                if isactive:
 
552
                    result.append((istack[-1], lineno, l))
610
553
            lineno += 1
611
554
 
612
555
        if istack:
613
 
            raise WeaveFormatError("unclosed insertion blocks "
614
 
                    "at end of weave: %s" % istack)
 
556
            raise WFE("unclosed insertion blocks at end of weave",
 
557
                                   istack)
615
558
        if dset:
616
 
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
617
 
                                   % dset)
618
 
 
 
559
            raise WFE("unclosed deletion blocks at end of weave",
 
560
                                   dset)
 
561
 
 
562
        return result
 
563
    
 
564
 
 
565
 
 
566
    def get_iter(self, name_or_index):
 
567
        """Yield lines for the specified version."""
 
568
        incls = [self.maybe_lookup(name_or_index)]
 
569
        for origin, lineno, line in self._extract(incls):
 
570
            yield line
 
571
 
 
572
 
 
573
    def get_text(self, name_or_index):
 
574
        return ''.join(self.get_iter(name_or_index))
 
575
        assert isinstance(version, int)
 
576
 
 
577
 
 
578
    def get_lines(self, name_or_index):
 
579
        return list(self.get_iter(name_or_index))
 
580
 
 
581
 
 
582
    get = get_lines
 
583
 
 
584
 
 
585
    def mash_iter(self, included):
 
586
        """Return composed version of multiple included versions."""
 
587
        included = map(self.maybe_lookup, included)
 
588
        for origin, lineno, text in self._extract(included):
 
589
            yield text
 
590
 
 
591
 
 
592
    def dump(self, to_file):
 
593
        from pprint import pprint
 
594
        print >>to_file, "Weave._weave = ",
 
595
        pprint(self._weave, to_file)
 
596
        print >>to_file, "Weave._parents = ",
 
597
        pprint(self._parents, to_file)
 
598
 
 
599
 
 
600
 
 
601
    def numversions(self):
 
602
        l = len(self._parents)
 
603
        assert l == len(self._sha1s)
 
604
        return l
 
605
 
 
606
 
 
607
    def __len__(self):
 
608
        return self.numversions()
 
609
 
 
610
 
 
611
    def check(self, progress_bar=None):
 
612
        # check no circular inclusions
 
613
        for version in range(self.numversions()):
 
614
            inclusions = list(self._parents[version])
 
615
            if inclusions:
 
616
                inclusions.sort()
 
617
                if inclusions[-1] >= version:
 
618
                    raise WeaveFormatError("invalid included version %d for index %d"
 
619
                                           % (inclusions[-1], version))
 
620
 
 
621
        # try extracting all versions; this is a bit slow and parallel
 
622
        # extraction could be used
 
623
        nv = self.numversions()
 
624
        for version in range(nv):
 
625
            if progress_bar:
 
626
                progress_bar.update('checking text', version, nv)
 
627
            s = sha.new()
 
628
            for l in self.get_iter(version):
 
629
                s.update(l)
 
630
            hd = s.hexdigest()
 
631
            expected = self._sha1s[version]
 
632
            if hd != expected:
 
633
                raise WeaveError("mismatched sha1 for version %d; "
 
634
                                 "got %s, expected %s"
 
635
                                 % (version, hd, expected))
 
636
 
 
637
        # TODO: check insertions are properly nested, that there are
 
638
        # no lines outside of insertion blocks, that deletions are
 
639
        # properly paired, etc.
 
640
 
 
641
 
 
642
 
 
643
    def merge(self, merge_versions):
 
644
        """Automerge and mark conflicts between versions.
 
645
 
 
646
        This returns a sequence, each entry describing alternatives
 
647
        for a chunk of the file.  Each of the alternatives is given as
 
648
        a list of lines.
 
649
 
 
650
        If there is a chunk of the file where there's no diagreement,
 
651
        only one alternative is given.
 
652
        """
 
653
        # approach: find the included versions common to all the
 
654
        # merged versions
 
655
        raise NotImplementedError()
 
656
 
 
657
 
 
658
 
 
659
    def _delta(self, included, lines):
 
660
        """Return changes from basis to new revision.
 
661
 
 
662
        The old text for comparison is the union of included revisions.
 
663
 
 
664
        This is used in inserting a new text.
 
665
 
 
666
        Delta is returned as a sequence of
 
667
        (weave1, weave2, newlines).
 
668
 
 
669
        This indicates that weave1:weave2 of the old weave should be
 
670
        replaced by the sequence of lines in newlines.  Note that
 
671
        these line numbers are positions in the total weave and don't
 
672
        correspond to the lines in any extracted version, or even the
 
673
        extracted union of included versions.
 
674
 
 
675
        If line1=line2, this is a pure insert; if newlines=[] this is a
 
676
        pure delete.  (Similar to difflib.)
 
677
        """
 
678
        raise NotImplementedError()
 
679
 
 
680
            
619
681
    def plan_merge(self, ver_a, ver_b):
620
682
        """Return pseudo-annotation indicating how the two versions merge.
621
683
 
624
686
 
625
687
        Weave lines present in none of them are skipped entirely.
626
688
        """
627
 
        inc_a = set(self.get_ancestry([ver_a]))
628
 
        inc_b = set(self.get_ancestry([ver_b]))
 
689
        inc_a = self.inclusions([ver_a])
 
690
        inc_b = self.inclusions([ver_b])
629
691
        inc_c = inc_a & inc_b
630
692
 
631
 
        for lineno, insert, deleteset, line in self._walk_internal([ver_a, ver_b]):
 
693
        for lineno, insert, deleteset, line in self._walk():
632
694
            if deleteset & inc_c:
633
695
                # killed in parent; can't be in either a or b
634
696
                # not relevant to our work
660
722
                # not in either revision
661
723
                yield 'irrelevant', line
662
724
 
663
 
    def _extract(self, versions):
664
 
        """Yield annotation of lines in included set.
665
 
 
666
 
        Yields a sequence of tuples (origin, lineno, text), where
667
 
        origin is the origin version, lineno the index in the weave,
668
 
        and text the text of the line.
669
 
 
670
 
        The set typically but not necessarily corresponds to a version.
671
 
        """
672
 
        for i in versions:
673
 
            if not isinstance(i, int):
674
 
                raise ValueError(i)
675
 
 
676
 
        included = self._inclusions(versions)
677
 
 
678
 
        istack = []
679
 
        iset = set()
680
 
        dset = set()
681
 
 
682
 
        lineno = 0         # line of weave, 0-based
683
 
 
684
 
        isactive = None
685
 
 
686
 
        result = []
687
 
 
688
 
        WFE = WeaveFormatError
689
 
 
690
 
        # wow.
691
 
        #  449       0   4474.6820   2356.5590   bzrlib.weave:556(_extract)
692
 
        #  +285282   0   1676.8040   1676.8040   +<isinstance>
693
 
        # 1.6 seconds in 'isinstance'.
694
 
        # changing the first isinstance:
695
 
        #  449       0   2814.2660   1577.1760   bzrlib.weave:556(_extract)
696
 
        #  +140414   0    762.8050    762.8050   +<isinstance>
697
 
        # note that the inline time actually dropped (less function calls)
698
 
        # and total processing time was halved.
699
 
        # we're still spending ~1/4 of the method in isinstance though.
700
 
        # so lets hard code the acceptable string classes we expect:
701
 
        #  449       0   1202.9420    786.2930   bzrlib.weave:556(_extract)
702
 
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list'
703
 
        #                                          objects>
704
 
        # yay, down to ~1/4 the initial extract time, and our inline time
705
 
        # has shrunk again, with isinstance no longer dominating.
706
 
        # tweaking the stack inclusion test to use a set gives:
707
 
        #  449       0   1122.8030    713.0080   bzrlib.weave:556(_extract)
708
 
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list'
709
 
        #                                          objects>
710
 
        # - a 5% win, or possibly just noise. However with large istacks that
711
 
        # 'in' test could dominate, so I'm leaving this change in place -
712
 
        # when its fast enough to consider profiling big datasets we can review.
713
 
 
714
 
 
715
 
 
716
 
 
717
 
        for l in self._weave:
718
 
            if l.__class__ == tuple:
719
 
                c, v = l
720
 
                isactive = None
721
 
                if c == '{':
722
 
                    istack.append(v)
723
 
                    iset.add(v)
724
 
                elif c == '}':
725
 
                    iset.remove(istack.pop())
726
 
                elif c == '[':
727
 
                    if v in included:
728
 
                        dset.add(v)
729
 
                elif c == ']':
730
 
                    if v in included:
731
 
                        dset.remove(v)
 
725
        yield 'unchanged', ''           # terminator
 
726
 
 
727
 
 
728
 
 
729
    def weave_merge(self, plan):
 
730
        lines_a = []
 
731
        lines_b = []
 
732
        ch_a = ch_b = False
 
733
 
 
734
        for state, line in plan:
 
735
            if state == 'unchanged' or state == 'killed-both':
 
736
                # resync and flush queued conflicts changes if any
 
737
                if not lines_a and not lines_b:
 
738
                    pass
 
739
                elif ch_a and not ch_b:
 
740
                    # one-sided change:                    
 
741
                    for l in lines_a: yield l
 
742
                elif ch_b and not ch_a:
 
743
                    for l in lines_b: yield l
 
744
                elif lines_a == lines_b:
 
745
                    for l in lines_a: yield l
732
746
                else:
733
 
                    raise AssertionError()
 
747
                    yield '<<<<\n'
 
748
                    for l in lines_a: yield l
 
749
                    yield '====\n'
 
750
                    for l in lines_b: yield l
 
751
                    yield '>>>>\n'
 
752
 
 
753
                del lines_a[:]
 
754
                del lines_b[:]
 
755
                ch_a = ch_b = False
 
756
                
 
757
            if state == 'unchanged':
 
758
                if line:
 
759
                    yield line
 
760
            elif state == 'killed-a':
 
761
                ch_a = True
 
762
                lines_b.append(line)
 
763
            elif state == 'killed-b':
 
764
                ch_b = True
 
765
                lines_a.append(line)
 
766
            elif state == 'new-a':
 
767
                ch_a = True
 
768
                lines_a.append(line)
 
769
            elif state == 'new-b':
 
770
                ch_b = True
 
771
                lines_b.append(line)
734
772
            else:
735
 
                if isactive is None:
736
 
                    isactive = (not dset) and istack and (istack[-1] in included)
737
 
                if isactive:
738
 
                    result.append((istack[-1], lineno, l))
739
 
            lineno += 1
740
 
        if istack:
741
 
            raise WeaveFormatError("unclosed insertion blocks "
742
 
                    "at end of weave: %s" % istack)
743
 
        if dset:
744
 
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
745
 
                                   % dset)
746
 
        return result
747
 
 
748
 
    def _maybe_lookup(self, name_or_index):
749
 
        """Convert possible symbolic name to index, or pass through indexes.
750
 
 
751
 
        NOT FOR PUBLIC USE.
 
773
                assert state in ('irrelevant', 'ghost-a', 'ghost-b', 'killed-base',
 
774
                                 'killed-both'), \
 
775
                       state
 
776
 
 
777
                
 
778
    def join(self, other):
 
779
        """Integrate versions from other into this weave.
 
780
 
 
781
        The resulting weave contains all the history of both weaves; 
 
782
        any version you could retrieve from either self or other can be 
 
783
        retrieved from self after this call.
 
784
 
 
785
        It is illegal for the two weaves to contain different values 
 
786
        or different parents for any version.  See also reweave().
752
787
        """
753
 
        if isinstance(name_or_index, (int, long)):
754
 
            return name_or_index
755
 
        else:
756
 
            return self._lookup(name_or_index)
757
 
 
758
 
    def get_lines(self, version_id):
759
 
        """See VersionedFile.get_lines()."""
760
 
        int_index = self._maybe_lookup(version_id)
761
 
        result = [line for (origin, lineno, line) in self._extract([int_index])]
762
 
        expected_sha1 = self._sha1s[int_index]
763
 
        measured_sha1 = sha_strings(result)
764
 
        if measured_sha1 != expected_sha1:
765
 
            raise errors.WeaveInvalidChecksum(
766
 
                    'file %s, revision %s, expected: %s, measured %s'
767
 
                    % (self._weave_name, version_id,
768
 
                       expected_sha1, measured_sha1))
769
 
        return result
770
 
 
771
 
    def get_sha1s(self, version_ids):
772
 
        """See VersionedFile.get_sha1s()."""
773
 
        result = {}
774
 
        for v in version_ids:
775
 
            result[v] = self._sha1s[self._lookup(v)]
776
 
        return result
777
 
 
778
 
    def num_versions(self):
779
 
        """How many versions are in this weave?"""
780
 
        l = len(self._parents)
781
 
        return l
782
 
 
783
 
    __len__ = num_versions
784
 
 
785
 
    def check(self, progress_bar=None):
786
 
        # TODO evaluate performance hit of using string sets in this routine.
787
 
        # TODO: check no circular inclusions
788
 
        # TODO: create a nested progress bar
789
 
        for version in range(self.num_versions()):
790
 
            inclusions = list(self._parents[version])
791
 
            if inclusions:
792
 
                inclusions.sort()
793
 
                if inclusions[-1] >= version:
794
 
                    raise WeaveFormatError("invalid included version %d for index %d"
795
 
                                           % (inclusions[-1], version))
796
 
 
797
 
        # try extracting all versions; parallel extraction is used
798
 
        nv = self.num_versions()
799
 
        sha1s = {}
800
 
        texts = {}
801
 
        inclusions = {}
802
 
        for i in range(nv):
803
 
            # For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
804
 
            # The problem is that set membership is much more expensive
805
 
            name = self._idx_to_name(i)
806
 
            sha1s[name] = sha()
807
 
            texts[name] = []
808
 
            new_inc = set([name])
809
 
            for p in self._parents[i]:
810
 
                new_inc.update(inclusions[self._idx_to_name(p)])
811
 
 
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))))
816
 
            inclusions[name] = new_inc
817
 
 
818
 
        nlines = len(self._weave)
819
 
 
820
 
        update_text = 'checking weave'
821
 
        if self._weave_name:
822
 
            short_name = os.path.basename(self._weave_name)
823
 
            update_text = 'checking %s' % (short_name,)
824
 
            update_text = update_text[:25]
825
 
 
826
 
        for lineno, insert, deleteset, line in self._walk_internal():
827
 
            if progress_bar:
828
 
                progress_bar.update(update_text, lineno, nlines)
829
 
 
830
 
            for name, name_inclusions in inclusions.items():
831
 
                # The active inclusion must be an ancestor,
832
 
                # and no ancestors must have deleted this line,
833
 
                # because we don't support resurrection.
834
 
                if (insert in name_inclusions) and not (deleteset & name_inclusions):
835
 
                    sha1s[name].update(line)
836
 
 
837
 
        for i in range(nv):
838
 
            version = self._idx_to_name(i)
839
 
            hd = sha1s[version].hexdigest()
840
 
            expected = self._sha1s[i]
841
 
            if hd != expected:
842
 
                raise errors.WeaveInvalidChecksum(
843
 
                        "mismatched sha1 for version %s: "
844
 
                        "got %s, expected %s"
845
 
                        % (version, hd, expected))
846
 
 
847
 
        # TODO: check insertions are properly nested, that there are
848
 
        # no lines outside of insertion blocks, that deletions are
849
 
        # properly paired, etc.
 
788
        if other.numversions() == 0:
 
789
            return          # nothing to update, easy
 
790
        # two loops so that we do not change ourselves before verifying it
 
791
        # will be ok
 
792
        # work through in index order to make sure we get all dependencies
 
793
        for other_idx, name in enumerate(other._names):
 
794
            if self._check_version_consistent(other, other_idx, name):
 
795
                continue
 
796
        for other_idx, name in enumerate(other._names):
 
797
            # TODO: If all the parents of the other version are already 
 
798
            # present then we can avoid some work by just taking the delta
 
799
            # and adjusting the offsets.
 
800
            new_parents = self._imported_parents(other, other_idx)
 
801
            lines = other.get_lines(other_idx)
 
802
            sha1 = other._sha1s[other_idx]
 
803
            self.add(name, new_parents, lines, sha1)
 
804
 
850
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 = []
854
809
        for parent_idx in other._parents[other_idx]:
855
810
            parent_name = other._names[parent_idx]
856
 
            if parent_name not in self._name_map:
 
811
            if parent_name not in self._names:
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:
877
832
            if self._sha1s[this_idx] != other._sha1s[other_idx]:
878
 
                raise errors.WeaveTextDiffers(name, self, other)
 
833
                raise WeaveError("inconsistent texts for version {%s} "
 
834
                                 "when joining weaves"
 
835
                                 % (name))
879
836
            self_parents = self._parents[this_idx]
880
837
            other_parents = other._parents[other_idx]
881
 
            n1 = set([self._names[i] for i in self_parents])
882
 
            n2 = set([other._names[i] for i in other_parents])
883
 
            if not self._compatible_parents(n1, n2):
 
838
            n1 = [self._names[i] for i in self_parents]
 
839
            n2 = [other._names[i] for i in other_parents]
 
840
            n1.sort()
 
841
            n2.sort()
 
842
            if n1 != n2:
884
843
                raise WeaveParentMismatch("inconsistent parents "
885
844
                    "for version {%s}: %s vs %s" % (name, n1, n2))
886
845
            else:
888
847
        else:
889
848
            return False
890
849
 
891
 
    def _reweave(self, other, pb, msg):
892
 
        """Reweave self with other - internal helper for join().
893
 
 
894
 
        :param other: The other weave to merge
895
 
        :param pb: An optional progress bar, indicating how far done we are
896
 
        :param msg: An optional message for the progress
897
 
        """
898
 
        new_weave = _reweave(self, other, pb=pb, msg=msg)
899
 
        self._copy_weave_content(new_weave)
900
 
 
901
 
    def _copy_weave_content(self, otherweave):
902
 
        """adsorb the content from otherweave."""
 
850
    def reweave(self, other):
 
851
        """Reweave self with other."""
 
852
        new_weave = reweave(self, other)
903
853
        for attr in self.__slots__:
904
 
            if attr != '_weave_name':
905
 
                setattr(self, attr, copy(getattr(otherweave, attr)))
906
 
 
907
 
 
908
 
class WeaveFile(Weave):
909
 
    """A WeaveFile represents a Weave on disk and writes on change."""
910
 
 
911
 
    WEAVE_SUFFIX = '.weave'
912
 
 
913
 
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w', get_scope=None):
914
 
        """Create a WeaveFile.
915
 
 
916
 
        :param create: If not True, only open an existing knit.
917
 
        """
918
 
        super(WeaveFile, self).__init__(name, access_mode, get_scope=get_scope,
919
 
            allow_reserved=False)
920
 
        self._transport = transport
921
 
        self._filemode = filemode
922
 
        try:
923
 
            _read_weave_v5(self._transport.get(name + WeaveFile.WEAVE_SUFFIX), self)
924
 
        except errors.NoSuchFile:
925
 
            if not create:
926
 
                raise
927
 
            # new file, save it
928
 
            self._save()
929
 
 
930
 
    def _add_lines(self, version_id, parents, lines, parent_texts,
931
 
        left_matching_blocks, nostore_sha, random_id, check_content):
932
 
        """Add a version and save the weave."""
933
 
        self.check_not_reserved_id(version_id)
934
 
        result = super(WeaveFile, self)._add_lines(version_id, parents, lines,
935
 
            parent_texts, left_matching_blocks, nostore_sha, random_id,
936
 
            check_content)
937
 
        self._save()
938
 
        return result
939
 
 
940
 
    def copy_to(self, name, transport):
941
 
        """See VersionedFile.copy_to()."""
942
 
        # as we are all in memory always, just serialise to the new place.
943
 
        sio = StringIO()
944
 
        write_weave_v5(self, sio)
945
 
        sio.seek(0)
946
 
        transport.put_file(name + WeaveFile.WEAVE_SUFFIX, sio, self._filemode)
947
 
 
948
 
    def _save(self):
949
 
        """Save the weave."""
950
 
        self._check_write_ok()
951
 
        sio = StringIO()
952
 
        write_weave_v5(self, sio)
953
 
        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)
961
 
 
962
 
    @staticmethod
963
 
    def get_suffixes():
964
 
        """See VersionedFile.get_suffixes()."""
965
 
        return [WeaveFile.WEAVE_SUFFIX]
966
 
 
967
 
    def insert_record_stream(self, stream):
968
 
        super(WeaveFile, self).insert_record_stream(stream)
969
 
        self._save()
970
 
 
971
 
 
972
 
def _reweave(wa, wb, pb=None, msg=None):
 
854
            setattr(self, attr, getattr(new_weave, attr))
 
855
 
 
856
 
 
857
def reweave(wa, wb):
973
858
    """Combine two weaves and return the result.
974
859
 
975
 
    This works even if a revision R has different parents in
 
860
    This works even if a revision R has different parents in 
976
861
    wa and wb.  In the resulting weave all the parents are given.
977
862
 
978
 
    This is done by just building up a new weave, maintaining ordering
 
863
    This is done by just building up a new weave, maintaining ordering 
979
864
    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
 
865
    might be possible but it should only be necessary to do 
 
866
    this operation rarely, when a new previously ghost version is 
982
867
    inserted.
983
 
 
984
 
    :param pb: An optional progress bar, indicating how far done we are
985
 
    :param msg: An optional message for the progress
986
868
    """
987
869
    wr = Weave()
988
870
    ia = ib = 0
989
 
    queue_a = range(wa.num_versions())
990
 
    queue_b = range(wb.num_versions())
 
871
    queue_a = range(wa.numversions())
 
872
    queue_b = range(wb.numversions())
991
873
    # first determine combined parents of all versions
992
874
    # map from version name -> all parent names
993
875
    combined_parents = _reweave_parent_graphs(wa, wb)
994
876
    mutter("combined parents: %r", combined_parents)
995
 
    order = tsort.topo_sort(combined_parents.iteritems())
 
877
    order = _make_reweave_order(wa._names, wb._names, combined_parents)
996
878
    mutter("order to reweave: %r", order)
997
 
 
998
 
    if pb and not msg:
999
 
        msg = 'reweave'
1000
 
 
1001
 
    for idx, name in enumerate(order):
1002
 
        if pb:
1003
 
            pb.update(msg, idx, len(order))
 
879
    for name in order:
1004
880
        if name in wa._name_map:
1005
881
            lines = wa.get_lines(name)
1006
882
            if name in wb._name_map:
1007
 
                lines_b = wb.get_lines(name)
1008
 
                if lines != lines_b:
1009
 
                    mutter('Weaves differ on content. rev_id {%s}', name)
1010
 
                    mutter('weaves: %s, %s', wa._weave_name, wb._weave_name)
1011
 
                    import difflib
1012
 
                    lines = list(difflib.unified_diff(lines, lines_b,
1013
 
                            wa._weave_name, wb._weave_name))
1014
 
                    mutter('lines:\n%s', ''.join(lines))
1015
 
                    raise errors.WeaveTextDiffers(name, wa, wb)
 
883
                assert lines == wb.get_lines(name)
1016
884
        else:
1017
885
            lines = wb.get_lines(name)
1018
 
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
 
886
        wr.add(name, combined_parents[name], lines)
1019
887
    return wr
1020
888
 
1021
889
 
1022
890
def _reweave_parent_graphs(wa, wb):
1023
891
    """Return combined parent ancestry for two weaves.
1024
 
 
 
892
    
1025
893
    Returned as a list of (version_name, set(parent_names))"""
1026
894
    combined = {}
1027
895
    for weave in [wa, wb]:
1028
896
        for idx, name in enumerate(weave._names):
1029
897
            p = combined.setdefault(name, set())
1030
 
            p.update(map(weave._idx_to_name, weave._parents[idx]))
 
898
            p.update(map(weave.idx_to_name, weave._parents[idx]))
1031
899
    return combined
 
900
 
 
901
 
 
902
def _make_reweave_order(wa_order, wb_order, combined_parents):
 
903
    """Return an order to reweave versions respecting parents."""
 
904
    done = set()
 
905
    result = []
 
906
    ia = ib = 0
 
907
    next_a = next_b = None
 
908
    len_a = len(wa_order)
 
909
    len_b = len(wb_order)
 
910
    while ia < len(wa_order) or ib < len(wb_order):
 
911
        if ia < len_a:
 
912
            next_a = wa_order[ia]
 
913
            if next_a in done:
 
914
                ia += 1
 
915
                continue
 
916
            if combined_parents[next_a].issubset(done):
 
917
                ia += 1
 
918
                result.append(next_a)
 
919
                done.add(next_a)
 
920
                continue
 
921
        if ib < len_b:
 
922
            next_b = wb_order[ib]
 
923
            if next_b in done:
 
924
                ib += 1
 
925
                continue
 
926
            elif combined_parents[next_b].issubset(done):
 
927
                ib += 1
 
928
                result.append(next_b)
 
929
                done.add(next_b)
 
930
                continue
 
931
        raise WeaveError("don't know how to reweave at {%s} and {%s}"
 
932
                         % (next_a, next_b))
 
933
    return result
 
934
 
 
935
 
 
936
def weave_toc(w):
 
937
    """Show the weave's table-of-contents"""
 
938
    print '%6s %50s %10s %10s' % ('ver', 'name', 'sha1', 'parents')
 
939
    for i in (6, 50, 10, 10):
 
940
        print '-' * i,
 
941
    print
 
942
    for i in range(w.numversions()):
 
943
        sha1 = w._sha1s[i]
 
944
        name = w._names[i]
 
945
        parent_str = ' '.join(map(str, w._parents[i]))
 
946
        print '%6d %-50.50s %10.10s %s' % (i, name, sha1, parent_str)
 
947
 
 
948
 
 
949
 
 
950
def weave_stats(weave_file, pb):
 
951
    from bzrlib.weavefile import read_weave
 
952
 
 
953
    wf = file(weave_file, 'rb')
 
954
    w = read_weave(wf)
 
955
    # FIXME: doesn't work on pipes
 
956
    weave_size = wf.tell()
 
957
 
 
958
    total = 0
 
959
    vers = len(w)
 
960
    for i in range(vers):
 
961
        pb.update('checking sizes', i, vers)
 
962
        for origin, lineno, line in w._extract([i]):
 
963
            total += len(line)
 
964
 
 
965
    pb.clear()
 
966
 
 
967
    print 'versions          %9d' % vers
 
968
    print 'weave file        %9d bytes' % weave_size
 
969
    print 'total contents    %9d bytes' % total
 
970
    print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
 
971
    if vers:
 
972
        avg = total/vers
 
973
        print 'average size      %9d bytes' % avg
 
974
        print 'relative size     %9.2fx' % (float(weave_size) / float(avg))
 
975
 
 
976
 
 
977
def usage():
 
978
    print """bzr weave tool
 
979
 
 
980
Experimental tool for weave algorithm.
 
981
 
 
982
usage:
 
983
    weave init WEAVEFILE
 
984
        Create an empty weave file
 
985
    weave get WEAVEFILE VERSION
 
986
        Write out specified version.
 
987
    weave check WEAVEFILE
 
988
        Check consistency of all versions.
 
989
    weave toc WEAVEFILE
 
990
        Display table of contents.
 
991
    weave add WEAVEFILE NAME [BASE...] < NEWTEXT
 
992
        Add NEWTEXT, with specified parent versions.
 
993
    weave annotate WEAVEFILE VERSION
 
994
        Display origin of each line.
 
995
    weave mash WEAVEFILE VERSION...
 
996
        Display composite of all selected versions.
 
997
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
 
998
        Auto-merge two versions and display conflicts.
 
999
    weave diff WEAVEFILE VERSION1 VERSION2 
 
1000
        Show differences between two versions.
 
1001
 
 
1002
example:
 
1003
 
 
1004
    % weave init foo.weave
 
1005
    % vi foo.txt
 
1006
    % weave add foo.weave ver0 < foo.txt
 
1007
    added version 0
 
1008
 
 
1009
    (create updated version)
 
1010
    % vi foo.txt
 
1011
    % weave get foo.weave 0 | diff -u - foo.txt
 
1012
    % weave add foo.weave ver1 0 < foo.txt
 
1013
    added version 1
 
1014
 
 
1015
    % weave get foo.weave 0 > foo.txt       (create forked version)
 
1016
    % vi foo.txt
 
1017
    % weave add foo.weave ver2 0 < foo.txt
 
1018
    added version 2
 
1019
 
 
1020
    % weave merge foo.weave 1 2 > foo.txt   (merge them)
 
1021
    % vi foo.txt                            (resolve conflicts)
 
1022
    % weave add foo.weave merged 1 2 < foo.txt     (commit merged version)     
 
1023
    
 
1024
"""
 
1025
    
 
1026
 
 
1027
 
 
1028
def main(argv):
 
1029
    import sys
 
1030
    import os
 
1031
    try:
 
1032
        import bzrlib
 
1033
    except ImportError:
 
1034
        # in case we're run directly from the subdirectory
 
1035
        sys.path.append('..')
 
1036
        import bzrlib
 
1037
    from bzrlib.weavefile import write_weave, read_weave
 
1038
    from bzrlib.progress import ProgressBar
 
1039
 
 
1040
    try:
 
1041
        import psyco
 
1042
        psyco.full()
 
1043
    except ImportError:
 
1044
        pass
 
1045
 
 
1046
    if len(argv) < 2:
 
1047
        usage()
 
1048
        return 0
 
1049
 
 
1050
    cmd = argv[1]
 
1051
 
 
1052
    def readit():
 
1053
        return read_weave(file(argv[2], 'rb'))
 
1054
    
 
1055
    if cmd == 'help':
 
1056
        usage()
 
1057
    elif cmd == 'add':
 
1058
        w = readit()
 
1059
        # at the moment, based on everything in the file
 
1060
        name = argv[3]
 
1061
        parents = map(int, argv[4:])
 
1062
        lines = sys.stdin.readlines()
 
1063
        ver = w.add(name, parents, lines)
 
1064
        write_weave(w, file(argv[2], 'wb'))
 
1065
        print 'added version %r %d' % (name, ver)
 
1066
    elif cmd == 'init':
 
1067
        fn = argv[2]
 
1068
        if os.path.exists(fn):
 
1069
            raise IOError("file exists")
 
1070
        w = Weave()
 
1071
        write_weave(w, file(fn, 'wb'))
 
1072
    elif cmd == 'get': # get one version
 
1073
        w = readit()
 
1074
        sys.stdout.writelines(w.get_iter(int(argv[3])))
 
1075
        
 
1076
    elif cmd == 'mash': # get composite
 
1077
        w = readit()
 
1078
        sys.stdout.writelines(w.mash_iter(map(int, argv[3:])))
 
1079
 
 
1080
    elif cmd == 'diff':
 
1081
        from difflib import unified_diff
 
1082
        w = readit()
 
1083
        fn = argv[2]
 
1084
        v1, v2 = map(int, argv[3:5])
 
1085
        lines1 = w.get(v1)
 
1086
        lines2 = w.get(v2)
 
1087
        diff_gen = unified_diff(lines1, lines2,
 
1088
                                '%s version %d' % (fn, v1),
 
1089
                                '%s version %d' % (fn, v2))
 
1090
        sys.stdout.writelines(diff_gen)
 
1091
            
 
1092
    elif cmd == 'annotate':
 
1093
        w = readit()
 
1094
        # newline is added to all lines regardless; too hard to get
 
1095
        # reasonable formatting otherwise
 
1096
        lasto = None
 
1097
        for origin, text in w.annotate(int(argv[3])):
 
1098
            text = text.rstrip('\r\n')
 
1099
            if origin == lasto:
 
1100
                print '      | %s' % (text)
 
1101
            else:
 
1102
                print '%5d | %s' % (origin, text)
 
1103
                lasto = origin
 
1104
                
 
1105
    elif cmd == 'toc':
 
1106
        weave_toc(readit())
 
1107
 
 
1108
    elif cmd == 'stats':
 
1109
        weave_stats(argv[2], ProgressBar())
 
1110
        
 
1111
    elif cmd == 'check':
 
1112
        w = readit()
 
1113
        pb = ProgressBar()
 
1114
        w.check(pb)
 
1115
        pb.clear()
 
1116
        print '%d versions ok' % w.numversions()
 
1117
 
 
1118
    elif cmd == 'inclusions':
 
1119
        w = readit()
 
1120
        print ' '.join(map(str, w.inclusions([int(argv[3])])))
 
1121
 
 
1122
    elif cmd == 'parents':
 
1123
        w = readit()
 
1124
        print ' '.join(map(str, w._parents[int(argv[3])]))
 
1125
 
 
1126
    elif cmd == 'plan-merge':
 
1127
        w = readit()
 
1128
        for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
 
1129
            if line:
 
1130
                print '%14s | %s' % (state, line),
 
1131
 
 
1132
    elif cmd == 'merge':
 
1133
        w = readit()
 
1134
        p = w.plan_merge(int(argv[3]), int(argv[4]))
 
1135
        sys.stdout.writelines(w.weave_merge(p))
 
1136
            
 
1137
    elif cmd == 'mash-merge':
 
1138
        if len(argv) != 5:
 
1139
            usage()
 
1140
            return 1
 
1141
 
 
1142
        w = readit()
 
1143
        v1, v2 = map(int, argv[3:5])
 
1144
 
 
1145
        basis = w.inclusions([v1]).intersection(w.inclusions([v2]))
 
1146
 
 
1147
        base_lines = list(w.mash_iter(basis))
 
1148
        a_lines = list(w.get(v1))
 
1149
        b_lines = list(w.get(v2))
 
1150
 
 
1151
        from bzrlib.merge3 import Merge3
 
1152
        m3 = Merge3(base_lines, a_lines, b_lines)
 
1153
 
 
1154
        name_a = 'version %d' % v1
 
1155
        name_b = 'version %d' % v2
 
1156
        sys.stdout.writelines(m3.merge_lines(name_a=name_a, name_b=name_b))
 
1157
    else:
 
1158
        raise ValueError('unknown command %r' % cmd)
 
1159
    
 
1160
 
 
1161
 
 
1162
def profile_main(argv): 
 
1163
    import tempfile, hotshot, hotshot.stats
 
1164
 
 
1165
    prof_f = tempfile.NamedTemporaryFile()
 
1166
 
 
1167
    prof = hotshot.Profile(prof_f.name)
 
1168
 
 
1169
    ret = prof.runcall(main, argv)
 
1170
    prof.close()
 
1171
 
 
1172
    stats = hotshot.stats.load(prof_f.name)
 
1173
    #stats.strip_dirs()
 
1174
    stats.sort_stats('cumulative')
 
1175
    ## XXX: Might like to write to stderr or the trace file instead but
 
1176
    ## print_stats seems hardcoded to stdout
 
1177
    stats.print_stats(20)
 
1178
            
 
1179
    return ret
 
1180
 
 
1181
 
 
1182
if __name__ == '__main__':
 
1183
    import sys
 
1184
    if '--profile' in sys.argv:
 
1185
        args = sys.argv[:]
 
1186
        args.remove('--profile')
 
1187
        sys.exit(profile_main(args))
 
1188
    else:
 
1189
        sys.exit(main(sys.argv))
 
1190