tyler.durden/icingaweb2-module-director
1
0
Fork 0
mirror of https://github.com/Icinga/icingaweb2-module-director.git synced 2025-09-25 10:57:41 +02:00
Code Issues Packages Projects Releases Wiki Activity

RestApi: cleanup, exceptions, phpdoc

Browse Source
This commit is contained in:
Thomas Gelf 2018-06-14 08:33:11 +02:00
parent 6b67662de7
commit 75268479ca
1 changed files with 37 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
library/Director/Web/Controller/Extension/RestApi.php
View File

@ -4,7 +4,10 @@ namespace Icinga\Module\Director\Web\Controller\Extension;
use Icinga\Exception\AuthenticationException; use Icinga\Exception\AuthenticationException;
use Icinga\Exception\NotFoundError; use Icinga\Exception\NotFoundError;
use Icinga\Module\Director\Exception\JsonException;
use Icinga\Web\Response; use Icinga\Web\Response;
use InvalidArgumentException;
use Zend_Controller_Response_Exception;
trait RestApi trait RestApi
{ {
@ -17,9 +20,14 @@ trait RestApi
} }
} }
/**
* @return bool
*/
protected function sendNotFoundForRestApi() protected function sendNotFoundForRestApi()
{ {
if ($this->getRequest()->isApiRequest()) { /** @var \Icinga\Web\Request $request */
$request = $this->getRequest();
if ($request->isApiRequest()) {
$this->sendJsonError($this->getResponse(), 'Not found', 404); $this->sendJsonError($this->getResponse(), 'Not found', 404);
return true; return true;
} else { } else {
@ -27,6 +35,9 @@ trait RestApi
} }
} }
/**
* @throws AuthenticationException
*/
protected function assertApiPermission() protected function assertApiPermission()
{ {
if (! $this->hasPermission('director/api')) { if (! $this->hasPermission('director/api')) {
@ -34,9 +45,15 @@ trait RestApi
} }
} }
/**
* @throws AuthenticationException
* @throws NotFoundError
*/
protected function checkForRestApiRequest() protected function checkForRestApiRequest()
{ {
if ($this->getRequest()->isApiRequest()) { /** @var \Icinga\Web\Request $request */
$request = $this->getRequest();
if ($request->isApiRequest()) {
$this->assertApiPermission(); $this->assertApiPermission();
if (! $this->isApified()) { if (! $this->isApified()) {
throw new NotFoundError('No such API endpoint found'); throw new NotFoundError('No such API endpoint found');
@ -44,37 +61,39 @@ trait RestApi
} }
} }
/**
* @param Response $response
* @param $object
*/
protected function sendJson(Response $response, $object) protected function sendJson(Response $response, $object)
{ {
$response->setHeader('Content-Type', 'application/json', true); $response->setHeader('Content-Type', 'application/json', true);
echo json_encode($object, JSON_PRETTY_PRINT) . "\n"; echo json_encode($object, JSON_PRETTY_PRINT) . "\n";
} }
/**
* @param Response $response
* @param string $message
* @param int|null $code
*/
protected function sendJsonError(Response $response, $message, $code = null) protected function sendJsonError(Response $response, $message, $code = null)
{ {
if ($code !== null) { if ($code !== null) {
$response->setHttpResponseCode((int) $code); try {
$response->setHttpResponseCode((int) $code);
} catch (Zend_Controller_Response_Exception $e) {
throw new InvalidArgumentException($e->getMessage(), 0, $e);
}
} }
$this->sendJson($response, (object) ['error' => $message]); $this->sendJson($response, (object) ['error' => $message]);
} }
// TODO: just return json_last_error_msg() for PHP >= 5.5.0 /**
* @return string
*/
protected function getLastJsonError() protected function getLastJsonError()
{ {
switch (json_last_error()) { return JsonException::getJsonErrorMessage(json_last_error());
case JSON_ERROR_DEPTH:
return 'The maximum stack depth has been exceeded';
case JSON_ERROR_CTRL_CHAR:
return 'Control character error, possibly incorrectly encoded';
case JSON_ERROR_STATE_MISMATCH:
return 'Invalid or malformed JSON';
case JSON_ERROR_SYNTAX:
return 'Syntax error';
case JSON_ERROR_UTF8:
return 'Malformed UTF-8 characters, possibly incorrectly encoded';
default:
return 'An error occured when parsing a JSON string';
}
} }
} }