nextcloud/apps/dav/lib/CardDAV/MultiGetExportPlugin.php

125 lines
3.4 KiB
PHP
Raw Normal View History

<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2018 John Molakvoæ <skjnldsv@protonmail.com>
*
* @author John Molakvoæ (skjnldsv) <skjnldsv@protonmail.com>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* 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
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCA\DAV\CardDAV;
use Sabre\DAV;
use Sabre\DAV\Server;
use Sabre\HTTP\RequestInterface;
use Sabre\HTTP\ResponseInterface;
class MultiGetExportPlugin extends DAV\ServerPlugin {
/** @var Server */
protected $server;
/**
* Initializes the plugin and registers event handlers
*
* @param Server $server
* @return void
*/
public function initialize(Server $server) {
$this->server = $server;
$this->server->on('afterMethod:REPORT', [$this, 'httpReport'], 90);
}
/**
* Intercepts REPORT requests
*
* @param RequestInterface $request
* @param ResponseInterface $response
* @return bool
*/
public function httpReport(RequestInterface $request, ResponseInterface $response) {
$queryParams = $request->getQueryParameters();
if (!array_key_exists('export', $queryParams)) {
return;
}
// Only handling xml
$contentType = $response->getHeader('Content-Type');
if (strpos($contentType, 'application/xml') === false && strpos($contentType, 'text/xml') === false) {
return;
}
$this->server->transactionType = 'vcf-multi-get-intercept-and-export';
// Get the xml response
$responseBody = $response->getBodyAsString();
$responseXml = $this->server->xml->parse($responseBody);
// Reduce the vcards into one string
$output = array_reduce($responseXml->getResponses(), function ($vcf, $card) {
$vcf .= $card->getResponseProperties()[200]['{urn:ietf:params:xml:ns:carddav}address-data'];
return $vcf;
}, '');
// Build and override the response
$filename = 'vcfexport-' . date('Y-m-d') . '.vcf';
$response->setHeader('Content-Disposition', 'attachment; filename="' . $filename . '"');
$response->setHeader('Content-Type', 'text/vcard');
$response->setStatus(200);
$response->setBody($output);
return true;
}
/**
* 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-multi-get-intercept-and-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' => 'Intercept a multi-get request and return a single vcf file instead.'
];
}
}