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
246
__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
def get_parent_map(self, version_ids):
330
"""See VersionedFile.get_parent_map."""
332
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
345
def get_parents_with_ghosts(self, version_id):
346
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:
248
def get_parents(self, version_id):
249
"""See VersionedFile.get_parent."""
250
return map(self._idx_to_name, self._parents[self._lookup(version_id)])
380
252
def _check_repeated_add(self, name, parents, text, sha1):
381
253
"""Check that a duplicated add is OK.
398
270
def _add(self, version_id, lines, parents, sha1=None, nostore_sha=None):
399
271
"""Add a single text on top of the weave.
401
273
Returns the index number of the newly added version.
404
276
Symbolic name for this version.
405
277
(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
280
List or set of direct parent version numbers.
412
283
Sequence of lines to be added in the new version.
414
285
:param nostore_sha: See VersionedFile.add_lines.
287
assert isinstance(version_id, basestring)
416
288
self._check_lines_not_unicode(lines)
417
289
self._check_lines_are_lines(lines)
419
291
sha1 = sha_strings(lines)
420
292
if sha1 == nostore_sha:
421
293
raise errors.ExistingContent
422
if version_id is None:
423
version_id = "sha1:" + sha1
424
294
if version_id in self._name_map:
425
295
return self._check_repeated_add(version_id, parents, lines, sha1)
557
438
def _compatible_parents(self, my_parents, other_parents):
558
439
"""During join check that other_parents are joinable with my_parents.
560
Joinable is defined as 'is a subset of' - supersets may require
441
Joinable is defined as 'is a subset of' - supersets may require
561
442
regeneration of diffs, but subsets do not.
563
444
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.
446
def annotate_iter(self, version_id):
447
"""Yield list of (version-id, line) pairs for the specified version.
568
449
The index indicates when the line originated in the weave."""
569
450
incls = [self._lookup(version_id)]
570
return [(self._idx_to_name(origin), text) for origin, lineno, text in
571
self._extract(incls)]
451
for origin, lineno, text in self._extract(incls):
452
yield self._idx_to_name(origin), text
573
454
def iter_lines_added_or_present_in_versions(self, version_ids=None,
848
740
# no lines outside of insertion blocks, that deletions are
849
741
# properly paired, etc.
743
def _join(self, other, pb, msg, version_ids, ignore_missing):
744
"""Worker routine for join()."""
745
if not other.versions():
746
return # nothing to update, easy
749
# versions is never none, InterWeave checks this.
752
# two loops so that we do not change ourselves before verifying it
754
# work through in index order to make sure we get all dependencies
757
# get the selected versions only that are in other.versions.
758
version_ids = set(other.versions()).intersection(set(version_ids))
759
# pull in the referenced graph.
760
version_ids = other.get_ancestry(version_ids)
761
pending_graph = [(version, other.get_parents(version)) for
762
version in version_ids]
763
for name in topo_sort(pending_graph):
764
other_idx = other._name_map[name]
765
# returns True if we have it, False if we need it.
766
if not self._check_version_consistent(other, other_idx, name):
767
names_to_join.append((other_idx, name))
776
for other_idx, name in names_to_join:
777
# TODO: If all the parents of the other version are already
778
# present then we can avoid some work by just taking the delta
779
# and adjusting the offsets.
780
new_parents = self._imported_parents(other, other_idx)
781
sha1 = other._sha1s[other_idx]
786
pb.update(msg, merged, len(names_to_join))
788
lines = other.get_lines(other_idx)
789
self._add(name, lines, new_parents, sha1)
791
mutter("merged = %d, processed = %d, file_id=%s; deltat=%d"%(
792
merged, processed, self._weave_name, time.time()-time0))
851
794
def _imported_parents(self, other, other_idx):
852
795
"""Return list of parents in self corresponding to indexes in other."""
930
872
def _add_lines(self, version_id, parents, lines, parent_texts,
931
left_matching_blocks, nostore_sha, random_id, check_content):
873
left_matching_blocks, nostore_sha):
932
874
"""Add a version and save the weave."""
933
875
self.check_not_reserved_id(version_id)
934
876
result = super(WeaveFile, self)._add_lines(version_id, parents, lines,
935
parent_texts, left_matching_blocks, nostore_sha, random_id,
877
parent_texts, left_matching_blocks, nostore_sha)
881
def _clone_text(self, new_version_id, old_version_id, parents):
882
"""See VersionedFile.clone_text."""
883
super(WeaveFile, self)._clone_text(new_version_id, old_version_id, parents)
940
886
def copy_to(self, name, transport):
941
887
"""See VersionedFile.copy_to()."""
942
888
# as we are all in memory always, just serialise to the new place.
946
892
transport.put_file(name + WeaveFile.WEAVE_SUFFIX, sio, self._filemode)
894
def create_empty(self, name, transport, filemode=None):
895
return WeaveFile(name, transport, filemode, create=True)
949
898
"""Save the weave."""
950
899
self._check_write_ok()
952
901
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)
903
self._transport.put_file(self._weave_name + WeaveFile.WEAVE_SUFFIX,
963
908
def get_suffixes():
964
909
"""See VersionedFile.get_suffixes()."""
965
910
return [WeaveFile.WEAVE_SUFFIX]
967
def insert_record_stream(self, stream):
968
super(WeaveFile, self).insert_record_stream(stream)
912
def join(self, other, pb=None, msg=None, version_ids=None,
913
ignore_missing=False):
914
"""Join other into self and save."""
915
super(WeaveFile, self).join(other, pb, msg, version_ids, ignore_missing)
972
919
def _reweave(wa, wb, pb=None, msg=None):
973
920
"""Combine two weaves and return the result.
975
This works even if a revision R has different parents in
922
This works even if a revision R has different parents in
976
923
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
925
This is done by just building up a new weave, maintaining ordering
979
926
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
927
might be possible but it should only be necessary to do
928
this operation rarely, when a new previously ghost version is
984
931
:param pb: An optional progress bar, indicating how far done we are
1029
975
p = combined.setdefault(name, set())
1030
976
p.update(map(weave._idx_to_name, weave._parents[idx]))
981
"""Show the weave's table-of-contents"""
982
print '%6s %50s %10s %10s' % ('ver', 'name', 'sha1', 'parents')
983
for i in (6, 50, 10, 10):
986
for i in range(w.num_versions()):
989
parent_str = ' '.join(map(str, w._parents[i]))
990
print '%6d %-50.50s %10.10s %s' % (i, name, sha1, parent_str)
994
def weave_stats(weave_file, pb):
995
from bzrlib.weavefile import read_weave
997
wf = file(weave_file, 'rb')
999
# FIXME: doesn't work on pipes
1000
weave_size = wf.tell()
1004
for i in range(vers):
1005
pb.update('checking sizes', i, vers)
1006
for origin, lineno, line in w._extract([i]):
1011
print 'versions %9d' % vers
1012
print 'weave file %9d bytes' % weave_size
1013
print 'total contents %9d bytes' % total
1014
print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
1017
print 'average size %9d bytes' % avg
1018
print 'relative size %9.2fx' % (float(weave_size) / float(avg))
1022
print """bzr weave tool
1024
Experimental tool for weave algorithm.
1027
weave init WEAVEFILE
1028
Create an empty weave file
1029
weave get WEAVEFILE VERSION
1030
Write out specified version.
1031
weave check WEAVEFILE
1032
Check consistency of all versions.
1034
Display table of contents.
1035
weave add WEAVEFILE NAME [BASE...] < NEWTEXT
1036
Add NEWTEXT, with specified parent versions.
1037
weave annotate WEAVEFILE VERSION
1038
Display origin of each line.
1039
weave merge WEAVEFILE VERSION1 VERSION2 > OUT
1040
Auto-merge two versions and display conflicts.
1041
weave diff WEAVEFILE VERSION1 VERSION2
1042
Show differences between two versions.
1046
% weave init foo.weave
1048
% weave add foo.weave ver0 < foo.txt
1051
(create updated version)
1053
% weave get foo.weave 0 | diff -u - foo.txt
1054
% weave add foo.weave ver1 0 < foo.txt
1057
% weave get foo.weave 0 > foo.txt (create forked version)
1059
% weave add foo.weave ver2 0 < foo.txt
1062
% weave merge foo.weave 1 2 > foo.txt (merge them)
1063
% vi foo.txt (resolve conflicts)
1064
% weave add foo.weave merged 1 2 < foo.txt (commit merged version)
1076
# in case we're run directly from the subdirectory
1077
sys.path.append('..')
1079
from bzrlib.weavefile import write_weave, read_weave
1080
from bzrlib.progress import ProgressBar
1095
return read_weave(file(argv[2], 'rb'))
1101
# at the moment, based on everything in the file
1103
parents = map(int, argv[4:])
1104
lines = sys.stdin.readlines()
1105
ver = w.add(name, parents, lines)
1106
write_weave(w, file(argv[2], 'wb'))
1107
print 'added version %r %d' % (name, ver)
1110
if os.path.exists(fn):
1111
raise IOError("file exists")
1113
write_weave(w, file(fn, 'wb'))
1114
elif cmd == 'get': # get one version
1116
sys.stdout.writelines(w.get_iter(int(argv[3])))
1121
v1, v2 = map(int, argv[3:5])
1124
diff_gen = bzrlib.patiencediff.unified_diff(lines1, lines2,
1125
'%s version %d' % (fn, v1),
1126
'%s version %d' % (fn, v2))
1127
sys.stdout.writelines(diff_gen)
1129
elif cmd == 'annotate':
1131
# newline is added to all lines regardless; too hard to get
1132
# reasonable formatting otherwise
1134
for origin, text in w.annotate(int(argv[3])):
1135
text = text.rstrip('\r\n')
1137
print ' | %s' % (text)
1139
print '%5d | %s' % (origin, text)
1145
elif cmd == 'stats':
1146
weave_stats(argv[2], ProgressBar())
1148
elif cmd == 'check':
1153
print '%d versions ok' % w.num_versions()
1155
elif cmd == 'inclusions':
1157
print ' '.join(map(str, w.inclusions([int(argv[3])])))
1159
elif cmd == 'parents':
1161
print ' '.join(map(str, w._parents[int(argv[3])]))
1163
elif cmd == 'plan-merge':
1164
# replaced by 'bzr weave-plan-merge'
1166
for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
1168
print '%14s | %s' % (state, line),
1169
elif cmd == 'merge':
1170
# replaced by 'bzr weave-merge-text'
1172
p = w.plan_merge(int(argv[3]), int(argv[4]))
1173
sys.stdout.writelines(w.weave_merge(p))
1175
raise ValueError('unknown command %r' % cmd)
1178
if __name__ == '__main__':
1180
sys.exit(main(sys.argv))
1183
class InterWeave(InterVersionedFile):
1184
"""Optimised code paths for weave to weave operations."""
1186
_matching_file_from_factory = staticmethod(WeaveFile)
1187
_matching_file_to_factory = staticmethod(WeaveFile)
1190
def is_compatible(source, target):
1191
"""Be compatible with weaves."""
1193
return (isinstance(source, Weave) and
1194
isinstance(target, Weave))
1195
except AttributeError:
1198
def join(self, pb=None, msg=None, version_ids=None, ignore_missing=False):
1199
"""See InterVersionedFile.join."""
1200
version_ids = self._get_source_version_ids(version_ids, ignore_missing)
1201
if self.target.versions() == [] and version_ids is None:
1202
self.target._copy_weave_content(self.source)
1205
self.target._join(self.source, pb, msg, version_ids, ignore_missing)
1206
except errors.WeaveParentMismatch:
1207
self.target._reweave(self.source, pb, msg)
1210
InterVersionedFile.register_optimiser(InterWeave)
added
removed
bzrlib/weave.py
