2017-03-25 13:56:40 +03:00
|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* @author Georg Ehrke <oc.list@georgehrke.com>
|
|
|
|
*
|
|
|
|
* @copyright Copyright (c) 2017 Georg Ehrke <oc.list@georgehrke.com>
|
|
|
|
* @license GNU AGPL version 3 or any later version
|
|
|
|
*
|
|
|
|
* 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\Search;
|
|
|
|
|
|
|
|
use Sabre\DAV\Server;
|
|
|
|
use Sabre\DAV\ServerPlugin;
|
|
|
|
use OCA\DAV\CalDAV\CalendarHome;
|
|
|
|
|
|
|
|
class SearchPlugin extends ServerPlugin {
|
|
|
|
const NS_Nextcloud = 'http://nextcloud.com/ns';
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Reference to SabreDAV server object.
|
|
|
|
*
|
|
|
|
* @var \Sabre\DAV\Server
|
|
|
|
*/
|
|
|
|
protected $server;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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 ['nc-calendar-search'];
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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 'nc-calendar-search';
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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;
|
|
|
|
|
|
|
|
$server->on('report', [$this, 'report']);
|
|
|
|
|
|
|
|
$server->xml->elementMap['{' . self::NS_Nextcloud . '}calendar-search'] =
|
|
|
|
'OCA\\DAV\\CalDAV\\Search\\Xml\\Request\\CalendarSearchReport';
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* This functions handles REPORT requests specific to CalDAV
|
|
|
|
*
|
|
|
|
* @param string $reportName
|
|
|
|
* @param mixed $report
|
|
|
|
* @param mixed $path
|
|
|
|
* @return bool
|
|
|
|
*/
|
2017-04-25 17:37:13 +03:00
|
|
|
public function report($reportName, $report, $path) {
|
2017-03-25 13:56:40 +03:00
|
|
|
switch ($reportName) {
|
2017-04-25 17:37:13 +03:00
|
|
|
case '{' . self::NS_Nextcloud . '}calendar-search':
|
2017-03-25 13:56:40 +03:00
|
|
|
$this->server->transactionType = 'report-nc-calendar-search';
|
|
|
|
$this->calendarSearch($report);
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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);
|
|
|
|
|
|
|
|
$reports = [];
|
|
|
|
if ($node instanceof CalendarHome) {
|
|
|
|
$reports[] = '{' . self::NS_Nextcloud . '}calendar-search';
|
|
|
|
}
|
|
|
|
|
|
|
|
return $reports;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* This function handles the calendar-query REPORT
|
|
|
|
*
|
|
|
|
* This report is used by clients to request calendar objects based on
|
|
|
|
* complex conditions.
|
|
|
|
*
|
|
|
|
* @param Xml\Request\CalendarSearchReport $report
|
|
|
|
* @return void
|
|
|
|
*/
|
|
|
|
private function calendarSearch($report) {
|
|
|
|
$node = $this->server->tree->getNodeForPath($this->server->getRequestUri());
|
2017-04-25 17:37:13 +03:00
|
|
|
$depth = $this->server->getHTTPDepth(2);
|
2017-03-25 13:56:40 +03:00
|
|
|
|
|
|
|
// The default result is an empty array
|
|
|
|
$result = [];
|
|
|
|
|
|
|
|
// If we're dealing with the calendar home, the calendar home itself is
|
|
|
|
// responsible for the calendar-query
|
2017-05-10 15:03:14 +03:00
|
|
|
if ($node instanceof CalendarHome && $depth === 2) {
|
2017-03-25 13:56:40 +03:00
|
|
|
|
|
|
|
$nodePaths = $node->calendarSearch($report->filters, $report->limit, $report->offset);
|
|
|
|
|
|
|
|
foreach ($nodePaths as $path) {
|
|
|
|
list($properties) = $this->server->getPropertiesForPath(
|
|
|
|
$this->server->getRequestUri() . '/' . $path,
|
|
|
|
$report->properties);
|
|
|
|
$result[] = $properties;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
$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,
|
|
|
|
$prefer['return'] === 'minimal'));
|
|
|
|
}
|
2017-05-10 15:03:14 +03:00
|
|
|
}
|