* * @author Christoph Wurst * @author Georg Ehrke * @author Roeland Jago Douma * * @license GNU AGPL version 3 or any later version * * 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 . * */ namespace OCA\DAV\CalDAV; use OCA\DAV\CalDAV\Auth\CustomPrincipalPlugin; use OCA\DAV\CalDAV\InvitationResponse\InvitationResponseServer; use OCP\Calendar\Exceptions\CalendarException; use OCP\Calendar\ICreateFromString; use OCP\Constants; use Sabre\DAV\Exception\Conflict; use function Sabre\Uri\split as uriSplit; class CalendarImpl implements ICreateFromString { /** @var CalDavBackend */ private $backend; /** @var Calendar */ private $calendar; /** @var array */ private $calendarInfo; /** * CalendarImpl constructor. * * @param Calendar $calendar * @param array $calendarInfo * @param CalDavBackend $backend */ public function __construct(Calendar $calendar, array $calendarInfo, CalDavBackend $backend) { $this->calendar = $calendar; $this->calendarInfo = $calendarInfo; $this->backend = $backend; } /** * @return string defining the technical unique key * @since 13.0.0 */ public function getKey() { return $this->calendarInfo['id']; } /** * In comparison to getKey() this function returns a human readable (maybe translated) name * @return null|string * @since 13.0.0 */ public function getDisplayName() { return $this->calendarInfo['{DAV:}displayname']; } /** * Calendar color * @return null|string * @since 13.0.0 */ public function getDisplayColor() { return $this->calendarInfo['{http://apple.com/ns/ical/}calendar-color']; } /** * @param string $pattern which should match within the $searchProperties * @param array $searchProperties defines the properties within the query pattern should match * @param array $options - optional parameters: * ['timerange' => ['start' => new DateTime(...), 'end' => new DateTime(...)]] * @param integer|null $limit - limit number of search results * @param integer|null $offset - offset for paging of search results * @return array an array of events/journals/todos which are arrays of key-value-pairs * @since 13.0.0 */ public function search($pattern, array $searchProperties = [], array $options = [], $limit = null, $offset = null) { return $this->backend->search($this->calendarInfo, $pattern, $searchProperties, $options, $limit, $offset); } /** * @return integer build up using \OCP\Constants * @since 13.0.0 */ public function getPermissions() { $permissions = $this->calendar->getACL(); $result = 0; foreach ($permissions as $permission) { switch ($permission['privilege']) { case '{DAV:}read': $result |= Constants::PERMISSION_READ; break; case '{DAV:}write': $result |= Constants::PERMISSION_CREATE; $result |= Constants::PERMISSION_UPDATE; break; case '{DAV:}all': $result |= Constants::PERMISSION_ALL; break; } } return $result; } /** * Create a new calendar event for this calendar * by way of an ICS string * * @param string $name the file name - needs to contan the .ics ending * @param string $calendarData a string containing a valid VEVENT ics * * @throws CalendarException */ public function createFromString(string $name, string $calendarData): void { $server = new InvitationResponseServer(false); /** @var CustomPrincipalPlugin $plugin */ $plugin = $server->server->getPlugin('auth'); // we're working around the previous implementation // that only allowed the public system principal to be used // so set the custom principal here $plugin->setCurrentPrincipal($this->calendar->getPrincipalURI()); if (empty($this->calendarInfo['uri'])) { throw new CalendarException('Could not write to calendar as URI parameter is missing'); } // Build full calendar path [, $user] = uriSplit($this->calendar->getPrincipalURI()); $fullCalendarFilename = sprintf('calendars/%s/%s/%s', $user, $this->calendarInfo['uri'], $name); // Force calendar change URI /** @var Schedule\Plugin $schedulingPlugin */ $schedulingPlugin = $server->server->getPlugin('caldav-schedule'); $schedulingPlugin->setPathOfCalendarObjectChange($fullCalendarFilename); $stream = fopen('php://memory', 'rb+'); fwrite($stream, $calendarData); rewind($stream); try { $server->server->createFile($fullCalendarFilename, $stream); } catch (Conflict $e) { throw new CalendarException('Could not create new calendar event: ' . $e->getMessage(), 0, $e); } finally { fclose($stream); } } }