install_from_db.profile in Open Atrium 7.2
Install profile helper to add option for importing from database.
File
install_from_db/install_from_db.profileView source
<?php
/**
* @file
* Install profile helper to add option for importing from database.
*/
/**
* CALL THIS from your profile_install_tasks_alter() hook function.
*/
function install_from_db_install_tasks_alter(&$tasks, $install_state) {
// Prevent cron from running when finished.
$tasks['install_finished']['function'] = 'install_from_db_install_finished';
// Redirect the drupal install_profile_modules step to our own function.
$tasks['install_profile_modules']['function'] = 'install_from_db_install_profile_modules';
// Add the new quickstart step to the installer.
$quickstart = array(
'display_name' => st('Choose installation method'),
'type' => 'form',
'run' => INSTALL_TASK_RUN_IF_NOT_COMPLETED,
);
$tasks = _install_from_db_insert_before_key($tasks, 'install_profile_modules', 'install_from_db_form', $quickstart);
}
/**
* Helper function to insert a key/value pair before an existing key used to re-order the install tasks array.
*/
function _install_from_db_insert_before_key($originalArray, $originalKey, $insertKey, $insertValue) {
$newArray = array();
$inserted = FALSE;
foreach ($originalArray as $key => $value) {
if (!$inserted && $key === $originalKey) {
$newArray[$insertKey] = $insertValue;
$inserted = TRUE;
}
$newArray[$key] = $value;
}
return $newArray;
}
/**
* Prompt user to select normal or quick installation method
* TODO: Check db to be sure it is mysql, or provide mechanism for using dumps of other database types.
*
* @see install_from_db_form_validate()
* @see install_from_db_form_submit()
*/
function install_from_db_form($form, &$form_state, &$install_state) {
$profile = $install_state['parameters']['profile'];
// Find database dump in the /db folder within the profile
// TODO: support different database dump formats.
$filename = DRUPAL_ROOT . '/profiles/' . $profile . '/db/' . $profile . '.mysql';
$conn = Database::getConnection('default');
if (!file_exists($filename) || !$conn || $conn
->driver() !== 'mysql') {
// can't do quickstart if no db dump exists
// also only allow quickstart for mysql databases currently.
unset($install_state['parameters']['quickstart']);
$form_state['executed'] = TRUE;
return;
}
$install_state['parameters']['db_import_filename'] = $filename;
if ($install_state['interactive'] && !empty($install_state['parameters']['quickstart'])) {
// If url argument is already specified, then just use it.
$form_state['input']['quickstart'] = $install_state['parameters']['quickstart'];
$form_state['executed'] = TRUE;
return;
}
if (!$install_state['interactive'] && !isset($form_state['values']['quickstart'])) {
// Default non-interactive to quickstart.
$install_state['parameters']['quickstart'] = 'quick';
$form_state['input']['quickstart'] = 'quick';
}
$form['quickstart']['quick'] = array(
'#type' => 'radio',
'#value' => 'quick',
'#return_value' => 'quick',
'#title' => st('Quick installation'),
'#description' => st('Quickly install using a predefined database dump. (recommended)'),
'#parents' => array(
'quickstart',
),
);
$form['quickstart']['standard'] = array(
'#type' => 'radio',
'#value' => 'quick',
'#return_value' => 'standard',
'#title' => st('Standard installation'),
'#description' => st('Install using the full Drupal process. This is slower.'),
'#parents' => array(
'quickstart',
),
);
$form['actions'] = array(
'#type' => 'actions',
);
$form['actions']['submit'] = array(
'#type' => 'submit',
'#value' => st('Save and continue'),
);
return $form;
}
/**
* Form validation handler for install_from_db_form().
*
* @see install_from_db_form_submit()
*/
function install_from_db_form_validate($form, &$form_state) {
}
/**
* Form submission handler for install_from_db_form().
*
* @see install_from_db_form_validate()
*/
function install_from_db_form_submit($form, &$form_state) {
global $install_state;
$install_state['parameters']['quickstart'] = $form_state['input']['quickstart'];
}
/**
* Overrides install_profile_modules(). For quick install, load database from sql dump otherwise install normally.
*/
function install_from_db_install_profile_modules(&$install_state) {
if (!empty($install_state['parameters']['quickstart']) && $install_state['parameters']['quickstart'] === 'quick' && !empty($install_state['parameters']['db_import_filename'])) {
if (!$install_state['interactive']) {
watchdog('install', 'Installing from database import.', array(), WATCHDOG_INFO);
print "Installing from database\n";
}
// Bypass normal module installation
// load database dump instead
// uses batch because normal module install task uses batch
// and it's also good for this potentially time consuming db restore.
$operations = array();
$defer_operations = array();
$system_sql = '';
$filename = $install_state['parameters']['db_import_filename'];
if (file_exists($filename)) {
$file = fopen($filename, 'rb');
if ($file) {
while (($line = _install_from_db_read_sql_batch($file, $table)) !== FALSE) {
if (!empty($line)) {
// don't process blank lines.
if (in_array($table, array(
'system',
))) {
$defer_operations[] = array(
'_install_from_db_install_db_import',
array(
$line,
$table,
),
);
}
else {
$operations[] = array(
'_install_from_db_install_db_import',
array(
$line,
$table,
),
);
}
}
}
}
fclose($file);
$operations = array_merge($operations, $defer_operations);
}
$batch = array(
'operations' => $operations,
'title' => st('Importing site database'),
'error_message' => st('The database import has encountered an error.'),
'finished' => '_install_from_db_install_db_import_finished',
);
return $batch;
}
if (!$install_state['interactive']) {
watchdog('install', 'Performing standard Drupal install.', array(), WATCHDOG_INFO);
print "Standard Drupal install\n";
}
return install_profile_modules($install_state);
}
/**
* Finished callback for module installation batch.
*/
function _install_from_db_install_db_import_finished($success, $results, $operations) {
_install_from_db_cc_all();
// Remove any field data added to user entity
// since we did not import any users.
$fields_info = field_info_instances('user', 'user');
foreach ($fields_info as $field_name => $info) {
db_delete('field_data_' . $field_name)
->condition('entity_type', 'user')
->condition('bundle', 'user')
->execute();
db_delete('field_revision_' . $field_name)
->condition('entity_type', 'user')
->condition('bundle', 'user')
->execute();
}
}
/**
* Aggressively clear the cache so new database will take affect. Do this right after importing the new system module as the last step.
*/
function _install_from_db_cc_all() {
// Load the module files as if we just installed them.
cache_clear_all('lookup_cache', 'cache_bootstrap');
cache_clear_all('variables', 'cache_bootstrap');
cache_clear_all('module_implements', 'cache_bootstrap');
registry_rebuild();
$module_list = module_list(TRUE);
foreach ($module_list as $module) {
drupal_load('module', $module);
}
drupal_static_reset();
drupal_flush_all_caches();
}
/**
* Batch callback for batch database import.
*/
function _install_from_db_install_db_import($lines, $table, &$context) {
global $conf;
if ($table === 'variable') {
// save/restore some variables needed by installer or unique to new site.
$saved_vars = array(
'install_task',
'install_current_batch',
'cron_key',
'drupal_private_key',
);
foreach ($saved_vars as $var) {
$value = variable_get($var);
if (isset($value)) {
$saved_values[$var] = $value;
}
}
}
// Do NOT use db_query here as it will mess with the query data, such as the {} in
// serialized data fields.
$conn = Database::getConnection('default');
foreach ($lines as $line) {
$stmt = $conn
->prepare($line);
$stmt
->execute();
$stmt
->closeCursor();
}
if ($table === 'variable') {
// Restore saved variables.
foreach ($saved_values as $key => $value) {
variable_set($key, $value);
}
}
}
/**
* Read a batch of sql commands (ending in commit)
*
* @param string $file
* Name of file to read from.
* @param string $table
* Name of table referenced in sql statements is returned.
*
* @return array
* An array of strings containing sql commands for a single table.
*/
function _install_from_db_read_sql_batch($file, &$table) {
$conn = Database::getConnection('default');
$line = array();
$table = '';
$skip = FALSE;
$skip_tables = array(
'batch',
'cache',
'sessions',
'queue',
'semaphore',
'users',
'advagg_aggregates',
'advagg_aggregates_hashes',
'advagg_aggregates_versions',
'advagg_files',
);
while (($newline = _install_from_db_read_sql_command_from_file($file)) !== FALSE) {
// Process the line read.
$newline_prefix = _install_from_db_replace_prefix($newline, $conn);
// Block of SQL starts with a Table structure comment.
if (preg_match('/Table structure for table `([^`]+)`/', $newline, $matches)) {
$new_table = $matches[1];
if (!empty($table) && $new_table !== $table) {
// Close out the previous table
// put this line back into the read buffer for the next time.
_install_from_db_read_sql_command_from_file($file, $newline);
break;
}
$table = $new_table;
if (!$skip) {
if (in_array($table, $skip_tables) || strpos($table, 'cache_') === 0) {
// Skip listed tables, along with any cache_* table.
$skip = TRUE;
}
}
}
if (preg_match('/\\A(CREATE TABLE )`([^`]+)`/', $newline, $matches)) {
// Always check first before creating tables.
$newline_prefix = preg_replace('/\\ACREATE TABLE/', 'CREATE TABLE IF NOT EXISTS', $newline_prefix);
if ($skip) {
// Make sure skipped tables are still created.
$line[] = $newline_prefix;
}
}
if (!empty($newline) && substr($newline, 0, 2) == '--') {
// Otherwise skip comments.
$newline_prefix = '';
}
if (!$skip && !empty($newline_prefix)) {
$line[] = $newline_prefix;
}
// Block of SQL ends with a commit command.
if ($newline === 'commit;') {
// Be sure to turn autocommit back on for Drupal batch system and other database
// queries to work properly.
$line[] = 'set autocommit=1;';
}
}
if (empty($line) && $newline === FALSE) {
return FALSE;
}
return $line;
}
/**
* Read a multiline sql command from a file.
*
* Supports the formatting created by mysqldump, but won't handle multiline comments.
* Taken from backup_migrate module.
*/
function _install_from_db_read_sql_command_from_file($file, $save_line = '') {
static $save_for_later = '';
if (!empty($save_for_later)) {
// Check if a previous line was saved.
$out = $save_for_later;
$save_for_later = '';
return trim($out);
}
if (!empty($save_line)) {
// Save this text for the next time we read from file
// used to stuff the previous line back into the read buffer.
$save_for_later = $save_line;
return;
}
$out = '';
while (($line = fgets($file)) !== FALSE) {
$line = trim($line);
if (empty($out) && !empty($line) && substr($line, 0, 2) == '--') {
// Return single line comments so we can parse what table this was later.
return trim($line);
}
$first2 = substr($line, 0, 2);
$first3 = substr($line, 0, 3);
// If a line begins with /*! it is a commented inline sql command
// only execute lines that don't reference @variables
if (empty($out) && $first3 == '/*!' && strpos($line, '= @') === FALSE && strpos($line, '=@') === FALSE) {
return trim($line);
}
// Otherwise, ignore single line comments within a sql statement.
if (!empty($line) && $first2 != '--' && $first2 != '/*') {
$out .= ' ' . $line;
// If a line ends in ; it is a sql command.
if (substr($out, strlen($out) - 1, 1) == ';') {
return trim($out);
}
}
}
if (empty($out) && $line === FALSE) {
return FALSE;
}
return trim($out);
}
/**
* Apply the correct prefix to tables in the SQL statement.
*/
function _install_from_db_replace_prefix($line, $conn) {
$patterns = array(
'DROP TABLE IF EXISTS',
'CREATE TABLE',
'LOCK TABLES',
'ALTER TABLE',
'INSERT INTO',
'UPDATE',
);
foreach ($patterns as $pattern) {
// Handle lines like this: /*!40000 ALTER TABLE `actions` ENABLE KEYS */;.
$find = '#\\A((/\\*\\!\\d+ )?' . $pattern . ' )`([^`]+)`#';
// NOTE: We need to replace `tablename` with the new prefixed table name
// We cannot run $conn->prefixQuery on the entire $line because it will mess
// with the {} characters within serialized data.
// So we ONLY match and replace the table name here.
if (preg_match($find, $line, $matches)) {
$new_table = $conn
->prefixTables('{' . $matches[3] . '}');
$replace = '$1`' . $new_table . '`';
$line = preg_replace($find, $replace, $line);
}
}
return $line;
}
/**
* Finishes importing files at end of installation.
* COPIED from install.core.inc but no longer calls drupal_run_cron
* since we just installed the correct module versions for the distro
* that we desire.
*
* @param array $install_state
* An array of information about the current installation state.
*
* @return string
* A message informing the user that the installation is complete.
*/
function install_from_db_install_finished(array &$install_state) {
drupal_set_title(st('@drupal installation complete', array(
'@drupal' => drupal_install_profile_distribution_name(),
)), PASS_THROUGH);
$messages = drupal_set_message();
$output = '<p>' . st('Congratulations, you installed @drupal!', array(
'@drupal' => drupal_install_profile_distribution_name(),
)) . '</p>';
$output .= '<p>' . (isset($messages['error']) ? st('Review the messages above before visiting <a href="@url">your new site</a>.', array(
'@url' => url(''),
)) : st('<a href="@url">Visit your new site</a>.', array(
'@url' => url(''),
))) . '</p>';
// Flush all caches to ensure that any full bootstraps during the installer
// do not leave stale cached data, and that any content types or other items
// registered by the installation profile are registered correctly.
drupal_flush_all_caches();
// Remember the profile which was used.
variable_set('install_profile', drupal_get_profile());
// Installation profiles are always loaded last.
db_update('system')
->fields(array(
'weight' => 1000,
))
->condition('type', 'module')
->condition('name', drupal_get_profile())
->execute();
// Cache a fully-built schema.
drupal_get_schema(NULL, TRUE);
// Run cron to populate update status tables (if available) so that users
// will be warned if they've installed an out of date Drupal version.
// Will also trigger indexing of profile-supplied content or feeds.
//
// NO! Don't do this after installing profile from DB since we have the
// module versions we want and the Update module is potentially enabled
//
// drupal_cron_run();
//
// Mark cron as run so it doesn't run on next page load either.
variable_set('cron_last', REQUEST_TIME);
return $output;
}Functions
Name |
Description |
|---|---|
| install_from_db_form | Prompt user to select normal or quick installation method TODO: Check db to be sure it is mysql, or provide mechanism for using dumps of other database types. |
| install_from_db_form_submit | Form submission handler for install_from_db_form(). |
| install_from_db_form_validate | Form validation handler for install_from_db_form(). |
| install_from_db_install_finished | Finishes importing files at end of installation. COPIED from install.core.inc but no longer calls drupal_run_cron since we just installed the correct module versions for the distro that we desire. |
| install_from_db_install_profile_modules | Overrides install_profile_modules(). For quick install, load database from sql dump otherwise install normally. |
| install_from_db_install_tasks_alter | CALL THIS from your profile_install_tasks_alter() hook function. |
| _install_from_db_cc_all | Aggressively clear the cache so new database will take affect. Do this right after importing the new system module as the last step. |
| _install_from_db_insert_before_key | Helper function to insert a key/value pair before an existing key used to re-order the install tasks array. |
| _install_from_db_install_db_import | Batch callback for batch database import. |
| _install_from_db_install_db_import_finished | Finished callback for module installation batch. |
| _install_from_db_read_sql_batch | Read a batch of sql commands (ending in commit) |
| _install_from_db_read_sql_command_from_file | Read a multiline sql command from a file. |
| _install_from_db_replace_prefix | Apply the correct prefix to tables in the SQL statement. |