← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Vincent Ladeuil
  • Date: 2012-08-02 14:14:36 UTC
  • mto: This revision was merged to the branch mainline in revision 6551.
  • Revision ID: v.ladeuil+lp@free.fr-20120802141436-pa7qqfq0qj3t4oup
Fix obvious bug, the filter stack needs the path to not be None.

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
 
 
22
19
"""Weave - storage of related text file versions"""
23
20
 
 
21
from __future__ import absolute_import
24
22
 
25
23
# XXX: If we do weaves this way, will a merge still behave the same
26
24
# way if it's done in a different order?  That's a pretty desirable
27
25
# property.
28
26
 
29
27
# TODO: Nothing here so far assumes the lines are really \n newlines,
30
 
# 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
31
29
# binaries, perhaps by naively splitting on \n or perhaps using
32
30
# something like a rolling checksum.
33
31
 
50
48
# have slight specializations for different ways its used: annotate,
51
49
# basis for add, get, etc.
52
50
 
53
 
# TODO: Perhaps the API should work only in names to hide the integer
54
 
# indexes from the user?
 
51
# TODO: Probably the API should work only in names to hide the integer
 
52
# indexes from the user.
55
53
 
56
54
# TODO: Is there any potential performance win by having an add()
57
55
# variant that is passed a pre-cooked version of the single basis
58
56
# version?
59
57
 
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):
 
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):
89
127
    """weave - versioned text file storage.
90
 
    
 
128
 
91
129
    A Weave manages versions of line-based text files, keeping track
92
130
    of the originating version for each line.
93
131
 
139
177
 
140
178
    * It doesn't seem very useful to have an active insertion
141
179
      inside an inactive insertion, but it might happen.
142
 
      
 
180
 
143
181
    * Therefore, all instructions are always"considered"; that
144
182
      is passed onto and off the stack.  An outer inactive block
145
183
      doesn't disable an inner block.
175
213
    """
176
214
 
177
215
    __slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map',
178
 
                 '_weave_name']
179
 
    
180
 
    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__()
181
227
        self._weave = []
182
228
        self._parents = []
183
229
        self._sha1s = []
184
230
        self._names = []
185
231
        self._name_map = {}
186
232
        self._weave_name = weave_name
187
 
 
 
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)
188
253
 
189
254
    def copy(self):
190
255
        """Return a deep copy of self.
191
 
        
 
256
 
192
257
        The copy can be modified without affecting the original weave."""
193
258
        other = Weave()
194
259
        other._weave = self._weave[:]
204
269
            return False
205
270
        return self._parents == other._parents \
206
271
               and self._weave == other._weave \
207
 
               and self._sha1s == other._sha1s 
 
272
               and self._sha1s == other._sha1s
208
273
 
209
 
    
210
274
    def __ne__(self, other):
211
275
        return not self.__eq__(other)
212
276
 
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):
 
277
    def _idx_to_name(self, version):
 
278
        return self._names[version]
 
279
 
 
280
    def _lookup(self, name):
223
281
        """Convert symbolic version name to index."""
 
282
        if not self._allow_reserved:
 
283
            self.check_not_reserved_id(name)
224
284
        try:
225
285
            return self._name_map[name]
226
286
        except KeyError:
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
 
 
 
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
238
379
 
239
380
    def _check_repeated_add(self, name, parents, text, sha1):
240
381
        """Check that a duplicated add is OK.
241
382
 
242
383
        If it is, return the (old) index; otherwise raise an exception.
243
384
        """
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)            
 
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)
251
389
        return idx
252
 
        
253
 
 
254
 
        
255
 
    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):
256
399
        """Add a single text on top of the weave.
257
 
  
 
400
 
258
401
        Returns the index number of the newly added version.
259
402
 
260
 
        name
 
403
        version_id
261
404
            Symbolic name for this version.
262
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)
263
407
 
264
408
        parents
265
409
            List or set of direct parent version numbers.
266
 
            
267
 
        text
 
410
 
 
411
        lines
268
412
            Sequence of lines to be added in the new version.
269
413
 
270
 
        sha -- SHA-1 of the file, if known.  This is trusted to be
271
 
            correct if supplied.
 
414
        :param nostore_sha: See VersionedFile.add_lines.
272
415
        """
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)
 
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
 
282
427
        self._check_versions(parents)
283
 
        ## self._check_lines(text)
 
428
        ## self._check_lines(lines)
284
429
        new_version = len(self._parents)
285
430
 
286
 
 
287
431
        # if we abort after here the (in-memory) weave will be corrupt because only
288
432
        # some fields are updated
 
433
        # XXX: FIXME implement a succeed-or-fail of the rest of this routine.
 
434
        #      - Robert Collins 20060226
289
435
        self._parents.append(parents[:])
290
436
        self._sha1s.append(sha1)
291
 
        self._names.append(name)
292
 
        self._name_map[name] = new_version
293
 
 
294
 
            
 
437
        self._names.append(version_id)
 
438
        self._name_map[version_id] = new_version
 
439
 
 
440
 
295
441
        if not parents:
296
442
            # special case; adding with no parents revision; can do
297
443
            # this more quickly by just appending unconditionally.
298
444
            # even more specially, if we're adding an empty text we
299
445
            # need do nothing at all.
300
 
            if text:
 
446
            if lines:
301
447
                self._weave.append(('{', new_version))
302
 
                self._weave.extend(text)
 
448
                self._weave.extend(lines)
303
449
                self._weave.append(('}', None))
304
 
        
305
450
            return new_version
306
451
 
307
452
        if len(parents) == 1:
309
454
            if sha1 == self._sha1s[pv]:
310
455
                # special case: same as the single parent
311
456
                return new_version
312
 
            
313
 
 
314
 
        ancestors = self.inclusions(parents)
 
457
 
 
458
 
 
459
        ancestors = self._inclusions(parents)
315
460
 
316
461
        l = self._weave
317
462
 
324
469
 
325
470
        # another small special case: a merge, producing the same text
326
471
        # as auto-merge
327
 
        if text == basis_lines:
328
 
            return new_version            
 
472
        if lines == basis_lines:
 
473
            return new_version
329
474
 
330
 
        # 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
331
476
        basis_lineno.append(len(self._weave))
332
477
 
333
478
        # XXX: which line of the weave should we really consider
337
482
        #print 'basis_lines:', basis_lines
338
483
        #print 'new_lines:  ', lines
339
484
 
340
 
        s = SequenceMatcher(None, basis_lines, text)
 
485
        s = self._matcher(None, basis_lines, lines)
341
486
 
342
487
        # offset gives the number of lines that have been inserted
343
488
        # into the weave up to the current point; if the original edit instruction
350
495
            #print 'raw match', tag, i1, i2, j1, j2
351
496
            if tag == 'equal':
352
497
                continue
353
 
 
354
498
            i1 = basis_lineno[i1]
355
499
            i2 = basis_lineno[i2]
356
 
 
357
 
            assert 0 <= j1 <= j2 <= len(text)
358
 
 
359
 
            #print tag, i1, i2, j1, j2
360
 
 
361
500
            # the deletion and insertion are handled separately.
362
501
            # first delete the region.
363
502
            if i1 != i2:
370
509
                # i2; we want to insert after this region to make sure
371
510
                # we don't destroy ourselves
372
511
                i = i2 + offset
373
 
                self._weave[i:i] = ([('{', new_version)] 
374
 
                                    + text[j1:j2] 
 
512
                self._weave[i:i] = ([('{', new_version)]
 
513
                                    + lines[j1:j2]
375
514
                                    + [('}', None)])
376
515
                offset += 2 + (j2 - j1)
377
 
 
378
516
        return new_version
379
517
 
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):
 
518
    def _inclusions(self, versions):
386
519
        """Return set of all ancestors of given version(s)."""
 
520
        if not len(versions):
 
521
            return []
387
522
        i = set(versions)
388
523
        for v in xrange(max(versions), 0, -1):
389
524
            if v in i:
393
528
        ## except IndexError:
394
529
        ##     raise ValueError("version %d not present in weave" % v)
395
530
 
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
 
 
 
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]
423
537
 
424
538
    def _check_lines(self, text):
425
539
        if not isinstance(text, list):
429
543
            if not isinstance(l, basestring):
430
544
                raise ValueError("text line should be a string or unicode, not %s"
431
545
                                 % type(l))
432
 
        
 
546
 
433
547
 
434
548
 
435
549
    def _check_versions(self, indexes):
440
554
            except IndexError:
441
555
                raise IndexError("invalid version number %r" % i)
442
556
 
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.
 
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.
450
567
 
451
568
        The index indicates when the line originated in the weave."""
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
 
        
 
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
 
465
589
        istack = []
466
590
        dset = set()
467
591
 
468
592
        lineno = 0         # line of weave, 0-based
469
593
 
470
594
        for l in self._weave:
471
 
            if isinstance(l, tuple):
 
595
            if l.__class__ == tuple:
472
596
                c, v = l
473
597
                isactive = None
474
598
                if c == '{':
475
 
                    istack.append(v)
 
599
                    istack.append(self._names[v])
476
600
                elif c == '}':
477
601
                    istack.pop()
478
602
                elif c == '[':
479
 
                    assert v not in dset
480
 
                    dset.add(v)
 
603
                    dset.add(self._names[v])
481
604
                elif c == ']':
482
 
                    dset.remove(v)
 
605
                    dset.remove(self._names[v])
483
606
                else:
484
 
                    raise WeaveFormatError('unexpected instruction %r'
485
 
                                           % v)
 
607
                    raise WeaveFormatError('unexpected instruction %r' % v)
486
608
            else:
487
 
                assert isinstance(l, basestring)
488
 
                assert istack
489
 
                yield lineno, istack[-1], dset, l
 
609
                yield lineno, istack[-1], frozenset(dset), l
490
610
            lineno += 1
491
611
 
492
 
 
 
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
493
662
 
494
663
    def _extract(self, versions):
495
664
        """Yield annotation of lines in included set.
503
672
        for i in versions:
504
673
            if not isinstance(i, int):
505
674
                raise ValueError(i)
506
 
            
507
 
        included = self.inclusions(versions)
 
675
 
 
676
        included = self._inclusions(versions)
508
677
 
509
678
        istack = []
 
679
        iset = set()
510
680
        dset = set()
511
681
 
512
682
        lineno = 0         # line of weave, 0-based
517
687
 
518
688
        WFE = WeaveFormatError
519
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
 
520
717
        for l in self._weave:
521
 
            if isinstance(l, tuple):
 
718
            if l.__class__ == tuple:
522
719
                c, v = l
523
720
                isactive = None
524
721
                if c == '{':
525
 
                    assert v not in istack
526
722
                    istack.append(v)
 
723
                    iset.add(v)
527
724
                elif c == '}':
528
 
                    istack.pop()
 
725
                    iset.remove(istack.pop())
529
726
                elif c == '[':
530
727
                    if v in included:
531
 
                        assert v not in dset
532
728
                        dset.add(v)
533
 
                else:
534
 
                    assert c == ']'
 
729
                elif c == ']':
535
730
                    if v in included:
536
 
                        assert v in dset
537
731
                        dset.remove(v)
 
732
                else:
 
733
                    raise AssertionError()
538
734
            else:
539
 
                assert isinstance(l, basestring)
540
735
                if isactive is None:
541
736
                    isactive = (not dset) and istack and (istack[-1] in included)
542
737
                if isactive:
543
738
                    result.append((istack[-1], lineno, l))
544
739
            lineno += 1
545
 
 
546
740
        if istack:
547
 
            raise WFE("unclosed insertion blocks at end of weave",
548
 
                                   istack)
 
741
            raise WeaveFormatError("unclosed insertion blocks "
 
742
                    "at end of weave: %s" % istack)
549
743
        if dset:
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):
 
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?"""
593
780
        l = len(self._parents)
594
 
        assert l == len(self._sha1s)
595
781
        return l
596
782
 
597
 
 
598
 
    def __len__(self):
599
 
        return self.numversions()
600
 
 
 
783
    __len__ = num_versions
601
784
 
602
785
    def check(self, progress_bar=None):
603
 
        # check no circular inclusions
604
 
        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()):
605
790
            inclusions = list(self._parents[version])
606
791
            if inclusions:
607
792
                inclusions.sort()
609
794
                    raise WeaveFormatError("invalid included version %d for index %d"
610
795
                                           % (inclusions[-1], version))
611
796
 
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):
 
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():
616
827
            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]
 
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]
623
841
            if hd != expected:
624
 
                raise WeaveError("mismatched sha1 for version %d; "
625
 
                                 "got %s, expected %s"
626
 
                                 % (version, hd, expected))
 
842
                raise errors.WeaveInvalidChecksum(
 
843
                        "mismatched sha1 for version %s: "
 
844
                        "got %s, expected %s"
 
845
                        % (version, hd, expected))
627
846
 
628
847
        # TODO: check insertions are properly nested, that there are
629
848
        # no lines outside of insertion blocks, that deletions are
630
849
        # properly paired, etc.
631
850
 
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
 
            
672
 
    def plan_merge(self, ver_a, ver_b):
673
 
        """Return pseudo-annotation indicating how the two versions merge.
674
 
 
675
 
        This is computed between versions a and b and their common
676
 
        base.
677
 
 
678
 
        Weave lines present in none of them are skipped entirely.
679
 
        """
680
 
        inc_a = self.inclusions([ver_a])
681
 
        inc_b = self.inclusions([ver_b])
682
 
        inc_c = inc_a & inc_b
683
 
 
684
 
        for lineno, insert, deleteset, line in self._walk():
685
 
            if deleteset & inc_c:
686
 
                # killed in parent; can't be in either a or b
687
 
                # not relevant to our work
688
 
                yield 'killed-base', line
689
 
            elif insert in inc_c:
690
 
                # was inserted in base
691
 
                killed_a = bool(deleteset & inc_a)
692
 
                killed_b = bool(deleteset & inc_b)
693
 
                if killed_a and killed_b:
694
 
                    yield 'killed-both', line
695
 
                elif killed_a:
696
 
                    yield 'killed-a', line
697
 
                elif killed_b:
698
 
                    yield 'killed-b', line
699
 
                else:
700
 
                    yield 'unchanged', line
701
 
            elif insert in inc_a:
702
 
                if deleteset & inc_a:
703
 
                    yield 'ghost-a', line
704
 
                else:
705
 
                    # new in A; not in B
706
 
                    yield 'new-a', line
707
 
            elif insert in inc_b:
708
 
                if deleteset & inc_b:
709
 
                    yield 'ghost-b', line
710
 
                else:
711
 
                    yield 'new-b', line
712
 
            else:
713
 
                # not in either revision
714
 
                yield 'irrelevant', line
715
 
 
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
737
 
                else:
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)
763
 
            else:
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.
778
 
        """
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
 
 
793
 
 
794
851
    def _imported_parents(self, other, other_idx):
795
852
        """Return list of parents in self corresponding to indexes in other."""
796
853
        new_parents = []
797
854
        for parent_idx in other._parents[other_idx]:
798
855
            parent_name = other._names[parent_idx]
799
 
            if parent_name not in self._names:
 
856
            if parent_name not in self._name_map:
800
857
                # should not be possible
801
 
                raise WeaveError("missing parent {%s} of {%s} in %r" 
 
858
                raise WeaveError("missing parent {%s} of {%s} in %r"
802
859
                                 % (parent_name, other._name_map[other_idx], self))
803
860
            new_parents.append(self._name_map[parent_name])
804
861
        return new_parents
805
862
 
806
863
    def _check_version_consistent(self, other, other_idx, name):
807
864
        """Check if a version in consistent in this and other.
808
 
        
 
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
 
809
872
        If present & correct return True;
810
 
        if not present in self return False; 
 
873
        if not present in self return False;
811
874
        if inconsistent raise error."""
812
875
        this_idx = self._name_map.get(name, -1)
813
876
        if this_idx != -1:
814
877
            if self._sha1s[this_idx] != other._sha1s[other_idx]:
815
 
                raise WeaveError("inconsistent texts for version {%s} in %r and %r"
816
 
                                 % (name, self, other))
817
 
            elif set(self._parents[this_idx]) != set(other._parents[other_idx]):
818
 
                raise WeaveError("inconsistent parents for version {%s} in %r and %r"
819
 
                                 % (name, self, other))
 
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))
820
886
            else:
821
887
                return True         # ok!
822
888
        else:
823
889
            return False
824
890
 
825
 
 
826
 
def weave_toc(w):
827
 
    """Show the weave's table-of-contents"""
828
 
    print '%6s %50s %10s %10s' % ('ver', 'name', 'sha1', 'parents')
829
 
    for i in (6, 50, 10, 10):
830
 
        print '-' * i,
831
 
    print
832
 
    for i in range(w.numversions()):
833
 
        sha1 = w._sha1s[i]
834
 
        name = w._names[i]
835
 
        parent_str = ' '.join(map(str, w._parents[i]))
836
 
        print '%6d %-50.50s %10.10s %s' % (i, name, sha1, parent_str)
837
 
 
838
 
 
839
 
 
840
 
def weave_stats(weave_file, pb):
841
 
    from bzrlib.weavefile import read_weave
842
 
 
843
 
    wf = file(weave_file, 'rb')
844
 
    w = read_weave(wf)
845
 
    # FIXME: doesn't work on pipes
846
 
    weave_size = wf.tell()
847
 
 
848
 
    total = 0
849
 
    vers = len(w)
850
 
    for i in range(vers):
851
 
        pb.update('checking sizes', i, vers)
852
 
        for origin, lineno, line in w._extract([i]):
853
 
            total += len(line)
854
 
 
855
 
    pb.clear()
856
 
 
857
 
    print 'versions          %9d' % vers
858
 
    print 'weave file        %9d bytes' % weave_size
859
 
    print 'total contents    %9d bytes' % total
860
 
    print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
861
 
    if vers:
862
 
        avg = total/vers
863
 
        print 'average size      %9d bytes' % avg
864
 
        print 'relative size     %9.2fx' % (float(weave_size) / float(avg))
865
 
 
866
 
 
867
 
def usage():
868
 
    print """bzr weave tool
869
 
 
870
 
Experimental tool for weave algorithm.
871
 
 
872
 
usage:
873
 
    weave init WEAVEFILE
874
 
        Create an empty weave file
875
 
    weave get WEAVEFILE VERSION
876
 
        Write out specified version.
877
 
    weave check WEAVEFILE
878
 
        Check consistency of all versions.
879
 
    weave toc WEAVEFILE
880
 
        Display table of contents.
881
 
    weave add WEAVEFILE NAME [BASE...] < NEWTEXT
882
 
        Add NEWTEXT, with specified parent versions.
883
 
    weave annotate WEAVEFILE VERSION
884
 
        Display origin of each line.
885
 
    weave mash WEAVEFILE VERSION...
886
 
        Display composite of all selected versions.
887
 
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
888
 
        Auto-merge two versions and display conflicts.
889
 
    weave diff WEAVEFILE VERSION1 VERSION2 
890
 
        Show differences between two versions.
891
 
 
892
 
example:
893
 
 
894
 
    % weave init foo.weave
895
 
    % vi foo.txt
896
 
    % weave add foo.weave ver0 < foo.txt
897
 
    added version 0
898
 
 
899
 
    (create updated version)
900
 
    % vi foo.txt
901
 
    % weave get foo.weave 0 | diff -u - foo.txt
902
 
    % weave add foo.weave ver1 0 < foo.txt
903
 
    added version 1
904
 
 
905
 
    % weave get foo.weave 0 > foo.txt       (create forked version)
906
 
    % vi foo.txt
907
 
    % weave add foo.weave ver2 0 < foo.txt
908
 
    added version 2
909
 
 
910
 
    % weave merge foo.weave 1 2 > foo.txt   (merge them)
911
 
    % vi foo.txt                            (resolve conflicts)
912
 
    % weave add foo.weave merged 1 2 < foo.txt     (commit merged version)     
913
 
    
914
 
"""
915
 
    
916
 
 
917
 
 
918
 
def main(argv):
919
 
    import sys
920
 
    import os
921
 
    try:
922
 
        import bzrlib
923
 
    except ImportError:
924
 
        # in case we're run directly from the subdirectory
925
 
        sys.path.append('..')
926
 
        import bzrlib
927
 
    from bzrlib.weavefile import write_weave, read_weave
928
 
    from bzrlib.progress import ProgressBar
929
 
 
930
 
    try:
931
 
        import psyco
932
 
        psyco.full()
933
 
    except ImportError:
934
 
        pass
935
 
 
936
 
    if len(argv) < 2:
937
 
        usage()
938
 
        return 0
939
 
 
940
 
    cmd = argv[1]
941
 
 
942
 
    def readit():
943
 
        return read_weave(file(argv[2], 'rb'))
944
 
    
945
 
    if cmd == 'help':
946
 
        usage()
947
 
    elif cmd == 'add':
948
 
        w = readit()
949
 
        # at the moment, based on everything in the file
950
 
        name = argv[3]
951
 
        parents = map(int, argv[4:])
952
 
        lines = sys.stdin.readlines()
953
 
        ver = w.add(name, parents, lines)
954
 
        write_weave(w, file(argv[2], 'wb'))
955
 
        print 'added version %r %d' % (name, ver)
956
 
    elif cmd == 'init':
957
 
        fn = argv[2]
958
 
        if os.path.exists(fn):
959
 
            raise IOError("file exists")
960
 
        w = Weave()
961
 
        write_weave(w, file(fn, 'wb'))
962
 
    elif cmd == 'get': # get one version
963
 
        w = readit()
964
 
        sys.stdout.writelines(w.get_iter(int(argv[3])))
965
 
        
966
 
    elif cmd == 'mash': # get composite
967
 
        w = readit()
968
 
        sys.stdout.writelines(w.mash_iter(map(int, argv[3:])))
969
 
 
970
 
    elif cmd == 'diff':
971
 
        from difflib import unified_diff
972
 
        w = readit()
973
 
        fn = argv[2]
974
 
        v1, v2 = map(int, argv[3:5])
975
 
        lines1 = w.get(v1)
976
 
        lines2 = w.get(v2)
977
 
        diff_gen = unified_diff(lines1, lines2,
978
 
                                '%s version %d' % (fn, v1),
979
 
                                '%s version %d' % (fn, v2))
980
 
        sys.stdout.writelines(diff_gen)
981
 
            
982
 
    elif cmd == 'annotate':
983
 
        w = readit()
984
 
        # newline is added to all lines regardless; too hard to get
985
 
        # reasonable formatting otherwise
986
 
        lasto = None
987
 
        for origin, text in w.annotate(int(argv[3])):
988
 
            text = text.rstrip('\r\n')
989
 
            if origin == lasto:
990
 
                print '      | %s' % (text)
991
 
            else:
992
 
                print '%5d | %s' % (origin, text)
993
 
                lasto = origin
994
 
                
995
 
    elif cmd == 'toc':
996
 
        weave_toc(readit())
997
 
 
998
 
    elif cmd == 'stats':
999
 
        weave_stats(argv[2], ProgressBar())
1000
 
        
1001
 
    elif cmd == 'check':
1002
 
        w = readit()
1003
 
        pb = ProgressBar()
1004
 
        w.check(pb)
1005
 
        pb.clear()
1006
 
        print '%d versions ok' % w.numversions()
1007
 
 
1008
 
    elif cmd == 'inclusions':
1009
 
        w = readit()
1010
 
        print ' '.join(map(str, w.inclusions([int(argv[3])])))
1011
 
 
1012
 
    elif cmd == 'parents':
1013
 
        w = readit()
1014
 
        print ' '.join(map(str, w._parents[int(argv[3])]))
1015
 
 
1016
 
    elif cmd == 'plan-merge':
1017
 
        w = readit()
1018
 
        for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
1019
 
            if line:
1020
 
                print '%14s | %s' % (state, line),
1021
 
 
1022
 
    elif cmd == 'merge':
1023
 
        w = readit()
1024
 
        p = w.plan_merge(int(argv[3]), int(argv[4]))
1025
 
        sys.stdout.writelines(w.weave_merge(p))
1026
 
            
1027
 
    elif cmd == 'mash-merge':
1028
 
        if len(argv) != 5:
1029
 
            usage()
1030
 
            return 1
1031
 
 
1032
 
        w = readit()
1033
 
        v1, v2 = map(int, argv[3:5])
1034
 
 
1035
 
        basis = w.inclusions([v1]).intersection(w.inclusions([v2]))
1036
 
 
1037
 
        base_lines = list(w.mash_iter(basis))
1038
 
        a_lines = list(w.get(v1))
1039
 
        b_lines = list(w.get(v2))
1040
 
 
1041
 
        from bzrlib.merge3 import Merge3
1042
 
        m3 = Merge3(base_lines, a_lines, b_lines)
1043
 
 
1044
 
        name_a = 'version %d' % v1
1045
 
        name_b = 'version %d' % v2
1046
 
        sys.stdout.writelines(m3.merge_lines(name_a=name_a, name_b=name_b))
1047
 
    else:
1048
 
        raise ValueError('unknown command %r' % cmd)
1049
 
    
1050
 
 
1051
 
 
1052
 
def profile_main(argv): 
1053
 
    import tempfile, hotshot, hotshot.stats
1054
 
 
1055
 
    prof_f = tempfile.NamedTemporaryFile()
1056
 
 
1057
 
    prof = hotshot.Profile(prof_f.name)
1058
 
 
1059
 
    ret = prof.runcall(main, argv)
1060
 
    prof.close()
1061
 
 
1062
 
    stats = hotshot.stats.load(prof_f.name)
1063
 
    #stats.strip_dirs()
1064
 
    stats.sort_stats('cumulative')
1065
 
    ## XXX: Might like to write to stderr or the trace file instead but
1066
 
    ## print_stats seems hardcoded to stdout
1067
 
    stats.print_stats(20)
1068
 
            
1069
 
    return ret
1070
 
 
1071
 
 
1072
 
if __name__ == '__main__':
1073
 
    import sys
1074
 
    if '--profile' in sys.argv:
1075
 
        args = sys.argv[:]
1076
 
        args.remove('--profile')
1077
 
        sys.exit(profile_main(args))
1078
 
    else:
1079
 
        sys.exit(main(sys.argv))
1080
 
 
 
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