← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Martin Pool
  • Date: 2007-08-21 05:29:59 UTC
  • mto: This revision was merged to the branch mainline in revision 2779.
  • Revision ID: mbp@sourcefrog.net-20070821052959-5odvyjziwyuaeo3d
Move per-inventory tests from test_inv to tests.inventory_implementations

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/weave.py
1
 
# Copyright (C) 2005, 2009 Canonical Ltd
 
1
#! /usr/bin/python
 
2
 
 
3
# Copyright (C) 2005 Canonical Ltd
2
4
#
3
5
# This program is free software; you can redistribute it and/or modify
4
6
# it under the terms of the GNU General Public License as published by
12
14
#
13
15
# You should have received a copy of the GNU General Public License
14
16
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
18
 
17
19
# Author: Martin Pool <mbp@canonical.com>
18
20
 
 
21
 
19
22
"""Weave - storage of related text file versions"""
20
23
 
21
 
from __future__ import absolute_import
22
24
 
23
25
# XXX: If we do weaves this way, will a merge still behave the same
24
26
# way if it's done in a different order?  That's a pretty desirable
59
61
# where the basis and destination are unchanged.
60
62
 
61
63
# 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
# that includes some redundant parents (i.e. already a parent of 
 
65
# something in the list.)  We should eliminate them.  This can 
64
66
# be done fairly efficiently because the sequence numbers constrain
65
67
# the possible relationships.
66
68
 
69
71
from copy import copy
70
72
from cStringIO import StringIO
71
73
import os
 
74
import sha
 
75
import time
 
76
import warnings
72
77
 
73
 
from bzrlib.lazy_import import lazy_import
74
 
lazy_import(globals(), """
75
 
from bzrlib import tsort
76
 
""")
77
78
from bzrlib import (
78
 
    errors,
79
 
    osutils,
 
79
    progress,
80
80
    )
 
81
from bzrlib.trace import mutter
81
82
from bzrlib.errors import (WeaveError, WeaveFormatError, WeaveParentMismatch,
82
83
        RevisionAlreadyPresent,
83
84
        RevisionNotPresent,
84
 
        UnavailableRepresentation,
 
85
        WeaveRevisionAlreadyPresent,
 
86
        WeaveRevisionNotPresent,
85
87
        )
86
 
from bzrlib.osutils import dirname, sha, sha_strings, split_lines
 
88
import bzrlib.errors as errors
 
89
from bzrlib.osutils import sha_strings
87
90
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
 
    )
 
91
from bzrlib.tsort import topo_sort
 
92
from bzrlib.versionedfile import VersionedFile, InterVersionedFile
98
93
from bzrlib.weavefile import _read_weave_v5, write_weave_v5
99
94
 
100
95
 
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
96
class Weave(VersionedFile):
127
97
    """weave - versioned text file storage.
128
 
 
 
98
    
129
99
    A Weave manages versions of line-based text files, keeping track
130
100
    of the originating version for each line.
131
101
 
177
147
 
178
148
    * It doesn't seem very useful to have an active insertion
179
149
      inside an inactive insertion, but it might happen.
180
 
 
 
150
      
181
151
    * Therefore, all instructions are always"considered"; that
182
152
      is passed onto and off the stack.  An outer inactive block
183
153
      doesn't disable an inner block.
213
183
    """
214
184
 
215
185
    __slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map',
216
 
                 '_weave_name', '_matcher', '_allow_reserved']
217
 
 
218
 
    def __init__(self, weave_name=None, access_mode='w', matcher=None,
219
 
                 get_scope=None, allow_reserved=False):
220
 
        """Create a weave.
221
 
 
222
 
        :param get_scope: A callable that returns an opaque object to be used
223
 
            for detecting when this weave goes out of scope (should stop
224
 
            answering requests or allowing mutation).
225
 
        """
226
 
        super(Weave, self).__init__()
 
186
                 '_weave_name', '_matcher']
 
187
    
 
188
    def __init__(self, weave_name=None, access_mode='w', matcher=None):
 
189
        super(Weave, self).__init__(access_mode)
227
190
        self._weave = []
228
191
        self._parents = []
229
192
        self._sha1s = []
234
197
            self._matcher = bzrlib.patiencediff.PatienceSequenceMatcher
235
198
        else:
236
199
            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
200
 
244
201
    def __repr__(self):
245
202
        return "Weave(%r)" % self._weave_name
246
203
 
247
 
    def _check_write_ok(self):
248
 
        """Is the versioned file marked as 'finished' ? Raise if it is."""
249
 
        if self._get_scope() != self._scope:
250
 
            raise errors.OutSideTransaction()
251
 
        if self._access_mode != 'w':
252
 
            raise errors.ReadOnlyObjectDirtiedError(self)
253
 
 
254
204
    def copy(self):
255
205
        """Return a deep copy of self.
256
 
 
 
206
        
257
207
        The copy can be modified without affecting the original weave."""
258
208
        other = Weave()
259
209
        other._weave = self._weave[:]
269
219
            return False
270
220
        return self._parents == other._parents \
271
221
               and self._weave == other._weave \
272
 
               and self._sha1s == other._sha1s
273
 
 
 
222
               and self._sha1s == other._sha1s 
 
223
    
274
224
    def __ne__(self, other):
275
225
        return not self.__eq__(other)
276
226
 
279
229
 
280
230
    def _lookup(self, name):
281
231
        """Convert symbolic version name to index."""
282
 
        if not self._allow_reserved:
283
 
            self.check_not_reserved_id(name)
 
232
        self.check_not_reserved_id(name)
284
233
        try:
285
234
            return self._name_map[name]
286
235
        except KeyError:
296
245
 
297
246
    __contains__ = has_version
298
247
 
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 = {}
 
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)
332
255
        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:
 
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
341
319
                    continue
342
 
            result[version_id] = parents
 
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
                                  )
343
402
        return result
344
403
 
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
 
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)])
379
407
 
380
408
    def _check_repeated_add(self, name, parents, text, sha1):
381
409
        """Check that a duplicated add is OK.
389
417
        return idx
390
418
 
391
419
    def _add_lines(self, version_id, parents, lines, parent_texts,
392
 
       left_matching_blocks, nostore_sha, random_id, check_content):
 
420
                   left_matching_blocks=None):
393
421
        """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
 
422
        return self._add(version_id, lines, map(self._lookup, parents))
397
423
 
398
 
    def _add(self, version_id, lines, parents, sha1=None, nostore_sha=None):
 
424
    def _add(self, version_id, lines, parents, sha1=None):
399
425
        """Add a single text on top of the weave.
400
 
 
 
426
  
401
427
        Returns the index number of the newly added version.
402
428
 
403
429
        version_id
404
430
            Symbolic name for this version.
405
431
            (Typically the revision-id of the revision that added it.)
406
 
            If None, a name will be allocated based on the hash. (sha1:SHAHASH)
407
432
 
408
433
        parents
409
434
            List or set of direct parent version numbers.
410
 
 
 
435
            
411
436
        lines
412
437
            Sequence of lines to be added in the new version.
 
438
        """
413
439
 
414
 
        :param nostore_sha: See VersionedFile.add_lines.
415
 
        """
 
440
        assert isinstance(version_id, basestring)
416
441
        self._check_lines_not_unicode(lines)
417
442
        self._check_lines_are_lines(lines)
418
443
        if not sha1:
419
444
            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
445
        if version_id in self._name_map:
425
446
            return self._check_repeated_add(version_id, parents, lines, sha1)
426
447
 
437
458
        self._names.append(version_id)
438
459
        self._name_map[version_id] = new_version
439
460
 
440
 
 
 
461
            
441
462
        if not parents:
442
463
            # special case; adding with no parents revision; can do
443
464
            # this more quickly by just appending unconditionally.
454
475
            if sha1 == self._sha1s[pv]:
455
476
                # special case: same as the single parent
456
477
                return new_version
457
 
 
 
478
            
458
479
 
459
480
        ancestors = self._inclusions(parents)
460
481
 
470
491
        # another small special case: a merge, producing the same text
471
492
        # as auto-merge
472
493
        if lines == basis_lines:
473
 
            return new_version
 
494
            return new_version            
474
495
 
475
496
        # add a sentinel, because we can also match against the final line
476
497
        basis_lineno.append(len(self._weave))
495
516
            #print 'raw match', tag, i1, i2, j1, j2
496
517
            if tag == 'equal':
497
518
                continue
 
519
 
498
520
            i1 = basis_lineno[i1]
499
521
            i2 = basis_lineno[i2]
 
522
 
 
523
            assert 0 <= j1 <= j2 <= len(lines)
 
524
 
 
525
            #print tag, i1, i2, j1, j2
 
526
 
500
527
            # the deletion and insertion are handled separately.
501
528
            # first delete the region.
502
529
            if i1 != i2:
509
536
                # i2; we want to insert after this region to make sure
510
537
                # we don't destroy ourselves
511
538
                i = i2 + offset
512
 
                self._weave[i:i] = ([('{', new_version)]
513
 
                                    + lines[j1:j2]
 
539
                self._weave[i:i] = ([('{', new_version)] 
 
540
                                    + lines[j1:j2] 
514
541
                                    + [('}', None)])
515
542
                offset += 2 + (j2 - j1)
516
543
        return new_version
517
544
 
 
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
 
518
550
    def _inclusions(self, versions):
519
551
        """Return set of all ancestors of given version(s)."""
520
552
        if not len(versions):
543
575
            if not isinstance(l, basestring):
544
576
                raise ValueError("text line should be a string or unicode, not %s"
545
577
                                 % type(l))
546
 
 
 
578
        
547
579
 
548
580
 
549
581
    def _check_versions(self, indexes):
557
589
    def _compatible_parents(self, my_parents, other_parents):
558
590
        """During join check that other_parents are joinable with my_parents.
559
591
 
560
 
        Joinable is defined as 'is a subset of' - supersets may require
 
592
        Joinable is defined as 'is a subset of' - supersets may require 
561
593
        regeneration of diffs, but subsets do not.
562
594
        """
563
595
        return len(other_parents.difference(my_parents)) == 0
564
596
 
565
 
    def annotate(self, version_id):
566
 
        """Return a list of (version-id, line) tuples for version_id.
 
597
    def annotate_iter(self, version_id):
 
598
        """Yield list of (version-id, line) pairs for the specified version.
567
599
 
568
600
        The index indicates when the line originated in the weave."""
569
601
        incls = [self._lookup(version_id)]
570
 
        return [(self._idx_to_name(origin), text) for origin, lineno, text in
571
 
            self._extract(incls)]
 
602
        for origin, lineno, text in self._extract(incls):
 
603
            yield self._idx_to_name(origin), text
572
604
 
573
605
    def iter_lines_added_or_present_in_versions(self, version_ids=None,
574
606
                                                pb=None):
577
609
            version_ids = self.versions()
578
610
        version_ids = set(version_ids)
579
611
        for lineno, inserted, deletes, line in self._walk_internal(version_ids):
580
 
            if inserted not in version_ids: continue
 
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
581
616
            if line[-1] != '\n':
582
 
                yield line + '\n', inserted
 
617
                yield line + '\n'
583
618
            else:
584
 
                yield line, inserted
 
619
                yield line
585
620
 
586
621
    def _walk_internal(self, version_ids=None):
587
622
        """Helper method for weave actions."""
588
 
 
 
623
        
589
624
        istack = []
590
625
        dset = set()
591
626
 
600
635
                elif c == '}':
601
636
                    istack.pop()
602
637
                elif c == '[':
 
638
                    assert self._names[v] not in dset
603
639
                    dset.add(self._names[v])
604
640
                elif c == ']':
605
641
                    dset.remove(self._names[v])
606
642
                else:
607
643
                    raise WeaveFormatError('unexpected instruction %r' % v)
608
644
            else:
 
645
                assert l.__class__ in (str, unicode)
 
646
                assert istack
609
647
                yield lineno, istack[-1], frozenset(dset), l
610
648
            lineno += 1
611
649
 
660
698
                # not in either revision
661
699
                yield 'irrelevant', line
662
700
 
 
701
        yield 'unchanged', ''           # terminator
 
702
 
663
703
    def _extract(self, versions):
664
704
        """Yield annotation of lines in included set.
665
705
 
672
712
        for i in versions:
673
713
            if not isinstance(i, int):
674
714
                raise ValueError(i)
675
 
 
 
715
            
676
716
        included = self._inclusions(versions)
677
717
 
678
718
        istack = []
687
727
 
688
728
        WFE = WeaveFormatError
689
729
 
690
 
        # wow.
 
730
        # wow. 
691
731
        #  449       0   4474.6820   2356.5590   bzrlib.weave:556(_extract)
692
732
        #  +285282   0   1676.8040   1676.8040   +<isinstance>
693
733
        # 1.6 seconds in 'isinstance'.
699
739
        # we're still spending ~1/4 of the method in isinstance though.
700
740
        # so lets hard code the acceptable string classes we expect:
701
741
        #  449       0   1202.9420    786.2930   bzrlib.weave:556(_extract)
702
 
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list'
 
742
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list' 
703
743
        #                                          objects>
704
744
        # yay, down to ~1/4 the initial extract time, and our inline time
705
745
        # has shrunk again, with isinstance no longer dominating.
706
746
        # tweaking the stack inclusion test to use a set gives:
707
747
        #  449       0   1122.8030    713.0080   bzrlib.weave:556(_extract)
708
 
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list'
 
748
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list' 
709
749
        #                                          objects>
710
750
        # - a 5% win, or possibly just noise. However with large istacks that
711
751
        # 'in' test could dominate, so I'm leaving this change in place -
712
752
        # when its fast enough to consider profiling big datasets we can review.
713
753
 
714
 
 
715
 
 
 
754
              
 
755
             
716
756
 
717
757
        for l in self._weave:
718
758
            if l.__class__ == tuple:
719
759
                c, v = l
720
760
                isactive = None
721
761
                if c == '{':
 
762
                    assert v not in iset
722
763
                    istack.append(v)
723
764
                    iset.add(v)
724
765
                elif c == '}':
725
766
                    iset.remove(istack.pop())
726
767
                elif c == '[':
727
768
                    if v in included:
 
769
                        assert v not in dset
728
770
                        dset.add(v)
729
 
                elif c == ']':
 
771
                else:
 
772
                    assert c == ']'
730
773
                    if v in included:
 
774
                        assert v in dset
731
775
                        dset.remove(v)
732
 
                else:
733
 
                    raise AssertionError()
734
776
            else:
 
777
                assert l.__class__ in (str, unicode)
735
778
                if isactive is None:
736
779
                    isactive = (not dset) and istack and (istack[-1] in included)
737
780
                if isactive:
747
790
 
748
791
    def _maybe_lookup(self, name_or_index):
749
792
        """Convert possible symbolic name to index, or pass through indexes.
750
 
 
 
793
        
751
794
        NOT FOR PUBLIC USE.
752
795
        """
753
796
        if isinstance(name_or_index, (int, long)):
763
806
        measured_sha1 = sha_strings(result)
764
807
        if measured_sha1 != expected_sha1:
765
808
            raise errors.WeaveInvalidChecksum(
766
 
                    'file %s, revision %s, expected: %s, measured %s'
 
809
                    'file %s, revision %s, expected: %s, measured %s' 
767
810
                    % (self._weave_name, version_id,
768
811
                       expected_sha1, measured_sha1))
769
812
        return result
770
813
 
 
814
    def get_sha1(self, version_id):
 
815
        """See VersionedFile.get_sha1()."""
 
816
        return self._sha1s[self._lookup(version_id)]
 
817
 
771
818
    def get_sha1s(self, version_ids):
772
819
        """See VersionedFile.get_sha1s()."""
773
 
        result = {}
774
 
        for v in version_ids:
775
 
            result[v] = self._sha1s[self._lookup(v)]
776
 
        return result
 
820
        return [self._sha1s[self._lookup(v)] for v in version_ids]
777
821
 
778
822
    def num_versions(self):
779
823
        """How many versions are in this weave?"""
780
824
        l = len(self._parents)
 
825
        assert l == len(self._sha1s)
781
826
        return l
782
827
 
783
828
    __len__ = num_versions
803
848
            # For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
804
849
            # The problem is that set membership is much more expensive
805
850
            name = self._idx_to_name(i)
806
 
            sha1s[name] = sha()
 
851
            sha1s[name] = sha.new()
807
852
            texts[name] = []
808
853
            new_inc = set([name])
809
854
            for p in self._parents[i]:
810
855
                new_inc.update(inclusions[self._idx_to_name(p)])
811
856
 
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))))
 
857
            assert set(new_inc) == set(self.get_ancestry(name)), \
 
858
                'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
816
859
            inclusions[name] = new_inc
817
860
 
818
861
        nlines = len(self._weave)
848
891
        # no lines outside of insertion blocks, that deletions are
849
892
        # properly paired, etc.
850
893
 
 
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
 
851
945
    def _imported_parents(self, other, other_idx):
852
946
        """Return list of parents in self corresponding to indexes in other."""
853
947
        new_parents = []
855
949
            parent_name = other._names[parent_idx]
856
950
            if parent_name not in self._name_map:
857
951
                # should not be possible
858
 
                raise WeaveError("missing parent {%s} of {%s} in %r"
 
952
                raise WeaveError("missing parent {%s} of {%s} in %r" 
859
953
                                 % (parent_name, other._name_map[other_idx], self))
860
954
            new_parents.append(self._name_map[parent_name])
861
955
        return new_parents
868
962
         * the same text
869
963
         * the same direct parents (by name, not index, and disregarding
870
964
           order)
871
 
 
 
965
        
872
966
        If present & correct return True;
873
 
        if not present in self return False;
 
967
        if not present in self return False; 
874
968
        if inconsistent raise error."""
875
969
        this_idx = self._name_map.get(name, -1)
876
970
        if this_idx != -1:
909
1003
    """A WeaveFile represents a Weave on disk and writes on change."""
910
1004
 
911
1005
    WEAVE_SUFFIX = '.weave'
912
 
 
913
 
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w', get_scope=None):
 
1006
    
 
1007
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w'):
914
1008
        """Create a WeaveFile.
915
 
 
 
1009
        
916
1010
        :param create: If not True, only open an existing knit.
917
1011
        """
918
 
        super(WeaveFile, self).__init__(name, access_mode, get_scope=get_scope,
919
 
            allow_reserved=False)
 
1012
        super(WeaveFile, self).__init__(name, access_mode)
920
1013
        self._transport = transport
921
1014
        self._filemode = filemode
922
1015
        try:
923
 
            f = self._transport.get(name + WeaveFile.WEAVE_SUFFIX)
924
 
            _read_weave_v5(StringIO(f.read()), self)
 
1016
            _read_weave_v5(self._transport.get(name + WeaveFile.WEAVE_SUFFIX), self)
925
1017
        except errors.NoSuchFile:
926
1018
            if not create:
927
1019
                raise
929
1021
            self._save()
930
1022
 
931
1023
    def _add_lines(self, version_id, parents, lines, parent_texts,
932
 
        left_matching_blocks, nostore_sha, random_id, check_content):
 
1024
        left_matching_blocks=None):
933
1025
        """Add a version and save the weave."""
934
1026
        self.check_not_reserved_id(version_id)
935
1027
        result = super(WeaveFile, self)._add_lines(version_id, parents, lines,
936
 
            parent_texts, left_matching_blocks, nostore_sha, random_id,
937
 
            check_content)
 
1028
                                                   parent_texts)
938
1029
        self._save()
939
1030
        return result
940
1031
 
 
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
 
941
1037
    def copy_to(self, name, transport):
942
1038
        """See VersionedFile.copy_to()."""
943
1039
        # as we are all in memory always, just serialise to the new place.
946
1042
        sio.seek(0)
947
1043
        transport.put_file(name + WeaveFile.WEAVE_SUFFIX, sio, self._filemode)
948
1044
 
 
1045
    def create_empty(self, name, transport, filemode=None):
 
1046
        return WeaveFile(name, transport, filemode, create=True)
 
1047
 
949
1048
    def _save(self):
950
1049
        """Save the weave."""
951
1050
        self._check_write_ok()
952
1051
        sio = StringIO()
953
1052
        write_weave_v5(self, sio)
954
1053
        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)
 
1054
        self._transport.put_file(self._weave_name + WeaveFile.WEAVE_SUFFIX,
 
1055
                                 sio,
 
1056
                                 self._filemode)
962
1057
 
963
1058
    @staticmethod
964
1059
    def get_suffixes():
965
1060
        """See VersionedFile.get_suffixes()."""
966
1061
        return [WeaveFile.WEAVE_SUFFIX]
967
1062
 
968
 
    def insert_record_stream(self, stream):
969
 
        super(WeaveFile, self).insert_record_stream(stream)
 
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)
970
1067
        self._save()
971
1068
 
972
1069
 
973
1070
def _reweave(wa, wb, pb=None, msg=None):
974
1071
    """Combine two weaves and return the result.
975
1072
 
976
 
    This works even if a revision R has different parents in
 
1073
    This works even if a revision R has different parents in 
977
1074
    wa and wb.  In the resulting weave all the parents are given.
978
1075
 
979
 
    This is done by just building up a new weave, maintaining ordering
 
1076
    This is done by just building up a new weave, maintaining ordering 
980
1077
    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
 
1078
    might be possible but it should only be necessary to do 
 
1079
    this operation rarely, when a new previously ghost version is 
983
1080
    inserted.
984
1081
 
985
1082
    :param pb: An optional progress bar, indicating how far done we are
993
1090
    # map from version name -> all parent names
994
1091
    combined_parents = _reweave_parent_graphs(wa, wb)
995
1092
    mutter("combined parents: %r", combined_parents)
996
 
    order = tsort.topo_sort(combined_parents.iteritems())
 
1093
    order = topo_sort(combined_parents.iteritems())
997
1094
    mutter("order to reweave: %r", order)
998
1095
 
999
1096
    if pb and not msg:
1019
1116
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
1020
1117
    return wr
1021
1118
 
1022
 
 
1023
1119
def _reweave_parent_graphs(wa, wb):
1024
1120
    """Return combined parent ancestry for two weaves.
1025
 
 
 
1121
    
1026
1122
    Returned as a list of (version_name, set(parent_names))"""
1027
1123
    combined = {}
1028
1124
    for weave in [wa, wb]:
1030
1126
            p = combined.setdefault(name, set())
1031
1127
            p.update(map(weave._idx_to_name, weave._parents[idx]))
1032
1128
    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)