- md5
- 06f2cbafe3d750305c4b674ec957b0be
- sha1
- ae9b91abef397ad2e89552be09eb55a2431df78e
- sha256
- 2c140d8d76c5b9c6db94ecf5f55f47341f836989f681324f531c400dea850fd1
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502
<?php
/**
* @package Joomla.Installation
*
* @copyright (C) 2009 Open Source Matters, Inc. <https://www.joomla.org>
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Joomla\CMS\Installation\Helper;
use Joomla\CMS\Factory;
use Joomla\CMS\Language\Text;
use Joomla\CMS\User\UserHelper;
use Joomla\Database\DatabaseDriver;
use Joomla\Database\DatabaseInterface;
use Joomla\Filesystem\File;
use Joomla\Filesystem\Path;
use Joomla\Utilities\ArrayHelper;
// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects
/**
* Joomla Installation Database Helper Class.
*
* @since 1.6
*/
abstract class DatabaseHelper
{
/**
* 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.4';
/**
* 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 = '8.0.13';
/**
* 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 = '12.0';
/**
* Method to get a database driver.
*
* @param string $driver The database driver to use.
* @param string $host The hostname to connect on.
* @param string $user The user name to connect with.
* @param string $password The password to use for connection authentication.
* @param string $database The database to use.
* @param string $prefix The table prefix to use.
* @param boolean $select True if the database should be selected.
* @param array $ssl Database TLS connection options.
*
* @return DatabaseInterface
*
* @since 1.6
*/
public static function getDbo($driver, $host, $user, $password, $database, $prefix, $select = true, array $ssl = [])
{
static $db;
if (!$db) {
// Build the connection options array.
$options = [
'driver' => $driver,
'host' => $host,
'user' => $user,
'password' => $password,
'database' => $database,
'prefix' => $prefix,
'select' => $select,
];
if (!empty($ssl['dbencryption'])) {
$options['ssl'] = [
'enable' => true,
'verify_server_cert' => (bool) $ssl['dbsslverifyservercert'],
];
foreach (['cipher', 'ca', 'key', 'cert'] as $value) {
$confVal = trim($ssl['dbssl' . $value]);
if ($confVal !== '') {
$options['ssl'][$value] = $confVal;
}
}
}
// Enable utf8mb4 connections for mysql adapters
if (strtolower($driver) === 'mysqli') {
$options['utf8mb4'] = true;
}
if (strtolower($driver) === 'mysql') {
$options['charset'] = 'utf8mb4';
}
// Get a database object.
$db = DatabaseDriver::getInstance($options);
}
return $db;
}
/**
* Convert encryption options to array.
*
* @param \stdClass $options The session options
*
* @return array The encryption settings
*
* @since 4.0.0
*/
public static function getEncryptionSettings($options)
{
return [
'dbencryption' => $options->db_encryption,
'dbsslverifyservercert' => $options->db_sslverifyservercert,
'dbsslkey' => $options->db_sslkey,
'dbsslcert' => $options->db_sslcert,
'dbsslca' => $options->db_sslca,
'dbsslcipher' => $options->db_sslcipher,
];
}
/**
* Get the minimum required database server version.
*
* @param DatabaseDriver $db Database object
* @param \stdClass $options The session options
*
* @return string The minimum required database server version.
*
* @since 4.0.0
*/
public static function getMinimumServerVersion($db, $options)
{
// Get minimum database version required by the database driver
$minDbVersionRequired = $db->getMinimum();
// Get minimum database version required by the CMS
if (in_array($options->db_type, ['mysql', 'mysqli'])) {
if ($db->isMariaDb()) {
$minDbVersionCms = self::$dbMinimumMariaDb;
} else {
$minDbVersionCms = self::$dbMinimumMySql;
}
} else {
$minDbVersionCms = self::$dbMinimumPostgreSql;
}
// Use most restrictive, i.e. largest minimum database version requirement
if (version_compare($minDbVersionCms, $minDbVersionRequired) > 0) {
$minDbVersionRequired = $minDbVersionCms;
}
return $minDbVersionRequired;
}
/**
* Validate and clean up database connection parameters.
*
* @param \stdClass $options The session options
*
* @return string|boolean A string with the translated error message if
* validation error, otherwise false.
*
* @since 4.0.0
*/
public static function validateConnectionParameters($options)
{
// Ensure a database type was selected.
if (empty($options->db_type)) {
return Text::_('INSTL_DATABASE_INVALID_TYPE');
}
// Ensure that a hostname and user name were input.
if (empty($options->db_host) || empty($options->db_user)) {
return Text::_('INSTL_DATABASE_INVALID_DB_DETAILS');
}
// Ensure that a database name is given.
if (empty($options->db_name)) {
return Text::_('INSTL_DATABASE_EMPTY_NAME');
}
// Validate length of database name.
if (strlen($options->db_name) > 64) {
return Text::_('INSTL_DATABASE_NAME_TOO_LONG');
}
// Validate database table prefix.
if (empty($options->db_prefix) || !preg_match('#^[a-zA-Z]+[a-zA-Z0-9_]*$#', $options->db_prefix)) {
return Text::_('INSTL_DATABASE_PREFIX_MSG');
}
// Validate length of database table prefix.
if (strlen($options->db_prefix) > 15) {
return Text::_('INSTL_DATABASE_FIX_TOO_LONG');
}
// Validate database name.
if (in_array($options->db_type, ['pgsql', 'postgresql']) && !preg_match('#^[a-zA-Z_][0-9a-zA-Z_$]*$#', $options->db_name)) {
return Text::_('INSTL_DATABASE_NAME_MSG_POSTGRES');
}
if (in_array($options->db_type, ['mysql', 'mysqli']) && preg_match('#[\\\\\/]#', $options->db_name)) {
return Text::_('INSTL_DATABASE_NAME_MSG_MYSQL');
}
// Workaround for UPPERCASE table prefix for postgresql
if (in_array($options->db_type, ['pgsql', 'postgresql'])) {
if (strtolower($options->db_prefix) != $options->db_prefix) {
return Text::_('INSTL_DATABASE_FIX_LOWERCASE');
}
}
// Validate and clean up database connection encryption options
$optionsChanged = false;
if ($options->db_encryption === 0) {
// Reset unused options
if (!empty($options->db_sslkey)) {
$options->db_sslkey = '';
$optionsChanged = true;
}
if (!empty($options->db_sslcert)) {
$options->db_sslcert = '';
$optionsChanged = true;
}
if ($options->db_sslverifyservercert) {
$options->db_sslverifyservercert = false;
$optionsChanged = true;
}
if (!empty($options->db_sslca)) {
$options->db_sslca = '';
$optionsChanged = true;
}
if (!empty($options->db_sslcipher)) {
$options->db_sslcipher = '';
$optionsChanged = true;
}
} else {
// Check localhost
if (strtolower($options->db_host) === 'localhost') {
return Text::_('INSTL_DATABASE_ENCRYPTION_MSG_LOCALHOST');
}
// Check CA file and folder depending on database type if server certificate verification
if ($options->db_sslverifyservercert) {
if (empty($options->db_sslca)) {
return Text::sprintf('INSTL_DATABASE_ENCRYPTION_MSG_FILE_FIELD_EMPTY', Text::_('INSTL_DATABASE_ENCRYPTION_CA_LABEL'));
}
if (!is_file(Path::clean($options->db_sslca))) {
return Text::sprintf('INSTL_DATABASE_ENCRYPTION_MSG_FILE_FIELD_BAD', Text::_('INSTL_DATABASE_ENCRYPTION_CA_LABEL'));
}
} else {
// Reset unused option
if (!empty($options->db_sslca)) {
$options->db_sslca = '';
$optionsChanged = true;
}
}
// Check key and certificate if two-way encryption
if ($options->db_encryption === 2) {
if (empty($options->db_sslkey)) {
return Text::sprintf('INSTL_DATABASE_ENCRYPTION_MSG_FILE_FIELD_EMPTY', Text::_('INSTL_DATABASE_ENCRYPTION_KEY_LABEL'));
}
if (!is_file(Path::clean($options->db_sslkey))) {
return Text::sprintf('INSTL_DATABASE_ENCRYPTION_MSG_FILE_FIELD_BAD', Text::_('INSTL_DATABASE_ENCRYPTION_KEY_LABEL'));
}
if (empty($options->db_sslcert)) {
return Text::sprintf('INSTL_DATABASE_ENCRYPTION_MSG_FILE_FIELD_EMPTY', Text::_('INSTL_DATABASE_ENCRYPTION_CERT_LABEL'));
}
if (!is_file(Path::clean($options->db_sslcert))) {
return Text::sprintf('INSTL_DATABASE_ENCRYPTION_MSG_FILE_FIELD_BAD', Text::_('INSTL_DATABASE_ENCRYPTION_CERT_LABEL'));
}
} else {
// Reset unused options
if (!empty($options->db_sslkey)) {
$options->db_sslkey = '';
$optionsChanged = true;
}
if (!empty($options->db_sslcert)) {
$options->db_sslcert = '';
$optionsChanged = true;
}
}
}
// Save options to session data if changed
if ($optionsChanged) {
$optsArr = ArrayHelper::fromObject($options);
Factory::getSession()->set('setup.options', $optsArr);
}
return false;
}
/**
* Security check for remote db hosts
*
* @param \stdClass $options The session options
*
* @return boolean True if passed, otherwise false.
*
* @since 4.0.0
*/
public static function checkRemoteDbHost($options)
{
// Security check for remote db hosts: Check env var if disabled. Also disable in CLI.
$shouldCheckLocalhost = getenv('JOOMLA_INSTALLATION_DISABLE_LOCALHOST_CHECK') !== '1'
&& !defined('_JCLI_INSTALLATION');
// Per default allowed DB hosts: localhost / 127.0.0.1 / ::1 (optionally with port)
$localhost = '/^(((localhost|127\.0\.0\.1|\[\:\:1\])(\:[1-9]{1}[0-9]{0,4})?)|(\:\:1))$/';
// Check the security file if the db_host is not localhost / 127.0.0.1 / ::1
if ($shouldCheckLocalhost && preg_match($localhost, $options->db_host) !== 1) {
$remoteDbFileTestsPassed = Factory::getSession()->get('remoteDbFileTestsPassed', false);
// When all checks have been passed we don't need to do this here again.
if ($remoteDbFileTestsPassed === false) {
$generalRemoteDatabaseMessage = Text::sprintf(
'INSTL_DATABASE_HOST_IS_NOT_LOCALHOST_GENERAL_MESSAGE',
'https://docs.joomla.org/Special:MyLanguage/J3.x:Secured_procedure_for_installing_Joomla_with_a_remote_database'
);
$remoteDbFile = Factory::getSession()->get('remoteDbFile', false);
if ($remoteDbFile === false) {
// Add the general message
Factory::getApplication()->enqueueMessage($generalRemoteDatabaseMessage, 'warning');
// This is the file you need to remove if you want to use a remote database
$remoteDbFile = '_Joomla' . UserHelper::genRandomPassword(21) . '.txt';
Factory::getSession()->set('remoteDbFile', $remoteDbFile);
// Get the path
$remoteDbPath = JPATH_INSTALLATION . '/' . $remoteDbFile;
$emptyString = '';
// When the path is not writable the user needs to create the file manually
if (!File::write($remoteDbPath, $emptyString)) {
// Request to create the file manually
Factory::getApplication()->enqueueMessage(
Text::sprintf(
'INSTL_DATABASE_HOST_IS_NOT_LOCALHOST_CREATE_FILE',
$remoteDbFile,
'installation',
Text::_('INSTL_INSTALL_JOOMLA')
),
'notice'
);
Factory::getSession()->set('remoteDbFileUnwritable', true);
return false;
}
// Save the file name to the session
Factory::getSession()->set('remoteDbFileWrittenByJoomla', true);
// Request to delete that file
Factory::getApplication()->enqueueMessage(
Text::sprintf(
'INSTL_DATABASE_HOST_IS_NOT_LOCALHOST_DELETE_FILE',
$remoteDbFile,
'installation',
Text::_('INSTL_INSTALL_JOOMLA')
),
'notice'
);
return false;
}
if (
Factory::getSession()->get('remoteDbFileWrittenByJoomla', false) === true
&& is_file(JPATH_INSTALLATION . '/' . $remoteDbFile)
) {
// Add the general message
Factory::getApplication()->enqueueMessage($generalRemoteDatabaseMessage, 'warning');
// Request to delete the file
Factory::getApplication()->enqueueMessage(
Text::sprintf(
'INSTL_DATABASE_HOST_IS_NOT_LOCALHOST_DELETE_FILE',
$remoteDbFile,
'installation',
Text::_('INSTL_INSTALL_JOOMLA')
),
'notice'
);
return false;
}
if (Factory::getSession()->get('remoteDbFileUnwritable', false) === true && !is_file(JPATH_INSTALLATION . '/' . $remoteDbFile)) {
// Add the general message
Factory::getApplication()->enqueueMessage($generalRemoteDatabaseMessage, 'warning');
// Request to create the file manually
Factory::getApplication()->enqueueMessage(
Text::sprintf(
'INSTL_DATABASE_HOST_IS_NOT_LOCALHOST_CREATE_FILE',
$remoteDbFile,
'installation',
Text::_('INSTL_INSTALL_JOOMLA')
),
'notice'
);
return false;
}
// All tests for this session passed set it to the session
Factory::getSession()->set('remoteDbFileTestsPassed', true);
}
}
return true;
}
/**
* Check database server parameters after connection
*
* @param DatabaseDriver $db Database object
* @param \stdClass $options The session options
*
* @return string|boolean A string with the translated error message if
* some server parameter is not ok, otherwise false.
*
* @since 4.0.0
*/
public static function checkDbServerParameters($db, $options)
{
$dbVersion = $db->getVersion();
// Get required database version
$minDbVersionRequired = self::getMinimumServerVersion($db, $options);
// Check minimum database version
if (version_compare($dbVersion, $minDbVersionRequired) < 0) {
if (in_array($options->db_type, ['mysql', 'mysqli']) && $db->isMariaDb()) {
$errorMessage = Text::sprintf(
'INSTL_DATABASE_INVALID_MARIADB_VERSION',
$minDbVersionRequired,
$dbVersion
);
} else {
$errorMessage = Text::sprintf(
'INSTL_DATABASE_INVALID_' . strtoupper($options->db_type) . '_VERSION',
$minDbVersionRequired,
$dbVersion
);
}
return $errorMessage;
}
// Check database connection encryption
if ($options->db_encryption !== 0 && empty($db->getConnectionEncryption())) {
if ($db->isConnectionEncryptionSupported()) {
$errorMessage = Text::_('INSTL_DATABASE_ENCRYPTION_MSG_CONN_NOT_ENCRYPT');
} else {
$errorMessage = Text::_('INSTL_DATABASE_ENCRYPTION_MSG_SRV_NOT_SUPPORTS');
}
return $errorMessage;
}
return false;
}
}
The same content is in 5 releases, Joomla 5.0.0-alpha3 to 5.0.0-beta3. See them all, or every version of this file.