- md5
- 087737ad9694b70d8be403ecbb1fa707
- sha1
- 73072a33817e257addcba357c68d55e59104ec0d
- sha256
- db7a6b46c0bb3ee82699fb3f756a3d2c95f62eadfe1d433a405319f784f7ca2c
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289
<?php
/**
* @package Joomla.Installation
* @subpackage Model
*
* @copyright Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
* @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\Installer\Installer;
use Joomla\CMS\Language\LanguageHelper;
use Joomla\Database\DatabaseDriver;
use Joomla\Database\DatabaseInterface;
use Joomla\Database\Exception\ExecutionFailureException;
use Joomla\Database\UTF8MB4SupportInterface;
use Joomla\Utilities\ArrayHelper;
/**
* Database configuration model for the Joomla Core Installer.
*
* @since 3.1
*/
class DatabaseModel extends BaseInstallationModel
{
/**
* The generated user ID.
*
* @var integer
* @since 3.1
*/
protected static $userId = 0;
/**
* Get the current setup options from the session.
*
* @return array An array of options from the session.
*
* @since __DEPLOY_VERSION__
*/
public function getOptions()
{
return Factory::getSession()->get('setup.options', array());
}
/**
* Generates the user ID.
*
* @return integer The user ID.
*
* @since 3.1
*/
protected static function generateRandUserId()
{
$session = Factory::getSession();
$randUserId = $session->get('randUserId');
if (empty($randUserId))
{
// Create the ID for the root user only once and store in session.
$randUserId = mt_rand(1, 1000);
$session->set('randUserId', $randUserId);
}
return $randUserId;
}
/**
* Resets the user ID.
*
* @return void
*
* @since 3.1
*/
public static function resetRandUserId()
{
self::$userId = 0;
Factory::getSession()->set('randUserId', self::$userId);
}
/**
* Retrieves the default user ID and sets it if necessary.
*
* @return integer The user ID.
*
* @since 3.1
*/
public static function getUserId()
{
if (!self::$userId)
{
self::$userId = self::generateRandUserId();
}
return self::$userId;
}
/**
* Method to initialise the database.
*
* @param array $options The options to use for configuration.
*
* @return DatabaseInterface|boolean Database object on success, boolean false on failure
*
* @since 3.1
*/
public function initialise($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);
}
// Ensure a database type was selected.
if (empty($options->db_type))
{
Factory::getApplication()->enqueueMessage(\JText::_('INSTL_DATABASE_INVALID_TYPE'), 'warning');
return false;
}
// Ensure that a hostname and user name were input.
if (empty($options->db_host) || empty($options->db_user))
{
Factory::getApplication()->enqueueMessage(\JText::_('INSTL_DATABASE_INVALID_DB_DETAILS'), 'warning');
return false;
}
// Ensure that a database name was input.
if (empty($options->db_name))
{
Factory::getApplication()->enqueueMessage(\JText::_('INSTL_DATABASE_EMPTY_NAME'), 'warning');
return false;
}
// Validate database table prefix.
if (isset($options->db_prefix) && !preg_match('#^[a-zA-Z]+[a-zA-Z0-9_]*$#', $options->db_prefix))
{
Factory::getApplication()->enqueueMessage(\JText::_('INSTL_DATABASE_PREFIX_MSG'), 'warning');
return false;
}
// Validate length of database table prefix.
if (isset($options->db_prefix) && strlen($options->db_prefix) > 15)
{
Factory::getApplication()->enqueueMessage(\JText::_('INSTL_DATABASE_FIX_TOO_LONG'), 'warning');
return false;
}
// Validate length of database name.
if (strlen($options->db_name) > 64)
{
Factory::getApplication()->enqueueMessage(\JText::_('INSTL_DATABASE_NAME_TOO_LONG'), 'warning');
return false;
}
// Workaround for UPPERCASE table prefix for postgresql
if ($options->db_type == 'postgresql')
{
if (isset($options->db_prefix) && strtolower($options->db_prefix) !== $options->db_prefix)
{
Factory::getApplication()->enqueueMessage(\JText::_('INSTL_DATABASE_FIX_LOWERCASE'), 'warning');
return false;
}
// @TODO implement the security check
/**
$shouldCheckLocalhost = getenv('JOOMLA_INSTALLATION_DISABLE_LOCALHOST_CHECK') !== '1';
// Per Default allowed DB Hosts
$localhost = array(
'localhost',
'127.0.0.1',
'::1',
);
// Check the security file if the db_host is not localhost / 127.0.0.1 / ::1
if ($shouldCheckLocalhost && !in_array($options->db_host, $localhost))
{
$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 = \JText::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' . JUserHelper::genRandomPassword(21) . '.txt';
Factory::getSession()->set('remoteDbFile', $remoteDbFile);
// Get the path
$remoteDbPath = JPATH_INSTALLATION . '/' . $remoteDbFile;
// When the path is not writable the user needs to create the file manually
if (!JFile::write($remoteDbPath, ''))
{
// Request to create the file manually
Factory::getApplication()->enqueueMessage(\JText::sprintf('INSTL_DATABASE_HOST_IS_NOT_LOCALHOST_CREATE_FILE', $remoteDbFile), 'error');
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(\JText::sprintf('INSTL_DATABASE_HOST_IS_NOT_LOCALHOST_DELETE_FILE', $remoteDbFile), 'error');
return false;
}
if (Factory::getSession()->get('remoteDbFileWrittenByJoomla', false) === true && file_exists(JPATH_INSTALLATION . '/' . $remoteDbFile))
{
// Add the general message
Factory::getApplication()->enqueueMessage($generalRemoteDatabaseMessage, 'warning');
Factory::getApplication()->enqueueMessage(\JText::sprintf('INSTL_DATABASE_HOST_IS_NOT_LOCALHOST_DELETE_FILE', $remoteDbFile), 'error');
return false;
}
if (Factory::getSession()->get('remoteDbFileUnwritable', false) === true && !file_exists(JPATH_INSTALLATION . '/' . $remoteDbFile))
{
// Add the general message
Factory::getApplication()->enqueueMessage($generalRemoteDatabaseMessage, 'warning');
Factory::getApplication()->enqueueMessage(\JText::sprintf('INSTL_DATABASE_HOST_IS_NOT_LOCALHOST_CREATE_FILE', $remoteDbFile), 'error');
return false;
}
// All tests for this session passed set it to the session
Factory::getSession()->set('remoteDbFileTestsPassed', true);
}
}
*/
}
// Get a database object.
try
{
return DatabaseHelper::getDbo(
$options->db_type,
$options->db_host,
$options->db_user,
$options->db_pass,
$options->db_name,
$options->db_prefix,
isset($options->db_select) ? $options->db_select : false
);
}
catch (\RuntimeException $e)
{
Factory::getApplication()->enqueueMessage(\JText::sprintf('INSTL_DATABASE_COULD_NOT_CONNECT', $e->getMessage()), 'error');
return false;
}
}
/**
* Method to create a new database.
*
* @param array $options The configuration options
*
* @return boolean
*
* @since 3.1
* @throws \RuntimeException
*/
public function createDatabase($options)
{
// Disable autoselect database before it's created.
$tmpSelect = true;
if (isset($options->db_select))
{
$tmpSelect = $options->db_select;
}
$options->db_select = false;
$db = $this->initialise($options);
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 PostgreSQL and the PDO MySQL drivers presently
*
* Error Messages:
* PDO MySQL: [1049] Unknown database 'database_name'
* PostgreSQL: Error connecting to PGSQL database
*/
if ($type == 'pdomysql' && strpos($e->getMessage(), '[1049] Unknown database') === 42)
{
/*
* Now we're really getting insane here; we're going to try building a new JDatabaseDriver instance without the database name
* in order to trick the connection into creating the database
*/
$altDBoptions = array(
'driver' => $options->db_type,
'host' => $options->db_host,
'user' => $options->db_user,
'password' => $options->db_pass,
'prefix' => $options->db_prefix,
'select' => $options->db_select,
);
$altDB = \JDatabaseDriver::getInstance($altDBoptions);
// 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(\JText::_('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(\JText::sprintf('INSTL_DATABASE_COULD_NOT_CONNECT', $e->getMessage()), 500, $e);
}
}
elseif ($type == 'postgresql' && strpos($e->getMessage(), 'Error connecting to PGSQL database') === 42)
{
throw new \RuntimeException(\JText::_('INSTL_DATABASE_COULD_NOT_CREATE_DATABASE'), 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(\JText::sprintf('INSTL_DATABASE_COULD_NOT_CONNECT', $e->getMessage()), 500, $e);
}
}
if (!$db->isMinimumVersion())
{
throw new \RuntimeException(\JText::sprintf('INSTL_DATABASE_INVALID_' . strtoupper($type) . '_VERSION', $db_version));
}
if ($db->getServerType() === 'mysql')
{
// @internal MySQL versions pre 5.1.6 forbid . / or \ or NULL.
if (preg_match('#[\\\/\.\0]#', $options->db_name) && (!version_compare($db_version, '5.1.6', '>=')))
{
throw new \RuntimeException(\JText::sprintf('INSTL_DATABASE_INVALID_NAME', $db_version));
}
}
// @internal Check for spaces in beginning or end of name.
if (strlen(trim($options->db_name)) <> strlen($options->db_name))
{
throw new \RuntimeException(\JText::_('INSTL_DATABASE_NAME_INVALID_SPACES'));
}
// @internal Check for asc(00) Null in name.
if (strpos($options->db_name, chr(00)) !== false)
{
throw new \RuntimeException(\JText::_('INSTL_DATABASE_NAME_INVALID_CHAR'));
}
// PostgreSQL database older than version 9.0.0 needs to run 'CREATE LANGUAGE' to create function.
if ($db->getServerType() === 'postgresql' && !version_compare($db_version, '9.0.0', '>='))
{
$db->setQuery("select lanpltrusted from pg_language where lanname='plpgsql'");
try
{
$db->execute();
}
catch (\RuntimeException $e)
{
throw new \RuntimeException(\JText::_('INSTL_DATABASE_ERROR_POSTGRESQL_QUERY'), 500, $e);
}
$column = $db->loadResult();
if ($column != 't')
{
$db->setQuery('CREATE LANGUAGE plpgsql');
try
{
$db->execute();
}
catch (\RuntimeException $e)
{
throw new \RuntimeException(\JText::_('INSTL_DATABASE_ERROR_POSTGRESQL_QUERY'), 500, $e);
}
}
}
// 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(\JText::sprintf('INSTL_DATABASE_ERROR_CREATE', $options->db_name), 500, $e);
}
$db->select($options->db_name);
}
$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);
// Restore autoselect value after database creation.
$options['db_select'] = $tmpSelect;
Factory::getSession()->set('setup.options', $options);
return true;
}
/**
* Method to process the old database.
*
* @param array $options The options array.
*
* @return boolean True on success.
*
* @since 3.1
*/
public function handleOldDatabase($options)
{
if (!isset($options->db_created) || !$options->db_created)
{
return $this->createDatabase($options);
}
if (!$db = $this->initialise($options))
{
return false;
}
// Set the character set to UTF-8 for pre-existing databases.
try
{
$db->alterDbCharacterSet($options->db_name);
}
catch (\RuntimeException $e)
{
// Continue Anyhow
}
// Should any old database tables be removed or backed up?
if ($options->db_old == 'remove')
{
// Attempt to delete the old database tables.
if (!$this->deleteDatabase($db, $options->db_prefix))
{
// Message queued by method, simply return
return false;
}
}
else
{
// If the database isn't being deleted, back it up.
if (!$this->backupDatabase($db, $options->db_prefix))
{
return false;
}
}
return true;
}
/**
* Method to create the database tables.
*
* @param array $options The options array.
*
* @return boolean True on success.
*
* @since 3.1
*/
public function createTables($options)
{
if (!isset($options->db_created) || !$options->db_created)
{
return $this->createDatabase($options);
}
if (!$db = $this->initialise($options))
{
return false;
}
// Check database type.
$type = $options->db_type;
// Set the character set to UTF-8 for pre-existing databases.
try
{
$db->alterDbCharacterSet($options->db_name);
}
catch (\RuntimeException $e)
{
// Continue Anyhow
}
// Set the appropriate schema script based on UTF-8 support.
if ($db->getServerType() === 'mysql')
{
$schema = 'sql/mysql/joomla.sql';
}
else
{
$schema = 'sql/' . $type . '/joomla.sql';
}
// Check if the schema is a valid file
if (!is_file($schema))
{
Factory::getApplication()->enqueueMessage(\JText::sprintf('INSTL_ERROR_DB', \JText::_('INSTL_DATABASE_NO_SCHEMA')), 'error');
return false;
}
// Attempt to import the database schema.
if (!$this->populateDatabase($db, $schema))
{
return false;
}
// Get query object for later database access
$query = $db->getQuery(true);
// MySQL only: Attempt to update the table #__utf8_conversion.
$serverType = $db->getServerType();
if ($serverType === 'mysql')
{
$query->clear()
->update($db->quoteName('#__utf8_conversion'))
->set($db->quoteName('converted') . ' = ' . ($db->hasUTF8mb4Support() ? 2 : 1));
$db->setQuery($query);
try
{
$db->execute();
}
catch (\RuntimeException $e)
{
Factory::getApplication()->enqueueMessage($e->getMessage(), 'error');
return false;
}
}
// Attempt to update the table #__schema.
$pathPart = JPATH_ADMINISTRATOR . '/components/com_admin/sql/updates/';
if ($serverType === 'mysql')
{
$pathPart .= 'mysql/';
}
else
{
$pathPart .= $type . '/';
}
$files = \JFolder::files($pathPart, '\.sql$');
if (empty($files))
{
Factory::getApplication()->enqueueMessage(\JText::_('INSTL_ERROR_INITIALISE_SCHEMA'), 'error');
return false;
}
$version = '';
foreach ($files as $file)
{
if (version_compare($version, \JFile::stripExt($file)) < 0)
{
$version = \JFile::stripExt($file);
}
}
$query->clear()
->insert($db->quoteName('#__schemas'))
->columns(
array(
$db->quoteName('extension_id'),
$db->quoteName('version_id')
)
)
->values('700, ' . $db->quote($version));
$db->setQuery($query);
try
{
$db->execute();
}
catch (\RuntimeException $e)
{
Factory::getApplication()->enqueueMessage($e->getMessage(), 'error');
return false;
}
// Attempt to refresh manifest caches.
$query->clear()
->select('*')
->from('#__extensions');
$db->setQuery($query);
$return = true;
try
{
$extensions = $db->loadObjectList();
}
catch (\RuntimeException $e)
{
Factory::getApplication()->enqueueMessage($e->getMessage(), 'error');
$return = false;
}
Factory::$database = $db;
$installer = Installer::getInstance();
foreach ($extensions as $extension)
{
if (!$installer->refreshManifestCache($extension->extension_id))
{
Factory::getApplication()->enqueueMessage(\JText::sprintf('INSTL_DATABASE_COULD_NOT_REFRESH_MANIFEST_CACHE', $extension->name), 'error');
return false;
}
}
// Load the localise.sql for translating the data in joomla.sql.
if ($serverType === 'mysql')
{
$dblocalise = 'sql/mysql/localise.sql';
}
else
{
$dblocalise = 'sql/' . $type . '/localise.sql';
}
if (is_file($dblocalise))
{
if (!$this->populateDatabase($db, $dblocalise))
{
return false;
}
}
// Handle default backend language setting. This feature is available for localized versions of Joomla.
$languages = Factory::getApplication()->getLocaliseAdmin($db);
if (in_array($options->language, $languages['admin']) || in_array($options->language, $languages['site']))
{
// Build the language parameters for the language manager.
$params = array();
// Set default administrator/site language to sample data values.
$params['administrator'] = 'en-GB';
$params['site'] = 'en-GB';
if (in_array($options->language, $languages['admin']))
{
$params['administrator'] = $options->language;
}
if (in_array($options->language, $languages['site']))
{
$params['site'] = $options->language;
}
$params = json_encode($params);
// Update the language settings in the language manager.
$query->clear()
->update($db->quoteName('#__extensions'))
->set($db->quoteName('params') . ' = ' . $db->quote($params))
->where($db->quoteName('element') . ' = ' . $db->quote('com_languages'));
$db->setQuery($query);
try
{
$db->execute();
}
catch (\RuntimeException $e)
{
Factory::getApplication()->enqueueMessage($e->getMessage(), 'error');
$return = false;
}
}
return $return;
}
/**
* Method to install the sample data.
*
* @param array $options The options array.
*
* @return boolean True on success.
*
* @since 3.1
*/
public function installSampleData($options)
{
if (empty($options) && !empty(Factory::getSession()->get('setup.options', array())))
{
$options = Factory::getSession()->get('setup.options', array());
}
if (is_array($options))
{
// Get the options as an object for easier handling.
$options = ArrayHelper::toObject($options);
}
if (!isset($options->db_created) || !$options->db_created)
{
return $this->createDatabase($options);
}
if (!$db = $this->initialise($options))
{
return false;
}
// Build the path to the sample data file.
$type = $options->db_type;
if ($db->getServerType() === 'mysql')
{
$type = 'mysql';
}
if (Factory::getApplication()->input->get('sample_file', ''))
{
$options->sample_file = Factory::getApplication()->input->get('sample_file', '');
}
else
{
$options->sample_file = 'sample_testing.sql';
}
$data = JPATH_INSTALLATION . '/sql/' . $type . '/' . $options->sample_file;
// Attempt to import the database schema if one is chosen.
if ($options->sample_file != '')
{
if (!file_exists($data))
{
Factory::getApplication()->enqueueMessage(\JText::sprintf('INSTL_DATABASE_FILE_DOES_NOT_EXIST', $data), 'error');
return false;
}
elseif (!$this->populateDatabase($db, $data))
{
return false;
}
$this->postInstallSampleData($db, $options->sample_file);
}
return true;
}
/**
* Sample data tables and data post install process.
*
* @param \JDatabaseDriver $db Database connector object $db*.
* @param string $sampleFileName The sample dats filename.
*
* @return void
*
* @since 3.1
*/
protected function postInstallSampleData($db, $sampleFileName = '')
{
// Update the sample data user ids.
$this->updateUserIds($db);
// If not joomla sample data for testing, update the sample data dates.
if ($sampleFileName !== 'sample_testing.sql')
{
$this->updateDates($db);
}
}
/**
* Method to install the cms data.
*
* @param array $options The options array.
*
* @return boolean True on success.
*
* @since 3.6.1
*/
public function installCmsData($options)
{
if (!$db = $this->initialise($options))
{
return false;
}
// Run Cms data post install to update user ids.
$this->postInstallCmsData($db);
return true;
}
/**
* Cms tables and data post install process.
*
* @param \JDatabaseDriver $db Database connector object $db*.
*
* @return void
*
* @since 3.6.1
*/
protected function postInstallCmsData($db)
{
// Update the cms data user ids.
$this->updateUserIds($db);
// Update the cms data dates.
$this->updateDates($db);
}
/**
* Method to update the user id of sql data content to the new rand user id.
*
* @param \JDatabaseDriver $db Database connector object $db*.
*
* @return boolean True on success.
*
* @since 3.6.1
*/
protected function updateUserIds($db)
{
// Create the ID for the root user.
$userId = self::getUserId();
// Update all core tables created_by fields of the tables with the random user id.
$updatesArray = array(
'#__banners' => array('created_by', 'modified_by'),
'#__categories' => array('created_user_id', 'modified_user_id'),
'#__contact_details' => array('created_by', 'modified_by'),
'#__content' => array('created_by', 'modified_by'),
'#__fields' => array('created_user_id', 'modified_by'),
'#__finder_filters' => array('created_by', 'modified_by'),
'#__newsfeeds' => array('created_by', 'modified_by'),
'#__tags' => array('created_user_id', 'modified_user_id'),
'#__ucm_content' => array('core_created_user_id', 'core_modified_user_id'),
'#__ucm_history' => array('editor_user_id'),
'#__user_notes' => array('created_user_id', 'modified_user_id'),
);
foreach ($updatesArray as $table => $fields)
{
foreach ($fields as $field)
{
$query = $db->getQuery(true)
->update($db->quoteName($table))
->set($db->quoteName($field) . ' = ' . $db->quote($userId))
->where($db->quoteName($field) . ' != 0')
->where($db->quoteName($field) . ' IS NOT NULL');
$db->setQuery($query);
try
{
$db->execute();
}
catch (\RuntimeException $e)
{
Factory::getApplication()->enqueueMessage($e->getMessage(), 'error');
}
}
}
}
/**
* Method to update the dates of sql data content to the current date.
*
* @param \JDatabaseDriver $db Database connector object $db*.
*
* @return boolean True on success.
*
* @since 3.7.0
*/
protected function updateDates($db)
{
// Get the current date.
$currentDate = Factory::getDate()->toSql();
$nullDate = $db->getNullDate();
// Update all core tables date fields of the tables with the current date.
$updatesArray = array(
'#__banners' => array('publish_up', 'publish_down', 'reset', 'created', 'modified'),
'#__banner_tracks' => array('track_date'),
'#__categories' => array('created_time', 'modified_time'),
'#__contact_details' => array('publish_up', 'publish_down', 'created', 'modified'),
'#__content' => array('publish_up', 'publish_down', 'created', 'modified'),
'#__contentitem_tag_map' => array('tag_date'),
'#__fields' => array('created_time', 'modified_time'),
'#__finder_filters' => array('created', 'modified'),
'#__finder_links' => array('indexdate', 'publish_start_date', 'publish_end_date', 'start_date', 'end_date'),
'#__messages' => array('date_time'),
'#__modules' => array('publish_up', 'publish_down'),
'#__newsfeeds' => array('publish_up', 'publish_down', 'created', 'modified'),
'#__redirect_links' => array('created_date', 'modified_date'),
'#__tags' => array('publish_up', 'publish_down', 'created_time', 'modified_time'),
'#__ucm_content' => array('core_created_time', 'core_modified_time', 'core_publish_up', 'core_publish_down'),
'#__ucm_history' => array('save_date'),
'#__users' => array('registerDate', 'lastvisitDate', 'lastResetTime'),
'#__user_notes' => array('publish_up', 'publish_down', 'created_time', 'modified_time'),
);
foreach ($updatesArray as $table => $fields)
{
foreach ($fields as $field)
{
$query = $db->getQuery(true)
->update($db->quoteName($table))
->set($db->quoteName($field) . ' = ' . $db->quote($currentDate))
->where($db->quoteName($field) . ' != ' . $db->quote($nullDate));
$db->setQuery($query);
try
{
$db->execute();
}
catch (\RuntimeException $e)
{
Factory::getApplication()->enqueueMessage($e->getMessage(), 'error');
}
}
}
}
/**
* Method to backup all tables in a database with a given prefix.
*
* @param \JDatabaseDriver $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(\JText::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(\JText::sprintf('INSTL_DATABASE_ERROR_BACKINGUP', $e->getMessage()), 'error');
$return = false;
}
}
}
}
return $return;
}
/**
* Method to create a new database.
*
* @param \JDatabaseDriver $db JDatabase object.
* @param \JObject $options JObject 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 delete all tables in a database with a given prefix.
*
* @param \JDatabaseDriver $db JDatabaseDriver object.
* @param string $prefix Database table prefix.
*
* @return boolean True on success.
*
* @since 3.1
*/
public function deleteDatabase($db, $prefix)
{
$return = true;
// Get the tables in the database.
$tables = $db->getTableList();
if ($tables)
{
foreach ($tables as $table)
{
// If the table uses the given prefix, drop it.
if (strpos($table, $prefix) === 0)
{
// Drop the table.
try
{
$db->dropTable($table);
}
catch (\RuntimeException $e)
{
Factory::getApplication()->enqueueMessage(\JText::sprintf('INSTL_DATABASE_ERROR_DELETE', $e->getMessage()), 'error');
$return = false;
}
}
}
}
return $return;
}
/**
* Method to import a database schema from a file.
*
* @param \JDatabaseDriver $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($db->getErrorMsg(), '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} != '-'))
{
/**
* If we don't have UTF-8 Multibyte support we'll have to convert queries to plain UTF-8
*
* Note: the JDatabaseDriver::convertUtf8mb4QueryToUtf8 performs the conversion ONLY when
* necessary, so there's no need to check the conditions in JInstaller.
*/
$query = $db->convertUtf8mb4QueryToUtf8($query);
/**
* This is a query which was supposed to convert tables to utf8mb4 charset but the server doesn't
* support utf8mb4. Therefore we don't have to run it, it has no effect and it's a mere waste of time.
*/
if (!$db->hasUTF8mb4Support() && stristr($query, 'CONVERT TO CHARACTER SET utf8 '))
{
continue;
}
// 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;
}
}
No other release has this exact content. See every version of this file.