- md5
- 60e6dc353ad2fc13b4f9a8c205510a4a
- sha1
- 45eb9d787283e1b7d174987133ea6c9e762b0c0d
- sha256
- 38b3bf08db048e015fccbcb1820b8b6435ff829dfcb15f4bd52e05068771496c
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585
<?php
/**
* @package Joomla.Installation
* @subpackage Model
*
* @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\Model;
\defined('_JEXEC') or die;
use Joomla\CMS\Factory;
use Joomla\CMS\Installation\Helper\DatabaseHelper;
use Joomla\CMS\Language\LanguageHelper;
use Joomla\CMS\Language\Text;
use Joomla\CMS\Object\CMSObject;
use Joomla\Database\DatabaseDriver;
use Joomla\Database\DatabaseInterface;
use Joomla\Utilities\ArrayHelper;
/**
* Database configuration model for the Joomla Core Installer.
*
* @since 3.1
*/
class DatabaseModel extends BaseInstallationModel
{
/**
* Get the current setup options from the session.
*
* @return array An array of options from the session.
*
* @since 4.0.0
*/
public function getOptions()
{
return Factory::getSession()->get('setup.options', array());
}
/**
* Method to initialise the database.
*
* @param boolean $select Select the database when creating the connections.
*
* @return DatabaseInterface|boolean Database object on success, boolean false on failure
*
* @since 3.1
*/
public function initialise($select = true)
{
$options = $this->getOptions();
// Get the options as an object for easier handling.
$options = ArrayHelper::toObject($options);
// Load the backend language files so that the DB error messages work.
$lang = Factory::getLanguage();
$currentLang = $lang->getTag();
// Load the selected language
if (LanguageHelper::exists($currentLang, JPATH_ADMINISTRATOR))
{
$lang->load('joomla', JPATH_ADMINISTRATOR, $currentLang, true);
}
// Pre-load en-GB in case the chosen language files do not exist.
else
{
$lang->load('joomla', JPATH_ADMINISTRATOR, 'en-GB', true);
}
// Validate and clean up connection parameters
$paramsCheck = DatabaseHelper::validateConnectionParameters($options);
if ($paramsCheck)
{
Factory::getApplication()->enqueueMessage($paramsCheck, 'warning');
return false;
}
// Security check for remote db hosts
if (!DatabaseHelper::checkRemoteDbHost($options))
{
// Messages have been enqueued in the called function.
return false;
}
// Get a database object.
try
{
return DatabaseHelper::getDbo(
$options->db_type,
$options->db_host,
$options->db_user,
$options->db_pass_plain,
$options->db_name,
$options->db_prefix,
$select,
DatabaseHelper::getEncryptionSettings($options)
);
}
catch (\RuntimeException $e)
{
Factory::getApplication()->enqueueMessage(Text::sprintf('INSTL_DATABASE_COULD_NOT_CONNECT', $e->getMessage()), 'error');
return false;
}
}
/**
* Method to create a new database.
*
* @return boolean
*
* @since 3.1
* @throws \RuntimeException
*/
public function createDatabase()
{
$options = (object) $this->getOptions();
$db = $this->initialise(false);
if ($db === false)
{
// Error messages are enqueued by the initialise function, we just need to tell the controller how to redirect
return false;
}
// Check database version.
$type = $options->db_type;
try
{
$db_version = $db->getVersion();
}
catch (\RuntimeException $e)
{
/*
* We may get here if the database doesn't exist, if so then explain that to users instead of showing the database connector's error
* This only supports PDO PostgreSQL and the PDO MySQL drivers presently
*
* Error Messages:
* PDO MySQL: [1049] Unknown database 'database_name'
* PDO PostgreSQL: database "database_name" does not exist
*/
if ($type === 'mysql' && strpos($e->getMessage(), '[1049] Unknown database') === 42
|| $type === 'pgsql' && strpos($e->getMessage(), 'database "' . $options->db_name . '" does not exist'))
{
/*
* Now we're really getting insane here; we're going to try building a new JDatabaseDriver instance
* in order to trick the connection into creating the database
*/
if ($type === 'mysql')
{
// MySQL (PDO): Don't specify database name
$altDBoptions = array(
'driver' => $options->db_type,
'host' => $options->db_host,
'user' => $options->db_user,
'password' => $options->db_pass_plain,
'prefix' => $options->db_prefix,
'select' => false,
DatabaseHelper::getEncryptionSettings($options),
);
}
else
{
// PostgreSQL (PDO): Use 'postgres'
$altDBoptions = array(
'driver' => $options->db_type,
'host' => $options->db_host,
'user' => $options->db_user,
'password' => $options->db_pass_plain,
'database' => 'postgres',
'prefix' => $options->db_prefix,
'select' => false,
DatabaseHelper::getEncryptionSettings($options),
);
}
$altDB = DatabaseDriver::getInstance($altDBoptions);
// Check database server parameters
$dbServerCheck = DatabaseHelper::checkDbServerParameters($altDB, $options);
if ($dbServerCheck)
{
// Some server parameter is not ok
throw new \RuntimeException($dbServerCheck, 500, $e);
}
// Try to create the database now using the alternate driver
try
{
$this->createDb($altDB, $options, $altDB->hasUtfSupport());
}
catch (\RuntimeException $e)
{
// We did everything we could
throw new \RuntimeException(Text::_('INSTL_DATABASE_COULD_NOT_CREATE_DATABASE'), 500, $e);
}
// If we got here, the database should have been successfully created, now try one more time to get the version
try
{
$db_version = $db->getVersion();
}
catch (\RuntimeException $e)
{
// We did everything we could
throw new \RuntimeException(Text::sprintf('INSTL_DATABASE_COULD_NOT_CONNECT', $e->getMessage()), 500, $e);
}
}
// Anything getting into this part of the conditional either doesn't support manually creating the database or isn't that type of error
else
{
throw new \RuntimeException(Text::sprintf('INSTL_DATABASE_COULD_NOT_CONNECT', $e->getMessage()), 500, $e);
}
}
// Check database server parameters
$dbServerCheck = DatabaseHelper::checkDbServerParameters($db, $options);
if ($dbServerCheck)
{
// Some server parameter is not ok
throw new \RuntimeException($dbServerCheck, 500, $e);
}
// @internal Check for spaces in beginning or end of name.
if (strlen(trim($options->db_name)) <> strlen($options->db_name))
{
throw new \RuntimeException(Text::_('INSTL_DATABASE_NAME_INVALID_SPACES'));
}
// @internal Check for asc(00) Null in name.
if (strpos($options->db_name, chr(00)) !== false)
{
throw new \RuntimeException(Text::_('INSTL_DATABASE_NAME_INVALID_CHAR'));
}
// Get database's UTF support.
$utfSupport = $db->hasUtfSupport();
// Try to select the database.
try
{
$db->select($options->db_name);
}
catch (\RuntimeException $e)
{
// If the database could not be selected, attempt to create it and then select it.
if (!$this->createDb($db, $options, $utfSupport))
{
throw new \RuntimeException(Text::sprintf('INSTL_DATABASE_ERROR_CREATE', $options->db_name), 500, $e);
}
$db->select($options->db_name);
}
// Set the character set to UTF-8 for pre-existing databases.
try
{
$db->alterDbCharacterSet($options->db_name);
}
catch (\RuntimeException $e)
{
// Continue Anyhow
}
$options = (array) $options;
// Remove *_errors value.
foreach ($options as $i => $option)
{
if (isset($i['1']) && $i['1'] == '*')
{
unset($options[$i]);
break;
}
}
$options = array_merge(['db_created' => 1], $options);
Factory::getSession()->set('setup.options', $options);
return true;
}
/**
* Method to process the old database.
*
* @return boolean True on success.
*
* @since 3.1
*/
public function handleOldDatabase()
{
$options = $this->getOptions();
if (!isset($options['db_created']) || !$options['db_created'])
{
return $this->createDatabase($options);
}
// Get the options as an object for easier handling.
$options = ArrayHelper::toObject($options);
if (!$db = $this->initialise())
{
return false;
}
// Set the character set to UTF-8 for pre-existing databases.
try
{
$db->alterDbCharacterSet($options->db_name);
}
catch (\RuntimeException $e)
{
// Continue Anyhow
}
// Backup any old database.
if (!$this->backupDatabase($db, $options->db_prefix))
{
return false;
}
return true;
}
/**
* Method to create the database tables.
*
* @param string $schema The SQL schema file to apply.
*
* @return boolean True on success.
*
* @since 3.1
*/
public function createTables($schema)
{
if (!$db = $this->initialise())
{
return false;
}
$serverType = $db->getServerType();
// Set the appropriate schema script based on UTF-8 support.
$schemaFile = 'sql/' . $serverType . '/' . $schema . '.sql';
// Check if the schema is a valid file
if (!is_file($schemaFile))
{
Factory::getApplication()->enqueueMessage(Text::sprintf('INSTL_ERROR_DB', Text::_('INSTL_DATABASE_NO_SCHEMA')), 'error');
return false;
}
// Attempt to import the database schema.
if (!$this->populateDatabase($db, $schemaFile))
{
return false;
}
return true;
}
/**
* Method to backup all tables in a database with a given prefix.
*
* @param DatabaseDriver $db JDatabaseDriver object.
* @param string $prefix Database table prefix.
*
* @return boolean True on success.
*
* @since 3.1
*/
public function backupDatabase($db, $prefix)
{
$return = true;
$backup = 'bak_' . $prefix;
// Get the tables in the database.
$tables = $db->getTableList();
if ($tables)
{
foreach ($tables as $table)
{
// If the table uses the given prefix, back it up.
if (strpos($table, $prefix) === 0)
{
// Backup table name.
$backupTable = str_replace($prefix, $backup, $table);
// Drop the backup table.
try
{
$db->dropTable($backupTable, true);
}
catch (\RuntimeException $e)
{
Factory::getApplication()->enqueueMessage(Text::sprintf('INSTL_DATABASE_ERROR_BACKINGUP', $e->getMessage()), 'error');
$return = false;
}
// Rename the current table to the backup table.
try
{
$db->renameTable($table, $backupTable, $backup, $prefix);
}
catch (\RuntimeException $e)
{
Factory::getApplication()->enqueueMessage(Text::sprintf('INSTL_DATABASE_ERROR_BACKINGUP', $e->getMessage()), 'error');
$return = false;
}
}
}
}
return $return;
}
/**
* Method to create a new database.
*
* @param DatabaseDriver $db Database object.
* @param CMSObject $options CMSObject coming from "initialise" function to pass user
* and database name to database driver.
* @param boolean $utf True if the database supports the UTF-8 character set.
*
* @return boolean True on success.
*
* @since 3.1
*/
public function createDb($db, $options, $utf)
{
// Build the create database query.
try
{
// Run the create database query.
$db->createDatabase($options, $utf);
}
catch (\RuntimeException $e)
{
// If an error occurred return false.
return false;
}
return true;
}
/**
* Method to import a database schema from a file.
*
* @param \Joomla\Database\DatabaseInterface $db JDatabase object.
* @param string $schema Path to the schema file.
*
* @return boolean True on success.
*
* @since 3.1
*/
public function populateDatabase($db, $schema)
{
$return = true;
// Get the contents of the schema file.
if (!($buffer = file_get_contents($schema)))
{
Factory::getApplication()->enqueueMessage(Text::_('INSTL_SAMPLE_DATA_NOT_FOUND'), 'error');
return false;
}
// Get an array of queries from the schema and process them.
$queries = $this->splitQueries($buffer);
foreach ($queries as $query)
{
// Trim any whitespace.
$query = trim($query);
// If the query isn't empty and is not a MySQL or PostgreSQL comment, execute it.
if (!empty($query) && ($query[0] != '#') && ($query[0] != '-'))
{
// Execute the query.
$db->setQuery($query);
try
{
$db->execute();
}
catch (\RuntimeException $e)
{
Factory::getApplication()->enqueueMessage($e->getMessage(), 'error');
$return = false;
}
}
}
return $return;
}
/**
* Method to split up queries from a schema file into an array.
*
* @param string $query SQL schema.
*
* @return array Queries to perform.
*
* @since 3.1
*/
protected function splitQueries($query)
{
$buffer = array();
$queries = array();
$in_string = false;
// Trim any whitespace.
$query = trim($query);
// Remove comment lines.
$query = preg_replace("/\n\#[^\n]*/", '', "\n" . $query);
// Remove PostgreSQL comment lines.
$query = preg_replace("/\n\--[^\n]*/", '', "\n" . $query);
// Find function.
$funct = explode('CREATE OR REPLACE FUNCTION', $query);
// Save sql before function and parse it.
$query = $funct[0];
// Parse the schema file to break up queries.
for ($i = 0; $i < strlen($query) - 1; $i++)
{
if ($query[$i] == ';' && !$in_string)
{
$queries[] = substr($query, 0, $i);
$query = substr($query, $i + 1);
$i = 0;
}
if ($in_string && ($query[$i] == $in_string) && $buffer[1] != "\\")
{
$in_string = false;
}
elseif (!$in_string && ($query[$i] == '"' || $query[$i] == "'") && (!isset($buffer[0]) || $buffer[0] != "\\"))
{
$in_string = $query[$i];
}
if (isset($buffer[1]))
{
$buffer[0] = $buffer[1];
}
$buffer[1] = $query[$i];
}
// If the is anything left over, add it to the queries.
if (!empty($query))
{
$queries[] = $query;
}
// Add function part as is.
for ($f = 1, $fMax = count($funct); $f < $fMax; $f++)
{
$queries[] = 'CREATE OR REPLACE FUNCTION ' . $funct[$f];
}
return $queries;
}
}
The same content is in 49 releases, Joomla 4.0.0-rc1 to 4.2.0-beta2. See them all, or every version of this file.