/usr/share/pyshared/bzrlib/chk_serializer.py is in python-bzrlib 2.6.0~bzr6526-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 | # Copyright (C) 2008, 2009, 2010 Canonical Ltd
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
"""Serializer object for CHK based inventory storage."""
from __future__ import absolute_import
from cStringIO import StringIO
from bzrlib import lazy_import
lazy_import.lazy_import(globals(),
"""
from bzrlib import (
xml_serializer,
)
""")
from bzrlib import (
bencode,
cache_utf8,
errors,
revision as _mod_revision,
serializer,
)
def _validate_properties(props, _decode=cache_utf8._utf8_decode):
# TODO: we really want an 'isascii' check for key
# Cast the utf8 properties into Unicode 'in place'
for key, value in props.iteritems():
props[key] = _decode(value)[0]
return props
def _is_format_10(value):
if value != 10:
raise ValueError('Format number was not recognized, expected 10 got %d'
% (value,))
return 10
class BEncodeRevisionSerializer1(object):
"""Simple revision serializer based around bencode.
"""
squashes_xml_invalid_characters = False
# Maps {key:(Revision attribute, bencode_type, validator)}
# This tells us what kind we expect bdecode to create, what variable on
# Revision we should be using, and a function to call to validate/transform
# the type.
# TODO: add a 'validate_utf8' for things like revision_id and file_id
# and a validator for parent-ids
_schema = {'format': (None, int, _is_format_10),
'committer': ('committer', str, cache_utf8.decode),
'timezone': ('timezone', int, None),
'timestamp': ('timestamp', str, float),
'revision-id': ('revision_id', str, None),
'parent-ids': ('parent_ids', list, None),
'inventory-sha1': ('inventory_sha1', str, None),
'message': ('message', str, cache_utf8.decode),
'properties': ('properties', dict, _validate_properties),
}
def write_revision_to_string(self, rev):
encode_utf8 = cache_utf8._utf8_encode
# Use a list of tuples rather than a dict
# This lets us control the ordering, so that we are able to create
# smaller deltas
ret = [
("format", 10),
("committer", encode_utf8(rev.committer)[0]),
]
if rev.timezone is not None:
ret.append(("timezone", rev.timezone))
# For bzr revisions, the most common property is just 'branch-nick'
# which changes infrequently.
revprops = {}
for key, value in rev.properties.iteritems():
revprops[key] = encode_utf8(value)[0]
ret.append(('properties', revprops))
ret.extend([
("timestamp", "%.3f" % rev.timestamp),
("revision-id", rev.revision_id),
("parent-ids", rev.parent_ids),
("inventory-sha1", rev.inventory_sha1),
("message", encode_utf8(rev.message)[0]),
])
return bencode.bencode(ret)
def write_revision(self, rev, f):
f.write(self.write_revision_to_string(rev))
def read_revision_from_string(self, text):
# TODO: consider writing a Revision decoder, rather than using the
# generic bencode decoder
# However, to decode all 25k revisions of bzr takes approx 1.3s
# If we remove all extra validation that goes down to about 1.2s.
# Of that time, probably 0.6s is spend in bencode.bdecode().
# Regardless 'time bzr log' of everything is 7+s, so 1.3s to
# extract revision texts isn't a majority of time.
ret = bencode.bdecode(text)
if not isinstance(ret, list):
raise ValueError("invalid revision text")
schema = self._schema
# timezone is allowed to be missing, but should be set
bits = {'timezone': None}
for key, value in ret:
# Will raise KeyError if not a valid part of the schema, or an
# entry is given 2 times.
var_name, expected_type, validator = schema[key]
if value.__class__ is not expected_type:
raise ValueError('key %s did not conform to the expected type'
' %s, but was %s'
% (key, expected_type, type(value)))
if validator is not None:
value = validator(value)
bits[var_name] = value
if len(bits) != len(schema):
missing = [key for key, (var_name, _, _) in schema.iteritems()
if var_name not in bits]
raise ValueError('Revision text was missing expected keys %s.'
' text %r' % (missing, text))
del bits[None] # Get rid of 'format' since it doesn't get mapped
rev = _mod_revision.Revision(**bits)
return rev
def read_revision(self, f):
return self.read_revision_from_string(f.read())
class CHKSerializer(serializer.Serializer):
"""A CHKInventory based serializer with 'plain' behaviour."""
format_num = '9'
revision_format_num = None
support_altered_by_hack = False
supported_kinds = set(['file', 'directory', 'symlink', 'tree-reference'])
def __init__(self, node_size, search_key_name):
self.maximum_size = node_size
self.search_key_name = search_key_name
def _unpack_inventory(self, elt, revision_id=None, entry_cache=None,
return_from_cache=False):
"""Construct from XML Element"""
inv = xml_serializer.unpack_inventory_flat(elt, self.format_num,
xml_serializer.unpack_inventory_entry, entry_cache,
return_from_cache)
return inv
def read_inventory_from_string(self, xml_string, revision_id=None,
entry_cache=None, return_from_cache=False):
"""Read xml_string into an inventory object.
:param xml_string: The xml to read.
:param revision_id: If not-None, the expected revision id of the
inventory.
:param entry_cache: An optional cache of InventoryEntry objects. If
supplied we will look up entries via (file_id, revision_id) which
should map to a valid InventoryEntry (File/Directory/etc) object.
:param return_from_cache: Return entries directly from the cache,
rather than copying them first. This is only safe if the caller
promises not to mutate the returned inventory entries, but it can
make some operations significantly faster.
"""
try:
return self._unpack_inventory(
xml_serializer.fromstring(xml_string), revision_id,
entry_cache=entry_cache,
return_from_cache=return_from_cache)
except xml_serializer.ParseError, e:
raise errors.UnexpectedInventoryFormat(e)
def read_inventory(self, f, revision_id=None):
"""Read an inventory from a file-like object."""
try:
try:
return self._unpack_inventory(self._read_element(f),
revision_id=None)
finally:
f.close()
except xml_serializer.ParseError, e:
raise errors.UnexpectedInventoryFormat(e)
def write_inventory_to_lines(self, inv):
"""Return a list of lines with the encoded inventory."""
return self.write_inventory(inv, None)
def write_inventory_to_string(self, inv, working=False):
"""Just call write_inventory with a StringIO and return the value.
:param working: If True skip history data - text_sha1, text_size,
reference_revision, symlink_target.
"""
sio = StringIO()
self.write_inventory(inv, sio, working)
return sio.getvalue()
def write_inventory(self, inv, f, working=False):
"""Write inventory to a file.
:param inv: the inventory to write.
:param f: the file to write. (May be None if the lines are the desired
output).
:param working: If True skip history data - text_sha1, text_size,
reference_revision, symlink_target.
:return: The inventory as a list of lines.
"""
output = []
append = output.append
if inv.revision_id is not None:
revid1 = ' revision_id="'
revid2 = xml_serializer.encode_and_escape(inv.revision_id)
else:
revid1 = ""
revid2 = ""
append('<inventory format="%s"%s%s>\n' % (
self.format_num, revid1, revid2))
append('<directory file_id="%s name="%s revision="%s />\n' % (
xml_serializer.encode_and_escape(inv.root.file_id),
xml_serializer.encode_and_escape(inv.root.name),
xml_serializer.encode_and_escape(inv.root.revision)))
xml_serializer.serialize_inventory_flat(inv,
append,
root_id=None, supported_kinds=self.supported_kinds,
working=working)
if f is not None:
f.writelines(output)
return output
chk_serializer_255_bigpage = CHKSerializer(65536, 'hash-255-way')
class CHKBEncodeSerializer(BEncodeRevisionSerializer1, CHKSerializer):
"""A CHKInventory and BEncode based serializer with 'plain' behaviour."""
format_num = '10'
chk_bencode_serializer = CHKBEncodeSerializer(65536, 'hash-255-way')
|