2016-07-20 10:43:02 +03:00
|
|
|
<?php
|
|
|
|
/**
|
|
|
|
*
|
2017-11-06 17:56:42 +03:00
|
|
|
*
|
2020-04-29 12:57:22 +03:00
|
|
|
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
|
2017-11-06 17:56:42 +03:00
|
|
|
* @author Lukas Reschke <lukas@statuscode.ch>
|
2016-07-20 10:43:02 +03:00
|
|
|
* @author Roeland Jago Douma <roeland@famdouma.nl>
|
|
|
|
*
|
|
|
|
* @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
|
2019-12-03 21:57:53 +03:00
|
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
2016-07-20 10:43:02 +03:00
|
|
|
*
|
|
|
|
*/
|
2019-11-22 22:52:10 +03:00
|
|
|
|
2016-07-20 10:43:02 +03:00
|
|
|
namespace OC\AppFramework\Middleware;
|
|
|
|
|
|
|
|
use OC\AppFramework\Http;
|
2016-09-05 22:00:53 +03:00
|
|
|
use OC\AppFramework\OCS\BaseResponse;
|
|
|
|
use OC\AppFramework\OCS\V1Response;
|
|
|
|
use OC\AppFramework\OCS\V2Response;
|
2016-08-11 10:44:12 +03:00
|
|
|
use OCP\API;
|
2016-09-05 22:00:53 +03:00
|
|
|
use OCP\AppFramework\Controller;
|
2016-08-11 10:44:12 +03:00
|
|
|
use OCP\AppFramework\Http\DataResponse;
|
|
|
|
use OCP\AppFramework\Http\JSONResponse;
|
|
|
|
use OCP\AppFramework\Http\Response;
|
2019-11-22 22:52:10 +03:00
|
|
|
use OCP\AppFramework\Middleware;
|
2016-07-20 10:43:02 +03:00
|
|
|
use OCP\AppFramework\OCS\OCSException;
|
|
|
|
use OCP\AppFramework\OCSController;
|
|
|
|
use OCP\IRequest;
|
|
|
|
|
|
|
|
class OCSMiddleware extends Middleware {
|
|
|
|
|
|
|
|
/** @var IRequest */
|
|
|
|
private $request;
|
|
|
|
|
2016-09-05 22:00:53 +03:00
|
|
|
/** @var int */
|
|
|
|
private $ocsVersion;
|
|
|
|
|
2016-07-20 10:43:02 +03:00
|
|
|
/**
|
|
|
|
* @param IRequest $request
|
|
|
|
*/
|
|
|
|
public function __construct(IRequest $request) {
|
|
|
|
$this->request = $request;
|
|
|
|
}
|
|
|
|
|
2016-09-05 22:00:53 +03:00
|
|
|
/**
|
2017-07-26 10:03:04 +03:00
|
|
|
* @param Controller $controller
|
2016-09-05 22:00:53 +03:00
|
|
|
* @param string $methodName
|
|
|
|
*/
|
2017-08-01 18:32:03 +03:00
|
|
|
public function beforeController($controller, $methodName) {
|
2016-09-05 22:00:53 +03:00
|
|
|
if ($controller instanceof OCSController) {
|
|
|
|
if (substr_compare($this->request->getScriptName(), '/ocs/v2.php', -strlen('/ocs/v2.php')) === 0) {
|
|
|
|
$this->ocsVersion = 2;
|
|
|
|
} else {
|
|
|
|
$this->ocsVersion = 1;
|
|
|
|
}
|
|
|
|
$controller->setOCSVersion($this->ocsVersion);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-07-20 10:43:02 +03:00
|
|
|
/**
|
2017-07-26 10:03:04 +03:00
|
|
|
* @param Controller $controller
|
2016-07-20 10:43:02 +03:00
|
|
|
* @param string $methodName
|
|
|
|
* @param \Exception $exception
|
|
|
|
* @throws \Exception
|
2016-09-05 22:00:53 +03:00
|
|
|
* @return BaseResponse
|
2016-07-20 10:43:02 +03:00
|
|
|
*/
|
2017-08-01 18:32:03 +03:00
|
|
|
public function afterException($controller, $methodName, \Exception $exception) {
|
2016-07-20 10:43:02 +03:00
|
|
|
if ($controller instanceof OCSController && $exception instanceof OCSException) {
|
|
|
|
$code = $exception->getCode();
|
|
|
|
if ($code === 0) {
|
2016-08-11 10:44:12 +03:00
|
|
|
$code = API::RESPOND_UNKNOWN_ERROR;
|
2016-07-20 10:43:02 +03:00
|
|
|
}
|
2016-08-11 10:44:12 +03:00
|
|
|
|
2016-09-05 22:00:53 +03:00
|
|
|
return $this->buildNewResponse($controller, $code, $exception->getMessage());
|
2016-07-20 10:43:02 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
throw $exception;
|
|
|
|
}
|
|
|
|
|
2016-08-11 10:44:12 +03:00
|
|
|
/**
|
2017-07-26 10:03:04 +03:00
|
|
|
* @param Controller $controller
|
2016-08-11 10:44:12 +03:00
|
|
|
* @param string $methodName
|
|
|
|
* @param Response $response
|
|
|
|
* @return \OCP\AppFramework\Http\Response
|
|
|
|
*/
|
2017-08-01 18:32:03 +03:00
|
|
|
public function afterController($controller, $methodName, Response $response) {
|
2016-08-11 10:44:12 +03:00
|
|
|
/*
|
|
|
|
* If a different middleware has detected that a request unauthorized or forbidden
|
|
|
|
* we need to catch the response and convert it to a proper OCS response.
|
|
|
|
*/
|
2016-09-05 22:00:53 +03:00
|
|
|
if ($controller instanceof OCSController && !($response instanceof BaseResponse)) {
|
2016-08-11 10:44:12 +03:00
|
|
|
if ($response->getStatus() === Http::STATUS_UNAUTHORIZED ||
|
2020-04-09 10:22:29 +03:00
|
|
|
$response->getStatus() === Http::STATUS_FORBIDDEN) {
|
2016-08-11 10:44:12 +03:00
|
|
|
$message = '';
|
|
|
|
if ($response instanceof JSONResponse) {
|
|
|
|
/** @var DataResponse $response */
|
|
|
|
$message = $response->getData()['message'];
|
|
|
|
}
|
2016-09-05 22:00:53 +03:00
|
|
|
|
|
|
|
return $this->buildNewResponse($controller, API::RESPOND_UNAUTHORISED, $message);
|
2016-08-11 10:44:12 +03:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return $response;
|
|
|
|
}
|
|
|
|
|
2016-09-05 22:00:53 +03:00
|
|
|
/**
|
|
|
|
* @param Controller $controller
|
|
|
|
* @param int $code
|
|
|
|
* @param string $message
|
|
|
|
* @return V1Response|V2Response
|
|
|
|
*/
|
2017-07-26 10:03:04 +03:00
|
|
|
private function buildNewResponse(Controller $controller, $code, $message) {
|
2016-09-05 22:00:53 +03:00
|
|
|
$format = $this->getFormat($controller);
|
|
|
|
|
|
|
|
$data = new DataResponse();
|
|
|
|
$data->setStatus($code);
|
|
|
|
if ($this->ocsVersion === 1) {
|
|
|
|
$response = new V1Response($data, $format, $message);
|
|
|
|
} else {
|
|
|
|
$response = new V2Response($data, $format, $message);
|
|
|
|
}
|
|
|
|
|
|
|
|
return $response;
|
|
|
|
}
|
|
|
|
|
2016-07-20 10:43:02 +03:00
|
|
|
/**
|
2017-07-26 10:03:04 +03:00
|
|
|
* @param Controller $controller
|
2016-07-20 10:43:02 +03:00
|
|
|
* @return string
|
|
|
|
*/
|
2017-07-26 10:03:04 +03:00
|
|
|
private function getFormat(Controller $controller) {
|
2016-07-20 10:43:02 +03:00
|
|
|
// get format from the url format or request format parameter
|
|
|
|
$format = $this->request->getParam('format');
|
|
|
|
|
|
|
|
// if none is given try the first Accept header
|
2020-04-10 15:19:56 +03:00
|
|
|
if ($format === null) {
|
2016-07-20 10:43:02 +03:00
|
|
|
$headers = $this->request->getHeader('Accept');
|
2016-07-20 22:30:39 +03:00
|
|
|
$format = $controller->getResponderByHTTPHeader($headers, 'xml');
|
2016-07-20 10:43:02 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
return $format;
|
|
|
|
}
|
|
|
|
}
|