123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261 |
- <?php
- namespace Sabre\CalDAV\Schedule;
- use Sabre\DAV;
- use Sabre\CalDAV;
- use Sabre\DAVACL;
- use Sabre\CalDAV\Backend;
- use Sabre\VObject;
- /**
- * The CalDAV scheduling inbox
- *
- * @copyright Copyright (C) fruux GmbH (https://fruux.com/)
- * @author Evert Pot (http://evertpot.com/)
- * @license http://sabre.io/license/ Modified BSD License
- */
- class Inbox extends DAV\Collection implements IInbox {
- /**
- * CalDAV backend
- *
- * @var Backend\BackendInterface
- */
- protected $caldavBackend;
- /**
- * The principal Uri
- *
- * @var string
- */
- protected $principalUri;
- /**
- * Constructor
- *
- * @param Backend\SchedulingSupport $caldavBackend
- * @param string $principalUri
- */
- function __construct(Backend\SchedulingSupport $caldavBackend, $principalUri) {
- $this->caldavBackend = $caldavBackend;
- $this->principalUri = $principalUri;
- }
- /**
- * Returns the name of the node.
- *
- * This is used to generate the url.
- *
- * @return string
- */
- function getName() {
- return 'inbox';
- }
- /**
- * Returns an array with all the child nodes
- *
- * @return \Sabre\DAV\INode[]
- */
- function getChildren() {
- $objs = $this->caldavBackend->getSchedulingObjects($this->principalUri);
- $children = [];
- foreach ($objs as $obj) {
- //$obj['acl'] = $this->getACL();
- $obj['principaluri'] = $this->principalUri;
- $children[] = new SchedulingObject($this->caldavBackend, $obj);
- }
- return $children;
- }
- /**
- * Creates a new file in the directory
- *
- * Data will either be supplied as a stream resource, or in certain cases
- * as a string. Keep in mind that you may have to support either.
- *
- * After succesful creation of the file, you may choose to return the ETag
- * of the new file here.
- *
- * The returned ETag must be surrounded by double-quotes (The quotes should
- * be part of the actual string).
- *
- * If you cannot accurately determine the ETag, you should not return it.
- * If you don't store the file exactly as-is (you're transforming it
- * somehow) you should also not return an ETag.
- *
- * This means that if a subsequent GET to this new file does not exactly
- * return the same contents of what was submitted here, you are strongly
- * recommended to omit the ETag.
- *
- * @param string $name Name of the file
- * @param resource|string $data Initial payload
- * @return null|string
- */
- function createFile($name, $data = null) {
- $this->caldavBackend->createSchedulingObject($this->principalUri, $name, $data);
- }
- /**
- * 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->principalUri;
- }
- /**
- * 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' => '{DAV:}authenticated',
- 'protected' => true,
- ],
- [
- 'privilege' => '{DAV:}write-properties',
- 'principal' => $this->getOwner(),
- 'protected' => true,
- ],
- [
- 'privilege' => '{DAV:}unbind',
- 'principal' => $this->getOwner(),
- 'protected' => true,
- ],
- [
- 'privilege' => '{DAV:}unbind',
- 'principal' => $this->getOwner() . '/calendar-proxy-write',
- 'protected' => true,
- ],
- [
- 'privilege' => '{' . CalDAV\Plugin::NS_CALDAV . '}schedule-deliver-invite',
- 'principal' => '{DAV:}authenticated',
- 'protected' => true,
- ],
- [
- 'privilege' => '{' . CalDAV\Plugin::NS_CALDAV . '}schedule-deliver-reply',
- 'principal' => '{DAV:}authenticated',
- '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('You\'re not allowed to update the ACL');
- }
- /**
- * 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() {
- $ns = '{' . CalDAV\Plugin::NS_CALDAV . '}';
- $default = DAVACL\Plugin::getDefaultSupportedPrivilegeSet();
- $default['aggregates'][] = [
- 'privilege' => $ns . 'schedule-deliver',
- 'aggregates' => [
- ['privilege' => $ns . 'schedule-deliver-invite'],
- ['privilege' => $ns . 'schedule-deliver-reply'],
- ],
- ];
- return $default;
- }
- /**
- * 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.
- *
- * @param array $filters
- * @return array
- */
- function calendarQuery(array $filters) {
- $result = [];
- $validator = new CalDAV\CalendarQueryValidator();
- $objects = $this->caldavBackend->getSchedulingObjects($this->principalUri);
- foreach ($objects as $object) {
- $vObject = VObject\Reader::read($object['calendardata']);
- if ($validator->validate($vObject, $filters)) {
- $result[] = $object['uri'];
- }
- // Destroy circular references to PHP will GC the object.
- $vObject->destroy();
- }
- return $result;
- }
- }
|