install.php 43.9 KB
Newer Older
1 2 3 4 5
<?php
// $Id$

require_once './includes/install.inc';

6 7
define('MAINTENANCE_MODE', 'install');

8 9 10 11 12 13 14 15 16 17 18 19 20 21
/**
 * The Drupal installation happens in a series of steps. We begin by verifying
 * that the current environment meets our minimum requirements. We then go
 * on to verify that settings.php is properly configured. From there we
 * connect to the configured database and verify that it meets our minimum
 * requirements. Finally we can allow the user to select an installation
 * profile and complete the installation process.
 *
 * @param $phase
 *   The installation phase we should proceed to.
 */
function install_main() {
  require_once './includes/bootstrap.inc';
  drupal_bootstrap(DRUPAL_BOOTSTRAP_CONFIGURATION);
22

23 24 25
  // This must go after drupal_bootstrap(), which unsets globals!
  global $profile, $install_locale, $conf;

26
  require_once './modules/system/system.install';
27
  require_once './includes/file.inc';
28

29 30 31
  // Ensure correct page headers are sent (e.g. caching)
  drupal_page_header();

32 33 34
  // Set up $language, so t() caller functions will still work.
  drupal_init_language();

35 36 37 38 39 40 41 42 43 44 45
  // Load module basics (needed for hook invokes).
  include_once './includes/module.inc';
  $module_list['system']['filename'] = 'modules/system/system.module';
  $module_list['filter']['filename'] = 'modules/filter/filter.module';
  module_list(TRUE, FALSE, FALSE, $module_list);
  drupal_load('module', 'system');
  drupal_load('module', 'filter');

  // Set up theme system for the maintenance page.
  drupal_maintenance_theme();

46 47 48 49
  // Check existing settings.php.
  $verify = install_verify_settings();

  if ($verify) {
50 51 52 53 54 55
    // Since we have a database connection, we use the normal cache system.
    // This is important, as the installer calls into the Drupal system for
    // the clean URL checks, so we should maintain the cache properly.
    require_once './includes/cache.inc';
    $conf['cache_inc'] = './includes/cache.inc';

56 57 58
    // Establish a connection to the database.
    require_once './includes/database.inc';
    db_set_active();
59

60
    // Check if Drupal is installed.
61 62
    $task = install_verify_drupal();
    if ($task == 'done') {
63 64 65
      install_already_done_error();
    }
  }
66
  else {
67 68 69 70 71 72 73
    // Since no persistent storage is available yet, and functions that check
    // for cached data will fail, we temporarily replace the normal cache
    // system with a stubbed-out version that short-circuits the actual
    // caching process and avoids any errors.
    require_once './includes/cache-install.inc';
    $conf['cache_inc'] = './includes/cache-install.inc';

74 75
    $task = NULL;
  }
76 77 78 79 80 81

  // Decide which profile to use.
  if (!empty($_GET['profile'])) {
    $profile = preg_replace('/[^a-zA-Z_0-9]/', '', $_GET['profile']);
  }
  elseif ($profile = install_select_profile()) {
82
    install_goto("install.php?profile=$profile");
83 84
  }
  else {
85
    install_no_profile_error();
86
  }
drumm's avatar
drumm committed
87

88 89 90
  // Load the profile.
  require_once "./profiles/$profile/$profile.profile";

drumm's avatar
drumm committed
91 92 93 94 95 96 97 98
  // Locale selection
  if (!empty($_GET['locale'])) {
    $install_locale = preg_replace('/[^a-zA-Z_0-9]/', '', $_GET['locale']);
  }
  elseif (($install_locale = install_select_locale($profile)) !== FALSE) {
    install_goto("install.php?profile=$profile&locale=$install_locale");
  }

99 100 101
  // Tasks come after the database is set up
  if (!$task) {
    // Check the installation requirements for Drupal and this profile.
102
    install_check_requirements($profile, $verify);
103

104 105
    // Verify existence of all required modules.
    $modules = drupal_verify_profile($profile, $install_locale);
106 107 108 109 110 111 112 113

    // If any error messages are set now, it means a requirement problem.
    $messages = drupal_set_message();
    if (!empty($messages['error'])) {
      install_task_list('requirements');
      drupal_set_title(st('Requirements problem'));
      print theme('install_page', '');
      exit;
114
    }
115

116 117 118 119 120
    // Change the settings.php information if verification failed earlier.
    // Note: will trigger a redirect if database credentials change.
    if (!$verify) {
      install_change_settings($profile, $install_locale);
    }
121

122 123 124 125 126 127
    // Install system.module.
    drupal_install_system();
    // Save the list of other modules to install for the 'profile-install'
    // task. variable_set() can be used now that system.module is installed
    // and drupal is bootstrapped.
    variable_set('install_profile_modules', array_diff($modules, array('system')));
128
  }
129

130 131
  // The database is set up, turn to further tasks.
  install_tasks($profile, $task);
132 133 134 135 136 137
}

/**
 * Verify if Drupal is installed.
 */
function install_verify_drupal() {
138
  // Read the variable manually using the @ so we don't trigger an error if it fails.
139
  $result = @db_query("SELECT value FROM {variable} WHERE name = '%s'", 'install_task');
140 141 142
  if ($result) {
    return unserialize(db_result($result));
  }
143 144 145 146 147 148 149 150 151
}

/**
 * Verify existing settings.php
 */
function install_verify_settings() {
  global $db_prefix, $db_type, $db_url;

  // Verify existing settings (if any).
152
  if (!empty($db_url)) {
153 154 155
    // We need this because we want to run form_get_errors.
    include_once './includes/form.inc';

156
    $url = parse_url(is_array($db_url) ? $db_url['default'] : $db_url);
157 158 159
    $db_user = urldecode($url['user']);
    $db_pass = urldecode($url['pass']);
    $db_host = urldecode($url['host']);
160
    $db_port = isset($url['port']) ? urldecode($url['port']) : '';
161 162 163
    $db_path = ltrim(urldecode($url['path']), '/');
    $settings_file = './'. conf_path() .'/settings.php';

164 165
    $form_state = array();
    _install_settings_form_validate($db_prefix, $db_type, $db_user, $db_pass, $db_host, $db_port, $db_path, $settings_file, $form_state);
166 167 168 169 170 171 172 173 174 175
    if (!form_get_errors()) {
      return TRUE;
    }
  }
  return FALSE;
}

/**
 * Configure and rewrite settings.php.
 */
176 177
function install_change_settings($profile = 'default', $install_locale = '') {
  global $db_url, $db_type, $db_prefix;
178

179
  $url = parse_url(is_array($db_url) ? $db_url['default'] : $db_url);
180 181 182
  $db_user = isset($url['user']) ? urldecode($url['user']) : '';
  $db_pass = isset($url['pass']) ? urldecode($url['pass']) : '';
  $db_host = isset($url['host']) ? urldecode($url['host']) : '';
183
  $db_port = isset($url['port']) ? urldecode($url['port']) : '';
184
  $db_path = ltrim(urldecode($url['path']), '/');
185 186
  $conf_path = './'. conf_path();
  $settings_file = $conf_path .'/settings.php';
187 188 189

  // We always need this because we want to run form_get_errors.
  include_once './includes/form.inc';
190
  install_task_list('database');
191

192 193 194 195 196 197 198 199
  if ($db_url == 'mysql://username:password@localhost/databasename') {
    $db_user = $db_pass = $db_path = '';
  }
  elseif (!empty($db_url)) {
    // Do not install over a configured settings.php.
    install_already_done_error();
  }

200
  $output = drupal_get_form('install_settings_form', $profile, $install_locale, $settings_file, $db_url, $db_type, $db_prefix, $db_user, $db_pass, $db_host, $db_port, $db_path);
drumm's avatar
drumm committed
201
  drupal_set_title(st('Database configuration'));
202 203 204
  print theme('install_page', $output);
  exit;
}
205

206

207 208 209
/**
 * Form API array definition for install_settings.
 */
210
function install_settings_form(&$form_state, $profile, $install_locale, $settings_file, $db_url, $db_type, $db_prefix, $db_user, $db_pass, $db_host, $db_port, $db_path) {
211 212 213
  if (empty($db_host)) {
    $db_host = 'localhost';
  }
214
  $db_types = drupal_detect_database_types();
215 216 217 218 219 220

  // If both 'mysql' and 'mysqli' are available, we disable 'mysql':
  if (isset($db_types['mysqli'])) {
    unset($db_types['mysql']);
  }

221 222
  if (count($db_types) == 0) {
    $form['no_db_types'] = array(
drumm's avatar
drumm committed
223
      '#value' => st('Your web server does not appear to support any common database types. Check with your hosting provider to see if they offer any databases that <a href="@drupal-databases">Drupal supports</a>.', array('@drupal-databases' => 'http://drupal.org/node/270#database')),
224 225 226 227 228
    );
  }
  else {
    $form['basic_options'] = array(
      '#type' => 'fieldset',
drumm's avatar
drumm committed
229
      '#title' => st('Basic options'),
230
      '#description' => '<p>'. st('To set up your @drupal database, enter the following information.', array('@drupal' => drupal_install_profile_name())) .'</p>',
231 232 233 234 235
    );

    if (count($db_types) > 1) {
      $form['basic_options']['db_type'] = array(
        '#type' => 'radios',
drumm's avatar
drumm committed
236
        '#title' => st('Database type'),
237
        '#required' => TRUE,
238 239
        '#options' => $db_types,
        '#default_value' => ($db_type ? $db_type : current($db_types)),
240
        '#description' => st('The type of database your @drupal data will be stored in.', array('@drupal' => drupal_install_profile_name())),
241
      );
242
      $db_path_description = st('The name of the database your @drupal data will be stored in. It must exist on your server before @drupal can be installed.', array('@drupal' => drupal_install_profile_name()));
243 244 245
    }
    else {
      if (count($db_types) == 1) {
246
        $db_types = array_values($db_types);
247 248 249 250
        $form['basic_options']['db_type'] = array(
          '#type' => 'hidden',
          '#value' => $db_types[0],
        );
251
        $db_path_description = st('The name of the %db_type database your @drupal data will be stored in. It must exist on your server before @drupal can be installed.', array('%db_type' => $db_types[0], '@drupal' => drupal_install_profile_name()));
252 253 254 255 256 257
      }
    }

    // Database name
    $form['basic_options']['db_path'] = array(
      '#type' => 'textfield',
drumm's avatar
drumm committed
258
      '#title' => st('Database name'),
259 260 261 262 263 264 265 266 267 268
      '#default_value' => $db_path,
      '#size' => 45,
      '#maxlength' => 45,
      '#required' => TRUE,
      '#description' => $db_path_description
    );

    // Database username
    $form['basic_options']['db_user'] = array(
      '#type' => 'textfield',
drumm's avatar
drumm committed
269
      '#title' => st('Database username'),
270 271 272 273 274 275 276 277 278
      '#default_value' => $db_user,
      '#size' => 45,
      '#maxlength' => 45,
      '#required' => TRUE,
    );

    // Database username
    $form['basic_options']['db_pass'] = array(
      '#type' => 'password',
drumm's avatar
drumm committed
279
      '#title' => st('Database password'),
280 281 282 283 284 285 286
      '#default_value' => $db_pass,
      '#size' => 45,
      '#maxlength' => 45,
    );

    $form['advanced_options'] = array(
      '#type' => 'fieldset',
drumm's avatar
drumm committed
287
      '#title' => st('Advanced options'),
288 289
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
290
      '#description' => st("These options are only necessary for some sites. If you're not sure what you should enter here, leave the default settings or check with your hosting provider.")
291 292 293 294 295
    );

    // Database host
    $form['advanced_options']['db_host'] = array(
      '#type' => 'textfield',
drumm's avatar
drumm committed
296
      '#title' => st('Database host'),
297 298 299 300
      '#default_value' => $db_host,
      '#size' => 45,
      '#maxlength' => 45,
      '#required' => TRUE,
drumm's avatar
drumm committed
301
      '#description' => st('If your database is located on a different server, change this.'),
302 303
    );

304 305 306 307 308 309 310 311 312 313
    // Database port
    $form['advanced_options']['db_port'] = array(
      '#type' => 'textfield',
      '#title' => st('Database port'),
      '#default_value' => $db_port,
      '#size' => 45,
      '#maxlength' => 45,
      '#description' => st('If your database server is listening to a non-standard port, enter its number.'),
    );

314
    // Table prefix
315
    $prefix = ($profile == 'default') ? 'drupal_' : $profile .'_';
316 317
    $form['advanced_options']['db_prefix'] = array(
      '#type' => 'textfield',
318
      '#title' => st('Table prefix'),
319 320 321
      '#default_value' => $db_prefix,
      '#size' => 45,
      '#maxlength' => 45,
322
      '#description' => st('If more than one application will be sharing this database, enter a table prefix such as %prefix for your @drupal site here.', array('@drupal' => drupal_install_profile_name(), '%prefix' => $prefix)),
323 324 325 326
    );

    $form['save'] = array(
      '#type' => 'submit',
drumm's avatar
drumm committed
327
      '#value' => st('Save configuration'),
328 329 330 331 332
    );

    $form['errors'] = array();
    $form['settings_file'] = array('#type' => 'value', '#value' => $settings_file);
    $form['_db_url'] = array('#type' => 'value');
333
    $form['#action'] = "install.php?profile=$profile". ($install_locale ? "&locale=$install_locale" : '');
334
    $form['#redirect'] = FALSE;
335
  }
336
  return $form;
337
}
338

339 340 341
/**
 * Form API validate for install_settings form.
 */
342
function install_settings_form_validate($form, &$form_state) {
343
  global $db_url;
344
  _install_settings_form_validate($form_state['values']['db_prefix'], $form_state['values']['db_type'], $form_state['values']['db_user'], $form_state['values']['db_pass'], $form_state['values']['db_host'], $form_state['values']['db_port'], $form_state['values']['db_path'], $form_state['values']['settings_file'], $form_state, $form);
345 346 347 348 349
}

/**
 * Helper function for install_settings_validate.
 */
350
function _install_settings_form_validate($db_prefix, $db_type, $db_user, $db_pass, $db_host, $db_port, $db_path, $settings_file, &$form_state, $form = NULL) {
351 352
  global $db_url;

353
  // Verify the table prefix
354
  if (!empty($db_prefix) && is_string($db_prefix) && !preg_match('/^[A-Za-z0-9_.]+$/', $db_prefix)) {
355
    form_set_error('db_prefix', st('The database table prefix you have entered, %db_prefix, is invalid. The table prefix can only contain alphanumeric characters, periods, or underscores.', array('%db_prefix' => $db_prefix)), 'error');
356 357
  }

358 359 360 361
  if (!empty($db_port) && !is_numeric($db_port)) {
    form_set_error('db_port', st('Database port must be a number.'));
  }

362 363
  // Check database type
  if (!isset($form)) {
364 365
    $_db_url = is_array($db_url) ? $db_url['default'] : $db_url;
    $db_type = substr($_db_url, 0, strpos($_db_url, '://'));
366 367 368
  }
  $databases = drupal_detect_database_types();
  if (!in_array($db_type, $databases)) {
369
    form_set_error('db_type', st("In your %settings_file file you have configured @drupal to use a %db_type server, however your PHP installation currently does not support this database type.", array('%settings_file' => $settings_file, '@drupal' => drupal_install_profile_name(), '%db_type' => $db_type)));
370 371 372
  }
  else {
    // Verify
373
    $db_url = $db_type .'://'. urlencode($db_user) . ($db_pass ? ':'. urlencode($db_pass) : '') .'@'. ($db_host ? urlencode($db_host) : 'localhost') . ($db_port ? ":$db_port" : '') .'/'. urlencode($db_path);
374
    if (isset($form)) {
375
      form_set_value($form['_db_url'], $db_url, $form_state);
376 377 378 379 380 381
    }
    $success = array();

    $function = 'drupal_test_'. $db_type;
    if (!$function($db_url, $success)) {
      if (isset($success['CONNECT'])) {
382
        form_set_error('db_type', st('In order for Drupal to work, and to continue with the installation process, you must resolve all permission issues reported above. We were able to verify that we have permission for the following commands: %commands. For more help with configuring your database server, see the <a href="http://drupal.org/node/258">Installation and upgrading handbook</a>. If you are unsure what any of this means you should probably contact your hosting provider.', array('%commands' => implode($success, ', '))));
383 384 385 386 387 388 389 390 391 392 393
      }
      else {
        form_set_error('db_type', '');
      }
    }
  }
}

/**
 * Form API submit for install_settings form.
 */
394
function install_settings_form_submit($form, &$form_state) {
drumm's avatar
drumm committed
395
  global $profile, $install_locale;
396 397 398

  // Update global settings array and save
  $settings['db_url'] = array(
399
    'value'    => $form_state['values']['_db_url'],
400 401 402
    'required' => TRUE,
  );
  $settings['db_prefix'] = array(
403
    'value'    => $form_state['values']['db_prefix'],
404 405 406 407 408
    'required' => TRUE,
  );
  drupal_rewrite_settings($settings);

  // Continue to install profile step
409
  install_goto("install.php?profile=$profile". ($install_locale ? "&locale=$install_locale" : ''));
410 411 412
}

/**
413 414 415
 * Find all .profile files.
 */
function install_find_profiles() {
Dries's avatar
Dries committed
416
  return file_scan_directory('./profiles', '\.profile$', array('.', '..', 'CVS'), 0, TRUE, 'name', 0);
417 418 419 420
}

/**
 * Allow admin to select which profile to install.
421 422 423 424 425 426 427
 *
 * @return
 *   The selected profile.
 */
function install_select_profile() {
  include_once './includes/form.inc';

428
  $profiles = install_find_profiles();
429 430 431 432 433 434 435 436
  // Don't need to choose profile if only one available.
  if (sizeof($profiles) == 1) {
    $profile = array_pop($profiles);
    require_once $profile->filename;
    return $profile->name;
  }
  elseif (sizeof($profiles) > 1) {
    foreach ($profiles as $profile) {
437
      if ($_POST['profile'] == $profile->name) {
438 439 440
        return $profile->name;
      }
    }
441

442
    install_task_list('profile-select');
443

drumm's avatar
drumm committed
444
    drupal_set_title(st('Select an installation profile'));
445
    print theme('install_page', drupal_get_form('install_select_profile_form', $profiles));
446 447 448 449
    exit;
  }
}

450 451 452
/**
 * Form API array definition for the profile selection form.
 */
453
function install_select_profile_form(&$form_state, $profiles) {
454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473
  foreach ($profiles as $profile) {
    include_once($profile->filename);
    // Load profile details.
    $function = $profile->name .'_profile_details';
    if (function_exists($function)) {
      $details = $function();
    }
    // If set, used defined name. Otherwise use file name.
    $name = isset($details['name']) ? $details['name'] : $profile->name;
    $form['profile'][$name] = array(
      '#type' => 'radio',
      '#value' => 'default',
      '#return_value' => $profile->name,
      '#title' => $name,
      '#description' => isset($details['description']) ? $details['description'] : '',
      '#parents' => array('profile'),
    );
  }
  $form['submit'] =  array(
    '#type' => 'submit',
drumm's avatar
drumm committed
474 475 476 477 478 479
    '#value' => st('Save configuration'),
  );
  return $form;
}

/**
480 481 482
 * Find all .po files for the current profile.
 */
function install_find_locales($profilename) {
483
  $locales = file_scan_directory('./profiles/'. $profilename .'/translations', '\.po$', array('.', '..', 'CVS'), 0, FALSE);
484 485 486 487 488 489
  array_unshift($locales, (object) array('name' => 'en'));
  return $locales;
}

/**
 * Allow admin to select which locale to use for the current profile.
drumm's avatar
drumm committed
490 491 492 493 494 495 496 497
 *
 * @return
 *   The selected language.
 */
function install_select_locale($profilename) {
  include_once './includes/file.inc';
  include_once './includes/form.inc';

498 499
  // Find all available locales.
  $locales = install_find_locales($profilename);
drumm's avatar
drumm committed
500

501 502 503 504 505 506
  // If only the built-in (English) language is available,
  // and we are using the default profile, inform the user
  // that the installer can be localized. Otherwise we assume
  // the user know what he is doing.
  if (count($locales) == 1) {
    if ($profilename == 'default') {
507 508 509
      install_task_list('locale-select');
      drupal_set_title(st('Choose language'));
      if (!empty($_GET['localize'])) {
510
        $output = '<p>'. st('With the addition of an appropriate language pack, this installer is capable of proceeding in another language of your choice. To install and use Drupal in a language other than English:') .'</p>';
511
        $output .= '<ul><li>'. st('Determine if <a href="@translations" target="_blank">a translation of this Drupal version</a> is available in your language of choice. A translation is provided via a translation pack; each translation pack enables the display of a specific version of Drupal in a specific language. Not all languages are available for every version of Drupal.', array('@translations' => 'http://drupal.org/project/translations')) .'</li>';
512 513
        $output .= '<li>'. st('If an alternative language pack of your choice is available, download and extract its contents to your Drupal root directory.') .'</li>';
        $output .= '<li>'. st('Return to choose language using the second link below and select your desired language from the displayed list. Reloading the page allows the list to automatically adjust to the presence of new language packs.') .'</li>';
514 515 516
        $output .= '</ul><p>'. st('Alternatively, to install and use Drupal in English, or to defer the selection of an alternative language until after installation, select the first link below.') .'</p>';
        $output .= '<p>'. st('How should the installation continue?') .'</p>';
        $output .= '<ul><li><a href="install.php?profile='. $profilename .'&amp;locale=en">'. st('Continue installation in English') .'</a></li><li><a href="install.php?profile='. $profilename .'">'. st('Return to choose a language') .'</a></li></ul>';
517 518
      }
      else {
519
        $output = '<ul><li><a href="install.php?profile='. $profilename .'&amp;locale=en">'. st('Install Drupal in English') .'</a></li><li><a href="install.php?profile='. $profilename .'&localize=true">'. st('Learn how to install Drupal in other languages') .'</a></li></ul>';
520
      }
521 522 523 524 525
      print theme('install_page', $output);
      exit;
    }
    // One language, but not the default profile, assume
    // the user knows what he is doing.
drumm's avatar
drumm committed
526
    return FALSE;
527 528
  }
  else {
529 530 531 532 533 534 535 536 537 538 539 540 541
    // Allow profile to pre-select the language, skipping the selection.
    $function = $profilename .'_profile_details';
    if (function_exists($function)) {
      $details = $function();
      if (isset($details['language'])) {
        foreach ($locales as $locale) {
          if ($details['language'] == $locale->name) {
            return $locale->name;
          }
        }
      }
    }

drumm's avatar
drumm committed
542 543 544 545 546 547
    foreach ($locales as $locale) {
      if ($_POST['locale'] == $locale->name) {
        return $locale->name;
      }
    }

548
    install_task_list('locale-select');
drumm's avatar
drumm committed
549

550
    drupal_set_title(st('Choose language'));
drumm's avatar
drumm committed
551 552 553 554 555
    print theme('install_page', drupal_get_form('install_select_locale_form', $locales));
    exit;
  }
}

556 557 558
/**
 * Form API array definition for language selection.
 */
559
function install_select_locale_form(&$form_state, $locales) {
drumm's avatar
drumm committed
560
  include_once './includes/locale.inc';
561
  $languages = _locale_get_predefined_list();
drumm's avatar
drumm committed
562 563 564 565
  foreach ($locales as $locale) {
    // Try to use verbose locale name
    $name = $locale->name;
    if (isset($languages[$name])) {
566
      $name = $languages[$name][0] . (isset($languages[$name][1]) ? ' '. st('(@language)', array('@language' => $languages[$name][1])) : '');
drumm's avatar
drumm committed
567 568 569 570 571
    }
    $form['locale'][$locale->name] = array(
      '#type' => 'radio',
      '#return_value' => $locale->name,
      '#default_value' => ($locale->name == 'en' ? TRUE : FALSE),
572
      '#title' => $name . ($locale->name == 'en' ? ' '. st('(built-in)') : ''),
drumm's avatar
drumm committed
573 574 575 576 577
      '#parents' => array('locale')
    );
  }
  $form['submit'] =  array(
    '#type' => 'submit',
578
    '#value' => st('Select language'),
579 580 581 582
  );
  return $form;
}

583 584 585 586
/**
 * Show an error page when there are no profiles available.
 */
function install_no_profile_error() {
587
  install_task_list('profile-select');
drumm's avatar
drumm committed
588
  drupal_set_title(st('No profiles available'));
589
  print theme('install_page', '<p>'. st('We were unable to find any installer profiles. Installer profiles tell us what modules to enable and what schema to install in the database. A profile is necessary to continue with the installation process.') .'</p>');
590 591 592 593 594 595 596 597
  exit;
}


/**
 * Show an error page when Drupal has already been installed.
 */
function install_already_done_error() {
598 599
  global $base_url;

drumm's avatar
drumm committed
600
  drupal_set_title(st('Drupal already installed'));
601
  print theme('install_page', st('<ul><li>To start over, you must empty your existing database.</li><li>To install to a different database, edit the appropriate <em>settings.php</em> file in the <em>sites</em> folder.</li><li>To upgrade an existing installation, proceed to the <a href="@base-url/update.php">update script</a>.</li><li>View your <a href="@base-url">existing site</a>.</li></ul>', array('@base-url' => $base_url)));
602 603 604 605
  exit;
}

/**
606
 * Tasks performed after the database is initialized.
607
 */
608
function install_tasks($profile, $task) {
609
  global $base_url, $install_locale;
610 611

  // Bootstrap newly installed Drupal, while preserving existing messages.
612
  $messages = isset($_SESSION['messages']) ? $_SESSION['messages'] : '';
613 614 615
  drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL);
  $_SESSION['messages'] = $messages;

616 617 618 619
  // URL used to direct page requests.
  $url = $base_url .'/install.php?locale='. $install_locale .'&profile='. $profile;

  // Build a page for final tasks.
620
  if (empty($task)) {
621 622
    variable_set('install_task', 'profile-install');
    $task = 'profile-install';
623 624
  }

625 626 627
  // We are using a list of if constructs here to allow for
  // passing from one task to the other in the same request.

628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657
  // Install profile modules.
  if ($task == 'profile-install') {
    $modules = variable_get('install_profile_modules', array());
    $files = module_rebuild_cache();
    variable_del('install_profile_modules');
    $operations = array();
    foreach ($modules as $module) {
      $operations[] = array('_install_module_batch', array($module, $files[$module]->info['name']));
    }
    $batch = array(
      'operations' => $operations,
      'finished' => '_install_profile_batch_finished',
      'title' => t('Installing @drupal', array('@drupal' => drupal_install_profile_name())),
      'error_message' => t('The installation has encountered an error.'),
    );
    // Start a batch, switch to 'profile-install-batch' task. We need to
    // set the variable here, because batch_process() redirects.
    variable_set('install_task', 'profile-install-batch');
    batch_set($batch);
    batch_process($url, $url);
  }
  // We are running a batch install of the profile's modules.
  // This might run in multiple HTTP requests, constantly redirecting
  // to the same address, until the batch finished callback is invoked
  // and the task advances to 'locale-initial-import'.
  if ($task == 'profile-install-batch') {
    include_once 'includes/batch.inc';
    $output = _batch_page();
  }

658 659 660 661 662 663 664 665 666 667
  // Import interface translations for the enabled modules.
  if ($task == 'locale-initial-import') {
    if (!empty($install_locale) && ($install_locale != 'en')) {
      include_once 'includes/locale.inc';
      // Enable installation language as default site language.
      locale_add_language($install_locale, NULL, NULL, NULL, NULL, NULL, 1, TRUE);
      // Collect files to import for this language.
      $batch = locale_batch_by_language($install_locale, '_install_locale_initial_batch_finished');
      if (!empty($batch)) {
        // Remember components we cover in this batch set.
668
        variable_set('install_locale_batch_components', $batch['#components']);
669 670 671 672 673 674 675 676 677 678 679 680 681 682 683
        // Start a batch, switch to 'locale-batch' task. We need to
        // set the variable here, because batch_process() redirects.
        variable_set('install_task', 'locale-initial-batch');
        batch_set($batch);
        batch_process($url, $url);
      }
    }
    // Found nothing to import or not foreign language, go to next task.
    $task = 'configure';
  }
  if ($task == 'locale-initial-batch') {
    include_once 'includes/batch.inc';
    include_once 'includes/locale.inc';
    $output = _batch_page();
  }
684

685 686 687 688 689 690
  if ($task == 'configure') {
    if (variable_get('site_name', FALSE) || variable_get('site_mail', FALSE)) {
      // Site already configured: This should never happen, means re-running
      // the installer, possibly by an attacker after the 'install_task' variable
      // got accidentally blown somewhere. Stop it now.
      install_already_done_error();
691
    }
692 693 694 695 696 697
    $form = drupal_get_form('install_configure_form', $url);

    if (!variable_get('site_name', FALSE) && !variable_get('site_mail', FALSE)) {
      // Not submitted yet: Prepare to display the form.
      $output = $form;
      drupal_set_title(st('Configure site'));
698

699 700 701 702 703 704 705 706 707 708
      // Warn about settings.php permissions risk
      $settings_dir = './'. conf_path();
      $settings_file = $settings_dir .'/settings.php';
      if (!drupal_verify_install_file($settings_file, FILE_EXIST|FILE_READABLE|FILE_NOT_WRITABLE) || !drupal_verify_install_file($settings_dir, FILE_NOT_WRITABLE, 'dir')) {
        drupal_set_message(st('All necessary changes to %dir and %file have been made, so you should remove write permissions to them now in order to avoid security risks. If you are unsure how to do so, please consult the <a href="@handbook_url">on-line handbook</a>.', array('%dir' => $settings_dir, '%file' => $settings_file, '@handbook_url' => 'http://drupal.org/getting-started')), 'error');
      }
      else {
        drupal_set_message(st('All necessary changes to %dir and %file have been made. They have been set to read-only for security.', array('%dir' => $settings_dir, '%file' => $settings_file)));
      }

709
      // Add JavaScript validation.
710 711 712 713 714 715 716 717 718 719 720 721 722
      _user_password_dynamic_validation();
      drupal_add_js(drupal_get_path('module', 'system') .'/system.js', 'module');
      // We add these strings as settings because JavaScript translation does not
      // work on install time.
      drupal_add_js(array('copyFieldValue' => array('edit-site-mail' => array('edit-account-mail')), 'cleanURL' => array('success' => st('Your server has been successfully tested to support this feature.'), 'failure' => st('Your system configuration does not currently support this feature. The <a href="http://drupal.org/node/15365">handbook page on Clean URLs</a> has additional troubleshooting information.'), 'testing' => st('Testing clean URLs...'))), 'setting');
      drupal_add_js('
// Global Killswitch
if (Drupal.jsEnabled) {
  $(document).ready(function() {
    Drupal.cleanURLsInstallCheck();
    Drupal.setDefaultTimezone();
  });
}', 'inline');
723 724
      // Build menu to allow clean URL check.
      menu_rebuild();
725
    }
726

727 728
    else {
      $task = 'profile';
729
    }
730
  }
731

732
  // If found an unknown task or the 'profile' task, which is
733 734 735 736
  // reserved for profiles, hand over the control to the profile,
  // so it can run any number of custom tasks it defines.
  if (!in_array($task, install_reserved_tasks())) {
    $function = $profile .'_profile_tasks';
737
    if (function_exists($function)) {
738
      // The profile needs to run more code, maybe even more tasks.
739
      // $task is sent through as a reference and may be changed!
740
      $output = $function($task, $url);
741 742
    }

743
    // If the profile doesn't move on to a new task we assume
744
    // that it is done.
745
    if ($task == 'profile') {
746
      $task = 'profile-finished';
747
    }
748
  }
749

750 751 752
  // Profile custom tasks are done, so let the installer regain
  // control and proceed with importing the remaining translations.
  if ($task == 'profile-finished') {
753 754
    if (!empty($install_locale) && ($install_locale != 'en')) {
      include_once 'includes/locale.inc';
755 756 757 758 759
      // Collect files to import for this language. Skip components
      // already covered in the initial batch set.
      $batch = locale_batch_by_language($install_locale, '_install_locale_remaining_batch_finished', variable_get('install_locale_batch_components', array()));
      // Remove temporary variable.
      variable_del('install_locale_batch_components');
760
      if (!empty($batch)) {
761
        // Start a batch, switch to 'locale-remaining-batch' task. We need to
762
        // set the variable here, because batch_process() redirects.
763
        variable_set('install_task', 'locale-remaining-batch');
764
        batch_set($batch);
765
        batch_process($url, $url);
766
      }
767
    }
768
    // Found nothing to import or not foreign language, go to next task.
769
    $task = 'finished';
770
  }
771
  if ($task == 'locale-remaining-batch') {
772 773
    include_once 'includes/batch.inc';
    include_once 'includes/locale.inc';
774
    $output = _batch_page();
775
  }
776

777 778 779 780
  // Display a 'finished' page to user.
  if ($task == 'finished') {
    drupal_set_title(st('@drupal installation complete', array('@drupal' => drupal_install_profile_name())));
    $messages = drupal_set_message();
781
    $output = '<p>'. st('Congratulations, @drupal has been successfully installed.', array('@drupal' => drupal_install_profile_name())) .'</p>';
782 783 784
    $output .= '<p>'. (isset($messages['error']) ? st('Please review the messages above before continuing on to <a href="@url">your new site</a>.', array('@url' => url(''))) : st('You may now visit <a href="@url">your new site</a>.', array('@url' => url('')))) .'</p>';
    $task = 'done';
  }
785

786 787 788 789 790
  // The end of the install process. Remember profile used.
  if ($task == 'done') {
    // Rebuild menu to get content type links registered by the profile,
    // and possibly any other menu items created through the tasks.
    menu_rebuild();
791 792 793 794

    // Register actions declared by any modules.
    actions_synchronize();

795
    variable_set('install_profile', $profile);
796
  }
797 798 799 800 801

  // Set task for user, and remember the task in the database.
  install_task_list($task);
  variable_set('install_task', $task);

802 803 804 805 806
  // Output page, if some output was required. Otherwise it is possible
  // that we are printing a JSON page and theme output should not be there.
  if (isset($output)) {
    print theme('maintenance_page', $output);
  }
807 808
}

809 810 811 812 813 814 815 816 817 818 819
/**
 * Batch callback for batch installation of modules.
 */
function _install_module_batch($module, $module_name, &$context) {
  _drupal_install_module($module);
  // We enable the installed module right away, so that the module will be
  // loaded by drupal_bootstrap in subsequent batch requests, and other
  // modules possibly depending on it can safely perform their installation
  // steps.
  module_enable(array($module));
  $context['results'][] = $module;
820
  $context['message'] = 'Installed '. $module_name .' module.';
821 822 823 824 825 826 827 828 829 830 831
}

/**
 * Finished callback for the modules install batch.
 *
 * Advance installer task to language import.
 */
function _install_profile_batch_finished($success, $results) {
  variable_set('install_task', 'locale-initial-import');
}

832 833
/**
 * Finished callback for the first locale import batch.
834
 *
835 836 837 838 839 840 841 842
 * Advance installer task to the configure screen.
 */
function _install_locale_initial_batch_finished($success, $results) {
  variable_set('install_task', 'configure');
}

/**
 * Finished callback for the second locale import batch.
843
 *
844 845 846 847 848 849
 * Advance installer task to the finished screen.
 */
function _install_locale_remaining_batch_finished($success, $results) {
  variable_set('install_task', 'finished');
}

850 851 852 853
/**
 * The list of reserved tasks to run in the installer.
 */
function install_reserved_tasks() {
854
  return array('configure', 'profile-install', 'profile-install-batch', 'locale-initial-import', 'locale-initial-batch', 'profile-finished', 'locale-remaining-batch', 'finished', 'done');
855 856
}

857
/**
858
 * Check installation requirements and report any errors.
859
 */
860
function install_check_requirements($profile, $verify) {
861 862 863 864 865 866 867 868
  $requirements = drupal_check_profile($profile);
  $severity = drupal_requirements_severity($requirements);

  // If there are issues, report them.
  if ($severity == REQUIREMENT_ERROR) {

    foreach ($requirements as $requirement) {
      if (isset($requirement['severity']) && $requirement['severity'] == REQUIREMENT_ERROR) {
869 870 871 872 873
        $message = $requirement['description'];
        if ($requirement['value']) {
          $message .= ' ('. st('Currently using !item !version', array('!item' => $requirement['title'], '!version' => $requirement['value'])) .')';
        }
        drupal_set_message($message, 'error');
874 875
      }
    }
876
  }
877

878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900
  // If Drupal is not set up already, we also need to create a settings file.
  if (!$verify) {
    $writable = FALSE;
    $conf_path = './'. conf_path();
    $settings_file = $conf_path .'/settings.php';
    $file = $conf_path;
    // Verify that the directory exists.
    if (drupal_verify_install_file($conf_path, FILE_EXIST, 'dir')) {
      // Check to see if a settings.php already exists.
      if (drupal_verify_install_file($settings_file, FILE_EXIST)) {
        // If it does, make sure it is writable.
        $writable = drupal_verify_install_file($settings_file, FILE_READABLE|FILE_WRITABLE);
        $file = $settings_file;
      }
      else {
        // If not, make sure the directory is.
        $writable = drupal_verify_install_file($conf_path, FILE_READABLE|FILE_WRITABLE, 'dir');
      }
    }

    if (!$writable) {
      drupal_set_message(st('The @drupal installer requires write permissions to %file during the installation process. If you are unsure how to grant file permissions, please consult the <a href="@handbook_url">on-line handbook</a>.', array('@drupal' => drupal_install_profile_name(), '%file' => $file, '@handbook_url' => 'http://drupal.org/getting-started')), 'error');
    }
901 902 903
  }
}

904 905 906 907 908 909
/**
 * Add the installation task list to the current page.
 */
function install_task_list($active = NULL) {
  // Default list of tasks.
  $tasks = array(
910 911 912 913 914 915 916
    'profile-select'        => st('Choose profile'),
    'locale-select'         => st('Choose language'),
    'requirements'          => st('Verify requirements'),
    'database'              => st('Set up database'),
    'profile-install-batch' => st('Install profile'),
    'locale-initial-batch'  => st('Set up translations'),
    'configure'             => st('Configure site'),
917
  );
Dries's avatar
Dries committed
918

919 920
  $profiles = install_find_profiles();
  $profile = isset($_GET['profile']) && isset($profiles[$_GET['profile']]) ? $_GET['profile'] : '.';
921 922
  $locales = install_find_locales($profile);

923 924
  // If we have only one profile, remove 'Choose profile'
  // and rename 'Install profile'.
925 926
  if (count($profiles) == 1) {
    unset($tasks['profile-select']);
927
    $tasks['profile-install-batch'] = st('Install site');
928 929
  }

930
  // Add tasks defined by the profile.
931 932 933 934 935 936 937 938 939 940
  if ($profile) {
    $function = $profile .'_profile_task_list';
    if (function_exists($function)) {
      $result = $function();
      if (is_array($result)) {
        $tasks += $result;
      }
    }
  }

941 942 943 944 945 946 947
  if (count($locales) < 2 || empty($_GET['locale']) || $_GET['locale'] == 'en') {
    // If not required, remove translation import from the task list.
    unset($tasks['locale-initial-batch']);
  }
  else {
    // If required, add remaining translations import task.
    $tasks += array('locale-remaining-batch' => st('Finish translations'));
948 949
  }

950
  // Add finished step as the last task.
951 952 953 954
  $tasks += array(
    'finished'     => st('Finished')
  );

955 956 957 958 959
  // Let the theming function know that 'finished' and 'done'
  // include everything, so every step is completed.
  if (in_array($active, array('finished', 'done'))) {
    $active = NULL;
  }
960 961 962
  drupal_set_content('left', theme_task_list($tasks, $active));
}

963 964 965 966
/**
 * Form API array definition for site configuration.
 */
function install_configure_form(&$form_state, $url) {
967 968

  $form['intro'] = array(
969
    '#value' => st('To configure your website, please provide the following information.'),
970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985
    '#weight' => -10,
  );
  $form['site_information'] = array(
    '#type' => 'fieldset',
    '#title' => st('Site information'),
    '#collapsible' => FALSE,
  );
  $form['site_information']['site_name'] = array(
    '#type' => 'textfield',
    '#title' => st('Site name'),
    '#required' => TRUE,
    '#weight' => -20,
  );
  $form['site_information']['site_mail'] = array(
    '#type' => 'textfield',
    '#title' => st('Site e-mail address'),
986
    '#default_value' => ini_get('sendmail_from'),
987
    '#description' => st('A valid e-mail address to be used as the "From" address by the auto-mailer during registration, new password requests, notifications, etc. To lessen the likelihood of e-mail being marked as spam, this e-mail address should use the same domain as the website.'),
988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010