3
# Copyright (C) 2005 Canonical Ltd
5
# This program is free software; you can redistribute it and/or modify
6
# it under the terms of the GNU General Public License as published by
7
# the Free Software Foundation; either version 2 of the License, or
8
# (at your option) any later version.
10
# This program is distributed in the hope that it will be useful,
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
# GNU General Public License for more details.
15
# You should have received a copy of the GNU General Public License
16
# along with this program; if not, write to the Free Software
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
# Author: Martin Pool <mbp@canonical.com>
22
"""Weave - storage of related text file versions"""
25
# XXX: If we do weaves this way, will a merge still behave the same
26
# way if it's done in a different order? That's a pretty desirable
29
# TODO: Nothing here so far assumes the lines are really \n newlines,
30
# rather than being split up in some other way. We could accommodate
31
# binaries, perhaps by naively splitting on \n or perhaps using
32
# something like a rolling checksum.
34
# TODO: End marker for each version so we can stop reading?
36
# TODO: Check that no insertion occurs inside a deletion that was
37
# 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: Probably 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: Reweave can possibly be made faster by remembering diffs
61
# where the basis and destination are unchanged.
63
# 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
66
# be done fairly efficiently because the sequence numbers constrain
67
# the possible relationships.
69
# FIXME: the conflict markers should be *7* characters
72
from cStringIO import StringIO
81
from bzrlib.trace import mutter
82
from bzrlib.errors import (WeaveError, WeaveFormatError, WeaveParentMismatch,
83
RevisionAlreadyPresent,
85
WeaveRevisionAlreadyPresent,
86
WeaveRevisionNotPresent,
88
import bzrlib.errors as errors
89
from bzrlib.osutils import sha_strings
90
import bzrlib.patiencediff
91
from bzrlib.symbol_versioning import (deprecated_method,
95
from bzrlib.tsort import topo_sort
96
from bzrlib.versionedfile import VersionedFile, InterVersionedFile
97
from bzrlib.weavefile import _read_weave_v5, write_weave_v5
100
class Weave(VersionedFile):
101
"""weave - versioned text file storage.
103
A Weave manages versions of line-based text files, keeping track
104
of the originating version for each line.
106
To clients the "lines" of the file are represented as a list of strings.
107
These strings will typically have terminal newline characters, but
108
this is not required. In particular files commonly do not have a newline
109
at the end of the file.
111
Texts can be identified in either of two ways:
113
* a nonnegative index number.
115
* a version-id string.
117
Typically the index number will be valid only inside this weave and
118
the version-id is used to reference it in the larger world.
120
The weave is represented as a list mixing edit instructions and
121
literal text. Each entry in _weave can be either a string (or
122
unicode), or a tuple. If a string, it means that the given line
123
should be output in the currently active revisions.
125
If a tuple, it gives a processing instruction saying in which
126
revisions the enclosed lines are active. The tuple has the form
127
(instruction, version).
129
The instruction can be '{' or '}' for an insertion block, and '['
130
and ']' for a deletion block respectively. The version is the
131
integer version index. There is no replace operator, only deletes
132
and inserts. For '}', the end of an insertion, there is no
133
version parameter because it always closes the most recently
138
* A later version can delete lines that were introduced by any
139
number of ancestor versions; this implies that deletion
140
instructions can span insertion blocks without regard to the
141
insertion block's nesting.
143
* Similarly, deletions need not be properly nested with regard to
144
each other, because they might have been generated by
145
independent revisions.
147
* Insertions are always made by inserting a new bracketed block
148
into a single point in the previous weave. This implies they
149
can nest but not overlap, and the nesting must always have later
150
insertions on the inside.
152
* It doesn't seem very useful to have an active insertion
153
inside an inactive insertion, but it might happen.
155
* Therefore, all instructions are always"considered"; that
156
is passed onto and off the stack. An outer inactive block
157
doesn't disable an inner block.
159
* Lines are enabled if the most recent enclosing insertion is
160
active and none of the enclosing deletions are active.
162
* There is no point having a deletion directly inside its own
163
insertion; you might as well just not write it. And there
164
should be no way to get an earlier version deleting a later
168
Text of the weave; list of control instruction tuples and strings.
171
List of parents, indexed by version number.
172
It is only necessary to store the minimal set of parents for
173
each version; the parent's parents are implied.
176
List of hex SHA-1 of each version.
179
List of symbolic names for each version. Each should be unique.
182
For each name, the version number.
185
Descriptive name of this weave; typically the filename if known.
189
__slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map',
190
'_weave_name', '_matcher']
192
def __init__(self, weave_name=None, access_mode='w', matcher=None):
193
super(Weave, self).__init__(access_mode)
199
self._weave_name = weave_name
201
self._matcher = bzrlib.patiencediff.PatienceSequenceMatcher
203
self._matcher = matcher
206
return "Weave(%r)" % self._weave_name
209
"""Return a deep copy of self.
211
The copy can be modified without affecting the original weave."""
213
other._weave = self._weave[:]
214
other._parents = self._parents[:]
215
other._sha1s = self._sha1s[:]
216
other._names = self._names[:]
217
other._name_map = self._name_map.copy()
218
other._weave_name = self._weave_name
221
def __eq__(self, other):
222
if not isinstance(other, Weave):
224
return self._parents == other._parents \
225
and self._weave == other._weave \
226
and self._sha1s == other._sha1s
228
def __ne__(self, other):
229
return not self.__eq__(other)
231
@deprecated_method(zero_eight)
232
def idx_to_name(self, index):
233
"""Old public interface, the public interface is all names now."""
236
def _idx_to_name(self, version):
237
return self._names[version]
239
@deprecated_method(zero_eight)
240
def lookup(self, name):
241
"""Backwards compatibility thunk:
243
Return name, as name is valid in the api now, and spew deprecation
248
def _lookup(self, name):
249
"""Convert symbolic version name to index."""
250
self.check_not_reserved_id(name)
252
return self._name_map[name]
254
raise RevisionNotPresent(name, self._weave_name)
256
@deprecated_method(zero_eight)
257
def iter_names(self):
258
"""Deprecated convenience function, please see VersionedFile.names()."""
259
return iter(self.names())
261
@deprecated_method(zero_eight)
263
"""See Weave.versions for the current api."""
264
return self.versions()
267
"""See VersionedFile.versions."""
268
return self._names[:]
270
def has_version(self, version_id):
271
"""See VersionedFile.has_version."""
272
return (version_id in self._name_map)
274
__contains__ = has_version
276
def get_delta(self, version_id):
277
"""See VersionedFile.get_delta."""
278
return self.get_deltas([version_id])[version_id]
280
def get_deltas(self, version_ids):
281
"""See VersionedFile.get_deltas."""
282
version_ids = self.get_ancestry(version_ids)
283
for version_id in version_ids:
284
if not self.has_version(version_id):
285
raise RevisionNotPresent(version_id, self)
286
# try extracting all versions; parallel extraction is used
287
nv = self.num_versions()
293
last_parent_lines = {}
295
parent_inclusions = {}
300
# its simplest to generate a full set of prepared variables.
302
name = self._names[i]
303
sha1s[name] = self.get_sha1(name)
304
parents_list = self.get_parents(name)
306
parent = parents_list[0]
307
parents[name] = parent
308
parent_inclusions[name] = inclusions[parent]
311
parent_inclusions[name] = set()
312
# we want to emit start, finish, replacement_length, replacement_lines tuples.
313
diff_hunks[name] = []
314
current_hunks[name] = [0, 0, 0, []] # #start, finish, repl_length, repl_tuples
315
parent_linenums[name] = 0
317
parent_noeols[name] = False
318
last_parent_lines[name] = None
319
new_inc = set([name])
320
for p in self._parents[i]:
321
new_inc.update(inclusions[self._idx_to_name(p)])
322
# debug only, known good so far.
323
#assert set(new_inc) == set(self.get_ancestry(name)), \
324
# 'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
325
inclusions[name] = new_inc
327
nlines = len(self._weave)
329
for lineno, inserted, deletes, line in self._walk_internal():
330
# a line is active in a version if:
331
# insert is in the versions inclusions
333
# deleteset & the versions inclusions is an empty set.
334
# so - if we have a included by mapping - version is included by
335
# children, we get a list of children to examine for deletes affect
336
# ing them, which is less than the entire set of children.
337
for version_id in version_ids:
338
# The active inclusion must be an ancestor,
339
# and no ancestors must have deleted this line,
340
# because we don't support resurrection.
341
parent_inclusion = parent_inclusions[version_id]
342
inclusion = inclusions[version_id]
343
parent_active = inserted in parent_inclusion and not (deletes & parent_inclusion)
344
version_active = inserted in inclusion and not (deletes & inclusion)
345
if not parent_active and not version_active:
346
# unrelated line of ancestry
348
elif parent_active and version_active:
350
parent_linenum = parent_linenums[version_id]
351
if current_hunks[version_id] != [parent_linenum, parent_linenum, 0, []]:
352
diff_hunks[version_id].append(tuple(current_hunks[version_id]))
354
current_hunks[version_id] = [parent_linenum, parent_linenum, 0, []]
355
parent_linenums[version_id] = parent_linenum
358
noeols[version_id] = True
361
elif parent_active and not version_active:
363
current_hunks[version_id][1] += 1
364
parent_linenums[version_id] += 1
365
last_parent_lines[version_id] = line
366
elif not parent_active and version_active:
368
# noeol only occurs at the end of a file because we
369
# diff linewise. We want to show noeol changes as a
370
# empty diff unless the actual eol-less content changed.
373
if last_parent_lines[version_id][-1] != '\n':
374
parent_noeols[version_id] = True
375
except (TypeError, IndexError):
378
if theline[-1] != '\n':
379
noeols[version_id] = True
383
parent_should_go = False
385
if parent_noeols[version_id] == noeols[version_id]:
386
# no noeol toggle, so trust the weaves statement
387
# that this line is changed.
389
if parent_noeols[version_id]:
390
theline = theline + '\n'
391
elif parent_noeols[version_id]:
392
# parent has no eol, we do:
393
# our line is new, report as such..
395
elif noeols[version_id]:
396
# append a eol so that it looks like
398
theline = theline + '\n'
399
if parents[version_id] is not None:
400
#if last_parent_lines[version_id] is not None:
401
parent_should_go = True
402
if last_parent_lines[version_id] != theline:
405
#parent_should_go = False
407
current_hunks[version_id][2] += 1
408
current_hunks[version_id][3].append((inserted, theline))
410
# last hunk last parent line is not eaten
411
current_hunks[version_id][1] -= 1
412
if current_hunks[version_id][1] < 0:
413
current_hunks[version_id][1] = 0
414
# import pdb;pdb.set_trace()
415
# assert current_hunks[version_id][1] >= 0
419
version = self._idx_to_name(i)
420
if current_hunks[version] != [0, 0, 0, []]:
421
diff_hunks[version].append(tuple(current_hunks[version]))
423
for version_id in version_ids:
424
result[version_id] = (
428
diff_hunks[version_id],
432
def get_parents(self, version_id):
433
"""See VersionedFile.get_parent."""
434
return map(self._idx_to_name, self._parents[self._lookup(version_id)])
436
def _check_repeated_add(self, name, parents, text, sha1):
437
"""Check that a duplicated add is OK.
439
If it is, return the (old) index; otherwise raise an exception.
441
idx = self._lookup(name)
442
if sorted(self._parents[idx]) != sorted(parents) \
443
or sha1 != self._sha1s[idx]:
444
raise RevisionAlreadyPresent(name, self._weave_name)
447
@deprecated_method(zero_eight)
448
def add_identical(self, old_rev_id, new_rev_id, parents):
449
"""Please use Weave.clone_text now."""
450
return self.clone_text(new_rev_id, old_rev_id, parents)
452
def _add_lines(self, version_id, parents, lines, parent_texts):
453
"""See VersionedFile.add_lines."""
454
return self._add(version_id, lines, map(self._lookup, parents))
456
@deprecated_method(zero_eight)
457
def add(self, name, parents, text, sha1=None):
458
"""See VersionedFile.add_lines for the non deprecated api."""
459
return self._add(name, text, map(self._maybe_lookup, parents), sha1)
461
def _add(self, version_id, lines, parents, sha1=None):
462
"""Add a single text on top of the weave.
464
Returns the index number of the newly added version.
467
Symbolic name for this version.
468
(Typically the revision-id of the revision that added it.)
471
List or set of direct parent version numbers.
474
Sequence of lines to be added in the new version.
477
assert isinstance(version_id, basestring)
478
self._check_lines_not_unicode(lines)
479
self._check_lines_are_lines(lines)
481
sha1 = sha_strings(lines)
482
if version_id in self._name_map:
483
return self._check_repeated_add(version_id, parents, lines, sha1)
485
self._check_versions(parents)
486
## self._check_lines(lines)
487
new_version = len(self._parents)
489
# if we abort after here the (in-memory) weave will be corrupt because only
490
# some fields are updated
491
# XXX: FIXME implement a succeed-or-fail of the rest of this routine.
492
# - Robert Collins 20060226
493
self._parents.append(parents[:])
494
self._sha1s.append(sha1)
495
self._names.append(version_id)
496
self._name_map[version_id] = new_version
500
# special case; adding with no parents revision; can do
501
# this more quickly by just appending unconditionally.
502
# even more specially, if we're adding an empty text we
503
# need do nothing at all.
505
self._weave.append(('{', new_version))
506
self._weave.extend(lines)
507
self._weave.append(('}', None))
510
if len(parents) == 1:
511
pv = list(parents)[0]
512
if sha1 == self._sha1s[pv]:
513
# special case: same as the single parent
517
ancestors = self._inclusions(parents)
521
# basis a list of (origin, lineno, line)
524
for origin, lineno, line in self._extract(ancestors):
525
basis_lineno.append(lineno)
526
basis_lines.append(line)
528
# another small special case: a merge, producing the same text
530
if lines == basis_lines:
533
# add a sentinel, because we can also match against the final line
534
basis_lineno.append(len(self._weave))
536
# XXX: which line of the weave should we really consider
537
# matches the end of the file? the current code says it's the
538
# last line of the weave?
540
#print 'basis_lines:', basis_lines
541
#print 'new_lines: ', lines
543
s = self._matcher(None, basis_lines, lines)
545
# offset gives the number of lines that have been inserted
546
# into the weave up to the current point; if the original edit instruction
547
# says to change line A then we actually change (A+offset)
550
for tag, i1, i2, j1, j2 in s.get_opcodes():
551
# i1,i2 are given in offsets within basis_lines; we need to map them
552
# back to offsets within the entire weave
553
#print 'raw match', tag, i1, i2, j1, j2
557
i1 = basis_lineno[i1]
558
i2 = basis_lineno[i2]
560
assert 0 <= j1 <= j2 <= len(lines)
562
#print tag, i1, i2, j1, j2
564
# the deletion and insertion are handled separately.
565
# first delete the region.
567
self._weave.insert(i1+offset, ('[', new_version))
568
self._weave.insert(i2+offset+1, (']', new_version))
572
# there may have been a deletion spanning up to
573
# i2; we want to insert after this region to make sure
574
# we don't destroy ourselves
576
self._weave[i:i] = ([('{', new_version)]
579
offset += 2 + (j2 - j1)
582
def _clone_text(self, new_version_id, old_version_id, parents):
583
"""See VersionedFile.clone_text."""
584
old_lines = self.get_text(old_version_id)
585
self.add_lines(new_version_id, parents, old_lines)
587
def _inclusions(self, versions):
588
"""Return set of all ancestors of given version(s)."""
589
if not len(versions):
592
for v in xrange(max(versions), 0, -1):
594
# include all its parents
595
i.update(self._parents[v])
597
## except IndexError:
598
## raise ValueError("version %d not present in weave" % v)
600
@deprecated_method(zero_eight)
601
def inclusions(self, version_ids):
602
"""Deprecated - see VersionedFile.get_ancestry for the replacement."""
605
if isinstance(version_ids[0], int):
606
return [self._idx_to_name(v) for v in self._inclusions(version_ids)]
608
return self.get_ancestry(version_ids)
610
def get_ancestry(self, version_ids):
611
"""See VersionedFile.get_ancestry."""
612
if isinstance(version_ids, basestring):
613
version_ids = [version_ids]
614
i = self._inclusions([self._lookup(v) for v in version_ids])
615
return [self._idx_to_name(v) for v in i]
617
def _check_lines(self, text):
618
if not isinstance(text, list):
619
raise ValueError("text should be a list, not %s" % type(text))
622
if not isinstance(l, basestring):
623
raise ValueError("text line should be a string or unicode, not %s"
628
def _check_versions(self, indexes):
629
"""Check everything in the sequence of indexes is valid"""
634
raise IndexError("invalid version number %r" % i)
636
def _compatible_parents(self, my_parents, other_parents):
637
"""During join check that other_parents are joinable with my_parents.
639
Joinable is defined as 'is a subset of' - supersets may require
640
regeneration of diffs, but subsets do not.
642
return len(other_parents.difference(my_parents)) == 0
644
def annotate(self, version_id):
645
if isinstance(version_id, int):
646
warnings.warn('Weave.annotate(int) is deprecated. Please use version names'
647
' in all circumstances as of 0.8',
652
for origin, lineno, text in self._extract([version_id]):
653
result.append((origin, text))
656
return super(Weave, self).annotate(version_id)
658
def annotate_iter(self, version_id):
659
"""Yield list of (version-id, line) pairs for the specified version.
661
The index indicates when the line originated in the weave."""
662
incls = [self._lookup(version_id)]
663
for origin, lineno, text in self._extract(incls):
664
yield self._idx_to_name(origin), text
666
@deprecated_method(zero_eight)
668
"""_walk has become visit, a supported api."""
669
return self._walk_internal()
671
def iter_lines_added_or_present_in_versions(self, version_ids=None,
673
"""See VersionedFile.iter_lines_added_or_present_in_versions()."""
674
if version_ids is None:
675
version_ids = self.versions()
676
version_ids = set(version_ids)
677
for lineno, inserted, deletes, line in self._walk_internal(version_ids):
678
# if inserted not in version_ids then it was inserted before the
679
# versions we care about, but because weaves cannot represent ghosts
680
# properly, we do not filter down to that
681
# if inserted not in version_ids: continue
687
#@deprecated_method(zero_eight)
688
def walk(self, version_ids=None):
689
"""See VersionedFile.walk."""
690
return self._walk_internal(version_ids)
692
def _walk_internal(self, version_ids=None):
693
"""Helper method for weave actions."""
698
lineno = 0 # line of weave, 0-based
700
for l in self._weave:
701
if l.__class__ == tuple:
705
istack.append(self._names[v])
709
assert self._names[v] not in dset
710
dset.add(self._names[v])
712
dset.remove(self._names[v])
714
raise WeaveFormatError('unexpected instruction %r' % v)
716
assert l.__class__ in (str, unicode)
718
yield lineno, istack[-1], frozenset(dset), l
722
raise WeaveFormatError("unclosed insertion blocks "
723
"at end of weave: %s" % istack)
725
raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
728
def plan_merge(self, ver_a, ver_b):
729
"""Return pseudo-annotation indicating how the two versions merge.
731
This is computed between versions a and b and their common
734
Weave lines present in none of them are skipped entirely.
736
inc_a = set(self.get_ancestry([ver_a]))
737
inc_b = set(self.get_ancestry([ver_b]))
738
inc_c = inc_a & inc_b
740
for lineno, insert, deleteset, line in\
741
self.walk([ver_a, ver_b]):
742
if deleteset & inc_c:
743
# killed in parent; can't be in either a or b
744
# not relevant to our work
745
yield 'killed-base', line
746
elif insert in inc_c:
747
# was inserted in base
748
killed_a = bool(deleteset & inc_a)
749
killed_b = bool(deleteset & inc_b)
750
if killed_a and killed_b:
751
yield 'killed-both', line
753
yield 'killed-a', line
755
yield 'killed-b', line
757
yield 'unchanged', line
758
elif insert in inc_a:
759
if deleteset & inc_a:
760
yield 'ghost-a', line
764
elif insert in inc_b:
765
if deleteset & inc_b:
766
yield 'ghost-b', line
770
# not in either revision
771
yield 'irrelevant', line
773
yield 'unchanged', '' # terminator
775
def _extract(self, versions):
776
"""Yield annotation of lines in included set.
778
Yields a sequence of tuples (origin, lineno, text), where
779
origin is the origin version, lineno the index in the weave,
780
and text the text of the line.
782
The set typically but not necessarily corresponds to a version.
785
if not isinstance(i, int):
788
included = self._inclusions(versions)
794
lineno = 0 # line of weave, 0-based
800
WFE = WeaveFormatError
803
# 449 0 4474.6820 2356.5590 bzrlib.weave:556(_extract)
804
# +285282 0 1676.8040 1676.8040 +<isinstance>
805
# 1.6 seconds in 'isinstance'.
806
# changing the first isinstance:
807
# 449 0 2814.2660 1577.1760 bzrlib.weave:556(_extract)
808
# +140414 0 762.8050 762.8050 +<isinstance>
809
# note that the inline time actually dropped (less function calls)
810
# and total processing time was halved.
811
# we're still spending ~1/4 of the method in isinstance though.
812
# so lets hard code the acceptable string classes we expect:
813
# 449 0 1202.9420 786.2930 bzrlib.weave:556(_extract)
814
# +71352 0 377.5560 377.5560 +<method 'append' of 'list'
816
# yay, down to ~1/4 the initial extract time, and our inline time
817
# has shrunk again, with isinstance no longer dominating.
818
# tweaking the stack inclusion test to use a set gives:
819
# 449 0 1122.8030 713.0080 bzrlib.weave:556(_extract)
820
# +71352 0 354.9980 354.9980 +<method 'append' of 'list'
822
# - a 5% win, or possibly just noise. However with large istacks that
823
# 'in' test could dominate, so I'm leaving this change in place -
824
# when its fast enough to consider profiling big datasets we can review.
829
for l in self._weave:
830
if l.__class__ == tuple:
838
iset.remove(istack.pop())
849
assert l.__class__ in (str, unicode)
851
isactive = (not dset) and istack and (istack[-1] in included)
853
result.append((istack[-1], lineno, l))
856
raise WeaveFormatError("unclosed insertion blocks "
857
"at end of weave: %s" % istack)
859
raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
863
@deprecated_method(zero_eight)
864
def get_iter(self, name_or_index):
865
"""Deprecated, please do not use. Lookups are not not needed.
867
Please use get_lines now.
869
return iter(self.get_lines(self._maybe_lookup(name_or_index)))
871
@deprecated_method(zero_eight)
872
def maybe_lookup(self, name_or_index):
873
"""Deprecated, please do not use. Lookups are not not needed."""
874
return self._maybe_lookup(name_or_index)
876
def _maybe_lookup(self, name_or_index):
877
"""Convert possible symbolic name to index, or pass through indexes.
881
if isinstance(name_or_index, (int, long)):
884
return self._lookup(name_or_index)
886
@deprecated_method(zero_eight)
887
def get(self, version_id):
888
"""Please use either Weave.get_text or Weave.get_lines as desired."""
889
return self.get_lines(version_id)
891
def get_lines(self, version_id):
892
"""See VersionedFile.get_lines()."""
893
int_index = self._maybe_lookup(version_id)
894
result = [line for (origin, lineno, line) in self._extract([int_index])]
895
expected_sha1 = self._sha1s[int_index]
896
measured_sha1 = sha_strings(result)
897
if measured_sha1 != expected_sha1:
898
raise errors.WeaveInvalidChecksum(
899
'file %s, revision %s, expected: %s, measured %s'
900
% (self._weave_name, version_id,
901
expected_sha1, measured_sha1))
904
def get_sha1(self, version_id):
905
"""See VersionedFile.get_sha1()."""
906
return self._sha1s[self._lookup(version_id)]
908
@deprecated_method(zero_eight)
909
def numversions(self):
910
"""How many versions are in this weave?
912
Deprecated in favour of num_versions.
914
return self.num_versions()
916
def num_versions(self):
917
"""How many versions are in this weave?"""
918
l = len(self._parents)
919
assert l == len(self._sha1s)
922
__len__ = num_versions
924
def check(self, progress_bar=None):
925
# TODO evaluate performance hit of using string sets in this routine.
926
# TODO: check no circular inclusions
927
# TODO: create a nested progress bar
928
for version in range(self.num_versions()):
929
inclusions = list(self._parents[version])
932
if inclusions[-1] >= version:
933
raise WeaveFormatError("invalid included version %d for index %d"
934
% (inclusions[-1], version))
936
# try extracting all versions; parallel extraction is used
937
nv = self.num_versions()
942
# For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
943
# The problem is that set membership is much more expensive
944
name = self._idx_to_name(i)
945
sha1s[name] = sha.new()
947
new_inc = set([name])
948
for p in self._parents[i]:
949
new_inc.update(inclusions[self._idx_to_name(p)])
951
assert set(new_inc) == set(self.get_ancestry(name)), \
952
'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
953
inclusions[name] = new_inc
955
nlines = len(self._weave)
957
update_text = 'checking weave'
959
short_name = os.path.basename(self._weave_name)
960
update_text = 'checking %s' % (short_name,)
961
update_text = update_text[:25]
963
for lineno, insert, deleteset, line in self._walk_internal():
965
progress_bar.update(update_text, lineno, nlines)
967
for name, name_inclusions in inclusions.items():
968
# The active inclusion must be an ancestor,
969
# and no ancestors must have deleted this line,
970
# because we don't support resurrection.
971
if (insert in name_inclusions) and not (deleteset & name_inclusions):
972
sha1s[name].update(line)
975
version = self._idx_to_name(i)
976
hd = sha1s[version].hexdigest()
977
expected = self._sha1s[i]
979
raise errors.WeaveInvalidChecksum(
980
"mismatched sha1 for version %s: "
981
"got %s, expected %s"
982
% (version, hd, expected))
984
# TODO: check insertions are properly nested, that there are
985
# no lines outside of insertion blocks, that deletions are
986
# properly paired, etc.
988
def _join(self, other, pb, msg, version_ids, ignore_missing):
989
"""Worker routine for join()."""
990
if not other.versions():
991
return # nothing to update, easy
994
# versions is never none, InterWeave checks this.
997
# two loops so that we do not change ourselves before verifying it
999
# work through in index order to make sure we get all dependencies
1002
# get the selected versions only that are in other.versions.
1003
version_ids = set(other.versions()).intersection(set(version_ids))
1004
# pull in the referenced graph.
1005
version_ids = other.get_ancestry(version_ids)
1006
pending_graph = [(version, other.get_parents(version)) for
1007
version in version_ids]
1008
for name in topo_sort(pending_graph):
1009
other_idx = other._name_map[name]
1010
# returns True if we have it, False if we need it.
1011
if not self._check_version_consistent(other, other_idx, name):
1012
names_to_join.append((other_idx, name))
1021
for other_idx, name in names_to_join:
1022
# TODO: If all the parents of the other version are already
1023
# present then we can avoid some work by just taking the delta
1024
# and adjusting the offsets.
1025
new_parents = self._imported_parents(other, other_idx)
1026
sha1 = other._sha1s[other_idx]
1031
pb.update(msg, merged, len(names_to_join))
1033
lines = other.get_lines(other_idx)
1034
self._add(name, lines, new_parents, sha1)
1036
mutter("merged = %d, processed = %d, file_id=%s; deltat=%d"%(
1037
merged, processed, self._weave_name, time.time()-time0))
1039
def _imported_parents(self, other, other_idx):
1040
"""Return list of parents in self corresponding to indexes in other."""
1042
for parent_idx in other._parents[other_idx]:
1043
parent_name = other._names[parent_idx]
1044
if parent_name not in self._name_map:
1045
# should not be possible
1046
raise WeaveError("missing parent {%s} of {%s} in %r"
1047
% (parent_name, other._name_map[other_idx], self))
1048
new_parents.append(self._name_map[parent_name])
1051
def _check_version_consistent(self, other, other_idx, name):
1052
"""Check if a version in consistent in this and other.
1054
To be consistent it must have:
1057
* the same direct parents (by name, not index, and disregarding
1060
If present & correct return True;
1061
if not present in self return False;
1062
if inconsistent raise error."""
1063
this_idx = self._name_map.get(name, -1)
1065
if self._sha1s[this_idx] != other._sha1s[other_idx]:
1066
raise errors.WeaveTextDiffers(name, self, other)
1067
self_parents = self._parents[this_idx]
1068
other_parents = other._parents[other_idx]
1069
n1 = set([self._names[i] for i in self_parents])
1070
n2 = set([other._names[i] for i in other_parents])
1071
if not self._compatible_parents(n1, n2):
1072
raise WeaveParentMismatch("inconsistent parents "
1073
"for version {%s}: %s vs %s" % (name, n1, n2))
1079
@deprecated_method(zero_eight)
1080
def reweave(self, other, pb=None, msg=None):
1081
"""reweave has been superseded by plain use of join."""
1082
return self.join(other, pb, msg)
1084
def _reweave(self, other, pb, msg):
1085
"""Reweave self with other - internal helper for join().
1087
:param other: The other weave to merge
1088
:param pb: An optional progress bar, indicating how far done we are
1089
:param msg: An optional message for the progress
1091
new_weave = _reweave(self, other, pb=pb, msg=msg)
1092
self._copy_weave_content(new_weave)
1094
def _copy_weave_content(self, otherweave):
1095
"""adsorb the content from otherweave."""
1096
for attr in self.__slots__:
1097
if attr != '_weave_name':
1098
setattr(self, attr, copy(getattr(otherweave, attr)))
1101
class WeaveFile(Weave):
1102
"""A WeaveFile represents a Weave on disk and writes on change."""
1104
WEAVE_SUFFIX = '.weave'
1106
def __init__(self, name, transport, filemode=None, create=False, access_mode='w'):
1107
"""Create a WeaveFile.
1109
:param create: If not True, only open an existing knit.
1111
super(WeaveFile, self).__init__(name, access_mode)
1112
self._transport = transport
1113
self._filemode = filemode
1115
_read_weave_v5(self._transport.get(name + WeaveFile.WEAVE_SUFFIX), self)
1116
except errors.NoSuchFile:
1122
def _add_lines(self, version_id, parents, lines, parent_texts):
1123
"""Add a version and save the weave."""
1124
self.check_not_reserved_id(version_id)
1125
result = super(WeaveFile, self)._add_lines(version_id, parents, lines,
1130
def _clone_text(self, new_version_id, old_version_id, parents):
1131
"""See VersionedFile.clone_text."""
1132
super(WeaveFile, self)._clone_text(new_version_id, old_version_id, parents)
1135
def copy_to(self, name, transport):
1136
"""See VersionedFile.copy_to()."""
1137
# as we are all in memory always, just serialise to the new place.
1139
write_weave_v5(self, sio)
1141
transport.put_file(name + WeaveFile.WEAVE_SUFFIX, sio, self._filemode)
1143
def create_empty(self, name, transport, filemode=None):
1144
return WeaveFile(name, transport, filemode, create=True)
1147
"""Save the weave."""
1148
self._check_write_ok()
1150
write_weave_v5(self, sio)
1152
self._transport.put_file(self._weave_name + WeaveFile.WEAVE_SUFFIX,
1158
"""See VersionedFile.get_suffixes()."""
1159
return [WeaveFile.WEAVE_SUFFIX]
1161
def join(self, other, pb=None, msg=None, version_ids=None,
1162
ignore_missing=False):
1163
"""Join other into self and save."""
1164
super(WeaveFile, self).join(other, pb, msg, version_ids, ignore_missing)
1168
@deprecated_function(zero_eight)
1169
def reweave(wa, wb, pb=None, msg=None):
1170
"""reweaving is deprecation, please just use weave.join()."""
1171
_reweave(wa, wb, pb, msg)
1173
def _reweave(wa, wb, pb=None, msg=None):
1174
"""Combine two weaves and return the result.
1176
This works even if a revision R has different parents in
1177
wa and wb. In the resulting weave all the parents are given.
1179
This is done by just building up a new weave, maintaining ordering
1180
of the versions in the two inputs. More efficient approaches
1181
might be possible but it should only be necessary to do
1182
this operation rarely, when a new previously ghost version is
1185
:param pb: An optional progress bar, indicating how far done we are
1186
:param msg: An optional message for the progress
1190
queue_a = range(wa.num_versions())
1191
queue_b = range(wb.num_versions())
1192
# first determine combined parents of all versions
1193
# map from version name -> all parent names
1194
combined_parents = _reweave_parent_graphs(wa, wb)
1195
mutter("combined parents: %r", combined_parents)
1196
order = topo_sort(combined_parents.iteritems())
1197
mutter("order to reweave: %r", order)
1202
for idx, name in enumerate(order):
1204
pb.update(msg, idx, len(order))
1205
if name in wa._name_map:
1206
lines = wa.get_lines(name)
1207
if name in wb._name_map:
1208
lines_b = wb.get_lines(name)
1209
if lines != lines_b:
1210
mutter('Weaves differ on content. rev_id {%s}', name)
1211
mutter('weaves: %s, %s', wa._weave_name, wb._weave_name)
1213
lines = list(difflib.unified_diff(lines, lines_b,
1214
wa._weave_name, wb._weave_name))
1215
mutter('lines:\n%s', ''.join(lines))
1216
raise errors.WeaveTextDiffers(name, wa, wb)
1218
lines = wb.get_lines(name)
1219
wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
1222
def _reweave_parent_graphs(wa, wb):
1223
"""Return combined parent ancestry for two weaves.
1225
Returned as a list of (version_name, set(parent_names))"""
1227
for weave in [wa, wb]:
1228
for idx, name in enumerate(weave._names):
1229
p = combined.setdefault(name, set())
1230
p.update(map(weave._idx_to_name, weave._parents[idx]))
1235
"""Show the weave's table-of-contents"""
1236
print '%6s %50s %10s %10s' % ('ver', 'name', 'sha1', 'parents')
1237
for i in (6, 50, 10, 10):
1240
for i in range(w.num_versions()):
1243
parent_str = ' '.join(map(str, w._parents[i]))
1244
print '%6d %-50.50s %10.10s %s' % (i, name, sha1, parent_str)
1248
def weave_stats(weave_file, pb):
1249
from bzrlib.weavefile import read_weave
1251
wf = file(weave_file, 'rb')
1253
# FIXME: doesn't work on pipes
1254
weave_size = wf.tell()
1258
for i in range(vers):
1259
pb.update('checking sizes', i, vers)
1260
for origin, lineno, line in w._extract([i]):
1265
print 'versions %9d' % vers
1266
print 'weave file %9d bytes' % weave_size
1267
print 'total contents %9d bytes' % total
1268
print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
1271
print 'average size %9d bytes' % avg
1272
print 'relative size %9.2fx' % (float(weave_size) / float(avg))
1276
print """bzr weave tool
1278
Experimental tool for weave algorithm.
1281
weave init WEAVEFILE
1282
Create an empty weave file
1283
weave get WEAVEFILE VERSION
1284
Write out specified version.
1285
weave check WEAVEFILE
1286
Check consistency of all versions.
1288
Display table of contents.
1289
weave add WEAVEFILE NAME [BASE...] < NEWTEXT
1290
Add NEWTEXT, with specified parent versions.
1291
weave annotate WEAVEFILE VERSION
1292
Display origin of each line.
1293
weave merge WEAVEFILE VERSION1 VERSION2 > OUT
1294
Auto-merge two versions and display conflicts.
1295
weave diff WEAVEFILE VERSION1 VERSION2
1296
Show differences between two versions.
1300
% weave init foo.weave
1302
% weave add foo.weave ver0 < foo.txt
1305
(create updated version)
1307
% weave get foo.weave 0 | diff -u - foo.txt
1308
% weave add foo.weave ver1 0 < foo.txt
1311
% weave get foo.weave 0 > foo.txt (create forked version)
1313
% weave add foo.weave ver2 0 < foo.txt
1316
% weave merge foo.weave 1 2 > foo.txt (merge them)
1317
% vi foo.txt (resolve conflicts)
1318
% weave add foo.weave merged 1 2 < foo.txt (commit merged version)
1330
# in case we're run directly from the subdirectory
1331
sys.path.append('..')
1333
from bzrlib.weavefile import write_weave, read_weave
1334
from bzrlib.progress import ProgressBar
1349
return read_weave(file(argv[2], 'rb'))
1355
# at the moment, based on everything in the file
1357
parents = map(int, argv[4:])
1358
lines = sys.stdin.readlines()
1359
ver = w.add(name, parents, lines)
1360
write_weave(w, file(argv[2], 'wb'))
1361
print 'added version %r %d' % (name, ver)
1364
if os.path.exists(fn):
1365
raise IOError("file exists")
1367
write_weave(w, file(fn, 'wb'))
1368
elif cmd == 'get': # get one version
1370
sys.stdout.writelines(w.get_iter(int(argv[3])))
1375
v1, v2 = map(int, argv[3:5])
1378
diff_gen = bzrlib.patiencediff.unified_diff(lines1, lines2,
1379
'%s version %d' % (fn, v1),
1380
'%s version %d' % (fn, v2))
1381
sys.stdout.writelines(diff_gen)
1383
elif cmd == 'annotate':
1385
# newline is added to all lines regardless; too hard to get
1386
# reasonable formatting otherwise
1388
for origin, text in w.annotate(int(argv[3])):
1389
text = text.rstrip('\r\n')
1391
print ' | %s' % (text)
1393
print '%5d | %s' % (origin, text)
1399
elif cmd == 'stats':
1400
weave_stats(argv[2], ProgressBar())
1402
elif cmd == 'check':
1407
print '%d versions ok' % w.num_versions()
1409
elif cmd == 'inclusions':
1411
print ' '.join(map(str, w.inclusions([int(argv[3])])))
1413
elif cmd == 'parents':
1415
print ' '.join(map(str, w._parents[int(argv[3])]))
1417
elif cmd == 'plan-merge':
1418
# replaced by 'bzr weave-plan-merge'
1420
for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
1422
print '%14s | %s' % (state, line),
1423
elif cmd == 'merge':
1424
# replaced by 'bzr weave-merge-text'
1426
p = w.plan_merge(int(argv[3]), int(argv[4]))
1427
sys.stdout.writelines(w.weave_merge(p))
1429
raise ValueError('unknown command %r' % cmd)
1432
if __name__ == '__main__':
1434
sys.exit(main(sys.argv))
1437
class InterWeave(InterVersionedFile):
1438
"""Optimised code paths for weave to weave operations."""
1440
_matching_file_from_factory = staticmethod(WeaveFile)
1441
_matching_file_to_factory = staticmethod(WeaveFile)
1444
def is_compatible(source, target):
1445
"""Be compatible with weaves."""
1447
return (isinstance(source, Weave) and
1448
isinstance(target, Weave))
1449
except AttributeError:
1452
def join(self, pb=None, msg=None, version_ids=None, ignore_missing=False):
1453
"""See InterVersionedFile.join."""
1454
version_ids = self._get_source_version_ids(version_ids, ignore_missing)
1455
if self.target.versions() == [] and version_ids is None:
1456
self.target._copy_weave_content(self.source)
1459
self.target._join(self.source, pb, msg, version_ids, ignore_missing)
1460
except errors.WeaveParentMismatch:
1461
self.target._reweave(self.source, pb, msg)
1464
InterVersionedFile.register_optimiser(InterWeave)
added
removed
bzrlib/weave.py
