~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Martin Pool
  • Date: 2005-10-06 08:11:46 UTC
  • mto: (1185.13.3)
  • mto: This revision was merged to the branch mainline in revision 1418.
  • Revision ID: mbp@sourcefrog.net-20051006081146-6be9d0613fd0d24d
- fix join of weaves where parents occur at different offsets
- test for this

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
 
 
21
 
19
22
"""Weave - storage of related text file versions"""
20
23
 
21
 
from __future__ import absolute_import
22
24
 
23
25
# XXX: If we do weaves this way, will a merge still behave the same
24
26
# way if it's done in a different order?  That's a pretty desirable
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 *
90
 
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):
 
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
 
 
77
 
 
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 Weave(object):
127
89
    """weave - versioned text file storage.
128
 
 
 
90
    
129
91
    A Weave manages versions of line-based text files, keeping track
130
92
    of the originating version for each line.
131
93
 
177
139
 
178
140
    * It doesn't seem very useful to have an active insertion
179
141
      inside an inactive insertion, but it might happen.
180
 
 
 
142
      
181
143
    * Therefore, all instructions are always"considered"; that
182
144
      is passed onto and off the stack.  An outer inactive block
183
145
      doesn't disable an inner block.
213
175
    """
214
176
 
215
177
    __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__()
 
178
                 '_weave_name']
 
179
    
 
180
    def __init__(self, weave_name=None):
227
181
        self._weave = []
228
182
        self._parents = []
229
183
        self._sha1s = []
230
184
        self._names = []
231
185
        self._name_map = {}
232
186
        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)
 
187
 
253
188
 
254
189
    def copy(self):
255
190
        """Return a deep copy of self.
256
 
 
 
191
        
257
192
        The copy can be modified without affecting the original weave."""
258
193
        other = Weave()
259
194
        other._weave = self._weave[:]
269
204
            return False
270
205
        return self._parents == other._parents \
271
206
               and self._weave == other._weave \
272
 
               and self._sha1s == other._sha1s
 
207
               and self._sha1s == other._sha1s 
273
208
 
 
209
    
274
210
    def __ne__(self, other):
275
211
        return not self.__eq__(other)
276
212
 
277
 
    def _idx_to_name(self, version):
278
 
        return self._names[version]
279
 
 
280
 
    def _lookup(self, name):
 
213
 
 
214
    def maybe_lookup(self, name_or_index):
 
215
        """Convert possible symbolic name to index, or pass through indexes."""
 
216
        if isinstance(name_or_index, (int, long)):
 
217
            return name_or_index
 
218
        else:
 
219
            return self.lookup(name_or_index)
 
220
 
 
221
        
 
222
    def lookup(self, name):
281
223
        """Convert symbolic version name to index."""
282
 
        if not self._allow_reserved:
283
 
            self.check_not_reserved_id(name)
284
224
        try:
285
225
            return self._name_map[name]
286
226
        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
 
227
            raise WeaveError("name %r not present in weave %r" %
 
228
                             (name, self._weave_name))
 
229
 
 
230
 
 
231
    def iter_names(self):
 
232
        """Yield a list of all names in this weave."""
 
233
        return iter(self._names)
 
234
 
 
235
    def idx_to_name(self, version):
 
236
        return self._names[version]
 
237
 
379
238
 
380
239
    def _check_repeated_add(self, name, parents, text, sha1):
381
240
        """Check that a duplicated add is OK.
382
241
 
383
242
        If it is, return the (old) index; otherwise raise an exception.
384
243
        """
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)
 
244
        idx = self.lookup(name)
 
245
        if sorted(self._parents[idx]) != sorted(parents):
 
246
            raise WeaveError("name \"%s\" already present in weave "
 
247
                             "with different parents" % name)
 
248
        if sha1 != self._sha1s[idx]:
 
249
            raise WeaveError("name \"%s\" already present in weave "
 
250
                             "with different text" % name)            
389
251
        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):
 
252
        
 
253
 
 
254
        
 
255
    def add(self, name, parents, text, sha1=None):
399
256
        """Add a single text on top of the weave.
400
 
 
 
257
  
401
258
        Returns the index number of the newly added version.
402
259
 
403
 
        version_id
 
260
        name
404
261
            Symbolic name for this version.
405
262
            (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
263
 
408
264
        parents
409
265
            List or set of direct parent version numbers.
410
 
 
411
 
        lines
 
266
            
 
267
        text
412
268
            Sequence of lines to be added in the new version.
413
269
 
414
 
        :param nostore_sha: See VersionedFile.add_lines.
 
270
        sha -- SHA-1 of the file, if known.  This is trusted to be
 
271
            correct if supplied.
415
272
        """
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
 
 
 
273
        from bzrlib.osutils import sha_strings
 
274
 
 
275
        assert isinstance(name, basestring)
 
276
        if sha1 is None:
 
277
            sha1 = sha_strings(text)
 
278
        if name in self._name_map:
 
279
            return self._check_repeated_add(name, parents, text, sha1)
 
280
 
 
281
        parents = map(self.maybe_lookup, parents)
427
282
        self._check_versions(parents)
428
 
        ## self._check_lines(lines)
 
283
        ## self._check_lines(text)
429
284
        new_version = len(self._parents)
430
285
 
 
286
 
431
287
        # if we abort after here the (in-memory) weave will be corrupt because only
432
288
        # some fields are updated
433
 
        # XXX: FIXME implement a succeed-or-fail of the rest of this routine.
434
 
        #      - Robert Collins 20060226
435
289
        self._parents.append(parents[:])
436
290
        self._sha1s.append(sha1)
437
 
        self._names.append(version_id)
438
 
        self._name_map[version_id] = new_version
439
 
 
440
 
 
 
291
        self._names.append(name)
 
292
        self._name_map[name] = new_version
 
293
 
 
294
            
441
295
        if not parents:
442
296
            # special case; adding with no parents revision; can do
443
297
            # this more quickly by just appending unconditionally.
444
298
            # even more specially, if we're adding an empty text we
445
299
            # need do nothing at all.
446
 
            if lines:
 
300
            if text:
447
301
                self._weave.append(('{', new_version))
448
 
                self._weave.extend(lines)
 
302
                self._weave.extend(text)
449
303
                self._weave.append(('}', None))
 
304
        
450
305
            return new_version
451
306
 
452
307
        if len(parents) == 1:
454
309
            if sha1 == self._sha1s[pv]:
455
310
                # special case: same as the single parent
456
311
                return new_version
457
 
 
458
 
 
459
 
        ancestors = self._inclusions(parents)
 
312
            
 
313
 
 
314
        ancestors = self.inclusions(parents)
460
315
 
461
316
        l = self._weave
462
317
 
469
324
 
470
325
        # another small special case: a merge, producing the same text
471
326
        # as auto-merge
472
 
        if lines == basis_lines:
473
 
            return new_version
 
327
        if text == basis_lines:
 
328
            return new_version            
474
329
 
475
 
        # add a sentinel, because we can also match against the final line
 
330
        # add a sentinal, because we can also match against the final line
476
331
        basis_lineno.append(len(self._weave))
477
332
 
478
333
        # XXX: which line of the weave should we really consider
482
337
        #print 'basis_lines:', basis_lines
483
338
        #print 'new_lines:  ', lines
484
339
 
485
 
        s = self._matcher(None, basis_lines, lines)
 
340
        s = SequenceMatcher(None, basis_lines, text)
486
341
 
487
342
        # offset gives the number of lines that have been inserted
488
343
        # into the weave up to the current point; if the original edit instruction
495
350
            #print 'raw match', tag, i1, i2, j1, j2
496
351
            if tag == 'equal':
497
352
                continue
 
353
 
498
354
            i1 = basis_lineno[i1]
499
355
            i2 = basis_lineno[i2]
 
356
 
 
357
            assert 0 <= j1 <= j2 <= len(text)
 
358
 
 
359
            #print tag, i1, i2, j1, j2
 
360
 
500
361
            # the deletion and insertion are handled separately.
501
362
            # first delete the region.
502
363
            if i1 != i2:
509
370
                # i2; we want to insert after this region to make sure
510
371
                # we don't destroy ourselves
511
372
                i = i2 + offset
512
 
                self._weave[i:i] = ([('{', new_version)]
513
 
                                    + lines[j1:j2]
 
373
                self._weave[i:i] = ([('{', new_version)] 
 
374
                                    + text[j1:j2] 
514
375
                                    + [('}', None)])
515
376
                offset += 2 + (j2 - j1)
 
377
 
516
378
        return new_version
517
379
 
518
 
    def _inclusions(self, versions):
 
380
    def add_identical(self, old_rev_id, new_rev_id, parents):
 
381
        """Add an identical text to old_rev_id as new_rev_id."""
 
382
        old_lines = self.get(self.lookup(old_rev_id))
 
383
        self.add(new_rev_id, parents, old_lines)
 
384
 
 
385
    def inclusions(self, versions):
519
386
        """Return set of all ancestors of given version(s)."""
520
 
        if not len(versions):
521
 
            return []
522
387
        i = set(versions)
523
388
        for v in xrange(max(versions), 0, -1):
524
389
            if v in i:
528
393
        ## except IndexError:
529
394
        ##     raise ValueError("version %d not present in weave" % v)
530
395
 
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]
 
396
 
 
397
    def parents(self, version):
 
398
        return self._parents[version]
 
399
 
 
400
 
 
401
    def minimal_parents(self, version):
 
402
        """Find the minimal set of parents for the version."""
 
403
        included = self._parents[version]
 
404
        if not included:
 
405
            return []
 
406
        
 
407
        li = list(included)
 
408
        li.sort(reverse=True)
 
409
 
 
410
        mininc = []
 
411
        gotit = set()
 
412
 
 
413
        for pv in li:
 
414
            if pv not in gotit:
 
415
                mininc.append(pv)
 
416
                gotit.update(self.inclusions(pv))
 
417
 
 
418
        assert mininc[0] >= 0
 
419
        assert mininc[-1] < version
 
420
        return mininc
 
421
 
 
422
 
537
423
 
538
424
    def _check_lines(self, text):
539
425
        if not isinstance(text, list):
543
429
            if not isinstance(l, basestring):
544
430
                raise ValueError("text line should be a string or unicode, not %s"
545
431
                                 % type(l))
546
 
 
 
432
        
547
433
 
548
434
 
549
435
    def _check_versions(self, indexes):
554
440
            except IndexError:
555
441
                raise IndexError("invalid version number %r" % i)
556
442
 
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.
 
443
    
 
444
    def annotate(self, name_or_index):
 
445
        return list(self.annotate_iter(name_or_index))
 
446
 
 
447
 
 
448
    def annotate_iter(self, name_or_index):
 
449
        """Yield list of (index-id, line) pairs for the specified version.
567
450
 
568
451
        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
 
 
 
452
        incls = [self.maybe_lookup(name_or_index)]
 
453
        for origin, lineno, text in self._extract(incls):
 
454
            yield origin, text
 
455
 
 
456
 
 
457
    def _walk(self):
 
458
        """Walk the weave.
 
459
 
 
460
        Yields sequence of
 
461
        (lineno, insert, deletes, text)
 
462
        for each literal line.
 
463
        """
 
464
        
589
465
        istack = []
590
466
        dset = set()
591
467
 
592
468
        lineno = 0         # line of weave, 0-based
593
469
 
594
470
        for l in self._weave:
595
 
            if l.__class__ == tuple:
 
471
            if isinstance(l, tuple):
596
472
                c, v = l
597
473
                isactive = None
598
474
                if c == '{':
599
 
                    istack.append(self._names[v])
 
475
                    istack.append(v)
600
476
                elif c == '}':
601
477
                    istack.pop()
602
478
                elif c == '[':
603
 
                    dset.add(self._names[v])
 
479
                    assert v not in dset
 
480
                    dset.add(v)
604
481
                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
 
482
                    dset.remove(v)
 
483
                else:
 
484
                    raise WeaveFormatError('unexpected instruction %r'
 
485
                                           % v)
 
486
            else:
 
487
                assert isinstance(l, basestring)
 
488
                assert istack
 
489
                yield lineno, istack[-1], dset, l
 
490
            lineno += 1
 
491
 
 
492
 
 
493
 
 
494
    def _extract(self, versions):
 
495
        """Yield annotation of lines in included set.
 
496
 
 
497
        Yields a sequence of tuples (origin, lineno, text), where
 
498
        origin is the origin version, lineno the index in the weave,
 
499
        and text the text of the line.
 
500
 
 
501
        The set typically but not necessarily corresponds to a version.
 
502
        """
 
503
        for i in versions:
 
504
            if not isinstance(i, int):
 
505
                raise ValueError(i)
 
506
            
 
507
        included = self.inclusions(versions)
 
508
 
 
509
        istack = []
 
510
        dset = set()
 
511
 
 
512
        lineno = 0         # line of weave, 0-based
 
513
 
 
514
        isactive = None
 
515
 
 
516
        result = []
 
517
 
 
518
        WFE = WeaveFormatError
 
519
 
 
520
        for l in self._weave:
 
521
            if isinstance(l, tuple):
 
522
                c, v = l
 
523
                isactive = None
 
524
                if c == '{':
 
525
                    assert v not in istack
 
526
                    istack.append(v)
 
527
                elif c == '}':
 
528
                    istack.pop()
 
529
                elif c == '[':
 
530
                    if v in included:
 
531
                        assert v not in dset
 
532
                        dset.add(v)
 
533
                else:
 
534
                    assert c == ']'
 
535
                    if v in included:
 
536
                        assert v in dset
 
537
                        dset.remove(v)
 
538
            else:
 
539
                assert isinstance(l, basestring)
 
540
                if isactive is None:
 
541
                    isactive = (not dset) and istack and (istack[-1] in included)
 
542
                if isactive:
 
543
                    result.append((istack[-1], lineno, l))
610
544
            lineno += 1
611
545
 
612
546
        if istack:
613
 
            raise WeaveFormatError("unclosed insertion blocks "
614
 
                    "at end of weave: %s" % istack)
 
547
            raise WFE("unclosed insertion blocks at end of weave",
 
548
                                   istack)
615
549
        if dset:
616
 
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
617
 
                                   % dset)
618
 
 
 
550
            raise WFE("unclosed deletion blocks at end of weave",
 
551
                                   dset)
 
552
 
 
553
        return result
 
554
    
 
555
 
 
556
 
 
557
    def get_iter(self, name_or_index):
 
558
        """Yield lines for the specified version."""
 
559
        incls = [self.maybe_lookup(name_or_index)]
 
560
        for origin, lineno, line in self._extract(incls):
 
561
            yield line
 
562
 
 
563
 
 
564
    def get_text(self, name_or_index):
 
565
        return ''.join(self.get_iter(name_or_index))
 
566
        assert isinstance(version, int)
 
567
 
 
568
 
 
569
    def get_lines(self, name_or_index):
 
570
        return list(self.get_iter(name_or_index))
 
571
 
 
572
 
 
573
    get = get_lines
 
574
 
 
575
 
 
576
    def mash_iter(self, included):
 
577
        """Return composed version of multiple included versions."""
 
578
        included = map(self.maybe_lookup, included)
 
579
        for origin, lineno, text in self._extract(included):
 
580
            yield text
 
581
 
 
582
 
 
583
    def dump(self, to_file):
 
584
        from pprint import pprint
 
585
        print >>to_file, "Weave._weave = ",
 
586
        pprint(self._weave, to_file)
 
587
        print >>to_file, "Weave._parents = ",
 
588
        pprint(self._parents, to_file)
 
589
 
 
590
 
 
591
 
 
592
    def numversions(self):
 
593
        l = len(self._parents)
 
594
        assert l == len(self._sha1s)
 
595
        return l
 
596
 
 
597
 
 
598
    def __len__(self):
 
599
        return self.numversions()
 
600
 
 
601
 
 
602
    def check(self, progress_bar=None):
 
603
        # check no circular inclusions
 
604
        for version in range(self.numversions()):
 
605
            inclusions = list(self._parents[version])
 
606
            if inclusions:
 
607
                inclusions.sort()
 
608
                if inclusions[-1] >= version:
 
609
                    raise WeaveFormatError("invalid included version %d for index %d"
 
610
                                           % (inclusions[-1], version))
 
611
 
 
612
        # try extracting all versions; this is a bit slow and parallel
 
613
        # extraction could be used
 
614
        nv = self.numversions()
 
615
        for version in range(nv):
 
616
            if progress_bar:
 
617
                progress_bar.update('checking text', version, nv)
 
618
            s = sha.new()
 
619
            for l in self.get_iter(version):
 
620
                s.update(l)
 
621
            hd = s.hexdigest()
 
622
            expected = self._sha1s[version]
 
623
            if hd != expected:
 
624
                raise WeaveError("mismatched sha1 for version %d; "
 
625
                                 "got %s, expected %s"
 
626
                                 % (version, hd, expected))
 
627
 
 
628
        # TODO: check insertions are properly nested, that there are
 
629
        # no lines outside of insertion blocks, that deletions are
 
630
        # properly paired, etc.
 
631
 
 
632
 
 
633
 
 
634
    def merge(self, merge_versions):
 
635
        """Automerge and mark conflicts between versions.
 
636
 
 
637
        This returns a sequence, each entry describing alternatives
 
638
        for a chunk of the file.  Each of the alternatives is given as
 
639
        a list of lines.
 
640
 
 
641
        If there is a chunk of the file where there's no diagreement,
 
642
        only one alternative is given.
 
643
        """
 
644
        # approach: find the included versions common to all the
 
645
        # merged versions
 
646
        raise NotImplementedError()
 
647
 
 
648
 
 
649
 
 
650
    def _delta(self, included, lines):
 
651
        """Return changes from basis to new revision.
 
652
 
 
653
        The old text for comparison is the union of included revisions.
 
654
 
 
655
        This is used in inserting a new text.
 
656
 
 
657
        Delta is returned as a sequence of
 
658
        (weave1, weave2, newlines).
 
659
 
 
660
        This indicates that weave1:weave2 of the old weave should be
 
661
        replaced by the sequence of lines in newlines.  Note that
 
662
        these line numbers are positions in the total weave and don't
 
663
        correspond to the lines in any extracted version, or even the
 
664
        extracted union of included versions.
 
665
 
 
666
        If line1=line2, this is a pure insert; if newlines=[] this is a
 
667
        pure delete.  (Similar to difflib.)
 
668
        """
 
669
        raise NotImplementedError()
 
670
 
 
671
            
619
672
    def plan_merge(self, ver_a, ver_b):
620
673
        """Return pseudo-annotation indicating how the two versions merge.
621
674
 
624
677
 
625
678
        Weave lines present in none of them are skipped entirely.
626
679
        """
627
 
        inc_a = set(self.get_ancestry([ver_a]))
628
 
        inc_b = set(self.get_ancestry([ver_b]))
 
680
        inc_a = self.inclusions([ver_a])
 
681
        inc_b = self.inclusions([ver_b])
629
682
        inc_c = inc_a & inc_b
630
683
 
631
 
        for lineno, insert, deleteset, line in self._walk_internal([ver_a, ver_b]):
 
684
        for lineno, insert, deleteset, line in self._walk():
632
685
            if deleteset & inc_c:
633
686
                # killed in parent; can't be in either a or b
634
687
                # not relevant to our work
660
713
                # not in either revision
661
714
                yield 'irrelevant', line
662
715
 
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)
 
716
        yield 'unchanged', ''           # terminator
 
717
 
 
718
 
 
719
 
 
720
    def weave_merge(self, plan):
 
721
        lines_a = []
 
722
        lines_b = []
 
723
        ch_a = ch_b = False
 
724
 
 
725
        for state, line in plan:
 
726
            if state == 'unchanged' or state == 'killed-both':
 
727
                # resync and flush queued conflicts changes if any
 
728
                if not lines_a and not lines_b:
 
729
                    pass
 
730
                elif ch_a and not ch_b:
 
731
                    # one-sided change:                    
 
732
                    for l in lines_a: yield l
 
733
                elif ch_b and not ch_a:
 
734
                    for l in lines_b: yield l
 
735
                elif lines_a == lines_b:
 
736
                    for l in lines_a: yield l
732
737
                else:
733
 
                    raise AssertionError()
 
738
                    yield '<<<<\n'
 
739
                    for l in lines_a: yield l
 
740
                    yield '====\n'
 
741
                    for l in lines_b: yield l
 
742
                    yield '>>>>\n'
 
743
 
 
744
                del lines_a[:]
 
745
                del lines_b[:]
 
746
                ch_a = ch_b = False
 
747
                
 
748
            if state == 'unchanged':
 
749
                if line:
 
750
                    yield line
 
751
            elif state == 'killed-a':
 
752
                ch_a = True
 
753
                lines_b.append(line)
 
754
            elif state == 'killed-b':
 
755
                ch_b = True
 
756
                lines_a.append(line)
 
757
            elif state == 'new-a':
 
758
                ch_a = True
 
759
                lines_a.append(line)
 
760
            elif state == 'new-b':
 
761
                ch_b = True
 
762
                lines_b.append(line)
734
763
            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.
 
764
                assert state in ('irrelevant', 'ghost-a', 'ghost-b', 'killed-base',
 
765
                                 'killed-both'), \
 
766
                       state
 
767
 
 
768
                
 
769
    def join(self, other):
 
770
        """Integrate versions from other into this weave.
 
771
 
 
772
        The resulting weave contains all the history of both weaves; 
 
773
        any version you could retrieve from either self or other can be 
 
774
        retrieved from self after this call.
 
775
 
 
776
        It is illegal for the two weaves to contain different values 
 
777
        for any version.
752
778
        """
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.
 
779
        if other.numversions() == 0:
 
780
            return          # nothing to update, easy
 
781
        # work through in index order to make sure we get all dependencies
 
782
        for other_idx, name in enumerate(other._names):
 
783
            # TODO: If all the parents of the other version are already 
 
784
            # present then we can avoid some work by just taking the delta
 
785
            # and adjusting the offsets.
 
786
            if self._check_version_consistent(other, other_idx, name):
 
787
                continue
 
788
            new_parents = self._imported_parents(other, other_idx)
 
789
            lines = other.get_lines(other_idx)
 
790
            sha1 = other._sha1s[other_idx]
 
791
            self.add(name, new_parents, lines, sha1)
 
792
 
850
793
 
851
794
    def _imported_parents(self, other, other_idx):
852
795
        """Return list of parents in self corresponding to indexes in other."""
853
796
        new_parents = []
854
797
        for parent_idx in other._parents[other_idx]:
855
798
            parent_name = other._names[parent_idx]
856
 
            if parent_name not in self._name_map:
 
799
            if parent_name not in self._names:
857
800
                # should not be possible
858
 
                raise WeaveError("missing parent {%s} of {%s} in %r"
 
801
                raise WeaveError("missing parent {%s} of {%s} in %r" 
859
802
                                 % (parent_name, other._name_map[other_idx], self))
860
803
            new_parents.append(self._name_map[parent_name])
861
804
        return new_parents
868
811
         * the same text
869
812
         * the same direct parents (by name, not index, and disregarding
870
813
           order)
871
 
 
 
814
        
872
815
        If present & correct return True;
873
 
        if not present in self return False;
 
816
        if not present in self return False; 
874
817
        if inconsistent raise error."""
875
818
        this_idx = self._name_map.get(name, -1)
876
819
        if this_idx != -1:
877
820
            if self._sha1s[this_idx] != other._sha1s[other_idx]:
878
 
                raise errors.WeaveTextDiffers(name, self, other)
 
821
                raise WeaveError("inconsistent texts for version {%s} "
 
822
                                 "when joining weaves"
 
823
                                 % (name))
879
824
            self_parents = self._parents[this_idx]
880
825
            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):
884
 
                raise WeaveParentMismatch("inconsistent parents "
885
 
                    "for version {%s}: %s vs %s" % (name, n1, n2))
 
826
            n1 = [self._names[i] for i in self_parents]
 
827
            n2 = [other._names[i] for i in other_parents]
 
828
            n1.sort()
 
829
            n2.sort()
 
830
            if n1 != n2:
 
831
                raise WeaveError("inconsistent parents for version {%s}: "
 
832
                                 "%s vs %s"
 
833
                                 % (name, n1, n2))
886
834
            else:
887
835
                return True         # ok!
888
836
        else:
889
837
            return False
890
838
 
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."""
903
 
        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
 
            f = self._transport.get(name + WeaveFile.WEAVE_SUFFIX)
924
 
            _read_weave_v5(StringIO(f.read()), self)
925
 
        except errors.NoSuchFile:
926
 
            if not create:
927
 
                raise
928
 
            # new file, save it
929
 
            self._save()
930
 
 
931
 
    def _add_lines(self, version_id, parents, lines, parent_texts,
932
 
        left_matching_blocks, nostore_sha, random_id, check_content):
933
 
        """Add a version and save the weave."""
934
 
        self.check_not_reserved_id(version_id)
935
 
        result = super(WeaveFile, self)._add_lines(version_id, parents, lines,
936
 
            parent_texts, left_matching_blocks, nostore_sha, random_id,
937
 
            check_content)
938
 
        self._save()
939
 
        return result
940
 
 
941
 
    def copy_to(self, name, transport):
942
 
        """See VersionedFile.copy_to()."""
943
 
        # as we are all in memory always, just serialise to the new place.
944
 
        sio = StringIO()
945
 
        write_weave_v5(self, sio)
946
 
        sio.seek(0)
947
 
        transport.put_file(name + WeaveFile.WEAVE_SUFFIX, sio, self._filemode)
948
 
 
949
 
    def _save(self):
950
 
        """Save the weave."""
951
 
        self._check_write_ok()
952
 
        sio = StringIO()
953
 
        write_weave_v5(self, sio)
954
 
        sio.seek(0)
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)
962
 
 
963
 
    @staticmethod
964
 
    def get_suffixes():
965
 
        """See VersionedFile.get_suffixes()."""
966
 
        return [WeaveFile.WEAVE_SUFFIX]
967
 
 
968
 
    def insert_record_stream(self, stream):
969
 
        super(WeaveFile, self).insert_record_stream(stream)
970
 
        self._save()
971
 
 
972
 
 
973
 
def _reweave(wa, wb, pb=None, msg=None):
974
 
    """Combine two weaves and return the result.
975
 
 
976
 
    This works even if a revision R has different parents in
977
 
    wa and wb.  In the resulting weave all the parents are given.
978
 
 
979
 
    This is done by just building up a new weave, maintaining ordering
980
 
    of the versions in the two inputs.  More efficient approaches
981
 
    might be possible but it should only be necessary to do
982
 
    this operation rarely, when a new previously ghost version is
983
 
    inserted.
984
 
 
985
 
    :param pb: An optional progress bar, indicating how far done we are
986
 
    :param msg: An optional message for the progress
987
 
    """
988
 
    wr = Weave()
989
 
    ia = ib = 0
990
 
    queue_a = range(wa.num_versions())
991
 
    queue_b = range(wb.num_versions())
992
 
    # first determine combined parents of all versions
993
 
    # map from version name -> all parent names
994
 
    combined_parents = _reweave_parent_graphs(wa, wb)
995
 
    mutter("combined parents: %r", combined_parents)
996
 
    order = tsort.topo_sort(combined_parents.iteritems())
997
 
    mutter("order to reweave: %r", order)
998
 
 
999
 
    if pb and not msg:
1000
 
        msg = 'reweave'
1001
 
 
1002
 
    for idx, name in enumerate(order):
1003
 
        if pb:
1004
 
            pb.update(msg, idx, len(order))
1005
 
        if name in wa._name_map:
1006
 
            lines = wa.get_lines(name)
1007
 
            if name in wb._name_map:
1008
 
                lines_b = wb.get_lines(name)
1009
 
                if lines != lines_b:
1010
 
                    mutter('Weaves differ on content. rev_id {%s}', name)
1011
 
                    mutter('weaves: %s, %s', wa._weave_name, wb._weave_name)
1012
 
                    import difflib
1013
 
                    lines = list(difflib.unified_diff(lines, lines_b,
1014
 
                            wa._weave_name, wb._weave_name))
1015
 
                    mutter('lines:\n%s', ''.join(lines))
1016
 
                    raise errors.WeaveTextDiffers(name, wa, wb)
1017
 
        else:
1018
 
            lines = wb.get_lines(name)
1019
 
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
1020
 
    return wr
1021
 
 
1022
 
 
1023
 
def _reweave_parent_graphs(wa, wb):
1024
 
    """Return combined parent ancestry for two weaves.
1025
 
 
1026
 
    Returned as a list of (version_name, set(parent_names))"""
1027
 
    combined = {}
1028
 
    for weave in [wa, wb]:
1029
 
        for idx, name in enumerate(weave._names):
1030
 
            p = combined.setdefault(name, set())
1031
 
            p.update(map(weave._idx_to_name, weave._parents[idx]))
1032
 
    return combined
 
839
 
 
840
def weave_toc(w):
 
841
    """Show the weave's table-of-contents"""
 
842
    print '%6s %50s %10s %10s' % ('ver', 'name', 'sha1', 'parents')
 
843
    for i in (6, 50, 10, 10):
 
844
        print '-' * i,
 
845
    print
 
846
    for i in range(w.numversions()):
 
847
        sha1 = w._sha1s[i]
 
848
        name = w._names[i]
 
849
        parent_str = ' '.join(map(str, w._parents[i]))
 
850
        print '%6d %-50.50s %10.10s %s' % (i, name, sha1, parent_str)
 
851
 
 
852
 
 
853
 
 
854
def weave_stats(weave_file, pb):
 
855
    from bzrlib.weavefile import read_weave
 
856
 
 
857
    wf = file(weave_file, 'rb')
 
858
    w = read_weave(wf)
 
859
    # FIXME: doesn't work on pipes
 
860
    weave_size = wf.tell()
 
861
 
 
862
    total = 0
 
863
    vers = len(w)
 
864
    for i in range(vers):
 
865
        pb.update('checking sizes', i, vers)
 
866
        for origin, lineno, line in w._extract([i]):
 
867
            total += len(line)
 
868
 
 
869
    pb.clear()
 
870
 
 
871
    print 'versions          %9d' % vers
 
872
    print 'weave file        %9d bytes' % weave_size
 
873
    print 'total contents    %9d bytes' % total
 
874
    print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
 
875
    if vers:
 
876
        avg = total/vers
 
877
        print 'average size      %9d bytes' % avg
 
878
        print 'relative size     %9.2fx' % (float(weave_size) / float(avg))
 
879
 
 
880
 
 
881
def usage():
 
882
    print """bzr weave tool
 
883
 
 
884
Experimental tool for weave algorithm.
 
885
 
 
886
usage:
 
887
    weave init WEAVEFILE
 
888
        Create an empty weave file
 
889
    weave get WEAVEFILE VERSION
 
890
        Write out specified version.
 
891
    weave check WEAVEFILE
 
892
        Check consistency of all versions.
 
893
    weave toc WEAVEFILE
 
894
        Display table of contents.
 
895
    weave add WEAVEFILE NAME [BASE...] < NEWTEXT
 
896
        Add NEWTEXT, with specified parent versions.
 
897
    weave annotate WEAVEFILE VERSION
 
898
        Display origin of each line.
 
899
    weave mash WEAVEFILE VERSION...
 
900
        Display composite of all selected versions.
 
901
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
 
902
        Auto-merge two versions and display conflicts.
 
903
    weave diff WEAVEFILE VERSION1 VERSION2 
 
904
        Show differences between two versions.
 
905
 
 
906
example:
 
907
 
 
908
    % weave init foo.weave
 
909
    % vi foo.txt
 
910
    % weave add foo.weave ver0 < foo.txt
 
911
    added version 0
 
912
 
 
913
    (create updated version)
 
914
    % vi foo.txt
 
915
    % weave get foo.weave 0 | diff -u - foo.txt
 
916
    % weave add foo.weave ver1 0 < foo.txt
 
917
    added version 1
 
918
 
 
919
    % weave get foo.weave 0 > foo.txt       (create forked version)
 
920
    % vi foo.txt
 
921
    % weave add foo.weave ver2 0 < foo.txt
 
922
    added version 2
 
923
 
 
924
    % weave merge foo.weave 1 2 > foo.txt   (merge them)
 
925
    % vi foo.txt                            (resolve conflicts)
 
926
    % weave add foo.weave merged 1 2 < foo.txt     (commit merged version)     
 
927
    
 
928
"""
 
929
    
 
930
 
 
931
 
 
932
def main(argv):
 
933
    import sys
 
934
    import os
 
935
    try:
 
936
        import bzrlib
 
937
    except ImportError:
 
938
        # in case we're run directly from the subdirectory
 
939
        sys.path.append('..')
 
940
        import bzrlib
 
941
    from bzrlib.weavefile import write_weave, read_weave
 
942
    from bzrlib.progress import ProgressBar
 
943
 
 
944
    try:
 
945
        import psyco
 
946
        psyco.full()
 
947
    except ImportError:
 
948
        pass
 
949
 
 
950
    if len(argv) < 2:
 
951
        usage()
 
952
        return 0
 
953
 
 
954
    cmd = argv[1]
 
955
 
 
956
    def readit():
 
957
        return read_weave(file(argv[2], 'rb'))
 
958
    
 
959
    if cmd == 'help':
 
960
        usage()
 
961
    elif cmd == 'add':
 
962
        w = readit()
 
963
        # at the moment, based on everything in the file
 
964
        name = argv[3]
 
965
        parents = map(int, argv[4:])
 
966
        lines = sys.stdin.readlines()
 
967
        ver = w.add(name, parents, lines)
 
968
        write_weave(w, file(argv[2], 'wb'))
 
969
        print 'added version %r %d' % (name, ver)
 
970
    elif cmd == 'init':
 
971
        fn = argv[2]
 
972
        if os.path.exists(fn):
 
973
            raise IOError("file exists")
 
974
        w = Weave()
 
975
        write_weave(w, file(fn, 'wb'))
 
976
    elif cmd == 'get': # get one version
 
977
        w = readit()
 
978
        sys.stdout.writelines(w.get_iter(int(argv[3])))
 
979
        
 
980
    elif cmd == 'mash': # get composite
 
981
        w = readit()
 
982
        sys.stdout.writelines(w.mash_iter(map(int, argv[3:])))
 
983
 
 
984
    elif cmd == 'diff':
 
985
        from difflib import unified_diff
 
986
        w = readit()
 
987
        fn = argv[2]
 
988
        v1, v2 = map(int, argv[3:5])
 
989
        lines1 = w.get(v1)
 
990
        lines2 = w.get(v2)
 
991
        diff_gen = unified_diff(lines1, lines2,
 
992
                                '%s version %d' % (fn, v1),
 
993
                                '%s version %d' % (fn, v2))
 
994
        sys.stdout.writelines(diff_gen)
 
995
            
 
996
    elif cmd == 'annotate':
 
997
        w = readit()
 
998
        # newline is added to all lines regardless; too hard to get
 
999
        # reasonable formatting otherwise
 
1000
        lasto = None
 
1001
        for origin, text in w.annotate(int(argv[3])):
 
1002
            text = text.rstrip('\r\n')
 
1003
            if origin == lasto:
 
1004
                print '      | %s' % (text)
 
1005
            else:
 
1006
                print '%5d | %s' % (origin, text)
 
1007
                lasto = origin
 
1008
                
 
1009
    elif cmd == 'toc':
 
1010
        weave_toc(readit())
 
1011
 
 
1012
    elif cmd == 'stats':
 
1013
        weave_stats(argv[2], ProgressBar())
 
1014
        
 
1015
    elif cmd == 'check':
 
1016
        w = readit()
 
1017
        pb = ProgressBar()
 
1018
        w.check(pb)
 
1019
        pb.clear()
 
1020
        print '%d versions ok' % w.numversions()
 
1021
 
 
1022
    elif cmd == 'inclusions':
 
1023
        w = readit()
 
1024
        print ' '.join(map(str, w.inclusions([int(argv[3])])))
 
1025
 
 
1026
    elif cmd == 'parents':
 
1027
        w = readit()
 
1028
        print ' '.join(map(str, w._parents[int(argv[3])]))
 
1029
 
 
1030
    elif cmd == 'plan-merge':
 
1031
        w = readit()
 
1032
        for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
 
1033
            if line:
 
1034
                print '%14s | %s' % (state, line),
 
1035
 
 
1036
    elif cmd == 'merge':
 
1037
        w = readit()
 
1038
        p = w.plan_merge(int(argv[3]), int(argv[4]))
 
1039
        sys.stdout.writelines(w.weave_merge(p))
 
1040
            
 
1041
    elif cmd == 'mash-merge':
 
1042
        if len(argv) != 5:
 
1043
            usage()
 
1044
            return 1
 
1045
 
 
1046
        w = readit()
 
1047
        v1, v2 = map(int, argv[3:5])
 
1048
 
 
1049
        basis = w.inclusions([v1]).intersection(w.inclusions([v2]))
 
1050
 
 
1051
        base_lines = list(w.mash_iter(basis))
 
1052
        a_lines = list(w.get(v1))
 
1053
        b_lines = list(w.get(v2))
 
1054
 
 
1055
        from bzrlib.merge3 import Merge3
 
1056
        m3 = Merge3(base_lines, a_lines, b_lines)
 
1057
 
 
1058
        name_a = 'version %d' % v1
 
1059
        name_b = 'version %d' % v2
 
1060
        sys.stdout.writelines(m3.merge_lines(name_a=name_a, name_b=name_b))
 
1061
    else:
 
1062
        raise ValueError('unknown command %r' % cmd)
 
1063
    
 
1064
 
 
1065
 
 
1066
def profile_main(argv): 
 
1067
    import tempfile, hotshot, hotshot.stats
 
1068
 
 
1069
    prof_f = tempfile.NamedTemporaryFile()
 
1070
 
 
1071
    prof = hotshot.Profile(prof_f.name)
 
1072
 
 
1073
    ret = prof.runcall(main, argv)
 
1074
    prof.close()
 
1075
 
 
1076
    stats = hotshot.stats.load(prof_f.name)
 
1077
    #stats.strip_dirs()
 
1078
    stats.sort_stats('cumulative')
 
1079
    ## XXX: Might like to write to stderr or the trace file instead but
 
1080
    ## print_stats seems hardcoded to stdout
 
1081
    stats.print_stats(20)
 
1082
            
 
1083
    return ret
 
1084
 
 
1085
 
 
1086
if __name__ == '__main__':
 
1087
    import sys
 
1088
    if '--profile' in sys.argv:
 
1089
        args = sys.argv[:]
 
1090
        args.remove('--profile')
 
1091
        sys.exit(profile_main(args))
 
1092
    else:
 
1093
        sys.exit(main(sys.argv))
 
1094