Merge pull request #18857 from kamil-tekiela/SqlAutoCompleteController

MauricioFauth · web-flow · commit e53c76d179b8 · 2023-12-24T03:06:39.000-03:00
New implementation for SqlAutoCompleteController
diff --git a/app/services_controllers.php b/app/services_controllers.php
@@ -225,7 +225,12 @@
         ],
         Database\SqlAutoCompleteController::class => [
             'class' => Database\SqlAutoCompleteController::class,
-            'arguments' => ['$response' => '@response', '$template' => '@template', '$dbi' => '@dbi'],
+            'arguments' => [
+                '$response' => '@response',
+                '$template' => '@template',
+                '$dbi' => '@dbi',
+                '$config' => '@config',
+            ],
         ],
         Database\SqlController::class => [
             'class' => Database\SqlController::class,
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -1985,21 +1985,6 @@ parameters:
 			count: 1
 			path: src/Controllers/Database/SearchController.php
 
-		-
-			message: "#^Only booleans are allowed in an if condition, mixed given\\.$#"
-			count: 1
-			path: src/Controllers/Database/SqlAutoCompleteController.php
-
-		-
-			message: "#^Parameter \\#1 \\$database of method PhpMyAdmin\\\\DatabaseInterface\\:\\:getColumns\\(\\) expects string, mixed given\\.$#"
-			count: 1
-			path: src/Controllers/Database/SqlAutoCompleteController.php
-
-		-
-			message: "#^Parameter \\#1 \\$database of method PhpMyAdmin\\\\DatabaseInterface\\:\\:getTables\\(\\) expects string, mixed given\\.$#"
-			count: 1
-			path: src/Controllers/Database/SqlAutoCompleteController.php
-
 		-
 			message: "#^Parameter \\#1 \\$string of function htmlspecialchars expects string, mixed given\\.$#"
 			count: 1
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -1279,15 +1279,6 @@
     </PossiblyUnusedMethod>
   </file>
   <file src="src/Controllers/Database/SqlAutoCompleteController.php">
-    <DeprecatedMethod>
-      <code>Config::getInstance()</code>
-    </DeprecatedMethod>
-    <MixedArgument>
-      <code>$db</code>
-    </MixedArgument>
-    <MixedAssignment>
-      <code>$db</code>
-    </MixedAssignment>
     <PossiblyUnusedMethod>
       <code>__construct</code>
     </PossiblyUnusedMethod>
diff --git a/src/Controllers/Database/SqlAutoCompleteController.php b/src/Controllers/Database/SqlAutoCompleteController.php
@@ -4,51 +4,65 @@
 
 namespace PhpMyAdmin\Controllers\Database;
 
-use PhpMyAdmin\Column;
 use PhpMyAdmin\Config;
 use PhpMyAdmin\Controllers\AbstractController;
-use PhpMyAdmin\Current;
 use PhpMyAdmin\DatabaseInterface;
 use PhpMyAdmin\Http\ServerRequest;
+use PhpMyAdmin\Identifiers\DatabaseName;
 use PhpMyAdmin\ResponseRenderer;
 use PhpMyAdmin\Template;
 
-use function array_map;
-use function array_values;
+use function sprintf;
 
 /**
  * Table/Column autocomplete in SQL editors.
  */
 class SqlAutoCompleteController extends AbstractController
 {
-    public function __construct(ResponseRenderer $response, Template $template, private DatabaseInterface $dbi)
-    {
+    public function __construct(
+        ResponseRenderer $response,
+        Template $template,
+        private readonly DatabaseInterface $dbi,
+        private readonly Config $config,
+    ) {
         parent::__construct($response, $template);
     }
 
     public function __invoke(ServerRequest $request): void
     {
         $sqlAutocomplete = [];
-        if (Config::getInstance()->settings['EnableAutocompleteForTablesAndColumns']) {
-            $db = $request->getParam('db', Current::$database);
-            if ($db) {
-                $tableNames = $this->dbi->getTables($db);
-                foreach ($tableNames as $tableName) {
-                    $sqlAutocomplete[$tableName] = array_map(
-                        static fn (Column $field): array => [
-                            'field' => $field->field,
-                            'columnHint' => $field->type . match ($field->key) {
-                                'PRI' => ' | Primary',
-                                'UNI' => ' | Unique',
-                                default=> ''
-                            },
-                        ],
-                        array_values($this->dbi->getColumns($db, $tableName)),
-                    );
-                }
+        if ($this->config->settings['EnableAutocompleteForTablesAndColumns']) {
+            $db = DatabaseName::tryFrom($request->getParam('db'));
+            if ($db !== null) {
+                $sqlAutocomplete = $this->getColumnList($db);
             }
         }
 
         $this->response->addJSON(['tables' => $sqlAutocomplete]);
     }
+
+    /** @return string[][][] */
+    private function getColumnList(DatabaseName $db): array
+    {
+        $columns = $this->dbi->query(sprintf(
+            'SELECT TABLE_NAME, COLUMN_NAME, COLUMN_TYPE, COLUMN_KEY ' .
+                'FROM information_schema.columns WHERE table_schema = %s',
+            $this->dbi->quoteString($db->getName()),
+        ));
+
+        $autocompleteList = [];
+        /** @var array{TABLE_NAME:string, COLUMN_NAME:string, COLUMN_TYPE:string, COLUMN_KEY:string} $columnInfo */
+        foreach ($columns as $columnInfo) {
+            $autocompleteList[$columnInfo['TABLE_NAME']][] = [
+                'field' => $columnInfo['COLUMN_NAME'],
+                'columnHint' => $columnInfo['COLUMN_TYPE'] . match ($columnInfo['COLUMN_KEY']) {
+                    'PRI' => ' | Primary',
+                    'UNI' => ' | Unique',
+                    default=> ''
+                },
+            ];
+        }
+
+        return $autocompleteList;
+    }
 }
