123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290 |
- <?php
- namespace Sabre\CalDAV;
- /**
- * The CalendarObject represents a single VEVENT or VTODO within a Calendar.
- *
- * @copyright Copyright (C) fruux GmbH (https://fruux.com/)
- * @author Evert Pot (http://evertpot.com/)
- * @license http://sabre.io/license/ Modified BSD License
- */
- class CalendarObject extends \Sabre\DAV\File implements ICalendarObject, \Sabre\DAVACL\IACL {
- /**
- * Sabre\CalDAV\Backend\BackendInterface
- *
- * @var Sabre\CalDAV\Backend\AbstractBackend
- */
- protected $caldavBackend;
- /**
- * Array with information about this CalendarObject
- *
- * @var array
- */
- protected $objectData;
- /**
- * Array with information about the containing calendar
- *
- * @var array
- */
- protected $calendarInfo;
- /**
- * Constructor
- *
- * The following properties may be passed within $objectData:
- *
- * * calendarid - This must refer to a calendarid from a caldavBackend
- * * uri - A unique uri. Only the 'basename' must be passed.
- * * calendardata (optional) - The iCalendar data
- * * etag - (optional) The etag for this object, MUST be encloded with
- * double-quotes.
- * * size - (optional) The size of the data in bytes.
- * * lastmodified - (optional) format as a unix timestamp.
- * * acl - (optional) Use this to override the default ACL for the node.
- *
- * @param Backend\BackendInterface $caldavBackend
- * @param array $calendarInfo
- * @param array $objectData
- */
- function __construct(Backend\BackendInterface $caldavBackend, array $calendarInfo, array $objectData) {
- $this->caldavBackend = $caldavBackend;
- if (!isset($objectData['uri'])) {
- throw new \InvalidArgumentException('The objectData argument must contain an \'uri\' property');
- }
- $this->calendarInfo = $calendarInfo;
- $this->objectData = $objectData;
- }
- /**
- * Returns the uri for this object
- *
- * @return string
- */
- function getName() {
- return $this->objectData['uri'];
- }
- /**
- * Returns the ICalendar-formatted object
- *
- * @return string
- */
- function get() {
- // Pre-populating the 'calendardata' is optional, if we don't have it
- // already we fetch it from the backend.
- if (!isset($this->objectData['calendardata'])) {
- $this->objectData = $this->caldavBackend->getCalendarObject($this->calendarInfo['id'], $this->objectData['uri']);
- }
- return $this->objectData['calendardata'];
- }
- /**
- * Updates the ICalendar-formatted object
- *
- * @param string|resource $calendarData
- * @return string
- */
- function put($calendarData) {
- if (is_resource($calendarData)) {
- $calendarData = stream_get_contents($calendarData);
- }
- $etag = $this->caldavBackend->updateCalendarObject($this->calendarInfo['id'], $this->objectData['uri'], $calendarData);
- $this->objectData['calendardata'] = $calendarData;
- $this->objectData['etag'] = $etag;
- return $etag;
- }
- /**
- * Deletes the calendar object
- *
- * @return void
- */
- function delete() {
- $this->caldavBackend->deleteCalendarObject($this->calendarInfo['id'], $this->objectData['uri']);
- }
- /**
- * Returns the mime content-type
- *
- * @return string
- */
- function getContentType() {
- $mime = 'text/calendar; charset=utf-8';
- if (isset($this->objectData['component']) && $this->objectData['component']) {
- $mime .= '; component=' . $this->objectData['component'];
- }
- return $mime;
- }
- /**
- * Returns an ETag for this object.
- *
- * The ETag is an arbitrary string, but MUST be surrounded by double-quotes.
- *
- * @return string
- */
- function getETag() {
- if (isset($this->objectData['etag'])) {
- return $this->objectData['etag'];
- } else {
- return '"' . md5($this->get()) . '"';
- }
- }
- /**
- * Returns the last modification date as a unix timestamp
- *
- * @return int
- */
- function getLastModified() {
- return $this->objectData['lastmodified'];
- }
- /**
- * Returns the size of this object in bytes
- *
- * @return int
- */
- function getSize() {
- if (array_key_exists('size', $this->objectData)) {
- return $this->objectData['size'];
- } else {
- return strlen($this->get());
- }
- }
- /**
- * 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() {
- // An alternative acl may be specified in the object data.
- if (isset($this->objectData['acl'])) {
- return $this->objectData['acl'];
- }
- // The default ACL
- return [
- [
- 'privilege' => '{DAV:}read',
- 'principal' => $this->calendarInfo['principaluri'],
- 'protected' => true,
- ],
- [
- 'privilege' => '{DAV:}write',
- 'principal' => $this->calendarInfo['principaluri'],
- 'protected' => true,
- ],
- [
- 'privilege' => '{DAV:}read',
- 'principal' => $this->calendarInfo['principaluri'] . '/calendar-proxy-write',
- 'protected' => true,
- ],
- [
- 'privilege' => '{DAV:}write',
- 'principal' => $this->calendarInfo['principaluri'] . '/calendar-proxy-write',
- 'protected' => true,
- ],
- [
- 'privilege' => '{DAV:}read',
- 'principal' => $this->calendarInfo['principaluri'] . '/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 \Sabre\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;
- }
- }
|