system.install 74.1 KB
Newer Older
Dries's avatar
 
Dries committed
1
<?php
2

3 4 5 6
/**
 * @file
 * Install, update and uninstall functions for the system module.
 */
7

8
use Drupal\Component\Utility\Crypt;
9
use Drupal\Component\Uuid\Uuid;
10 11 12
use Drupal\Core\Config\FileStorage;
use Drupal\Core\Database\Database;
use Drupal\Core\Language\Language;
13

14 15
/**
 * Test and report Drupal installation requirements.
16 17 18 19 20
 *
 * @param $phase
 *   The current system installation phase.
 * @return
 *   An array of system requirements.
21 22
 */
function system_requirements($phase) {
23
  global $base_url;
24 25 26 27 28
  $requirements = array();

  // Report Drupal version
  if ($phase == 'runtime') {
    $requirements['drupal'] = array(
29
      'title' => t('Drupal'),
30
      'value' => VERSION,
Steven Wittens's avatar
Steven Wittens committed
31 32
      'severity' => REQUIREMENT_INFO,
      'weight' => -10,
33
    );
34

35 36
    // Display the currently active installation profile, if the site
    // is not running the default installation profile.
37
    $profile = drupal_get_profile();
38
    if ($profile != 'standard') {
39
      $info = system_get_info('module', $profile);
40
      $requirements['install_profile'] = array(
41 42
        'title' => t('Installation profile'),
        'value' => t('%profile_name (%profile-%version)', array(
43 44 45 46 47 48 49
          '%profile_name' => $info['name'],
          '%profile' => $profile,
          '%version' => $info['version']
        )),
        'severity' => REQUIREMENT_INFO,
        'weight' => -9
      );
50
    }
51 52
  }

53
  // Web server information.
Steven Wittens's avatar
Steven Wittens committed
54
  $software = $_SERVER['SERVER_SOFTWARE'];
55
  $requirements['webserver'] = array(
56
    'title' => t('Web server'),
Steven Wittens's avatar
Steven Wittens committed
57
    'value' => $software,
58 59
  );

60 61 62 63
  // Test PHP version and show link to phpinfo() if it's available
  $phpversion = phpversion();
  if (function_exists('phpinfo')) {
    $requirements['php'] = array(
64 65
      'title' => t('PHP'),
      'value' => ($phase == 'runtime') ? $phpversion .' ('. l(t('more information'), 'admin/reports/status/php') .')' : $phpversion,
66 67 68 69
    );
  }
  else {
    $requirements['php'] = array(
70
      'title' => t('PHP'),
71
      'value' => $phpversion,
72
      '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')),
73 74 75 76 77
      'severity' => REQUIREMENT_INFO,
    );
  }

  if (version_compare($phpversion, DRUPAL_MINIMUM_PHP) < 0) {
78
    $requirements['php']['description'] = t('Your PHP installation is too old. Drupal requires at least PHP %version.', array('%version' => DRUPAL_MINIMUM_PHP));
79
    $requirements['php']['severity'] = REQUIREMENT_ERROR;
80 81
    // If PHP is old, it's not safe to continue with the requirements check.
    return $requirements;
82
  }
83

84 85
  // Test PHP register_globals setting.
  $requirements['php_register_globals'] = array(
86
    'title' => t('PHP register globals'),
87 88
  );
  $register_globals = trim(ini_get('register_globals'));
89
  // Unfortunately, ini_get() may return many different values, and we can't
90 91 92 93 94
  // 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') {
95
    $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'));
96
    $requirements['php_register_globals']['severity'] = REQUIREMENT_ERROR;
97
    $requirements['php_register_globals']['value'] = t("Enabled ('@value')", array('@value' => $register_globals));
98 99
  }
  else {
100
    $requirements['php_register_globals']['value'] = t('Disabled');
101
  }
102

103 104
  // Test for PHP extensions.
  $requirements['php_extensions'] = array(
105
    'title' => t('PHP extensions'),
106
  );
107 108 109 110 111 112 113 114 115 116 117 118 119 120

  $missing_extensions = array();
  $required_extensions = array(
    'date',
    'dom',
    'filter',
    'gd',
    'hash',
    'json',
    'pcre',
    'pdo',
    'session',
    'SimpleXML',
    'SPL',
121
    'tokenizer',
122 123 124 125 126 127 128 129 130
    'xml',
  );
  foreach ($required_extensions as $extension) {
    if (!extension_loaded($extension)) {
      $missing_extensions[] = $extension;
    }
  }

  if (!empty($missing_extensions)) {
131
    $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(
132 133 134
      '@system_requirements' => 'http://drupal.org/requirements',
    ));

135
    $description .= theme('item_list', array('items' => $missing_extensions));
136

137
    $requirements['php_extensions']['value'] = t('Disabled');
138 139
    $requirements['php_extensions']['severity'] = REQUIREMENT_ERROR;
    $requirements['php_extensions']['description'] = $description;
140 141
  }
  else {
142
    $requirements['php_extensions']['value'] = t('Enabled');
143
  }
144

145 146 147
  if ($phase == 'install' || $phase == 'update') {
    // Test for PDO (database).
    $requirements['database_extensions'] = array(
148
      'title' => t('Database support'),
149
    );
150

151
    // Make sure PDO is available.
152
    $database_ok = extension_loaded('pdo');
153
    if (!$database_ok) {
154
      $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(
155 156 157 158 159
        '@link' => 'http://drupal.org/requirements/pdo',
      ));
    }
    else {
      // Make sure at least one supported database driver exists.
160
      $drivers = drupal_detect_database_types();
161 162
      if (empty($drivers)) {
        $database_ok = FALSE;
163
        $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(
164 165 166 167 168 169 170
          '@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;
171
        $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(
172 173 174
          '@link' => 'http://drupal.org/requirements/pdo#pecl',
        ));
      }
175
    }
176

177
    if (!$database_ok) {
178
      $requirements['database_extensions']['value'] = t('Disabled');
179
      $requirements['database_extensions']['severity'] = REQUIREMENT_ERROR;
180
      $requirements['database_extensions']['description'] = $pdo_message;
181 182
    }
    else {
183
      $requirements['database_extensions']['value'] = t('Enabled');
184
    }
185
  }
186 187
  else {
    // Database information.
188
    $class = Database::getConnection()->getDriverClass('Install\\Tasks');
189 190
    $tasks = new $class();
    $requirements['database_system'] = array(
191
      'title' => t('Database system'),
192 193 194
      'value' => $tasks->name(),
    );
    $requirements['database_system_version'] = array(
195
      'title' => t('Database system version'),
196 197 198
      'value' => Database::getConnection()->version(),
    );
  }
199

200
  // Test PHP memory_limit
201
  $memory_limit = ini_get('memory_limit');
202
  $requirements['php_memory_limit'] = array(
203
    'title' => t('PHP memory limit'),
204
    'value' => $memory_limit == -1 ? t('-1 (Unlimited)') : $memory_limit,
205
  );
206

207
  if (!drupal_check_memory_limit(DRUPAL_MINIMUM_PHP_MEMORY_LIMIT, $memory_limit)) {
208 209
    $description = '';
    if ($phase == 'install') {
210
      $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));
211 212
    }
    elseif ($phase == 'update') {
213
      $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));
214
    }
215
    elseif ($phase == 'runtime') {
216
      $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));
217
    }
218

219 220
    if (!empty($description)) {
      if ($php_ini_path = get_cfg_var('cfg_file_path')) {
221
        $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));
222 223
      }
      else {
224
        $description .= ' ' . t('Contact your system administrator or hosting provider for assistance with increasing your PHP memory limit.');
225
      }
226

227
      $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'));
228
      $requirements['php_memory_limit']['severity'] = REQUIREMENT_WARNING;
229
    }
230
  }
231

232
  // Test configuration files and directory for writability.
233
  if ($phase == 'runtime') {
234 235 236
    $conf_errors = array();
    $conf_path = conf_path();
    if (!drupal_verify_install_file($conf_path, FILE_NOT_WRITABLE, 'dir')) {
237
      $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));
238 239 240 241
    }
    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)) {
242
        $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));
243 244 245 246 247 248 249 250 251
      }
    }
    if (!empty($conf_errors)) {
      if (count($conf_errors) == 1) {
        $description = $conf_errors[0];
      }
      else {
        $description = theme('item_list', array('items' => $conf_errors));
      }
252
      $requirements['settings.php'] = array(
253
        'value' => t('Not protected'),
254
        'severity' => REQUIREMENT_ERROR,
255
        'description' => $description,
256 257 258 259
      );
    }
    else {
      $requirements['settings.php'] = array(
260
        'value' => t('Protected'),
261 262
      );
    }
263
    $requirements['settings.php']['title'] = t('Configuration files');
264 265
  }

266
  // Report cron status.
267
  if ($phase == 'runtime') {
268
    $cron_config = config('system.cron');
269
    // Cron warning threshold defaults to two days.
270
    $threshold_warning = $cron_config->get('threshold.requirements_warning');
271
    // Cron error threshold defaults to two weeks.
272
    $threshold_error = $cron_config->get('threshold.requirements_error');
273
    // Cron configuration help text.
274
    $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'));
275

276
    // Determine when cron last ran.
277
    $cron_last = Drupal::state()->get('system.cron_last');
278
    if (!is_numeric($cron_last)) {
279
      $cron_last = variable_get('install_time', 0);
280
    }
281

282
    // Determine severity based on time since cron last ran.
283
    $severity = REQUIREMENT_INFO;
284
    if (REQUEST_TIME - $cron_last > $threshold_error) {
285
      $severity = REQUIREMENT_ERROR;
286
    }
287
    elseif (REQUEST_TIME - $cron_last > $threshold_warning) {
288 289 290 291
      $severity = REQUIREMENT_WARNING;
    }

    // Set summary and description based on values determined above.
292
    $summary = t('Last run !time ago', array('!time' => format_interval(REQUEST_TIME - $cron_last)));
293
    $description = '';
294
    if ($severity != REQUIREMENT_INFO) {
295
      $description = t('Cron has not run recently.') . ' ' . $help;
296
    }
297

298 299
    $description .= ' ' . t('You can <a href="@cron">run cron manually</a>.', array('@cron' => url('admin/reports/status/run-cron')));
    $description .= '<br />' . t('To run cron from outside the site, go to <a href="!cron">!cron</a>', array('!cron' => url('cron/' . Drupal::state()->get('system.cron_key'), array('absolute' => TRUE))));
300

301
    $requirements['cron'] = array(
302
      'title' => t('Cron maintenance tasks'),
303 304
      'severity' => $severity,
      'value' => $summary,
305
      'description' => $description
306
    );
307
  }
308 309 310 311 312 313 314 315 316 317
  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(),
    );
  }
318

319 320
  // During an install we need to make assumptions about the file system
  // unless overrides are provided in settings.php.
321
  if ($phase == 'install') {
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
    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();
    }
344 345
  }

346 347 348
  // 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.
349 350 351
  if (!empty($GLOBALS['config_directories'])) {
    $directories[] = config_get_config_directory(CONFIG_ACTIVE_DIRECTORY);
    $directories[] = config_get_config_directory(CONFIG_STAGING_DIRECTORY);
352 353
  }
  elseif ($phase != 'install') {
354
    $requirements['config directories'] = array(
355 356 357
      'title' => t('Configuration directories'),
      'value' => t('Not present'),
      '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')),
358 359 360 361
      'severity' => REQUIREMENT_ERROR,
    );
  }

362
  $requirements['file system'] = array(
363
    'title' => t('File system'),
364
  );
365

366 367 368
  $error = '';
  // For installer, create the directories if possible.
  foreach ($directories as $directory) {
369 370 371
    if (!$directory) {
      continue;
    }
372
    if ($phase == 'install') {
373
      file_prepare_directory($directory, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);
374
    }
375 376 377 378
    $is_writable = is_writable($directory);
    $is_directory = is_dir($directory);
    if (!$is_writable || !$is_directory) {
      $description = '';
379
      $requirements['file system']['value'] = t('Not writable');
380
      if (!$is_directory) {
381
        $error .= t('The directory %directory does not exist.', array('%directory' => $directory)) . ' ';
382 383
      }
      else {
384
        $error .= t('The directory %directory is not writable.', array('%directory' => $directory)) . ' ';
385 386 387
      }
      // The files directory requirement check is done only during install and runtime.
      if ($phase == 'runtime') {
388
        $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')));
389 390 391 392
      }
      elseif ($phase == 'install') {
        // For the installer UI, we need different wording. 'value' will
        // be treated as version, so provide none there.
393
        $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'));
394 395 396 397 398 399
        $requirements['file system']['value'] = '';
      }
      if (!empty($description)) {
        $requirements['file system']['description'] = $description;
        $requirements['file system']['severity'] = REQUIREMENT_ERROR;
      }
400 401
    }
    else {
402 403 404
      // This function can be called before the config_cache table has been
      // created.
      if ($phase == 'install' || file_default_scheme() == 'public') {
405
        $requirements['file system']['value'] = t('Writable (<em>public</em> download method)');
406 407
      }
      else {
408
        $requirements['file system']['value'] = t('Writable (<em>private</em> download method)');
409
      }
410 411 412
    }
  }

413 414 415
  // See if updates are available in update.php.
  if ($phase == 'runtime') {
    $requirements['update'] = array(
416 417
      'title' => t('Database updates'),
      'value' => t('Up to date'),
418 419 420
    );

    // Check installed modules.
421
    foreach (Drupal::moduleHandler()->getModuleList() as $module => $filename) {
422 423 424 425 426
      $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;
427 428
          $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() . 'core/update.php'));
429 430 431 432 433 434
          break;
        }
      }
    }
  }

435 436
  // Verify the update.php access setting
  if ($phase == 'runtime') {
437
    if (settings()->get('update_free_access')) {
438
      $requirements['update access'] = array(
439
        'value' => t('Not protected'),
440
        'severity' => REQUIREMENT_ERROR,
441
        '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\']')),
442 443 444 445
      );
    }
    else {
      $requirements['update access'] = array(
446
        'value' => t('Protected'),
447 448
      );
    }
449
    $requirements['update access']['title'] = t('Access to update.php');
450 451
  }

452 453
  // Display an error if a newly introduced dependency in a module is not resolved.
  if ($phase == 'update') {
454
    $profile = drupal_get_profile();
455 456
    $files = system_rebuild_module_data();
    foreach ($files as $module => $file) {
457
      // Ignore disabled modules and installation profiles.
458
      if (!$file->status || $module == $profile) {
459 460 461 462 463 464
        continue;
      }
      // Check the module's PHP version.
      $name = $file->info['name'];
      $php = $file->info['php'];
      if (version_compare($php, PHP_VERSION, '>')) {
465
        $requirements['php']['description'] .= t('@name requires at least PHP @version.', array('@name' => $name, '@version' => $php));
466 467 468 469 470 471 472 473
        $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(
474 475
            'title' => t('Unresolved dependency'),
            'description' => t('@name requires this module.', array('@name' => $name)),
476 477 478 479 480 481 482 483 484 485 486 487 488
            '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(
489 490
            '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)),
491 492 493 494 495 496 497 498 499
            'value' => t('@required_name (Version @compatibility required)', array('@required_name' => $required_name, '@compatibility' => $compatibility)),
            'severity' => REQUIREMENT_ERROR,
          );
          continue;
        }
      }
    }
  }

500
  // Test Unicode library
501
  include_once DRUPAL_ROOT . '/core/includes/unicode.inc';
502 503
  $requirements = array_merge($requirements, unicode_requirements());

504
  if ($phase == 'runtime') {
505
    // Check for update status module.
506 507
    if (!module_exists('update')) {
      $requirements['update status'] = array(
508
        'value' => t('Not enabled'),
509
        'severity' => REQUIREMENT_WARNING,
510
        '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'))),
511 512 513 514
      );
    }
    else {
      $requirements['update status'] = array(
515
        'value' => t('Enabled'),
516 517
      );
    }
518
    $requirements['update status']['title'] = t('Update notifications');
519 520
  }

521 522 523
  return $requirements;
}

524
/**
525
 * Implements hook_install().
526
 */
527
function system_install() {
528
  // Enable and set the default theme. Can't use theme_enable() this early in
529 530
  // installation.
  config_install_default_config('theme', 'stark');
531 532 533
  config('system.theme')
    ->set('default', 'stark')
    ->save();
534

535
  // Populate the cron key state variable.
536
  $cron_key = Crypt::randomStringHashed(55);
537
  Drupal::state()->set('system.cron_key', $cron_key);
538 539
}

540
/**
541
 * Implements hook_schema().
542 543 544 545 546 547
 */
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(
548
    '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.',
549
    'fields' => array(
550
      'name' => array(
551
        'description' => 'The name of the variable.',
552 553 554
        'type' => 'varchar',
        'length' => 128,
        'not null' => TRUE,
555 556
        'default' => '',
      ),
557
      'value' => array(
558
        'description' => 'The value of the variable.',
559
        'type' => 'blob',
560
        'not null' => TRUE,
561
        'size' => 'big',
562
      ),
563
    ),
564
    'primary key' => array('name'),
565
  );
566 567

  $schema['batch'] = array(
568
    'description' => 'Stores details about batches (processes that run in multiple HTTP requests).',
569
    'fields' => array(
570
      'bid' => array(
571
        'description' => 'Primary Key: Unique batch ID.',
572 573 574
        // This is not a serial column, to allow both progressive and
        // non-progressive batches. See batch_process().
        'type' => 'int',
575
        'unsigned' => TRUE,
576 577
        'not null' => TRUE,
      ),
578
      'token' => array(
579
        '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.",
580 581
        'type' => 'varchar',
        'length' => 64,
582 583
        'not null' => TRUE,
      ),
584
      'timestamp' => array(
585
        'description' => 'A Unix timestamp indicating when this batch was submitted for processing. Stale batches are purged at cron time.',
586
        'type' => 'int',
587 588
        'not null' => TRUE,
      ),
589
      'batch' => array(
590
        'description' => 'A serialized array containing the processing data for the batch.',
591
        'type' => 'blob',
592
        'not null' => FALSE,
593
        'size' => 'big',
594
      ),
595
    ),
596
    'primary key' => array('bid'),
597 598 599 600
    'indexes' => array(
      'token' => array('token'),
    ),
  );
601 602

  $schema['flood'] = array(
603
    'description' => 'Flood controls the threshold of events, such as the number of contact attempts.',
604
    'fields' => array(
605
      'fid' => array(
606
        'description' => 'Unique flood event ID.',
607
        'type' => 'serial',
608 609
        'not null' => TRUE,
      ),
610
      'event' => array(
611
        'description' => 'Name of event (e.g. contact).',
612 613 614
        'type' => 'varchar',
        'length' => 64,
        'not null' => TRUE,
615 616
        'default' => '',
      ),
617 618
      'identifier' => array(
        'description' => 'Identifier of the visitor, such as an IP address or hostname.',
619 620 621
        'type' => 'varchar',
        'length' => 128,
        'not null' => TRUE,
622 623
        'default' => '',
      ),
624
      'timestamp' => array(
625
        'description' => 'Timestamp of the event.',
626 627
        'type' => 'int',
        'not null' => TRUE,
628
        'default' => 0,
629
      ),
630 631 632 633 634 635
      'expiration' => array(
        'description' => 'Expiration timestamp. Expired events are purged on cron run.',
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
      ),
636
    ),
637
    'primary key' => array('fid'),
638
    'indexes' => array(
639
      'allow' => array('event', 'identifier', 'timestamp'),
640
      'purge' => array('expiration'),
641
    ),
642
  );
643

644
  $schema['key_value'] = array(
645
    'description' => 'Generic key-value storage table. See the state system for an example.',
646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670
    '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'),
  );

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 707
  $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'),
    ),
  );

708
  $schema['menu_router'] = array(
709
    'description' => 'Maps paths to various callbacks (access, page and title)',
710
    'fields' => array(
711
      'path' => array(
712
        'description' => 'Primary Key: the Drupal path this entry describes',
713 714 715
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
716 717
        'default' => '',
      ),
718
      'load_functions' => array(
719
        '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.',
720
        'type' => 'blob',
721
        'not null' => TRUE,
722
      ),
723
      'to_arg_functions' => array(
724
        '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.',
725
        'type' => 'blob',
726
        'not null' => TRUE,
727
      ),
728
      'access_callback' => array(
729
        'description' => 'The callback which determines the access to this router path. Defaults to user_access.',
730 731 732
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
733 734
        'default' => '',
      ),
735
      'access_arguments' => array(
736
        'description' => 'A serialized array of arguments for the access callback.',
737
        'type' => 'blob',
738 739
        'not null' => FALSE,
      ),
740
      'page_callback' => array(
741
        'description' => 'The name of the function that renders the page.',
742 743 744
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
745 746
        'default' => '',
      ),
747
      'page_arguments' => array(
748
        'description' => 'A serialized array of arguments for the page callback.',
749
        'type' => 'blob',
750 751
        'not null' => FALSE,
      ),
752
      'fit' => array(
753
        'description' => 'A numeric representation of how specific the path is.',
754 755
        'type' => 'int',
        'not null' => TRUE,
756 757
        'default' => 0,
      ),
758
      'number_parts' => array(
759
        'description' => 'Number of parts in this router path.',
760 761 762
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
763 764
        'size' => 'small',
      ),
765 766 767 768 769 770
      '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,
      ),
Gábor Hojtsy's avatar