199
210
return self._parents == other._parents \
200
211
and self._weave == other._weave \
201
212
and self._sha1s == other._sha1s
204
214
def __ne__(self, other):
205
215
return not self.__eq__(other)
217
@deprecated_method(zero_eight)
218
def idx_to_name(self, index):
219
"""Old public interface, the public interface is all names now."""
222
def _idx_to_name(self, version):
223
return self._names[version]
225
@deprecated_method(zero_eight)
208
226
def lookup(self, name):
227
"""Backwards compatability thunk:
229
Return name, as name is valid in the api now, and spew deprecation
234
def _lookup(self, name):
235
"""Convert symbolic version name to index."""
210
237
return self._name_map[name]
212
raise WeaveError("name %s not present in weave" % name)
215
def add(self, name, parents, text):
239
raise RevisionNotPresent(name, self._weave_name)
241
@deprecated_method(zero_eight)
242
def iter_names(self):
243
"""Deprecated convenience function, please see VersionedFile.names()."""
244
return iter(self.names())
246
@deprecated_method(zero_eight)
248
"""See Weave.versions for the current api."""
249
return self.versions()
252
"""See VersionedFile.versions."""
253
return self._names[:]
255
def has_version(self, version_id):
256
"""See VersionedFile.has_version."""
257
return self._name_map.has_key(version_id)
259
__contains__ = has_version
261
def get_parents(self, version_id):
262
"""See VersionedFile.get_parent."""
263
return map(self._idx_to_name, self._parents[self._lookup(version_id)])
265
def _check_repeated_add(self, name, parents, text, sha1):
266
"""Check that a duplicated add is OK.
268
If it is, return the (old) index; otherwise raise an exception.
270
idx = self._lookup(name)
271
if sorted(self._parents[idx]) != sorted(parents) \
272
or sha1 != self._sha1s[idx]:
273
raise RevisionAlreadyPresent(name, self._weave_name)
276
@deprecated_method(zero_eight)
277
def add_identical(self, old_rev_id, new_rev_id, parents):
278
"""Please use Weave.clone_text now."""
279
return self.clone_text(new_rev_id, old_rev_id, parents)
281
def add_lines(self, version_id, parents, lines):
282
"""See VersionedFile.add_lines."""
283
return self._add(version_id, lines, map(self._lookup, parents))
285
@deprecated_method(zero_eight)
286
def add(self, name, parents, text, sha1=None):
287
"""See VersionedFile.add_lines for the non deprecated api."""
288
return self._add(name, text, map(self._maybe_lookup, parents), sha1)
290
def _add(self, version_id, lines, parents, sha1=None):
216
291
"""Add a single text on top of the weave.
218
293
Returns the index number of the newly added version.
221
296
Symbolic name for this version.
222
297
(Typically the revision-id of the revision that added it.)
225
300
List or set of direct parent version numbers.
228
Sequence of lines to be added in the new version."""
230
assert isinstance(name, basestring)
231
if name in self._name_map:
232
raise WeaveError("name %r already present in weave" % name)
303
Sequence of lines to be added in the new version.
306
assert isinstance(version_id, basestring)
308
sha1 = sha_strings(lines)
309
if version_id in self._name_map:
310
return self._check_repeated_add(version_id, parents, lines, sha1)
234
312
self._check_versions(parents)
235
## self._check_lines(text)
313
## self._check_lines(lines)
236
314
new_version = len(self._parents)
243
316
# if we abort after here the (in-memory) weave will be corrupt because only
244
317
# some fields are updated
245
318
self._parents.append(parents[:])
246
319
self._sha1s.append(sha1)
247
self._names.append(name)
248
self._name_map[name] = new_version
320
self._names.append(version_id)
321
self._name_map[version_id] = new_version
490
571
result.append((istack[-1], lineno, l))
494
raise WFE("unclosed insertion blocks at end of weave",
574
raise WeaveFormatError("unclosed insertion blocks "
575
"at end of weave: %s" % istack)
497
raise WFE("unclosed deletion blocks at end of weave",
577
raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
504
def get_iter(self, version):
581
@deprecated_method(zero_eight)
582
def get_iter(self, name_or_index):
583
"""Deprecated, please do not use. Lookups are not not needed.
585
Please use get_lines now.
587
return self._get_iter(self._maybe_lookup(name_or_index))
589
@deprecated_method(zero_eight)
590
def maybe_lookup(self, name_or_index):
591
"""Deprecated, please do not use. Lookups are not not needed."""
592
return self._maybe_lookup(name_or_index)
594
def _maybe_lookup(self, name_or_index):
595
"""Convert possible symbolic name to index, or pass through indexes.
599
if isinstance(name_or_index, (int, long)):
602
return self._lookup(name_or_index)
604
def _get_iter(self, version_id):
505
605
"""Yield lines for the specified version."""
506
for origin, lineno, line in self._extract([version]):
606
incls = [self._maybe_lookup(version_id)]
611
# We don't have sha1 sums for multiple entries
613
for origin, lineno, line in self._extract(incls):
510
def get(self, index):
511
return list(self.get_iter(index))
514
def mash_iter(self, included):
515
"""Return composed version of multiple included versions."""
516
for origin, lineno, text in self._extract(included):
520
def dump(self, to_file):
521
from pprint import pprint
522
print >>to_file, "Weave._weave = ",
523
pprint(self._weave, to_file)
524
print >>to_file, "Weave._parents = ",
525
pprint(self._parents, to_file)
618
expected_sha1 = self._sha1s[index]
619
measured_sha1 = cur_sha.hexdigest()
620
if measured_sha1 != expected_sha1:
621
raise errors.WeaveInvalidChecksum(
622
'file %s, revision %s, expected: %s, measured %s'
623
% (self._weave_name, self._names[index],
624
expected_sha1, measured_sha1))
626
@deprecated_method(zero_eight)
627
def get(self, version_id):
628
"""Please use either Weave.get_text or Weave.get_lines as desired."""
629
return self.get_lines(version_id)
631
def get_lines(self, version_id):
632
"""See VersionedFile.get_lines()."""
633
return list(self._get_iter(version_id))
635
def get_sha1(self, name):
636
"""Get the stored sha1 sum for the given revision.
638
:param name: The name of the version to lookup
640
return self._sha1s[self._lookup(name)]
529
642
def numversions(self):
530
643
l = len(self._parents)
531
644
assert l == len(self._sha1s)
536
return self.numversions()
647
__len__ = numversions
539
649
def check(self, progress_bar=None):
650
# TODO evaluate performance hit of using string sets in this routine.
540
651
# check no circular inclusions
541
652
for version in range(self.numversions()):
542
653
inclusions = list(self._parents[version])
546
657
raise WeaveFormatError("invalid included version %d for index %d"
547
658
% (inclusions[-1], version))
549
# try extracting all versions; this is a bit slow and parallel
550
# extraction could be used
660
# try extracting all versions; parallel extraction is used
551
661
nv = self.numversions()
552
for version in range(nv):
666
# For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
667
# The problem is that set membership is much more expensive
668
name = self._idx_to_name(i)
669
sha1s[name] = sha.new()
671
new_inc = set([name])
672
for p in self._parents[i]:
673
new_inc.update(inclusions[self._idx_to_name(p)])
675
assert set(new_inc) == set(self.get_ancestry(name)), \
676
'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
677
inclusions[name] = new_inc
679
nlines = len(self._weave)
681
update_text = 'checking weave'
683
short_name = os.path.basename(self._weave_name)
684
update_text = 'checking %s' % (short_name,)
685
update_text = update_text[:25]
687
for lineno, insert, deleteset, line in self.walk():
554
progress_bar.update('checking text', version, nv)
556
for l in self.get_iter(version):
559
expected = self._sha1s[version]
689
progress_bar.update(update_text, lineno, nlines)
691
for name, name_inclusions in inclusions.items():
692
# The active inclusion must be an ancestor,
693
# and no ancestors must have deleted this line,
694
# because we don't support resurrection.
695
if (insert in name_inclusions) and not (deleteset & name_inclusions):
696
sha1s[name].update(line)
699
version = self._idx_to_name(i)
700
hd = sha1s[version].hexdigest()
701
expected = self._sha1s[i]
560
702
if hd != expected:
561
raise WeaveError("mismatched sha1 for version %d; "
562
"got %s, expected %s"
563
% (version, hd, expected))
703
raise errors.WeaveInvalidChecksum(
704
"mismatched sha1 for version %s: "
705
"got %s, expected %s"
706
% (version, hd, expected))
565
708
# TODO: check insertions are properly nested, that there are
566
709
# no lines outside of insertion blocks, that deletions are
567
710
# properly paired, etc.
571
def merge(self, merge_versions):
572
"""Automerge and mark conflicts between versions.
574
This returns a sequence, each entry describing alternatives
575
for a chunk of the file. Each of the alternatives is given as
578
If there is a chunk of the file where there's no diagreement,
579
only one alternative is given.
582
# approach: find the included versions common to all the
584
raise NotImplementedError()
588
def _delta(self, included, lines):
589
"""Return changes from basis to new revision.
591
The old text for comparison is the union of included revisions.
593
This is used in inserting a new text.
595
Delta is returned as a sequence of
596
(weave1, weave2, newlines).
598
This indicates that weave1:weave2 of the old weave should be
599
replaced by the sequence of lines in newlines. Note that
600
these line numbers are positions in the total weave and don't
601
correspond to the lines in any extracted version, or even the
602
extracted union of included versions.
604
If line1=line2, this is a pure insert; if newlines=[] this is a
605
pure delete. (Similar to difflib.)
610
def plan_merge(self, ver_a, ver_b):
611
"""Return pseudo-annotation indicating how the two versions merge.
613
This is computed between versions a and b and their common
616
Weave lines present in none of them are skipped entirely.
618
inc_a = self.inclusions([ver_a])
619
inc_b = self.inclusions([ver_b])
620
inc_c = inc_a & inc_b
622
for lineno, insert, deleteset, line in self._walk():
623
if deleteset & inc_c:
624
# killed in parent; can't be in either a or b
625
# not relevant to our work
626
yield 'killed-base', line
627
elif insert in inc_c:
628
# was inserted in base
629
killed_a = bool(deleteset & inc_a)
630
killed_b = bool(deleteset & inc_b)
631
if killed_a and killed_b:
632
yield 'killed-both', line
634
yield 'killed-a', line
636
yield 'killed-b', line
638
yield 'unchanged', line
639
elif insert in inc_a:
640
if deleteset & inc_a:
641
yield 'ghost-a', line
645
elif insert in inc_b:
646
if deleteset & inc_b:
647
yield 'ghost-b', line
651
# not in either revision
652
yield 'irrelevant', line
654
yield 'unchanged', '' # terminator
658
def weave_merge(self, plan):
663
for state, line in plan:
664
if state == 'unchanged' or state == 'killed-both':
665
# resync and flush queued conflicts changes if any
666
if not lines_a and not lines_b:
668
elif ch_a and not ch_b:
670
for l in lines_a: yield l
671
elif ch_b and not ch_a:
672
for l in lines_b: yield l
673
elif lines_a == lines_b:
674
for l in lines_a: yield l
677
for l in lines_a: yield l
679
for l in lines_b: yield l
686
if state == 'unchanged':
689
elif state == 'killed-a':
692
elif state == 'killed-b':
695
elif state == 'new-a':
698
elif state == 'new-b':
702
assert state in ('irrelevant', 'ghost-a', 'ghost-b', 'killed-base',
712
def _join(self, other, pb, msg, version_ids):
713
"""Worker routine for join()."""
714
if not other.versions():
715
return # nothing to update, easy
718
for version_id in version_ids:
719
if not self.has_version(version_id):
720
raise RevisionNotPresent(version_id, self._weave_name)
721
assert version_ids == None
723
# two loops so that we do not change ourselves before verifying it
725
# work through in index order to make sure we get all dependencies
728
for other_idx, name in enumerate(other._names):
729
self._check_version_consistent(other, other_idx, name)
730
sha1 = other._sha1s[other_idx]
734
if name in self._name_map:
735
idx = self._lookup(name)
736
n1 = set(map(other._idx_to_name, other._parents[other_idx]))
737
n2 = set(map(self._idx_to_name, self._parents[idx]))
738
if sha1 == self._sha1s[idx] and n1 == n2:
741
names_to_join.append((other_idx, name))
748
for other_idx, name in names_to_join:
749
# TODO: If all the parents of the other version are already
750
# present then we can avoid some work by just taking the delta
751
# and adjusting the offsets.
752
new_parents = self._imported_parents(other, other_idx)
753
sha1 = other._sha1s[other_idx]
758
pb.update(msg, merged, len(names_to_join))
760
lines = other.get_lines(other_idx)
761
self._add(name, lines, new_parents, sha1)
763
mutter("merged = %d, processed = %d, file_id=%s; deltat=%d"%(
764
merged, processed, self._weave_name, time.time()-time0))
766
def _imported_parents(self, other, other_idx):
767
"""Return list of parents in self corresponding to indexes in other."""
769
for parent_idx in other._parents[other_idx]:
770
parent_name = other._names[parent_idx]
771
if parent_name not in self._names:
772
# should not be possible
773
raise WeaveError("missing parent {%s} of {%s} in %r"
774
% (parent_name, other._name_map[other_idx], self))
775
new_parents.append(self._name_map[parent_name])
778
def _check_version_consistent(self, other, other_idx, name):
779
"""Check if a version in consistent in this and other.
781
To be consistent it must have:
784
* the same direct parents (by name, not index, and disregarding
787
If present & correct return True;
788
if not present in self return False;
789
if inconsistent raise error."""
790
this_idx = self._name_map.get(name, -1)
792
if self._sha1s[this_idx] != other._sha1s[other_idx]:
793
raise errors.WeaveTextDiffers(name, self, other)
794
self_parents = self._parents[this_idx]
795
other_parents = other._parents[other_idx]
796
n1 = set([self._names[i] for i in self_parents])
797
n2 = set([other._names[i] for i in other_parents])
799
raise WeaveParentMismatch("inconsistent parents "
800
"for version {%s}: %s vs %s" % (name, n1, n2))
806
@deprecated_method(zero_eight)
807
def reweave(self, other, pb=None, msg=None):
808
"""reweave has been superceded by plain use of join."""
809
return self.join(other, pb, msg)
811
def _reweave(self, other, pb, msg):
812
"""Reweave self with other - internal helper for join().
814
:param other: The other weave to merge
815
:param pb: An optional progress bar, indicating how far done we are
816
:param msg: An optional message for the progress
818
new_weave = _reweave(self, other, pb=pb, msg=msg)
819
for attr in self.__slots__:
820
if attr != '_weave_name':
821
setattr(self, attr, getattr(new_weave, attr))
824
class WeaveFile(Weave):
825
"""A WeaveFile represents a Weave on disk and writes on change."""
827
def __init__(self, name, transport, mode=None):
828
super(WeaveFile, self).__init__(name)
829
self._transport = transport
832
_read_weave_v5(self._transport.get(name), self)
833
except errors.NoSuchFile:
837
def add_lines(self, version_id, parents, lines):
838
"""Add a version and save the weave."""
839
super(WeaveFile, self).add_lines(version_id, parents, lines)
842
def create_empty(self, name, transport, mode=None):
843
return WeaveFile(name, transport, mode)
846
"""Save the weave."""
848
write_weave_v5(self, sio)
850
self._transport.put(self._weave_name, sio, self._mode)
852
def join(self, other, pb=None, msg=None, version_ids=None):
853
"""Join other into self and save."""
854
super(WeaveFile, self).join(other, pb, msg, version_ids)
858
@deprecated_function(zero_eight)
859
def reweave(wa, wb, pb=None, msg=None):
860
"""reweaving is deprecation, please just use weave.join()."""
861
_reweave(wa, wb, pb, msg)
863
def _reweave(wa, wb, pb=None, msg=None):
864
"""Combine two weaves and return the result.
866
This works even if a revision R has different parents in
867
wa and wb. In the resulting weave all the parents are given.
869
This is done by just building up a new weave, maintaining ordering
870
of the versions in the two inputs. More efficient approaches
871
might be possible but it should only be necessary to do
872
this operation rarely, when a new previously ghost version is
875
:param pb: An optional progress bar, indicating how far done we are
876
:param msg: An optional message for the progress
880
queue_a = range(wa.numversions())
881
queue_b = range(wb.numversions())
882
# first determine combined parents of all versions
883
# map from version name -> all parent names
884
combined_parents = _reweave_parent_graphs(wa, wb)
885
mutter("combined parents: %r", combined_parents)
886
order = topo_sort(combined_parents.iteritems())
887
mutter("order to reweave: %r", order)
892
for idx, name in enumerate(order):
894
pb.update(msg, idx, len(order))
895
if name in wa._name_map:
896
lines = wa.get_lines(name)
897
if name in wb._name_map:
898
lines_b = wb.get_lines(name)
900
mutter('Weaves differ on content. rev_id {%s}', name)
901
mutter('weaves: %s, %s', wa._weave_name, wb._weave_name)
903
lines = list(difflib.unified_diff(lines, lines_b,
904
wa._weave_name, wb._weave_name))
905
mutter('lines:\n%s', ''.join(lines))
906
raise errors.WeaveTextDiffers(name, wa, wb)
908
lines = wb.get_lines(name)
909
wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
912
def _reweave_parent_graphs(wa, wb):
913
"""Return combined parent ancestry for two weaves.
915
Returned as a list of (version_name, set(parent_names))"""
917
for weave in [wa, wb]:
918
for idx, name in enumerate(weave._names):
919
p = combined.setdefault(name, set())
920
p.update(map(weave._idx_to_name, weave._parents[idx]))
712
924
def weave_toc(w):