mirror of
https://github.com/EGroupware/egroupware.git
synced 2024-11-21 23:43:17 +01:00
WIP Calendar REST API
This commit is contained in:
ralf
parent
a3bed88d04
commit
7e333ceac9
@ -712,7 +712,7 @@ class addressbook_groupdav extends Api\CalDAV\Handler
|
||||
}
|
||||
elseif (empty($id))
|
||||
{
|
||||
$contact['cardav_name'] = $contact['uid'].'.vcf';
|
||||
$contact['carddav_name'] = $contact['uid'].'.vcf';
|
||||
$contact['owner'] = $user;
|
||||
}
|
||||
|
||||
|
||||
@ -594,7 +594,7 @@ class CalDAV extends HTTP_WebDAV_Server
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate (hierachical) supported-privilege property
|
||||
* Generate (hierarchical) supported-privilege property
|
||||
*
|
||||
* @param string $name name of privilege
|
||||
* @param string|array $data string with description or array with aggregated privileges plus value for key '*description*', '*ns*', '*only*'
|
||||
@ -1142,12 +1142,15 @@ class CalDAV extends HTTP_WebDAV_Server
|
||||
{
|
||||
header('Content-Type: application/json; charset=utf-8');
|
||||
$is_addressbook = strpos($options['path'], '/addressbook') !== false;
|
||||
$is_calendar = strpos($options['path'], '/calendar') !== false;
|
||||
$propfind_options = array(
|
||||
'path' => $options['path'],
|
||||
'depth' => 1,
|
||||
'props' => $is_addressbook ? [
|
||||
'address-data' => self::mkprop(self::CARDDAV, 'address-data', '')
|
||||
] : 'all',
|
||||
] : ($is_calendar ? [
|
||||
'calendar-data' => self::mkprop(self::CALDAV, 'calendar-data', ''),
|
||||
] : 'all'),
|
||||
'other' => [],
|
||||
);
|
||||
|
||||
@ -1253,7 +1256,7 @@ class CalDAV extends HTTP_WebDAV_Server
|
||||
// check if this is a property-object
|
||||
elseif (count($prop) === 3 && isset($prop['name']) && isset($prop['ns']) && isset($prop['val']))
|
||||
{
|
||||
$value = $prop['name'] === 'address-data' ? $prop['val'] : self::jsonProps($prop['val']);
|
||||
$value = in_array($prop['name'], ['address-data', 'calendar-data']) ? $prop['val'] : self::jsonProps($prop['val']);
|
||||
}
|
||||
else
|
||||
{
|
||||
@ -1504,7 +1507,7 @@ class CalDAV extends HTTP_WebDAV_Server
|
||||
// POST to the collection URL plus a UID like name component (like for regular PUT) to create new entrys
|
||||
if (isset($_GET['add-member']) || Handler::get_agent() == 'cfnetwork' ||
|
||||
// addressbook has not implemented a POST handler, therefore we have to call the PUT handler
|
||||
preg_match('#^(/[^/]+)?/addressbook(-[^/]+)?/$#', $options['path']) && self::isJSON())
|
||||
preg_match('#^(/[^/]+)?/(addressbook|calendar)(-[^/]+)?/$#', $options['path']) && self::isJSON())
|
||||
{
|
||||
$_GET['add-member'] = ''; // otherwise we give no Location header
|
||||
return $this->PUT($options, 'POST');
|
||||
@ -2016,8 +2019,8 @@ class CalDAV extends HTTP_WebDAV_Server
|
||||
{
|
||||
return '404 Not Found';
|
||||
}
|
||||
// REST API & PATCH only implemented for addressbook currently
|
||||
if ($app !== 'addressbook' && $method === 'PATCH')
|
||||
// REST API & PATCH only implemented for addressbook and calendar currently
|
||||
if (!in_array($app, ['addressbook', 'calendar']) && $method === 'PATCH')
|
||||
{
|
||||
return '501 Not implemented';
|
||||
}
|
||||
|
||||
726
api/src/CalDAV/JsCalendar.php
Normal file
726
api/src/CalDAV/JsCalendar.php
Normal file
@ -0,0 +1,726 @@
|
||||
<?php
|
||||
/**
|
||||
* EGroupware Calendar - JsCalendar
|
||||
*
|
||||
* @link https://www.egroupware.org
|
||||
* @author Ralf Becker <RalfBecker-AT-outdoor-training.de>
|
||||
* @package calendar
|
||||
* @copyright (c) 2023 by Ralf Becker <rb@egroupware.org>
|
||||
* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
|
||||
*/
|
||||
|
||||
namespace EGroupware\Api\CalDAV;
|
||||
|
||||
use EGroupware\Api;
|
||||
|
||||
/**
|
||||
* Rendering events as JSON using new JsCalendar format
|
||||
*
|
||||
* @link https://datatracker.ietf.org/doc/html/rfc8984
|
||||
* @link https://jmap.io/spec-calendars.html
|
||||
*/
|
||||
class JsCalendar
|
||||
{
|
||||
const MIME_TYPE = "application/jscalendar+json";
|
||||
const MIME_TYPE_JSEVENT = "application/jscalendar+json;type=event";
|
||||
const MIME_TYPE_JSTASK = "application/jscalendar+json;type=task";
|
||||
const MIME_TYPE_JSON = "application/json";
|
||||
|
||||
const TYPE_EVENT = 'Event';
|
||||
|
||||
/**
|
||||
* Get JsEvent for given event
|
||||
*
|
||||
* @param int|array $event
|
||||
* @param bool|"pretty" $encode=true true: JSON encode, "pretty": JSON encode with pretty-print, false: return raw data e.g. from listing
|
||||
* @return string|array
|
||||
* @throws Api\Exception\NotFound
|
||||
*/
|
||||
public static function getJsEvent($event, $encode=true)
|
||||
{
|
||||
if (is_scalar($event) && !($event = self::getCalendar()->read($event)))
|
||||
{
|
||||
throw new Api\Exception\NotFound();
|
||||
}
|
||||
$data = array_filter([
|
||||
self::AT_TYPE => self::TYPE_EVENT,
|
||||
'prodId' => 'EGroupware Calendar '.$GLOBALS['egw_info']['apps']['api']['version'],
|
||||
'uid' => self::uid($event['uid']),
|
||||
'sequence' => $event['etag'],
|
||||
'created' => self::UTCDateTime($event['created']),
|
||||
'updated' => self::UTCDateTime($event['modified']),
|
||||
'title' => $event['title'],
|
||||
'start' => self::DateTime($event['start'], $event['tzid']),
|
||||
'timeZone' => $event['tzid'],
|
||||
'showWithoutTime' => $event['whole_day'],
|
||||
'duration' => self::Duration($event['start'], $event['end'], $event['whole_day']),
|
||||
'freeBusyStatus' => $event['non_blocking'] ? 'free' : null, // default is busy
|
||||
'description' => $event['description'],
|
||||
'participants' => self::Participants($event),
|
||||
'status' => empty($event['deleted']) ? 'confirmed' : 'cancelled', // we have no "tentative" event-status (only participants)!
|
||||
'priority' => self::Priority($event['priority']),
|
||||
'categories' => self::categories($event['category']),
|
||||
'privacy' => $event['public'] ? 'public' : 'private',
|
||||
'alerts' => self::Alerts($event['alarms']),
|
||||
'egroupware.org:customfields' => self::customfields($event),
|
||||
]+self::Locations($event)+self::Recurrence($event));
|
||||
if ($encode)
|
||||
{
|
||||
return Api\CalDAV::json_encode($data, $encode === "pretty");
|
||||
}
|
||||
return $data;
|
||||
}
|
||||
|
||||
/**
|
||||
* Parse JsEvent
|
||||
*
|
||||
* We use strict parsing for "application/jscalendar+json" content-type, not for "application/json".
|
||||
* Strict parsing checks objects for proper @type attributes and value attributes, non-strict allows scalar values.
|
||||
*
|
||||
* Non-strict parsing also automatic detects patch for POST requests.
|
||||
*
|
||||
* @param string $json
|
||||
* @param array $old=[] existing contact for patch
|
||||
* @param ?string $content_type=null application/json no strict parsing and automatic patch detection, if method not 'PATCH' or 'PUT'
|
||||
* @param string $method='PUT' 'PUT', 'POST' or 'PATCH'
|
||||
* @return array
|
||||
*/
|
||||
public static function parseJsEvent(string $json, array $old=[], string $content_type=null, $method='PUT')
|
||||
{
|
||||
try
|
||||
{
|
||||
$strict = !isset($content_type) || !preg_match('#^application/json#', $content_type);
|
||||
$data = json_decode($json, true, 10, JSON_THROW_ON_ERROR);
|
||||
|
||||
// check if we use patch: method is PATCH or method is POST AND keys contain slashes
|
||||
if ($method === 'PATCH' || !$strict && $method === 'POST' && array_filter(array_keys($data), static function ($key)
|
||||
{
|
||||
return strpos($key, '/') !== false;
|
||||
}))
|
||||
{
|
||||
// apply patch on JsCard of contact
|
||||
$data = self::patch($data, $old ? self::getJsCalendar($old, false) : [], !$old);
|
||||
}
|
||||
|
||||
if (!isset($data['uid'])) $data['uid'] = null; // to fail below, if it does not exist
|
||||
|
||||
$event = [];
|
||||
foreach ($data as $name => $value)
|
||||
{
|
||||
switch ($name)
|
||||
{
|
||||
case 'uid':
|
||||
$event['uid'] = self::parseUid($value, $old['uid'], !$strict);
|
||||
break;
|
||||
|
||||
case 'title':
|
||||
$event['title'] = $value;
|
||||
break;
|
||||
|
||||
case 'description':
|
||||
$event['description'] = $value;
|
||||
break;
|
||||
|
||||
case 'start':
|
||||
case 'duration':
|
||||
case 'timeZone':
|
||||
case 'showWithoutTime':
|
||||
if (!isset($event['start']))
|
||||
{
|
||||
$event += self::parseStartDuration($data);
|
||||
}
|
||||
break;
|
||||
|
||||
|
||||
case 'freeBusyStatus':
|
||||
$event['non_blocking'] = $value === 'free'; // default is busy
|
||||
break;
|
||||
|
||||
case 'participants':
|
||||
$event['participants'] = self::parseParticipants($value);
|
||||
break;
|
||||
|
||||
case 'priority':
|
||||
$event['priority'] = self::parsePriority($value);
|
||||
break;
|
||||
|
||||
case 'privacy':
|
||||
$event['public'] = $value !== 'private';
|
||||
break;
|
||||
|
||||
case 'alerts':
|
||||
$event['alarms'] = self::parseAlerts($value);
|
||||
break;
|
||||
|
||||
case 'categories':
|
||||
$event['category'] = self::parseCategories($value);
|
||||
break;
|
||||
|
||||
case 'egroupware.org:customfields':
|
||||
$event += self::parseCustomfields($value, $strict);
|
||||
break;
|
||||
|
||||
case 'prodId':
|
||||
case 'created':
|
||||
case 'updated':
|
||||
break;
|
||||
|
||||
default:
|
||||
error_log(__METHOD__ . "() $name=" . json_encode($value, self::JSON_OPTIONS_ERROR) . ' --> ignored');
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
catch (\Throwable $e) {
|
||||
self::handleExceptions($e, 'JsCalendar Event', $name, $value);
|
||||
}
|
||||
return $event;
|
||||
}
|
||||
|
||||
const URN_UUID_PREFIX = 'urn:uuid:';
|
||||
const UUID_PREG = '/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/i';
|
||||
|
||||
/**
|
||||
* Get UID with either "urn:uuid:" prefix for UUIDs or just the text
|
||||
*
|
||||
* @param string $uid
|
||||
* @return string
|
||||
*/
|
||||
protected static function uid(string $uid)
|
||||
{
|
||||
return preg_match(self::UUID_PREG, $uid) ? self::URN_UUID_PREFIX.$uid : $uid;
|
||||
}
|
||||
|
||||
/**
|
||||
* Parse and optionally generate UID
|
||||
*
|
||||
* @param string|null $uid
|
||||
* @param string|null $old old value, if given it must NOT change
|
||||
* @param bool $generate_when_empty true: generate UID if empty, false: throw error
|
||||
* @return string without urn:uuid: prefix
|
||||
* @throws \InvalidArgumentException
|
||||
*/
|
||||
protected static function parseUid(string $uid=null, string $old=null, bool $generate_when_empty=false)
|
||||
{
|
||||
if (empty($uid) || strlen($uid) < 12)
|
||||
{
|
||||
if (!$generate_when_empty)
|
||||
{
|
||||
throw new \InvalidArgumentException("Invalid or missing UID: ".json_encode($uid));
|
||||
}
|
||||
$uid = \HTTP_WebDAV_Server::_new_uuid();
|
||||
}
|
||||
if (strpos($uid, self::URN_UUID_PREFIX) === 0)
|
||||
{
|
||||
$uid = substr($uid, strlen(self::URN_UUID_PREFIX));
|
||||
}
|
||||
if (isset($old) && $old !== $uid)
|
||||
{
|
||||
throw new \InvalidArgumentException("You must NOT change the UID ('$old'): ".json_encode($uid));
|
||||
}
|
||||
return $uid;
|
||||
}
|
||||
|
||||
/**
|
||||
* JSON options for errors thrown as exceptions
|
||||
*/
|
||||
const JSON_OPTIONS_ERROR = JSON_UNESCAPED_SLASHES|JSON_UNESCAPED_UNICODE;
|
||||
|
||||
const AT_TYPE = '@type';
|
||||
|
||||
/**
|
||||
* Return EGroupware custom fields
|
||||
*
|
||||
* @param array $contact
|
||||
* @return array
|
||||
*/
|
||||
protected static function customfields(array $contact)
|
||||
{
|
||||
$fields = [];
|
||||
foreach(Api\Storage\Customfields::get('calendar') as $name => $data)
|
||||
{
|
||||
$value = $contact['#'.$name];
|
||||
if (isset($value))
|
||||
{
|
||||
switch($data['type'])
|
||||
{
|
||||
case 'date-time':
|
||||
$value = Api\DateTime::to($value, Api\DateTime::RFC3339);
|
||||
break;
|
||||
case 'float':
|
||||
$value = (double)$value;
|
||||
break;
|
||||
case 'int':
|
||||
$value = (int)$value;
|
||||
break;
|
||||
case 'select':
|
||||
$value = explode(',', $value);
|
||||
break;
|
||||
}
|
||||
$fields[$name] = array_filter([
|
||||
'value' => $value,
|
||||
'type' => $data['type'],
|
||||
'label' => $data['label'],
|
||||
'values' => $data['values'],
|
||||
]);
|
||||
}
|
||||
}
|
||||
return $fields;
|
||||
}
|
||||
|
||||
/**
|
||||
* Parse custom fields
|
||||
*
|
||||
* Not defined custom fields are ignored!
|
||||
* Not send custom fields are set to null!
|
||||
*
|
||||
* @param array $cfs name => object with attribute data and optional type, label, values
|
||||
* @return array
|
||||
*/
|
||||
protected static function parseCustomfields(array $cfs)
|
||||
{
|
||||
$contact = [];
|
||||
$definitions = Api\Storage\Customfields::get('calendar');
|
||||
|
||||
foreach($definitions as $name => $definition)
|
||||
{
|
||||
$data = $cfs[$name];
|
||||
if (isset($data))
|
||||
{
|
||||
if (is_scalar($data))
|
||||
{
|
||||
$data = ['value' => $data];
|
||||
}
|
||||
if (!is_array($data) || !array_key_exists('value', $data))
|
||||
{
|
||||
throw new \InvalidArgumentException("Invalid customfield object $name: ".json_encode($data, self::JSON_OPTIONS_ERROR));
|
||||
}
|
||||
switch($definition['type'])
|
||||
{
|
||||
case 'date-time':
|
||||
$data['value'] = Api\DateTime::to($data['value'], 'object');
|
||||
break;
|
||||
case 'float':
|
||||
$data['value'] = (double)$data['value'];
|
||||
break;
|
||||
case 'int':
|
||||
$data['value'] = round($data['value']);
|
||||
break;
|
||||
case 'select':
|
||||
if (is_scalar($data['value'])) $data['value'] = explode(',', $data['value']);
|
||||
$data['value'] = array_intersect(array_keys($definition['values']), $data['value']);
|
||||
$data['value'] = $data['value'] ? implode(',', (array)$data['value']) : null;
|
||||
break;
|
||||
}
|
||||
$contact['#'.$name] = $data['value'];
|
||||
}
|
||||
// set not return cfs to null
|
||||
else
|
||||
{
|
||||
$contact['#'.$name] = null;
|
||||
}
|
||||
}
|
||||
// report not existing cfs to log
|
||||
if (($not_existing=array_diff(array_keys($cfs), array_keys($definitions))))
|
||||
{
|
||||
error_log(__METHOD__."() not existing/ignored custom fields: ".implode(', ', $not_existing));
|
||||
}
|
||||
return $contact;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return object of category-name(s) => true
|
||||
*
|
||||
* @link https://datatracker.ietf.org/doc/html/draft-ietf-jmap-jscontact-07#section-2.5.4
|
||||
* @param ?string $cat_ids comma-sep. cat_id's
|
||||
* @return true[]
|
||||
*/
|
||||
protected static function categories(?string $cat_ids)
|
||||
{
|
||||
$cat_ids = array_filter($cat_ids ? explode(',', $cat_ids): []);
|
||||
|
||||
return array_combine(array_map(static function ($cat_id)
|
||||
{
|
||||
return Api\Categories::id2name($cat_id);
|
||||
}, $cat_ids), array_fill(0, count($cat_ids), true));
|
||||
}
|
||||
|
||||
/**
|
||||
* Parse categories object
|
||||
*
|
||||
* @param array $categories category-name => true pairs
|
||||
* @return ?string comma-separated cat_id's
|
||||
*/
|
||||
protected static function parseCategories(array $categories)
|
||||
{
|
||||
static $bo=null;
|
||||
$cat_ids = [];
|
||||
if ($categories)
|
||||
{
|
||||
if (!isset($bo)) $bo = new \calendar_bo();
|
||||
$cat_ids = $bo->find_or_add_categories(array_keys($categories));
|
||||
}
|
||||
return $cat_ids ? implode(',', $cat_ids) : null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return a localized string
|
||||
*
|
||||
* @link https://datatracker.ietf.org/doc/html/draft-ietf-jmap-jscontact-07#section-1.5.3
|
||||
* @param string $value
|
||||
* @param ?string $language
|
||||
* @param string[] $localications map with extra language => value pairs
|
||||
* @return array[] with values for keys "value", "language" and "localizations"
|
||||
*/
|
||||
protected static function localizedString($value, string $language=null, array $localications=[])
|
||||
{
|
||||
if (empty($value) && !$localications)
|
||||
{
|
||||
return null;
|
||||
}
|
||||
return array_filter([
|
||||
'value' => $value,
|
||||
'language' => $language,
|
||||
'localizations' => $localications,
|
||||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Parse localized string
|
||||
*
|
||||
* We're not currently storing/allowing any localization --> they get ignored/thrown away!
|
||||
*
|
||||
* @param string $value =null
|
||||
* @return string
|
||||
*/
|
||||
protected static function parseString(string $value=null)
|
||||
{
|
||||
return $value;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return a date-time value in UTC
|
||||
*
|
||||
* @link https://datatracker.ietf.org/doc/html/rfc8984#section-1.4.4
|
||||
* @param null|string|\DateTime $date
|
||||
* @return string|null
|
||||
*/
|
||||
protected static function UTCDateTime($date)
|
||||
{
|
||||
static $utc=null;
|
||||
if (!isset($utc)) $utc = new \DateTimeZone('UTC');
|
||||
|
||||
if (!isset($date))
|
||||
{
|
||||
return null;
|
||||
}
|
||||
$date = Api\DateTime::to($date, 'object');
|
||||
$date->setTimezone($utc);
|
||||
|
||||
// we need to use "Z", not "+00:00"
|
||||
return substr($date->format(Api\DateTime::RFC3339), 0, -6).'Z';
|
||||
}
|
||||
|
||||
const DATETIME_FORMAT = 'Y-m-d\TH:i:s';
|
||||
|
||||
/**
|
||||
* Return a date-time value in the given timezone
|
||||
*
|
||||
* @link https://datatracker.ietf.org/doc/html/rfc8984#name-localdatetime
|
||||
* @param null|string|\DateTime $date
|
||||
* @return string|null
|
||||
*/
|
||||
protected static function DateTime($date, $timezone)
|
||||
{
|
||||
static $timezones = [];
|
||||
if (!isset($timezones[$timezone])) $timezones[$timezone] = new \DateTimeZone($timezone);
|
||||
|
||||
if (!isset($date))
|
||||
{
|
||||
return null;
|
||||
}
|
||||
$date = Api\DateTime::to($date, 'object');
|
||||
$date->setTimezone($timezones[$timezone]);
|
||||
|
||||
return $date->format(self::DATETIME_FORMAT);
|
||||
}
|
||||
|
||||
/**
|
||||
* Return a duration calculated from given start- and end-time
|
||||
*
|
||||
* @link https://datatracker.ietf.org/doc/html/rfc8984#name-duration
|
||||
* @param int|string|\DateTime $start
|
||||
* @param int|string|\DateTime $end
|
||||
* @param bool $whole_day
|
||||
* @return string
|
||||
*/
|
||||
protected static function Duration($start, $end, bool $whole_day)
|
||||
{
|
||||
$start = Api\DateTime::to($start, 'object');
|
||||
$end = Api\DateTime::to($end, 'object');
|
||||
|
||||
$value = $end->getTimestamp() - $start->getTimestamp() + (int)$whole_day;
|
||||
|
||||
$duration = '';
|
||||
if ($value < 0)
|
||||
{
|
||||
$duration .= '-';
|
||||
$value *= -1;
|
||||
}
|
||||
$duration .= 'P';
|
||||
foreach([
|
||||
'D' => 86400,
|
||||
'H' => 3600,
|
||||
'M' => 60,
|
||||
'S' => 1,
|
||||
] as $unit => $n)
|
||||
{
|
||||
if ($value >= $n || $unit === 'S' && substr($duration, -2) === 'PT')
|
||||
{
|
||||
$duration .= intdiv($value, $n).$unit;
|
||||
if (!($value %= $n)) break;
|
||||
}
|
||||
if ($unit === 'D') $duration .= 'T';
|
||||
}
|
||||
return $duration;
|
||||
}
|
||||
|
||||
protected static function parseStartDuration(array $data)
|
||||
{
|
||||
$parsed = [];
|
||||
|
||||
if (empty($data['start']))
|
||||
{
|
||||
throw new \InvalidArgumentException("Invalid or missing start: ".json_encode($data['start']));
|
||||
}
|
||||
else
|
||||
{
|
||||
$parsed['start'] = new Api\DateTime($data['start'], !empty($data['timeZone']) ? new \DateTimeZone($data['timeZone']) : null);
|
||||
$parsed['tzid'] = $data['timeZone'] ?? null;
|
||||
}
|
||||
if (empty($data['duration']) || !preg_match('/^(-)?P(\d+W)?(\d+D)?(T(\d+H)?(\d+M)?(\d+S)?)?$/', $data['duration'], $matches))
|
||||
{
|
||||
throw new \InvalidArgumentException("Invalid or missing duration: ".json_encode($data['duration']));
|
||||
}
|
||||
$duration = new \DateInterval($data['duration']);
|
||||
$parsed['end'] = new Api\DateTime($parsed['start']);
|
||||
$parsed['end']->add($duration);
|
||||
if (($parsed['whole_day'] = !empty($data['showWithoutTime'])))
|
||||
{
|
||||
$parsed['end']->sub(\DateInterval::createFromDateString('1 sec'));
|
||||
}
|
||||
return $parsed;
|
||||
}
|
||||
|
||||
const TYPE_PARTICIPANT = 'Participant';
|
||||
|
||||
/**
|
||||
* Return participants object
|
||||
*
|
||||
* @param array $event
|
||||
* @return array
|
||||
*/
|
||||
protected static function Participants(array $event)
|
||||
{
|
||||
static $status2jscal = [
|
||||
'U' => 'needs-action',
|
||||
'A' => 'accepted',
|
||||
'R' => 'declined',
|
||||
'T' => 'tentative',
|
||||
//'' => 'delegated',
|
||||
];
|
||||
$participants = [];
|
||||
foreach($event['participants'] as $uid => $status)
|
||||
{
|
||||
\calendar_so::split_status($status, $quantity, $role);
|
||||
\calendar_so::split_user($uid, $user_type, $user_id);
|
||||
try {
|
||||
$info = self::getCalendar()->resource_info($uid) ?: [];
|
||||
switch($info['type'] ?? $info['app'])
|
||||
{
|
||||
case 'user':
|
||||
$info['kind'] = 'individual';
|
||||
break;
|
||||
case 'group':
|
||||
$info['kind'] = 'group';
|
||||
break;
|
||||
case 'resources':
|
||||
$info['kind'] = Api\CalDAV\Principals::resource_is_location($user_id) ? 'location' : 'resource';
|
||||
break;
|
||||
}
|
||||
}
|
||||
catch (\Exception $e) {
|
||||
$info = [];
|
||||
}
|
||||
$participant = [
|
||||
self::AT_TYPE => self::TYPE_PARTICIPANT,
|
||||
'name' => $info['name'] ?? null,
|
||||
'email' => $info['email'] ?? null,
|
||||
'kind' => $info['kind'] ?? null,
|
||||
'roles' => array_filter([
|
||||
'owner' => $uid == $event['owner'],
|
||||
'chair' => $role === 'CHAIR',
|
||||
'attendee' => $role === 'REQ-PARTICIPANT',
|
||||
'optional' => $role === 'OPT-PARTICIPANT',
|
||||
'informational' => $role === 'NON-PARTICIPANT',
|
||||
]),
|
||||
'participationStatus' => $status2jscal[$status],
|
||||
];
|
||||
$participants[$uid] = $participant;
|
||||
}
|
||||
|
||||
return $participants;
|
||||
}
|
||||
|
||||
const TYPE_LOCATION = 'Location';
|
||||
const TYPE_VIRTALLOCATION = 'VirtualLocation';
|
||||
|
||||
/**
|
||||
* Return locations object
|
||||
*
|
||||
* @param array $event
|
||||
* @return array
|
||||
*/
|
||||
protected static function Locations(array $event)
|
||||
{
|
||||
$locations = [];
|
||||
if (!empty($event['location']))
|
||||
{
|
||||
$locations['locations']["1"] = [
|
||||
self::AT_TYPE => self::TYPE_LOCATION,
|
||||
'name' => $event['location'],
|
||||
];
|
||||
}
|
||||
// ToDo: set virtualLocations with videoconference link
|
||||
return $locations;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return JsCal priority 0=undefined, 1=highest, ..., 9=lowest
|
||||
*
|
||||
* @param int $priority
|
||||
* @return int
|
||||
*/
|
||||
protected static function Priority(int $priority)
|
||||
{
|
||||
static $priority_egw2jscal = array(
|
||||
0 => 0, // undefined
|
||||
1 => 9, // low
|
||||
2 => 5, // normal
|
||||
3 => 1, // high
|
||||
);
|
||||
return $priority_egw2jscal[$priority];
|
||||
}
|
||||
|
||||
/**
|
||||
* Return recurrence properties: recurrenceId, recurrenceRules, recurrenceOverrides, ...
|
||||
*
|
||||
* @TODO
|
||||
* @param array $event
|
||||
* @return array
|
||||
*/
|
||||
protected static function Recurrence(array $event)
|
||||
{
|
||||
return [];
|
||||
}
|
||||
|
||||
/**
|
||||
* Return alerts object
|
||||
*
|
||||
* @TODO
|
||||
* @param array|null $alarms
|
||||
* @return array
|
||||
*/
|
||||
protected static function Alerts(array $alarms=null)
|
||||
{
|
||||
$alerts = [];
|
||||
foreach($alarms ?? [] as $alarm)
|
||||
{
|
||||
|
||||
}
|
||||
return $alerts;
|
||||
}
|
||||
|
||||
/**
|
||||
* Patch JsEvent
|
||||
*
|
||||
* @param array $patches JSON path
|
||||
* @param array $jsevent to patch
|
||||
* @param bool $create =false true: create missing components
|
||||
* @return array patched $jsevent
|
||||
*/
|
||||
public static function patch(array $patches, array $jsevent, bool $create=false)
|
||||
{
|
||||
foreach($patches as $path => $value)
|
||||
{
|
||||
$parts = explode('/', $path);
|
||||
$target = &$jsevent;
|
||||
foreach($parts as $n => $part)
|
||||
{
|
||||
if (!isset($target[$part]) && $n < count($parts)-1 && !$create)
|
||||
{
|
||||
throw new \InvalidArgumentException("Trying to patch not existing attribute with path $path!");
|
||||
}
|
||||
$parent = $target;
|
||||
$target = &$target[$part];
|
||||
}
|
||||
if (isset($value))
|
||||
{
|
||||
$target = $value;
|
||||
}
|
||||
else
|
||||
{
|
||||
unset($parent[$part]);
|
||||
}
|
||||
}
|
||||
return $jsevent;
|
||||
}
|
||||
|
||||
/**
|
||||
* Map all kind of exceptions while parsing to a JsCalendarParseException
|
||||
*
|
||||
* @param \Throwable $e
|
||||
* @param string $type
|
||||
* @param ?string $name
|
||||
* @param mixed $value
|
||||
* @throws JsCalendarParseException
|
||||
*/
|
||||
protected static function handleExceptions(\Throwable $e, $type='JsCalendar', ?string $name, $value)
|
||||
{
|
||||
try {
|
||||
throw $e;
|
||||
}
|
||||
catch (\JsonException $e) {
|
||||
throw new JsCalendarParseException("Error parsing JSON: ".$e->getMessage(), 422, $e);
|
||||
}
|
||||
catch (\InvalidArgumentException $e) {
|
||||
throw new JsCalendarParseException("Error parsing $type attribute '$name': ".
|
||||
str_replace('"', "'", $e->getMessage()), 422);
|
||||
}
|
||||
catch (\TypeError $e) {
|
||||
$message = $e->getMessage();
|
||||
if (preg_match('/must be of the type ([^ ]+( or [^ ]+)*), ([^ ]+) given/', $message, $matches))
|
||||
{
|
||||
$message = "$matches[1] expected, but got $matches[3]: ".
|
||||
str_replace('"', "'", json_encode($value, self::JSON_OPTIONS_ERROR));
|
||||
}
|
||||
throw new JsCalendarParseException("Error parsing $type attribute '$name': $message", 422, $e);
|
||||
}
|
||||
catch (\Throwable $e) {
|
||||
throw new JsCalendarParseException("Error parsing $type attribute '$name': ". $e->getMessage(), 422, $e);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @return \calendar_boupdate
|
||||
*/
|
||||
protected static function getCalendar()
|
||||
{
|
||||
static $calendar_bo=null;
|
||||
if (!isset($calendar_bo))
|
||||
{
|
||||
$calendar_bo = new \calendar_boupdate();
|
||||
}
|
||||
return $calendar_bo;
|
||||
}
|
||||
}
|
||||
27
api/src/CalDAV/JsCalendarParseException.php
Normal file
27
api/src/CalDAV/JsCalendarParseException.php
Normal file
@ -0,0 +1,27 @@
|
||||
<?php
|
||||
/**
|
||||
* EGroupware API - JsCalendar
|
||||
*
|
||||
* @link https://www.egroupware.org
|
||||
* @author Ralf Becker <rb@egroupware.org>
|
||||
* @package calendar
|
||||
* @copyright (c) 2023 by Ralf Becker <rb@egroupware.org>
|
||||
* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
|
||||
*/
|
||||
|
||||
namespace EGroupware\Api\CalDAV;
|
||||
|
||||
use Throwable;
|
||||
|
||||
/**
|
||||
* Error parsing JsContact format
|
||||
*
|
||||
* @link * @link https://datatracker.ietf.org/doc/html/rfc8984
|
||||
*/
|
||||
class JsCalendarParseException extends \InvalidArgumentException
|
||||
{
|
||||
public function __construct($message = "", $code = 422, Throwable $previous = null)
|
||||
{
|
||||
parent::__construct($message, $code ?: 422, $previous);
|
||||
}
|
||||
}
|
||||
@ -105,8 +105,13 @@ class calendar_groupdav extends Api\CalDAV\Handler
|
||||
$this->bo = new calendar_boupdate();
|
||||
$this->vCalendar = new Horde_Icalendar;
|
||||
|
||||
if (Api\CalDAV::isJSON())
|
||||
{
|
||||
self::$path_attr = 'id';
|
||||
self::$path_extension = '';
|
||||
}
|
||||
// since 1.9.003 we allow clients to specify the URL when creating a new event, as specified by CalDAV
|
||||
if (version_compare($GLOBALS['egw_info']['apps']['calendar']['version'], '1.9.003', '>='))
|
||||
elseif (version_compare($GLOBALS['egw_info']['apps']['calendar']['version'], '1.9.003', '>='))
|
||||
{
|
||||
self::$path_attr = 'caldav_name';
|
||||
self::$path_extension = '';
|
||||
@ -256,6 +261,20 @@ class calendar_groupdav extends Api\CalDAV\Handler
|
||||
unset($filter['end']);
|
||||
}
|
||||
|
||||
// check if we have to return the full calendar data or just the etag's
|
||||
if (!($filter['calendar_data'] = $options['props'] == 'all' &&
|
||||
$options['root']['ns'] == Api\CalDAV::CALDAV) && is_array($options['props']))
|
||||
{
|
||||
foreach($options['props'] as $prop)
|
||||
{
|
||||
if ($prop['name'] == 'calendar-data')
|
||||
{
|
||||
$filter['calendar_data'] = true;
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (isset($nresults))
|
||||
{
|
||||
unset($filter['no_total']); // we need the total!
|
||||
@ -346,8 +365,8 @@ class calendar_groupdav extends Api\CalDAV\Handler
|
||||
{
|
||||
if ($this->debug) $starttime = microtime(true);
|
||||
|
||||
$calendar_data = $this->caldav->prop_requested('calendar-data', Api\CalDAV::CALDAV, true);
|
||||
if (!is_array($calendar_data)) $calendar_data = false; // not in allprop or autoindex
|
||||
$calendar_data = $filter['calendar_data'];
|
||||
unset($filter['calendar_data']);
|
||||
|
||||
// yield extra resources like the root itself
|
||||
$yielded = 0;
|
||||
@ -362,6 +381,7 @@ class calendar_groupdav extends Api\CalDAV\Handler
|
||||
$sync_collection = $filter['sync-collection'];
|
||||
|
||||
$events = null;
|
||||
$is_jscalendar = Api\CalDAV::isJSON();
|
||||
for($chunk=0; (!$chunk || count($events) === self::CHUNK_SIZE) && // stop after we have not got a full chunk
|
||||
($events =& $this->bo->search($filter+[
|
||||
'offset' => $chunk*self::CHUNK_SIZE,
|
||||
@ -404,7 +424,8 @@ class calendar_groupdav extends Api\CalDAV\Handler
|
||||
|
||||
//header('X-EGROUPWARE-EVENT-'.$event['id'].': '.$event['title'].': '.date('Y-m-d H:i:s',$event['start']).' - '.date('Y-m-d H:i:s',$event['end']));
|
||||
$props = array(
|
||||
'getcontenttype' => $this->agent != 'kde' ? 'text/calendar; charset=utf-8; component=VEVENT' : 'text/calendar',
|
||||
'getcontenttype' => $is_jscalendar ? Api\CalDAV\JsCalendar::MIME_TYPE_JSEVENT :
|
||||
($this->agent != 'kde' ? 'text/calendar; charset=utf-8; component=VEVENT' : 'text/calendar'),
|
||||
'getetag' => '"'.$etag.'"',
|
||||
'getlastmodified' => $event['modified'],
|
||||
// user and timestamp of creation or last modification of event, used in calendarserver only for shared calendars
|
||||
@ -420,11 +441,12 @@ class calendar_groupdav extends Api\CalDAV\Handler
|
||||
//error_log(__FILE__ . __METHOD__ . "Calendar Data : $calendar_data");
|
||||
if ($calendar_data)
|
||||
{
|
||||
$content = $this->iCal($event, $filter['users'],
|
||||
$content = $is_jscalendar ? Api\CalDAV\JsCalendar::getJsEvent($event, false) :
|
||||
$this->iCal($event, $filter['users'],
|
||||
strpos($path, '/inbox/') !== false ? 'REQUEST' : null,
|
||||
!isset($calendar_data['children']['expand']) ? false :
|
||||
($calendar_data['children']['expand']['attrs'] ?: true), $exceptions);
|
||||
$props['getcontentlength'] = bytes($content);
|
||||
$props['getcontentlength'] = bytes($is_jscalendar ? json_encode($content) : $content);
|
||||
$props['calendar-data'] = Api\CalDAV::mkprop(Api\CalDAV::CALDAV,'calendar-data',$content);
|
||||
}
|
||||
/* Calendarserver reports new events with schedule-changes: action: create, which iCal request
|
||||
@ -738,8 +760,17 @@ class calendar_groupdav extends Api\CalDAV\Handler
|
||||
return $event;
|
||||
}
|
||||
|
||||
$options['data'] = $this->iCal($event, $user, strpos($options['path'], '/inbox/') !== false ? 'REQUEST' : null);
|
||||
$options['mimetype'] = 'text/calendar; charset=utf-8';
|
||||
// jsEvent or iCal
|
||||
if (($type=Api\CalDAV::isJSON()))
|
||||
{
|
||||
$options['data'] = Api\CalDAV\JsCalendar::getJsEvent($event, $type);
|
||||
$options['mimetype'] = Api\CalDAV\JsCalendar::MIME_TYPE_JSEVENT.';charset=utf-8';
|
||||
}
|
||||
else
|
||||
{
|
||||
$options['data'] = $this->iCal($event, $user, strpos($options['path'], '/inbox/') !== false ? 'REQUEST' : null);
|
||||
$options['mimetype'] = 'text/calendar; charset=utf-8';
|
||||
}
|
||||
header('Content-Encoding: identity');
|
||||
$schedule_tag = null;
|
||||
header('ETag: "'.$this->get_etag($event, $schedule_tag).'"');
|
||||
@ -960,7 +991,7 @@ class calendar_groupdav extends Api\CalDAV\Handler
|
||||
* @param string $prefix =null user prefix from path (eg. /ralf from /ralf/addressbook)
|
||||
* @return mixed boolean true on success, false on failure or string with http status (eg. '404 Not Found')
|
||||
*/
|
||||
function put(&$options,$id,$user=null,$prefix=null)
|
||||
function put(&$options,$id,$user=null,$prefix=null,$method='PUT')
|
||||
{
|
||||
if ($this->debug) error_log(__METHOD__."($id, $user)".print_r($options,true));
|
||||
|
||||
@ -1135,7 +1166,7 @@ class calendar_groupdav extends Api\CalDAV\Handler
|
||||
}
|
||||
if (!isset($master) && !$event['recurrence']) $master = $event;
|
||||
}
|
||||
if (!$modified) // NO modififictions, or none we understood --> log it and return Ok: "204 No Content"
|
||||
if (!$modified) // NO modification, or none we understood --> log it and return Ok: "204 No Content"
|
||||
{
|
||||
$this->caldav->log(__METHOD__."(,,$user) NO changes for current user events=".array2string($events).', old-event='.array2string($oldEvent));
|
||||
}
|
||||
@ -1177,8 +1208,20 @@ class calendar_groupdav extends Api\CalDAV\Handler
|
||||
$retval = '201 Created';
|
||||
}
|
||||
|
||||
if (!($cal_id = $handler->importVCal($vCalendar, $eventId,
|
||||
self::etag2value($this->http_if_match), false, 0, $this->caldav->current_user_principal, $user, $charset, $id)))
|
||||
$type = null;
|
||||
if (($is_json=Api\CalDAV::isJSON($type)))
|
||||
{
|
||||
$event = Api\CalDAV\JsCalendar::parseJsEvent($options['content'], $oldEvent ?? [], $type, $method);
|
||||
$cal_id = $this->bo->save($event);
|
||||
}
|
||||
else
|
||||
{
|
||||
$cal_id = $handler->importVCal($vCalendar, $eventId,
|
||||
self::etag2value($this->http_if_match), false, 0, $this->caldav->current_user_principal, $user, $charset, $id);
|
||||
}
|
||||
|
||||
|
||||
if (!$cal_id)
|
||||
{
|
||||
if ($this->debug) error_log(__METHOD__."(,$id) eventId=$eventId: importVCal('$options[content]') returned ".array2string($cal_id));
|
||||
if ($eventId && $cal_id === false)
|
||||
|
||||
@ -36,10 +36,10 @@ One can use the following URLs relative (!) to https://example.org/egroupware/gr
|
||||
Shared addressbooks or calendars are only shown in the users home-set, if he subscribed to it via his CalDAV preferences!
|
||||
|
||||
Calling one of the above collections with a GET request / regular browser generates an automatic index
|
||||
from the data of a allprop PROPFIND, allow browsing CalDAV/CardDAV tree with a regular browser.
|
||||
from the data of an allprop PROPFIND, allow browsing CalDAV/CardDAV tree with a regular browser.
|
||||
|
||||
## REST API: using EGroupware CalDAV/CardDAV server with JSON
|
||||
> currently implemented only for contacts!
|
||||
> currently implemented only for contacts and calendar (without recurring events)!
|
||||
|
||||
Following RFCs / drafts used/planned for JSON encoding of ressources
|
||||
* [draft-ietf-jmap-jscontact: JSContact: A JSON Representation of Contact Data](https://datatracker.ietf.org/doc/html/draft-ietf-jmap-jscontact)
|
||||
@ -543,6 +543,6 @@ use ```<domain-name>:<name>``` like in JsCalendar
|
||||
- [x] Addressbook
|
||||
- [ ] update of photos, keys, attachments
|
||||
- [ ] InfoLog
|
||||
- [ ] Calendar
|
||||
- [X] Calendar
|
||||
- [ ] relatedTo / links
|
||||
- [ ] storing not native supported attributes eg. localization
|
||||
Loading…
Reference in New Issue
Block a user