No OneTemporary
Actions

Size

56 KB

Referenced Files

None

Subscribers

None

View Options

	diff --git a/config/dav.inc.php.sample b/config/dav.inc.php.sample
	index 4fe2efe..2ada669 100644
	--- a/config/dav.inc.php.sample
	+++ b/config/dav.inc.php.sample
	@@ -1,124 +1,126 @@
	<?php

	/*
	+-------------------------------------------------------------------------+
	\| Configuration for the Kolab DAV server \|
	\| \|
	\| Copyright (C) 2013, Kolab Systems AG \|
	\| \|
	\| This program is free software: you can redistribute it and/or modify \|
	\| it under the terms of the GNU Affero General Public License as \|
	\| published by the Free Software Foundation, either version 3 of the \|
	\| License, or (at your option) any later version. \|
	\| \|
	\| This program 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 Affero General Public License for more details. \|
	\| \|
	\| You should have received a copy of the GNU Affero General Public License\|
	\| along with this program. If not, see <http://www.gnu.org/licenses/>. \|
	\| \|
	+-------------------------------------------------------------------------+
	*/

	$config = array();

	// The HTTP path to the iRony root directory.
	// Set to / if the service is registered as document root for a virtual host
	$config['base_uri'] = '/iRony/';

	// User agent string written to kolab storage MIME messages
	$config['useragent'] = 'Kolab DAV Server libkolab/' . RCUBE_VERSION;

	// Roundcube plugins. Not all are supported here.
	$config['kolabdav_plugins'] = array('kolab_auth');

	// Type of Auth cache. Supported values: 'db', 'apc' and 'memcache'.
	// Note: This is only for username canonification map.
	$config['kolabdav_auth_cache'] = 'db';

	// lifetime of the Auth cache, possible units: s, m, h, d, w
	$config['kolabdav_auth_cache_ttl'] = '1h';

	// enable debug console showing the internal function calls triggered
	// by http requests. This will write log to /var/log/iRony/console
	$config['kolabdav_console'] = false;

	// enable per-user debugging if /var/log/iRony/<username>/ folder exists
	$config['kolabdav_user_debug'] = false;

	// enable logging of full HTTP payload
	// (bitmask of these values: 2 = HTTP Requests, 4 = HTTP Responses)
	$config['kolabdav_http_log'] = 0;

	// expose iTip invitations from email inbox in CalDAV scheduling inbox.
	// this will make capable CalDAV clients process event invitations and
	// as a result, the invitation messages are removed from the email inbox.
	+// WARNING: this feature is still experimental and not fully implemented.
	+// See https://git.kolab.org/T93 for details and implementation status.
	$config['kolabdav_caldav_inbox'] = false;

	// Enables the CardDAV Directory Gateway Extension by exposing an
	// LDAP-based address book in the pricipals address book collection.
	// Properties of this option are the same as for $config['ldap_public'] entries.
	/*
	$config['kolabdav_ldap_directory'] = array(
	'name' => 'Global Address Book',
	'hosts' => 'localhost',
	'port' => 389,
	'use_tls' => false,
	// If true the base_dn, bind_dn and bind_pass default to the user's credentials.
	'user_specific' => false,
	// It's possible to bind with the current user's credentials for individual address books.
	// The login name is used to search for the DN to bind with
	'search_base_dn' => 'ou=People,dc=example,dc=org',
	'search_bind_dn' => 'uid=kolab-service,ou=Special Users,dc=example,dc=org',
	'search_bind_pw' => 'Welcome2KolabSystems',
	'search_filter' => '(&(objectClass=inetOrgPerson)(mail=%fu))',
	// When 'user_specific' is enabled following variables can be used in base_dn/bind_dn config:
	// %fu - The full username provided, assumes the username is an email
	// address, uses the username_domain value if not an email address.
	// %u - The username prior to the '@'.
	// %d - The domain name after the '@'.
	// %dc - The domain name hierarchal string e.g. "dc=test,dc=domain,dc=com"
	// %dn - DN found by ldap search when search_filter/search_base_dn are used
	'base_dn' => 'ou=People,dc=example,dc=org',
	'bind_dn' => 'uid=kolab-service,ou=Special Users,dc=example,dc=org',
	'bind_pass' => 'Welcome2KolabSystems',
	'ldap_version' => 3,
	'filter' => '(objectClass=inetOrgPerson)',
	'search_fields' => array('displayname', 'mail'),
	'sort' => array('displayname', 'sn', 'givenname', 'cn'),
	'scope' => 'sub',
	'searchonly' => true, // Set to false to enable listing
	'sizelimit' => '1000',
	'timelimit' => '0',
	'fieldmap' => array(
	// Roundcube => LDAP
	'name' => 'displayName',
	'surname' => 'sn',
	'firstname' => 'givenName',
	'middlename' => 'initials',
	'prefix' => 'title',
	'email:work' => 'mail',
	'email:other' => 'alias',
	'phone:main' => 'telephoneNumber',
	'phone:work' => 'alternateTelephoneNumber',
	'phone:mobile' => 'mobile',
	'phone:work2' => 'blackberry',
	'street' => 'street',
	'zipcode' => 'postalCode',
	'locality' => 'l',
	'organization' => 'o',
	'jobtitle' => 'title',
	'photo' => 'jpegphoto',
	// required for internal handling and caching
	'uid' => 'nsuniqueid',
	'changed' => 'modifytimestamp',
	),
	);
	*/

	// Enable caching for LDAP directory data.
	// This is recommended with 'searchonly' => false to speed-up sychronization of multiple clients
	// $config['kolabdav_ldap_cache'] = 'memcache';
	// $config['kolabdav_ldap_cache_ttl'] = 600; // in seconds
	diff --git a/lib/Kolab/CalDAV/CalendarBackend.php b/lib/Kolab/CalDAV/CalendarBackend.php
	index 9f5a000..89365ee 100644
	--- a/lib/Kolab/CalDAV/CalendarBackend.php
	+++ b/lib/Kolab/CalDAV/CalendarBackend.php
	@@ -1,1126 +1,1187 @@
	<?php

	/**
	* SabreDAV Calendaring backend for Kolab.
	*
	* @author Thomas Bruederli <bruederli@kolabsys.com>
	*
	* Copyright (C) 2013, Kolab Systems AG <contact@kolabsys.com>
	*
	* This program is free software: you can redistribute it and/or modify
	* it under the terms of the GNU Affero General Public License as
	* published by the Free Software Foundation, either version 3 of the
	* License, or (at your option) any later version.
	*
	* This program 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 Affero General Public License for more details.
	*
	* You should have received a copy of the GNU Affero General Public License
	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	*/

	namespace Kolab\CalDAV;

	use \PEAR;
	use \rcube;
	use \rcube_charset;
	use \rcube_message;
	use \kolab_storage;
	use \kolab_storage_config;
	use \libcalendaring;
	use Kolab\Utils\DAVBackend;
	use Kolab\Utils\VObjectUtils;
	use Kolab\DAV\Auth\HTTPBasic;
	use Sabre\DAV;
	use Sabre\CalDAV;
	use Sabre\VObject;

	/**
	* Kolab Calendaring backend.
	*
	* Checkout the Sabre\CalDAV\Backend\BackendInterface for all the methods that must be implemented.
	*
	*/
	class CalendarBackend extends CalDAV\Backend\AbstractBackend implements CalDAV\Backend\SchedulingSupport
	{
	private $calendars;
	private $folders;
	private $aliases;
	private $useragent;
	private $subscribed = null;

	/**
	* Read available calendar folders from server
	*/
	private function _read_calendars()
	{
	// already read sources
	if (isset($this->calendars))
	return $this->calendars;

	// get all folders that have "event" type
	$folders = array_merge(kolab_storage::get_folders('event', $this->subscribed), kolab_storage::get_folders('task', $this->subscribed));
	$this->calendars = $this->folders = $this->aliases = array();

	$order = 1;
	$default_calendar_id = null;
	foreach (kolab_storage::sort_folders($folders) as $folder) {
	$id = $folder->get_uid();
	$this->folders[$id] = $folder;
	$fdata = $folder->get_imap_data(); // fetch IMAP folder data for CTag generation
	$this->calendars[$id] = array(
	'id' => $id,
	'uri' => $id,
	'{DAV:}displayname' => html_entity_decode($folder->get_name(), ENT_COMPAT, RCUBE_CHARSET),
	'{http://apple.com/ns/ical/}calendar-color' => '#' . $folder->get_color('FF0000') . 'FF',
	'{http://calendarserver.org/ns/}getctag' => sprintf('%d-%d-%d', $fdata['UIDVALIDITY'], $fdata['HIGHESTMODSEQ'], $fdata['UIDNEXT']),
	'{urn:ietf:params:xml:ns:caldav}supported-calendar-component-set' => new CalDAV\Property\SupportedCalendarComponentSet(array(DAVBackend::$caldav_type_component_map[$folder->type])),
	'{urn:ietf:params:xml:ns:caldav}schedule-calendar-transp' => new CalDAV\Property\ScheduleCalendarTransp('opaque'),
	'{http://apple.com/ns/ical/}calendar-order' => $order++,
	);

	if ($folder->default && $folder->type == 'event') {
	$default_calendar_id = $id;
	}

	$this->aliases[$folder->name] = $id;

	// these properties are used for sharing supprt (not yet active)
	if (false && $folder->get_namespace() != 'personal') {
	$rights = $folder->get_myrights();
	$this->calendars[$id]['{http://calendarserver.org/ns/}shared-url'] = '/calendars/' . $folder->get_owner() . '/' . $id;
	$this->calendars[$id]['{http://calendarserver.org/ns/}owner-principal'] = $folder->get_owner();
	$this->calendars[$id]['{http://sabredav.org/ns}read-only'] = strpos($rights, 'i') === false;
	}
	}

	// put default calendar on top of the list:
	// {urn:ietf:params:xml:ns:caldav}schedule-default-calendar-URL is derived from the first item on this list
	if ($default_calendar_id) {
	$this->calendars = array($default_calendar_id => $this->calendars[$default_calendar_id]) + $this->calendars;
	}

	return $this->calendars;
	}

	/**
	* Getter for a kolab_storage_folder representing the calendar for the given ID
	*
	* @param string Calendar ID
	* @return object kolab_storage_folder instance
	*/
	public function get_storage_folder($id)
	{
	// resolve alias name
	if ($this->aliases[$id]) {
	$id = $this->aliases[$id];
	}

	if ($this->folders[$id]) {
	DAVBackend::check_storage_folder($this->folders[$id]);
	return $this->folders[$id];
	}
	else {
	return DAVBackend::get_storage_folder($id, '');
	}
	}

	/**
	* Returns a list of calendars for a principal.
	*
	* Every calendars is an array with the following keys:
	* * id, a unique id that will be used by other functions to modify the
	* calendar. This can be the same as the uri or a database key.
	* * uri, which the basename of the uri with which the calendar is
	* accessed.
	* * principaluri. The owner of the calendar. Almost always the same as
	* principalUri passed to this method.
	*
	* Furthermore it can contain webdav properties in clark notation. A very
	* common one is '{DAV:}displayname'.
	*
	* @param string $principalUri
	* @return array
	*/
	public function getCalendarsForUser($principalUri)
	{
	console(__METHOD__, $principalUri);

	if (!$this->is_current_pricipal($principalUri)) {
	return array();
	}

	$this->_read_calendars();

	$calendars = array();
	foreach ($this->calendars as $id => $cal) {
	$this->calendars[$id]['principaluri'] = $principalUri;
	$calendars[] = $this->calendars[$id];
	}

	return $calendars;
	}

	/**
	* Returns calendar properties for a specific node identified by name/uri
	*
	* @param string Node name/uri
	* @return array Hash array with calendar properties or null if not found
	*/
	public function getCalendarByName($calendarUri)
	{
	console(__METHOD__, $calendarUri);

	$this->_read_calendars();
	$id = $calendarUri;

	// resolve aliases (calendar by folder name)
	if ($this->aliases[$calendarUri]) {
	$id = $this->aliases[$calendarUri];
	}

	if ($this->calendars[$id] && empty($this->calendars[$id]['principaluri'])) {
	$this->calendars[$id]['principaluri'] = 'principals/' . HTTPBasic::$current_user;
	}

	// retry with subscribed = false (#2701)
	if (empty($this->calendars[$id]) && !in_array($id, array('inbox','outbox','notifications')) && $this->subscribed === null && rcube::get_instance()->config->get('kolab_use_subscriptions')) {
	$this->subscribed = false;
	unset($this->calendars);
	return $this->getCalendarByName($calendarUri);
	}

	return $this->calendars[$id];
	}

	/**
	* Creates a new calendar for a principal.
	*
	* If the creation was a success, an id must be returned that can be used to reference
	* this calendar in other methods, such as updateCalendar.
	*
	* @param string $principalUri
	* @param string $calendarUri
	* @param array $properties
	* @return void
	*/
	public function createCalendar($principalUri, $calendarUri, array $properties)
	{
	console(__METHOD__, $calendarUri, $properties);

	return DAVBackend::folder_create('event', $properties, $calendarUri);
	}

	/**
	* Updates properties for a calendar.
	*
	* The list of mutations is stored in a Sabre\DAV\PropPatch object.
	* To do the actual updates, you must tell this object which properties
	* you're going to process with the handle() method.
	*
	* Calling the handle method is like telling the PropPatch object "I
	* promise I can handle updating this property".
	*
	* Read the PropPatch documenation for more info and examples.
	*
	* @param string $path
	* @param \Sabre\DAV\PropPatch $propPatch
	* @return void
	*/
	public function updateCalendar($calendarId, \Sabre\DAV\PropPatch $propPatch)
	{
	console(__METHOD__, $calendarId, $propPatch);

	if ($folder = $this->get_storage_folder($calendarId)) {
	DAVBackend::handle_propatch($folder, $propPatch);
	}
	}

	/**
	* Delete a calendar and all it's objects
	*
	* @param mixed $calendarId
	* @return void
	*/
	public function deleteCalendar($calendarId)
	{
	console(__METHOD__, $calendarId);

	$folder = $this->get_storage_folder($calendarId);
	if ($folder && !kolab_storage::folder_delete($folder->name)) {
	rcube::raise_error(array(
	'code' => 600, 'type' => 'php',
	'file' => __FILE__, 'line' => __LINE__,
	'message' => "Error deleting calendar folder $folder->name"),
	true, false);
	}
	}


	/**
	* Returns all calendar objects within a calendar.
	*
	* Every item contains an array with the following keys:
	* * id - unique identifier which will be used for subsequent updates
	* * calendardata - The iCalendar-compatible calendar data (optional)
	* * uri - a unique key which will be used to construct the uri. This can be any arbitrary string.
	* * lastmodified - a timestamp of the last modification time
	* * etag - An arbitrary string, surrounded by double-quotes. (e.g.: "abcdef"')
	* * calendarid - The calendarid as it was passed to this function.
	* * size - The size of the calendar objects, in bytes.
	*
	* Note that the etag is optional, but it's highly encouraged to return for
	* speed reasons.
	*
	* If neither etag or size are specified, the calendardata will be
	* used/fetched to determine these numbers. If both are specified the
	* amount of times this is needed is reduced by a great degree.
	*
	* @param mixed $calendarId
	* @return array
	*/
	public function getCalendarObjects($calendarId)
	{
	console(__METHOD__, $calendarId);

	$events = array();
	$query = $this->_event_filter_query();
	$storage = $this->get_storage_folder($calendarId);
	if ($storage) {
	foreach ($storage->select($query) as $event) {
	// post-filter events to suppress declined invitations
	if (!$this->_event_filter_compare($event)) {
	continue;
	}

	// get tags/categories from relations
	$this->load_tags($event);

	$events[] = array(
	'id' => $event['uid'],
	'uri' => VObjectUtils::uid2uri($event['uid'], '.ics'),
	'lastmodified' => $event['changed'] ? $event['changed']->format('U') : null,
	'calendarid' => $calendarId,
	'etag' => self::_get_etag($event),
	'size' => $event['_size'],
	);
	}
	}

	return $events;
	}

	/**
	* Returns information from a single calendar object, based on it's object
	* uri.
	*
	* The returned array must have the same keys as getCalendarObjects. The
	* 'calendardata' object is required here though, while it's not required
	* for getCalendarObjects.
	*
	* @param mixed $calendarId
	* @param string $objectUri
	* @return array
	*/
	public function getCalendarObject($calendarId, $objectUri)
	{
	console(__METHOD__, $calendarId, $objectUri);

	$uid = VObjectUtils::uri2uid($objectUri, '.ics');
	$storage = $this->get_storage_folder($calendarId);

	// attachment content is requested
	if (preg_match('!^(.+).ics:attachment:(\d+):.+$!', $objectUri, $m)) {
	$uid = VObjectUtils::uri2uid($m[1]);
	$part = $m[2];
	}

	if ($storage && ($event = $storage->get_object($uid))) {
	// deliver attachment content directly
	if ($part && !empty($event['_attachments'])) {
	foreach ($event['_attachments'] as $attachment) {
	if ($attachment['id'] == $part) {
	header('Content-Type: ' . $attachment['mimetype']);
	header('Content-Disposition: inline; filename="' . $attachment['name'] . '"');
	$storage->get_attachment($uid, $part, null, true);
	exit;
	}
	}
	}

	// map attributes
	$event['attachments'] = $event['_attachments'];

	// compose an absolute URI for referencing object attachments
	$base_uri = DAVBackend::abs_url(array(
	CalDAV\Plugin::CALENDAR_ROOT,
	preg_replace('!principals/!', '', $this->calendars[$calendarId]['principaluri']),
	$calendarId,
	VObjectUtils::uid2uri($event['uid'], '.ics'),
	));

	// get tags/categories from relations
	$this->load_tags($event);

	// default response
	return array(
	'id' => $event['uid'],
	'uri' => VObjectUtils::uid2uri($event['uid'], '.ics'),
	'lastmodified' => $event['changed'] ? $event['changed']->format('U') : null,
	'calendarid' => $calendarId,
	'calendardata' => $this->_to_ical($event, $base_uri, $storage),
	'etag' => self::_get_etag($event),
	);
	}

	return array();
	}


	/**
	* Creates a new calendar object.
	*
	* It is possible return an etag from this function, which will be used in
	* the response to this PUT request. Note that the ETag must be surrounded
	* by double-quotes.
	*
	* However, you should only really return this ETag if you don't mangle the
	* calendar-data. If the result of a subsequent GET to this object is not
	* the exact same as this request body, you should omit the ETag.
	*
	* @param mixed $calendarId
	* @param string $objectUri
	* @param string $calendarData
	* @return string\|null
	*/
	public function createCalendarObject($calendarId, $objectUri, $calendarData)
	{
	console(__METHOD__, $calendarId, $objectUri, $calendarData);

	$uid = VObjectUtils::uri2uid($objectUri, '.ics');
	$storage = $this->get_storage_folder($calendarId);
	$object = $this->parse_calendar_data($calendarData, $uid);

	if (empty($object) \|\| empty($object['uid'])) {
	throw new DAV\Exception('Parse error: not a valid iCalendar 2.0 object');
	}

	// if URI doesn't match the content's UID, the object might already exist!
	if ($object['uid'] != $uid && $storage->get_object($object['uid'])) {
	$objectUri = VObjectUtils::uid2uri($object['uid'], '.ics');
	Plugin::$redirect_basename = $objectUri;
	return $this->updateCalendarObject($calendarId, $objectUri, $calendarData);
	}

	// map attachments attribute
	$object['_attachments'] = $object['attachments'];
	unset($object['attachments']);

	// remove categories from object data (only for tasks yet)
	if ($object['_type'] == 'task') {
	$tags = (array)$object['categories'];
	unset($object['categories']);
	}

	$success = $storage->save($object, $object['_type']);
	if (!$success) {
	rcube::raise_error(array(
	'code' => 600, 'type' => 'php',
	'file' => __FILE__, 'line' => __LINE__,
	'message' => "Error saving $object[_type] object to Kolab server"),
	true, false);

	throw new DAV\Exception('Error saving calendar object to backend');
	}

	// save tag relations on success (only available for tasks yet)
	if ($object['_type'] == 'task') {
	$this->save_tags($uid, $tags);
	$object['categories'] = $tags; // add again for etag computation
	}

	// send Location: header if URI doesn't match object's UID (Bug #2109)
	if ($object['uid'] != $uid) {
	Plugin::$redirect_basename = VObjectUtils::uid2uri($object['uid'], '.ics');
	}

	// return new Etag
	return $success ? self::_get_etag($object) : null;
	}

	/**
	* Updates an existing calendarobject, based on it's uri.
	*
	* It is possible return an etag from this function, which will be used in
	* the response to this PUT request. Note that the ETag must be surrounded
	* by double-quotes.
	*
	* However, you should only really return this ETag if you don't mangle the
	* calendar-data. If the result of a subsequent GET to this object is not
	* the exact same as this request body, you should omit the ETag.
	*
	* @param mixed $calendarId
	* @param string $objectUri
	* @param string $calendarData
	* @return string\|null
	*/
	public function updateCalendarObject($calendarId, $objectUri, $calendarData)
	{
	console(__METHOD__, $calendarId, $objectUri, $calendarData);

	$uid = VObjectUtils::uri2uid($objectUri, '.ics');
	$storage = $this->get_storage_folder($calendarId);
	$object = $this->parse_calendar_data($calendarData, $uid);

	if (empty($object)) {
	throw new DAV\Exception('Parse error: not a valid iCalendar 2.0 object');
	}

	// sanity check
	if ($object['uid'] != $uid) {
	rcube::raise_error(array(
	'code' => 600, 'type' => 'php',
	'file' => __FILE__, 'line' => __LINE__,
	'message' => "Error creating calendar object: UID doesn't match object URI"),
	true, false);

	throw new DAV\Exception\NotFound("UID doesn't match object URI");
	}

	// copy meta data (starting with _) from old object
	$old = $storage->get_object($uid);
	foreach ((array)$old as $key => $val) {
	if (!isset($object[$key]) && $key[0] == '_')
	$object[$key] = $val;
	}

	// process attachments
	if (/* user agent known to handle attachments inline */ !empty($object['attachments'])) {
	$object['_attachments'] = $object['attachments'];
	unset($object['attachments']);

	// mark all existing attachments as deleted (update is always absolute)
	foreach ($old['_attachments'] as $key => $attach) {
	$object['_attachments'][$key] = false;
	}
	}

	// remove categories from object data (only for tasks yet)
	if ($object['_type'] == 'task') {
	$tags = (array)$object['categories'];
	unset($object['categories']);
	}

	// save object
	$saved = $storage->save($object, $object['_type'], $uid);
	if (!$saved) {
	rcube::raise_error(array(
	'code' => 600, 'type' => 'php',
	'file' => __FILE__, 'line' => __LINE__,
	'message' => "Error saving event object to Kolab server"),
	true, false);

	Plugin::$redirect_basename = null;
	throw new DAV\Exception('Error saving event object to backend');
	}

	// save tag relations on success (only available for tasks yet)
	if ($object['_type'] == 'task') {
	$this->save_tags($uid, $tags);
	$object['categories'] = $tags; // add again for etag computation
	}

	// return new Etag
	return self::_get_etag($object);
	}

	/**
	* Deletes an existing calendar object.
	*
	* @param mixed $calendarId
	* @param string $objectUri
	* @return void
	*/
	public function deleteCalendarObject($calendarId, $objectUri)
	{
	console(__METHOD__, $calendarId, $objectUri);

	$uid = VObjectUtils::uri2uid($objectUri, '.ics');
	if ($storage = $this->get_storage_folder($calendarId)) {
	if ($storage->delete($uid)) {
	$this->save_tags($uid, null);
	}
	}
	}

	/**
	* Performs a calendar-query on the contents of this calendar.
	*
	* The calendar-query is defined in RFC4791 : CalDAV. Using the
	* calendar-query it is possible for a client to request a specific set of
	* object, based on contents of iCalendar properties, date-ranges and
	* iCalendar component types (VTODO, VEVENT).
	*
	* This method should just return a list of (relative) urls that match this
	* query.
	*
	* The list of filters are specified as an array. The exact array is
	* documented by Sabre\CalDAV\CalendarQueryParser.
	*
	* Note that it is extremely likely that getCalendarObject for every path
	* returned from this method will be called almost immediately after. You
	* may want to anticipate this to speed up these requests.
	*
	* Requests that are extremely common are:
	* * requests for just VEVENTS
	* * requests for just VTODO
	* * requests with a time-range-filter on either VEVENT or VTODO.
	*
	* ..and combinations of these requests. It may not be worth it to try to
	* handle every possible situation and just rely on the (relatively
	* easy to use) CalendarQueryValidator to handle the rest.
	*
	* Note that especially time-range-filters may be difficult to parse. A
	* time-range filter specified on a VEVENT must for instance also handle
	* recurrence rules correctly.
	* A good example of how to interprete all these filters can also simply
	* be found in Sabre\CalDAV\CalendarQueryFilter. This class is as correct
	* as possible, so it gives you a good idea on what type of stuff you need
	* to think of.
	*
	* @param mixed $calendarId
	* @param array $filters
	* @return array
	*/
	public function calendarQuery($calendarId, array $filters)
	{
	console(__METHOD__, $calendarId, $filters);

	// build kolab storage query from $filters
	$query = $this->_event_filter_query();
	foreach ((array)$filters['comp-filters'] as $filter) {
	if ($filter['name'] != 'VEVENT')
	continue;
	if (is_array($filter['time-range'])) {
	if (!empty($filter['time-range']['end'])) {
	$query[] = array('dtstart', '<=', $filter['time-range']['end']);
	}
	if (!empty($filter['time-range']['start'])) {
	$query[] = array('dtend', '>=', $filter['time-range']['start']);
	}
	}
	if (is_array($filter['prop-filters'])) {
	foreach ($filter['prop-filters'] as $prop_filter) {
	$match = $prop_filter['text-match'];
	if ($match['value']) {
	$op = $match['negate-condition'] ? '!=' : '=';
	switch ($prop_filter['name']) {
	case 'UID':
	$query[] = array('uid', $op, $match['value']);
	break;
	}
	}
	}
	}
	}

	$results = array();
	if ($storage = $this->get_storage_folder($calendarId)) {
	foreach ($storage->select($query) as $event) {
	// post-filter events to suppress declined invitations
	if ($this->_event_filter_compare($event)) {
	$results[] = $event['uid'] . '.ics';
	}
	}
	}

	return $results;
	}

	/**
	* Set User-Agent string of the connected client
	*/
	public function setUserAgent($uastring)
	{
	$ua_classes = array(
	'ical' => 'iCal/\d',
	'outlook' => 'iCal4OL/\d',
	'lightning' => 'Lightning/\d',
	);

	foreach ($ua_classes as $class => $regex) {
	if (preg_match("!$regex!", $uastring)) {
	$this->useragent = $class;
	break;
	}
	}
	}


	/******** SchedulingBackend methods *********/

	/**
	* Returns a single scheduling object for the inbox collection.
	*
	* The returned array should contain the following elements:
	* * uri - A unique basename for the object. This will be used to
	* construct a full uri.
	* * calendardata - The iCalendar object
	* * lastmodified - The last modification date. Can be an int for a unix
	* timestamp, or a PHP DateTime object.
	* * etag - A unique token that must change if the object changed.
	* * size - The size of the object, in bytes.
	*
	* @param string $principalUri
	* @param string $objectUri
	* @return array
	*/
	public function getSchedulingObject($principalUri, $objectUri)
	{
	console(__METHOD__, $principalUri, $objectUri);

	if (!$this->is_current_pricipal($principalUri)) {
	return array();
	}

	$uid = VObjectUtils::uri2uid($objectUri, '.ics');
	list($msguid, $mime_id) = explode('-', $uid, 2);

	$message = new rcube_message($msguid, 'INBOX');
	if ($ical = $message->get_part_content($mime_id, null, false, 0, false)) {
	if ($event = $this->parse_calendar_data($ical, null)) {
	if ($event['_type'] == 'event') {
	$event['_msguid'] = $msguid;
	return array(
	'uri' => $objectUri,
	'calendardata' => $ical,
	'lastmodified' => $event['changed'] ? $event['changed']->format('U') : null,
	'etag' => self::_get_etag($event),
	);
	}
	}
	}

	return array();
	}

	/**
	* Returns all scheduling objects for the inbox collection.
	*
	* These objects should be returned as an array. Every item in the array
	* should follow the same structure as returned from getSchedulingObject.
	*
	* The main difference is that 'calendardata' is optional.
	*
	* @param string $principalUri
	* @return array
	*/
	public function getSchedulingObjects($principalUri)
	{
	console(__METHOD__, $principalUri);

	$results = array();
	+ $threshold = new \DateTime('now - 7 days');

	// we can only access the current user's calendars (if enabled)
	if (!$this->is_current_pricipal($principalUri) \|\| !rcube::get_instance()->config->get('kolabdav_caldav_inbox', false)) {
	return $results;
	}

	// find iTip messages in users email INBOX and extract the ics attachment.
	foreach ($this->search_email_inbox() as $msg) {
	list($msguid, $mime_id) = $msg;
	$message = new rcube_message($msguid, 'INBOX');
	if ($ical = $message->get_part_content($mime_id, null, false, 0, false)) {
	if ($event = $this->parse_calendar_data($ical, null)) {
	if ($event['_type'] != 'event') {
	continue;
	}

	+ // filter past event invitations
	+ if (is_a($event['end'], '\\DateTime') && $event['end'] < $threshold && empty($event['recurrence'])) {
	+ console(sprintf('Skip iTip message for past event: %s // %s // %s', $event['uid'], $event['title'], $event['end']->format('c')));
	+ continue;
	+ }
	+
	$event['_msguid'] = $msguid;
	$results[] = array(
	'uri' => VObjectUtils::uid2uri($msguid . '-' . $mime_id, '.ics'),
	'calendardata' => $ical,
	'lastmodified' => $event['changed'] ? $event['changed']->format('U') : null,
	'etag' => self::_get_etag($event),
	);
	-
	- break;
	}
	}
	}

	return $results;
	}

	/**
	* Deletes a scheduling object from the inbox collection.
	*
	* @param string $principalUri
	* @param string $objectUri
	* @return void
	*/
	public function deleteSchedulingObject($principalUri, $objectUri)
	{
	console(__METHOD__, $principalUri, $objectUri);

	$rcube = rcube::get_instance();

	// we can only access the current user's inbox (if enabled)
	if (!$this->is_current_pricipal($principalUri) \|\| !$rcube->config->get('kolabdav_caldav_inbox', false)) {
	return;
	}

	- // TODO: get the referenced iTip message from email INBOX and
	+ // get the referenced iTip message from email INBOX and
	// copy it to the default calendar. This will also remove the message
	// from the email inbox as the message is considered 'processed'.
	$uid = VObjectUtils::uri2uid($objectUri, '.ics');
	list($msguid, $mime_id) = explode('-', $uid, 2);

	$message = new rcube_message($msguid, 'INBOX');
	if ($ical = $message->get_part_content($mime_id, null, false, 0, false)) {
	if ($object = $this->parse_calendar_data($ical, null)) {
	if ($object['_type'] != 'event') {
	return;
	}

	+ console('Copy iTip Schedule object', $object);
	+
	// get default calendar and search for an existing copy
	- $calendarId = reset(array_keys($this->_read_calendars()));
	+ $calendars = $this->_read_calendars();
	+ $calendarId = reset(array_keys($calendars));
	+
	+ // select private/confidential calendar folder
	+ if (!empty($object['sensitivity'])) {
	+ foreach ($calendars as $calid => $calprop) {
	+ if (($folder = $this->folders[$calid]) && $object['sensitivity'] === $folder->subtype) {
	+ $calendarId = $calid;
	+ }
	+ }
	+ }
	+
	$storage = $this->get_storage_folder($calendarId);
	$existing = $storage->get_object($object['uid']);
	+ $update = true;

	// copy meta data (starting with _) from old object
	if (!empty($existing)) {
	+ // ignore update if existing is newer
	+ if ($existing['sequence'] > $object['sequence']) {
	+ $update = false;
	+ }
	+
	foreach ((array)$existing as $key => $val) {
	if (!isset($object[$key]) && $key[0] == '_')
	$object[$key] = $val;
	}
	}

	- // TODO: if iTip REPLY or CANCEL, only copy necessary properties
	+ // act according to the scheduling method
	+ switch ($object['_method']) {
	+ case 'REQUEST':
	+ // store the new version
	+ break;
	+
	+ case 'REPLY':
	+ if (!empty($existing)) {
	+ // TODO: only update attendee status(es) on the existing event
	+ // as in pykolab/wallace/module_invitationpolicy/process_itip_reply()
	+ // FIXME: replies can refer to single recurrence instances
	+ $attendee = null;
	+ $object = $existing;
	+ $update = false;
	+ }
	+ else {
	+ $update = false;
	+ }
	+ break;
	+
	+ case 'CANCEL':
	+ // set status to cancelled
	+ if (!empty($existing)) {
	+ $existing['cancelled'] = true;
	+ $existing['status'] = 'cancelled';
	+ $object = $existing;
	+ }
	+ else {
	+ $update = false;
	+ }
	+ break;
	+
	+ default:
	+ console('iTip method ' . $object['_method'] . ' not supported; ignoring');
	+ $update = false;
	+ }

	- // map attachments attribute
	- $object['_attachments'] = $object['attachments'];
	- unset($object['attachments']);
	+ if ($update) {
	+ // map attachments attribute
	+ $object['_attachments'] = $object['attachments'];
	+ unset($object['attachments']);

	- $success = $storage->save($object, $object['_type'], $existing['uid']);
	- if (!$success) {
	- rcube::raise_error(array(
	- 'code' => 600, 'type' => 'php',
	- 'file' => __FILE__, 'line' => __LINE__,
	- 'message' => "Error saving $object[_type] object to Kolab server"),
	- true, false);
	+ $success = $storage->save($object, $object['_type'], $existing['uid']);
	+ if (!$success) {
	+ rcube::raise_error(array(
	+ 'code' => 600, 'type' => 'php',
	+ 'file' => __FILE__, 'line' => __LINE__,
	+ 'message' => "Error saving $object[_type] object to Kolab server"),
	+ true, false);

	- throw new DAV\Exception('Error saving calendar object to backend');
	+ throw new DAV\Exception('Error saving calendar object to backend');
	+ }
	}

	- // remove iTip message from email inbox
	- // TODO: move to Trash instead ?
	+ // remove iTip message from email inbox or move to Trash instead ?
	$imap = $rcube->get_storage();
	- $imap->move_message($msguid, 'Trash', 'INBOX');
	+ $done = $imap->move_message($msguid, 'Trash', 'INBOX');
	+ console("MOVE $msguid to Trash", $done);
	//console("DELETE $msguid", $imap->delete_message($msguid, 'INBOX'));
	}
	}
	}

	/**
	* Creates a new scheduling object. This should land in a users' inbox.
	*
	* @param string $principalUri
	* @param string $objectUri
	* @param string $objectData
	* @return void
	*/
	public function createSchedulingObject($principalUri, $objectUri, $objectData)
	{
	console(__METHOD__, $principalUri, $objectUri, $objectData);

	// accept only for current user principal (we don't have permissions for other users)
	if ($this->is_current_pricipal($principalUri)) {

	}
	else {
	// send as iTip?
	}
	}

	/**
	* Return the ctag value for the scheduling inbox
	*/
	public function getSchedulingInboxCtag($principalUri)
	{
	$rcube = rcube::get_instance();

	if ($this->is_current_pricipal($principalUri) && $rcube->config->get('kolabdav_caldav_inbox', false)) {
	// we could use the INBOX imap folder properties but these are likely subject to
	// frequent changes without new invitations. Let's count potential iTip messages:
	$candidates = $this->search_email_inbox();

	if (count($candidates)) {
	$fdata = $rcube->storage->folder_data('INBOX');
	return sprintf('%d-%d-%d-%d',
	$fdata['UIDVALIDITY'],
	$fdata['HIGHESTMODSEQ'],
	$fdata['UIDNEXT'],
	count($candidates)
	);
	}
	}

	return "empty-000";
	}

	/**
	*
	*/
	protected function search_email_inbox()
	{
	$result = array();
	$rcube = rcube::get_instance();
	$imap = $rcube->get_storage();

	// FIXME: search by content-type doesn't return any results from Cyrus IMAP
	// $query = $imap->search_once('INBOX', 'UNDELETED OR OR HEADER Content-Type text/calendar HEADER Content-Type multipart/mixed HEADER Content-Type multipart/alternative');
	$query = $imap->search_once('INBOX', 'UNDELETED');
	if ($query && $query->count() > 0) {
	foreach ($query->get() as $msguid) {
	// get bodystructure and check for iTip parts
	$message = new rcube_message($msguid, 'INBOX');
	foreach ((array)$message->mime_parts as $part) {
	if (self::part_is_itip($part)) {
	$result[] = array($msguid, $part->mime_id);
	}
	}
	}
	}

	return $result;
	}

	/**
	* Checks if specified message part is a vcalendar data
	*
	* @param rcube_message_part Part object
	* @return boolean True if part is of type vcard
	*/
	protected static function part_is_itip($part)
	{
	return (
	in_array($part->mimetype, array('text/calendar', 'text/x-vcalendar', 'application/ics')) \|\|
	($part->mimetype == 'application/x-any' && $part->filename && preg_match('/\.ics$/i', $part->filename))
	) && !empty($part->ctype_parameters['method']);
	}


	/******** Data conversion utilities *********/

	/**
	* Get object tags
	*/
	private function load_tags(&$event)
	{
	// tag relations are only available for tasks yet
	if ($event['_type'] != 'task') {
	return;
	}

	$config = kolab_storage_config::get_instance();
	$tags = $config->get_tags($event['uid']);

	if (!empty($tags)) {
	$event['categories'] = array();
	}

	foreach ($tags as $tag) {
	$event['categories'][] = $tag['name'];

	// modify changed time if relation is newer
	if ($tag['changed'] && !$event['changed'] \|\| $tag['changed'] > $event['changed']) {
	$event['changed'] = $tag['changed'];
	}
	}
	}

	/**
	* Update object tags
	*/
	private function save_tags($uid, $tags)
	{
	$config = kolab_storage_config::get_instance();
	$config->save_tags($uid, $tags);
	}

	/**
	* Parse the given iCal string into a hash array kolab_format_event can handle
	*
	* @param string iCal data block
	* @return array Hash array with event properties or null on failure
	*/
	private function parse_calendar_data($calendarData, $uid)
	{
	try {
	$ical = libcalendaring::get_ical();

	// use already parsed object
	if (Plugin::$parsed_vevent && Plugin::$parsed_vevent->UID == $uid) {
	$objects = $ical->import_from_vobject(Plugin::$parsed_vcalendar);
	}
	else {
	$objects = $ical->import($calendarData);
	}

	// return the first object
	if (count($objects)) {
	$objects[0]['_method'] = $ical->method;
	return $objects[0];
	}
	}
	catch (VObject\ParseException $e) {
	rcube::raise_error(array(
	'code' => 600, 'type' => 'php',
	'file' => __FILE__, 'line' => __LINE__,
	'message' => "iCal data parse error: " . $e->getMessage()),
	true, false);
	}

	return null;
	}

	/**
	* Build a valid iCal format block from the given event
	*
	* @param array Hash array with event/task properties from libkolab
	* @param string Absolute URI referenceing this event object
	* @param object RECURRENCE-ID property when serializing a recurrence exception
	* @return mixed VCALENDAR string containing the VEVENT data
	* or VObject\VEvent object with a recurrence exception instance
	* @see: \libvcalendar::export()
	*/
	private function _to_ical($event, $base_uri, $storage, $recurrence_id = null)
	{
	$ical = libcalendaring::get_ical();
	$ical->set_prodid('-//Kolab//iRony DAV Server ' . KOLAB_DAV_VERSION . '//Sabre//Sabre VObject ' . VObject\Version::VERSION . '//EN');
	$ical->set_agent($this->useragent == 'ical' ? 'Apple' : '');

	// list attachments as absolute URIs for Thunderbird
	if ($this->useragent == 'lightning') {
	$ical->set_attach_uri($base_uri . ':attachment:{{id}}:{{name}}');
	$get_attachment = null;
	}
	else { // embed attachments for others
	$get_attachment = function($id, $event) use ($storage) {
	return $storage->get_attachment($event['uid'], $id);
	};
	}

	$events = array($event);

	// add more instances from exceptions (not recurrence) to the output
	if (!empty($event['exceptions']) && empty($event['recurrence'])) {
	$events = array_merge($events, $event['exceptions']);
	}

	return $ical->export($events, null, false, $get_attachment, false);
	}

	/**
	* Wrapper for libcalendaring::get_user_emails()
	*/
	private function get_user_emails()
	{
	$emails = libcalendaring::get_instance()->get_user_emails();

	if (empty($emails)) {
	$emails = array(HTTPBasic::$current_user);
	}

	return $emails;
	}

	/**
	* Provide basic query for kolab_storage_folder::select()
	*
	* @param boolean Filter for inbox events (i.e. status=NEEDS-ACTION)
	* @return array List of query parameters for kolab_storage_folder::select()
	*/
	private function _event_filter_query($inbox = false)
	{
	// get email addresses of the current user
	$user_emails = $this->get_user_emails();
	$query = $subquery = array();

	// add query to exclude declined invitations
	foreach ($user_emails as $email) {
	if ($inbox) {
	$subquery[] = array('tags', '=', 'x-partstat:' . $email . ':needs-action');
	$subquery[] = array('tags', '=', 'x-partstat:' . $email . ':needs-action');
	}
	else {
	$query[] = array('tags', '!=', 'x-partstat:' . $email . ':declined');
	}
	}

	if (!empty($subquery)) {
	$query[] = array($subquery, 'OR');
	}

	return $query;
	}

	/**
	* Check the given event if it matches the filter
	*
	* @param array Hash array with event properties
	* @param boolean Filter for inbox events (i.e. status=NEEDS-ACTION)
	* @return boolean True if matches, false if not
	*/
	private function _event_filter_compare($event, $inbox = false)
	{
	static $user_emails;

	if (!is_array($user_emails)) {
	$user_emails = $this->get_user_emails();
	}

	if (is_array($event['attendees'])) {
	foreach ($event['attendees'] as $attendee) {
	if (in_array($attendee['email'], $user_emails)) {
	if ($attendee['status'] == 'DECLINED') {
	return false;
	}
	else if ($inbox && $attendee['status'] == 'NEEDS-ACTION') {
	return true;
	}
	}
	}
	}

	return !$inbox;
	}

	/**
	* Generate an Etag string from the given event data
	*
	* @param array Hash array with event properties from libkolab
	* @return string Etag string
	*/
	private static function _get_etag($event)
	{
	return sprintf('"%s-%d-%s"',
	substr(md5($event['uid']), 0, 16),
	$event['_msguid'],
	!empty($event['categories']) ? substr(md5(join(',', (array)$event['categories'])), 0, 16) : '0'
	);
	}

	/**
	* Helpter method to determine whether the given principal URI
	* matches the authenticated user principal.
	*/
	private function is_current_pricipal($principalUri)
	{
	return $principalUri === 'principals/' . HTTPBasic::$current_user;
	}

	}
	diff --git a/lib/Kolab/CalDAV/IMipPlugin.php b/lib/Kolab/CalDAV/IMipPlugin.php
	index 5fae8f0..bc016db 100644
	--- a/lib/Kolab/CalDAV/IMipPlugin.php
	+++ b/lib/Kolab/CalDAV/IMipPlugin.php
	@@ -1,135 +1,137 @@
	<?php

	/**
	* Extended CalDAV IMip plugin for the Kolab DAV server
	*
	* @author Thomas Bruederli <bruederli@kolabsys.com>
	*
	* Copyright (C) 2014, Kolab Systems AG <contact@kolabsys.com>
	*
	* This program is free software: you can redistribute it and/or modify
	* it under the terms of the GNU Affero General Public License as
	* published by the Free Software Foundation, either version 3 of the
	* License, or (at your option) any later version.
	*
	* This program 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 Affero General Public License for more details.
	*
	* You should have received a copy of the GNU Affero General Public License
	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	*/

	namespace Kolab\CalDAV;

	use \rcube;
	use \rcube_utils;
	use \Mail_mime;

	use Sabre\VObject;
	use Sabre\CalDAV;
	use Sabre\DAV;

	/**
	* iMIP plugin.
	*
	* This class is responsible for sending out iMIP messages. iMIP is the
	* email-based transport for iTIP. iTIP deals with scheduling operations for
	* iCalendar objects.
	*/
	class IMipPlugin extends CalDAV\Schedule\IMipPlugin
	{

	/**
	* Event handler for the 'schedule' event.
	*
	* @param ITip\Message $iTipMessage
	* @return void
	*/
	function schedule(VObject\ITip\Message $iTipMessage)
	{
	console(__METHOD__, $iTipMessage->method, $iTipMessage->recipient, $iTipMessage->significantChange, $iTipMessage->scheduleStatus);

	// Not sending any emails if the system considers the update insignificant.
	if (!$iTipMessage->significantChange) {
	if (!$iTipMessage->scheduleStatus) {
	$iTipMessage->scheduleStatus = '1.0;We got the message, but it\'s not significant enough to warrant an email';
	}
	return;
	}

	$recipient = preg_replace('!^mailto:!i', '', $iTipMessage->recipient);
	$summary = strval($iTipMessage->message->VEVENT->SUMMARY);

	$rcube = rcube::get_instance();
	$sender = $rcube->user->get_identity();
	$sender_email = $sender['email'] ?: $rcube->get_user_email();
	$sender_name = $sender['name'] ?: $rcube->get_user_name();

	$subject = 'KolabDAV iTIP message';
	switch (strtoupper($iTipMessage->method)) {
	case 'REPLY' :
	$subject = 'Re: ' . $summary;
	break;
	case 'REQUEST' :
	$subject = 'Invitation: ' .$summary;
	break;
	case 'CANCEL' :
	$subject = 'Cancelled: ' . $summary;
	break;
	}

	$sender = rcube_utils::idn_to_ascii($sender_email);
	$from = format_email_recipient($sender, $sender_name);
	$mailto = rcube_utils::idn_to_ascii($recipient);
	$to = format_email_recipient($mailto, $iTipMessage->recipientName);

	// copy some missing properties from master event to make it validate in our clients
	if (Plugin::$parsed_vevent && strval(Plugin::$parsed_vevent->UID) == strval($iTipMessage->uid)) {
	if (isset(Plugin::$parsed_vevent->DTEND)) {
	$iTipMessage->message->VEVENT->DTEND = clone Plugin::$parsed_vevent->DTEND;
	}
	if (isset(Plugin::$parsed_vevent->STATUS)) {
	$iTipMessage->message->VEVENT->STATUS = strval(Plugin::$parsed_vevent->STATUS);
	}
	}

	// compose multipart message using PEAR:Mail_Mime
	$message = new Mail_mime("\r\n");
	$message->setParam('text_encoding', 'quoted-printable');
	$message->setParam('head_encoding', 'quoted-printable');
	$message->setParam('head_charset', RCUBE_CHARSET);
	$message->setParam('text_charset', RCUBE_CHARSET . ";\r\n format=flowed");

	// compose common headers array
	$headers = array(
	'To' => $to,
	'From' => $from,
	'Date' => date('r'),
	'Reply-To' => $originator,
	'Message-ID' => $rcube->gen_message_id(),
	'X-Sender' => $sender,
	'Subject' => $subject,
	);
	if ($agent = $rcube->config->get('useragent'))
	$headers['User-Agent'] = $agent;

	$message->headers($headers);
	$message->setContentType('text/calendar', array('method' => strval($iTipMessage->method), 'charset' => RCUBE_CHARSET));
	$message->setTXTBody($iTipMessage->message->serialize());

	// send message through Roundcube's SMTP feature
	if ($rcube->deliver_message($message, $sender, $mailto, $smtp_error)) {
	$iTipMessage->scheduleStatus = '1.1;Scheduling message sent via iMip';
	}
	else {
	rcube::raise_error(array(
	'code' => 600, 'type' => 'php',
	'file' => __FILE__, 'line' => __LINE__,
	'message' => "Failed to send iTIP message to " . $mailto),
	true, false);
	}
	+
	+ console(__METHOD__, "DONE", $iTipMessage->scheduleStatus);
	}

	}

File Metadata

Mime Type: text/x-diff
Expires: Thu, Nov 21, 10:04 PM (10 h, 49 m)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 80051
Default Alt Text: (56 KB)

No OneTemporaryActions

View Options

File Metadata

Event Timeline

No OneTemporary
Actions