[4.0] [Installation] Fix minimum required version check when creating a new database by richard67 · Pull Request #28346 · joomla/joomla-cms

richard67 · 2020-03-14T23:40:29Z

Pull Request for Issue # .

Summary of Changes

With Pull Request (PR) #28135 I have added the check for the CMS' minimum database server version requirement to the installation, because the CMS requirement is at least for PostgreSQL more strict than the database driver's requirement, which was the only checked one before that PR.

But that PR has fixed that only for the case when the database already exists in case of MySQL (PDO) and PostgreSQL (PDO). When creating a new database during installation and using these drivers, still only the database driver's requirement is checked. For MySQLi that is not a problem because there the check in the setup model (which respects the CMS' requirement) works also when the database doesn't exist (yet).

This PR here corrects this so it works for all 3 drivers.

In addition it adds the same checks for connection encryption after successful connection to the database model as I have added them with my PR #27348 when I had added the connection encryption feature to the installation. The reason for this change is the same: Without this PR here these checks take only place when the database already exists, but not when a new database is created. This change is harder to test, because it is only relevant for the special case that the server doesn't support encryption, or negotiating an encrypted connection fails, and the server is configured to allow to fall back to an unencrypted connection. This part can only be tested by code review, I think.

Testing Instructions

Requirements

You need a database server with a version which does fulfill the particular database driver's requirement on the minimum server version but doesn't fulfill the CMS' requirement on the minimum server version.

The minimum database server versions currently required by the database drivers are:

5.6 for MySQLi and MySQL (PDO) drivers when using a MySQL database
10.0 for MySQLi and MySQL (PDO) drivers when using a MariaDB database
9.4.0 for PostgreSQL

The minimum database server versions currently required by the CMS are:

5.6 for MySQL database
10.0 for MariaDB database
11.0 for PostgreSQL database

Because for MySQL and MariaDB the requirements of database driver and CMS are equal, you have to patch either the driver's or the CMS' requirement so that the above condition is fulfilled. For PostgreSQL you either use a server version 10 or have to patch some requirements, too.

The minimum version as required by the particular database driver for the particular database type can be patched at the following places:

For MySQL databases

MySQLi driver - file libraries/vendor/joomla/database/src/Mysqli/MysqliDriver.php, line 86
MySQL (PDO) driver - file libraries/vendor/joomla/database/src/Mysql/MysqlDriver.php, line 72

protected static $dbMinimum = '5.6';

For MariaDB databases

MySQLi driver - file libraries/vendor/joomla/database/src/Mysqli/MysqliDriver.php, line 94
MySQL (PDO) driver - file libraries/vendor/joomla/database/src/Mysql/MysqlDriver.php, line 80

protected static $dbMinMariadb = '10.0';

For PostgreSQL databases

PostgreSQL (PDO) driver - file libraries/vendor/joomla/database/src/Pgsql/PgsqlDriver.php, line 54

protected static $dbMinimum = '9.4.0';

The minimum version as required by the CMS for the particular database type can be patched here:

joomla-cms/installation/src/Helper/DatabaseHelper.php

Lines 23 to 48 in 8925612

    
           	/** 
        
           	 * The minimum database server version for MariaDB databases as required by the CMS. 
        
           	 * This is not necessarily equal to what the database driver requires. 
        
           	 * 
        
           	 * @var    string 
        
           	 * @since  4.0.0 
        
           	 */ 
        
           	protected static $dbMinimumMariaDb = '10.1'; 
        
           	/** 
        
           	 * The minimum database server version for MySQL databases as required by the CMS. 
        
           	 * This is not necessarily equal to what the database driver requires. 
        
           	 * 
        
           	 * @var    string 
        
           	 * @since  4.0.0 
        
           	 */ 
        
           	protected static $dbMinimumMySql = '5.6'; 
        
           	/** 
        
           	 * The minimum database server version for PostgreSQL databases as required by the CMS. 
        
           	 * This is not necessarily equal to what the database driver requires. 
        
           	 * 
        
           	 * @var    string 
        
           	 * @since  4.0.0 
        
           	 */ 
        
           	protected static $dbMinimumPostgreSql = '11.0';

You need a database user who has the privilege to create a database on that server with that kind of connection, e.g. on a standard installation of

MySql: user 'root' on host 'localhost'
MariaDB: no idea
PostgreSQL: user 'postgres'

You need an up-to-date 4.0-dev branch so it contains the recently merged PR [4.0] [Installation] Fix creation of new database for MySQL (PDO) and PostgreSQL (PDO) #28338 , or when using a nightly build, wait until tomorrow so that PR is included.
This PR has to be tested with the PDO drivers, i.e. database type MySQL (PDO) or PosgreSQL (PDO). Of course if you have a MySQL or MariaDB database, you can test in addition if this PR doesn't break anything when using the MySQLi driver.

Instructions

Start a new Joomla 4 installation without the patch of this PR applied, using a database server and user combination which allows to create a new database, and a database name for which no database exists on that server, and make sure that for the server version the 1st point in section "Recuirements" above is fulfilled.

Result: See section "Actual result" below.

Do the same with the patch of this PR applied. When getting an error message about version requirement not being fulfilled, change database server or patch the requirement so that it will be fulfilled, and try again, using the "Install Jooma >" button again.

Result: See section "Expected result" below.

Finally check by code review that the checks for connection encryption added by this PR to here

joomla-cms/installation/src/Model/DatabaseModel.php

Lines 486 to 497 in 8925612

    
           // Check database connection encryption 
        
           if ($options->db_encryption !== 0 && empty($db->getConnectionEncryption())) 
        
           { 
        
           	if ($db->isConnectionEncryptionSupported()) 
        
           	{ 
        
           		throw new \RuntimeException(Text::_('INSTL_DATABASE_ENCRYPTION_MSG_CONN_NOT_ENCRYPT')); 
        
           	} 
        
           	else 
        
           	{ 
        
           		throw new \RuntimeException(Text::_('INSTL_DATABASE_ENCRYPTION_MSG_SRV_NOT_SUPPORTS')); 
        
           	} 
        
           }

are the same as already present here

joomla-cms/installation/src/Model/SetupModel.php

Lines 569 to 584 in 8925612

    
           // Check database connection encryption 
        
           if ($options->db_encryption !== 0 && empty($db->getConnectionEncryption())) 
        
           { 
        
           	if ($db->isConnectionEncryptionSupported()) 
        
           	{ 
        
           		Factory::getApplication()->enqueueMessage(Text::_('INSTL_DATABASE_ENCRYPTION_MSG_CONN_NOT_ENCRYPT'), 'error'); 
        
           	} 
        
           	else 
        
           	{ 
        
           		Factory::getApplication()->enqueueMessage(Text::_('INSTL_DATABASE_ENCRYPTION_MSG_SRV_NOT_SUPPORTS'), 'error'); 
        
           	} 
        
           	$db->disconnect(); 
        
           	return false; 
        
           }

except that in the database model they raise exceptions instead of enqueueing messages and returning, but the exception texts are equal to the message texts used in the setup model.

Expected result

When creating a new database at installation, the CMS' requirement on the minimum database server version is checked, and if it is not fulfilled, the installation stops with an appropriate error message.

The user can correct database information in the installation form and then finish the installation by using the "Install Joomla >" button again.

Actual result

When creating a new database at installation, the CMS' requirement on the minimum database server version is not checked, i.e. Joomla is installed in that database even if the server doesn't fulfill the version requirement by the CMS.

Documentation Changes Required

None.

Additional information

This PR doesn't fix the fact that a database will also be created with MySQL (PDO) or PosgreSQL (PDO) when the server doesn't fulfill the minimum version requirement because that version check is done after database creation. This issue I plan to fix with another, future PR.

- Move CMS server version requirement constants from setup model to database helper. - Add function to get the version requirement to database helper. - Let setup model use database helper for server version check.

…tion-tweaks-6

Use minimum required version from database helper for version test in database model and add connection encryption tests.

installation/src/Helper/DatabaseHelper.php

Co-Authored-By: Quy <quy@fluxbb.org>

richard67 · 2020-03-15T08:47:24Z

Wait a bit with testing ... I have to adjust description so it is clear that the problem fixed by this PR doesn’t appear with MySQLi, only with MySQL (PDO) and PostgreSQL (PDO).

richard67 · 2020-03-15T09:01:40Z

Done. Description adapted. Ready for test.

jwaisner · 2020-03-17T13:53:24Z

I have tested this item ✅ successfully on ef7f047

Test is successful with MariaDB. I get the proper error message and it reads the proper version that I am running.

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/28346.}

alikon · 2020-04-17T08:01:39Z

I have tested this item ✅ successfully on ef7f047

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/28346.}

alikon · 2020-04-17T08:02:17Z

RTC

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/28346.}

richard67 · 2020-04-26T10:07:07Z

Anything wrong with my PR? It is RTC, has no conflicts and is still valid.

HLeithner · 2020-05-02T08:26:30Z

Thanks

richard67 · 2020-05-02T08:45:25Z

Thanks.

… a new database (joomla#28346) * Move CMS requirement for minimum server version - Move CMS server version requirement constants from setup model to database helper. - Add function to get the version requirement to database helper. - Let setup model use database helper for server version check. * Correct version test and add connection encryption tests Use minimum required version from database helper for version test in database model and add connection encryption tests. * Use $type as like before * Fix silly typo in comment Co-Authored-By: Quy <quy@fluxbb.org> Co-authored-by: Quy <quy@fluxbb.org>

richard67 added 4 commits March 14, 2020 15:27

Move CMS requirement for minimum server version

cc0f469

- Move CMS server version requirement constants from setup model to database helper. - Add function to get the version requirement to database helper. - Let setup model use database helper for server version check.

Merge remote-tracking branch 'upstream/4.0-dev' into 4.0-dev-installa…

acbf79c

…tion-tweaks-6

Correct version test and add connection encryption tests

6cf6a1d

Use minimum required version from database helper for version test in database model and add connection encryption tests.

Use $type as like before

8925612

joomla-cms-bot added the PR-4.0-dev label Mar 14, 2020

richard67 changed the title ~~[4.0] [Installation] [WiP] Fix minimum required version check when creating a new database~~ [4.0] [Installation] Fix minimum required version check when creating a new database Mar 15, 2020

richard67 marked this pull request as ready for review March 15, 2020 00:41

richard67 requested a review from wilsonge March 15, 2020 00:42

Quy reviewed Mar 15, 2020

View reviewed changes

installation/src/Helper/DatabaseHelper.php Outdated Show resolved Hide resolved

Fix silly typo in comment

ef7f047

Co-Authored-By: Quy <quy@fluxbb.org>

joomla-cms-bot added the RTC This Pull Request is Ready To Commit label Apr 17, 2020

HLeithner merged commit b0c17dd into joomla:4.0-dev May 2, 2020

joomla-cms-bot removed the RTC This Pull Request is Ready To Commit label May 2, 2020

HLeithner added this to the Joomla 4.0 milestone May 2, 2020

richard67 deleted the 4.0-dev-installation-tweaks-6 branch May 2, 2020 08:45

richard67 mentioned this pull request Jun 1, 2020

[4.0] Refactor and harden database checks at installation #29362

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[4.0] [Installation] Fix minimum required version check when creating a new database#28346

[4.0] [Installation] Fix minimum required version check when creating a new database#28346
HLeithner merged 5 commits intojoomla:4.0-devfrom
richard67:4.0-dev-installation-tweaks-6

richard67 commented Mar 14, 2020 •

edited

Loading

Uh oh!

Uh oh!

richard67 commented Mar 15, 2020

Uh oh!

richard67 commented Mar 15, 2020

Uh oh!

jwaisner commented Mar 17, 2020

Uh oh!

alikon commented Apr 17, 2020

Uh oh!

alikon commented Apr 17, 2020

Uh oh!

richard67 commented Apr 26, 2020

Uh oh!

HLeithner commented May 2, 2020

Uh oh!

richard67 commented May 2, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

	/**
	* The minimum database server version for MariaDB databases as required by the CMS.
	* This is not necessarily equal to what the database driver requires.
	*
	* @var string
	* @since 4.0.0
	*/
	protected static $dbMinimumMariaDb = '10.1';

	/**
	* The minimum database server version for MySQL databases as required by the CMS.
	* This is not necessarily equal to what the database driver requires.
	*
	* @var string
	* @since 4.0.0
	*/
	protected static $dbMinimumMySql = '5.6';

	/**
	* The minimum database server version for PostgreSQL databases as required by the CMS.
	* This is not necessarily equal to what the database driver requires.
	*
	* @var string
	* @since 4.0.0
	*/
	protected static $dbMinimumPostgreSql = '11.0';

	// Check database connection encryption
	if ($options->db_encryption !== 0 && empty($db->getConnectionEncryption()))
	{
	if ($db->isConnectionEncryptionSupported())
	{
	throw new \RuntimeException(Text::_('INSTL_DATABASE_ENCRYPTION_MSG_CONN_NOT_ENCRYPT'));
	}
	else
	{
	throw new \RuntimeException(Text::_('INSTL_DATABASE_ENCRYPTION_MSG_SRV_NOT_SUPPORTS'));
	}
	}

Uh oh!

Conversation

richard67 commented Mar 14, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary of Changes

Testing Instructions

Requirements

Instructions

Expected result

Actual result

Documentation Changes Required

Additional information

Uh oh!

Uh oh!

richard67 commented Mar 15, 2020

Uh oh!

richard67 commented Mar 15, 2020

Uh oh!

jwaisner commented Mar 17, 2020

Uh oh!

alikon commented Apr 17, 2020

Uh oh!

alikon commented Apr 17, 2020

Uh oh!

richard67 commented Apr 26, 2020

Uh oh!

HLeithner commented May 2, 2020

Uh oh!

richard67 commented May 2, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

richard67 commented Mar 14, 2020 •

edited

Loading