webmaster@1: <?php
webmaster@1: // $Id: install.inc,v 1.56.2.2 2008/02/11 15:10:26 goba Exp $
webmaster@1: 
webmaster@1: define('SCHEMA_UNINSTALLED', -1);
webmaster@1: define('SCHEMA_INSTALLED', 0);
webmaster@1: 
webmaster@1: define('REQUIREMENT_INFO', -1);
webmaster@1: define('REQUIREMENT_OK', 0);
webmaster@1: define('REQUIREMENT_WARNING', 1);
webmaster@1: define('REQUIREMENT_ERROR', 2);
webmaster@1: 
webmaster@1: define('FILE_EXIST',          1);
webmaster@1: define('FILE_READABLE',       2);
webmaster@1: define('FILE_WRITABLE',       4);
webmaster@1: define('FILE_EXECUTABLE',     8);
webmaster@1: define('FILE_NOT_EXIST',      16);
webmaster@1: define('FILE_NOT_READABLE',   32);
webmaster@1: define('FILE_NOT_WRITABLE',   64);
webmaster@1: define('FILE_NOT_EXECUTABLE', 128);
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Initialize the update system by loading all installed module's .install files.
webmaster@1:  */
webmaster@1: function drupal_load_updates() {
webmaster@1:   foreach (drupal_get_installed_schema_version(NULL, FALSE, TRUE) as $module => $schema_version) {
webmaster@1:     if ($schema_version > -1) {
webmaster@1:       module_load_install($module);
webmaster@1:     }
webmaster@1:   }
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Returns an array of available schema versions for a module.
webmaster@1:  *
webmaster@1:  * @param $module
webmaster@1:  *   A module name.
webmaster@1:  * @return
webmaster@1:  *   If the module has updates, an array of available updates. Otherwise,
webmaster@1:  *   FALSE.
webmaster@1:  */
webmaster@1: function drupal_get_schema_versions($module) {
webmaster@1:   $updates = array();
webmaster@1:   $functions = get_defined_functions();
webmaster@1:   foreach ($functions['user'] as $function) {
webmaster@1:     if (strpos($function, $module .'_update_') === 0) {
webmaster@1:       $version = substr($function, strlen($module .'_update_'));
webmaster@1:       if (is_numeric($version)) {
webmaster@1:         $updates[] = $version;
webmaster@1:       }
webmaster@1:     }
webmaster@1:   }
webmaster@1:   if (count($updates) == 0) {
webmaster@1:     return FALSE;
webmaster@1:   }
webmaster@1:   return $updates;
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Returns the currently installed schema version for a module.
webmaster@1:  *
webmaster@1:  * @param $module
webmaster@1:  *   A module name.
webmaster@1:  * @param $reset
webmaster@1:  *   Set to TRUE after modifying the system table.
webmaster@1:  * @param $array
webmaster@1:  *   Set to TRUE if you want to get information about all modules in the
webmaster@1:  *   system.
webmaster@1:  * @return
webmaster@1:  *   The currently installed schema version.
webmaster@1:  */
webmaster@1: function drupal_get_installed_schema_version($module, $reset = FALSE, $array = FALSE) {
webmaster@1:   static $versions = array();
webmaster@1: 
webmaster@1:   if ($reset) {
webmaster@1:     $versions = array();
webmaster@1:   }
webmaster@1: 
webmaster@1:   if (!$versions) {
webmaster@1:     $versions = array();
webmaster@1:     $result = db_query("SELECT name, schema_version FROM {system} WHERE type = '%s'", 'module');
webmaster@1:     while ($row = db_fetch_object($result)) {
webmaster@1:       $versions[$row->name] = $row->schema_version;
webmaster@1:     }
webmaster@1:   }
webmaster@1: 
webmaster@1:   return $array ? $versions : $versions[$module];
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Update the installed version information for a module.
webmaster@1:  *
webmaster@1:  * @param $module
webmaster@1:  *   A module name.
webmaster@1:  * @param $version
webmaster@1:  *   The new schema version.
webmaster@1:  */
webmaster@1: function drupal_set_installed_schema_version($module, $version) {
webmaster@1:   db_query("UPDATE {system} SET schema_version = %d WHERE name = '%s'", $version, $module);
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Loads the profile definition, extracting the profile's defined name.
webmaster@1:  *
webmaster@1:  * @return
webmaster@1:  *   The name defined in the profile's _profile_details() hook.
webmaster@1:  */
webmaster@1: function drupal_install_profile_name() {
webmaster@1:   global $profile;
webmaster@1:   static $name = NULL;
webmaster@1: 
webmaster@1:   if (!isset($name)) {
webmaster@1:     // Load profile details.
webmaster@1:     $function = $profile .'_profile_details';
webmaster@1:     if (function_exists($function)) {
webmaster@1:       $details = $function();
webmaster@1:     }
webmaster@1:     $name = isset($details['name']) ? $details['name'] : 'Drupal';
webmaster@1:   }
webmaster@1: 
webmaster@1:   return $name;
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Auto detect the base_url with PHP predefined variables.
webmaster@1:  *
webmaster@1:  * @param $file
webmaster@1:  *   The name of the file calling this function so we can strip it out of
webmaster@1:  *   the URI when generating the base_url.
webmaster@1:  *
webmaster@1:  * @return
webmaster@1:  *   The auto-detected $base_url that should be configured in settings.php
webmaster@1:  */
webmaster@1: function drupal_detect_baseurl($file = 'install.php') {
webmaster@1:   global $profile;
webmaster@1:   $proto = $_SERVER['HTTPS'] ? 'https://' : 'http://';
webmaster@1:   $host = $_SERVER['SERVER_NAME'];
webmaster@1:   $port = ($_SERVER['SERVER_PORT'] == 80 ? '' : ':'. $_SERVER['SERVER_PORT']);
webmaster@1:   $uri = preg_replace("/\?.*/", '', $_SERVER['REQUEST_URI']);
webmaster@1:   $dir = str_replace("/$file", '', $uri);
webmaster@1: 
webmaster@1:   return "$proto$host$port$dir";
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Detect all databases supported by Drupal that are compiled into the current
webmaster@1:  * PHP installation.
webmaster@1:  *
webmaster@1:  * @return
webmaster@1:  *  An array of database types compiled into PHP.
webmaster@1:  */
webmaster@1: function drupal_detect_database_types() {
webmaster@1:   $databases = array();
webmaster@1: 
webmaster@1:   foreach (array('mysql', 'mysqli', 'pgsql') as $type) {
webmaster@1:     if (file_exists('./includes/install.'. $type .'.inc')) {
webmaster@1:       include_once './includes/install.'. $type .'.inc';
webmaster@1:       $function = $type .'_is_available';
webmaster@1:       if ($function()) {
webmaster@1:         $databases[$type] = $type;
webmaster@1:       }
webmaster@1:     }
webmaster@1:   }
webmaster@1: 
webmaster@1:   return $databases;
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Read settings.php into a buffer line by line, changing values specified in
webmaster@1:  * $settings array, then over-writing the old settings.php file.
webmaster@1:  *
webmaster@1:  * @param $settings
webmaster@1:  *   An array of settings that need to be updated.
webmaster@1:  */
webmaster@1: function drupal_rewrite_settings($settings = array(), $prefix = '') {
webmaster@1:   $default_settings = './sites/default/default.settings.php';
webmaster@1:   $settings_file = './'. conf_path(FALSE, TRUE) .'/'. $prefix .'settings.php';
webmaster@1: 
webmaster@1:   // Build list of setting names and insert the values into the global namespace.
webmaster@1:   $keys = array();
webmaster@1:   foreach ($settings as $setting => $data) {
webmaster@1:     $GLOBALS[$setting] = $data['value'];
webmaster@1:     $keys[] = $setting;
webmaster@1:   }
webmaster@1: 
webmaster@1:   $buffer = NULL;
webmaster@1:   $first = TRUE;
webmaster@1:   if ($fp = fopen($default_settings, 'r')) {
webmaster@1:     // Step line by line through settings.php.
webmaster@1:     while (!feof($fp)) {
webmaster@1:       $line = fgets($fp);
webmaster@1:       if ($first && substr($line, 0, 5) != '<?php') {
webmaster@1:         $buffer = "<?php\n\n";
webmaster@1:       }
webmaster@1:       $first = FALSE;
webmaster@1:       // Check for constants.
webmaster@1:       if (substr($line, 0, 7) == 'define(') {
webmaster@1:         preg_match('/define\(\s*[\'"]([A-Z_-]+)[\'"]\s*,(.*?)\);/', $line, $variable);
webmaster@1:         if (in_array($variable[1], $keys)) {
webmaster@1:           $setting = $settings[$variable[1]];
webmaster@1:           $buffer .= str_replace($variable[2], " '". $setting['value'] ."'", $line);
webmaster@1:           unset($settings[$variable[1]]);
webmaster@1:           unset($settings[$variable[2]]);
webmaster@1:         }
webmaster@1:         else {
webmaster@1:           $buffer .= $line;
webmaster@1:         }
webmaster@1:       }
webmaster@1:       // Check for variables.
webmaster@1:       elseif (substr($line, 0, 1) == '$') {
webmaster@1:         preg_match('/\$([^ ]*) /', $line, $variable);
webmaster@1:         if (in_array($variable[1], $keys)) {
webmaster@1:           // Write new value to settings.php in the following format:
webmaster@1:           //    $'setting' = 'value'; // 'comment'
webmaster@1:           $setting = $settings[$variable[1]];
webmaster@1:           $buffer .= '$'. $variable[1] ." = '". $setting['value'] ."';". (!empty($setting['comment']) ? ' // '. $setting['comment'] ."\n" : "\n");
webmaster@1:           unset($settings[$variable[1]]);
webmaster@1:         }
webmaster@1:         else {
webmaster@1:           $buffer .= $line;
webmaster@1:         }
webmaster@1:       }
webmaster@1:       else {
webmaster@1:         $buffer .= $line;
webmaster@1:       }
webmaster@1:     }
webmaster@1:     fclose($fp);
webmaster@1: 
webmaster@1:     // Add required settings that were missing from settings.php.
webmaster@1:     foreach ($settings as $setting => $data) {
webmaster@1:       if ($data['required']) {
webmaster@1:         $buffer .= "\$$setting = '". $data['value'] ."';\n";
webmaster@1:       }
webmaster@1:     }
webmaster@1: 
webmaster@1:     $fp = fopen($settings_file, 'w');
webmaster@1:     if ($fp && fwrite($fp, $buffer) === FALSE) {
webmaster@1:       drupal_set_message(st('Failed to modify %settings, please verify the file permissions.', array('%settings' => $settings_file)), 'error');
webmaster@1:     }
webmaster@1:   }
webmaster@1:   else {
webmaster@1:     drupal_set_message(st('Failed to open %settings, please verify the file permissions.', array('%settings' => $default_settings)), 'error');
webmaster@1:   }
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Get list of all .install files.
webmaster@1:  *
webmaster@1:  * @param $module_list
webmaster@1:  *   An array of modules to search for their .install files.
webmaster@1:  */
webmaster@1: function drupal_get_install_files($module_list = array()) {
webmaster@1:   $installs = array();
webmaster@1:   foreach ($module_list as $module) {
webmaster@1:     $installs = array_merge($installs, drupal_system_listing($module .'.install$', 'modules'));
webmaster@1:   }
webmaster@1:   return $installs;
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Verify a profile for installation.
webmaster@1:  *
webmaster@1:  * @param profile
webmaster@1:  *   Name of profile to verify.
webmaster@1:  * @param locale
webmaster@1:  *   Name of locale used (if any).
webmaster@1:  * @return
webmaster@1:  *   The list of modules to install.
webmaster@1:  */
webmaster@1: function drupal_verify_profile($profile, $locale) {
webmaster@1:   include_once './includes/file.inc';
webmaster@1:   include_once './includes/common.inc';
webmaster@1: 
webmaster@1:   $profile_file = "./profiles/$profile/$profile.profile";
webmaster@1: 
webmaster@1:   if (!isset($profile) || !file_exists($profile_file)) {
webmaster@1:     install_no_profile_error();
webmaster@1:   }
webmaster@1: 
webmaster@1:   require_once($profile_file);
webmaster@1: 
webmaster@1:   // Get a list of modules required by this profile.
webmaster@1:   $function = $profile .'_profile_modules';
webmaster@1:   $module_list = array_merge(drupal_required_modules(), $function(), ($locale != 'en' ? array('locale') : array()));
webmaster@1: 
webmaster@1:   // Get a list of modules that exist in Drupal's assorted subdirectories.
webmaster@1:   $present_modules = array();
webmaster@1:   foreach (drupal_system_listing('\.module$', 'modules', 'name', 0) as $present_module) {
webmaster@1:     $present_modules[] = $present_module->name;
webmaster@1:   }
webmaster@1: 
webmaster@1:   // Verify that all of the profile's required modules are present.
webmaster@1:   $missing_modules = array_diff($module_list, $present_modules);
webmaster@1:   if (count($missing_modules)) {
webmaster@1:     foreach ($missing_modules as $module) {
webmaster@1:       drupal_set_message(st('The %module module is required but was not found. Please move it into the <em>modules</em> subdirectory.', array('%module' => $module)), 'error');
webmaster@1:     }
webmaster@1:   }
webmaster@1:   else {
webmaster@1:     return $module_list;
webmaster@1:   }
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Calls the install function and updates the system table for a given list of
webmaster@1:  * modules.
webmaster@1:  *
webmaster@1:  * @param module_list
webmaster@1:  *   The modules to install.
webmaster@1:  */
webmaster@1: function drupal_install_modules($module_list = array()) {
webmaster@1:   $files = module_rebuild_cache();
webmaster@1:   $module_list = array_flip(array_values($module_list));
webmaster@1:   do {
webmaster@1:     $moved = FALSE;
webmaster@1:     foreach ($module_list as $module => $weight) {
webmaster@1:       $file = $files[$module];
webmaster@1:       if (isset($file->info['dependencies']) && is_array($file->info['dependencies'])) {
webmaster@1:         foreach ($file->info['dependencies'] as $dependency) {
webmaster@1:           if (isset($module_list[$dependency]) && $module_list[$module] < $module_list[$dependency] +1) {
webmaster@1:             $module_list[$module] = $module_list[$dependency] +1;
webmaster@1:             $moved = TRUE;
webmaster@1:           }
webmaster@1:         }
webmaster@1:       }
webmaster@1:     }
webmaster@1:   } while ($moved);
webmaster@1:   asort($module_list);
webmaster@1:   $module_list = array_keys($module_list);
webmaster@1:   array_filter($module_list, '_drupal_install_module');
webmaster@1:   module_enable($module_list);
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Callback to install an individual profile module.
webmaster@1:  *
webmaster@1:  * Used during installation to install modules one at a time and then
webmaster@1:  * enable them, or to install a number of modules at one time
webmaster@1:  * from admin/build/modules.
webmaster@1:  */
webmaster@1: function _drupal_install_module($module) {
webmaster@1:   if (drupal_get_installed_schema_version($module, TRUE) == SCHEMA_UNINSTALLED) {
webmaster@1:     module_load_install($module);
webmaster@1:     module_invoke($module, 'install');
webmaster@1:     $versions = drupal_get_schema_versions($module);
webmaster@1:     drupal_set_installed_schema_version($module, $versions ? max($versions) : SCHEMA_INSTALLED);
webmaster@1:     return TRUE;
webmaster@1:   }
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Callback to install the system module.
webmaster@1:  *
webmaster@1:  * Separated from the installation of other modules so core system
webmaster@1:  * functions can be made available while other modules are installed.
webmaster@1:  */
webmaster@1: function drupal_install_system() {
webmaster@1:   $system_path = dirname(drupal_get_filename('module', 'system', NULL));
webmaster@1:   require_once './'. $system_path .'/system.install';
webmaster@1:   module_invoke('system', 'install');
webmaster@1:   $system_versions = drupal_get_schema_versions('system');
webmaster@1:   $system_version = $system_versions ? max($system_versions) : SCHEMA_INSTALLED;
webmaster@1:   db_query("INSERT INTO {system} (filename, name, type, owner, status, throttle, bootstrap, schema_version) VALUES('%s', '%s', '%s', '%s', %d, %d, %d, %d)", $system_path .'/system.module', 'system', 'module', '', 1, 0, 0, $system_version);
webmaster@1:   // Now that we've installed things properly, bootstrap the full Drupal environment
webmaster@1:   drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL);
webmaster@1:   module_rebuild_cache();
webmaster@1: }
webmaster@1: 
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Calls the uninstall function and updates the system table for a given module.
webmaster@1:  *
webmaster@1:  * @param $module
webmaster@1:  *   The module to uninstall.
webmaster@1:  */
webmaster@1: function drupal_uninstall_module($module) {
webmaster@1:   // First, retrieve all the module's menu paths from db.
webmaster@1:   drupal_load('module', $module);
webmaster@1:   $paths = module_invoke($module, 'menu');
webmaster@1: 
webmaster@1:   // Uninstall the module(s).
webmaster@1:   module_load_install($module);
webmaster@1:   module_invoke($module, 'uninstall');
webmaster@1: 
webmaster@1:   // Now remove the menu links for all paths declared by this module.
webmaster@1:   if (!empty($paths)) {
webmaster@1:     $paths = array_keys($paths);
webmaster@1:     // Clean out the names of load functions.
webmaster@1:     foreach ($paths as $index => $path) {
webmaster@1:       $parts = explode('/', $path, MENU_MAX_PARTS);
webmaster@1:       foreach ($parts as $k => $part) {
webmaster@1:         if (preg_match('/^%[a-z_]*$/', $part)) {
webmaster@1:           $parts[$k] = '%';
webmaster@1:         }
webmaster@1:       }
webmaster@1:       $paths[$index] = implode('/', $parts);
webmaster@1:     }
webmaster@1:     $placeholders = implode(', ', array_fill(0, count($paths), "'%s'"));
webmaster@1: 
webmaster@1:     $result = db_query('SELECT * FROM {menu_links} WHERE router_path IN ('. $placeholders .') AND external = 0 ORDER BY depth DESC', $paths);
webmaster@1:     // Remove all such items. Starting from those with the greatest depth will
webmaster@1:     // minimize the amount of re-parenting done by menu_link_delete().
webmaster@1:     while ($item = db_fetch_array($result)) {
webmaster@1:       _menu_delete_item($item, TRUE);
webmaster@1:     }
webmaster@1:   }
webmaster@1: 
webmaster@1:   drupal_set_installed_schema_version($module, SCHEMA_UNINSTALLED);
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Verify the state of the specified file.
webmaster@1:  *
webmaster@1:  * @param $file
webmaster@1:  *   The file to check for.
webmaster@1:  * @param $mask
webmaster@1:  *   An optional bitmask created from various FILE_* constants.
webmaster@1:  * @param $type
webmaster@1:  *   The type of file. Can be file (default), dir, or link.
webmaster@1:  * @return
webmaster@1:  *   TRUE on success or FALSE on failure. A message is set for the latter.
webmaster@1:  */
webmaster@1: function drupal_verify_install_file($file, $mask = NULL, $type = 'file') {
webmaster@1:   $return = TRUE;
webmaster@1:   // Check for files that shouldn't be there.
webmaster@1:   if (isset($mask) && ($mask & FILE_NOT_EXIST) && file_exists($file)) {
webmaster@1:     return FALSE;
webmaster@1:   }
webmaster@1:   // Verify that the file is the type of file it is supposed to be.
webmaster@1:   if (isset($type) && file_exists($file)) {
webmaster@1:     $check = 'is_'. $type;
webmaster@1:     if (!function_exists($check) || !$check($file)) {
webmaster@1:       $return = FALSE;
webmaster@1:     }
webmaster@1:   }
webmaster@1: 
webmaster@1:   // Verify file permissions.
webmaster@1:   if (isset($mask)) {
webmaster@1:     $masks = array(FILE_EXIST, FILE_READABLE, FILE_WRITABLE, FILE_EXECUTABLE, FILE_NOT_READABLE, FILE_NOT_WRITABLE, FILE_NOT_EXECUTABLE);
webmaster@1:     foreach ($masks as $current_mask) {
webmaster@1:       if ($mask & $current_mask) {
webmaster@1:         switch ($current_mask) {
webmaster@1:           case FILE_EXIST:
webmaster@1:             if (!file_exists($file)) {
webmaster@1:               if ($type == 'dir') {
webmaster@1:                 drupal_install_mkdir($file, $mask);
webmaster@1:               }
webmaster@1:               if (!file_exists($file)) {
webmaster@1:                 $return = FALSE;
webmaster@1:               }
webmaster@1:             }
webmaster@1:             break;
webmaster@1:           case FILE_READABLE:
webmaster@1:             if (!is_readable($file) && !drupal_install_fix_file($file, $mask)) {
webmaster@1:               $return = FALSE;
webmaster@1:             }
webmaster@1:             break;
webmaster@1:           case FILE_WRITABLE:
webmaster@1:             if (!is_writable($file) && !drupal_install_fix_file($file, $mask)) {
webmaster@1:               $return = FALSE;
webmaster@1:             }
webmaster@1:             break;
webmaster@1:           case FILE_EXECUTABLE:
webmaster@1:             if (!is_executable($file) && !drupal_install_fix_file($file, $mask)) {
webmaster@1:               $return = FALSE;
webmaster@1:             }
webmaster@1:             break;
webmaster@1:           case FILE_NOT_READABLE:
webmaster@1:             if (is_readable($file) && !drupal_install_fix_file($file, $mask)) {
webmaster@1:               $return = FALSE;
webmaster@1:             }
webmaster@1:             break;
webmaster@1:           case FILE_NOT_WRITABLE:
webmaster@1:             if (is_writable($file) && !drupal_install_fix_file($file, $mask)) {
webmaster@1:               $return = FALSE;
webmaster@1:             }
webmaster@1:             break;
webmaster@1:           case FILE_NOT_EXECUTABLE:
webmaster@1:             if (is_executable($file) && !drupal_install_fix_file($file, $mask)) {
webmaster@1:               $return = FALSE;
webmaster@1:             }
webmaster@1:             break;
webmaster@1:         }
webmaster@1:       }
webmaster@1:     }
webmaster@1:   }
webmaster@1:   return $return;
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Create a directory with specified permissions.
webmaster@1:  *
webmaster@1:  * @param file
webmaster@1:  *  The name of the directory to create;
webmaster@1:  * @param mask
webmaster@1:  *  The permissions of the directory to create.
webmaster@1:  * @param $message
webmaster@1:  *  (optional) Whether to output messages. Defaults to TRUE.
webmaster@1:  *
webmaster@1:  * @return
webmaster@1:  *  TRUE/FALSE whether or not the directory was successfully created.
webmaster@1:  */
webmaster@1: function drupal_install_mkdir($file, $mask, $message = TRUE) {
webmaster@1:   $mod = 0;
webmaster@1:   $masks = array(FILE_READABLE, FILE_WRITABLE, FILE_EXECUTABLE, FILE_NOT_READABLE, FILE_NOT_WRITABLE, FILE_NOT_EXECUTABLE);
webmaster@1:   foreach ($masks as $m) {
webmaster@1:     if ($mask & $m) {
webmaster@1:       switch ($m) {
webmaster@1:         case FILE_READABLE:
webmaster@1:           $mod += 444;
webmaster@1:           break;
webmaster@1:         case FILE_WRITABLE:
webmaster@1:           $mod += 222;
webmaster@1:           break;
webmaster@1:         case FILE_EXECUTABLE:
webmaster@1:           $mod += 111;
webmaster@1:           break;
webmaster@1:       }
webmaster@1:     }
webmaster@1:   }
webmaster@1: 
webmaster@1:   if (@mkdir($file, intval("0$mod", 8))) {
webmaster@1:     return TRUE;
webmaster@1:   }
webmaster@1:   else {
webmaster@1:     return FALSE;
webmaster@1:   }
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Attempt to fix file permissions.
webmaster@1:  *
webmaster@1:  * The general approach here is that, because we do not know the security
webmaster@1:  * setup of the webserver, we apply our permission changes to all three
webmaster@1:  * digits of the file permission (i.e. user, group and all).
webmaster@1:  *
webmaster@1:  * To ensure that the values behave as expected (and numbers don't carry
webmaster@1:  * from one digit to the next) we do the calculation on the octal value
webmaster@1:  * using bitwise operations. This lets us remove, for example, 0222 from
webmaster@1:  * 0700 and get the correct value of 0500.
webmaster@1:  *
webmaster@1:  * @param $file
webmaster@1:  *  The name of the file with permissions to fix.
webmaster@1:  * @param $mask
webmaster@1:  *  The desired permissions for the file.
webmaster@1:  * @param $message
webmaster@1:  *  (optional) Whether to output messages. Defaults to TRUE.
webmaster@1:  *
webmaster@1:  * @return
webmaster@1:  *  TRUE/FALSE whether or not we were able to fix the file's permissions.
webmaster@1:  */
webmaster@1: function drupal_install_fix_file($file, $mask, $message = TRUE) {
webmaster@1:   $mod = fileperms($file) & 0777;
webmaster@1:   $masks = array(FILE_READABLE, FILE_WRITABLE, FILE_EXECUTABLE, FILE_NOT_READABLE, FILE_NOT_WRITABLE, FILE_NOT_EXECUTABLE);
webmaster@1: 
webmaster@1:   // FILE_READABLE, FILE_WRITABLE, and FILE_EXECUTABLE permission strings
webmaster@1:   // can theoretically be 0400, 0200, and 0100 respectively, but to be safe
webmaster@1:   // we set all three access types in case the administrator intends to
webmaster@1:   // change the owner of settings.php after installation.
webmaster@1:   foreach ($masks as $m) {
webmaster@1:     if ($mask & $m) {
webmaster@1:       switch ($m) {
webmaster@1:         case FILE_READABLE:
webmaster@1:           if (!is_readable($file)) {
webmaster@1:             $mod |= 0444;
webmaster@1:           }
webmaster@1:           break;
webmaster@1:         case FILE_WRITABLE:
webmaster@1:           if (!is_writable($file)) {
webmaster@1:             $mod |= 0222;
webmaster@1:           }
webmaster@1:           break;
webmaster@1:         case FILE_EXECUTABLE:
webmaster@1:           if (!is_executable($file)) {
webmaster@1:             $mod |= 0111;
webmaster@1:           }
webmaster@1:           break;
webmaster@1:         case FILE_NOT_READABLE:
webmaster@1:           if (is_readable($file)) {
webmaster@1:             $mod &= ~0444;
webmaster@1:           }
webmaster@1:           break;
webmaster@1:         case FILE_NOT_WRITABLE:
webmaster@1:           if (is_writable($file)) {
webmaster@1:             $mod &= ~0222;
webmaster@1:           }
webmaster@1:           break;
webmaster@1:         case FILE_NOT_EXECUTABLE:
webmaster@1:           if (is_executable($file)) {
webmaster@1:             $mod &= ~0111;
webmaster@1:           }
webmaster@1:           break;
webmaster@1:       }
webmaster@1:     }
webmaster@1:   }
webmaster@1: 
webmaster@1:   // chmod() will work if the web server is running as owner of the file.
webmaster@1:   // If PHP safe_mode is enabled the currently executing script must also
webmaster@1:   // have the same owner.
webmaster@1:   if (@chmod($file, $mod)) {
webmaster@1:     return TRUE;
webmaster@1:   }
webmaster@1:   else {
webmaster@1:     return FALSE;
webmaster@1:   }
webmaster@1: }
webmaster@1: 
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Send the user to a different installer page. This issues an on-site HTTP
webmaster@1:  * redirect. Messages (and errors) are erased.
webmaster@1:  *
webmaster@1:  * @param $path
webmaster@1:  *   An installer path.
webmaster@1:  */
webmaster@1: function install_goto($path) {
webmaster@1:   global $base_url;
webmaster@1:   header('Location: '. $base_url .'/'. $path);
webmaster@1:   header('Cache-Control: no-cache'); // Not a permanent redirect.
webmaster@1:   exit();
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Hardcoded function for doing the equivalent of t() during
webmaster@1:  * the install process, when database, theme, and localization
webmaster@1:  * system is possibly not yet available.
webmaster@1:  */
webmaster@1: function st($string, $args = array()) {
webmaster@1:   static $locale_strings = NULL;
webmaster@1:   global $profile, $install_locale;
webmaster@1: 
webmaster@1:   if (!isset($locale_strings)) {
webmaster@1:     $locale_strings = array();
webmaster@1:     $filename = './profiles/'. $profile .'/translations/'. $install_locale .'.po';
webmaster@1:     if (file_exists($filename)) {
webmaster@1:       require_once './includes/locale.inc';
webmaster@1:       $file = (object) array('filepath' => $filename);
webmaster@1:       _locale_import_read_po('mem-store', $file);
webmaster@1:       $locale_strings = _locale_import_one_string('mem-report');
webmaster@1:     }
webmaster@1:   }
webmaster@1: 
webmaster@1:   require_once './includes/theme.inc';
webmaster@1:   // Transform arguments before inserting them
webmaster@1:   foreach ($args as $key => $value) {
webmaster@1:     switch ($key[0]) {
webmaster@1:       // Escaped only
webmaster@1:       case '@':
webmaster@1:         $args[$key] = check_plain($value);
webmaster@1:         break;
webmaster@1:       // Escaped and placeholder
webmaster@1:       case '%':
webmaster@1:       default:
webmaster@1:         $args[$key] = '<em>'. check_plain($value) .'</em>';
webmaster@1:         break;
webmaster@1:       // Pass-through
webmaster@1:       case '!':
webmaster@1:     }
webmaster@1:   }
webmaster@1:   return strtr((!empty($locale_strings[$string]) ? $locale_strings[$string] : $string), $args);
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Check a profile's requirements.
webmaster@1:  *
webmaster@1:  * @param profile
webmaster@1:  *   Name of profile to check.
webmaster@1:  */
webmaster@1: function drupal_check_profile($profile) {
webmaster@1:   include_once './includes/file.inc';
webmaster@1: 
webmaster@1:   $profile_file = "./profiles/$profile/$profile.profile";
webmaster@1: 
webmaster@1:   if (!isset($profile) || !file_exists($profile_file)) {
webmaster@1:     install_no_profile_error();
webmaster@1:   }
webmaster@1: 
webmaster@1:   require_once($profile_file);
webmaster@1: 
webmaster@1:   // Get a list of modules required by this profile.
webmaster@1:   $function = $profile .'_profile_modules';
webmaster@1:   $module_list = array_unique(array_merge(drupal_required_modules(), $function()));
webmaster@1: 
webmaster@1:   // Get a list of all .install files.
webmaster@1:   $installs = drupal_get_install_files($module_list);
webmaster@1: 
webmaster@1:   // Collect requirement testing results
webmaster@1:   $requirements = array();
webmaster@1:   foreach ($installs as $install) {
webmaster@1:     require_once $install->filename;
webmaster@1:     if (module_hook($install->name, 'requirements')) {
webmaster@1:       $requirements = array_merge($requirements, module_invoke($install->name, 'requirements', 'install'));
webmaster@1:     }
webmaster@1:   }
webmaster@1:   return $requirements;
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Extract highest severity from requirements array.
webmaster@1:  */
webmaster@1: function drupal_requirements_severity(&$requirements) {
webmaster@1:   $severity = REQUIREMENT_OK;
webmaster@1:   foreach ($requirements as $requirement) {
webmaster@1:     if (isset($requirement['severity'])) {
webmaster@1:       $severity = max($severity, $requirement['severity']);
webmaster@1:     }
webmaster@1:   }
webmaster@1:   return $severity;
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Check a module's requirements.
webmaster@1:  */
webmaster@1: function drupal_check_module($module) {
webmaster@1:   // Include install file
webmaster@1:   $install = drupal_get_install_files(array($module));
webmaster@1:   if (isset($install[$module])) {
webmaster@1:     require_once $install[$module]->filename;
webmaster@1: 
webmaster@1:     // Check requirements
webmaster@1:     $requirements = module_invoke($module, 'requirements', 'install');
webmaster@1:     if (is_array($requirements) && drupal_requirements_severity($requirements) == REQUIREMENT_ERROR) {
webmaster@1:       // Print any error messages
webmaster@1:       foreach ($requirements as $requirement) {
webmaster@1:         if (isset($requirement['severity']) && $requirement['severity'] == REQUIREMENT_ERROR) {
webmaster@1:           $message = $requirement['description'];
webmaster@1:           if (isset($requirement['value']) && $requirement['value']) {
webmaster@1:             $message .= ' ('. t('Currently using !item !version', array('!item' => $requirement['title'], '!version' => $requirement['value'])) .')';
webmaster@1:           }
webmaster@1:           drupal_set_message($message, 'error');
webmaster@1:         }
webmaster@1:       }
webmaster@1:       return FALSE;
webmaster@1:     }
webmaster@1:   }
webmaster@1:   return TRUE;
webmaster@1: }