Dolibarr / dolibarr

htdocs/includes/sabre/sabre/dav/lib/CalDAV/Schedule/Plugin.php

Spacing +7 added lines, -7 removed lines

@@ -198,7 +198,7 @@ 
             $principalUrl = $node->getPrincipalUrl();
 
             // schedule-outbox-URL property
-            $propFind->handle('{'.self::NS_CALDAV.'}schedule-outbox-URL', function () use ($principalUrl, $caldavPlugin) {
+            $propFind->handle('{'.self::NS_CALDAV.'}schedule-outbox-URL', function() use ($principalUrl, $caldavPlugin) {
                 $calendarHomePath = $caldavPlugin->getCalendarHomeForPrincipal($principalUrl);
                 if (!$calendarHomePath) {
                     return null;
@@ -208,7 +208,7 @@ 
                 return new LocalHref($outboxPath);
             });
             // schedule-inbox-URL property
-            $propFind->handle('{'.self::NS_CALDAV.'}schedule-inbox-URL', function () use ($principalUrl, $caldavPlugin) {
+            $propFind->handle('{'.self::NS_CALDAV.'}schedule-inbox-URL', function() use ($principalUrl, $caldavPlugin) {
                 $calendarHomePath = $caldavPlugin->getCalendarHomeForPrincipal($principalUrl);
                 if (!$calendarHomePath) {
                     return null;
@@ -218,7 +218,7 @@ 
                 return new LocalHref($inboxPath);
             });
 
-            $propFind->handle('{'.self::NS_CALDAV.'}schedule-default-calendar-URL', function () use ($principalUrl, $caldavPlugin) {
+            $propFind->handle('{'.self::NS_CALDAV.'}schedule-default-calendar-URL', function() use ($principalUrl, $caldavPlugin) {
                 // We don't support customizing this property yet, so in the
                 // meantime we just grab the first calendar in the home-set.
                 $calendarHomePath = $caldavPlugin->getCalendarHomeForPrincipal($principalUrl);
@@ -258,13 +258,13 @@ 
 
             // The server currently reports every principal to be of type
             // 'INDIVIDUAL'
-            $propFind->handle('{'.self::NS_CALDAV.'}calendar-user-type', function () {
+            $propFind->handle('{'.self::NS_CALDAV.'}calendar-user-type', function() {
                 return 'INDIVIDUAL';
             });
         }
 
         // Mapping the old property to the new property.
-        $propFind->handle('{http://calendarserver.org/ns/}calendar-availability', function () use ($propFind, $node) {
+        $propFind->handle('{http://calendarserver.org/ns/}calendar-availability', function() use ($propFind, $node) {
             // In case it wasn't clear, the only difference is that we map the
             // old property to a different namespace.
             $availProp = '{'.self::NS_CALDAV.'}calendar-availability';
@@ -294,7 +294,7 @@ 
     public function propPatch($path, PropPatch $propPatch)
     {
         // Mapping the old property to the new property.
-        $propPatch->handle('{http://calendarserver.org/ns/}calendar-availability', function ($value) use ($path) {
+        $propPatch->handle('{http://calendarserver.org/ns/}calendar-availability', function($value) use ($path) {
             $availProp = '{'.self::NS_CALDAV.'}calendar-availability';
             $subPropPatch = new PropPatch([$availProp => $value]);
             $this->server->emit('propPatch', [$path, $subPropPatch]);
@@ -919,7 +919,7 @@ 
                 'time-range' => null,
             ]);
 
-            $calObjects = array_map(function ($url) use ($node) {
+            $calObjects = array_map(function($url) use ($node) {
                 $obj = $node->getChild($url)->get();
 
                 return $obj;

Indentation +931 added lines, -931 removed lines

@@ -57,941 +57,941 @@
  */
 class Plugin extends ServerPlugin
 {
-    /**
-     * This is the official CalDAV namespace.
-     */
-    const NS_CALDAV = 'urn:ietf:params:xml:ns:caldav';
-
-    /**
-     * Reference to main Server object.
-     *
-     * @var Server
-     */
-    protected $server;
-
-    /**
-     * Returns a list of features for the DAV: HTTP header.
-     *
-     * @return array
-     */
-    public function getFeatures()
-    {
-        return ['calendar-auto-schedule', 'calendar-availability'];
-    }
-
-    /**
-     * Returns the name of the plugin.
-     *
-     * Using this name other plugins will be able to access other plugins
-     * using Server::getPlugin
-     *
-     * @return string
-     */
-    public function getPluginName()
-    {
-        return 'caldav-schedule';
-    }
-
-    /**
-     * Initializes the plugin.
-     */
-    public function initialize(Server $server)
-    {
-        $this->server = $server;
-        $server->on('method:POST', [$this, 'httpPost']);
-        $server->on('propFind', [$this, 'propFind']);
-        $server->on('propPatch', [$this, 'propPatch']);
-        $server->on('calendarObjectChange', [$this, 'calendarObjectChange']);
-        $server->on('beforeUnbind', [$this, 'beforeUnbind']);
-        $server->on('schedule', [$this, 'scheduleLocalDelivery']);
-        $server->on('getSupportedPrivilegeSet', [$this, 'getSupportedPrivilegeSet']);
-
-        $ns = '{'.self::NS_CALDAV.'}';
-
-        /*
+	/**
+	 * This is the official CalDAV namespace.
+	 */
+	const NS_CALDAV = 'urn:ietf:params:xml:ns:caldav';
+
+	/**
+	 * Reference to main Server object.
+	 *
+	 * @var Server
+	 */
+	protected $server;
+
+	/**
+	 * Returns a list of features for the DAV: HTTP header.
+	 *
+	 * @return array
+	 */
+	public function getFeatures()
+	{
+		return ['calendar-auto-schedule', 'calendar-availability'];
+	}
+
+	/**
+	 * Returns the name of the plugin.
+	 *
+	 * Using this name other plugins will be able to access other plugins
+	 * using Server::getPlugin
+	 *
+	 * @return string
+	 */
+	public function getPluginName()
+	{
+		return 'caldav-schedule';
+	}
+
+	/**
+	 * Initializes the plugin.
+	 */
+	public function initialize(Server $server)
+	{
+		$this->server = $server;
+		$server->on('method:POST', [$this, 'httpPost']);
+		$server->on('propFind', [$this, 'propFind']);
+		$server->on('propPatch', [$this, 'propPatch']);
+		$server->on('calendarObjectChange', [$this, 'calendarObjectChange']);
+		$server->on('beforeUnbind', [$this, 'beforeUnbind']);
+		$server->on('schedule', [$this, 'scheduleLocalDelivery']);
+		$server->on('getSupportedPrivilegeSet', [$this, 'getSupportedPrivilegeSet']);
+
+		$ns = '{'.self::NS_CALDAV.'}';
+
+		/*
          * This information ensures that the {DAV:}resourcetype property has
          * the correct values.
          */
-        $server->resourceTypeMapping['\\Sabre\\CalDAV\\Schedule\\IOutbox'] = $ns.'schedule-outbox';
-        $server->resourceTypeMapping['\\Sabre\\CalDAV\\Schedule\\IInbox'] = $ns.'schedule-inbox';
+		$server->resourceTypeMapping['\\Sabre\\CalDAV\\Schedule\\IOutbox'] = $ns.'schedule-outbox';
+		$server->resourceTypeMapping['\\Sabre\\CalDAV\\Schedule\\IInbox'] = $ns.'schedule-inbox';
 
-        /*
+		/*
          * Properties we protect are made read-only by the server.
          */
-        array_push($server->protectedProperties,
-            $ns.'schedule-inbox-URL',
-            $ns.'schedule-outbox-URL',
-            $ns.'calendar-user-address-set',
-            $ns.'calendar-user-type',
-            $ns.'schedule-default-calendar-URL'
-        );
-    }
-
-    /**
-     * Use this method to tell the server this plugin defines additional
-     * HTTP methods.
-     *
-     * This method is passed a uri. It should only return HTTP methods that are
-     * available for the specified uri.
-     *
-     * @param string $uri
-     *
-     * @return array
-     */
-    public function getHTTPMethods($uri)
-    {
-        try {
-            $node = $this->server->tree->getNodeForPath($uri);
-        } catch (NotFound $e) {
-            return [];
-        }
-
-        if ($node instanceof IOutbox) {
-            return ['POST'];
-        }
-
-        return [];
-    }
-
-    /**
-     * This method handles POST request for the outbox.
-     *
-     * @return bool
-     */
-    public function httpPost(RequestInterface $request, ResponseInterface $response)
-    {
-        // Checking if this is a text/calendar content type
-        $contentType = $request->getHeader('Content-Type');
-        if (!$contentType || 0 !== strpos($contentType, 'text/calendar')) {
-            return;
-        }
-
-        $path = $request->getPath();
-
-        // Checking if we're talking to an outbox
-        try {
-            $node = $this->server->tree->getNodeForPath($path);
-        } catch (NotFound $e) {
-            return;
-        }
-        if (!$node instanceof IOutbox) {
-            return;
-        }
-
-        $this->server->transactionType = 'post-caldav-outbox';
-        $this->outboxRequest($node, $request, $response);
-
-        // Returning false breaks the event chain and tells the server we've
-        // handled the request.
-        return false;
-    }
-
-    /**
-     * This method handler is invoked during fetching of properties.
-     *
-     * We use this event to add calendar-auto-schedule-specific properties.
-     */
-    public function propFind(PropFind $propFind, INode $node)
-    {
-        if ($node instanceof DAVACL\IPrincipal) {
-            $caldavPlugin = $this->server->getPlugin('caldav');
-            $principalUrl = $node->getPrincipalUrl();
-
-            // schedule-outbox-URL property
-            $propFind->handle('{'.self::NS_CALDAV.'}schedule-outbox-URL', function () use ($principalUrl, $caldavPlugin) {
-                $calendarHomePath = $caldavPlugin->getCalendarHomeForPrincipal($principalUrl);
-                if (!$calendarHomePath) {
-                    return null;
-                }
-                $outboxPath = $calendarHomePath.'/outbox/';
-
-                return new LocalHref($outboxPath);
-            });
-            // schedule-inbox-URL property
-            $propFind->handle('{'.self::NS_CALDAV.'}schedule-inbox-URL', function () use ($principalUrl, $caldavPlugin) {
-                $calendarHomePath = $caldavPlugin->getCalendarHomeForPrincipal($principalUrl);
-                if (!$calendarHomePath) {
-                    return null;
-                }
-                $inboxPath = $calendarHomePath.'/inbox/';
-
-                return new LocalHref($inboxPath);
-            });
-
-            $propFind->handle('{'.self::NS_CALDAV.'}schedule-default-calendar-URL', function () use ($principalUrl, $caldavPlugin) {
-                // We don't support customizing this property yet, so in the
-                // meantime we just grab the first calendar in the home-set.
-                $calendarHomePath = $caldavPlugin->getCalendarHomeForPrincipal($principalUrl);
-
-                if (!$calendarHomePath) {
-                    return null;
-                }
-
-                $sccs = '{'.self::NS_CALDAV.'}supported-calendar-component-set';
-
-                $result = $this->server->getPropertiesForPath($calendarHomePath, [
-                    '{DAV:}resourcetype',
-                    '{DAV:}share-access',
-                    $sccs,
-                ], 1);
-
-                foreach ($result as $child) {
-                    if (!isset($child[200]['{DAV:}resourcetype']) || !$child[200]['{DAV:}resourcetype']->is('{'.self::NS_CALDAV.'}calendar')) {
-                        // Node is either not a calendar
-                        continue;
-                    }
-                    if (isset($child[200]['{DAV:}share-access'])) {
-                        $shareAccess = $child[200]['{DAV:}share-access']->getValue();
-                        if (Sharing\Plugin::ACCESS_NOTSHARED !== $shareAccess && Sharing\Plugin::ACCESS_SHAREDOWNER !== $shareAccess) {
-                            // Node is a shared node, not owned by the relevant
-                            // user.
-                            continue;
-                        }
-                    }
-                    if (!isset($child[200][$sccs]) || in_array('VEVENT', $child[200][$sccs]->getValue())) {
-                        // Either there is no supported-calendar-component-set
-                        // (which is fine) or we found one that supports VEVENT.
-                        return new LocalHref($child['href']);
-                    }
-                }
-            });
-
-            // The server currently reports every principal to be of type
-            // 'INDIVIDUAL'
-            $propFind->handle('{'.self::NS_CALDAV.'}calendar-user-type', function () {
-                return 'INDIVIDUAL';
-            });
-        }
-
-        // Mapping the old property to the new property.
-        $propFind->handle('{http://calendarserver.org/ns/}calendar-availability', function () use ($propFind, $node) {
-            // In case it wasn't clear, the only difference is that we map the
-            // old property to a different namespace.
-            $availProp = '{'.self::NS_CALDAV.'}calendar-availability';
-            $subPropFind = new PropFind(
-                 $propFind->getPath(),
-                 [$availProp]
-             );
-
-            $this->server->getPropertiesByNode(
-                 $subPropFind,
-                 $node
-             );
-
-            $propFind->set(
-                 '{http://calendarserver.org/ns/}calendar-availability',
-                 $subPropFind->get($availProp),
-                 $subPropFind->getStatus($availProp)
-             );
-        });
-    }
-
-    /**
-     * This method is called during property updates.
-     *
-     * @param string $path
-     */
-    public function propPatch($path, PropPatch $propPatch)
-    {
-        // Mapping the old property to the new property.
-        $propPatch->handle('{http://calendarserver.org/ns/}calendar-availability', function ($value) use ($path) {
-            $availProp = '{'.self::NS_CALDAV.'}calendar-availability';
-            $subPropPatch = new PropPatch([$availProp => $value]);
-            $this->server->emit('propPatch', [$path, $subPropPatch]);
-            $subPropPatch->commit();
-
-            return $subPropPatch->getResult()[$availProp];
-        });
-    }
-
-    /**
-     * This method is triggered whenever there was a calendar object gets
-     * created or updated.
-     *
-     * @param RequestInterface  $request      HTTP request
-     * @param ResponseInterface $response     HTTP Response
-     * @param VCalendar         $vCal         Parsed iCalendar object
-     * @param mixed             $calendarPath Path to calendar collection
-     * @param mixed             $modified     the iCalendar object has been touched
-     * @param mixed             $isNew        Whether this was a new item or we're updating one
-     */
-    public function calendarObjectChange(RequestInterface $request, ResponseInterface $response, VCalendar $vCal, $calendarPath, &$modified, $isNew)
-    {
-        if (!$this->scheduleReply($this->server->httpRequest)) {
-            return;
-        }
-
-        $calendarNode = $this->server->tree->getNodeForPath($calendarPath);
-
-        $addresses = $this->getAddressesForPrincipal(
-            $calendarNode->getOwner()
-        );
-
-        if (!$isNew) {
-            $node = $this->server->tree->getNodeForPath($request->getPath());
-            $oldObj = Reader::read($node->get());
-        } else {
-            $oldObj = null;
-        }
-
-        $this->processICalendarChange($oldObj, $vCal, $addresses, [], $modified);
-
-        if ($oldObj) {
-            // Destroy circular references so PHP will GC the object.
-            $oldObj->destroy();
-        }
-    }
-
-    /**
-     * This method is responsible for delivering the ITip message.
-     */
-    public function deliver(ITip\Message $iTipMessage)
-    {
-        $this->server->emit('schedule', [$iTipMessage]);
-        if (!$iTipMessage->scheduleStatus) {
-            $iTipMessage->scheduleStatus = '5.2;There was no system capable of delivering the scheduling message';
-        }
-        // In case the change was considered 'insignificant', we are going to
-        // remove any error statuses, if any. See ticket #525.
-        list($baseCode) = explode('.', $iTipMessage->scheduleStatus);
-        if (!$iTipMessage->significantChange && in_array($baseCode, ['3', '5'])) {
-            $iTipMessage->scheduleStatus = null;
-        }
-    }
-
-    /**
-     * This method is triggered before a file gets deleted.
-     *
-     * We use this event to make sure that when this happens, attendees get
-     * cancellations, and organizers get 'DECLINED' statuses.
-     *
-     * @param string $path
-     */
-    public function beforeUnbind($path)
-    {
-        // FIXME: We shouldn't trigger this functionality when we're issuing a
-        // MOVE. This is a hack.
-        if ('MOVE' === $this->server->httpRequest->getMethod()) {
-            return;
-        }
-
-        $node = $this->server->tree->getNodeForPath($path);
-
-        if (!$node instanceof ICalendarObject || $node instanceof ISchedulingObject) {
-            return;
-        }
-
-        if (!$this->scheduleReply($this->server->httpRequest)) {
-            return;
-        }
-
-        $addresses = $this->getAddressesForPrincipal(
-            $node->getOwner()
-        );
-
-        $broker = new ITip\Broker();
-        $messages = $broker->parseEvent(null, $addresses, $node->get());
-
-        foreach ($messages as $message) {
-            $this->deliver($message);
-        }
-    }
-
-    /**
-     * Event handler for the 'schedule' event.
-     *
-     * This handler attempts to look at local accounts to deliver the
-     * scheduling object.
-     */
-    public function scheduleLocalDelivery(ITip\Message $iTipMessage)
-    {
-        $aclPlugin = $this->server->getPlugin('acl');
-
-        // Local delivery is not available if the ACL plugin is not loaded.
-        if (!$aclPlugin) {
-            return;
-        }
-
-        $caldavNS = '{'.self::NS_CALDAV.'}';
-
-        $principalUri = $aclPlugin->getPrincipalByUri($iTipMessage->recipient);
-        if (!$principalUri) {
-            $iTipMessage->scheduleStatus = '3.7;Could not find principal.';
-
-            return;
-        }
-
-        // We found a principal URL, now we need to find its inbox.
-        // Unfortunately we may not have sufficient privileges to find this, so
-        // we are temporarily turning off ACL to let this come through.
-        //
-        // Once we support PHP 5.5, this should be wrapped in a try..finally
-        // block so we can ensure that this privilege gets added again after.
-        $this->server->removeListener('propFind', [$aclPlugin, 'propFind']);
-
-        $result = $this->server->getProperties(
-            $principalUri,
-            [
-                '{DAV:}principal-URL',
-                 $caldavNS.'calendar-home-set',
-                 $caldavNS.'schedule-inbox-URL',
-                 $caldavNS.'schedule-default-calendar-URL',
-                '{http://sabredav.org/ns}email-address',
-            ]
-        );
-
-        // Re-registering the ACL event
-        $this->server->on('propFind', [$aclPlugin, 'propFind'], 20);
-
-        if (!isset($result[$caldavNS.'schedule-inbox-URL'])) {
-            $iTipMessage->scheduleStatus = '5.2;Could not find local inbox';
-
-            return;
-        }
-        if (!isset($result[$caldavNS.'calendar-home-set'])) {
-            $iTipMessage->scheduleStatus = '5.2;Could not locate a calendar-home-set';
-
-            return;
-        }
-        if (!isset($result[$caldavNS.'schedule-default-calendar-URL'])) {
-            $iTipMessage->scheduleStatus = '5.2;Could not find a schedule-default-calendar-URL property';
-
-            return;
-        }
-
-        $calendarPath = $result[$caldavNS.'schedule-default-calendar-URL']->getHref();
-        $homePath = $result[$caldavNS.'calendar-home-set']->getHref();
-        $inboxPath = $result[$caldavNS.'schedule-inbox-URL']->getHref();
-
-        if ('REPLY' === $iTipMessage->method) {
-            $privilege = 'schedule-deliver-reply';
-        } else {
-            $privilege = 'schedule-deliver-invite';
-        }
-
-        if (!$aclPlugin->checkPrivileges($inboxPath, $caldavNS.$privilege, DAVACL\Plugin::R_PARENT, false)) {
-            $iTipMessage->scheduleStatus = '3.8;insufficient privileges: '.$privilege.' is required on the recipient schedule inbox.';
-
-            return;
-        }
-
-        // Next, we're going to find out if the item already exits in one of
-        // the users' calendars.
-        $uid = $iTipMessage->uid;
-
-        $newFileName = 'sabredav-'.\Sabre\DAV\UUIDUtil::getUUID().'.ics';
-
-        $home = $this->server->tree->getNodeForPath($homePath);
-        $inbox = $this->server->tree->getNodeForPath($inboxPath);
-
-        $currentObject = null;
-        $objectNode = null;
-        $oldICalendarData = null;
-        $isNewNode = false;
-
-        $result = $home->getCalendarObjectByUID($uid);
-        if ($result) {
-            // There was an existing object, we need to update probably.
-            $objectPath = $homePath.'/'.$result;
-            $objectNode = $this->server->tree->getNodeForPath($objectPath);
-            $oldICalendarData = $objectNode->get();
-            $currentObject = Reader::read($oldICalendarData);
-        } else {
-            $isNewNode = true;
-        }
-
-        $broker = new ITip\Broker();
-        $newObject = $broker->processMessage($iTipMessage, $currentObject);
-
-        $inbox->createFile($newFileName, $iTipMessage->message->serialize());
-
-        if (!$newObject) {
-            // We received an iTip message referring to a UID that we don't
-            // have in any calendars yet, and processMessage did not give us a
-            // calendarobject back.
-            //
-            // The implication is that processMessage did not understand the
-            // iTip message.
-            $iTipMessage->scheduleStatus = '5.0;iTip message was not processed by the server, likely because we didn\'t understand it.';
-
-            return;
-        }
-
-        // Note that we are bypassing ACL on purpose by calling this directly.
-        // We may need to look a bit deeper into this later. Supporting ACL
-        // here would be nice.
-        if ($isNewNode) {
-            $calendar = $this->server->tree->getNodeForPath($calendarPath);
-            $calendar->createFile($newFileName, $newObject->serialize());
-        } else {
-            // If the message was a reply, we may have to inform other
-            // attendees of this attendees status. Therefore we're shooting off
-            // another itipMessage.
-            if ('REPLY' === $iTipMessage->method) {
-                $this->processICalendarChange(
-                    $oldICalendarData,
-                    $newObject,
-                    [$iTipMessage->recipient],
-                    [$iTipMessage->sender]
-                );
-            }
-            $objectNode->put($newObject->serialize());
-        }
-        $iTipMessage->scheduleStatus = '1.2;Message delivered locally';
-    }
-
-    /**
-     * This method is triggered whenever a subsystem requests the privileges
-     * that are supported on a particular node.
-     *
-     * We need to add a number of privileges for scheduling purposes.
-     */
-    public function getSupportedPrivilegeSet(INode $node, array &$supportedPrivilegeSet)
-    {
-        $ns = '{'.self::NS_CALDAV.'}';
-        if ($node instanceof IOutbox) {
-            $supportedPrivilegeSet[$ns.'schedule-send'] = [
-                'abstract' => false,
-                'aggregates' => [
-                    $ns.'schedule-send-invite' => [
-                        'abstract' => false,
-                        'aggregates' => [],
-                    ],
-                    $ns.'schedule-send-reply' => [
-                        'abstract' => false,
-                        'aggregates' => [],
-                    ],
-                    $ns.'schedule-send-freebusy' => [
-                        'abstract' => false,
-                        'aggregates' => [],
-                    ],
-                    // Privilege from an earlier scheduling draft, but still
-                    // used by some clients.
-                    $ns.'schedule-post-vevent' => [
-                        'abstract' => false,
-                        'aggregates' => [],
-                    ],
-                ],
-            ];
-        }
-        if ($node instanceof IInbox) {
-            $supportedPrivilegeSet[$ns.'schedule-deliver'] = [
-                'abstract' => false,
-                'aggregates' => [
-                    $ns.'schedule-deliver-invite' => [
-                        'abstract' => false,
-                        'aggregates' => [],
-                    ],
-                    $ns.'schedule-deliver-reply' => [
-                        'abstract' => false,
-                        'aggregates' => [],
-                    ],
-                    $ns.'schedule-query-freebusy' => [
-                        'abstract' => false,
-                        'aggregates' => [],
-                    ],
-                ],
-            ];
-        }
-    }
-
-    /**
-     * This method looks at an old iCalendar object, a new iCalendar object and
-     * starts sending scheduling messages based on the changes.
-     *
-     * A list of addresses needs to be specified, so the system knows who made
-     * the update, because the behavior may be different based on if it's an
-     * attendee or an organizer.
-     *
-     * This method may update $newObject to add any status changes.
-     *
-     * @param VCalendar|string|null $oldObject
-     * @param array                 $ignore    any addresses to not send messages to
-     * @param bool                  $modified  a marker to indicate that the original object modified by this process
-     */
-    protected function processICalendarChange($oldObject, VCalendar $newObject, array $addresses, array $ignore = [], &$modified = false)
-    {
-        $broker = new ITip\Broker();
-        $messages = $broker->parseEvent($newObject, $addresses, $oldObject);
-
-        if ($messages) {
-            $modified = true;
-        }
-
-        foreach ($messages as $message) {
-            if (in_array($message->recipient, $ignore)) {
-                continue;
-            }
-
-            $this->deliver($message);
-
-            if (isset($newObject->VEVENT->ORGANIZER) && ($newObject->VEVENT->ORGANIZER->getNormalizedValue() === $message->recipient)) {
-                if ($message->scheduleStatus) {
-                    $newObject->VEVENT->ORGANIZER['SCHEDULE-STATUS'] = $message->getScheduleStatus();
-                }
-                unset($newObject->VEVENT->ORGANIZER['SCHEDULE-FORCE-SEND']);
-            } else {
-                if (isset($newObject->VEVENT->ATTENDEE)) {
-                    foreach ($newObject->VEVENT->ATTENDEE as $attendee) {
-                        if ($attendee->getNormalizedValue() === $message->recipient) {
-                            if ($message->scheduleStatus) {
-                                $attendee['SCHEDULE-STATUS'] = $message->getScheduleStatus();
-                            }
-                            unset($attendee['SCHEDULE-FORCE-SEND']);
-                            break;
-                        }
-                    }
-                }
-            }
-        }
-    }
-
-    /**
-     * Returns a list of addresses that are associated with a principal.
-     *
-     * @param string $principal
-     *
-     * @return array
-     */
-    protected function getAddressesForPrincipal($principal)
-    {
-        $CUAS = '{'.self::NS_CALDAV.'}calendar-user-address-set';
-
-        $properties = $this->server->getProperties(
-            $principal,
-            [$CUAS]
-        );
-
-        // If we can't find this information, we'll stop processing
-        if (!isset($properties[$CUAS])) {
-            return [];
-        }
-
-        $addresses = $properties[$CUAS]->getHrefs();
-
-        return $addresses;
-    }
-
-    /**
-     * This method handles POST requests to the schedule-outbox.
-     *
-     * Currently, two types of requests are supported:
-     *   * FREEBUSY requests from RFC 6638
-     *   * Simple iTIP messages from draft-desruisseaux-caldav-sched-04
-     *
-     * The latter is from an expired early draft of the CalDAV scheduling
-     * extensions, but iCal depends on a feature from that spec, so we
-     * implement it.
-     */
-    public function outboxRequest(IOutbox $outboxNode, RequestInterface $request, ResponseInterface $response)
-    {
-        $outboxPath = $request->getPath();
-
-        // Parsing the request body
-        try {
-            $vObject = VObject\Reader::read($request->getBody());
-        } catch (VObject\ParseException $e) {
-            throw new BadRequest('The request body must be a valid iCalendar object. Parse error: '.$e->getMessage());
-        }
-
-        // The incoming iCalendar object must have a METHOD property, and a
-        // component. The combination of both determines what type of request
-        // this is.
-        $componentType = null;
-        foreach ($vObject->getComponents() as $component) {
-            if ('VTIMEZONE' !== $component->name) {
-                $componentType = $component->name;
-                break;
-            }
-        }
-        if (is_null($componentType)) {
-            throw new BadRequest('We expected at least one VTODO, VJOURNAL, VFREEBUSY or VEVENT component');
-        }
-
-        // Validating the METHOD
-        $method = strtoupper((string) $vObject->METHOD);
-        if (!$method) {
-            throw new BadRequest('A METHOD property must be specified in iTIP messages');
-        }
-
-        // So we support one type of request:
-        //
-        // REQUEST with a VFREEBUSY component
-
-        $acl = $this->server->getPlugin('acl');
-
-        if ('VFREEBUSY' === $componentType && 'REQUEST' === $method) {
-            $acl && $acl->checkPrivileges($outboxPath, '{'.self::NS_CALDAV.'}schedule-send-freebusy');
-            $this->handleFreeBusyRequest($outboxNode, $vObject, $request, $response);
-
-            // Destroy circular references so PHP can GC the object.
-            $vObject->destroy();
-            unset($vObject);
-        } else {
-            throw new NotImplemented('We only support VFREEBUSY (REQUEST) on this endpoint');
-        }
-    }
-
-    /**
-     * This method is responsible for parsing a free-busy query request and
-     * returning its result in $response.
-     */
-    protected function handleFreeBusyRequest(IOutbox $outbox, VObject\Component $vObject, RequestInterface $request, ResponseInterface $response)
-    {
-        $vFreeBusy = $vObject->VFREEBUSY;
-        $organizer = $vFreeBusy->ORGANIZER;
-
-        $organizer = (string) $organizer;
-
-        // Validating if the organizer matches the owner of the inbox.
-        $owner = $outbox->getOwner();
-
-        $caldavNS = '{'.self::NS_CALDAV.'}';
-
-        $uas = $caldavNS.'calendar-user-address-set';
-        $props = $this->server->getProperties($owner, [$uas]);
-
-        if (empty($props[$uas]) || !in_array($organizer, $props[$uas]->getHrefs())) {
-            throw new Forbidden('The organizer in the request did not match any of the addresses for the owner of this inbox');
-        }
-
-        if (!isset($vFreeBusy->ATTENDEE)) {
-            throw new BadRequest('You must at least specify 1 attendee');
-        }
-
-        $attendees = [];
-        foreach ($vFreeBusy->ATTENDEE as $attendee) {
-            $attendees[] = (string) $attendee;
-        }
-
-        if (!isset($vFreeBusy->DTSTART) || !isset($vFreeBusy->DTEND)) {
-            throw new BadRequest('DTSTART and DTEND must both be specified');
-        }
-
-        $startRange = $vFreeBusy->DTSTART->getDateTime();
-        $endRange = $vFreeBusy->DTEND->getDateTime();
-
-        $results = [];
-        foreach ($attendees as $attendee) {
-            $results[] = $this->getFreeBusyForEmail($attendee, $startRange, $endRange, $vObject);
-        }
-
-        $dom = new \DOMDocument('1.0', 'utf-8');
-        $dom->formatOutput = true;
-        $scheduleResponse = $dom->createElement('cal:schedule-response');
-        foreach ($this->server->xml->namespaceMap as $namespace => $prefix) {
-            $scheduleResponse->setAttribute('xmlns:'.$prefix, $namespace);
-        }
-        $dom->appendChild($scheduleResponse);
-
-        foreach ($results as $result) {
-            $xresponse = $dom->createElement('cal:response');
-
-            $recipient = $dom->createElement('cal:recipient');
-            $recipientHref = $dom->createElement('d:href');
-
-            $recipientHref->appendChild($dom->createTextNode($result['href']));
-            $recipient->appendChild($recipientHref);
-            $xresponse->appendChild($recipient);
-
-            $reqStatus = $dom->createElement('cal:request-status');
-            $reqStatus->appendChild($dom->createTextNode($result['request-status']));
-            $xresponse->appendChild($reqStatus);
-
-            if (isset($result['calendar-data'])) {
-                $calendardata = $dom->createElement('cal:calendar-data');
-                $calendardata->appendChild($dom->createTextNode(str_replace("\r\n", "\n", $result['calendar-data']->serialize())));
-                $xresponse->appendChild($calendardata);
-            }
-            $scheduleResponse->appendChild($xresponse);
-        }
-
-        $response->setStatus(200);
-        $response->setHeader('Content-Type', 'application/xml');
-        $response->setBody($dom->saveXML());
-    }
-
-    /**
-     * Returns free-busy information for a specific address. The returned
-     * data is an array containing the following properties:.
-     *
-     * calendar-data : A VFREEBUSY VObject
-     * request-status : an iTip status code.
-     * href: The principal's email address, as requested
-     *
-     * The following request status codes may be returned:
-     *   * 2.0;description
-     *   * 3.7;description
-     *
-     * @param string $email address
-     *
-     * @return array
-     */
-    protected function getFreeBusyForEmail($email, \DateTimeInterface $start, \DateTimeInterface $end, VObject\Component $request)
-    {
-        $caldavNS = '{'.self::NS_CALDAV.'}';
-
-        $aclPlugin = $this->server->getPlugin('acl');
-        if ('mailto:' === substr($email, 0, 7)) {
-            $email = substr($email, 7);
-        }
-
-        $result = $aclPlugin->principalSearch(
-            ['{http://sabredav.org/ns}email-address' => $email],
-            [
-                '{DAV:}principal-URL',
-                $caldavNS.'calendar-home-set',
-                $caldavNS.'schedule-inbox-URL',
-                '{http://sabredav.org/ns}email-address',
-            ]
-        );
-
-        if (!count($result)) {
-            return [
-                'request-status' => '3.7;Could not find principal',
-                'href' => 'mailto:'.$email,
-            ];
-        }
-
-        if (!isset($result[0][200][$caldavNS.'calendar-home-set'])) {
-            return [
-                'request-status' => '3.7;No calendar-home-set property found',
-                'href' => 'mailto:'.$email,
-            ];
-        }
-        if (!isset($result[0][200][$caldavNS.'schedule-inbox-URL'])) {
-            return [
-                'request-status' => '3.7;No schedule-inbox-URL property found',
-                'href' => 'mailto:'.$email,
-            ];
-        }
-        $homeSet = $result[0][200][$caldavNS.'calendar-home-set']->getHref();
-        $inboxUrl = $result[0][200][$caldavNS.'schedule-inbox-URL']->getHref();
-
-        // Do we have permission?
-        $aclPlugin->checkPrivileges($inboxUrl, $caldavNS.'schedule-query-freebusy');
-
-        // Grabbing the calendar list
-        $objects = [];
-        $calendarTimeZone = new DateTimeZone('UTC');
-
-        foreach ($this->server->tree->getNodeForPath($homeSet)->getChildren() as $node) {
-            if (!$node instanceof ICalendar) {
-                continue;
-            }
-
-            $sct = $caldavNS.'schedule-calendar-transp';
-            $ctz = $caldavNS.'calendar-timezone';
-            $props = $node->getProperties([$sct, $ctz]);
-
-            if (isset($props[$sct]) && ScheduleCalendarTransp::TRANSPARENT == $props[$sct]->getValue()) {
-                // If a calendar is marked as 'transparent', it means we must
-                // ignore it for free-busy purposes.
-                continue;
-            }
-
-            if (isset($props[$ctz])) {
-                $vtimezoneObj = VObject\Reader::read($props[$ctz]);
-                $calendarTimeZone = $vtimezoneObj->VTIMEZONE->getTimeZone();
-
-                // Destroy circular references so PHP can garbage collect the object.
-                $vtimezoneObj->destroy();
-            }
-
-            // Getting the list of object uris within the time-range
-            $urls = $node->calendarQuery([
-                'name' => 'VCALENDAR',
-                'comp-filters' => [
-                    [
-                        'name' => 'VEVENT',
-                        'comp-filters' => [],
-                        'prop-filters' => [],
-                        'is-not-defined' => false,
-                        'time-range' => [
-                            'start' => $start,
-                            'end' => $end,
-                        ],
-                    ],
-                ],
-                'prop-filters' => [],
-                'is-not-defined' => false,
-                'time-range' => null,
-            ]);
-
-            $calObjects = array_map(function ($url) use ($node) {
-                $obj = $node->getChild($url)->get();
-
-                return $obj;
-            }, $urls);
-
-            $objects = array_merge($objects, $calObjects);
-        }
-
-        $inboxProps = $this->server->getProperties(
-            $inboxUrl,
-            $caldavNS.'calendar-availability'
-        );
-
-        $vcalendar = new VObject\Component\VCalendar();
-        $vcalendar->METHOD = 'REPLY';
-
-        $generator = new VObject\FreeBusyGenerator();
-        $generator->setObjects($objects);
-        $generator->setTimeRange($start, $end);
-        $generator->setBaseObject($vcalendar);
-        $generator->setTimeZone($calendarTimeZone);
-
-        if ($inboxProps) {
-            $generator->setVAvailability(
-                VObject\Reader::read(
-                    $inboxProps[$caldavNS.'calendar-availability']
-                )
-            );
-        }
-
-        $result = $generator->getResult();
-
-        $vcalendar->VFREEBUSY->ATTENDEE = 'mailto:'.$email;
-        $vcalendar->VFREEBUSY->UID = (string) $request->VFREEBUSY->UID;
-        $vcalendar->VFREEBUSY->ORGANIZER = clone $request->VFREEBUSY->ORGANIZER;
-
-        return [
-            'calendar-data' => $result,
-            'request-status' => '2.0;Success',
-            'href' => 'mailto:'.$email,
-        ];
-    }
-
-    /**
-     * This method checks the 'Schedule-Reply' header
-     * and returns false if it's 'F', otherwise true.
-     *
-     * @return bool
-     */
-    protected function scheduleReply(RequestInterface $request)
-    {
-        $scheduleReply = $request->getHeader('Schedule-Reply');
-
-        return 'F' !== $scheduleReply;
-    }
-
-    /**
-     * Returns a bunch of meta-data about the plugin.
-     *
-     * Providing this information is optional, and is mainly displayed by the
-     * Browser plugin.
-     *
-     * The description key in the returned array may contain html and will not
-     * be sanitized.
-     *
-     * @return array
-     */
-    public function getPluginInfo()
-    {
-        return [
-            'name' => $this->getPluginName(),
-            'description' => 'Adds calendar-auto-schedule, as defined in rfc6638',
-            'link' => 'http://sabre.io/dav/scheduling/',
-        ];
-    }
+		array_push($server->protectedProperties,
+			$ns.'schedule-inbox-URL',
+			$ns.'schedule-outbox-URL',
+			$ns.'calendar-user-address-set',
+			$ns.'calendar-user-type',
+			$ns.'schedule-default-calendar-URL'
+		);
+	}
+
+	/**
+	 * Use this method to tell the server this plugin defines additional
+	 * HTTP methods.
+	 *
+	 * This method is passed a uri. It should only return HTTP methods that are
+	 * available for the specified uri.
+	 *
+	 * @param string $uri
+	 *
+	 * @return array
+	 */
+	public function getHTTPMethods($uri)
+	{
+		try {
+			$node = $this->server->tree->getNodeForPath($uri);
+		} catch (NotFound $e) {
+			return [];
+		}
+
+		if ($node instanceof IOutbox) {
+			return ['POST'];
+		}
+
+		return [];
+	}
+
+	/**
+	 * This method handles POST request for the outbox.
+	 *
+	 * @return bool
+	 */
+	public function httpPost(RequestInterface $request, ResponseInterface $response)
+	{
+		// Checking if this is a text/calendar content type
+		$contentType = $request->getHeader('Content-Type');
+		if (!$contentType || 0 !== strpos($contentType, 'text/calendar')) {
+			return;
+		}
+
+		$path = $request->getPath();
+
+		// Checking if we're talking to an outbox
+		try {
+			$node = $this->server->tree->getNodeForPath($path);
+		} catch (NotFound $e) {
+			return;
+		}
+		if (!$node instanceof IOutbox) {
+			return;
+		}
+
+		$this->server->transactionType = 'post-caldav-outbox';
+		$this->outboxRequest($node, $request, $response);
+
+		// Returning false breaks the event chain and tells the server we've
+		// handled the request.
+		return false;
+	}
+
+	/**
+	 * This method handler is invoked during fetching of properties.
+	 *
+	 * We use this event to add calendar-auto-schedule-specific properties.
+	 */
+	public function propFind(PropFind $propFind, INode $node)
+	{
+		if ($node instanceof DAVACL\IPrincipal) {
+			$caldavPlugin = $this->server->getPlugin('caldav');
+			$principalUrl = $node->getPrincipalUrl();
+
+			// schedule-outbox-URL property
+			$propFind->handle('{'.self::NS_CALDAV.'}schedule-outbox-URL', function () use ($principalUrl, $caldavPlugin) {
+				$calendarHomePath = $caldavPlugin->getCalendarHomeForPrincipal($principalUrl);
+				if (!$calendarHomePath) {
+					return null;
+				}
+				$outboxPath = $calendarHomePath.'/outbox/';
+
+				return new LocalHref($outboxPath);
+			});
+			// schedule-inbox-URL property
+			$propFind->handle('{'.self::NS_CALDAV.'}schedule-inbox-URL', function () use ($principalUrl, $caldavPlugin) {
+				$calendarHomePath = $caldavPlugin->getCalendarHomeForPrincipal($principalUrl);
+				if (!$calendarHomePath) {
+					return null;
+				}
+				$inboxPath = $calendarHomePath.'/inbox/';
+
+				return new LocalHref($inboxPath);
+			});
+
+			$propFind->handle('{'.self::NS_CALDAV.'}schedule-default-calendar-URL', function () use ($principalUrl, $caldavPlugin) {
+				// We don't support customizing this property yet, so in the
+				// meantime we just grab the first calendar in the home-set.
+				$calendarHomePath = $caldavPlugin->getCalendarHomeForPrincipal($principalUrl);
+
+				if (!$calendarHomePath) {
+					return null;
+				}
+
+				$sccs = '{'.self::NS_CALDAV.'}supported-calendar-component-set';
+
+				$result = $this->server->getPropertiesForPath($calendarHomePath, [
+					'{DAV:}resourcetype',
+					'{DAV:}share-access',
+					$sccs,
+				], 1);
+
+				foreach ($result as $child) {
+					if (!isset($child[200]['{DAV:}resourcetype']) || !$child[200]['{DAV:}resourcetype']->is('{'.self::NS_CALDAV.'}calendar')) {
+						// Node is either not a calendar
+						continue;
+					}
+					if (isset($child[200]['{DAV:}share-access'])) {
+						$shareAccess = $child[200]['{DAV:}share-access']->getValue();
+						if (Sharing\Plugin::ACCESS_NOTSHARED !== $shareAccess && Sharing\Plugin::ACCESS_SHAREDOWNER !== $shareAccess) {
+							// Node is a shared node, not owned by the relevant
+							// user.
+							continue;
+						}
+					}
+					if (!isset($child[200][$sccs]) || in_array('VEVENT', $child[200][$sccs]->getValue())) {
+						// Either there is no supported-calendar-component-set
+						// (which is fine) or we found one that supports VEVENT.
+						return new LocalHref($child['href']);
+					}
+				}
+			});
+
+			// The server currently reports every principal to be of type
+			// 'INDIVIDUAL'
+			$propFind->handle('{'.self::NS_CALDAV.'}calendar-user-type', function () {
+				return 'INDIVIDUAL';
+			});
+		}
+
+		// Mapping the old property to the new property.
+		$propFind->handle('{http://calendarserver.org/ns/}calendar-availability', function () use ($propFind, $node) {
+			// In case it wasn't clear, the only difference is that we map the
+			// old property to a different namespace.
+			$availProp = '{'.self::NS_CALDAV.'}calendar-availability';
+			$subPropFind = new PropFind(
+				 $propFind->getPath(),
+				 [$availProp]
+			 );
+
+			$this->server->getPropertiesByNode(
+				 $subPropFind,
+				 $node
+			 );
+
+			$propFind->set(
+				 '{http://calendarserver.org/ns/}calendar-availability',
+				 $subPropFind->get($availProp),
+				 $subPropFind->getStatus($availProp)
+			 );
+		});
+	}
+
+	/**
+	 * This method is called during property updates.
+	 *
+	 * @param string $path
+	 */
+	public function propPatch($path, PropPatch $propPatch)
+	{
+		// Mapping the old property to the new property.
+		$propPatch->handle('{http://calendarserver.org/ns/}calendar-availability', function ($value) use ($path) {
+			$availProp = '{'.self::NS_CALDAV.'}calendar-availability';
+			$subPropPatch = new PropPatch([$availProp => $value]);
+			$this->server->emit('propPatch', [$path, $subPropPatch]);
+			$subPropPatch->commit();
+
+			return $subPropPatch->getResult()[$availProp];
+		});
+	}
+
+	/**
+	 * This method is triggered whenever there was a calendar object gets
+	 * created or updated.
+	 *
+	 * @param RequestInterface  $request      HTTP request
+	 * @param ResponseInterface $response     HTTP Response
+	 * @param VCalendar         $vCal         Parsed iCalendar object
+	 * @param mixed             $calendarPath Path to calendar collection
+	 * @param mixed             $modified     the iCalendar object has been touched
+	 * @param mixed             $isNew        Whether this was a new item or we're updating one
+	 */
+	public function calendarObjectChange(RequestInterface $request, ResponseInterface $response, VCalendar $vCal, $calendarPath, &$modified, $isNew)
+	{
+		if (!$this->scheduleReply($this->server->httpRequest)) {
+			return;
+		}
+
+		$calendarNode = $this->server->tree->getNodeForPath($calendarPath);
+
+		$addresses = $this->getAddressesForPrincipal(
+			$calendarNode->getOwner()
+		);
+
+		if (!$isNew) {
+			$node = $this->server->tree->getNodeForPath($request->getPath());
+			$oldObj = Reader::read($node->get());
+		} else {
+			$oldObj = null;
+		}
+
+		$this->processICalendarChange($oldObj, $vCal, $addresses, [], $modified);
+
+		if ($oldObj) {
+			// Destroy circular references so PHP will GC the object.
+			$oldObj->destroy();
+		}
+	}
+
+	/**
+	 * This method is responsible for delivering the ITip message.
+	 */
+	public function deliver(ITip\Message $iTipMessage)
+	{
+		$this->server->emit('schedule', [$iTipMessage]);
+		if (!$iTipMessage->scheduleStatus) {
+			$iTipMessage->scheduleStatus = '5.2;There was no system capable of delivering the scheduling message';
+		}
+		// In case the change was considered 'insignificant', we are going to
+		// remove any error statuses, if any. See ticket #525.
+		list($baseCode) = explode('.', $iTipMessage->scheduleStatus);
+		if (!$iTipMessage->significantChange && in_array($baseCode, ['3', '5'])) {
+			$iTipMessage->scheduleStatus = null;
+		}
+	}
+
+	/**
+	 * This method is triggered before a file gets deleted.
+	 *
+	 * We use this event to make sure that when this happens, attendees get
+	 * cancellations, and organizers get 'DECLINED' statuses.
+	 *
+	 * @param string $path
+	 */
+	public function beforeUnbind($path)
+	{
+		// FIXME: We shouldn't trigger this functionality when we're issuing a
+		// MOVE. This is a hack.
+		if ('MOVE' === $this->server->httpRequest->getMethod()) {
+			return;
+		}
+
+		$node = $this->server->tree->getNodeForPath($path);
+
+		if (!$node instanceof ICalendarObject || $node instanceof ISchedulingObject) {
+			return;
+		}
+
+		if (!$this->scheduleReply($this->server->httpRequest)) {
+			return;
+		}
+
+		$addresses = $this->getAddressesForPrincipal(
+			$node->getOwner()
+		);
+
+		$broker = new ITip\Broker();
+		$messages = $broker->parseEvent(null, $addresses, $node->get());
+
+		foreach ($messages as $message) {
+			$this->deliver($message);
+		}
+	}
+
+	/**
+	 * Event handler for the 'schedule' event.
+	 *
+	 * This handler attempts to look at local accounts to deliver the
+	 * scheduling object.
+	 */
+	public function scheduleLocalDelivery(ITip\Message $iTipMessage)
+	{
+		$aclPlugin = $this->server->getPlugin('acl');
+
+		// Local delivery is not available if the ACL plugin is not loaded.
+		if (!$aclPlugin) {
+			return;
+		}
+
+		$caldavNS = '{'.self::NS_CALDAV.'}';
+
+		$principalUri = $aclPlugin->getPrincipalByUri($iTipMessage->recipient);
+		if (!$principalUri) {
+			$iTipMessage->scheduleStatus = '3.7;Could not find principal.';
+
+			return;
+		}
+
+		// We found a principal URL, now we need to find its inbox.
+		// Unfortunately we may not have sufficient privileges to find this, so
+		// we are temporarily turning off ACL to let this come through.
+		//
+		// Once we support PHP 5.5, this should be wrapped in a try..finally
+		// block so we can ensure that this privilege gets added again after.
+		$this->server->removeListener('propFind', [$aclPlugin, 'propFind']);
+
+		$result = $this->server->getProperties(
+			$principalUri,
+			[
+				'{DAV:}principal-URL',
+				 $caldavNS.'calendar-home-set',
+				 $caldavNS.'schedule-inbox-URL',
+				 $caldavNS.'schedule-default-calendar-URL',
+				'{http://sabredav.org/ns}email-address',
+			]
+		);
+
+		// Re-registering the ACL event
+		$this->server->on('propFind', [$aclPlugin, 'propFind'], 20);
+
+		if (!isset($result[$caldavNS.'schedule-inbox-URL'])) {
+			$iTipMessage->scheduleStatus = '5.2;Could not find local inbox';
+
+			return;
+		}
+		if (!isset($result[$caldavNS.'calendar-home-set'])) {
+			$iTipMessage->scheduleStatus = '5.2;Could not locate a calendar-home-set';
+
+			return;
+		}
+		if (!isset($result[$caldavNS.'schedule-default-calendar-URL'])) {
+			$iTipMessage->scheduleStatus = '5.2;Could not find a schedule-default-calendar-URL property';
+
+			return;
+		}
+
+		$calendarPath = $result[$caldavNS.'schedule-default-calendar-URL']->getHref();
+		$homePath = $result[$caldavNS.'calendar-home-set']->getHref();
+		$inboxPath = $result[$caldavNS.'schedule-inbox-URL']->getHref();
+
+		if ('REPLY' === $iTipMessage->method) {
+			$privilege = 'schedule-deliver-reply';
+		} else {
+			$privilege = 'schedule-deliver-invite';
+		}
+
+		if (!$aclPlugin->checkPrivileges($inboxPath, $caldavNS.$privilege, DAVACL\Plugin::R_PARENT, false)) {
+			$iTipMessage->scheduleStatus = '3.8;insufficient privileges: '.$privilege.' is required on the recipient schedule inbox.';
+
+			return;
+		}
+
+		// Next, we're going to find out if the item already exits in one of
+		// the users' calendars.
+		$uid = $iTipMessage->uid;
+
+		$newFileName = 'sabredav-'.\Sabre\DAV\UUIDUtil::getUUID().'.ics';
+
+		$home = $this->server->tree->getNodeForPath($homePath);
+		$inbox = $this->server->tree->getNodeForPath($inboxPath);
+
+		$currentObject = null;
+		$objectNode = null;
+		$oldICalendarData = null;
+		$isNewNode = false;
+
+		$result = $home->getCalendarObjectByUID($uid);
+		if ($result) {
+			// There was an existing object, we need to update probably.
+			$objectPath = $homePath.'/'.$result;
+			$objectNode = $this->server->tree->getNodeForPath($objectPath);
+			$oldICalendarData = $objectNode->get();
+			$currentObject = Reader::read($oldICalendarData);
+		} else {
+			$isNewNode = true;
+		}
+
+		$broker = new ITip\Broker();
+		$newObject = $broker->processMessage($iTipMessage, $currentObject);
+
+		$inbox->createFile($newFileName, $iTipMessage->message->serialize());
+
+		if (!$newObject) {
+			// We received an iTip message referring to a UID that we don't
+			// have in any calendars yet, and processMessage did not give us a
+			// calendarobject back.
+			//
+			// The implication is that processMessage did not understand the
+			// iTip message.
+			$iTipMessage->scheduleStatus = '5.0;iTip message was not processed by the server, likely because we didn\'t understand it.';
+
+			return;
+		}
+
+		// Note that we are bypassing ACL on purpose by calling this directly.
+		// We may need to look a bit deeper into this later. Supporting ACL
+		// here would be nice.
+		if ($isNewNode) {
+			$calendar = $this->server->tree->getNodeForPath($calendarPath);
+			$calendar->createFile($newFileName, $newObject->serialize());
+		} else {
+			// If the message was a reply, we may have to inform other
+			// attendees of this attendees status. Therefore we're shooting off
+			// another itipMessage.
+			if ('REPLY' === $iTipMessage->method) {
+				$this->processICalendarChange(
+					$oldICalendarData,
+					$newObject,
+					[$iTipMessage->recipient],
+					[$iTipMessage->sender]
+				);
+			}
+			$objectNode->put($newObject->serialize());
+		}
+		$iTipMessage->scheduleStatus = '1.2;Message delivered locally';
+	}
+
+	/**
+	 * This method is triggered whenever a subsystem requests the privileges
+	 * that are supported on a particular node.
+	 *
+	 * We need to add a number of privileges for scheduling purposes.
+	 */
+	public function getSupportedPrivilegeSet(INode $node, array &$supportedPrivilegeSet)
+	{
+		$ns = '{'.self::NS_CALDAV.'}';
+		if ($node instanceof IOutbox) {
+			$supportedPrivilegeSet[$ns.'schedule-send'] = [
+				'abstract' => false,
+				'aggregates' => [
+					$ns.'schedule-send-invite' => [
+						'abstract' => false,
+						'aggregates' => [],
+					],
+					$ns.'schedule-send-reply' => [
+						'abstract' => false,
+						'aggregates' => [],
+					],
+					$ns.'schedule-send-freebusy' => [
+						'abstract' => false,
+						'aggregates' => [],
+					],
+					// Privilege from an earlier scheduling draft, but still
+					// used by some clients.
+					$ns.'schedule-post-vevent' => [
+						'abstract' => false,
+						'aggregates' => [],
+					],
+				],
+			];
+		}
+		if ($node instanceof IInbox) {
+			$supportedPrivilegeSet[$ns.'schedule-deliver'] = [
+				'abstract' => false,
+				'aggregates' => [
+					$ns.'schedule-deliver-invite' => [
+						'abstract' => false,
+						'aggregates' => [],
+					],
+					$ns.'schedule-deliver-reply' => [
+						'abstract' => false,
+						'aggregates' => [],
+					],
+					$ns.'schedule-query-freebusy' => [
+						'abstract' => false,
+						'aggregates' => [],
+					],
+				],
+			];
+		}
+	}
+
+	/**
+	 * This method looks at an old iCalendar object, a new iCalendar object and
+	 * starts sending scheduling messages based on the changes.
+	 *
+	 * A list of addresses needs to be specified, so the system knows who made
+	 * the update, because the behavior may be different based on if it's an
+	 * attendee or an organizer.
+	 *
+	 * This method may update $newObject to add any status changes.
+	 *
+	 * @param VCalendar|string|null $oldObject
+	 * @param array                 $ignore    any addresses to not send messages to
+	 * @param bool                  $modified  a marker to indicate that the original object modified by this process
+	 */
+	protected function processICalendarChange($oldObject, VCalendar $newObject, array $addresses, array $ignore = [], &$modified = false)
+	{
+		$broker = new ITip\Broker();
+		$messages = $broker->parseEvent($newObject, $addresses, $oldObject);
+
+		if ($messages) {
+			$modified = true;
+		}
+
+		foreach ($messages as $message) {
+			if (in_array($message->recipient, $ignore)) {
+				continue;
+			}
+
+			$this->deliver($message);
+
+			if (isset($newObject->VEVENT->ORGANIZER) && ($newObject->VEVENT->ORGANIZER->getNormalizedValue() === $message->recipient)) {
+				if ($message->scheduleStatus) {
+					$newObject->VEVENT->ORGANIZER['SCHEDULE-STATUS'] = $message->getScheduleStatus();
+				}
+				unset($newObject->VEVENT->ORGANIZER['SCHEDULE-FORCE-SEND']);
+			} else {
+				if (isset($newObject->VEVENT->ATTENDEE)) {
+					foreach ($newObject->VEVENT->ATTENDEE as $attendee) {
+						if ($attendee->getNormalizedValue() === $message->recipient) {
+							if ($message->scheduleStatus) {
+								$attendee['SCHEDULE-STATUS'] = $message->getScheduleStatus();
+							}
+							unset($attendee['SCHEDULE-FORCE-SEND']);
+							break;
+						}
+					}
+				}
+			}
+		}
+	}
+
+	/**
+	 * Returns a list of addresses that are associated with a principal.
+	 *
+	 * @param string $principal
+	 *
+	 * @return array
+	 */
+	protected function getAddressesForPrincipal($principal)
+	{
+		$CUAS = '{'.self::NS_CALDAV.'}calendar-user-address-set';
+
+		$properties = $this->server->getProperties(
+			$principal,
+			[$CUAS]
+		);
+
+		// If we can't find this information, we'll stop processing
+		if (!isset($properties[$CUAS])) {
+			return [];
+		}
+
+		$addresses = $properties[$CUAS]->getHrefs();
+
+		return $addresses;
+	}
+
+	/**
+	 * This method handles POST requests to the schedule-outbox.
+	 *
+	 * Currently, two types of requests are supported:
+	 *   * FREEBUSY requests from RFC 6638
+	 *   * Simple iTIP messages from draft-desruisseaux-caldav-sched-04
+	 *
+	 * The latter is from an expired early draft of the CalDAV scheduling
+	 * extensions, but iCal depends on a feature from that spec, so we
+	 * implement it.
+	 */
+	public function outboxRequest(IOutbox $outboxNode, RequestInterface $request, ResponseInterface $response)
+	{
+		$outboxPath = $request->getPath();
+
+		// Parsing the request body
+		try {
+			$vObject = VObject\Reader::read($request->getBody());
+		} catch (VObject\ParseException $e) {
+			throw new BadRequest('The request body must be a valid iCalendar object. Parse error: '.$e->getMessage());
+		}
+
+		// The incoming iCalendar object must have a METHOD property, and a
+		// component. The combination of both determines what type of request
+		// this is.
+		$componentType = null;
+		foreach ($vObject->getComponents() as $component) {
+			if ('VTIMEZONE' !== $component->name) {
+				$componentType = $component->name;
+				break;
+			}
+		}
+		if (is_null($componentType)) {
+			throw new BadRequest('We expected at least one VTODO, VJOURNAL, VFREEBUSY or VEVENT component');
+		}
+
+		// Validating the METHOD
+		$method = strtoupper((string) $vObject->METHOD);
+		if (!$method) {
+			throw new BadRequest('A METHOD property must be specified in iTIP messages');
+		}
+
+		// So we support one type of request:
+		//
+		// REQUEST with a VFREEBUSY component
+
+		$acl = $this->server->getPlugin('acl');
+
+		if ('VFREEBUSY' === $componentType && 'REQUEST' === $method) {
+			$acl && $acl->checkPrivileges($outboxPath, '{'.self::NS_CALDAV.'}schedule-send-freebusy');
+			$this->handleFreeBusyRequest($outboxNode, $vObject, $request, $response);
+
+			// Destroy circular references so PHP can GC the object.
+			$vObject->destroy();
+			unset($vObject);
+		} else {
+			throw new NotImplemented('We only support VFREEBUSY (REQUEST) on this endpoint');
+		}
+	}
+
+	/**
+	 * This method is responsible for parsing a free-busy query request and
+	 * returning its result in $response.
+	 */
+	protected function handleFreeBusyRequest(IOutbox $outbox, VObject\Component $vObject, RequestInterface $request, ResponseInterface $response)
+	{
+		$vFreeBusy = $vObject->VFREEBUSY;
+		$organizer = $vFreeBusy->ORGANIZER;
+
+		$organizer = (string) $organizer;
+
+		// Validating if the organizer matches the owner of the inbox.
+		$owner = $outbox->getOwner();
+
+		$caldavNS = '{'.self::NS_CALDAV.'}';
+
+		$uas = $caldavNS.'calendar-user-address-set';
+		$props = $this->server->getProperties($owner, [$uas]);
+
+		if (empty($props[$uas]) || !in_array($organizer, $props[$uas]->getHrefs())) {
+			throw new Forbidden('The organizer in the request did not match any of the addresses for the owner of this inbox');
+		}
+
+		if (!isset($vFreeBusy->ATTENDEE)) {
+			throw new BadRequest('You must at least specify 1 attendee');
+		}
+
+		$attendees = [];
+		foreach ($vFreeBusy->ATTENDEE as $attendee) {
+			$attendees[] = (string) $attendee;
+		}
+
+		if (!isset($vFreeBusy->DTSTART) || !isset($vFreeBusy->DTEND)) {
+			throw new BadRequest('DTSTART and DTEND must both be specified');
+		}
+
+		$startRange = $vFreeBusy->DTSTART->getDateTime();
+		$endRange = $vFreeBusy->DTEND->getDateTime();
+
+		$results = [];
+		foreach ($attendees as $attendee) {
+			$results[] = $this->getFreeBusyForEmail($attendee, $startRange, $endRange, $vObject);
+		}
+
+		$dom = new \DOMDocument('1.0', 'utf-8');
+		$dom->formatOutput = true;
+		$scheduleResponse = $dom->createElement('cal:schedule-response');
+		foreach ($this->server->xml->namespaceMap as $namespace => $prefix) {
+			$scheduleResponse->setAttribute('xmlns:'.$prefix, $namespace);
+		}
+		$dom->appendChild($scheduleResponse);
+
+		foreach ($results as $result) {
+			$xresponse = $dom->createElement('cal:response');
+
+			$recipient = $dom->createElement('cal:recipient');
+			$recipientHref = $dom->createElement('d:href');
+
+			$recipientHref->appendChild($dom->createTextNode($result['href']));
+			$recipient->appendChild($recipientHref);
+			$xresponse->appendChild($recipient);
+
+			$reqStatus = $dom->createElement('cal:request-status');
+			$reqStatus->appendChild($dom->createTextNode($result['request-status']));
+			$xresponse->appendChild($reqStatus);
+
+			if (isset($result['calendar-data'])) {
+				$calendardata = $dom->createElement('cal:calendar-data');
+				$calendardata->appendChild($dom->createTextNode(str_replace("\r\n", "\n", $result['calendar-data']->serialize())));
+				$xresponse->appendChild($calendardata);
+			}
+			$scheduleResponse->appendChild($xresponse);
+		}
+
+		$response->setStatus(200);
+		$response->setHeader('Content-Type', 'application/xml');
+		$response->setBody($dom->saveXML());
+	}
+
+	/**
+	 * Returns free-busy information for a specific address. The returned
+	 * data is an array containing the following properties:.
+	 *
+	 * calendar-data : A VFREEBUSY VObject
+	 * request-status : an iTip status code.
+	 * href: The principal's email address, as requested
+	 *
+	 * The following request status codes may be returned:
+	 *   * 2.0;description
+	 *   * 3.7;description
+	 *
+	 * @param string $email address
+	 *
+	 * @return array
+	 */
+	protected function getFreeBusyForEmail($email, \DateTimeInterface $start, \DateTimeInterface $end, VObject\Component $request)
+	{
+		$caldavNS = '{'.self::NS_CALDAV.'}';
+
+		$aclPlugin = $this->server->getPlugin('acl');
+		if ('mailto:' === substr($email, 0, 7)) {
+			$email = substr($email, 7);
+		}
+
+		$result = $aclPlugin->principalSearch(
+			['{http://sabredav.org/ns}email-address' => $email],
+			[
+				'{DAV:}principal-URL',
+				$caldavNS.'calendar-home-set',
+				$caldavNS.'schedule-inbox-URL',
+				'{http://sabredav.org/ns}email-address',
+			]
+		);
+
+		if (!count($result)) {
+			return [
+				'request-status' => '3.7;Could not find principal',
+				'href' => 'mailto:'.$email,
+			];
+		}
+
+		if (!isset($result[0][200][$caldavNS.'calendar-home-set'])) {
+			return [
+				'request-status' => '3.7;No calendar-home-set property found',
+				'href' => 'mailto:'.$email,
+			];
+		}
+		if (!isset($result[0][200][$caldavNS.'schedule-inbox-URL'])) {
+			return [
+				'request-status' => '3.7;No schedule-inbox-URL property found',
+				'href' => 'mailto:'.$email,
+			];
+		}
+		$homeSet = $result[0][200][$caldavNS.'calendar-home-set']->getHref();
+		$inboxUrl = $result[0][200][$caldavNS.'schedule-inbox-URL']->getHref();
+
+		// Do we have permission?
+		$aclPlugin->checkPrivileges($inboxUrl, $caldavNS.'schedule-query-freebusy');
+
+		// Grabbing the calendar list
+		$objects = [];
+		$calendarTimeZone = new DateTimeZone('UTC');
+
+		foreach ($this->server->tree->getNodeForPath($homeSet)->getChildren() as $node) {
+			if (!$node instanceof ICalendar) {
+				continue;
+			}
+
+			$sct = $caldavNS.'schedule-calendar-transp';
+			$ctz = $caldavNS.'calendar-timezone';
+			$props = $node->getProperties([$sct, $ctz]);
+
+			if (isset($props[$sct]) && ScheduleCalendarTransp::TRANSPARENT == $props[$sct]->getValue()) {
+				// If a calendar is marked as 'transparent', it means we must
+				// ignore it for free-busy purposes.
+				continue;
+			}
+
+			if (isset($props[$ctz])) {
+				$vtimezoneObj = VObject\Reader::read($props[$ctz]);
+				$calendarTimeZone = $vtimezoneObj->VTIMEZONE->getTimeZone();
+
+				// Destroy circular references so PHP can garbage collect the object.
+				$vtimezoneObj->destroy();
+			}
+
+			// Getting the list of object uris within the time-range
+			$urls = $node->calendarQuery([
+				'name' => 'VCALENDAR',
+				'comp-filters' => [
+					[
+						'name' => 'VEVENT',
+						'comp-filters' => [],
+						'prop-filters' => [],
+						'is-not-defined' => false,
+						'time-range' => [
+							'start' => $start,
+							'end' => $end,
+						],
+					],
+				],
+				'prop-filters' => [],
+				'is-not-defined' => false,
+				'time-range' => null,
+			]);
+
+			$calObjects = array_map(function ($url) use ($node) {
+				$obj = $node->getChild($url)->get();
+
+				return $obj;
+			}, $urls);
+
+			$objects = array_merge($objects, $calObjects);
+		}
+
+		$inboxProps = $this->server->getProperties(
+			$inboxUrl,
+			$caldavNS.'calendar-availability'
+		);
+
+		$vcalendar = new VObject\Component\VCalendar();
+		$vcalendar->METHOD = 'REPLY';
+
+		$generator = new VObject\FreeBusyGenerator();
+		$generator->setObjects($objects);
+		$generator->setTimeRange($start, $end);
+		$generator->setBaseObject($vcalendar);
+		$generator->setTimeZone($calendarTimeZone);
+
+		if ($inboxProps) {
+			$generator->setVAvailability(
+				VObject\Reader::read(
+					$inboxProps[$caldavNS.'calendar-availability']
+				)
+			);
+		}
+
+		$result = $generator->getResult();
+
+		$vcalendar->VFREEBUSY->ATTENDEE = 'mailto:'.$email;
+		$vcalendar->VFREEBUSY->UID = (string) $request->VFREEBUSY->UID;
+		$vcalendar->VFREEBUSY->ORGANIZER = clone $request->VFREEBUSY->ORGANIZER;
+
+		return [
+			'calendar-data' => $result,
+			'request-status' => '2.0;Success',
+			'href' => 'mailto:'.$email,
+		];
+	}
+
+	/**
+	 * This method checks the 'Schedule-Reply' header
+	 * and returns false if it's 'F', otherwise true.
+	 *
+	 * @return bool
+	 */
+	protected function scheduleReply(RequestInterface $request)
+	{
+		$scheduleReply = $request->getHeader('Schedule-Reply');
+
+		return 'F' !== $scheduleReply;
+	}
+
+	/**
+	 * Returns a bunch of meta-data about the plugin.
+	 *
+	 * Providing this information is optional, and is mainly displayed by the
+	 * Browser plugin.
+	 *
+	 * The description key in the returned array may contain html and will not
+	 * be sanitized.
+	 *
+	 * @return array
+	 */
+	public function getPluginInfo()
+	{
+		return [
+			'name' => $this->getPluginName(),
+			'description' => 'Adds calendar-auto-schedule, as defined in rfc6638',
+			'link' => 'http://sabre.io/dav/scheduling/',
+		];
+	}
 }

htdocs/includes/sabre/sabre/dav/lib/CalDAV/Schedule/Inbox.php

Indentation +176 added lines, -176 removed lines

@@ -19,180 +19,180 @@
  */
 class Inbox extends DAV\Collection implements IInbox
 {
-    use DAVACL\ACLTrait;
-
-    /**
-     * CalDAV backend.
-     *
-     * @var Backend\BackendInterface
-     */
-    protected $caldavBackend;
-
-    /**
-     * The principal Uri.
-     *
-     * @var string
-     */
-    protected $principalUri;
-
-    /**
-     * Constructor.
-     *
-     * @param string $principalUri
-     */
-    public 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
-     */
-    public function getName()
-    {
-        return 'inbox';
-    }
-
-    /**
-     * Returns an array with all the child nodes.
-     *
-     * @return \Sabre\DAV\INode[]
-     */
-    public 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 successful 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 string|null
-     */
-    public 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
-     */
-    public function getOwner()
-    {
-        return $this->principalUri;
-    }
-
-    /**
-     * 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 [
-            [
-                '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',
-                'principal' => '{DAV:}authenticated',
-                'protected' => true,
-            ],
-        ];
-    }
-
-    /**
-     * 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.
-     *
-     * @return array
-     */
-    public 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;
-    }
+	use DAVACL\ACLTrait;
+
+	/**
+	 * CalDAV backend.
+	 *
+	 * @var Backend\BackendInterface
+	 */
+	protected $caldavBackend;
+
+	/**
+	 * The principal Uri.
+	 *
+	 * @var string
+	 */
+	protected $principalUri;
+
+	/**
+	 * Constructor.
+	 *
+	 * @param string $principalUri
+	 */
+	public 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
+	 */
+	public function getName()
+	{
+		return 'inbox';
+	}
+
+	/**
+	 * Returns an array with all the child nodes.
+	 *
+	 * @return \Sabre\DAV\INode[]
+	 */
+	public 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 successful 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 string|null
+	 */
+	public 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
+	 */
+	public function getOwner()
+	{
+		return $this->principalUri;
+	}
+
+	/**
+	 * 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 [
+			[
+				'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',
+				'principal' => '{DAV:}authenticated',
+				'protected' => true,
+			],
+		];
+	}
+
+	/**
+	 * 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.
+	 *
+	 * @return array
+	 */
+	public 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;
+	}
 }

htdocs/includes/sabre/sabre/dav/lib/CalDAV/Schedule/SchedulingObject.php

Indentation +102 added lines, -102 removed lines

@@ -16,115 +16,115 @@
  */
 class SchedulingObject extends \Sabre\CalDAV\CalendarObject implements ISchedulingObject
 {
-    /**
-     * Constructor.
-     *
-     * The following properties may be passed within $objectData:
-     *
-     *   * uri - A unique uri. Only the 'basename' must be passed.
-     *   * principaluri - the principal that owns the object.
-     *   * 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.
-     */
-    public function __construct(Backend\SchedulingSupport $caldavBackend, array $objectData)
-    {
-        parent::__construct($caldavBackend, [], $objectData);
+	/**
+	 * Constructor.
+	 *
+	 * The following properties may be passed within $objectData:
+	 *
+	 *   * uri - A unique uri. Only the 'basename' must be passed.
+	 *   * principaluri - the principal that owns the object.
+	 *   * 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.
+	 */
+	public function __construct(Backend\SchedulingSupport $caldavBackend, array $objectData)
+	{
+		parent::__construct($caldavBackend, [], $objectData);
 
-        if (!isset($objectData['uri'])) {
-            throw new \InvalidArgumentException('The objectData argument must contain an \'uri\' property');
-        }
-    }
+		if (!isset($objectData['uri'])) {
+			throw new \InvalidArgumentException('The objectData argument must contain an \'uri\' property');
+		}
+	}
 
-    /**
-     * Returns the ICalendar-formatted object.
-     *
-     * @return string
-     */
-    public 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->getSchedulingObject($this->objectData['principaluri'], $this->objectData['uri']);
-        }
+	/**
+	 * Returns the ICalendar-formatted object.
+	 *
+	 * @return string
+	 */
+	public 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->getSchedulingObject($this->objectData['principaluri'], $this->objectData['uri']);
+		}
 
-        return $this->objectData['calendardata'];
-    }
+		return $this->objectData['calendardata'];
+	}
 
-    /**
-     * Updates the ICalendar-formatted object.
-     *
-     * @param string|resource $calendarData
-     *
-     * @return string
-     */
-    public function put($calendarData)
-    {
-        throw new MethodNotAllowed('Updating scheduling objects is not supported');
-    }
+	/**
+	 * Updates the ICalendar-formatted object.
+	 *
+	 * @param string|resource $calendarData
+	 *
+	 * @return string
+	 */
+	public function put($calendarData)
+	{
+		throw new MethodNotAllowed('Updating scheduling objects is not supported');
+	}
 
-    /**
-     * Deletes the scheduling message.
-     */
-    public function delete()
-    {
-        $this->caldavBackend->deleteSchedulingObject($this->objectData['principaluri'], $this->objectData['uri']);
-    }
+	/**
+	 * Deletes the scheduling message.
+	 */
+	public function delete()
+	{
+		$this->caldavBackend->deleteSchedulingObject($this->objectData['principaluri'], $this->objectData['uri']);
+	}
 
-    /**
-     * 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->objectData['principaluri'];
-    }
+	/**
+	 * 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->objectData['principaluri'];
+	}
 
-    /**
-     * 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()
-    {
-        // An alternative acl may be specified in the object data.
-        //
+	/**
+	 * 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()
+	{
+		// An alternative acl may be specified in the object data.
+		//
 
-        if (isset($this->objectData['acl'])) {
-            return $this->objectData['acl'];
-        }
+		if (isset($this->objectData['acl'])) {
+			return $this->objectData['acl'];
+		}
 
-        // The default ACL
-        return [
-            [
-                'privilege' => '{DAV:}all',
-                'principal' => '{DAV:}owner',
-                'protected' => true,
-            ],
-            [
-                'privilege' => '{DAV:}all',
-                'principal' => $this->objectData['principaluri'].'/calendar-proxy-write',
-                'protected' => true,
-            ],
-            [
-                'privilege' => '{DAV:}read',
-                'principal' => $this->objectData['principaluri'].'/calendar-proxy-read',
-                'protected' => true,
-            ],
-        ];
-    }
+		// The default ACL
+		return [
+			[
+				'privilege' => '{DAV:}all',
+				'principal' => '{DAV:}owner',
+				'protected' => true,
+			],
+			[
+				'privilege' => '{DAV:}all',
+				'principal' => $this->objectData['principaluri'].'/calendar-proxy-write',
+				'protected' => true,
+			],
+			[
+				'privilege' => '{DAV:}read',
+				'principal' => $this->objectData['principaluri'].'/calendar-proxy-read',
+				'protected' => true,
+			],
+		];
+	}
 }

htdocs/includes/sabre/sabre/dav/lib/CardDAV/Plugin.php

Indentation +849 added lines, -849 removed lines

@@ -25,683 +25,683 @@ 
  */
 class Plugin extends DAV\ServerPlugin
 {
-    /**
-     * Url to the addressbooks.
-     */
-    const ADDRESSBOOK_ROOT = 'addressbooks';
-
-    /**
-     * xml namespace for CardDAV elements.
-     */
-    const NS_CARDDAV = 'urn:ietf:params:xml:ns:carddav';
-
-    /**
-     * Add urls to this property to have them automatically exposed as
-     * 'directories' to the user.
-     *
-     * @var array
-     */
-    public $directories = [];
-
-    /**
-     * Server class.
-     *
-     * @var DAV\Server
-     */
-    protected $server;
-
-    /**
-     * The default PDO storage uses a MySQL MEDIUMBLOB for iCalendar data,
-     * which can hold up to 2^24 = 16777216 bytes. This is plenty. We're
-     * capping it to 10M here.
-     */
-    protected $maxResourceSize = 10000000;
-
-    /**
-     * Initializes the plugin.
-     */
-    public function initialize(DAV\Server $server)
-    {
-        /* Events */
-        $server->on('propFind', [$this, 'propFindEarly']);
-        $server->on('propFind', [$this, 'propFindLate'], 150);
-        $server->on('report', [$this, 'report']);
-        $server->on('onHTMLActionsPanel', [$this, 'htmlActionsPanel']);
-        $server->on('beforeWriteContent', [$this, 'beforeWriteContent']);
-        $server->on('beforeCreateFile', [$this, 'beforeCreateFile']);
-        $server->on('afterMethod:GET', [$this, 'httpAfterGet']);
-
-        $server->xml->namespaceMap[self::NS_CARDDAV] = 'card';
-
-        $server->xml->elementMap['{'.self::NS_CARDDAV.'}addressbook-query'] = 'Sabre\\CardDAV\\Xml\\Request\\AddressBookQueryReport';
-        $server->xml->elementMap['{'.self::NS_CARDDAV.'}addressbook-multiget'] = 'Sabre\\CardDAV\\Xml\\Request\\AddressBookMultiGetReport';
-
-        /* Mapping Interfaces to {DAV:}resourcetype values */
-        $server->resourceTypeMapping['Sabre\\CardDAV\\IAddressBook'] = '{'.self::NS_CARDDAV.'}addressbook';
-        $server->resourceTypeMapping['Sabre\\CardDAV\\IDirectory'] = '{'.self::NS_CARDDAV.'}directory';
-
-        /* Adding properties that may never be changed */
-        $server->protectedProperties[] = '{'.self::NS_CARDDAV.'}supported-address-data';
-        $server->protectedProperties[] = '{'.self::NS_CARDDAV.'}max-resource-size';
-        $server->protectedProperties[] = '{'.self::NS_CARDDAV.'}addressbook-home-set';
-        $server->protectedProperties[] = '{'.self::NS_CARDDAV.'}supported-collation-set';
-
-        $server->xml->elementMap['{http://calendarserver.org/ns/}me-card'] = 'Sabre\\DAV\\Xml\\Property\\Href';
-
-        $this->server = $server;
-    }
-
-    /**
-     * Returns a list of supported features.
-     *
-     * This is used in the DAV: header in the OPTIONS and PROPFIND requests.
-     *
-     * @return array
-     */
-    public function getFeatures()
-    {
-        return ['addressbook'];
-    }
-
-    /**
-     * Returns a list of reports this plugin supports.
-     *
-     * This will be used in the {DAV:}supported-report-set property.
-     * Note that you still need to subscribe to the 'report' event to actually
-     * implement them
-     *
-     * @param string $uri
-     *
-     * @return array
-     */
-    public function getSupportedReportSet($uri)
-    {
-        $node = $this->server->tree->getNodeForPath($uri);
-        if ($node instanceof IAddressBook || $node instanceof ICard) {
-            return [
-                 '{'.self::NS_CARDDAV.'}addressbook-multiget',
-                 '{'.self::NS_CARDDAV.'}addressbook-query',
-            ];
-        }
-
-        return [];
-    }
-
-    /**
-     * Adds all CardDAV-specific properties.
-     */
-    public function propFindEarly(DAV\PropFind $propFind, DAV\INode $node)
-    {
-        $ns = '{'.self::NS_CARDDAV.'}';
-
-        if ($node instanceof IAddressBook) {
-            $propFind->handle($ns.'max-resource-size', $this->maxResourceSize);
-            $propFind->handle($ns.'supported-address-data', function () {
-                return new Xml\Property\SupportedAddressData();
-            });
-            $propFind->handle($ns.'supported-collation-set', function () {
-                return new Xml\Property\SupportedCollationSet();
-            });
-        }
-        if ($node instanceof DAVACL\IPrincipal) {
-            $path = $propFind->getPath();
-
-            $propFind->handle('{'.self::NS_CARDDAV.'}addressbook-home-set', function () use ($path) {
-                return new LocalHref($this->getAddressBookHomeForPrincipal($path).'/');
-            });
-
-            if ($this->directories) {
-                $propFind->handle('{'.self::NS_CARDDAV.'}directory-gateway', function () {
-                    return new LocalHref($this->directories);
-                });
-            }
-        }
-
-        if ($node instanceof ICard) {
-            // The address-data property is not supposed to be a 'real'
-            // property, but in large chunks of the spec it does act as such.
-            // Therefore we simply expose it as a property.
-            $propFind->handle('{'.self::NS_CARDDAV.'}address-data', function () use ($node) {
-                $val = $node->get();
-                if (is_resource($val)) {
-                    $val = stream_get_contents($val);
-                }
-
-                return $val;
-            });
-        }
-    }
-
-    /**
-     * This functions handles REPORT requests specific to CardDAV.
-     *
-     * @param string   $reportName
-     * @param \DOMNode $dom
-     * @param mixed    $path
-     *
-     * @return bool
-     */
-    public function report($reportName, $dom, $path)
-    {
-        switch ($reportName) {
-            case '{'.self::NS_CARDDAV.'}addressbook-multiget':
-                $this->server->transactionType = 'report-addressbook-multiget';
-                $this->addressbookMultiGetReport($dom);
-
-                return false;
-            case '{'.self::NS_CARDDAV.'}addressbook-query':
-                $this->server->transactionType = 'report-addressbook-query';
-                $this->addressBookQueryReport($dom);
-
-                return false;
-            default:
-                return;
-        }
-    }
-
-    /**
-     * Returns the addressbook home for a given principal.
-     *
-     * @param string $principal
-     *
-     * @return string
-     */
-    protected function getAddressbookHomeForPrincipal($principal)
-    {
-        list(, $principalId) = Uri\split($principal);
-
-        return self::ADDRESSBOOK_ROOT.'/'.$principalId;
-    }
-
-    /**
-     * This function handles the addressbook-multiget REPORT.
-     *
-     * This report is used by the client to fetch the content of a series
-     * of urls. Effectively avoiding a lot of redundant requests.
-     *
-     * @param Xml\Request\AddressBookMultiGetReport $report
-     */
-    public function addressbookMultiGetReport($report)
-    {
-        $contentType = $report->contentType;
-        $version = $report->version;
-        if ($version) {
-            $contentType .= '; version='.$version;
-        }
-
-        $vcardType = $this->negotiateVCard(
-            $contentType
-        );
-
-        $propertyList = [];
-        $paths = array_map(
-            [$this->server, 'calculateUri'],
-            $report->hrefs
-        );
-        foreach ($this->server->getPropertiesForMultiplePaths($paths, $report->properties) as $props) {
-            if (isset($props['200']['{'.self::NS_CARDDAV.'}address-data'])) {
-                $props['200']['{'.self::NS_CARDDAV.'}address-data'] = $this->convertVCard(
-                    $props[200]['{'.self::NS_CARDDAV.'}address-data'],
-                    $vcardType
-                );
-            }
-            $propertyList[] = $props;
-        }
-
-        $prefer = $this->server->getHTTPPrefer();
-
-        $this->server->httpResponse->setStatus(207);
-        $this->server->httpResponse->setHeader('Content-Type', 'application/xml; charset=utf-8');
-        $this->server->httpResponse->setHeader('Vary', 'Brief,Prefer');
-        $this->server->httpResponse->setBody($this->server->generateMultiStatus($propertyList, 'minimal' === $prefer['return']));
-    }
-
-    /**
-     * This method is triggered before a file gets updated with new content.
-     *
-     * This plugin uses this method to ensure that Card nodes receive valid
-     * vcard data.
-     *
-     * @param string   $path
-     * @param resource $data
-     * @param bool     $modified should be set to true, if this event handler
-     *                           changed &$data
-     */
-    public function beforeWriteContent($path, DAV\IFile $node, &$data, &$modified)
-    {
-        if (!$node instanceof ICard) {
-            return;
-        }
-
-        $this->validateVCard($data, $modified);
-    }
-
-    /**
-     * This method is triggered before a new file is created.
-     *
-     * This plugin uses this method to ensure that Card nodes receive valid
-     * vcard data.
-     *
-     * @param string   $path
-     * @param resource $data
-     * @param bool     $modified should be set to true, if this event handler
-     *                           changed &$data
-     */
-    public function beforeCreateFile($path, &$data, DAV\ICollection $parentNode, &$modified)
-    {
-        if (!$parentNode instanceof IAddressBook) {
-            return;
-        }
-
-        $this->validateVCard($data, $modified);
-    }
-
-    /**
-     * Checks if the submitted iCalendar data is in fact, valid.
-     *
-     * An exception is thrown if it's not.
-     *
-     * @param resource|string $data
-     * @param bool            $modified should be set to true, if this event handler
-     *                                  changed &$data
-     */
-    protected function validateVCard(&$data, &$modified)
-    {
-        // If it's a stream, we convert it to a string first.
-        if (is_resource($data)) {
-            $data = stream_get_contents($data);
-        }
-
-        $before = $data;
-
-        try {
-            // If the data starts with a [, we can reasonably assume we're dealing
-            // with a jCal object.
-            if ('[' === substr($data, 0, 1)) {
-                $vobj = VObject\Reader::readJson($data);
-
-                // Converting $data back to iCalendar, as that's what we
-                // technically support everywhere.
-                $data = $vobj->serialize();
-                $modified = true;
-            } else {
-                $vobj = VObject\Reader::read($data);
-            }
-        } catch (VObject\ParseException $e) {
-            throw new DAV\Exception\UnsupportedMediaType('This resource only supports valid vCard or jCard data. Parse error: '.$e->getMessage());
-        }
-
-        if ('VCARD' !== $vobj->name) {
-            throw new DAV\Exception\UnsupportedMediaType('This collection can only support vcard objects.');
-        }
-
-        $options = VObject\Node::PROFILE_CARDDAV;
-        $prefer = $this->server->getHTTPPrefer();
-
-        if ('strict' !== $prefer['handling']) {
-            $options |= VObject\Node::REPAIR;
-        }
-
-        $messages = $vobj->validate($options);
-
-        $highestLevel = 0;
-        $warningMessage = null;
-
-        // $messages contains a list of problems with the vcard, along with
-        // their severity.
-        foreach ($messages as $message) {
-            if ($message['level'] > $highestLevel) {
-                // Recording the highest reported error level.
-                $highestLevel = $message['level'];
-                $warningMessage = $message['message'];
-            }
-
-            switch ($message['level']) {
-                case 1:
-                    // Level 1 means that there was a problem, but it was repaired.
-                    $modified = true;
-                    break;
-                case 2:
-                    // Level 2 means a warning, but not critical
-                    break;
-                case 3:
-                    // Level 3 means a critical error
-                    throw new DAV\Exception\UnsupportedMediaType('Validation error in vCard: '.$message['message']);
-            }
-        }
-        if ($warningMessage) {
-            $this->server->httpResponse->setHeader(
-                'X-Sabre-Ew-Gross',
-                'vCard validation warning: '.$warningMessage
-            );
-
-            // Re-serializing object.
-            $data = $vobj->serialize();
-            if (!$modified && 0 !== strcmp($data, $before)) {
-                // This ensures that the system does not send an ETag back.
-                $modified = true;
-            }
-        }
-
-        // Destroy circular references to PHP will GC the object.
-        $vobj->destroy();
-    }
-
-    /**
-     * This function handles the addressbook-query REPORT.
-     *
-     * This report is used by the client to filter an addressbook based on a
-     * complex query.
-     *
-     * @param Xml\Request\AddressBookQueryReport $report
-     */
-    protected function addressbookQueryReport($report)
-    {
-        $depth = $this->server->getHTTPDepth(0);
-
-        if (0 == $depth) {
-            $candidateNodes = [
-                $this->server->tree->getNodeForPath($this->server->getRequestUri()),
-            ];
-            if (!$candidateNodes[0] instanceof ICard) {
-                throw new ReportNotSupported('The addressbook-query report is not supported on this url with Depth: 0');
-            }
-        } else {
-            $candidateNodes = $this->server->tree->getChildren($this->server->getRequestUri());
-        }
-
-        $contentType = $report->contentType;
-        if ($report->version) {
-            $contentType .= '; version='.$report->version;
-        }
-
-        $vcardType = $this->negotiateVCard(
-            $contentType
-        );
-
-        $validNodes = [];
-        foreach ($candidateNodes as $node) {
-            if (!$node instanceof ICard) {
-                continue;
-            }
-
-            $blob = $node->get();
-            if (is_resource($blob)) {
-                $blob = stream_get_contents($blob);
-            }
-
-            if (!$this->validateFilters($blob, $report->filters, $report->test)) {
-                continue;
-            }
-
-            $validNodes[] = $node;
-
-            if ($report->limit && $report->limit <= count($validNodes)) {
-                // We hit the maximum number of items, we can stop now.
-                break;
-            }
-        }
-
-        $result = [];
-        foreach ($validNodes as $validNode) {
-            if (0 == $depth) {
-                $href = $this->server->getRequestUri();
-            } else {
-                $href = $this->server->getRequestUri().'/'.$validNode->getName();
-            }
-
-            list($props) = $this->server->getPropertiesForPath($href, $report->properties, 0);
-
-            if (isset($props[200]['{'.self::NS_CARDDAV.'}address-data'])) {
-                $props[200]['{'.self::NS_CARDDAV.'}address-data'] = $this->convertVCard(
-                    $props[200]['{'.self::NS_CARDDAV.'}address-data'],
-                    $vcardType,
-                    $report->addressDataProperties
-                );
-            }
-            $result[] = $props;
-        }
-
-        $prefer = $this->server->getHTTPPrefer();
-
-        $this->server->httpResponse->setStatus(207);
-        $this->server->httpResponse->setHeader('Content-Type', 'application/xml; charset=utf-8');
-        $this->server->httpResponse->setHeader('Vary', 'Brief,Prefer');
-        $this->server->httpResponse->setBody($this->server->generateMultiStatus($result, 'minimal' === $prefer['return']));
-    }
-
-    /**
-     * Validates if a vcard makes it throught a list of filters.
-     *
-     * @param string $vcardData
-     * @param string $test      anyof or allof (which means OR or AND)
-     *
-     * @return bool
-     */
-    public function validateFilters($vcardData, array $filters, $test)
-    {
-        if (!$filters) {
-            return true;
-        }
-        $vcard = VObject\Reader::read($vcardData);
-
-        foreach ($filters as $filter) {
-            $isDefined = isset($vcard->{$filter['name']});
-            if ($filter['is-not-defined']) {
-                if ($isDefined) {
-                    $success = false;
-                } else {
-                    $success = true;
-                }
-            } elseif ((!$filter['param-filters'] && !$filter['text-matches']) || !$isDefined) {
-                // We only need to check for existence
-                $success = $isDefined;
-            } else {
-                $vProperties = $vcard->select($filter['name']);
-
-                $results = [];
-                if ($filter['param-filters']) {
-                    $results[] = $this->validateParamFilters($vProperties, $filter['param-filters'], $filter['test']);
-                }
-                if ($filter['text-matches']) {
-                    $texts = [];
-                    foreach ($vProperties as $vProperty) {
-                        $texts[] = $vProperty->getValue();
-                    }
-
-                    $results[] = $this->validateTextMatches($texts, $filter['text-matches'], $filter['test']);
-                }
-
-                if (1 === count($results)) {
-                    $success = $results[0];
-                } else {
-                    if ('anyof' === $filter['test']) {
-                        $success = $results[0] || $results[1];
-                    } else {
-                        $success = $results[0] && $results[1];
-                    }
-                }
-            } // else
-
-            // There are two conditions where we can already determine whether
-            // or not this filter succeeds.
-            if ('anyof' === $test && $success) {
-                // Destroy circular references to PHP will GC the object.
-                $vcard->destroy();
-
-                return true;
-            }
-            if ('allof' === $test && !$success) {
-                // Destroy circular references to PHP will GC the object.
-                $vcard->destroy();
-
-                return false;
-            }
-        } // foreach
-
-        // Destroy circular references to PHP will GC the object.
-        $vcard->destroy();
-
-        // If we got all the way here, it means we haven't been able to
-        // determine early if the test failed or not.
-        //
-        // This implies for 'anyof' that the test failed, and for 'allof' that
-        // we succeeded. Sounds weird, but makes sense.
-        return 'allof' === $test;
-    }
-
-    /**
-     * Validates if a param-filter can be applied to a specific property.
-     *
-     * @todo currently we're only validating the first parameter of the passed
-     *       property. Any subsequence parameters with the same name are
-     *       ignored.
-     *
-     * @param string $test
-     *
-     * @return bool
-     */
-    protected function validateParamFilters(array $vProperties, array $filters, $test)
-    {
-        foreach ($filters as $filter) {
-            $isDefined = false;
-            foreach ($vProperties as $vProperty) {
-                $isDefined = isset($vProperty[$filter['name']]);
-                if ($isDefined) {
-                    break;
-                }
-            }
-
-            if ($filter['is-not-defined']) {
-                if ($isDefined) {
-                    $success = false;
-                } else {
-                    $success = true;
-                }
-
-                // If there's no text-match, we can just check for existence
-            } elseif (!$filter['text-match'] || !$isDefined) {
-                $success = $isDefined;
-            } else {
-                $success = false;
-                foreach ($vProperties as $vProperty) {
-                    // If we got all the way here, we'll need to validate the
-                    // text-match filter.
-                    if (isset($vProperty[$filter['name']])) {
-                        $success = DAV\StringUtil::textMatch(
-                            $vProperty[$filter['name']]->getValue(),
-                            $filter['text-match']['value'],
-                            $filter['text-match']['collation'],
-                            $filter['text-match']['match-type']
-                        );
-                        if ($filter['text-match']['negate-condition']) {
-                            $success = !$success;
-                        }
-                    }
-                    if ($success) {
-                        break;
-                    }
-                }
-            } // else
-
-            // There are two conditions where we can already determine whether
-            // or not this filter succeeds.
-            if ('anyof' === $test && $success) {
-                return true;
-            }
-            if ('allof' === $test && !$success) {
-                return false;
-            }
-        }
-
-        // If we got all the way here, it means we haven't been able to
-        // determine early if the test failed or not.
-        //
-        // This implies for 'anyof' that the test failed, and for 'allof' that
-        // we succeeded. Sounds weird, but makes sense.
-        return 'allof' === $test;
-    }
-
-    /**
-     * Validates if a text-filter can be applied to a specific property.
-     *
-     * @param string $test
-     *
-     * @return bool
-     */
-    protected function validateTextMatches(array $texts, array $filters, $test)
-    {
-        foreach ($filters as $filter) {
-            $success = false;
-            foreach ($texts as $haystack) {
-                $success = DAV\StringUtil::textMatch($haystack, $filter['value'], $filter['collation'], $filter['match-type']);
-                if ($filter['negate-condition']) {
-                    $success = !$success;
-                }
-
-                // Breaking on the first match
-                if ($success) {
-                    break;
-                }
-            }
-
-            if ($success && 'anyof' === $test) {
-                return true;
-            }
-
-            if (!$success && 'allof' == $test) {
-                return false;
-            }
-        }
-
-        // If we got all the way here, it means we haven't been able to
-        // determine early if the test failed or not.
-        //
-        // This implies for 'anyof' that the test failed, and for 'allof' that
-        // we succeeded. Sounds weird, but makes sense.
-        return 'allof' === $test;
-    }
-
-    /**
-     * This event is triggered when fetching properties.
-     *
-     * This event is scheduled late in the process, after most work for
-     * propfind has been done.
-     */
-    public function propFindLate(DAV\PropFind $propFind, DAV\INode $node)
-    {
-        // If the request was made using the SOGO connector, we must rewrite
-        // the content-type property. By default SabreDAV will send back
-        // text/x-vcard; charset=utf-8, but for SOGO we must strip that last
-        // part.
-        if (false === strpos((string) $this->server->httpRequest->getHeader('User-Agent'), 'Thunderbird')) {
-            return;
-        }
-        $contentType = $propFind->get('{DAV:}getcontenttype');
-        if (null !== $contentType) {
-            list($part) = explode(';', $contentType);
-            if ('text/x-vcard' === $part || 'text/vcard' === $part) {
-                $propFind->set('{DAV:}getcontenttype', 'text/x-vcard');
-            }
-        }
-    }
-
-    /**
-     * This method is used to generate HTML output for the
-     * Sabre\DAV\Browser\Plugin. This allows us to generate an interface users
-     * can use to create new addressbooks.
-     *
-     * @param string $output
-     *
-     * @return bool
-     */
-    public function htmlActionsPanel(DAV\INode $node, &$output)
-    {
-        if (!$node instanceof AddressBookHome) {
-            return;
-        }
-
-        $output .= '<tr><td colspan="2"><form method="post" action="">
+	/**
+	 * Url to the addressbooks.
+	 */
+	const ADDRESSBOOK_ROOT = 'addressbooks';
+
+	/**
+	 * xml namespace for CardDAV elements.
+	 */
+	const NS_CARDDAV = 'urn:ietf:params:xml:ns:carddav';
+
+	/**
+	 * Add urls to this property to have them automatically exposed as
+	 * 'directories' to the user.
+	 *
+	 * @var array
+	 */
+	public $directories = [];
+
+	/**
+	 * Server class.
+	 *
+	 * @var DAV\Server
+	 */
+	protected $server;
+
+	/**
+	 * The default PDO storage uses a MySQL MEDIUMBLOB for iCalendar data,
+	 * which can hold up to 2^24 = 16777216 bytes. This is plenty. We're
+	 * capping it to 10M here.
+	 */
+	protected $maxResourceSize = 10000000;
+
+	/**
+	 * Initializes the plugin.
+	 */
+	public function initialize(DAV\Server $server)
+	{
+		/* Events */
+		$server->on('propFind', [$this, 'propFindEarly']);
+		$server->on('propFind', [$this, 'propFindLate'], 150);
+		$server->on('report', [$this, 'report']);
+		$server->on('onHTMLActionsPanel', [$this, 'htmlActionsPanel']);
+		$server->on('beforeWriteContent', [$this, 'beforeWriteContent']);
+		$server->on('beforeCreateFile', [$this, 'beforeCreateFile']);
+		$server->on('afterMethod:GET', [$this, 'httpAfterGet']);
+
+		$server->xml->namespaceMap[self::NS_CARDDAV] = 'card';
+
+		$server->xml->elementMap['{'.self::NS_CARDDAV.'}addressbook-query'] = 'Sabre\\CardDAV\\Xml\\Request\\AddressBookQueryReport';
+		$server->xml->elementMap['{'.self::NS_CARDDAV.'}addressbook-multiget'] = 'Sabre\\CardDAV\\Xml\\Request\\AddressBookMultiGetReport';
+
+		/* Mapping Interfaces to {DAV:}resourcetype values */
+		$server->resourceTypeMapping['Sabre\\CardDAV\\IAddressBook'] = '{'.self::NS_CARDDAV.'}addressbook';
+		$server->resourceTypeMapping['Sabre\\CardDAV\\IDirectory'] = '{'.self::NS_CARDDAV.'}directory';
+
+		/* Adding properties that may never be changed */
+		$server->protectedProperties[] = '{'.self::NS_CARDDAV.'}supported-address-data';
+		$server->protectedProperties[] = '{'.self::NS_CARDDAV.'}max-resource-size';
+		$server->protectedProperties[] = '{'.self::NS_CARDDAV.'}addressbook-home-set';
+		$server->protectedProperties[] = '{'.self::NS_CARDDAV.'}supported-collation-set';
+
+		$server->xml->elementMap['{http://calendarserver.org/ns/}me-card'] = 'Sabre\\DAV\\Xml\\Property\\Href';
+
+		$this->server = $server;
+	}
+
+	/**
+	 * Returns a list of supported features.
+	 *
+	 * This is used in the DAV: header in the OPTIONS and PROPFIND requests.
+	 *
+	 * @return array
+	 */
+	public function getFeatures()
+	{
+		return ['addressbook'];
+	}
+
+	/**
+	 * Returns a list of reports this plugin supports.
+	 *
+	 * This will be used in the {DAV:}supported-report-set property.
+	 * Note that you still need to subscribe to the 'report' event to actually
+	 * implement them
+	 *
+	 * @param string $uri
+	 *
+	 * @return array
+	 */
+	public function getSupportedReportSet($uri)
+	{
+		$node = $this->server->tree->getNodeForPath($uri);
+		if ($node instanceof IAddressBook || $node instanceof ICard) {
+			return [
+				 '{'.self::NS_CARDDAV.'}addressbook-multiget',
+				 '{'.self::NS_CARDDAV.'}addressbook-query',
+			];
+		}
+
+		return [];
+	}
+
+	/**
+	 * Adds all CardDAV-specific properties.
+	 */
+	public function propFindEarly(DAV\PropFind $propFind, DAV\INode $node)
+	{
+		$ns = '{'.self::NS_CARDDAV.'}';
+
+		if ($node instanceof IAddressBook) {
+			$propFind->handle($ns.'max-resource-size', $this->maxResourceSize);
+			$propFind->handle($ns.'supported-address-data', function () {
+				return new Xml\Property\SupportedAddressData();
+			});
+			$propFind->handle($ns.'supported-collation-set', function () {
+				return new Xml\Property\SupportedCollationSet();
+			});
+		}
+		if ($node instanceof DAVACL\IPrincipal) {
+			$path = $propFind->getPath();
+
+			$propFind->handle('{'.self::NS_CARDDAV.'}addressbook-home-set', function () use ($path) {
+				return new LocalHref($this->getAddressBookHomeForPrincipal($path).'/');
+			});
+
+			if ($this->directories) {
+				$propFind->handle('{'.self::NS_CARDDAV.'}directory-gateway', function () {
+					return new LocalHref($this->directories);
+				});
+			}
+		}
+
+		if ($node instanceof ICard) {
+			// The address-data property is not supposed to be a 'real'
+			// property, but in large chunks of the spec it does act as such.
+			// Therefore we simply expose it as a property.
+			$propFind->handle('{'.self::NS_CARDDAV.'}address-data', function () use ($node) {
+				$val = $node->get();
+				if (is_resource($val)) {
+					$val = stream_get_contents($val);
+				}
+
+				return $val;
+			});
+		}
+	}
+
+	/**
+	 * This functions handles REPORT requests specific to CardDAV.
+	 *
+	 * @param string   $reportName
+	 * @param \DOMNode $dom
+	 * @param mixed    $path
+	 *
+	 * @return bool
+	 */
+	public function report($reportName, $dom, $path)
+	{
+		switch ($reportName) {
+			case '{'.self::NS_CARDDAV.'}addressbook-multiget':
+				$this->server->transactionType = 'report-addressbook-multiget';
+				$this->addressbookMultiGetReport($dom);
+
+				return false;
+			case '{'.self::NS_CARDDAV.'}addressbook-query':
+				$this->server->transactionType = 'report-addressbook-query';
+				$this->addressBookQueryReport($dom);
+
+				return false;
+			default:
+				return;
+		}
+	}
+
+	/**
+	 * Returns the addressbook home for a given principal.
+	 *
+	 * @param string $principal
+	 *
+	 * @return string
+	 */
+	protected function getAddressbookHomeForPrincipal($principal)
+	{
+		list(, $principalId) = Uri\split($principal);
+
+		return self::ADDRESSBOOK_ROOT.'/'.$principalId;
+	}
+
+	/**
+	 * This function handles the addressbook-multiget REPORT.
+	 *
+	 * This report is used by the client to fetch the content of a series
+	 * of urls. Effectively avoiding a lot of redundant requests.
+	 *
+	 * @param Xml\Request\AddressBookMultiGetReport $report
+	 */
+	public function addressbookMultiGetReport($report)
+	{
+		$contentType = $report->contentType;
+		$version = $report->version;
+		if ($version) {
+			$contentType .= '; version='.$version;
+		}
+
+		$vcardType = $this->negotiateVCard(
+			$contentType
+		);
+
+		$propertyList = [];
+		$paths = array_map(
+			[$this->server, 'calculateUri'],
+			$report->hrefs
+		);
+		foreach ($this->server->getPropertiesForMultiplePaths($paths, $report->properties) as $props) {
+			if (isset($props['200']['{'.self::NS_CARDDAV.'}address-data'])) {
+				$props['200']['{'.self::NS_CARDDAV.'}address-data'] = $this->convertVCard(
+					$props[200]['{'.self::NS_CARDDAV.'}address-data'],
+					$vcardType
+				);
+			}
+			$propertyList[] = $props;
+		}
+
+		$prefer = $this->server->getHTTPPrefer();
+
+		$this->server->httpResponse->setStatus(207);
+		$this->server->httpResponse->setHeader('Content-Type', 'application/xml; charset=utf-8');
+		$this->server->httpResponse->setHeader('Vary', 'Brief,Prefer');
+		$this->server->httpResponse->setBody($this->server->generateMultiStatus($propertyList, 'minimal' === $prefer['return']));
+	}
+
+	/**
+	 * This method is triggered before a file gets updated with new content.
+	 *
+	 * This plugin uses this method to ensure that Card nodes receive valid
+	 * vcard data.
+	 *
+	 * @param string   $path
+	 * @param resource $data
+	 * @param bool     $modified should be set to true, if this event handler
+	 *                           changed &$data
+	 */
+	public function beforeWriteContent($path, DAV\IFile $node, &$data, &$modified)
+	{
+		if (!$node instanceof ICard) {
+			return;
+		}
+
+		$this->validateVCard($data, $modified);
+	}
+
+	/**
+	 * This method is triggered before a new file is created.
+	 *
+	 * This plugin uses this method to ensure that Card nodes receive valid
+	 * vcard data.
+	 *
+	 * @param string   $path
+	 * @param resource $data
+	 * @param bool     $modified should be set to true, if this event handler
+	 *                           changed &$data
+	 */
+	public function beforeCreateFile($path, &$data, DAV\ICollection $parentNode, &$modified)
+	{
+		if (!$parentNode instanceof IAddressBook) {
+			return;
+		}
+
+		$this->validateVCard($data, $modified);
+	}
+
+	/**
+	 * Checks if the submitted iCalendar data is in fact, valid.
+	 *
+	 * An exception is thrown if it's not.
+	 *
+	 * @param resource|string $data
+	 * @param bool            $modified should be set to true, if this event handler
+	 *                                  changed &$data
+	 */
+	protected function validateVCard(&$data, &$modified)
+	{
+		// If it's a stream, we convert it to a string first.
+		if (is_resource($data)) {
+			$data = stream_get_contents($data);
+		}
+
+		$before = $data;
+
+		try {
+			// If the data starts with a [, we can reasonably assume we're dealing
+			// with a jCal object.
+			if ('[' === substr($data, 0, 1)) {
+				$vobj = VObject\Reader::readJson($data);
+
+				// Converting $data back to iCalendar, as that's what we
+				// technically support everywhere.
+				$data = $vobj->serialize();
+				$modified = true;
+			} else {
+				$vobj = VObject\Reader::read($data);
+			}
+		} catch (VObject\ParseException $e) {
+			throw new DAV\Exception\UnsupportedMediaType('This resource only supports valid vCard or jCard data. Parse error: '.$e->getMessage());
+		}
+
+		if ('VCARD' !== $vobj->name) {
+			throw new DAV\Exception\UnsupportedMediaType('This collection can only support vcard objects.');
+		}
+
+		$options = VObject\Node::PROFILE_CARDDAV;
+		$prefer = $this->server->getHTTPPrefer();
+
+		if ('strict' !== $prefer['handling']) {
+			$options |= VObject\Node::REPAIR;
+		}
+
+		$messages = $vobj->validate($options);
+
+		$highestLevel = 0;
+		$warningMessage = null;
+
+		// $messages contains a list of problems with the vcard, along with
+		// their severity.
+		foreach ($messages as $message) {
+			if ($message['level'] > $highestLevel) {
+				// Recording the highest reported error level.
+				$highestLevel = $message['level'];
+				$warningMessage = $message['message'];
+			}
+
+			switch ($message['level']) {
+				case 1:
+					// Level 1 means that there was a problem, but it was repaired.
+					$modified = true;
+					break;
+				case 2:
+					// Level 2 means a warning, but not critical
+					break;
+				case 3:
+					// Level 3 means a critical error
+					throw new DAV\Exception\UnsupportedMediaType('Validation error in vCard: '.$message['message']);
+			}
+		}
+		if ($warningMessage) {
+			$this->server->httpResponse->setHeader(
+				'X-Sabre-Ew-Gross',
+				'vCard validation warning: '.$warningMessage
+			);
+
+			// Re-serializing object.
+			$data = $vobj->serialize();
+			if (!$modified && 0 !== strcmp($data, $before)) {
+				// This ensures that the system does not send an ETag back.
+				$modified = true;
+			}
+		}
+
+		// Destroy circular references to PHP will GC the object.
+		$vobj->destroy();
+	}
+
+	/**
+	 * This function handles the addressbook-query REPORT.
+	 *
+	 * This report is used by the client to filter an addressbook based on a
+	 * complex query.
+	 *
+	 * @param Xml\Request\AddressBookQueryReport $report
+	 */
+	protected function addressbookQueryReport($report)
+	{
+		$depth = $this->server->getHTTPDepth(0);
+
+		if (0 == $depth) {
+			$candidateNodes = [
+				$this->server->tree->getNodeForPath($this->server->getRequestUri()),
+			];
+			if (!$candidateNodes[0] instanceof ICard) {
+				throw new ReportNotSupported('The addressbook-query report is not supported on this url with Depth: 0');
+			}
+		} else {
+			$candidateNodes = $this->server->tree->getChildren($this->server->getRequestUri());
+		}
+
+		$contentType = $report->contentType;
+		if ($report->version) {
+			$contentType .= '; version='.$report->version;
+		}
+
+		$vcardType = $this->negotiateVCard(
+			$contentType
+		);
+
+		$validNodes = [];
+		foreach ($candidateNodes as $node) {
+			if (!$node instanceof ICard) {
+				continue;
+			}
+
+			$blob = $node->get();
+			if (is_resource($blob)) {
+				$blob = stream_get_contents($blob);
+			}
+
+			if (!$this->validateFilters($blob, $report->filters, $report->test)) {
+				continue;
+			}
+
+			$validNodes[] = $node;
+
+			if ($report->limit && $report->limit <= count($validNodes)) {
+				// We hit the maximum number of items, we can stop now.
+				break;
+			}
+		}
+
+		$result = [];
+		foreach ($validNodes as $validNode) {
+			if (0 == $depth) {
+				$href = $this->server->getRequestUri();
+			} else {
+				$href = $this->server->getRequestUri().'/'.$validNode->getName();
+			}
+
+			list($props) = $this->server->getPropertiesForPath($href, $report->properties, 0);
+
+			if (isset($props[200]['{'.self::NS_CARDDAV.'}address-data'])) {
+				$props[200]['{'.self::NS_CARDDAV.'}address-data'] = $this->convertVCard(
+					$props[200]['{'.self::NS_CARDDAV.'}address-data'],
+					$vcardType,
+					$report->addressDataProperties
+				);
+			}
+			$result[] = $props;
+		}
+
+		$prefer = $this->server->getHTTPPrefer();
+
+		$this->server->httpResponse->setStatus(207);
+		$this->server->httpResponse->setHeader('Content-Type', 'application/xml; charset=utf-8');
+		$this->server->httpResponse->setHeader('Vary', 'Brief,Prefer');
+		$this->server->httpResponse->setBody($this->server->generateMultiStatus($result, 'minimal' === $prefer['return']));
+	}
+
+	/**
+	 * Validates if a vcard makes it throught a list of filters.
+	 *
+	 * @param string $vcardData
+	 * @param string $test      anyof or allof (which means OR or AND)
+	 *
+	 * @return bool
+	 */
+	public function validateFilters($vcardData, array $filters, $test)
+	{
+		if (!$filters) {
+			return true;
+		}
+		$vcard = VObject\Reader::read($vcardData);
+
+		foreach ($filters as $filter) {
+			$isDefined = isset($vcard->{$filter['name']});
+			if ($filter['is-not-defined']) {
+				if ($isDefined) {
+					$success = false;
+				} else {
+					$success = true;
+				}
+			} elseif ((!$filter['param-filters'] && !$filter['text-matches']) || !$isDefined) {
+				// We only need to check for existence
+				$success = $isDefined;
+			} else {
+				$vProperties = $vcard->select($filter['name']);
+
+				$results = [];
+				if ($filter['param-filters']) {
+					$results[] = $this->validateParamFilters($vProperties, $filter['param-filters'], $filter['test']);
+				}
+				if ($filter['text-matches']) {
+					$texts = [];
+					foreach ($vProperties as $vProperty) {
+						$texts[] = $vProperty->getValue();
+					}
+
+					$results[] = $this->validateTextMatches($texts, $filter['text-matches'], $filter['test']);
+				}
+
+				if (1 === count($results)) {
+					$success = $results[0];
+				} else {
+					if ('anyof' === $filter['test']) {
+						$success = $results[0] || $results[1];
+					} else {
+						$success = $results[0] && $results[1];
+					}
+				}
+			} // else
+
+			// There are two conditions where we can already determine whether
+			// or not this filter succeeds.
+			if ('anyof' === $test && $success) {
+				// Destroy circular references to PHP will GC the object.
+				$vcard->destroy();
+
+				return true;
+			}
+			if ('allof' === $test && !$success) {
+				// Destroy circular references to PHP will GC the object.
+				$vcard->destroy();
+
+				return false;
+			}
+		} // foreach
+
+		// Destroy circular references to PHP will GC the object.
+		$vcard->destroy();
+
+		// If we got all the way here, it means we haven't been able to
+		// determine early if the test failed or not.
+		//
+		// This implies for 'anyof' that the test failed, and for 'allof' that
+		// we succeeded. Sounds weird, but makes sense.
+		return 'allof' === $test;
+	}
+
+	/**
+	 * Validates if a param-filter can be applied to a specific property.
+	 *
+	 * @todo currently we're only validating the first parameter of the passed
+	 *       property. Any subsequence parameters with the same name are
+	 *       ignored.
+	 *
+	 * @param string $test
+	 *
+	 * @return bool
+	 */
+	protected function validateParamFilters(array $vProperties, array $filters, $test)
+	{
+		foreach ($filters as $filter) {
+			$isDefined = false;
+			foreach ($vProperties as $vProperty) {
+				$isDefined = isset($vProperty[$filter['name']]);
+				if ($isDefined) {
+					break;
+				}
+			}
+
+			if ($filter['is-not-defined']) {
+				if ($isDefined) {
+					$success = false;
+				} else {
+					$success = true;
+				}
+
+				// If there's no text-match, we can just check for existence
+			} elseif (!$filter['text-match'] || !$isDefined) {
+				$success = $isDefined;
+			} else {
+				$success = false;
+				foreach ($vProperties as $vProperty) {
+					// If we got all the way here, we'll need to validate the
+					// text-match filter.
+					if (isset($vProperty[$filter['name']])) {
+						$success = DAV\StringUtil::textMatch(
+							$vProperty[$filter['name']]->getValue(),
+							$filter['text-match']['value'],
+							$filter['text-match']['collation'],
+							$filter['text-match']['match-type']
+						);
+						if ($filter['text-match']['negate-condition']) {
+							$success = !$success;
+						}
+					}
+					if ($success) {
+						break;
+					}
+				}
+			} // else
+
+			// There are two conditions where we can already determine whether
+			// or not this filter succeeds.
+			if ('anyof' === $test && $success) {
+				return true;
+			}
+			if ('allof' === $test && !$success) {
+				return false;
+			}
+		}
+
+		// If we got all the way here, it means we haven't been able to
+		// determine early if the test failed or not.
+		//
+		// This implies for 'anyof' that the test failed, and for 'allof' that
+		// we succeeded. Sounds weird, but makes sense.
+		return 'allof' === $test;
+	}
+
+	/**
+	 * Validates if a text-filter can be applied to a specific property.
+	 *
+	 * @param string $test
+	 *
+	 * @return bool
+	 */
+	protected function validateTextMatches(array $texts, array $filters, $test)
+	{
+		foreach ($filters as $filter) {
+			$success = false;
+			foreach ($texts as $haystack) {
+				$success = DAV\StringUtil::textMatch($haystack, $filter['value'], $filter['collation'], $filter['match-type']);
+				if ($filter['negate-condition']) {
+					$success = !$success;
+				}
+
+				// Breaking on the first match
+				if ($success) {
+					break;
+				}
+			}
+
+			if ($success && 'anyof' === $test) {
+				return true;
+			}
+
+			if (!$success && 'allof' == $test) {
+				return false;
+			}
+		}
+
+		// If we got all the way here, it means we haven't been able to
+		// determine early if the test failed or not.
+		//
+		// This implies for 'anyof' that the test failed, and for 'allof' that
+		// we succeeded. Sounds weird, but makes sense.
+		return 'allof' === $test;
+	}
+
+	/**
+	 * This event is triggered when fetching properties.
+	 *
+	 * This event is scheduled late in the process, after most work for
+	 * propfind has been done.
+	 */
+	public function propFindLate(DAV\PropFind $propFind, DAV\INode $node)
+	{
+		// If the request was made using the SOGO connector, we must rewrite
+		// the content-type property. By default SabreDAV will send back
+		// text/x-vcard; charset=utf-8, but for SOGO we must strip that last
+		// part.
+		if (false === strpos((string) $this->server->httpRequest->getHeader('User-Agent'), 'Thunderbird')) {
+			return;
+		}
+		$contentType = $propFind->get('{DAV:}getcontenttype');
+		if (null !== $contentType) {
+			list($part) = explode(';', $contentType);
+			if ('text/x-vcard' === $part || 'text/vcard' === $part) {
+				$propFind->set('{DAV:}getcontenttype', 'text/x-vcard');
+			}
+		}
+	}
+
+	/**
+	 * This method is used to generate HTML output for the
+	 * Sabre\DAV\Browser\Plugin. This allows us to generate an interface users
+	 * can use to create new addressbooks.
+	 *
+	 * @param string $output
+	 *
+	 * @return bool
+	 */
+	public function htmlActionsPanel(DAV\INode $node, &$output)
+	{
+		if (!$node instanceof AddressBookHome) {
+			return;
+		}
+
+		$output .= '<tr><td colspan="2"><form method="post" action="">
             <h3>Create new address book</h3>
             <input type="hidden" name="sabreAction" value="mkcol" />
             <input type="hidden" name="resourceType" value="{DAV:}collection,{'.self::NS_CARDDAV.'}addressbook" />
@@ -711,176 +711,176 @@ 
             </form>
             </td></tr>';
 
-        return false;
-    }
-
-    /**
-     * This event is triggered after GET requests.
-     *
-     * This is used to transform data into jCal, if this was requested.
-     */
-    public function httpAfterGet(RequestInterface $request, ResponseInterface $response)
-    {
-        $contentType = $response->getHeader('Content-Type');
-        if (null === $contentType || false === strpos($contentType, 'text/vcard')) {
-            return;
-        }
-
-        $target = $this->negotiateVCard($request->getHeader('Accept'), $mimeType);
-
-        $newBody = $this->convertVCard(
-            $response->getBody(),
-            $target
-        );
-
-        $response->setBody($newBody);
-        $response->setHeader('Content-Type', $mimeType.'; charset=utf-8');
-        $response->setHeader('Content-Length', strlen($newBody));
-    }
-
-    /**
-     * This helper function performs the content-type negotiation for vcards.
-     *
-     * It will return one of the following strings:
-     * 1. vcard3
-     * 2. vcard4
-     * 3. jcard
-     *
-     * It defaults to vcard3.
-     *
-     * @param string $input
-     * @param string $mimeType
-     *
-     * @return string
-     */
-    protected function negotiateVCard($input, &$mimeType = null)
-    {
-        $result = HTTP\negotiateContentType(
-            $input,
-            [
-                // Most often used mime-type. Version 3
-                'text/x-vcard',
-                // The correct standard mime-type. Defaults to version 3 as
-                // well.
-                'text/vcard',
-                // vCard 4
-                'text/vcard; version=4.0',
-                // vCard 3
-                'text/vcard; version=3.0',
-                // jCard
-                'application/vcard+json',
-            ]
-        );
-
-        $mimeType = $result;
-        switch ($result) {
-            default:
-            case 'text/x-vcard':
-            case 'text/vcard':
-            case 'text/vcard; version=3.0':
-                $mimeType = 'text/vcard';
-
-                return 'vcard3';
-            case 'text/vcard; version=4.0':
-                return 'vcard4';
-            case 'application/vcard+json':
-                return 'jcard';
-
-        // @codeCoverageIgnoreStart
-        }
-        // @codeCoverageIgnoreEnd
-    }
-
-    /**
-     * Converts a vcard blob to a different version, or jcard.
-     *
-     * @param string|resource $data
-     * @param string          $target
-     * @param array           $propertiesFilter
-     *
-     * @return string
-     */
-    protected function convertVCard($data, $target, array $propertiesFilter = null)
-    {
-        if (is_resource($data)) {
-            $data = stream_get_contents($data);
-        }
-        $input = VObject\Reader::read($data);
-        if (!empty($propertiesFilter)) {
-            $propertiesFilter = array_merge(['UID', 'VERSION', 'FN'], $propertiesFilter);
-            $keys = array_unique(array_map(function ($child) {
-                return $child->name;
-            }, $input->children()));
-            $keys = array_diff($keys, $propertiesFilter);
-            foreach ($keys as $key) {
-                unset($input->$key);
-            }
-            $data = $input->serialize();
-        }
-        $output = null;
-        try {
-            switch ($target) {
-                default:
-                case 'vcard3':
-                    if (VObject\Document::VCARD30 === $input->getDocumentType()) {
-                        // Do nothing
-                        return $data;
-                    }
-                    $output = $input->convert(VObject\Document::VCARD30);
-
-                    return $output->serialize();
-                case 'vcard4':
-                    if (VObject\Document::VCARD40 === $input->getDocumentType()) {
-                        // Do nothing
-                        return $data;
-                    }
-                    $output = $input->convert(VObject\Document::VCARD40);
-
-                    return $output->serialize();
-                case 'jcard':
-                    $output = $input->convert(VObject\Document::VCARD40);
-
-                    return json_encode($output);
-            }
-        } finally {
-            // Destroy circular references to PHP will GC the object.
-            $input->destroy();
-            if (!is_null($output)) {
-                $output->destroy();
-            }
-        }
-    }
-
-    /**
-     * Returns a plugin name.
-     *
-     * Using this name other plugins will be able to access other plugins
-     * using DAV\Server::getPlugin
-     *
-     * @return string
-     */
-    public function getPluginName()
-    {
-        return 'carddav';
-    }
-
-    /**
-     * Returns a bunch of meta-data about the plugin.
-     *
-     * Providing this information is optional, and is mainly displayed by the
-     * Browser plugin.
-     *
-     * The description key in the returned array may contain html and will not
-     * be sanitized.
-     *
-     * @return array
-     */
-    public function getPluginInfo()
-    {
-        return [
-            'name' => $this->getPluginName(),
-            'description' => 'Adds support for CardDAV (rfc6352)',
-            'link' => 'http://sabre.io/dav/carddav/',
-        ];
-    }
+		return false;
+	}
+
+	/**
+	 * This event is triggered after GET requests.
+	 *
+	 * This is used to transform data into jCal, if this was requested.
+	 */
+	public function httpAfterGet(RequestInterface $request, ResponseInterface $response)
+	{
+		$contentType = $response->getHeader('Content-Type');
+		if (null === $contentType || false === strpos($contentType, 'text/vcard')) {
+			return;
+		}
+
+		$target = $this->negotiateVCard($request->getHeader('Accept'), $mimeType);
+
+		$newBody = $this->convertVCard(
+			$response->getBody(),
+			$target
+		);
+
+		$response->setBody($newBody);
+		$response->setHeader('Content-Type', $mimeType.'; charset=utf-8');
+		$response->setHeader('Content-Length', strlen($newBody));
+	}
+
+	/**
+	 * This helper function performs the content-type negotiation for vcards.
+	 *
+	 * It will return one of the following strings:
+	 * 1. vcard3
+	 * 2. vcard4
+	 * 3. jcard
+	 *
+	 * It defaults to vcard3.
+	 *
+	 * @param string $input
+	 * @param string $mimeType
+	 *
+	 * @return string
+	 */
+	protected function negotiateVCard($input, &$mimeType = null)
+	{
+		$result = HTTP\negotiateContentType(
+			$input,
+			[
+				// Most often used mime-type. Version 3
+				'text/x-vcard',
+				// The correct standard mime-type. Defaults to version 3 as
+				// well.
+				'text/vcard',
+				// vCard 4
+				'text/vcard; version=4.0',
+				// vCard 3
+				'text/vcard; version=3.0',
+				// jCard
+				'application/vcard+json',
+			]
+		);
+
+		$mimeType = $result;
+		switch ($result) {
+			default:
+			case 'text/x-vcard':
+			case 'text/vcard':
+			case 'text/vcard; version=3.0':
+				$mimeType = 'text/vcard';
+
+				return 'vcard3';
+			case 'text/vcard; version=4.0':
+				return 'vcard4';
+			case 'application/vcard+json':
+				return 'jcard';
+
+		// @codeCoverageIgnoreStart
+		}
+		// @codeCoverageIgnoreEnd
+	}
+
+	/**
+	 * Converts a vcard blob to a different version, or jcard.
+	 *
+	 * @param string|resource $data
+	 * @param string          $target
+	 * @param array           $propertiesFilter
+	 *
+	 * @return string
+	 */
+	protected function convertVCard($data, $target, array $propertiesFilter = null)
+	{
+		if (is_resource($data)) {
+			$data = stream_get_contents($data);
+		}
+		$input = VObject\Reader::read($data);
+		if (!empty($propertiesFilter)) {
+			$propertiesFilter = array_merge(['UID', 'VERSION', 'FN'], $propertiesFilter);
+			$keys = array_unique(array_map(function ($child) {
+				return $child->name;
+			}, $input->children()));
+			$keys = array_diff($keys, $propertiesFilter);
+			foreach ($keys as $key) {
+				unset($input->$key);
+			}
+			$data = $input->serialize();
+		}
+		$output = null;
+		try {
+			switch ($target) {
+				default:
+				case 'vcard3':
+					if (VObject\Document::VCARD30 === $input->getDocumentType()) {
+						// Do nothing
+						return $data;
+					}
+					$output = $input->convert(VObject\Document::VCARD30);
+
+					return $output->serialize();
+				case 'vcard4':
+					if (VObject\Document::VCARD40 === $input->getDocumentType()) {
+						// Do nothing
+						return $data;
+					}
+					$output = $input->convert(VObject\Document::VCARD40);
+
+					return $output->serialize();
+				case 'jcard':
+					$output = $input->convert(VObject\Document::VCARD40);
+
+					return json_encode($output);
+			}
+		} finally {
+			// Destroy circular references to PHP will GC the object.
+			$input->destroy();
+			if (!is_null($output)) {
+				$output->destroy();
+			}
+		}
+	}
+
+	/**
+	 * Returns a plugin name.
+	 *
+	 * Using this name other plugins will be able to access other plugins
+	 * using DAV\Server::getPlugin
+	 *
+	 * @return string
+	 */
+	public function getPluginName()
+	{
+		return 'carddav';
+	}
+
+	/**
+	 * Returns a bunch of meta-data about the plugin.
+	 *
+	 * Providing this information is optional, and is mainly displayed by the
+	 * Browser plugin.
+	 *
+	 * The description key in the returned array may contain html and will not
+	 * be sanitized.
+	 *
+	 * @return array
+	 */
+	public function getPluginInfo()
+	{
+		return [
+			'name' => $this->getPluginName(),
+			'description' => 'Adds support for CardDAV (rfc6352)',
+			'link' => 'http://sabre.io/dav/carddav/',
+		];
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -136,22 +136,22 @@ 
 
         if ($node instanceof IAddressBook) {
             $propFind->handle($ns.'max-resource-size', $this->maxResourceSize);
-            $propFind->handle($ns.'supported-address-data', function () {
+            $propFind->handle($ns.'supported-address-data', function() {
                 return new Xml\Property\SupportedAddressData();
             });
-            $propFind->handle($ns.'supported-collation-set', function () {
+            $propFind->handle($ns.'supported-collation-set', function() {
                 return new Xml\Property\SupportedCollationSet();
             });
         }
         if ($node instanceof DAVACL\IPrincipal) {
             $path = $propFind->getPath();
 
-            $propFind->handle('{'.self::NS_CARDDAV.'}addressbook-home-set', function () use ($path) {
+            $propFind->handle('{'.self::NS_CARDDAV.'}addressbook-home-set', function() use ($path) {
                 return new LocalHref($this->getAddressBookHomeForPrincipal($path).'/');
             });
 
             if ($this->directories) {
-                $propFind->handle('{'.self::NS_CARDDAV.'}directory-gateway', function () {
+                $propFind->handle('{'.self::NS_CARDDAV.'}directory-gateway', function() {
                     return new LocalHref($this->directories);
                 });
             }
@@ -161,7 +161,7 @@ 
             // The address-data property is not supposed to be a 'real'
             // property, but in large chunks of the spec it does act as such.
             // Therefore we simply expose it as a property.
-            $propFind->handle('{'.self::NS_CARDDAV.'}address-data', function () use ($node) {
+            $propFind->handle('{'.self::NS_CARDDAV.'}address-data', function() use ($node) {
                 $val = $node->get();
                 if (is_resource($val)) {
                     $val = stream_get_contents($val);
@@ -808,7 +808,7 @@ 
         $input = VObject\Reader::read($data);
         if (!empty($propertiesFilter)) {
             $propertiesFilter = array_merge(['UID', 'VERSION', 'FN'], $propertiesFilter);
-            $keys = array_unique(array_map(function ($child) {
+            $keys = array_unique(array_map(function($child) {
                 return $child->name;
             }, $input->children()));
             $keys = array_diff($keys, $propertiesFilter);

htdocs/includes/sabre/sabre/dav/lib/CardDAV/Backend/BackendInterface.php

Indentation +163 added lines, -163 removed lines

@@ -19,176 +19,176 @@
  */
 interface BackendInterface
 {
-    /**
-     * Returns the list of addressbooks for a specific user.
-     *
-     * Every addressbook should have the following properties:
-     *   id - an arbitrary unique id
-     *   uri - the 'basename' part of the url
-     *   principaluri - Same as the passed parameter
-     *
-     * Any additional clark-notation property may be passed besides this. Some
-     * common ones are :
-     *   {DAV:}displayname
-     *   {urn:ietf:params:xml:ns:carddav}addressbook-description
-     *   {http://calendarserver.org/ns/}getctag
-     *
-     * @param string $principalUri
-     *
-     * @return array
-     */
-    public function getAddressBooksForUser($principalUri);
+	/**
+	 * Returns the list of addressbooks for a specific user.
+	 *
+	 * Every addressbook should have the following properties:
+	 *   id - an arbitrary unique id
+	 *   uri - the 'basename' part of the url
+	 *   principaluri - Same as the passed parameter
+	 *
+	 * Any additional clark-notation property may be passed besides this. Some
+	 * common ones are :
+	 *   {DAV:}displayname
+	 *   {urn:ietf:params:xml:ns:carddav}addressbook-description
+	 *   {http://calendarserver.org/ns/}getctag
+	 *
+	 * @param string $principalUri
+	 *
+	 * @return array
+	 */
+	public function getAddressBooksForUser($principalUri);
 
-    /**
-     * Updates properties for an address book.
-     *
-     * The list of mutations is stored in a Sabre\DAV\PropPatch object.
-     * To do the actual updates, you must tell this object which properties
-     * you're going to process with the handle() method.
-     *
-     * Calling the handle method is like telling the PropPatch object "I
-     * promise I can handle updating this property".
-     *
-     * Read the PropPatch documentation for more info and examples.
-     *
-     * @param string $addressBookId
-     */
-    public function updateAddressBook($addressBookId, \Sabre\DAV\PropPatch $propPatch);
+	/**
+	 * Updates properties for an address book.
+	 *
+	 * The list of mutations is stored in a Sabre\DAV\PropPatch object.
+	 * To do the actual updates, you must tell this object which properties
+	 * you're going to process with the handle() method.
+	 *
+	 * Calling the handle method is like telling the PropPatch object "I
+	 * promise I can handle updating this property".
+	 *
+	 * Read the PropPatch documentation for more info and examples.
+	 *
+	 * @param string $addressBookId
+	 */
+	public function updateAddressBook($addressBookId, \Sabre\DAV\PropPatch $propPatch);
 
-    /**
-     * Creates a new address book.
-     *
-     * This method should return the id of the new address book. The id can be
-     * in any format, including ints, strings, arrays or objects.
-     *
-     * @param string $principalUri
-     * @param string $url          just the 'basename' of the url
-     *
-     * @return mixed
-     */
-    public function createAddressBook($principalUri, $url, array $properties);
+	/**
+	 * Creates a new address book.
+	 *
+	 * This method should return the id of the new address book. The id can be
+	 * in any format, including ints, strings, arrays or objects.
+	 *
+	 * @param string $principalUri
+	 * @param string $url          just the 'basename' of the url
+	 *
+	 * @return mixed
+	 */
+	public function createAddressBook($principalUri, $url, array $properties);
 
-    /**
-     * Deletes an entire addressbook and all its contents.
-     *
-     * @param mixed $addressBookId
-     */
-    public function deleteAddressBook($addressBookId);
+	/**
+	 * Deletes an entire addressbook and all its contents.
+	 *
+	 * @param mixed $addressBookId
+	 */
+	public function deleteAddressBook($addressBookId);
 
-    /**
-     * Returns all cards for a specific addressbook id.
-     *
-     * This method should return the following properties for each card:
-     *   * carddata - raw vcard data
-     *   * uri - Some unique url
-     *   * lastmodified - A unix timestamp
-     *
-     * It's recommended to also return the following properties:
-     *   * etag - A unique etag. This must change every time the card changes.
-     *   * size - The size of the card in bytes.
-     *
-     * If these last two properties are provided, less time will be spent
-     * calculating them. If they are specified, you can also ommit carddata.
-     * This may speed up certain requests, especially with large cards.
-     *
-     * @param mixed $addressbookId
-     *
-     * @return array
-     */
-    public function getCards($addressbookId);
+	/**
+	 * Returns all cards for a specific addressbook id.
+	 *
+	 * This method should return the following properties for each card:
+	 *   * carddata - raw vcard data
+	 *   * uri - Some unique url
+	 *   * lastmodified - A unix timestamp
+	 *
+	 * It's recommended to also return the following properties:
+	 *   * etag - A unique etag. This must change every time the card changes.
+	 *   * size - The size of the card in bytes.
+	 *
+	 * If these last two properties are provided, less time will be spent
+	 * calculating them. If they are specified, you can also ommit carddata.
+	 * This may speed up certain requests, especially with large cards.
+	 *
+	 * @param mixed $addressbookId
+	 *
+	 * @return array
+	 */
+	public function getCards($addressbookId);
 
-    /**
-     * Returns a specfic card.
-     *
-     * The same set of properties must be returned as with getCards. The only
-     * exception is that 'carddata' is absolutely required.
-     *
-     * If the card does not exist, you must return false.
-     *
-     * @param mixed  $addressBookId
-     * @param string $cardUri
-     *
-     * @return array
-     */
-    public function getCard($addressBookId, $cardUri);
+	/**
+	 * Returns a specfic card.
+	 *
+	 * The same set of properties must be returned as with getCards. The only
+	 * exception is that 'carddata' is absolutely required.
+	 *
+	 * If the card does not exist, you must return false.
+	 *
+	 * @param mixed  $addressBookId
+	 * @param string $cardUri
+	 *
+	 * @return array
+	 */
+	public function getCard($addressBookId, $cardUri);
 
-    /**
-     * Returns a list of cards.
-     *
-     * This method should work identical to getCard, but instead return all the
-     * cards in the list as an array.
-     *
-     * If the backend supports this, it may allow for some speed-ups.
-     *
-     * @param mixed $addressBookId
-     *
-     * @return array
-     */
-    public function getMultipleCards($addressBookId, array $uris);
+	/**
+	 * Returns a list of cards.
+	 *
+	 * This method should work identical to getCard, but instead return all the
+	 * cards in the list as an array.
+	 *
+	 * If the backend supports this, it may allow for some speed-ups.
+	 *
+	 * @param mixed $addressBookId
+	 *
+	 * @return array
+	 */
+	public function getMultipleCards($addressBookId, array $uris);
 
-    /**
-     * Creates a new card.
-     *
-     * The addressbook id will be passed as the first argument. This is the
-     * same id as it is returned from the getAddressBooksForUser method.
-     *
-     * The cardUri is a base uri, and doesn't include the full path. The
-     * cardData argument is the vcard body, and is passed as a string.
-     *
-     * It is possible to return an ETag from this method. This ETag is for the
-     * newly created resource, and must be enclosed with double quotes (that
-     * is, the string itself must contain the double quotes).
-     *
-     * You should only return the ETag if you store the carddata as-is. If a
-     * subsequent GET request on the same card does not have the same body,
-     * byte-by-byte and you did return an ETag here, clients tend to get
-     * confused.
-     *
-     * If you don't return an ETag, you can just return null.
-     *
-     * @param mixed  $addressBookId
-     * @param string $cardUri
-     * @param string $cardData
-     *
-     * @return string|null
-     */
-    public function createCard($addressBookId, $cardUri, $cardData);
+	/**
+	 * Creates a new card.
+	 *
+	 * The addressbook id will be passed as the first argument. This is the
+	 * same id as it is returned from the getAddressBooksForUser method.
+	 *
+	 * The cardUri is a base uri, and doesn't include the full path. The
+	 * cardData argument is the vcard body, and is passed as a string.
+	 *
+	 * It is possible to return an ETag from this method. This ETag is for the
+	 * newly created resource, and must be enclosed with double quotes (that
+	 * is, the string itself must contain the double quotes).
+	 *
+	 * You should only return the ETag if you store the carddata as-is. If a
+	 * subsequent GET request on the same card does not have the same body,
+	 * byte-by-byte and you did return an ETag here, clients tend to get
+	 * confused.
+	 *
+	 * If you don't return an ETag, you can just return null.
+	 *
+	 * @param mixed  $addressBookId
+	 * @param string $cardUri
+	 * @param string $cardData
+	 *
+	 * @return string|null
+	 */
+	public function createCard($addressBookId, $cardUri, $cardData);
 
-    /**
-     * Updates a card.
-     *
-     * The addressbook id will be passed as the first argument. This is the
-     * same id as it is returned from the getAddressBooksForUser method.
-     *
-     * The cardUri is a base uri, and doesn't include the full path. The
-     * cardData argument is the vcard body, and is passed as a string.
-     *
-     * It is possible to return an ETag from this method. This ETag should
-     * match that of the updated resource, and must be enclosed with double
-     * quotes (that is: the string itself must contain the actual quotes).
-     *
-     * You should only return the ETag if you store the carddata as-is. If a
-     * subsequent GET request on the same card does not have the same body,
-     * byte-by-byte and you did return an ETag here, clients tend to get
-     * confused.
-     *
-     * If you don't return an ETag, you can just return null.
-     *
-     * @param mixed  $addressBookId
-     * @param string $cardUri
-     * @param string $cardData
-     *
-     * @return string|null
-     */
-    public function updateCard($addressBookId, $cardUri, $cardData);
+	/**
+	 * Updates a card.
+	 *
+	 * The addressbook id will be passed as the first argument. This is the
+	 * same id as it is returned from the getAddressBooksForUser method.
+	 *
+	 * The cardUri is a base uri, and doesn't include the full path. The
+	 * cardData argument is the vcard body, and is passed as a string.
+	 *
+	 * It is possible to return an ETag from this method. This ETag should
+	 * match that of the updated resource, and must be enclosed with double
+	 * quotes (that is: the string itself must contain the actual quotes).
+	 *
+	 * You should only return the ETag if you store the carddata as-is. If a
+	 * subsequent GET request on the same card does not have the same body,
+	 * byte-by-byte and you did return an ETag here, clients tend to get
+	 * confused.
+	 *
+	 * If you don't return an ETag, you can just return null.
+	 *
+	 * @param mixed  $addressBookId
+	 * @param string $cardUri
+	 * @param string $cardData
+	 *
+	 * @return string|null
+	 */
+	public function updateCard($addressBookId, $cardUri, $cardData);
 
-    /**
-     * Deletes a card.
-     *
-     * @param mixed  $addressBookId
-     * @param string $cardUri
-     *
-     * @return bool
-     */
-    public function deleteCard($addressBookId, $cardUri);
+	/**
+	 * Deletes a card.
+	 *
+	 * @param mixed  $addressBookId
+	 * @param string $cardUri
+	 *
+	 * @return bool
+	 */
+	public function deleteCard($addressBookId, $cardUri);
 }

htdocs/includes/sabre/sabre/dav/lib/CardDAV/Backend/AbstractBackend.php

Indentation +18 added lines, -18 removed lines

@@ -17,22 +17,22 @@
  */
 abstract class AbstractBackend implements BackendInterface
 {
-    /**
-     * Returns a list of cards.
-     *
-     * This method should work identical to getCard, but instead return all the
-     * cards in the list as an array.
-     *
-     * If the backend supports this, it may allow for some speed-ups.
-     *
-     * @param mixed $addressBookId
-     *
-     * @return array
-     */
-    public function getMultipleCards($addressBookId, array $uris)
-    {
-        return array_map(function ($uri) use ($addressBookId) {
-            return $this->getCard($addressBookId, $uri);
-        }, $uris);
-    }
+	/**
+	 * Returns a list of cards.
+	 *
+	 * This method should work identical to getCard, but instead return all the
+	 * cards in the list as an array.
+	 *
+	 * If the backend supports this, it may allow for some speed-ups.
+	 *
+	 * @param mixed $addressBookId
+	 *
+	 * @return array
+	 */
+	public function getMultipleCards($addressBookId, array $uris)
+	{
+		return array_map(function ($uri) use ($addressBookId) {
+			return $this->getCard($addressBookId, $uri);
+		}, $uris);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -31,7 +31,7 @@
      */
     public function getMultipleCards($addressBookId, array $uris)
     {
-        return array_map(function ($uri) use ($addressBookId) {
+        return array_map(function($uri) use ($addressBookId) {
             return $this->getCard($addressBookId, $uri);
         }, $uris);
     }

htdocs/includes/sabre/sabre/dav/lib/CardDAV/Backend/PDO.php

Spacing +1 added lines, -1 removed lines

@@ -101,7 +101,7 @@
             '{'.CardDAV\Plugin::NS_CARDDAV.'}addressbook-description',
         ];
 
-        $propPatch->handle($supportedProperties, function ($mutations) use ($addressBookId) {
+        $propPatch->handle($supportedProperties, function($mutations) use ($addressBookId) {
             $updates = [];
             foreach ($mutations as $property => $newValue) {
                 switch ($property) {

Indentation +517 added lines, -517 removed lines

@@ -19,521 +19,521 @@
  */
 class PDO extends AbstractBackend implements SyncSupport
 {
-    /**
-     * PDO connection.
-     *
-     * @var PDO
-     */
-    protected $pdo;
-
-    /**
-     * The PDO table name used to store addressbooks.
-     */
-    public $addressBooksTableName = 'addressbooks';
-
-    /**
-     * The PDO table name used to store cards.
-     */
-    public $cardsTableName = 'cards';
-
-    /**
-     * The table name that will be used for tracking changes in address books.
-     *
-     * @var string
-     */
-    public $addressBookChangesTableName = 'addressbookchanges';
-
-    /**
-     * Sets up the object.
-     */
-    public function __construct(\PDO $pdo)
-    {
-        $this->pdo = $pdo;
-    }
-
-    /**
-     * Returns the list of addressbooks for a specific user.
-     *
-     * @param string $principalUri
-     *
-     * @return array
-     */
-    public function getAddressBooksForUser($principalUri)
-    {
-        $stmt = $this->pdo->prepare('SELECT id, uri, displayname, principaluri, description, synctoken FROM '.$this->addressBooksTableName.' WHERE principaluri = ?');
-        $stmt->execute([$principalUri]);
-
-        $addressBooks = [];
-
-        foreach ($stmt->fetchAll() as $row) {
-            $addressBooks[] = [
-                'id' => $row['id'],
-                'uri' => $row['uri'],
-                'principaluri' => $row['principaluri'],
-                '{DAV:}displayname' => $row['displayname'],
-                '{'.CardDAV\Plugin::NS_CARDDAV.'}addressbook-description' => $row['description'],
-                '{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
-                '{http://sabredav.org/ns}sync-token' => $row['synctoken'] ? $row['synctoken'] : '0',
-            ];
-        }
-
-        return $addressBooks;
-    }
-
-    /**
-     * Updates properties for an address book.
-     *
-     * The list of mutations is stored in a Sabre\DAV\PropPatch object.
-     * To do the actual updates, you must tell this object which properties
-     * you're going to process with the handle() method.
-     *
-     * Calling the handle method is like telling the PropPatch object "I
-     * promise I can handle updating this property".
-     *
-     * Read the PropPatch documentation for more info and examples.
-     *
-     * @param string $addressBookId
-     */
-    public function updateAddressBook($addressBookId, PropPatch $propPatch)
-    {
-        $supportedProperties = [
-            '{DAV:}displayname',
-            '{'.CardDAV\Plugin::NS_CARDDAV.'}addressbook-description',
-        ];
-
-        $propPatch->handle($supportedProperties, function ($mutations) use ($addressBookId) {
-            $updates = [];
-            foreach ($mutations as $property => $newValue) {
-                switch ($property) {
-                    case '{DAV:}displayname':
-                        $updates['displayname'] = $newValue;
-                        break;
-                    case '{'.CardDAV\Plugin::NS_CARDDAV.'}addressbook-description':
-                        $updates['description'] = $newValue;
-                        break;
-                }
-            }
-            $query = 'UPDATE '.$this->addressBooksTableName.' SET ';
-            $first = true;
-            foreach ($updates as $key => $value) {
-                if ($first) {
-                    $first = false;
-                } else {
-                    $query .= ', ';
-                }
-                $query .= ' '.$key.' = :'.$key.' ';
-            }
-            $query .= ' WHERE id = :addressbookid';
-
-            $stmt = $this->pdo->prepare($query);
-            $updates['addressbookid'] = $addressBookId;
-
-            $stmt->execute($updates);
-
-            $this->addChange($addressBookId, '', 2);
-
-            return true;
-        });
-    }
-
-    /**
-     * Creates a new address book.
-     *
-     * @param string $principalUri
-     * @param string $url          just the 'basename' of the url
-     *
-     * @return int Last insert id
-     */
-    public function createAddressBook($principalUri, $url, array $properties)
-    {
-        $values = [
-            'displayname' => null,
-            'description' => null,
-            'principaluri' => $principalUri,
-            'uri' => $url,
-        ];
-
-        foreach ($properties as $property => $newValue) {
-            switch ($property) {
-                case '{DAV:}displayname':
-                    $values['displayname'] = $newValue;
-                    break;
-                case '{'.CardDAV\Plugin::NS_CARDDAV.'}addressbook-description':
-                    $values['description'] = $newValue;
-                    break;
-                default:
-                    throw new DAV\Exception\BadRequest('Unknown property: '.$property);
-            }
-        }
-
-        $query = 'INSERT INTO '.$this->addressBooksTableName.' (uri, displayname, description, principaluri, synctoken) VALUES (:uri, :displayname, :description, :principaluri, 1)';
-        $stmt = $this->pdo->prepare($query);
-        $stmt->execute($values);
-
-        return $this->pdo->lastInsertId(
-            $this->addressBooksTableName.'_id_seq'
-        );
-    }
-
-    /**
-     * Deletes an entire addressbook and all its contents.
-     *
-     * @param int $addressBookId
-     */
-    public function deleteAddressBook($addressBookId)
-    {
-        $stmt = $this->pdo->prepare('DELETE FROM '.$this->cardsTableName.' WHERE addressbookid = ?');
-        $stmt->execute([$addressBookId]);
-
-        $stmt = $this->pdo->prepare('DELETE FROM '.$this->addressBooksTableName.' WHERE id = ?');
-        $stmt->execute([$addressBookId]);
-
-        $stmt = $this->pdo->prepare('DELETE FROM '.$this->addressBookChangesTableName.' WHERE addressbookid = ?');
-        $stmt->execute([$addressBookId]);
-    }
-
-    /**
-     * Returns all cards for a specific addressbook id.
-     *
-     * This method should return the following properties for each card:
-     *   * carddata - raw vcard data
-     *   * uri - Some unique url
-     *   * lastmodified - A unix timestamp
-     *
-     * It's recommended to also return the following properties:
-     *   * etag - A unique etag. This must change every time the card changes.
-     *   * size - The size of the card in bytes.
-     *
-     * If these last two properties are provided, less time will be spent
-     * calculating them. If they are specified, you can also ommit carddata.
-     * This may speed up certain requests, especially with large cards.
-     *
-     * @param mixed $addressbookId
-     *
-     * @return array
-     */
-    public function getCards($addressbookId)
-    {
-        $stmt = $this->pdo->prepare('SELECT id, uri, lastmodified, etag, size FROM '.$this->cardsTableName.' WHERE addressbookid = ?');
-        $stmt->execute([$addressbookId]);
-
-        $result = [];
-        while ($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
-            $row['etag'] = '"'.$row['etag'].'"';
-            $row['lastmodified'] = (int) $row['lastmodified'];
-            $result[] = $row;
-        }
-
-        return $result;
-    }
-
-    /**
-     * Returns a specific card.
-     *
-     * The same set of properties must be returned as with getCards. The only
-     * exception is that 'carddata' is absolutely required.
-     *
-     * If the card does not exist, you must return false.
-     *
-     * @param mixed  $addressBookId
-     * @param string $cardUri
-     *
-     * @return array
-     */
-    public function getCard($addressBookId, $cardUri)
-    {
-        $stmt = $this->pdo->prepare('SELECT id, carddata, uri, lastmodified, etag, size FROM '.$this->cardsTableName.' WHERE addressbookid = ? AND uri = ? LIMIT 1');
-        $stmt->execute([$addressBookId, $cardUri]);
-
-        $result = $stmt->fetch(\PDO::FETCH_ASSOC);
-
-        if (!$result) {
-            return false;
-        }
-
-        $result['etag'] = '"'.$result['etag'].'"';
-        $result['lastmodified'] = (int) $result['lastmodified'];
-
-        return $result;
-    }
-
-    /**
-     * Returns a list of cards.
-     *
-     * This method should work identical to getCard, but instead return all the
-     * cards in the list as an array.
-     *
-     * If the backend supports this, it may allow for some speed-ups.
-     *
-     * @param mixed $addressBookId
-     *
-     * @return array
-     */
-    public function getMultipleCards($addressBookId, array $uris)
-    {
-        $query = 'SELECT id, uri, lastmodified, etag, size, carddata FROM '.$this->cardsTableName.' WHERE addressbookid = ? AND uri IN (';
-        // Inserting a whole bunch of question marks
-        $query .= implode(',', array_fill(0, count($uris), '?'));
-        $query .= ')';
-
-        $stmt = $this->pdo->prepare($query);
-        $stmt->execute(array_merge([$addressBookId], $uris));
-        $result = [];
-        while ($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
-            $row['etag'] = '"'.$row['etag'].'"';
-            $row['lastmodified'] = (int) $row['lastmodified'];
-            $result[] = $row;
-        }
-
-        return $result;
-    }
-
-    /**
-     * Creates a new card.
-     *
-     * The addressbook id will be passed as the first argument. This is the
-     * same id as it is returned from the getAddressBooksForUser method.
-     *
-     * The cardUri is a base uri, and doesn't include the full path. The
-     * cardData argument is the vcard body, and is passed as a string.
-     *
-     * It is possible to return an ETag from this method. This ETag is for the
-     * newly created resource, and must be enclosed with double quotes (that
-     * is, the string itself must contain the double quotes).
-     *
-     * You should only return the ETag if you store the carddata as-is. If a
-     * subsequent GET request on the same card does not have the same body,
-     * byte-by-byte and you did return an ETag here, clients tend to get
-     * confused.
-     *
-     * If you don't return an ETag, you can just return null.
-     *
-     * @param mixed  $addressBookId
-     * @param string $cardUri
-     * @param string $cardData
-     *
-     * @return string|null
-     */
-    public function createCard($addressBookId, $cardUri, $cardData)
-    {
-        $stmt = $this->pdo->prepare('INSERT INTO '.$this->cardsTableName.' (carddata, uri, lastmodified, addressbookid, size, etag) VALUES (?, ?, ?, ?, ?, ?)');
-
-        $etag = md5($cardData);
-
-        $stmt->execute([
-            $cardData,
-            $cardUri,
-            time(),
-            $addressBookId,
-            strlen($cardData),
-            $etag,
-        ]);
-
-        $this->addChange($addressBookId, $cardUri, 1);
-
-        return '"'.$etag.'"';
-    }
-
-    /**
-     * Updates a card.
-     *
-     * The addressbook id will be passed as the first argument. This is the
-     * same id as it is returned from the getAddressBooksForUser method.
-     *
-     * The cardUri is a base uri, and doesn't include the full path. The
-     * cardData argument is the vcard body, and is passed as a string.
-     *
-     * It is possible to return an ETag from this method. This ETag should
-     * match that of the updated resource, and must be enclosed with double
-     * quotes (that is: the string itself must contain the actual quotes).
-     *
-     * You should only return the ETag if you store the carddata as-is. If a
-     * subsequent GET request on the same card does not have the same body,
-     * byte-by-byte and you did return an ETag here, clients tend to get
-     * confused.
-     *
-     * If you don't return an ETag, you can just return null.
-     *
-     * @param mixed  $addressBookId
-     * @param string $cardUri
-     * @param string $cardData
-     *
-     * @return string|null
-     */
-    public function updateCard($addressBookId, $cardUri, $cardData)
-    {
-        $stmt = $this->pdo->prepare('UPDATE '.$this->cardsTableName.' SET carddata = ?, lastmodified = ?, size = ?, etag = ? WHERE uri = ? AND addressbookid =?');
-
-        $etag = md5($cardData);
-        $stmt->execute([
-            $cardData,
-            time(),
-            strlen($cardData),
-            $etag,
-            $cardUri,
-            $addressBookId,
-        ]);
-
-        $this->addChange($addressBookId, $cardUri, 2);
-
-        return '"'.$etag.'"';
-    }
-
-    /**
-     * Deletes a card.
-     *
-     * @param mixed  $addressBookId
-     * @param string $cardUri
-     *
-     * @return bool
-     */
-    public function deleteCard($addressBookId, $cardUri)
-    {
-        $stmt = $this->pdo->prepare('DELETE FROM '.$this->cardsTableName.' WHERE addressbookid = ? AND uri = ?');
-        $stmt->execute([$addressBookId, $cardUri]);
-
-        $this->addChange($addressBookId, $cardUri, 3);
-
-        return 1 === $stmt->rowCount();
-    }
-
-    /**
-     * The getChanges method returns all the changes that have happened, since
-     * the specified syncToken in the specified address book.
-     *
-     * This function should return an array, such as the following:
-     *
-     * [
-     *   'syncToken' => 'The current synctoken',
-     *   'added'   => [
-     *      'new.txt',
-     *   ],
-     *   'modified'   => [
-     *      'updated.txt',
-     *   ],
-     *   'deleted' => [
-     *      'foo.php.bak',
-     *      'old.txt'
-     *   ]
-     * ];
-     *
-     * The returned syncToken property should reflect the *current* syncToken
-     * of the addressbook, as reported in the {http://sabredav.org/ns}sync-token
-     * property. This is needed here too, to ensure the operation is atomic.
-     *
-     * If the $syncToken argument 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 $syncLevel 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 $limit 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 $addressBookId
-     * @param string $syncToken
-     * @param int    $syncLevel
-     * @param int    $limit
-     *
-     * @return array|null
-     */
-    public function getChangesForAddressBook($addressBookId, $syncToken, $syncLevel, $limit = null)
-    {
-        // Current synctoken
-        $stmt = $this->pdo->prepare('SELECT synctoken FROM '.$this->addressBooksTableName.' WHERE id = ?');
-        $stmt->execute([$addressBookId]);
-        $currentToken = $stmt->fetchColumn(0);
-
-        if (is_null($currentToken)) {
-            return null;
-        }
-
-        $result = [
-            'syncToken' => $currentToken,
-            'added' => [],
-            'modified' => [],
-            'deleted' => [],
-        ];
-
-        if ($syncToken) {
-            $query = 'SELECT uri, operation FROM '.$this->addressBookChangesTableName.' WHERE synctoken >= ? AND synctoken < ? AND addressbookid = ? ORDER BY synctoken';
-            if ($limit > 0) {
-                $query .= ' LIMIT '.(int) $limit;
-            }
-
-            // Fetching all changes
-            $stmt = $this->pdo->prepare($query);
-            $stmt->execute([$syncToken, $currentToken, $addressBookId]);
-
-            $changes = [];
-
-            // This loop ensures that any duplicates are overwritten, only the
-            // last change on a node is relevant.
-            while ($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
-                $changes[$row['uri']] = $row['operation'];
-            }
-
-            foreach ($changes as $uri => $operation) {
-                switch ($operation) {
-                    case 1:
-                        $result['added'][] = $uri;
-                        break;
-                    case 2:
-                        $result['modified'][] = $uri;
-                        break;
-                    case 3:
-                        $result['deleted'][] = $uri;
-                        break;
-                }
-            }
-        } else {
-            // No synctoken supplied, this is the initial sync.
-            $query = 'SELECT uri FROM '.$this->cardsTableName.' WHERE addressbookid = ?';
-            $stmt = $this->pdo->prepare($query);
-            $stmt->execute([$addressBookId]);
-
-            $result['added'] = $stmt->fetchAll(\PDO::FETCH_COLUMN);
-        }
-
-        return $result;
-    }
-
-    /**
-     * Adds a change record to the addressbookchanges table.
-     *
-     * @param mixed  $addressBookId
-     * @param string $objectUri
-     * @param int    $operation     1 = add, 2 = modify, 3 = delete
-     */
-    protected function addChange($addressBookId, $objectUri, $operation)
-    {
-        $stmt = $this->pdo->prepare('INSERT INTO '.$this->addressBookChangesTableName.' (uri, synctoken, addressbookid, operation) SELECT ?, synctoken, ?, ? FROM '.$this->addressBooksTableName.' WHERE id = ?');
-        $stmt->execute([
-            $objectUri,
-            $addressBookId,
-            $operation,
-            $addressBookId,
-        ]);
-        $stmt = $this->pdo->prepare('UPDATE '.$this->addressBooksTableName.' SET synctoken = synctoken + 1 WHERE id = ?');
-        $stmt->execute([
-            $addressBookId,
-        ]);
-    }
+	/**
+	 * PDO connection.
+	 *
+	 * @var PDO
+	 */
+	protected $pdo;
+
+	/**
+	 * The PDO table name used to store addressbooks.
+	 */
+	public $addressBooksTableName = 'addressbooks';
+
+	/**
+	 * The PDO table name used to store cards.
+	 */
+	public $cardsTableName = 'cards';
+
+	/**
+	 * The table name that will be used for tracking changes in address books.
+	 *
+	 * @var string
+	 */
+	public $addressBookChangesTableName = 'addressbookchanges';
+
+	/**
+	 * Sets up the object.
+	 */
+	public function __construct(\PDO $pdo)
+	{
+		$this->pdo = $pdo;
+	}
+
+	/**
+	 * Returns the list of addressbooks for a specific user.
+	 *
+	 * @param string $principalUri
+	 *
+	 * @return array
+	 */
+	public function getAddressBooksForUser($principalUri)
+	{
+		$stmt = $this->pdo->prepare('SELECT id, uri, displayname, principaluri, description, synctoken FROM '.$this->addressBooksTableName.' WHERE principaluri = ?');
+		$stmt->execute([$principalUri]);
+
+		$addressBooks = [];
+
+		foreach ($stmt->fetchAll() as $row) {
+			$addressBooks[] = [
+				'id' => $row['id'],
+				'uri' => $row['uri'],
+				'principaluri' => $row['principaluri'],
+				'{DAV:}displayname' => $row['displayname'],
+				'{'.CardDAV\Plugin::NS_CARDDAV.'}addressbook-description' => $row['description'],
+				'{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
+				'{http://sabredav.org/ns}sync-token' => $row['synctoken'] ? $row['synctoken'] : '0',
+			];
+		}
+
+		return $addressBooks;
+	}
+
+	/**
+	 * Updates properties for an address book.
+	 *
+	 * The list of mutations is stored in a Sabre\DAV\PropPatch object.
+	 * To do the actual updates, you must tell this object which properties
+	 * you're going to process with the handle() method.
+	 *
+	 * Calling the handle method is like telling the PropPatch object "I
+	 * promise I can handle updating this property".
+	 *
+	 * Read the PropPatch documentation for more info and examples.
+	 *
+	 * @param string $addressBookId
+	 */
+	public function updateAddressBook($addressBookId, PropPatch $propPatch)
+	{
+		$supportedProperties = [
+			'{DAV:}displayname',
+			'{'.CardDAV\Plugin::NS_CARDDAV.'}addressbook-description',
+		];
+
+		$propPatch->handle($supportedProperties, function ($mutations) use ($addressBookId) {
+			$updates = [];
+			foreach ($mutations as $property => $newValue) {
+				switch ($property) {
+					case '{DAV:}displayname':
+						$updates['displayname'] = $newValue;
+						break;
+					case '{'.CardDAV\Plugin::NS_CARDDAV.'}addressbook-description':
+						$updates['description'] = $newValue;
+						break;
+				}
+			}
+			$query = 'UPDATE '.$this->addressBooksTableName.' SET ';
+			$first = true;
+			foreach ($updates as $key => $value) {
+				if ($first) {
+					$first = false;
+				} else {
+					$query .= ', ';
+				}
+				$query .= ' '.$key.' = :'.$key.' ';
+			}
+			$query .= ' WHERE id = :addressbookid';
+
+			$stmt = $this->pdo->prepare($query);
+			$updates['addressbookid'] = $addressBookId;
+
+			$stmt->execute($updates);
+
+			$this->addChange($addressBookId, '', 2);
+
+			return true;
+		});
+	}
+
+	/**
+	 * Creates a new address book.
+	 *
+	 * @param string $principalUri
+	 * @param string $url          just the 'basename' of the url
+	 *
+	 * @return int Last insert id
+	 */
+	public function createAddressBook($principalUri, $url, array $properties)
+	{
+		$values = [
+			'displayname' => null,
+			'description' => null,
+			'principaluri' => $principalUri,
+			'uri' => $url,
+		];
+
+		foreach ($properties as $property => $newValue) {
+			switch ($property) {
+				case '{DAV:}displayname':
+					$values['displayname'] = $newValue;
+					break;
+				case '{'.CardDAV\Plugin::NS_CARDDAV.'}addressbook-description':
+					$values['description'] = $newValue;
+					break;
+				default:
+					throw new DAV\Exception\BadRequest('Unknown property: '.$property);
+			}
+		}
+
+		$query = 'INSERT INTO '.$this->addressBooksTableName.' (uri, displayname, description, principaluri, synctoken) VALUES (:uri, :displayname, :description, :principaluri, 1)';
+		$stmt = $this->pdo->prepare($query);
+		$stmt->execute($values);
+
+		return $this->pdo->lastInsertId(
+			$this->addressBooksTableName.'_id_seq'
+		);
+	}
+
+	/**
+	 * Deletes an entire addressbook and all its contents.
+	 *
+	 * @param int $addressBookId
+	 */
+	public function deleteAddressBook($addressBookId)
+	{
+		$stmt = $this->pdo->prepare('DELETE FROM '.$this->cardsTableName.' WHERE addressbookid = ?');
+		$stmt->execute([$addressBookId]);
+
+		$stmt = $this->pdo->prepare('DELETE FROM '.$this->addressBooksTableName.' WHERE id = ?');
+		$stmt->execute([$addressBookId]);
+
+		$stmt = $this->pdo->prepare('DELETE FROM '.$this->addressBookChangesTableName.' WHERE addressbookid = ?');
+		$stmt->execute([$addressBookId]);
+	}
+
+	/**
+	 * Returns all cards for a specific addressbook id.
+	 *
+	 * This method should return the following properties for each card:
+	 *   * carddata - raw vcard data
+	 *   * uri - Some unique url
+	 *   * lastmodified - A unix timestamp
+	 *
+	 * It's recommended to also return the following properties:
+	 *   * etag - A unique etag. This must change every time the card changes.
+	 *   * size - The size of the card in bytes.
+	 *
+	 * If these last two properties are provided, less time will be spent
+	 * calculating them. If they are specified, you can also ommit carddata.
+	 * This may speed up certain requests, especially with large cards.
+	 *
+	 * @param mixed $addressbookId
+	 *
+	 * @return array
+	 */
+	public function getCards($addressbookId)
+	{
+		$stmt = $this->pdo->prepare('SELECT id, uri, lastmodified, etag, size FROM '.$this->cardsTableName.' WHERE addressbookid = ?');
+		$stmt->execute([$addressbookId]);
+
+		$result = [];
+		while ($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
+			$row['etag'] = '"'.$row['etag'].'"';
+			$row['lastmodified'] = (int) $row['lastmodified'];
+			$result[] = $row;
+		}
+
+		return $result;
+	}
+
+	/**
+	 * Returns a specific card.
+	 *
+	 * The same set of properties must be returned as with getCards. The only
+	 * exception is that 'carddata' is absolutely required.
+	 *
+	 * If the card does not exist, you must return false.
+	 *
+	 * @param mixed  $addressBookId
+	 * @param string $cardUri
+	 *
+	 * @return array
+	 */
+	public function getCard($addressBookId, $cardUri)
+	{
+		$stmt = $this->pdo->prepare('SELECT id, carddata, uri, lastmodified, etag, size FROM '.$this->cardsTableName.' WHERE addressbookid = ? AND uri = ? LIMIT 1');
+		$stmt->execute([$addressBookId, $cardUri]);
+
+		$result = $stmt->fetch(\PDO::FETCH_ASSOC);
+
+		if (!$result) {
+			return false;
+		}
+
+		$result['etag'] = '"'.$result['etag'].'"';
+		$result['lastmodified'] = (int) $result['lastmodified'];
+
+		return $result;
+	}
+
+	/**
+	 * Returns a list of cards.
+	 *
+	 * This method should work identical to getCard, but instead return all the
+	 * cards in the list as an array.
+	 *
+	 * If the backend supports this, it may allow for some speed-ups.
+	 *
+	 * @param mixed $addressBookId
+	 *
+	 * @return array
+	 */
+	public function getMultipleCards($addressBookId, array $uris)
+	{
+		$query = 'SELECT id, uri, lastmodified, etag, size, carddata FROM '.$this->cardsTableName.' WHERE addressbookid = ? AND uri IN (';
+		// Inserting a whole bunch of question marks
+		$query .= implode(',', array_fill(0, count($uris), '?'));
+		$query .= ')';
+
+		$stmt = $this->pdo->prepare($query);
+		$stmt->execute(array_merge([$addressBookId], $uris));
+		$result = [];
+		while ($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
+			$row['etag'] = '"'.$row['etag'].'"';
+			$row['lastmodified'] = (int) $row['lastmodified'];
+			$result[] = $row;
+		}
+
+		return $result;
+	}
+
+	/**
+	 * Creates a new card.
+	 *
+	 * The addressbook id will be passed as the first argument. This is the
+	 * same id as it is returned from the getAddressBooksForUser method.
+	 *
+	 * The cardUri is a base uri, and doesn't include the full path. The
+	 * cardData argument is the vcard body, and is passed as a string.
+	 *
+	 * It is possible to return an ETag from this method. This ETag is for the
+	 * newly created resource, and must be enclosed with double quotes (that
+	 * is, the string itself must contain the double quotes).
+	 *
+	 * You should only return the ETag if you store the carddata as-is. If a
+	 * subsequent GET request on the same card does not have the same body,
+	 * byte-by-byte and you did return an ETag here, clients tend to get
+	 * confused.
+	 *
+	 * If you don't return an ETag, you can just return null.
+	 *
+	 * @param mixed  $addressBookId
+	 * @param string $cardUri
+	 * @param string $cardData
+	 *
+	 * @return string|null
+	 */
+	public function createCard($addressBookId, $cardUri, $cardData)
+	{
+		$stmt = $this->pdo->prepare('INSERT INTO '.$this->cardsTableName.' (carddata, uri, lastmodified, addressbookid, size, etag) VALUES (?, ?, ?, ?, ?, ?)');
+
+		$etag = md5($cardData);
+
+		$stmt->execute([
+			$cardData,
+			$cardUri,
+			time(),
+			$addressBookId,
+			strlen($cardData),
+			$etag,
+		]);
+
+		$this->addChange($addressBookId, $cardUri, 1);
+
+		return '"'.$etag.'"';
+	}
+
+	/**
+	 * Updates a card.
+	 *
+	 * The addressbook id will be passed as the first argument. This is the
+	 * same id as it is returned from the getAddressBooksForUser method.
+	 *
+	 * The cardUri is a base uri, and doesn't include the full path. The
+	 * cardData argument is the vcard body, and is passed as a string.
+	 *
+	 * It is possible to return an ETag from this method. This ETag should
+	 * match that of the updated resource, and must be enclosed with double
+	 * quotes (that is: the string itself must contain the actual quotes).
+	 *
+	 * You should only return the ETag if you store the carddata as-is. If a
+	 * subsequent GET request on the same card does not have the same body,
+	 * byte-by-byte and you did return an ETag here, clients tend to get
+	 * confused.
+	 *
+	 * If you don't return an ETag, you can just return null.
+	 *
+	 * @param mixed  $addressBookId
+	 * @param string $cardUri
+	 * @param string $cardData
+	 *
+	 * @return string|null
+	 */
+	public function updateCard($addressBookId, $cardUri, $cardData)
+	{
+		$stmt = $this->pdo->prepare('UPDATE '.$this->cardsTableName.' SET carddata = ?, lastmodified = ?, size = ?, etag = ? WHERE uri = ? AND addressbookid =?');
+
+		$etag = md5($cardData);
+		$stmt->execute([
+			$cardData,
+			time(),
+			strlen($cardData),
+			$etag,
+			$cardUri,
+			$addressBookId,
+		]);
+
+		$this->addChange($addressBookId, $cardUri, 2);
+
+		return '"'.$etag.'"';
+	}
+
+	/**
+	 * Deletes a card.
+	 *
+	 * @param mixed  $addressBookId
+	 * @param string $cardUri
+	 *
+	 * @return bool
+	 */
+	public function deleteCard($addressBookId, $cardUri)
+	{
+		$stmt = $this->pdo->prepare('DELETE FROM '.$this->cardsTableName.' WHERE addressbookid = ? AND uri = ?');
+		$stmt->execute([$addressBookId, $cardUri]);
+
+		$this->addChange($addressBookId, $cardUri, 3);
+
+		return 1 === $stmt->rowCount();
+	}
+
+	/**
+	 * The getChanges method returns all the changes that have happened, since
+	 * the specified syncToken in the specified address book.
+	 *
+	 * This function should return an array, such as the following:
+	 *
+	 * [
+	 *   'syncToken' => 'The current synctoken',
+	 *   'added'   => [
+	 *      'new.txt',
+	 *   ],
+	 *   'modified'   => [
+	 *      'updated.txt',
+	 *   ],
+	 *   'deleted' => [
+	 *      'foo.php.bak',
+	 *      'old.txt'
+	 *   ]
+	 * ];
+	 *
+	 * The returned syncToken property should reflect the *current* syncToken
+	 * of the addressbook, as reported in the {http://sabredav.org/ns}sync-token
+	 * property. This is needed here too, to ensure the operation is atomic.
+	 *
+	 * If the $syncToken argument 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 $syncLevel 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 $limit 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 $addressBookId
+	 * @param string $syncToken
+	 * @param int    $syncLevel
+	 * @param int    $limit
+	 *
+	 * @return array|null
+	 */
+	public function getChangesForAddressBook($addressBookId, $syncToken, $syncLevel, $limit = null)
+	{
+		// Current synctoken
+		$stmt = $this->pdo->prepare('SELECT synctoken FROM '.$this->addressBooksTableName.' WHERE id = ?');
+		$stmt->execute([$addressBookId]);
+		$currentToken = $stmt->fetchColumn(0);
+
+		if (is_null($currentToken)) {
+			return null;
+		}
+
+		$result = [
+			'syncToken' => $currentToken,
+			'added' => [],
+			'modified' => [],
+			'deleted' => [],
+		];
+
+		if ($syncToken) {
+			$query = 'SELECT uri, operation FROM '.$this->addressBookChangesTableName.' WHERE synctoken >= ? AND synctoken < ? AND addressbookid = ? ORDER BY synctoken';
+			if ($limit > 0) {
+				$query .= ' LIMIT '.(int) $limit;
+			}
+
+			// Fetching all changes
+			$stmt = $this->pdo->prepare($query);
+			$stmt->execute([$syncToken, $currentToken, $addressBookId]);
+
+			$changes = [];
+
+			// This loop ensures that any duplicates are overwritten, only the
+			// last change on a node is relevant.
+			while ($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
+				$changes[$row['uri']] = $row['operation'];
+			}
+
+			foreach ($changes as $uri => $operation) {
+				switch ($operation) {
+					case 1:
+						$result['added'][] = $uri;
+						break;
+					case 2:
+						$result['modified'][] = $uri;
+						break;
+					case 3:
+						$result['deleted'][] = $uri;
+						break;
+				}
+			}
+		} else {
+			// No synctoken supplied, this is the initial sync.
+			$query = 'SELECT uri FROM '.$this->cardsTableName.' WHERE addressbookid = ?';
+			$stmt = $this->pdo->prepare($query);
+			$stmt->execute([$addressBookId]);
+
+			$result['added'] = $stmt->fetchAll(\PDO::FETCH_COLUMN);
+		}
+
+		return $result;
+	}
+
+	/**
+	 * Adds a change record to the addressbookchanges table.
+	 *
+	 * @param mixed  $addressBookId
+	 * @param string $objectUri
+	 * @param int    $operation     1 = add, 2 = modify, 3 = delete
+	 */
+	protected function addChange($addressBookId, $objectUri, $operation)
+	{
+		$stmt = $this->pdo->prepare('INSERT INTO '.$this->addressBookChangesTableName.' (uri, synctoken, addressbookid, operation) SELECT ?, synctoken, ?, ? FROM '.$this->addressBooksTableName.' WHERE id = ?');
+		$stmt->execute([
+			$objectUri,
+			$addressBookId,
+			$operation,
+			$addressBookId,
+		]);
+		$stmt = $this->pdo->prepare('UPDATE '.$this->addressBooksTableName.' SET synctoken = synctoken + 1 WHERE id = ?');
+		$stmt->execute([
+			$addressBookId,
+		]);
+	}
 }

htdocs/includes/sabre/sabre/dav/lib/CardDAV/AddressBookRoot.php

Indentation +51 added lines, -51 removed lines

@@ -17,59 +17,59 @@
  */
 class AddressBookRoot extends DAVACL\AbstractPrincipalCollection
 {
-    /**
-     * Principal Backend.
-     *
-     * @var DAVACL\PrincipalBackend\BackendInterface
-     */
-    protected $principalBackend;
+	/**
+	 * Principal Backend.
+	 *
+	 * @var DAVACL\PrincipalBackend\BackendInterface
+	 */
+	protected $principalBackend;
 
-    /**
-     * CardDAV backend.
-     *
-     * @var Backend\BackendInterface
-     */
-    protected $carddavBackend;
+	/**
+	 * CardDAV backend.
+	 *
+	 * @var Backend\BackendInterface
+	 */
+	protected $carddavBackend;
 
-    /**
-     * Constructor.
-     *
-     * This constructor needs both a principal and a carddav backend.
-     *
-     * By default this class will show a list of addressbook collections for
-     * principals in the 'principals' collection. If your main principals are
-     * actually located in a different path, use the $principalPrefix argument
-     * to override this.
-     *
-     * @param string $principalPrefix
-     */
-    public function __construct(DAVACL\PrincipalBackend\BackendInterface $principalBackend, Backend\BackendInterface $carddavBackend, $principalPrefix = 'principals')
-    {
-        $this->carddavBackend = $carddavBackend;
-        parent::__construct($principalBackend, $principalPrefix);
-    }
+	/**
+	 * Constructor.
+	 *
+	 * This constructor needs both a principal and a carddav backend.
+	 *
+	 * By default this class will show a list of addressbook collections for
+	 * principals in the 'principals' collection. If your main principals are
+	 * actually located in a different path, use the $principalPrefix argument
+	 * to override this.
+	 *
+	 * @param string $principalPrefix
+	 */
+	public function __construct(DAVACL\PrincipalBackend\BackendInterface $principalBackend, Backend\BackendInterface $carddavBackend, $principalPrefix = 'principals')
+	{
+		$this->carddavBackend = $carddavBackend;
+		parent::__construct($principalBackend, $principalPrefix);
+	}
 
-    /**
-     * Returns the name of the node.
-     *
-     * @return string
-     */
-    public function getName()
-    {
-        return Plugin::ADDRESSBOOK_ROOT;
-    }
+	/**
+	 * Returns the name of the node.
+	 *
+	 * @return string
+	 */
+	public function getName()
+	{
+		return Plugin::ADDRESSBOOK_ROOT;
+	}
 
-    /**
-     * This method returns a node for a principal.
-     *
-     * The passed array contains principal information, and is guaranteed to
-     * at least contain a uri item. Other properties may or may not be
-     * supplied by the authentication backend.
-     *
-     * @return \Sabre\DAV\INode
-     */
-    public function getChildForPrincipal(array $principal)
-    {
-        return new AddressBookHome($this->carddavBackend, $principal['uri']);
-    }
+	/**
+	 * This method returns a node for a principal.
+	 *
+	 * The passed array contains principal information, and is guaranteed to
+	 * at least contain a uri item. Other properties may or may not be
+	 * supplied by the authentication backend.
+	 *
+	 * @return \Sabre\DAV\INode
+	 */
+	public function getChildForPrincipal(array $principal)
+	{
+		return new AddressBookHome($this->carddavBackend, $principal['uri']);
+	}
 }

htdocs/includes/sabre/sabre/dav/lib/CardDAV/VCFExportPlugin.php

Indentation +139 added lines, -139 removed lines

@@ -23,143 +23,143 @@
  */
 class VCFExportPlugin extends DAV\ServerPlugin
 {
-    /**
-     * Reference to Server class.
-     *
-     * @var DAV\Server
-     */
-    protected $server;
-
-    /**
-     * Initializes the plugin and registers event handlers.
-     */
-    public function initialize(DAV\Server $server)
-    {
-        $this->server = $server;
-        $this->server->on('method:GET', [$this, 'httpGet'], 90);
-        $server->on('browserButtonActions', function ($path, $node, &$actions) {
-            if ($node instanceof IAddressBook) {
-                $actions .= '<a href="'.htmlspecialchars($path, ENT_QUOTES, 'UTF-8').'?export"><span class="oi" data-glyph="book"></span></a>';
-            }
-        });
-    }
-
-    /**
-     * Intercepts GET requests on addressbook urls ending with ?export.
-     *
-     * @return bool
-     */
-    public function httpGet(RequestInterface $request, ResponseInterface $response)
-    {
-        $queryParams = $request->getQueryParameters();
-        if (!array_key_exists('export', $queryParams)) {
-            return;
-        }
-
-        $path = $request->getPath();
-
-        $node = $this->server->tree->getNodeForPath($path);
-
-        if (!($node instanceof IAddressBook)) {
-            return;
-        }
-
-        $this->server->transactionType = 'get-addressbook-export';
-
-        // Checking ACL, if available.
-        if ($aclPlugin = $this->server->getPlugin('acl')) {
-            $aclPlugin->checkPrivileges($path, '{DAV:}read');
-        }
-
-        $nodes = $this->server->getPropertiesForPath($path, [
-            '{'.Plugin::NS_CARDDAV.'}address-data',
-        ], 1);
-
-        $format = 'text/directory';
-
-        $output = null;
-        $filenameExtension = null;
-
-        switch ($format) {
-            case 'text/directory':
-                $output = $this->generateVCF($nodes);
-                $filenameExtension = '.vcf';
-                break;
-        }
-
-        $filename = preg_replace(
-            '/[^a-zA-Z0-9-_ ]/um',
-            '',
-            $node->getName()
-        );
-        $filename .= '-'.date('Y-m-d').$filenameExtension;
-
-        $response->setHeader('Content-Disposition', 'attachment; filename="'.$filename.'"');
-        $response->setHeader('Content-Type', $format);
-
-        $response->setStatus(200);
-        $response->setBody($output);
-
-        // Returning false to break the event chain
-        return false;
-    }
-
-    /**
-     * Merges all vcard objects, and builds one big vcf export.
-     *
-     * @return string
-     */
-    public function generateVCF(array $nodes)
-    {
-        $output = '';
-
-        foreach ($nodes as $node) {
-            if (!isset($node[200]['{'.Plugin::NS_CARDDAV.'}address-data'])) {
-                continue;
-            }
-            $nodeData = $node[200]['{'.Plugin::NS_CARDDAV.'}address-data'];
-
-            // Parsing this node so VObject can clean up the output.
-            $vcard = VObject\Reader::read($nodeData);
-            $output .= $vcard->serialize();
-
-            // Destroy circular references to PHP will GC the object.
-            $vcard->destroy();
-        }
-
-        return $output;
-    }
-
-    /**
-     * Returns a plugin name.
-     *
-     * Using this name other plugins will be able to access other plugins
-     * using \Sabre\DAV\Server::getPlugin
-     *
-     * @return string
-     */
-    public function getPluginName()
-    {
-        return 'vcf-export';
-    }
-
-    /**
-     * Returns a bunch of meta-data about the plugin.
-     *
-     * Providing this information is optional, and is mainly displayed by the
-     * Browser plugin.
-     *
-     * The description key in the returned array may contain html and will not
-     * be sanitized.
-     *
-     * @return array
-     */
-    public function getPluginInfo()
-    {
-        return [
-            'name' => $this->getPluginName(),
-            'description' => 'Adds the ability to export CardDAV addressbooks as a single vCard file.',
-            'link' => 'http://sabre.io/dav/vcf-export-plugin/',
-        ];
-    }
+	/**
+	 * Reference to Server class.
+	 *
+	 * @var DAV\Server
+	 */
+	protected $server;
+
+	/**
+	 * Initializes the plugin and registers event handlers.
+	 */
+	public function initialize(DAV\Server $server)
+	{
+		$this->server = $server;
+		$this->server->on('method:GET', [$this, 'httpGet'], 90);
+		$server->on('browserButtonActions', function ($path, $node, &$actions) {
+			if ($node instanceof IAddressBook) {
+				$actions .= '<a href="'.htmlspecialchars($path, ENT_QUOTES, 'UTF-8').'?export"><span class="oi" data-glyph="book"></span></a>';
+			}
+		});
+	}
+
+	/**
+	 * Intercepts GET requests on addressbook urls ending with ?export.
+	 *
+	 * @return bool
+	 */
+	public function httpGet(RequestInterface $request, ResponseInterface $response)
+	{
+		$queryParams = $request->getQueryParameters();
+		if (!array_key_exists('export', $queryParams)) {
+			return;
+		}
+
+		$path = $request->getPath();
+
+		$node = $this->server->tree->getNodeForPath($path);
+
+		if (!($node instanceof IAddressBook)) {
+			return;
+		}
+
+		$this->server->transactionType = 'get-addressbook-export';
+
+		// Checking ACL, if available.
+		if ($aclPlugin = $this->server->getPlugin('acl')) {
+			$aclPlugin->checkPrivileges($path, '{DAV:}read');
+		}
+
+		$nodes = $this->server->getPropertiesForPath($path, [
+			'{'.Plugin::NS_CARDDAV.'}address-data',
+		], 1);
+
+		$format = 'text/directory';
+
+		$output = null;
+		$filenameExtension = null;
+
+		switch ($format) {
+			case 'text/directory':
+				$output = $this->generateVCF($nodes);
+				$filenameExtension = '.vcf';
+				break;
+		}
+
+		$filename = preg_replace(
+			'/[^a-zA-Z0-9-_ ]/um',
+			'',
+			$node->getName()
+		);
+		$filename .= '-'.date('Y-m-d').$filenameExtension;
+
+		$response->setHeader('Content-Disposition', 'attachment; filename="'.$filename.'"');
+		$response->setHeader('Content-Type', $format);
+
+		$response->setStatus(200);
+		$response->setBody($output);
+
+		// Returning false to break the event chain
+		return false;
+	}
+
+	/**
+	 * Merges all vcard objects, and builds one big vcf export.
+	 *
+	 * @return string
+	 */
+	public function generateVCF(array $nodes)
+	{
+		$output = '';
+
+		foreach ($nodes as $node) {
+			if (!isset($node[200]['{'.Plugin::NS_CARDDAV.'}address-data'])) {
+				continue;
+			}
+			$nodeData = $node[200]['{'.Plugin::NS_CARDDAV.'}address-data'];
+
+			// Parsing this node so VObject can clean up the output.
+			$vcard = VObject\Reader::read($nodeData);
+			$output .= $vcard->serialize();
+
+			// Destroy circular references to PHP will GC the object.
+			$vcard->destroy();
+		}
+
+		return $output;
+	}
+
+	/**
+	 * Returns a plugin name.
+	 *
+	 * Using this name other plugins will be able to access other plugins
+	 * using \Sabre\DAV\Server::getPlugin
+	 *
+	 * @return string
+	 */
+	public function getPluginName()
+	{
+		return 'vcf-export';
+	}
+
+	/**
+	 * Returns a bunch of meta-data about the plugin.
+	 *
+	 * Providing this information is optional, and is mainly displayed by the
+	 * Browser plugin.
+	 *
+	 * The description key in the returned array may contain html and will not
+	 * be sanitized.
+	 *
+	 * @return array
+	 */
+	public function getPluginInfo()
+	{
+		return [
+			'name' => $this->getPluginName(),
+			'description' => 'Adds the ability to export CardDAV addressbooks as a single vCard file.',
+			'link' => 'http://sabre.io/dav/vcf-export-plugin/',
+		];
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -37,7 +37,7 @@
     {
         $this->server = $server;
         $this->server->on('method:GET', [$this, 'httpGet'], 90);
-        $server->on('browserButtonActions', function ($path, $node, &$actions) {
+        $server->on('browserButtonActions', function($path, $node, &$actions) {
             if ($node instanceof IAddressBook) {
                 $actions .= '<a href="'.htmlspecialchars($path, ENT_QUOTES, 'UTF-8').'?export"><span class="oi" data-glyph="book"></span></a>';
             }