class Tasks in Drupal driver for SQL Server and SQL Azure 8.2
Same name and namespace in other branches
- 8 drivers/lib/Drupal/Driver/Database/sqlsrv/Install/Tasks.php \Drupal\Driver\Database\sqlsrv\Install\Tasks
- 3.0.x drivers/lib/Drupal/Driver/Database/sqlsrv/Install/Tasks.php \Drupal\Driver\Database\sqlsrv\Install\Tasks
Specifies installation tasks for PostgreSQL databases.
Hierarchy
Expanded class hierarchy of Tasks
1 file declares its use of Tasks
- sqlsrv.install in ./
sqlsrv.install - Installation file for sqlsrv module.
File
- drivers/
lib/ Drupal/ Driver/ Database/ sqlsrv/ Install/ Tasks.php, line 20 - Definition of Drupal\Driver\Database\sqlsrv\Tasks
Namespace
Drupal\Driver\Database\sqlsrv\InstallView source
class Tasks extends InstallTasks {
/**
* {@inheritdoc}
*/
protected $pdoDriver = 'sqlsrv';
/**
* Constructs a \Drupal\Core\Database\Driver\pgsql\Install\Tasks object.
*/
public function __construct() {
$this->tasks[] = array(
'function' => 'checkEncoding',
'arguments' => [],
);
$this->tasks[] = array(
'function' => 'checkRequirements',
'arguments' => [],
);
$this->tasks[] = array(
'function' => 'initializeDatabase',
'arguments' => [],
);
}
/**
* {@inheritdoc}
*/
public function name() {
return t('SQLServer');
}
/**
* {@inheritdoc}
*/
public function minimumVersion() {
return '8.3';
}
/**
* {@inheritdoc}
*/
protected function connect() {
try {
// This doesn't actually test the connection.
Database::setActiveConnection();
// Now actually do a check.
Database::getConnection();
$this
->pass('Drupal can CONNECT to the database ok.');
} catch (\Exception $e) {
// Attempt to create the database if it is not found.
if ($e
->getCode() == Connection::DATABASE_NOT_FOUND) {
// Remove the database string from connection info.
$connection_info = Database::getConnectionInfo();
$database = $connection_info['default']['database'];
unset($connection_info['default']['database']);
// In order to change the Database::$databaseInfo array, need to remove
// the active connection, then re-add it with the new info.
Database::removeConnection('default');
Database::addConnectionInfo('default', 'default', $connection_info['default']);
try {
// Now, attempt the connection again; if it's successful, attempt to
// create the database.
Database::getConnection()
->createDatabase($database);
Database::closeConnection();
// Now, restore the database config.
Database::removeConnection('default');
$connection_info['default']['database'] = $database;
Database::addConnectionInfo('default', 'default', $connection_info['default']);
// Check the database connection.
Database::getConnection();
$this
->pass('Drupal can CONNECT to the database ok.');
} catch (DatabaseNotFoundException $e) {
// Still no dice; probably a permission issue. Raise the error to the
// installer.
$this
->fail(t('Database %database not found. The server reports the following message when attempting to create the database: %error.', array(
'%database' => $database,
'%error' => $e
->getMessage(),
)));
return false;
} catch (\PDOException $e) {
// Still no dice; probably a permission issue. Raise the error to the
// installer.
$this
->fail(t('Database %database not found. The server reports the following message when attempting to create the database: %error.', array(
'%database' => $database,
'%error' => $e
->getMessage(),
)));
return false;
}
}
else {
// Database connection failed for some other reason than the database
// not existing.
$this
->fail(t('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;
}
/**
* Check encoding is UTF8.
*/
protected function checkEncoding() {
try {
/** @var \Drupal\Driver\Database\sqlsrv\Connection */
$connection = Database::getConnection();
$collation = $connection
->Scheme()
->getCollation($connection
->getDatabaseName(), $connection
->schema()->defaultSchema);
if ($collation == Schema::DEFAULT_COLLATION_CI || stristr($collation, '_CI') !== false) {
$this
->pass(t('Database is encoded in case insensitive collation: $collation'));
}
else {
$this
->fail(t('The %driver database must use case insensitive encoding (recomended %encoding) to work with Drupal. Recreate the database with %encoding encoding. See !link for more details.', array(
'%encoding' => Schema::DEFAULT_COLLATION_CI,
'%driver' => $this
->name(),
'!link' => '<a href="INSTALL.sqlsrv.txt">INSTALL.sqlsrv.txt</a>',
)));
}
} catch (\Exception $e) {
$this
->fail(t('Drupal could not determine the encoding of the database was set to UTF-8'));
}
}
/**
* Check for general requirements
*/
protected function checkRequirements() {
try {
$errors = static::InstallRequirements();
// TODO: Find a better way to print this information...
if (!empty($errors)) {
foreach ($errors as $error) {
if ($error['severity'] == REQUIREMENT_ERROR || $error['severity'] == REQUIREMENT_WARNING) {
$this
->fail($error['description']);
}
}
}
} catch (\Exception $e) {
$this
->fail(t('Could not check requirements:') . $e
->getMessage());
}
}
/**
* Make SQLServer Drupal friendly.
*/
public 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 {
/** @var \Drupal\Driver\Database\sqlsrv\Connection $database */
$connection = Database::getConnection();
Utils::DeployCustomFunctions($connection
->getConnection(), dirname(__FILE__) . '/../Programability');
$this
->pass(t('SQLServer has initialized itself.'));
// Ensure we clear the schema cache
$connection
->getConnection()
->Cache('sqlsrv_meta')
->Clear(null);
$connection
->getConnection()
->Cache('sqlsrv-table-exists')
->Clear(null);
$connection
->getConnection()
->Cache('sqlsrv-tabledetails')
->Clear(null);
} catch (\Exception $e) {
$this
->fail(t('Drupal could not be correctly setup with the existing database. Revise any errors.'));
}
}
/**
* Enable the SQL Server module.
*/
public function enableModule() {
/** @var \Drupal\Core\Extension\ModuleInstallerInterface */
$installer = \Drupal::service('module_installer');
$installer
->install(array(
'sqlsrv',
));
}
/**
* Return the install requirements for both the status
* page and the install process.
*/
public static function InstallRequirements() {
// Array of requirement errors.
$errors = [];
#region check for MS SQL PDO version and client buffer size
$sqlsrv_extension_data = Utils::ExtensionData('pdo_sqlsrv');
// Version.
$version_ok = version_compare($sqlsrv_extension_data
->Version(), '3.2') >= 0;
$requirements['sqlsrv_pdo'] = array(
'title' => t('MSSQL Server PDO extension'),
'severity' => $version_ok ? REQUIREMENT_OK : REQUIREMENT_ERROR,
'value' => t('@level', array(
'@level' => $sqlsrv_extension_data
->Version(),
)),
'description' => t('Use at least the 3.2.0.0 version of the MSSQL PDO driver.'),
);
// Client buffer size.
$buffer_size = $sqlsrv_extension_data
->IniEntries()['pdo_sqlsrv.client_buffer_max_kb_size'];
$buffer_size_min = 12240 * 2;
$buffer_size_ok = $buffer_size >= $buffer_size_min;
$errors['sqlsrv_client_buffer_size'] = array(
'title' => t('MSSQL Server client buffer size'),
'severity' => $buffer_size_ok ? REQUIREMENT_OK : REQUIREMENT_WARNING,
'value' => "{$buffer_size} Kb",
'description' => "pdo_sqlsrv.client_buffer_max_kb_size setting must be of at least {$buffer_size_min}Kb. Currently {$buffer_size}Kb.",
);
return $errors;
}
/**
* {@inheritdoc}
*/
public function getFormOptions(array $database) {
$form = parent::getFormOptions($database);
if (empty($form['advanced_options']['port']['#default_value'])) {
$form['advanced_options']['port']['#default_value'] = '1433';
}
// Make username not required.
$form['username']['#required'] = false;
// Add a description for about leaving username blank.
$form['username']['#description'] = t('Leave username (and password) blank to use Windows authentication.');
$form['#submit'] = [];
return $form;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Tasks:: |
protected | property |
The name of the PDO driver this database type requires. Overrides Tasks:: |
|
Tasks:: |
protected | property | Results from tasks. | |
Tasks:: |
protected | property | Structure that describes each task to run. | |
Tasks:: |
protected | function | Check encoding is UTF8. | |
Tasks:: |
protected | function | Check the engine version. | 1 |
Tasks:: |
protected | function | Check for general requirements | |
Tasks:: |
protected | function |
Check if we can connect to the database. Overrides Tasks:: |
|
Tasks:: |
public | function | Enable the SQL Server module. | |
Tasks:: |
final public | function | Checks engine version requirements for the status report. | |
Tasks:: |
protected | function | Assert test as failed. | |
Tasks:: |
public | function |
Return driver specific configuration options. Overrides Tasks:: |
|
Tasks:: |
protected | function | Ensure the PDO driver is supported by the version of PHP in use. | |
Tasks:: |
public | function | Make SQLServer Drupal friendly. | |
Tasks:: |
public | function | Check whether Drupal is installable on the database. | |
Tasks:: |
public static | function | Return the install requirements for both the status page and the install process. | |
Tasks:: |
public | function |
Return the minimum required version of the engine. Overrides Tasks:: |
|
Tasks:: |
public | function |
Return the human-readable name of the driver. Overrides Tasks:: |
|
Tasks:: |
protected | function | Assert test as a pass. | |
Tasks:: |
public | function | Run database tasks and tests to see if Drupal can run on the database. | |
Tasks:: |
protected | function | Run SQL tests to ensure the database can execute commands with the current user. | |
Tasks:: |
public | function | Validates driver specific configuration settings. | |
Tasks:: |
public | function | Constructs a \Drupal\Core\Database\Driver\pgsql\Install\Tasks object. |