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

require_once './includes/install.inc';

6 7 8
/**
 * Global flag to indicate that site is in installation mode.
 */
9 10
define('MAINTENANCE_MODE', 'install');

11 12 13 14 15 16 17 18 19 20 21 22
/**
 * 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() {
23 24 25 26 27 28
  // The user agent header is used to pass a database prefix in the request when
  // running tests.  However, for security reasons, it is imperative that no
  // installation be permitted using such a prefix.
  if (preg_match("/^simpletest\d+$/", $_SERVER['HTTP_USER_AGENT'])) {
    header('HTTP/1.1 403 Forbidden');
    exit;
29 30
  }

31 32
  require_once './includes/bootstrap.inc';
  drupal_bootstrap(DRUPAL_BOOTSTRAP_CONFIGURATION);
33

34 35 36
  // This must go after drupal_bootstrap(), which unsets globals!
  global $profile, $install_locale, $conf;

37
  require_once './modules/system/system.install';
38
  require_once './includes/file.inc';
39

40 41 42
  // Ensure correct page headers are sent (e.g. caching)
  drupal_page_header();

43 44 45
  // Set up $language, so t() caller functions will still work.
  drupal_init_language();

46 47 48 49 50 51 52 53 54 55 56
  // 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();

57 58 59 60
  // Check existing settings.php.
  $verify = install_verify_settings();

  if ($verify) {
61 62 63 64 65 66
    // 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';

67 68 69
    // Establish a connection to the database.
    require_once './includes/database.inc';
    db_set_active();
70

71
    // Check if Drupal is installed.
72 73
    $task = install_verify_drupal();
    if ($task == 'done') {
74 75 76
      install_already_done_error();
    }
  }
77
  else {
78 79 80 81 82 83 84
    // 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';

85 86
    $task = NULL;
  }
87 88 89 90 91 92

  // Decide which profile to use.
  if (!empty($_GET['profile'])) {
    $profile = preg_replace('/[^a-zA-Z_0-9]/', '', $_GET['profile']);
  }
  elseif ($profile = install_select_profile()) {
93
    install_goto("install.php?profile=$profile");
94 95
  }
  else {
96
    install_no_profile_error();
97
  }
drumm's avatar
drumm committed
98

99 100 101
  // Load the profile.
  require_once "./profiles/$profile/$profile.profile";

drumm's avatar
drumm committed
102 103 104 105 106 107 108 109
  // 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");
  }

110 111
  // Tasks come after the database is set up
  if (!$task) {
112 113 114 115 116 117 118
    global $db_url;

    if (!$verify && !empty($db_url)) {
      // Do not install over a configured settings.php.
      install_already_done_error();
    }

119
    // Check the installation requirements for Drupal and this profile.
120
    install_check_requirements($profile, $verify);
121

122 123
    // Verify existence of all required modules.
    $modules = drupal_verify_profile($profile, $install_locale);
124 125 126 127 128 129 130 131

    // 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;
132
    }
133

134 135 136 137 138
    // 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);
    }
139

140 141 142 143 144 145
    // 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')));
146
  }
147

148 149
  // The database is set up, turn to further tasks.
  install_tasks($profile, $task);
150 151 152 153 154 155
}

/**
 * Verify if Drupal is installed.
 */
function install_verify_drupal() {
156
  // Read the variable manually using the @ so we don't trigger an error if it fails.
157
  $result = @db_query("SELECT value FROM {variable} WHERE name = '%s'", 'install_task');
158 159 160
  if ($result) {
    return unserialize(db_result($result));
  }
161 162 163 164 165 166 167 168 169
}

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

  // Verify existing settings (if any).
170
  if (!empty($db_url)) {
171 172 173
    // We need this because we want to run form_get_errors.
    include_once './includes/form.inc';

174
    $url = parse_url(is_array($db_url) ? $db_url['default'] : $db_url);
175
    $db_user = urldecode($url['user']);
176
    $db_pass = isset($url['pass']) ? urldecode($url['pass']) : NULL;
177
    $db_host = urldecode($url['host']);
178
    $db_port = isset($url['port']) ? urldecode($url['port']) : '';
179
    $db_path = ltrim(urldecode($url['path']), '/');
180
    $settings_file = './' . conf_path(FALSE, TRUE) . '/settings.php';
181

182 183
    $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);
184 185 186 187 188 189 190 191 192 193
    if (!form_get_errors()) {
      return TRUE;
    }
  }
  return FALSE;
}

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

197
  $url = parse_url(is_array($db_url) ? $db_url['default'] : $db_url);
198 199 200
  $db_user = isset($url['user']) ? urldecode($url['user']) : '';
  $db_pass = isset($url['pass']) ? urldecode($url['pass']) : '';
  $db_host = isset($url['host']) ? urldecode($url['host']) : '';
201
  $db_port = isset($url['port']) ? urldecode($url['port']) : '';
202
  $db_path = ltrim(urldecode($url['path']), '/');
203 204
  $conf_path = './' . conf_path(FALSE, TRUE);
  $settings_file = $conf_path . '/settings.php';
205 206 207

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

210
  $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
211
  drupal_set_title(st('Database configuration'));
212 213 214
  print theme('install_page', $output);
  exit;
}
215

216

217 218 219
/**
 * Form API array definition for install_settings.
 */
220
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) {
221 222 223
  if (empty($db_host)) {
    $db_host = 'localhost';
  }
224
  $db_types = drupal_detect_database_types();
225 226 227 228 229 230

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

231 232
  if (count($db_types) == 0) {
    $form['no_db_types'] = array(
233
      '#markup' => 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')),
234 235 236 237 238
    );
  }
  else {
    $form['basic_options'] = array(
      '#type' => 'fieldset',
drumm's avatar
drumm committed
239
      '#title' => st('Basic options'),
240
      '#description' => '<p>' . st('To set up your @drupal database, enter the following information.', array('@drupal' => drupal_install_profile_name())) . '</p>',
241 242 243 244 245
    );

    if (count($db_types) > 1) {
      $form['basic_options']['db_type'] = array(
        '#type' => 'radios',
drumm's avatar
drumm committed
246
        '#title' => st('Database type'),
247
        '#required' => TRUE,
248 249
        '#options' => $db_types,
        '#default_value' => ($db_type ? $db_type : current($db_types)),
250
        '#description' => st('The type of database your @drupal data will be stored in.', array('@drupal' => drupal_install_profile_name())),
251
      );
252
      $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()));
253 254 255
    }
    else {
      if (count($db_types) == 1) {
256
        $db_types = array_values($db_types);
257 258 259 260
        $form['basic_options']['db_type'] = array(
          '#type' => 'hidden',
          '#value' => $db_types[0],
        );
261
        $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()));
262 263 264 265 266 267
      }
    }

    // Database name
    $form['basic_options']['db_path'] = array(
      '#type' => 'textfield',
drumm's avatar
drumm committed
268
      '#title' => st('Database name'),
269 270 271 272 273 274 275 276 277 278
      '#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
279
      '#title' => st('Database username'),
280 281 282 283 284 285 286 287 288
      '#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
289
      '#title' => st('Database password'),
290 291 292 293 294 295 296
      '#default_value' => $db_pass,
      '#size' => 45,
      '#maxlength' => 45,
    );

    $form['advanced_options'] = array(
      '#type' => 'fieldset',
drumm's avatar
drumm committed
297
      '#title' => st('Advanced options'),
298 299
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
300
      '#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.")
301 302 303 304 305
    );

    // Database host
    $form['advanced_options']['db_host'] = array(
      '#type' => 'textfield',
drumm's avatar
drumm committed
306
      '#title' => st('Database host'),
307 308 309 310
      '#default_value' => $db_host,
      '#size' => 45,
      '#maxlength' => 45,
      '#required' => TRUE,
drumm's avatar
drumm committed
311
      '#description' => st('If your database is located on a different server, change this.'),
312 313
    );

314 315 316 317 318 319 320 321 322 323
    // 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.'),
    );

324
    // Table prefix
325
    $prefix = ($profile == 'default') ? 'drupal_' : $profile . '_';
326 327
    $form['advanced_options']['db_prefix'] = array(
      '#type' => 'textfield',
328
      '#title' => st('Table prefix'),
329 330 331
      '#default_value' => $db_prefix,
      '#size' => 45,
      '#maxlength' => 45,
332
      '#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)),
333 334 335 336
    );

    $form['save'] = array(
      '#type' => 'submit',
337
      '#value' => st('Save and continue'),
338 339 340 341 342
    );

    $form['errors'] = array();
    $form['settings_file'] = array('#type' => 'value', '#value' => $settings_file);
    $form['_db_url'] = array('#type' => 'value');
343
    $form['#action'] = "install.php?profile=$profile" . ($install_locale ? "&locale=$install_locale" : '');
344
    $form['#redirect'] = FALSE;
345
  }
346
  return $form;
347
}
348

349 350 351
/**
 * Form API validate for install_settings form.
 */
352
function install_settings_form_validate($form, &$form_state) {
353
  global $db_url;
354
  _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);
355 356 357 358 359
}

/**
 * Helper function for install_settings_validate.
 */
360
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) {
361 362
  global $db_url;

363
  // Verify the table prefix
364
  if (!empty($db_prefix) && is_string($db_prefix) && !preg_match('/^[A-Za-z0-9_.]+$/', $db_prefix)) {
365
    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');
366 367
  }

368 369 370 371
  if (!empty($db_port) && !is_numeric($db_port)) {
    form_set_error('db_port', st('Database port must be a number.'));
  }

372 373
  // Check database type
  if (!isset($form)) {
374 375
    $_db_url = is_array($db_url) ? $db_url['default'] : $db_url;
    $db_type = substr($_db_url, 0, strpos($_db_url, '://'));
376 377 378
  }
  $databases = drupal_detect_database_types();
  if (!in_array($db_type, $databases)) {
379
    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)));
380 381 382
  }
  else {
    // Verify
383
    $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);
384
    if (isset($form)) {
385
      form_set_value($form['_db_url'], $db_url, $form_state);
386 387 388
    }
    $success = array();

389
    $function = 'drupal_test_' . $db_type;
390 391
    if (!$function($db_url, $success)) {
      if (isset($success['CONNECT'])) {
392
        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, ', '))));
393 394 395 396 397 398 399 400 401 402 403
      }
      else {
        form_set_error('db_type', '');
      }
    }
  }
}

/**
 * Form API submit for install_settings form.
 */
404
function install_settings_form_submit($form, &$form_state) {
drumm's avatar
drumm committed
405
  global $profile, $install_locale;
406 407 408

  // Update global settings array and save
  $settings['db_url'] = array(
409
    'value'    => $form_state['values']['_db_url'],
410 411 412
    'required' => TRUE,
  );
  $settings['db_prefix'] = array(
413
    'value'    => $form_state['values']['db_prefix'],
414 415 416 417 418
    'required' => TRUE,
  );
  drupal_rewrite_settings($settings);

  // Continue to install profile step
419
  install_goto("install.php?profile=$profile" . ($install_locale ? "&locale=$install_locale" : ''));
420 421 422
}

/**
423 424 425
 * Find all .profile files.
 */
function install_find_profiles() {
Dries's avatar
Dries committed
426
  return file_scan_directory('./profiles', '\.profile$', array('.', '..', 'CVS'), 0, TRUE, 'name', 0);
427 428 429 430
}

/**
 * Allow admin to select which profile to install.
431 432 433 434 435 436 437
 *
 * @return
 *   The selected profile.
 */
function install_select_profile() {
  include_once './includes/form.inc';

438
  $profiles = install_find_profiles();
439 440 441 442 443 444 445 446
  // 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) {
447
      if (!empty($_POST['profile']) && ($_POST['profile'] == $profile->name)) {
448 449 450
        return $profile->name;
      }
    }
451

452
    install_task_list('profile-select');
453

drumm's avatar
drumm committed
454
    drupal_set_title(st('Select an installation profile'));
455
    print theme('install_page', drupal_get_form('install_select_profile_form', $profiles));
456 457 458 459
    exit;
  }
}

460 461
/**
 * Form API array definition for the profile selection form.
462 463 464 465 466
 *
 * @param $form_state
 *   Array of metadata about state of form processing.
 * @param $profile_files
 *   Array of .profile files, as returned from file_scan_directory().
467
 */
468 469 470 471 472
function install_select_profile_form(&$form_state, $profile_files) {
  $profiles = array();
  $names = array();

  foreach ($profile_files as $profile) {
473
    include_once($profile->filename);
474 475

    // Load profile details and store them for later retrieval.
476
    $function = $profile->name . '_profile_details';
477 478 479
    if (function_exists($function)) {
      $details = $function();
    }
480 481 482 483
    $profiles[$profile->name] = $details;

    // Determine the name of the profile; default to file name if defined name
    // is unspecified.
484
    $name = isset($details['name']) ? $details['name'] : $profile->name;
485 486 487 488 489 490 491
    $names[$profile->name] = $name;
  }

  // Display radio buttons alphabetically by human-readable name.
  natcasesort($names);

  foreach ($names as $profile => $name) {
492 493 494
    $form['profile'][$name] = array(
      '#type' => 'radio',
      '#value' => 'default',
495
      '#return_value' => $profile,
496
      '#title' => $name,
497
      '#description' => isset($profiles[$profile]['description']) ? $profiles[$profile]['description'] : '',
498 499 500 501 502
      '#parents' => array('profile'),
    );
  }
  $form['submit'] =  array(
    '#type' => 'submit',
503
    '#value' => st('Save and continue'),
drumm's avatar
drumm committed
504 505 506 507 508
  );
  return $form;
}

/**
509 510 511
 * Find all .po files for the current profile.
 */
function install_find_locales($profilename) {
512
  $locales = file_scan_directory('./profiles/' . $profilename . '/translations', '\.po$', array('.', '..', 'CVS'), 0, FALSE);
513 514 515 516 517 518
  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
519 520 521 522 523 524 525 526
 *
 * @return
 *   The selected language.
 */
function install_select_locale($profilename) {
  include_once './includes/file.inc';
  include_once './includes/form.inc';

527 528
  // Find all available locales.
  $locales = install_find_locales($profilename);
drumm's avatar
drumm committed
529

530 531 532 533 534 535
  // 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') {
536 537 538
      install_task_list('locale-select');
      drupal_set_title(st('Choose language'));
      if (!empty($_GET['localize'])) {
539 540 541 542 543 544 545
        $output = '<p>' . st('With the addition of an appropriate translation package, this installer is capable of proceeding in another language of your choice. To install and use Drupal in a language other than English:') . '</p>';
        $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 package; each translation package 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>';
        $output .= '<li>' . st('If an alternative translation package 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 translation packages.') . '</li>';
        $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>';
546 547
      }
      else {
548
        $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 . '&amp;localize=true">' . st('Learn how to install Drupal in other languages') . '</a></li></ul>';
549
      }
550 551 552 553 554
      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
555
    return FALSE;
556 557
  }
  else {
558
    // Allow profile to pre-select the language, skipping the selection.
559
    $function = $profilename . '_profile_details';
560 561 562 563 564 565 566 567 568 569 570
    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
571 572 573 574 575 576
    foreach ($locales as $locale) {
      if ($_POST['locale'] == $locale->name) {
        return $locale->name;
      }
    }

577
    install_task_list('locale-select');
drumm's avatar
drumm committed
578

579
    drupal_set_title(st('Choose language'));
drumm's avatar
drumm committed
580 581 582 583 584
    print theme('install_page', drupal_get_form('install_select_locale_form', $locales));
    exit;
  }
}

585 586 587
/**
 * Form API array definition for language selection.
 */
588
function install_select_locale_form(&$form_state, $locales) {
drumm's avatar
drumm committed
589
  include_once './includes/locale.inc';
590
  $languages = _locale_get_predefined_list();
drumm's avatar
drumm committed
591 592 593 594
  foreach ($locales as $locale) {
    // Try to use verbose locale name
    $name = $locale->name;
    if (isset($languages[$name])) {
595
      $name = $languages[$name][0] . (isset($languages[$name][1]) ? ' ' . st('(@language)', array('@language' => $languages[$name][1])) : '');
drumm's avatar
drumm committed
596 597 598 599 600
    }
    $form['locale'][$locale->name] = array(
      '#type' => 'radio',
      '#return_value' => $locale->name,
      '#default_value' => ($locale->name == 'en' ? TRUE : FALSE),
601
      '#title' => $name . ($locale->name == 'en' ? ' ' . st('(built-in)') : ''),
drumm's avatar
drumm committed
602 603 604 605 606
      '#parents' => array('locale')
    );
  }
  $form['submit'] =  array(
    '#type' => 'submit',
607
    '#value' => st('Select language'),
608 609 610 611
  );
  return $form;
}

612 613 614 615
/**
 * Show an error page when there are no profiles available.
 */
function install_no_profile_error() {
616
  install_task_list('profile-select');
drumm's avatar
drumm committed
617
  drupal_set_title(st('No profiles available'));
618
  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>');
619 620 621 622 623 624 625 626
  exit;
}


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

drumm's avatar
drumm committed
629
  drupal_set_title(st('Drupal already installed'));
630
  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)));
631 632 633 634
  exit;
}

/**
635
 * Tasks performed after the database is initialized.
636
 */
637
function install_tasks($profile, $task) {
638
  global $base_url, $install_locale;
639 640

  // Bootstrap newly installed Drupal, while preserving existing messages.
641
  $messages = isset($_SESSION['messages']) ? $_SESSION['messages'] : '';
642 643 644
  drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL);
  $_SESSION['messages'] = $messages;

645
  // URL used to direct page requests.
646
  $url = $base_url . '/install.php?locale=' . $install_locale . '&profile=' . $profile;
647 648

  // Build a page for final tasks.
649
  if (empty($task)) {
650 651
    variable_set('install_task', 'profile-install');
    $task = 'profile-install';
652 653
  }

654 655 656
  // We are using a list of if constructs here to allow for
  // passing from one task to the other in the same request.

657 658 659 660 661 662 663 664 665 666 667 668
  // 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',
669 670
      'title' => st('Installing @drupal', array('@drupal' => drupal_install_profile_name())),
      'error_message' => st('The installation has encountered an error.'),
671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686
    );
    // 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();
  }

687 688 689 690 691 692 693 694 695 696
  // 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.
697
        variable_set('install_locale_batch_components', $batch['#components']);
698 699 700 701 702 703 704 705 706 707 708 709 710 711 712
        // 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();
  }
713

714 715 716 717 718 719
  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();
720
    }
721 722 723 724 725 726
    $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'));
727

728
      // Warn about settings.php permissions risk
729 730
      $settings_dir = './' . conf_path();
      $settings_file = $settings_dir . '/settings.php';
731
      if (!drupal_verify_install_file($settings_file, FILE_EXIST|FILE_READABLE|FILE_NOT_WRITABLE) || !drupal_verify_install_file($settings_dir, FILE_NOT_WRITABLE, 'dir')) {
732
        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">online handbook</a>.', array('%dir' => $settings_dir, '%file' => $settings_file, '@handbook_url' => 'http://drupal.org/getting-started')), 'error');
733 734 735 736 737
      }
      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)));
      }

738
      // Add JavaScript validation.
739
      _user_password_dynamic_validation();
740
      drupal_add_js(drupal_get_path('module', 'system') . '/system.js', 'module');
741 742 743 744 745 746 747 748 749 750 751
      // 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');
752 753
      // Build menu to allow clean URL check.
      menu_rebuild();
754
    }
755

756 757
    else {
      $task = 'profile';
758
    }
759
  }
760

761
  // If found an unknown task or the 'profile' task, which is
762 763 764
  // 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())) {
765
    $function = $profile . '_profile_tasks';
766
    if (function_exists($function)) {
767
      // The profile needs to run more code, maybe even more tasks.
768
      // $task is sent through as a reference and may be changed!
769
      $output = $function($task, $url);
770 771
    }

772
    // If the profile doesn't move on to a new task we assume
773
    // that it is done.
774
    if ($task == 'profile') {
775
      $task = 'profile-finished';
776
    }
777
  }
778

779 780 781
  // Profile custom tasks are done, so let the installer regain
  // control and proceed with importing the remaining translations.
  if ($task == 'profile-finished') {
782 783
    if (!empty($install_locale) && ($install_locale != 'en')) {
      include_once 'includes/locale.inc';
784 785 786 787 788
      // 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');
789
      if (!empty($batch)) {
790
        // Start a batch, switch to 'locale-remaining-batch' task. We need to
791
        // set the variable here, because batch_process() redirects.
792
        variable_set('install_task', 'locale-remaining-batch');
793
        batch_set($batch);
794
        batch_process($url, $url);
795
      }
796
    }
797
    // Found nothing to import or not foreign language, go to next task.
798
    $task = 'finished';
799
  }
800
  if ($task == 'locale-remaining-batch') {
801 802
    include_once 'includes/batch.inc';
    include_once 'includes/locale.inc';
803
    $output = _batch_page();
804
  }
805

806 807 808 809
  // 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();
810 811
    $output = '<p>' . st('Congratulations, @drupal has been successfully installed.', array('@drupal' => drupal_install_profile_name())) . '</p>';
    $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>';
812 813
    $task = 'done';
  }
814

815 816
  // The end of the install process. Remember profile used.
  if ($task == 'done') {
817 818
    // Rebuild menu and registry to get content type links registered by the
    // profile, and possibly any other menu items created through the tasks.
819
    menu_rebuild();
820 821 822 823

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

824 825 826 827
    // Randomize query-strings on css/js files, to hide the fact that
    // this is a new install, not upgraded yet.
    _drupal_flush_css_js();

828
    variable_set('install_profile', $profile);
829
  }
830 831 832 833 834

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

835 836 837 838 839
  // 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);
  }
840 841
}

842 843 844 845 846 847 848 849 850 851 852
/**
 * 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;
853
  $context['message'] = 'Installed ' . $module_name . ' module.';
854 855 856 857 858 859 860 861 862 863 864
}

/**
 * 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');
}

865 866
/**
 * Finished callback for the first locale import batch.
867
 *
868 869 870 871 872 873 874 875
 * 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.
876
 *
877 878 879 880 881 882
 * Advance installer task to the finished screen.
 */
function _install_locale_remaining_batch_finished($success, $results) {
  variable_set('install_task', 'finished');
}

883 884 885 886
/**
 * The list of reserved tasks to run in the installer.
 */
function install_reserved_tasks() {
887
  return array('configure', 'profile-install', 'profile-install-batch', 'locale-initial-import', 'locale-initial-batch', 'profile-finished', 'locale-remaining-batch', 'finished', 'done');
888 889
}

890
/**
891
 * Check installation requirements and report any errors.
892
 */
893
function install_check_requirements($profile, $verify) {
894

895
  // If Drupal is not set up already, we need to create a settings file.
896 897
  if (!$verify) {
    $writable = FALSE;
898 899
    $conf_path = './' . conf_path(FALSE, TRUE);
    $settings_file = $conf_path . '/settings.php';
900
    $file = $conf_path;
901
    $exists = FALSE;
902 903
    // Verify that the directory exists.
    if (drupal_verify_install_file($conf_path, FILE_EXIST, 'dir')) {
904 905
      // Check to make sure a settings.php already exists.
      $file = $settings_file;
906
      if (drupal_verify_install_file($settings_file, FILE_EXIST)) {
907
        $exists = TRUE;
908 909
        // If it does, make sure it is writable.
        $writable = drupal_verify_install_file($settings_file, FILE_READABLE|FILE_WRITABLE);
910
        $exists = TRUE;
911 912
      }
    }
913 914 915 916 917 918 919 920 921
    if (!$exists) {
      drupal_set_message(st('The @drupal installer requires that you create a settings file as part of the installation process.
<ol>
<li>Copy the %default_file file to %file.</li>
<li>Change file permissions so that it is writable by the web server. If you are unsure how to grant file permissions, please consult the <a href="@handbook_url">on-line handbook</a>.</li>
</ol>
More details about installing Drupal are available in INSTALL.txt.', array('@drupal' => drupal_install_profile_name(), '%file' => $file, '%default_file' => $conf_path .'/default.settings.php', '@handbook_url' => 'http://drupal.org/server-permissions')), 'error');
    }
    elseif (!$writable) {
922
      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">online handbook</a>.', array('@drupal' => drupal_install_profile_name(), '%file' => $file, '@handbook_url' => 'http://drupal.org/server-permissions')), 'error');
923
    }