phpmyadmin/libraries/classes/Controllers/AbstractController.php

<?php

declare(strict_types=1);

namespace PhpMyAdmin\Controllers;

use PhpMyAdmin\Core;
use PhpMyAdmin\Dbal\DatabaseName;
use PhpMyAdmin\Html\MySQLDocumentation;
use PhpMyAdmin\Message;
use PhpMyAdmin\ResponseRenderer;
use PhpMyAdmin\Template;
use PhpMyAdmin\Url;

use function __;
use function basename;
use function defined;

abstract class AbstractController
{
    protected ResponseRenderer $response;

    protected Template $template;

    public function __construct(ResponseRenderer $response, Template $template)
    {
        $this->response = $response;
        $this->template = $template;
    }

    /**
     * @param array<string, mixed> $templateData
     */
    protected function render(string $templatePath, array $templateData = []): void
    {
        $this->response->addHTML($this->template->render($templatePath, $templateData));
    }

    /**
     * @param string[] $files
     */
    protected function addScriptFiles(array $files): void
    {
        $header = $this->response->getHeader();
        $scripts = $header->getScripts();
        $scripts->addFiles($files);
    }

    protected function hasDatabase(): bool
    {
        $GLOBALS['errno'] ??= null;
        $GLOBALS['message'] ??= null;

        if (isset($GLOBALS['is_db']) && $GLOBALS['is_db']) {
            return true;
        }

        $GLOBALS['is_db'] = false;
        $db = DatabaseName::tryFromValue($GLOBALS['db']);

        if ($db !== null) {
            $GLOBALS['is_db'] = $GLOBALS['dbi']->selectDb($db->getName());
            // This "Command out of sync" 2014 error may happen, for example
            // after calling a MySQL procedure; at this point we can't select
            // the db but it's not necessarily wrong
            if ($GLOBALS['dbi']->getError() && $GLOBALS['errno'] == 2014) {
                $GLOBALS['is_db'] = true;
                unset($GLOBALS['errno']);
            }
        }

        if ($db === null || ! $GLOBALS['is_db']) {
            if ($this->response->isAjax()) {
                $this->response->setRequestStatus(false);
                $this->response->addJSON(
                    'message',
                    Message::error(__('No databases selected.'))
                );

                return false;
            }

            // Not a valid db name -> back to the welcome page
            $params = ['reload' => '1'];
            if (isset($GLOBALS['message'])) {
                $params['message'] = $GLOBALS['message'];
            }

            $this->redirect('/', $params);

            return false;
        }

        return $GLOBALS['is_db'];
    }

    /**
     * @param array<string, mixed> $params
     */
    protected function redirect(string $route, array $params = []): void
    {
        if (defined('TESTSUITE')) {
            return;
        }

        $uri = './index.php?route=' . $route . Url::getCommonRaw($params, '&');
        Core::sendHeaderLocation($uri);
    }

    /**
     * Function added to avoid path disclosures.
     * Called by each script that needs parameters, it displays
     * an error message and, by default, stops the execution.
     *
     * @param bool $request Check parameters in request
     * @psalm-param non-empty-list<non-empty-string> $params The names of the parameters needed by the calling script
     */
    protected function checkParameters(array $params, bool $request = false): void
    {
        $reportedScriptName = basename($GLOBALS['PMA_PHP_SELF']);
        $foundError = false;
        $errorMessage = '';
        if ($request) {
            $array = $_REQUEST;
        } else {
            $array = $GLOBALS;
        }

        foreach ($params as $param) {
            if (isset($array[$param]) && $array[$param] !== '') {
                continue;
            }

            $errorMessage .= $reportedScriptName
                . ': ' . __('Missing parameter:') . ' '
                . $param
                . MySQLDocumentation::showDocumentation('faq', 'faqmissingparameters', true)
                . '[br]';
            $foundError = true;
        }

        if (! $foundError) {
            return;
        }

        $this->response->setHttpResponseCode(400);
        $this->response->setRequestStatus(false);
        $this->response->addHTML(Message::error($errorMessage)->getDisplay());

        if (! defined('TESTSUITE')) {
            exit;
        }
    }

    /**
     * @psalm-param int<400,599> $statusCode
     */
    protected function sendErrorResponse(string $message, int $statusCode = 400): void
    {
        $this->response->setHttpResponseCode($statusCode);
        $this->response->setRequestStatus(false);

        if ($this->response->isAjax()) {
            $this->response->addJSON('isErrorResponse', true);
            $this->response->addJSON('message', $message);

            return;
        }

        $this->response->addHTML(Message::error($message)->getDisplay());
    }
}