1
# Copyright (C) 2005, 2009 Canonical Ltd
3
# Copyright (C) 2005 Canonical Ltd
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
5
7
# the Free Software Foundation; either version 2 of the License, or
6
8
# (at your option) any later version.
8
10
# This program is distributed in the hope that it will be useful,
9
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
13
# GNU General Public License for more details.
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
17
19
# Author: Martin Pool <mbp@canonical.com>
20
22
"""Weave - storage of related text file versions"""
24
# TODO: Perhaps have copy method for Weave instances?
23
26
# XXX: If we do weaves this way, will a merge still behave the same
24
27
# way if it's done in a different order? That's a pretty desirable
30
# TODO: How to write these to disk? One option is cPickle, which
31
# would be fast but less friendly to C, and perhaps not portable. Another is
27
33
# TODO: Nothing here so far assumes the lines are really \n newlines,
28
# rather than being split up in some other way. We could accommodate
34
# rather than being split up in some other way. We could accomodate
29
35
# binaries, perhaps by naively splitting on \n or perhaps using
30
36
# something like a rolling checksum.
32
# TODO: End marker for each version so we can stop reading?
38
# TODO: Perhaps track SHA-1 in the header for protection? This would
39
# be redundant with it being stored in the inventory, but perhaps
42
# TODO: Track version names as well as indexes.
44
# TODO: Probably do transitive expansion when specifying parents?
46
# TODO: Separate out some code to read and write weaves.
48
# TODO: End marker for each version?
34
50
# TODO: Check that no insertion occurs inside a deletion that was
35
51
# active in the version of the insertion.
37
# TODO: In addition to the SHA-1 check, perhaps have some code that
38
# checks structural constraints of the weave: ie that insertions are
39
# properly nested, that there is no text outside of an insertion, that
40
# insertions or deletions are not repeated, etc.
42
# TODO: Parallel-extract that passes back each line along with a
43
# description of which revisions include it. Nice for checking all
44
# shas or calculating stats in parallel.
46
# TODO: Using a single _extract routine and then processing the output
47
# is probably inefficient. It's simple enough that we can afford to
48
# have slight specializations for different ways its used: annotate,
49
# basis for add, get, etc.
51
# TODO: Probably the API should work only in names to hide the integer
52
# indexes from the user.
54
# TODO: Is there any potential performance win by having an add()
55
# variant that is passed a pre-cooked version of the single basis
58
# TODO: Reweave can possibly be made faster by remembering diffs
59
# where the basis and destination are unchanged.
61
# FIXME: Sometimes we will be given a parents list for a revision
62
# that includes some redundant parents (i.e. already a parent of
63
# something in the list.) We should eliminate them. This can
64
# be done fairly efficiently because the sequence numbers constrain
65
# the possible relationships.
67
# FIXME: the conflict markers should be *7* characters
70
from cStringIO import StringIO
73
from bzrlib.lazy_import import lazy_import
74
lazy_import(globals(), """
75
from bzrlib import tsort
81
from bzrlib.errors import (WeaveError, WeaveFormatError, WeaveParentMismatch,
82
RevisionAlreadyPresent,
84
UnavailableRepresentation,
86
from bzrlib.osutils import dirname, sha, sha_strings, split_lines
87
import bzrlib.patiencediff
88
from bzrlib.revision import NULL_REVISION
89
from bzrlib.symbol_versioning import *
90
from bzrlib.trace import mutter
91
from bzrlib.versionedfile import (
98
from bzrlib.weavefile import _read_weave_v5, write_weave_v5
101
class WeaveContentFactory(ContentFactory):
102
"""Content factory for streaming from weaves.
104
:seealso ContentFactory:
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'
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])
123
raise UnavailableRepresentation(self.key, storage_kind, 'fulltext')
126
class Weave(VersionedFile):
58
from sets import Set, ImmutableSet
60
frozenset = ImmutableSet
64
class WeaveError(Exception):
65
"""Exception in processing weave"""
68
class WeaveFormatError(WeaveError):
69
"""Weave invariant violated"""
127
73
"""weave - versioned text file storage.
129
75
A Weave manages versions of line-based text files, keeping track
130
76
of the originating version for each line.
190
134
should be no way to get an earlier version deleting a later
194
Text of the weave; list of control instruction tuples and strings.
197
List of parents, indexed by version number.
198
It is only necessary to store the minimal set of parents for
199
each version; the parent's parents are implied.
202
List of hex SHA-1 of each version.
205
List of symbolic names for each version. Each should be unique.
208
For each name, the version number.
211
Descriptive name of this weave; typically the filename if known.
141
List of versions, indexed by index number.
143
For each version we store the tuple (included_versions), which
144
lists the previous versions also considered active.
215
__slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map',
216
'_weave_name', '_matcher', '_allow_reserved']
218
def __init__(self, weave_name=None, access_mode='w', matcher=None,
219
get_scope=None, allow_reserved=False):
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).
226
super(Weave, self).__init__()
232
self._weave_name = weave_name
234
self._matcher = bzrlib.patiencediff.PatienceSequenceMatcher
236
self._matcher = matcher
237
if get_scope is None:
238
get_scope = lambda:None
239
self._get_scope = get_scope
240
self._scope = get_scope()
241
self._access_mode = access_mode
242
self._allow_reserved = allow_reserved
245
return "Weave(%r)" % self._weave_name
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)
255
"""Return a deep copy of self.
257
The copy can be modified without affecting the original weave."""
259
other._weave = self._weave[:]
260
other._parents = self._parents[:]
261
other._sha1s = self._sha1s[:]
262
other._names = self._names[:]
263
other._name_map = self._name_map.copy()
264
other._weave_name = self._weave_name
267
152
def __eq__(self, other):
268
153
if not isinstance(other, Weave):
270
return self._parents == other._parents \
271
and self._weave == other._weave \
272
and self._sha1s == other._sha1s
155
return self._v == other._v \
156
and self._l == other._l
274
159
def __ne__(self, other):
275
160
return not self.__eq__(other)
277
def _idx_to_name(self, version):
278
return self._names[version]
280
def _lookup(self, name):
281
"""Convert symbolic version name to index."""
282
if not self._allow_reserved:
283
self.check_not_reserved_id(name)
285
return self._name_map[name]
287
raise RevisionNotPresent(name, self._weave_name)
290
"""See VersionedFile.versions."""
291
return self._names[:]
293
def has_version(self, version_id):
294
"""See VersionedFile.has_version."""
295
return (version_id in self._name_map)
297
__contains__ = has_version
299
def get_record_stream(self, versions, ordering, include_delta_closure):
300
"""Get a stream of records for versions.
302
:param versions: The versions to include. Each version is a tuple
304
:param ordering: Either 'unordered' or 'topological'. A topologically
305
sorted stream has compression parents strictly before their
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.
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:
325
yield WeaveContentFactory(version, self)
327
yield AbsentContentFactory((version,))
329
def get_parent_map(self, version_ids):
330
"""See VersionedFile.get_parent_map."""
332
for version_id in version_ids:
333
if version_id == NULL_REVISION:
338
map(self._idx_to_name,
339
self._parents[self._lookup(version_id)]))
340
except RevisionNotPresent:
342
result[version_id] = parents
345
def get_parents_with_ghosts(self, version_id):
346
raise NotImplementedError(self.get_parents_with_ghosts)
348
def insert_record_stream(self, stream):
349
"""Insert a record stream into this versioned file.
351
:param stream: A stream of records to insert.
353
:seealso VersionedFile.get_record_stream:
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')))
367
adapter_key = record.storage_kind, 'fulltext'
369
adapter = adapters[adapter_key]
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))
376
self.add_lines(record.key[0], parents, lines)
377
except RevisionAlreadyPresent:
380
def _check_repeated_add(self, name, parents, text, sha1):
381
"""Check that a duplicated add is OK.
383
If it is, return the (old) index; otherwise raise an exception.
385
idx = self._lookup(name)
386
if sorted(self._parents[idx]) != sorted(parents) \
387
or sha1 != self._sha1s[idx]:
388
raise RevisionAlreadyPresent(name, self._weave_name)
391
def _add_lines(self, version_id, parents, lines, parent_texts,
392
left_matching_blocks, nostore_sha, random_id, check_content):
393
"""See VersionedFile.add_lines."""
394
idx = self._add(version_id, lines, map(self._lookup, parents),
395
nostore_sha=nostore_sha)
396
return sha_strings(lines), sum(map(len, lines)), idx
398
def _add(self, version_id, lines, parents, sha1=None, nostore_sha=None):
163
def add(self, parents, text):
399
164
"""Add a single text on top of the weave.
401
166
Returns the index number of the newly added version.
404
Symbolic name for this version.
405
(Typically the revision-id of the revision that added it.)
406
If None, a name will be allocated based on the hash. (sha1:SHAHASH)
409
List or set of direct parent version numbers.
412
Sequence of lines to be added in the new version.
414
:param nostore_sha: See VersionedFile.add_lines.
416
self._check_lines_not_unicode(lines)
417
self._check_lines_are_lines(lines)
419
sha1 = sha_strings(lines)
420
if sha1 == nostore_sha:
421
raise errors.ExistingContent
422
if version_id is None:
423
version_id = "sha1:" + sha1
424
if version_id in self._name_map:
425
return self._check_repeated_add(version_id, parents, lines, sha1)
169
List or set of parent version numbers. This must normally include
170
the parents and the parent's parents, or wierd things might happen.
173
Sequence of lines to be added in the new version."""
427
174
self._check_versions(parents)
428
## self._check_lines(lines)
429
new_version = len(self._parents)
431
# if we abort after here the (in-memory) weave will be corrupt because only
432
# some fields are updated
433
# XXX: FIXME implement a succeed-or-fail of the rest of this routine.
434
# - Robert Collins 20060226
435
self._parents.append(parents[:])
436
self._sha1s.append(sha1)
437
self._names.append(version_id)
438
self._name_map[version_id] = new_version
442
# special case; adding with no parents revision; can do
443
# this more quickly by just appending unconditionally.
444
# even more specially, if we're adding an empty text we
445
# need do nothing at all.
447
self._weave.append(('{', new_version))
448
self._weave.extend(lines)
449
self._weave.append(('}', None))
452
if len(parents) == 1:
453
pv = list(parents)[0]
454
if sha1 == self._sha1s[pv]:
455
# special case: same as the single parent
459
ancestors = self._inclusions(parents)
463
# basis a list of (origin, lineno, line)
466
for origin, lineno, line in self._extract(ancestors):
467
basis_lineno.append(lineno)
468
basis_lines.append(line)
470
# another small special case: a merge, producing the same text
472
if lines == basis_lines:
475
# add a sentinel, because we can also match against the final line
476
basis_lineno.append(len(self._weave))
478
# XXX: which line of the weave should we really consider
479
# matches the end of the file? the current code says it's the
480
# last line of the weave?
482
#print 'basis_lines:', basis_lines
483
#print 'new_lines: ', lines
485
s = self._matcher(None, basis_lines, lines)
487
# offset gives the number of lines that have been inserted
488
# into the weave up to the current point; if the original edit instruction
489
# says to change line A then we actually change (A+offset)
492
for tag, i1, i2, j1, j2 in s.get_opcodes():
493
# i1,i2 are given in offsets within basis_lines; we need to map them
494
# back to offsets within the entire weave
495
#print 'raw match', tag, i1, i2, j1, j2
498
i1 = basis_lineno[i1]
499
i2 = basis_lineno[i2]
500
# the deletion and insertion are handled separately.
501
# first delete the region.
503
self._weave.insert(i1+offset, ('[', new_version))
504
self._weave.insert(i2+offset+1, (']', new_version))
508
# there may have been a deletion spanning up to
509
# i2; we want to insert after this region to make sure
510
# we don't destroy ourselves
512
self._weave[i:i] = ([('{', new_version)]
515
offset += 2 + (j2 - j1)
518
def _inclusions(self, versions):
519
"""Return set of all ancestors of given version(s)."""
520
if not len(versions):
523
for v in xrange(max(versions), 0, -1):
525
# include all its parents
526
i.update(self._parents[v])
528
## except IndexError:
529
## raise ValueError("version %d not present in weave" % v)
531
def get_ancestry(self, version_ids, topo_sorted=True):
532
"""See VersionedFile.get_ancestry."""
533
if isinstance(version_ids, basestring):
534
version_ids = [version_ids]
535
i = self._inclusions([self._lookup(v) for v in version_ids])
536
return [self._idx_to_name(v) for v in i]
175
self._check_lines(text)
180
parents = frozenset(parents)
181
delta = self._delta(parents, text)
183
# offset gives the number of lines that have been inserted
184
# into the weave up to the current point; if the original edit instruction
185
# says to change line A then we actually change (A+offset)
188
for i1, i2, newlines in delta:
191
assert i2 <= len(self._l)
193
# the deletion and insertion are handled separately.
194
# first delete the region.
196
self._l.insert(i1+offset, ('[', idx))
197
self._l.insert(i2+offset+1, (']', idx))
202
# there may have been a deletion spanning up to
203
# i2; we want to insert after this region to make sure
204
# we don't destroy ourselves
206
self._l[i:i] = [('{', idx)] \
209
offset += 2 + len(newlines)
211
self._addversion(parents)
213
# special case; adding with no parents revision; can do this
214
# more quickly by just appending unconditionally
215
self._l.append(('{', idx))
217
self._l.append(('}', idx))
219
self._addversion(None)
224
def _addversion(self, parents):
226
self._v.append(frozenset(parents))
228
self._v.append(frozenset())
538
231
def _check_lines(self, text):
539
232
if not isinstance(text, list):
543
236
if not isinstance(l, basestring):
544
raise ValueError("text line should be a string or unicode, not %s"
237
raise ValueError("text line should be a string or unicode, not %s" % type(l))
549
241
def _check_versions(self, indexes):
550
242
"""Check everything in the sequence of indexes is valid"""
551
243
for i in indexes:
554
246
except IndexError:
555
247
raise IndexError("invalid version number %r" % i)
557
def _compatible_parents(self, my_parents, other_parents):
558
"""During join check that other_parents are joinable with my_parents.
560
Joinable is defined as 'is a subset of' - supersets may require
561
regeneration of diffs, but subsets do not.
563
return len(other_parents.difference(my_parents)) == 0
565
def annotate(self, version_id):
566
"""Return a list of (version-id, line) tuples for version_id.
250
def annotate(self, index):
251
return list(self.annotate_iter(index))
254
def annotate_iter(self, index):
255
"""Yield list of (index-id, line) pairs for the specified version.
568
257
The index indicates when the line originated in the weave."""
569
incls = [self._lookup(version_id)]
570
return [(self._idx_to_name(origin), text) for origin, lineno, text in
571
self._extract(incls)]
573
def iter_lines_added_or_present_in_versions(self, version_ids=None,
575
"""See VersionedFile.iter_lines_added_or_present_in_versions()."""
576
if version_ids is None:
577
version_ids = self.versions()
578
version_ids = set(version_ids)
579
for lineno, inserted, deletes, line in self._walk_internal(version_ids):
580
if inserted not in version_ids: continue
582
yield line + '\n', inserted
586
def _walk_internal(self, version_ids=None):
587
"""Helper method for weave actions."""
592
lineno = 0 # line of weave, 0-based
594
for l in self._weave:
595
if l.__class__ == tuple:
599
istack.append(self._names[v])
603
dset.add(self._names[v])
605
dset.remove(self._names[v])
607
raise WeaveFormatError('unexpected instruction %r' % v)
609
yield lineno, istack[-1], frozenset(dset), l
613
raise WeaveFormatError("unclosed insertion blocks "
614
"at end of weave: %s" % istack)
616
raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
619
def plan_merge(self, ver_a, ver_b):
620
"""Return pseudo-annotation indicating how the two versions merge.
622
This is computed between versions a and b and their common
625
Weave lines present in none of them are skipped entirely.
627
inc_a = set(self.get_ancestry([ver_a]))
628
inc_b = set(self.get_ancestry([ver_b]))
629
inc_c = inc_a & inc_b
631
for lineno, insert, deleteset, line in self._walk_internal([ver_a, ver_b]):
632
if deleteset & inc_c:
633
# killed in parent; can't be in either a or b
634
# not relevant to our work
635
yield 'killed-base', line
636
elif insert in inc_c:
637
# was inserted in base
638
killed_a = bool(deleteset & inc_a)
639
killed_b = bool(deleteset & inc_b)
640
if killed_a and killed_b:
641
yield 'killed-both', line
643
yield 'killed-a', line
645
yield 'killed-b', line
647
yield 'unchanged', line
648
elif insert in inc_a:
649
if deleteset & inc_a:
650
yield 'ghost-a', line
654
elif insert in inc_b:
655
if deleteset & inc_b:
656
yield 'ghost-b', line
660
# not in either revision
661
yield 'irrelevant', line
663
def _extract(self, versions):
261
raise IndexError('version index %d out of range' % index)
264
for origin, lineno, text in self._extract(included):
268
def _extract(self, included):
664
269
"""Yield annotation of lines in included set.
666
271
Yields a sequence of tuples (origin, lineno, text), where
670
275
The set typically but not necessarily corresponds to a version.
673
if not isinstance(i, int):
676
included = self._inclusions(versions)
277
istack = [] # versions for which an insertion block is current
279
dset = set() # versions for which a deletion block is current
682
283
lineno = 0 # line of weave, 0-based
285
# TODO: Probably only need to put included revisions in the istack
287
# TODO: Could split this into two functions, one that updates
288
# the stack and the other that processes the results -- but
289
# I'm not sure it's really needed.
688
291
WFE = WeaveFormatError
691
# 449 0 4474.6820 2356.5590 bzrlib.weave:556(_extract)
692
# +285282 0 1676.8040 1676.8040 +<isinstance>
693
# 1.6 seconds in 'isinstance'.
694
# changing the first isinstance:
695
# 449 0 2814.2660 1577.1760 bzrlib.weave:556(_extract)
696
# +140414 0 762.8050 762.8050 +<isinstance>
697
# note that the inline time actually dropped (less function calls)
698
# and total processing time was halved.
699
# we're still spending ~1/4 of the method in isinstance though.
700
# so lets hard code the acceptable string classes we expect:
701
# 449 0 1202.9420 786.2930 bzrlib.weave:556(_extract)
702
# +71352 0 377.5560 377.5560 +<method 'append' of 'list'
704
# yay, down to ~1/4 the initial extract time, and our inline time
705
# has shrunk again, with isinstance no longer dominating.
706
# tweaking the stack inclusion test to use a set gives:
707
# 449 0 1122.8030 713.0080 bzrlib.weave:556(_extract)
708
# +71352 0 354.9980 354.9980 +<method 'append' of 'list'
710
# - a 5% win, or possibly just noise. However with large istacks that
711
# 'in' test could dominate, so I'm leaving this change in place -
712
# when its fast enough to consider profiling big datasets we can review.
717
for l in self._weave:
718
if l.__class__ == tuple:
294
if isinstance(l, tuple):
297
if istack and (istack[-1] >= v):
298
raise WFE("improperly nested insertions %d>=%d on line %d"
299
% (istack[-1], v, lineno))
725
iset.remove(istack.pop())
305
raise WFE("unmatched close of insertion %d on line %d"
308
raise WFE("mismatched close of insertion %d!=%d on line %d"
313
raise WFE("repeated deletion marker for version %d on line %d"
317
raise WFE("version %d deletes own text on line %d"
324
raise WFE("unmatched close of deletion %d on line %d"
733
raise AssertionError()
327
raise WFE("invalid processing instruction %r on line %d"
736
isactive = (not dset) and istack and (istack[-1] in included)
330
assert isinstance(l, basestring)
332
raise WFE("literal at top level on line %d"
334
isactive = (istack[-1] in included) \
335
and not included.intersection(dset)
738
result.append((istack[-1], lineno, l))
338
yield origin, lineno, l
741
raise WeaveFormatError("unclosed insertion blocks "
742
"at end of weave: %s" % istack)
342
raise WFE("unclosed insertion blocks at end of weave",
744
raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
748
def _maybe_lookup(self, name_or_index):
749
"""Convert possible symbolic name to index, or pass through indexes.
753
if isinstance(name_or_index, (int, long)):
756
return self._lookup(name_or_index)
758
def get_lines(self, version_id):
759
"""See VersionedFile.get_lines()."""
760
int_index = self._maybe_lookup(version_id)
761
result = [line for (origin, lineno, line) in self._extract([int_index])]
762
expected_sha1 = self._sha1s[int_index]
763
measured_sha1 = sha_strings(result)
764
if measured_sha1 != expected_sha1:
765
raise errors.WeaveInvalidChecksum(
766
'file %s, revision %s, expected: %s, measured %s'
767
% (self._weave_name, version_id,
768
expected_sha1, measured_sha1))
771
def get_sha1s(self, version_ids):
772
"""See VersionedFile.get_sha1s()."""
774
for v in version_ids:
775
result[v] = self._sha1s[self._lookup(v)]
778
def num_versions(self):
779
"""How many versions are in this weave?"""
780
l = len(self._parents)
783
__len__ = num_versions
785
def check(self, progress_bar=None):
786
# TODO evaluate performance hit of using string sets in this routine.
787
# TODO: check no circular inclusions
788
# TODO: create a nested progress bar
789
for version in range(self.num_versions()):
790
inclusions = list(self._parents[version])
793
if inclusions[-1] >= version:
345
raise WFE("unclosed deletion blocks at end of weave",
349
def getiter(self, index):
350
"""Yield lines for the specified version."""
351
for origin, line in self.annotate_iter(index):
355
def get(self, index):
356
return list(self.getiter(index))
359
def merge_iter(self, included):
360
"""Return composed version of multiple included versions."""
361
included = frozenset(included)
362
for origin, lineno, text in self._extract(included):
366
def dump(self, to_file):
367
from pprint import pprint
368
print >>to_file, "Weave._l = ",
369
pprint(self._l, to_file)
370
print >>to_file, "Weave._v = ",
371
pprint(self._v, to_file)
375
for vers_info in self._v:
377
for vi in vers_info[0]:
378
if vi < 0 or vi >= index:
794
379
raise WeaveFormatError("invalid included version %d for index %d"
795
% (inclusions[-1], version))
797
# try extracting all versions; parallel extraction is used
798
nv = self.num_versions()
803
# For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
804
# The problem is that set membership is much more expensive
805
name = self._idx_to_name(i)
808
new_inc = set([name])
809
for p in self._parents[i]:
810
new_inc.update(inclusions[self._idx_to_name(p)])
812
if set(new_inc) != set(self.get_ancestry(name)):
813
raise AssertionError(
815
% (set(new_inc), set(self.get_ancestry(name))))
816
inclusions[name] = new_inc
818
nlines = len(self._weave)
820
update_text = 'checking weave'
822
short_name = os.path.basename(self._weave_name)
823
update_text = 'checking %s' % (short_name,)
824
update_text = update_text[:25]
826
for lineno, insert, deleteset, line in self._walk_internal():
828
progress_bar.update(update_text, lineno, nlines)
830
for name, name_inclusions in inclusions.items():
831
# The active inclusion must be an ancestor,
832
# and no ancestors must have deleted this line,
833
# because we don't support resurrection.
834
if (insert in name_inclusions) and not (deleteset & name_inclusions):
835
sha1s[name].update(line)
838
version = self._idx_to_name(i)
839
hd = sha1s[version].hexdigest()
840
expected = self._sha1s[i]
842
raise errors.WeaveInvalidChecksum(
843
"mismatched sha1 for version %s: "
844
"got %s, expected %s"
845
% (version, hd, expected))
847
# TODO: check insertions are properly nested, that there are
848
# no lines outside of insertion blocks, that deletions are
849
# properly paired, etc.
851
def _imported_parents(self, other, other_idx):
852
"""Return list of parents in self corresponding to indexes in other."""
854
for parent_idx in other._parents[other_idx]:
855
parent_name = other._names[parent_idx]
856
if parent_name not in self._name_map:
857
# should not be possible
858
raise WeaveError("missing parent {%s} of {%s} in %r"
859
% (parent_name, other._name_map[other_idx], self))
860
new_parents.append(self._name_map[parent_name])
863
def _check_version_consistent(self, other, other_idx, name):
864
"""Check if a version in consistent in this and other.
866
To be consistent it must have:
869
* the same direct parents (by name, not index, and disregarding
872
If present & correct return True;
873
if not present in self return False;
874
if inconsistent raise error."""
875
this_idx = self._name_map.get(name, -1)
877
if self._sha1s[this_idx] != other._sha1s[other_idx]:
878
raise errors.WeaveTextDiffers(name, self, other)
879
self_parents = self._parents[this_idx]
880
other_parents = other._parents[other_idx]
881
n1 = set([self._names[i] for i in self_parents])
882
n2 = set([other._names[i] for i in other_parents])
883
if not self._compatible_parents(n1, n2):
884
raise WeaveParentMismatch("inconsistent parents "
885
"for version {%s}: %s vs %s" % (name, n1, n2))
382
raise WeaveFormatError("repeated included version %d for index %d"
388
def _delta(self, included, lines):
389
"""Return changes from basis to new revision.
391
The old text for comparison is the union of included revisions.
393
This is used in inserting a new text.
395
Delta is returned as a sequence of
396
(weave1, weave2, newlines).
398
This indicates that weave1:weave2 of the old weave should be
399
replaced by the sequence of lines in newlines. Note that
400
these line numbers are positions in the total weave and don't
401
correspond to the lines in any extracted version, or even the
402
extracted union of included versions.
404
If line1=line2, this is a pure insert; if newlines=[] this is a
405
pure delete. (Similar to difflib.)
408
self._check_versions(included)
410
##from pprint import pprint
412
# first get basis for comparison
413
# basis holds (lineno, origin, line)
419
# basis a list of (origin, lineno, line)
420
basis = list(self._extract(included))
422
# now make a parallel list with only the text, to pass to the differ
423
basis_lines = [line for (origin, lineno, line) in basis]
425
# add a sentinal, because we can also match against the final line
426
basis.append((None, len(self._l), None))
428
# XXX: which line of the weave should we really consider
429
# matches the end of the file? the current code says it's the
430
# last line of the weave?
432
from difflib import SequenceMatcher
433
s = SequenceMatcher(None, basis_lines, lines)
435
##print 'basis sequence:'
438
# TODO: Perhaps return line numbers from composed weave as well?
440
for tag, i1, i2, j1, j2 in s.get_opcodes():
441
##print tag, i1, i2, j1, j2
446
# i1,i2 are given in offsets within basis_lines; we need to map them
447
# back to offsets within the entire weave
448
real_i1 = basis[i1][1]
449
real_i2 = basis[i2][1]
453
assert j2 <= len(lines)
455
yield real_i1, real_i2, lines[j1:j2]
463
from weavefile import write_weave_v1, read_weave_v1
466
w = read_weave_v1(file(argv[2], 'rb'))
467
# at the moment, based on everything in the file
468
parents = set(range(len(w._v)))
469
lines = sys.stdin.readlines()
470
ver = w.add(parents, lines)
471
write_weave_v1(w, file(argv[2], 'wb'))
472
print 'added %d' % ver
475
if os.path.exists(fn):
476
raise IOError("file exists")
478
write_weave_v1(w, file(fn, 'wb'))
480
w = read_weave_v1(file(argv[2], 'rb'))
481
sys.stdout.writelines(w.getiter(int(argv[3])))
482
elif cmd == 'annotate':
483
w = read_weave_v1(file(argv[2], 'rb'))
484
# newline is added to all lines regardless; too hard to get
485
# reasonable formatting otherwise
487
for origin, text in w.annotate(int(argv[3])):
488
text = text.rstrip('\r\n')
490
print ' | %s' % (text)
891
def _reweave(self, other, pb, msg):
892
"""Reweave self with other - internal helper for join().
894
:param other: The other weave to merge
895
:param pb: An optional progress bar, indicating how far done we are
896
:param msg: An optional message for the progress
898
new_weave = _reweave(self, other, pb=pb, msg=msg)
899
self._copy_weave_content(new_weave)
901
def _copy_weave_content(self, otherweave):
902
"""adsorb the content from otherweave."""
903
for attr in self.__slots__:
904
if attr != '_weave_name':
905
setattr(self, attr, copy(getattr(otherweave, attr)))
908
class WeaveFile(Weave):
909
"""A WeaveFile represents a Weave on disk and writes on change."""
911
WEAVE_SUFFIX = '.weave'
913
def __init__(self, name, transport, filemode=None, create=False, access_mode='w', get_scope=None):
914
"""Create a WeaveFile.
916
:param create: If not True, only open an existing knit.
918
super(WeaveFile, self).__init__(name, access_mode, get_scope=get_scope,
919
allow_reserved=False)
920
self._transport = transport
921
self._filemode = filemode
923
_read_weave_v5(self._transport.get(name + WeaveFile.WEAVE_SUFFIX), self)
924
except errors.NoSuchFile:
930
def _add_lines(self, version_id, parents, lines, parent_texts,
931
left_matching_blocks, nostore_sha, random_id, check_content):
932
"""Add a version and save the weave."""
933
self.check_not_reserved_id(version_id)
934
result = super(WeaveFile, self)._add_lines(version_id, parents, lines,
935
parent_texts, left_matching_blocks, nostore_sha, random_id,
940
def copy_to(self, name, transport):
941
"""See VersionedFile.copy_to()."""
942
# as we are all in memory always, just serialise to the new place.
944
write_weave_v5(self, sio)
946
transport.put_file(name + WeaveFile.WEAVE_SUFFIX, sio, self._filemode)
949
"""Save the weave."""
950
self._check_write_ok()
952
write_weave_v5(self, sio)
954
bytes = sio.getvalue()
955
path = self._weave_name + WeaveFile.WEAVE_SUFFIX
957
self._transport.put_bytes(path, bytes, self._filemode)
958
except errors.NoSuchFile:
959
self._transport.mkdir(dirname(path))
960
self._transport.put_bytes(path, bytes, self._filemode)
964
"""See VersionedFile.get_suffixes()."""
965
return [WeaveFile.WEAVE_SUFFIX]
967
def insert_record_stream(self, stream):
968
super(WeaveFile, self).insert_record_stream(stream)
972
def _reweave(wa, wb, pb=None, msg=None):
973
"""Combine two weaves and return the result.
975
This works even if a revision R has different parents in
976
wa and wb. In the resulting weave all the parents are given.
978
This is done by just building up a new weave, maintaining ordering
979
of the versions in the two inputs. More efficient approaches
980
might be possible but it should only be necessary to do
981
this operation rarely, when a new previously ghost version is
984
:param pb: An optional progress bar, indicating how far done we are
985
:param msg: An optional message for the progress
989
queue_a = range(wa.num_versions())
990
queue_b = range(wb.num_versions())
991
# first determine combined parents of all versions
992
# map from version name -> all parent names
993
combined_parents = _reweave_parent_graphs(wa, wb)
994
mutter("combined parents: %r", combined_parents)
995
order = tsort.topo_sort(combined_parents.iteritems())
996
mutter("order to reweave: %r", order)
1001
for idx, name in enumerate(order):
1003
pb.update(msg, idx, len(order))
1004
if name in wa._name_map:
1005
lines = wa.get_lines(name)
1006
if name in wb._name_map:
1007
lines_b = wb.get_lines(name)
1008
if lines != lines_b:
1009
mutter('Weaves differ on content. rev_id {%s}', name)
1010
mutter('weaves: %s, %s', wa._weave_name, wb._weave_name)
1012
lines = list(difflib.unified_diff(lines, lines_b,
1013
wa._weave_name, wb._weave_name))
1014
mutter('lines:\n%s', ''.join(lines))
1015
raise errors.WeaveTextDiffers(name, wa, wb)
1017
lines = wb.get_lines(name)
1018
wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
1022
def _reweave_parent_graphs(wa, wb):
1023
"""Return combined parent ancestry for two weaves.
1025
Returned as a list of (version_name, set(parent_names))"""
1027
for weave in [wa, wb]:
1028
for idx, name in enumerate(weave._names):
1029
p = combined.setdefault(name, set())
1030
p.update(map(weave._idx_to_name, weave._parents[idx]))
492
print '%5d | %s' % (origin, text)
495
raise ValueError('unknown command %r' % cmd)
498
if __name__ == '__main__':
500
sys.exit(main(sys.argv))
added
removed
weave.py
