tyler.durden/icingaweb2
1
0
Fork 0
mirror of https://github.com/Icinga/icingaweb2.git synced 2025-09-25 18:59:04 +02:00
Code Issues Packages Projects Releases Wiki Activity

JsonResponse: Try to serve as much output as possible on PHP 5.5+

Browse Source 
...and add some logging to ease tracking errors.

refs #2635
This commit is contained in:
Johannes Meyer 2017-02-03 11:44:33 +01:00
parent 5b4de83970
commit a23b24680c
1 changed files with 29 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
library/Icinga/Web/Response/JsonResponse.php
View File

@ -4,6 +4,7 @@
namespace Icinga\Web\Response; namespace Icinga\Web\Response;
use Zend_Controller_Action_HelperBroker; use Zend_Controller_Action_HelperBroker;
use Icinga\Application\Logger;
use Icinga\Web\Response; use Icinga\Web\Response;
/** /**
@ -42,7 +43,7 @@ class JsonResponse extends Response
* *
* @var int * @var int
*/ */
protected $encodingOptions = 0; protected $encodingOptions;
/** /**
* Error message if the API call failed due to a server error * Error message if the API call failed due to a server error
@ -79,6 +80,13 @@ class JsonResponse extends Response
*/ */
public function getEncodingOptions() public function getEncodingOptions()
{ {
if ($this->encodingOptions === null) {
// PHP 5.5+ does never emit a warning and only replaces non-UTF8 strings with
// NULL if the option JSON_PARTIAL_OUTPUT_ON_ERROR is used. We're using this
// as the default here to emulate PHP <= 5.4's behaviour.
return defined('JSON_PARTIAL_OUTPUT_ON_ERROR') ? JSON_PARTIAL_OUTPUT_ON_ERROR : 0;
}
return $this->encodingOptions; return $this->encodingOptions;
} }
@ -188,7 +196,26 @@ class JsonResponse extends Response
$body['data'] = $this->getSuccessData(); $body['data'] = $this->getSuccessData();
break; break;
} }
echo json_encode($body, $this->getEncodingOptions());
// Since we're enabling display_errors in our bootstrapper, PHP <= 5.4 won't emit any warning or log
// message if it encounters non-UTF8 characters. It will simply replace such strings with NULL.
$json = json_encode($body, $this->getEncodingOptions());
if (($errNo = json_last_error()) > 0) {
Logger::error(
'Failed to render route "%s" as JSON: %s',
$this->getRequest()->getUrl()->getAbsoluteUrl(),
function_exists('json_last_error_msg') ? json_last_error_msg() : "Error #$errNo"
);
// JSON_PARTIAL_OUTPUT_ON_ERROR may have not been in use..
if ($json === false) {
// Since the headers have already been sent at this stage we
// can only output NULL to signal an error to the client
$json = 'null';
}
}
echo $json;
} }
/** /**