Newer
Older
<?php
Jennifer Hodgdon
committed
/**
* @file
* API functions for installing modules and themes.
*/
use Symfony\Component\HttpFoundation\RedirectResponse;
Angie Byron
committed
use Drupal\Component\Utility\Crypt;
use Drupal\Component\Utility\OpCodeCache;
catch
committed
use Drupal\Component\Utility\Settings;
use Drupal\Component\Utility\UrlHelper;
use Drupal\Core\Database\Database;
use Drupal\Core\DrupalKernel;
catch
committed
use Drupal\Core\Extension\ExtensionDiscovery;
Larry Garfield
committed
/**
* Requirement severity -- Informational message only.
*/
const REQUIREMENT_INFO = -1;
/**
* Requirement severity -- Requirement successfully met.
*/
const REQUIREMENT_OK = 0;
/**
* Requirement severity -- Warning condition; proceed but flag warning.
*/
const REQUIREMENT_WARNING = 1;
/**
* Requirement severity -- Error condition; abort installation.
*/
const REQUIREMENT_ERROR = 2;
/**
* File permission check -- File exists.
*/
const FILE_EXIST = 1;
/**
* File permission check -- File is readable.
*/
const FILE_READABLE = 2;
/**
* File permission check -- File is writable.
*/
const FILE_WRITABLE = 4;
/**
* File permission check -- File is executable.
*/
const FILE_EXECUTABLE = 8;
/**
* File permission check -- File does not exist.
*/
const FILE_NOT_EXIST = 16;
/**
* File permission check -- File is not readable.
*/
const FILE_NOT_READABLE = 32;
/**
* File permission check -- File is not writable.
*/
const FILE_NOT_WRITABLE = 64;
/**
* File permission check -- File is not executable.
*/
const FILE_NOT_EXECUTABLE = 128;
Jennifer Hodgdon
committed
* Loads .install files for installed modules to initialize the update system.
*/
function drupal_load_updates() {
foreach (drupal_get_installed_schema_version(NULL, FALSE, TRUE) as $module => $schema_version) {
if ($schema_version > -1) {
module_load_install($module);
}
}
}
Dries Buytaert
committed
/**
Jennifer Hodgdon
committed
* Loads the installation profile, extracting its defined distribution name.
Dries Buytaert
committed
*
* @return
* The distribution name defined in the profile's .info.yml file. Defaults to
Jennifer Hodgdon
committed
* "Drupal" if none is explicitly provided by the installation profile.
*
* @see install_profile_info()
Dries Buytaert
committed
*/
function drupal_install_profile_distribution_name() {
Angie Byron
committed
// During installation, the profile information is stored in the global
// installation state (it might not be saved anywhere yet).
$info = array();
Angie Byron
committed
if (drupal_installation_attempted()) {
global $install_state;
if (isset($install_state['profile_info'])) {
$info = $install_state['profile_info'];
}
Angie Byron
committed
}
// At all other times, we load the profile via standard methods.
else {
$profile = drupal_get_profile();
Dries Buytaert
committed
$info = system_get_info('module', $profile);
Angie Byron
committed
}
return isset($info['distribution']['name']) ? $info['distribution']['name'] : 'Drupal';
Dries Buytaert
committed
}
/**
Jennifer Hodgdon
committed
* Detects all supported databases that are compiled into PHP.
Dries Buytaert
committed
*
* @return
* An array of database types compiled into PHP.
*/
function drupal_detect_database_types() {
Angie Byron
committed
$databases = drupal_get_database_types();
foreach ($databases as $driver => $installer) {
$databases[$driver] = $installer->name();
}
return $databases;
}
/**
catch
committed
* Returns all supported database driver installer objects.
Angie Byron
committed
*
catch
committed
* @return \Drupal\Core\Database\Install\Tasks[]
* An array of available database driver installer objects.
Angie Byron
committed
*/
function drupal_get_database_types() {
Dries Buytaert
committed
$databases = array();
Larry Garfield
committed
$drivers = array();
Dries Buytaert
committed
catch
committed
// The internal database driver name is any valid PHP identifier.
$mask = '/^' . DRUPAL_PHP_FUNCTION_PATTERN . '$/';
$files = file_scan_directory(DRUPAL_ROOT . '/core/lib/Drupal/Core/Database/Driver', $mask, array('recurse' => FALSE));
if (is_dir(DRUPAL_ROOT . '/drivers/lib/Drupal/Driver/Database')) {
$files += file_scan_directory(DRUPAL_ROOT . '/drivers/lib/Drupal/Driver/Database/', $mask, array('recurse' => FALSE));
}
foreach ($files as $file) {
Larry Garfield
committed
if (file_exists($file->uri . '/Install/Tasks.php')) {
Angie Byron
committed
$drivers[$file->filename] = $file->uri;
}
Dries Buytaert
committed
}
foreach ($drivers as $driver => $file) {
Angie Byron
committed
$installer = db_installer_object($driver);
Dries Buytaert
committed
if ($installer->installable()) {
Angie Byron
committed
$databases[$driver] = $installer;
Dries Buytaert
committed
}
}
Dries Buytaert
committed
// Usability: unconditionally put the MySQL driver on top.
Dries Buytaert
committed
if (isset($databases['mysql'])) {
$mysql_database = $databases['mysql'];
unset($databases['mysql']);
$databases = array('mysql' => $mysql_database) + $databases;
}
Dries Buytaert
committed
return $databases;
}
Dries Buytaert
committed
/**
Jennifer Hodgdon
committed
* Replaces values in settings.php with values in the submitted array.
Dries Buytaert
committed
*
Angie Byron
committed
* This function replaces values in place if possible, even for
* multidimensional arrays. This way the old settings do not linger,
* overridden and also the doxygen on a value remains where it should be.
*
Dries Buytaert
committed
* @param $settings
Angie Byron
committed
* An array of settings that need to be updated. Multidimensional arrays
* are dumped up to a stdClass object. The object can have value, required
* and comment properties.
* @code
* $settings['config_directories'] = array(
catch
committed
* CONFIG_ACTIVE_DIRECTORY => (object) array(
* 'value' => 'config_hash/active'
* 'required' => TRUE,
Angie Byron
committed
* ),
catch
committed
* CONFIG_STAGING_DIRECTORY => (object) array(
* 'value' => 'config_hash/staging',
* 'required' => TRUE,
Angie Byron
committed
* ),
* );
* @endcode
* gets dumped as:
* @code
catch
committed
* $config_directories['active'] = 'config_hash/active';
* $config_directories['staging'] = 'config_hash/staging'
Angie Byron
committed
* @endcode
Dries Buytaert
committed
*/
Angie Byron
committed
function drupal_rewrite_settings($settings = array(), $settings_file = NULL) {
if (!isset($settings_file)) {
$settings_file = conf_path(FALSE) . '/settings.php';
}
Dries Buytaert
committed
// Build list of setting names and insert the values into the global namespace.
Angie Byron
committed
$variable_names = array();
catch
committed
$settings_settings = array();
Dries Buytaert
committed
foreach ($settings as $setting => $data) {
catch
committed
if ($setting != 'settings') {
_drupal_rewrite_settings_global($GLOBALS[$setting], $data);
}
else {
_drupal_rewrite_settings_global($settings_settings, $data);
}
Angie Byron
committed
$variable_names['$'. $setting] = $setting;
Dries Buytaert
committed
}
$contents = file_get_contents(DRUPAL_ROOT . '/' . $settings_file);
if ($contents !== FALSE) {
Angie Byron
committed
// Initialize the contents for the settings.php file if it is empty.
if (trim($contents) === '') {
$contents = "<?php\n";
}
// Step through each token in settings.php and replace any variables that
// are in the passed-in array.
Angie Byron
committed
$buffer = '';
$state = 'default';
foreach (token_get_all($contents) as $token) {
Angie Byron
committed
if (is_array($token)) {
list($type, $value) = $token;
Dries Buytaert
committed
}
else {
Angie Byron
committed
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
$type = -1;
$value = $token;
}
// Do not operate on whitespace.
if (!in_array($type, array(T_WHITESPACE, T_COMMENT, T_DOC_COMMENT))) {
switch ($state) {
case 'default':
if ($type === T_VARIABLE && isset($variable_names[$value])) {
// This will be necessary to unset the dumped variable.
$parent = &$settings;
// This is the current index in parent.
$index = $variable_names[$value];
// This will be necessary for descending into the array.
$current = &$parent[$index];
$state = 'candidate_left';
}
break;
case 'candidate_left':
if ($value == '[') {
$state = 'array_index';
}
if ($value == '=') {
$state = 'candidate_right';
}
break;
case 'array_index':
if (_drupal_rewrite_settings_is_array_index($type, $value)) {
$index = trim($value, '\'"');
$state = 'right_bracket';
}
else {
// $a[foo()] or $a[$bar] or something like that.
throw new Exception('invalid array index');
}
break;
case 'right_bracket':
if ($value == ']') {
if (isset($current[$index])) {
// If the new settings has this index, descend into it.
$parent = &$current;
$current = &$parent[$index];
$state = 'candidate_left';
}
else {
// Otherwise, jump back to the default state.
$state = 'wait_for_semicolon';
}
}
else {
// $a[1 + 2].
throw new Exception('] expected');
}
break;
case 'candidate_right':
if (_drupal_rewrite_settings_is_simple($type, $value)) {
$value = _drupal_rewrite_settings_dump_one($current);
// Unsetting $current would not affect $settings at all.
unset($parent[$index]);
// Skip the semicolon because _drupal_rewrite_settings_dump_one() added one.
$state = 'semicolon_skip';
}
else {
$state = 'wait_for_semicolon';
}
break;
case 'wait_for_semicolon':
if ($value == ';') {
$state = 'default';
}
break;
case 'semicolon_skip':
if ($value == ';') {
$value = '';
$state = 'default';
}
else {
// If the expression was $a = 1 + 2; then we replaced 1 and
// the + is unexpected.
Alex Pott
committed
throw new Exception('Unexpected token after replacing value.');
Angie Byron
committed
}
break;
Dries Buytaert
committed
}
}
Angie Byron
committed
$buffer .= $value;
Dries Buytaert
committed
}
Angie Byron
committed
foreach ($settings as $name => $setting) {
$buffer .= _drupal_rewrite_settings_dump($setting, '$' . $name);
Dries Buytaert
committed
}
// Write the new settings file.
if (file_put_contents(DRUPAL_ROOT . '/' . $settings_file, $buffer) === FALSE) {
throw new Exception(t('Failed to modify %settings. Verify the file permissions.', array('%settings' => $settings_file)));
Dries Buytaert
committed
}
catch
committed
else {
// In case any $settings variables were written, import them into the
// Settings singleton.
if (!empty($settings_settings)) {
$old_settings = Settings::getAll();
catch
committed
new Settings($settings_settings + $old_settings);
}
// The existing settings.php file might have been included already. In
// case an opcode cache is enabled, the rewritten contents of the file
// will not be reflected in this process. Ensure to invalidate the file
// in case an opcode cache is enabled.
OpCodeCache::invalidate(DRUPAL_ROOT . '/' . $settings_file);
catch
committed
}
Dries Buytaert
committed
}
else {
throw new Exception(t('Failed to open %settings. Verify the file permissions.', array('%settings' => $settings_file)));
Dries Buytaert
committed
}
}
Angie Byron
committed
341
342
343
344
345
346
347
348
349
350
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
/**
* Helper for drupal_rewrite_settings().
*
* Checks whether this token represents a scalar or NULL.
*
* @param int $type
* The token type
* @see token_name().
* @param string $value
* The value of the token.
*
* @return bool
* TRUE if this token represents a scalar or NULL.
*/
function _drupal_rewrite_settings_is_simple($type, $value) {
$is_integer = $type == T_LNUMBER;
$is_float = $type == T_DNUMBER;
$is_string = $type == T_CONSTANT_ENCAPSED_STRING;
$is_boolean_or_null = $type == T_STRING && in_array(strtoupper($value), array('TRUE', 'FALSE', 'NULL'));
return $is_integer || $is_float || $is_string || $is_boolean_or_null;
}
/**
* Helper for drupal_rewrite_settings().
*
* Checks whether this token represents a valid array index: a number or a
* stirng.
*
* @param int $type
* The token type
* @see token_name().
*
* @return bool
* TRUE if this token represents a number or a string.
*/
function _drupal_rewrite_settings_is_array_index($type) {
$is_integer = $type == T_LNUMBER;
$is_float = $type == T_DNUMBER;
$is_string = $type == T_CONSTANT_ENCAPSED_STRING;
return $is_integer || $is_float || $is_string;
}
/**
* Helper for drupal_rewrite_settings().
*
* Makes the new settings global.
*
Jennifer Hodgdon
committed
* @param array|null $ref
Angie Byron
committed
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
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
* A reference to a nested index in $GLOBALS.
* @param array|object $variable
* The nested value of the setting being copied.
*/
function _drupal_rewrite_settings_global(&$ref, $variable) {
if (is_object($variable)) {
$ref = $variable->value;
}
else {
foreach ($variable as $k => $v) {
_drupal_rewrite_settings_global($ref[$k], $v);
}
}
}
/**
* Helper for drupal_rewrite_settings().
*
* Dump the relevant value properties.
*
* @param array|object $variable
* The container for variable values.
* @param string $variable_name
* Name of variable.
* @return string
* A string containing valid PHP code of the variable suitable for placing
* into settings.php.
*/
function _drupal_rewrite_settings_dump($variable, $variable_name) {
$return = '';
if (is_object($variable)) {
if (!empty($variable->required)) {
$return .= _drupal_rewrite_settings_dump_one($variable, "$variable_name = ", "\n");
}
}
else {
foreach ($variable as $k => $v) {
$return .= _drupal_rewrite_settings_dump($v, $variable_name . "['" . $k . "']");
}
}
return $return;
}
/**
* Helper for drupal_rewrite_settings().
*
* Dump the value of a value property and adds the comment if it exists.
*
Jennifer Hodgdon
committed
* @param object $variable
Angie Byron
committed
* A stdClass object with at least a value property.
* @param string $prefix
* A string to prepend to the variable's value.
* @param string $suffix
* A string to append to the variable's value.
* @return string
* A string containing valid PHP code of the variable suitable for placing
* into settings.php.
*/
function _drupal_rewrite_settings_dump_one(\stdClass $variable, $prefix = '', $suffix = '') {
$return = $prefix . var_export($variable->value, TRUE) . ';';
if (!empty($variable->comment)) {
$return .= ' // ' . $variable->comment;
}
$return .= $suffix;
return $return;
}
/**
* Creates the config directory and ensures it is operational.
*
* @see install_settings_form_submit()
* @see update_prepare_d8_bootstrap()
*/
function drupal_install_config_directories() {
Angie Byron
committed
global $config_directories;
// Add a randomized config directory name to settings.php, unless it was
// manually defined in the existing already.
Angie Byron
committed
if (empty($config_directories)) {
Angie Byron
committed
$config_directories_hash = Crypt::randomBytesBase64(55);
Angie Byron
committed
$settings['config_directories'] = array(
catch
committed
CONFIG_ACTIVE_DIRECTORY => (object) array(
'value' => conf_path() . '/files/config_' . $config_directories_hash . '/active',
'required' => TRUE,
Angie Byron
committed
),
catch
committed
CONFIG_STAGING_DIRECTORY => (object) array(
'value' => conf_path() . '/files/config_' . $config_directories_hash . '/staging',
'required' => TRUE,
Angie Byron
committed
),
);
// Rewrite settings.php, which also sets the value as global variable.
drupal_rewrite_settings($settings);
}
catch
committed
// Ensure the config directories exist or can be created, and are writable.
Angie Byron
committed
foreach (array(CONFIG_ACTIVE_DIRECTORY, CONFIG_STAGING_DIRECTORY) as $config_type) {
// This should never fail, since if the config directory was specified in
// settings.php it will have already been created and verified earlier, and
// if it wasn't specified in settings.php, it is created here inside the
// public files directory, which has already been verified to be writable
// itself. But if it somehow fails anyway, the installation cannot proceed.
// Bail out using a similar error message as in system_requirements().
if (!install_ensure_config_directory($config_type)) {
throw new Exception(t('The directory %directory could not be created or could not be made writable. 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 the <a href="@handbook_url">online handbook</a>.', array(
Angie Byron
committed
'%directory' => config_get_config_directory($config_type),
'@handbook_url' => 'http://drupal.org/server-permissions',
)));
}
// Put a README.txt into each config directory. This is required so that
// they can later be added to git. Since these directories are auto-
// created, we have to write out the README rather than just adding it
// to the drupal core repo.
switch ($config_type) {
case CONFIG_ACTIVE_DIRECTORY:
Angie Byron
committed
$text = 'This directory contains the active configuration for your Drupal site. To move this configuration between environments, contents from this directory should be placed in the staging directory on the target server. To make this configuration active, see admin/config/development/configuration/sync on the target server.';
break;
case CONFIG_STAGING_DIRECTORY:
Angie Byron
committed
$text = 'This directory contains configuration to be imported into your Drupal site. To make this configuration active, see admin/config/development/configuration/sync.';
break;
}
$text .= ' For information about deploying configuration between servers, see http://drupal.org/documentation/administer/config';
file_put_contents(config_get_config_directory($config_type) . '/README.txt', $text);
}
}
Angie Byron
committed
/**
* Checks whether a config directory exists and is writable.
Angie Byron
committed
*
catch
committed
* This partially duplicates install_ensure_config_directory(), but is required
Angie Byron
committed
* since the installer would create the config directory too early in the
* installation process otherwise (e.g., when only visiting install.php when
* there is a settings.php already, but not actually executing the
* installation).
Angie Byron
committed
*
* @param string $type
* Type of config directory to return. Drupal core provides 'active' and
* 'staging'.
*
* @return bool
* TRUE if the config directory exists and is writable.
*/
function install_verify_config_directory($type) {
global $config_directories;
if (!isset($config_directories[$type])) {
return FALSE;
}
catch
committed
// config_get_config_directory() throws an exception when the passed $type
// does not exist in $config_directories. This can happen if there is a
// prepared settings.php that defines $config_directories already.
try {
$config_directory = config_get_config_directory($type);
if (is_dir($config_directory) && is_writable($config_directory)) {
return TRUE;
}
}
catch (\Exception $e) {
Angie Byron
committed
}
return FALSE;
}
/**
* Ensures that the config directory exists and is writable, or can be made so.
Angie Byron
committed
*
* @param string $type
* Type of config directory to return. Drupal core provides 'active' and
* 'staging'.
*
* @return bool
* TRUE if the config directory exists and is writable.
*/
function install_ensure_config_directory($type) {
// The config directory must be defined in settings.php.
Angie Byron
committed
global $config_directories;
if (!isset($config_directories[$type])) {
return FALSE;
}
// The logic here is similar to that used by system_requirements() for other
// directories that the installer creates.
else {
Angie Byron
committed
$config_directory = config_get_config_directory($type);
return file_prepare_directory($config_directory, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);
}
}
Dries Buytaert
committed
/**
Jennifer Hodgdon
committed
* Verifies that all dependencies are met for a given installation profile.
Dries Buytaert
committed
*
Dries Buytaert
committed
* @param $install_state
* An array of information about the current installation state.
Jennifer Hodgdon
committed
*
Dries Buytaert
committed
*/
Dries Buytaert
committed
function drupal_verify_profile($install_state) {
include_once __DIR__ . '/file.inc';
include_once __DIR__ . '/common.inc';
Dries Buytaert
committed
$profile = $install_state['parameters']['profile'];
if (!isset($profile) || !isset($install_state['profiles'][$profile])) {
Dries Buytaert
committed
throw new Exception(install_no_profile_error());
Dries Buytaert
committed
}
Dries Buytaert
committed
$info = $install_state['profile_info'];
catch
committed
// Get the list of available modules for the selected installation profile.
$listing = new ExtensionDiscovery();
Dries Buytaert
committed
$present_modules = array();
catch
committed
foreach ($listing->scan('module') as $present_module) {
$present_modules[] = $present_module->getName();
Dries Buytaert
committed
}
Jennifer Hodgdon
committed
// The installation profile is also a module, which needs to be installed
// after all the other dependencies have been installed.
catch
committed
$present_modules[] = $profile;
Angie Byron
committed
Dries Buytaert
committed
// Verify that all of the profile's required modules are present.
$missing_modules = array_diff($info['dependencies'], $present_modules);
Angie Byron
committed
$requirements = array();
Dries Buytaert
committed
if (count($missing_modules)) {
Angie Byron
committed
$modules = array();
foreach ($missing_modules as $module) {
Angie Byron
committed
$modules[] = '<span class="admin-missing">' . drupal_ucfirst($module) . '</span>';
Angie Byron
committed
$requirements['required_modules'] = array(
'title' => t('Required modules'),
'value' => t('Required modules not found.'),
Angie Byron
committed
'severity' => REQUIREMENT_ERROR,
'description' => t('The following modules are required but were not found. Move them into the appropriate modules subdirectory, such as <em>/modules</em>. Missing modules: !modules', array('!modules' => implode(', ', $modules))),
Angie Byron
committed
);
Angie Byron
committed
return $requirements;
Gábor Hojtsy
committed
/**
Jennifer Hodgdon
committed
* Installs the system module.
Gábor Hojtsy
committed
*
* Separated from the installation of other modules so core system
* functions can be made available while other modules are installed.
catch
committed
*
* @param array $install_state
* An array of information about the current installation state. This is used
* to set the default language.
Gábor Hojtsy
committed
*/
catch
committed
function drupal_install_system($install_state) {
// Boot a new kernel into a regular production environment.
$request = \Drupal::hasRequest() ? \Drupal::request() : FALSE;
unset($GLOBALS['conf']['container_service_providers']['InstallerServiceProvider']);
$kernel = new DrupalKernel('prod', drupal_classloader(), FALSE);
$kernel->boot();
if ($request) {
$kernel->getContainer()->enterScope('request');
$kernel->getContainer()->set('request', $request, 'request');
$kernel->getContainer()->get('request_stack')->push($request);
Angie Byron
committed
}
// Install base system configuration.
\Drupal::service('config.installer')->installDefaultConfig('core', 'core');
// Install System module.
\Drupal::moduleHandler()->install(array('system'), FALSE);
catch
committed
// Ensure default language is saved.
if (isset($install_state['parameters']['langcode'])) {
\Drupal::config('system.site')
->set('langcode', $install_state['parameters']['langcode'])
->save();
}
Neil Drumm
committed
}
Dries Buytaert
committed
/**
Jennifer Hodgdon
committed
* Verifies the state of the specified file.
Dries Buytaert
committed
*
* @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.
Jennifer Hodgdon
committed
*
Dries Buytaert
committed
* @return
* TRUE on success or FALSE on failure. A message is set for the latter.
Dries Buytaert
committed
*/
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)) {
$check = 'is_' . $type;
Dries Buytaert
committed
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
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;
}
/**
Jennifer Hodgdon
committed
* Creates a directory with the specified permissions.
Dries Buytaert
committed
*
* @param $file
Dries Buytaert
committed
* The name of the directory to create;
* @param $mask
Dries Buytaert
committed
* The permissions of the directory to create.
* @param $message
* (optional) Whether to output messages. Defaults to TRUE.
Jennifer Hodgdon
committed
*
Dries Buytaert
committed
* @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:
Dries Buytaert
committed
$mod |= 0444;
Dries Buytaert
committed
break;
case FILE_WRITABLE:
Dries Buytaert
committed
$mod |= 0222;
Dries Buytaert
committed
break;
case FILE_EXECUTABLE:
Dries Buytaert
committed
$mod |= 0111;
Dries Buytaert
committed
break;
}
}
}
Dries Buytaert
committed
if (@drupal_mkdir($file, $mod)) {
Dries Buytaert
committed
return TRUE;
}
else {
return FALSE;
}
}
/**
Jennifer Hodgdon
committed
* Attempts to fix file permissions.
Dries Buytaert
committed
*
* 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.
*
Dries Buytaert
committed
* @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.
Jennifer Hodgdon
committed
*
Dries Buytaert
committed
* @return
* TRUE/FALSE whether or not we were able to fix the file's permissions.
*/
function drupal_install_fix_file($file, $mask, $message = TRUE) {
Angie Byron
committed
// If $file does not exist, fileperms() issues a PHP warning.
if (!file_exists($file)) {
return FALSE;
}
$mod = fileperms($file) & 0777;
Dries Buytaert
committed
$masks = array(FILE_READABLE, FILE_WRITABLE, FILE_EXECUTABLE, FILE_NOT_READABLE, FILE_NOT_WRITABLE, FILE_NOT_EXECUTABLE);
// 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.
Dries Buytaert
committed
foreach ($masks as $m) {
if ($mask & $m) {
switch ($m) {
case FILE_READABLE:
if (!is_readable($file)) {
$mod |= 0444;
Dries Buytaert
committed
}
break;
case FILE_WRITABLE:
if (!is_writable($file)) {
$mod |= 0222;
Dries Buytaert
committed
}
break;
case FILE_EXECUTABLE:
if (!is_executable($file)) {
$mod |= 0111;
Dries Buytaert
committed
}
break;
case FILE_NOT_READABLE:
if (is_readable($file)) {
$mod &= ~0444;
Dries Buytaert
committed
}
break;
case FILE_NOT_WRITABLE:
if (is_writable($file)) {
$mod &= ~0222;
Dries Buytaert
committed
}
break;
case FILE_NOT_EXECUTABLE:
if (is_executable($file)) {
$mod &= ~0111;
Dries Buytaert
committed
}
break;
}
}
}
// chmod() will work if the web server is running as owner of the file.
if (@chmod($file, $mod)) {
Dries Buytaert
committed
return TRUE;
}
else {
return FALSE;
}
}
Jennifer Hodgdon
committed
* Sends the user to a different installer page.
*
* This issues an on-site HTTP redirect. Messages (and errors) are erased.
*
* @param $path
* An installer path.
*/
function install_goto($path) {
Dries Buytaert
committed
global $base_url;
$headers = array(
// Not a permanent redirect.
'Cache-Control' => 'no-cache',
);
$response = new RedirectResponse($base_url . '/' . $path, 302, $headers);
$response->send();
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
/**
* 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 .= '?' . UrlHelper::buildQuery($query);
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
}
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);
}
Steven Wittens
committed
/**
Jennifer Hodgdon
committed
* Checks an installation profile's requirements.
Steven Wittens
committed
*
* @param string $profile
Jennifer Hodgdon
committed
* Name of installation profile to check.
* @param array $install_state
* The current state in the install process.
*
* @return array
Jennifer Hodgdon
committed
* Array of the installation profile's requirements.
Steven Wittens
committed
*/
function drupal_check_profile($profile, array $install_state) {
include_once __DIR__ . '/file.inc';
Steven Wittens
committed
catch
committed
if (!isset($profile) || !isset($install_state['profiles'][$profile])) {
Dries Buytaert
committed
throw new Exception(install_no_profile_error());
Steven Wittens
committed
}
$info = install_profile_info($profile);
Steven Wittens
committed
Angie Byron
committed
// Collect requirement testing results.
Steven Wittens
committed
$requirements = array();
Angie Byron
committed
foreach ($info['dependencies'] as $module) {
module_load_install($module);
$function = $module . '_requirements';
Dries Buytaert
committed
if (function_exists($function)) {
$requirements = array_merge($requirements, $function('install'));
Neil Drumm
committed
}
Steven Wittens
committed
}
return $requirements;
}
/**
Jennifer Hodgdon
committed
* Extracts the highest severity from the requirements array.
*
* @param $requirements
* An array of requirements, in the same format as is returned by
* hook_requirements().
Jennifer Hodgdon
committed
*
* @return
* The highest severity in the array.
Steven Wittens
committed
*/
function drupal_requirements_severity(&$requirements) {
$severity = REQUIREMENT_OK;
foreach ($requirements as $requirement) {
if (isset($requirement['severity'])) {
$severity = max($severity, $requirement['severity']);
}
}
return $severity;
}
/**
Jennifer Hodgdon
committed
* Checks a module's requirements.
*
* @param $module