Move the install code into namespaced classes, too.
Larry Garfield
parent
9062e1e4e7
commit
7ef58b85b9
|
|
@ -0,0 +1,31 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\Database\Driver\mysql\Install;
|
||||
|
||||
use Drupal\Database\Install\Tasks as InstallTasks;
|
||||
|
||||
/**
|
||||
* Specifies installation tasks for MySQL and equivalent databases.
|
||||
*/
|
||||
class Tasks extends InstallTasks {
|
||||
/**
|
||||
* The PDO driver name for MySQL and equivalent databases.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $pdoDriver = 'mysql';
|
||||
|
||||
/**
|
||||
* Returns a human-readable name string for MySQL and equivalent databases.
|
||||
*/
|
||||
public function name() {
|
||||
return st('MySQL, MariaDB, or equivalent');
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the minimum version for MySQL.
|
||||
*/
|
||||
public function minimumVersion() {
|
||||
return '5.0.15';
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,175 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\Database\Driver\pgsql\Install;
|
||||
|
||||
use Drupal\Database\Install\Tasks as InstallTasks;
|
||||
|
||||
/**
|
||||
* PostgreSQL specific install functions
|
||||
*/
|
||||
class Tasks extends InstallTasks {
|
||||
protected $pdoDriver = 'pgsql';
|
||||
|
||||
public function __construct() {
|
||||
$this->tasks[] = array(
|
||||
'function' => 'checkEncoding',
|
||||
'arguments' => array(),
|
||||
);
|
||||
$this->tasks[] = array(
|
||||
'function' => 'checkBinaryOutput',
|
||||
'arguments' => array(),
|
||||
);
|
||||
$this->tasks[] = array(
|
||||
'function' => 'initializeDatabase',
|
||||
'arguments' => array(),
|
||||
);
|
||||
}
|
||||
|
||||
public function name() {
|
||||
return st('PostgreSQL');
|
||||
}
|
||||
|
||||
public function minimumVersion() {
|
||||
return '8.3';
|
||||
}
|
||||
|
||||
/**
|
||||
* Check encoding is UTF8.
|
||||
*/
|
||||
protected function checkEncoding() {
|
||||
try {
|
||||
if (db_query('SHOW server_encoding')->fetchField() == 'UTF8') {
|
||||
$this->pass(st('Database is encoded in UTF-8'));
|
||||
}
|
||||
else {
|
||||
$replacements = array(
|
||||
'%encoding' => 'UTF8',
|
||||
'%driver' => $this->name(),
|
||||
'!link' => '<a href="INSTALL.pgsql.txt">INSTALL.pgsql.txt</a>'
|
||||
);
|
||||
$text = 'The %driver database must use %encoding encoding to work with Drupal.';
|
||||
$text .= 'Recreate the database with %encoding encoding. See !link for more details.';
|
||||
$this->fail(st($text, $replacements));
|
||||
}
|
||||
}
|
||||
catch (Exception $e) {
|
||||
$this->fail(st('Drupal could not determine the encoding of the database was set to UTF-8'));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Check Binary Output.
|
||||
*
|
||||
* Unserializing does not work on Postgresql 9 when bytea_output is 'hex'.
|
||||
*/
|
||||
function checkBinaryOutput() {
|
||||
// PostgreSQL < 9 doesn't support bytea_output, so verify we are running
|
||||
// at least PostgreSQL 9.
|
||||
$database_connection = Database::getConnection();
|
||||
if (version_compare($database_connection->version(), '9') >= 0) {
|
||||
if (!$this->checkBinaryOutputSuccess()) {
|
||||
// First try to alter the database. If it fails, raise an error telling
|
||||
// the user to do it themselves.
|
||||
$connection_options = $database_connection->getConnectionOptions();
|
||||
// It is safe to include the database name directly here, because this
|
||||
// code is only called when a connection to the database is already
|
||||
// established, thus the database name is guaranteed to be a correct
|
||||
// value.
|
||||
$query = "ALTER DATABASE \"" . $connection_options['database'] . "\" SET bytea_output = 'escape';";
|
||||
try {
|
||||
db_query($query);
|
||||
}
|
||||
catch (Exception $e) {
|
||||
// Ignore possible errors when the user doesn't have the necessary
|
||||
// privileges to ALTER the database.
|
||||
}
|
||||
|
||||
// Close the database connection so that the configuration parameter
|
||||
// is applied to the current connection.
|
||||
db_close();
|
||||
|
||||
// Recheck, if it fails, finally just rely on the end user to do the
|
||||
// right thing.
|
||||
if (!$this->checkBinaryOutputSuccess()) {
|
||||
$replacements = array(
|
||||
'%setting' => 'bytea_output',
|
||||
'%current_value' => 'hex',
|
||||
'%needed_value' => 'escape',
|
||||
'!query' => "<code>" . $query . "</code>",
|
||||
);
|
||||
$this->fail(st("The %setting setting is currently set to '%current_value', but needs to be '%needed_value'. Change this by running the following query: !query", $replacements));
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Verify that a binary data roundtrip returns the original string.
|
||||
*/
|
||||
protected function checkBinaryOutputSuccess() {
|
||||
$bytea_output = db_query("SELECT 'encoding'::bytea AS output")->fetchField();
|
||||
return ($bytea_output == 'encoding');
|
||||
}
|
||||
|
||||
/**
|
||||
* Make PostgreSQL Drupal friendly.
|
||||
*/
|
||||
function initializeDatabase() {
|
||||
// We create some functions using global names instead of prefixing them
|
||||
// like we do with table names. This is so that we don't double up if more
|
||||
// than one instance of Drupal is running on a single database. We therefore
|
||||
// avoid trying to create them again in that case.
|
||||
|
||||
try {
|
||||
// Create functions.
|
||||
db_query('CREATE OR REPLACE FUNCTION "greatest"(numeric, numeric) RETURNS numeric AS
|
||||
\'SELECT CASE WHEN (($1 > $2) OR ($2 IS NULL)) THEN $1 ELSE $2 END;\'
|
||||
LANGUAGE \'sql\''
|
||||
);
|
||||
db_query('CREATE OR REPLACE FUNCTION "greatest"(numeric, numeric, numeric) RETURNS numeric AS
|
||||
\'SELECT greatest($1, greatest($2, $3));\'
|
||||
LANGUAGE \'sql\''
|
||||
);
|
||||
// Don't use {} around pg_proc table.
|
||||
if (!db_query("SELECT COUNT(*) FROM pg_proc WHERE proname = 'rand'")->fetchField()) {
|
||||
db_query('CREATE OR REPLACE FUNCTION "rand"() RETURNS float AS
|
||||
\'SELECT random();\'
|
||||
LANGUAGE \'sql\''
|
||||
);
|
||||
}
|
||||
|
||||
db_query('CREATE OR REPLACE FUNCTION "substring_index"(text, text, integer) RETURNS text AS
|
||||
\'SELECT array_to_string((string_to_array($1, $2)) [1:$3], $2);\'
|
||||
LANGUAGE \'sql\''
|
||||
);
|
||||
|
||||
// Using || to concatenate in Drupal is not recommeneded because there are
|
||||
// database drivers for Drupal that do not support the syntax, however
|
||||
// they do support CONCAT(item1, item2) which we can replicate in
|
||||
// PostgreSQL. PostgreSQL requires the function to be defined for each
|
||||
// different argument variation the function can handle.
|
||||
db_query('CREATE OR REPLACE FUNCTION "concat"(anynonarray, anynonarray) RETURNS text AS
|
||||
\'SELECT CAST($1 AS text) || CAST($2 AS text);\'
|
||||
LANGUAGE \'sql\'
|
||||
');
|
||||
db_query('CREATE OR REPLACE FUNCTION "concat"(text, anynonarray) RETURNS text AS
|
||||
\'SELECT $1 || CAST($2 AS text);\'
|
||||
LANGUAGE \'sql\'
|
||||
');
|
||||
db_query('CREATE OR REPLACE FUNCTION "concat"(anynonarray, text) RETURNS text AS
|
||||
\'SELECT CAST($1 AS text) || $2;\'
|
||||
LANGUAGE \'sql\'
|
||||
');
|
||||
db_query('CREATE OR REPLACE FUNCTION "concat"(text, text) RETURNS text AS
|
||||
\'SELECT $1 || $2;\'
|
||||
LANGUAGE \'sql\'
|
||||
');
|
||||
|
||||
$this->pass(st('PostgreSQL has initialized itself.'));
|
||||
}
|
||||
catch (Exception $e) {
|
||||
$this->fail(st('Drupal could not be correctly setup with the existing database. Revise any errors.'));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -0,0 +1,51 @@
|
|||
<?php
|
||||
|
||||
|
||||
namespace Drupal\Database\Driver\sqlite\Install;
|
||||
|
||||
use Drupal\Database\Install\Tasks as InstallTasks;
|
||||
|
||||
class Tasks extends InstallTasks {
|
||||
protected $pdoDriver = 'sqlite';
|
||||
|
||||
public function name() {
|
||||
return st('SQLite');
|
||||
}
|
||||
|
||||
/**
|
||||
* Minimum engine version.
|
||||
*
|
||||
* @todo: consider upping to 3.6.8 in Drupal 8 to get SAVEPOINT support.
|
||||
*/
|
||||
public function minimumVersion() {
|
||||
return '3.3.7';
|
||||
}
|
||||
|
||||
public function getFormOptions($database) {
|
||||
$form = parent::getFormOptions($database);
|
||||
|
||||
// Remove the options that only apply to client/server style databases.
|
||||
unset($form['username'], $form['password'], $form['advanced_options']['host'], $form['advanced_options']['port']);
|
||||
|
||||
// Make the text more accurate for SQLite.
|
||||
$form['database']['#title'] = st('Database file');
|
||||
$form['database']['#description'] = st('The absolute path to the file where @drupal data will be stored. This must be writable by the web server and should exist outside of the web root.', array('@drupal' => drupal_install_profile_distribution_name()));
|
||||
$default_database = conf_path(FALSE, TRUE) . '/files/.ht.sqlite';
|
||||
$form['database']['#default_value'] = empty($database['database']) ? $default_database : $database['database'];
|
||||
return $form;
|
||||
}
|
||||
|
||||
public function validateDatabaseSettings($database) {
|
||||
// Perform standard validation.
|
||||
$errors = parent::validateDatabaseSettings($database);
|
||||
|
||||
// Verify the database is writable.
|
||||
$db_directory = new SplFileInfo(dirname($database['database']));
|
||||
if (!$db_directory->isWritable()) {
|
||||
$errors[$database['driver'] . '][database'] = st('The directory you specified is not writable by the web server.');
|
||||
}
|
||||
|
||||
return $errors;
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\Database\Install;
|
||||
|
||||
use RuntimeException;
|
||||
|
||||
/**
|
||||
* Exception thrown if the database installer fails.
|
||||
*/
|
||||
class TaskException extends RuntimeException { }
|
||||
|
|
@ -0,0 +1,300 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\Database\Install;
|
||||
|
||||
use Drupal\Database\Database;
|
||||
|
||||
use PDO;
|
||||
|
||||
/**
|
||||
* Database installer structure.
|
||||
*
|
||||
* Defines basic Drupal requirements for databases.
|
||||
*/
|
||||
abstract class Tasks {
|
||||
|
||||
/**
|
||||
* Structure that describes each task to run.
|
||||
*
|
||||
* @var array
|
||||
*
|
||||
* Each value of the tasks array is an associative array defining the function
|
||||
* to call (optional) and any arguments to be passed to the function.
|
||||
*/
|
||||
protected $tasks = array(
|
||||
array(
|
||||
'function' => 'checkEngineVersion',
|
||||
'arguments' => array(),
|
||||
),
|
||||
array(
|
||||
'arguments' => array(
|
||||
'CREATE TABLE {drupal_install_test} (id int NULL)',
|
||||
'Drupal can use CREATE TABLE database commands.',
|
||||
'Failed to <strong>CREATE</strong> a test table on your database server with the command %query. The server reports the following message: %error.<p>Are you sure the configured username has the necessary permissions to create tables in the database?</p>',
|
||||
TRUE,
|
||||
),
|
||||
),
|
||||
array(
|
||||
'arguments' => array(
|
||||
'INSERT INTO {drupal_install_test} (id) VALUES (1)',
|
||||
'Drupal can use INSERT database commands.',
|
||||
'Failed to <strong>INSERT</strong> a value into a test table on your database server. We tried inserting a value with the command %query and the server reported the following error: %error.',
|
||||
),
|
||||
),
|
||||
array(
|
||||
'arguments' => array(
|
||||
'UPDATE {drupal_install_test} SET id = 2',
|
||||
'Drupal can use UPDATE database commands.',
|
||||
'Failed to <strong>UPDATE</strong> a value in a test table on your database server. We tried updating a value with the command %query and the server reported the following error: %error.',
|
||||
),
|
||||
),
|
||||
array(
|
||||
'arguments' => array(
|
||||
'DELETE FROM {drupal_install_test}',
|
||||
'Drupal can use DELETE database commands.',
|
||||
'Failed to <strong>DELETE</strong> a value from a test table on your database server. We tried deleting a value with the command %query and the server reported the following error: %error.',
|
||||
),
|
||||
),
|
||||
array(
|
||||
'arguments' => array(
|
||||
'DROP TABLE {drupal_install_test}',
|
||||
'Drupal can use DROP TABLE database commands.',
|
||||
'Failed to <strong>DROP</strong> a test table from your database server. We tried dropping a table with the command %query and the server reported the following error %error.',
|
||||
),
|
||||
),
|
||||
);
|
||||
|
||||
/**
|
||||
* Results from tasks.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $results = array();
|
||||
|
||||
/**
|
||||
* Ensure the PDO driver is supported by the version of PHP in use.
|
||||
*/
|
||||
protected function hasPdoDriver() {
|
||||
return in_array($this->pdoDriver, PDO::getAvailableDrivers());
|
||||
}
|
||||
|
||||
/**
|
||||
* Assert test as failed.
|
||||
*/
|
||||
protected function fail($message) {
|
||||
$this->results[$message] = FALSE;
|
||||
}
|
||||
|
||||
/**
|
||||
* Assert test as a pass.
|
||||
*/
|
||||
protected function pass($message) {
|
||||
$this->results[$message] = TRUE;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check whether Drupal is installable on the database.
|
||||
*/
|
||||
public function installable() {
|
||||
return $this->hasPdoDriver() && empty($this->error);
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the human-readable name of the driver.
|
||||
*/
|
||||
abstract public function name();
|
||||
|
||||
/**
|
||||
* Return the minimum required version of the engine.
|
||||
*
|
||||
* @return
|
||||
* A version string. If not NULL, it will be checked against the version
|
||||
* reported by the Database engine using version_compare().
|
||||
*/
|
||||
public function minimumVersion() {
|
||||
return NULL;
|
||||
}
|
||||
|
||||
/**
|
||||
* Run database tasks and tests to see if Drupal can run on the database.
|
||||
*/
|
||||
public function runTasks() {
|
||||
// We need to establish a connection before we can run tests.
|
||||
if ($this->connect()) {
|
||||
foreach ($this->tasks as $task) {
|
||||
if (!isset($task['function'])) {
|
||||
$task['function'] = 'runTestQuery';
|
||||
}
|
||||
if (method_exists($this, $task['function'])) {
|
||||
// Returning false is fatal. No other tasks can run.
|
||||
if (FALSE === call_user_func_array(array($this, $task['function']), $task['arguments'])) {
|
||||
break;
|
||||
}
|
||||
}
|
||||
else {
|
||||
throw new TaskException(st("Failed to run all tasks against the database server. The task %task wasn't found.", array('%task' => $task['function'])));
|
||||
}
|
||||
}
|
||||
}
|
||||
// Check for failed results and compile message
|
||||
$message = '';
|
||||
foreach ($this->results as $result => $success) {
|
||||
if (!$success) {
|
||||
$message .= '<p class="error">' . $result . '</p>';
|
||||
}
|
||||
}
|
||||
if (!empty($message)) {
|
||||
$message = '<p>In order for Drupal to work, and to continue with the installation process, you must resolve all issues reported below. For more help with configuring your database server, see the <a href="http://drupal.org/getting-started/install">installation handbook</a>. If you are unsure what any of this means you should probably contact your hosting provider.</p>' . $message;
|
||||
throw new TaskException($message);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if we can connect to the database.
|
||||
*/
|
||||
protected function connect() {
|
||||
try {
|
||||
// This doesn't actually test the connection.
|
||||
db_set_active();
|
||||
// Now actually do a check.
|
||||
Database::getConnection();
|
||||
$this->pass('Drupal can CONNECT to the database ok.');
|
||||
}
|
||||
catch (Exception $e) {
|
||||
$this->fail(st('Failed to connect to your database server. The server reports the following message: %error.<ul><li>Is the database server running?</li><li>Does the database exist, and have you entered the correct database name?</li><li>Have you entered the correct username and password?</li><li>Have you entered the correct database hostname?</li></ul>', array('%error' => $e->getMessage())));
|
||||
return FALSE;
|
||||
}
|
||||
return TRUE;
|
||||
}
|
||||
|
||||
/**
|
||||
* Run SQL tests to ensure the database can execute commands with the current user.
|
||||
*/
|
||||
protected function runTestQuery($query, $pass, $fail, $fatal = FALSE) {
|
||||
try {
|
||||
db_query($query);
|
||||
$this->pass(st($pass));
|
||||
}
|
||||
catch (Exception $e) {
|
||||
$this->fail(st($fail, array('%query' => $query, '%error' => $e->getMessage(), '%name' => $this->name())));
|
||||
return !$fatal;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Check the engine version.
|
||||
*/
|
||||
protected function checkEngineVersion() {
|
||||
if ($this->minimumVersion() && version_compare(Database::getConnection()->version(), $this->minimumVersion(), '<')) {
|
||||
$this->fail(st("The database version %version is less than the minimum required version %minimum_version.", array('%version' => Database::getConnection()->version(), '%minimum_version' => $this->minimumVersion())));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Return driver specific configuration options.
|
||||
*
|
||||
* @param $database
|
||||
* An array of driver specific configuration options.
|
||||
*
|
||||
* @return
|
||||
* The options form array.
|
||||
*/
|
||||
public function getFormOptions($database) {
|
||||
$form['database'] = array(
|
||||
'#type' => 'textfield',
|
||||
'#title' => st('Database name'),
|
||||
'#default_value' => empty($database['database']) ? '' : $database['database'],
|
||||
'#size' => 45,
|
||||
'#required' => TRUE,
|
||||
'#description' => st('The name of the database your @drupal data will be stored in. It must exist on your server before @drupal can be installed.', array('@drupal' => drupal_install_profile_distribution_name())),
|
||||
);
|
||||
|
||||
$form['username'] = array(
|
||||
'#type' => 'textfield',
|
||||
'#title' => st('Database username'),
|
||||
'#default_value' => empty($database['username']) ? '' : $database['username'],
|
||||
'#required' => TRUE,
|
||||
'#size' => 45,
|
||||
);
|
||||
|
||||
$form['password'] = array(
|
||||
'#type' => 'password',
|
||||
'#title' => st('Database password'),
|
||||
'#default_value' => empty($database['password']) ? '' : $database['password'],
|
||||
'#required' => FALSE,
|
||||
'#size' => 45,
|
||||
);
|
||||
|
||||
$form['advanced_options'] = array(
|
||||
'#type' => 'fieldset',
|
||||
'#title' => st('Advanced options'),
|
||||
'#collapsible' => TRUE,
|
||||
'#collapsed' => TRUE,
|
||||
'#description' => st("These options are only necessary for some sites. If you're not sure what you should enter here, leave the default settings or check with your hosting provider."),
|
||||
'#weight' => 10,
|
||||
);
|
||||
|
||||
$profile = drupal_get_profile();
|
||||
$db_prefix = ($profile == 'standard') ? 'drupal_' : $profile . '_';
|
||||
$form['advanced_options']['db_prefix'] = array(
|
||||
'#type' => 'textfield',
|
||||
'#title' => st('Table prefix'),
|
||||
'#default_value' => '',
|
||||
'#size' => 45,
|
||||
'#description' => st('If more than one application will be sharing this database, enter a table prefix such as %prefix for your @drupal site here.', array('@drupal' => drupal_install_profile_distribution_name(), '%prefix' => $db_prefix)),
|
||||
'#weight' => 10,
|
||||
);
|
||||
|
||||
$form['advanced_options']['host'] = array(
|
||||
'#type' => 'textfield',
|
||||
'#title' => st('Database host'),
|
||||
'#default_value' => empty($database['host']) ? 'localhost' : $database['host'],
|
||||
'#size' => 45,
|
||||
// Hostnames can be 255 characters long.
|
||||
'#maxlength' => 255,
|
||||
'#required' => TRUE,
|
||||
'#description' => st('If your database is located on a different server, change this.'),
|
||||
);
|
||||
|
||||
$form['advanced_options']['port'] = array(
|
||||
'#type' => 'textfield',
|
||||
'#title' => st('Database port'),
|
||||
'#default_value' => empty($database['port']) ? '' : $database['port'],
|
||||
'#size' => 45,
|
||||
// The maximum port number is 65536, 5 digits.
|
||||
'#maxlength' => 5,
|
||||
'#description' => st('If your database server is listening to a non-standard port, enter its number.'),
|
||||
);
|
||||
|
||||
return $form;
|
||||
}
|
||||
|
||||
/**
|
||||
* Validates driver specific configuration settings.
|
||||
*
|
||||
* Checks to ensure correct basic database settings and that a proper
|
||||
* connection to the database can be established.
|
||||
*
|
||||
* @param $database
|
||||
* An array of driver specific configuration options.
|
||||
*
|
||||
* @return
|
||||
* An array of driver configuration errors, keyed by form element name.
|
||||
*/
|
||||
public function validateDatabaseSettings($database) {
|
||||
$errors = array();
|
||||
|
||||
// Verify the table prefix.
|
||||
if (!empty($database['prefix']) && is_string($database['prefix']) && !preg_match('/^[A-Za-z0-9_.]+$/', $database['prefix'])) {
|
||||
$errors[$database['driver'] . '][advanced_options][db_prefix'] = st('The database table prefix you have entered, %prefix, is invalid. The table prefix can only contain alphanumeric characters, periods, or underscores.', array('%prefix' => $database['prefix']));
|
||||
}
|
||||
|
||||
// Verify the database port.
|
||||
if (!empty($database['port']) && !is_numeric($database['port'])) {
|
||||
$errors[$database['driver'] . '][advanced_options][port'] = st('Database port must be a number.');
|
||||
}
|
||||
|
||||
return $errors;
|
||||
}
|
||||
|
||||
}
|
||||
Loading…
Reference in New Issue