system.install 74.9 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
9
10
use Drupal\Component\Utility\Crypt;
use Drupal\Core\Database\Database;
use Drupal\Core\Language\Language;
11
use Drupal\Core\StreamWrapper\PublicStream;
12

13
/**
14
 * Implements hook_requirements().
15
16
 */
function system_requirements($phase) {
17
  global $base_url;
18
19
20
21
22
  $requirements = array();

  // Report Drupal version
  if ($phase == 'runtime') {
    $requirements['drupal'] = array(
23
      'title' => t('Drupal'),
24
      'value' => \Drupal::VERSION,
Steven Wittens's avatar
Steven Wittens committed
25
26
      'severity' => REQUIREMENT_INFO,
      'weight' => -10,
27
    );
28

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

47
  // Web server information.
Steven Wittens's avatar
Steven Wittens committed
48
  $software = $_SERVER['SERVER_SOFTWARE'];
49
  $requirements['webserver'] = array(
50
    'title' => t('Web server'),
Steven Wittens's avatar
Steven Wittens committed
51
    'value' => $software,
52
53
  );

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

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

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

97
98
  // Test for PHP extensions.
  $requirements['php_extensions'] = array(
99
    'title' => t('PHP extensions'),
100
  );
101
102
103
104
105
106
107
108
109
110
111
112
113
114

  $missing_extensions = array();
  $required_extensions = array(
    'date',
    'dom',
    'filter',
    'gd',
    'hash',
    'json',
    'pcre',
    'pdo',
    'session',
    'SimpleXML',
    'SPL',
115
    'tokenizer',
116
117
118
119
120
121
122
123
124
    'xml',
  );
  foreach ($required_extensions as $extension) {
    if (!extension_loaded($extension)) {
      $missing_extensions[] = $extension;
    }
  }

  if (!empty($missing_extensions)) {
125
    $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(
126
127
128
      '@system_requirements' => 'http://drupal.org/requirements',
    ));

129
    $description .= theme('item_list', array('items' => $missing_extensions));
130

131
    $requirements['php_extensions']['value'] = t('Disabled');
132
133
    $requirements['php_extensions']['severity'] = REQUIREMENT_ERROR;
    $requirements['php_extensions']['description'] = $description;
134
135
  }
  else {
136
    $requirements['php_extensions']['value'] = t('Enabled');
137
  }
138

139
140
141
  if ($phase == 'install' || $phase == 'update') {
    // Test for PDO (database).
    $requirements['database_extensions'] = array(
142
      'title' => t('Database support'),
143
    );
144

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

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

194
  // Test PHP memory_limit
195
  $memory_limit = ini_get('memory_limit');
196
  $requirements['php_memory_limit'] = array(
197
    'title' => t('PHP memory limit'),
198
    'value' => $memory_limit == -1 ? t('-1 (Unlimited)') : $memory_limit,
199
  );
200

201
  if (!drupal_check_memory_limit(DRUPAL_MINIMUM_PHP_MEMORY_LIMIT, $memory_limit)) {
202
203
    $description = '';
    if ($phase == 'install') {
204
      $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));
205
206
    }
    elseif ($phase == 'update') {
207
      $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));
208
    }
209
    elseif ($phase == 'runtime') {
210
      $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));
211
    }
212

213
214
    if (!empty($description)) {
      if ($php_ini_path = get_cfg_var('cfg_file_path')) {
215
        $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));
216
217
      }
      else {
218
        $description .= ' ' . t('Contact your system administrator or hosting provider for assistance with increasing your PHP memory limit.');
219
      }
220

221
      $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'));
222
      $requirements['php_memory_limit']['severity'] = REQUIREMENT_WARNING;
223
    }
224
  }
225

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

260
  // Report cron status.
261
  if ($phase == 'runtime') {
262
    $cron_config = \Drupal::config('system.cron');
263
    // Cron warning threshold defaults to two days.
264
    $threshold_warning = $cron_config->get('threshold.requirements_warning');
265
    // Cron error threshold defaults to two weeks.
266
    $threshold_error = $cron_config->get('threshold.requirements_error');
267
    // Cron configuration help text.
268
    $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'));
269

270
    // Determine when cron last ran.
271
    $cron_last = \Drupal::state()->get('system.cron_last');
272
    if (!is_numeric($cron_last)) {
273
      $cron_last = variable_get('install_time', 0);
274
    }
275

276
    // Determine severity based on time since cron last ran.
277
    $severity = REQUIREMENT_INFO;
278
    if (REQUEST_TIME - $cron_last > $threshold_error) {
279
      $severity = REQUIREMENT_ERROR;
280
    }
281
    elseif (REQUEST_TIME - $cron_last > $threshold_warning) {
282
283
284
285
      $severity = REQUIREMENT_WARNING;
    }

    // Set summary and description based on values determined above.
286
    $summary = t('Last run !time ago', array('!time' => format_interval(REQUEST_TIME - $cron_last)));
287
    $description = '';
288
    if ($severity != REQUIREMENT_INFO) {
289
      $description = t('Cron has not run recently.') . ' ' . $help;
290
    }
291

292
    $description .= ' ' . t('You can <a href="@cron">run cron manually</a>.', array('@cron' => url('admin/reports/status/run-cron')));
293
    $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))));
294

295
    $requirements['cron'] = array(
296
      'title' => t('Cron maintenance tasks'),
297
298
      'severity' => $severity,
      'value' => $summary,
299
      'description' => $description
300
    );
301
  }
302
  if ($phase != 'install') {
303
    $filesystem_config = \Drupal::config('system.file');
304
    $directories = array(
305
      PublicStream::basePath(),
306
307
308
309
310
311
      // 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(),
    );
  }
312

313
314
  // During an install we need to make assumptions about the file system
  // unless overrides are provided in settings.php.
315
  if ($phase == 'install') {
316
317
    global $conf;
    $directories = array();
318
319
    if ($file_public_path = settings()->get('file_public_path')) {
      $directories[] = $file_public_path;
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
    }
    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();
    }
338
339
  }

340
341
342
  // 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.
343
344
345
  if (!empty($GLOBALS['config_directories'])) {
    $directories[] = config_get_config_directory(CONFIG_ACTIVE_DIRECTORY);
    $directories[] = config_get_config_directory(CONFIG_STAGING_DIRECTORY);
346
347
  }
  elseif ($phase != 'install') {
348
    $requirements['config directories'] = array(
349
350
351
      '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')),
352
353
354
355
      'severity' => REQUIREMENT_ERROR,
    );
  }

356
  $requirements['file system'] = array(
357
    'title' => t('File system'),
358
  );
359

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

407
408
409
  // See if updates are available in update.php.
  if ($phase == 'runtime') {
    $requirements['update'] = array(
410
411
      'title' => t('Database updates'),
      'value' => t('Up to date'),
412
413
414
    );

    // Check installed modules.
415
    foreach (\Drupal::moduleHandler()->getModuleList() as $module => $filename) {
416
417
418
419
420
      $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;
421
422
          $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'));
423
424
425
426
427
428
          break;
        }
      }
    }
  }

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

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

494
  // Test Unicode library
495
  include_once DRUPAL_ROOT . '/core/includes/unicode.inc';
496
497
  $requirements = array_merge($requirements, unicode_requirements());

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

515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
  // Ensure that if upgrading from 7 to 8 we have no disabled modules.
  if ($phase == 'update' && db_table_exists('system')) {
    $modules = db_query('SELECT name, info FROM {system} WHERE type = :module AND status = 0 AND schema_version <> :schema_uninstalled', array(
      ':module' => 'module',
      ':schema_uninstalled' => SCHEMA_UNINSTALLED,
    ))->fetchAllKeyed(0, 1);
    array_walk($modules, function (&$value, $key) {
      $info = unserialize($value);
      $value = $info['name'];
    });
    if (!empty($modules)) {
      $requirements['disabled_modules'] = array(
        'severity' => REQUIREMENT_ERROR,
        'title' => t('Disabled modules'),
        'value' => format_plural(count($modules), 'The %modules module is disabled.', 'The following modules are disabled: %modules', array('%modules' => implode(', ', $modules))),
        'description' => t('Drupal 8 no longer supports disabled modules. Please either enable or uninstall them before upgrading.'),
      );
    }
  }
534
535
536
  return $requirements;
}

537
/**
538
 * Implements hook_install().
539
 */
540
function system_install() {
541
  // Enable and set the default theme. Can't use theme_enable() this early in
542
543
  // installation.
  config_install_default_config('theme', 'stark');
544
  \Drupal::config('system.theme')
545
546
    ->set('default', 'stark')
    ->save();
547

548
  // Populate the cron key state variable.
549
  $cron_key = Crypt::randomStringHashed(55);
550
  \Drupal::state()->set('system.cron_key', $cron_key);
551
552
}

553
/**
554
 * Implements hook_schema().
555
556
557
558
559
560
 */
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(
561
    '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.',
562
    'fields' => array(
563
      'name' => array(
564
        'description' => 'The name of the variable.',
565
566
567
        'type' => 'varchar',
        'length' => 128,
        'not null' => TRUE,
568
569
        'default' => '',
      ),
570
      'value' => array(
571
        'description' => 'The value of the variable.',
572
        'type' => 'blob',
573
        'not null' => TRUE,
574
        'size' => 'big',
575
      ),
576
    ),
577
    'primary key' => array('name'),
578
  );
579
580

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

  $schema['flood'] = array(
616
    'description' => 'Flood controls the threshold of events, such as the number of contact attempts.',
617
    'fields' => array(
618
      'fid' => array(
619
        'description' => 'Unique flood event ID.',
620
        'type' => 'serial',
621
622
        'not null' => TRUE,
      ),
623
      'event' => array(
624
        'description' => 'Name of event (e.g. contact).',
625
626
627
        'type' => 'varchar',
        'length' => 64,
        'not null' => TRUE,
628
629
        'default' => '',
      ),
630
631
      'identifier' => array(
        'description' => 'Identifier of the visitor, such as an IP address or hostname.',
632
633
634
        'type' => 'varchar',
        'length' => 128,
        'not null' => TRUE,
635
636
        'default' => '',
      ),
637
      'timestamp' => array(
638
        'description' => 'Timestamp of the event.',
639
640
        'type' => 'int',
        'not null' => TRUE,
641
        'default' => 0,
642
      ),
643
644
645
646
647
648
      'expiration' => array(
        'description' => 'Expiration timestamp. Expired events are purged on cron run.',
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
      ),
649
    ),
650
    'primary key' => array('fid'),
651
    'indexes' => array(
652
      'allow' => array('event', 'identifier', 'timestamp'),
653
      'purge' => array('expiration'),
654
    ),
655
  );
656

657
  $schema['key_value'] = array(
658
    'description' => 'Generic key-value storage table. See the state system for an example.',
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
    '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'),
  );

684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
  $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'),
    ),
  );

721
  $schema['menu_router'] = array(
722
    'description' => 'Maps paths to various callbacks (access, page and title)',
723
    'fields' => array(
724
      'path' => array(
725
        'description' => 'Primary Key: the Drupal path this entry describes',
726
727
728
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
729
730
        'default' => '',
      ),
731
      'load_functions' => array(
732
        '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.',
733
        'type' => 'blob',
734
        'not null' => TRUE,
735
      ),
736
      'to_arg_functions' => array(
737
        '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.',
738
        'type' => 'blob',
739
        'not null' => TRUE,
740
      ),
741
      'access_callback' => array(
742
        'description' => 'The callback which determines the access to this router path. Defaults to user_access.',
743
744
745
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
746
747
        'default' => '',
      ),
748
      'access_arguments' => array(
749
        'description' => 'A serialized array of arguments for the access callback.',
750
        'type' => 'blob',
751
752
        'not null' => FALSE,
      ),
753
      'page_callback' => array(
754
        'description' => 'The name of the function that renders the page.',
755
756
757
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
758
759
        'default' => '',
      ),
760
      'page_arguments' => array(
761
        'description' => 'A serialized array of arguments for the page callback.',
762
        'type' => 'blob',
763
764
        'not null' => FALSE,
      ),
765
      'fit' => array(
766
        'description' => 'A numeric representation of how specific the path is.',
767
768
        'type' => 'int',
        'not null' => TRUE,
769
770
        'default' => 0,
      ),
771
      'number_parts' => array(
772
        'description' => 'Number of parts in this router path.',
773
774
775
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
776
777
        'size' => 'small',
      ),
778
779
780
781
782
783
      '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,
      ),
784
      'tab_parent' => array(
785
        'description' => 'Only for local tasks (tabs) - the router path of the parent page (which may also be a local task).',
786
787
788
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
789
790
        'default' => '',
      ),
791
      'tab_root' => array(
792
        '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.',
793
794
795
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
796
797
        'default' => '',
      ),
798
      'title' => array(
799
        'description' => 'The title for the current page, or the title for the tab if this is a local task.',
800
801
802
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
803
804
        'default' => '',
      ),
805
      'title_callback' => array(
806
        'description' => 'A function which will alter the title. Defaults to t()',
807
808
809
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
810
811
        'default' => '',
      ),
812
      'title_arguments' => array(
813
        '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.',
814
815
816
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
817
818
        'default' => '',
      ),
819
820
821
822
823
824
825
826
827
828
829
830
831
832
      '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' => '',
      ),
833
      'type' => array(
834
        'description' => 'Numeric representation of the type of the menu item, like MENU_LOCAL_TASK.',
835
836
        'type' => 'int',
        'not null' => TRUE,
837
838
        'default' => 0,
      ),
839
      'description' => array(
840
        'description' => 'A description of this item.',
841
        'type' => 'text',
842
843
        'not null' => TRUE,
      ),
844
845
846
847
848
849
850
851
852
853
854
855
856
857
      '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' => '',
      ),
858
      'position' => array(
859
        'description' => 'The position of the block (left or right) on the system administration page for this item.',
860
861
862
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
863
864
        'default' => '',
      ),
865
      'weight' => array(
866
        'description' => 'Weight of the element. Lighter weights are higher up, heavier weights go down.',
867
868
        'type' => 'int',
        'not null' => TRUE,
869
870
        'default' => 0,
      ),
871
      'include_file' => array(
872
873
        'description' => 'The file to include for this element, usually the page callback function lives in this file.',
        'type' => 'text',
874
        'size' => 'medium',
875
      ),
876
877
878
879
880
      'route_name' => array(
        'description' => 'The machine name of a defined Symfony Route this menu item represents.',
        'type' => 'varchar',
        'length' => 255,
      ),
881
    ),
882
    'indexes' => array(
883
      'fit' => array('fit'),
884
      'tab_parent' => array(array('tab_parent', 64), 'weight', 'title'),
885
      'tab_root_weight_title' => array(array('tab_root', 64), 'weight', 'title'),
886
    ),