~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Robert Collins
  • Date: 2009-09-07 03:08:30 UTC
  • mto: This revision was merged to the branch mainline in revision 4690.
  • Revision ID: robertc@robertcollins.net-20090907030830-rf59kt28d550eauj
Milestones language tightning, internal consistency.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#! /usr/bin/python
2
 
 
3
 
# Copyright (C) 2005 Canonical Ltd
4
 
 
 
1
# Copyright (C) 2005, 2009 Canonical Ltd
 
2
#
5
3
# This program is free software; you can redistribute it and/or modify
6
4
# it under the terms of the GNU General Public License as published by
7
5
# the Free Software Foundation; either version 2 of the License, or
8
6
# (at your option) any later version.
9
 
 
 
7
#
10
8
# This program is distributed in the hope that it will be useful,
11
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13
11
# GNU General Public License for more details.
14
 
 
 
12
#
15
13
# You should have received a copy of the GNU General Public License
16
14
# along with this program; if not, write to the Free Software
17
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
16
 
19
17
# Author: Martin Pool <mbp@canonical.com>
20
18
 
27
25
# property.
28
26
 
29
27
# TODO: Nothing here so far assumes the lines are really \n newlines,
30
 
# rather than being split up in some other way.  We could accomodate
 
28
# rather than being split up in some other way.  We could accommodate
31
29
# binaries, perhaps by naively splitting on \n or perhaps using
32
30
# something like a rolling checksum.
33
31
 
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
 
 
67
# FIXME: the conflict markers should be *7* characters
69
68
 
 
69
from copy import copy
 
70
from cStringIO import StringIO
70
71
import os
71
 
import sha
72
 
from difflib import SequenceMatcher
 
72
import time
 
73
import warnings
73
74
 
 
75
from bzrlib.lazy_import import lazy_import
 
76
lazy_import(globals(), """
 
77
from bzrlib import tsort
 
78
""")
 
79
from bzrlib import (
 
80
    errors,
 
81
    osutils,
 
82
    progress,
 
83
    )
 
84
from bzrlib.errors import (WeaveError, WeaveFormatError, WeaveParentMismatch,
 
85
        RevisionAlreadyPresent,
 
86
        RevisionNotPresent,
 
87
        UnavailableRepresentation,
 
88
        WeaveRevisionAlreadyPresent,
 
89
        WeaveRevisionNotPresent,
 
90
        )
 
91
from bzrlib.osutils import dirname, sha, sha_strings, split_lines
 
92
import bzrlib.patiencediff
 
93
from bzrlib.revision import NULL_REVISION
 
94
from bzrlib.symbol_versioning import *
74
95
from bzrlib.trace import mutter
75
 
from bzrlib.errors import (WeaveError, WeaveFormatError, WeaveParentMismatch,
76
 
        WeaveRevisionNotPresent, WeaveRevisionAlreadyPresent)
77
 
import bzrlib.errors as errors
78
 
from bzrlib.tsort import topo_sort
79
 
 
80
 
 
81
 
class Weave(object):
 
96
from bzrlib.versionedfile import (
 
97
    AbsentContentFactory,
 
98
    adapter_registry,
 
99
    ContentFactory,
 
100
    sort_groupcompress,
 
101
    VersionedFile,
 
102
    )
 
103
from bzrlib.weavefile import _read_weave_v5, write_weave_v5
 
104
 
 
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
 
 
131
class Weave(VersionedFile):
82
132
    """weave - versioned text file storage.
83
 
    
 
133
 
84
134
    A Weave manages versions of line-based text files, keeping track
85
135
    of the originating version for each line.
86
136
 
132
182
 
133
183
    * It doesn't seem very useful to have an active insertion
134
184
      inside an inactive insertion, but it might happen.
135
 
      
 
185
 
136
186
    * Therefore, all instructions are always"considered"; that
137
187
      is passed onto and off the stack.  An outer inactive block
138
188
      doesn't disable an inner block.
168
218
    """
169
219
 
170
220
    __slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map',
171
 
                 '_weave_name']
172
 
    
173
 
    def __init__(self, weave_name=None):
 
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__()
174
232
        self._weave = []
175
233
        self._parents = []
176
234
        self._sha1s = []
177
235
        self._names = []
178
236
        self._name_map = {}
179
237
        self._weave_name = weave_name
 
238
        if matcher is None:
 
239
            self._matcher = bzrlib.patiencediff.PatienceSequenceMatcher
 
240
        else:
 
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
180
248
 
181
249
    def __repr__(self):
182
250
        return "Weave(%r)" % self._weave_name
183
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)
184
258
 
185
259
    def copy(self):
186
260
        """Return a deep copy of self.
187
 
        
 
261
 
188
262
        The copy can be modified without affecting the original weave."""
189
263
        other = Weave()
190
264
        other._weave = self._weave[:]
200
274
            return False
201
275
        return self._parents == other._parents \
202
276
               and self._weave == other._weave \
203
 
               and self._sha1s == other._sha1s 
 
277
               and self._sha1s == other._sha1s
204
278
 
205
 
    
206
279
    def __ne__(self, other):
207
280
        return not self.__eq__(other)
208
281
 
209
 
    def __contains__(self, name):
210
 
        return self._name_map.has_key(name)
211
 
 
212
 
    def maybe_lookup(self, name_or_index):
213
 
        """Convert possible symbolic name to index, or pass through indexes."""
214
 
        if isinstance(name_or_index, (int, long)):
215
 
            return name_or_index
216
 
        else:
217
 
            return self.lookup(name_or_index)
218
 
 
219
 
        
220
 
    def lookup(self, name):
 
282
    def _idx_to_name(self, version):
 
283
        return self._names[version]
 
284
 
 
285
    def _lookup(self, name):
221
286
        """Convert symbolic version name to index."""
 
287
        if not self._allow_reserved:
 
288
            self.check_not_reserved_id(name)
222
289
        try:
223
290
            return self._name_map[name]
224
291
        except KeyError:
225
 
            raise WeaveRevisionNotPresent(name, self)
 
292
            raise RevisionNotPresent(name, self._weave_name)
226
293
 
227
 
    def names(self):
 
294
    def versions(self):
 
295
        """See VersionedFile.versions."""
228
296
        return self._names[:]
229
297
 
230
 
    def iter_names(self):
231
 
        """Yield a list of all names in this weave."""
232
 
        return iter(self._names)
233
 
 
234
 
    def idx_to_name(self, version):
235
 
        return self._names[version]
 
298
    def has_version(self, version_id):
 
299
        """See VersionedFile.has_version."""
 
300
        return (version_id in self._name_map)
 
301
 
 
302
    __contains__ = has_version
 
303
 
 
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 = {}
 
337
        for version_id in version_ids:
 
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:
 
346
                    continue
 
347
            result[version_id] = parents
 
348
        return result
 
349
 
 
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
236
384
 
237
385
    def _check_repeated_add(self, name, parents, text, sha1):
238
386
        """Check that a duplicated add is OK.
239
387
 
240
388
        If it is, return the (old) index; otherwise raise an exception.
241
389
        """
242
 
        idx = self.lookup(name)
 
390
        idx = self._lookup(name)
243
391
        if sorted(self._parents[idx]) != sorted(parents) \
244
392
            or sha1 != self._sha1s[idx]:
245
 
            raise WeaveRevisionAlreadyPresent(name, self)
 
393
            raise RevisionAlreadyPresent(name, self._weave_name)
246
394
        return idx
247
 
        
248
 
    def add(self, name, parents, text, sha1=None):
 
395
 
 
396
    def _add_lines(self, version_id, parents, lines, parent_texts,
 
397
       left_matching_blocks, nostore_sha, random_id, check_content):
 
398
        """See VersionedFile.add_lines."""
 
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
 
402
 
 
403
    def _add(self, version_id, lines, parents, sha1=None, nostore_sha=None):
249
404
        """Add a single text on top of the weave.
250
 
  
 
405
 
251
406
        Returns the index number of the newly added version.
252
407
 
253
 
        name
 
408
        version_id
254
409
            Symbolic name for this version.
255
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)
256
412
 
257
413
        parents
258
414
            List or set of direct parent version numbers.
259
 
            
260
 
        text
 
415
 
 
416
        lines
261
417
            Sequence of lines to be added in the new version.
262
418
 
263
 
        sha -- SHA-1 of the file, if known.  This is trusted to be
264
 
            correct if supplied.
 
419
        :param nostore_sha: See VersionedFile.add_lines.
265
420
        """
266
 
        from bzrlib.osutils import sha_strings
267
 
 
268
 
        assert isinstance(name, basestring)
269
 
        if sha1 is None:
270
 
            sha1 = sha_strings(text)
271
 
        if name in self._name_map:
272
 
            return self._check_repeated_add(name, parents, text, sha1)
273
 
 
274
 
        parents = map(self.maybe_lookup, parents)
 
421
        self._check_lines_not_unicode(lines)
 
422
        self._check_lines_are_lines(lines)
 
423
        if not sha1:
 
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
 
429
        if version_id in self._name_map:
 
430
            return self._check_repeated_add(version_id, parents, lines, sha1)
 
431
 
275
432
        self._check_versions(parents)
276
 
        ## self._check_lines(text)
 
433
        ## self._check_lines(lines)
277
434
        new_version = len(self._parents)
278
435
 
279
 
 
280
436
        # if we abort after here the (in-memory) weave will be corrupt because only
281
437
        # some fields are updated
 
438
        # XXX: FIXME implement a succeed-or-fail of the rest of this routine.
 
439
        #      - Robert Collins 20060226
282
440
        self._parents.append(parents[:])
283
441
        self._sha1s.append(sha1)
284
 
        self._names.append(name)
285
 
        self._name_map[name] = new_version
286
 
 
287
 
            
 
442
        self._names.append(version_id)
 
443
        self._name_map[version_id] = new_version
 
444
 
 
445
 
288
446
        if not parents:
289
447
            # special case; adding with no parents revision; can do
290
448
            # this more quickly by just appending unconditionally.
291
449
            # even more specially, if we're adding an empty text we
292
450
            # need do nothing at all.
293
 
            if text:
 
451
            if lines:
294
452
                self._weave.append(('{', new_version))
295
 
                self._weave.extend(text)
 
453
                self._weave.extend(lines)
296
454
                self._weave.append(('}', None))
297
 
        
298
455
            return new_version
299
456
 
300
457
        if len(parents) == 1:
302
459
            if sha1 == self._sha1s[pv]:
303
460
                # special case: same as the single parent
304
461
                return new_version
305
 
            
306
 
 
307
 
        ancestors = self.inclusions(parents)
 
462
 
 
463
 
 
464
        ancestors = self._inclusions(parents)
308
465
 
309
466
        l = self._weave
310
467
 
317
474
 
318
475
        # another small special case: a merge, producing the same text
319
476
        # as auto-merge
320
 
        if text == basis_lines:
321
 
            return new_version            
 
477
        if lines == basis_lines:
 
478
            return new_version
322
479
 
323
 
        # add a sentinal, because we can also match against the final line
 
480
        # add a sentinel, because we can also match against the final line
324
481
        basis_lineno.append(len(self._weave))
325
482
 
326
483
        # XXX: which line of the weave should we really consider
330
487
        #print 'basis_lines:', basis_lines
331
488
        #print 'new_lines:  ', lines
332
489
 
333
 
        s = SequenceMatcher(None, basis_lines, text)
 
490
        s = self._matcher(None, basis_lines, lines)
334
491
 
335
492
        # offset gives the number of lines that have been inserted
336
493
        # into the weave up to the current point; if the original edit instruction
343
500
            #print 'raw match', tag, i1, i2, j1, j2
344
501
            if tag == 'equal':
345
502
                continue
346
 
 
347
503
            i1 = basis_lineno[i1]
348
504
            i2 = basis_lineno[i2]
349
 
 
350
 
            assert 0 <= j1 <= j2 <= len(text)
351
 
 
352
 
            #print tag, i1, i2, j1, j2
353
 
 
354
505
            # the deletion and insertion are handled separately.
355
506
            # first delete the region.
356
507
            if i1 != i2:
363
514
                # i2; we want to insert after this region to make sure
364
515
                # we don't destroy ourselves
365
516
                i = i2 + offset
366
 
                self._weave[i:i] = ([('{', new_version)] 
367
 
                                    + text[j1:j2] 
 
517
                self._weave[i:i] = ([('{', new_version)]
 
518
                                    + lines[j1:j2]
368
519
                                    + [('}', None)])
369
520
                offset += 2 + (j2 - j1)
370
 
 
371
521
        return new_version
372
522
 
373
 
    def add_identical(self, old_rev_id, new_rev_id, parents):
374
 
        """Add an identical text to old_rev_id as new_rev_id."""
375
 
        old_lines = self.get(self.lookup(old_rev_id))
376
 
        self.add(new_rev_id, parents, old_lines)
377
 
 
378
 
    def inclusions(self, versions):
 
523
    def _inclusions(self, versions):
379
524
        """Return set of all ancestors of given version(s)."""
 
525
        if not len(versions):
 
526
            return []
380
527
        i = set(versions)
381
528
        for v in xrange(max(versions), 0, -1):
382
529
            if v in i:
386
533
        ## except IndexError:
387
534
        ##     raise ValueError("version %d not present in weave" % v)
388
535
 
389
 
 
390
 
    def parents(self, version):
391
 
        return self._parents[version]
392
 
 
393
 
 
394
 
    def parent_names(self, version):
395
 
        """Return version names for parents of a version."""
396
 
        return map(self.idx_to_name, self._parents[self.lookup(version)])
397
 
 
398
 
 
399
 
    def minimal_parents(self, version):
400
 
        """Find the minimal set of parents for the version."""
401
 
        included = self._parents[version]
402
 
        if not included:
403
 
            return []
404
 
        
405
 
        li = list(included)
406
 
        li.sort(reverse=True)
407
 
 
408
 
        mininc = []
409
 
        gotit = set()
410
 
 
411
 
        for pv in li:
412
 
            if pv not in gotit:
413
 
                mininc.append(pv)
414
 
                gotit.update(self.inclusions(pv))
415
 
 
416
 
        assert mininc[0] >= 0
417
 
        assert mininc[-1] < version
418
 
        return mininc
419
 
 
420
 
 
 
536
    def get_ancestry(self, version_ids, topo_sorted=True):
 
537
        """See VersionedFile.get_ancestry."""
 
538
        if isinstance(version_ids, basestring):
 
539
            version_ids = [version_ids]
 
540
        i = self._inclusions([self._lookup(v) for v in version_ids])
 
541
        return [self._idx_to_name(v) for v in i]
421
542
 
422
543
    def _check_lines(self, text):
423
544
        if not isinstance(text, list):
427
548
            if not isinstance(l, basestring):
428
549
                raise ValueError("text line should be a string or unicode, not %s"
429
550
                                 % type(l))
430
 
        
 
551
 
431
552
 
432
553
 
433
554
    def _check_versions(self, indexes):
438
559
            except IndexError:
439
560
                raise IndexError("invalid version number %r" % i)
440
561
 
441
 
    
442
 
    def annotate(self, name_or_index):
443
 
        return list(self.annotate_iter(name_or_index))
444
 
 
445
 
 
446
 
    def annotate_iter(self, name_or_index):
447
 
        """Yield list of (index-id, line) pairs for the specified version.
 
562
    def _compatible_parents(self, my_parents, other_parents):
 
563
        """During join check that other_parents are joinable with my_parents.
 
564
 
 
565
        Joinable is defined as 'is a subset of' - supersets may require
 
566
        regeneration of diffs, but subsets do not.
 
567
        """
 
568
        return len(other_parents.difference(my_parents)) == 0
 
569
 
 
570
    def annotate(self, version_id):
 
571
        """Return a list of (version-id, line) tuples for version_id.
448
572
 
449
573
        The index indicates when the line originated in the weave."""
450
 
        incls = [self.maybe_lookup(name_or_index)]
451
 
        for origin, lineno, text in self._extract(incls):
452
 
            yield origin, text
453
 
 
454
 
    def _walk(self):
455
 
        """Walk the weave.
456
 
 
457
 
        Yields sequence of
458
 
        (lineno, insert, deletes, text)
459
 
        for each literal line.
460
 
        """
461
 
        
 
574
        incls = [self._lookup(version_id)]
 
575
        return [(self._idx_to_name(origin), text) for origin, lineno, text in
 
576
            self._extract(incls)]
 
577
 
 
578
    def iter_lines_added_or_present_in_versions(self, version_ids=None,
 
579
                                                pb=None):
 
580
        """See VersionedFile.iter_lines_added_or_present_in_versions()."""
 
581
        if version_ids is None:
 
582
            version_ids = self.versions()
 
583
        version_ids = set(version_ids)
 
584
        for lineno, inserted, deletes, line in self._walk_internal(version_ids):
 
585
            if inserted not in version_ids: continue
 
586
            if line[-1] != '\n':
 
587
                yield line + '\n', inserted
 
588
            else:
 
589
                yield line, inserted
 
590
 
 
591
    def _walk_internal(self, version_ids=None):
 
592
        """Helper method for weave actions."""
 
593
 
462
594
        istack = []
463
595
        dset = set()
464
596
 
465
597
        lineno = 0         # line of weave, 0-based
466
598
 
467
599
        for l in self._weave:
468
 
            if isinstance(l, tuple):
 
600
            if l.__class__ == tuple:
469
601
                c, v = l
470
602
                isactive = None
471
603
                if c == '{':
472
 
                    istack.append(v)
 
604
                    istack.append(self._names[v])
473
605
                elif c == '}':
474
606
                    istack.pop()
475
607
                elif c == '[':
476
 
                    assert v not in dset
477
 
                    dset.add(v)
 
608
                    dset.add(self._names[v])
478
609
                elif c == ']':
479
 
                    dset.remove(v)
 
610
                    dset.remove(self._names[v])
480
611
                else:
481
612
                    raise WeaveFormatError('unexpected instruction %r' % v)
482
613
            else:
483
 
                assert isinstance(l, basestring)
484
 
                assert istack
485
 
                yield lineno, istack[-1], dset, l
 
614
                yield lineno, istack[-1], frozenset(dset), l
486
615
            lineno += 1
487
616
 
488
617
        if istack:
492
621
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
493
622
                                   % dset)
494
623
 
 
624
    def plan_merge(self, ver_a, ver_b):
 
625
        """Return pseudo-annotation indicating how the two versions merge.
 
626
 
 
627
        This is computed between versions a and b and their common
 
628
        base.
 
629
 
 
630
        Weave lines present in none of them are skipped entirely.
 
631
        """
 
632
        inc_a = set(self.get_ancestry([ver_a]))
 
633
        inc_b = set(self.get_ancestry([ver_b]))
 
634
        inc_c = inc_a & inc_b
 
635
 
 
636
        for lineno, insert, deleteset, line in self._walk_internal([ver_a, ver_b]):
 
637
            if deleteset & inc_c:
 
638
                # killed in parent; can't be in either a or b
 
639
                # not relevant to our work
 
640
                yield 'killed-base', line
 
641
            elif insert in inc_c:
 
642
                # was inserted in base
 
643
                killed_a = bool(deleteset & inc_a)
 
644
                killed_b = bool(deleteset & inc_b)
 
645
                if killed_a and killed_b:
 
646
                    yield 'killed-both', line
 
647
                elif killed_a:
 
648
                    yield 'killed-a', line
 
649
                elif killed_b:
 
650
                    yield 'killed-b', line
 
651
                else:
 
652
                    yield 'unchanged', line
 
653
            elif insert in inc_a:
 
654
                if deleteset & inc_a:
 
655
                    yield 'ghost-a', line
 
656
                else:
 
657
                    # new in A; not in B
 
658
                    yield 'new-a', line
 
659
            elif insert in inc_b:
 
660
                if deleteset & inc_b:
 
661
                    yield 'ghost-b', line
 
662
                else:
 
663
                    yield 'new-b', line
 
664
            else:
 
665
                # not in either revision
 
666
                yield 'irrelevant', line
 
667
 
495
668
    def _extract(self, versions):
496
669
        """Yield annotation of lines in included set.
497
670
 
504
677
        for i in versions:
505
678
            if not isinstance(i, int):
506
679
                raise ValueError(i)
507
 
            
508
 
        included = self.inclusions(versions)
 
680
 
 
681
        included = self._inclusions(versions)
509
682
 
510
683
        istack = []
 
684
        iset = set()
511
685
        dset = set()
512
686
 
513
687
        lineno = 0         # line of weave, 0-based
518
692
 
519
693
        WFE = WeaveFormatError
520
694
 
 
695
        # wow.
 
696
        #  449       0   4474.6820   2356.5590   bzrlib.weave:556(_extract)
 
697
        #  +285282   0   1676.8040   1676.8040   +<isinstance>
 
698
        # 1.6 seconds in 'isinstance'.
 
699
        # changing the first isinstance:
 
700
        #  449       0   2814.2660   1577.1760   bzrlib.weave:556(_extract)
 
701
        #  +140414   0    762.8050    762.8050   +<isinstance>
 
702
        # note that the inline time actually dropped (less function calls)
 
703
        # and total processing time was halved.
 
704
        # we're still spending ~1/4 of the method in isinstance though.
 
705
        # so lets hard code the acceptable string classes we expect:
 
706
        #  449       0   1202.9420    786.2930   bzrlib.weave:556(_extract)
 
707
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list'
 
708
        #                                          objects>
 
709
        # yay, down to ~1/4 the initial extract time, and our inline time
 
710
        # has shrunk again, with isinstance no longer dominating.
 
711
        # tweaking the stack inclusion test to use a set gives:
 
712
        #  449       0   1122.8030    713.0080   bzrlib.weave:556(_extract)
 
713
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list'
 
714
        #                                          objects>
 
715
        # - a 5% win, or possibly just noise. However with large istacks that
 
716
        # 'in' test could dominate, so I'm leaving this change in place -
 
717
        # when its fast enough to consider profiling big datasets we can review.
 
718
 
 
719
 
 
720
 
 
721
 
521
722
        for l in self._weave:
522
 
            if isinstance(l, tuple):
 
723
            if l.__class__ == tuple:
523
724
                c, v = l
524
725
                isactive = None
525
726
                if c == '{':
526
 
                    assert v not in istack
527
727
                    istack.append(v)
 
728
                    iset.add(v)
528
729
                elif c == '}':
529
 
                    istack.pop()
 
730
                    iset.remove(istack.pop())
530
731
                elif c == '[':
531
732
                    if v in included:
532
 
                        assert v not in dset
533
733
                        dset.add(v)
534
 
                else:
535
 
                    assert c == ']'
 
734
                elif c == ']':
536
735
                    if v in included:
537
 
                        assert v in dset
538
736
                        dset.remove(v)
 
737
                else:
 
738
                    raise AssertionError()
539
739
            else:
540
 
                assert isinstance(l, basestring)
541
740
                if isactive is None:
542
741
                    isactive = (not dset) and istack and (istack[-1] in included)
543
742
                if isactive:
551
750
                                   % dset)
552
751
        return result
553
752
 
 
753
    def _maybe_lookup(self, name_or_index):
 
754
        """Convert possible symbolic name to index, or pass through indexes.
554
755
 
555
 
    def get_iter(self, name_or_index):
556
 
        """Yield lines for the specified version."""
557
 
        incls = [self.maybe_lookup(name_or_index)]
558
 
        if len(incls) == 1:
559
 
            index = incls[0]
560
 
            cur_sha = sha.new()
 
756
        NOT FOR PUBLIC USE.
 
757
        """
 
758
        if isinstance(name_or_index, (int, long)):
 
759
            return name_or_index
561
760
        else:
562
 
            # We don't have sha1 sums for multiple entries
563
 
            cur_sha = None
564
 
        for origin, lineno, line in self._extract(incls):
565
 
            if cur_sha:
566
 
                cur_sha.update(line)
567
 
            yield line
568
 
        if cur_sha:
569
 
            expected_sha1 = self._sha1s[index]
570
 
            measured_sha1 = cur_sha.hexdigest() 
571
 
            if measured_sha1 != expected_sha1:
572
 
                raise errors.WeaveInvalidChecksum(
573
 
                        'file %s, revision %s, expected: %s, measured %s' 
574
 
                        % (self._weave_name, self._names[index],
575
 
                           expected_sha1, measured_sha1))
576
 
 
577
 
 
578
 
    def get_text(self, name_or_index):
579
 
        return ''.join(self.get_iter(name_or_index))
580
 
        assert isinstance(version, int)
581
 
 
582
 
 
583
 
    def get_lines(self, name_or_index):
584
 
        return list(self.get_iter(name_or_index))
585
 
 
586
 
 
587
 
    get = get_lines
588
 
 
589
 
 
590
 
    def get_sha1(self, name):
591
 
        """Get the stored sha1 sum for the given revision.
592
 
        
593
 
        :param name: The name of the version to lookup
594
 
        """
595
 
        return self._sha1s[self.lookup(name)]
596
 
 
597
 
    def mash_iter(self, included):
598
 
        """Return composed version of multiple included versions."""
599
 
        included = map(self.maybe_lookup, included)
600
 
        for origin, lineno, text in self._extract(included):
601
 
            yield text
602
 
 
603
 
 
604
 
    def dump(self, to_file):
605
 
        from pprint import pprint
606
 
        print >>to_file, "Weave._weave = ",
607
 
        pprint(self._weave, to_file)
608
 
        print >>to_file, "Weave._parents = ",
609
 
        pprint(self._parents, to_file)
610
 
 
611
 
 
612
 
 
613
 
    def numversions(self):
 
761
            return self._lookup(name_or_index)
 
762
 
 
763
    def get_lines(self, version_id):
 
764
        """See VersionedFile.get_lines()."""
 
765
        int_index = self._maybe_lookup(version_id)
 
766
        result = [line for (origin, lineno, line) in self._extract([int_index])]
 
767
        expected_sha1 = self._sha1s[int_index]
 
768
        measured_sha1 = sha_strings(result)
 
769
        if measured_sha1 != expected_sha1:
 
770
            raise errors.WeaveInvalidChecksum(
 
771
                    'file %s, revision %s, expected: %s, measured %s'
 
772
                    % (self._weave_name, version_id,
 
773
                       expected_sha1, measured_sha1))
 
774
        return result
 
775
 
 
776
    def get_sha1s(self, version_ids):
 
777
        """See VersionedFile.get_sha1s()."""
 
778
        result = {}
 
779
        for v in version_ids:
 
780
            result[v] = self._sha1s[self._lookup(v)]
 
781
        return result
 
782
 
 
783
    def num_versions(self):
 
784
        """How many versions are in this weave?"""
614
785
        l = len(self._parents)
615
 
        assert l == len(self._sha1s)
616
786
        return l
617
787
 
618
 
 
619
 
    def __len__(self):
620
 
        return self.numversions()
 
788
    __len__ = num_versions
621
789
 
622
790
    def check(self, progress_bar=None):
623
 
        # check no circular inclusions
624
 
        for version in range(self.numversions()):
 
791
        # TODO evaluate performance hit of using string sets in this routine.
 
792
        # TODO: check no circular inclusions
 
793
        # TODO: create a nested progress bar
 
794
        for version in range(self.num_versions()):
625
795
            inclusions = list(self._parents[version])
626
796
            if inclusions:
627
797
                inclusions.sort()
630
800
                                           % (inclusions[-1], version))
631
801
 
632
802
        # try extracting all versions; parallel extraction is used
633
 
        nv = self.numversions()
634
 
        sha1s = [sha.new() for i in range(nv)]
635
 
        texts = [[] for i in range(nv)]
636
 
        inclusions = []
 
803
        nv = self.num_versions()
 
804
        sha1s = {}
 
805
        texts = {}
 
806
        inclusions = {}
637
807
        for i in range(nv):
638
808
            # For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
639
809
            # The problem is that set membership is much more expensive
640
 
            new_inc = set([i])
 
810
            name = self._idx_to_name(i)
 
811
            sha1s[name] = sha()
 
812
            texts[name] = []
 
813
            new_inc = set([name])
641
814
            for p in self._parents[i]:
642
 
                new_inc.update(inclusions[p])
 
815
                new_inc.update(inclusions[self._idx_to_name(p)])
643
816
 
644
 
            #assert set(new_inc) == self.inclusions([i]), 'failed %s != %s' % (new_inc, self.inclusions([i]))
645
 
            inclusions.append(new_inc)
 
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))))
 
821
            inclusions[name] = new_inc
646
822
 
647
823
        nlines = len(self._weave)
648
824
 
652
828
            update_text = 'checking %s' % (short_name,)
653
829
            update_text = update_text[:25]
654
830
 
655
 
        for lineno, insert, deleteset, line in self._walk():
 
831
        for lineno, insert, deleteset, line in self._walk_internal():
656
832
            if progress_bar:
657
833
                progress_bar.update(update_text, lineno, nlines)
658
834
 
659
 
            for j, j_inc in enumerate(inclusions):
 
835
            for name, name_inclusions in inclusions.items():
660
836
                # The active inclusion must be an ancestor,
661
837
                # and no ancestors must have deleted this line,
662
838
                # because we don't support resurrection.
663
 
                if (insert in j_inc) and not (deleteset & j_inc):
664
 
                    sha1s[j].update(line)
 
839
                if (insert in name_inclusions) and not (deleteset & name_inclusions):
 
840
                    sha1s[name].update(line)
665
841
 
666
 
        for version in range(nv):
 
842
        for i in range(nv):
 
843
            version = self._idx_to_name(i)
667
844
            hd = sha1s[version].hexdigest()
668
 
            expected = self._sha1s[version]
 
845
            expected = self._sha1s[i]
669
846
            if hd != expected:
670
847
                raise errors.WeaveInvalidChecksum(
671
848
                        "mismatched sha1 for version %s: "
672
849
                        "got %s, expected %s"
673
 
                        % (self._names[version], hd, expected))
 
850
                        % (version, hd, expected))
674
851
 
675
852
        # TODO: check insertions are properly nested, that there are
676
853
        # no lines outside of insertion blocks, that deletions are
677
854
        # properly paired, etc.
678
855
 
679
 
    def _delta(self, included, lines):
680
 
        """Return changes from basis to new revision.
681
 
 
682
 
        The old text for comparison is the union of included revisions.
683
 
 
684
 
        This is used in inserting a new text.
685
 
 
686
 
        Delta is returned as a sequence of
687
 
        (weave1, weave2, newlines).
688
 
 
689
 
        This indicates that weave1:weave2 of the old weave should be
690
 
        replaced by the sequence of lines in newlines.  Note that
691
 
        these line numbers are positions in the total weave and don't
692
 
        correspond to the lines in any extracted version, or even the
693
 
        extracted union of included versions.
694
 
 
695
 
        If line1=line2, this is a pure insert; if newlines=[] this is a
696
 
        pure delete.  (Similar to difflib.)
697
 
        """
698
 
        raise NotImplementedError()
699
 
 
700
 
            
701
 
    def plan_merge(self, ver_a, ver_b):
702
 
        """Return pseudo-annotation indicating how the two versions merge.
703
 
 
704
 
        This is computed between versions a and b and their common
705
 
        base.
706
 
 
707
 
        Weave lines present in none of them are skipped entirely.
708
 
        """
709
 
        inc_a = self.inclusions([ver_a])
710
 
        inc_b = self.inclusions([ver_b])
711
 
        inc_c = inc_a & inc_b
712
 
 
713
 
        for lineno, insert, deleteset, line in self._walk():
714
 
            if deleteset & inc_c:
715
 
                # killed in parent; can't be in either a or b
716
 
                # not relevant to our work
717
 
                yield 'killed-base', line
718
 
            elif insert in inc_c:
719
 
                # was inserted in base
720
 
                killed_a = bool(deleteset & inc_a)
721
 
                killed_b = bool(deleteset & inc_b)
722
 
                if killed_a and killed_b:
723
 
                    yield 'killed-both', line
724
 
                elif killed_a:
725
 
                    yield 'killed-a', line
726
 
                elif killed_b:
727
 
                    yield 'killed-b', line
728
 
                else:
729
 
                    yield 'unchanged', line
730
 
            elif insert in inc_a:
731
 
                if deleteset & inc_a:
732
 
                    yield 'ghost-a', line
733
 
                else:
734
 
                    # new in A; not in B
735
 
                    yield 'new-a', line
736
 
            elif insert in inc_b:
737
 
                if deleteset & inc_b:
738
 
                    yield 'ghost-b', line
739
 
                else:
740
 
                    yield 'new-b', line
741
 
            else:
742
 
                # not in either revision
743
 
                yield 'irrelevant', line
744
 
 
745
 
        yield 'unchanged', ''           # terminator
746
 
 
747
 
 
748
 
 
749
 
    def weave_merge(self, plan, a_marker='<<<<<<< \n', b_marker='>>>>>>> \n'):
750
 
        lines_a = []
751
 
        lines_b = []
752
 
        ch_a = ch_b = False
753
 
        # TODO: Return a structured form of the conflicts (e.g. 2-tuples for
754
 
        # conflicted regions), rather than just inserting the markers.
755
 
        # 
756
 
        # TODO: Show some version information (e.g. author, date) on 
757
 
        # conflicted regions.
758
 
        for state, line in plan:
759
 
            if state == 'unchanged' or state == 'killed-both':
760
 
                # resync and flush queued conflicts changes if any
761
 
                if not lines_a and not lines_b:
762
 
                    pass
763
 
                elif ch_a and not ch_b:
764
 
                    # one-sided change:                    
765
 
                    for l in lines_a: yield l
766
 
                elif ch_b and not ch_a:
767
 
                    for l in lines_b: yield l
768
 
                elif lines_a == lines_b:
769
 
                    for l in lines_a: yield l
770
 
                else:
771
 
                    yield a_marker
772
 
                    for l in lines_a: yield l
773
 
                    yield '=======\n'
774
 
                    for l in lines_b: yield l
775
 
                    yield b_marker
776
 
 
777
 
                del lines_a[:]
778
 
                del lines_b[:]
779
 
                ch_a = ch_b = False
780
 
                
781
 
            if state == 'unchanged':
782
 
                if line:
783
 
                    yield line
784
 
            elif state == 'killed-a':
785
 
                ch_a = True
786
 
                lines_b.append(line)
787
 
            elif state == 'killed-b':
788
 
                ch_b = True
789
 
                lines_a.append(line)
790
 
            elif state == 'new-a':
791
 
                ch_a = True
792
 
                lines_a.append(line)
793
 
            elif state == 'new-b':
794
 
                ch_b = True
795
 
                lines_b.append(line)
796
 
            else:
797
 
                assert state in ('irrelevant', 'ghost-a', 'ghost-b', 'killed-base',
798
 
                                 'killed-both'), \
799
 
                       state
800
 
 
801
 
 
802
 
    def join(self, other, pb=None, msg=None):
803
 
        import sys, time
804
 
        """Integrate versions from other into this weave.
805
 
 
806
 
        The resulting weave contains all the history of both weaves; 
807
 
        any version you could retrieve from either self or other can be 
808
 
        retrieved from self after this call.
809
 
 
810
 
        It is illegal for the two weaves to contain different values 
811
 
        or different parents for any version.  See also reweave().
812
 
 
813
 
        :param other: The other weave to pull into this one
814
 
        :param pb: An optional progress bar
815
 
        :param msg: An optional message to display for progress
816
 
        """
817
 
        if other.numversions() == 0:
818
 
            return          # nothing to update, easy
819
 
        # two loops so that we do not change ourselves before verifying it
820
 
        # will be ok
821
 
        # work through in index order to make sure we get all dependencies
822
 
        names_to_join = []
823
 
        processed = 0
824
 
        for other_idx, name in enumerate(other._names):
825
 
            self._check_version_consistent(other, other_idx, name)
826
 
            sha1 = other._sha1s[other_idx]
827
 
 
828
 
            processed += 1
829
 
 
830
 
            if name in self._name_map:
831
 
                idx = self.lookup(name)
832
 
                n1 = set(map(other.idx_to_name, other._parents[other_idx]))
833
 
                n2 = set(map(self.idx_to_name, self._parents[idx]))
834
 
                if sha1 ==  self._sha1s[idx] and n1 == n2:
835
 
                        continue
836
 
 
837
 
            names_to_join.append((other_idx, name))
838
 
 
839
 
        if pb and not msg:
840
 
            msg = 'weave join'
841
 
 
842
 
        merged = 0
843
 
        time0 = time.time( )
844
 
        for other_idx, name in names_to_join:
845
 
            # TODO: If all the parents of the other version are already
846
 
            # present then we can avoid some work by just taking the delta
847
 
            # and adjusting the offsets.
848
 
            new_parents = self._imported_parents(other, other_idx)
849
 
            sha1 = other._sha1s[other_idx]
850
 
 
851
 
            merged += 1
852
 
 
853
 
            if pb:
854
 
                pb.update(msg, merged, len(names_to_join))
855
 
           
856
 
            lines = other.get_lines(other_idx)
857
 
            self.add(name, new_parents, lines, sha1)
858
 
 
859
 
        mutter("merged = %d, processed = %d, file_id=%s; deltat=%d"%(
860
 
                merged, processed, self._weave_name, time.time( )-time0))
861
 
 
862
856
    def _imported_parents(self, other, other_idx):
863
857
        """Return list of parents in self corresponding to indexes in other."""
864
858
        new_parents = []
865
859
        for parent_idx in other._parents[other_idx]:
866
860
            parent_name = other._names[parent_idx]
867
 
            if parent_name not in self._names:
 
861
            if parent_name not in self._name_map:
868
862
                # should not be possible
869
 
                raise WeaveError("missing parent {%s} of {%s} in %r" 
 
863
                raise WeaveError("missing parent {%s} of {%s} in %r"
870
864
                                 % (parent_name, other._name_map[other_idx], self))
871
865
            new_parents.append(self._name_map[parent_name])
872
866
        return new_parents
879
873
         * the same text
880
874
         * the same direct parents (by name, not index, and disregarding
881
875
           order)
882
 
        
 
876
 
883
877
        If present & correct return True;
884
 
        if not present in self return False; 
 
878
        if not present in self return False;
885
879
        if inconsistent raise error."""
886
880
        this_idx = self._name_map.get(name, -1)
887
881
        if this_idx != -1:
888
882
            if self._sha1s[this_idx] != other._sha1s[other_idx]:
889
 
                raise WeaveError("inconsistent texts for version {%s} "
890
 
                                 "when joining weaves"
891
 
                                 % (name))
 
883
                raise errors.WeaveTextDiffers(name, self, other)
892
884
            self_parents = self._parents[this_idx]
893
885
            other_parents = other._parents[other_idx]
894
886
            n1 = set([self._names[i] for i in self_parents])
895
887
            n2 = set([other._names[i] for i in other_parents])
896
 
            if n1 != n2:
 
888
            if not self._compatible_parents(n1, n2):
897
889
                raise WeaveParentMismatch("inconsistent parents "
898
890
                    "for version {%s}: %s vs %s" % (name, n1, n2))
899
891
            else:
901
893
        else:
902
894
            return False
903
895
 
904
 
    def reweave(self, other, pb=None, msg=None):
905
 
        """Reweave self with other.
 
896
    def _reweave(self, other, pb, msg):
 
897
        """Reweave self with other - internal helper for join().
906
898
 
907
899
        :param other: The other weave to merge
908
900
        :param pb: An optional progress bar, indicating how far done we are
909
901
        :param msg: An optional message for the progress
910
902
        """
911
 
        new_weave = reweave(self, other, pb=pb, msg=msg)
 
903
        new_weave = _reweave(self, other, pb=pb, msg=msg)
 
904
        self._copy_weave_content(new_weave)
 
905
 
 
906
    def _copy_weave_content(self, otherweave):
 
907
        """adsorb the content from otherweave."""
912
908
        for attr in self.__slots__:
913
 
            setattr(self, attr, getattr(new_weave, attr))
914
 
 
915
 
 
916
 
def reweave(wa, wb, pb=None, msg=None):
 
909
            if attr != '_weave_name':
 
910
                setattr(self, attr, copy(getattr(otherweave, attr)))
 
911
 
 
912
 
 
913
class WeaveFile(Weave):
 
914
    """A WeaveFile represents a Weave on disk and writes on change."""
 
915
 
 
916
    WEAVE_SUFFIX = '.weave'
 
917
 
 
918
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w', get_scope=None):
 
919
        """Create a WeaveFile.
 
920
 
 
921
        :param create: If not True, only open an existing knit.
 
922
        """
 
923
        super(WeaveFile, self).__init__(name, access_mode, get_scope=get_scope,
 
924
            allow_reserved=False)
 
925
        self._transport = transport
 
926
        self._filemode = filemode
 
927
        try:
 
928
            _read_weave_v5(self._transport.get(name + WeaveFile.WEAVE_SUFFIX), self)
 
929
        except errors.NoSuchFile:
 
930
            if not create:
 
931
                raise
 
932
            # new file, save it
 
933
            self._save()
 
934
 
 
935
    def _add_lines(self, version_id, parents, lines, parent_texts,
 
936
        left_matching_blocks, nostore_sha, random_id, check_content):
 
937
        """Add a version and save the weave."""
 
938
        self.check_not_reserved_id(version_id)
 
939
        result = super(WeaveFile, self)._add_lines(version_id, parents, lines,
 
940
            parent_texts, left_matching_blocks, nostore_sha, random_id,
 
941
            check_content)
 
942
        self._save()
 
943
        return result
 
944
 
 
945
    def copy_to(self, name, transport):
 
946
        """See VersionedFile.copy_to()."""
 
947
        # as we are all in memory always, just serialise to the new place.
 
948
        sio = StringIO()
 
949
        write_weave_v5(self, sio)
 
950
        sio.seek(0)
 
951
        transport.put_file(name + WeaveFile.WEAVE_SUFFIX, sio, self._filemode)
 
952
 
 
953
    def _save(self):
 
954
        """Save the weave."""
 
955
        self._check_write_ok()
 
956
        sio = StringIO()
 
957
        write_weave_v5(self, sio)
 
958
        sio.seek(0)
 
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)
 
966
 
 
967
    @staticmethod
 
968
    def get_suffixes():
 
969
        """See VersionedFile.get_suffixes()."""
 
970
        return [WeaveFile.WEAVE_SUFFIX]
 
971
 
 
972
    def insert_record_stream(self, stream):
 
973
        super(WeaveFile, self).insert_record_stream(stream)
 
974
        self._save()
 
975
 
 
976
 
 
977
def _reweave(wa, wb, pb=None, msg=None):
917
978
    """Combine two weaves and return the result.
918
979
 
919
 
    This works even if a revision R has different parents in 
 
980
    This works even if a revision R has different parents in
920
981
    wa and wb.  In the resulting weave all the parents are given.
921
982
 
922
 
    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
923
984
    of the versions in the two inputs.  More efficient approaches
924
 
    might be possible but it should only be necessary to do 
925
 
    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
926
987
    inserted.
927
988
 
928
989
    :param pb: An optional progress bar, indicating how far done we are
930
991
    """
931
992
    wr = Weave()
932
993
    ia = ib = 0
933
 
    queue_a = range(wa.numversions())
934
 
    queue_b = range(wb.numversions())
 
994
    queue_a = range(wa.num_versions())
 
995
    queue_b = range(wb.num_versions())
935
996
    # first determine combined parents of all versions
936
997
    # map from version name -> all parent names
937
998
    combined_parents = _reweave_parent_graphs(wa, wb)
938
999
    mutter("combined parents: %r", combined_parents)
939
 
    order = topo_sort(combined_parents.iteritems())
 
1000
    order = tsort.topo_sort(combined_parents.iteritems())
940
1001
    mutter("order to reweave: %r", order)
941
1002
 
942
1003
    if pb and not msg:
959
1020
                    raise errors.WeaveTextDiffers(name, wa, wb)
960
1021
        else:
961
1022
            lines = wb.get_lines(name)
962
 
        wr.add(name, combined_parents[name], lines)
 
1023
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
963
1024
    return wr
964
1025
 
965
1026
 
966
1027
def _reweave_parent_graphs(wa, wb):
967
1028
    """Return combined parent ancestry for two weaves.
968
 
    
 
1029
 
969
1030
    Returned as a list of (version_name, set(parent_names))"""
970
1031
    combined = {}
971
1032
    for weave in [wa, wb]:
972
1033
        for idx, name in enumerate(weave._names):
973
1034
            p = combined.setdefault(name, set())
974
 
            p.update(map(weave.idx_to_name, weave._parents[idx]))
 
1035
            p.update(map(weave._idx_to_name, weave._parents[idx]))
975
1036
    return combined
976
 
 
977
 
 
978
 
def weave_toc(w):
979
 
    """Show the weave's table-of-contents"""
980
 
    print '%6s %50s %10s %10s' % ('ver', 'name', 'sha1', 'parents')
981
 
    for i in (6, 50, 10, 10):
982
 
        print '-' * i,
983
 
    print
984
 
    for i in range(w.numversions()):
985
 
        sha1 = w._sha1s[i]
986
 
        name = w._names[i]
987
 
        parent_str = ' '.join(map(str, w._parents[i]))
988
 
        print '%6d %-50.50s %10.10s %s' % (i, name, sha1, parent_str)
989
 
 
990
 
 
991
 
 
992
 
def weave_stats(weave_file, pb):
993
 
    from bzrlib.weavefile import read_weave
994
 
 
995
 
    wf = file(weave_file, 'rb')
996
 
    w = read_weave(wf)
997
 
    # FIXME: doesn't work on pipes
998
 
    weave_size = wf.tell()
999
 
 
1000
 
    total = 0
1001
 
    vers = len(w)
1002
 
    for i in range(vers):
1003
 
        pb.update('checking sizes', i, vers)
1004
 
        for origin, lineno, line in w._extract([i]):
1005
 
            total += len(line)
1006
 
 
1007
 
    pb.clear()
1008
 
 
1009
 
    print 'versions          %9d' % vers
1010
 
    print 'weave file        %9d bytes' % weave_size
1011
 
    print 'total contents    %9d bytes' % total
1012
 
    print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
1013
 
    if vers:
1014
 
        avg = total/vers
1015
 
        print 'average size      %9d bytes' % avg
1016
 
        print 'relative size     %9.2fx' % (float(weave_size) / float(avg))
1017
 
 
1018
 
 
1019
 
def usage():
1020
 
    print """bzr weave tool
1021
 
 
1022
 
Experimental tool for weave algorithm.
1023
 
 
1024
 
usage:
1025
 
    weave init WEAVEFILE
1026
 
        Create an empty weave file
1027
 
    weave get WEAVEFILE VERSION
1028
 
        Write out specified version.
1029
 
    weave check WEAVEFILE
1030
 
        Check consistency of all versions.
1031
 
    weave toc WEAVEFILE
1032
 
        Display table of contents.
1033
 
    weave add WEAVEFILE NAME [BASE...] < NEWTEXT
1034
 
        Add NEWTEXT, with specified parent versions.
1035
 
    weave annotate WEAVEFILE VERSION
1036
 
        Display origin of each line.
1037
 
    weave mash WEAVEFILE VERSION...
1038
 
        Display composite of all selected versions.
1039
 
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
1040
 
        Auto-merge two versions and display conflicts.
1041
 
    weave diff WEAVEFILE VERSION1 VERSION2 
1042
 
        Show differences between two versions.
1043
 
 
1044
 
example:
1045
 
 
1046
 
    % weave init foo.weave
1047
 
    % vi foo.txt
1048
 
    % weave add foo.weave ver0 < foo.txt
1049
 
    added version 0
1050
 
 
1051
 
    (create updated version)
1052
 
    % vi foo.txt
1053
 
    % weave get foo.weave 0 | diff -u - foo.txt
1054
 
    % weave add foo.weave ver1 0 < foo.txt
1055
 
    added version 1
1056
 
 
1057
 
    % weave get foo.weave 0 > foo.txt       (create forked version)
1058
 
    % vi foo.txt
1059
 
    % weave add foo.weave ver2 0 < foo.txt
1060
 
    added version 2
1061
 
 
1062
 
    % weave merge foo.weave 1 2 > foo.txt   (merge them)
1063
 
    % vi foo.txt                            (resolve conflicts)
1064
 
    % weave add foo.weave merged 1 2 < foo.txt     (commit merged version)     
1065
 
    
1066
 
"""
1067
 
    
1068
 
 
1069
 
 
1070
 
def main(argv):
1071
 
    import sys
1072
 
    import os
1073
 
    try:
1074
 
        import bzrlib
1075
 
    except ImportError:
1076
 
        # in case we're run directly from the subdirectory
1077
 
        sys.path.append('..')
1078
 
        import bzrlib
1079
 
    from bzrlib.weavefile import write_weave, read_weave
1080
 
    from bzrlib.progress import ProgressBar
1081
 
 
1082
 
    try:
1083
 
        import psyco
1084
 
        psyco.full()
1085
 
    except ImportError:
1086
 
        pass
1087
 
 
1088
 
    if len(argv) < 2:
1089
 
        usage()
1090
 
        return 0
1091
 
 
1092
 
    cmd = argv[1]
1093
 
 
1094
 
    def readit():
1095
 
        return read_weave(file(argv[2], 'rb'))
1096
 
    
1097
 
    if cmd == 'help':
1098
 
        usage()
1099
 
    elif cmd == 'add':
1100
 
        w = readit()
1101
 
        # at the moment, based on everything in the file
1102
 
        name = argv[3]
1103
 
        parents = map(int, argv[4:])
1104
 
        lines = sys.stdin.readlines()
1105
 
        ver = w.add(name, parents, lines)
1106
 
        write_weave(w, file(argv[2], 'wb'))
1107
 
        print 'added version %r %d' % (name, ver)
1108
 
    elif cmd == 'init':
1109
 
        fn = argv[2]
1110
 
        if os.path.exists(fn):
1111
 
            raise IOError("file exists")
1112
 
        w = Weave()
1113
 
        write_weave(w, file(fn, 'wb'))
1114
 
    elif cmd == 'get': # get one version
1115
 
        w = readit()
1116
 
        sys.stdout.writelines(w.get_iter(int(argv[3])))
1117
 
        
1118
 
    elif cmd == 'mash': # get composite
1119
 
        w = readit()
1120
 
        sys.stdout.writelines(w.mash_iter(map(int, argv[3:])))
1121
 
 
1122
 
    elif cmd == 'diff':
1123
 
        from difflib import unified_diff
1124
 
        w = readit()
1125
 
        fn = argv[2]
1126
 
        v1, v2 = map(int, argv[3:5])
1127
 
        lines1 = w.get(v1)
1128
 
        lines2 = w.get(v2)
1129
 
        diff_gen = unified_diff(lines1, lines2,
1130
 
                                '%s version %d' % (fn, v1),
1131
 
                                '%s version %d' % (fn, v2))
1132
 
        sys.stdout.writelines(diff_gen)
1133
 
            
1134
 
    elif cmd == 'annotate':
1135
 
        w = readit()
1136
 
        # newline is added to all lines regardless; too hard to get
1137
 
        # reasonable formatting otherwise
1138
 
        lasto = None
1139
 
        for origin, text in w.annotate(int(argv[3])):
1140
 
            text = text.rstrip('\r\n')
1141
 
            if origin == lasto:
1142
 
                print '      | %s' % (text)
1143
 
            else:
1144
 
                print '%5d | %s' % (origin, text)
1145
 
                lasto = origin
1146
 
                
1147
 
    elif cmd == 'toc':
1148
 
        weave_toc(readit())
1149
 
 
1150
 
    elif cmd == 'stats':
1151
 
        weave_stats(argv[2], ProgressBar())
1152
 
        
1153
 
    elif cmd == 'check':
1154
 
        w = readit()
1155
 
        pb = ProgressBar()
1156
 
        w.check(pb)
1157
 
        pb.clear()
1158
 
        print '%d versions ok' % w.numversions()
1159
 
 
1160
 
    elif cmd == 'inclusions':
1161
 
        w = readit()
1162
 
        print ' '.join(map(str, w.inclusions([int(argv[3])])))
1163
 
 
1164
 
    elif cmd == 'parents':
1165
 
        w = readit()
1166
 
        print ' '.join(map(str, w._parents[int(argv[3])]))
1167
 
 
1168
 
    elif cmd == 'plan-merge':
1169
 
        w = readit()
1170
 
        for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
1171
 
            if line:
1172
 
                print '%14s | %s' % (state, line),
1173
 
 
1174
 
    elif cmd == 'merge':
1175
 
        w = readit()
1176
 
        p = w.plan_merge(int(argv[3]), int(argv[4]))
1177
 
        sys.stdout.writelines(w.weave_merge(p))
1178
 
            
1179
 
    elif cmd == 'mash-merge':
1180
 
        if len(argv) != 5:
1181
 
            usage()
1182
 
            return 1
1183
 
 
1184
 
        w = readit()
1185
 
        v1, v2 = map(int, argv[3:5])
1186
 
 
1187
 
        basis = w.inclusions([v1]).intersection(w.inclusions([v2]))
1188
 
 
1189
 
        base_lines = list(w.mash_iter(basis))
1190
 
        a_lines = list(w.get(v1))
1191
 
        b_lines = list(w.get(v2))
1192
 
 
1193
 
        from bzrlib.merge3 import Merge3
1194
 
        m3 = Merge3(base_lines, a_lines, b_lines)
1195
 
 
1196
 
        name_a = 'version %d' % v1
1197
 
        name_b = 'version %d' % v2
1198
 
        sys.stdout.writelines(m3.merge_lines(name_a=name_a, name_b=name_b))
1199
 
    else:
1200
 
        raise ValueError('unknown command %r' % cmd)
1201
 
    
1202
 
 
1203
 
 
1204
 
def profile_main(argv): 
1205
 
    import tempfile, hotshot, hotshot.stats
1206
 
 
1207
 
    prof_f = tempfile.NamedTemporaryFile()
1208
 
 
1209
 
    prof = hotshot.Profile(prof_f.name)
1210
 
 
1211
 
    ret = prof.runcall(main, argv)
1212
 
    prof.close()
1213
 
 
1214
 
    stats = hotshot.stats.load(prof_f.name)
1215
 
    #stats.strip_dirs()
1216
 
    stats.sort_stats('cumulative')
1217
 
    ## XXX: Might like to write to stderr or the trace file instead but
1218
 
    ## print_stats seems hardcoded to stdout
1219
 
    stats.print_stats(20)
1220
 
            
1221
 
    return ret
1222
 
 
1223
 
 
1224
 
def lsprofile_main(argv): 
1225
 
    from bzrlib.lsprof import profile
1226
 
    ret,stats = profile(main, argv)
1227
 
    stats.sort()
1228
 
    stats.pprint()
1229
 
    return ret
1230
 
 
1231
 
 
1232
 
if __name__ == '__main__':
1233
 
    import sys
1234
 
    if '--profile' in sys.argv:
1235
 
        args = sys.argv[:]
1236
 
        args.remove('--profile')
1237
 
        sys.exit(profile_main(args))
1238
 
    elif '--lsprof' in sys.argv:
1239
 
        args = sys.argv[:]
1240
 
        args.remove('--lsprof')
1241
 
        sys.exit(lsprofile_main(args))
1242
 
    else:
1243
 
        sys.exit(main(sys.argv))
1244