22
22
"""Weave - storage of related text file versions"""
24
# TODO: Perhaps have copy method for Weave instances?
25
26
# XXX: If we do weaves this way, will a merge still behave the same
26
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
29
33
# TODO: Nothing here so far assumes the lines are really \n newlines,
30
34
# rather than being split up in some other way. We could accomodate
31
35
# binaries, perhaps by naively splitting on \n or perhaps using
32
36
# something like a rolling checksum.
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.
34
48
# TODO: End marker for each version so we can stop reading?
36
50
# TODO: Check that no insertion occurs inside a deletion that was
37
51
# active in the version of the insertion.
39
# TODO: In addition to the SHA-1 check, perhaps have some code that
40
# checks structural constraints of the weave: ie that insertions are
41
# properly nested, that there is no text outside of an insertion, that
42
# insertions or deletions are not repeated, etc.
44
# TODO: Parallel-extract that passes back each line along with a
45
# description of which revisions include it. Nice for checking all
46
# shas or calculating stats in parallel.
48
# TODO: Using a single _extract routine and then processing the output
49
# is probably inefficient. It's simple enough that we can afford to
50
# have slight specializations for different ways its used: annotate,
51
# basis for add, get, etc.
53
# TODO: Perhaps the API should work only in names to hide the integer
54
# indexes from the user?
56
# TODO: Is there any potential performance win by having an add()
57
# variant that is passed a pre-cooked version of the single basis
60
# TODO: Have a way to go back and insert a revision V1 that is a parent
61
# of an already-stored revision V2. This means some lines previously
62
# counted as new in V2 will be discovered to have actually come from V1.
63
# It is probably necessary to insert V1, then compute a whole new diff
64
# from the mashed ancestors to V2. This must be repeated for every
65
# direct child of V1. The deltas from V2 to its descendents won't change,
66
# although their location within the weave may change. It may be possible
67
# to just adjust the location of those instructions rather than
68
# re-weaving the whole thing. This is expected to be a fairly rare
69
# operation, only used when inserting data that was previously a ghost.
75
from difflib import SequenceMatcher
53
# TODO: Perhaps a special slower check() method that verifies more
54
# nesting constraints and the MD5 of each version?
62
from sets import Set, ImmutableSet
64
frozenset = ImmutableSet
80
68
class WeaveError(Exception):
152
138
should be no way to get an earlier version deleting a later
156
Text of the weave; list of control instruction tuples and strings.
159
List of parents, indexed by version number.
160
It is only necessary to store the minimal set of parents for
161
each version; the parent's parents are implied.
145
List of versions, indexed by index number.
147
For each version we store the set (included_versions), which
148
lists the previous versions also considered active; the
149
versions included in those versions are included transitively.
150
So new versions created from nothing list []; most versions
151
have a single entry; some have more.
164
List of hex SHA-1 of each version.
167
List of symbolic names for each version. Each should be unique.
170
For each name, the version number.
173
Descriptive name of this weave; typically the filename if known.
154
List of hex SHA-1 of each version, or None if not recorded.
177
__slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map',
180
def __init__(self, weave_name=None):
186
self._weave_name = weave_name
190
"""Return a deep copy of self.
192
The copy can be modified without affecting the original weave."""
194
other._weave = self._weave[:]
195
other._parents = self._parents[:]
196
other._sha1s = self._sha1s[:]
197
other._names = self._names[:]
198
other._name_map = self._name_map.copy()
199
other._weave_name = self._weave_name
202
162
def __eq__(self, other):
203
163
if not isinstance(other, Weave):
205
return self._parents == other._parents \
206
and self._weave == other._weave \
207
and self._sha1s == other._sha1s
165
return self._v == other._v \
166
and self._l == other._l
210
169
def __ne__(self, other):
211
170
return not self.__eq__(other)
214
def maybe_lookup(self, name_or_index):
215
"""Convert possible symbolic name to index, or pass through indexes."""
216
if isinstance(name_or_index, (int, long)):
219
return self.lookup(name_or_index)
222
def lookup(self, name):
223
"""Convert symbolic version name to index."""
225
return self._name_map[name]
227
raise WeaveError("name %r not present in weave %r" %
228
(name, self._weave_name))
231
def iter_names(self):
232
"""Yield a list of all names in this weave."""
233
return iter(self._names)
235
def idx_to_name(self, version):
236
return self._names[version]
239
def _check_repeated_add(self, name, parents, text, sha1):
240
"""Check that a duplicated add is OK.
242
If it is, return the (old) index; otherwise raise an exception.
244
idx = self.lookup(name)
245
if sorted(self._parents[idx]) != sorted(parents):
246
raise WeaveError("name \"%s\" already present in weave "
247
"with different parents" % name)
248
if sha1 != self._sha1s[idx]:
249
raise WeaveError("name \"%s\" already present in weave "
250
"with different text" % name)
255
def add(self, name, parents, text, sha1=None):
173
def add(self, parents, text):
256
174
"""Add a single text on top of the weave.
258
176
Returns the index number of the newly added version.
261
Symbolic name for this version.
262
(Typically the revision-id of the revision that added it.)
265
List or set of direct parent version numbers.
179
List or set of parent version numbers. This must normally include
180
the parents and the parent's parents, or wierd things might happen.
268
Sequence of lines to be added in the new version.
270
sha -- SHA-1 of the file, if known. This is trusted to be
273
from bzrlib.osutils import sha_strings
275
assert isinstance(name, basestring)
277
sha1 = sha_strings(text)
278
if name in self._name_map:
279
return self._check_repeated_add(name, parents, text, sha1)
281
parents = map(self.maybe_lookup, parents)
282
self._check_versions(parents)
183
Sequence of lines to be added in the new version."""
184
## self._check_versions(parents)
283
185
## self._check_lines(text)
284
new_version = len(self._parents)
287
# if we abort after here the (in-memory) weave will be corrupt because only
288
# some fields are updated
289
self._parents.append(parents[:])
196
delta = self._delta(self.inclusions(parents), text)
198
# offset gives the number of lines that have been inserted
199
# into the weave up to the current point; if the original edit instruction
200
# says to change line A then we actually change (A+offset)
203
for i1, i2, newlines in delta:
206
assert i2 <= len(self._l)
208
# the deletion and insertion are handled separately.
209
# first delete the region.
211
self._l.insert(i1+offset, ('[', idx))
212
self._l.insert(i2+offset+1, (']', idx))
217
# there may have been a deletion spanning up to
218
# i2; we want to insert after this region to make sure
219
# we don't destroy ourselves
221
self._l[i:i] = [('{', idx)] \
224
offset += 2 + len(newlines)
226
self._addversion(parents)
228
# special case; adding with no parents revision; can do this
229
# more quickly by just appending unconditionally
230
self._l.append(('{', idx))
232
self._l.append(('}', idx))
234
self._addversion(None)
290
236
self._sha1s.append(sha1)
291
self._names.append(name)
292
self._name_map[name] = new_version
296
# special case; adding with no parents revision; can do
297
# this more quickly by just appending unconditionally.
298
# even more specially, if we're adding an empty text we
299
# need do nothing at all.
301
self._weave.append(('{', new_version))
302
self._weave.extend(text)
303
self._weave.append(('}', None))
307
if len(parents) == 1:
308
pv = list(parents)[0]
309
if sha1 == self._sha1s[pv]:
310
# special case: same as the single parent
314
ancestors = self.inclusions(parents)
318
# basis a list of (origin, lineno, line)
321
for origin, lineno, line in self._extract(ancestors):
322
basis_lineno.append(lineno)
323
basis_lines.append(line)
325
# another small special case: a merge, producing the same text
327
if text == basis_lines:
330
# add a sentinal, because we can also match against the final line
331
basis_lineno.append(len(self._weave))
333
# XXX: which line of the weave should we really consider
334
# matches the end of the file? the current code says it's the
335
# last line of the weave?
337
#print 'basis_lines:', basis_lines
338
#print 'new_lines: ', lines
340
s = SequenceMatcher(None, basis_lines, text)
342
# offset gives the number of lines that have been inserted
343
# into the weave up to the current point; if the original edit instruction
344
# says to change line A then we actually change (A+offset)
347
for tag, i1, i2, j1, j2 in s.get_opcodes():
348
# i1,i2 are given in offsets within basis_lines; we need to map them
349
# back to offsets within the entire weave
350
#print 'raw match', tag, i1, i2, j1, j2
354
i1 = basis_lineno[i1]
355
i2 = basis_lineno[i2]
357
assert 0 <= j1 <= j2 <= len(text)
359
#print tag, i1, i2, j1, j2
361
# the deletion and insertion are handled separately.
362
# first delete the region.
364
self._weave.insert(i1+offset, ('[', new_version))
365
self._weave.insert(i2+offset+1, (']', new_version))
369
# there may have been a deletion spanning up to
370
# i2; we want to insert after this region to make sure
371
# we don't destroy ourselves
373
self._weave[i:i] = ([('{', new_version)]
376
offset += 2 + (j2 - j1)
380
def add_identical(self, old_rev_id, new_rev_id, parents):
381
"""Add an identical text to old_rev_id as new_rev_id."""
382
old_lines = self.get(self.lookup(old_rev_id))
383
self.add(new_rev_id, parents, old_lines)
385
241
def inclusions(self, versions):
386
"""Return set of all ancestors of given version(s)."""
242
"""Expand out everything included by versions."""
387
243
i = set(versions)
388
for v in xrange(max(versions), 0, -1):
390
# include all its parents
391
i.update(self._parents[v])
248
raise ValueError("version %d not present in weave" % v)
393
## except IndexError:
394
## raise ValueError("version %d not present in weave" % v)
397
def parents(self, version):
398
return self._parents[version]
401
def minimal_parents(self, version):
402
"""Find the minimal set of parents for the version."""
403
included = self._parents[version]
408
li.sort(reverse=True)
416
gotit.update(self.inclusions(pv))
418
assert mininc[0] >= 0
419
assert mininc[-1] < version
252
def _addversion(self, parents):
254
self._v.append(frozenset(parents))
256
self._v.append(frozenset())
424
259
def _check_lines(self, text):
550
341
raise WFE("unclosed deletion blocks at end of weave",
557
def get_iter(self, name_or_index):
345
def get_iter(self, version):
558
346
"""Yield lines for the specified version."""
559
incls = [self.maybe_lookup(name_or_index)]
560
for origin, lineno, line in self._extract(incls):
347
for origin, lineno, line in self._extract(self.inclusions([version])):
564
def get_text(self, name_or_index):
565
return ''.join(self.get_iter(name_or_index))
566
assert isinstance(version, int)
569
def get_lines(self, name_or_index):
570
return list(self.get_iter(name_or_index))
351
def get(self, index):
352
return list(self.get_iter(index))
576
355
def mash_iter(self, included):
577
356
"""Return composed version of multiple included versions."""
578
included = map(self.maybe_lookup, included)
357
included = frozenset(included)
579
358
for origin, lineno, text in self._extract(included):
583
362
def dump(self, to_file):
584
363
from pprint import pprint
585
print >>to_file, "Weave._weave = ",
586
pprint(self._weave, to_file)
587
print >>to_file, "Weave._parents = ",
588
pprint(self._parents, to_file)
364
print >>to_file, "Weave._l = ",
365
pprint(self._l, to_file)
366
print >>to_file, "Weave._v = ",
367
pprint(self._v, to_file)
592
371
def numversions(self):
593
l = len(self._parents)
594
373
assert l == len(self._sha1s)
599
return self.numversions()
602
def check(self, progress_bar=None):
603
378
# check no circular inclusions
604
379
for version in range(self.numversions()):
605
inclusions = list(self._parents[version])
380
inclusions = list(self._v[version])
607
382
inclusions.sort()
608
383
if inclusions[-1] >= version:
666
440
If line1=line2, this is a pure insert; if newlines=[] this is a
667
441
pure delete. (Similar to difflib.)
669
raise NotImplementedError()
672
def plan_merge(self, ver_a, ver_b):
673
"""Return pseudo-annotation indicating how the two versions merge.
675
This is computed between versions a and b and their common
678
Weave lines present in none of them are skipped entirely.
680
inc_a = self.inclusions([ver_a])
681
inc_b = self.inclusions([ver_b])
682
inc_c = inc_a & inc_b
684
for lineno, insert, deleteset, line in self._walk():
685
if deleteset & inc_c:
686
# killed in parent; can't be in either a or b
687
# not relevant to our work
688
yield 'killed-base', line
689
elif insert in inc_c:
690
# was inserted in base
691
killed_a = bool(deleteset & inc_a)
692
killed_b = bool(deleteset & inc_b)
693
if killed_a and killed_b:
694
yield 'killed-both', line
696
yield 'killed-a', line
698
yield 'killed-b', line
700
yield 'unchanged', line
701
elif insert in inc_a:
702
if deleteset & inc_a:
703
yield 'ghost-a', line
707
elif insert in inc_b:
708
if deleteset & inc_b:
709
yield 'ghost-b', line
713
# not in either revision
714
yield 'irrelevant', line
716
yield 'unchanged', '' # terminator
720
def weave_merge(self, plan):
725
for state, line in plan:
726
if state == 'unchanged' or state == 'killed-both':
727
# resync and flush queued conflicts changes if any
728
if not lines_a and not lines_b:
730
elif ch_a and not ch_b:
732
for l in lines_a: yield l
733
elif ch_b and not ch_a:
734
for l in lines_b: yield l
735
elif lines_a == lines_b:
736
for l in lines_a: yield l
739
for l in lines_a: yield l
741
for l in lines_b: yield l
748
if state == 'unchanged':
751
elif state == 'killed-a':
754
elif state == 'killed-b':
757
elif state == 'new-a':
760
elif state == 'new-b':
764
assert state in ('irrelevant', 'ghost-a', 'ghost-b', 'killed-base',
769
def join(self, other):
770
"""Integrate versions from other into this weave.
772
The resulting weave contains all the history of both weaves;
773
any version you could retrieve from either self or other can be
774
retrieved from self after this call.
776
It is illegal for the two weaves to contain different values
779
if other.numversions() == 0:
780
return # nothing to update, easy
781
# work through in index order to make sure we get all dependencies
782
for other_idx, name in enumerate(other._names):
783
# TODO: If all the parents of the other version are already
784
# present then we can avoid some work by just taking the delta
785
# and adjusting the offsets.
786
if self._check_version_consistent(other, other_idx, name):
443
# basis a list of (origin, lineno, line)
446
for origin, lineno, line in self._extract(included):
447
basis_lineno.append(lineno)
448
basis_lines.append(line)
450
# add a sentinal, because we can also match against the final line
451
basis_lineno.append(len(self._l))
453
# XXX: which line of the weave should we really consider
454
# matches the end of the file? the current code says it's the
455
# last line of the weave?
457
from difflib import SequenceMatcher
458
s = SequenceMatcher(None, basis_lines, lines)
460
# TODO: Perhaps return line numbers from composed weave as well?
462
for tag, i1, i2, j1, j2 in s.get_opcodes():
463
##print tag, i1, i2, j1, j2
788
new_parents = self._imported_parents(other, other_idx)
789
lines = other.get_lines(other_idx)
790
sha1 = other._sha1s[other_idx]
791
self.add(name, new_parents, lines, sha1)
794
def _imported_parents(self, other, other_idx):
795
"""Return list of parents in self corresponding to indexes in other."""
797
for parent_idx in other._parents[other_idx]:
798
parent_name = other._names[parent_idx]
799
if parent_name not in self._names:
800
# should not be possible
801
raise WeaveError("missing parent {%s} of {%s} in %r"
802
% (parent_name, other._name_map[other_idx], self))
803
new_parents.append(self._name_map[parent_name])
806
def _check_version_consistent(self, other, other_idx, name):
807
"""Check if a version in consistent in this and other.
809
To be consistent it must have:
812
* the same direct parents (by name, not index, and disregarding
815
If present & correct return True;
816
if not present in self return False;
817
if inconsistent raise error."""
818
this_idx = self._name_map.get(name, -1)
820
if self._sha1s[this_idx] != other._sha1s[other_idx]:
821
raise WeaveError("inconsistent texts for version {%s} "
822
"when joining weaves"
824
self_parents = self._parents[this_idx]
825
other_parents = other._parents[other_idx]
826
n1 = [self._names[i] for i in self_parents]
827
n2 = [other._names[i] for i in other_parents]
831
raise WeaveError("inconsistent parents for version {%s}: "
841
"""Show the weave's table-of-contents"""
842
print '%6s %50s %10s %10s' % ('ver', 'name', 'sha1', 'parents')
843
for i in (6, 50, 10, 10):
846
for i in range(w.numversions()):
849
parent_str = ' '.join(map(str, w._parents[i]))
850
print '%6d %-50.50s %10.10s %s' % (i, name, sha1, parent_str)
854
def weave_stats(weave_file, pb):
855
from bzrlib.weavefile import read_weave
857
wf = file(weave_file, 'rb')
468
# i1,i2 are given in offsets within basis_lines; we need to map them
469
# back to offsets within the entire weave
470
real_i1 = basis_lineno[i1]
471
real_i2 = basis_lineno[i2]
475
assert j2 <= len(lines)
477
yield real_i1, real_i2, lines[j1:j2]
481
def weave_info(filename, out):
482
"""Show some text information about the weave."""
483
from weavefile import read_weave
484
wf = file(filename, 'rb')
858
485
w = read_weave(wf)
859
486
# FIXME: doesn't work on pipes
860
487
weave_size = wf.tell()
488
print >>out, "weave file size %d bytes" % weave_size
489
print >>out, "weave contains %d versions" % len(w._v)
864
for i in range(vers):
865
pb.update('checking sizes', i, vers)
866
for origin, lineno, line in w._extract([i]):
871
print 'versions %9d' % vers
872
print 'weave file %9d bytes' % weave_size
873
print 'total contents %9d bytes' % total
874
print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
877
print 'average size %9d bytes' % avg
878
print 'relative size %9.2fx' % (float(weave_size) / float(avg))
492
print '%6s %6s %8s %40s %20s' % ('ver', 'lines', 'bytes', 'sha1', 'parents')
493
for i in (6, 6, 8, 40, 20):
496
for i in range(len(w._v)):
499
bytes = sum((len(a) for a in text))
501
print '%6d %6d %8d %40s' % (i, lines, bytes, sha1),
502
print ', '.join(map(str, w._v[i]))
505
print >>out, "versions total %d bytes" % total
506
print >>out, "compression ratio %.3f" % (float(total)/float(weave_size))