Replace DBG config array access with Debug class

Signed-off-by: Maurício Meneghini Fauth <mauricio@fauth.dev>
phpmyadmin · Mar 17, 2024 · c9c286b · c9c286b
1 parent 8754b9b
commit c9c286b
Show file tree

Hide file tree

Showing 17 changed files with 41 additions and 58 deletions.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -16725,16 +16725,6 @@ parameters:
 			count: 2
 			path: tests/unit/Tracking/TrackingTest.php
 
-		-
-			message: "#^Cannot access offset 'sql' on mixed\\.$#"
-			count: 1
-			path: tests/unit/TransformationsTest.php
-
-		-
-			message: "#^Property PhpMyAdmin\\\\Config\\:\\:\\$settings \\(array\\{PmaAbsoluteUri\\: string, AuthLog\\: string, AuthLogSuccess\\: bool, PmaNoRelation_DisableWarning\\: bool, SuhosinDisableWarning\\: bool, LoginCookieValidityDisableWarning\\: bool, ReservedWordDisableWarning\\: bool, TranslationWarningThreshold\\: int, \\.\\.\\.\\}\\) does not accept array\\{PmaAbsoluteUri\\: string, AuthLog\\: string, AuthLogSuccess\\: bool, PmaNoRelation_DisableWarning\\: bool, SuhosinDisableWarning\\: bool, LoginCookieValidityDisableWarning\\: bool, ReservedWordDisableWarning\\: bool, TranslationWarningThreshold\\: int, \\.\\.\\.\\}\\.$#"
-			count: 1
-			path: tests/unit/TransformationsTest.php
-
 		-
 			message: "#^Property PhpMyAdmin\\\\Config\\:\\:\\$settings \\(array\\{PmaAbsoluteUri\\: string, AuthLog\\: string, AuthLogSuccess\\: bool, PmaNoRelation_DisableWarning\\: bool, SuhosinDisableWarning\\: bool, LoginCookieValidityDisableWarning\\: bool, ReservedWordDisableWarning\\: bool, TranslationWarningThreshold\\: int, \\.\\.\\.\\}\\) does not accept array\\{ServerDefault\\: 1, ActionLinksMode\\: 'icons'\\}\\.$#"
 			count: 1
@@ -16755,11 +16745,6 @@ parameters:
 			count: 2
 			path: tests/unit/TwoFactorTest.php
 
-		-
-			message: "#^Property PhpMyAdmin\\\\Config\\:\\:\\$settings \\(array\\{PmaAbsoluteUri\\: string, AuthLog\\: string, AuthLogSuccess\\: bool, PmaNoRelation_DisableWarning\\: bool, SuhosinDisableWarning\\: bool, LoginCookieValidityDisableWarning\\: bool, ReservedWordDisableWarning\\: bool, TranslationWarningThreshold\\: int, \\.\\.\\.\\}\\) does not accept array\\{PmaAbsoluteUri\\: string, AuthLog\\: string, AuthLogSuccess\\: bool, PmaNoRelation_DisableWarning\\: bool, SuhosinDisableWarning\\: bool, LoginCookieValidityDisableWarning\\: bool, ReservedWordDisableWarning\\: bool, TranslationWarningThreshold\\: int, \\.\\.\\.\\}\\.$#"
-			count: 1
-			path: tests/unit/TwoFactorTest.php
-
 		-
 			message: "#^Class PhpMyAdmin\\\\Tests\\\\TypesByDatabaseVersionTest has an uninitialized property \\$object\\. Give it default value or assign it in the constructor\\.$#"
 			count: 1

diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -13231,6 +13231,10 @@
       <code><![CDATA[DatabaseInterface::getInstance()]]></code>
       <code><![CDATA[DatabaseInterface::getInstance()]]></code>
     </DeprecatedMethod>
+    <InaccessibleProperty>
+      <code><![CDATA[$config->config->DBG->sql]]></code>
+      <code><![CDATA[$config->config->DBG->sql]]></code>
+    </InaccessibleProperty>
     <PossiblyUnusedMethod>
       <code><![CDATA[currentRolesData]]></code>
       <code><![CDATA[currentUserData]]></code>
@@ -13440,6 +13444,10 @@
       <code><![CDATA[Config::getInstance()]]></code>
       <code><![CDATA[Config::getInstance()]]></code>
     </DeprecatedMethod>
+    <InaccessibleProperty>
+      <code><![CDATA[$config->config->DBG->sql]]></code>
+      <code><![CDATA[$config->config->DBG->sql]]></code>
+    </InaccessibleProperty>
     <MixedArrayAssignment>
       <code><![CDATA[$_SESSION['debug']['queries']]]></code>
     </MixedArrayAssignment>
@@ -14409,7 +14417,6 @@
       <code><![CDATA[$config->settings]]></code>
       <code><![CDATA[$config->settings]]></code>
       <code><![CDATA[$config->settings]]></code>
-      <code><![CDATA[$config->settings]]></code>
     </InvalidPropertyAssignmentValue>
   </file>
   <file src="tests/unit/Routing/RoutingTest.php">
@@ -14562,11 +14569,6 @@
       <code><![CDATA[providerGetEngine]]></code>
     </PossiblyUnusedMethod>
   </file>
-  <file src="tests/unit/Stubs/DbiDummy.php">
-    <DeprecatedMethod>
-      <code><![CDATA[Config::getInstance()]]></code>
-    </DeprecatedMethod>
-  </file>
   <file src="tests/unit/Stubs/DummyResult.php">
     <InvalidReturnStatement>
       <code><![CDATA[array_column($this->result, 1, 0)]]></code>
@@ -14699,7 +14701,6 @@
       <code><![CDATA[Config::getInstance()]]></code>
     </DeprecatedMethod>
     <InvalidPropertyAssignmentValue>
-      <code><![CDATA[$config->settings]]></code>
       <code><![CDATA[['ServerDefault' => 1, 'ActionLinksMode' => 'icons']]]></code>
     </InvalidPropertyAssignmentValue>
     <PossiblyUnusedMethod>
@@ -14737,10 +14738,14 @@
       <code><![CDATA[Config::getInstance()]]></code>
       <code><![CDATA[Config::getInstance()]]></code>
     </DeprecatedMethod>
-    <InvalidPropertyAssignmentValue>
-      <code><![CDATA[$config->settings]]></code>
-      <code><![CDATA[$config->settings]]></code>
-    </InvalidPropertyAssignmentValue>
+    <InaccessibleProperty>
+      <code><![CDATA[$config->config->DBG->simple2fa]]></code>
+      <code><![CDATA[$config->config->DBG->simple2fa]]></code>
+      <code><![CDATA[$config->config->DBG->simple2fa]]></code>
+      <code><![CDATA[$config->config->DBG->simple2fa]]></code>
+      <code><![CDATA[$config->config->DBG->simple2fa]]></code>
+      <code><![CDATA[$config->config->DBG->simple2fa]]></code>
+    </InaccessibleProperty>
     <MixedArgument>
       <code><![CDATA[$object->config['settings']['secret']]]></code>
       <code><![CDATA[$object->config['settings']['secret']]]></code>

diff --git a/src/Config/Validator.php b/src/Config/Validator.php
@@ -220,7 +220,8 @@ public static function testDBConnection(
         string $pass,
         string $errorKey = 'Server',
     ): bool|array {
-        if (Config::getInstance()->settings['DBG']['demo']) {
+        $config = Config::getInstance();
+        if ($config->config->DBG->demo) {
             // Connection test disabled on the demo server!
             return true;
         }

diff --git a/src/Console.php b/src/Console.php
@@ -111,13 +111,12 @@ public function getDisplay(): string
         $bookmarkFeature = $this->relation->getRelationParameters()->bookmarkFeature;
         $sqlHistory = $this->relation->getHistory($this->config->selectedServer['user']);
         $bookmarkContent = $this->getBookmarkContent();
-        $debug = isset($this->config->settings['DBG']) && $this->config->settings['DBG']['sql'];
 
         return $this->template->render('console/display', [
             'has_bookmark_feature' => $bookmarkFeature !== null,
             'sql_history' => $sqlHistory,
             'bookmark_content' => $bookmarkContent,
-            'debug' => $debug,
+            'debug' => $this->config->config->DBG->sql,
         ]);
     }
 }
diff --git a/src/Controllers/HomeController.php b/src/Controllers/HomeController.php
@@ -229,7 +229,7 @@ public function __invoke(ServerRequest $request): Response|null
             'server' => Current::$server,
             'sync_favorite_tables' => $syncFavoriteTables,
             'has_server' => $hasServer,
-            'is_demo' => $config->settings['DBG']['demo'],
+            'is_demo' => $config->config->DBG->demo,
             'has_server_selection' => $hasServerSelection ?? false,
             'server_selection' => $serverSelection ?? '',
             'has_change_password_link' => ($config->selectedServer['auth_type'] ?? '') !== 'config'

diff --git a/src/Controllers/Setup/MainController.php b/src/Controllers/Setup/MainController.php
@@ -33,7 +33,7 @@ public function __construct(
     public function __invoke(ServerRequest $request): Response
     {
         $config = Config::getInstance();
-        if (@file_exists(CONFIG_FILE) && ! $config->settings['DBG']['demo']) {
+        if (@file_exists(CONFIG_FILE) && ! $config->config->DBG->demo) {
             $response = $this->responseFactory->createResponse(StatusCodeInterface::STATUS_NOT_FOUND);
 
             return $response->write($this->template->render('error/generic', [

diff --git a/src/DatabaseInterface.php b/src/DatabaseInterface.php
@@ -209,7 +209,6 @@ public function tryQuery(
         int $options = self::QUERY_BUFFERED,
         bool $cacheAffectedRows = true,
     ): ResultInterface|false {
-        $debug = isset($this->config->settings['DBG']) && $this->config->settings['DBG']['sql'];
         if (! isset($this->connections[$connectionType->value])) {
             return false;
         }
@@ -226,15 +225,15 @@ public function tryQuery(
             $GLOBALS['cached_affected_rows'] = $this->affectedRows($connectionType, false);
         }
 
-        if ($debug) {
+        if ($this->config->config->DBG->sql) {
             $errorMessage = $this->getError($connectionType);
             Utilities::debugLogQueryIntoSession(
                 $query,
                 $errorMessage !== '' ? $errorMessage : null,
                 $result,
                 $this->lastQueryExecutionTime,
             );
-            if ($this->config->settings['DBG']['sqllog']) {
+            if ($this->config->config->DBG->sqllog) {
                 openlog('phpMyAdmin', LOG_NDELAY | LOG_PID, LOG_USER);
 
                 syslog(

diff --git a/src/Footer.php b/src/Footer.php
@@ -101,9 +101,7 @@ private static function removeRecursion(mixed &$object, array $stack = []): mixe
     public function getDebugMessage(): string
     {
         $retval = '\'false\'';
-        if (
-            $this->config->settings['DBG']['sql'] && empty($_REQUEST['no_debug']) && ! empty($_SESSION['debug'])
-        ) {
+        if ($this->config->config->DBG->sql && empty($_REQUEST['no_debug']) && ! empty($_SESSION['debug'])) {
             // Remove recursions and iterators from $_SESSION['debug']
             self::removeRecursion($_SESSION['debug']);
 
@@ -241,7 +239,7 @@ public function getDisplay(): string
                 $errorMessages = $this->getErrorMessages();
                 $scripts = $this->scripts->getDisplay();
 
-                if ($this->config->settings['DBG']['demo']) {
+                if ($this->config->config->DBG->demo) {
                     $gitRevisionInfo = $this->getGitRevisionInfo();
                 }
 
@@ -254,7 +252,7 @@ public function getDisplay(): string
                 'self_url' => $url ?? null,
                 'error_messages' => $errorMessages ?? '',
                 'scripts' => $scripts ?? '',
-                'is_demo' => $this->config->settings['DBG']['demo'],
+                'is_demo' => $this->config->config->DBG->demo,
                 'git_revision_info' => $gitRevisionInfo ?? [],
                 'footer' => $footer ?? '',
             ]);

diff --git a/src/Plugins/Auth/AuthenticationCookie.php b/src/Plugins/Auth/AuthenticationCookie.php
@@ -161,7 +161,7 @@ public function showLoginForm(): never
 
         $response->addHTML($this->template->render('login/form', [
             'login_header' => $loginHeader,
-            'is_demo' => $config->settings['DBG']['demo'],
+            'is_demo' => $config->config->DBG->demo,
             'error_messages' => $errorMessages,
             'available_languages' => $availableLanguages,
             'is_session_expired' => $sessionExpired,

diff --git a/src/TwoFactor.php b/src/TwoFactor.php
@@ -118,7 +118,8 @@ public function showSubmit(): bool
     public function getAvailableBackends(): array
     {
         $result = [];
-        if (Config::getInstance()->settings['DBG']['simple2fa']) {
+        $config = Config::getInstance();
+        if ($config->config->DBG->simple2fa) {
             $result[] = 'simple';
         }
 

diff --git a/tests/unit/DatabaseInterfaceTest.php b/tests/unit/DatabaseInterfaceTest.php
@@ -276,7 +276,6 @@ public function testGetDbCollation(): void
 
         $config = Config::getInstance();
         $config->selectedServer['DisableIS'] = false;
-        $config->settings['DBG']['sql'] = false;
 
         self::assertSame(
             'utf8_general_ci',
@@ -300,8 +299,10 @@ public function testGetDbCollation(): void
     public function testGetServerCollation(): void
     {
         $dbi = $this->createDatabaseInterface();
-        Config::getInstance()->settings['DBG']['sql'] = true;
+        $config = Config::getInstance();
+        $config->config->DBG->sql = true;
         self::assertSame('utf8_general_ci', $dbi->getServerCollation());
+        $config->config->DBG->sql = false;
     }
 
     /**

diff --git a/tests/unit/Dbal/DbiDummyTest.php b/tests/unit/Dbal/DbiDummyTest.php
@@ -31,7 +31,6 @@ protected function setUp(): void
         $this->dbi = $this->createDatabaseInterface($this->dummyDbi);
         DatabaseInterface::$instance = $this->dbi;
         $config = Config::getInstance();
-        $config->settings['DBG']['sql'] = false;
         $config->settings['IconvExtraParams'] = '';
     }
 

diff --git a/tests/unit/FooterTest.php b/tests/unit/FooterTest.php
@@ -68,7 +68,8 @@ protected function tearDown(): void
     #[Group('medium')]
     public function testGetDebugMessage(): void
     {
-        Config::getInstance()->settings['DBG']['sql'] = true;
+        $config = Config::getInstance();
+        $config->config->DBG->sql = true;
         $_SESSION['debug']['queries'] = [
             ['count' => 1, 'time' => 0.2, 'query' => 'SELECT * FROM `pma_bookmark` WHERE 1'],
             ['count' => 1, 'time' => 2.5, 'query' => 'SELECT * FROM `db` WHERE 1'],
@@ -79,6 +80,7 @@ public function testGetDebugMessage(): void
             . '{"count":1,"time":2.5,"query":"SELECT * FROM `db` WHERE 1"}]}',
             $this->object->getDebugMessage(),
         );
+        $config->config->DBG->sql = false;
     }
 
     /**

diff --git a/tests/unit/Replication/ReplicationGuiTest.php b/tests/unit/Replication/ReplicationGuiTest.php
@@ -44,7 +44,6 @@ protected function setUp(): void
         $config->settings['ShowSQL'] = true;
         $config->settings['TableNavigationLinksMode'] = 'icons';
         $config->settings['LimitChars'] = 100;
-        $config->settings['DBG']['sql'] = false;
         $config->settings['ShowHint'] = true;
 
         Current::$table = 'table';

diff --git a/tests/unit/Stubs/DbiDummy.php b/tests/unit/Stubs/DbiDummy.php
@@ -11,7 +11,6 @@
 
 namespace PhpMyAdmin\Tests\Stubs;
 
-use PhpMyAdmin\Config;
 use PhpMyAdmin\Config\Settings\Server;
 use PhpMyAdmin\Dbal\Connection;
 use PhpMyAdmin\Dbal\DbiExtension;
@@ -2256,8 +2255,5 @@ private function init(): void
                 ],
             ],
         ];
-
-        /* Some basic setup for dummy driver */
-        Config::getInstance()->settings['DBG']['sql'] = false;
     }
 }
diff --git a/tests/unit/TransformationsTest.php b/tests/unit/TransformationsTest.php
@@ -41,7 +41,6 @@ protected function setUp(): void
         $config->selectedServer['table_info'] = '';
         $config->selectedServer['table_coords'] = '';
         $config->selectedServer['column_info'] = 'column_info';
-        $config->settings['DBG']['sql'] = false;
 
         $this->transformations = new Transformations();
     }

diff --git a/tests/unit/TwoFactorTest.php b/tests/unit/TwoFactorTest.php
@@ -46,7 +46,6 @@ protected function setUp(): void
         Current::$table = 'table';
         $config = Config::getInstance();
         $config->selectedServer['DisableIS'] = false;
-        $config->settings['DBG'] = ['simple2fa' => false, 'sql' => false];
         $config->settings['NaturalOrder'] = true;
         $this->initStorageConfigAndData();
     }
@@ -175,11 +174,11 @@ public function testSimple(): void
     {
         $request = new ServerRequest(self::createStub(ServerRequestInterface::class));
         $config = Config::getInstance();
-        $config->settings['DBG']['simple2fa'] = true;
+        $config->config->DBG->simple2fa = true;
         $object = $this->getTwoFactorAndLoadConfig('user', ['type' => 'db', 'backend' => 'simple']);
         $backend = $object->getBackend();
         self::assertSame('simple', $backend::$id);
-        $config->settings['DBG']['simple2fa'] = false;
+        $config->config->DBG->simple2fa = false;
 
         unset($_POST['2fa_confirm']);
         self::assertFalse($object->check($request, true));
@@ -204,7 +203,7 @@ public function testConfigureSimple(): void
     {
         $request = new ServerRequest(self::createStub(ServerRequestInterface::class));
         $config = Config::getInstance();
-        $config->settings['DBG']['simple2fa'] = true;
+        $config->config->DBG->simple2fa = true;
         $object = $this->getTwoFactorAndLoadConfig('user', null);
 
         $this->dummyDbi->assertAllQueriesConsumed();
@@ -229,7 +228,7 @@ public function testConfigureSimple(): void
 
         $this->initStorageConfigAndData();// Needs a re-init
 
-        $config->settings['DBG']['simple2fa'] = false;
+        $config->config->DBG->simple2fa = false;
         $object = $this->getTwoFactorAndLoadConfig('user', null);
         self::assertFalse($object->configure($request, 'simple'));
         $this->dummyDbi->assertAllQueriesConsumed();
@@ -484,13 +483,13 @@ public function testKeyAuthentication(): void
     public function testBackends(): void
     {
         $config = Config::getInstance();
-        $config->settings['DBG']['simple2fa'] = true;
+        $config->config->DBG->simple2fa = true;
         $object = $this->getTwoFactorAndLoadConfig('user', null);
         $backends = $object->getAllBackends();
         self::assertCount(
             count($object->getAvailable()) + 1,
             $backends,
         );
-        $config->settings['DBG']['simple2fa'] = false;
+        $config->config->DBG->simple2fa = false;
     }
 }