300766277

Build Type

push

github

Committed by Unrud

Commit Message

Cancel mkcalendar request on error

Run Details

1222 of 1579 branches covered (77.39%)

Branch coverage included in aggregate %.

0 of 1 new or added line in 1 file covered. (0.0%)

18 existing lines in 1 file now uncovered.

2913 of 3467 relevant lines covered (84.02%)

12.59 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

77.89

/radicale/item/__init__.py

# This file is part of Radicale Server - Calendar Server
# Copyright © 2008 Nicolas Kandel
# Copyright © 2008 Pascal Halter
# Copyright © 2014 Jean-Marc Martins
# Copyright © 2008-2017 Guillaume Ayoub
# Copyright © 2017-2018 Unrud <unrud@outlook.com>
#
# This library 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 3 of the License, or
# (at your option) any later version.
#
# This library 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 Radicale.  If not, see <http://www.gnu.org/licenses/>.

"""
Module for address books and calendar entries (see ``Item``).

"""

import binascii
import math
import os
import sys
from datetime import timedelta
from hashlib import sha256

import vobject

from radicale import pathutils
from radicale.item import filter as radicale_filter
from radicale.log import logger


def predict_tag_of_parent_collection(vobject_items):
    if len(vobject_items) != 1:
        return ""
    if vobject_items[0].name == "VCALENDAR":
        return "VCALENDAR"
    if vobject_items[0].name in ("VCARD", "VLIST"):
        return "VADDRESSBOOK"
    return ""


def predict_tag_of_whole_collection(vobject_items, fallback_tag=None):
    if vobject_items and vobject_items[0].name == "VCALENDAR":
        return "VCALENDAR"
    if vobject_items and vobject_items[0].name in ("VCARD", "VLIST"):
        return "VADDRESSBOOK"
    if not fallback_tag and not vobject_items:
        # Maybe an empty address book
        return "VADDRESSBOOK"
    return fallback_tag


def check_and_sanitize_items(vobject_items, is_collection=False, tag=None):
    """Check vobject items for common errors and add missing UIDs.

    ``is_collection`` indicates that vobject_item contains unrelated
    components.

    The ``tag`` of the collection.

    """
    if tag and tag not in ("VCALENDAR", "VADDRESSBOOK"):
        raise ValueError("Unsupported collection tag: %r" % tag)
    if not is_collection and len(vobject_items) != 1:
        raise ValueError("Item contains %d components" % len(vobject_items))
    if tag == "VCALENDAR":
        if len(vobject_items) > 1:
            raise RuntimeError("VCALENDAR collection contains %d "
                               "components" % len(vobject_items))
        vobject_item = vobject_items[0]
        if vobject_item.name != "VCALENDAR":
            raise ValueError("Item type %r not supported in %r "
                             "collection" % (vobject_item.name, tag))
        component_uids = set()
        for component in vobject_item.components():
            if component.name in ("VTODO", "VEVENT", "VJOURNAL"):
                component_uid = get_uid(component)
                if component_uid:
                    component_uids.add(component_uid)
        component_name = None
        object_uid = None
        object_uid_set = False
        for component in vobject_item.components():
            # https://tools.ietf.org/html/rfc4791#section-4.1
            if component.name == "VTIMEZONE":
                continue
            if component_name is None or is_collection:
                component_name = component.name
            elif component_name != component.name:
                raise ValueError("Multiple component types in object: %r, %r" %
                                 (component_name, component.name))
            if component_name not in ("VTODO", "VEVENT", "VJOURNAL"):
                continue
            component_uid = get_uid(component)
            if not object_uid_set or is_collection:
                object_uid_set = True
                object_uid = component_uid
                if not component_uid:
                    if not is_collection:
                        raise ValueError("%s component without UID in object" %
                                         component_name)
                    component_uid = find_available_uid(
                        component_uids.__contains__)
                    component_uids.add(component_uid)
                    if hasattr(component, "uid"):
                        component.uid.value = component_uid
                    else:
                        component.add("UID").value = component_uid
            elif not object_uid or not component_uid:
                raise ValueError("Multiple %s components without UID in "
                                 "object" % component_name)
            elif object_uid != component_uid:
                raise ValueError(
                    "Multiple %s components with different UIDs in object: "
                    "%r, %r" % (component_name, object_uid, component_uid))
            # Workaround for bug in Lightning (Thunderbird)
            # Rescheduling a single occurrence from a repeating event creates
            # an event with DTEND and DURATION:PT0S
            if (hasattr(component, "dtend") and
                    hasattr(component, "duration") and
                    component.duration.value == timedelta(0)):
                logger.debug("Quirks: Removing zero duration from %s in "
                             "object %r", component_name, component_uid)
                del component.duration
            # vobject interprets recurrence rules on demand
            try:
                component.rruleset
            except Exception as e:
                raise ValueError("Invalid recurrence rules in %s in object %r"
                                 % (component.name, component_uid)) from e
    elif tag == "VADDRESSBOOK":
        # https://tools.ietf.org/html/rfc6352#section-5.1
        object_uids = set()
        for vobject_item in vobject_items:
            if vobject_item.name == "VCARD":
                object_uid = get_uid(vobject_item)
                if object_uid:
                    object_uids.add(object_uid)
        for vobject_item in vobject_items:
            if vobject_item.name == "VLIST":
                # Custom format used by SOGo Connector to store lists of
                # contacts
                continue
            if vobject_item.name != "VCARD":
                raise ValueError("Item type %r not supported in %r "
                                 "collection" % (vobject_item.name, tag))
            object_uid = get_uid(vobject_item)
            if not object_uid:
                if not is_collection:
                    raise ValueError("%s object without UID" %
                                     vobject_item.name)
                object_uid = find_available_uid(object_uids.__contains__)
                object_uids.add(object_uid)
                if hasattr(vobject_item, "uid"):
                    vobject_item.uid.value = object_uid
                else:
                    vobject_item.add("UID").value = object_uid
    else:
        for i in vobject_items:
            raise ValueError("Item type %r not supported in %s collection" %
                             (i.name, repr(tag) if tag else "generic"))


def check_and_sanitize_props(props):
    """Check collection properties for common errors."""
    for k, v in props.copy().items():  # Make copy to be able to delete items
        if not isinstance(k, str):
            raise ValueError("Key must be %r not %r: %r" % (
                str.__name__, type(k).__name__, k))
        if not isinstance(v, str):
            if v is None:
                del props[k]
                continue
            raise ValueError("Value of %r must be %r not %r: %r" % (
                k, str.__name__, type(v).__name__, v))
        if k == "tag":
            if not v:
                del props[k]
                continue
            if v not in ("VCALENDAR", "VADDRESSBOOK"):
                raise ValueError("Unsupported collection tag: %r" % v)


def find_available_uid(exists_fn, suffix=""):
    """Generate a pseudo-random UID"""
    # Prevent infinite loop
    for _ in range(1000):
        r = binascii.hexlify(os.urandom(16)).decode("ascii")
        name = "%s-%s-%s-%s-%s%s" % (
            r[:8], r[8:12], r[12:16], r[16:20], r[20:], suffix)
        if not exists_fn(name):
            return name
    # something is wrong with the PRNG
    raise RuntimeError("No unique random sequence found")


def get_etag(text):
    """Etag from collection or item.

    Encoded as quoted-string (see RFC 2616).

    """
    etag = sha256()
    etag.update(text.encode())
    return '"%s"' % etag.hexdigest()


def get_uid(vobject_component):
    """UID value of an item if defined."""
    return (vobject_component.uid.value
            if hasattr(vobject_component, "uid") else None)


def get_uid_from_object(vobject_item):
    """UID value of an calendar/addressbook object."""
    if vobject_item.name == "VCALENDAR":
        if hasattr(vobject_item, "vevent"):
            return get_uid(vobject_item.vevent)
        if hasattr(vobject_item, "vjournal"):
            return get_uid(vobject_item.vjournal)
        if hasattr(vobject_item, "vtodo"):
            return get_uid(vobject_item.vtodo)
    elif vobject_item.name == "VCARD":
        return get_uid(vobject_item)
    return None


def find_tag(vobject_item):
    """Find component name from ``vobject_item``."""
    if vobject_item.name == "VCALENDAR":
        for component in vobject_item.components():
            if component.name != "VTIMEZONE":
                return component.name or ""
    return ""


def find_tag_and_time_range(vobject_item):
    """Find component name and enclosing time range from ``vobject item``.

    Returns a tuple (``tag``, ``start``, ``end``) where ``tag`` is a string
    and ``start`` and ``end`` are POSIX timestamps (as int).

    This is intened to be used for matching against simplified prefilters.

    """
    tag = find_tag(vobject_item)
    if not tag:
        return (
            tag, radicale_filter.TIMESTAMP_MIN, radicale_filter.TIMESTAMP_MAX)
    start = end = None

    def range_fn(range_start, range_end, is_recurrence):
        nonlocal start, end
        if start is None or range_start < start:
            start = range_start
        if end is None or end < range_end:
            end = range_end
        return False

    def infinity_fn(range_start):
        nonlocal start, end
        if start is None or range_start < start:
            start = range_start
        end = radicale_filter.DATETIME_MAX
        return True

    radicale_filter.visit_time_ranges(vobject_item, tag, range_fn, infinity_fn)
    if start is None:
        start = radicale_filter.DATETIME_MIN
    if end is None:
        end = radicale_filter.DATETIME_MAX
    try:
        return tag, math.floor(start.timestamp()), math.ceil(end.timestamp())
    except ValueError as e:
        if str(e) == ("offset must be a timedelta representing a whole "
                      "number of minutes") and sys.version_info < (3, 6):
            raise RuntimeError("Unsupported in Python < 3.6: %s" % e) from e
        raise


class Item:
    """Class for address book and calendar entries."""

    def __init__(self, collection_path=None, collection=None,
                 vobject_item=None, href=None, last_modified=None, text=None,
                 etag=None, uid=None, name=None, component_name=None,
                 time_range=None):
        """Initialize an item.

        ``collection_path`` the path of the parent collection (optional if
        ``collection`` is set).

        ``collection`` the parent collection (optional).

        ``href`` the href of the item.

        ``last_modified`` the HTTP-datetime of when the item was modified.

        ``text`` the text representation of the item (optional if
        ``vobject_item`` is set).

        ``vobject_item`` the vobject item (optional if ``text`` is set).

        ``etag`` the etag of the item (optional). See ``get_etag``.

        ``uid`` the UID of the object (optional). See ``get_uid_from_object``.

        ``name`` the name of the item (optional). See ``vobject_item.name``.

        ``component_name`` the name of the primary component (optional).
        See ``find_tag``.

        ``time_range`` the enclosing time range.
        See ``find_tag_and_time_range``.

        """
        if text is None and vobject_item is None:
            raise ValueError(
                "At least one of 'text' or 'vobject_item' must be set")
        if collection_path is None:
            if collection is None:
                raise ValueError("At least one of 'collection_path' or "
                                 "'collection' must be set")
            collection_path = collection.path
        assert collection_path == pathutils.strip_path(
            pathutils.sanitize_path(collection_path))
        self._collection_path = collection_path
        self.collection = collection
        self.href = href
        self.last_modified = last_modified
        self._text = text
        self._vobject_item = vobject_item
        self._etag = etag
        self._uid = uid
        self._name = name
        self._component_name = component_name
        self._time_range = time_range

    def serialize(self):
        if self._text is None:
            try:
                self._text = self.vobject_item.serialize()
            except Exception as e:
                raise RuntimeError("Failed to serialize item %r from %r: %s" %
                                   (self.href, self._collection_path,
                                    e)) from e
        return self._text

    @property
    def vobject_item(self):
        if self._vobject_item is None:
            try:
                self._vobject_item = vobject.readOne(self._text)
            except Exception as e:
                raise RuntimeError("Failed to parse item %r from %r: %s" %
                                   (self.href, self._collection_path,
                                    e)) from e
        return self._vobject_item

    @property
    def etag(self):
        """Encoded as quoted-string (see RFC 2616)."""
        if self._etag is None:
            self._etag = get_etag(self.serialize())
        return self._etag

    @property
    def uid(self):
        if self._uid is None:
            self._uid = get_uid_from_object(self.vobject_item)
        return self._uid

    @property
    def name(self):
        if self._name is None:
            self._name = self.vobject_item.name or ""
        return self._name

    @property
    def component_name(self):
        if self._component_name is not None:
            return self._component_name
        return find_tag(self.vobject_item)

    @property
    def time_range(self):
        if self._time_range is None:
            self._component_name, *self._time_range = (
                find_tag_and_time_range(self.vobject_item))
        return self._time_range

    def prepare(self):
        """Fill cache with values."""
        orig_vobject_item = self._vobject_item
        self.serialize()
        self.etag
        self.uid
        self.name
        self.time_range
        self.component_name
        self._vobject_item = orig_vobject_item

1	# This file is part of Radicale Server - Calendar Server
2	# Copyright © 2008 Nicolas Kandel
3	# Copyright © 2008 Pascal Halter
4	# Copyright © 2014 Jean-Marc Martins
5	# Copyright © 2008-2017 Guillaume Ayoub
6	# Copyright © 2017-2018 Unrud <unrud@outlook.com>
7	#
8	# This library is free software: you can redistribute it and/or modify
9	# it under the terms of the GNU General Public License as published by
10	# the Free Software Foundation, either version 3 of the License, or
11	# (at your option) any later version.
12	#
13	# This library is distributed in the hope that it will be useful,
14	# but WITHOUT ANY WARRANTY; without even the implied warranty of
15	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16	# GNU General Public License for more details.
17	#
18	# You should have received a copy of the GNU General Public License
19	# along with Radicale. If not, see <http://www.gnu.org/licenses/>.
20
21	"""	15✔
22	Module for address books and calendar entries (see ``Item``).
23
24	"""
25
26	import binascii	15✔
27	import math	15✔
28	import os	15✔
29	import sys	15✔
30	from datetime import timedelta	15✔
31	from hashlib import sha256	15✔
32
33	import vobject	15✔
34
35	from radicale import pathutils	15✔
36	from radicale.item import filter as radicale_filter	15✔
37	from radicale.log import logger	15✔
38
39
40	def predict_tag_of_parent_collection(vobject_items):	15✔
41	if len(vobject_items) != 1:	15!
42	return ""	×
43	if vobject_items[0].name == "VCALENDAR":	15!
44	return "VCALENDAR"	15✔
45	if vobject_items[0].name in ("VCARD", "VLIST"):	×
46	return "VADDRESSBOOK"	×
47	return ""	×
48
49
50	def predict_tag_of_whole_collection(vobject_items, fallback_tag=None):	15✔
51	if vobject_items and vobject_items[0].name == "VCALENDAR":	15✔
52	return "VCALENDAR"	15✔
53	if vobject_items and vobject_items[0].name in ("VCARD", "VLIST"):	15!
54	return "VADDRESSBOOK"	15✔
55	if not fallback_tag and not vobject_items:	×
56	# Maybe an empty address book
57	return "VADDRESSBOOK"	×
58	return fallback_tag	×
59
60
61	def check_and_sanitize_items(vobject_items, is_collection=False, tag=None):	15✔
62	"""Check vobject items for common errors and add missing UIDs.
63
64	``is_collection`` indicates that vobject_item contains unrelated
65	components.
66
67	The ``tag`` of the collection.
68
69	"""
70	if tag and tag not in ("VCALENDAR", "VADDRESSBOOK"):	15!
71	raise ValueError("Unsupported collection tag: %r" % tag)	×
72	if not is_collection and len(vobject_items) != 1:	15!
73	raise ValueError("Item contains %d components" % len(vobject_items))	×
74	if tag == "VCALENDAR":	15✔
75	if len(vobject_items) > 1:	15!
76	raise RuntimeError("VCALENDAR collection contains %d "	×
77	"components" % len(vobject_items))
78	vobject_item = vobject_items[0]	15✔
79	if vobject_item.name != "VCALENDAR":	15!
80	raise ValueError("Item type %r not supported in %r "	×
81	"collection" % (vobject_item.name, tag))
82	component_uids = set()	15✔
83	for component in vobject_item.components():	15✔
84	if component.name in ("VTODO", "VEVENT", "VJOURNAL"):	15✔
85	component_uid = get_uid(component)	15✔
86	if component_uid:	15✔
87	component_uids.add(component_uid)	15✔
88	component_name = None	15✔
89	object_uid = None	15✔
90	object_uid_set = False	15✔
91	for component in vobject_item.components():	15✔
92	# https://tools.ietf.org/html/rfc4791#section-4.1
93	if component.name == "VTIMEZONE":	15✔
94	continue	15✔
95	if component_name is None or is_collection:	15✔
96	component_name = component.name	15✔
97	elif component_name != component.name:	15!
98	raise ValueError("Multiple component types in object: %r, %r" %	×
99	(component_name, component.name))
100	if component_name not in ("VTODO", "VEVENT", "VJOURNAL"):	15!
101	continue	×
102	component_uid = get_uid(component)	15✔
103	if not object_uid_set or is_collection:	15✔
104	object_uid_set = True	15✔
105	object_uid = component_uid	15✔
106	if not component_uid:	15✔
107	if not is_collection:	15✔
108	raise ValueError("%s component without UID in object" %	15✔
109	component_name)
110	component_uid = find_available_uid(	15✔
111	component_uids.__contains__)
112	component_uids.add(component_uid)	15✔
113	if hasattr(component, "uid"):	15!
114	component.uid.value = component_uid	×
115	else:
116	component.add("UID").value = component_uid	15✔
117	elif not object_uid or not component_uid:	15!
118	raise ValueError("Multiple %s components without UID in "	×
119	"object" % component_name)
120	elif object_uid != component_uid:	15!
121	raise ValueError(	×
122	"Multiple %s components with different UIDs in object: "
123	"%r, %r" % (component_name, object_uid, component_uid))
124	# Workaround for bug in Lightning (Thunderbird)
125	# Rescheduling a single occurrence from a repeating event creates
126	# an event with DTEND and DURATION:PT0S
127	if (hasattr(component, "dtend") and	15!
128	hasattr(component, "duration") and
129	component.duration.value == timedelta(0)):
130	logger.debug("Quirks: Removing zero duration from %s in "	×
131	"object %r", component_name, component_uid)
132	del component.duration	×
133	# vobject interprets recurrence rules on demand
134	try:	15✔
135	component.rruleset	15✔
136	except Exception as e:	×
137	raise ValueError("Invalid recurrence rules in %s in object %r"	×
138	% (component.name, component_uid)) from e
139	elif tag == "VADDRESSBOOK":	15!
140	# https://tools.ietf.org/html/rfc6352#section-5.1
141	object_uids = set()	15✔
142	for vobject_item in vobject_items:	15✔
143	if vobject_item.name == "VCARD":	15!
144	object_uid = get_uid(vobject_item)	15✔
145	if object_uid:	15✔
146	object_uids.add(object_uid)	15✔
147	for vobject_item in vobject_items:	15✔
148	if vobject_item.name == "VLIST":	15!
149	# Custom format used by SOGo Connector to store lists of
150	# contacts
151	continue	×
152	if vobject_item.name != "VCARD":	15!
153	raise ValueError("Item type %r not supported in %r "	×
154	"collection" % (vobject_item.name, tag))
155	object_uid = get_uid(vobject_item)	15✔
156	if not object_uid:	15✔
157	if not is_collection:	15✔
158	raise ValueError("%s object without UID" %	15✔
159	vobject_item.name)
160	object_uid = find_available_uid(object_uids.__contains__)	15✔
161	object_uids.add(object_uid)	15✔
162	if hasattr(vobject_item, "uid"):	15!
163	vobject_item.uid.value = object_uid	×
164	else:
165	vobject_item.add("UID").value = object_uid	15✔
166	else:
167	for i in vobject_items:	×
168	raise ValueError("Item type %r not supported in %s collection" %	×
169	(i.name, repr(tag) if tag else "generic"))
170
171
172	def check_and_sanitize_props(props):	15✔
173	"""Check collection properties for common errors."""
174	for k, v in props.copy().items(): # Make copy to be able to delete items	15✔
175	if not isinstance(k, str):	15!
176	raise ValueError("Key must be %r not %r: %r" % (	×
177	str.__name__, type(k).__name__, k))
178	if not isinstance(v, str):	15!
UNCOV 179	if v is None:	×
UNCOV 180	del props[k]	×
UNCOV 181	continue	×
UNCOV 182	raise ValueError("Value of %r must be %r not %r: %r" % (	×
183	k, str.__name__, type(v).__name__, v))
184	if k == "tag":	15✔
185	if not v:	15!
UNCOV 186	del props[k]	×
UNCOV 187	continue	×
188	if v not in ("VCALENDAR", "VADDRESSBOOK"):	15!
189	raise ValueError("Unsupported collection tag: %r" % v)	×
190
191
192	def find_available_uid(exists_fn, suffix=""):	15✔
193	"""Generate a pseudo-random UID"""
194	# Prevent infinite loop
195	for _ in range(1000):	15!
196	r = binascii.hexlify(os.urandom(16)).decode("ascii")	15✔
197	name = "%s-%s-%s-%s-%s%s" % (	15✔
198	r[:8], r[8:12], r[12:16], r[16:20], r[20:], suffix)
199	if not exists_fn(name):	15!
200	return name	15✔
201	# something is wrong with the PRNG
UNCOV 202	raise RuntimeError("No unique random sequence found")	×
203
204
205	def get_etag(text):	15✔
206	"""Etag from collection or item.
207
208	Encoded as quoted-string (see RFC 2616).
209
210	"""
211	etag = sha256()	15✔
212	etag.update(text.encode())	15✔
213	return '"%s"' % etag.hexdigest()	15✔
214
215
216	def get_uid(vobject_component):	15✔
217	"""UID value of an item if defined."""
218	return (vobject_component.uid.value	15✔
219	if hasattr(vobject_component, "uid") else None)
220
221
222	def get_uid_from_object(vobject_item):	15✔
223	"""UID value of an calendar/addressbook object."""
224	if vobject_item.name == "VCALENDAR":	15✔
225	if hasattr(vobject_item, "vevent"):	15✔
226	return get_uid(vobject_item.vevent)	15✔
227	if hasattr(vobject_item, "vjournal"):	15✔
228	return get_uid(vobject_item.vjournal)	15✔
229	if hasattr(vobject_item, "vtodo"):	15!
230	return get_uid(vobject_item.vtodo)	15✔
231	elif vobject_item.name == "VCARD":	15!
232	return get_uid(vobject_item)	15✔
UNCOV 233	return None	×
234
235
236	def find_tag(vobject_item):	15✔
237	"""Find component name from ``vobject_item``."""
238	if vobject_item.name == "VCALENDAR":	15✔
239	for component in vobject_item.components():	15!
240	if component.name != "VTIMEZONE":	15✔
241	return component.name or ""	15✔
242	return ""	15✔
243
244
245	def find_tag_and_time_range(vobject_item):	15✔
246	"""Find component name and enclosing time range from ``vobject item``.
247
248	Returns a tuple (``tag``, ``start``, ``end``) where ``tag`` is a string
249	and ``start`` and ``end`` are POSIX timestamps (as int).
250
251	This is intened to be used for matching against simplified prefilters.
252
253	"""
254	tag = find_tag(vobject_item)	15✔
255	if not tag:	15✔
256	return (	15✔
257	tag, radicale_filter.TIMESTAMP_MIN, radicale_filter.TIMESTAMP_MAX)
258	start = end = None	15✔
259
260	def range_fn(range_start, range_end, is_recurrence):	15✔
261	nonlocal start, end
262	if start is None or range_start < start:	15✔
263	start = range_start	15✔
264	if end is None or end < range_end:	15✔
265	end = range_end	15✔
266	return False	15✔
267
268	def infinity_fn(range_start):	15✔
269	nonlocal start, end
270	if start is None or range_start < start:	15✔
271	start = range_start	15✔
272	end = radicale_filter.DATETIME_MAX	15✔
273	return True	15✔
274
275	radicale_filter.visit_time_ranges(vobject_item, tag, range_fn, infinity_fn)	15✔
276	if start is None:	15✔
277	start = radicale_filter.DATETIME_MIN	15✔
278	if end is None:	15✔
279	end = radicale_filter.DATETIME_MAX	15✔
280	try:	15✔
281	return tag, math.floor(start.timestamp()), math.ceil(end.timestamp())	15✔
UNCOV 282	except ValueError as e:	×
UNCOV 283	if str(e) == ("offset must be a timedelta representing a whole "	×
284	"number of minutes") and sys.version_info < (3, 6):
UNCOV 285	raise RuntimeError("Unsupported in Python < 3.6: %s" % e) from e	×
UNCOV 286	raise	×
287
288
289	class Item:	15✔
290	"""Class for address book and calendar entries."""
291
292	def __init__(self, collection_path=None, collection=None,	15✔
293	vobject_item=None, href=None, last_modified=None, text=None,
294	etag=None, uid=None, name=None, component_name=None,
295	time_range=None):
296	"""Initialize an item.
297
298	``collection_path`` the path of the parent collection (optional if
299	``collection`` is set).
300
301	``collection`` the parent collection (optional).
302
303	``href`` the href of the item.
304
305	``last_modified`` the HTTP-datetime of when the item was modified.
306
307	``text`` the text representation of the item (optional if
308	``vobject_item`` is set).
309
310	``vobject_item`` the vobject item (optional if ``text`` is set).
311
312	``etag`` the etag of the item (optional). See ``get_etag``.
313
314	``uid`` the UID of the object (optional). See ``get_uid_from_object``.
315
316	``name`` the name of the item (optional). See ``vobject_item.name``.
317
318	``component_name`` the name of the primary component (optional).
319	See ``find_tag``.
320
321	``time_range`` the enclosing time range.
322	See ``find_tag_and_time_range``.
323
324	"""
325	if text is None and vobject_item is None:	15!
UNCOV 326	raise ValueError(	×
327	"At least one of 'text' or 'vobject_item' must be set")
328	if collection_path is None:	15✔
329	if collection is None:	15!
UNCOV 330	raise ValueError("At least one of 'collection_path' or "	×
331	"'collection' must be set")
332	collection_path = collection.path	15✔
333	assert collection_path == pathutils.strip_path(	15✔
334	pathutils.sanitize_path(collection_path))
335	self._collection_path = collection_path	15✔
336	self.collection = collection	15✔
337	self.href = href	15✔
338	self.last_modified = last_modified	15✔
339	self._text = text	15✔
340	self._vobject_item = vobject_item	15✔
341	self._etag = etag	15✔
342	self._uid = uid	15✔
343	self._name = name	15✔
344	self._component_name = component_name	15✔
345	self._time_range = time_range	15✔
346
347	def serialize(self):	15✔
348	if self._text is None:	15✔
349	try:	15✔
350	self._text = self.vobject_item.serialize()	15✔
UNCOV 351	except Exception as e:	×
UNCOV 352	raise RuntimeError("Failed to serialize item %r from %r: %s" %	×
353	(self.href, self._collection_path,
354	e)) from e
355	return self._text	15✔
356
357	@property	15✔
358	def vobject_item(self):	6✔
359	if self._vobject_item is None:	15✔
360	try:	15✔
361	self._vobject_item = vobject.readOne(self._text)	15✔
UNCOV 362	except Exception as e:	×
UNCOV 363	raise RuntimeError("Failed to parse item %r from %r: %s" %	×
364	(self.href, self._collection_path,
365	e)) from e
366	return self._vobject_item	15✔
367
368	@property	15✔
369	def etag(self):	6✔
370	"""Encoded as quoted-string (see RFC 2616)."""
371	if self._etag is None:	15✔
372	self._etag = get_etag(self.serialize())	15✔
373	return self._etag	15✔
374
375	@property	15✔
376	def uid(self):	6✔
377	if self._uid is None:	15✔
378	self._uid = get_uid_from_object(self.vobject_item)	15✔
379	return self._uid	15✔
380
381	@property	15✔
382	def name(self):	6✔
383	if self._name is None:	15✔
384	self._name = self.vobject_item.name or ""	15✔
385	return self._name	15✔
386
387	@property	15✔
388	def component_name(self):	6✔
389	if self._component_name is not None:	15✔
390	return self._component_name	15✔
391	return find_tag(self.vobject_item)	15✔
392
393	@property	15✔
394	def time_range(self):	6✔
395	if self._time_range is None:	15✔
396	self._component_name, *self._time_range = (	15✔
397	find_tag_and_time_range(self.vobject_item))
398	return self._time_range	15✔
399
400	def prepare(self):	15✔
401	"""Fill cache with values."""
402	orig_vobject_item = self._vobject_item	15✔
403	self.serialize()	15✔
404	self.etag	15✔
405	self.uid	15✔
406	self.name	15✔
407	self.time_range	15✔
408	self.component_name	15✔
409	self._vobject_item = orig_vobject_item	15✔

Kozea / Radicale / 300766277

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous