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

3
4
use Drupal\Database\Database;

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

10
11
/**
 * Test and report Drupal installation requirements.
12
13
14
15
16
 *
 * @param $phase
 *   The current system installation phase.
 * @return
 *   An array of system requirements.
17
18
 */
function system_requirements($phase) {
19
  global $base_url;
20
21
  $requirements = array();
  // Ensure translations don't break at install time
22
  $t = get_t();
23
24
25
26
27
28

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

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

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

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

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

82
83
84
85
86
  // Test PHP register_globals setting.
  $requirements['php_register_globals'] = array(
    'title' => $t('PHP register globals'),
  );
  $register_globals = trim(ini_get('register_globals'));
87
  // Unfortunately, ini_get() may return many different values, and we can't
88
89
90
91
92
93
94
95
96
97
98
99
  // be certain which values mean 'on', so we instead check for 'not off'
  // since we never want to tell the user that their site is secure
  // (register_globals off), when it is in fact on. We can only guarantee
  // register_globals is off if the value returned is 'off', '', or 0.
  if (!empty($register_globals) && strtolower($register_globals) != 'off') {
    $requirements['php_register_globals']['description'] = $t('<em>register_globals</em> is enabled. Drupal requires this configuration directive to be disabled. Your site may not be secure when <em>register_globals</em> is enabled. The PHP manual has instructions for <a href="http://php.net/configuration.changes">how to change configuration settings</a>.');
    $requirements['php_register_globals']['severity'] = REQUIREMENT_ERROR;
    $requirements['php_register_globals']['value'] = $t("Enabled ('@value')", array('@value' => $register_globals));
  }
  else {
    $requirements['php_register_globals']['value'] = $t('Disabled');
  }
100

101
102
103
  // Test for PHP extensions.
  $requirements['php_extensions'] = array(
    'title' => $t('PHP extensions'),
104
  );
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

  $missing_extensions = array();
  $required_extensions = array(
    'date',
    'dom',
    'filter',
    'gd',
    'hash',
    'json',
    'pcre',
    'pdo',
    'session',
    'SimpleXML',
    'SPL',
    'xml',
  );
  foreach ($required_extensions as $extension) {
    if (!extension_loaded($extension)) {
      $missing_extensions[] = $extension;
    }
  }

  if (!empty($missing_extensions)) {
    $description = $t('Drupal requires you to enable the PHP extensions in the following list (see the <a href="@system_requirements">system requirements page</a> for more information):', array(
      '@system_requirements' => 'http://drupal.org/requirements',
    ));

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

    $requirements['php_extensions']['value'] = $t('Disabled');
    $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
145
146
  if ($phase == 'install' || $phase == 'update') {
    // Test for PDO (database).
    $requirements['database_extensions'] = array(
      'title' => $t('Database support'),
    );
147

148
    // Make sure PDO is available.
149
    $database_ok = extension_loaded('pdo');
150
151
152
153
154
155
156
    if (!$database_ok) {
      $pdo_message = $t('Your web server does not appear to support PDO (PHP Data Objects). Ask your hosting provider if they support the native PDO extension. See the <a href="@link">system requirements</a> page for more information.', array(
        '@link' => 'http://drupal.org/requirements/pdo',
      ));
    }
    else {
      // Make sure at least one supported database driver exists.
157
      $drivers = drupal_detect_database_types();
158
159
160
161
162
163
164
165
166
167
168
169
170
171
      if (empty($drivers)) {
        $database_ok = FALSE;
        $pdo_message = $t('Your web server does not appear to support any common PDO database extensions. Check with your hosting provider to see if they support PDO (PHP Data Objects) and offer any databases that <a href="@drupal-databases">Drupal supports</a>.', array(
          '@drupal-databases' => 'http://drupal.org/node/270#database',
        ));
      }
      // Make sure the native PDO extension is available, not the older PEAR
      // version. (See install_verify_pdo() for details.)
      if (!defined('PDO::ATTR_DEFAULT_FETCH_MODE')) {
        $database_ok = FALSE;
        $pdo_message = $t('Your web server seems to have the wrong version of PDO installed. Drupal 7 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(
          '@link' => 'http://drupal.org/requirements/pdo#pecl',
        ));
      }
172
    }
173

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

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

204
  if ($memory_limit && $memory_limit != -1 && parse_size($memory_limit) < parse_size(DRUPAL_MINIMUM_PHP_MEMORY_LIMIT)) {
205
206
207
    $description = '';
    if ($phase == 'install') {
      $description = $t('Consider increasing your PHP memory limit to %memory_minimum_limit to help prevent errors in the installation process.', array('%memory_minimum_limit' => DRUPAL_MINIMUM_PHP_MEMORY_LIMIT));
208
209
210
    }
    elseif ($phase == 'update') {
      $description = $t('Consider increasing your PHP memory limit to %memory_minimum_limit to help prevent errors in the update process.', array('%memory_minimum_limit' => DRUPAL_MINIMUM_PHP_MEMORY_LIMIT));
211
    }
212
213
    elseif ($phase == 'runtime') {
      $description = $t('Depending on your configuration, Drupal can run with a %memory_limit PHP memory limit. However, a %memory_minimum_limit PHP memory limit or above is recommended, especially if your site uses additional custom or contributed modules.', array('%memory_limit' => $memory_limit, '%memory_minimum_limit' => DRUPAL_MINIMUM_PHP_MEMORY_LIMIT));
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('See the <a href="@url">Drupal requirements</a> for more information.', array('@url' => 'http://drupal.org/requirements'));
225
      $requirements['php_memory_limit']['severity'] = REQUIREMENT_WARNING;
226
    }
227
  }
228

229
230
  // Test settings.php file writability
  if ($phase == 'runtime') {
231
    $conf_dir = drupal_verify_install_file(conf_path(), FILE_NOT_WRITABLE, 'dir');
232
    $conf_file = drupal_verify_install_file(conf_path() . '/settings.php', FILE_EXIST|FILE_READABLE|FILE_NOT_WRITABLE);
233
    if (!$conf_dir || !$conf_file) {
234
235
236
      $requirements['settings.php'] = array(
        'value' => $t('Not protected'),
        'severity' => REQUIREMENT_ERROR,
237
        'description' => '',
238
      );
239
240
241
242
      if (!$conf_dir) {
        $requirements['settings.php']['description'] .= $t('The directory %file is not protected from modifications and poses a security risk. You must change the directory\'s permissions to be non-writable. ', array('%file' => conf_path()));
      }
      if (!$conf_file) {
243
        $requirements['settings.php']['description'] .= $t('The file %file is not protected from modifications and poses a security risk. You must change the file\'s permissions to be non-writable.', array('%file' => conf_path() . '/settings.php'));
244
      }
245
246
247
248
249
250
251
252
253
    }
    else {
      $requirements['settings.php'] = array(
        'value' => $t('Protected'),
      );
    }
    $requirements['settings.php']['title'] = $t('Configuration file');
  }

254
  // Report cron status.
255
  if ($phase == 'runtime') {
256
257
258
259
260
    // Cron warning threshold defaults to two days.
    $threshold_warning = variable_get('cron_threshold_warning', 172800);
    // Cron error threshold defaults to two weeks.
    $threshold_error = variable_get('cron_threshold_error', 1209600);
    // Cron configuration help text.
261
    $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'));
262

263
    // Determine when cron last ran.
264
    $cron_last = variable_get('cron_last');
265
266
267
    if (!is_numeric($cron_last)) {
      $cron_last = variable_get('install_time', 0);
    }
268

269
270
    // Determine severity based on time since cron last ran.
    $severity = REQUIREMENT_OK;
271
    if (REQUEST_TIME - $cron_last > $threshold_error) {
272
      $severity = REQUIREMENT_ERROR;
273
    }
274
    elseif (REQUEST_TIME - $cron_last > $threshold_warning) {
275
276
277
278
      $severity = REQUIREMENT_WARNING;
    }

    // Set summary and description based on values determined above.
279
280
281
282
    $summary = $t('Last run !time ago', array('!time' => format_interval(REQUEST_TIME - $cron_last)));
    $description = '';
    if ($severity != REQUIREMENT_OK) {
      $description = $t('Cron has not run recently.') . ' ' . $help;
283
    }
284

285
    $description .= ' ' . $t('You can <a href="@cron">run cron manually</a>.', array('@cron' => url('admin/reports/status/run-cron')));
286
    $description .= '<br />' . $t('To run cron from outside the site, go to <a href="!cron">!cron</a>', array('!cron' => url($base_url . '/core/cron.php', array('external' => TRUE, 'query' => array('cron_key' => variable_get('cron_key', 'drupal'))))));
287

288
289
290
291
    $requirements['cron'] = array(
      'title' => $t('Cron maintenance tasks'),
      'severity' => $severity,
      'value' => $summary,
292
      'description' => $description
293
    );
294
295
  }

296
297
298
  // Test files directories.
  $directories = array(
    variable_get('file_public_path', conf_path() . '/files'),
299
300
301
    // By default no private files directory is configured. For private files
    // to be secure the admin needs to provide a path outside the webroot.
    variable_get('file_private_path', FALSE),
302
  );
303
304
305
306
307
308
309
310
311
312
313

  // Do not check for the temporary files directory at install time
  // unless it has been set in settings.php. In this case the user has
  // no alternative but to fix the directory if it is not writable.
  if ($phase == 'install') {
    $directories[] = variable_get('file_temporary_path', FALSE);
  }
  else {
    $directories[] = variable_get('file_temporary_path', file_directory_temp());
  }

314
315
316
  $requirements['file system'] = array(
    'title' => $t('File system'),
  );
317

318
319
320
  $error = '';
  // For installer, create the directories if possible.
  foreach ($directories as $directory) {
321
322
323
    if (!$directory) {
      continue;
    }
324
325
    if ($phase == 'install') {
      file_prepare_directory($directory, FILE_CREATE_DIRECTORY);
326
    }
327
328
329
330
331
332
333
334
335
336
337
338
339
    $is_writable = is_writable($directory);
    $is_directory = is_dir($directory);
    if (!$is_writable || !$is_directory) {
      $description = '';
      $requirements['file system']['value'] = $t('Not writable');
      if (!$is_directory) {
        $error .= $t('The directory %directory does not exist.', array('%directory' => $directory)) . ' ';
      }
      else {
        $error .= $t('The directory %directory is not writable.', array('%directory' => $directory)) . ' ';
      }
      // The files directory requirement check is done only during install and runtime.
      if ($phase == 'runtime') {
340
        $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')));
341
342
343
344
      }
      elseif ($phase == 'install') {
        // For the installer UI, we need different wording. 'value' will
        // be treated as version, so provide none there.
345
        $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'));
346
347
348
349
350
351
        $requirements['file system']['value'] = '';
      }
      if (!empty($description)) {
        $requirements['file system']['description'] = $description;
        $requirements['file system']['severity'] = REQUIREMENT_ERROR;
      }
352
353
    }
    else {
354
      if (file_default_scheme() == 'public') {
355
356
357
358
359
        $requirements['file system']['value'] = $t('Writable (<em>public</em> download method)');
      }
      else {
        $requirements['file system']['value'] = $t('Writable (<em>private</em> download method)');
      }
360
361
362
    }
  }

363
364
365
  // See if updates are available in update.php.
  if ($phase == 'runtime') {
    $requirements['update'] = array(
366
      'title' => $t('Database updates'),
367
368
369
370
371
372
373
374
375
376
377
378
      'severity' => REQUIREMENT_OK,
      'value' => $t('Up to date'),
    );

    // Check installed modules.
    foreach (module_list() as $module) {
      $updates = drupal_get_schema_versions($module);
      if ($updates !== FALSE) {
        $default = drupal_get_installed_schema_version($module);
        if (max($updates) > $default) {
          $requirements['update']['severity'] = REQUIREMENT_ERROR;
          $requirements['update']['value'] = $t('Out of date');
379
          $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'));
380
381
382
383
384
385
          break;
        }
      }
    }
  }

386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
  // Verify the update.php access setting
  if ($phase == 'runtime') {
    if (!empty($GLOBALS['update_free_access'])) {
      $requirements['update access'] = array(
        'value' => $t('Not protected'),
        'severity' => REQUIREMENT_ERROR,
        'description' => $t('The update.php script is accessible to everyone without authentication check, which is a security risk. You must change the $update_free_access value in your settings.php back to FALSE.'),
      );
    }
    else {
      $requirements['update access'] = array(
        'value' => $t('Protected'),
      );
    }
    $requirements['update access']['title'] = $t('Access to update.php');
  }

403
404
  // Display an error if a newly introduced dependency in a module is not resolved.
  if ($phase == 'update') {
405
    $profile = drupal_get_profile();
406
407
    $files = system_rebuild_module_data();
    foreach ($files as $module => $file) {
408
      // Ignore disabled modules and install profiles.
409
      if (!$file->status || $module == $profile) {
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
        continue;
      }
      // Check the module's PHP version.
      $name = $file->info['name'];
      $php = $file->info['php'];
      if (version_compare($php, PHP_VERSION, '>')) {
        $requirements['php']['description'] .= $t('@name requires at least PHP @version.', array('@name' => $name, '@version' => $php));
        $requirements['php']['severity'] = REQUIREMENT_ERROR;
      }
      // Check the module's required modules.
      foreach ($file->requires as $requirement) {
        $required_module = $requirement['name'];
        // Check if the module exists.
        if (!isset($files[$required_module])) {
          $requirements["$module-$required_module"] = array(
            'title' => $t('Unresolved dependency'),
            'description' => $t('@name requires this module.', array('@name' => $name)),
            'value' => t('@required_name (Missing)', array('@required_name' => $required_module)),
            'severity' => REQUIREMENT_ERROR,
          );
          continue;
        }
        // Check for an incompatible version.
        $required_file = $files[$required_module];
        $required_name = $required_file->info['name'];
        $version = str_replace(DRUPAL_CORE_COMPATIBILITY . '-', '', $required_file->info['version']);
        $compatibility = drupal_check_incompatibility($requirement, $version);
        if ($compatibility) {
          $compatibility = rtrim(substr($compatibility, 2), ')');
          $requirements["$module-$required_module"] = array(
            'title' => $t('Unresolved dependency'),
            'description' => $t('@name requires this module and version. Currently using @required_name version @version', array('@name' => $name, '@required_name' => $required_name, '@version' => $version)),
            'value' => t('@required_name (Version @compatibility required)', array('@required_name' => $required_name, '@compatibility' => $compatibility)),
            'severity' => REQUIREMENT_ERROR,
          );
          continue;
        }
      }
    }
  }

451
  // Test Unicode library
452
  include_once DRUPAL_ROOT . '/core/includes/unicode.inc';
453
454
  $requirements = array_merge($requirements, unicode_requirements());

455
  if ($phase == 'runtime') {
456
    // Check for update status module.
457
458
459
    if (!module_exists('update')) {
      $requirements['update status'] = array(
        'value' => $t('Not enabled'),
460
        'severity' => REQUIREMENT_WARNING,
461
        '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/handbook/modules/update', '@module' => url('admin/modules'))),
462
463
464
465
466
467
468
469
      );
    }
    else {
      $requirements['update status'] = array(
        'value' => $t('Enabled'),
      );
    }
    $requirements['update status']['title'] = $t('Update notifications');
470
471
472
473
474
475
476

    // Check that Drupal can issue HTTP requests.
    if (variable_get('drupal_http_request_fails', TRUE) && !system_check_http_request()) {
      $requirements['http requests'] = array(
        'title' => $t('HTTP request status'),
        'value' => $t('Fails'),
        'severity' => REQUIREMENT_ERROR,
477
        'description' => $t('Your system or network configuration does not allow Drupal to access web pages, resulting in reduced functionality. This could be due to your webserver configuration or PHP settings, and should be resolved in order to download information about available updates, fetch aggregator feeds, sign in via OpenID, or use other network-dependent services. If you are certain that Drupal can access web pages but you are still seeing this message, you may add <code>$conf[\'drupal_http_request_fails\'] = FALSE;</code> to the bottom of your settings.php file.'),
478
479
      );
    }
480
481
  }

482
483
484
  return $requirements;
}

485
/**
486
 * Implements hook_install().
487
 */
488
function system_install() {
489
  // Create tables.
490
491
492
493
  drupal_install_schema('system');
  $versions = drupal_get_schema_versions('system');
  $version = $versions ? max($versions) : SCHEMA_INSTALLED;
  drupal_set_installed_schema_version('system', $version);
494

495
  // Clear out module list and hook implementation statics before calling
496
  // system_rebuild_theme_data().
497
  module_list(TRUE);
498
  module_implements_reset();
499

500
  // Load system theme data appropriately.
501
  system_rebuild_theme_data();
502

503
  // Enable the default theme.
504
  variable_set('theme_default', 'stark');
505
506
507
  db_update('system')
    ->fields(array('status' => 1))
    ->condition('type', 'theme')
508
    ->condition('name', 'stark')
509
510
    ->execute();

511
  // Populate the cron key variable.
512
  $cron_key = drupal_hash_base64(drupal_random_bytes(55));
513
  variable_set('cron_key', $cron_key);
514
515
}

516
/**
517
 * Implements hook_schema().
518
519
520
521
522
523
 */
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(
524
    '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.',
525
    'fields' => array(
526
      'name' => array(
527
        'description' => 'The name of the variable.',
528
529
530
        'type' => 'varchar',
        'length' => 128,
        'not null' => TRUE,
531
532
        'default' => '',
      ),
533
      'value' => array(
534
        'description' => 'The value of the variable.',
535
        'type' => 'blob',
536
        'not null' => TRUE,
537
        'size' => 'big',
538
        'translatable' => TRUE,
539
      ),
540
    ),
541
    'primary key' => array('name'),
542
  );
543
544

  $schema['actions'] = array(
545
    'description' => 'Stores action information.',
546
    'fields' => array(
547
      'aid' => array(
548
        'description' => 'Primary Key: Unique actions ID.',
549
550
551
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
552
553
        'default' => '0',
      ),
554
      'type' => array(
555
        'description' => 'The object that that action acts on (node, user, comment, system or custom types.)',
556
557
558
        'type' => 'varchar',
        'length' => 32,
        'not null' => TRUE,
559
560
        'default' => '',
      ),
561
      'callback' => array(
562
        'description' => 'The callback function that executes when the action runs.',
563
564
565
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
566
567
        'default' => '',
      ),
568
      'parameters' => array(
569
        'description' => 'Parameters to be passed to the callback function.',
570
        'type' => 'blob',
571
        'not null' => TRUE,
572
573
        'size' => 'big',
      ),
574
575
      'label' => array(
        'description' => 'Label of the action.',
576
577
578
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
579
        'default' => '0',
580
      ),
581
    ),
582
    'primary key' => array('aid'),
583
  );
584
585

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

620
  $schema['blocked_ips'] = array(
621
    'description' => 'Stores blocked IP addresses.',
622
623
    'fields' => array(
       'iid' => array(
624
        'description' => 'Primary Key: unique ID for IP addresses.',
625
626
627
628
629
        'type' => 'serial',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
      'ip' => array(
630
        'description' => 'IP address',
631
        'type' => 'varchar',
632
        'length' => 40,
633
634
635
636
637
638
639
640
641
642
        'not null' => TRUE,
        'default' => '',
      ),
    ),
    'indexes' => array(
      'blocked_ip' => array('ip'),
    ),
    'primary key' => array('iid'),
  );

643
  $schema['cache'] = array(
644
    'description' => 'Generic cache table for caching things not separated out into their own tables. Contributed modules may also use this to store cached items.',
645
    'fields' => array(
646
      'cid' => array(
647
        'description' => 'Primary Key: Unique cache ID.',
648
649
650
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
651
652
        'default' => '',
      ),
653
      'data' => array(
654
        'description' => 'A collection of data to cache.',
655
656
        'type' => 'blob',
        'not null' => FALSE,
657
658
        'size' => 'big',
      ),
659
      'expire' => array(
660
        'description' => 'A Unix timestamp indicating when the cache entry should expire, or 0 for never.',
661
662
        'type' => 'int',
        'not null' => TRUE,
663
664
        'default' => 0,
      ),
665
      'created' => array(
666
        'description' => 'A Unix timestamp indicating when the cache entry was created.',
667
668
        'type' => 'int',
        'not null' => TRUE,
669
670
        'default' => 0,
      ),
671
      'serialized' => array(
672
        'description' => 'A flag to indicate whether content is serialized (1) or not (0).',
673
674
675
        'type' => 'int',
        'size' => 'small',
        'not null' => TRUE,
676
        'default' => 0,
677
      ),
678
679
680
681
    ),
    'indexes' => array(
      'expire' => array('expire'),
    ),
682
    'primary key' => array('cid'),
683
  );
684
685
  $schema['cache_bootstrap'] = $schema['cache'];
  $schema['cache_bootstrap']['description'] = 'Cache table for data required to bootstrap Drupal, may be routed to a shared memory cache.';
686
  $schema['cache_form'] = $schema['cache'];
687
  $schema['cache_form']['description'] = 'Cache table for the form system to store recently built forms and their storage data, to be used in subsequent page requests.';
688
  $schema['cache_page'] = $schema['cache'];
689
  $schema['cache_page']['description'] = 'Cache table used to store compressed pages for anonymous users, if page caching is enabled.';
690
  $schema['cache_menu'] = $schema['cache'];
691
  $schema['cache_menu']['description'] = 'Cache table for the menu system to store router information as well as generated link trees for various menu/page/user combinations.';
692
693
  $schema['cache_path'] = $schema['cache'];
  $schema['cache_path']['description'] = 'Cache table for path alias lookup.';
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
  $schema['date_format_type'] = array(
    'description' => 'Stores configured date format types.',
    'fields' => array(
      'type' => array(
        'description' => 'The date format type, e.g. medium.',
        'type' => 'varchar',
        'length' => 64,
        'not null' => TRUE,
      ),
      'title' => array(
        'description' => 'The human readable name of the format type.',
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
      ),
      'locked' => array(
        'description' => 'Whether or not this is a system provided format.',
        'type' => 'int',
        'size' => 'tiny',
        'default' => 0,
        'not null' => TRUE,
      ),
    ),
    'primary key' => array('type'),
719
720
721
    'indexes' => array(
      'title' => array('title'),
    ),
722
723
  );

724
  // This table's name is plural as some versions of MySQL can't create a
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
  // table named 'date_format'.
  $schema['date_formats'] = array(
    'description' => 'Stores configured date formats.',
    'fields' => array(
      'dfid' => array(
        'description' => 'The date format identifier.',
        'type' => 'serial',
        'not null' => TRUE,
        'unsigned' => TRUE,
      ),
      'format' => array(
        'description' => 'The date format string.',
        'type' => 'varchar',
        'length' => 100,
        'not null' => TRUE,
      ),
      'type' => array(
        'description' => 'The date format type, e.g. medium.',
        'type' => 'varchar',
        'length' => 64,
        'not null' => TRUE,
      ),
      'locked' => array(
        'description' => 'Whether or not this format can be modified.',
        'type' => 'int',
        'size' => 'tiny',
        'default' => 0,
        'not null' => TRUE,
      ),
    ),
    'primary key' => array('dfid'),
    'unique keys' => array('formats' => array('format', 'type')),
  );

  $schema['date_format_locale'] = array(
    'description' => 'Stores configured date formats for each locale.',
    'fields' => array(
      'format' => array(
        'description' => 'The date format string.',
        'type' => 'varchar',
        'length' => 100,
        'not null' => TRUE,
      ),
      'type' => array(
        'description' => 'The date format type, e.g. medium.',
        'type' => 'varchar',
        'length' => 64,
        'not null' => TRUE,
      ),
      'language' => array(
775
        'description' => 'A {language}.language for this format to be used with.',
776
777
778
779
780
781
782
783
        'type' => 'varchar',
        'length' => 12,
        'not null' => TRUE,
      ),
    ),
    'primary key' => array('type', 'language'),
  );

784
  $schema['file_managed'] = array(
785
    'description' => 'Stores information for uploaded files.',
786
    'fields' => array(
787
      'fid' => array(
788
        'description' => 'File ID.',
789
790
        'type' => 'serial',
        'unsigned' => TRUE,
791
792
        'not null' => TRUE,
      ),
793
      'uid' => array(
794
        'description' => 'The {users}.uid of the user who is associated with the file.',
795
796
797
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
798
799
        'default' => 0,
      ),
800
      'filename' => array(
801
        'description' => 'Name of the file with no path components. This may differ from the basename of the URI if the file is renamed to avoid overwriting an existing file.',
802
803
804
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
805
806
        'default' => '',
      ),
807
      'uri' => array(
808
        'description' => 'The URI to access the file (either local or remote).',
809
810
811
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
812
813
        'default' => '',
      ),
814
      'filemime' => array(
815
        'description' => "The file's MIME type.",
816
817
818
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
819
820
        'default' => '',
      ),
821
      'filesize' => array(
822
        'description' => 'The size of the file in bytes.',
823
824
825
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
826
827
        'default' => 0,
      ),
828
      'status' => array(
829
        'description' => 'A field indicating the status of the file. Two status are defined in core: temporary (0) and permanent (1). Temporary files older than DRUPAL_MAXIMUM_TEMP_FILE_AGE will be removed during a cron run.',
830
831
        'type' => 'int',
        'not null' => TRUE,
832
        'default' => 0,
833
        'size' => 'tiny',
834
      ),
835
      'timestamp' => array(
836
        'description' => 'UNIX timestamp for when the file was added.',
837
838
839
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
840
        'default' => 0,
841
      ),
842
    ),
843
    'indexes' => array(
844
845
      'uid' => array('uid'),
      'status' => array('status'),
846
      'timestamp' => array('timestamp'),
847
    ),
848
849
850
    'unique keys' => array(
      'uri' => array('uri'),
    ),
851
    'primary key' => array('fid'),
852
    'foreign keys' => array(
853
854
855
856
      'file_owner' => array(
        'table' => 'users',
        'columns' => array('uid' => 'uid'),
      ),
857
    ),
858
  );
859

860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
  $schema['file_usage'] = array(
    'description' => 'Track where a file is used.',
    'fields' => array(
      'fid' => array(
        'description' => 'File ID.',
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
      'module' => array(
        'description' => 'The name of the module that is using the file.',
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
      ),
      'type' => array(
        'description' => 'The name of the object type in which the file is used.',
        'type' => 'varchar',
        'length' => 64,
        'not null' => TRUE,
        'default' => '',
      ),
      'id' => array(
        'description' => 'The primary key of the object using the file.',
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0,
      ),
      'count' => array(
        'description' => 'The number of times this file is used by this object.',
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0,
      ),
    ),
    'primary key' => array('fid', 'type', 'id', 'module'),
    'indexes' => array(
      'type_id' => array('type', 'id'),
      'fid_count' => array('fid', 'count'),
      'fid_module' => array('fid', 'module'),
    ),
  );

906
  $schema['flood'] = array(
907
    'description' => 'Flood controls the threshold of events, such as the number of contact attempts.',
908
    'fields' => array(
909
      'fid' => array(
910
        'description' => 'Unique flood event ID.',
911
        'type' => 'serial',
912
913
        'not null' => TRUE,
      ),
914
      'event' => array(
915
        'description' => 'Name of event (e.g. contact).',
916
917
918
        'type' => 'varchar',
        'length' => 64,
        'not null' => TRUE,
919
920
        'default' => '',
      ),
921
922
      'identifier' => array(
        'description' => 'Identifier of the visitor, such as an IP address or hostname.',
923
924
925
        'type' => 'varchar',
        'length' => 128,
        'not null' => TRUE,
926
927
        'default' => '',
      ),
928
      'timestamp' => array(
929
        'description' => 'Timestamp of the event.',
930
931
        'type' => 'int',
        'not null' => TRUE,
932
        'default' => 0,
933
      ),
934
935
936
937
938
939
      'expiration' => array(
        'description' => 'Expiration timestamp. Expired events are purged on cron run.',
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
      ),
940
    ),
941
    'primary key' => array('fid'),
942
    'indexes' => array(
943
      'allow' => array('event', 'identifier', 'timestamp'),
944
      'purge' => array('expiration'),
945
    ),
946
  );
947
948

  $schema['menu_router'] = array(
949
    'description' => 'Maps paths to various callbacks (access, page and title)',
950
    'fields' => array(
951
      'path' => array(
952
        'description' => 'Primary Key: the Drupal path this entry describes',
953
954
955
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
956
957
        'default' => '',
      ),
958
      'load_functions' => array(
959
        '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.',
960
        'type' => 'blob',
961
        'not null' => TRUE,
962
      ),
963
      'to_arg_functions' => array(
964
        '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.',
965
        'type' => 'blob',
966
        'not null' => TRUE,
967
      ),
968
      'access_callback' => array(
969
        'description' => 'The callback which determines the access to this router path. Defaults to user_access.',
970
971
972
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
973
974
        'default' => '',
      ),
975
      'access_arguments' => array(
976
        'description' => 'A serialized array of arguments for the access callback.',
977
        'type' => 'blob',
978
979
        'not null' => FALSE,
      ),
980
      'page_callback' => array(
981
        'description' => 'The name of the function that renders the page.',
982
983
984
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
985
986
        'default' => '',
      ),
987
      'page_arguments' => array(
988
        'description' => 'A serialized array of arguments for the page callback.',
989
        'type' => 'blob',
990
991
        'not null' => FALSE,
      ),
992
993
994
995
996
997
998
      'delivery_callback' => array(
        'description' => 'The name of the function that sends the result of the page_callback function to the browser.',
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
      ),
999
      'fit' => array(
1000
        'description' => 'A numeric representation of how specific the path is.',
1001
1002
        'type' => 'int',
        'not null' => TRUE,
1003
1004
        'default' => 0,
      ),
1005
      'number_parts' => array(
1006
        'description' => 'Number of parts in this router path.',
1007
1008
1009
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
1010
1011
        'size' => 'small',
      ),