DataTableManipulator
3 months ago
ApiRenderer.php
3 months ago
CORSHandler.php
1 year ago
DataTableGenericFilter.php
1 year ago
DataTableManipulator.php
1 year ago
DataTablePostProcessor.php
3 months ago
DocumentationGenerator.php
6 months ago
Inconsistencies.php
2 years ago
NoDefaultValue.php
2 years ago
Proxy.php
4 months ago
Request.php
3 months ago
ResponseBuilder.php
6 months ago
ResponseBuilder.php
210 lines
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * Matomo - free/libre analytics platform |
| 5 | * |
| 6 | * @link https://matomo.org |
| 7 | * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later |
| 8 | */ |
| 9 | namespace Piwik\API; |
| 10 | |
| 11 | use Exception; |
| 12 | use Piwik\Common; |
| 13 | use Piwik\DataTable; |
| 14 | use Piwik\DataTable\DataTableInterface; |
| 15 | use Piwik\DataTable\Filter\ColumnDelete; |
| 16 | use Piwik\DataTable\Filter\Pattern; |
| 17 | use Piwik\DataTable\Renderer; |
| 18 | use Piwik\ExceptionHandler; |
| 19 | use Piwik\Http\HttpCodeException; |
| 20 | use Piwik\Plugins\Monolog\Processor\ExceptionToTextProcessor; |
| 21 | /** |
| 22 | */ |
| 23 | class ResponseBuilder |
| 24 | { |
| 25 | private $outputFormat = null; |
| 26 | private $apiRenderer = null; |
| 27 | private $request = null; |
| 28 | private $sendHeader = \true; |
| 29 | private $postProcessDataTable = \true; |
| 30 | private $apiModule = \false; |
| 31 | private $apiMethod = \false; |
| 32 | private $shouldPrintBacktrace = \false; |
| 33 | /** |
| 34 | * @param string $outputFormat |
| 35 | * @param array $request |
| 36 | */ |
| 37 | public function __construct($outputFormat, $request = array(), $shouldPrintBacktrace = null) |
| 38 | { |
| 39 | $this->outputFormat = $outputFormat; |
| 40 | $this->request = $request; |
| 41 | $this->apiRenderer = \Piwik\API\ApiRenderer::factory($outputFormat, $request); |
| 42 | $this->shouldPrintBacktrace = $shouldPrintBacktrace === null ? ExceptionHandler::shouldPrintBackTraceWithMessage() : $shouldPrintBacktrace; |
| 43 | } |
| 44 | public function disableSendHeader() |
| 45 | { |
| 46 | $this->sendHeader = \false; |
| 47 | } |
| 48 | public function disableDataTablePostProcessor() |
| 49 | { |
| 50 | $this->postProcessDataTable = \false; |
| 51 | } |
| 52 | /** |
| 53 | * This method processes the data resulting from the API call. |
| 54 | * |
| 55 | * - If the data resulted from the API call is a DataTable then |
| 56 | * - we apply the standard filters if the parameters have been found |
| 57 | * in the URL. For example to offset,limit the Table you can add the following parameters to any API |
| 58 | * call that returns a DataTable: filter_limit=10&filter_offset=20 |
| 59 | * - we apply the filters that have been previously queued on the DataTable |
| 60 | * @see DataTable::queueFilter() |
| 61 | * - we apply the renderer that generate the DataTable in a given format (XML, PHP, HTML, JSON, etc.) |
| 62 | * the format can be changed using the 'format' parameter in the request. |
| 63 | * Example: format=xml |
| 64 | * |
| 65 | * - If there is nothing returned (void) we display a standard success message |
| 66 | * |
| 67 | * - If there is a PHP array returned, we try to convert it to a dataTable |
| 68 | * It is then possible to convert this datatable to any requested format (xml/etc) |
| 69 | * |
| 70 | * - If a bool is returned we convert to a string (true is displayed as 'true' false as 'false') |
| 71 | * |
| 72 | * - If an integer / float is returned, we simply return it |
| 73 | * |
| 74 | * @param mixed $value The initial returned value, before post process. If set to null, success response is returned. |
| 75 | * @param bool|string $apiModule The API module that was called |
| 76 | * @param bool|string $apiMethod The API method that was called |
| 77 | * @return mixed Usually a string, but can still be a PHP data structure if the format requested is 'original' |
| 78 | */ |
| 79 | public function getResponse($value = null, $apiModule = \false, $apiMethod = \false) |
| 80 | { |
| 81 | $this->apiModule = $apiModule; |
| 82 | $this->apiMethod = $apiMethod; |
| 83 | $this->sendHeaderIfEnabled(); |
| 84 | // when null or void is returned from the api call, we handle it as a successful operation |
| 85 | if (!isset($value)) { |
| 86 | if (ob_get_contents()) { |
| 87 | return null; |
| 88 | } |
| 89 | return $this->apiRenderer->renderSuccess('ok'); |
| 90 | } |
| 91 | // If the returned value is an object DataTable we |
| 92 | // apply the set of generic filters if asked in the URL |
| 93 | // and we render the DataTable according to the format specified in the URL |
| 94 | if ($value instanceof DataTableInterface) { |
| 95 | return $this->handleDataTable($value); |
| 96 | } |
| 97 | // Case an array is returned from the API call, we convert it to the requested format |
| 98 | // - if calling from inside the application (format = original) |
| 99 | // => the data stays unchanged (ie. a standard php array or whatever data structure) |
| 100 | // - if any other format is requested, we have to convert this data structure (which we assume |
| 101 | // to be an array) to a DataTable in order to apply the requested DataTable_Renderer (for example XML) |
| 102 | if (is_array($value)) { |
| 103 | return $this->handleArray($value); |
| 104 | } |
| 105 | if (is_object($value)) { |
| 106 | return $this->apiRenderer->renderObject($value); |
| 107 | } |
| 108 | if (is_resource($value)) { |
| 109 | return $this->apiRenderer->renderResource($value); |
| 110 | } |
| 111 | return $this->apiRenderer->renderScalar($value); |
| 112 | } |
| 113 | /** |
| 114 | * Returns an error $message in the requested $format |
| 115 | * |
| 116 | * @param Exception|\Throwable $e |
| 117 | * @throws Exception |
| 118 | * @return string |
| 119 | */ |
| 120 | public function getResponseException($e) |
| 121 | { |
| 122 | $e = $this->decorateExceptionWithDebugTrace($e); |
| 123 | $message = $this->formatExceptionMessage($e); |
| 124 | if ($this->sendHeader && $e instanceof HttpCodeException && $e->getCode() > 0) { |
| 125 | http_response_code($e->getCode()); |
| 126 | } |
| 127 | $this->sendHeaderIfEnabled(); |
| 128 | return $this->apiRenderer->renderException($message, $e); |
| 129 | } |
| 130 | /** |
| 131 | * @param Exception|\Throwable $e |
| 132 | * @return Exception |
| 133 | */ |
| 134 | private function decorateExceptionWithDebugTrace($e) |
| 135 | { |
| 136 | // If we are in tests, show full backtrace |
| 137 | if (defined('PIWIK_PATH_TEST_TO_ROOT')) { |
| 138 | if ($this->shouldPrintBacktrace) { |
| 139 | $message = $e->getMessage() . " in \n " . $e->getFile() . ":" . $e->getLine() . " \n " . $e->getTraceAsString(); |
| 140 | } else { |
| 141 | $message = $e->getMessage() . "\n \n --> To temporarily debug this error further, set const PIWIK_PRINT_ERROR_BACKTRACE=true; in index.php"; |
| 142 | } |
| 143 | return new Exception($message); |
| 144 | } |
| 145 | return $e; |
| 146 | } |
| 147 | /** |
| 148 | * @param Exception|\Throwable $exception |
| 149 | * @return string |
| 150 | */ |
| 151 | private function formatExceptionMessage($exception) |
| 152 | { |
| 153 | $message = ExceptionToTextProcessor::getMessageAndWholeBacktrace($exception, $this->shouldPrintBacktrace); |
| 154 | if ($exception instanceof \Piwik\Exception\Exception && $exception->isHtmlMessage() && \Piwik\API\Request::isRootRequestApiRequest()) { |
| 155 | $message = strip_tags(str_replace('<br />', \PHP_EOL, $message)); |
| 156 | } |
| 157 | return Renderer::formatValueXml($message); |
| 158 | } |
| 159 | private function handleDataTable(DataTableInterface $datatable) |
| 160 | { |
| 161 | if ($this->postProcessDataTable) { |
| 162 | $postProcessor = new \Piwik\API\DataTablePostProcessor($this->apiModule, $this->apiMethod, $this->request); |
| 163 | $datatable = $postProcessor->process($datatable); |
| 164 | } |
| 165 | return $this->apiRenderer->renderDataTable($datatable); |
| 166 | } |
| 167 | private function handleArray($array) |
| 168 | { |
| 169 | $firstArray = null; |
| 170 | $firstKey = null; |
| 171 | if (!empty($array)) { |
| 172 | $firstArray = reset($array); |
| 173 | $firstKey = key($array); |
| 174 | } |
| 175 | $isAssoc = !empty($firstArray) && is_numeric($firstKey) && is_array($firstArray) && count(array_filter(array_keys($firstArray), 'is_string')); |
| 176 | if (is_numeric($firstKey)) { |
| 177 | $columns = Common::getRequestVar('filter_column', \false, 'array', $this->request); |
| 178 | $pattern = Common::getRequestVar('filter_pattern', '', 'string', $this->request); |
| 179 | if ($columns != array(\false) && $pattern !== '') { |
| 180 | $pattern = new Pattern(new DataTable(), $columns, $pattern); |
| 181 | $array = $pattern->filterArray($array); |
| 182 | } |
| 183 | $limit = Common::getRequestVar('filter_limit', -1, 'integer', $this->request); |
| 184 | $offset = Common::getRequestVar('filter_offset', '0', 'integer', $this->request); |
| 185 | if ($limit >= 0 || $offset > 0) { |
| 186 | if ($limit < 0) { |
| 187 | $limit = null; |
| 188 | // make sure to return all results from offset |
| 189 | } |
| 190 | $array = array_slice($array, $offset, $limit, $preserveKeys = \false); |
| 191 | } |
| 192 | } |
| 193 | if ($isAssoc) { |
| 194 | $hideColumns = Common::getRequestVar('hideColumns', '', 'string', $this->request); |
| 195 | $showColumns = Common::getRequestVar('showColumns', '', 'string', $this->request); |
| 196 | if ($hideColumns !== '' || $showColumns !== '') { |
| 197 | $columnDelete = new ColumnDelete(new DataTable(), $hideColumns, $showColumns); |
| 198 | $array = $columnDelete->filter($array); |
| 199 | } |
| 200 | } |
| 201 | return $this->apiRenderer->renderArray($array); |
| 202 | } |
| 203 | private function sendHeaderIfEnabled() |
| 204 | { |
| 205 | if ($this->sendHeader) { |
| 206 | $this->apiRenderer->sendHeader(); |
| 207 | } |
| 208 | } |
| 209 | } |
| 210 |