owncloud/core

View on GitHub
apps/dav/lib/CalDAV/Publishing/PublishPlugin.php

Summary

Maintainability
B
6 hrs
Test Coverage
<?php
/**
 * @author Thomas Citharel <tcit@tcit.fr>
 * @author Thomas Müller <thomas.mueller@tmit.eu>
 *
 * @copyright Copyright (c) 2018, ownCloud GmbH
 * @license AGPL-3.0
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */
namespace OCA\DAV\CalDAV\Publishing;

use OCA\DAV\CalDAV\Calendar;
use OCA\DAV\CalDAV\Publishing\Xml\Publisher;
use OCP\IConfig;
use OCP\IURLGenerator;
use Sabre\CalDAV\Xml\Property\AllowedSharingModes;
use Sabre\DAV\Exception\NotFound;
use Sabre\DAV\INode;
use Sabre\DAV\PropFind;
use Sabre\DAV\Server;
use Sabre\DAV\ServerPlugin;
use Sabre\HTTP\RequestInterface;
use Sabre\HTTP\ResponseInterface;

class PublishPlugin extends ServerPlugin {
    public const NS_CALENDARSERVER = 'http://calendarserver.org/ns/';

    /**
     * Reference to SabreDAV server object.
     *
     * @var \Sabre\DAV\Server
     */
    protected $server;

    /**
     * Config instance to get instance secret.
     *
     * @var IConfig
     */
    protected $config;

    /**
     * URL Generator for absolute URLs.
     *
     * @var IURLGenerator
     */
    protected $urlGenerator;

    /**
     * PublishPlugin constructor.
     *
     * @param IConfig $config
     * @param IURLGenerator $urlGenerator
     */
    public function __construct(IConfig $config, IURLGenerator $urlGenerator) {
        $this->config = $config;
        $this->urlGenerator = $urlGenerator;
    }

    /**
     * This method should return a list of server-features.
     *
     * This is for example 'versioning' and is added to the DAV: header
     * in an OPTIONS response.
     *
     * @return string[]
     */
    public function getFeatures() {
        // May have to be changed to be detected
        return ['oc-calendar-publishing', 'calendarserver-sharing'];
    }

    /**
     * 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 'oc-calendar-publishing';
    }

    /**
     * This initializes the plugin.
     *
     * This function is called by Sabre\DAV\Server, after
     * addPlugin is called.
     *
     * This method should set up the required event subscriptions.
     *
     * @param Server $server
     */
    public function initialize(Server $server) {
        $this->server = $server;

        $this->server->on('method:POST', [$this, 'httpPost']);
        $this->server->on('propFind', [$this, 'propFind']);
    }

    public function propFind(PropFind $propFind, INode $node) {
        if ($node instanceof Calendar) {
            $propFind->handle('{'.self::NS_CALENDARSERVER.'}publish-url', function () use ($node) {
                if ($node->getPublishStatus()) {
                    // We return the publish-url only if the calendar is published.
                    $token = $node->getPublishStatus();
                    $publishUrl = $this->urlGenerator->getAbsoluteURL($this->server->getBaseUri().'public-calendars/').$token;

                    return new Publisher($publishUrl, true);
                }
            });

            $propFind->handle('{'.self::NS_CALENDARSERVER.'}allowed-sharing-modes', function () use ($node) {
                return new AllowedSharingModes(!$node->isSubscription(), !$node->isSubscription());
            });
        }
    }

    /**
     * We intercept this to handle POST requests on calendars.
     *
     * @param RequestInterface $request
     * @param ResponseInterface $response
     *
     * @return null|bool
     */
    public function httpPost(RequestInterface $request, ResponseInterface $response) {
        $path = $request->getPath();

        // Only handling xml
        $contentType = $request->getHeader('Content-Type');
        if (\strpos($contentType, 'application/xml') === false && \strpos($contentType, 'text/xml') === false) {
            return;
        }

        // Making sure the node exists
        try {
            $node = $this->server->tree->getNodeForPath($path);
        } catch (NotFound $e) {
            return;
        }

        $requestBody = $request->getBodyAsString();

        // If this request handler could not deal with this POST request, it
        // will return 'null' and other plugins get a chance to handle the
        // request.
        //
        // However, we already requested the full body. This is a problem,
        // because a body can only be read once. This is why we preemptively
        // re-populated the request body with the existing data.
        $request->setBody($requestBody);

        $this->server->xml->parse($requestBody, $request->getUrl(), $documentType);

        switch ($documentType) {
            case '{'.self::NS_CALENDARSERVER.'}publish-calendar':

                // We can only deal with IShareableCalendar objects
                if (!$node instanceof Calendar) {
                    return;
                }
                $this->server->transactionType = 'post-publish-calendar';

                // Getting ACL info
                $acl = $this->server->getPlugin('acl');

                // If there's no ACL support, we allow everything
                if ($acl) {
                    '@phan-var \OCA\DAV\Connector\Sabre\DavAclPlugin $acl';
                    $acl->checkPrivileges($path, '{DAV:}write');
                }

                $node->setPublishStatus(true);

                // iCloud sends back the 202, so we will too.
                $response->setStatus(202);

                // Adding this because sending a response body may cause issues,
                // and I wanted some type of indicator the response was handled.
                $response->setHeader('X-Sabre-Status', 'everything-went-well');

                // Breaking the event chain
                return false;

            case '{'.self::NS_CALENDARSERVER.'}unpublish-calendar':

                // We can only deal with IShareableCalendar objects
                if (!$node instanceof Calendar) {
                    return;
                }
                $this->server->transactionType = 'post-unpublish-calendar';

                // Getting ACL info
                $acl = $this->server->getPlugin('acl');

                // If there's no ACL support, we allow everything
                if ($acl) {
                    '@phan-var \OCA\DAV\Connector\Sabre\DavAclPlugin $acl';
                    $acl->checkPrivileges($path, '{DAV:}write');
                }

                $node->setPublishStatus(false);

                $response->setStatus(200);

                // Adding this because sending a response body may cause issues,
                // and I wanted some type of indicator the response was handled.
                $response->setHeader('X-Sabre-Status', 'everything-went-well');

                // Breaking the event chain
                return false;
        }
    }
}