69
71
from copy import copy
70
72
from cStringIO import StringIO
73
78
from bzrlib.lazy_import import lazy_import
74
79
lazy_import(globals(), """
75
80
from bzrlib import tsort
77
82
from bzrlib import (
85
from bzrlib.trace import mutter
81
86
from bzrlib.errors import (WeaveError, WeaveFormatError, WeaveParentMismatch,
82
87
RevisionAlreadyPresent,
83
88
RevisionNotPresent,
84
UnavailableRepresentation,
89
WeaveRevisionAlreadyPresent,
90
WeaveRevisionNotPresent,
86
from bzrlib.osutils import dirname, sha, sha_strings, split_lines
92
import bzrlib.errors as errors
93
from bzrlib.osutils import sha_strings
87
94
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 (
95
from bzrlib.versionedfile import VersionedFile, InterVersionedFile
98
96
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
99
class Weave(VersionedFile):
127
100
"""weave - versioned text file storage.
129
102
A Weave manages versions of line-based text files, keeping track
130
103
of the originating version for each line.
297
249
__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
251
def get_parent_map(self, version_ids):
330
252
"""See VersionedFile.get_parent_map."""
332
254
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
256
result[version_id] = tuple(
257
map(self._idx_to_name, self._parents[self._lookup(version_id)]))
258
except RevisionNotPresent:
345
262
def get_parents_with_ghosts(self, version_id):
346
263
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
265
def _check_repeated_add(self, name, parents, text, sha1):
381
266
"""Check that a duplicated add is OK.
398
283
def _add(self, version_id, lines, parents, sha1=None, nostore_sha=None):
399
284
"""Add a single text on top of the weave.
401
286
Returns the index number of the newly added version.
404
289
Symbolic name for this version.
405
290
(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
293
List or set of direct parent version numbers.
412
296
Sequence of lines to be added in the new version.
414
298
:param nostore_sha: See VersionedFile.add_lines.
300
assert isinstance(version_id, basestring)
416
301
self._check_lines_not_unicode(lines)
417
302
self._check_lines_are_lines(lines)
419
304
sha1 = sha_strings(lines)
420
305
if sha1 == nostore_sha:
421
306
raise errors.ExistingContent
422
if version_id is None:
423
version_id = "sha1:" + sha1
424
307
if version_id in self._name_map:
425
308
return self._check_repeated_add(version_id, parents, lines, sha1)
557
451
def _compatible_parents(self, my_parents, other_parents):
558
452
"""During join check that other_parents are joinable with my_parents.
560
Joinable is defined as 'is a subset of' - supersets may require
454
Joinable is defined as 'is a subset of' - supersets may require
561
455
regeneration of diffs, but subsets do not.
563
457
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.
459
def annotate_iter(self, version_id):
460
"""Yield list of (version-id, line) pairs for the specified version.
568
462
The index indicates when the line originated in the weave."""
569
463
incls = [self._lookup(version_id)]
570
return [(self._idx_to_name(origin), text) for origin, lineno, text in
571
self._extract(incls)]
464
for origin, lineno, text in self._extract(incls):
465
yield self._idx_to_name(origin), text
573
467
def iter_lines_added_or_present_in_versions(self, version_ids=None,
699
601
# we're still spending ~1/4 of the method in isinstance though.
700
602
# so lets hard code the acceptable string classes we expect:
701
603
# 449 0 1202.9420 786.2930 bzrlib.weave:556(_extract)
702
# +71352 0 377.5560 377.5560 +<method 'append' of 'list'
604
# +71352 0 377.5560 377.5560 +<method 'append' of 'list'
704
606
# yay, down to ~1/4 the initial extract time, and our inline time
705
607
# has shrunk again, with isinstance no longer dominating.
706
608
# tweaking the stack inclusion test to use a set gives:
707
609
# 449 0 1122.8030 713.0080 bzrlib.weave:556(_extract)
708
# +71352 0 354.9980 354.9980 +<method 'append' of 'list'
610
# +71352 0 354.9980 354.9980 +<method 'append' of 'list'
710
612
# - a 5% win, or possibly just noise. However with large istacks that
711
613
# 'in' test could dominate, so I'm leaving this change in place -
712
614
# when its fast enough to consider profiling big datasets we can review.
717
619
for l in self._weave:
718
620
if l.__class__ == tuple:
725
628
iset.remove(istack.pop())
727
630
if v in included:
730
635
if v in included:
733
raise AssertionError()
639
assert l.__class__ in (str, unicode)
735
640
if isactive is None:
736
641
isactive = (not dset) and istack and (istack[-1] in included)
848
753
# no lines outside of insertion blocks, that deletions are
849
754
# properly paired, etc.
756
def _join(self, other, pb, msg, version_ids, ignore_missing):
757
"""Worker routine for join()."""
758
if not other.versions():
759
return # nothing to update, easy
762
# versions is never none, InterWeave checks this.
765
# two loops so that we do not change ourselves before verifying it
767
# work through in index order to make sure we get all dependencies
770
# get the selected versions only that are in other.versions.
771
version_ids = set(other.versions()).intersection(set(version_ids))
772
# pull in the referenced graph.
773
version_ids = other.get_ancestry(version_ids)
774
pending_parents = other.get_parent_map(version_ids)
775
pending_graph = pending_parents.items()
776
if len(pending_graph) != len(version_ids):
777
raise RevisionNotPresent(
778
set(version_ids) - set(pending_parents.keys()), self)
779
for name in tsort.topo_sort(pending_graph):
780
other_idx = other._name_map[name]
781
# returns True if we have it, False if we need it.
782
if not self._check_version_consistent(other, other_idx, name):
783
names_to_join.append((other_idx, name))
791
for other_idx, name in names_to_join:
792
# TODO: If all the parents of the other version are already
793
# present then we can avoid some work by just taking the delta
794
# and adjusting the offsets.
795
new_parents = self._imported_parents(other, other_idx)
796
sha1 = other._sha1s[other_idx]
801
pb.update(msg, merged, len(names_to_join))
803
lines = other.get_lines(other_idx)
804
self._add(name, lines, new_parents, sha1)
806
mutter("merged = %d, processed = %d, file_id=%s; deltat=%d"%(
807
merged, processed, self._weave_name, time.time()-time0))
851
809
def _imported_parents(self, other, other_idx):
852
810
"""Return list of parents in self corresponding to indexes in other."""
946
908
transport.put_file(name + WeaveFile.WEAVE_SUFFIX, sio, self._filemode)
910
def create_empty(self, name, transport, filemode=None):
911
return WeaveFile(name, transport, filemode, create=True)
949
914
"""Save the weave."""
950
915
self._check_write_ok()
952
917
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)
919
self._transport.put_file(self._weave_name + WeaveFile.WEAVE_SUFFIX,
963
924
def get_suffixes():
964
925
"""See VersionedFile.get_suffixes()."""
965
926
return [WeaveFile.WEAVE_SUFFIX]
967
def insert_record_stream(self, stream):
968
super(WeaveFile, self).insert_record_stream(stream)
928
def join(self, other, pb=None, msg=None, version_ids=None,
929
ignore_missing=False):
930
"""Join other into self and save."""
931
super(WeaveFile, self).join(other, pb, msg, version_ids, ignore_missing)
972
935
def _reweave(wa, wb, pb=None, msg=None):
973
936
"""Combine two weaves and return the result.
975
This works even if a revision R has different parents in
938
This works even if a revision R has different parents in
976
939
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
941
This is done by just building up a new weave, maintaining ordering
979
942
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
943
might be possible but it should only be necessary to do
944
this operation rarely, when a new previously ghost version is
984
947
:param pb: An optional progress bar, indicating how far done we are
1029
991
p = combined.setdefault(name, set())
1030
992
p.update(map(weave._idx_to_name, weave._parents[idx]))
997
"""Show the weave's table-of-contents"""
998
print '%6s %50s %10s %10s' % ('ver', 'name', 'sha1', 'parents')
999
for i in (6, 50, 10, 10):
1002
for i in range(w.num_versions()):
1005
parent_str = ' '.join(map(str, w._parents[i]))
1006
print '%6d %-50.50s %10.10s %s' % (i, name, sha1, parent_str)
1010
def weave_stats(weave_file, pb):
1011
from bzrlib.weavefile import read_weave
1013
wf = file(weave_file, 'rb')
1015
# FIXME: doesn't work on pipes
1016
weave_size = wf.tell()
1020
for i in range(vers):
1021
pb.update('checking sizes', i, vers)
1022
for origin, lineno, line in w._extract([i]):
1027
print 'versions %9d' % vers
1028
print 'weave file %9d bytes' % weave_size
1029
print 'total contents %9d bytes' % total
1030
print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
1033
print 'average size %9d bytes' % avg
1034
print 'relative size %9.2fx' % (float(weave_size) / float(avg))
1038
print """bzr weave tool
1040
Experimental tool for weave algorithm.
1043
weave init WEAVEFILE
1044
Create an empty weave file
1045
weave get WEAVEFILE VERSION
1046
Write out specified version.
1047
weave check WEAVEFILE
1048
Check consistency of all versions.
1050
Display table of contents.
1051
weave add WEAVEFILE NAME [BASE...] < NEWTEXT
1052
Add NEWTEXT, with specified parent versions.
1053
weave annotate WEAVEFILE VERSION
1054
Display origin of each line.
1055
weave merge WEAVEFILE VERSION1 VERSION2 > OUT
1056
Auto-merge two versions and display conflicts.
1057
weave diff WEAVEFILE VERSION1 VERSION2
1058
Show differences between two versions.
1062
% weave init foo.weave
1064
% weave add foo.weave ver0 < foo.txt
1067
(create updated version)
1069
% weave get foo.weave 0 | diff -u - foo.txt
1070
% weave add foo.weave ver1 0 < foo.txt
1073
% weave get foo.weave 0 > foo.txt (create forked version)
1075
% weave add foo.weave ver2 0 < foo.txt
1078
% weave merge foo.weave 1 2 > foo.txt (merge them)
1079
% vi foo.txt (resolve conflicts)
1080
% weave add foo.weave merged 1 2 < foo.txt (commit merged version)
1092
# in case we're run directly from the subdirectory
1093
sys.path.append('..')
1095
from bzrlib.weavefile import write_weave, read_weave
1096
from bzrlib.progress import ProgressBar
1111
return read_weave(file(argv[2], 'rb'))
1117
# at the moment, based on everything in the file
1119
parents = map(int, argv[4:])
1120
lines = sys.stdin.readlines()
1121
ver = w.add(name, parents, lines)
1122
write_weave(w, file(argv[2], 'wb'))
1123
print 'added version %r %d' % (name, ver)
1126
if os.path.exists(fn):
1127
raise IOError("file exists")
1129
write_weave(w, file(fn, 'wb'))
1130
elif cmd == 'get': # get one version
1132
sys.stdout.writelines(w.get_iter(int(argv[3])))
1137
v1, v2 = map(int, argv[3:5])
1140
diff_gen = bzrlib.patiencediff.unified_diff(lines1, lines2,
1141
'%s version %d' % (fn, v1),
1142
'%s version %d' % (fn, v2))
1143
sys.stdout.writelines(diff_gen)
1145
elif cmd == 'annotate':
1147
# newline is added to all lines regardless; too hard to get
1148
# reasonable formatting otherwise
1150
for origin, text in w.annotate(int(argv[3])):
1151
text = text.rstrip('\r\n')
1153
print ' | %s' % (text)
1155
print '%5d | %s' % (origin, text)
1161
elif cmd == 'stats':
1162
weave_stats(argv[2], ProgressBar())
1164
elif cmd == 'check':
1169
print '%d versions ok' % w.num_versions()
1171
elif cmd == 'inclusions':
1173
print ' '.join(map(str, w.inclusions([int(argv[3])])))
1175
elif cmd == 'parents':
1177
print ' '.join(map(str, w._parents[int(argv[3])]))
1179
elif cmd == 'plan-merge':
1180
# replaced by 'bzr weave-plan-merge'
1182
for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
1184
print '%14s | %s' % (state, line),
1185
elif cmd == 'merge':
1186
# replaced by 'bzr weave-merge-text'
1188
p = w.plan_merge(int(argv[3]), int(argv[4]))
1189
sys.stdout.writelines(w.weave_merge(p))
1191
raise ValueError('unknown command %r' % cmd)
1194
if __name__ == '__main__':
1196
sys.exit(main(sys.argv))
1199
class InterWeave(InterVersionedFile):
1200
"""Optimised code paths for weave to weave operations."""
1202
_matching_file_from_factory = staticmethod(WeaveFile)
1203
_matching_file_to_factory = staticmethod(WeaveFile)
1206
def is_compatible(source, target):
1207
"""Be compatible with weaves."""
1209
return (isinstance(source, Weave) and
1210
isinstance(target, Weave))
1211
except AttributeError:
1214
def join(self, pb=None, msg=None, version_ids=None, ignore_missing=False):
1215
"""See InterVersionedFile.join."""
1216
version_ids = self._get_source_version_ids(version_ids, ignore_missing)
1217
if self.target.versions() == [] and version_ids is None:
1218
self.target._copy_weave_content(self.source)
1220
self.target._join(self.source, pb, msg, version_ids, ignore_missing)
1223
InterVersionedFile.register_optimiser(InterWeave)
added
removed
bzrlib/weave.py
