Controller.php

<?php

/**
 * Matomo - free/libre analytics platform
 *
 * @link    https://matomo.org
 * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 */

namespace Piwik\Plugins\FlexibleDashboard;

use Piwik\API\Request;
use Piwik\Common;
use Piwik\DataTable\Renderer\Json;
use Piwik\Piwik;
use Piwik\Plugins\FlexibleDashboard\Markdown\SafeMarkdown;
use Piwik\Session\SessionNamespace;
use Piwik\View;

/**
 * FlexibleDashboard Controller
 */
class Controller extends \Piwik\Plugin\Controller
{
    const SESSION_NAMESPACE = 'FlexibleDashboard';

    /** Reject absurdly large layouts (2 MB of JSON is already enormous). */
    const MAX_LAYOUT_BYTES = 2097152;

    /**
     * @var FlexibleDashboard
     */
    private $dashboard;

    protected function init()
    {
        parent::init();
        $this->dashboard = new FlexibleDashboard();
    }

    protected function getDashboardView($template)
    {
        $view = new View($template);
        $this->setGeneralVariablesView($view);

        $view->availableLayouts  = $this->getAvailableLayouts();
        $view->hasSomeAdminAccess = Piwik::isUserHasSomeAdminAccess();
        $view->dashboardId        = Common::getRequestVar('idDashboard', 1, 'int');

        return $view;
    }

    public function embeddedIndex()
    {
        $view = $this->getDashboardView('@FlexibleDashboard/embeddedIndex');
        return $view->render();
    }

    public function index()
    {
        $view = $this->getDashboardView('@FlexibleDashboard/index');
        $view->hasSomeAdminAccess = Piwik::isUserHasSomeAdminAccess();
        $view->dashboards = array();

        if (!Piwik::isUserIsAnonymous()) {
            $login = Piwik::getCurrentUserLogin();
            $view->dashboards = $this->dashboard->getAllDashboards($login);
        }

        return $view->render();
    }

    public function getDashboardLayout($checkToken = true)
    {
        if ($checkToken) {
            $this->checkTokenInUrl();
        }

        $idDashboard = Common::getRequestVar('idDashboard', 1, 'int');
        $layout      = $this->getLayout($idDashboard);

        Json::sendHeaderJSON();
        return json_encode(array(
            'name'   => $this->getDashboardName($idDashboard),
            'layout' => json_decode($layout),
        ));
    }

    private function getDashboardName($idDashboard)
    {
        if (!Piwik::isUserIsAnonymous()) {
            $login = Piwik::getCurrentUserLogin();
            foreach ($this->dashboard->getAllDashboards($login) as $dashboard) {
                if ((int) $dashboard['iddashboard'] === $idDashboard) {
                    return $dashboard['name'];
                }
            }
        }

        return Piwik::translate('FlexibleDashboard_FlexibleDashboard');
    }

    public function resetLayout()
    {
        $this->checkTokenInUrl();

        $idDashboard = Common::getRequestVar('idDashboard', 1, 'int');

        if (Piwik::isUserIsAnonymous()) {
            $session = new SessionNamespace(self::SESSION_NAMESPACE);
            $session->dashboardLayout = $this->dashboard->getDefaultLayout();
            $session->setExpirationSeconds(1800);
        } else {
            Request::processRequest('FlexibleDashboard.resetDashboardLayout', array('idDashboard' => $idDashboard));
        }
    }

    private function getModel()
    {
        return new Model();
    }

    public function getAllDashboards()
    {
        $this->checkTokenInUrl();

        if (Piwik::isUserIsAnonymous()) {
            Json::sendHeaderJSON();
            return '[]';
        }

        $login      = Piwik::getCurrentUserLogin();
        $dashboards = $this->dashboard->getAllDashboards($login);

        Json::sendHeaderJSON();
        return json_encode($dashboards);
    }

    /**
     * Saves the layout for the current user.
     * Anonymous -> session. Authenticated -> DB.
     *
     * Note: unlike the core Dashboard plugin we do NOT strip_tags() the
     * payload, because Markdown blocks legitimately contain characters such
     * as "<". The layout is never injected as HTML: report widgets are
     * rendered by Matomo's own widget machinery and Markdown is rendered
     * through SafeMarkdown (escape-first). We only validate that the payload
     * is well-formed JSON of a sane size.
     */
    public function saveLayout()
    {
        $this->checkTokenInUrl();

        $layout      = \Piwik\Request::fromRequest()->getStringParameter('layout');
        $idDashboard = Common::getRequestVar('idDashboard', 1, 'int');
        $name        = Common::getRequestVar('name', '', 'string');

        $this->assertLayoutIsValid($layout);

        if (Piwik::isUserIsAnonymous()) {
            $session = new SessionNamespace(self::SESSION_NAMESPACE);
            $session->dashboardLayout = $layout;
            $session->setExpirationSeconds(1800);
        } else {
            $login = Piwik::getCurrentUserLogin();
            $this->getModel()->createOrUpdateDashboard($login, $idDashboard, $layout);
            if (!empty($name)) {
                $this->getModel()->updateDashboardName($login, $idDashboard, $name);
            }
        }
    }

    public function saveLayoutAsDefault()
    {
        $this->checkTokenInUrl();

        if (Piwik::hasUserSuperUserAccess()) {
            $layout = \Piwik\Request::fromRequest()->getStringParameter('layout');
            $this->assertLayoutIsValid($layout);
            $this->getModel()->createOrUpdateDashboard('', '1', $layout);
        }
    }

    /**
     * Renders a single Markdown block to safe HTML.
     * Used both for the live editor preview and when the engine paints a block.
     */
    public function renderMarkdown()
    {
        $this->checkTokenInUrl();

        // \Piwik\Request returns the raw request value (unlike
        // Common::getRequestVar) — exactly what the Markdown parser needs.
        $markdown = \Piwik\Request::fromRequest()->getStringParameter('markdown', '');

        $html = SafeMarkdown::toHtml($markdown);

        Common::sendHeader('Content-Type: text/html; charset=utf-8');
        return $html;
    }

    private function assertLayoutIsValid($layout)
    {
        if (!is_string($layout) || $layout === '') {
            throw new \Exception('Invalid layout');
        }

        if (strlen($layout) > self::MAX_LAYOUT_BYTES) {
            throw new \Exception('Layout too large');
        }

        // Validate the exact string that will be stored: the layout arrives
        // raw via \Piwik\Request, so no unsanitize round-trip is involved.
        $decoded = json_decode($layout);
        if ($decoded === null && strtolower(trim($layout)) !== 'null') {
            throw new \Exception('Layout is not valid JSON');
        }
    }

    /**
     * Get the layout JSON for the current user (anonymous or logged in).
     *
     * @param int $idDashboard
     * @return string
     */
    protected function getLayout($idDashboard)
    {
        if (Piwik::isUserIsAnonymous()) {
            $session = new SessionNamespace(self::SESSION_NAMESPACE);
            if (!isset($session->dashboardLayout)) {
                return $this->dashboard->getDefaultLayout();
            }
            $layout = $session->dashboardLayout;
        } else {
            $layout = $this->dashboard->getLayoutForUser(Piwik::getCurrentUserLogin(), $idDashboard);
        }

        if (empty($layout)) {
            $layout = $this->dashboard->getDefaultLayout();
        }

        if (!empty($layout)) {
            $layout = $this->dashboard->removeDisabledPluginFromLayout($layout);
        }

        return $layout;
    }

    /**
     * Per-row column width presets, reused by every row's layout chooser.
     *
     * @return array
     */
    protected function getAvailableLayouts()
    {
        return array(
            array(100),
            array(50, 50), array(67, 33), array(33, 67),
            array(33, 33, 33), array(40, 30, 30), array(30, 40, 30), array(30, 30, 40),
            array(25, 25, 25, 25),
        );
    }
}