/usr/lib/python3/dist-packages/plainbox/impl/secure/rfc822.py is in python3-plainbox 0.25-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 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 | # This file is part of Checkbox.
#
# Copyright 2012, 2013 Canonical Ltd.
# Written by:
# Sylvain Pineau <sylvain.pineau@canonical.com>
# Zygmunt Krynicki <zygmunt.krynicki@canonical.com>
#
# Checkbox is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 3,
# as published by the Free Software Foundation.
#
# Checkbox 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 Checkbox. If not, see <http://www.gnu.org/licenses/>.
"""
:mod:`plainbox.impl.secure.rfc822` -- RFC822 parser
===================================================
Implementation of rfc822 serializer and deserializer.
.. warning::
THIS MODULE DOES NOT HAVE STABLE PUBLIC API
"""
import logging
import re
import textwrap
from plainbox.i18n import gettext as _
from plainbox.impl.secure.origin import FileTextSource
from plainbox.impl.secure.origin import Origin
from plainbox.impl.secure.origin import UnknownTextSource
logger = logging.getLogger("plainbox.secure.rfc822")
def normalize_rfc822_value(value):
# Remove the multi-line dot marker
value = re.sub('^(\s*)\.$', '\\1', value, flags=re.M)
# Remove consistent indentation
value = textwrap.dedent(value)
# Strip the remaining whitespace
value = value.strip()
return value
class RFC822Record:
"""
Class for tracking RFC822 records.
This is a simple container for the dictionary of data. The data is
represented by two copies, one original and one after value normalization.
Value normalization strips out excess whitespace and processes the magic
leading dot syntax that is essential for empty newlines.
Comparison is performed on the normalized data only, raw data is stored for
reference but does not differentiate records.
Each instance also holds the origin of the data (location of the
file/stream where it was parsed from).
"""
def __init__(self, data, origin=None, raw_data=None,
field_offset_map=None):
"""
Initialize a new record.
:param data:
A dictionary with normalized record data
:param origin:
A :class:`Origin` instance that describes where the data came from
:param raw_data:
An optional dictionary with raw record data. If omitted then it
will default to normalized data (as the same object, without making
a copy)
:param field_offset_map:
An optional dictionary with offsets (in line numbers) of each field
"""
self._data = data
if raw_data is None:
raw_data = data
self._raw_data = raw_data
if origin is None:
origin = Origin.get_caller_origin()
self._origin = origin
self._field_offset_map = field_offset_map
def __repr__(self):
return "<{} data:{!r} origin:{!r}>".format(
self.__class__.__name__, self._data, self._origin)
def __eq__(self, other):
if isinstance(other, RFC822Record):
return (self._data, self._origin) == (other._data, other._origin)
return NotImplemented
def __ne__(self, other):
if isinstance(other, RFC822Record):
return (self._data, self._origin) != (other._data, other._origin)
return NotImplemented
@property
def data(self):
"""
The normalized version of the data set (dictionary)
This property exposes the normalized version of the data encapsulated
in this record. Normalization is performed with
:func:`normalize_rfc822_value()`. Only values are normalized, keys are
left intact.
"""
return self._data
@property
def raw_data(self):
"""
The raw version of data set (dictionary)
This property exposes the raw (original) version of the data
encapsulated by this record. This data is as it was originally parsed,
including all the whitespace layout.
In some records this may be 'normal' data object itself (same object).
"""
return self._raw_data
@property
def origin(self):
"""
The origin of the record.
"""
return self._origin
@property
def field_offset_map(self):
"""
The field-to-line-number-offset mapping.
A dictionary mapping field name to offset (in lines) relative to the
origin where that field definition commences.
Note: the return value may be None
"""
return self._field_offset_map
def dump(self, stream):
"""
Dump this record to a stream
"""
def _dump_part(stream, key, values):
stream.write("{}:\n".format(key))
for value in values:
if not value:
stream.write(" .\n")
elif value == ".":
stream.write(" ..\n")
else:
stream.write(" {}\n".format(value))
for key, value in self.data.items():
if isinstance(value, (list, tuple)):
_dump_part(stream, key, value)
elif isinstance(value, str) and "\n" in value:
values = value.split("\n")
if not values[-1]:
values = values[:-1]
_dump_part(stream, key, values)
else:
stream.write("{}: {}\n".format(key, value))
stream.write("\n")
class RFC822SyntaxError(SyntaxError):
"""
SyntaxError subclass for RFC822 parsing functions
"""
def __init__(self, filename, lineno, msg):
self.filename = filename
self.lineno = lineno
self.msg = msg
def __repr__(self):
return "{}({!r}, {!r}, {!r})".format(
self.__class__.__name__, self.filename, self.lineno, self.msg)
def __eq__(self, other):
if isinstance(other, RFC822SyntaxError):
return ((self.filename, self.lineno, self.msg)
== (other.filename, other.lineno, other.msg))
return NotImplemented
def __ne__(self, other):
if isinstance(other, RFC822SyntaxError):
return ((self.filename, self.lineno, self.msg)
!= (other.filename, other.lineno, other.msg))
return NotImplemented
def __hash__(self):
return hash((self.filename, self.lineno, self.msg))
def load_rfc822_records(stream, data_cls=dict, source=None):
"""
Load a sequence of rfc822-like records from a text stream.
:param stream:
A file-like object from which to load the rfc822 data
:param data_cls:
The class of the dictionary-like type to hold the results. This is
mainly there so that callers may pass collections.OrderedDict.
:param source:
A :class:`plainbox.abc.ITextSource` subclass instance that describes
where stream data is coming from. If None, it will be inferred from the
stream (if possible). Specialized callers should provider a custom
source object to allow developers to accurately keep track of where
(possibly problematic) RFC822 data is coming from. If this is None and
inferring fails then all of the loaded records will have a None origin.
Each record consists of any number of key-value pairs. Subsequent records
are separated by one blank line. A record key may have a multi-line value
if the line starts with whitespace character.
Returns a list of subsequent values as instances RFC822Record class. If
the optional data_cls argument is collections.OrderedDict then the values
retain their original ordering.
"""
return list(gen_rfc822_records(stream, data_cls, source))
def gen_rfc822_records(stream, data_cls=dict, source=None):
"""
Load a sequence of rfc822-like records from a text stream.
:param stream:
A file-like object from which to load the rfc822 data
:param data_cls:
The class of the dictionary-like type to hold the results. This is
mainly there so that callers may pass collections.OrderedDict.
:param source:
A :class:`plainbox.abc.ITextSource` subclass instance that describes
where stream data is coming from. If None, it will be inferred from the
stream (if possible). Specialized callers should provider a custom
source object to allow developers to accurately keep track of where
(possibly problematic) RFC822 data is coming from. If this is None and
inferring fails then all of the loaded records will have a None origin.
Each record consists of any number of key-value pairs. Subsequent records
are separated by one blank line. A record key may have a multi-line value
if the line starts with whitespace character.
Returns a list of subsequent values as instances RFC822Record class. If
the optional data_cls argument is collections.OrderedDict then the values
retain their original ordering.
"""
record = None
key = None
value_list = None
origin = None
field_offset_map = None
# If the source was not provided then try constructing a FileTextSource
# from the name of the stream. If that fails, keep using None.
if source is None:
try:
source = FileTextSource(stream.name)
except AttributeError:
source = UnknownTextSource()
def _syntax_error(msg):
"""
Report a syntax error in the current line
"""
try:
filename = stream.name
except AttributeError:
filename = None
return RFC822SyntaxError(filename, lineno, msg)
def _new_record():
"""
Reset local state to track new record
"""
nonlocal key
nonlocal value_list
nonlocal record
nonlocal origin
nonlocal field_offset_map
key = None
value_list = None
if source is not None:
origin = Origin(source, None, None)
field_offset_map = {}
record = RFC822Record(data_cls(), origin, data_cls(), field_offset_map)
def _commit_key_value_if_needed():
"""
Finalize the most recently seen key: value pair
"""
nonlocal key
if key is not None:
raw_value = ''.join(value_list)
normalized_value = normalize_rfc822_value(raw_value)
record.raw_data[key] = raw_value
record.data[key] = normalized_value
logger.debug(_("Committed key/value %r=%r"), key, normalized_value)
key = None
def _set_start_lineno_if_needed():
"""
Remember the line number of the record start unless already set
"""
if origin and record.origin.line_start is None:
record.origin.line_start = lineno
def _update_end_lineno():
"""
Update the line number of the record tail
"""
if origin:
record.origin.line_end = lineno
# Start with an empty record
_new_record()
# Support simple text strings
if isinstance(stream, str):
# keepends=True (python3.2 has no keyword for this)
stream = iter(stream.splitlines(True))
# Iterate over subsequent lines of the stream
for lineno, line in enumerate(stream, start=1):
logger.debug(_("Looking at line %d:%r"), lineno, line)
# Treat # as comments
if line.startswith("#"):
pass
# Treat empty lines as record separators
elif line.strip() == "":
# Commit the current record so that the multi-line value of the
# last key, if any, is saved as a string
_commit_key_value_if_needed()
# If data is non-empty, yield the record, this allows us to safely
# use newlines for formatting
if record.data:
logger.debug(_("yielding record: %r"), record)
yield record
# Reset local state so that we can build a new record
_new_record()
# Treat lines staring with whitespace as multi-line continuation of the
# most recently seen key-value
elif line.startswith(" "):
if key is None:
# If we have not seen any keys yet then this is a syntax error
raise _syntax_error(_("Unexpected multi-line value"))
# Strip the initial space. This matches the behavior of xgettext
# scanning our job definitions with multi-line values.
line = line[1:]
# Append the current line to the list of values of the most recent
# key. This prevents quadratic complexity of string concatenation
value_list.append(line)
# Update the end line location of this record
_update_end_lineno()
# Treat lines with a colon as new key-value pairs
elif ":" in line:
# Since this is actual data let's try to remember where it came
# from. This may be a no-operation if there were any preceding
# key-value pairs.
_set_start_lineno_if_needed()
# Since we have a new, key-value pair we need to commit any
# previous key that we may have (regardless of multi-line or
# single-line values).
_commit_key_value_if_needed()
# Parse the line by splitting on the colon, getting rid of
# all surrounding whitespace from the key and getting rid of the
# leading whitespace from the value.
key, value = line.split(":", 1)
key = key.strip()
value = value.lstrip()
# Check if the key already exist in this message
if key in record.data:
raise _syntax_error(_(
"Job has a duplicate key {!r} "
"with old value {!r} and new value {!r}"
).format(key, record.raw_data[key], value))
if value.strip() != "":
# Construct initial value list out of the (only) value that we
# have so far. Additional multi-line values will just append to
# value_list
value_list = [value]
# Store the offset of the filed in the offset map
field_offset_map[key] = lineno - origin.line_start
else:
# The initial line may be empty, in that case the spaces and
# newlines there are discarded
value_list = []
# Store the offset of the filed in the offset map
# The +1 is for the fact that value is empty (or just
# whitespace) and that is stripped away in the normalized data
# part of the RFC822 record. To keep line tracking accurate
# we just assume that the field actually starts on
# the following line.
field_offset_map[key] = lineno - origin.line_start + 1
# Update the end-line location
_update_end_lineno()
# Treat all other lines as syntax errors
else:
raise _syntax_error(
_("Unexpected non-empty line: {!r}").format(line))
# Make sure to commit the last key from the record
_commit_key_value_if_needed()
# Once we've seen the whole file return the last record, if any
if record.data:
logger.debug(_("yielding record: %r"), record)
yield record
|