Merge pull request phpmyadmin#19440 from MauricioFauth/ResponseRender…

…er-checkParameters-removal Remove the ResponseRenderer::checkParameters() method
liviuconcioiu · Dec 10, 2024 · b759e81 · b759e81
2 parents c29067d + b68a82e
commit b759e81
Show file tree

Hide file tree

Showing 42 changed files with 407 additions and 206 deletions.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -2823,12 +2823,6 @@ parameters:
 			count: 1
 			path: src/Controllers/Export/ExportController.php
 
-		-
-			message: '#^Cannot cast mixed to string\.$#'
-			identifier: cast.string
-			count: 1
-			path: src/Controllers/Export/ExportController.php
-
 		-
 			message: '#^Construct empty\(\) is not allowed\. Use more strict comparison\.$#'
 			identifier: empty.notAllowed

diff --git a/psalm-baseline.xml b/psalm-baseline.xml
diff --git a/src/Controllers/Database/DataDictionaryController.php b/src/Controllers/Database/DataDictionaryController.php
@@ -30,8 +30,8 @@ public function __construct(
 
     public function __invoke(ServerRequest $request): Response
     {
-        if (! $this->response->checkParameters(['db'], true)) {
-            return $this->response->response();
+        if (Current::$database === '') {
+            return $this->response->missingParameterError('db');
         }
 
         $relationParameters = $this->relation->getRelationParameters();

diff --git a/src/Controllers/Database/DesignerController.php b/src/Controllers/Database/DesignerController.php
@@ -160,8 +160,8 @@ public function __invoke(ServerRequest $request): Response
             return $this->response->response();
         }
 
-        if (! $this->response->checkParameters(['db'])) {
-            return $this->response->response();
+        if (Current::$database === '') {
+            return $this->response->missingParameterError('db');
         }
 
         $GLOBALS['errorUrl'] = Util::getScriptNameForOption(

diff --git a/src/Controllers/Database/EventsController.php b/src/Controllers/Database/EventsController.php
@@ -45,8 +45,8 @@ public function __invoke(ServerRequest $request): Response
         $this->response->addScriptFiles(['database/events.js', 'sql.js']);
 
         if (! $request->isAjax()) {
-            if (! $this->response->checkParameters(['db'])) {
-                return $this->response->response();
+            if (Current::$database === '') {
+                return $this->response->missingParameterError('db');
             }
 
             $GLOBALS['errorUrl'] = Util::getScriptNameForOption(

diff --git a/src/Controllers/Database/ExportController.php b/src/Controllers/Database/ExportController.php
@@ -49,8 +49,8 @@ public function __invoke(ServerRequest $request): Response
 
         $this->response->addScriptFiles(['export.js']);
 
-        if (! $this->response->checkParameters(['db'])) {
-            return $this->response->response();
+        if (Current::$database === '') {
+            return $this->response->missingParameterError('db');
         }
 
         $GLOBALS['errorUrl'] = Util::getScriptNameForOption(

diff --git a/src/Controllers/Database/ImportController.php b/src/Controllers/Database/ImportController.php
@@ -49,8 +49,8 @@ public function __invoke(ServerRequest $request): Response
 
         $this->response->addScriptFiles(['import.js']);
 
-        if (! $this->response->checkParameters(['db'])) {
-            return $this->response->response();
+        if (Current::$database === '') {
+            return $this->response->missingParameterError('db');
         }
 
         $config = Config::getInstance();

diff --git a/src/Controllers/Database/RoutinesController.php b/src/Controllers/Database/RoutinesController.php
@@ -61,14 +61,14 @@ public function __invoke(ServerRequest $request): Response
 
         $config = Config::getInstance();
         if (! $request->isAjax()) {
+            if (Current::$database === '') {
+                return $this->response->missingParameterError('db');
+            }
+
             /**
              * Displays the header and tabs
              */
             if (Current::$table !== '' && in_array(Current::$table, $this->dbi->getTables(Current::$database), true)) {
-                if (! $this->response->checkParameters(['db', 'table'])) {
-                    return $this->response->response();
-                }
-
                 UrlParams::$params = ['db' => Current::$database, 'table' => Current::$table];
                 $GLOBALS['errorUrl'] = Util::getScriptNameForOption($config->settings['DefaultTabTable'], 'table');
                 $GLOBALS['errorUrl'] .= Url::getCommon(UrlParams::$params, '&');
@@ -92,10 +92,6 @@ public function __invoke(ServerRequest $request): Response
             } else {
                 Current::$table = '';
 
-                if (! $this->response->checkParameters(['db'])) {
-                    return $this->response->response();
-                }
-
                 $GLOBALS['errorUrl'] = Util::getScriptNameForOption(
                     $config->settings['DefaultTabDatabase'],
                     'database',

diff --git a/src/Controllers/Database/SearchController.php b/src/Controllers/Database/SearchController.php
@@ -39,8 +39,8 @@ public function __invoke(ServerRequest $request): Response
 
         $this->response->addScriptFiles(['database/search.js', 'sql.js', 'makegrid.js']);
 
-        if (! $this->response->checkParameters(['db'])) {
-            return $this->response->response();
+        if (Current::$database === '') {
+            return $this->response->missingParameterError('db');
         }
 
         $config = Config::getInstance();

diff --git a/src/Controllers/Database/SqlController.php b/src/Controllers/Database/SqlController.php
@@ -45,8 +45,8 @@ public function __invoke(ServerRequest $request): Response
         $this->response->addHTML($this->pageSettings->getErrorHTML());
         $this->response->addHTML($this->pageSettings->getHTML());
 
-        if (! $this->response->checkParameters(['db'])) {
-            return $this->response->response();
+        if (Current::$database === '') {
+            return $this->response->missingParameterError('db');
         }
 
         $GLOBALS['errorUrl'] = Util::getScriptNameForOption(

diff --git a/src/Controllers/Database/Structure/RealRowCountController.php b/src/Controllers/Database/Structure/RealRowCountController.php
@@ -40,8 +40,8 @@ public function __invoke(ServerRequest $request): Response
             'table' => $_REQUEST['table'] ?? null,
         ];
 
-        if (! $this->response->checkParameters(['db'])) {
-            return $this->response->response();
+        if (Current::$database === '') {
+            return $this->response->missingParameterError('db');
         }
 
         $GLOBALS['errorUrl'] = Util::getScriptNameForOption(

diff --git a/src/Controllers/Database/StructureController.php b/src/Controllers/Database/StructureController.php
@@ -127,8 +127,8 @@ public function __invoke(ServerRequest $request): Response
 
         $parameters = ['sort' => $_REQUEST['sort'] ?? null, 'sort_order' => $_REQUEST['sort_order'] ?? null];
 
-        if (! $this->response->checkParameters(['db'])) {
-            return $this->response->response();
+        if (Current::$database === '') {
+            return $this->response->missingParameterError('db');
         }
 
         $config = Config::getInstance();

diff --git a/src/Controllers/Database/TrackingController.php b/src/Controllers/Database/TrackingController.php
@@ -44,8 +44,8 @@ public function __invoke(ServerRequest $request): Response
 
         $this->response->addScriptFiles(['vendor/jquery/jquery.tablesorter.js', 'database/tracking.js']);
 
-        if (! $this->response->checkParameters(['db'])) {
-            return $this->response->response();
+        if (Current::$database === '') {
+            return $this->response->missingParameterError('db');
         }
 
         $config = Config::getInstance();

diff --git a/src/Controllers/Export/ExportController.php b/src/Controllers/Export/ExportController.php
@@ -36,6 +36,7 @@
 use function in_array;
 use function ini_set;
 use function is_array;
+use function is_string;
 use function register_shutdown_function;
 use function time;
 
@@ -93,13 +94,17 @@ public function __invoke(ServerRequest $request): Response
         // sanitize this parameter which will be used below in a file inclusion
         $GLOBALS['what'] = Core::securePath($whatParam);
 
-        if (! $this->response->checkParameters(['what', 'export_type'])) {
-            return $this->response->response();
+        if ($GLOBALS['what'] === '') {
+            return $this->response->missingParameterError('what');
+        }
+
+        if (! is_string($GLOBALS['export_type']) || $GLOBALS['export_type'] === '') {
+            return $this->response->missingParameterError('export_type');
         }
 
         // export class instance, not array of properties, as before
         $exportPlugin = Plugins::getPlugin('export', $GLOBALS['what'], [
-            'export_type' => (string) $GLOBALS['export_type'],
+            'export_type' => $GLOBALS['export_type'],
             'single_table' => isset($GLOBALS['single_table']),
         ]);
 

diff --git a/src/Controllers/Operations/Database/CollationController.php b/src/Controllers/Operations/Database/CollationController.php
@@ -46,8 +46,8 @@ public function __invoke(ServerRequest $request): Response
             return $this->response->response();
         }
 
-        if (! $this->response->checkParameters(['db'])) {
-            return $this->response->response();
+        if (Current::$database === '') {
+            return $this->response->missingParameterError('db');
         }
 
         $GLOBALS['errorUrl'] = Util::getScriptNameForOption(

diff --git a/src/Controllers/Operations/DatabaseController.php b/src/Controllers/Operations/DatabaseController.php
@@ -225,8 +225,8 @@ public function __invoke(ServerRequest $request): Response
             $this->relation->setDbComment(Current::$database, $request->getParsedBodyParamAsString('comment'));
         }
 
-        if (! $this->response->checkParameters(['db'])) {
-            return $this->response->response();
+        if (Current::$database === '') {
+            return $this->response->missingParameterError('db');
         }
 
         $config = Config::getInstance();

diff --git a/src/Controllers/Operations/TableController.php b/src/Controllers/Operations/TableController.php
@@ -69,8 +69,12 @@ public function __invoke(ServerRequest $request): Response
 
         $this->response->addScriptFiles(['table/operations.js']);
 
-        if (! $this->response->checkParameters(['db', 'table'])) {
-            return $this->response->response();
+        if (Current::$database === '') {
+            return $this->response->missingParameterError('db');
+        }
+
+        if (Current::$table === '') {
+            return $this->response->missingParameterError('table');
         }
 
         $isSystemSchema = Utilities::isSystemSchema(Current::$database);

diff --git a/src/Controllers/Operations/ViewController.php b/src/Controllers/Operations/ViewController.php
@@ -45,8 +45,12 @@ public function __invoke(ServerRequest $request): Response
         $GLOBALS['errorUrl'] ??= null;
         $this->response->addScriptFiles(['table/operations.js']);
 
-        if (! $this->response->checkParameters(['db', 'table'])) {
-            return $this->response->response();
+        if (Current::$database === '') {
+            return $this->response->missingParameterError('db');
+        }
+
+        if (Current::$table === '') {
+            return $this->response->missingParameterError('table');
         }
 
         UrlParams::$params = ['db' => Current::$database, 'table' => Current::$table];

diff --git a/src/Controllers/Sql/SqlController.php b/src/Controllers/Sql/SqlController.php
@@ -128,8 +128,8 @@ public function __invoke(ServerRequest $request): Response
 
             // set $goto to what will be displayed if query returns 0 rows
             UrlParams::$goto = '';
-        } elseif (! $this->response->checkParameters(['sql_query'], true)) {
-            return $this->response->response();
+        } elseif (Current::$sqlQuery === '') {
+            return $this->response->missingParameterError('sql_query');
         }
 
         /**

diff --git a/src/Controllers/Table/AddFieldController.php b/src/Controllers/Table/AddFieldController.php
@@ -56,8 +56,12 @@ public function __invoke(ServerRequest $request): Response
 
         $this->response->addScriptFiles(['table/structure.js']);
 
-        if (! $this->response->checkParameters(['db', 'table'])) {
-            return $this->response->response();
+        if (Current::$database === '') {
+            return $this->response->missingParameterError('db');
+        }
+
+        if (Current::$table === '') {
+            return $this->response->missingParameterError('table');
         }
 
         $userPrivileges = $this->userPrivilegesFactory->getPrivileges();
@@ -186,8 +190,8 @@ public function __invoke(ServerRequest $request): Response
 
         $this->response->addScriptFiles(['vendor/jquery/jquery.uitablefilter.js']);
 
-        if (! $this->response->checkParameters(['server', 'db', 'table'])) {
-            return $this->response->response();
+        if (Current::$server === 0) {
+            return $this->response->missingParameterError('server');
         }
 
         $templateData = $this->columnsDefinition->displayForm($userPrivileges, '/table/add-field', $numFields);

diff --git a/src/Controllers/Table/ChartController.php b/src/Controllers/Table/ChartController.php
@@ -47,13 +47,6 @@ public function __invoke(ServerRequest $request): Response
         $GLOBALS['errorUrl'] ??= null;
 
         if (isset($_REQUEST['pos'], $_REQUEST['session_max_rows']) && $request->isAjax()) {
-            if (
-                Current::$table !== '' && Current::$database !== ''
-                && ! $this->response->checkParameters(['db', 'table'])
-            ) {
-                return $this->response->response();
-            }
-
             $this->ajax($request);
 
             return $this->response->response();
@@ -82,8 +75,8 @@ public function __invoke(ServerRequest $request): Response
          * Runs common work
          */
         if (Current::$table !== '') {
-            if (! $this->response->checkParameters(['db', 'table'])) {
-                return $this->response->response();
+            if (Current::$database === '') {
+                return $this->response->missingParameterError('db');
             }
 
             $urlParams = ['db' => Current::$database, 'table' => Current::$table];
@@ -125,10 +118,6 @@ public function __invoke(ServerRequest $request): Response
             $urlParams['goto'] = Util::getScriptNameForOption($config->settings['DefaultTabDatabase'], 'database');
             $urlParams['back'] = Url::getFromRoute('/sql');
 
-            if (! $this->response->checkParameters(['db'])) {
-                return $this->response->response();
-            }
-
             $GLOBALS['errorUrl'] = Util::getScriptNameForOption($config->settings['DefaultTabDatabase'], 'database');
             $GLOBALS['errorUrl'] .= Url::getCommon(['db' => Current::$database], '&');
 

diff --git a/src/Controllers/Table/CreateController.php b/src/Controllers/Table/CreateController.php
@@ -44,24 +44,14 @@ public function __construct(
 
     public function __invoke(ServerRequest $request): Response
     {
-        if (! $this->response->checkParameters(['db'])) {
-            return $this->response->response();
+        if (Current::$database === '') {
+            return $this->response->missingParameterError('db');
         }
 
         $userPrivileges = $this->userPrivilegesFactory->getPrivileges();
 
         $cfg = $this->config->settings;
 
-        /* Check if database name is empty */
-        if (Current::$database === '') {
-            Generator::mysqlDie(
-                __('The database name is empty!'),
-                '',
-                false,
-                'index.php',
-            );
-        }
-
         /**
          * Selects the database to work with
          */
@@ -145,8 +135,8 @@ public function __invoke(ServerRequest $request): Response
 
         $this->response->addScriptFiles(['vendor/jquery/jquery.uitablefilter.js']);
 
-        if (! $this->response->checkParameters(['server', 'db'])) {
-            return $this->response->response();
+        if (Current::$server === 0) {
+            return $this->response->missingParameterError('server');
         }
 
         $templateData = $this->columnsDefinition->displayForm($userPrivileges, '/table/create', $numFields);

diff --git a/src/Controllers/Table/DeleteConfirmController.php b/src/Controllers/Table/DeleteConfirmController.php
@@ -43,8 +43,12 @@ public function __invoke(ServerRequest $request): Response
             return $this->response->response();
         }
 
-        if (! $this->response->checkParameters(['db', 'table'])) {
-            return $this->response->response();
+        if (Current::$database === '') {
+            return $this->response->missingParameterError('db');
+        }
+
+        if (Current::$table === '') {
+            return $this->response->missingParameterError('table');
         }
 
         UrlParams::$params = ['db' => Current::$database, 'table' => Current::$table];

diff --git a/src/Controllers/Table/ExportController.php b/src/Controllers/Table/ExportController.php
@@ -47,8 +47,12 @@ public function __invoke(ServerRequest $request): Response
 
         $this->response->addScriptFiles(['export.js']);
 
-        if (! $this->response->checkParameters(['db', 'table'])) {
-            return $this->response->response();
+        if (Current::$database === '') {
+            return $this->response->missingParameterError('db');
+        }
+
+        if (Current::$table === '') {
+            return $this->response->missingParameterError('table');
         }
 
         UrlParams::$params = ['db' => Current::$database, 'table' => Current::$table];

diff --git a/src/Controllers/Table/FindReplaceController.php b/src/Controllers/Table/FindReplaceController.php
@@ -56,8 +56,12 @@ public function __construct(
     public function __invoke(ServerRequest $request): Response
     {
         $GLOBALS['errorUrl'] ??= null;
-        if (! $this->response->checkParameters(['db', 'table'])) {
-            return $this->response->response();
+        if (Current::$database === '') {
+            return $this->response->missingParameterError('db');
+        }
+
+        if (Current::$table === '') {
+            return $this->response->missingParameterError('table');
         }
 
         UrlParams::$params = ['db' => Current::$database, 'table' => Current::$table];