/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/weave.py
1
 
#! /usr/bin/python
2
 
 
3
 
# Copyright (C) 2005 Canonical Ltd
4
 
 
 
1
# Copyright (C) 2005, 2009 Canonical Ltd
 
2
#
5
3
# This program is free software; you can redistribute it and/or modify
6
4
# it under the terms of the GNU General Public License as published by
7
5
# the Free Software Foundation; either version 2 of the License, or
8
6
# (at your option) any later version.
9
 
 
 
7
#
10
8
# This program is distributed in the hope that it will be useful,
11
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13
11
# GNU General Public License for more details.
14
 
 
 
12
#
15
13
# You should have received a copy of the GNU General Public License
16
14
# along with this program; if not, write to the Free Software
17
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
16
 
19
17
# Author: Martin Pool <mbp@canonical.com>
20
18
 
21
19
 
22
20
"""Weave - storage of related text file versions"""
23
21
 
24
 
# before intset (r923) 2000 versions in 41.5s
25
 
# with intset (r926) 2000 versions in 93s !!!
26
 
# better to just use plain sets.
27
 
 
28
 
# making _extract build and return a list, rather than being a generator
29
 
# takes 37.94s
30
 
 
31
 
# with python -O, r923 does 2000 versions in 36.87s
32
 
 
33
 
# with optimizations to avoid mutating lists - 35.75!  I guess copying
34
 
# all the elements every time costs more than the small manipulations.
35
 
# a surprisingly small change.
36
 
 
37
 
# r931, which avoids using a generator for extract, does 36.98s
38
 
 
39
 
# with memoized inclusions, takes 41.49s; not very good
40
 
 
41
 
# with slots, takes 37.35s; without takes 39.16, a bit surprising
42
 
 
43
 
# with the delta calculation mixed in with the add method, rather than
44
 
# separated, takes 36.78s
45
 
 
46
 
# with delta folded in and mutation of the list, 36.13s
47
 
 
48
 
# with all this and simplification of add code, 33s
49
 
 
50
 
 
51
 
 
52
 
 
53
 
 
54
 
# TODO: Perhaps have copy method for Weave instances?
55
22
 
56
23
# XXX: If we do weaves this way, will a merge still behave the same
57
24
# way if it's done in a different order?  That's a pretty desirable
58
25
# property.
59
26
 
60
27
# TODO: Nothing here so far assumes the lines are really \n newlines,
61
 
# rather than being split up in some other way.  We could accomodate
 
28
# rather than being split up in some other way.  We could accommodate
62
29
# binaries, perhaps by naively splitting on \n or perhaps using
63
30
# something like a rolling checksum.
64
31
 
74
41
 
75
42
# TODO: Parallel-extract that passes back each line along with a
76
43
# description of which revisions include it.  Nice for checking all
77
 
# shas in parallel.
 
44
# shas or calculating stats in parallel.
78
45
 
79
46
# TODO: Using a single _extract routine and then processing the output
80
47
# is probably inefficient.  It's simple enough that we can afford to
81
48
# have slight specializations for different ways its used: annotate,
82
49
# basis for add, get, etc.
83
50
 
84
 
# TODO: Perhaps the API should work only in names to hide the integer
85
 
# indexes from the user?
 
51
# TODO: Probably the API should work only in names to hide the integer
 
52
# indexes from the user.
86
53
 
87
54
# TODO: Is there any potential performance win by having an add()
88
55
# variant that is passed a pre-cooked version of the single basis
89
56
# version?
90
57
 
91
 
 
92
 
 
93
 
import sha
94
 
from difflib import SequenceMatcher
95
 
 
96
 
 
97
 
from bzrlib.osutils import sha_strings
98
 
 
99
 
 
100
 
class WeaveError(Exception):
101
 
    """Exception in processing weave"""
102
 
 
103
 
 
104
 
class WeaveFormatError(WeaveError):
105
 
    """Weave invariant violated"""
106
 
    
107
 
 
108
 
class Weave(object):
 
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):
109
127
    """weave - versioned text file storage.
110
 
    
 
128
 
111
129
    A Weave manages versions of line-based text files, keeping track
112
130
    of the originating version for each line.
113
131
 
159
177
 
160
178
    * It doesn't seem very useful to have an active insertion
161
179
      inside an inactive insertion, but it might happen.
162
 
      
 
180
 
163
181
    * Therefore, all instructions are always"considered"; that
164
182
      is passed onto and off the stack.  An outer inactive block
165
183
      doesn't disable an inner block.
195
213
    """
196
214
 
197
215
    __slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map',
198
 
                 '_weave_name']
199
 
    
200
 
    def __init__(self, weave_name=None):
 
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__()
201
227
        self._weave = []
202
228
        self._parents = []
203
229
        self._sha1s = []
204
230
        self._names = []
205
231
        self._name_map = {}
206
232
        self._weave_name = weave_name
207
 
 
 
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)
 
253
 
 
254
    def copy(self):
 
255
        """Return a deep copy of self.
 
256
 
 
257
        The copy can be modified without affecting the original weave."""
 
258
        other = Weave()
 
259
        other._weave = self._weave[:]
 
260
        other._parents = self._parents[:]
 
261
        other._sha1s = self._sha1s[:]
 
262
        other._names = self._names[:]
 
263
        other._name_map = self._name_map.copy()
 
264
        other._weave_name = self._weave_name
 
265
        return other
208
266
 
209
267
    def __eq__(self, other):
210
268
        if not isinstance(other, Weave):
211
269
            return False
212
270
        return self._parents == other._parents \
213
271
               and self._weave == other._weave \
214
 
               and self._sha1s == other._sha1s 
 
272
               and self._sha1s == other._sha1s
215
273
 
216
 
    
217
274
    def __ne__(self, other):
218
275
        return not self.__eq__(other)
219
276
 
220
 
 
221
 
    def maybe_lookup(self, name_or_index):
222
 
        """Convert possible symbolic name to index, or pass through indexes."""
223
 
        if isinstance(name_or_index, (int, long)):
224
 
            return name_or_index
225
 
        else:
226
 
            return self.lookup(name_or_index)
227
 
 
228
 
        
229
 
    def lookup(self, name):
 
277
    def _idx_to_name(self, version):
 
278
        return self._names[version]
 
279
 
 
280
    def _lookup(self, name):
230
281
        """Convert symbolic version name to index."""
 
282
        if not self._allow_reserved:
 
283
            self.check_not_reserved_id(name)
231
284
        try:
232
285
            return self._name_map[name]
233
286
        except KeyError:
234
 
            raise WeaveError("name %r not present in weave %r" %
235
 
                             (name, self._weave_name))
236
 
 
237
 
 
238
 
    def idx_to_name(self, version):
239
 
        return self._names[version]
240
 
 
 
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
241
379
 
242
380
    def _check_repeated_add(self, name, parents, text, sha1):
243
381
        """Check that a duplicated add is OK.
244
382
 
245
383
        If it is, return the (old) index; otherwise raise an exception.
246
384
        """
247
 
        idx = self.lookup(name)
248
 
        if sorted(self._parents[idx]) != sorted(parents):
249
 
            raise WeaveError("name \"%s\" already present in weave "
250
 
                             "with different parents" % name)
251
 
        if sha1 != self._sha1s[idx]:
252
 
            raise WeaveError("name \"%s\" already present in weave "
253
 
                             "with different text" % name)            
 
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)
254
389
        return idx
255
 
        
256
 
 
257
 
        
258
 
    def add(self, name, parents, text, sha1=None):
 
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):
259
399
        """Add a single text on top of the weave.
260
 
  
 
400
 
261
401
        Returns the index number of the newly added version.
262
402
 
263
 
        name
 
403
        version_id
264
404
            Symbolic name for this version.
265
405
            (Typically the revision-id of the revision that added it.)
 
406
            If None, a name will be allocated based on the hash. (sha1:SHAHASH)
266
407
 
267
408
        parents
268
409
            List or set of direct parent version numbers.
269
 
            
270
 
        text
 
410
 
 
411
        lines
271
412
            Sequence of lines to be added in the new version.
272
413
 
273
 
        sha -- SHA-1 of the file, if known.  This is trusted to be
274
 
            correct if supplied.
 
414
        :param nostore_sha: See VersionedFile.add_lines.
275
415
        """
276
 
 
277
 
        assert isinstance(name, basestring)
278
 
        if sha1 is None:
279
 
            sha1 = sha_strings(text)
280
 
        if name in self._name_map:
281
 
            return self._check_repeated_add(name, parents, text, sha1)
282
 
 
283
 
        parents = map(self.maybe_lookup, parents)
 
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
 
284
427
        self._check_versions(parents)
285
 
        ## self._check_lines(text)
 
428
        ## self._check_lines(lines)
286
429
        new_version = len(self._parents)
287
430
 
288
 
 
289
431
        # if we abort after here the (in-memory) weave will be corrupt because only
290
432
        # some fields are updated
 
433
        # XXX: FIXME implement a succeed-or-fail of the rest of this routine.
 
434
        #      - Robert Collins 20060226
291
435
        self._parents.append(parents[:])
292
436
        self._sha1s.append(sha1)
293
 
        self._names.append(name)
294
 
        self._name_map[name] = new_version
295
 
 
296
 
            
 
437
        self._names.append(version_id)
 
438
        self._name_map[version_id] = new_version
 
439
 
 
440
 
297
441
        if not parents:
298
442
            # special case; adding with no parents revision; can do
299
443
            # this more quickly by just appending unconditionally.
300
444
            # even more specially, if we're adding an empty text we
301
445
            # need do nothing at all.
302
 
            if text:
 
446
            if lines:
303
447
                self._weave.append(('{', new_version))
304
 
                self._weave.extend(text)
 
448
                self._weave.extend(lines)
305
449
                self._weave.append(('}', None))
306
 
        
307
450
            return new_version
308
451
 
309
452
        if len(parents) == 1:
311
454
            if sha1 == self._sha1s[pv]:
312
455
                # special case: same as the single parent
313
456
                return new_version
314
 
            
315
 
 
316
 
        ancestors = self.inclusions(parents)
 
457
 
 
458
 
 
459
        ancestors = self._inclusions(parents)
317
460
 
318
461
        l = self._weave
319
462
 
326
469
 
327
470
        # another small special case: a merge, producing the same text
328
471
        # as auto-merge
329
 
        if text == basis_lines:
330
 
            return new_version            
 
472
        if lines == basis_lines:
 
473
            return new_version
331
474
 
332
 
        # add a sentinal, because we can also match against the final line
 
475
        # add a sentinel, because we can also match against the final line
333
476
        basis_lineno.append(len(self._weave))
334
477
 
335
478
        # XXX: which line of the weave should we really consider
339
482
        #print 'basis_lines:', basis_lines
340
483
        #print 'new_lines:  ', lines
341
484
 
342
 
        s = SequenceMatcher(None, basis_lines, text)
 
485
        s = self._matcher(None, basis_lines, lines)
343
486
 
344
487
        # offset gives the number of lines that have been inserted
345
488
        # into the weave up to the current point; if the original edit instruction
352
495
            #print 'raw match', tag, i1, i2, j1, j2
353
496
            if tag == 'equal':
354
497
                continue
355
 
 
356
498
            i1 = basis_lineno[i1]
357
499
            i2 = basis_lineno[i2]
358
 
 
359
 
            assert 0 <= j1 <= j2 <= len(text)
360
 
 
361
 
            #print tag, i1, i2, j1, j2
362
 
 
363
500
            # the deletion and insertion are handled separately.
364
501
            # first delete the region.
365
502
            if i1 != i2:
372
509
                # i2; we want to insert after this region to make sure
373
510
                # we don't destroy ourselves
374
511
                i = i2 + offset
375
 
                self._weave[i:i] = ([('{', new_version)] 
376
 
                                    + text[j1:j2] 
 
512
                self._weave[i:i] = ([('{', new_version)]
 
513
                                    + lines[j1:j2]
377
514
                                    + [('}', None)])
378
515
                offset += 2 + (j2 - j1)
379
 
 
380
516
        return new_version
381
517
 
382
 
 
383
 
    def inclusions(self, versions):
 
518
    def _inclusions(self, versions):
384
519
        """Return set of all ancestors of given version(s)."""
 
520
        if not len(versions):
 
521
            return []
385
522
        i = set(versions)
386
523
        for v in xrange(max(versions), 0, -1):
387
524
            if v in i:
391
528
        ## except IndexError:
392
529
        ##     raise ValueError("version %d not present in weave" % v)
393
530
 
394
 
 
395
 
    def parents(self, version):
396
 
        return self._parents[version]
397
 
 
398
 
 
399
 
    def minimal_parents(self, version):
400
 
        """Find the minimal set of parents for the version."""
401
 
        included = self._parents[version]
402
 
        if not included:
403
 
            return []
404
 
        
405
 
        li = list(included)
406
 
        li.sort(reverse=True)
407
 
 
408
 
        mininc = []
409
 
        gotit = set()
410
 
 
411
 
        for pv in li:
412
 
            if pv not in gotit:
413
 
                mininc.append(pv)
414
 
                gotit.update(self.inclusions(pv))
415
 
 
416
 
        assert mininc[0] >= 0
417
 
        assert mininc[-1] < version
418
 
        return mininc
419
 
 
420
 
 
 
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]
421
537
 
422
538
    def _check_lines(self, text):
423
539
        if not isinstance(text, list):
427
543
            if not isinstance(l, basestring):
428
544
                raise ValueError("text line should be a string or unicode, not %s"
429
545
                                 % type(l))
430
 
        
 
546
 
431
547
 
432
548
 
433
549
    def _check_versions(self, indexes):
438
554
            except IndexError:
439
555
                raise IndexError("invalid version number %r" % i)
440
556
 
441
 
    
442
 
    def annotate(self, name_or_index):
443
 
        return list(self.annotate_iter(name_or_index))
444
 
 
445
 
 
446
 
    def annotate_iter(self, name_or_index):
447
 
        """Yield list of (index-id, line) pairs for the specified version.
 
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.
448
567
 
449
568
        The index indicates when the line originated in the weave."""
450
 
        incls = [self.maybe_lookup(name_or_index)]
451
 
        for origin, lineno, text in self._extract(incls):
452
 
            yield origin, text
453
 
 
454
 
 
455
 
    def _walk(self):
456
 
        """Walk the weave.
457
 
 
458
 
        Yields sequence of
459
 
        (lineno, insert, deletes, text)
460
 
        for each literal line.
461
 
        """
462
 
        
 
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
 
463
589
        istack = []
464
590
        dset = set()
465
591
 
466
592
        lineno = 0         # line of weave, 0-based
467
593
 
468
594
        for l in self._weave:
469
 
            if isinstance(l, tuple):
 
595
            if l.__class__ == tuple:
470
596
                c, v = l
471
597
                isactive = None
472
598
                if c == '{':
473
 
                    istack.append(v)
 
599
                    istack.append(self._names[v])
474
600
                elif c == '}':
475
601
                    istack.pop()
476
602
                elif c == '[':
477
 
                    assert v not in dset
478
 
                    dset.add(v)
 
603
                    dset.add(self._names[v])
479
604
                elif c == ']':
480
 
                    dset.remove(v)
 
605
                    dset.remove(self._names[v])
481
606
                else:
482
 
                    raise WeaveFormatError('unexpected instruction %r'
483
 
                                           % v)
 
607
                    raise WeaveFormatError('unexpected instruction %r' % v)
484
608
            else:
485
 
                assert isinstance(l, basestring)
486
 
                assert istack
487
 
                yield lineno, istack[-1], dset, l
 
609
                yield lineno, istack[-1], frozenset(dset), l
488
610
            lineno += 1
489
611
 
490
 
 
 
612
        if istack:
 
613
            raise WeaveFormatError("unclosed insertion blocks "
 
614
                    "at end of weave: %s" % istack)
 
615
        if dset:
 
616
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
 
617
                                   % dset)
 
618
 
 
619
    def plan_merge(self, ver_a, ver_b):
 
620
        """Return pseudo-annotation indicating how the two versions merge.
 
621
 
 
622
        This is computed between versions a and b and their common
 
623
        base.
 
624
 
 
625
        Weave lines present in none of them are skipped entirely.
 
626
        """
 
627
        inc_a = set(self.get_ancestry([ver_a]))
 
628
        inc_b = set(self.get_ancestry([ver_b]))
 
629
        inc_c = inc_a & inc_b
 
630
 
 
631
        for lineno, insert, deleteset, line in self._walk_internal([ver_a, ver_b]):
 
632
            if deleteset & inc_c:
 
633
                # killed in parent; can't be in either a or b
 
634
                # not relevant to our work
 
635
                yield 'killed-base', line
 
636
            elif insert in inc_c:
 
637
                # was inserted in base
 
638
                killed_a = bool(deleteset & inc_a)
 
639
                killed_b = bool(deleteset & inc_b)
 
640
                if killed_a and killed_b:
 
641
                    yield 'killed-both', line
 
642
                elif killed_a:
 
643
                    yield 'killed-a', line
 
644
                elif killed_b:
 
645
                    yield 'killed-b', line
 
646
                else:
 
647
                    yield 'unchanged', line
 
648
            elif insert in inc_a:
 
649
                if deleteset & inc_a:
 
650
                    yield 'ghost-a', line
 
651
                else:
 
652
                    # new in A; not in B
 
653
                    yield 'new-a', line
 
654
            elif insert in inc_b:
 
655
                if deleteset & inc_b:
 
656
                    yield 'ghost-b', line
 
657
                else:
 
658
                    yield 'new-b', line
 
659
            else:
 
660
                # not in either revision
 
661
                yield 'irrelevant', line
491
662
 
492
663
    def _extract(self, versions):
493
664
        """Yield annotation of lines in included set.
501
672
        for i in versions:
502
673
            if not isinstance(i, int):
503
674
                raise ValueError(i)
504
 
            
505
 
        included = self.inclusions(versions)
 
675
 
 
676
        included = self._inclusions(versions)
506
677
 
507
678
        istack = []
 
679
        iset = set()
508
680
        dset = set()
509
681
 
510
682
        lineno = 0         # line of weave, 0-based
515
687
 
516
688
        WFE = WeaveFormatError
517
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
 
518
717
        for l in self._weave:
519
 
            if isinstance(l, tuple):
 
718
            if l.__class__ == tuple:
520
719
                c, v = l
521
720
                isactive = None
522
721
                if c == '{':
523
 
                    assert v not in istack
524
722
                    istack.append(v)
 
723
                    iset.add(v)
525
724
                elif c == '}':
526
 
                    istack.pop()
 
725
                    iset.remove(istack.pop())
527
726
                elif c == '[':
528
727
                    if v in included:
529
 
                        assert v not in dset
530
728
                        dset.add(v)
531
 
                else:
532
 
                    assert c == ']'
 
729
                elif c == ']':
533
730
                    if v in included:
534
 
                        assert v in dset
535
731
                        dset.remove(v)
 
732
                else:
 
733
                    raise AssertionError()
536
734
            else:
537
 
                assert isinstance(l, basestring)
538
735
                if isactive is None:
539
736
                    isactive = (not dset) and istack and (istack[-1] in included)
540
737
                if isactive:
541
738
                    result.append((istack[-1], lineno, l))
542
739
            lineno += 1
543
 
 
544
740
        if istack:
545
 
            raise WFE("unclosed insertion blocks at end of weave",
546
 
                                   istack)
 
741
            raise WeaveFormatError("unclosed insertion blocks "
 
742
                    "at end of weave: %s" % istack)
547
743
        if dset:
548
 
            raise WFE("unclosed deletion blocks at end of weave",
549
 
                                   dset)
550
 
 
551
 
        return result
552
 
    
553
 
 
554
 
 
555
 
    def get_iter(self, name_or_index):
556
 
        """Yield lines for the specified version."""
557
 
        incls = [self.maybe_lookup(name_or_index)]
558
 
        for origin, lineno, line in self._extract(incls):
559
 
            yield line
560
 
 
561
 
 
562
 
    def get_text(self, name_or_index):
563
 
        return ''.join(self.get_iter(name_or_index))
564
 
        assert isinstance(version, int)
565
 
 
566
 
 
567
 
    def get_lines(self, name_or_index):
568
 
        return list(self.get_iter(name_or_index))
569
 
 
570
 
 
571
 
    get = get_lines
572
 
 
573
 
 
574
 
    def mash_iter(self, included):
575
 
        """Return composed version of multiple included versions."""
576
 
        included = map(self.maybe_lookup, included)
577
 
        for origin, lineno, text in self._extract(included):
578
 
            yield text
579
 
 
580
 
 
581
 
    def dump(self, to_file):
582
 
        from pprint import pprint
583
 
        print >>to_file, "Weave._weave = ",
584
 
        pprint(self._weave, to_file)
585
 
        print >>to_file, "Weave._parents = ",
586
 
        pprint(self._parents, to_file)
587
 
 
588
 
 
589
 
 
590
 
    def numversions(self):
 
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.
 
752
        """
 
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?"""
591
780
        l = len(self._parents)
592
 
        assert l == len(self._sha1s)
593
781
        return l
594
782
 
595
 
 
596
 
    def __len__(self):
597
 
        return self.numversions()
598
 
 
 
783
    __len__ = num_versions
599
784
 
600
785
    def check(self, progress_bar=None):
601
 
        # check no circular inclusions
602
 
        for version in range(self.numversions()):
 
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()):
603
790
            inclusions = list(self._parents[version])
604
791
            if inclusions:
605
792
                inclusions.sort()
607
794
                    raise WeaveFormatError("invalid included version %d for index %d"
608
795
                                           % (inclusions[-1], version))
609
796
 
610
 
        # try extracting all versions; this is a bit slow and parallel
611
 
        # extraction could be used
612
 
        nv = self.numversions()
613
 
        for version in range(nv):
 
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():
614
827
            if progress_bar:
615
 
                progress_bar.update('checking text', version, nv)
616
 
            s = sha.new()
617
 
            for l in self.get_iter(version):
618
 
                s.update(l)
619
 
            hd = s.hexdigest()
620
 
            expected = self._sha1s[version]
 
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]
621
841
            if hd != expected:
622
 
                raise WeaveError("mismatched sha1 for version %d; "
623
 
                                 "got %s, expected %s"
624
 
                                 % (version, hd, expected))
 
842
                raise errors.WeaveInvalidChecksum(
 
843
                        "mismatched sha1 for version %s: "
 
844
                        "got %s, expected %s"
 
845
                        % (version, hd, expected))
625
846
 
626
847
        # TODO: check insertions are properly nested, that there are
627
848
        # no lines outside of insertion blocks, that deletions are
628
849
        # properly paired, etc.
629
850
 
630
 
 
631
 
 
632
 
    def merge(self, merge_versions):
633
 
        """Automerge and mark conflicts between versions.
634
 
 
635
 
        This returns a sequence, each entry describing alternatives
636
 
        for a chunk of the file.  Each of the alternatives is given as
637
 
        a list of lines.
638
 
 
639
 
        If there is a chunk of the file where there's no diagreement,
640
 
        only one alternative is given.
641
 
        """
642
 
 
643
 
        # approach: find the included versions common to all the
644
 
        # merged versions
645
 
        raise NotImplementedError()
646
 
 
647
 
 
648
 
 
649
 
    def _delta(self, included, lines):
650
 
        """Return changes from basis to new revision.
651
 
 
652
 
        The old text for comparison is the union of included revisions.
653
 
 
654
 
        This is used in inserting a new text.
655
 
 
656
 
        Delta is returned as a sequence of
657
 
        (weave1, weave2, newlines).
658
 
 
659
 
        This indicates that weave1:weave2 of the old weave should be
660
 
        replaced by the sequence of lines in newlines.  Note that
661
 
        these line numbers are positions in the total weave and don't
662
 
        correspond to the lines in any extracted version, or even the
663
 
        extracted union of included versions.
664
 
 
665
 
        If line1=line2, this is a pure insert; if newlines=[] this is a
666
 
        pure delete.  (Similar to difflib.)
667
 
        """
668
 
 
669
 
 
670
 
            
671
 
    def plan_merge(self, ver_a, ver_b):
672
 
        """Return pseudo-annotation indicating how the two versions merge.
673
 
 
674
 
        This is computed between versions a and b and their common
675
 
        base.
676
 
 
677
 
        Weave lines present in none of them are skipped entirely.
678
 
        """
679
 
        inc_a = self.inclusions([ver_a])
680
 
        inc_b = self.inclusions([ver_b])
681
 
        inc_c = inc_a & inc_b
682
 
 
683
 
        for lineno, insert, deleteset, line in self._walk():
684
 
            if deleteset & inc_c:
685
 
                # killed in parent; can't be in either a or b
686
 
                # not relevant to our work
687
 
                yield 'killed-base', line
688
 
            elif insert in inc_c:
689
 
                # was inserted in base
690
 
                killed_a = bool(deleteset & inc_a)
691
 
                killed_b = bool(deleteset & inc_b)
692
 
                if killed_a and killed_b:
693
 
                    yield 'killed-both', line
694
 
                elif killed_a:
695
 
                    yield 'killed-a', line
696
 
                elif killed_b:
697
 
                    yield 'killed-b', line
698
 
                else:
699
 
                    yield 'unchanged', line
700
 
            elif insert in inc_a:
701
 
                if deleteset & inc_a:
702
 
                    yield 'ghost-a', line
703
 
                else:
704
 
                    # new in A; not in B
705
 
                    yield 'new-a', line
706
 
            elif insert in inc_b:
707
 
                if deleteset & inc_b:
708
 
                    yield 'ghost-b', line
709
 
                else:
710
 
                    yield 'new-b', line
711
 
            else:
712
 
                # not in either revision
713
 
                yield 'irrelevant', line
714
 
 
715
 
        yield 'unchanged', ''           # terminator
716
 
 
717
 
 
718
 
 
719
 
    def weave_merge(self, plan):
720
 
        lines_a = []
721
 
        lines_b = []
722
 
        ch_a = ch_b = False
723
 
 
724
 
        for state, line in plan:
725
 
            if state == 'unchanged' or state == 'killed-both':
726
 
                # resync and flush queued conflicts changes if any
727
 
                if not lines_a and not lines_b:
728
 
                    pass
729
 
                elif ch_a and not ch_b:
730
 
                    # one-sided change:                    
731
 
                    for l in lines_a: yield l
732
 
                elif ch_b and not ch_a:
733
 
                    for l in lines_b: yield l
734
 
                elif lines_a == lines_b:
735
 
                    for l in lines_a: yield l
736
 
                else:
737
 
                    yield '<<<<\n'
738
 
                    for l in lines_a: yield l
739
 
                    yield '====\n'
740
 
                    for l in lines_b: yield l
741
 
                    yield '>>>>\n'
742
 
 
743
 
                del lines_a[:]
744
 
                del lines_b[:]
745
 
                ch_a = ch_b = False
746
 
                
747
 
            if state == 'unchanged':
748
 
                if line:
749
 
                    yield line
750
 
            elif state == 'killed-a':
751
 
                ch_a = True
752
 
                lines_b.append(line)
753
 
            elif state == 'killed-b':
754
 
                ch_b = True
755
 
                lines_a.append(line)
756
 
            elif state == 'new-a':
757
 
                ch_a = True
758
 
                lines_a.append(line)
759
 
            elif state == 'new-b':
760
 
                ch_b = True
761
 
                lines_b.append(line)
762
 
            else:
763
 
                assert state in ('irrelevant', 'ghost-a', 'ghost-b', 'killed-base',
764
 
                                 'killed-both'), \
765
 
                       state
766
 
 
767
 
                
768
 
 
769
 
 
770
 
 
771
 
 
772
 
 
773
 
def weave_toc(w):
774
 
    """Show the weave's table-of-contents"""
775
 
    print '%6s %50s %10s %10s' % ('ver', 'name', 'sha1', 'parents')
776
 
    for i in (6, 50, 10, 10):
777
 
        print '-' * i,
778
 
    print
779
 
    for i in range(w.numversions()):
780
 
        sha1 = w._sha1s[i]
781
 
        name = w._names[i]
782
 
        parent_str = ' '.join(map(str, w._parents[i]))
783
 
        print '%6d %-50.50s %10.10s %s' % (i, name, sha1, parent_str)
784
 
 
785
 
 
786
 
 
787
 
def weave_stats(weave_file):
788
 
    from bzrlib.progress import ProgressBar
789
 
    from bzrlib.weavefile import read_weave
790
 
 
791
 
    pb = ProgressBar()
792
 
 
793
 
    wf = file(weave_file, 'rb')
794
 
    w = read_weave(wf)
795
 
    # FIXME: doesn't work on pipes
796
 
    weave_size = wf.tell()
797
 
 
798
 
    total = 0
799
 
    vers = len(w)
800
 
    for i in range(vers):
801
 
        pb.update('checking sizes', i, vers)
802
 
        for line in w.get_iter(i):
803
 
            total += len(line)
804
 
 
805
 
    pb.clear()
806
 
 
807
 
    print 'versions          %9d' % vers
808
 
    print 'weave file        %9d bytes' % weave_size
809
 
    print 'total contents    %9d bytes' % total
810
 
    print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
811
 
    if vers:
812
 
        avg = total/vers
813
 
        print 'average size      %9d bytes' % avg
814
 
        print 'relative size     %9.2fx' % (float(weave_size) / float(avg))
815
 
 
816
 
 
817
 
def usage():
818
 
    print """bzr weave tool
819
 
 
820
 
Experimental tool for weave algorithm.
821
 
 
822
 
usage:
823
 
    weave init WEAVEFILE
824
 
        Create an empty weave file
825
 
    weave get WEAVEFILE VERSION
826
 
        Write out specified version.
827
 
    weave check WEAVEFILE
828
 
        Check consistency of all versions.
829
 
    weave toc WEAVEFILE
830
 
        Display table of contents.
831
 
    weave add WEAVEFILE NAME [BASE...] < NEWTEXT
832
 
        Add NEWTEXT, with specified parent versions.
833
 
    weave annotate WEAVEFILE VERSION
834
 
        Display origin of each line.
835
 
    weave mash WEAVEFILE VERSION...
836
 
        Display composite of all selected versions.
837
 
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
838
 
        Auto-merge two versions and display conflicts.
839
 
    weave diff WEAVEFILE VERSION1 VERSION2 
840
 
        Show differences between two versions.
841
 
 
842
 
example:
843
 
 
844
 
    % weave init foo.weave
845
 
    % vi foo.txt
846
 
    % weave add foo.weave ver0 < foo.txt
847
 
    added version 0
848
 
 
849
 
    (create updated version)
850
 
    % vi foo.txt
851
 
    % weave get foo.weave 0 | diff -u - foo.txt
852
 
    % weave add foo.weave ver1 0 < foo.txt
853
 
    added version 1
854
 
 
855
 
    % weave get foo.weave 0 > foo.txt       (create forked version)
856
 
    % vi foo.txt
857
 
    % weave add foo.weave ver2 0 < foo.txt
858
 
    added version 2
859
 
 
860
 
    % weave merge foo.weave 1 2 > foo.txt   (merge them)
861
 
    % vi foo.txt                            (resolve conflicts)
862
 
    % weave add foo.weave merged 1 2 < foo.txt     (commit merged version)     
863
 
    
864
 
"""
865
 
    
866
 
 
867
 
 
868
 
def main(argv):
869
 
    import sys
870
 
    import os
871
 
    from bzrlib.weavefile import write_weave, read_weave
872
 
    from bzrlib.progress import ProgressBar
873
 
 
874
 
    try:
875
 
        import psyco
876
 
        psyco.full()
877
 
    except ImportError:
878
 
        pass
879
 
 
880
 
    if len(argv) < 2:
881
 
        usage()
882
 
        return 0
883
 
 
884
 
    cmd = argv[1]
885
 
 
886
 
    def readit():
887
 
        return read_weave(file(argv[2], 'rb'))
888
 
    
889
 
    if cmd == 'help':
890
 
        usage()
891
 
    elif cmd == 'add':
892
 
        w = readit()
893
 
        # at the moment, based on everything in the file
894
 
        name = argv[3]
895
 
        parents = map(int, argv[4:])
896
 
        lines = sys.stdin.readlines()
897
 
        ver = w.add(name, parents, lines)
898
 
        write_weave(w, file(argv[2], 'wb'))
899
 
        print 'added version %r %d' % (name, ver)
900
 
    elif cmd == 'init':
901
 
        fn = argv[2]
902
 
        if os.path.exists(fn):
903
 
            raise IOError("file exists")
904
 
        w = Weave()
905
 
        write_weave(w, file(fn, 'wb'))
906
 
    elif cmd == 'get': # get one version
907
 
        w = readit()
908
 
        sys.stdout.writelines(w.get_iter(int(argv[3])))
909
 
        
910
 
    elif cmd == 'mash': # get composite
911
 
        w = readit()
912
 
        sys.stdout.writelines(w.mash_iter(map(int, argv[3:])))
913
 
 
914
 
    elif cmd == 'diff':
915
 
        from difflib import unified_diff
916
 
        w = readit()
917
 
        fn = argv[2]
918
 
        v1, v2 = map(int, argv[3:5])
919
 
        lines1 = w.get(v1)
920
 
        lines2 = w.get(v2)
921
 
        diff_gen = unified_diff(lines1, lines2,
922
 
                                '%s version %d' % (fn, v1),
923
 
                                '%s version %d' % (fn, v2))
924
 
        sys.stdout.writelines(diff_gen)
925
 
            
926
 
    elif cmd == 'annotate':
927
 
        w = readit()
928
 
        # newline is added to all lines regardless; too hard to get
929
 
        # reasonable formatting otherwise
930
 
        lasto = None
931
 
        for origin, text in w.annotate(int(argv[3])):
932
 
            text = text.rstrip('\r\n')
933
 
            if origin == lasto:
934
 
                print '      | %s' % (text)
935
 
            else:
936
 
                print '%5d | %s' % (origin, text)
937
 
                lasto = origin
938
 
                
939
 
    elif cmd == 'toc':
940
 
        weave_toc(readit())
941
 
 
942
 
    elif cmd == 'stats':
943
 
        weave_stats(argv[2])
944
 
        
945
 
    elif cmd == 'check':
946
 
        w = readit()
947
 
        pb = ProgressBar()
948
 
        w.check(pb)
949
 
        pb.clear()
950
 
        print '%d versions ok' % w.numversions()
951
 
 
952
 
    elif cmd == 'inclusions':
953
 
        w = readit()
954
 
        print ' '.join(map(str, w.inclusions([int(argv[3])])))
955
 
 
956
 
    elif cmd == 'parents':
957
 
        w = readit()
958
 
        print ' '.join(map(str, w._parents[int(argv[3])]))
959
 
 
960
 
    elif cmd == 'plan-merge':
961
 
        w = readit()
962
 
        for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
963
 
            if line:
964
 
                print '%14s | %s' % (state, line),
965
 
 
966
 
    elif cmd == 'merge':
967
 
        w = readit()
968
 
        p = w.plan_merge(int(argv[3]), int(argv[4]))
969
 
        sys.stdout.writelines(w.weave_merge(p))
970
 
            
971
 
    elif cmd == 'mash-merge':
972
 
        if len(argv) != 5:
973
 
            usage()
974
 
            return 1
975
 
 
976
 
        w = readit()
977
 
        v1, v2 = map(int, argv[3:5])
978
 
 
979
 
        basis = w.inclusions([v1]).intersection(w.inclusions([v2]))
980
 
 
981
 
        base_lines = list(w.mash_iter(basis))
982
 
        a_lines = list(w.get(v1))
983
 
        b_lines = list(w.get(v2))
984
 
 
985
 
        from bzrlib.merge3 import Merge3
986
 
        m3 = Merge3(base_lines, a_lines, b_lines)
987
 
 
988
 
        name_a = 'version %d' % v1
989
 
        name_b = 'version %d' % v2
990
 
        sys.stdout.writelines(m3.merge_lines(name_a=name_a, name_b=name_b))
991
 
    else:
992
 
        raise ValueError('unknown command %r' % cmd)
993
 
    
994
 
 
995
 
 
996
 
def profile_main(argv): 
997
 
    import tempfile, hotshot, hotshot.stats
998
 
 
999
 
    prof_f = tempfile.NamedTemporaryFile()
1000
 
 
1001
 
    prof = hotshot.Profile(prof_f.name)
1002
 
 
1003
 
    ret = prof.runcall(main, argv)
1004
 
    prof.close()
1005
 
 
1006
 
    stats = hotshot.stats.load(prof_f.name)
1007
 
    #stats.strip_dirs()
1008
 
    stats.sort_stats('cumulative')
1009
 
    ## XXX: Might like to write to stderr or the trace file instead but
1010
 
    ## print_stats seems hardcoded to stdout
1011
 
    stats.print_stats(20)
1012
 
            
1013
 
    return ret
1014
 
 
1015
 
 
1016
 
if __name__ == '__main__':
1017
 
    import sys
1018
 
    if '--profile' in sys.argv:
1019
 
        args = sys.argv[:]
1020
 
        args.remove('--profile')
1021
 
        sys.exit(profile_main(args))
1022
 
    else:
1023
 
        sys.exit(main(sys.argv))
1024
 
 
 
851
    def _imported_parents(self, other, other_idx):
 
852
        """Return list of parents in self corresponding to indexes in other."""
 
853
        new_parents = []
 
854
        for parent_idx in other._parents[other_idx]:
 
855
            parent_name = other._names[parent_idx]
 
856
            if parent_name not in self._name_map:
 
857
                # should not be possible
 
858
                raise WeaveError("missing parent {%s} of {%s} in %r"
 
859
                                 % (parent_name, other._name_map[other_idx], self))
 
860
            new_parents.append(self._name_map[parent_name])
 
861
        return new_parents
 
862
 
 
863
    def _check_version_consistent(self, other, other_idx, name):
 
864
        """Check if a version in consistent in this and other.
 
865
 
 
866
        To be consistent it must have:
 
867
 
 
868
         * the same text
 
869
         * the same direct parents (by name, not index, and disregarding
 
870
           order)
 
871
 
 
872
        If present & correct return True;
 
873
        if not present in self return False;
 
874
        if inconsistent raise error."""
 
875
        this_idx = self._name_map.get(name, -1)
 
876
        if this_idx != -1:
 
877
            if self._sha1s[this_idx] != other._sha1s[other_idx]:
 
878
                raise errors.WeaveTextDiffers(name, self, other)
 
879
            self_parents = self._parents[this_idx]
 
880
            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))
 
886
            else:
 
887
                return True         # ok!
 
888
        else:
 
889
            return False
 
890
 
 
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
            _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):
 
973
    """Combine two weaves and return the result.
 
974
 
 
975
    This works even if a revision R has different parents in
 
976
    wa and wb.  In the resulting weave all the parents are given.
 
977
 
 
978
    This is done by just building up a new weave, maintaining ordering
 
979
    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
 
982
    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
    """
 
987
    wr = Weave()
 
988
    ia = ib = 0
 
989
    queue_a = range(wa.num_versions())
 
990
    queue_b = range(wb.num_versions())
 
991
    # first determine combined parents of all versions
 
992
    # map from version name -> all parent names
 
993
    combined_parents = _reweave_parent_graphs(wa, wb)
 
994
    mutter("combined parents: %r", combined_parents)
 
995
    order = tsort.topo_sort(combined_parents.iteritems())
 
996
    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))
 
1004
        if name in wa._name_map:
 
1005
            lines = wa.get_lines(name)
 
1006
            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)
 
1016
        else:
 
1017
            lines = wb.get_lines(name)
 
1018
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
 
1019
    return wr
 
1020
 
 
1021
 
 
1022
def _reweave_parent_graphs(wa, wb):
 
1023
    """Return combined parent ancestry for two weaves.
 
1024
 
 
1025
    Returned as a list of (version_name, set(parent_names))"""
 
1026
    combined = {}
 
1027
    for weave in [wa, wb]:
 
1028
        for idx, name in enumerate(weave._names):
 
1029
            p = combined.setdefault(name, set())
 
1030
            p.update(map(weave._idx_to_name, weave._parents[idx]))
 
1031
    return combined