Improve handling of database port during installation process (#22252)

* Allow providing database port during installation

* don't reveal already provided password during installation

* Revert using an additional field for host

* apply review feedback

core/Db/Adapter.php

@@ -89,6 +89,7 @@ private static function getAdapterClassName($adapterName)
     /**
      * Get default port for named adapter
      *
+     * @deprecated use Schema::getDefaultPortForSchema instead
      * @param string $adapterName
      * @return int
      */
@@ -118,7 +119,7 @@ public static function getAdapters()
         foreach ($adapterNames as $adapterName) {
             $className = '\Piwik\Db\Adapter\\' . $adapterName;
             if (call_user_func(array($className, 'isEnabled'))) {
-                $adapters[strtoupper($adapterName)] = call_user_func(array($className, 'getDefaultPort'));
+                $adapters[] = strtoupper($adapterName);
             }
         }
 

core/Db/Adapter/Mysqli.php

@@ -70,6 +70,7 @@ public function resetConfig()
     /**
      * Return default port.
      *
+     * @deprecated Use Schema::getDefaultPortForSchema instead
      * @return int
      */
     public static function getDefaultPort()

core/Db/Adapter/Pdo/Mysql.php

@@ -136,6 +136,7 @@ public function resetConfig()
     /**
      * Return default port.
      *
+     * @deprecated Use Schema::getDefaultPortForSchema instead
      * @return int
      */
     public static function getDefaultPort()

core/Db/AdapterInterface.php

@@ -22,6 +22,7 @@ public function resetConfig();
 
     /**
      * Return default port.
+     * @deprecated Use Schema::getDefaultPortForSchema instead
      *
      * @return int
      */

core/Db/Schema.php

@@ -48,6 +48,19 @@ private static function getSchemaClassName($schemaName): string
         return '\Piwik\Db\Schema\\' . $class;
     }
 
+    /**
+     * Return the default port for the provided database schema
+     *
+     * @param string $schemaName
+     * @return int
+     */
+    public static function getDefaultPortForSchema(string $schemaName): int
+    {
+        $schemaClassName = self::getSchemaClassName($schemaName);
+        /** @var SchemaInterface $schemaClass */
+        $schemaClass = new $schemaClassName();
+        return $schemaClass->getDefaultPort();
+    }
 
     /**
      * Load schema

core/Db/Schema/Mysql.php

@@ -675,6 +675,11 @@ public function supportsComplexColumnUpdates(): bool
         return true;
     }
 
+    public function getDefaultPort(): int
+    {
+        return 3306;
+    }
+
     private function getTablePrefix()
     {
         return $this->getDbSettings()->getTablePrefix();

core/Db/Schema/Tidb.php

@@ -24,4 +24,9 @@ public function supportsComplexColumnUpdates(): bool
     {
         return false;
     }
+
+    public function getDefaultPort(): int
+    {
+        return 4000;
+    }
 }

core/Db/SchemaInterface.php

@@ -124,4 +124,11 @@ public function addMaxExecutionTimeHintToQuery(string $sql, float $limit): strin
      * @return bool
      */
     public function supportsComplexColumnUpdates(): bool;
+
+    /**
+     * Return the default port used by this database engine
+     *
+     * @return int
+     */
+    public function getDefaultPort(): int;
 }

plugins/Diagnostics/Diagnostic/DbAdapterCheck.php

@@ -55,7 +55,7 @@ private function checkDbAdapters()
         $results = array();
         $adapters = Adapter::getAdapters();
 
-        foreach ($adapters as $adapter => $port) {
+        foreach ($adapters as $adapter) {
             $label = $adapter . ' ' . $this->translator->translate('Installation_Extension');
 
             $results[] = DiagnosticResult::singleResult($label, DiagnosticResult::STATUS_OK);

plugins/Installation/FormDatabaseSetup.php

@@ -27,6 +27,8 @@
  */
 class FormDatabaseSetup extends QuickForm2
 {
+    const MASKED_PASSWORD_VALUE = '**********';
+
     function __construct($id = 'databasesetupform', $method = 'post', $attributes = null, $trackSubmit = false)
     {
         parent::__construct($id, $method, $attributes = array('autocomplete' => 'off'), $trackSubmit);
@@ -46,7 +48,7 @@ function init()
 
         $availableAdapters = Adapter::getAdapters();
         $adapters = array();
-        foreach ($availableAdapters as $adapter => $port) {
+        foreach ($availableAdapters as $adapter) {
             $adapters[$adapter] = $adapter;
             if (Adapter::isRecommendedAdapter($adapter)) {
                 $adapters[$adapter] .= ' (' . Piwik::translate('General_Recommended') . ')';
@@ -98,23 +100,39 @@ function init()
             'type'          => $defaultDatabaseType,
             'tables_prefix' => 'matomo_',
             'schema'        => 'Mysql',
+            'port'          => '3306',
         );
 
         $defaultsEnvironment = array('host', 'adapter', 'tables_prefix', 'username', 'schema', 'password', 'dbname');
         foreach ($defaultsEnvironment as $name) {
-            $envName = 'DATABASE_' . strtoupper($name); // fyi getenv is case insensitive
-            $envNameMatomo = 'MATOMO_' . $envName;
-            if (getenv($envNameMatomo)) {
-                $defaults[$name] = getenv($envNameMatomo);
-            } elseif (getenv($envName)) {
-                $defaults[$name] = getenv($envName);
+            $envValue = $this->getEnvironmentSetting($name);
+
+            if (null !== $envValue) {
+                $defaults[$name] = $envValue;
             }
         }
 
+        if (array_key_exists('password', $defaults)) {
+            $defaults['password'] = self::MASKED_PASSWORD_VALUE; // ensure not to show password in UI
+        }
+
         // default values
         $this->addDataSource(new HTML_QuickForm2_DataSource_Array($defaults));
     }
 
+    private function getEnvironmentSetting(string $name): ?string
+    {
+        $envName = 'DATABASE_' . strtoupper($name); // fyi getenv is case insensitive
+        $envNameMatomo = 'MATOMO_' . $envName;
+        if (is_string(getenv($envNameMatomo))) {
+            return getenv($envNameMatomo);
+        } elseif (is_string(getenv($envName))) {
+            return getenv($envName);
+        }
+
+        return null;
+    }
+
     /**
      * Creates database object based on form data.
      *
@@ -130,20 +148,27 @@ public function createDatabaseObject()
         }
 
         $adapter = $this->getSubmitValue('adapter');
-        $port = Adapter::getDefaultPortForAdapter($adapter);
-
         $host = $this->getSubmitValue('host');
         $tables_prefix = $this->getSubmitValue('tables_prefix');
-
+
+        $password = $this->getSubmitValue('password');
+        $passwordFromEnv = $this->getEnvironmentSetting('password');
+
+        if ($password === self::MASKED_PASSWORD_VALUE && null !== $passwordFromEnv) {
+            $password = $passwordFromEnv;
+        }
+
+        $schema = $this->getSubmitValue('schema');
+
         $dbInfos = array(
             'host'          => (is_null($host)) ? $host : trim($host),
             'username'      => $this->getSubmitValue('username'),
-            'password'      => $this->getSubmitValue('password'),
+            'password'      => $password,
             'dbname'        => $dbname,
             'tables_prefix' => (is_null($tables_prefix)) ? $tables_prefix : trim($tables_prefix),
             'adapter'       => $adapter,
-            'port'          => $port,
-            'schema'        => $this->getSubmitValue('schema'),
+            'port'          => Db\Schema::getDefaultPortForSchema($schema),
+            'schema'        => $schema,
             'type'          => $this->getSubmitValue('type'),
             'enable_ssl'    => false
         );