← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: John Arbash Meinel
  • Date: 2009-08-25 18:45:40 UTC
  • mto: (4634.6.15 2.0)
  • mto: This revision was merged to the branch mainline in revision 4667.
  • Revision ID: john@arbash-meinel.com-20090825184540-6dn3xjq62xhgj2gq
Add support for skipping ghost nodes.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/weave.py
1
 
#! /usr/bin/python
2
 
 
3
 
# Copyright (C) 2005 Canonical Ltd
 
1
# Copyright (C) 2005, 2009 Canonical Ltd
4
2
#
5
3
# This program is free software; you can redistribute it and/or modify
6
4
# it under the terms of the GNU General Public License as published by
14
12
#
15
13
# You should have received a copy of the GNU General Public License
16
14
# along with this program; if not, write to the Free Software
17
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
16
 
19
17
# Author: Martin Pool <mbp@canonical.com>
20
18
 
61
59
# where the basis and destination are unchanged.
62
60
 
63
61
# FIXME: Sometimes we will be given a parents list for a revision
64
 
# that includes some redundant parents (i.e. already a parent of 
65
 
# something in the list.)  We should eliminate them.  This can 
 
62
# that includes some redundant parents (i.e. already a parent of
 
63
# something in the list.)  We should eliminate them.  This can
66
64
# be done fairly efficiently because the sequence numbers constrain
67
65
# the possible relationships.
68
66
 
71
69
from copy import copy
72
70
from cStringIO import StringIO
73
71
import os
74
 
import sha
75
72
import time
76
73
import warnings
77
74
 
 
75
from bzrlib.lazy_import import lazy_import
 
76
lazy_import(globals(), """
 
77
from bzrlib import tsort
 
78
""")
78
79
from bzrlib import (
 
80
    errors,
 
81
    osutils,
79
82
    progress,
80
83
    )
81
 
from bzrlib.trace import mutter
82
84
from bzrlib.errors import (WeaveError, WeaveFormatError, WeaveParentMismatch,
83
85
        RevisionAlreadyPresent,
84
86
        RevisionNotPresent,
 
87
        UnavailableRepresentation,
85
88
        WeaveRevisionAlreadyPresent,
86
89
        WeaveRevisionNotPresent,
87
90
        )
88
 
import bzrlib.errors as errors
89
 
from bzrlib.osutils import sha_strings
 
91
from bzrlib.osutils import dirname, sha, sha_strings, split_lines
90
92
import bzrlib.patiencediff
91
 
from bzrlib.tsort import topo_sort
92
 
from bzrlib.versionedfile import VersionedFile, InterVersionedFile
 
93
from bzrlib.revision import NULL_REVISION
 
94
from bzrlib.symbol_versioning import *
 
95
from bzrlib.trace import mutter
 
96
from bzrlib.versionedfile import (
 
97
    AbsentContentFactory,
 
98
    adapter_registry,
 
99
    ContentFactory,
 
100
    sort_groupcompress,
 
101
    VersionedFile,
 
102
    )
93
103
from bzrlib.weavefile import _read_weave_v5, write_weave_v5
94
104
 
95
105
 
 
106
class WeaveContentFactory(ContentFactory):
 
107
    """Content factory for streaming from weaves.
 
108
 
 
109
    :seealso ContentFactory:
 
110
    """
 
111
 
 
112
    def __init__(self, version, weave):
 
113
        """Create a WeaveContentFactory for version from weave."""
 
114
        ContentFactory.__init__(self)
 
115
        self.sha1 = weave.get_sha1s([version])[version]
 
116
        self.key = (version,)
 
117
        parents = weave.get_parent_map([version])[version]
 
118
        self.parents = tuple((parent,) for parent in parents)
 
119
        self.storage_kind = 'fulltext'
 
120
        self._weave = weave
 
121
 
 
122
    def get_bytes_as(self, storage_kind):
 
123
        if storage_kind == 'fulltext':
 
124
            return self._weave.get_text(self.key[-1])
 
125
        elif storage_kind == 'chunked':
 
126
            return self._weave.get_lines(self.key[-1])
 
127
        else:
 
128
            raise UnavailableRepresentation(self.key, storage_kind, 'fulltext')
 
129
 
 
130
 
96
131
class Weave(VersionedFile):
97
132
    """weave - versioned text file storage.
98
 
    
 
133
 
99
134
    A Weave manages versions of line-based text files, keeping track
100
135
    of the originating version for each line.
101
136
 
147
182
 
148
183
    * It doesn't seem very useful to have an active insertion
149
184
      inside an inactive insertion, but it might happen.
150
 
      
 
185
 
151
186
    * Therefore, all instructions are always"considered"; that
152
187
      is passed onto and off the stack.  An outer inactive block
153
188
      doesn't disable an inner block.
183
218
    """
184
219
 
185
220
    __slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map',
186
 
                 '_weave_name', '_matcher']
187
 
    
188
 
    def __init__(self, weave_name=None, access_mode='w', matcher=None):
189
 
        super(Weave, self).__init__(access_mode)
 
221
                 '_weave_name', '_matcher', '_allow_reserved']
 
222
 
 
223
    def __init__(self, weave_name=None, access_mode='w', matcher=None,
 
224
                 get_scope=None, allow_reserved=False):
 
225
        """Create a weave.
 
226
 
 
227
        :param get_scope: A callable that returns an opaque object to be used
 
228
            for detecting when this weave goes out of scope (should stop
 
229
            answering requests or allowing mutation).
 
230
        """
 
231
        super(Weave, self).__init__()
190
232
        self._weave = []
191
233
        self._parents = []
192
234
        self._sha1s = []
197
239
            self._matcher = bzrlib.patiencediff.PatienceSequenceMatcher
198
240
        else:
199
241
            self._matcher = matcher
 
242
        if get_scope is None:
 
243
            get_scope = lambda:None
 
244
        self._get_scope = get_scope
 
245
        self._scope = get_scope()
 
246
        self._access_mode = access_mode
 
247
        self._allow_reserved = allow_reserved
200
248
 
201
249
    def __repr__(self):
202
250
        return "Weave(%r)" % self._weave_name
203
251
 
 
252
    def _check_write_ok(self):
 
253
        """Is the versioned file marked as 'finished' ? Raise if it is."""
 
254
        if self._get_scope() != self._scope:
 
255
            raise errors.OutSideTransaction()
 
256
        if self._access_mode != 'w':
 
257
            raise errors.ReadOnlyObjectDirtiedError(self)
 
258
 
204
259
    def copy(self):
205
260
        """Return a deep copy of self.
206
 
        
 
261
 
207
262
        The copy can be modified without affecting the original weave."""
208
263
        other = Weave()
209
264
        other._weave = self._weave[:]
219
274
            return False
220
275
        return self._parents == other._parents \
221
276
               and self._weave == other._weave \
222
 
               and self._sha1s == other._sha1s 
223
 
    
 
277
               and self._sha1s == other._sha1s
 
278
 
224
279
    def __ne__(self, other):
225
280
        return not self.__eq__(other)
226
281
 
229
284
 
230
285
    def _lookup(self, name):
231
286
        """Convert symbolic version name to index."""
232
 
        self.check_not_reserved_id(name)
 
287
        if not self._allow_reserved:
 
288
            self.check_not_reserved_id(name)
233
289
        try:
234
290
            return self._name_map[name]
235
291
        except KeyError:
245
301
 
246
302
    __contains__ = has_version
247
303
 
248
 
    def get_delta(self, version_id):
249
 
        """See VersionedFile.get_delta."""
250
 
        return self.get_deltas([version_id])[version_id]
251
 
 
252
 
    def get_deltas(self, version_ids):
253
 
        """See VersionedFile.get_deltas."""
254
 
        version_ids = self.get_ancestry(version_ids)
 
304
    def get_record_stream(self, versions, ordering, include_delta_closure):
 
305
        """Get a stream of records for versions.
 
306
 
 
307
        :param versions: The versions to include. Each version is a tuple
 
308
            (version,).
 
309
        :param ordering: Either 'unordered' or 'topological'. A topologically
 
310
            sorted stream has compression parents strictly before their
 
311
            children.
 
312
        :param include_delta_closure: If True then the closure across any
 
313
            compression parents will be included (in the opaque data).
 
314
        :return: An iterator of ContentFactory objects, each of which is only
 
315
            valid until the iterator is advanced.
 
316
        """
 
317
        versions = [version[-1] for version in versions]
 
318
        if ordering == 'topological':
 
319
            parents = self.get_parent_map(versions)
 
320
            new_versions = tsort.topo_sort(parents)
 
321
            new_versions.extend(set(versions).difference(set(parents)))
 
322
            versions = new_versions
 
323
        elif ordering == 'groupcompress':
 
324
            parents = self.get_parent_map(versions)
 
325
            new_versions = sort_groupcompress(parents)
 
326
            new_versions.extend(set(versions).difference(set(parents)))
 
327
            versions = new_versions
 
328
        for version in versions:
 
329
            if version in self:
 
330
                yield WeaveContentFactory(version, self)
 
331
            else:
 
332
                yield AbsentContentFactory((version,))
 
333
 
 
334
    def get_parent_map(self, version_ids):
 
335
        """See VersionedFile.get_parent_map."""
 
336
        result = {}
255
337
        for version_id in version_ids:
256
 
            if not self.has_version(version_id):
257
 
                raise RevisionNotPresent(version_id, self)
258
 
        # try extracting all versions; parallel extraction is used
259
 
        nv = self.num_versions()
260
 
        sha1s = {}
261
 
        deltas = {}
262
 
        texts = {}
263
 
        inclusions = {}
264
 
        noeols = {}
265
 
        last_parent_lines = {}
266
 
        parents = {}
267
 
        parent_inclusions = {}
268
 
        parent_linenums = {}
269
 
        parent_noeols = {}
270
 
        current_hunks = {}
271
 
        diff_hunks = {}
272
 
        # its simplest to generate a full set of prepared variables.
273
 
        for i in range(nv):
274
 
            name = self._names[i]
275
 
            sha1s[name] = self.get_sha1(name)
276
 
            parents_list = self.get_parents(name)
277
 
            try:
278
 
                parent = parents_list[0]
279
 
                parents[name] = parent
280
 
                parent_inclusions[name] = inclusions[parent]
281
 
            except IndexError:
282
 
                parents[name] = None
283
 
                parent_inclusions[name] = set()
284
 
            # we want to emit start, finish, replacement_length, replacement_lines tuples.
285
 
            diff_hunks[name] = []
286
 
            current_hunks[name] = [0, 0, 0, []] # #start, finish, repl_length, repl_tuples
287
 
            parent_linenums[name] = 0
288
 
            noeols[name] = False
289
 
            parent_noeols[name] = False
290
 
            last_parent_lines[name] = None
291
 
            new_inc = set([name])
292
 
            for p in self._parents[i]:
293
 
                new_inc.update(inclusions[self._idx_to_name(p)])
294
 
            # debug only, known good so far.
295
 
            #assert set(new_inc) == set(self.get_ancestry(name)), \
296
 
            #    'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
297
 
            inclusions[name] = new_inc
298
 
 
299
 
        nlines = len(self._weave)
300
 
 
301
 
        for lineno, inserted, deletes, line in self._walk_internal():
302
 
            # a line is active in a version if:
303
 
            # insert is in the versions inclusions
304
 
            # and
305
 
            # deleteset & the versions inclusions is an empty set.
306
 
            # so - if we have a included by mapping - version is included by
307
 
            # children, we get a list of children to examine for deletes affect
308
 
            # ing them, which is less than the entire set of children.
309
 
            for version_id in version_ids:  
310
 
                # The active inclusion must be an ancestor,
311
 
                # and no ancestors must have deleted this line,
312
 
                # because we don't support resurrection.
313
 
                parent_inclusion = parent_inclusions[version_id]
314
 
                inclusion = inclusions[version_id]
315
 
                parent_active = inserted in parent_inclusion and not (deletes & parent_inclusion)
316
 
                version_active = inserted in inclusion and not (deletes & inclusion)
317
 
                if not parent_active and not version_active:
318
 
                    # unrelated line of ancestry
 
338
            if version_id == NULL_REVISION:
 
339
                parents = ()
 
340
            else:
 
341
                try:
 
342
                    parents = tuple(
 
343
                        map(self._idx_to_name,
 
344
                            self._parents[self._lookup(version_id)]))
 
345
                except RevisionNotPresent:
319
346
                    continue
320
 
                elif parent_active and version_active:
321
 
                    # shared line
322
 
                    parent_linenum = parent_linenums[version_id]
323
 
                    if current_hunks[version_id] != [parent_linenum, parent_linenum, 0, []]:
324
 
                        diff_hunks[version_id].append(tuple(current_hunks[version_id]))
325
 
                    parent_linenum += 1
326
 
                    current_hunks[version_id] = [parent_linenum, parent_linenum, 0, []]
327
 
                    parent_linenums[version_id] = parent_linenum
328
 
                    try:
329
 
                        if line[-1] != '\n':
330
 
                            noeols[version_id] = True
331
 
                    except IndexError:
332
 
                        pass
333
 
                elif parent_active and not version_active:
334
 
                    # deleted line
335
 
                    current_hunks[version_id][1] += 1
336
 
                    parent_linenums[version_id] += 1
337
 
                    last_parent_lines[version_id] = line
338
 
                elif not parent_active and version_active:
339
 
                    # replacement line
340
 
                    # noeol only occurs at the end of a file because we 
341
 
                    # diff linewise. We want to show noeol changes as a
342
 
                    # empty diff unless the actual eol-less content changed.
343
 
                    theline = line
344
 
                    try:
345
 
                        if last_parent_lines[version_id][-1] != '\n':
346
 
                            parent_noeols[version_id] = True
347
 
                    except (TypeError, IndexError):
348
 
                        pass
349
 
                    try:
350
 
                        if theline[-1] != '\n':
351
 
                            noeols[version_id] = True
352
 
                    except IndexError:
353
 
                        pass
354
 
                    new_line = False
355
 
                    parent_should_go = False
356
 
 
357
 
                    if parent_noeols[version_id] == noeols[version_id]:
358
 
                        # no noeol toggle, so trust the weaves statement
359
 
                        # that this line is changed.
360
 
                        new_line = True
361
 
                        if parent_noeols[version_id]:
362
 
                            theline = theline + '\n'
363
 
                    elif parent_noeols[version_id]:
364
 
                        # parent has no eol, we do:
365
 
                        # our line is new, report as such..
366
 
                        new_line = True
367
 
                    elif noeols[version_id]:
368
 
                        # append a eol so that it looks like
369
 
                        # a normalised delta
370
 
                        theline = theline + '\n'
371
 
                        if parents[version_id] is not None:
372
 
                        #if last_parent_lines[version_id] is not None:
373
 
                            parent_should_go = True
374
 
                        if last_parent_lines[version_id] != theline:
375
 
                            # but changed anyway
376
 
                            new_line = True
377
 
                            #parent_should_go = False
378
 
                    if new_line:
379
 
                        current_hunks[version_id][2] += 1
380
 
                        current_hunks[version_id][3].append((inserted, theline))
381
 
                    if parent_should_go:
382
 
                        # last hunk last parent line is not eaten
383
 
                        current_hunks[version_id][1] -= 1
384
 
                    if current_hunks[version_id][1] < 0:
385
 
                        current_hunks[version_id][1] = 0
386
 
                        # import pdb;pdb.set_trace()
387
 
                    # assert current_hunks[version_id][1] >= 0
388
 
 
389
 
        # flush last hunk
390
 
        for i in range(nv):
391
 
            version = self._idx_to_name(i)
392
 
            if current_hunks[version] != [0, 0, 0, []]:
393
 
                diff_hunks[version].append(tuple(current_hunks[version]))
394
 
        result = {}
395
 
        for version_id in version_ids:
396
 
            result[version_id] = (
397
 
                                  parents[version_id],
398
 
                                  sha1s[version_id],
399
 
                                  noeols[version_id],
400
 
                                  diff_hunks[version_id],
401
 
                                  )
 
347
            result[version_id] = parents
402
348
        return result
403
349
 
404
 
    def get_parents(self, version_id):
405
 
        """See VersionedFile.get_parent."""
406
 
        return map(self._idx_to_name, self._parents[self._lookup(version_id)])
 
350
    def get_parents_with_ghosts(self, version_id):
 
351
        raise NotImplementedError(self.get_parents_with_ghosts)
 
352
 
 
353
    def insert_record_stream(self, stream):
 
354
        """Insert a record stream into this versioned file.
 
355
 
 
356
        :param stream: A stream of records to insert.
 
357
        :return: None
 
358
        :seealso VersionedFile.get_record_stream:
 
359
        """
 
360
        adapters = {}
 
361
        for record in stream:
 
362
            # Raise an error when a record is missing.
 
363
            if record.storage_kind == 'absent':
 
364
                raise RevisionNotPresent([record.key[0]], self)
 
365
            # adapt to non-tuple interface
 
366
            parents = [parent[0] for parent in record.parents]
 
367
            if (record.storage_kind == 'fulltext'
 
368
                or record.storage_kind == 'chunked'):
 
369
                self.add_lines(record.key[0], parents,
 
370
                    osutils.chunks_to_lines(record.get_bytes_as('chunked')))
 
371
            else:
 
372
                adapter_key = record.storage_kind, 'fulltext'
 
373
                try:
 
374
                    adapter = adapters[adapter_key]
 
375
                except KeyError:
 
376
                    adapter_factory = adapter_registry.get(adapter_key)
 
377
                    adapter = adapter_factory(self)
 
378
                    adapters[adapter_key] = adapter
 
379
                lines = split_lines(adapter.get_bytes(record))
 
380
                try:
 
381
                    self.add_lines(record.key[0], parents, lines)
 
382
                except RevisionAlreadyPresent:
 
383
                    pass
407
384
 
408
385
    def _check_repeated_add(self, name, parents, text, sha1):
409
386
        """Check that a duplicated add is OK.
417
394
        return idx
418
395
 
419
396
    def _add_lines(self, version_id, parents, lines, parent_texts,
420
 
                   left_matching_blocks=None):
 
397
       left_matching_blocks, nostore_sha, random_id, check_content):
421
398
        """See VersionedFile.add_lines."""
422
 
        return self._add(version_id, lines, map(self._lookup, parents))
 
399
        idx = self._add(version_id, lines, map(self._lookup, parents),
 
400
            nostore_sha=nostore_sha)
 
401
        return sha_strings(lines), sum(map(len, lines)), idx
423
402
 
424
 
    def _add(self, version_id, lines, parents, sha1=None):
 
403
    def _add(self, version_id, lines, parents, sha1=None, nostore_sha=None):
425
404
        """Add a single text on top of the weave.
426
 
  
 
405
 
427
406
        Returns the index number of the newly added version.
428
407
 
429
408
        version_id
430
409
            Symbolic name for this version.
431
410
            (Typically the revision-id of the revision that added it.)
 
411
            If None, a name will be allocated based on the hash. (sha1:SHAHASH)
432
412
 
433
413
        parents
434
414
            List or set of direct parent version numbers.
435
 
            
 
415
 
436
416
        lines
437
417
            Sequence of lines to be added in the new version.
 
418
 
 
419
        :param nostore_sha: See VersionedFile.add_lines.
438
420
        """
439
 
 
440
 
        assert isinstance(version_id, basestring)
441
421
        self._check_lines_not_unicode(lines)
442
422
        self._check_lines_are_lines(lines)
443
423
        if not sha1:
444
424
            sha1 = sha_strings(lines)
 
425
        if sha1 == nostore_sha:
 
426
            raise errors.ExistingContent
 
427
        if version_id is None:
 
428
            version_id = "sha1:" + sha1
445
429
        if version_id in self._name_map:
446
430
            return self._check_repeated_add(version_id, parents, lines, sha1)
447
431
 
458
442
        self._names.append(version_id)
459
443
        self._name_map[version_id] = new_version
460
444
 
461
 
            
 
445
 
462
446
        if not parents:
463
447
            # special case; adding with no parents revision; can do
464
448
            # this more quickly by just appending unconditionally.
475
459
            if sha1 == self._sha1s[pv]:
476
460
                # special case: same as the single parent
477
461
                return new_version
478
 
            
 
462
 
479
463
 
480
464
        ancestors = self._inclusions(parents)
481
465
 
491
475
        # another small special case: a merge, producing the same text
492
476
        # as auto-merge
493
477
        if lines == basis_lines:
494
 
            return new_version            
 
478
            return new_version
495
479
 
496
480
        # add a sentinel, because we can also match against the final line
497
481
        basis_lineno.append(len(self._weave))
516
500
            #print 'raw match', tag, i1, i2, j1, j2
517
501
            if tag == 'equal':
518
502
                continue
519
 
 
520
503
            i1 = basis_lineno[i1]
521
504
            i2 = basis_lineno[i2]
522
 
 
523
 
            assert 0 <= j1 <= j2 <= len(lines)
524
 
 
525
 
            #print tag, i1, i2, j1, j2
526
 
 
527
505
            # the deletion and insertion are handled separately.
528
506
            # first delete the region.
529
507
            if i1 != i2:
536
514
                # i2; we want to insert after this region to make sure
537
515
                # we don't destroy ourselves
538
516
                i = i2 + offset
539
 
                self._weave[i:i] = ([('{', new_version)] 
540
 
                                    + lines[j1:j2] 
 
517
                self._weave[i:i] = ([('{', new_version)]
 
518
                                    + lines[j1:j2]
541
519
                                    + [('}', None)])
542
520
                offset += 2 + (j2 - j1)
543
521
        return new_version
544
522
 
545
 
    def _clone_text(self, new_version_id, old_version_id, parents):
546
 
        """See VersionedFile.clone_text."""
547
 
        old_lines = self.get_text(old_version_id)
548
 
        self.add_lines(new_version_id, parents, old_lines)
549
 
 
550
523
    def _inclusions(self, versions):
551
524
        """Return set of all ancestors of given version(s)."""
552
525
        if not len(versions):
575
548
            if not isinstance(l, basestring):
576
549
                raise ValueError("text line should be a string or unicode, not %s"
577
550
                                 % type(l))
578
 
        
 
551
 
579
552
 
580
553
 
581
554
    def _check_versions(self, indexes):
589
562
    def _compatible_parents(self, my_parents, other_parents):
590
563
        """During join check that other_parents are joinable with my_parents.
591
564
 
592
 
        Joinable is defined as 'is a subset of' - supersets may require 
 
565
        Joinable is defined as 'is a subset of' - supersets may require
593
566
        regeneration of diffs, but subsets do not.
594
567
        """
595
568
        return len(other_parents.difference(my_parents)) == 0
596
569
 
597
 
    def annotate_iter(self, version_id):
598
 
        """Yield list of (version-id, line) pairs for the specified version.
 
570
    def annotate(self, version_id):
 
571
        """Return a list of (version-id, line) tuples for version_id.
599
572
 
600
573
        The index indicates when the line originated in the weave."""
601
574
        incls = [self._lookup(version_id)]
602
 
        for origin, lineno, text in self._extract(incls):
603
 
            yield self._idx_to_name(origin), text
 
575
        return [(self._idx_to_name(origin), text) for origin, lineno, text in
 
576
            self._extract(incls)]
604
577
 
605
578
    def iter_lines_added_or_present_in_versions(self, version_ids=None,
606
579
                                                pb=None):
609
582
            version_ids = self.versions()
610
583
        version_ids = set(version_ids)
611
584
        for lineno, inserted, deletes, line in self._walk_internal(version_ids):
612
 
            # if inserted not in version_ids then it was inserted before the
613
 
            # versions we care about, but because weaves cannot represent ghosts
614
 
            # properly, we do not filter down to that
615
 
            # if inserted not in version_ids: continue
 
585
            if inserted not in version_ids: continue
616
586
            if line[-1] != '\n':
617
 
                yield line + '\n'
 
587
                yield line + '\n', inserted
618
588
            else:
619
 
                yield line
 
589
                yield line, inserted
620
590
 
621
591
    def _walk_internal(self, version_ids=None):
622
592
        """Helper method for weave actions."""
623
 
        
 
593
 
624
594
        istack = []
625
595
        dset = set()
626
596
 
635
605
                elif c == '}':
636
606
                    istack.pop()
637
607
                elif c == '[':
638
 
                    assert self._names[v] not in dset
639
608
                    dset.add(self._names[v])
640
609
                elif c == ']':
641
610
                    dset.remove(self._names[v])
642
611
                else:
643
612
                    raise WeaveFormatError('unexpected instruction %r' % v)
644
613
            else:
645
 
                assert l.__class__ in (str, unicode)
646
 
                assert istack
647
614
                yield lineno, istack[-1], frozenset(dset), l
648
615
            lineno += 1
649
616
 
698
665
                # not in either revision
699
666
                yield 'irrelevant', line
700
667
 
701
 
        yield 'unchanged', ''           # terminator
702
 
 
703
668
    def _extract(self, versions):
704
669
        """Yield annotation of lines in included set.
705
670
 
712
677
        for i in versions:
713
678
            if not isinstance(i, int):
714
679
                raise ValueError(i)
715
 
            
 
680
 
716
681
        included = self._inclusions(versions)
717
682
 
718
683
        istack = []
727
692
 
728
693
        WFE = WeaveFormatError
729
694
 
730
 
        # wow. 
 
695
        # wow.
731
696
        #  449       0   4474.6820   2356.5590   bzrlib.weave:556(_extract)
732
697
        #  +285282   0   1676.8040   1676.8040   +<isinstance>
733
698
        # 1.6 seconds in 'isinstance'.
739
704
        # we're still spending ~1/4 of the method in isinstance though.
740
705
        # so lets hard code the acceptable string classes we expect:
741
706
        #  449       0   1202.9420    786.2930   bzrlib.weave:556(_extract)
742
 
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list' 
 
707
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list'
743
708
        #                                          objects>
744
709
        # yay, down to ~1/4 the initial extract time, and our inline time
745
710
        # has shrunk again, with isinstance no longer dominating.
746
711
        # tweaking the stack inclusion test to use a set gives:
747
712
        #  449       0   1122.8030    713.0080   bzrlib.weave:556(_extract)
748
 
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list' 
 
713
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list'
749
714
        #                                          objects>
750
715
        # - a 5% win, or possibly just noise. However with large istacks that
751
716
        # 'in' test could dominate, so I'm leaving this change in place -
752
717
        # when its fast enough to consider profiling big datasets we can review.
753
718
 
754
 
              
755
 
             
 
719
 
 
720
 
756
721
 
757
722
        for l in self._weave:
758
723
            if l.__class__ == tuple:
759
724
                c, v = l
760
725
                isactive = None
761
726
                if c == '{':
762
 
                    assert v not in iset
763
727
                    istack.append(v)
764
728
                    iset.add(v)
765
729
                elif c == '}':
766
730
                    iset.remove(istack.pop())
767
731
                elif c == '[':
768
732
                    if v in included:
769
 
                        assert v not in dset
770
733
                        dset.add(v)
771
 
                else:
772
 
                    assert c == ']'
 
734
                elif c == ']':
773
735
                    if v in included:
774
 
                        assert v in dset
775
736
                        dset.remove(v)
 
737
                else:
 
738
                    raise AssertionError()
776
739
            else:
777
 
                assert l.__class__ in (str, unicode)
778
740
                if isactive is None:
779
741
                    isactive = (not dset) and istack and (istack[-1] in included)
780
742
                if isactive:
790
752
 
791
753
    def _maybe_lookup(self, name_or_index):
792
754
        """Convert possible symbolic name to index, or pass through indexes.
793
 
        
 
755
 
794
756
        NOT FOR PUBLIC USE.
795
757
        """
796
758
        if isinstance(name_or_index, (int, long)):
806
768
        measured_sha1 = sha_strings(result)
807
769
        if measured_sha1 != expected_sha1:
808
770
            raise errors.WeaveInvalidChecksum(
809
 
                    'file %s, revision %s, expected: %s, measured %s' 
 
771
                    'file %s, revision %s, expected: %s, measured %s'
810
772
                    % (self._weave_name, version_id,
811
773
                       expected_sha1, measured_sha1))
812
774
        return result
813
775
 
814
 
    def get_sha1(self, version_id):
815
 
        """See VersionedFile.get_sha1()."""
816
 
        return self._sha1s[self._lookup(version_id)]
817
 
 
818
776
    def get_sha1s(self, version_ids):
819
777
        """See VersionedFile.get_sha1s()."""
820
 
        return [self._sha1s[self._lookup(v)] for v in version_ids]
 
778
        result = {}
 
779
        for v in version_ids:
 
780
            result[v] = self._sha1s[self._lookup(v)]
 
781
        return result
821
782
 
822
783
    def num_versions(self):
823
784
        """How many versions are in this weave?"""
824
785
        l = len(self._parents)
825
 
        assert l == len(self._sha1s)
826
786
        return l
827
787
 
828
788
    __len__ = num_versions
848
808
            # For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
849
809
            # The problem is that set membership is much more expensive
850
810
            name = self._idx_to_name(i)
851
 
            sha1s[name] = sha.new()
 
811
            sha1s[name] = sha()
852
812
            texts[name] = []
853
813
            new_inc = set([name])
854
814
            for p in self._parents[i]:
855
815
                new_inc.update(inclusions[self._idx_to_name(p)])
856
816
 
857
 
            assert set(new_inc) == set(self.get_ancestry(name)), \
858
 
                'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
 
817
            if set(new_inc) != set(self.get_ancestry(name)):
 
818
                raise AssertionError(
 
819
                    'failed %s != %s'
 
820
                    % (set(new_inc), set(self.get_ancestry(name))))
859
821
            inclusions[name] = new_inc
860
822
 
861
823
        nlines = len(self._weave)
891
853
        # no lines outside of insertion blocks, that deletions are
892
854
        # properly paired, etc.
893
855
 
894
 
    def _join(self, other, pb, msg, version_ids, ignore_missing):
895
 
        """Worker routine for join()."""
896
 
        if not other.versions():
897
 
            return          # nothing to update, easy
898
 
 
899
 
        if not version_ids:
900
 
            # versions is never none, InterWeave checks this.
901
 
            return 0
902
 
 
903
 
        # two loops so that we do not change ourselves before verifying it
904
 
        # will be ok
905
 
        # work through in index order to make sure we get all dependencies
906
 
        names_to_join = []
907
 
        processed = 0
908
 
        # get the selected versions only that are in other.versions.
909
 
        version_ids = set(other.versions()).intersection(set(version_ids))
910
 
        # pull in the referenced graph.
911
 
        version_ids = other.get_ancestry(version_ids)
912
 
        pending_graph = [(version, other.get_parents(version)) for
913
 
                         version in version_ids]
914
 
        for name in topo_sort(pending_graph):
915
 
            other_idx = other._name_map[name]
916
 
            # returns True if we have it, False if we need it.
917
 
            if not self._check_version_consistent(other, other_idx, name):
918
 
                names_to_join.append((other_idx, name))
919
 
            processed += 1
920
 
 
921
 
 
922
 
        if pb and not msg:
923
 
            msg = 'weave join'
924
 
 
925
 
        merged = 0
926
 
        time0 = time.time()
927
 
        for other_idx, name in names_to_join:
928
 
            # TODO: If all the parents of the other version are already
929
 
            # present then we can avoid some work by just taking the delta
930
 
            # and adjusting the offsets.
931
 
            new_parents = self._imported_parents(other, other_idx)
932
 
            sha1 = other._sha1s[other_idx]
933
 
 
934
 
            merged += 1
935
 
 
936
 
            if pb:
937
 
                pb.update(msg, merged, len(names_to_join))
938
 
           
939
 
            lines = other.get_lines(other_idx)
940
 
            self._add(name, lines, new_parents, sha1)
941
 
 
942
 
        mutter("merged = %d, processed = %d, file_id=%s; deltat=%d"%(
943
 
                merged, processed, self._weave_name, time.time()-time0))
944
 
 
945
856
    def _imported_parents(self, other, other_idx):
946
857
        """Return list of parents in self corresponding to indexes in other."""
947
858
        new_parents = []
949
860
            parent_name = other._names[parent_idx]
950
861
            if parent_name not in self._name_map:
951
862
                # should not be possible
952
 
                raise WeaveError("missing parent {%s} of {%s} in %r" 
 
863
                raise WeaveError("missing parent {%s} of {%s} in %r"
953
864
                                 % (parent_name, other._name_map[other_idx], self))
954
865
            new_parents.append(self._name_map[parent_name])
955
866
        return new_parents
962
873
         * the same text
963
874
         * the same direct parents (by name, not index, and disregarding
964
875
           order)
965
 
        
 
876
 
966
877
        If present & correct return True;
967
 
        if not present in self return False; 
 
878
        if not present in self return False;
968
879
        if inconsistent raise error."""
969
880
        this_idx = self._name_map.get(name, -1)
970
881
        if this_idx != -1:
1003
914
    """A WeaveFile represents a Weave on disk and writes on change."""
1004
915
 
1005
916
    WEAVE_SUFFIX = '.weave'
1006
 
    
1007
 
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w'):
 
917
 
 
918
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w', get_scope=None):
1008
919
        """Create a WeaveFile.
1009
 
        
 
920
 
1010
921
        :param create: If not True, only open an existing knit.
1011
922
        """
1012
 
        super(WeaveFile, self).__init__(name, access_mode)
 
923
        super(WeaveFile, self).__init__(name, access_mode, get_scope=get_scope,
 
924
            allow_reserved=False)
1013
925
        self._transport = transport
1014
926
        self._filemode = filemode
1015
927
        try:
1021
933
            self._save()
1022
934
 
1023
935
    def _add_lines(self, version_id, parents, lines, parent_texts,
1024
 
        left_matching_blocks=None):
 
936
        left_matching_blocks, nostore_sha, random_id, check_content):
1025
937
        """Add a version and save the weave."""
1026
938
        self.check_not_reserved_id(version_id)
1027
939
        result = super(WeaveFile, self)._add_lines(version_id, parents, lines,
1028
 
                                                   parent_texts)
 
940
            parent_texts, left_matching_blocks, nostore_sha, random_id,
 
941
            check_content)
1029
942
        self._save()
1030
943
        return result
1031
944
 
1032
 
    def _clone_text(self, new_version_id, old_version_id, parents):
1033
 
        """See VersionedFile.clone_text."""
1034
 
        super(WeaveFile, self)._clone_text(new_version_id, old_version_id, parents)
1035
 
        self._save
1036
 
 
1037
945
    def copy_to(self, name, transport):
1038
946
        """See VersionedFile.copy_to()."""
1039
947
        # as we are all in memory always, just serialise to the new place.
1042
950
        sio.seek(0)
1043
951
        transport.put_file(name + WeaveFile.WEAVE_SUFFIX, sio, self._filemode)
1044
952
 
1045
 
    def create_empty(self, name, transport, filemode=None):
1046
 
        return WeaveFile(name, transport, filemode, create=True)
1047
 
 
1048
953
    def _save(self):
1049
954
        """Save the weave."""
1050
955
        self._check_write_ok()
1051
956
        sio = StringIO()
1052
957
        write_weave_v5(self, sio)
1053
958
        sio.seek(0)
1054
 
        self._transport.put_file(self._weave_name + WeaveFile.WEAVE_SUFFIX,
1055
 
                                 sio,
1056
 
                                 self._filemode)
 
959
        bytes = sio.getvalue()
 
960
        path = self._weave_name + WeaveFile.WEAVE_SUFFIX
 
961
        try:
 
962
            self._transport.put_bytes(path, bytes, self._filemode)
 
963
        except errors.NoSuchFile:
 
964
            self._transport.mkdir(dirname(path))
 
965
            self._transport.put_bytes(path, bytes, self._filemode)
1057
966
 
1058
967
    @staticmethod
1059
968
    def get_suffixes():
1060
969
        """See VersionedFile.get_suffixes()."""
1061
970
        return [WeaveFile.WEAVE_SUFFIX]
1062
971
 
1063
 
    def join(self, other, pb=None, msg=None, version_ids=None,
1064
 
             ignore_missing=False):
1065
 
        """Join other into self and save."""
1066
 
        super(WeaveFile, self).join(other, pb, msg, version_ids, ignore_missing)
 
972
    def insert_record_stream(self, stream):
 
973
        super(WeaveFile, self).insert_record_stream(stream)
1067
974
        self._save()
1068
975
 
1069
976
 
1070
977
def _reweave(wa, wb, pb=None, msg=None):
1071
978
    """Combine two weaves and return the result.
1072
979
 
1073
 
    This works even if a revision R has different parents in 
 
980
    This works even if a revision R has different parents in
1074
981
    wa and wb.  In the resulting weave all the parents are given.
1075
982
 
1076
 
    This is done by just building up a new weave, maintaining ordering 
 
983
    This is done by just building up a new weave, maintaining ordering
1077
984
    of the versions in the two inputs.  More efficient approaches
1078
 
    might be possible but it should only be necessary to do 
1079
 
    this operation rarely, when a new previously ghost version is 
 
985
    might be possible but it should only be necessary to do
 
986
    this operation rarely, when a new previously ghost version is
1080
987
    inserted.
1081
988
 
1082
989
    :param pb: An optional progress bar, indicating how far done we are
1090
997
    # map from version name -> all parent names
1091
998
    combined_parents = _reweave_parent_graphs(wa, wb)
1092
999
    mutter("combined parents: %r", combined_parents)
1093
 
    order = topo_sort(combined_parents.iteritems())
 
1000
    order = tsort.topo_sort(combined_parents.iteritems())
1094
1001
    mutter("order to reweave: %r", order)
1095
1002
 
1096
1003
    if pb and not msg:
1116
1023
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
1117
1024
    return wr
1118
1025
 
 
1026
 
1119
1027
def _reweave_parent_graphs(wa, wb):
1120
1028
    """Return combined parent ancestry for two weaves.
1121
 
    
 
1029
 
1122
1030
    Returned as a list of (version_name, set(parent_names))"""
1123
1031
    combined = {}
1124
1032
    for weave in [wa, wb]:
1126
1034
            p = combined.setdefault(name, set())
1127
1035
            p.update(map(weave._idx_to_name, weave._parents[idx]))
1128
1036
    return combined
1129
 
 
1130
 
 
1131
 
def weave_toc(w):
1132
 
    """Show the weave's table-of-contents"""
1133
 
    print '%6s %50s %10s %10s' % ('ver', 'name', 'sha1', 'parents')
1134
 
    for i in (6, 50, 10, 10):
1135
 
        print '-' * i,
1136
 
    print
1137
 
    for i in range(w.num_versions()):
1138
 
        sha1 = w._sha1s[i]
1139
 
        name = w._names[i]
1140
 
        parent_str = ' '.join(map(str, w._parents[i]))
1141
 
        print '%6d %-50.50s %10.10s %s' % (i, name, sha1, parent_str)
1142
 
 
1143
 
 
1144
 
 
1145
 
def weave_stats(weave_file, pb):
1146
 
    from bzrlib.weavefile import read_weave
1147
 
 
1148
 
    wf = file(weave_file, 'rb')
1149
 
    w = read_weave(wf)
1150
 
    # FIXME: doesn't work on pipes
1151
 
    weave_size = wf.tell()
1152
 
 
1153
 
    total = 0
1154
 
    vers = len(w)
1155
 
    for i in range(vers):
1156
 
        pb.update('checking sizes', i, vers)
1157
 
        for origin, lineno, line in w._extract([i]):
1158
 
            total += len(line)
1159
 
 
1160
 
    pb.clear()
1161
 
 
1162
 
    print 'versions          %9d' % vers
1163
 
    print 'weave file        %9d bytes' % weave_size
1164
 
    print 'total contents    %9d bytes' % total
1165
 
    print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
1166
 
    if vers:
1167
 
        avg = total/vers
1168
 
        print 'average size      %9d bytes' % avg
1169
 
        print 'relative size     %9.2fx' % (float(weave_size) / float(avg))
1170
 
 
1171
 
 
1172
 
def usage():
1173
 
    print """bzr weave tool
1174
 
 
1175
 
Experimental tool for weave algorithm.
1176
 
 
1177
 
usage:
1178
 
    weave init WEAVEFILE
1179
 
        Create an empty weave file
1180
 
    weave get WEAVEFILE VERSION
1181
 
        Write out specified version.
1182
 
    weave check WEAVEFILE
1183
 
        Check consistency of all versions.
1184
 
    weave toc WEAVEFILE
1185
 
        Display table of contents.
1186
 
    weave add WEAVEFILE NAME [BASE...] < NEWTEXT
1187
 
        Add NEWTEXT, with specified parent versions.
1188
 
    weave annotate WEAVEFILE VERSION
1189
 
        Display origin of each line.
1190
 
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
1191
 
        Auto-merge two versions and display conflicts.
1192
 
    weave diff WEAVEFILE VERSION1 VERSION2 
1193
 
        Show differences between two versions.
1194
 
 
1195
 
example:
1196
 
 
1197
 
    % weave init foo.weave
1198
 
    % vi foo.txt
1199
 
    % weave add foo.weave ver0 < foo.txt
1200
 
    added version 0
1201
 
 
1202
 
    (create updated version)
1203
 
    % vi foo.txt
1204
 
    % weave get foo.weave 0 | diff -u - foo.txt
1205
 
    % weave add foo.weave ver1 0 < foo.txt
1206
 
    added version 1
1207
 
 
1208
 
    % weave get foo.weave 0 > foo.txt       (create forked version)
1209
 
    % vi foo.txt
1210
 
    % weave add foo.weave ver2 0 < foo.txt
1211
 
    added version 2
1212
 
 
1213
 
    % weave merge foo.weave 1 2 > foo.txt   (merge them)
1214
 
    % vi foo.txt                            (resolve conflicts)
1215
 
    % weave add foo.weave merged 1 2 < foo.txt     (commit merged version)     
1216
 
    
1217
 
"""
1218
 
    
1219
 
 
1220
 
 
1221
 
def main(argv):
1222
 
    import sys
1223
 
    import os
1224
 
    try:
1225
 
        import bzrlib
1226
 
    except ImportError:
1227
 
        # in case we're run directly from the subdirectory
1228
 
        sys.path.append('..')
1229
 
        import bzrlib
1230
 
    from bzrlib.weavefile import write_weave, read_weave
1231
 
    from bzrlib.progress import ProgressBar
1232
 
 
1233
 
    try:
1234
 
        import psyco
1235
 
        psyco.full()
1236
 
    except ImportError:
1237
 
        pass
1238
 
 
1239
 
    if len(argv) < 2:
1240
 
        usage()
1241
 
        return 0
1242
 
 
1243
 
    cmd = argv[1]
1244
 
 
1245
 
    def readit():
1246
 
        return read_weave(file(argv[2], 'rb'))
1247
 
    
1248
 
    if cmd == 'help':
1249
 
        usage()
1250
 
    elif cmd == 'add':
1251
 
        w = readit()
1252
 
        # at the moment, based on everything in the file
1253
 
        name = argv[3]
1254
 
        parents = map(int, argv[4:])
1255
 
        lines = sys.stdin.readlines()
1256
 
        ver = w.add(name, parents, lines)
1257
 
        write_weave(w, file(argv[2], 'wb'))
1258
 
        print 'added version %r %d' % (name, ver)
1259
 
    elif cmd == 'init':
1260
 
        fn = argv[2]
1261
 
        if os.path.exists(fn):
1262
 
            raise IOError("file exists")
1263
 
        w = Weave()
1264
 
        write_weave(w, file(fn, 'wb'))
1265
 
    elif cmd == 'get': # get one version
1266
 
        w = readit()
1267
 
        sys.stdout.writelines(w.get_iter(int(argv[3])))
1268
 
        
1269
 
    elif cmd == 'diff':
1270
 
        w = readit()
1271
 
        fn = argv[2]
1272
 
        v1, v2 = map(int, argv[3:5])
1273
 
        lines1 = w.get(v1)
1274
 
        lines2 = w.get(v2)
1275
 
        diff_gen = bzrlib.patiencediff.unified_diff(lines1, lines2,
1276
 
                                '%s version %d' % (fn, v1),
1277
 
                                '%s version %d' % (fn, v2))
1278
 
        sys.stdout.writelines(diff_gen)
1279
 
            
1280
 
    elif cmd == 'annotate':
1281
 
        w = readit()
1282
 
        # newline is added to all lines regardless; too hard to get
1283
 
        # reasonable formatting otherwise
1284
 
        lasto = None
1285
 
        for origin, text in w.annotate(int(argv[3])):
1286
 
            text = text.rstrip('\r\n')
1287
 
            if origin == lasto:
1288
 
                print '      | %s' % (text)
1289
 
            else:
1290
 
                print '%5d | %s' % (origin, text)
1291
 
                lasto = origin
1292
 
                
1293
 
    elif cmd == 'toc':
1294
 
        weave_toc(readit())
1295
 
 
1296
 
    elif cmd == 'stats':
1297
 
        weave_stats(argv[2], ProgressBar())
1298
 
        
1299
 
    elif cmd == 'check':
1300
 
        w = readit()
1301
 
        pb = ProgressBar()
1302
 
        w.check(pb)
1303
 
        pb.clear()
1304
 
        print '%d versions ok' % w.num_versions()
1305
 
 
1306
 
    elif cmd == 'inclusions':
1307
 
        w = readit()
1308
 
        print ' '.join(map(str, w.inclusions([int(argv[3])])))
1309
 
 
1310
 
    elif cmd == 'parents':
1311
 
        w = readit()
1312
 
        print ' '.join(map(str, w._parents[int(argv[3])]))
1313
 
 
1314
 
    elif cmd == 'plan-merge':
1315
 
        # replaced by 'bzr weave-plan-merge'
1316
 
        w = readit()
1317
 
        for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
1318
 
            if line:
1319
 
                print '%14s | %s' % (state, line),
1320
 
    elif cmd == 'merge':
1321
 
        # replaced by 'bzr weave-merge-text'
1322
 
        w = readit()
1323
 
        p = w.plan_merge(int(argv[3]), int(argv[4]))
1324
 
        sys.stdout.writelines(w.weave_merge(p))
1325
 
    else:
1326
 
        raise ValueError('unknown command %r' % cmd)
1327
 
    
1328
 
 
1329
 
if __name__ == '__main__':
1330
 
    import sys
1331
 
    sys.exit(main(sys.argv))
1332
 
 
1333
 
 
1334
 
class InterWeave(InterVersionedFile):
1335
 
    """Optimised code paths for weave to weave operations."""
1336
 
    
1337
 
    _matching_file_from_factory = staticmethod(WeaveFile)
1338
 
    _matching_file_to_factory = staticmethod(WeaveFile)
1339
 
    
1340
 
    @staticmethod
1341
 
    def is_compatible(source, target):
1342
 
        """Be compatible with weaves."""
1343
 
        try:
1344
 
            return (isinstance(source, Weave) and
1345
 
                    isinstance(target, Weave))
1346
 
        except AttributeError:
1347
 
            return False
1348
 
 
1349
 
    def join(self, pb=None, msg=None, version_ids=None, ignore_missing=False):
1350
 
        """See InterVersionedFile.join."""
1351
 
        version_ids = self._get_source_version_ids(version_ids, ignore_missing)
1352
 
        if self.target.versions() == [] and version_ids is None:
1353
 
            self.target._copy_weave_content(self.source)
1354
 
            return
1355
 
        try:
1356
 
            self.target._join(self.source, pb, msg, version_ids, ignore_missing)
1357
 
        except errors.WeaveParentMismatch:
1358
 
            self.target._reweave(self.source, pb, msg)
1359
 
 
1360
 
 
1361
 
InterVersionedFile.register_optimiser(InterWeave)