install.inc 26 KB
Newer Older
1
2
<?php

3
use Drupal\Core\Database\Database;
4

5
6
7
/**
 * Indicates that a module has not been installed yet.
 */
8
const SCHEMA_UNINSTALLED = -1;
9
10
11
12

/**
 * Indicates that a module has been installed.
 */
13
const SCHEMA_INSTALLED = 0;
14

15
16
17
/**
 * Requirement severity -- Informational message only.
 */
18
const REQUIREMENT_INFO = -1;
19
20
21
22

/**
 * Requirement severity -- Requirement successfully met.
 */
23
const REQUIREMENT_OK = 0;
24
25
26
27

/**
 * Requirement severity -- Warning condition; proceed but flag warning.
 */
28
const REQUIREMENT_WARNING = 1;
29
30
31
32

/**
 * Requirement severity -- Error condition; abort installation.
 */
33
const REQUIREMENT_ERROR = 2;
34

35
36
37
/**
 * File permission check -- File exists.
 */
38
const FILE_EXIST = 1;
39
40
41
42

/**
 * File permission check -- File is readable.
 */
43
const FILE_READABLE = 2;
44
45
46
47

/**
 * File permission check -- File is writable.
 */
48
const FILE_WRITABLE = 4;
49
50
51
52

/**
 * File permission check -- File is executable.
 */
53
const FILE_EXECUTABLE = 8;
54
55
56
57

/**
 * File permission check -- File does not exist.
 */
58
const FILE_NOT_EXIST = 16;
59
60
61
62

/**
 * File permission check -- File is not readable.
 */
63
const FILE_NOT_READABLE = 32;
64
65
66
67

/**
 * File permission check -- File is not writable.
 */
68
const FILE_NOT_WRITABLE = 64;
69
70
71
72

/**
 * File permission check -- File is not executable.
 */
73
const FILE_NOT_EXECUTABLE = 128;
74

75
76
77
78
/**
 * Initialize the update system by loading all installed module's .install files.
 */
function drupal_load_updates() {
79
80
81
82
  foreach (drupal_get_installed_schema_version(NULL, FALSE, TRUE) as $module => $schema_version) {
    if ($schema_version > -1) {
      module_load_install($module);
    }
83
84
85
  }
}

86
/**
87
 * Loads the install profile, extracting its defined distribution name.
88
89
 *
 * @return
90
91
92
93
 *   The distribution name defined in the profile's .info file. Defaults to
 *   "Drupal" if none is explicitly provided by the install profile.
 *
 * @see install_profile_info()
94
 */
95
function drupal_install_profile_distribution_name() {
96
97
98
99
100
101
102
103
104
  // During installation, the profile information is stored in the global
  // installation state (it might not be saved anywhere yet).
  if (drupal_installation_attempted()) {
    global $install_state;
    return $install_state['profile_info']['distribution_name'];
  }
  // At all other times, we load the profile via standard methods.
  else {
    $profile = drupal_get_profile();
105
    $info = system_get_info('module', $profile);
106
107
    return $info['distribution_name'];
  }
108
109
110
111
112
113
114
115
116
117
118
}

/**
 * Auto detect the base_url with PHP predefined variables.
 *
 * @param $file
 *   The name of the file calling this function so we can strip it out of
 *   the URI when generating the base_url.
 * @return
 *   The auto-detected $base_url that should be configured in settings.php
 */
119
function drupal_detect_baseurl($file = 'core/install.php') {
120
121
  $proto = $_SERVER['HTTPS'] ? 'https://' : 'http://';
  $host = $_SERVER['SERVER_NAME'];
122
  $port = ($_SERVER['SERVER_PORT'] == 80 ? '' : ':' . $_SERVER['SERVER_PORT']);
123
  $dir = str_replace("/$file", '', $_SERVER['SCRIPT_NAME']);
124
125
126
127
128

  return "$proto$host$port$dir";
}

/**
129
 * Detect all supported databases that are compiled into PHP.
130
131
132
133
134
 *
 * @return
 *  An array of database types compiled into PHP.
 */
function drupal_detect_database_types() {
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
  $databases = drupal_get_database_types();

  foreach ($databases as $driver => $installer) {
    $databases[$driver] = $installer->name();
  }

  return $databases;
}

/**
 * Return all supported database installer objects that are compiled into PHP.
 *
 * @return
 *  An array of database installer objects compiled into PHP.
 */
function drupal_get_database_types() {
151
  $databases = array();
152
  $drivers = array();
153

154
  // We define a driver as a directory in /core/includes/database that in turn
155
  // contains a database.inc file. That allows us to drop in additional drivers
156
157
158
  // without modifying the installer.
  // Because we have no registry yet, we need to also include the install.inc
  // file for the driver explicitly.
159
  require_once DRUPAL_ROOT . '/core/includes/database.inc';
160
  foreach (file_scan_directory(DRUPAL_ROOT . '/core/lib/Drupal/Core/Database/Driver', '/^[a-z]*$/i', array('recurse' => FALSE)) as $file) {
161
    if (file_exists($file->uri . '/Install/Tasks.php')) {
162
163
      $drivers[$file->filename] = $file->uri;
    }
164
165
166
  }

  foreach ($drivers as $driver => $file) {
167
    $installer = db_installer_object($driver);
168
    if ($installer->installable()) {
169
      $databases[$driver] = $installer;
170
171
    }
  }
172

173
  // Usability: unconditionally put the MySQL driver on top.
174
175
176
177
178
  if (isset($databases['mysql'])) {
    $mysql_database = $databases['mysql'];
    unset($databases['mysql']);
    $databases = array('mysql' => $mysql_database) + $databases;
  }
179

180
181
182
  return $databases;
}

183
/**
184
 * Replace values in settings.php with values in the submitted array.
185
186
187
188
 *
 * @param $settings
 *   An array of settings that need to be updated.
 */
189
function drupal_rewrite_settings($settings = array()) {
190
  drupal_static_reset('conf_path');
191
  $settings_file = conf_path(FALSE) . '/settings.php';
192
193
194
195
196
197
198
199
200

  // Build list of setting names and insert the values into the global namespace.
  $keys = array();
  foreach ($settings as $setting => $data) {
    $GLOBALS[$setting] = $data['value'];
    $keys[] = $setting;
  }

  $buffer = NULL;
201
202
203
204
205
206
207
208
209
210
211
212
213
214
  $contents = file_get_contents(DRUPAL_ROOT . '/' . $settings_file);
  if ($contents !== FALSE) {
    // Step through each token in settings.php and replace any variables that
    // are in the passed-in array.
    $replacing_variable = FALSE;
    foreach (token_get_all($contents) as $token) {
      // Strip off the leading "$" before comparing the variable name.
      if (is_array($token) && $token[0] == T_VARIABLE && ($variable_name = substr($token[1], 1)) && in_array($variable_name, $keys)) {
        // Write the new value to settings.php in the following format:
        //    $[setting] = '[value]'; // [comment]
        $setting = $settings[$variable_name];
        $buffer .= '$' . $variable_name . ' = ' . var_export($setting['value'], TRUE) . ';';
        if (!empty($setting['comment'])) {
          $buffer .= ' // ' . $setting['comment'];
215
        }
216
217
        unset($settings[$variable_name]);
        $replacing_variable = TRUE;
218
      }
219
220
221
222
223
      else {
        // Write a regular token (that is not part of a variable we're
        // replacing) to settings.php directly.
        if (!$replacing_variable) {
          $buffer .= is_array($token) ? $token[1] : $token;
224
        }
225
226
227
228
        // When we hit a semicolon, we are done with the code that defines the
        // variable that is being replaced.
        if ($token == ';') {
          $replacing_variable = FALSE;
229
230
231
232
233
234
        }
      }
    }

    // Add required settings that were missing from settings.php.
    foreach ($settings as $setting => $data) {
235
      if (!empty($data['required'])) {
236
        $buffer .= "\$$setting = " . var_export($data['value'], TRUE) . ";\n";
237
238
239
      }
    }

240
241
    // Write the new settings file.
    if (file_put_contents(DRUPAL_ROOT . '/' . $settings_file, $buffer) === FALSE) {
242
      throw new Exception(st('Failed to modify %settings. Verify the file permissions.', array('%settings' => $settings_file)));
243
244
245
    }
  }
  else {
246
    throw new Exception(st('Failed to open %settings. Verify the file permissions.', array('%settings' => $settings_file)));
247
248
249
250
  }
}

/**
251
 * Verify an install profile for installation.
252
 *
253
254
 * @param $install_state
 *   An array of information about the current installation state.
Steven Wittens's avatar
Steven Wittens committed
255
256
 * @return
 *   The list of modules to install.
257
 */
258
259
260
function drupal_verify_profile($install_state) {
  $profile = $install_state['parameters']['profile'];

261
262
  include_once DRUPAL_ROOT . '/core/includes/file.inc';
  include_once DRUPAL_ROOT . '/core/includes/common.inc';
263

264
  $profile_file = DRUPAL_ROOT . "/profiles/$profile/$profile.profile";
265
266

  if (!isset($profile) || !file_exists($profile_file)) {
267
    throw new Exception(install_no_profile_error());
268
  }
269
  $info = $install_state['profile_info'];
270

271
272
  // Get a list of modules that exist in Drupal's assorted subdirectories.
  $present_modules = array();
273
  foreach (drupal_system_listing('/^' . DRUPAL_PHP_FUNCTION_PATTERN . '\.module$/', 'modules', 'name', 0) as $present_module) {
274
275
276
    $present_modules[] = $present_module->name;
  }

277
278
279
280
  // The install profile is also a module, which needs to be installed after all the other dependencies
  // have been installed.
  $present_modules[] = drupal_get_profile();

281
  // Verify that all of the profile's required modules are present.
282
  $missing_modules = array_diff($info['dependencies'], $present_modules);
283
284

  $requirements = array();
285

286
  if (count($missing_modules)) {
287
    $modules = array();
288
    foreach ($missing_modules as $module) {
289
      $modules[] = '<span class="admin-missing">' . drupal_ucfirst($module) . '</span>';
Steven Wittens's avatar
Steven Wittens committed
290
    }
291
292
293
294
    $requirements['required_modules'] = array(
      'title'       => st('Required modules'),
      'value'       => st('Required modules not found.'),
      'severity'    => REQUIREMENT_ERROR,
295
      'description' => st('The following modules are required but were not found. Move them into the appropriate modules subdirectory, such as <em>sites/all/modules</em>. Missing modules: !modules', array('!modules' => implode(', ', $modules))),
296
    );
Steven Wittens's avatar
Steven Wittens committed
297
  }
298
  return $requirements;
Steven Wittens's avatar
Steven Wittens committed
299
}
300

301
302
303
304
305
306
307
/**
 * Callback to install the system module.
 *
 * Separated from the installation of other modules so core system
 * functions can be made available while other modules are installed.
 */
function drupal_install_system() {
308
  $system_path = drupal_get_path('module', 'system');
309
  require_once DRUPAL_ROOT . '/' . $system_path . '/system.install';
Steven Wittens's avatar
Steven Wittens committed
310
  module_invoke('system', 'install');
311

Steven Wittens's avatar
Steven Wittens committed
312
313
  $system_versions = drupal_get_schema_versions('system');
  $system_version = $system_versions ? max($system_versions) : SCHEMA_INSTALLED;
314
  db_insert('system')
315
    ->fields(array('filename', 'name', 'type', 'owner', 'status', 'schema_version', 'bootstrap'))
316
317
318
319
320
321
    ->values(array(
        'filename' => $system_path . '/system.module',
        'name' => 'system',
        'type' => 'module',
        'owner' => '',
        'status' => 1,
322
323
324
        'schema_version' => $system_version,
        'bootstrap' => 0,
      ))
325
    ->execute();
326
  system_rebuild_module_data();
327
  config_install_default_config('system');
328
329
}

330
331
332
333
334
335
336
337
338
339
/**
 * Verify the state of the specified file.
 *
 * @param $file
 *   The file to check for.
 * @param $mask
 *   An optional bitmask created from various FILE_* constants.
 * @param $type
 *   The type of file. Can be file (default), dir, or link.
 * @return
340
 *   TRUE on success or FALSE on failure. A message is set for the latter.
341
342
343
344
345
346
347
348
349
 */
function drupal_verify_install_file($file, $mask = NULL, $type = 'file') {
  $return = TRUE;
  // Check for files that shouldn't be there.
  if (isset($mask) && ($mask & FILE_NOT_EXIST) && file_exists($file)) {
    return FALSE;
  }
  // Verify that the file is the type of file it is supposed to be.
  if (isset($type) && file_exists($file)) {
350
    $check = 'is_' . $type;
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
    if (!function_exists($check) || !$check($file)) {
      $return = FALSE;
    }
  }

  // Verify file permissions.
  if (isset($mask)) {
    $masks = array(FILE_EXIST, FILE_READABLE, FILE_WRITABLE, FILE_EXECUTABLE, FILE_NOT_READABLE, FILE_NOT_WRITABLE, FILE_NOT_EXECUTABLE);
    foreach ($masks as $current_mask) {
      if ($mask & $current_mask) {
        switch ($current_mask) {
          case FILE_EXIST:
            if (!file_exists($file)) {
              if ($type == 'dir') {
                drupal_install_mkdir($file, $mask);
              }
              if (!file_exists($file)) {
                $return = FALSE;
              }
            }
            break;
          case FILE_READABLE:
            if (!is_readable($file) && !drupal_install_fix_file($file, $mask)) {
              $return = FALSE;
            }
            break;
          case FILE_WRITABLE:
            if (!is_writable($file) && !drupal_install_fix_file($file, $mask)) {
              $return = FALSE;
            }
            break;
          case FILE_EXECUTABLE:
            if (!is_executable($file) && !drupal_install_fix_file($file, $mask)) {
              $return = FALSE;
            }
            break;
          case FILE_NOT_READABLE:
            if (is_readable($file) && !drupal_install_fix_file($file, $mask)) {
              $return = FALSE;
            }
            break;
          case FILE_NOT_WRITABLE:
            if (is_writable($file) && !drupal_install_fix_file($file, $mask)) {
              $return = FALSE;
            }
            break;
          case FILE_NOT_EXECUTABLE:
            if (is_executable($file) && !drupal_install_fix_file($file, $mask)) {
              $return = FALSE;
            }
            break;
        }
      }
    }
  }
  return $return;
}

/**
 * Create a directory with specified permissions.
 *
412
 * @param $file
413
 *  The name of the directory to create;
414
 * @param $mask
415
416
417
418
419
420
421
422
423
424
425
426
427
 *  The permissions of the directory to create.
 * @param $message
 *  (optional) Whether to output messages. Defaults to TRUE.
 * @return
 *  TRUE/FALSE whether or not the directory was successfully created.
 */
function drupal_install_mkdir($file, $mask, $message = TRUE) {
  $mod = 0;
  $masks = array(FILE_READABLE, FILE_WRITABLE, FILE_EXECUTABLE, FILE_NOT_READABLE, FILE_NOT_WRITABLE, FILE_NOT_EXECUTABLE);
  foreach ($masks as $m) {
    if ($mask & $m) {
      switch ($m) {
        case FILE_READABLE:
428
          $mod |= 0444;
429
430
          break;
        case FILE_WRITABLE:
431
          $mod |= 0222;
432
433
          break;
        case FILE_EXECUTABLE:
434
          $mod |= 0111;
435
436
437
438
439
          break;
      }
    }
  }

440
  if (@drupal_mkdir($file, $mod)) {
441
442
443
444
445
446
447
448
449
450
    return TRUE;
  }
  else {
    return FALSE;
  }
}

/**
 * Attempt to fix file permissions.
 *
451
452
453
454
455
456
457
458
459
 * The general approach here is that, because we do not know the security
 * setup of the webserver, we apply our permission changes to all three
 * digits of the file permission (i.e. user, group and all).
 *
 * To ensure that the values behave as expected (and numbers don't carry
 * from one digit to the next) we do the calculation on the octal value
 * using bitwise operations. This lets us remove, for example, 0222 from
 * 0700 and get the correct value of 0500.
 *
460
461
462
463
464
465
466
467
468
469
 * @param $file
 *  The name of the file with permissions to fix.
 * @param $mask
 *  The desired permissions for the file.
 * @param $message
 *  (optional) Whether to output messages. Defaults to TRUE.
 * @return
 *  TRUE/FALSE whether or not we were able to fix the file's permissions.
 */
function drupal_install_fix_file($file, $mask, $message = TRUE) {
470
471
472
473
474
  // If $file does not exist, fileperms() issues a PHP warning.
  if (!file_exists($file)) {
    return FALSE;
  }

475
  $mod = fileperms($file) & 0777;
476
  $masks = array(FILE_READABLE, FILE_WRITABLE, FILE_EXECUTABLE, FILE_NOT_READABLE, FILE_NOT_WRITABLE, FILE_NOT_EXECUTABLE);
477
478
479
480
481

  // FILE_READABLE, FILE_WRITABLE, and FILE_EXECUTABLE permission strings
  // can theoretically be 0400, 0200, and 0100 respectively, but to be safe
  // we set all three access types in case the administrator intends to
  // change the owner of settings.php after installation.
482
483
484
485
486
  foreach ($masks as $m) {
    if ($mask & $m) {
      switch ($m) {
        case FILE_READABLE:
          if (!is_readable($file)) {
487
            $mod |= 0444;
488
489
490
491
          }
          break;
        case FILE_WRITABLE:
          if (!is_writable($file)) {
492
            $mod |= 0222;
493
494
495
496
          }
          break;
        case FILE_EXECUTABLE:
          if (!is_executable($file)) {
497
            $mod |= 0111;
498
499
500
501
          }
          break;
        case FILE_NOT_READABLE:
          if (is_readable($file)) {
502
            $mod &= ~0444;
503
504
505
506
          }
          break;
        case FILE_NOT_WRITABLE:
          if (is_writable($file)) {
507
            $mod &= ~0222;
508
509
510
511
          }
          break;
        case FILE_NOT_EXECUTABLE:
          if (is_executable($file)) {
512
            $mod &= ~0111;
513
514
515
516
517
518
          }
          break;
      }
    }
  }

519
520
521
522
  // chmod() will work if the web server is running as owner of the file.
  // If PHP safe_mode is enabled the currently executing script must also
  // have the same owner.
  if (@chmod($file, $mod)) {
523
524
525
526
527
528
529
    return TRUE;
  }
  else {
    return FALSE;
  }
}

530
/**
531
 * Send the user to a different installer page.
532
533
 *
 * This issues an on-site HTTP redirect. Messages (and errors) are erased.
534
535
536
537
538
 *
 * @param $path
 *   An installer path.
 */
function install_goto($path) {
539
  global $base_url;
540
  include_once DRUPAL_ROOT . '/core/includes/common.inc';
541
  header('Location: ' . $base_url . '/' . $path);
542
  header('Cache-Control: no-cache'); // Not a permanent redirect.
543
  drupal_exit();
544
545
}

546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
/**
 * Returns the URL of the current script, with modified query parameters.
 *
 * This function can be called by low-level scripts (such as install.php and
 * update.php) and returns the URL of the current script. Existing query
 * parameters are preserved by default, but new ones can optionally be merged
 * in.
 *
 * This function is used when the script must maintain certain query parameters
 * over multiple page requests in order to work correctly. In such cases (for
 * example, update.php, which requires the 'continue=1' parameter to remain in
 * the URL throughout the update process if there are any requirement warnings
 * that need to be bypassed), using this function to generate the URL for links
 * to the next steps of the script ensures that the links will work correctly.
 *
 * @param $query
 *   (optional) An array of query parameters to merge in to the existing ones.
 *
 * @return
 *   The URL of the current script, with query parameters modified by the
 *   passed-in $query. The URL is not sanitized, so it still needs to be run
 *   through check_url() if it will be used as an HTML attribute value.
 *
 * @see drupal_requirements_url()
 */
function drupal_current_script_url($query = array()) {
  $uri = $_SERVER['SCRIPT_NAME'];
  $query = array_merge(drupal_get_query_parameters(), $query);
  if (!empty($query)) {
    $uri .= '?' . drupal_http_build_query($query);
  }
  return $uri;
}

/**
 * Returns a URL for proceeding to the next page after a requirements problem.
 *
 * This function can be called by low-level scripts (such as install.php and
 * update.php) and returns a URL that can be used to attempt to proceed to the
 * next step of the script.
 *
 * @param $severity
 *   The severity of the requirements problem, as returned by
 *   drupal_requirements_severity().
 *
 * @return
 *   A URL for attempting to proceed to the next step of the script. The URL is
 *   not sanitized, so it still needs to be run through check_url() if it will
 *   be used as an HTML attribute value.
 *
 * @see drupal_current_script_url()
 */
function drupal_requirements_url($severity) {
  $query = array();
  // If there are no errors, only warnings, append 'continue=1' to the URL so
  // the user can bypass this screen on the next page load.
  if ($severity == REQUIREMENT_WARNING) {
    $query['continue'] = 1;
  }
  return drupal_current_script_url($query);
}

608
/**
609
610
611
 * Functional equivalent of t(), used when some systems are not available.
 *
 * Used during the install process, when database, theme, and localization
612
 * system is possibly not yet available.
613
 *
614
615
616
617
 * Use t() if your code will never run during the Drupal installation phase.
 * Use st() if your code will only run during installation and never any other
 * time. Use get_t() if your code could run in either circumstance.
 *
618
 * @see t()
619
 * @see get_t()
620
 * @ingroup sanitization
621
 */
622
function st($string, array $args = array(), array $options = array()) {
623
  static $strings = NULL;
624
  global $install_state;
drumm's avatar
drumm committed
625

626
627
628
629
  if (empty($options['context'])) {
    $options['context'] = '';
  }

630
631
  if (!isset($strings)) {
    $strings = array();
632
    if (isset($install_state['parameters']['langcode'])) {
633
634
      // If the given langcode was selected, there should be at least one .po file
      // with its name ending in install.{$install_state['parameters']['langcode']}.po
635
636
      // This might or might not be the entire filename. It is also possible
      // that multiple files end with the same extension, even if unlikely.
637
638
      $files = install_find_translation_files($install_state['parameters']['langcode']);
      if (!empty($files)) {
639
640
        // Include cross-dependent code from locale module and gettext.inc.
        require_once DRUPAL_ROOT . '/core/modules/locale/locale.module';
641
        require_once DRUPAL_ROOT . '/core/includes/gettext.inc';
642
643
        foreach ($files as $file) {
          _locale_import_read_po('mem-store', $file);
644
        }
645
        $strings = _locale_import_one_string('mem-report');
646
      }
647
    }
drumm's avatar
drumm committed
648
649
  }

650
  require_once DRUPAL_ROOT . '/core/includes/theme.inc';
651
  // Transform arguments before inserting them
652
  foreach ($args as $key => $value) {
653
654
655
656
657
658
659
660
    switch ($key[0]) {
      // Escaped only
      case '@':
        $args[$key] = check_plain($value);
        break;
      // Escaped and placeholder
      case '%':
      default:
661
        $args[$key] = '<em>' . check_plain($value) . '</em>';
662
663
664
665
        break;
      // Pass-through
      case '!':
    }
666
  }
667
  return strtr((!empty($strings[$options['context']][$string]) ? $strings[$options['context']][$string] : $string), $args);
668
}
669
670

/**
671
 * Check an install profile's requirements.
672
 *
673
674
675
676
 * @param $profile
 *   Name of install profile to check.
 * @return
 *   Array of the install profile's requirements.
677
678
 */
function drupal_check_profile($profile) {
679
  include_once DRUPAL_ROOT . '/core/includes/file.inc';
680

681
  $profile_file = DRUPAL_ROOT . "/profiles/$profile/$profile.profile";
682
683

  if (!isset($profile) || !file_exists($profile_file)) {
684
    throw new Exception(install_no_profile_error());
685
686
  }

687
  $info = install_profile_info($profile);
688

689
  // Collect requirement testing results.
690
  $requirements = array();
691
692
693
  foreach ($info['dependencies'] as $module) {
    module_load_install($module);
    $function = $module . '_requirements';
694
695
    if (function_exists($function)) {
      $requirements = array_merge($requirements, $function('install'));
696
    }
697
698
699
700
701
702
  }
  return $requirements;
}

/**
 * Extract highest severity from requirements array.
703
704
 *
 * @param $requirements
705
 *   An array of requirements, in the same format as is returned by
706
707
708
 *   hook_requirements().
 * @return
 *   The highest severity in the array.
709
710
711
712
713
714
715
716
717
718
719
720
721
 */
function drupal_requirements_severity(&$requirements) {
  $severity = REQUIREMENT_OK;
  foreach ($requirements as $requirement) {
    if (isset($requirement['severity'])) {
      $severity = max($severity, $requirement['severity']);
    }
  }
  return $severity;
}

/**
 * Check a module's requirements.
722
723
724
725
726
 *
 * @param $module
 *   Machine name of module to check.
 * @return
 *   TRUE/FALSE depending on the requirements are in place.
727
728
 */
function drupal_check_module($module) {
729
730
  module_load_install($module);
  if (module_hook($module, 'requirements')) {
731
732
733
734
735
736
    // Check requirements
    $requirements = module_invoke($module, 'requirements', 'install');
    if (is_array($requirements) && drupal_requirements_severity($requirements) == REQUIREMENT_ERROR) {
      // Print any error messages
      foreach ($requirements as $requirement) {
        if (isset($requirement['severity']) && $requirement['severity'] == REQUIREMENT_ERROR) {
737
738
          $message = $requirement['description'];
          if (isset($requirement['value']) && $requirement['value']) {
739
            $message .= ' (' . t('Currently using !item !version', array('!item' => $requirement['title'], '!version' => $requirement['value'])) . ')';
740
741
          }
          drupal_set_message($message, 'error');
742
743
744
745
746
747
748
        }
      }
      return FALSE;
    }
  }
  return TRUE;
}
749
750
751

/**
 * Retrieve info about an install profile from its .info file.
752
 *
753
754
 * The information stored in a profile .info file is similar to that stored in
 * a normal Drupal module .info file. For example:
755
756
757
758
 * - name: The real name of the install profile for display purposes.
 * - description: A brief description of the profile.
 * - dependencies: An array of shortnames of other modules this install profile requires.
 *
759
760
761
762
763
764
 * Additional, less commonly-used information that can appear in a profile.info
 * file but not in a normal Drupal module .info file includes:
 * - distribution_name: The name of the Drupal distribution that is being
 *   installed, to be shown throughout the installation process. Defaults to
 *   'Drupal'.
 *
765
766
767
768
 * Note that this function does an expensive file system scan to get info file
 * information for dependencies. If you only need information from the info
 * file itself, use system_get_info().
 *
769
 * Example of .info file:
770
 * @code
771
772
 *    name = Minimal
 *    description = Start fresh, with only a few modules enabled.
773
774
 *    dependencies[] = block
 *    dependencies[] = dblog
775
 * @endcode
776
 *
777
 * @param $profile
778
 *   Name of profile.
779
780
 * @param $langcode
 *   Language code (if any).
781
 *
782
783
 * @return
 *   The info array.
784
 */
785
function install_profile_info($profile, $langcode = 'en') {
786
787
788
789
790
791
792
  $cache = &drupal_static(__FUNCTION__, array());

  if (!isset($cache[$profile])) {
    // Set defaults for module info.
    $defaults = array(
      'dependencies' => array(),
      'description' => '',
793
      'distribution_name' => 'Drupal',
794
      'version' => NULL,
795
      'hidden' => FALSE,
796
797
798
799
      'php' => DRUPAL_MINIMUM_PHP,
    );
    $info = drupal_parse_info_file("profiles/$profile/$profile.info") + $defaults;
    $info['dependencies'] = array_unique(array_merge(
800
801
      drupal_required_modules(),
      $info['dependencies'],
802
      ($langcode != 'en' && !empty($langcode) ? array('locale') : array()))
803
    );
804
805
806
807
808

    // drupal_required_modules() includes the current profile as a dependency.
    // Since a module can't depend on itself we remove that element of the array.
    array_shift($info['dependencies']);

809
810
811
    $cache[$profile] = $info;
  }
  return $cache[$profile];
812
813
}

814
815
816
817
818
/**
 * Ensures the environment for a Drupal database on a predefined connection.
 *
 * This will run tasks that check that Drupal can perform all of the functions
 * on a database, that Drupal needs. Tasks include simple checks like CREATE
819
 * TABLE to database specific functions like stored procedures and client
820
821
822
 * encoding.
 */
function db_run_tasks($driver) {
823
  db_installer_object($driver)->runTasks();
824
  return TRUE;
825
}
826
827
828
829
830
831
832
833

/**
 * Returns a database installer object.
 *
 * @param $driver
 *   The name of the driver.
 */
function db_installer_object($driver) {
834
835
  // We cannot use Database::getConnection->getDriverClass() here, because
  // the connection object is not yet functional.
836
  $task_class = "Drupal\\Core\\Database\\Driver\\{$driver}\\Install\\Tasks";
837
838
  return new $task_class();
}