report.py 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746
  1. # This file is part of Radicale - CalDAV and CardDAV server
  2. # Copyright © 2008 Nicolas Kandel
  3. # Copyright © 2008 Pascal Halter
  4. # Copyright © 2008-2017 Guillaume Ayoub
  5. # Copyright © 2017-2021 Unrud <unrud@outlook.com>
  6. # Copyright © 2024-2024 Pieter Hijma <pieterhijma@users.noreply.github.com>
  7. # Copyright © 2024-2024 Ray <ray@react0r.com>
  8. # Copyright © 2024-2024 Georgiy <metallerok@gmail.com>
  9. # Copyright © 2024-2025 Peter Bieringer <pb@bieringer.de>
  10. #
  11. # This library is free software: you can redistribute it and/or modify
  12. # it under the terms of the GNU General Public License as published by
  13. # the Free Software Foundation, either version 3 of the License, or
  14. # (at your option) any later version.
  15. #
  16. # This library is distributed in the hope that it will be useful,
  17. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  18. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19. # GNU General Public License for more details.
  20. #
  21. # You should have received a copy of the GNU General Public License
  22. # along with Radicale. If not, see <http://www.gnu.org/licenses/>.
  23. import contextlib
  24. import copy
  25. import datetime
  26. import posixpath
  27. import socket
  28. import xml.etree.ElementTree as ET
  29. from http import client
  30. from typing import (Callable, Iterable, Iterator, List, Optional, Sequence,
  31. Tuple, Union)
  32. from urllib.parse import unquote, urlparse
  33. import vobject
  34. import vobject.base
  35. from vobject.base import ContentLine
  36. import radicale.item as radicale_item
  37. from radicale import httputils, pathutils, storage, types, xmlutils
  38. from radicale.app.base import Access, ApplicationBase
  39. from radicale.item import filter as radicale_filter
  40. from radicale.log import logger
  41. def free_busy_report(base_prefix: str, path: str, xml_request: Optional[ET.Element],
  42. collection: storage.BaseCollection, encoding: str,
  43. unlock_storage_fn: Callable[[], None],
  44. max_occurrence: int
  45. ) -> Tuple[int, Union[ET.Element, str]]:
  46. # NOTE: this function returns both an Element and a string because
  47. # free-busy reports are an edge-case on the return type according
  48. # to the spec.
  49. multistatus = ET.Element(xmlutils.make_clark("D:multistatus"))
  50. if xml_request is None:
  51. return client.MULTI_STATUS, multistatus
  52. root = xml_request
  53. if (root.tag == xmlutils.make_clark("C:free-busy-query") and
  54. collection.tag != "VCALENDAR"):
  55. logger.warning("Invalid REPORT method %r on %r requested",
  56. xmlutils.make_human_tag(root.tag), path)
  57. return client.FORBIDDEN, xmlutils.webdav_error("D:supported-report")
  58. time_range_element = root.find(xmlutils.make_clark("C:time-range"))
  59. assert isinstance(time_range_element, ET.Element)
  60. # Build a single filter from the free busy query for retrieval
  61. # TODO: filter for VFREEBUSY in additional to VEVENT but
  62. # test_filter doesn't support that yet.
  63. vevent_cf_element = ET.Element(xmlutils.make_clark("C:comp-filter"),
  64. attrib={'name': 'VEVENT'})
  65. vevent_cf_element.append(time_range_element)
  66. vcalendar_cf_element = ET.Element(xmlutils.make_clark("C:comp-filter"),
  67. attrib={'name': 'VCALENDAR'})
  68. vcalendar_cf_element.append(vevent_cf_element)
  69. filter_element = ET.Element(xmlutils.make_clark("C:filter"))
  70. filter_element.append(vcalendar_cf_element)
  71. filters = (filter_element,)
  72. # First pull from storage
  73. retrieved_items = list(collection.get_filtered(filters))
  74. # !!! Don't access storage after this !!!
  75. unlock_storage_fn()
  76. cal = vobject.iCalendar()
  77. collection_tag = collection.tag
  78. while retrieved_items:
  79. # Second filtering before evaluating occurrences.
  80. # ``item.vobject_item`` might be accessed during filtering.
  81. # Don't keep reference to ``item``, because VObject requires a lot of
  82. # memory.
  83. item, filter_matched = retrieved_items.pop(0)
  84. if not filter_matched:
  85. try:
  86. if not test_filter(collection_tag, item, filter_element):
  87. continue
  88. except ValueError as e:
  89. raise ValueError("Failed to free-busy filter item %r from %r: %s" %
  90. (item.href, collection.path, e)) from e
  91. except Exception as e:
  92. raise RuntimeError("Failed to free-busy filter item %r from %r: %s" %
  93. (item.href, collection.path, e)) from e
  94. fbtype = None
  95. if item.component_name == 'VEVENT':
  96. transp = getattr(item.vobject_item.vevent, 'transp', None)
  97. if transp and transp.value != 'OPAQUE':
  98. continue
  99. status = getattr(item.vobject_item.vevent, 'status', None)
  100. if not status or status.value == 'CONFIRMED':
  101. fbtype = 'BUSY'
  102. elif status.value == 'CANCELLED':
  103. fbtype = 'FREE'
  104. elif status.value == 'TENTATIVE':
  105. fbtype = 'BUSY-TENTATIVE'
  106. else:
  107. # Could do fbtype = status.value for x-name, I prefer this
  108. fbtype = 'BUSY'
  109. # TODO: coalesce overlapping periods
  110. if max_occurrence > 0:
  111. n_occurrences = max_occurrence+1
  112. else:
  113. n_occurrences = 0
  114. occurrences = radicale_filter.time_range_fill(item.vobject_item,
  115. time_range_element,
  116. "VEVENT",
  117. n=n_occurrences)
  118. if len(occurrences) >= max_occurrence:
  119. raise ValueError("FREEBUSY occurrences limit of {} hit"
  120. .format(max_occurrence))
  121. for occurrence in occurrences:
  122. vfb = cal.add('vfreebusy')
  123. vfb.add('dtstamp').value = item.vobject_item.vevent.dtstamp.value
  124. vfb.add('dtstart').value, vfb.add('dtend').value = occurrence
  125. if fbtype:
  126. vfb.add('fbtype').value = fbtype
  127. return (client.OK, cal.serialize())
  128. def xml_report(base_prefix: str, path: str, xml_request: Optional[ET.Element],
  129. collection: storage.BaseCollection, encoding: str,
  130. unlock_storage_fn: Callable[[], None]
  131. ) -> Tuple[int, ET.Element]:
  132. """Read and answer REPORT requests that return XML.
  133. Read rfc3253-3.6 for info.
  134. """
  135. multistatus = ET.Element(xmlutils.make_clark("D:multistatus"))
  136. if xml_request is None:
  137. return client.MULTI_STATUS, multistatus
  138. root = xml_request
  139. if root.tag in (xmlutils.make_clark("D:principal-search-property-set"),
  140. xmlutils.make_clark("D:principal-property-search"),
  141. xmlutils.make_clark("D:expand-property")):
  142. # We don't support searching for principals or indirect retrieving of
  143. # properties, just return an empty result.
  144. # InfCloud asks for expand-property reports (even if we don't announce
  145. # support for them) and stops working if an error code is returned.
  146. logger.warning("Unsupported REPORT method %r on %r requested",
  147. xmlutils.make_human_tag(root.tag), path)
  148. return client.MULTI_STATUS, multistatus
  149. if (root.tag == xmlutils.make_clark("C:calendar-multiget") and
  150. collection.tag != "VCALENDAR" or
  151. root.tag == xmlutils.make_clark("CR:addressbook-multiget") and
  152. collection.tag != "VADDRESSBOOK" or
  153. root.tag == xmlutils.make_clark("D:sync-collection") and
  154. collection.tag not in ("VADDRESSBOOK", "VCALENDAR")):
  155. logger.warning("Invalid REPORT method %r on %r requested",
  156. xmlutils.make_human_tag(root.tag), path)
  157. return client.FORBIDDEN, xmlutils.webdav_error("D:supported-report")
  158. props: Union[ET.Element, List]
  159. if root.find(xmlutils.make_clark("D:prop")) is not None:
  160. props = root.find(xmlutils.make_clark("D:prop")) # type: ignore[assignment]
  161. else:
  162. props = []
  163. hreferences: Iterable[str]
  164. if root.tag in (
  165. xmlutils.make_clark("C:calendar-multiget"),
  166. xmlutils.make_clark("CR:addressbook-multiget")):
  167. # Read rfc4791-7.9 for info
  168. hreferences = set()
  169. for href_element in root.findall(xmlutils.make_clark("D:href")):
  170. temp_url_path = urlparse(href_element.text).path
  171. assert isinstance(temp_url_path, str)
  172. href_path = pathutils.sanitize_path(unquote(temp_url_path))
  173. if (href_path + "/").startswith(base_prefix + "/"):
  174. hreferences.add(href_path[len(base_prefix):])
  175. else:
  176. logger.warning("Skipping invalid path %r in REPORT request on "
  177. "%r", href_path, path)
  178. elif root.tag == xmlutils.make_clark("D:sync-collection"):
  179. old_sync_token_element = root.find(
  180. xmlutils.make_clark("D:sync-token"))
  181. old_sync_token = ""
  182. if old_sync_token_element is not None and old_sync_token_element.text:
  183. old_sync_token = old_sync_token_element.text.strip()
  184. logger.debug("Client provided sync token: %r", old_sync_token)
  185. try:
  186. sync_token, names = collection.sync(old_sync_token)
  187. except ValueError as e:
  188. # Invalid sync token
  189. logger.warning("Client provided invalid sync token %r: %s",
  190. old_sync_token, e, exc_info=True)
  191. # client.CONFLICT doesn't work with some clients (e.g. InfCloud)
  192. return (client.FORBIDDEN,
  193. xmlutils.webdav_error("D:valid-sync-token"))
  194. hreferences = (pathutils.unstrip_path(
  195. posixpath.join(collection.path, n)) for n in names)
  196. # Append current sync token to response
  197. sync_token_element = ET.Element(xmlutils.make_clark("D:sync-token"))
  198. sync_token_element.text = sync_token
  199. multistatus.append(sync_token_element)
  200. else:
  201. hreferences = (path,)
  202. filters = (
  203. root.findall(xmlutils.make_clark("C:filter")) +
  204. root.findall(xmlutils.make_clark("CR:filter")))
  205. expand = root.find(".//" + xmlutils.make_clark("C:expand"))
  206. # if we have expand prop we use "filter (except time range) -> expand -> filter (only time range)" approach
  207. time_range_element = None
  208. main_filters = []
  209. for filter_ in filters:
  210. # extract time-range filter for processing after main filters
  211. # for expand request
  212. time_range_element = filter_.find(".//" + xmlutils.make_clark("C:time-range"))
  213. if expand is None or time_range_element is None:
  214. main_filters.append(filter_)
  215. # Retrieve everything required for finishing the request.
  216. retrieved_items = list(retrieve_items(
  217. base_prefix, path, collection, hreferences, main_filters, multistatus))
  218. collection_tag = collection.tag
  219. # !!! Don't access storage after this !!!
  220. unlock_storage_fn()
  221. while retrieved_items:
  222. # ``item.vobject_item`` might be accessed during filtering.
  223. # Don't keep reference to ``item``, because VObject requires a lot of
  224. # memory.
  225. item, filters_matched = retrieved_items.pop(0)
  226. if filters and not filters_matched:
  227. try:
  228. if not all(test_filter(collection_tag, item, filter_)
  229. for filter_ in main_filters):
  230. continue
  231. except ValueError as e:
  232. raise ValueError("Failed to filter item %r from %r: %s" %
  233. (item.href, collection.path, e)) from e
  234. except Exception as e:
  235. raise RuntimeError("Failed to filter item %r from %r: %s" %
  236. (item.href, collection.path, e)) from e
  237. # Filtering non-recurring events by time-range
  238. if (expand is not None) and (time_range_element is not None) and not hasattr(item, 'rrule'):
  239. start, end = radicale_filter.time_range_timestamps(time_range_element)
  240. istart, iend = item.time_range
  241. if istart >= end or iend <= start:
  242. continue
  243. found_props = []
  244. not_found_props = []
  245. for prop in props:
  246. element = ET.Element(prop.tag)
  247. if prop.tag == xmlutils.make_clark("D:getetag"):
  248. element.text = item.etag
  249. found_props.append(element)
  250. elif prop.tag == xmlutils.make_clark("D:getcontenttype"):
  251. element.text = xmlutils.get_content_type(item, encoding)
  252. found_props.append(element)
  253. elif prop.tag in (
  254. xmlutils.make_clark("C:calendar-data"),
  255. xmlutils.make_clark("CR:address-data")):
  256. element.text = item.serialize()
  257. if (expand is not None) and item.component_name == 'VEVENT':
  258. start = expand.get('start')
  259. end = expand.get('end')
  260. if (start is None) or (end is None):
  261. return client.FORBIDDEN, \
  262. xmlutils.webdav_error("C:expand")
  263. start = datetime.datetime.strptime(
  264. start, '%Y%m%dT%H%M%SZ'
  265. ).replace(tzinfo=datetime.timezone.utc)
  266. end = datetime.datetime.strptime(
  267. end, '%Y%m%dT%H%M%SZ'
  268. ).replace(tzinfo=datetime.timezone.utc)
  269. time_range_start = None
  270. time_range_end = None
  271. if time_range_element is not None:
  272. time_range_start, time_range_end = radicale_filter.parse_time_range(time_range_element)
  273. expanded_element = _expand(
  274. element=element, item=copy.copy(item),
  275. start=start, end=end,
  276. time_range_start=time_range_start, time_range_end=time_range_end,
  277. )
  278. found_props.append(expanded_element)
  279. else:
  280. found_props.append(element)
  281. else:
  282. not_found_props.append(element)
  283. assert item.href
  284. uri = pathutils.unstrip_path(
  285. posixpath.join(collection.path, item.href))
  286. multistatus.append(xml_item_response(
  287. base_prefix, uri, found_props=found_props,
  288. not_found_props=not_found_props, found_item=True))
  289. return client.MULTI_STATUS, multistatus
  290. def _expand(
  291. element: ET.Element,
  292. item: radicale_item.Item,
  293. start: datetime.datetime,
  294. end: datetime.datetime,
  295. time_range_start: Optional[datetime.datetime] = None,
  296. time_range_end: Optional[datetime.datetime] = None,
  297. ) -> ET.Element:
  298. vevent_component: vobject.base.Component = copy.copy(item.vobject_item)
  299. logger.info("Expanding event %s", item.href)
  300. # Split the vevents included in the component into one that contains the
  301. # recurrence information and others that contain a recurrence id to
  302. # override instances.
  303. vevent_recurrence, vevents_overridden = _split_overridden_vevents(vevent_component)
  304. dt_format = '%Y%m%dT%H%M%SZ'
  305. all_day_event = False
  306. if type(vevent_recurrence.dtstart.value) is datetime.date:
  307. # If an event comes to us with a dtstart specified as a date
  308. # then in the response we return the date, not datetime
  309. dt_format = '%Y%m%d'
  310. all_day_event = True
  311. # In case of dates, we need to remove timezone information since
  312. # rruleset.between computes with datetimes without timezone information
  313. start = start.replace(tzinfo=None)
  314. end = end.replace(tzinfo=None)
  315. if time_range_start is not None and time_range_end is not None:
  316. time_range_start = time_range_start.replace(tzinfo=None)
  317. time_range_end = time_range_end.replace(tzinfo=None)
  318. for vevent in vevents_overridden:
  319. _strip_single_event(vevent, dt_format)
  320. duration = None
  321. if hasattr(vevent_recurrence, "dtend"):
  322. duration = vevent_recurrence.dtend.value - vevent_recurrence.dtstart.value
  323. # Handle EXDATE to limit expansion range
  324. if hasattr(vevent_recurrence, 'exdate'):
  325. exdates = vevent_recurrence.exdate.value
  326. if not isinstance(exdates, list):
  327. exdates = [exdates]
  328. logger.debug("EXDATE values: %s", exdates)
  329. latest_exdate = max(exdates) if exdates else None
  330. if latest_exdate and end > latest_exdate:
  331. end = min(end, latest_exdate)
  332. rruleset = None
  333. if hasattr(vevent_recurrence, 'rrule'):
  334. rruleset = vevent_recurrence.getrruleset()
  335. filtered_vevents = []
  336. if rruleset:
  337. # This function uses datetimes internally without timezone info for dates
  338. recurrences = rruleset.between(start, end, inc=True)
  339. _strip_component(vevent_component)
  340. _strip_single_event(vevent_recurrence, dt_format)
  341. i_overridden = 0
  342. for recurrence_dt in recurrences:
  343. recurrence_utc = recurrence_dt if all_day_event else recurrence_dt.astimezone(datetime.timezone.utc)
  344. logger.debug("Processing recurrence: %s (all_day_event: %s)", recurrence_utc, all_day_event)
  345. # Apply time-range filter
  346. if time_range_start is not None and time_range_end is not None:
  347. dtstart = recurrence_utc
  348. dtend = dtstart + duration if duration else dtstart
  349. if not (dtstart < time_range_end and dtend > time_range_start):
  350. logger.debug("Recurrence %s filtered out by time-range", recurrence_utc)
  351. continue
  352. # Check for overridden instances
  353. i_overridden, vevent = _find_overridden(i_overridden, vevents_overridden, recurrence_utc, dt_format)
  354. if not vevent:
  355. # Create new instance from recurrence
  356. vevent = copy.deepcopy(vevent_recurrence)
  357. # For all day events, the system timezone may influence the
  358. # results, so use recurrence_dt
  359. recurrence_id = recurrence_dt if all_day_event else recurrence_utc
  360. logger.debug("Creating new VEVENT with RECURRENCE-ID: %s", recurrence_id)
  361. vevent.recurrence_id = ContentLine(
  362. name='RECURRENCE-ID',
  363. value=recurrence_id, params={}
  364. )
  365. _convert_to_utc(vevent, 'recurrence_id', dt_format)
  366. vevent.dtstart = ContentLine(
  367. name='DTSTART',
  368. value=recurrence_id.strftime(dt_format), params={}
  369. )
  370. if duration:
  371. vevent.dtend = ContentLine(
  372. name='DTEND',
  373. value=(recurrence_id + duration).strftime(dt_format), params={}
  374. )
  375. filtered_vevents.append(vevent)
  376. # Filter overridden and recurrence base events
  377. if time_range_start is not None and time_range_end is not None:
  378. for vevent in vevents_overridden + [vevent_recurrence]:
  379. dtstart = vevent.dtstart.value
  380. dtend = vevent.dtend.value if hasattr(vevent, 'dtend') else dtstart
  381. logger.debug(
  382. "Filtering VEVENT with DTSTART: %s (type: %s), DTEND: %s (type: %s)",
  383. dtstart, type(dtstart), dtend, type(dtend))
  384. # Handle string values for DTSTART/DTEND
  385. if isinstance(dtstart, str):
  386. try:
  387. dtstart = datetime.datetime.strptime(dtstart, dt_format)
  388. if all_day_event:
  389. dtstart = dtstart.date()
  390. except ValueError as e:
  391. logger.warning("Invalid DTSTART format: %s, error: %s", dtstart, e)
  392. continue
  393. if isinstance(dtend, str):
  394. try:
  395. dtend = datetime.datetime.strptime(dtend, dt_format)
  396. if all_day_event:
  397. dtend = dtend.date()
  398. except ValueError as e:
  399. logger.warning("Invalid DTEND format: %s, error: %s", dtend, e)
  400. continue
  401. # Convert to datetime for comparison
  402. if all_day_event and isinstance(dtstart, datetime.date) and not isinstance(dtstart, datetime.datetime):
  403. dtstart = datetime.datetime.fromordinal(dtstart.toordinal()).replace(tzinfo=None)
  404. dtend = datetime.datetime.fromordinal(dtend.toordinal()).replace(tzinfo=None)
  405. elif not all_day_event and isinstance(dtstart, datetime.datetime) \
  406. and isinstance(dtend, datetime.datetime):
  407. dtstart = dtstart.replace(tzinfo=datetime.timezone.utc)
  408. dtend = dtend.replace(tzinfo=datetime.timezone.utc)
  409. else:
  410. logger.warning("Unexpected DTSTART/DTEND type: dtstart=%s, dtend=%s", type(dtstart), type(dtend))
  411. continue
  412. if dtstart < time_range_end and dtend > time_range_start:
  413. if vevent not in filtered_vevents: # Avoid duplicates
  414. logger.debug("VEVENT passed time-range filter: %s", dtstart)
  415. filtered_vevents.append(vevent)
  416. else:
  417. logger.debug("VEVENT filtered out: %s", dtstart)
  418. # Rebuild component
  419. # ToDo: Get rid of return vevent_recurrence if filtered_vevents is empty it's wrong behavior
  420. vevent_component.vevent_list = filtered_vevents if filtered_vevents else [vevent_recurrence]
  421. element.text = vevent_component.serialize()
  422. logger.debug("Returning %d VEVENTs", len(vevent_component.vevent_list))
  423. return element
  424. def _convert_timezone(vevent: vobject.icalendar.RecurringComponent,
  425. name_prop: str,
  426. name_content_line: str):
  427. prop = getattr(vevent, name_prop, None)
  428. if prop:
  429. if type(prop.value) is datetime.date:
  430. date_time = datetime.datetime.fromordinal(
  431. prop.value.toordinal()
  432. ).replace(tzinfo=datetime.timezone.utc)
  433. else:
  434. date_time = prop.value.astimezone(datetime.timezone.utc)
  435. setattr(vevent, name_prop, ContentLine(name=name_content_line, value=date_time, params=[]))
  436. def _convert_to_utc(vevent: vobject.icalendar.RecurringComponent,
  437. name_prop: str,
  438. dt_format: str):
  439. prop = getattr(vevent, name_prop, None)
  440. if prop:
  441. setattr(vevent, name_prop, ContentLine(name=prop.name, value=prop.value.strftime(dt_format), params=[]))
  442. def _strip_single_event(vevent: vobject.icalendar.RecurringComponent, dt_format: str) -> None:
  443. _convert_timezone(vevent, 'dtstart', 'DTSTART')
  444. _convert_timezone(vevent, 'dtend', 'DTEND')
  445. _convert_timezone(vevent, 'recurrence_id', 'RECURRENCE-ID')
  446. # There is something strange behaviour during serialization native datetime, so converting manually
  447. _convert_to_utc(vevent, 'dtstart', dt_format)
  448. _convert_to_utc(vevent, 'dtend', dt_format)
  449. _convert_to_utc(vevent, 'recurrence_id', dt_format)
  450. try:
  451. delattr(vevent, 'rrule')
  452. delattr(vevent, 'exdate')
  453. delattr(vevent, 'exrule')
  454. delattr(vevent, 'rdate')
  455. except AttributeError:
  456. pass
  457. def _strip_component(vevent: vobject.base.Component) -> None:
  458. timezones_to_remove = []
  459. for component in vevent.components():
  460. if component.name == 'VTIMEZONE':
  461. timezones_to_remove.append(component)
  462. for timezone in timezones_to_remove:
  463. vevent.remove(timezone)
  464. def _split_overridden_vevents(
  465. component: vobject.base.Component,
  466. ) -> Tuple[
  467. vobject.icalendar.RecurringComponent,
  468. List[vobject.icalendar.RecurringComponent]
  469. ]:
  470. vevent_recurrence = None
  471. vevents_overridden = []
  472. for vevent in component.vevent_list:
  473. if hasattr(vevent, 'recurrence_id'):
  474. vevents_overridden += [vevent]
  475. elif vevent_recurrence:
  476. raise ValueError(
  477. f"component with UID {vevent.uid} "
  478. f"has more than one vevent with recurrence information"
  479. )
  480. else:
  481. vevent_recurrence = vevent
  482. if vevent_recurrence:
  483. return (
  484. vevent_recurrence, sorted(
  485. vevents_overridden,
  486. key=lambda vevent: vevent.recurrence_id.value
  487. )
  488. )
  489. else:
  490. raise ValueError(
  491. f"component with UID {vevent.uid} "
  492. f"does not have a vevent without a recurrence_id"
  493. )
  494. def _find_overridden(
  495. start: int,
  496. vevents: List[vobject.icalendar.RecurringComponent],
  497. dt: datetime.datetime,
  498. dt_format: str
  499. ) -> Tuple[int, Optional[vobject.icalendar.RecurringComponent]]:
  500. for i in range(start, len(vevents)):
  501. dt_event = datetime.datetime.strptime(
  502. vevents[i].recurrence_id.value,
  503. dt_format
  504. ).replace(tzinfo=datetime.timezone.utc)
  505. if dt_event == dt:
  506. return (i + 1, vevents[i])
  507. return (start, None)
  508. def xml_item_response(base_prefix: str, href: str,
  509. found_props: Sequence[ET.Element] = (),
  510. not_found_props: Sequence[ET.Element] = (),
  511. found_item: bool = True) -> ET.Element:
  512. response = ET.Element(xmlutils.make_clark("D:response"))
  513. href_element = ET.Element(xmlutils.make_clark("D:href"))
  514. href_element.text = xmlutils.make_href(base_prefix, href)
  515. response.append(href_element)
  516. if found_item:
  517. for code, props in ((200, found_props), (404, not_found_props)):
  518. if props:
  519. propstat = ET.Element(xmlutils.make_clark("D:propstat"))
  520. status = ET.Element(xmlutils.make_clark("D:status"))
  521. status.text = xmlutils.make_response(code)
  522. prop_element = ET.Element(xmlutils.make_clark("D:prop"))
  523. for prop in props:
  524. prop_element.append(prop)
  525. propstat.append(prop_element)
  526. propstat.append(status)
  527. response.append(propstat)
  528. else:
  529. status = ET.Element(xmlutils.make_clark("D:status"))
  530. status.text = xmlutils.make_response(404)
  531. response.append(status)
  532. return response
  533. def retrieve_items(
  534. base_prefix: str, path: str, collection: storage.BaseCollection,
  535. hreferences: Iterable[str], filters: Sequence[ET.Element],
  536. multistatus: ET.Element) -> Iterator[Tuple[radicale_item.Item, bool]]:
  537. """Retrieves all items that are referenced in ``hreferences`` from
  538. ``collection`` and adds 404 responses for missing and invalid items
  539. to ``multistatus``."""
  540. collection_requested = False
  541. def get_names() -> Iterator[str]:
  542. """Extracts all names from references in ``hreferences`` and adds
  543. 404 responses for invalid references to ``multistatus``.
  544. If the whole collections is referenced ``collection_requested``
  545. gets set to ``True``."""
  546. nonlocal collection_requested
  547. for hreference in hreferences:
  548. try:
  549. name = pathutils.name_from_path(hreference, collection)
  550. except ValueError as e:
  551. logger.warning("Skipping invalid path %r in REPORT request on "
  552. "%r: %s", hreference, path, e)
  553. response = xml_item_response(base_prefix, hreference,
  554. found_item=False)
  555. multistatus.append(response)
  556. continue
  557. if name:
  558. # Reference is an item
  559. yield name
  560. else:
  561. # Reference is a collection
  562. collection_requested = True
  563. for name, item in collection.get_multi(get_names()):
  564. if not item:
  565. uri = pathutils.unstrip_path(posixpath.join(collection.path, name))
  566. response = xml_item_response(base_prefix, uri, found_item=False)
  567. multistatus.append(response)
  568. else:
  569. yield item, False
  570. if collection_requested:
  571. yield from collection.get_filtered(filters)
  572. def test_filter(collection_tag: str, item: radicale_item.Item,
  573. filter_: ET.Element) -> bool:
  574. """Match an item against a filter."""
  575. if (collection_tag == "VCALENDAR" and
  576. filter_.tag != xmlutils.make_clark("C:%s" % filter_)):
  577. if len(filter_) == 0:
  578. return True
  579. if len(filter_) > 1:
  580. raise ValueError("Filter with %d children" % len(filter_))
  581. if filter_[0].tag != xmlutils.make_clark("C:comp-filter"):
  582. raise ValueError("Unexpected %r in filter" % filter_[0].tag)
  583. return radicale_filter.comp_match(item, filter_[0])
  584. if (collection_tag == "VADDRESSBOOK" and
  585. filter_.tag != xmlutils.make_clark("CR:%s" % filter_)):
  586. for child in filter_:
  587. if child.tag != xmlutils.make_clark("CR:prop-filter"):
  588. raise ValueError("Unexpected %r in filter" % child.tag)
  589. test = filter_.get("test", "anyof")
  590. if test == "anyof":
  591. return any(radicale_filter.prop_match(item.vobject_item, f, "CR")
  592. for f in filter_)
  593. if test == "allof":
  594. return all(radicale_filter.prop_match(item.vobject_item, f, "CR")
  595. for f in filter_)
  596. raise ValueError("Unsupported filter test: %r" % test)
  597. raise ValueError("Unsupported filter %r for %r" %
  598. (filter_.tag, collection_tag))
  599. class ApplicationPartReport(ApplicationBase):
  600. def do_REPORT(self, environ: types.WSGIEnviron, base_prefix: str,
  601. path: str, user: str) -> types.WSGIResponse:
  602. """Manage REPORT request."""
  603. access = Access(self._rights, user, path)
  604. if not access.check("r"):
  605. return httputils.NOT_ALLOWED
  606. try:
  607. xml_content = self._read_xml_request_body(environ)
  608. except RuntimeError as e:
  609. logger.warning("Bad REPORT request on %r: %s", path, e,
  610. exc_info=True)
  611. return httputils.BAD_REQUEST
  612. except socket.timeout:
  613. logger.debug("Client timed out", exc_info=True)
  614. return httputils.REQUEST_TIMEOUT
  615. with contextlib.ExitStack() as lock_stack:
  616. lock_stack.enter_context(self._storage.acquire_lock("r", user))
  617. item = next(iter(self._storage.discover(path)), None)
  618. if not item:
  619. return httputils.NOT_FOUND
  620. if not access.check("r", item):
  621. return httputils.NOT_ALLOWED
  622. if isinstance(item, storage.BaseCollection):
  623. collection = item
  624. else:
  625. assert item.collection is not None
  626. collection = item.collection
  627. if xml_content is not None and \
  628. xml_content.tag == xmlutils.make_clark("C:free-busy-query"):
  629. max_occurrence = self.configuration.get("reporting", "max_freebusy_occurrence")
  630. try:
  631. status, body = free_busy_report(
  632. base_prefix, path, xml_content, collection, self._encoding,
  633. lock_stack.close, max_occurrence)
  634. except ValueError as e:
  635. logger.warning(
  636. "Bad REPORT request on %r: %s", path, e, exc_info=True)
  637. return httputils.BAD_REQUEST
  638. headers = {"Content-Type": "text/calendar; charset=%s" % self._encoding}
  639. return status, headers, str(body)
  640. else:
  641. try:
  642. status, xml_answer = xml_report(
  643. base_prefix, path, xml_content, collection, self._encoding,
  644. lock_stack.close)
  645. except ValueError as e:
  646. logger.warning(
  647. "Bad REPORT request on %r: %s", path, e, exc_info=True)
  648. return httputils.BAD_REQUEST
  649. headers = {"Content-Type": "text/xml; charset=%s" % self._encoding}
  650. return status, headers, self._xml_response(xml_answer)