system.install 75.2 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
17
18
19
20
21
 */
function system_requirements($phase) {
  $requirements = array();

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

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

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

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

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

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

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

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

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

128
129
130
131
132
    $item_list = array(
      '#theme' => 'item_list',
      '#items' => $missing_extensions,
    );
    $description .= drupal_render($item_list);
133

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

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

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

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

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

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

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

224
      $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'));
225
      $requirements['php_memory_limit']['severity'] = REQUIREMENT_WARNING;
226
    }
227
  }
228

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
  // 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.'),
      );
    }
  }
542
543
544
  return $requirements;
}

545
/**
546
 * Implements hook_install().
547
 */
548
function system_install() {
549
  // Enable and set the default theme. Can't use theme_enable() this early in
550
551
  // installation.
  config_install_default_config('theme', 'stark');
552
  \Drupal::config('system.theme')
553
554
    ->set('default', 'stark')
    ->save();
555

556
  // Populate the cron key state variable.
557
  $cron_key = Crypt::randomStringHashed(55);
558
  \Drupal::state()->set('system.cron_key', $cron_key);
559
560
}

561
/**
562
 * Implements hook_schema().
563
564
565
566
567
568
 */
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(
569
    '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.',
570
    'fields' => array(
571
      'name' => array(
572
        'description' => 'The name of the variable.',
573
574
575
        'type' => 'varchar',
        'length' => 128,
        'not null' => TRUE,
576
577
        'default' => '',
      ),
578
      'value' => array(
579
        'description' => 'The value of the variable.',
580
        'type' => 'blob',
581
        'not null' => TRUE,
582
        'size' => 'big',
583
      ),
584
    ),
585
    'primary key' => array('name'),
586
  );
587
588

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

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

665
  $schema['key_value'] = array(
666
    'description' => 'Generic key-value storage table. See the state system for an example.',
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
    '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'),
  );

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
721
722
723
724
725
726
727
728
  $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'),
    ),
  );

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