Newer
Older
Dries Buytaert
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();
// Ensure translations don't break at install time
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
// Display the currently active install profile, if the site
// is not running the default install profile.
$profile = drupal_get_profile();
Angie Byron
committed
if ($profile != 'standard') {
Angie Byron
committed
$info = install_profile_info($profile);
$requirements['install_profile'] = array(
'title' => $t('Install profile'),
'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') {
$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="http://php.net/configuration.changes">how to change configuration settings</a>.');
$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
);
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
$missing_extensions = array();
$required_extensions = array(
'date',
'dom',
'filter',
'gd',
'hash',
'json',
'pcre',
'pdo',
'session',
'SimpleXML',
'SPL',
'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(
'type' => 'ul',
'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
// Test for PDO (database).
$requirements['database_extensions'] = array(
'title' => $t('Database support'),
Dries Buytaert
committed
);
// Test for at least one suitable PDO extension, if PDO is available.
$database_ok = extension_loaded('pdo');
if ($database_ok) {
$drivers = drupal_detect_database_types();
$database_ok = !empty($drivers);
}
if (!$database_ok) {
$requirements['database_extensions']['value'] = $t('Disabled');
$requirements['database_extensions']['severity'] = REQUIREMENT_ERROR;
$requirements['database_extensions']['description'] = $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',
));
Dries Buytaert
committed
}
else {
$requirements['database_extensions']['value'] = $t('Enabled');
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
Dries Buytaert
committed
if ($memory_limit && $memory_limit != -1 && parse_size($memory_limit) < parse_size(DRUPAL_MINIMUM_PHP_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('See the <a href="@url">Drupal requirements</a> for more information.', array('@url' => 'http://drupal.org/requirements'));
Gábor Hojtsy
committed
$requirements['php_memory_limit']['severity'] = REQUIREMENT_WARNING;
Gábor Hojtsy
committed
}
Gábor Hojtsy
committed
}
Gábor Hojtsy
committed
Steven Wittens
committed
// Test settings.php file writability
if ($phase == 'runtime') {
Gábor Hojtsy
committed
$conf_dir = drupal_verify_install_file(conf_path(), FILE_NOT_WRITABLE, 'dir');
$conf_file = drupal_verify_install_file(conf_path() . '/settings.php', FILE_EXIST|FILE_READABLE|FILE_NOT_WRITABLE);
Gábor Hojtsy
committed
if (!$conf_dir || !$conf_file) {
Steven Wittens
committed
$requirements['settings.php'] = array(
'value' => $t('Not protected'),
'severity' => REQUIREMENT_ERROR,
Gábor Hojtsy
committed
'description' => '',
Steven Wittens
committed
);
Gábor Hojtsy
committed
if (!$conf_dir) {
$requirements['settings.php']['description'] .= $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()));
}
if (!$conf_file) {
$requirements['settings.php']['description'] .= $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' => conf_path() . '/settings.php'));
Gábor Hojtsy
committed
}
Steven Wittens
committed
}
else {
$requirements['settings.php'] = array(
'value' => $t('Protected'),
);
}
$requirements['settings.php']['title'] = $t('Configuration file');
}
Gábor Hojtsy
committed
// Report cron status.
Steven Wittens
committed
if ($phase == 'runtime') {
Gábor Hojtsy
committed
// Cron warning threshold defaults to two days.
$threshold_warning = variable_get('cron_threshold_warning', 172800);
// Cron error threshold defaults to two weeks.
$threshold_error = variable_get('cron_threshold_error', 1209600);
// 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 = variable_get('cron_last');
Gábor Hojtsy
committed
if (!is_numeric($cron_last)) {
$cron_last = variable_get('install_time', 0);
}
Steven Wittens
committed
Gábor Hojtsy
committed
// Determine severity based on time since cron last ran.
$severity = REQUIREMENT_OK;
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_OK) {
$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')));
Dries Buytaert
committed
$description .= '<br />' . $t('To run cron from outside the site, go to <a href="!cron">!cron</a>', array('!cron' => url($base_url . '/cron.php', array('external' => TRUE, 'query' => array('cron_key' => variable_get('cron_key', 'drupal'))))));
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
}
// Test files directories.
$directories = array(
variable_get('file_public_path', conf_path() . '/files'),
Angie Byron
committed
// By default no private files directory is configured. For private files
// to be secure the admin needs to provide a path outside the webroot.
variable_get('file_private_path', FALSE),
);
// Do not check for the temporary files directory at install time
// unless it has been set in settings.php. In this case the user has
// no alternative but to fix the directory if it is not writable.
if ($phase == 'install') {
$directories[] = variable_get('file_temporary_path', FALSE);
}
else {
$directories[] = variable_get('file_temporary_path', file_directory_temp());
}
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);
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 {
if (variable_get('file_default_scheme', 'public') == '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'),
'severity' => REQUIREMENT_OK,
'value' => $t('Up to date'),
);
// Check installed modules.
foreach (module_list() as $module) {
$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');
$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() . 'update.php'));
break;
}
}
}
}
Gábor Hojtsy
committed
// Verify the update.php access setting
if ($phase == 'runtime') {
if (!empty($GLOBALS['update_free_access'])) {
$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 $update_free_access value in your settings.php back to FALSE.'),
);
}
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) {
Angie Byron
committed
// Ignore disabled modules and install profiles.
Angie Byron
committed
if (!$file->status || $module == $profile) {
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
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;
}
// Check for a disabled dependency.
if (!$required_file->status) {
$requirements["$module-$required_module"] = array(
'title' => $t('Unresolved dependency'),
'description' => $t('@name requires this module.', array('@name' => $name)),
'value' => $t('@required_name (Disabled)', array('@required_name' => $required_name)),
'severity' => REQUIREMENT_ERROR,
);
}
}
}
}
Steven Wittens
committed
// Test Unicode library
Angie Byron
committed
include_once DRUPAL_ROOT . '/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 status 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/handbook/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');
Dries Buytaert
committed
// Check that Drupal can issue HTTP requests.
if (variable_get('drupal_http_request_fails', TRUE) && !system_check_http_request()) {
$requirements['http requests'] = array(
'title' => $t('HTTP request status'),
'value' => $t('Fails'),
'severity' => REQUIREMENT_ERROR,
Dries Buytaert
committed
'description' => $t('Your system or network configuration does not allow Drupal to access web pages, resulting in reduced functionality. This could be due to your webserver configuration or PHP settings, and should be resolved in order to download information about available updates, fetch aggregator feeds, sign in via OpenID, or use other network-dependent services. If you are certain that Drupal can access web pages but you are still seeing this message, you may add <code>$conf[\'drupal_http_request_fails\'] = FALSE;</code> to the bottom of your settings.php file.'),
Dries Buytaert
committed
);
}
Gábor Hojtsy
committed
}
Steven Wittens
committed
return $requirements;
}
Dries Buytaert
committed
* Implements hook_install().
Dries Buytaert
committed
function system_install() {
Dries Buytaert
committed
// Create tables.
Dries Buytaert
committed
drupal_install_schema('system');
$versions = drupal_get_schema_versions('system');
$version = $versions ? max($versions) : SCHEMA_INSTALLED;
drupal_set_installed_schema_version('system', $version);
// Clear out module list and hook implementation statics before calling
Angie Byron
committed
// system_rebuild_theme_data().
module_list(TRUE);
module_implements('', FALSE, TRUE);
Dries Buytaert
committed
// Load system theme data appropriately.
Angie Byron
committed
system_rebuild_theme_data();
Dries Buytaert
committed
Dries Buytaert
committed
// Enable the default theme.
variable_set('theme_default', 'garland');
db_update('system')
->fields(array('status' => 1))
->condition('type', 'theme')
->condition('name', 'garland')
->execute();
Dries Buytaert
committed
// Populate the cron key variable.
Dries Buytaert
committed
$cron_key = drupal_hash_base64(drupal_random_bytes(55));
variable_set('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.',
'type' => 'text',
'not null' => TRUE,
'size' => 'big',
Dries Buytaert
committed
'translatable' => TRUE,
Dries Buytaert
committed
'primary key' => array('name'),
Dries Buytaert
committed
$schema['actions'] = array(
Dries Buytaert
committed
'description' => 'Stores action information.',
Dries Buytaert
committed
'fields' => array(
'aid' => array(
Dries Buytaert
committed
'description' => 'Primary Key: Unique actions ID.',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '0',
),
'type' => array(
Dries Buytaert
committed
'description' => 'The object that that action acts on (node, user, comment, system or custom types.)',
'type' => 'varchar',
'length' => 32,
'not null' => TRUE,
'default' => '',
),
'callback' => array(
Dries Buytaert
committed
'description' => 'The callback function that executes when the action runs.',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
),
'parameters' => array(
Dries Buytaert
committed
'description' => 'Parameters to be passed to the callback function.',
'type' => 'text',
'not null' => TRUE,
'size' => 'big',
),
Dries Buytaert
committed
'label' => array(
'description' => 'Label of the action.',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '0',
Dries Buytaert
committed
'primary key' => array('aid'),
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.',
'type' => 'text',
'not null' => FALSE,
'size' => 'big',
Dries Buytaert
committed
'primary key' => array('bid'),
'indexes' => array(
'token' => array('token'),
),
);
Dries Buytaert
committed
Dries Buytaert
committed
$schema['blocked_ips'] = array(
Dries Buytaert
committed
'description' => 'Stores blocked IP addresses.',
Dries Buytaert
committed
'fields' => array(
'iid' => array(
Dries Buytaert
committed
'description' => 'Primary Key: unique ID for IP addresses.',
Dries Buytaert
committed
'type' => 'serial',
'unsigned' => TRUE,
'not null' => TRUE,
),
'ip' => array(
Dries Buytaert
committed
'description' => 'IP address',
Dries Buytaert
committed
'type' => 'varchar',
'length' => 40,
Dries Buytaert
committed
'not null' => TRUE,
'default' => '',
),
),
'indexes' => array(
'blocked_ip' => array('ip'),
),
'primary key' => array('iid'),
);
Dries Buytaert
committed
$schema['cache'] = array(
Dries Buytaert
committed
'description' => 'Generic cache table for caching things not separated out into their own tables. Contributed modules may also use this to store cached items.',
Dries Buytaert
committed
'fields' => array(
'cid' => array(
Dries Buytaert
committed
'description' => 'Primary Key: Unique cache ID.',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
),
'data' => array(
Dries Buytaert
committed
'description' => 'A collection of data to cache.',
'type' => 'blob',
'not null' => FALSE,
'size' => 'big',
),
'expire' => array(
Dries Buytaert
committed
'description' => 'A Unix timestamp indicating when the cache entry should expire, or 0 for never.',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
),
'created' => array(
Dries Buytaert
committed
'description' => 'A Unix timestamp indicating when the cache entry was created.',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
),
'serialized' => array(
Dries Buytaert
committed
'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'),
),
Dries Buytaert
committed
'primary key' => array('cid'),
Dries Buytaert
committed
Dries Buytaert
committed
$schema['cache_bootstrap'] = $schema['cache'];
$schema['cache_bootstrap']['description'] = 'Cache table for data required to bootstrap Drupal, may be routed to a shared memory cache.';
Dries Buytaert
committed
$schema['cache_form'] = $schema['cache'];
Dries Buytaert
committed
$schema['cache_form']['description'] = 'Cache table for the form system to store recently built forms and their storage data, to be used in subsequent page requests.';
Dries Buytaert
committed
$schema['cache_page'] = $schema['cache'];
Dries Buytaert
committed
$schema['cache_page']['description'] = 'Cache table used to store compressed pages for anonymous users, if page caching is enabled.';
Dries Buytaert
committed
$schema['cache_menu'] = $schema['cache'];
Dries Buytaert
committed
$schema['cache_menu']['description'] = 'Cache table for the menu system to store router information as well as generated link trees for various menu/page/user combinations.';
$schema['cache_path'] = $schema['cache'];
$schema['cache_path']['description'] = 'Cache table for path alias lookup.';
Dries Buytaert
committed
Dries Buytaert
committed
$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'),
Dries Buytaert
committed
'indexes' => array(
'title' => array('title'),
),
Dries Buytaert
committed
);
// This table's name is plural as some versions of MySQL can't create a
Dries Buytaert
committed
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
// table named 'date_format'.
$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'),
);
Dries Buytaert
committed
$schema['file_managed'] = array(
Dries Buytaert
committed
'description' => 'Stores information for uploaded files.',
Dries Buytaert
committed
'fields' => array(
'fid' => array(
Dries Buytaert
committed
'description' => 'File ID.',
'type' => 'serial',
'unsigned' => TRUE,
'not null' => TRUE,
),
'uid' => array(
Angie Byron
committed
'description' => 'The {users}.uid of the user who is associated with the file.',
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
),
'filename' => array(
Dries Buytaert
committed
'description' => 'Name of the file with no path components. This may differ from the basename of the filepath if the file is renamed to avoid overwriting an existing file.',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
),
'uri' => array(
Dries Buytaert
committed
'description' => 'Path of the file relative to Drupal root.',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
),
'filemime' => array(
Dries Buytaert
committed
'description' => "The file's MIME type.",
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
),
'filesize' => array(
Dries Buytaert
committed
'description' => 'The size of the file in bytes.',
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
),
'status' => array(
'description' => 'A bitmapped field indicating the status of the file. The least significant bit indicates temporary (0) or permanent (1). Temporary files older than DRUPAL_MAXIMUM_TEMP_FILE_AGE will be removed during a cron run.',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
),
'timestamp' => array(
Dries Buytaert
committed
'description' => 'UNIX timestamp for when the file was added.',
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
Dries Buytaert
committed
'indexes' => array(
'uid' => array('uid'),
'status' => array('status'),
Dries Buytaert
committed
'timestamp' => array('timestamp'),
'unique keys' => array(
'uri' => array('uri'),
),
Dries Buytaert
committed
'primary key' => array('fid'),
'foreign keys' => array(
'uid' => array('users' => 'uid'),
),
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
$schema['history'] = array(
Angie Byron
committed
'description' => 'A record of which {users} have read which {node}s.',
Dries Buytaert
committed
'fields' => array(
'uid' => array(
Angie Byron
committed
'description' => 'The {users}.uid that read the {node} nid.',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
),
'nid' => array(
Dries Buytaert
committed
'description' => 'The {node}.nid that was read.',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
),
'timestamp' => array(
Dries Buytaert
committed
'description' => 'The Unix timestamp at which the read occurred.',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
Dries Buytaert
committed
'primary key' => array('uid', 'nid'),
Dries Buytaert
committed
'indexes' => array(
'nid' => array('nid'),
),
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' => 'text',
'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' => 'text',
'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.',
'type' => 'text',
'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.',
'type' => 'text',
'not null' => FALSE,
),
Dries Buytaert
committed
'delivery_callback' => array(
'description' => 'The name of the function that sends the result of the page_callback function to the browser.',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
),
'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,