CoreFiles by mySites.guru
DatabaseHelper.php180 lines, 4,582 bytes, from Joomla_4.0.0-beta1-Beta-Full_Package.zip
Raw History Compare with 3.9.0-beta4
md5
d0a44929857daa0a119b1f58cebf3f1f
sha1
3a83696b5b61cba0378b9be8d83b642814192cf8
sha256
c323c866bc27e095d07c0e152bca9a96086fe4bead2accaa53cfd76a82d640f3
<?php
/**
 * @package    Joomla.Installation
 *
 * @copyright  Copyright (C) 2005 - 2020 Open Source Matters, Inc. All rights reserved.
 * @license    GNU General Public License version 2 or later; see LICENSE.txt
 */

namespace Joomla\CMS\Installation\Helper;

defined('_JEXEC') or die;

use Joomla\Database\DatabaseDriver;
use Joomla\Database\DatabaseInterface;

/**
 * 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.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';

	/**
	 * 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;
	}
}

No other release has this exact content. See every version of this file.