system.install 98.2 KB
Newer Older
Dries's avatar
 
Dries committed
1
<?php
2
// $Id$
3

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

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

  // Report Drupal version
  if ($phase == 'runtime') {
    $requirements['drupal'] = array(
      'title' => $t('Drupal'),
      'value' => VERSION,
Steven Wittens's avatar
Steven Wittens committed
28
29
      'severity' => REQUIREMENT_INFO,
      'weight' => -10,
30
    );
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

    // Display the currently active install profile, if the site
    // is not running the default install profile.
    $profile = drupal_get_profile();
    if ($profile != 'default') {
      $info = install_profile_info($profile);
      $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
      );
47
    }
48
49
  }

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

57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
  // 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,
      '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, please read the <a href="@phpinfo">Enabling and disabling phpinfo()</a> handbook page.', array('@phpinfo' => 'http://drupal.org/node/243993')),
      'severity' => REQUIREMENT_INFO,
    );
  }

  if (version_compare($phpversion, DRUPAL_MINIMUM_PHP) < 0) {
75
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
80
81
82
83
  // Test PHP register_globals setting.
  $requirements['php_register_globals'] = array(
    'title' => $t('PHP register globals'),
  );
  $register_globals = trim(ini_get('register_globals'));
84
  // Unfortunately, ini_get() may return many different values, and we can't
85
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
  // Test PHP memory_limit
99
  $memory_limit = ini_get('memory_limit');
100
101
  $requirements['php_memory_limit'] = array(
    'title' => $t('PHP memory limit'),
102
    'value' => $memory_limit == -1 ? t('-1 (Unlimited)') : $memory_limit,
103
  );
104

105
  if ($memory_limit && $memory_limit != -1 && parse_size($memory_limit) < parse_size(DRUPAL_MINIMUM_PHP_MEMORY_LIMIT)) {
106
107
108
    $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));
109
110
111
    }
    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));
112
    }
113
114
    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));
115
    }
116

117
118
    if (!empty($description)) {
      if ($php_ini_path = get_cfg_var('cfg_file_path')) {
119
        $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));
120
121
      }
      else {
122
        $description .= ' ' . $t('Contact your system administrator or hosting provider for assistance with increasing your PHP memory limit.');
123
      }
124

125
      $requirements['php_memory_limit']['description'] = $description . ' ' . $t('See the <a href="@url">Drupal requirements</a> for more information.', array('@url' => 'http://drupal.org/requirements'));
126
      $requirements['php_memory_limit']['severity'] = REQUIREMENT_WARNING;
127
    }
128
  }
129

130
131
  // Test settings.php file writability
  if ($phase == 'runtime') {
132
    $conf_dir = drupal_verify_install_file(conf_path(), FILE_NOT_WRITABLE, 'dir');
133
    $conf_file = drupal_verify_install_file(conf_path() . '/settings.php', FILE_EXIST|FILE_READABLE|FILE_NOT_WRITABLE);
134
    if (!$conf_dir || !$conf_file) {
135
136
137
      $requirements['settings.php'] = array(
        'value' => $t('Not protected'),
        'severity' => REQUIREMENT_ERROR,
138
        'description' => '',
139
      );
140
141
142
143
      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) {
144
        $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'));
145
      }
146
147
148
149
150
151
152
153
154
    }
    else {
      $requirements['settings.php'] = array(
        'value' => $t('Protected'),
      );
    }
    $requirements['settings.php']['title'] = $t('Configuration file');
  }

155
  // Report cron status.
156
  if ($phase == 'runtime') {
157
158
159
160
161
    // 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.
162
    $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'));
163

164
    // Determine when cron last ran.
165
    $cron_last = variable_get('cron_last');
166
167
168
    if (!is_numeric($cron_last)) {
      $cron_last = variable_get('install_time', 0);
    }
169

170
171
    // Determine severity based on time since cron last ran.
    $severity = REQUIREMENT_OK;
172
    if (REQUEST_TIME - $cron_last > $threshold_error) {
173
      $severity = REQUIREMENT_ERROR;
174
    }
175
    elseif (REQUEST_TIME - $cron_last > $threshold_warning) {
176
177
178
179
      $severity = REQUIREMENT_WARNING;
    }

    // Set summary and description based on values determined above.
180
181
182
183
    $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;
184
    }
185

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

189
190
191
192
    $requirements['cron'] = array(
      'title' => $t('Cron maintenance tasks'),
      'severity' => $severity,
      'value' => $summary,
193
      'description' => $description
194
    );
195
196
  }

197
198
199
200
201
202
  // Test files directories.
  $directories = array(
    variable_get('file_public_path', conf_path() . '/files'),
    variable_get('file_private_path', conf_path() . '/private/files'),
    variable_get('file_temporary_path', conf_path() . '/private/temp'),
  );
203
204
205
  $requirements['file system'] = array(
    'title' => $t('File system'),
  );
206

207
208
209
210
211
  $error = '';
  // For installer, create the directories if possible.
  foreach ($directories as $directory) {
    if ($phase == 'install') {
      file_prepare_directory($directory, FILE_CREATE_DIRECTORY);
212
    }
213
214
215
216
217
218
219
220
221
222
223
224
225
    $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') {
226
        $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')));
227
228
229
230
231
232
233
234
235
236
237
      }
      elseif ($phase == 'install') {
        // For the installer UI, we need different wording. 'value' will
        // be treated as version, so provide none there.
        $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, please see INSTALL.txt or the <a href="@handbook_url">online handbook</a>.', array('@handbook_url' => 'http://drupal.org/server-permissions'));
        $requirements['file system']['value'] = '';
      }
      if (!empty($description)) {
        $requirements['file system']['description'] = $description;
        $requirements['file system']['severity'] = REQUIREMENT_ERROR;
      }
238
239
    }
    else {
240
241
242
243
244
245
      if (variable_get('file_default_scheme', 'public') == 'public') {
        $requirements['file system']['value'] = $t('Writable (<em>public</em> download method)');
      }
      else {
        $requirements['file system']['value'] = $t('Writable (<em>private</em> download method)');
      }
246
247
248
    }
  }

249
250
251
  // See if updates are available in update.php.
  if ($phase == 'runtime') {
    $requirements['update'] = array(
252
      'title' => $t('Database updates'),
253
254
255
256
257
258
259
260
261
262
263
264
      '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');
265
          $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() . 'update.php'));
266
267
268
269
270
271
          break;
        }
      }
    }
  }

272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
  // 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');
  }

289
  // Test Unicode library
290
  include_once DRUPAL_ROOT . '/includes/unicode.inc';
291
292
  $requirements = array_merge($requirements, unicode_requirements());

293
294
295
296
297
298
299
300
301
302
303
  // Verify if the DOM PHP 5 extension is available.
  $has_dom = class_exists('DOMDocument');
  if (!$has_dom) {
    $requirements['php_dom'] = array(
      'title' => $t('PHP DOM Extension'),
      'value' => $t('Not found'),
      'severity' => REQUIREMENT_ERROR,
      'description' => $t("The DOM extension is part of PHP 5 core, but doesn't seem to be enabled on your system. You need to enable the DOM extension on your PHP installation."),
    );
  }

304
  if ($phase == 'runtime') {
305
    // Check for update status module.
306
307
308
    if (!module_exists('update')) {
      $requirements['update status'] = array(
        'value' => $t('Not enabled'),
309
        'severity' => REQUIREMENT_WARNING,
310
        '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 please read the <a href="@update">Update status handbook page</a>.', array('@update' => 'http://drupal.org/handbook/modules/update', '@module' => url('admin/config/modules'))),
311
312
313
314
315
316
317
318
      );
    }
    else {
      $requirements['update status'] = array(
        'value' => $t('Enabled'),
      );
    }
    $requirements['update status']['title'] = $t('Update notifications');
319
320
321
322
323
324
325
326
327
328

    // 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,
        '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.'),
      );
    }
329
330
  }

331
332
333
  return $requirements;
}

334
/**
335
 * Implement hook_install().
336
 */
337
function system_install() {
338
  // Create tables.
339
  $modules = array('system', 'filter', 'user', 'node');
340
341
  foreach ($modules as $module) {
    drupal_install_schema($module);
342
343
344
    $versions = drupal_get_schema_versions($module);
    $version = $versions ? max($versions) : SCHEMA_INSTALLED;
    drupal_set_installed_schema_version($module, $version);
345
  }
346

347
  // Clear out module list and hook implementation statics before calling
348
  // system_rebuild_theme_data().
349
350
351
  module_list(TRUE);
  module_implements('', FALSE, TRUE);

352
  // Load system theme data appropriately.
353
  system_rebuild_theme_data();
354

355
356
  db_insert('users')
    ->fields(array(
357
      'uid' => 0,
358
359
360
361
      'name' => '',
      'mail' => '',
    ))
    ->execute();
362
  // We need some placeholders here as name and mail are uniques and data is
363
364
  // presumed to be a serialized array. This will be changed by the settings
  // form.
365
366
  db_insert('users')
    ->fields(array(
367
      'uid' => 1,
368
369
370
371
372
373
374
      'name' => 'placeholder-for-uid-1',
      'mail' => 'placeholder-for-uid-1',
      'created' => REQUEST_TIME,
      'status' => 1,
      'data' => serialize(array()),
    ))
    ->execute();
375
  // Built-in roles.
376
  $rid_anonymous = db_insert('role')
377
    ->fields(array('name' => 'anonymous user'))
378
379
380
    ->execute();

  $rid_authenticated = db_insert('role')
381
    ->fields(array('name' => 'authenticated user'))
382
383
    ->execute();

384
385
  // Sanity check to ensure the anonymous and authenticated role IDs are the
  // same as the drupal defined constants. In certain situations, this will
386
387
388
389
390
391
392
393
394
395
396
397
398
399
  // not be true.
  if ($rid_anonymous != DRUPAL_ANONYMOUS_RID) {
    db_update('role')
      ->fields(array('rid' => DRUPAL_ANONYMOUS_RID))
      ->condition('rid', $rid_anonymous)
      ->execute();
  }

  if ($rid_authenticated != DRUPAL_AUTHENTICATED_RID) {
    db_update('role')
      ->fields(array('rid' => DRUPAL_AUTHENTICATED_RID))
      ->condition('rid', $rid_authenticated)
      ->execute();
  }
400

401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
  variable_set('theme_default', 'garland');

  db_update('system')
    ->fields(array('status' => 1))
    ->condition('type', 'theme')
    ->condition('name', 'garland')
    ->execute();

  db_insert('node_access')
    ->fields(array(
      'nid' => 0,
      'gid' => 0,
      'realm' => 'all',
      'grant_view' => 1,
      'grant_update' => 0,
      'grant_delete' => 0,
    ))
    ->execute();
419

420
  // Add text formats.
421
422
423
424
  $filtered_html_format = db_insert('filter_format')
    ->fields(array(
      'name' => 'Filtered HTML',
      'cache' => 1,
425
      'weight' => 0,
426
427
428
429
430
431
    ))
    ->execute();
  $full_html_format = db_insert('filter_format')
    ->fields(array(
      'name' => 'Full HTML',
      'cache' => 1,
432
433
434
435
436
437
438
439
      'weight' => 0,
    ))
    ->execute();
  $plain_text_format = db_insert('filter_format')
    ->fields(array(
      'name' => 'Plain text',
      'cache' => 1,
      'weight' => 1,
440
441
    ))
    ->execute();
442

443
  // Enable filters for each text format.
444
445

  // Filtered HTML:
446
  db_insert('filter')
447
    ->fields(array('format', 'module', 'name', 'weight', 'status'))
448
449
450
451
    // URL filter.
    ->values(array(
      'format' => $filtered_html_format,
      'module' => 'filter',
452
      'name' => 'filter_url',
453
      'weight' => 0,
454
      'status' => 1,
455
456
457
458
459
    ))
    // HTML filter.
    ->values(array(
      'format' => $filtered_html_format,
      'module' => 'filter',
460
      'name' => 'filter_html',
461
      'weight' => 1,
462
      'status' => 1,
463
464
465
466
467
    ))
    // Line break filter.
    ->values(array(
      'format' => $filtered_html_format,
      'module' => 'filter',
468
      'name' => 'filter_autop',
469
      'weight' => 2,
470
      'status' => 1,
471
472
473
474
475
    ))
    // HTML corrector filter.
    ->values(array(
      'format' => $filtered_html_format,
      'module' => 'filter',
476
      'name' => 'filter_htmlcorrector',
477
      'weight' => 10,
478
      'status' => 1,
479
    ))
480
  // Full HTML:
481
482
483
484
    // URL filter.
    ->values(array(
      'format' => $full_html_format,
      'module' => 'filter',
485
      'name' => 'filter_url',
486
487
      'weight' => 0,
      'status' => 1,
488
489
490
491
492
    ))
    // Line break filter.
    ->values(array(
      'format' => $full_html_format,
      'module' => 'filter',
493
      'name' => 'filter_autop',
494
      'weight' => 1,
495
      'status' => 1,
496
497
498
499
500
    ))
    // HTML corrector filter.
    ->values(array(
      'format' => $full_html_format,
      'module' => 'filter',
501
      'name' => 'filter_htmlcorrector',
502
      'weight' => 10,
503
      'status' => 1,
504
    ))
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
  // Plain text:
    // Escape all HTML.
    ->values(array(
      'format' => $plain_text_format,
      'module' => 'filter',
      'name' => 'filter_html_escape',
      'weight' => 0,
      'status' => 1,
    ))
    // Line break filter.
    ->values(array(
      'format' => $plain_text_format,
      'module' => 'filter',
      'name' => 'filter_autop',
      'weight' => 1,
      'status' => 1,
    ))
522
523
    ->execute();

524
525
  // Set the fallback format to plain text.
  variable_set('filter_fallback_format', $plain_text_format);
526

527
  $cron_key = md5(mt_rand());
528

529
  variable_set('cron_key', $cron_key);
530
531
}

532
/**
533
 * Implement hook_schema().
534
535
536
537
538
539
 */
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(
540
    '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.',
541
    'fields' => array(
542
      'name' => array(
543
        'description' => 'The name of the variable.',
544
545
546
        'type' => 'varchar',
        'length' => 128,
        'not null' => TRUE,
547
548
        'default' => '',
      ),
549
      'value' => array(
550
        'description' => 'The value of the variable.',
551
552
        'type' => 'text',
        'not null' => TRUE,
553
        'size' => 'big',
554
        'translatable' => TRUE,
555
      ),
556
    ),
557
    'primary key' => array('name'),
558
  );
559
560

  $schema['actions'] = array(
561
    'description' => 'Stores action information.',
562
    'fields' => array(
563
      'aid' => array(
564
        'description' => 'Primary Key: Unique actions ID.',
565
566
567
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
568
569
        'default' => '0',
      ),
570
      'type' => array(
571
        'description' => 'The object that that action acts on (node, user, comment, system or custom types.)',
572
573
574
        'type' => 'varchar',
        'length' => 32,
        'not null' => TRUE,
575
576
        'default' => '',
      ),
577
      'callback' => array(
578
        'description' => 'The callback function that executes when the action runs.',
579
580
581
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
582
583
        'default' => '',
      ),
584
      'parameters' => array(
585
        'description' => 'Parameters to be passed to the callback function.',
586
587
        'type' => 'text',
        'not null' => TRUE,
588
589
        'size' => 'big',
      ),
590
591
      'label' => array(
        'description' => 'Label of the action.',
592
593
594
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
595
        'default' => '0',
596
      ),
597
    ),
598
    'primary key' => array('aid'),
599
  );
600
601

  $schema['batch'] = array(
602
    'description' => 'Stores details about batches (processes that run in multiple HTTP requests).',
603
    'fields' => array(
604
      'bid' => array(
605
        'description' => 'Primary Key: Unique batch ID.',
606
607
        'type' => 'serial',
        'unsigned' => TRUE,
608
609
        'not null' => TRUE,
      ),
610
      'token' => array(
611
        '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.",
612
613
        'type' => 'varchar',
        'length' => 64,
614
615
        'not null' => TRUE,
      ),
616
      'timestamp' => array(
617
        'description' => 'A Unix timestamp indicating when this batch was submitted for processing. Stale batches are purged at cron time.',
618
        'type' => 'int',
619
620
        'not null' => TRUE,
      ),
621
      'batch' => array(
622
        'description' => 'A serialized array containing the processing data for the batch.',
623
624
        'type' => 'text',
        'not null' => FALSE,
625
        'size' => 'big',
626
      ),
627
    ),
628
    'primary key' => array('bid'),
629
630
631
632
    'indexes' => array(
      'token' => array('token'),
    ),
  );
633

634
  $schema['blocked_ips'] = array(
635
    'description' => 'Stores blocked IP addresses.',
636
637
    'fields' => array(
       'iid' => array(
638
        'description' => 'Primary Key: unique ID for IP addresses.',
639
640
641
642
643
        'type' => 'serial',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
      'ip' => array(
644
        'description' => 'IP address',
645
646
647
648
649
650
651
652
653
654
655
656
        'type' => 'varchar',
        'length' => 32,
        'not null' => TRUE,
        'default' => '',
      ),
    ),
    'indexes' => array(
      'blocked_ip' => array('ip'),
    ),
    'primary key' => array('iid'),
  );

657
  $schema['cache'] = array(
658
    'description' => 'Generic cache table for caching things not separated out into their own tables. Contributed modules may also use this to store cached items.',
659
    'fields' => array(
660
      'cid' => array(
661
        'description' => 'Primary Key: Unique cache ID.',
662
663
664
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
665
666
        'default' => '',
      ),
667
      'data' => array(
668
        'description' => 'A collection of data to cache.',
669
670
        'type' => 'blob',
        'not null' => FALSE,
671
672
        'size' => 'big',
      ),
673
      'expire' => array(
674
        'description' => 'A Unix timestamp indicating when the cache entry should expire, or 0 for never.',
675
676
        'type' => 'int',
        'not null' => TRUE,
677
678
        'default' => 0,
      ),
679
      'created' => array(
680
        'description' => 'A Unix timestamp indicating when the cache entry was created.',
681
682
        'type' => 'int',
        'not null' => TRUE,
683
684
        'default' => 0,
      ),
685
      'headers' => array(
686
        'description' => 'Any custom HTTP headers to be added to cached data.',
687
        'type' => 'text',
688
689
        'not null' => FALSE,
      ),
690
      'serialized' => array(
691
        'description' => 'A flag to indicate whether content is serialized (1) or not (0).',
692
693
694
        'type' => 'int',
        'size' => 'small',
        'not null' => TRUE,
695
        'default' => 0,
696
      ),
697
698
699
700
    ),
    'indexes' => array(
      'expire' => array('expire'),
    ),
701
    'primary key' => array('cid'),
702
  );
703

704
705
  $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.';
706
  $schema['cache_form'] = $schema['cache'];
707
  $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.';
708
  $schema['cache_page'] = $schema['cache'];
709
  $schema['cache_page']['description'] = 'Cache table used to store compressed pages for anonymous users, if page caching is enabled.';
710
  $schema['cache_menu'] = $schema['cache'];
711
  $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.';
712
713
  $schema['cache_path'] = $schema['cache'];
  $schema['cache_path']['description'] = 'Cache table for path alias lookup.';
714

715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
  $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'),
  );

741
  // This table's name is plural as some versions of MySQL can't create a
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
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
  // 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'),
  );

801
  $schema['file'] = array(
802
    'description' => 'Stores information for uploaded files.',
803
    'fields' => array(
804
      'fid' => array(
805
        'description' => 'File ID.',
806
807
        'type' => 'serial',
        'unsigned' => TRUE,
808
809
        'not null' => TRUE,
      ),
810
      'uid' => array(
811
        'description' => 'The {users}.uid of the user who is associated with the file.',
812
813
814
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
815
816
        'default' => 0,
      ),
817
      'filename' => array(
818
        'description' => 'Name of the file with no path components. This may differ from the basename of the filepath if the file is renamed to avoid overwriting an existing file.',
819
820
821
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
822
823
        'default' => '',
      ),
824
      'uri' => array(
825
        'description' => 'Path of the file relative to Drupal root.',
826
827
828
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
829
830
        'default' => '',
      ),
831
      'filemime' => array(
832
        'description' => "The file's MIME type.",
833
834
835
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
836
837
        'default' => '',
      ),
838
      'filesize' => array(
839
        'description' => 'The size of the file in bytes.',
840
841
842
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
843
844
        'default' => 0,
      ),
845
      'status' => array(
846
        'description' => 'A bitmapped field indicating the status of the file. The least significant bit indicates temporary (0) or permanent (1). Temporary files older than DRUPAL_MAXIMUM_TEMP_FILE_AGE will be removed during a cron run.',
847
848
        'type' => 'int',
        'not null' => TRUE,
849
850
        'default' => 0,
      ),
851
      'timestamp' => array(
852
        'description' => 'UNIX timestamp for when the file was added.',
853
854
855
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
856
        'default' => 0,
857
      ),
858
    ),
859
    'indexes' => array(
860
861
      'uid' => array('uid'),
      'status' => array('status'),
862
      'timestamp' => array('timestamp'),
863
    ),
864
865
866
    'unique keys' => array(
      'uri' => array('uri'),
    ),
867
    'primary key' => array('fid'),
868
869
870
    'foreign keys' => array(
      'uid' => array('users' => 'uid'),
    ),
871
  );
872
873

  $schema['flood'] = array(
874
    'description' => 'Flood controls the threshold of events, such as the number of contact attempts.',
875
    'fields' => array(
876
      'fid' => array(
877
        'description' => 'Unique flood event ID.',
878
        'type' => 'serial',
879
880
        'not null' => TRUE,
      ),
881
      'event' => array(
882
        'description' => 'Name of event (e.g. contact).',
883
884
885
        'type' => 'varchar',
        'length' => 64,
        'not null' => TRUE,
886
887
        'default' => '',
      ),
888
889
      'identifier' => array(
        'description' => 'Identifier of the visitor, such as an IP address or hostname.',
890
891
892
        'type' => 'varchar',
        'length' => 128,
        'not null' => TRUE,
893
894
        'default' => '',
      ),
895
      'timestamp' => array(
896
        'description' => 'Timestamp of the event.',
897
898
        'type' => 'int',
        'not null' => TRUE,
899
        'default' => 0,
900
      ),
901
902
903
904
905
906
      'expiration' => array(
        'description' => 'Expiration timestamp. Expired events are purged on cron run.',
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
      ),
907
    ),
908
    'primary key' => array('fid'),
909
    'indexes' => array(
910
      'allow' => array('event', 'identifier', 'timestamp'),
911
      'purge' => array('expiration'),
912
    ),
913
  );
914
915

  $schema['history'] = array(
916
    'description' => 'A record of which {users} have read which {node}s.',
917
    'fields' => array(
918
      'uid' => array(
919
        'description' => 'The {users}.uid that read the {node} nid.',
920
921
        'type' => 'int',
        'not null' => TRUE,
922
923
        'default' => 0,
      ),
924
      'nid' => array(
925
        'description' => 'The {node}.nid that was read.',
926
927
        'type' => 'int',
        'not null' => TRUE,
928
929
        'default' => 0,
      ),
930
      'timestamp' => array(
931
        'description' => 'The Unix timestamp at which the read occurred.',
932
933
        'type' => 'int',
        'not null' => TRUE,
934
        'default' => 0,
935
      ),
936
    ),
937
    'primary key' => array('uid', 'nid'),
938
939
940
    'indexes' => array(
      'nid' => array('nid'),
    ),
941
  );
942
  $schema['menu_router'] = array(
943
    'description' => 'Maps paths to various callbacks (access, page and title)',
944
    'fields' => array(
945
      'path' => array(
946
        'description' => 'Primary Key: the Drupal path this entry describes',
947
948
949
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
950
951
        'default' => '',
      ),
952
      'load_functions' => array(
953
        '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.',
954
        'type' => 'text',
955
        'not null' => TRUE,
956
      ),
957
      'to_arg_functions' => array(
958
        '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.',
959
        'type' => 'text',
960
        'not null' => TRUE,
961
      ),
962
      'access_callback' => array(
963