123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527 |
- <?php
- namespace Sabre\CalDAV;
- use Sabre\DAV;
- use Sabre\DAVACL;
- use Sabre\DAV\PropPatch;
- /**
- * This object represents a CalDAV calendar.
- *
- * A calendar can contain multiple TODO and or Events. These are represented
- * as \Sabre\CalDAV\CalendarObject objects.
- *
- * @copyright Copyright (C) fruux GmbH (https://fruux.com/)
- * @author Evert Pot (http://evertpot.com/)
- * @license http://sabre.io/license/ Modified BSD License
- */
- class Calendar implements ICalendar, DAV\IProperties, DAV\Sync\ISyncCollection, DAV\IMultiGet {
- /**
- * This is an array with calendar information
- *
- * @var array
- */
- protected $calendarInfo;
- /**
- * CalDAV backend
- *
- * @var Backend\BackendInterface
- */
- protected $caldavBackend;
- /**
- * Constructor
- *
- * @param Backend\BackendInterface $caldavBackend
- * @param array $calendarInfo
- */
- function __construct(Backend\BackendInterface $caldavBackend, $calendarInfo) {
- $this->caldavBackend = $caldavBackend;
- $this->calendarInfo = $calendarInfo;
- }
- /**
- * Returns the name of the calendar
- *
- * @return string
- */
- function getName() {
- return $this->calendarInfo['uri'];
- }
- /**
- * Updates properties on this node.
- *
- * This method received a PropPatch object, which contains all the
- * information about the update.
- *
- * To update specific properties, call the 'handle' method on this object.
- * Read the PropPatch documentation for more information.
- *
- * @param PropPatch $propPatch
- * @return void
- */
- function propPatch(PropPatch $propPatch) {
- return $this->caldavBackend->updateCalendar($this->calendarInfo['id'], $propPatch);
- }
- /**
- * Returns the list of properties
- *
- * @param array $requestedProperties
- * @return array
- */
- function getProperties($requestedProperties) {
- $response = [];
- foreach ($this->calendarInfo as $propName => $propValue) {
- if ($propName[0] === '{')
- $response[$propName] = $this->calendarInfo[$propName];
- }
- return $response;
- }
- /**
- * Returns a calendar object
- *
- * The contained calendar objects are for example Events or Todo's.
- *
- * @param string $name
- * @return \Sabre\CalDAV\ICalendarObject
- */
- function getChild($name) {
- $obj = $this->caldavBackend->getCalendarObject($this->calendarInfo['id'], $name);
- if (!$obj) throw new DAV\Exception\NotFound('Calendar object not found');
- $obj['acl'] = $this->getChildACL();
- return new CalendarObject($this->caldavBackend, $this->calendarInfo, $obj);
- }
- /**
- * Returns the full list of calendar objects
- *
- * @return array
- */
- function getChildren() {
- $objs = $this->caldavBackend->getCalendarObjects($this->calendarInfo['id']);
- $children = [];
- foreach ($objs as $obj) {
- $obj['acl'] = $this->getChildACL();
- $children[] = new CalendarObject($this->caldavBackend, $this->calendarInfo, $obj);
- }
- return $children;
- }
- /**
- * This method receives a list of paths in it's first argument.
- * It must return an array with Node objects.
- *
- * If any children are not found, you do not have to return them.
- *
- * @param string[] $paths
- * @return array
- */
- function getMultipleChildren(array $paths) {
- $objs = $this->caldavBackend->getMultipleCalendarObjects($this->calendarInfo['id'], $paths);
- $children = [];
- foreach ($objs as $obj) {
- $obj['acl'] = $this->getChildACL();
- $children[] = new CalendarObject($this->caldavBackend, $this->calendarInfo, $obj);
- }
- return $children;
- }
- /**
- * Checks if a child-node exists.
- *
- * @param string $name
- * @return bool
- */
- function childExists($name) {
- $obj = $this->caldavBackend->getCalendarObject($this->calendarInfo['id'], $name);
- if (!$obj)
- return false;
- else
- return true;
- }
- /**
- * Creates a new directory
- *
- * We actually block this, as subdirectories are not allowed in calendars.
- *
- * @param string $name
- * @return void
- */
- function createDirectory($name) {
- throw new DAV\Exception\MethodNotAllowed('Creating collections in calendar objects is not allowed');
- }
- /**
- * Creates a new file
- *
- * The contents of the new file must be a valid ICalendar string.
- *
- * @param string $name
- * @param resource $calendarData
- * @return string|null
- */
- function createFile($name, $calendarData = null) {
- if (is_resource($calendarData)) {
- $calendarData = stream_get_contents($calendarData);
- }
- return $this->caldavBackend->createCalendarObject($this->calendarInfo['id'], $name, $calendarData);
- }
- /**
- * Deletes the calendar.
- *
- * @return void
- */
- function delete() {
- $this->caldavBackend->deleteCalendar($this->calendarInfo['id']);
- }
- /**
- * Renames the calendar. Note that most calendars use the
- * {DAV:}displayname to display a name to display a name.
- *
- * @param string $newName
- * @return void
- */
- function setName($newName) {
- throw new DAV\Exception\MethodNotAllowed('Renaming calendars is not yet supported');
- }
- /**
- * Returns the last modification date as a unix timestamp.
- *
- * @return void
- */
- function getLastModified() {
- return null;
- }
- /**
- * 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->calendarInfo['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() {
- $acl = [
- [
- 'privilege' => '{DAV:}read',
- 'principal' => $this->getOwner(),
- 'protected' => true,
- ],
- [
- 'privilege' => '{DAV:}read',
- 'principal' => $this->getOwner() . '/calendar-proxy-write',
- 'protected' => true,
- ],
- [
- 'privilege' => '{DAV:}read',
- 'principal' => $this->getOwner() . '/calendar-proxy-read',
- 'protected' => true,
- ],
- [
- 'privilege' => '{' . Plugin::NS_CALDAV . '}read-free-busy',
- 'principal' => '{DAV:}authenticated',
- 'protected' => true,
- ],
- ];
- if (empty($this->calendarInfo['{http://sabredav.org/ns}read-only'])) {
- $acl[] = [
- 'privilege' => '{DAV:}write',
- 'principal' => $this->getOwner(),
- 'protected' => true,
- ];
- $acl[] = [
- 'privilege' => '{DAV:}write',
- 'principal' => $this->getOwner() . '/calendar-proxy-write',
- 'protected' => true,
- ];
- }
- return $acl;
- }
- /**
- * This method returns the ACL's for calendar objects in this calendar.
- * The result of this method automatically gets passed to the
- * calendar-object nodes in the calendar.
- *
- * @return array
- */
- function getChildACL() {
- $acl = [
- [
- 'privilege' => '{DAV:}read',
- 'principal' => $this->getOwner(),
- 'protected' => true,
- ],
- [
- 'privilege' => '{DAV:}read',
- 'principal' => $this->getOwner() . '/calendar-proxy-write',
- 'protected' => true,
- ],
- [
- 'privilege' => '{DAV:}read',
- 'principal' => $this->getOwner() . '/calendar-proxy-read',
- 'protected' => true,
- ],
- ];
- if (empty($this->calendarInfo['{http://sabredav.org/ns}read-only'])) {
- $acl[] = [
- 'privilege' => '{DAV:}write',
- 'principal' => $this->getOwner(),
- 'protected' => true,
- ];
- $acl[] = [
- 'privilege' => '{DAV:}write',
- 'principal' => $this->getOwner() . '/calendar-proxy-write',
- 'protected' => true,
- ];
- }
- return $acl;
- }
- /**
- * 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() {
- $default = DAVACL\Plugin::getDefaultSupportedPrivilegeSet();
- // We need to inject 'read-free-busy' in the tree, aggregated under
- // {DAV:}read.
- foreach ($default['aggregates'] as &$agg) {
- if ($agg['privilege'] !== '{DAV:}read') continue;
- $agg['aggregates'][] = [
- 'privilege' => '{' . Plugin::NS_CALDAV . '}read-free-busy',
- ];
- }
- 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) {
- return $this->caldavBackend->calendarQuery($this->calendarInfo['id'], $filters);
- }
- /**
- * This method returns the current sync-token for this collection.
- * This can be any string.
- *
- * If null is returned from this function, the plugin assumes there's no
- * sync information available.
- *
- * @return string|null
- */
- function getSyncToken() {
- if (
- $this->caldavBackend instanceof Backend\SyncSupport &&
- isset($this->calendarInfo['{DAV:}sync-token'])
- ) {
- return $this->calendarInfo['{DAV:}sync-token'];
- }
- if (
- $this->caldavBackend instanceof Backend\SyncSupport &&
- isset($this->calendarInfo['{http://sabredav.org/ns}sync-token'])
- ) {
- return $this->calendarInfo['{http://sabredav.org/ns}sync-token'];
- }
- }
- /**
- * The getChanges method returns all the changes that have happened, since
- * the specified syncToken and the current collection.
- *
- * This function should return an array, such as the following:
- *
- * [
- * 'syncToken' => 'The current synctoken',
- * 'added' => [
- * 'new.txt',
- * ],
- * 'modified' => [
- * 'modified.txt',
- * ],
- * 'deleted' => [
- * 'foo.php.bak',
- * 'old.txt'
- * ]
- * ];
- *
- * The syncToken property should reflect the *current* syncToken of the
- * collection, as reported getSyncToken(). This is needed here too, to
- * ensure the operation is atomic.
- *
- * If the syncToken is specified as null, this is an initial sync, and all
- * members should be reported.
- *
- * The modified property is an array of nodenames that have changed since
- * the last token.
- *
- * The deleted property is an array with nodenames, that have been deleted
- * from collection.
- *
- * The second argument is basically the 'depth' of the report. If it's 1,
- * you only have to report changes that happened only directly in immediate
- * descendants. If it's 2, it should also include changes from the nodes
- * below the child collections. (grandchildren)
- *
- * The third (optional) argument allows a client to specify how many
- * results should be returned at most. If the limit is not specified, it
- * should be treated as infinite.
- *
- * If the limit (infinite or not) is higher than you're willing to return,
- * you should throw a Sabre\DAV\Exception\TooMuchMatches() exception.
- *
- * If the syncToken is expired (due to data cleanup) or unknown, you must
- * return null.
- *
- * The limit is 'suggestive'. You are free to ignore it.
- *
- * @param string $syncToken
- * @param int $syncLevel
- * @param int $limit
- * @return array
- */
- function getChanges($syncToken, $syncLevel, $limit = null) {
- if (!$this->caldavBackend instanceof Backend\SyncSupport) {
- return null;
- }
- return $this->caldavBackend->getChangesForCalendar(
- $this->calendarInfo['id'],
- $syncToken,
- $syncLevel,
- $limit
- );
- }
- }
|