]> git.mxchange.org Git - friendica-addons.git/blobdiff - dav/common/dav_user_addressbooks.inc.php
Initial Release of the calendar plugin
[friendica-addons.git] / dav / common / dav_user_addressbooks.inc.php
diff --git a/dav/common/dav_user_addressbooks.inc.php b/dav/common/dav_user_addressbooks.inc.php
new file mode 100644 (file)
index 0000000..d430274
--- /dev/null
@@ -0,0 +1,264 @@
+<?php
+
+/**
+ * The UserCalenders class contains all calendars associated to one user
+ *
+ * @package Sabre
+ * @subpackage CalDAV
+ * @copyright Copyright (C) 2007-2011 Rooftop Solutions. All rights reserved.
+ * @author Evert Pot (http://www.rooftopsolutions.nl/)
+ * @license http://code.google.com/p/sabredav/wiki/License Modified BSD License
+ */
+class Sabre_CardDAV_UserAddressBooksMultiBackend extends Sabre_DAV_Collection implements Sabre_DAV_IExtendedCollection, Sabre_DAVACL_IACL {
+
+       /**
+        * Principal uri
+        *
+        * @var array
+        */
+       protected $principalUri;
+
+       /**
+        * carddavBackend
+        *
+        * @var array|Sabre_CardDAV_Backend_Abstract[]
+        */
+       protected $carddavBackends;
+
+       /**
+        * Constructor
+        *
+        * @param array|Sabre_CardDAV_Backend_Abstract[] $carddavBackends
+        * @param string $principalUri
+        */
+       public function __construct($carddavBackends, $principalUri) {
+
+               $this->carddavBackends = $carddavBackends;
+               $this->principalUri = $principalUri;
+
+       }
+
+       /**
+        * Returns the name of this object
+        *
+        * @return string
+        */
+       public function getName() {
+
+               list(,$name) = Sabre_DAV_URLUtil::splitPath($this->principalUri);
+               return $name;
+
+       }
+
+       /**
+        * Updates the name of this object
+        *
+        * @param string $name
+        * @throws Sabre_DAV_Exception_MethodNotAllowed
+        * @return void
+        */
+       public function setName($name) {
+
+               throw new Sabre_DAV_Exception_MethodNotAllowed();
+
+       }
+
+       /**
+        * Deletes this object
+        *
+        * @throws Sabre_DAV_Exception_MethodNotAllowed
+        * @return void
+        */
+       public function delete() {
+
+               throw new Sabre_DAV_Exception_MethodNotAllowed();
+
+       }
+
+       /**
+        * Returns the last modification date
+        *
+        * @return int
+        */
+       public function getLastModified() {
+
+               return null;
+
+       }
+
+       /**
+        * Creates a new file under this object.
+        *
+        * This is currently not allowed
+        *
+        * @param string $filename
+        * @param resource $data
+        * @throws Sabre_DAV_Exception_MethodNotAllowed
+        * @return null|string|void
+        */
+       public function createFile($filename, $data=null) {
+
+               throw new Sabre_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
+        * @throws Sabre_DAV_Exception_MethodNotAllowed
+        * @return void
+        */
+       public function createDirectory($filename) {
+
+               throw new Sabre_DAV_Exception_MethodNotAllowed('Creating new collections in this collection is not supported');
+
+       }
+
+       /**
+        * Returns a single calendar, by name
+        *
+        * @param string $name
+        * @throws Sabre_DAV_Exception_NotFound
+        * @todo needs optimizing
+        * @return \Sabre_CardDAV_AddressBook|\Sabre_DAV_INode
+        */
+       public function getChild($name) {
+
+               foreach($this->getChildren() as $child) {
+                       if ($name==$child->getName())
+                               return $child;
+
+               }
+               throw new Sabre_DAV_Exception_NotFound('Addressbook with name \'' . $name . '\' could not be found');
+
+       }
+
+       /**
+        * Returns a list of addressbooks
+        *
+        * @return array|Sabre_DAV_INode[]
+        */
+       public function getChildren() {
+
+               $objs = array();
+               foreach ($this->carddavBackends as $backend) {
+                       $addressbooks = $backend->getAddressbooksForUser($this->principalUri);
+                       foreach($addressbooks as $addressbook) {
+                               $objs[] = new Sabre_CardDAV_AddressBook($backend, $addressbook);
+                       }
+               }
+               return $objs;
+
+       }
+
+       /**
+        * Creates a new addressbook
+        *
+        * @param string $name
+        * @param array $resourceType
+        * @param array $properties
+        * @throws Sabre_DAV_Exception_InvalidResourceType
+        * @return void
+        */
+       public function createExtendedCollection($name, array $resourceType, array $properties) {
+
+               if (!in_array('{'.Sabre_CardDAV_Plugin::NS_CARDDAV.'}addressbook',$resourceType) || count($resourceType)!==2) {
+                       throw new Sabre_DAV_Exception_InvalidResourceType('Unknown resourceType for this collection');
+               }
+               $this->carddavBackends[0]->createAddressBook($this->principalUri, $name, $properties);
+
+       }
+
+       /**
+        * Returns the owner principal
+        *
+        * This must be a url to a principal, or null if there's no owner
+        *
+        * @return string|null
+        */
+       public 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
+        */
+       public 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
+        */
+       public function getACL() {
+
+               return array(
+                       array(
+                               'privilege' => '{DAV:}read',
+                               'principal' => $this->principalUri,
+                               'protected' => true,
+                       ),
+                       array(
+                               'privilege' => '{DAV:}write',
+                               'principal' => $this->principalUri,
+                               'protected' => true,
+                       ),
+
+               );
+
+       }
+
+       /**
+        * Updates the ACL
+        *
+        * This method will receive a list of new ACE's.
+        *
+        * @param array $acl
+        * @throws Sabre_DAV_Exception_MethodNotAllowed
+        * @return void
+        */
+       public 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
+        */
+       public function getSupportedPrivilegeSet() {
+
+               return null;
+
+       }
+
+}