install.php 41.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
  // Check existing settings.php.
  $verify = install_verify_settings();

  if ($verify) {
39 40 41 42 43 44
    // 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';

45 46 47
    // Establish a connection to the database.
    require_once './includes/database.inc';
    db_set_active();
48

49
    // Check if Drupal is installed.
50 51
    $task = install_verify_drupal();
    if ($task == 'done') {
52 53 54
      install_already_done_error();
    }
  }
55
  else {
56 57 58 59 60 61 62
    // 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';

63 64
    $task = NULL;
  }
65 66 67 68 69 70 71 72 73 74 75 76 77 78

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

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

85 86 87
  // Load the profile.
  require_once "./profiles/$profile/$profile.profile";

drumm's avatar
drumm committed
88 89 90 91 92 93 94 95
  // 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");
  }

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

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

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

114 115 116 117 118
    // 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);
    }
119

120 121
    // Perform actual installation defined in the profile.
    drupal_install_profile($profile, $modules);
122

123
    // Warn about settings.php permissions risk
124 125 126
    $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')) {
127
      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');
128 129
    }
    else {
130
      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)));
131
    }
132
  }
133

134 135
  // The database is set up, turn to further tasks.
  install_tasks($profile, $task);
136 137 138 139 140 141
}

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

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

  // Verify existing settings (if any).
156
  if (!empty($db_url)) {
157 158 159
    // We need this because we want to run form_get_errors.
    include_once './includes/form.inc';

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

168 169
    $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);
170 171 172 173 174 175 176 177 178 179
    if (!form_get_errors()) {
      return TRUE;
    }
  }
  return FALSE;
}

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

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

  // We always need this because we want to run form_get_errors.
  include_once './includes/form.inc';
194
  drupal_maintenance_theme();
195
  install_task_list('database');
196

197 198 199 200 201 202 203 204
  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();
  }

205
  $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
206
  drupal_set_title(st('Database configuration'));
207 208 209
  print theme('install_page', $output);
  exit;
}
210

211

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

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

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

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

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

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

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

309 310 311 312 313 314 315 316 317 318
    // 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.'),
    );

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

    $form['save'] = array(
      '#type' => 'submit',
drumm's avatar
drumm committed
332
      '#value' => st('Save configuration'),
333 334 335 336 337
    );

    $form['errors'] = array();
    $form['settings_file'] = array('#type' => 'value', '#value' => $settings_file);
    $form['_db_url'] = array('#type' => 'value');
338
    $form['#action'] = "install.php?profile=$profile". ($install_locale ? "&locale=$install_locale" : '');
339
    $form['#redirect'] = FALSE;
340
  }
341
  return $form;
342
}
343

344 345 346
/**
 * Form API validate for install_settings form.
 */
347
function install_settings_form_validate($form, &$form_state) {
348
  global $db_url;
349
  _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);
350 351 352 353 354
}

/**
 * Helper function for install_settings_validate.
 */
355
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) {
356 357
  global $db_url;

358
  // Verify the table prefix
359
  if (!empty($db_prefix) && is_string($db_prefix) && !preg_match('/^[A-Za-z0-9_.]+$/', $db_prefix)) {
360
    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');
361 362
  }

363 364 365 366
  if (!empty($db_port) && !is_numeric($db_port)) {
    form_set_error('db_port', st('Database port must be a number.'));
  }

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

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

/**
 * Form API submit for install_settings form.
 */
399
function install_settings_form_submit($form, &$form_state) {
drumm's avatar
drumm committed
400
  global $profile, $install_locale;
401 402 403

  // Update global settings array and save
  $settings['db_url'] = array(
404
    'value'    => $form_state['values']['_db_url'],
405 406 407
    'required' => TRUE,
  );
  $settings['db_prefix'] = array(
408
    'value'    => $form_state['values']['db_prefix'],
409 410 411 412 413
    'required' => TRUE,
  );
  drupal_rewrite_settings($settings);

  // Continue to install profile step
414
  install_goto("install.php?profile=$profile". ($install_locale ? "&locale=$install_locale" : ''));
415 416 417
}

/**
418 419 420
 * Find all .profile files.
 */
function install_find_profiles() {
Dries's avatar
Dries committed
421
  return file_scan_directory('./profiles', '\.profile$', array('.', '..', 'CVS'), 0, TRUE, 'name', 0);
422 423 424 425
}

/**
 * Allow admin to select which profile to install.
426 427 428 429 430 431 432
 *
 * @return
 *   The selected profile.
 */
function install_select_profile() {
  include_once './includes/form.inc';

433
  $profiles = install_find_profiles();
434 435 436 437 438 439 440 441
  // 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) {
442
      if ($_POST['profile'] == $profile->name) {
443 444 445
        return $profile->name;
      }
    }
446 447

    drupal_maintenance_theme();
448
    install_task_list('profile-select');
449

drumm's avatar
drumm committed
450
    drupal_set_title(st('Select an installation profile'));
451
    print theme('install_page', drupal_get_form('install_select_profile_form', $profiles));
452 453 454 455
    exit;
  }
}

456 457 458
/**
 * Form API array definition for the profile selection form.
 */
459
function install_select_profile_form(&$form_state, $profiles) {
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479
  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
480 481 482 483 484 485
    '#value' => st('Save configuration'),
  );
  return $form;
}

/**
486 487 488
 * Find all .po files for the current profile.
 */
function install_find_locales($profilename) {
489
  $locales = file_scan_directory('./profiles/'. $profilename .'/translations', '\.po$', array('.', '..', 'CVS'), 0, FALSE);
490 491 492 493 494 495
  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
496 497 498 499 500 501 502 503
 *
 * @return
 *   The selected language.
 */
function install_select_locale($profilename) {
  include_once './includes/file.inc';
  include_once './includes/form.inc';

504 505
  // Find all available locales.
  $locales = install_find_locales($profilename);
drumm's avatar
drumm committed
506

507 508 509 510 511 512 513
  // 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') {
      drupal_maintenance_theme();
514 515 516
      install_task_list('locale-select');
      drupal_set_title(st('Choose language'));
      if (!empty($_GET['localize'])) {
517
        $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>';
518
        $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>';
519 520
        $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>';
521 522 523
        $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>';
524 525
      }
      else {
526
        $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>';
527
      }
528 529 530 531 532
      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
533
    return FALSE;
534 535
  }
  else {
536 537 538 539 540 541 542 543 544 545 546 547 548
    // 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
549 550 551 552 553 554 555
    foreach ($locales as $locale) {
      if ($_POST['locale'] == $locale->name) {
        return $locale->name;
      }
    }

    drupal_maintenance_theme();
556
    install_task_list('locale-select');
drumm's avatar
drumm committed
557

558
    drupal_set_title(st('Choose language'));
drumm's avatar
drumm committed
559 560 561 562 563
    print theme('install_page', drupal_get_form('install_select_locale_form', $locales));
    exit;
  }
}

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

591 592 593 594 595
/**
 * Show an error page when there are no profiles available.
 */
function install_no_profile_error() {
  drupal_maintenance_theme();
596
  install_task_list('profile-select');
drumm's avatar
drumm committed
597
  drupal_set_title(st('No profiles available'));
598
  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>');
599 600 601 602 603 604 605 606
  exit;
}


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

609
  drupal_maintenance_theme();
drumm's avatar
drumm committed
610
  drupal_set_title(st('Drupal already installed'));
611
  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)));
612 613 614 615
  exit;
}

/**
616
 * Tasks performed after the database is initialized.
617
 */
618
function install_tasks($profile, $task) {
619
  global $base_url, $install_locale;
620 621

  // Bootstrap newly installed Drupal, while preserving existing messages.
622
  $messages = isset($_SESSION['messages']) ? $_SESSION['messages'] : '';
623 624 625
  drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL);
  $_SESSION['messages'] = $messages;

626 627 628 629
  // URL used to direct page requests.
  $url = $base_url .'/install.php?locale='. $install_locale .'&profile='. $profile;

  // Build a page for final tasks.
630
  drupal_maintenance_theme();
631
  if (empty($task)) {
632 633
    variable_set('install_task', 'locale-initial-import');
    $task = 'locale-initial-import';
634 635
  }

636 637 638
  // We are using a list of if constructs here to allow for
  // passing from one task to the other in the same request.

639 640 641 642 643 644 645 646 647 648
  // 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.
649
        variable_set('install_locale_batch_components', $batch['#components']);
650 651 652 653 654 655 656 657 658 659
        // 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';
  }
660

661 662 663 664 665 666 667 668 669
  // We are running a batch import of interface translation files.
  // 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 'configure'.
  if ($task == 'locale-initial-batch') {
    include_once 'includes/batch.inc';
    include_once 'includes/locale.inc';
    $output = _batch_page();
  }
670

671 672 673 674 675 676
  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();
677
    }
678 679 680 681 682 683
    $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'));
684

685
      // Add JavaScript validation.
686 687 688 689 690 691 692 693 694 695 696 697 698
      _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');
699 700
      // Build menu to allow clean URL check.
      menu_rebuild();
701
    }
702

703 704
    else {
      $task = 'profile';
705
    }
706
  }
707

708
  // If found an unknown task or the 'profile' task, which is
709 710 711 712
  // 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';
713
    if (function_exists($function)) {
714
      // The profile needs to run more code, maybe even more tasks.
715
      // $task is sent through as a reference and may be changed!
716
      $output = $function($task, $url);
717 718
    }

719
    // If the profile doesn't move on to a new task we assume
720
    // that it is done.
721
    if ($task == 'profile') {
722
      $task = 'profile-finished';
723
    }
724
  }
725

726 727 728
  // Profile custom tasks are done, so let the installer regain
  // control and proceed with importing the remaining translations.
  if ($task == 'profile-finished') {
729 730
    if (!empty($install_locale) && ($install_locale != 'en')) {
      include_once 'includes/locale.inc';
731 732 733 734 735
      // 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');
736
      if (!empty($batch)) {
737
        // Start a batch, switch to 'locale-remaining-batch' task. We need to
738
        // set the variable here, because batch_process() redirects.
739
        variable_set('install_task', 'locale-remaining-batch');
740
        batch_set($batch);
741
        batch_process($url, $url);
742
      }
743
    }
744
    // Found nothing to import or not foreign language, go to next task.
745
    $task = 'finished';
746
  }
747
  if ($task == 'locale-remaining-batch') {
748 749
    include_once 'includes/batch.inc';
    include_once 'includes/locale.inc';
750
    $output = _batch_page();
751
  }
752

753 754 755 756 757 758 759 760
  // Display a 'finished' page to user.
  if ($task == 'finished') {
    drupal_set_title(st('@drupal installation complete', array('@drupal' => drupal_install_profile_name())));
    $output = '<p>'. st('Congratulations, @drupal has been successfully installed.', array('@drupal' => drupal_install_profile_name())) .'</p>';
    $messages = drupal_set_message();
    $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';
  }
761

762 763 764 765 766
  // 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();
767 768 769 770

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

771
    variable_set('install_profile', $profile);
772
  }
773 774 775 776 777

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

778 779 780 781 782
  // 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);
  }
783 784
}

785 786
/**
 * Finished callback for the first locale import batch.
787
 *
788 789 790 791 792 793 794 795
 * 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.
796
 *
797 798 799 800 801 802
 * Advance installer task to the finished screen.
 */
function _install_locale_remaining_batch_finished($success, $results) {
  variable_set('install_task', 'finished');
}

803 804 805 806
/**
 * The list of reserved tasks to run in the installer.
 */
function install_reserved_tasks() {
807
  return array('configure', 'locale-initial-import', 'locale-initial-batch', 'profile-finished', 'locale-remaining-batch', 'finished', 'done');
808 809
}

810
/**
811
 * Check installation requirements and report any errors.
812
 */
813
function install_check_requirements($profile, $verify) {
814 815 816 817 818 819 820 821
  $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) {
822 823 824 825 826
        $message = $requirement['description'];
        if ($requirement['value']) {
          $message .= ' ('. st('Currently using !item !version', array('!item' => $requirement['title'], '!version' => $requirement['value'])) .')';
        }
        drupal_set_message($message, 'error');
827 828
      }
    }
829
  }
830

831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853
  // 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');
    }
854 855 856
  }
}

857 858 859 860 861 862
/**
 * Add the installation task list to the current page.
 */
function install_task_list($active = NULL) {
  // Default list of tasks.
  $tasks = array(
863 864 865
    'profile-select'       => st('Choose profile'),
    'locale-select'        => st('Choose language'),
    'requirements'         => st('Verify requirements'),
866 867
    'database'             => st('Set up database'),
    'locale-initial-batch' => st('Set up translations'),
868
    'configure'            => st('Configure site'),
869
  );
Dries's avatar
Dries committed
870

871 872
  $profiles = install_find_profiles();
  $profile = isset($_GET['profile']) && isset($profiles[$_GET['profile']]) ? $_GET['profile'] : '.';
873 874
  $locales = install_find_locales($profile);

875 876 877 878 879
  // Remove select profile if we have only one.
  if (count($profiles) == 1) {
    unset($tasks['profile-select']);
  }

880
  // Add tasks defined by the profile.
881 882 883 884 885 886 887 888 889 890
  if ($profile) {
    $function = $profile .'_profile_task_list';
    if (function_exists($function)) {
      $result = $function();
      if (is_array($result)) {
        $tasks += $result;
      }
    }
  }

891 892 893 894 895 896 897
  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'));
898 899
  }

900
  // Add finished step as the last task.
901 902 903 904
  $tasks += array(
    'finished'     => st('Finished')
  );

905 906 907 908 909
  // 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;
  }
910 911 912
  drupal_set_content('left', theme_task_list($tasks, $active));
}

913 914 915 916
/**
 * Form API array definition for site configuration.
 */
function install_configure_form(&$form_state, $url) {
917 918

  $form['intro'] = array(
919
    '#value' => st('To configure your website, please provide the following information.'),
920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935
    '#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'),
936
    '#default_value' => ini_get('sendmail_from'),
937
    '#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.'),
938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981
    '#required' => TRUE,
    '#weight' => -15,
  );
  $form['admin_account'] = array(
    '#type' => 'fieldset',
    '#title' => st('Administrator account'),
    '#collapsible' => FALSE,
  );
  $form['admin_account']['account']['#tree'] = TRUE;
  $form['admin_account']['markup'] = array(
    '#value' => '<p class="description">'. st('The administrator account has complete access to the site; it will automatically be granted all permissions and can perform any administrative activity. This will be the only account that can perform certain activities, so keep its credentials safe.') .'</p>',
    '#weight' => -10,
  );

  $form['admin_account']['account']['name'] = array('#type' => 'textfield',
    '#title' => st('Username'),
    '#maxlength' => USERNAME_MAX_LENGTH,
    '#description' => st('Spaces are allowed; punctuation is not allowed except for periods, hyphens, and underscores.'),
    '#required' => TRUE,
    '#weight' => -10,
  );

  $form['admin_account']['account']['mail'] = array('#type' => 'textfield',
    '#title' => st('E-mail address'),
    '#maxlength' => EMAIL_MAX_LENGTH,
    '#description' => st('All e-mails from the system will be sent to this address. The e-mail address is not made public and will only be used if you wish to receive a new password or wish to receive certain news or notifications by e-mail.'),
    '#required' => TRUE,
    '#weight' => -5,
  );
  $form['admin_account']['account']['pass'] = array(
    '#type' => 'password_confirm',
    '#required' => TRUE,
    '#size' => 25,
    '#weight' => 0,
  );

  $form['server_settings'] = array(
    '#type' => 'fieldset',
    '#title' => st('Server settings'),
    '#collapsible' => FALSE,
  );
  $form['server_settings']['date_default_timezone'] = array(
    '#type' => 'select',
    '#title' => st('Default time zone'),
982
    '#default_value' => 0,
Gábor Hojtsy's avatar