"""This module parses and generates contentlines as defined in RFC 5545
(iCalendar), but will probably work for other MIME types with similar syntax.
Eg. RFC 2426 (vCard)
It is stupid in the sense that it treats the content purely as strings. No type
conversion is attempted.
"""
from __future__ import annotations
import os
from icalendar.caselessdict import CaselessDict
from icalendar.parser_tools import DEFAULT_ENCODING, ICAL_TYPE
from icalendar.parser_tools import SEQUENCE_TYPES
from icalendar.parser_tools import to_unicode
import re
def escape_char(text):
"""Format value according to iCalendar TEXT escaping rules."""
assert isinstance(text, (str, bytes))
# NOTE: ORDER MATTERS!
return (
text.replace(r"\N", "\n")
.replace("\\", "\\\\")
.replace(";", r"\;")
.replace(",", r"\,")
.replace("\r\n", r"\n")
.replace("\n", r"\n")
)
def unescape_char(text):
assert isinstance(text, (str, bytes))
# NOTE: ORDER MATTERS!
if isinstance(text, str):
return (
text.replace("\\N", "\\n")
.replace("\r\n", "\n")
.replace("\\n", "\n")
.replace("\\,", ",")
.replace("\\;", ";")
.replace("\\\\", "\\")
)
elif isinstance(text, bytes):
return (
text.replace(b"\\N", b"\\n")
.replace(b"\r\n", b"\n")
.replace(b"\\n", b"\n")
.replace(b"\\,", b",")
.replace(b"\\;", b";")
.replace(b"\\\\", b"\\")
)
def foldline(line, limit=75, fold_sep="\r\n "):
"""Make a string folded as defined in RFC5545
Lines of text SHOULD NOT be longer than 75 octets, excluding the line
break. Long content lines SHOULD be split into a multiple line
representations using a line "folding" technique. That is, a long
line can be split between any two characters by inserting a CRLF
immediately followed by a single linear white-space character (i.e.,
SPACE or HTAB).
"""
assert isinstance(line, str)
assert "\n" not in line
# Use a fast and simple variant for the common case that line is all ASCII.
try:
line.encode("ascii")
except (UnicodeEncodeError, UnicodeDecodeError):
pass
else:
return fold_sep.join(
line[i : i + limit - 1] for i in range(0, len(line), limit - 1)
)
ret_chars = []
byte_count = 0
for char in line:
char_byte_len = len(char.encode(DEFAULT_ENCODING))
byte_count += char_byte_len
if byte_count >= limit:
ret_chars.append(fold_sep)
byte_count = char_byte_len
ret_chars.append(char)
return "".join(ret_chars)
#################################################################
# Property parameter stuff
def param_value(value, always_quote=False):
"""Returns a parameter value."""
if isinstance(value, SEQUENCE_TYPES):
return q_join(map(rfc_6868_escape, value), always_quote=always_quote)
if isinstance(value, str):
return dquote(rfc_6868_escape(value), always_quote=always_quote)
return dquote(rfc_6868_escape(value.to_ical().decode(DEFAULT_ENCODING)))
# Could be improved
# [\w-] because of the iCalendar RFC
# . because of the vCard RFC
NAME = re.compile(r"[\w.-]+")
UNSAFE_CHAR = re.compile('[\x00-\x08\x0a-\x1f\x7f",:;]')
QUNSAFE_CHAR = re.compile('[\x00-\x08\x0a-\x1f\x7f"]')
FOLD = re.compile(b"(\r?\n)+[ \t]")
uFOLD = re.compile("(\r?\n)+[ \t]")
NEWLINE = re.compile(r"\r?\n")
def validate_token(name):
match = NAME.findall(name)
if len(match) == 1 and name == match[0]:
return
raise ValueError(name)
def validate_param_value(value, quoted=True):
validator = QUNSAFE_CHAR if quoted else UNSAFE_CHAR
if validator.findall(value):
raise ValueError(value)
# chars presence of which in parameter value will be cause the value
# to be enclosed in double-quotes
QUOTABLE = re.compile("[,;:’]")
def dquote(val, always_quote=False):
"""Enclose parameter values containing [,;:] in double quotes."""
# a double-quote character is forbidden to appear in a parameter value
# so replace it with a single-quote character
val = val.replace('"', "'")
if QUOTABLE.search(val) or always_quote:
return f'"{val}"'
return val
# parsing helper
def q_split(st, sep=",", maxsplit=-1):
"""Splits a string on char, taking double (q)uotes into considderation."""
if maxsplit == 0:
return [st]
result = []
cursor = 0
length = len(st)
inquote = 0
splits = 0
for i, ch in enumerate(st):
if ch == '"':
inquote = not inquote
if not inquote and ch == sep:
result.append(st[cursor:i])
cursor = i + 1
splits += 1
if i + 1 == length or splits == maxsplit:
result.append(st[cursor:])
break
return result
def q_join(lst, sep=",", always_quote=False):
"""Joins a list on sep, quoting strings with QUOTABLE chars."""
return sep.join(dquote(itm, always_quote=always_quote) for itm in lst)
class Parameters(CaselessDict):
"""Parser and generator of Property parameter strings. It knows nothing of
datatypes. Its main concern is textual structure.
"""
# The following paremeters must always be enclosed in double quotes
always_quoted = (
"ALTREP",
"DELEGATED-FROM",
"DELEGATED-TO",
"DIR",
"MEMBER",
"SENT-BY",
# Part of X-APPLE-STRUCTURED-LOCATION
"X-ADDRESS",
"X-TITLE",
)
# this is quoted should one of the values be present
quote_also = {
# This is escaped in the RFC
"CN" : " '",
}
def params(self):
"""In RFC 5545 keys are called parameters, so this is to be consitent
with the naming conventions.
"""
return self.keys()
# TODO?
# Later, when I get more time... need to finish this off now. The last major
# thing missing.
# def _encode(self, name, value, cond=1):
# # internal, for conditional convertion of values.
# if cond:
# klass = types_factory.for_property(name)
# return klass(value)
# return value
#
# def add(self, name, value, encode=0):
# "Add a parameter value and optionally encode it."
# if encode:
# value = self._encode(name, value, encode)
# self[name] = value
#
# def decoded(self, name):
# "returns a decoded value, or list of same"
def to_ical(self, sorted=True):
result = []
items = list(self.items())
if sorted:
items.sort()
for key, value in items:
upper_key = key.upper()
check_quoteable_characters = self.quote_also.get(key.upper())
always_quote = (
upper_key in self.always_quoted or (
check_quoteable_characters and
any(c in value for c in check_quoteable_characters)
)
)
quoted_value = param_value(value, always_quote=always_quote)
if isinstance(quoted_value, str):
quoted_value = quoted_value.encode(DEFAULT_ENCODING)
# CaselessDict keys are always unicode
result.append(upper_key.encode(DEFAULT_ENCODING) + b"=" + quoted_value)
return b";".join(result)
@classmethod
def from_ical(cls, st, strict=False):
"""Parses the parameter format from ical text format."""
# parse into strings
result = cls()
for param in q_split(st, ";"):
try:
key, val = q_split(param, "=", maxsplit=1)
validate_token(key)
# Property parameter values that are not in quoted
# strings are case insensitive.
vals = []
for v in q_split(val, ","):
if v.startswith('"') and v.endswith('"'):
v = v.strip('"')
validate_param_value(v, quoted=True)
vals.append(rfc_6868_unescape(v))
else:
validate_param_value(v, quoted=False)
if strict:
vals.append(rfc_6868_unescape(v.upper()))
else:
vals.append(rfc_6868_unescape(v))
if not vals:
result[key] = val
else:
if len(vals) == 1:
result[key] = vals[0]
else:
result[key] = vals
except ValueError as exc:
raise ValueError(f"{param!r} is not a valid parameter string: {exc}")
return result
def escape_string(val):
# f'{i:02X}'
return (
val.replace(r"\,", "%2C")
.replace(r"\:", "%3A")
.replace(r"\;", "%3B")
.replace(r"\\", "%5C")
)
def unescape_string(val):
return (
val.replace("%2C", ",")
.replace("%3A", ":")
.replace("%3B", ";")
.replace("%5C", "\\")
)
RFC_6868_UNESCAPE_REGEX = re.compile(r"\^\^|\^n|\^'")
def rfc_6868_unescape(param_value: str) -> str:
"""Take care of :rfc:`6868` unescaping.
- ^^ -> ^
- ^n -> system specific newline
- ^' -> "
- ^ with others stay intact
"""
replacements = {
"^^": "^",
"^n": os.linesep,
"^'": '"',
}
return RFC_6868_UNESCAPE_REGEX.sub(lambda m: replacements.get(m.group(0), m.group(0)), param_value)
RFC_6868_ESCAPE_REGEX = re.compile(r'\^|\r\n|\r|\n|"')
def rfc_6868_escape(param_value: str) -> str:
"""Take care of :rfc:`6868` escaping.
- ^ -> ^^
- " -> ^'
- newline -> ^n
"""
replacements = {
"^": "^^",
"\n": "^n",
"\r": "^n",
"\r\n": "^n",
'"': "^'",
}
return RFC_6868_ESCAPE_REGEX.sub(lambda m: replacements.get(m.group(0), m.group(0)), param_value)
def unescape_list_or_string(val):
if isinstance(val, list):
return [unescape_string(s) for s in val]
else:
return unescape_string(val)
#########################################
# parsing and generation of content lines
class Contentline(str):
"""A content line is basically a string that can be folded and parsed into
parts.
"""
def __new__(cls, value, strict=False, encoding=DEFAULT_ENCODING):
value = to_unicode(value, encoding=encoding)
assert "\n" not in value, (
"Content line can not contain unescaped " "new line characters."
)
self = super().__new__(cls, value)
self.strict = strict
return self
@classmethod
def from_parts(cls, name:ICAL_TYPE, params: Parameters, values, sorted=True):
"""Turn a parts into a content line."""
assert isinstance(params, Parameters)
if hasattr(values, "to_ical"):
values = values.to_ical()
else:
from icalendar.prop import vText
values = vText(values).to_ical()
# elif isinstance(values, basestring):
# values = escape_char(values)
# TODO: after unicode only, remove this
# Convert back to unicode, after to_ical encoded it.
name = to_unicode(name)
values = to_unicode(values)
if params:
params = to_unicode(params.to_ical(sorted=sorted))
return cls(f"{name};{params}:{values}")
return cls(f"{name}:{values}")
def parts(self):
"""Split the content line up into (name, parameters, values) parts."""
try:
st = escape_string(self)
name_split = None
value_split = None
in_quotes = False
for i, ch in enumerate(st):
if not in_quotes:
if ch in ":;" and not name_split:
name_split = i
if ch == ":" and not value_split:
value_split = i
if ch == '"':
in_quotes = not in_quotes
name = unescape_string(st[:name_split])
if not name:
raise ValueError("Key name is required")
validate_token(name)
if not value_split:
value_split = i + 1
if not name_split or name_split + 1 == value_split:
raise ValueError("Invalid content line")
params = Parameters.from_ical(
st[name_split + 1 : value_split], strict=self.strict
)
params = Parameters(
(unescape_string(key), unescape_list_or_string(value))
for key, value in iter(params.items())
)
values = unescape_string(st[value_split + 1 :])
return (name, params, values)
except ValueError as exc:
raise ValueError(
f"Content line could not be parsed into parts: '{self}': {exc}"
) from exc
@classmethod
def from_ical(cls, ical, strict=False):
"""Unfold the content lines in an iCalendar into long content lines."""
ical = to_unicode(ical)
# a fold is carriage return followed by either a space or a tab
return cls(uFOLD.sub("", ical), strict=strict)
def to_ical(self):
"""Long content lines are folded so they are less than 75 characters
wide.
"""
return foldline(self).encode(DEFAULT_ENCODING)
class Contentlines(list):
"""I assume that iCalendar files generally are a few kilobytes in size.
Then this should be efficient. for Huge files, an iterator should probably
be used instead.
"""
def to_ical(self):
"""Simply join self."""
return b"\r\n".join(line.to_ical() for line in self if line) + b"\r\n"
@classmethod
def from_ical(cls, st):
"""Parses a string into content lines."""
st = to_unicode(st)
try:
# a fold is carriage return followed by either a space or a tab
unfolded = uFOLD.sub("", st)
lines = cls(Contentline(line) for line in NEWLINE.split(unfolded) if line)
lines.append("") # '\r\n' at the end of every content line
return lines
except Exception:
raise ValueError("Expected StringType with content lines")
__all__ = [
"Contentline",
"Contentlines",
"FOLD",
"NAME",
"NEWLINE",
"Parameters",
"QUNSAFE_CHAR",
"QUOTABLE",
"UNSAFE_CHAR",
"dquote",
"escape_char",
"escape_string",
"foldline",
"param_value",
"q_join",
"q_split",
"rfc_6868_escape",
"rfc_6868_unescape",
"uFOLD",
"unescape_char",
"unescape_list_or_string",
"unescape_string",
"validate_param_value",
"validate_token",
]
