PDF rausgenommen

msd2/tracking/piwik/core/API/ApiRenderer.php

@@ -0,0 +1,143 @@
+<?php
+/**
+ * Piwik - free/libre analytics platform
+ *
+ * @link http://piwik.org
+ * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ *
+ */
+namespace Piwik\API;
+
+use Exception;
+use Piwik\Common;
+use Piwik\DataTable\Renderer;
+use Piwik\DataTable;
+use Piwik\Piwik;
+use Piwik\Plugin;
+
+/**
+ * API renderer
+ */
+abstract class ApiRenderer
+{
+    protected $request;
+
+    final public function __construct($request)
+    {
+        $this->request = $request;
+        $this->init();
+    }
+
+    protected function init()
+    {
+    }
+
+    abstract public function sendHeader();
+
+    public function renderSuccess($message)
+    {
+        return 'Success:' . $message;
+    }
+
+    /**
+     * @param $message
+     * @param Exception|\Throwable $exception
+     * @return mixed
+     */
+    public function renderException($message, $exception)
+    {
+        return $message;
+    }
+
+    public function renderScalar($scalar)
+    {
+        $dataTable = new DataTable\Simple();
+        $dataTable->addRowsFromArray(array($scalar));
+        return $this->renderDataTable($dataTable);
+    }
+
+    public function renderDataTable($dataTable)
+    {
+        $renderer = $this->buildDataTableRenderer($dataTable);
+        return $renderer->render();
+    }
+
+    public function renderArray($array)
+    {
+        $renderer = $this->buildDataTableRenderer($array);
+        return $renderer->render();
+    }
+
+    public function renderObject($object)
+    {
+        $exception = new Exception('The API cannot handle this data structure.');
+        return $this->renderException($exception->getMessage(), $exception);
+    }
+
+    public function renderResource($resource)
+    {
+        $exception = new Exception('The API cannot handle this data structure.');
+        return $this->renderException($exception->getMessage(), $exception);
+    }
+
+    /**
+     * @param $dataTable
+     * @return Renderer
+     */
+    protected function buildDataTableRenderer($dataTable)
+    {
+        $format   = self::getFormatFromClass(get_class($this));
+        if ($format == 'json2') {
+            $format = 'json';
+        }
+
+        $idSite = Common::getRequestVar('idSite', 0, 'int', $this->request);
+
+        if (empty($idSite)) {
+            $idSite = 'all';
+        }
+
+        $renderer = Renderer::factory($format);
+        $renderer->setTable($dataTable);
+        $renderer->setIdSite($idSite);
+        $renderer->setRenderSubTables(Common::getRequestVar('expanded', false, 'int', $this->request));
+        $renderer->setHideIdSubDatableFromResponse(Common::getRequestVar('hideIdSubDatable', false, 'int', $this->request));
+
+        return $renderer;
+    }
+
+    /**
+     * @param string $format
+     * @param array  $request
+     * @return ApiRenderer
+     * @throws Exception
+     */
+    public static function factory($format, $request)
+    {
+        $formatToCheck = '\\' . ucfirst(strtolower($format));
+
+        $rendererClassnames = Plugin\Manager::getInstance()->findMultipleComponents('Renderer', 'Piwik\\API\\ApiRenderer');
+
+        foreach ($rendererClassnames as $klassName) {
+            if (Common::stringEndsWith($klassName, $formatToCheck)) {
+                return new $klassName($request);
+            }
+        }
+
+        $availableRenderers = array();
+        foreach ($rendererClassnames as $rendererClassname) {
+            $availableRenderers[] = self::getFormatFromClass($rendererClassname);
+        }
+
+        $availableRenderers = implode(', ', $availableRenderers);
+        Common::sendHeader('Content-Type: text/plain; charset=utf-8');
+        throw new Exception(Piwik::translate('General_ExceptionInvalidRendererFormat', array($format, $availableRenderers)));
+    }
+
+    private static function getFormatFromClass($klassname)
+    {
+        $klass = explode('\\', $klassname);
+
+        return strtolower(end($klass));
+    }
+}