install.php 39.2 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
<?php
// $Id$

require_once './includes/install.inc';

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

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

24
  require_once './modules/system/system.install';
25
  require_once './includes/file.inc';
26

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

30 31 32 33
  // Check existing settings.php.
  $verify = install_verify_settings();

  if ($verify) {
34 35 36 37 38 39
    // 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';

40 41 42
    // Establish a connection to the database.
    require_once './includes/database.inc';
    db_set_active();
43

44
    // Check if Drupal is installed.
45 46
    $task = install_verify_drupal();
    if ($task == 'done') {
47 48 49
      install_already_done_error();
    }
  }
50
  else {
51 52 53 54 55 56 57
    // 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';

58 59
    $task = NULL;
  }
60 61 62 63 64 65 66 67 68 69 70 71 72 73

  // 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()) {
74
    install_goto("install.php?profile=$profile");
75 76
  }
  else {
77
    install_no_profile_error();
78
  }
drumm's avatar
drumm committed
79

80 81 82
  // Load the profile.
  require_once "./profiles/$profile/$profile.profile";

drumm's avatar
drumm committed
83 84 85 86 87 88 89 90
  // 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");
  }

91 92 93
  // Tasks come after the database is set up
  if (!$task) {
    // Check the installation requirements for Drupal and this profile.
94
    install_check_requirements($profile, $verify);
95

96 97
    // Verify existence of all required modules.
    $modules = drupal_verify_profile($profile, $install_locale);
98 99 100 101 102 103 104 105 106

    // 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;
107
    }
108

109 110 111 112 113
    // 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);
    }
114

115 116
    // Perform actual installation defined in the profile.
    drupal_install_profile($profile, $modules);
117

118
    // Warn about settings.php permissions risk
119 120 121
    $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')) {
122
      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');
123 124
    }
    else {
125
      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)));
126
    }
127
  }
128

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

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

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

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

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

163 164
    $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);
165 166 167 168 169 170 171 172 173 174
    if (!form_get_errors()) {
      return TRUE;
    }
  }
  return FALSE;
}

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

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

  // We always need this because we want to run form_get_errors.
  include_once './includes/form.inc';
189
  drupal_maintenance_theme();
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

    drupal_maintenance_theme();
443
    install_task_list('profile-select');
444

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

451
function install_select_profile_form(&$form_state, $profiles) {
452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
  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
472 473 474 475 476 477
    '#value' => st('Save configuration'),
  );
  return $form;
}

/**
478 479 480
 * Find all .po files for the current profile.
 */
function install_find_locales($profilename) {
481
  $locales = file_scan_directory('./profiles/'. $profilename .'/translations', '\.po$', array('.', '..', 'CVS'), 0, FALSE);
482 483 484 485 486 487
  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
488 489 490 491 492 493 494 495
 *
 * @return
 *   The selected language.
 */
function install_select_locale($profilename) {
  include_once './includes/file.inc';
  include_once './includes/form.inc';

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

499 500 501 502 503 504 505
  // 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();
506 507 508
      install_task_list('locale-select');
      drupal_set_title(st('Choose language'));
      if (!empty($_GET['localize'])) {
509
        $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>';
510 511 512
        $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>';
        $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>';
513 514 515
        $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>';
516 517
      }
      else {
518
        $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>';
519
      }
520 521 522 523 524
      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
525
    return FALSE;
526 527
  }
  else {
drumm's avatar
drumm committed
528 529 530 531 532 533 534
    foreach ($locales as $locale) {
      if ($_POST['locale'] == $locale->name) {
        return $locale->name;
      }
    }

    drupal_maintenance_theme();
535
    install_task_list('locale-select');
drumm's avatar
drumm committed
536

537
    drupal_set_title(st('Choose language'));
drumm's avatar
drumm committed
538 539 540 541 542
    print theme('install_page', drupal_get_form('install_select_locale_form', $locales));
    exit;
  }
}

543
function install_select_locale_form(&$form_state, $locales) {
drumm's avatar
drumm committed
544
  include_once './includes/locale.inc';
545
  $languages = _locale_get_predefined_list();
drumm's avatar
drumm committed
546 547 548 549
  foreach ($locales as $locale) {
    // Try to use verbose locale name
    $name = $locale->name;
    if (isset($languages[$name])) {
550
      $name = $languages[$name][0] . (isset($languages[$name][1]) ? ' '. st('(@language)', array('@language' => $languages[$name][1])) : '');
drumm's avatar
drumm committed
551 552 553 554 555
    }
    $form['locale'][$locale->name] = array(
      '#type' => 'radio',
      '#return_value' => $locale->name,
      '#default_value' => ($locale->name == 'en' ? TRUE : FALSE),
556
      '#title' => $name . ($locale->name == 'en' ? ' '. st('(built-in)') : ''),
drumm's avatar
drumm committed
557 558 559 560 561
      '#parents' => array('locale')
    );
  }
  $form['submit'] =  array(
    '#type' => 'submit',
562
    '#value' => st('Select language'),
563 564 565 566
  );
  return $form;
}

567 568 569 570 571
/**
 * Show an error page when there are no profiles available.
 */
function install_no_profile_error() {
  drupal_maintenance_theme();
572
  install_task_list('profile-select');
drumm's avatar
drumm committed
573
  drupal_set_title(st('No profiles available'));
574
  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>');
575 576 577 578 579 580 581 582
  exit;
}


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

585
  drupal_maintenance_theme();
drumm's avatar
drumm committed
586
  drupal_set_title(st('Drupal already installed'));
587
  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)));
588 589 590 591
  exit;
}

/**
592
 * Tasks performed after the database is initialized. Called from install.php.
593
 */
594
function install_tasks($profile, $task) {
595
  global $base_url, $install_locale;
596 597

  // Bootstrap newly installed Drupal, while preserving existing messages.
598
  $messages = isset($_SESSION['messages']) ? $_SESSION['messages'] : '';
599 600 601
  drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL);
  $_SESSION['messages'] = $messages;

602
  // Build a page for a final task.
603
  drupal_maintenance_theme();
604 605 606
  if (empty($task)) {
    variable_set('install_task', 'configure');
    $task = 'configure';
607 608
  }

609 610 611
  // We are using a list of if constructs here to allow for
  // passing from one task to the other in the same request.

612 613 614 615 616
  if ($task == 'configure') {
    drupal_set_title(st('Configure site'));

    // We break the form up so we can tell when it's been successfully
    // submitted.
617 618 619

    $form_state = array('storage' => NULL, 'submitted' => FALSE);

620
    $form = drupal_retrieve_form('install_configure_form', $form_state);
621 622 623
    $form_build_id = md5(mt_rand());
    $form['#build_id'] = $form_build_id;
    drupal_prepare_form('install_configure_form', $form, $form_state);
624

625
    // Is the form submitted?
626
    if (!empty($_POST) && $_POST['form_id'] == 'install_configure_form') {
627 628
      $form['#post'] = $_POST;
    }
629 630 631
    else {
      $form['#post'] = array();
    }
632

633 634
    drupal_process_form('install_configure_form', $form, $form_state);
    if (empty($form_state['redirect'])) {
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649
      // Add JavaScript validation for form.
      _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');

650 651
      // Build menu to allow clean URL check.
      menu_rebuild();
652
      $output = drupal_render_form('install_configure_form', $form);
653 654 655
    }
    else {
      $task = 'profile';
656
    }
657
  }
658

659 660 661 662 663
  // If found an unknown task or the 'profile-custom' task, which is
  // 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';
664
    if (function_exists($function)) {
665
      // The profile needs to run more code, maybe even more tasks.
666 667 668 669
      // $task is sent through as a reference and may be changed!
      $output = $function($task);
    }

670 671 672 673 674
    // If the profile doesn't move on to a new task we assume
    // that it is done: we let the installer regain control and
    // proceed with the locale import.
    if ($task == 'profile') {
      $task = 'locale-import';
675
    }
676
  }
677

678 679 680 681 682 683 684 685
  // Import interface translations for the enabled modules, after
  // any changes made by the profile through the profile forms.
  if ($task == 'locale-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.
686
      $batch = locale_batch_by_language($install_locale);
687 688 689 690 691 692 693 694
      if (!empty($batch)) {
        // Start a batch, switch to 'locale-batch' task. We need to
        // set the variable here, because batch_process() redirects.
        variable_set('install_task', 'locale-batch');
        batch_set($batch);
        $path = $base_url .'/install.php?locale='. $install_locale .'&profile='. $profile;
        batch_process($path, $path);
      }
695
    }
696
    // Found nothing to import or not foreign language, go to next task.
697
    $task = 'finished';
698
  }
699

700 701 702 703 704 705 706
  // 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 'finished'.
  if ($task == 'locale-batch') {
    include_once 'includes/batch.inc';
    include_once 'includes/locale.inc';
707
    $output = _batch_page();
708
  }
709

710 711 712 713 714 715 716 717
  // 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';
  }
718

719 720 721 722 723
  // 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();
724 725 726 727

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

728
    variable_set('install_profile', $profile);
729
  }
730 731 732 733 734

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

735 736 737 738 739
  // 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);
  }
740 741
}

742 743 744 745 746 747 748
/**
 * The list of reserved tasks to run in the installer.
 */
function install_reserved_tasks() {
  return array('configure', 'locale-import', 'locale-batch', 'finished', 'done');
}

749
/**
750
 * Check installation requirements and report any errors.
751
 */
752
function install_check_requirements($profile, $verify) {
753 754 755 756 757 758 759 760
  $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) {
761 762 763 764 765
        $message = $requirement['description'];
        if ($requirement['value']) {
          $message .= ' ('. st('Currently using !item !version', array('!item' => $requirement['title'], '!version' => $requirement['value'])) .')';
        }
        drupal_set_message($message, 'error');
766 767
      }
    }
768
  }
769

770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792
  // 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');
    }
793 794 795
  }
}

796 797 798 799 800 801
/**
 * Add the installation task list to the current page.
 */
function install_task_list($active = NULL) {
  // Default list of tasks.
  $tasks = array(
802 803 804 805 806
    'profile-select' => st('Choose profile'),
    'locale-select'  => st('Choose language'),
    'requirements'   => st('Verify requirements'),
    'database'       => st('Setup database'),
    'configure'      => st('Configure site'),
807
  );
Dries's avatar
Dries committed
808

809 810
  $profiles = install_find_profiles();
  $profile = isset($_GET['profile']) && isset($profiles[$_GET['profile']]) ? $_GET['profile'] : '.';
811 812
  $locales = install_find_locales($profile);

813 814 815 816 817
  // Remove select profile if we have only one.
  if (count($profiles) == 1) {
    unset($tasks['profile-select']);
  }

818
  // Add tasks defined by the profile.
819 820 821 822 823 824 825 826 827 828
  if ($profile) {
    $function = $profile .'_profile_task_list';
    if (function_exists($function)) {
      $result = $function();
      if (is_array($result)) {
        $tasks += $result;
      }
    }
  }

829 830 831 832 833 834 835
  // If necessary, add translation import to the task list.
  if (count($locales) > 1 && !empty($_GET['locale']) && $_GET['locale'] != 'en') {
    $tasks += array(
      'locale-batch' => st('Import translations'),
    );
  }

836
  // Add finished step as the last task.
837 838 839 840
  $tasks += array(
    'finished'     => st('Finished')
  );

841 842 843 844 845
  // 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;
  }
846 847 848
  drupal_set_content('left', theme_task_list($tasks, $active));
}

849 850 851 852 853
function install_configure_form() {
  // This is necessary to add the task to the $_GET args so the install
  // system will know that it is done and we've taken over.

  $form['intro'] = array(
854
    '#value' => st('To configure your website, please provide the following information.'),
855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 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 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918
    '#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'),
    '#default_value' => variable_get('site_name', 'Drupal'),
    '#required' => TRUE,
    '#weight' => -20,
  );
  $form['site_information']['site_mail'] = array(
    '#type' => 'textfield',
    '#title' => st('Site e-mail address'),
    '#default_value' => variable_get('site_mail', ini_get('sendmail_from')),
    '#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.'),
    '#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'),
    '#default_value' => variable_get('date_default_timezone', 0),
919
    '#options' => _system_zonelist(),
920 921 922 923 924 925 926 927
    '#description' => st('By default, dates in this site will be displayed in the chosen time zone.'),
    '#weight' => 5,
  );

  $form['server_settings']['clean_url'] = array(
    '#type' => 'radios',
    '#title' => st('Clean URLs'),
    '#default_value' => variable_get('clean_url', 0),
928
    '#options' => array(0 => st('Disabled'), 1 => st('Enabled')),
929 930 931 932 933 934 935
    '#description' => st('This option makes Drupal emit "clean" URLs (i.e. without <code>?q=</code> in the URL).'),
    '#disabled' => TRUE,
    '#prefix' => '<div id="clean-url" class="install">',
    '#suffix' => '</div>',
    '#weight' => 10,
  );

936 937 938 939 940 941 942 943 944
  $form['server_settings']['update_status_module'] = array(
    '#type' => 'checkboxes',
    '#title' => st('Update notifications'),
    '#options' => array(1 => st('Check for updates automatically')),
    '#default_value' => array(1),
    '#description' => st('Drupal can check periodically for important bug fixes and security releases. To do this, your site will send anonymous information on its installed components to drupal.org. It is <strong>highly recommended</strong> that you enable this option for your site\'s security. For more information please read the <a href="@update">update notification information</a>.', array('@update' => 'http://drupal.org/handbook/modules/update')),
    '#weight' => 15,
  );

945 946
  $form['submit'] = array(
    '#type' => 'submit',
947
    '#value' => st('Save'),
948 949
    '#weight' => 15,
  );
950 951
  $form['#redirect'] = FALSE;

952 953
  $hook_form_alter = $_GET['profile'] .'_form_alter';
  if (function_exists($hook_form_alter)) {
954
    $hook_form_alter($form, 'install_configure');
955 956 957 958
  }
  return $form;
}

959 960
function install_configure_form_validate($form, &$form_state) {
  if ($error = user_validate_name($form_state['values']['account']['name'])) {
961 962
    form_error($form['admin_account']['account']['name'], $error);
  }
963
  if ($error = user_validate_mail($form_state['values']['account']['mail'])) {
964 965
    form_error($form['admin_account']['account']['mail'], $error);
  }
966
  if ($error = user_validate_mail($form_state['values']['site_mail'])) {
967 968 969 970
    form_error($form['site_information']['site_mail'], $error);
  }
}

971
function install_configure_form_submit($form, &$form_state) {
972 973
  global $user;

974 975 976 977
  variable_set('site_name', $form_state['values']['site_name']);
  variable_set('site_mail', $form_state['values']['site_mail']);
  variable_set('date_default_timezone', $form_state['values']['date_default_timezone']);

978 979 980 981 982
  // Enable update.module if this option was selected.
  if ($form_state['values']['update_status_module'][1]) {
    drupal_install_modules(array('update'));
  }

983 984
  // Turn this off temporarily so that we can pass a password through.
  variable_set('user_email_verification', FALSE);
985 986
  $form_state['old_values'] = $form_state['values'];
  $form_state['values'] = $form_state['values']['account'];
987 988 989 990 991 992 993

  // We precreated user 1 with placeholder values. Let's save the real values.
  $account = user_load(1);
  $merge_data = array('init' => $form_state['values']['mail'], 'roles' => array(), 'status' => 1);
  user_save($account, array_merge($form_state['values'], $merge_data));
  // Log in the first user.
  user_authenticate($form_state['values']['name'], trim($form_state['values']['pass']));
994 995
  $form_state['values'] = $form_state['old_values'];
  unset($form_state['old_values']);
996
  variable_set('user_email_verification', TRUE);
997 998 999

  if (isset($form_state['values']['clean_url'])) {
    variable_set('clean_url', $form_state['values']['clean_url']);
1000
  }
1001 1002 1003
  // The user is now logged in, but has no session ID yet, which
  // would be required later in the request, so remember it.
  $user->sid = session_id();
1004

1005
  $form_state['redirect'] = 'finished';
1006 1007
}

1008
install_main();