Newer
Older
Dries Buytaert
committed
<?php
/**
* @file
* Drupal database update API.
*
* This file contains functions to perform database updates for a Drupal
* installation. It is included and used extensively by update.php.
*/
/**
* Minimum schema version of Drupal 6 required for upgrade to Drupal 7.
*
* Upgrades from Drupal 6 to Drupal 7 require that Drupal 6 be running
* the most recent version, or the upgrade could fail. We can't easily
* check the Drupal 6 version once the update process has begun, so instead
* we check the schema version of system.module in the system table.
*/
define('REQUIRED_D6_SCHEMA_VERSION', '6055');
Dries Buytaert
committed
/**
* Disable any items in the {system} table that are not core compatible.
Dries Buytaert
committed
*/
function update_fix_compatibility() {
$incompatible = array();
Angie Byron
committed
$result = db_query("SELECT name, type, status FROM {system} WHERE status = 1 AND type IN ('module','theme')");
foreach ($result as $row) {
if (update_check_incompatibility($row->name, $row->type)) {
$incompatible[] = $row->name;
Dries Buytaert
committed
}
}
if (!empty($incompatible)) {
db_update('system')
->fields(array('status' => 0))
->condition('name', $incompatible, 'IN')
->execute();
Dries Buytaert
committed
}
}
/**
* Helper function to test compatibility of a module or theme.
*/
function update_check_incompatibility($name, $type = 'module') {
static $themes, $modules;
// Store values of expensive functions for future use.
if (empty($themes) || empty($modules)) {
Dries Buytaert
committed
// We need to do a full rebuild here to make sure the database reflects any
// code changes that were made in the filesystem before the update script
// was initiated.
$themes = system_rebuild_theme_data();
Angie Byron
committed
$modules = system_rebuild_module_data();
Dries Buytaert
committed
}
if ($type == 'module' && isset($modules[$name])) {
$file = $modules[$name];
}
elseif ($type == 'theme' && isset($themes[$name])) {
$file = $themes[$name];
}
if (!isset($file)
|| !isset($file->info['core'])
|| $file->info['core'] != DRUPAL_CORE_COMPATIBILITY
Dries Buytaert
committed
|| version_compare(phpversion(), $file->info['php']) < 0) {
Dries Buytaert
committed
return TRUE;
}
return FALSE;
}
/**
* Performs extra steps required to bootstrap when using a Drupal 6 database.
*
Dries Buytaert
committed
* Users who still have a Drupal 6 database (and are in the process of
* updating to Drupal 7) need extra help before a full bootstrap can be
* achieved. This function does the necessary preliminary work that allows
* the bootstrap to be successful.
*
* No access check has been performed when this function is called, so no
Dries Buytaert
committed
* irreversible changes to the database are made here.
Dries Buytaert
committed
*/
function update_prepare_d7_bootstrap() {
// Allow the bootstrap to proceed even if a Drupal 6 settings.php file is
// still being used.
include_once DRUPAL_ROOT . '/includes/install.inc';
drupal_bootstrap(DRUPAL_BOOTSTRAP_CONFIGURATION);
Angie Byron
committed
global $databases, $db_url, $db_prefix, $update_rewrite_settings;
Dries Buytaert
committed
if (empty($databases) && !empty($db_url)) {
Angie Byron
committed
$databases = update_parse_db_url($db_url, $db_prefix);
Dries Buytaert
committed
// Record the fact that the settings.php file will need to be rewritten.
$update_rewrite_settings = TRUE;
$settings_file = conf_path() . '/settings.php';
$writable = drupal_verify_install_file($settings_file, FILE_EXIST|FILE_READABLE|FILE_WRITABLE);
$requirements = array(
'settings file' => array(
'title' => 'Settings file',
'value' => $writable ? 'The settings file is writable.' : 'The settings file is not writable.',
'severity' => $writable ? REQUIREMENT_OK : REQUIREMENT_ERROR,
'description' => $writable ? '' : 'Drupal requires write permissions to <em>' . $settings_file . '</em> during the update process. If you are unsure how to grant file permissions, consult the <a href="http://drupal.org/server-permissions">online handbook</a>.',
Dries Buytaert
committed
),
);
update_extra_requirements($requirements);
}
Dries Buytaert
committed
// The new {blocked_ips} table is used in Drupal 7 to store a list of
// banned IP addresses. If this table doesn't exist then we are still
// running on a Drupal 6 database, so we suppress the unavoidable errors
// that occur by creating a static list.
$GLOBALS['conf']['blocked_ips'] = array();
Dries Buytaert
committed
// Check that PDO is available and that the correct PDO database driver is
// loaded. Bootstrapping to DRUPAL_BOOTSTRAP_DATABASE will result in a fatal
// error otherwise.
$message = '';
Dries Buytaert
committed
$pdo_link = 'http://drupal.org/requirements/pdo';
Dries Buytaert
committed
// Check that PDO is loaded.
if (!extension_loaded('pdo')) {
$message = '<h2>PDO is required!</h2><p>Drupal 7 requires PHP ' . DRUPAL_MINIMUM_PHP . ' or higher with the PHP Data Objects (PDO) extension enabled.</p>';
}
Dries Buytaert
committed
// The PDO::ATTR_DEFAULT_FETCH_MODE constant is not available in the PECL
// version of PDO.
elseif (!defined('PDO::ATTR_DEFAULT_FETCH_MODE')) {
$message = '<h2>The wrong version of PDO is installed!</h2><p>Drupal 7 requires the PHP Data Objects (PDO) extension from PHP core to be enabled. This system has the older PECL version installed.';
$pdo_link = 'http://drupal.org/requirements/pdo#pecl';
}
Dries Buytaert
committed
// Check that the correct driver is loaded for the database being updated.
Angie Byron
committed
// If we have no driver information (for example, if someone tried to create
// the Drupal 7 $databases array themselves but did not do it correctly),
// this message will be confusing, so do not perform the check; instead, just
// let the database connection fail in the code that follows.
elseif (isset($databases['default']['default']['driver']) && !in_array($databases['default']['default']['driver'], PDO::getAvailableDrivers())) {
Dries Buytaert
committed
$message = '<h2>A PDO database driver is required!</h2><p>You need to enable the PDO_' . strtoupper($databases['default']['default']['driver']) . ' database driver for PHP ' . DRUPAL_MINIMUM_PHP . ' or higher so that Drupal 7 can access the database.</p>';
Dries Buytaert
committed
}
if ($message) {
Dries Buytaert
committed
print $message . '<p>See the <a href="' . $pdo_link . '">system requirements page</a> for more information.</p>';
Dries Buytaert
committed
exit();
}
Dries Buytaert
committed
// Allow the database system to work even if the registry has not been
// created yet.
drupal_bootstrap(DRUPAL_BOOTSTRAP_DATABASE);
// If the site has not updated to Drupal 7 yet, check to make sure that it is
// running an up-to-date version of Drupal 6 before proceeding. Note this has
// to happen AFTER the database bootstraps because of
// drupal_get_installed_schema_version().
Angie Byron
committed
$system_schema = drupal_get_installed_schema_version('system');
if ($system_schema < 7000) {
$has_required_schema = $system_schema >= REQUIRED_D6_SCHEMA_VERSION;
$requirements = array(
'drupal 6 version' => array(
'title' => 'Drupal 6 version',
'value' => $has_required_schema ? 'You are running a current version of Drupal 6.' : 'You are not running a current version of Drupal 6',
'severity' => $has_required_schema ? REQUIREMENT_OK : REQUIREMENT_ERROR,
'description' => $has_required_schema ? '' : 'Please update your Drupal 6 installation to the most recent version before attempting to upgrade to Drupal 7',
),
);
// Make sure that the database environment is properly set up.
try {
db_run_tasks(db_driver());
}
catch (DatabaseTaskException $e) {
$requirements['database tasks'] = array(
'title' => 'Database environment',
'value' => 'There is a problem with your database environment',
'severity' => REQUIREMENT_ERROR,
'description' => $e->getMessage(),
);
}
update_extra_requirements($requirements);
Angie Byron
committed
// Allow a D6 session to work, since the upgrade has not been performed yet.
$d6_session_name = update_get_d6_session_name();
if (!empty($_COOKIE[$d6_session_name])) {
// Set the current sid to the one found in the D6 cookie.
$sid = $_COOKIE[$d6_session_name];
$_COOKIE[session_name()] = $sid;
session_id($sid);
}
// Upgrading from D6 to D7.{0,1,2,3,4,8,...} is different than upgrading
// from D6 to D7.{5,6,7} which should be considered broken. To be able to
// properly handle this difference in node_update_7012 we need to keep track
// of whether a D6 > D7 upgrade or a D7 > D7 update is running.
// Since variable_set() is not available here, the D6 status is being saved
// in a local variable to be able to store it later.
$update_d6 = TRUE;
}
Angie Byron
committed
// Create the registry tables.
if (!db_table_exists('registry')) {
$schema['registry'] = array(
'fields' => array(
'name' => array('type' => 'varchar', 'length' => 255, 'not null' => TRUE, 'default' => ''),
'type' => array('type' => 'varchar', 'length' => 9, 'not null' => TRUE, 'default' => ''),
'filename' => array('type' => 'varchar', 'length' => 255, 'not null' => TRUE, 'default' => ''),
'module' => array('type' => 'varchar', 'length' => 255, 'not null' => TRUE, 'default' => ''),
'weight' => array('type' => 'int', 'not null' => TRUE, 'default' => 0),
),
'primary key' => array('name', 'type'),
'indexes' => array(
'hook' => array('type', 'weight', 'module'),
),
);
db_create_table('registry', $schema['registry']);
}
if (!db_table_exists('registry_file')) {
$schema['registry_file'] = array(
'fields' => array(
'filename' => array('type' => 'varchar', 'length' => 255, 'not null' => TRUE),
Dries Buytaert
committed
'hash' => array('type' => 'varchar', 'length' => 64, 'not null' => TRUE),
),
'primary key' => array('filename'),
);
db_create_table('registry_file', $schema['registry_file']);
}
// Older versions of Drupal 6 do not include the semaphore table, which is
// required to bootstrap, so we add it now so that we can bootstrap and
// provide a reasonable error message.
Angie Byron
committed
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
if (!db_table_exists('semaphore')) {
$semaphore = array(
'description' => 'Table for holding semaphores, locks, flags, etc. that cannot be stored as Drupal variables since they must not be cached.',
'fields' => array(
'name' => array(
'description' => 'Primary Key: Unique name.',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => ''
),
'value' => array(
'description' => 'A value for the semaphore.',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => ''
),
'expire' => array(
'description' => 'A Unix timestamp with microseconds indicating when the semaphore should expire.',
'type' => 'float',
'size' => 'big',
'not null' => TRUE
),
),
'indexes' => array(
'value' => array('value'),
'expire' => array('expire'),
),
'primary key' => array('name'),
);
db_create_table('semaphore', $semaphore);
}
// The new cache_bootstrap bin is required to bootstrap to
// DRUPAL_BOOTSTRAP_SESSION, so create it here rather than in
// update_fix_d7_requirements().
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
if (!db_table_exists('cache_bootstrap')) {
$cache_bootstrap = array(
'description' => 'Cache table for data required to bootstrap Drupal, may be routed to a shared memory cache.',
'fields' => array(
'cid' => array(
'description' => 'Primary Key: Unique cache ID.',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
),
'data' => array(
'description' => 'A collection of data to cache.',
'type' => 'blob',
'not null' => FALSE,
'size' => 'big',
),
'expire' => array(
'description' => 'A Unix timestamp indicating when the cache entry should expire, or 0 for never.',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
),
'created' => array(
'description' => 'A Unix timestamp indicating when the cache entry was created.',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
),
'serialized' => array(
'description' => 'A flag to indicate whether content is serialized (1) or not (0).',
'type' => 'int',
'size' => 'small',
'not null' => TRUE,
'default' => 0,
),
'indexes' => array(
'expire' => array('expire'),
'primary key' => array('cid'),
);
db_create_table('cache_bootstrap', $cache_bootstrap);
}
Dries Buytaert
committed
// Set a valid timezone for 6 -> 7 upgrade process.
drupal_bootstrap(DRUPAL_BOOTSTRAP_VARIABLES);
Angie Byron
committed
$timezone_offset = variable_get('date_default_timezone', 0);
if (is_numeric($timezone_offset)) {
// Save the original offset.
variable_set('date_temporary_timezone', $timezone_offset);
// Set the timezone for this request only.
Dries Buytaert
committed
$GLOBALS['conf']['date_default_timezone'] = 'UTC';
}
// This allows update functions to tell if an upgrade from D6 is running.
if (!empty($update_d6)) {
variable_set('update_d6', TRUE);
}
Dries Buytaert
committed
}
/**
* A helper function that modules can use to assist with the transformation
* from numeric block deltas to string block deltas during the 6.x -> 7.x
* upgrade.
*
* @todo This function should be removed in 8.x.
*
* @param $sandbox
* An array holding data for the batch process.
* @param $renamed_deltas
* An associative array. Keys are module names, values an associative array
* mapping the old block deltas to the new block deltas for the module.
* Example:
Dries Buytaert
committed
* @code
* $renamed_deltas = array(
* 'mymodule' =>
* array(
* 0 => 'mymodule-block-1',
* 1 => 'mymodule-block-2',
* );
Dries Buytaert
committed
* @endcode
* @param $moved_deltas
* An associative array. Keys are source module names, values an associative
* array mapping the (possibly renamed) block name to the new module name.
* Example:
* @code
* $moved_deltas = array(
* 'user' =>
* array(
* 'navigation' => 'system',
* ),
* );
* @endcode
Dries Buytaert
committed
function update_fix_d7_block_deltas(&$sandbox, $renamed_deltas, $moved_deltas) {
// Loop through each block and make changes to the block tables.
// Only run this the first time through the batch update.
if (!isset($sandbox['progress'])) {
Angie Byron
committed
// Determine whether to use the old or new block table names.
$block_tables = db_table_exists('blocks') ? array('blocks', 'blocks_roles') : array('block', 'block_role');
foreach ($block_tables as $table) {
foreach ($renamed_deltas as $module => $deltas) {
foreach ($deltas as $old_delta => $new_delta) {
// Only do the update if the old block actually exists.
$block_exists = db_query("SELECT COUNT(*) FROM {" . $table . "} WHERE module = :module AND delta = :delta", array(
Dries Buytaert
committed
':module' => $module,
':delta' => $old_delta,
))
->fetchField();
if ($block_exists) {
Angie Byron
committed
// Delete any existing blocks with the new module+delta.
db_delete($table)
->condition('module', $module)
->condition('delta', $new_delta)
->execute();
// Rename the old block to the new module+delta.
Dries Buytaert
committed
db_update($table)
->fields(array('delta' => $new_delta))
->condition('module', $module)
->condition('delta', $old_delta)
->execute();
}
}
}
Dries Buytaert
committed
foreach ($moved_deltas as $old_module => $deltas) {
foreach ($deltas as $delta => $new_module) {
// Only do the update if the old block actually exists.
$block_exists = db_query("SELECT COUNT(*) FROM {" . $table . "} WHERE module = :module AND delta = :delta", array(
':module' => $old_module,
':delta' => $delta,
))
->fetchField();
if ($block_exists) {
Angie Byron
committed
// Delete any existing blocks with the new module+delta.
db_delete($table)
->condition('module', $new_module)
->condition('delta', $delta)
->execute();
// Rename the old block to the new module+delta.
Dries Buytaert
committed
db_update($table)
->fields(array('module' => $new_module))
->condition('module', $old_module)
->condition('delta', $delta)
->execute();
}
}
}
}
// Initialize batch update information.
$sandbox['progress'] = 0;
$sandbox['last_user_processed'] = -1;
$sandbox['max'] = db_query("SELECT COUNT(*) FROM {users} WHERE data LIKE :block", array(
':block' => '%' . db_like(serialize('block')) . '%',
))
->fetchField();
}
// Now do the batch update of the user-specific block visibility settings.
$limit = 100;
$result = db_select('users', 'u')
->fields('u', array('uid', 'data'))
->condition('uid', $sandbox['last_user_processed'], '>')
->condition('data', '%' . db_like(serialize('block')) . '%', 'LIKE')
Angie Byron
committed
->orderBy('uid', 'ASC')
->range(0, $limit)
->execute();
foreach ($result as $row) {
$data = unserialize($row->data);
$user_needs_update = FALSE;
foreach ($renamed_deltas as $module => $deltas) {
foreach ($deltas as $old_delta => $new_delta) {
if (isset($data['block'][$module][$old_delta])) {
// Transfer the old block visibility settings to the newly-renamed
// block, and mark this user for a database update.
$data['block'][$module][$new_delta] = $data['block'][$module][$old_delta];
unset($data['block'][$module][$old_delta]);
$user_needs_update = TRUE;
}
}
}
Dries Buytaert
committed
foreach ($moved_deltas as $old_module => $deltas) {
foreach ($deltas as $delta => $new_module) {
if (isset($data['block'][$old_module][$delta])) {
// Transfer the old block visibility settings to the moved
// block, and mark this user for a database update.
$data['block'][$new_module][$delta] = $data['block'][$old_module][$delta];
unset($data['block'][$old_module][$delta]);
$user_needs_update = TRUE;
}
}
}
// Update the current user.
if ($user_needs_update) {
db_update('users')
->fields(array('data' => serialize($data)))
->condition('uid', $row->uid)
->execute();
}
// Update our progress information for the batch update.
$sandbox['progress']++;
$sandbox['last_user_processed'] = $row->uid;
}
// Indicate our current progress to the batch update system.
if ($sandbox['progress'] < $sandbox['max']) {
$sandbox['#finished'] = $sandbox['progress'] / $sandbox['max'];
}
}
Dries Buytaert
committed
/**
* Perform Drupal 6.x to 7.x updates that are required for update.php
* to function properly.
*
* This function runs when update.php is run the first time for 7.x,
* even before updates are selected or performed. It is important
* that if updates are not ultimately performed that no changes are
* made which make it impossible to continue using the prior version.
*/
function update_fix_d7_requirements() {
global $conf;
Dries Buytaert
committed
// Rewrite the settings.php file if necessary, see
// update_prepare_d7_bootstrap().
Angie Byron
committed
global $update_rewrite_settings, $db_url, $db_prefix;
Dries Buytaert
committed
if (!empty($update_rewrite_settings)) {
Angie Byron
committed
$databases = update_parse_db_url($db_url, $db_prefix);
Dries Buytaert
committed
$salt = drupal_hash_base64(drupal_random_bytes(55));
Dries Buytaert
committed
file_put_contents(conf_path() . '/settings.php', "\n" . '$databases = ' . var_export($databases, TRUE) . ";\n\$drupal_hash_salt = '$salt';", FILE_APPEND);
Dries Buytaert
committed
}
if (drupal_get_installed_schema_version('system') < 7000 && !variable_get('update_d7_requirements', FALSE)) {
Angie Byron
committed
// Change 6.x system table field values to 7.x equivalent.
// Change field values.
db_change_field('system', 'schema_version', 'schema_version', array(
'type' => 'int',
'size' => 'small',
'not null' => TRUE,
'default' => -1)
);
db_change_field('system', 'status', 'status', array(
Angie Byron
committed
'type' => 'int', 'not null' => TRUE, 'default' => 0));
Angie Byron
committed
db_change_field('system', 'weight', 'weight', array(
Angie Byron
committed
'type' => 'int', 'not null' => TRUE, 'default' => 0));
Angie Byron
committed
db_change_field('system', 'bootstrap', 'bootstrap', array(
Angie Byron
committed
'type' => 'int', 'not null' => TRUE, 'default' => 0));
Angie Byron
committed
// Drop and recreate 6.x indexes.
db_drop_index('system', 'bootstrap');
db_add_index('system', 'bootstrap', array(
'status', 'bootstrap', array('type', 12), 'weight', 'name'));
db_drop_index('system' ,'modules');
db_add_index('system', 'modules', array(array(
'type', 12), 'status', 'weight', 'name'));
db_drop_index('system', 'type_name');
db_add_index('system', 'type_name', array(array('type', 12), 'name'));
// Add 7.x indexes.
db_add_index('system', 'system_list', array('weight', 'name'));
Dries Buytaert
committed
// Add the cache_path table.
Angie Byron
committed
if (db_table_exists('cache_path')) {
db_drop_table('cache_path');
}
Dries Buytaert
committed
require_once('./modules/system/system.install');
$schema['cache_path'] = system_schema_cache_7054();
Dries Buytaert
committed
$schema['cache_path']['description'] = 'Cache table used for path alias lookups.';
Angie Byron
committed
db_create_table('cache_path', $schema['cache_path']);
Angie Byron
committed
// system_update_7042() renames columns, but these are needed to bootstrap.
Angie Byron
committed
// Add empty columns for now.
Angie Byron
committed
db_add_field('url_alias', 'source', array('type' => 'varchar', 'length' => 255, 'not null' => TRUE, 'default' => ''));
db_add_field('url_alias', 'alias', array('type' => 'varchar', 'length' => 255, 'not null' => TRUE, 'default' => ''));
Dries Buytaert
committed
// Add new columns to {menu_router}.
db_add_field('menu_router', 'delivery_callback', array('type' => 'varchar', 'length' => 255, 'not null' => TRUE, 'default' => ''));
db_add_field('menu_router', 'context', array(
'description' => 'Only for local tasks (tabs) - the context of a local task to control its placement.',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
));
Dries Buytaert
committed
db_drop_index('menu_router', 'tab_parent');
db_add_index('menu_router', 'tab_parent', array(array('tab_parent', 64), 'weight', 'title'));
db_add_field('menu_router', 'theme_callback', array('type' => 'varchar', 'length' => 255, 'not null' => TRUE, 'default' => ''));
db_add_field('menu_router', 'theme_arguments', array('type' => 'varchar', 'length' => 255, 'not null' => TRUE, 'default' => ''));
// Add the role_permission table.
Angie Byron
committed
$schema['role_permission'] = array(
'fields' => array(
'rid' => array(
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
),
'permission' => array(
'type' => 'varchar',
Angie Byron
committed
'length' => 128,
Angie Byron
committed
'not null' => TRUE,
'default' => '',
),
),
'primary key' => array('rid', 'permission'),
'indexes' => array(
'permission' => array('permission'),
),
);
db_create_table('role_permission', $schema['role_permission']);
Angie Byron
committed
// Drops and recreates semaphore value index.
Angie Byron
committed
db_drop_index('semaphore', 'value');
Angie Byron
committed
db_add_index('semaphore', 'value', array('value'));
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
$schema['date_format_type'] = array(
'description' => 'Stores configured date format types.',
'fields' => array(
'type' => array(
'description' => 'The date format type, e.g. medium.',
'type' => 'varchar',
'length' => 64,
'not null' => TRUE,
),
'title' => array(
'description' => 'The human readable name of the format type.',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
),
'locked' => array(
'description' => 'Whether or not this is a system provided format.',
'type' => 'int',
'size' => 'tiny',
'default' => 0,
'not null' => TRUE,
),
),
'primary key' => array('type'),
);
$schema['date_formats'] = array(
'description' => 'Stores configured date formats.',
'fields' => array(
'dfid' => array(
'description' => 'The date format identifier.',
'type' => 'serial',
'not null' => TRUE,
'unsigned' => TRUE,
),
'format' => array(
'description' => 'The date format string.',
'type' => 'varchar',
'length' => 100,
'not null' => TRUE,
),
'type' => array(
'description' => 'The date format type, e.g. medium.',
'type' => 'varchar',
'length' => 64,
'not null' => TRUE,
),
'locked' => array(
'description' => 'Whether or not this format can be modified.',
'type' => 'int',
'size' => 'tiny',
'default' => 0,
'not null' => TRUE,
),
),
'primary key' => array('dfid'),
'unique keys' => array('formats' => array('format', 'type')),
);
$schema['date_format_locale'] = array(
'description' => 'Stores configured date formats for each locale.',
'fields' => array(
'format' => array(
'description' => 'The date format string.',
'type' => 'varchar',
'length' => 100,
'not null' => TRUE,
),
'type' => array(
'description' => 'The date format type, e.g. medium.',
'type' => 'varchar',
'length' => 64,
'not null' => TRUE,
),
'language' => array(
'description' => 'A {languages}.language for this format to be used with.',
'type' => 'varchar',
'length' => 12,
'not null' => TRUE,
),
),
'primary key' => array('type', 'language'),
);
db_create_table('date_format_type', $schema['date_format_type']);
// Sites that have the Drupal 6 Date module installed already have the
// following tables.
if (db_table_exists('date_formats')) {
db_rename_table('date_formats', 'd6_date_formats');
}
db_create_table('date_formats', $schema['date_formats']);
if (db_table_exists('date_format_locale')) {
db_rename_table('date_format_locale', 'd6_date_format_locale');
}
db_create_table('date_format_locale', $schema['date_format_locale']);
// Add the queue table.
$schema['queue'] = array(
'description' => 'Stores items in queues.',
'fields' => array(
'item_id' => array(
'type' => 'serial',
'unsigned' => TRUE,
'not null' => TRUE,
'description' => 'Primary Key: Unique item ID.',
),
'name' => array(
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
'description' => 'The queue name.',
),
'data' => array(
Dries Buytaert
committed
'type' => 'blob',
'not null' => FALSE,
'size' => 'big',
'serialize' => TRUE,
'description' => 'The arbitrary data for the item.',
),
'expire' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'description' => 'Timestamp when the claim lease expires on the item.',
),
'created' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'description' => 'Timestamp when the item was created.',
),
),
'primary key' => array('item_id'),
'indexes' => array(
'name_created' => array('name', 'created'),
'expire' => array('expire'),
),
);
Dries Buytaert
committed
// Check for queue table that may remain from D5 or D6, if found
//drop it.
if (db_table_exists('queue')) {
db_drop_table('queue');
}
db_create_table('queue', $schema['queue']);
// Create the sequences table.
$schema['sequences'] = array(
'description' => 'Stores IDs.',
'fields' => array(
'value' => array(
'description' => 'The value of the sequence.',
'type' => 'serial',
'unsigned' => TRUE,
'not null' => TRUE,
),
),
'primary key' => array('value'),
);
Dries Buytaert
committed
// Check for sequences table that may remain from D5 or D6, if found
//drop it.
if (db_table_exists('sequences')) {
db_drop_table('sequences');
}
db_create_table('sequences', $schema['sequences']);
// Initialize the table with the maximum current increment of the tables
// that will rely on it for their ids.
$max_aid = db_query('SELECT MAX(aid) FROM {actions_aid}')->fetchField();
$max_uid = db_query('SELECT MAX(uid) FROM {users}')->fetchField();
$max_batch_id = db_query('SELECT MAX(bid) FROM {batch}')->fetchField();
db_insert('sequences')->fields(array('value' => max($max_aid, $max_uid, $max_batch_id)))->execute();
Dries Buytaert
committed
// Add column for locale context.
if (db_table_exists('locales_source')) {
Dries Buytaert
committed
db_add_field('locales_source', 'context', array('type' => 'varchar', 'length' => 255, 'not null' => TRUE, 'default' => '', 'description' => 'The context this string applies to.'));
Dries Buytaert
committed
}
Angie Byron
committed
// Rename 'site_offline_message' variable to 'maintenance_mode_message'
// and 'site_offline' variable to 'maintenance_mode'.
// Old variable is removed in update for system.module, see
// system_update_7072().
if ($message = variable_get('site_offline_message', NULL)) {
variable_set('maintenance_mode_message', $message);
}
Angie Byron
committed
// Old variable is removed in update for system.module, see
// system_update_7069().
$site_offline = variable_get('site_offline', -1);
if ($site_offline != -1) {
variable_set('maintenance_mode', $site_offline);
}
Angie Byron
committed
// Add ssid column and index.
Dries Buytaert
committed
db_add_field('sessions', 'ssid', array('description' => "Secure session ID. The value is generated by Drupal's session handlers.", 'type' => 'varchar', 'length' => 128, 'not null' => TRUE, 'default' => ''));
Angie Byron
committed
db_add_index('sessions', 'ssid', array('ssid'));
Dries Buytaert
committed
// Drop existing primary key.
db_drop_primary_key('sessions');
// Add new primary key.
db_add_primary_key('sessions', array('sid', 'ssid'));
Angie Byron
committed
Angie Byron
committed
// Allow longer javascript file names.
if (db_table_exists('languages')) {
db_change_field('languages', 'javascript', 'javascript', array('type' => 'varchar', 'length' => 64, 'not null' => TRUE, 'default' => ''));
}
// Rename action description to label.
db_change_field('actions', 'description', 'label', array('type' => 'varchar', 'length' => 255, 'not null' => TRUE, 'default' => '0'));
variable_set('update_d7_requirements', TRUE);
Dries Buytaert
committed
}
Angie Byron
committed
update_fix_d7_install_profile();
Dries Buytaert
committed
}
Angie Byron
committed
/**
* Register the currently installed profile in the system table.
*
Jennifer Hodgdon
committed
* Installation profiles are now treated as modules by Drupal, and have an
* upgrade path based on their schema version in the system table.
Jennifer Hodgdon
committed
* The installation profile will be set to schema_version 0, as it has already
* been installed. Any other hook_update_N functions provided by the
* installation profile will be run by update.php.
Angie Byron
committed
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
*/
function update_fix_d7_install_profile() {
$profile = drupal_get_profile();
$results = db_select('system', 's')
->fields('s', array('name', 'schema_version'))
->condition('name', $profile)
->condition('type', 'module')
->execute()
->fetchAll();
if (empty($results)) {
$filename = 'profiles/' . $profile . '/' . $profile . '.profile';
// Read profile info file
$info = drupal_parse_info_file(dirname($filename) . '/' . $profile . '.info');
// Merge in defaults.
$info = $info + array(
'dependencies' => array(),
'description' => '',
'package' => 'Other',
'version' => NULL,
'php' => DRUPAL_MINIMUM_PHP,
'files' => array(),
);
$values = array(
'filename' => $filename,
'name' => $profile,
'info' => serialize($info),
'schema_version' => 0,
'type' => 'module',
'status' => 1,
'owner' => '',
);
Jennifer Hodgdon
committed
// Installation profile hooks are always executed last by the module system
Angie Byron
committed
$values['weight'] = 1000;
Jennifer Hodgdon
committed
// Initializing the system table entry for the installation profile
Angie Byron
committed
db_insert('system')
->fields(array_keys($values))
->values($values)
->execute();
// Reset the cached schema version.
drupal_get_installed_schema_version($profile, TRUE);
Jennifer Hodgdon
committed
// Load the updates again to make sure the installation profile updates
// are loaded.
Angie Byron
committed
drupal_load_updates();
}
}
Dries Buytaert
committed
/**
* Parse pre-Drupal 7 database connection URLs and return D7 compatible array.
*
* @return
* Drupal 7 DBTNG compatible array of database connection information.
Dries Buytaert
committed
*/
Angie Byron
committed
function update_parse_db_url($db_url, $db_prefix) {
Dries Buytaert
committed
$databases = array();
if (!is_array($db_url)) {
$db_url = array('default' => $db_url);
}
foreach ($db_url as $database => $url) {
$url = parse_url($url);
$databases[$database]['default'] = array(
// MySQLi uses the mysql driver.
'driver' => $url['scheme'] == 'mysqli' ? 'mysql' : $url['scheme'],
// Remove the leading slash to get the database name.
'database' => substr(urldecode($url['path']), 1),
'username' => urldecode($url['user']),
'password' => isset($url['pass']) ? urldecode($url['pass']) : '',
'host' => urldecode($url['host']),
'port' => isset($url['port']) ? urldecode($url['port']) : '',
);
Angie Byron
committed
if (isset($db_prefix)) {
$databases[$database]['default']['prefix'] = $db_prefix;
}
Dries Buytaert
committed
}
return $databases;
}
Angie Byron
committed
/**
* Constructs a session name compatible with a D6 environment.
*
* @return
* D6-compatible session name string.
*
* @see drupal_settings_initialize()
*/
function update_get_d6_session_name() {
global $base_url, $cookie_domain;
$cookie_secure = ini_get('session.cookie_secure');
// If a custom cookie domain is set in settings.php, that variable forms
// the basis of the session name. Re-compute the D7 hashing method to find
// out if $cookie_domain was used as the session name.
if (($cookie_secure ? 'SSESS' : 'SESS') . substr(hash('sha256', $cookie_domain), 0, 32) == session_name()) {
$session_name = $cookie_domain;
}
else {
// Otherwise use $base_url as session name, without the protocol
Jennifer Hodgdon
committed
// to use the same session identifiers across HTTP and HTTPS.
Angie Byron
committed
list( , $session_name) = explode('://', $base_url, 2);
}
if ($cookie_secure) {
$session_name .= 'SSL';
}
return 'SESS' . md5($session_name);
}
Dries Buytaert
committed
/**
* Perform one update and store the results for display on finished page.
Dries Buytaert
committed
*
* If an update function completes successfully, it should return a message
* as a string indicating success, for example:
* @code
* return t('New index added successfully.');
* @endcode
*
* Alternatively, it may return nothing. In that case, no message
* will be displayed at all.
*
* If it fails for whatever reason, it should throw an instance of
* DrupalUpdateException with an appropriate error message, for example:
* @code
* throw new DrupalUpdateException(t('Description of what went wrong'));
* @endcode
*
Angie Byron
committed
* If an exception is thrown, the current update and all updates that depend on
* it will be aborted. The schema version will not be updated in this case, and
* all the aborted updates will continue to appear on update.php as updates
* that have not yet been run.
Dries Buytaert
committed
*
* If an update function needs to be re-run as part of a batch process, it
* should accept the $sandbox array by reference as its first parameter
* and set the #finished property to the percentage completed that it is, as a
* fraction of 1.
*
Dries Buytaert
committed
* @param $module
* The module whose update will be run.
* @param $number
* The update number to run.
Angie Byron
committed
* @param $dependency_map
* An array whose keys are the names of all update functions that will be
* performed during this batch process, and whose values are arrays of other
* update functions that each one depends on.
Dries Buytaert
committed
* @param $context
Angie Byron
committed
* The batch context array.
*
* @see update_resolve_dependencies()
Dries Buytaert
committed
*/
Angie Byron
committed
function update_do_one($module, $number, $dependency_map, &$context) {
$function = $module . '_update_' . $number;
// If this update was aborted in a previous step, or has a dependency that
// was aborted in a previous step, go no further.
Angie Byron
committed
if (!empty($context['results']['#abort']) && array_intersect($context['results']['#abort'], array_merge($dependency_map, array($function)))) {
Dries Buytaert
committed
return;
}
$ret = array();
Dries Buytaert
committed
if (function_exists($function)) {
try {
$ret['results']['query'] = $function($context['sandbox']);
$ret['results']['success'] = TRUE;
}
// @TODO We may want to do different error handling for different
// exception types, but for now we'll just log the exception and
// return the message for printing.
catch (Exception $e) {
watchdog_exception('update', $e);
require_once DRUPAL_ROOT . '/includes/errors.inc';
$variables = _drupal_decode_exception($e);
Dries Buytaert
committed
// The exception message is run through check_plain() by _drupal_decode_exception().
$ret['#abort'] = array('success' => FALSE, 'query' => t('%type: !message in %function (line %line of %file).', $variables));
Dries Buytaert
committed
}
if (isset($context['sandbox']['#finished'])) {
$context['finished'] = $context['sandbox']['#finished'];
unset($context['sandbox']['#finished']);
}
Dries Buytaert
committed
if (!isset($context['results'][$module])) {
$context['results'][$module] = array();
}
if (!isset($context['results'][$module][$number])) {
$context['results'][$module][$number] = array();
}
$context['results'][$module][$number] = array_merge($context['results'][$module][$number], $ret);
if (!empty($ret['#abort'])) {
Angie Byron
committed
// Record this function in the list of updates that were aborted.
$context['results']['#abort'][] = $function;
Dries Buytaert
committed
}
Dries Buytaert
committed
// Record the schema update if it was completed successfully.
Angie Byron
committed
if ($context['finished'] == 1 && empty($ret['#abort'])) {
Dries Buytaert
committed
drupal_set_installed_schema_version($module, $number);
}