Newer
Older
Dries Buytaert
committed
Angie Byron
committed
use Drupal\Component\Utility\Crypt;
use Drupal\Core\Database\Database;
Larry Garfield
committed
Angie Byron
committed
/**
* @file
* Install, update and uninstall functions for the system module.
*/
Steven Wittens
committed
/**
* Test and report Drupal installation requirements.
*
* @param $phase
* The current system installation phase.
* @return
* An array of system requirements.
Steven Wittens
committed
*/
function system_requirements($phase) {
Dries Buytaert
committed
global $base_url;
Steven Wittens
committed
$requirements = array();
Jennifer Hodgdon
committed
// Ensure translations don't break during installation.
Steven Wittens
committed
// Report Drupal version
if ($phase == 'runtime') {
$requirements['drupal'] = array(
'title' => $t('Drupal'),
'value' => VERSION,
'severity' => REQUIREMENT_INFO,
'weight' => -10,
Steven Wittens
committed
);
Angie Byron
committed
Jennifer Hodgdon
committed
// Display the currently active installation profile, if the site
// is not running the default installation profile.
Angie Byron
committed
$profile = drupal_get_profile();
Angie Byron
committed
if ($profile != 'standard') {
Dries Buytaert
committed
$info = system_get_info('module', $profile);
Angie Byron
committed
$requirements['install_profile'] = array(
Jennifer Hodgdon
committed
'title' => $t('Installation profile'),
Angie Byron
committed
'value' => $t('%profile_name (%profile-%version)', array(
'%profile_name' => $info['name'],
'%profile' => $profile,
'%version' => $info['version']
)),
'severity' => REQUIREMENT_INFO,
'weight' => -9
);
}
Steven Wittens
committed
}
Gábor Hojtsy
committed
// Web server information.
Steven Wittens
committed
$requirements['webserver'] = array(
'title' => $t('Web server'),
Steven Wittens
committed
);
// Test PHP version and show link to phpinfo() if it's available
$phpversion = phpversion();
if (function_exists('phpinfo')) {
$requirements['php'] = array(
'title' => $t('PHP'),
'value' => ($phase == 'runtime') ? $phpversion .' ('. l($t('more information'), 'admin/reports/status/php') .')' : $phpversion,
);
}
else {
$requirements['php'] = array(
'title' => $t('PHP'),
'value' => $phpversion,
'description' => $t('The phpinfo() function has been disabled for security reasons. To see your server\'s phpinfo() information, change your PHP settings or contact your server administrator. For more information, <a href="@phpinfo">Enabling and disabling phpinfo()</a> handbook page.', array('@phpinfo' => 'http://drupal.org/node/243993')),
'severity' => REQUIREMENT_INFO,
);
}
if (version_compare($phpversion, DRUPAL_MINIMUM_PHP) < 0) {
Steven Wittens
committed
$requirements['php']['description'] = $t('Your PHP installation is too old. Drupal requires at least PHP %version.', array('%version' => DRUPAL_MINIMUM_PHP));
$requirements['php']['severity'] = REQUIREMENT_ERROR;
Dries Buytaert
committed
// If PHP is old, it's not safe to continue with the requirements check.
return $requirements;
Steven Wittens
committed
}
Gábor Hojtsy
committed
Gábor Hojtsy
committed
// Test PHP register_globals setting.
$requirements['php_register_globals'] = array(
'title' => $t('PHP register globals'),
);
$register_globals = trim(ini_get('register_globals'));
Gábor Hojtsy
committed
// Unfortunately, ini_get() may return many different values, and we can't
Gábor Hojtsy
committed
// be certain which values mean 'on', so we instead check for 'not off'
// since we never want to tell the user that their site is secure
// (register_globals off), when it is in fact on. We can only guarantee
// register_globals is off if the value returned is 'off', '', or 0.
if (!empty($register_globals) && strtolower($register_globals) != 'off') {
Dries Buytaert
committed
$requirements['php_register_globals']['description'] = $t('<em>register_globals</em> is enabled. Drupal requires this configuration directive to be disabled. Your site may not be secure when <em>register_globals</em> is enabled. The PHP manual has instructions for <a href="@url">how to change configuration settings</a>.', array('@url' => 'http://php.net/configuration.changes'));
Gábor Hojtsy
committed
$requirements['php_register_globals']['severity'] = REQUIREMENT_ERROR;
$requirements['php_register_globals']['value'] = $t("Enabled ('@value')", array('@value' => $register_globals));
}
else {
$requirements['php_register_globals']['value'] = $t('Disabled');
}
Dries Buytaert
committed
// Test for PHP extensions.
$requirements['php_extensions'] = array(
'title' => $t('PHP extensions'),
Angie Byron
committed
);
$missing_extensions = array();
$required_extensions = array(
'date',
'dom',
'filter',
'gd',
'hash',
'json',
'pcre',
'pdo',
'session',
'SimpleXML',
'SPL',
'tokenizer',
'xml',
);
foreach ($required_extensions as $extension) {
if (!extension_loaded($extension)) {
$missing_extensions[] = $extension;
}
}
if (!empty($missing_extensions)) {
$description = $t('Drupal requires you to enable the PHP extensions in the following list (see the <a href="@system_requirements">system requirements page</a> for more information):', array(
'@system_requirements' => 'http://drupal.org/requirements',
));
$description .= theme('item_list', array('items' => $missing_extensions));
$requirements['php_extensions']['value'] = $t('Disabled');
$requirements['php_extensions']['severity'] = REQUIREMENT_ERROR;
$requirements['php_extensions']['description'] = $description;
Angie Byron
committed
}
else {
$requirements['php_extensions']['value'] = $t('Enabled');
Angie Byron
committed
}
Gábor Hojtsy
committed
Angie Byron
committed
if ($phase == 'install' || $phase == 'update') {
// Test for PDO (database).
$requirements['database_extensions'] = array(
'title' => $t('Database support'),
);
Dries Buytaert
committed
// Make sure PDO is available.
Angie Byron
committed
$database_ok = extension_loaded('pdo');
Dries Buytaert
committed
if (!$database_ok) {
$pdo_message = $t('Your web server does not appear to support PDO (PHP Data Objects). Ask your hosting provider if they support the native PDO extension. See the <a href="@link">system requirements</a> page for more information.', array(
'@link' => 'http://drupal.org/requirements/pdo',
));
}
else {
// Make sure at least one supported database driver exists.
Angie Byron
committed
$drivers = drupal_detect_database_types();
Dries Buytaert
committed
if (empty($drivers)) {
$database_ok = FALSE;
$pdo_message = $t('Your web server does not appear to support any common PDO database extensions. Check with your hosting provider to see if they support PDO (PHP Data Objects) and offer any databases that <a href="@drupal-databases">Drupal supports</a>.', array(
'@drupal-databases' => 'http://drupal.org/node/270#database',
));
}
// Make sure the native PDO extension is available, not the older PEAR
// version. (See install_verify_pdo() for details.)
if (!defined('PDO::ATTR_DEFAULT_FETCH_MODE')) {
$database_ok = FALSE;
$pdo_message = $t('Your web server seems to have the wrong version of PDO installed. Drupal requires the PDO extension from PHP core. This system has the older PECL version. See the <a href="@link">system requirements</a> page for more information.', array(
Dries Buytaert
committed
'@link' => 'http://drupal.org/requirements/pdo#pecl',
));
}
Angie Byron
committed
}
Angie Byron
committed
if (!$database_ok) {
$requirements['database_extensions']['value'] = $t('Disabled');
$requirements['database_extensions']['severity'] = REQUIREMENT_ERROR;
Dries Buytaert
committed
$requirements['database_extensions']['description'] = $pdo_message;
Angie Byron
committed
}
else {
$requirements['database_extensions']['value'] = $t('Enabled');
}
Dries Buytaert
committed
}
else {
// Database information.
Larry Garfield
committed
$class = Database::getConnection()->getDriverClass('Install\\Tasks');
$tasks = new $class();
$requirements['database_system'] = array(
'title' => $t('Database system'),
'value' => $tasks->name(),
);
$requirements['database_system_version'] = array(
'title' => $t('Database system version'),
'value' => Database::getConnection()->version(),
);
}
Dries Buytaert
committed
Gábor Hojtsy
committed
// Test PHP memory_limit
Gábor Hojtsy
committed
$memory_limit = ini_get('memory_limit');
Gábor Hojtsy
committed
$requirements['php_memory_limit'] = array(
'title' => $t('PHP memory limit'),
Dries Buytaert
committed
'value' => $memory_limit == -1 ? t('-1 (Unlimited)') : $memory_limit,
Gábor Hojtsy
committed
);
Gábor Hojtsy
committed
if (!drupal_check_memory_limit(DRUPAL_MINIMUM_PHP_MEMORY_LIMIT, $memory_limit)) {
Gábor Hojtsy
committed
$description = '';
if ($phase == 'install') {
$description = $t('Consider increasing your PHP memory limit to %memory_minimum_limit to help prevent errors in the installation process.', array('%memory_minimum_limit' => DRUPAL_MINIMUM_PHP_MEMORY_LIMIT));
Gábor Hojtsy
committed
}
elseif ($phase == 'update') {
$description = $t('Consider increasing your PHP memory limit to %memory_minimum_limit to help prevent errors in the update process.', array('%memory_minimum_limit' => DRUPAL_MINIMUM_PHP_MEMORY_LIMIT));
Gábor Hojtsy
committed
}
Gábor Hojtsy
committed
elseif ($phase == 'runtime') {
$description = $t('Depending on your configuration, Drupal can run with a %memory_limit PHP memory limit. However, a %memory_minimum_limit PHP memory limit or above is recommended, especially if your site uses additional custom or contributed modules.', array('%memory_limit' => $memory_limit, '%memory_minimum_limit' => DRUPAL_MINIMUM_PHP_MEMORY_LIMIT));
Gábor Hojtsy
committed
}
Gábor Hojtsy
committed
Gábor Hojtsy
committed
if (!empty($description)) {
if ($php_ini_path = get_cfg_var('cfg_file_path')) {
$description .= ' ' . $t('Increase the memory limit by editing the memory_limit parameter in the file %configuration-file and then restart your web server (or contact your system administrator or hosting provider for assistance).', array('%configuration-file' => $php_ini_path));
Gábor Hojtsy
committed
}
else {
$description .= ' ' . $t('Contact your system administrator or hosting provider for assistance with increasing your PHP memory limit.');
Gábor Hojtsy
committed
}
Gábor Hojtsy
committed
$requirements['php_memory_limit']['description'] = $description . ' ' . $t('For more information, see the online handbook entry for <a href="@memory-limit">increasing the PHP memory limit</a>.', array('@memory-limit' => 'http://drupal.org/node/207036'));
Gábor Hojtsy
committed
$requirements['php_memory_limit']['severity'] = REQUIREMENT_WARNING;
Gábor Hojtsy
committed
}
Gábor Hojtsy
committed
}
Gábor Hojtsy
committed
// Test configuration files and directory for writability.
Steven Wittens
committed
if ($phase == 'runtime') {
$conf_errors = array();
$conf_path = conf_path();
if (!drupal_verify_install_file($conf_path, FILE_NOT_WRITABLE, 'dir')) {
$conf_errors[] = $t("The directory %file is not protected from modifications and poses a security risk. You must change the directory's permissions to be non-writable.", array('%file' => $conf_path));
}
foreach (array('settings.php', 'settings.local.php') as $conf_file) {
$full_path = $conf_path . '/' . $conf_file;
if (file_exists($full_path) && !drupal_verify_install_file($full_path, FILE_EXIST|FILE_READABLE|FILE_NOT_WRITABLE)) {
$conf_errors[] = $t("The file %file is not protected from modifications and poses a security risk. You must change the file's permissions to be non-writable.", array('%file' => $full_path));
}
}
if (!empty($conf_errors)) {
if (count($conf_errors) == 1) {
$description = $conf_errors[0];
}
else {
$description = theme('item_list', array('items' => $conf_errors));
}
Steven Wittens
committed
$requirements['settings.php'] = array(
'value' => $t('Not protected'),
'severity' => REQUIREMENT_ERROR,
'description' => $description,
Steven Wittens
committed
);
}
else {
$requirements['settings.php'] = array(
'value' => $t('Protected'),
);
}
$requirements['settings.php']['title'] = $t('Configuration files');
Steven Wittens
committed
}
Gábor Hojtsy
committed
// Report cron status.
Steven Wittens
committed
if ($phase == 'runtime') {
$cron_config = config('system.cron');
Gábor Hojtsy
committed
// Cron warning threshold defaults to two days.
$threshold_warning = $cron_config->get('threshold.requirements_warning');
Gábor Hojtsy
committed
// Cron error threshold defaults to two weeks.
$threshold_error = $cron_config->get('threshold.requirements_error');
Gábor Hojtsy
committed
// Cron configuration help text.
$help = $t('For more information, see the online handbook entry for <a href="@cron-handbook">configuring cron jobs</a>.', array('@cron-handbook' => 'http://drupal.org/cron'));
Gábor Hojtsy
committed
Dries Buytaert
committed
// Determine when cron last ran.
$cron_last = state()->get('system.cron_last');
Gábor Hojtsy
committed
if (!is_numeric($cron_last)) {
catch
committed
$cron_last = variable_get('install_time', 0);
Gábor Hojtsy
committed
}
Steven Wittens
committed
Gábor Hojtsy
committed
// Determine severity based on time since cron last ran.
$severity = REQUIREMENT_INFO;
Dries Buytaert
committed
if (REQUEST_TIME - $cron_last > $threshold_error) {
Gábor Hojtsy
committed
$severity = REQUIREMENT_ERROR;
Steven Wittens
committed
}
Dries Buytaert
committed
elseif (REQUEST_TIME - $cron_last > $threshold_warning) {
Gábor Hojtsy
committed
$severity = REQUIREMENT_WARNING;
}
// Set summary and description based on values determined above.
Dries Buytaert
committed
$summary = $t('Last run !time ago', array('!time' => format_interval(REQUEST_TIME - $cron_last)));
$description = '';
if ($severity != REQUIREMENT_INFO) {
Dries Buytaert
committed
$description = $t('Cron has not run recently.') . ' ' . $help;
Gábor Hojtsy
committed
}
Steven Wittens
committed
$description .= ' ' . $t('You can <a href="@cron">run cron manually</a>.', array('@cron' => url('admin/reports/status/run-cron')));
Angie Byron
committed
$description .= '<br />' . $t('To run cron from outside the site, go to <a href="!cron">!cron</a>', array('!cron' => url('cron/' . state()->get('system.cron_key'), array('absolute' => TRUE))));
Dries Buytaert
committed
Gábor Hojtsy
committed
$requirements['cron'] = array(
'title' => $t('Cron maintenance tasks'),
'severity' => $severity,
'value' => $summary,
Dries Buytaert
committed
'description' => $description
Gábor Hojtsy
committed
);
Steven Wittens
committed
}
if ($phase != 'install') {
$filesystem_config = config('system.file');
$directories = array(
variable_get('file_public_path', conf_path() . '/files'),
// By default no private files directory is configured. For private files
// to be secure the admin needs to provide a path outside the webroot.
$filesystem_config->get('path.private'),
file_directory_temp(),
);
}
Steven Wittens
committed
// During an install we need to make assumptions about the file system
// unless overrides are provided in settings.php.
if ($phase == 'install') {
global $conf;
$directories = array();
if (!empty($conf['file_public_path'])) {
$directories[] = $conf['file_public_path'];
}
else {
// If we are installing Drupal, the settings.php file might not exist yet
// in the intended conf_path() directory, so don't require it. The
// conf_path() cache must also be reset in this case.
$directories[] = conf_path(FALSE, TRUE) . '/files';
}
if (!empty($conf['system.file']['path.private'])) {
$directories[] = $conf['system.file']['path.private'];
}
if (!empty($conf['system.file']['path.temporary'])) {
$directories[] = $conf['system.file']['path.temporary'];
}
else {
// If the temporary directory is not overridden use an appropriate
// temporary path for the system.
$directories[] = file_directory_os_temp();
}
// Check the config directory if it is defined in settings.php. If it isn't
// defined, the installer will create a valid config directory later, but
// during runtime we must always display an error.
Angie Byron
committed
if (!empty($GLOBALS['config_directories'])) {
$directories[] = config_get_config_directory(CONFIG_ACTIVE_DIRECTORY);
$directories[] = config_get_config_directory(CONFIG_STAGING_DIRECTORY);
}
elseif ($phase != 'install') {
Angie Byron
committed
$requirements['config directories'] = array(
'title' => $t('Configuration directories'),
'value' => $t('Not present'),
Angie Byron
committed
'description' => $t('Your %file file must define the $config_directories variable as an array containing the name of a directories in which configuration files can be written.', array('%file' => conf_path() . '/settings.php')),
'severity' => REQUIREMENT_ERROR,
);
}
Gábor Hojtsy
committed
$requirements['file system'] = array(
'title' => $t('File system'),
);
$error = '';
// For installer, create the directories if possible.
foreach ($directories as $directory) {
Angie Byron
committed
if (!$directory) {
continue;
}
if ($phase == 'install') {
file_prepare_directory($directory, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);
Gábor Hojtsy
committed
}
$is_writable = is_writable($directory);
$is_directory = is_dir($directory);
if (!$is_writable || !$is_directory) {
$description = '';
$requirements['file system']['value'] = $t('Not writable');
if (!$is_directory) {
$error .= $t('The directory %directory does not exist.', array('%directory' => $directory)) . ' ';
}
else {
$error .= $t('The directory %directory is not writable.', array('%directory' => $directory)) . ' ';
}
// The files directory requirement check is done only during install and runtime.
if ($phase == 'runtime') {
Dries Buytaert
committed
$description = $error . $t('You may need to set the correct directory at the <a href="@admin-file-system">file system settings page</a> or change the current directory\'s permissions so that it is writable.', array('@admin-file-system' => url('admin/config/media/file-system')));
}
elseif ($phase == 'install') {
// For the installer UI, we need different wording. 'value' will
// be treated as version, so provide none there.
$description = $error . $t('An automated attempt to create this directory failed, possibly due to a permissions problem. To proceed with the installation, either create the directory and modify its permissions manually or ensure that the installer has the permissions to create it automatically. For more information, see INSTALL.txt or the <a href="@handbook_url">online handbook</a>.', array('@handbook_url' => 'http://drupal.org/server-permissions'));
$requirements['file system']['value'] = '';
}
if (!empty($description)) {
$requirements['file system']['description'] = $description;
$requirements['file system']['severity'] = REQUIREMENT_ERROR;
}
Gábor Hojtsy
committed
}
else {
Angie Byron
committed
// This function can be called before the config_cache table has been
// created.
if ($phase == 'install' || file_default_scheme() == 'public') {
$requirements['file system']['value'] = $t('Writable (<em>public</em> download method)');
}
else {
$requirements['file system']['value'] = $t('Writable (<em>private</em> download method)');
}
// See if updates are available in update.php.
if ($phase == 'runtime') {
$requirements['update'] = array(
'title' => $t('Database updates'),
'value' => $t('Up to date'),
);
// Check installed modules.
foreach (drupal_container()->get('module_handler')->getModuleList() as $module => $filename) {
$updates = drupal_get_schema_versions($module);
if ($updates !== FALSE) {
$default = drupal_get_installed_schema_version($module);
if (max($updates) > $default) {
$requirements['update']['severity'] = REQUIREMENT_ERROR;
$requirements['update']['value'] = $t('Out of date');
Nate Lampton
committed
$requirements['update']['description'] = $t('Some modules have database schema updates to install. You should run the <a href="@update">database update script</a> immediately.', array('@update' => base_path() . 'core/update.php'));
break;
}
}
}
}
Gábor Hojtsy
committed
// Verify the update.php access setting
if ($phase == 'runtime') {
if (settings()->get('update_free_access')) {
Gábor Hojtsy
committed
$requirements['update access'] = array(
'value' => $t('Not protected'),
'severity' => REQUIREMENT_ERROR,
'description' => $t('The update.php script is accessible to everyone without authentication check, which is a security risk. You must change the @settings_name value in your settings.php back to FALSE.', array('@settings_name' => '$settings[\'update_free_access\']')),
Gábor Hojtsy
committed
);
}
else {
$requirements['update access'] = array(
'value' => $t('Protected'),
);
}
$requirements['update access']['title'] = $t('Access to update.php');
}
// Display an error if a newly introduced dependency in a module is not resolved.
if ($phase == 'update') {
Angie Byron
committed
$profile = drupal_get_profile();
$files = system_rebuild_module_data();
foreach ($files as $module => $file) {
Jennifer Hodgdon
committed
// Ignore disabled modules and installation profiles.
Angie Byron
committed
if (!$file->status || $module == $profile) {
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
continue;
}
// Check the module's PHP version.
$name = $file->info['name'];
$php = $file->info['php'];
if (version_compare($php, PHP_VERSION, '>')) {
$requirements['php']['description'] .= $t('@name requires at least PHP @version.', array('@name' => $name, '@version' => $php));
$requirements['php']['severity'] = REQUIREMENT_ERROR;
}
// Check the module's required modules.
foreach ($file->requires as $requirement) {
$required_module = $requirement['name'];
// Check if the module exists.
if (!isset($files[$required_module])) {
$requirements["$module-$required_module"] = array(
'title' => $t('Unresolved dependency'),
'description' => $t('@name requires this module.', array('@name' => $name)),
'value' => t('@required_name (Missing)', array('@required_name' => $required_module)),
'severity' => REQUIREMENT_ERROR,
);
continue;
}
// Check for an incompatible version.
$required_file = $files[$required_module];
$required_name = $required_file->info['name'];
$version = str_replace(DRUPAL_CORE_COMPATIBILITY . '-', '', $required_file->info['version']);
$compatibility = drupal_check_incompatibility($requirement, $version);
if ($compatibility) {
$compatibility = rtrim(substr($compatibility, 2), ')');
$requirements["$module-$required_module"] = array(
'title' => $t('Unresolved dependency'),
'description' => $t('@name requires this module and version. Currently using @required_name version @version', array('@name' => $name, '@required_name' => $required_name, '@version' => $version)),
'value' => t('@required_name (Version @compatibility required)', array('@required_name' => $required_name, '@compatibility' => $compatibility)),
'severity' => REQUIREMENT_ERROR,
);
continue;
}
}
}
}
Steven Wittens
committed
// Test Unicode library
Nate Lampton
committed
include_once DRUPAL_ROOT . '/core/includes/unicode.inc';
Steven Wittens
committed
$requirements = array_merge($requirements, unicode_requirements());
Gábor Hojtsy
committed
if ($phase == 'runtime') {
Dries Buytaert
committed
// Check for update status module.
Gábor Hojtsy
committed
if (!module_exists('update')) {
$requirements['update status'] = array(
'value' => $t('Not enabled'),
Dries Buytaert
committed
'severity' => REQUIREMENT_WARNING,
'description' => $t('Update notifications are not enabled. It is <strong>highly recommended</strong> that you enable the Update Manager module from the <a href="@module">module administration page</a> in order to stay up-to-date on new releases. For more information, <a href="@update">Update status handbook page</a>.', array('@update' => 'http://drupal.org/documentation/modules/update', '@module' => url('admin/modules'))),
Gábor Hojtsy
committed
);
}
else {
$requirements['update status'] = array(
'value' => $t('Enabled'),
);
}
$requirements['update status']['title'] = $t('Update notifications');
}
Steven Wittens
committed
return $requirements;
}
Dries Buytaert
committed
* Implements hook_install().
Dries Buytaert
committed
function system_install() {
// Enable and set the default theme. Can't use theme_enable() this early in
Dries Buytaert
committed
// installation.
config_install_default_config('theme', 'stark');
config('system.theme')
->set('default', 'stark')
->save();
// Populate the cron key state variable.
Angie Byron
committed
$cron_key = Crypt::randomStringHashed(55);
state()->set('system.cron_key', $cron_key);
Dries Buytaert
committed
}
Dries Buytaert
committed
/**
Dries Buytaert
committed
* Implements hook_schema().
Dries Buytaert
committed
*/
function system_schema() {
// NOTE: {variable} needs to be created before all other tables, as
// some database drivers, e.g. Oracle and DB2, will require variable_get()
// and variable_set() for overcoming some database specific limitations.
$schema['variable'] = array(
Dries Buytaert
committed
'description' => 'Named variable/value pairs created by Drupal core or any other module or theme. All variables are cached in memory at the start of every Drupal request so developers should not be careless about what is stored here.',
Dries Buytaert
committed
'fields' => array(
'name' => array(
Dries Buytaert
committed
'description' => 'The name of the variable.',
'type' => 'varchar',
'length' => 128,
'not null' => TRUE,
'default' => '',
),
'value' => array(
Dries Buytaert
committed
'description' => 'The value of the variable.',
Dries Buytaert
committed
'type' => 'blob',
'not null' => TRUE,
'size' => 'big',
Dries Buytaert
committed
'primary key' => array('name'),
Dries Buytaert
committed
$schema['batch'] = array(
Dries Buytaert
committed
'description' => 'Stores details about batches (processes that run in multiple HTTP requests).',
Dries Buytaert
committed
'fields' => array(
'bid' => array(
Dries Buytaert
committed
'description' => 'Primary Key: Unique batch ID.',
// This is not a serial column, to allow both progressive and
// non-progressive batches. See batch_process().
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
),
'token' => array(
Dries Buytaert
committed
'description' => "A string token generated against the current user's session id and the batch id, used to ensure that only the user who submitted the batch can effectively access it.",
'type' => 'varchar',
'length' => 64,
'not null' => TRUE,
),
'timestamp' => array(
Dries Buytaert
committed
'description' => 'A Unix timestamp indicating when this batch was submitted for processing. Stale batches are purged at cron time.',
'type' => 'int',
'not null' => TRUE,
),
'batch' => array(
Dries Buytaert
committed
'description' => 'A serialized array containing the processing data for the batch.',
Dries Buytaert
committed
'type' => 'blob',
'not null' => FALSE,
'size' => 'big',
Dries Buytaert
committed
'primary key' => array('bid'),
'indexes' => array(
'token' => array('token'),
),
);
Dries Buytaert
committed
$schema['flood'] = array(
Dries Buytaert
committed
'description' => 'Flood controls the threshold of events, such as the number of contact attempts.',
Dries Buytaert
committed
'fields' => array(
'fid' => array(
Dries Buytaert
committed
'description' => 'Unique flood event ID.',
'type' => 'serial',
'not null' => TRUE,
),
'event' => array(
Dries Buytaert
committed
'description' => 'Name of event (e.g. contact).',
'type' => 'varchar',
'length' => 64,
'not null' => TRUE,
'default' => '',
),
'identifier' => array(
'description' => 'Identifier of the visitor, such as an IP address or hostname.',
'type' => 'varchar',
'length' => 128,
'not null' => TRUE,
'default' => '',
),
'timestamp' => array(
Dries Buytaert
committed
'description' => 'Timestamp of the event.',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
Dries Buytaert
committed
'expiration' => array(
'description' => 'Expiration timestamp. Expired events are purged on cron run.',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
),
Dries Buytaert
committed
'primary key' => array('fid'),
Dries Buytaert
committed
'indexes' => array(
'allow' => array('event', 'identifier', 'timestamp'),
Dries Buytaert
committed
'purge' => array('expiration'),
Dries Buytaert
committed
),
Dries Buytaert
committed
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
$schema['key_value'] = array(
'description' => 'Generic key-value storage table. See state() for an example.',
'fields' => array(
'collection' => array(
'description' => 'A named collection of key and value pairs.',
'type' => 'varchar',
'length' => 128,
'not null' => TRUE,
'default' => '',
),
'name' => array(
'description' => 'The key of the key-value pair. As KEY is a SQL reserved keyword, name was chosen instead.',
'type' => 'varchar',
'length' => 128,
'not null' => TRUE,
'default' => '',
),
'value' => array(
'description' => 'The value.',
'type' => 'blob',
'not null' => TRUE,
'size' => 'big',
),
),
'primary key' => array('collection', 'name'),
);
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
$schema['key_value_expire'] = array(
'description' => 'Generic key/value storage table with an expiration.',
'fields' => array(
'collection' => array(
'description' => 'A named collection of key and value pairs.',
'type' => 'varchar',
'length' => 128,
'not null' => TRUE,
'default' => '',
),
'name' => array(
// KEY is an SQL reserved word, so use 'name' as the key's field name.
'description' => 'The key of the key/value pair.',
'type' => 'varchar',
'length' => 128,
'not null' => TRUE,
'default' => '',
),
'value' => array(
'description' => 'The value of the key/value pair.',
'type' => 'blob',
'not null' => TRUE,
'size' => 'big',
),
'expire' => array(
'description' => 'The time since Unix epoch in seconds when this item expires. Defaults to the maximum possible time.',
'type' => 'int',
'not null' => TRUE,
'default' => 2147483647,
),
),
'primary key' => array('collection', 'name'),
'indexes' => array(
'all' => array('name', 'collection', 'expire'),
),
);
Dries Buytaert
committed
$schema['menu_router'] = array(
Dries Buytaert
committed
'description' => 'Maps paths to various callbacks (access, page and title)',
Dries Buytaert
committed
'fields' => array(
'path' => array(
Dries Buytaert
committed
'description' => 'Primary Key: the Drupal path this entry describes',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
),
'load_functions' => array(
Dries Buytaert
committed
'description' => 'A serialized array of function names (like node_load) to be called to load an object corresponding to a part of the current path.',
Dries Buytaert
committed
'type' => 'blob',
'not null' => TRUE,
'to_arg_functions' => array(
Dries Buytaert
committed
'description' => 'A serialized array of function names (like user_uid_optional_to_arg) to be called to replace a part of the router path with another string.',
Dries Buytaert
committed
'type' => 'blob',
'not null' => TRUE,
'access_callback' => array(
Dries Buytaert
committed
'description' => 'The callback which determines the access to this router path. Defaults to user_access.',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
),
'access_arguments' => array(
Dries Buytaert
committed
'description' => 'A serialized array of arguments for the access callback.',
Dries Buytaert
committed
'type' => 'blob',
'not null' => FALSE,
),
'page_callback' => array(
Dries Buytaert
committed
'description' => 'The name of the function that renders the page.',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
),
'page_arguments' => array(
Dries Buytaert
committed
'description' => 'A serialized array of arguments for the page callback.',
Dries Buytaert
committed
'type' => 'blob',
'not null' => FALSE,
),
'fit' => array(
Dries Buytaert
committed
'description' => 'A numeric representation of how specific the path is.',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
),
'number_parts' => array(
Dries Buytaert
committed
'description' => 'Number of parts in this router path.',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'size' => 'small',
),
Angie Byron
committed
'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,
),
'tab_parent' => array(
Dries Buytaert
committed
'description' => 'Only for local tasks (tabs) - the router path of the parent page (which may also be a local task).',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
),
'tab_root' => array(
Dries Buytaert
committed
'description' => 'Router path of the closest non-tab parent page. For pages that are not local tasks, this will be the same as the path.',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
),
'title' => array(
Dries Buytaert
committed
'description' => 'The title for the current page, or the title for the tab if this is a local task.',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
),
'title_callback' => array(
Dries Buytaert
committed
'description' => 'A function which will alter the title. Defaults to t()',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
),
'title_arguments' => array(
Dries Buytaert
committed
'description' => 'A serialized array of arguments for the title callback. If empty, the title will be used as the sole argument for the title callback.',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
),
Dries Buytaert
committed
'theme_callback' => array(
'description' => 'A function which returns the name of the theme that will be used to render this page. If left empty, the default theme will be used.',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
),
'theme_arguments' => array(
'description' => 'A serialized array of arguments for the theme callback.',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
),
'type' => array(
Dries Buytaert
committed
'description' => 'Numeric representation of the type of the menu item, like MENU_LOCAL_TASK.',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
),
'description' => array(
Dries Buytaert
committed
'description' => 'A description of this item.',
'type' => 'text',
'not null' => TRUE,
),
catch
committed
'description_callback' => array(
'description' => 'A function which will alter the description. Defaults to t().',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
),
'description_arguments' => array(
'description' => 'A serialized array of arguments for the description callback. If empty, the description will be used as the sole argument for the description callback.',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
),
'position' => array(
Dries Buytaert
committed
'description' => 'The position of the block (left or right) on the system administration page for this item.',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
),
'weight' => array(
Dries Buytaert
committed
'description' => 'Weight of the element. Lighter weights are higher up, heavier weights go down.',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
),
Dries Buytaert
committed
'include_file' => array(
'description' => 'The file to include for this element, usually the page callback function lives in this file.',
'type' => 'text',
Dries Buytaert
committed
'size' => 'medium',
),
Angie Byron
committed
'route_name' => array(
'description' => 'The machine name of a defined Symfony Route this menu item represents.',
'type' => 'varchar',
'length' => 255,
),
Dries Buytaert
committed
'indexes' => array(
'fit' => array('fit'),
Dries Buytaert
committed
'tab_parent' => array(array('tab_parent', 64), 'weight', 'title'),
Angie Byron
committed
'tab_root_weight_title' => array(array('tab_root', 64), 'weight', 'title'),
Dries Buytaert
committed
'primary key' => array('path'),
Dries Buytaert
committed
Dries Buytaert
committed
$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',
Dries Buytaert
committed
'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
),
);
Larry Garfield
committed
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
$schema['router'] = array(
'description' => 'Maps paths to various callbacks (access, page and title)',
'fields' => array(
'name' => array(
'description' => 'Primary Key: Machine name of this route',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
),
'pattern' => array(
'description' => 'The path pattern for this URI',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
),
'pattern_outline' => array(
'description' => 'The pattern',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
),
'route_set' => array(
'description' => 'The route set grouping to which a route belongs.',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
),
'fit' => array(
'description' => 'A numeric representation of how specific the path is.',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
),
'route' => array(
'description' => 'A serialized Route object',
'type' => 'text',
),
'number_parts' => array(
'description' => 'Number of parts in this router path.',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'size' => 'small',
),
),
'indexes' => array(
'fit' => array('fit'),
'pattern_outline' => array('pattern_outline'),
'route_set' => array('route_set'),
),
'primary key' => array('name'),
);
Dries Buytaert
committed
$schema['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(