123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430 |
- <?php
- namespace Sabre\CalDAV;
- use Sabre\DAV;
- use Sabre\DAV\Exception\NotFound;
- use Sabre\DAV\MkCol;
- use Sabre\DAVACL;
- use Sabre\HTTP\URLUtil;
- /**
- * The CalendarHome represents a node that is usually in a users'
- * calendar-homeset.
- *
- * It contains all the users' calendars, and can optionally contain a
- * notifications collection, calendar subscriptions, a users' inbox, and a
- * users' outbox.
- *
- * @copyright Copyright (C) fruux GmbH (https://fruux.com/)
- * @author Evert Pot (http://evertpot.com/)
- * @license http://sabre.io/license/ Modified BSD License
- */
- class CalendarHome implements DAV\IExtendedCollection, DAVACL\IACL {
- /**
- * CalDAV backend
- *
- * @var Sabre\CalDAV\Backend\BackendInterface
- */
- protected $caldavBackend;
- /**
- * Principal information
- *
- * @var array
- */
- protected $principalInfo;
- /**
- * Constructor
- *
- * @param Backend\BackendInterface $caldavBackend
- * @param mixed $userUri
- */
- function __construct(Backend\BackendInterface $caldavBackend, $principalInfo) {
- $this->caldavBackend = $caldavBackend;
- $this->principalInfo = $principalInfo;
- }
- /**
- * Returns the name of this object
- *
- * @return string
- */
- function getName() {
- list(, $name) = URLUtil::splitPath($this->principalInfo['uri']);
- return $name;
- }
- /**
- * Updates the name of this object
- *
- * @param string $name
- * @return void
- */
- function setName($name) {
- throw new DAV\Exception\Forbidden();
- }
- /**
- * Deletes this object
- *
- * @return void
- */
- function delete() {
- throw new DAV\Exception\Forbidden();
- }
- /**
- * Returns the last modification date
- *
- * @return int
- */
- function getLastModified() {
- return null;
- }
- /**
- * Creates a new file under this object.
- *
- * This is currently not allowed
- *
- * @param string $filename
- * @param resource $data
- * @return void
- */
- function createFile($filename, $data = null) {
- throw new DAV\Exception\MethodNotAllowed('Creating new files in this collection is not supported');
- }
- /**
- * Creates a new directory under this object.
- *
- * This is currently not allowed.
- *
- * @param string $filename
- * @return void
- */
- function createDirectory($filename) {
- throw new DAV\Exception\MethodNotAllowed('Creating new collections in this collection is not supported');
- }
- /**
- * Returns a single calendar, by name
- *
- * @param string $name
- * @return Calendar
- */
- function getChild($name) {
- // Special nodes
- if ($name === 'inbox' && $this->caldavBackend instanceof Backend\SchedulingSupport) {
- return new Schedule\Inbox($this->caldavBackend, $this->principalInfo['uri']);
- }
- if ($name === 'outbox' && $this->caldavBackend instanceof Backend\SchedulingSupport) {
- return new Schedule\Outbox($this->principalInfo['uri']);
- }
- if ($name === 'notifications' && $this->caldavBackend instanceof Backend\NotificationSupport) {
- return new Notifications\Collection($this->caldavBackend, $this->principalInfo['uri']);
- }
- // Calendars
- foreach ($this->caldavBackend->getCalendarsForUser($this->principalInfo['uri']) as $calendar) {
- if ($calendar['uri'] === $name) {
- if ($this->caldavBackend instanceof Backend\SharingSupport) {
- if (isset($calendar['{http://calendarserver.org/ns/}shared-url'])) {
- return new SharedCalendar($this->caldavBackend, $calendar);
- } else {
- return new ShareableCalendar($this->caldavBackend, $calendar);
- }
- } else {
- return new Calendar($this->caldavBackend, $calendar);
- }
- }
- }
- if ($this->caldavBackend instanceof Backend\SubscriptionSupport) {
- foreach ($this->caldavBackend->getSubscriptionsForUser($this->principalInfo['uri']) as $subscription) {
- if ($subscription['uri'] === $name) {
- return new Subscriptions\Subscription($this->caldavBackend, $subscription);
- }
- }
- }
- throw new NotFound('Node with name \'' . $name . '\' could not be found');
- }
- /**
- * Checks if a calendar exists.
- *
- * @param string $name
- * @return bool
- */
- function childExists($name) {
- try {
- return !!$this->getChild($name);
- } catch (NotFound $e) {
- return false;
- }
- }
- /**
- * Returns a list of calendars
- *
- * @return array
- */
- function getChildren() {
- $calendars = $this->caldavBackend->getCalendarsForUser($this->principalInfo['uri']);
- $objs = [];
- foreach ($calendars as $calendar) {
- if ($this->caldavBackend instanceof Backend\SharingSupport) {
- if (isset($calendar['{http://calendarserver.org/ns/}shared-url'])) {
- $objs[] = new SharedCalendar($this->caldavBackend, $calendar);
- } else {
- $objs[] = new ShareableCalendar($this->caldavBackend, $calendar);
- }
- } else {
- $objs[] = new Calendar($this->caldavBackend, $calendar);
- }
- }
- if ($this->caldavBackend instanceof Backend\SchedulingSupport) {
- $objs[] = new Schedule\Inbox($this->caldavBackend, $this->principalInfo['uri']);
- $objs[] = new Schedule\Outbox($this->principalInfo['uri']);
- }
- // We're adding a notifications node, if it's supported by the backend.
- if ($this->caldavBackend instanceof Backend\NotificationSupport) {
- $objs[] = new Notifications\Collection($this->caldavBackend, $this->principalInfo['uri']);
- }
- // If the backend supports subscriptions, we'll add those as well,
- if ($this->caldavBackend instanceof Backend\SubscriptionSupport) {
- foreach ($this->caldavBackend->getSubscriptionsForUser($this->principalInfo['uri']) as $subscription) {
- $objs[] = new Subscriptions\Subscription($this->caldavBackend, $subscription);
- }
- }
- return $objs;
- }
- /**
- * Creates a new calendar or subscription.
- *
- * @param string $name
- * @param MkCol $mkCol
- * @throws DAV\Exception\InvalidResourceType
- * @return void
- */
- function createExtendedCollection($name, MkCol $mkCol) {
- $isCalendar = false;
- $isSubscription = false;
- foreach ($mkCol->getResourceType() as $rt) {
- switch ($rt) {
- case '{DAV:}collection' :
- case '{http://calendarserver.org/ns/}shared-owner' :
- // ignore
- break;
- case '{urn:ietf:params:xml:ns:caldav}calendar' :
- $isCalendar = true;
- break;
- case '{http://calendarserver.org/ns/}subscribed' :
- $isSubscription = true;
- break;
- default :
- throw new DAV\Exception\InvalidResourceType('Unknown resourceType: ' . $rt);
- }
- }
- $properties = $mkCol->getRemainingValues();
- $mkCol->setRemainingResultCode(201);
- if ($isSubscription) {
- if (!$this->caldavBackend instanceof Backend\SubscriptionSupport) {
- throw new DAV\Exception\InvalidResourceType('This backend does not support subscriptions');
- }
- $this->caldavBackend->createSubscription($this->principalInfo['uri'], $name, $properties);
- } elseif ($isCalendar) {
- $this->caldavBackend->createCalendar($this->principalInfo['uri'], $name, $properties);
- } else {
- throw new DAV\Exception\InvalidResourceType('You can only create calendars and subscriptions in this collection');
- }
- }
- /**
- * Returns the owner principal
- *
- * This must be a url to a principal, or null if there's no owner
- *
- * @return string|null
- */
- function getOwner() {
- return $this->principalInfo['uri'];
- }
- /**
- * Returns a group principal
- *
- * This must be a url to a principal, or null if there's no owner
- *
- * @return string|null
- */
- function getGroup() {
- return null;
- }
- /**
- * Returns a list of ACE's for this node.
- *
- * Each ACE has the following properties:
- * * 'privilege', a string such as {DAV:}read or {DAV:}write. These are
- * currently the only supported privileges
- * * 'principal', a url to the principal who owns the node
- * * 'protected' (optional), indicating that this ACE is not allowed to
- * be updated.
- *
- * @return array
- */
- function getACL() {
- return [
- [
- 'privilege' => '{DAV:}read',
- 'principal' => $this->principalInfo['uri'],
- 'protected' => true,
- ],
- [
- 'privilege' => '{DAV:}write',
- 'principal' => $this->principalInfo['uri'],
- 'protected' => true,
- ],
- [
- 'privilege' => '{DAV:}read',
- 'principal' => $this->principalInfo['uri'] . '/calendar-proxy-write',
- 'protected' => true,
- ],
- [
- 'privilege' => '{DAV:}write',
- 'principal' => $this->principalInfo['uri'] . '/calendar-proxy-write',
- 'protected' => true,
- ],
- [
- 'privilege' => '{DAV:}read',
- 'principal' => $this->principalInfo['uri'] . '/calendar-proxy-read',
- 'protected' => true,
- ],
- ];
- }
- /**
- * Updates the ACL
- *
- * This method will receive a list of new ACE's.
- *
- * @param array $acl
- * @return void
- */
- function setACL(array $acl) {
- throw new DAV\Exception\MethodNotAllowed('Changing ACL is not yet supported');
- }
- /**
- * Returns the list of supported privileges for this node.
- *
- * The returned data structure is a list of nested privileges.
- * See Sabre\DAVACL\Plugin::getDefaultSupportedPrivilegeSet for a simple
- * standard structure.
- *
- * If null is returned from this method, the default privilege set is used,
- * which is fine for most common usecases.
- *
- * @return array|null
- */
- function getSupportedPrivilegeSet() {
- return null;
- }
- /**
- * This method is called when a user replied to a request to share.
- *
- * This method should return the url of the newly created calendar if the
- * share was accepted.
- *
- * @param string href The sharee who is replying (often a mailto: address)
- * @param int status One of the SharingPlugin::STATUS_* constants
- * @param string $calendarUri The url to the calendar thats being shared
- * @param string $inReplyTo The unique id this message is a response to
- * @param string $summary A description of the reply
- * @return null|string
- */
- function shareReply($href, $status, $calendarUri, $inReplyTo, $summary = null) {
- if (!$this->caldavBackend instanceof Backend\SharingSupport) {
- throw new DAV\Exception\NotImplemented('Sharing support is not implemented by this backend.');
- }
- return $this->caldavBackend->shareReply($href, $status, $calendarUri, $inReplyTo, $summary);
- }
- /**
- * Searches through all of a users calendars and calendar objects to find
- * an object with a specific UID.
- *
- * This method should return the path to this object, relative to the
- * calendar home, so this path usually only contains two parts:
- *
- * calendarpath/objectpath.ics
- *
- * If the uid is not found, return null.
- *
- * This method should only consider * objects that the principal owns, so
- * any calendars owned by other principals that also appear in this
- * collection should be ignored.
- *
- * @param string $uid
- * @return string|null
- */
- function getCalendarObjectByUID($uid) {
- return $this->caldavBackend->getCalendarObjectByUID($this->principalInfo['uri'], $uid);
- }
- }
|