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

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

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

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

    // Display the currently active install profile, if the site
    // is not running the default install profile.
    $profile = drupal_get_profile();
34
    if ($profile != 'standard') {
35
      $info = system_get_info('module', $profile);
36
37
38
39
40
41
42
43
44
45
      $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
      );
46
    }
47
48
  }

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

56
57
58
59
60
61
62
63
64
65
66
67
  // 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,
68
      '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')),
69
70
71
72
73
      'severity' => REQUIREMENT_INFO,
    );
  }

  if (version_compare($phpversion, DRUPAL_MINIMUM_PHP) < 0) {
74
75
    $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;
76
77
    // If PHP is old, it's not safe to continue with the requirements check.
    return $requirements;
78
  }
79

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

99
100
101
  // Test for PHP extensions.
  $requirements['php_extensions'] = array(
    'title' => $t('PHP extensions'),
102
  );
103
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

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

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

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

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

146
    // Make sure PDO is available.
147
    $database_ok = extension_loaded('pdo');
148
149
150
151
152
153
154
    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.
155
      $drivers = drupal_detect_database_types();
156
157
158
159
160
161
162
163
164
165
166
167
168
169
      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',
        ));
      }
170
    }
171

172
173
174
    if (!$database_ok) {
      $requirements['database_extensions']['value'] = $t('Disabled');
      $requirements['database_extensions']['severity'] = REQUIREMENT_ERROR;
175
      $requirements['database_extensions']['description'] = $pdo_message;
176
177
178
179
    }
    else {
      $requirements['database_extensions']['value'] = $t('Enabled');
    }
180
  }
181
182
183
184
185
186
187
188
189
190
191
192
193
  else {
    // Database information.
    $class = 'DatabaseTasks_' . Database::getConnection()->driver();
    $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(),
    );
  }
194

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

202
  if ($memory_limit && $memory_limit != -1 && parse_size($memory_limit) < parse_size(DRUPAL_MINIMUM_PHP_MEMORY_LIMIT)) {
203
204
205
    $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));
206
207
208
    }
    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));
209
    }
210
211
    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));
212
    }
213

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

222
      $requirements['php_memory_limit']['description'] = $description . ' ' . $t('See the <a href="@url">Drupal requirements</a> for more information.', array('@url' => 'http://drupal.org/requirements'));
223
      $requirements['php_memory_limit']['severity'] = REQUIREMENT_WARNING;
224
    }
225
  }
226

227
228
  // Test settings.php file writability
  if ($phase == 'runtime') {
229
    $conf_dir = drupal_verify_install_file(conf_path(), FILE_NOT_WRITABLE, 'dir');
230
    $conf_file = drupal_verify_install_file(conf_path() . '/settings.php', FILE_EXIST|FILE_READABLE|FILE_NOT_WRITABLE);
231
    if (!$conf_dir || !$conf_file) {
232
233
234
      $requirements['settings.php'] = array(
        'value' => $t('Not protected'),
        'severity' => REQUIREMENT_ERROR,
235
        'description' => '',
236
      );
237
238
239
240
      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) {
241
        $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'));
242
      }
243
244
245
246
247
248
249
250
251
    }
    else {
      $requirements['settings.php'] = array(
        'value' => $t('Protected'),
      );
    }
    $requirements['settings.php']['title'] = $t('Configuration file');
  }

252
  // Report cron status.
253
  if ($phase == 'runtime') {
254
255
256
257
258
    // 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.
259
    $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'));
260

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

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

    // Set summary and description based on values determined above.
277
278
279
280
    $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;
281
    }
282

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

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

294
295
296
  // Test files directories.
  $directories = array(
    variable_get('file_public_path', conf_path() . '/files'),
297
298
299
    // 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),
300
  );
301
302
303
304
305
306
307
308
309
310
311

  // 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());
  }

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

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

361
362
363
  // See if updates are available in update.php.
  if ($phase == 'runtime') {
    $requirements['update'] = array(
364
      'title' => $t('Database updates'),
365
366
367
368
369
370
371
372
373
374
375
376
      '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');
377
          $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'));
378
379
380
381
382
383
          break;
        }
      }
    }
  }

384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
  // 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');
  }

401
402
  // Display an error if a newly introduced dependency in a module is not resolved.
  if ($phase == 'update') {
403
    $profile = drupal_get_profile();
404
405
    $files = system_rebuild_module_data();
    foreach ($files as $module => $file) {
406
      // Ignore disabled modules and install profiles.
407
      if (!$file->status || $module == $profile) {
408
409
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
        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;
        }
      }
    }
  }

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

453
  if ($phase == 'runtime') {
454
    // Check for update status module.
455
456
457
    if (!module_exists('update')) {
      $requirements['update status'] = array(
        'value' => $t('Not enabled'),
458
        'severity' => REQUIREMENT_WARNING,
459
        'description' => $t('Update notifications are not enabled. It is <strong>highly recommended</strong> that you enable the update status module from the <a href="@module">module administration page</a> in order to stay up-to-date on new releases. For more information, <a href="@update">Update status handbook page</a>.', array('@update' => 'http://drupal.org/handbook/modules/update', '@module' => url('admin/modules'))),
460
461
462
463
464
465
466
467
      );
    }
    else {
      $requirements['update status'] = array(
        'value' => $t('Enabled'),
      );
    }
    $requirements['update status']['title'] = $t('Update notifications');
468
469
470
471
472
473
474

    // 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,
475
        '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.'),
476
477
      );
    }
478
479
  }

480
481
482
  return $requirements;
}

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

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

498
  // Load system theme data appropriately.
499
  system_rebuild_theme_data();
500

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

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

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

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

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

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

641
  $schema['cache'] = array(
642
    'description' => 'Generic cache table for caching things not separated out into their own tables. Contributed modules may also use this to store cached items.',
643
    'fields' => array(
644
      'cid' => array(
645
        'description' => 'Primary Key: Unique cache ID.',
646
647
648
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
649
650
        'default' => '',
      ),
651
      'data' => array(
652
        'description' => 'A collection of data to cache.',
653
654
        'type' => 'blob',
        'not null' => FALSE,
655
656
        'size' => 'big',
      ),
657
      'expire' => array(
658
        'description' => 'A Unix timestamp indicating when the cache entry should expire, or 0 for never.',
659
660
        'type' => 'int',
        'not null' => TRUE,
661
662
        'default' => 0,
      ),
663
      'created' => array(
664
        'description' => 'A Unix timestamp indicating when the cache entry was created.',
665
666
        'type' => 'int',
        'not null' => TRUE,
667
668
        'default' => 0,
      ),
669
      'serialized' => array(
670
        'description' => 'A flag to indicate whether content is serialized (1) or not (0).',
671
672
673
        'type' => 'int',
        'size' => 'small',
        'not null' => TRUE,
674
        'default' => 0,
675
      ),
676
677
678
679
    ),
    'indexes' => array(
      'expire' => array('expire'),
    ),
680
    'primary key' => array('cid'),
681
  );
682
683
  $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.';
684
  $schema['cache_form'] = $schema['cache'];
685
  $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.';
686
  $schema['cache_page'] = $schema['cache'];
687
  $schema['cache_page']['description'] = 'Cache table used to store compressed pages for anonymous users, if page caching is enabled.';
688
  $schema['cache_menu'] = $schema['cache'];
689
  $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.';
690
691
  $schema['cache_path'] = $schema['cache'];
  $schema['cache_path']['description'] = 'Cache table for path alias lookup.';
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
  $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'),
717
718
719
    'indexes' => array(
      'title' => array('title'),
    ),
720
721
  );

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

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

782
  $schema['file_managed'] = array(
783
    'description' => 'Stores information for uploaded files.',
784
    'fields' => array(
785
      'fid' => array(
786
        'description' => 'File ID.',
787
788
        'type' => 'serial',
        'unsigned' => TRUE,
789
790
        'not null' => TRUE,
      ),
791
      'uid' => array(
792
        'description' => 'The {users}.uid of the user who is associated with the file.',
793
794
795
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
796
797
        'default' => 0,
      ),
798
      'filename' => array(
799
        '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.',
800
801
802
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
803
804
        'default' => '',
      ),
805
      'uri' => array(
806
        'description' => 'The URI to access the file (either local or remote).',
807
808
809
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
810
811
        'default' => '',
      ),
812
      'filemime' => array(
813
        'description' => "The file's MIME type.",
814
815
816
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
817
818
        'default' => '',
      ),
819
      'filesize' => array(
820
        'description' => 'The size of the file in bytes.',
821
822
823
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
824
825
        'default' => 0,
      ),
826
      'status' => array(
827
        '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.',
828
829
        'type' => 'int',
        'not null' => TRUE,
830
        'default' => 0,
831
        'size' => 'tiny',
832
      ),
833
      'timestamp' => array(
834
        'description' => 'UNIX timestamp for when the file was added.',
835
836
837
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
838
        'default' => 0,
839
      ),
840
    ),
841
    'indexes' => array(
842
843
      'uid' => array('uid'),
      'status' => array('status'),
844
      'timestamp' => array('timestamp'),
845
    ),
846
847
848
    'unique keys' => array(
      'uri' => array('uri'),
    ),
849
    'primary key' => array('fid'),
850
    'foreign keys' => array(
851
852
853
854
      'file_owner' => array(
        'table' => 'users',
        'columns' => array('uid' => 'uid'),
      ),
855
    ),
856
  );
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
  $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'),
    ),
  );

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

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