Fix some errors found by PHPStan and Psalm

Signed-off-by: Maurício Meneghini Fauth <mauricio@fauth.dev>
phpmyadmin · May 22, 2021 · cd1b8a9 · cd1b8a9
1 parent 5faf950
commit cd1b8a9
Show file tree

Hide file tree

Showing 26 changed files with 90 additions and 181 deletions.
diff --git a/libraries/classes/Controllers/HomeController.php b/libraries/classes/Controllers/HomeController.php
@@ -146,7 +146,7 @@ public function index(): void
         }
 
         $databaseServer = [];
-        if ($server > 0 && $cfg['ShowServerInfo']) {
+        if ($server > 0) {
             $hostInfo = '';
             if (! empty($cfg['Server']['verbose'])) {
                 $hostInfo .= $cfg['Server']['verbose'];

diff --git a/libraries/classes/Controllers/Server/PrivilegesController.php b/libraries/classes/Controllers/Server/PrivilegesController.php
@@ -334,8 +334,7 @@ public function index(): void
             && empty($_REQUEST['ajax_page_request'])
             && ! isset($_GET['export'])
             && (! isset($_POST['submit_mult']) || $_POST['submit_mult'] !== 'export')
-            && ((! isset($_GET['initial']) || $_GET['initial'] === null
-                    || $_GET['initial'] === '')
+            && ((! isset($_GET['initial']) || $_GET['initial'] === '')
                 || (isset($_POST['delete']) && $_POST['delete'] === __('Go')))
             && ! isset($_GET['showall'])
         ) {

diff --git a/libraries/classes/DatabaseInterface.php b/libraries/classes/DatabaseInterface.php
@@ -2165,7 +2165,7 @@ public function getError($link = self::CONNECT_USER)
     /**
      * returns the number of rows returned by last query
      *
-     * @param object $result result set identifier
+     * @param object|bool $result result set identifier
      *
      * @return string|int
      */

diff --git a/libraries/classes/Dbal/DbalInterface.php b/libraries/classes/Dbal/DbalInterface.php
@@ -625,7 +625,7 @@ public function getError($link = DatabaseInterface::CONNECT_USER);
     /**
      * returns the number of rows returned by last query
      *
-     * @param object $result result set identifier
+     * @param object|bool $result result set identifier
      *
      * @return string|int
      */

diff --git a/libraries/classes/Dbal/DbiExtension.php b/libraries/classes/Dbal/DbiExtension.php
@@ -32,12 +32,12 @@ public function connect(
     /**
      * selects given database
      *
-     * @param string|DatabaseName $dbname database name to select
-     * @param object              $link   connection object
+     * @param string|DatabaseName $databaseName database name to select
+     * @param object              $link         connection object
      *
      * @return bool
      */
-    public function selectDb($dbname, $link);
+    public function selectDb($databaseName, $link);
 
     /**
      * runs a query and returns the result
@@ -166,7 +166,7 @@ public function getError($link);
     /**
      * returns the number of rows returned by last query
      *
-     * @param object $result result set identifier
+     * @param object|bool $result result set identifier
      *
      * @return string|int
      */
@@ -222,12 +222,12 @@ public function fieldName($result, $i);
     /**
      * returns properly escaped string for use in MySQL queries
      *
-     * @param mixed  $link database link
-     * @param string $str  string to be escaped
+     * @param mixed  $link   database link
+     * @param string $string string to be escaped
      *
      * @return string a MySQL escaped string
      */
-    public function escapeString($link, $str);
+    public function escapeString($link, $string);
 
     /**
      * Prepare an SQL statement for execution.

diff --git a/libraries/classes/Dbal/DbiMysqli.php b/libraries/classes/Dbal/DbiMysqli.php
@@ -18,6 +18,8 @@
 use function defined;
 use function is_array;
 use function is_bool;
+use function mysqli_connect_errno;
+use function mysqli_connect_error;
 use function mysqli_init;
 use function mysqli_report;
 use function stripos;
@@ -62,6 +64,10 @@ public function connect($user, $password, array $server)
 
         $mysqli = mysqli_init();
 
+        if ($mysqli === false) {
+            return false;
+        }
+
         $client_flags = 0;
 
         /* Optionally compress connection */
@@ -118,7 +124,7 @@ public function connect($user, $password, array $server)
             $client_flags
         );
 
-        if ($return_value === false || $return_value === null) {
+        if ($return_value === false) {
             /*
              * Switch to SSL if server asked us to do so, unfortunately
              * there are more ways MySQL server can tell this:
@@ -160,25 +166,25 @@ public function connect($user, $password, array $server)
      * selects given database
      *
      * @param string|DatabaseName $databaseName database name to select
-     * @param mysqli              $mysqli       the mysqli object
+     * @param mysqli              $link         the mysqli object
      *
      * @return bool
      */
-    public function selectDb($databaseName, $mysqli)
+    public function selectDb($databaseName, $link)
     {
-        return $mysqli->select_db((string) $databaseName);
+        return $link->select_db((string) $databaseName);
     }
 
     /**
      * runs a query and returns the result
      *
      * @param string $query   query to execute
-     * @param mysqli $mysqli  mysqli object
+     * @param mysqli $link    mysqli object
      * @param int    $options query options
      *
      * @return mysqli_result|bool
      */
-    public function realQuery($query, $mysqli, $options)
+    public function realQuery($query, $link, $options)
     {
         if ($options == ($options | DatabaseInterface::QUERY_STORE)) {
             $method = MYSQLI_STORE_RESULT;
@@ -188,20 +194,20 @@ public function realQuery($query, $mysqli, $options)
             $method = 0;
         }
 
-        return $mysqli->query($query, $method);
+        return $link->query($query, $method);
     }
 
     /**
      * Run the multi query and output the results
      *
-     * @param mysqli $mysqli mysqli object
-     * @param string $query  multi query statement to execute
+     * @param mysqli $link  mysqli object
+     * @param string $query multi query statement to execute
      *
      * @return bool
      */
-    public function realMultiQuery($mysqli, $query)
+    public function realMultiQuery($link, $query)
     {
-        return $mysqli->multi_query($query);
+        return $link->multi_query($query);
     }
 
     /**
@@ -350,7 +356,7 @@ public function getClientInfo($mysqli)
     /**
      * returns last error message or false if no errors occurred
      *
-     * @param mysqli $mysqli mysql link
+     * @param mysqli|false|null $mysqli mysql link
      *
      * @return string|bool error or false
      */
@@ -362,11 +368,11 @@ public function getError($mysqli)
             $error_number = $mysqli->errno;
             $error_message = $mysqli->error;
         } else {
-            $error_number = $mysqli->connect_errno;
-            $error_message = $mysqli->connect_error;
+            $error_number = mysqli_connect_errno();
+            $error_message = (string) mysqli_connect_error();
         }
 
-        if ($error_number == 0) {
+        if ($error_number === 0 || $error_message === '') {
             return false;
         }
 
@@ -380,7 +386,7 @@ public function getError($mysqli)
     /**
      * returns the number of rows returned by last query
      *
-     * @param mysqli_result $result result set identifier
+     * @param mysqli_result|bool $result result set identifier
      *
      * @return string|int
      */
@@ -457,7 +463,7 @@ public function fieldLen($result, $i)
             return false;
         }
 
-        /** @var stdClass $fieldDefinition */
+        /** @var stdClass|false $fieldDefinition */
         $fieldDefinition = $result->fetch_field_direct($i);
         if ($fieldDefinition !== false) {
             return $fieldDefinition->length;
@@ -480,7 +486,7 @@ public function fieldName($result, $i)
             return '';
         }
 
-        /** @var stdClass $fieldDefinition */
+        /** @var stdClass|false $fieldDefinition */
         $fieldDefinition = $result->fetch_field_direct($i);
         if ($fieldDefinition !== false) {
             return $fieldDefinition->name;
@@ -492,26 +498,26 @@ public function fieldName($result, $i)
     /**
      * returns properly escaped string for use in MySQL queries
      *
-     * @param mysqli $mysqli database link
+     * @param mysqli $link   database link
      * @param string $string string to be escaped
      *
      * @return string a MySQL escaped string
      */
-    public function escapeString($mysqli, $string)
+    public function escapeString($link, $string)
     {
-        return $mysqli->real_escape_string($string);
+        return $link->real_escape_string($string);
     }
 
     /**
      * Prepare an SQL statement for execution.
      *
-     * @param mysqli $mysqli database link
-     * @param string $query  The query, as a string.
+     * @param mysqli $link  database link
+     * @param string $query The query, as a string.
      *
      * @return mysqli_stmt|false A statement object or false.
      */
-    public function prepare($mysqli, string $query)
+    public function prepare($link, string $query)
     {
-        return $mysqli->prepare($query);
+        return $link->prepare($query);
     }
 }
diff --git a/libraries/classes/Error.php b/libraries/classes/Error.php
@@ -427,7 +427,7 @@ public static function getFunctionCall(array $step, string $separator): string
      * if $function is one of include/require
      * the $arg is converted to a relative path
      *
-     * @param string $arg      argument to process
+     * @param mixed  $arg      argument to process
      * @param string $function function name
      */
     public static function getArg($arg, string $function): string

diff --git a/libraries/classes/Footer.php b/libraries/classes/Footer.php
@@ -92,11 +92,10 @@ private function getGitRevisionInfo(): array
     /**
      * Remove recursions and iterator objects from an object
      *
-     * @param object|array $object Object to clean
-     * @param array        $stack  Stack used to keep track of recursion,
-     *                             need not be passed for the first time
+     * @param mixed $object Object to clean
+     * @param array $stack  Stack used to keep track of recursion, need not be passed for the first time
      *
-     * @return object Reference passed object
+     * @return mixed Reference passed object
      */
     private static function removeRecursion(&$object, array $stack = [])
     {
@@ -105,8 +104,9 @@ private static function removeRecursion(&$object, array $stack = [])
                 $object = '***ITERATOR***';
             } elseif (! in_array($object, $stack, true)) {
                 $stack[] = $object;
-                foreach ($object as &$subobject) {
-                    self::removeRecursion($subobject, $stack);
+                // @phpstan-ignore-next-line
+                foreach ($object as &$subObject) {
+                    self::removeRecursion($subObject, $stack);
                 }
             } else {
                 $object = '***RECURSION***';
@@ -130,7 +130,7 @@ public function getDebugMessage(): string
             // Remove recursions and iterators from $_SESSION['debug']
             self::removeRecursion($_SESSION['debug']);
 
-            $retval = json_encode($_SESSION['debug']);
+            $retval = (string) json_encode($_SESSION['debug']);
             $_SESSION['debug'] = [];
 
             return json_last_error() ? '\'false\'' : $retval;

diff --git a/libraries/classes/Linter.php b/libraries/classes/Linter.php
@@ -26,7 +26,7 @@ class Linter
     /**
      * Gets the starting position of each line.
      *
-     * @param string $str String to be analyzed.
+     * @param string|UtfString $str String to be analyzed.
      *
      * @return array
      */

diff --git a/libraries/classes/Plugins/Export/ExportCsv.php b/libraries/classes/Plugins/Export/ExportCsv.php
@@ -284,7 +284,7 @@ public function exportData(
         while ($row = $dbi->fetchRow($result)) {
             $schema_insert = '';
             for ($j = 0; $j < $fields_cnt; $j++) {
-                if (! isset($row[$j]) || $row[$j] === null) {
+                if (! isset($row[$j])) {
                     $schema_insert .= $GLOBALS[$what . '_null'];
                 } elseif ($row[$j] == '0' || $row[$j] != '') {
                     // always enclose fields

diff --git a/libraries/classes/Plugins/Export/ExportHtmlword.php b/libraries/classes/Plugins/Export/ExportHtmlword.php
@@ -254,7 +254,7 @@ public function exportData(
         while ($row = $dbi->fetchRow($result)) {
             $schema_insert = '<tr class="print-category">';
             for ($j = 0; $j < $fields_cnt; $j++) {
-                if (! isset($row[$j]) || $row[$j] === null) {
+                if (! isset($row[$j])) {
                     $value = $GLOBALS[$what . '_null'];
                 } elseif ($row[$j] == '0' || $row[$j] != '') {
                     $value = $row[$j];

diff --git a/libraries/classes/Plugins/Export/ExportOds.php b/libraries/classes/Plugins/Export/ExportOds.php
@@ -263,7 +263,7 @@ public function exportData(
                     $row[$j] = '0x' . bin2hex($row[$j]);
                 }
 
-                if (! isset($row[$j]) || $row[$j] === null) {
+                if (! isset($row[$j])) {
                     $GLOBALS['ods_buffer'] .= '<table:table-cell office:value-type="string">'
                         . '<text:p>'
                         . htmlspecialchars($GLOBALS[$what . '_null'])

diff --git a/libraries/classes/Plugins/Export/ExportOdt.php b/libraries/classes/Plugins/Export/ExportOdt.php
@@ -301,7 +301,7 @@ public function exportData(
                     $row[$j] = '0x' . bin2hex($row[$j]);
                 }
 
-                if (! isset($row[$j]) || $row[$j] === null) {
+                if (! isset($row[$j])) {
                     $GLOBALS['odt_buffer'] .= '<table:table-cell office:value-type="string">'
                         . '<text:p>'
                         . htmlspecialchars($GLOBALS[$what . '_null'])

diff --git a/libraries/classes/Plugins/Export/ExportSql.php b/libraries/classes/Plugins/Export/ExportSql.php
@@ -2583,7 +2583,7 @@ public function exportData(
             $values = [];
             for ($j = 0; $j < $fieldsCnt; $j++) {
                 // NULL
-                if (! isset($row[$j]) || $row[$j] === null) {
+                if (! isset($row[$j])) {
                     $values[] = 'NULL';
                 } elseif (
                     $fieldsMeta[$j]->isNumeric

diff --git a/libraries/classes/Plugins/Export/ExportTexytext.php b/libraries/classes/Plugins/Export/ExportTexytext.php
@@ -228,7 +228,7 @@ public function exportData(
         while ($row = $dbi->fetchRow($result)) {
             $text_output = '';
             for ($j = 0; $j < $fields_cnt; $j++) {
-                if (! isset($row[$j]) || $row[$j] === null) {
+                if (! isset($row[$j])) {
                     $value = $GLOBALS[$what . '_null'];
                 } elseif ($row[$j] == '0' || $row[$j] != '') {
                     $value = $row[$j];

diff --git a/libraries/classes/Plugins/Export/ExportXml.php b/libraries/classes/Plugins/Export/ExportXml.php
@@ -551,7 +551,7 @@ public function exportData(
 
                     // If a cell is NULL, still export it to preserve
                     // the XML structure
-                    if (! isset($record[$i]) || $record[$i] === null) {
+                    if (! isset($record[$i])) {
                         $record[$i] = 'NULL';
                     }
 

diff --git a/libraries/classes/Plugins/Export/ExportYaml.php b/libraries/classes/Plugins/Export/ExportYaml.php
@@ -15,6 +15,7 @@
 use PhpMyAdmin\Properties\Options\Items\HiddenPropertyItem;
 use PhpMyAdmin\Properties\Plugins\ExportPluginProperties;
 
+use function array_key_exists;
 use function is_numeric;
 use function str_replace;
 use function stripslashes;
@@ -187,7 +188,7 @@ public function exportData(
             }
 
             for ($i = 0; $i < $columns_cnt; $i++) {
-                if (! isset($record[$i])) {
+                if (! array_key_exists($i, $record)) {
                     continue;
                 }