114 lines
3.7 KiB
PHP
114 lines
3.7 KiB
PHP
<?php
|
|
/**
|
|
* @copyright Copyright (c) 2016, ownCloud, Inc.
|
|
*
|
|
* @author Bernhard Posselt <dev@bernhard-posselt.com>
|
|
* @author Donquixote <marjunebatac@gmail.com>
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
|
* @author Roeland Jago Douma <roeland@famdouma.nl>
|
|
* @author Stefan Weil <sw@weilnetz.de>
|
|
* @author Thomas Müller <thomas.mueller@tmit.eu>
|
|
*
|
|
* @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/>
|
|
*
|
|
*/
|
|
|
|
/**
|
|
* Public interface of ownCloud for apps to use.
|
|
* AppFramework\Controller class
|
|
*/
|
|
|
|
namespace OCP\AppFramework;
|
|
|
|
use OCP\AppFramework\Http\DataResponse;
|
|
use OCP\AppFramework\Http\Response;
|
|
use OCP\IRequest;
|
|
|
|
/**
|
|
* Base class to inherit your controllers from that are used for RESTful APIs
|
|
* @since 8.1.0
|
|
*/
|
|
abstract class OCSController extends ApiController {
|
|
|
|
/** @var int */
|
|
private $ocsVersion;
|
|
|
|
/**
|
|
* constructor of the controller
|
|
* @param string $appName the name of the app
|
|
* @param IRequest $request an instance of the request
|
|
* @param string $corsMethods comma separated string of HTTP verbs which
|
|
* should be allowed for websites or webapps when calling your API, defaults to
|
|
* 'PUT, POST, GET, DELETE, PATCH'
|
|
* @param string $corsAllowedHeaders comma separated string of HTTP headers
|
|
* which should be allowed for websites or webapps when calling your API,
|
|
* defaults to 'Authorization, Content-Type, Accept'
|
|
* @param int $corsMaxAge number in seconds how long a preflighted OPTIONS
|
|
* request should be cached, defaults to 1728000 seconds
|
|
* @since 8.1.0
|
|
*/
|
|
public function __construct($appName,
|
|
IRequest $request,
|
|
$corsMethods='PUT, POST, GET, DELETE, PATCH',
|
|
$corsAllowedHeaders='Authorization, Content-Type, Accept',
|
|
$corsMaxAge=1728000){
|
|
parent::__construct($appName, $request, $corsMethods,
|
|
$corsAllowedHeaders, $corsMaxAge);
|
|
$this->registerResponder('json', function ($data) {
|
|
return $this->buildOCSResponse('json', $data);
|
|
});
|
|
$this->registerResponder('xml', function ($data) {
|
|
return $this->buildOCSResponse('xml', $data);
|
|
});
|
|
}
|
|
|
|
/**
|
|
* @param int $version
|
|
* @since 11.0.0
|
|
* @internal
|
|
*/
|
|
public function setOCSVersion($version) {
|
|
$this->ocsVersion = $version;
|
|
}
|
|
|
|
/**
|
|
* Since the OCS endpoints default to XML we need to find out the format
|
|
* again
|
|
* @param mixed $response the value that was returned from a controller and
|
|
* is not a Response instance
|
|
* @param string $format the format for which a formatter has been registered
|
|
* @throws \DomainException if format does not match a registered formatter
|
|
* @return Response
|
|
* @since 9.1.0
|
|
*/
|
|
public function buildResponse($response, $format = 'xml') {
|
|
return parent::buildResponse($response, $format);
|
|
}
|
|
|
|
/**
|
|
* Unwrap data and build ocs response
|
|
* @param string $format json or xml
|
|
* @param DataResponse $data the data which should be transformed
|
|
* @since 8.1.0
|
|
* @return \OC\AppFramework\OCS\BaseResponse
|
|
*/
|
|
private function buildOCSResponse($format, DataResponse $data) {
|
|
if ($this->ocsVersion === 1) {
|
|
return new \OC\AppFramework\OCS\V1Response($data, $format);
|
|
}
|
|
return new \OC\AppFramework\OCS\V2Response($data, $format);
|
|
}
|
|
|
|
}
|