69
71
from copy import copy
70
72
from cStringIO import StringIO
73
from bzrlib.lazy_import import lazy_import
74
lazy_import(globals(), """
75
from bzrlib import tsort
77
78
from bzrlib import (
81
from bzrlib.trace import mutter
81
82
from bzrlib.errors import (WeaveError, WeaveFormatError, WeaveParentMismatch,
82
83
RevisionAlreadyPresent,
83
84
RevisionNotPresent,
84
UnavailableRepresentation,
85
WeaveRevisionAlreadyPresent,
86
WeaveRevisionNotPresent,
86
from bzrlib.osutils import dirname, sha, sha_strings, split_lines
88
import bzrlib.errors as errors
89
from bzrlib.osutils import sha_strings
87
90
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 (
91
from bzrlib.tsort import topo_sort
92
from bzrlib.versionedfile import VersionedFile, InterVersionedFile
98
93
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
96
class Weave(VersionedFile):
127
97
"""weave - versioned text file storage.
129
99
A Weave manages versions of line-based text files, keeping track
130
100
of the originating version for each line.
297
264
__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
266
def get_parent_map(self, version_ids):
330
267
"""See VersionedFile.get_parent_map."""
332
269
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
271
result[version_id] = tuple(
272
map(self._idx_to_name, self._parents[self._lookup(version_id)]))
273
except RevisionNotPresent:
345
277
def get_parents_with_ghosts(self, version_id):
346
278
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
280
def _check_repeated_add(self, name, parents, text, sha1):
381
281
"""Check that a duplicated add is OK.
398
298
def _add(self, version_id, lines, parents, sha1=None, nostore_sha=None):
399
299
"""Add a single text on top of the weave.
401
301
Returns the index number of the newly added version.
404
304
Symbolic name for this version.
405
305
(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
308
List or set of direct parent version numbers.
412
311
Sequence of lines to be added in the new version.
414
313
:param nostore_sha: See VersionedFile.add_lines.
315
assert isinstance(version_id, basestring)
416
316
self._check_lines_not_unicode(lines)
417
317
self._check_lines_are_lines(lines)
419
319
sha1 = sha_strings(lines)
420
320
if sha1 == nostore_sha:
421
321
raise errors.ExistingContent
422
if version_id is None:
423
version_id = "sha1:" + sha1
424
322
if version_id in self._name_map:
425
323
return self._check_repeated_add(version_id, parents, lines, sha1)
699
611
# we're still spending ~1/4 of the method in isinstance though.
700
612
# so lets hard code the acceptable string classes we expect:
701
613
# 449 0 1202.9420 786.2930 bzrlib.weave:556(_extract)
702
# +71352 0 377.5560 377.5560 +<method 'append' of 'list'
614
# +71352 0 377.5560 377.5560 +<method 'append' of 'list'
704
616
# yay, down to ~1/4 the initial extract time, and our inline time
705
617
# has shrunk again, with isinstance no longer dominating.
706
618
# tweaking the stack inclusion test to use a set gives:
707
619
# 449 0 1122.8030 713.0080 bzrlib.weave:556(_extract)
708
# +71352 0 354.9980 354.9980 +<method 'append' of 'list'
620
# +71352 0 354.9980 354.9980 +<method 'append' of 'list'
710
622
# - a 5% win, or possibly just noise. However with large istacks that
711
623
# 'in' test could dominate, so I'm leaving this change in place -
712
624
# when its fast enough to consider profiling big datasets we can review.
717
629
for l in self._weave:
718
630
if l.__class__ == tuple:
725
638
iset.remove(istack.pop())
727
640
if v in included:
730
645
if v in included:
733
raise AssertionError()
649
assert l.__class__ in (str, unicode)
735
650
if isactive is None:
736
651
isactive = (not dset) and istack and (istack[-1] in included)
848
759
# no lines outside of insertion blocks, that deletions are
849
760
# properly paired, etc.
762
def _join(self, other, pb, msg, version_ids, ignore_missing):
763
"""Worker routine for join()."""
764
if not other.versions():
765
return # nothing to update, easy
768
# versions is never none, InterWeave checks this.
771
# two loops so that we do not change ourselves before verifying it
773
# work through in index order to make sure we get all dependencies
776
# get the selected versions only that are in other.versions.
777
version_ids = set(other.versions()).intersection(set(version_ids))
778
# pull in the referenced graph.
779
version_ids = other.get_ancestry(version_ids)
780
pending_parents = other.get_parent_map(version_ids)
781
pending_graph = pending_parents.items()
782
if len(pending_graph) != len(version_ids):
783
raise RevisionNotPresent(
784
set(version_ids) - set(pending_parents.keys()), self)
785
for name in topo_sort(pending_graph):
786
other_idx = other._name_map[name]
787
# returns True if we have it, False if we need it.
788
if not self._check_version_consistent(other, other_idx, name):
789
names_to_join.append((other_idx, name))
797
for other_idx, name in names_to_join:
798
# TODO: If all the parents of the other version are already
799
# present then we can avoid some work by just taking the delta
800
# and adjusting the offsets.
801
new_parents = self._imported_parents(other, other_idx)
802
sha1 = other._sha1s[other_idx]
807
pb.update(msg, merged, len(names_to_join))
809
lines = other.get_lines(other_idx)
810
self._add(name, lines, new_parents, sha1)
812
mutter("merged = %d, processed = %d, file_id=%s; deltat=%d"%(
813
merged, processed, self._weave_name, time.time()-time0))
851
815
def _imported_parents(self, other, other_idx):
852
816
"""Return list of parents in self corresponding to indexes in other."""
953
915
write_weave_v5(self, sio)
955
bytes = sio.getvalue()
956
path = self._weave_name + WeaveFile.WEAVE_SUFFIX
958
self._transport.put_bytes(path, bytes, self._filemode)
959
except errors.NoSuchFile:
960
self._transport.mkdir(dirname(path))
961
self._transport.put_bytes(path, bytes, self._filemode)
917
self._transport.put_file(self._weave_name + WeaveFile.WEAVE_SUFFIX,
964
922
def get_suffixes():
965
923
"""See VersionedFile.get_suffixes()."""
966
924
return [WeaveFile.WEAVE_SUFFIX]
968
def insert_record_stream(self, stream):
969
super(WeaveFile, self).insert_record_stream(stream)
926
def join(self, other, pb=None, msg=None, version_ids=None,
927
ignore_missing=False):
928
"""Join other into self and save."""
929
super(WeaveFile, self).join(other, pb, msg, version_ids, ignore_missing)
973
933
def _reweave(wa, wb, pb=None, msg=None):
974
934
"""Combine two weaves and return the result.
976
This works even if a revision R has different parents in
936
This works even if a revision R has different parents in
977
937
wa and wb. In the resulting weave all the parents are given.
979
This is done by just building up a new weave, maintaining ordering
939
This is done by just building up a new weave, maintaining ordering
980
940
of the versions in the two inputs. More efficient approaches
981
might be possible but it should only be necessary to do
982
this operation rarely, when a new previously ghost version is
941
might be possible but it should only be necessary to do
942
this operation rarely, when a new previously ghost version is
985
945
:param pb: An optional progress bar, indicating how far done we are
1030
989
p = combined.setdefault(name, set())
1031
990
p.update(map(weave._idx_to_name, weave._parents[idx]))
995
"""Show the weave's table-of-contents"""
996
print '%6s %50s %10s %10s' % ('ver', 'name', 'sha1', 'parents')
997
for i in (6, 50, 10, 10):
1000
for i in range(w.num_versions()):
1003
parent_str = ' '.join(map(str, w._parents[i]))
1004
print '%6d %-50.50s %10.10s %s' % (i, name, sha1, parent_str)
1008
def weave_stats(weave_file, pb):
1009
from bzrlib.weavefile import read_weave
1011
wf = file(weave_file, 'rb')
1013
# FIXME: doesn't work on pipes
1014
weave_size = wf.tell()
1018
for i in range(vers):
1019
pb.update('checking sizes', i, vers)
1020
for origin, lineno, line in w._extract([i]):
1025
print 'versions %9d' % vers
1026
print 'weave file %9d bytes' % weave_size
1027
print 'total contents %9d bytes' % total
1028
print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
1031
print 'average size %9d bytes' % avg
1032
print 'relative size %9.2fx' % (float(weave_size) / float(avg))
1036
print """bzr weave tool
1038
Experimental tool for weave algorithm.
1041
weave init WEAVEFILE
1042
Create an empty weave file
1043
weave get WEAVEFILE VERSION
1044
Write out specified version.
1045
weave check WEAVEFILE
1046
Check consistency of all versions.
1048
Display table of contents.
1049
weave add WEAVEFILE NAME [BASE...] < NEWTEXT
1050
Add NEWTEXT, with specified parent versions.
1051
weave annotate WEAVEFILE VERSION
1052
Display origin of each line.
1053
weave merge WEAVEFILE VERSION1 VERSION2 > OUT
1054
Auto-merge two versions and display conflicts.
1055
weave diff WEAVEFILE VERSION1 VERSION2
1056
Show differences between two versions.
1060
% weave init foo.weave
1062
% weave add foo.weave ver0 < foo.txt
1065
(create updated version)
1067
% weave get foo.weave 0 | diff -u - foo.txt
1068
% weave add foo.weave ver1 0 < foo.txt
1071
% weave get foo.weave 0 > foo.txt (create forked version)
1073
% weave add foo.weave ver2 0 < foo.txt
1076
% weave merge foo.weave 1 2 > foo.txt (merge them)
1077
% vi foo.txt (resolve conflicts)
1078
% weave add foo.weave merged 1 2 < foo.txt (commit merged version)
1090
# in case we're run directly from the subdirectory
1091
sys.path.append('..')
1093
from bzrlib.weavefile import write_weave, read_weave
1094
from bzrlib.progress import ProgressBar
1109
return read_weave(file(argv[2], 'rb'))
1115
# at the moment, based on everything in the file
1117
parents = map(int, argv[4:])
1118
lines = sys.stdin.readlines()
1119
ver = w.add(name, parents, lines)
1120
write_weave(w, file(argv[2], 'wb'))
1121
print 'added version %r %d' % (name, ver)
1124
if os.path.exists(fn):
1125
raise IOError("file exists")
1127
write_weave(w, file(fn, 'wb'))
1128
elif cmd == 'get': # get one version
1130
sys.stdout.writelines(w.get_iter(int(argv[3])))
1135
v1, v2 = map(int, argv[3:5])
1138
diff_gen = bzrlib.patiencediff.unified_diff(lines1, lines2,
1139
'%s version %d' % (fn, v1),
1140
'%s version %d' % (fn, v2))
1141
sys.stdout.writelines(diff_gen)
1143
elif cmd == 'annotate':
1145
# newline is added to all lines regardless; too hard to get
1146
# reasonable formatting otherwise
1148
for origin, text in w.annotate(int(argv[3])):
1149
text = text.rstrip('\r\n')
1151
print ' | %s' % (text)
1153
print '%5d | %s' % (origin, text)
1159
elif cmd == 'stats':
1160
weave_stats(argv[2], ProgressBar())
1162
elif cmd == 'check':
1167
print '%d versions ok' % w.num_versions()
1169
elif cmd == 'inclusions':
1171
print ' '.join(map(str, w.inclusions([int(argv[3])])))
1173
elif cmd == 'parents':
1175
print ' '.join(map(str, w._parents[int(argv[3])]))
1177
elif cmd == 'plan-merge':
1178
# replaced by 'bzr weave-plan-merge'
1180
for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
1182
print '%14s | %s' % (state, line),
1183
elif cmd == 'merge':
1184
# replaced by 'bzr weave-merge-text'
1186
p = w.plan_merge(int(argv[3]), int(argv[4]))
1187
sys.stdout.writelines(w.weave_merge(p))
1189
raise ValueError('unknown command %r' % cmd)
1192
if __name__ == '__main__':
1194
sys.exit(main(sys.argv))
1197
class InterWeave(InterVersionedFile):
1198
"""Optimised code paths for weave to weave operations."""
1200
_matching_file_from_factory = staticmethod(WeaveFile)
1201
_matching_file_to_factory = staticmethod(WeaveFile)
1204
def is_compatible(source, target):
1205
"""Be compatible with weaves."""
1207
return (isinstance(source, Weave) and
1208
isinstance(target, Weave))
1209
except AttributeError:
1212
def join(self, pb=None, msg=None, version_ids=None, ignore_missing=False):
1213
"""See InterVersionedFile.join."""
1214
version_ids = self._get_source_version_ids(version_ids, ignore_missing)
1215
if self.target.versions() == [] and version_ids is None:
1216
self.target._copy_weave_content(self.source)
1218
self.target._join(self.source, pb, msg, version_ids, ignore_missing)
1221
InterVersionedFile.register_optimiser(InterWeave)