install.php 36.4 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
<?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() {
18 19
  global $profile, $install_locale, $conf;
  require_once './includes/cache-install.inc';
20 21
  require_once './includes/bootstrap.inc';
  drupal_bootstrap(DRUPAL_BOOTSTRAP_CONFIGURATION);
22 23 24 25 26 27 28

  // Because no persistent storage is available yet, functions
  // that check for cached data will fail. During the installation
  // process, we temporarily replace the normal cache system with
  // a stubbed-out version that short-circuits the actual caching
  // process and avoids any errors.
  $conf['cache_inc'] = './includes/cache-install.inc';
29
  require_once './modules/system/system.install';
30
  require_once './includes/file.inc';
31

32 33 34
  // Ensure correct page headers are sent (e.g. caching)
  drupal_page_header();

35 36 37 38 39 40 41 42
  // Check existing settings.php.
  $verify = install_verify_settings();

  if ($verify) {
    // Establish a connection to the database.
    require_once './includes/database.inc';
    db_set_active();
    // Check if Drupal is installed.
43 44
    $task = install_verify_drupal();
    if ($task == 'done') {
45 46 47
      install_already_done_error();
    }
  }
48 49 50
  else {
    $task = NULL;
  }
51 52 53 54 55 56 57 58 59 60 61 62 63 64

  // 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()) {
65
    install_goto("install.php?profile=$profile");
66 67
  }
  else {
68
    install_no_profile_error();
69
  }
drumm's avatar
drumm committed
70

71 72 73
  // Load the profile.
  require_once "./profiles/$profile/$profile.profile";

drumm's avatar
drumm committed
74 75 76 77 78 79 80 81
  // 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");
  }

82 83 84 85
  // Tasks come after the database is set up
  if (!$task) {
    // Check the installation requirements for Drupal and this profile.
    install_check_requirements($profile);
86

87 88 89 90 91
    // Verify existence of all required modules.
    $modules = drupal_verify_profile($profile, $install_locale);
    if (!$modules) {
      install_missing_modules_error($profile);
    }
92

93 94 95 96 97
    // 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);
    }
98

99 100
    // Perform actual installation defined in the profile.
    drupal_install_profile($profile, $modules);
101

102 103 104 105 106 107 108 109
    // Warn about settings.php permissions risk
    $settings_file = './'. conf_path() .'/settings.php';
    if (!drupal_verify_install_file($settings_file, FILE_EXIST|FILE_READABLE|FILE_NOT_WRITABLE)) {
      drupal_set_message(st('All necessary changes to %file have been made, so you should now remove write permissions to this file. Failure to remove write permissions to this file is a security risk.', array('%file' => $settings_file)), 'error');
    }
    else {
      drupal_set_message(st('All necessary changes to %file have been made. It has been set to read-only for security.', array('%file' => $settings_file)));
    }
110
  }
111

112 113
  // The database is set up, turn to further tasks.
  install_tasks($profile, $task);
114 115 116 117 118 119
}

/**
 * Verify if Drupal is installed.
 */
function install_verify_drupal() {
120 121 122 123 124
  // Read the variable manually using the @ so we don't trigger an error if it fails.
  $result = @db_query("SELECT value FROM {variable} WHERE name = 'install_task'");
  if ($result) {
    return unserialize(db_result($result));
  }
125 126 127 128 129 130 131 132 133
}

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

  // Verify existing settings (if any).
134
  if (!empty($db_url)) {
135 136 137
    // We need this because we want to run form_get_errors.
    include_once './includes/form.inc';

138
    $url = parse_url(is_array($db_url) ? $db_url['default'] : $db_url);
139 140 141
    $db_user = urldecode($url['user']);
    $db_pass = urldecode($url['pass']);
    $db_host = urldecode($url['host']);
142
    $db_port = isset($url['port']) ? urldecode($url['port']) : '';
143 144 145
    $db_path = ltrim(urldecode($url['path']), '/');
    $settings_file = './'. conf_path() .'/settings.php';

146 147
    $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);
148 149 150 151 152 153 154 155 156 157
    if (!form_get_errors()) {
      return TRUE;
    }
  }
  return FALSE;
}

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

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

  // We always need this because we want to run form_get_errors.
  include_once './includes/form.inc';
172
  drupal_maintenance_theme();
173
  install_task_list('database');
174 175 176

  // The existing database settings are not working, so we need write access
  // to settings.php to change them.
177
  $writable = FALSE;
178 179 180 181 182
  $file = $conf_path;
  // Verify 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)) {
183 184
      // If it does, make sure it is writable
      $writable = drupal_verify_install_file($settings_file, FILE_READABLE|FILE_WRITABLE);
185 186 187 188
      $file = $settings_file;
    }
    else {
      // If not, makes sure the directory is.
189
      $writable = drupal_verify_install_file($conf_path, FILE_READABLE|FILE_WRITABLE, 'dir');
190 191 192
    }
  }

193
  if (!$writable) {
194
    drupal_set_message(st('The @drupal installer requires write permissions to %file during the installation process.', array('@drupal' => drupal_install_profile_name(), '%file' => $file)), 'error');
195

drumm's avatar
drumm committed
196
    drupal_set_title(st('Drupal database setup'));
197 198 199 200
    print theme('install_page', '');
    exit;
  }

201
  $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
202
  drupal_set_title(st('Database configuration'));
203 204 205
  print theme('install_page', $output);
  exit;
}
206

207

208 209 210
/**
 * Form API array definition for install_settings.
 */
211
function install_settings_form($profile, $install_locale, $settings_file, $db_url, $db_type, $db_prefix, $db_user, $db_pass, $db_host, $db_port, $db_path) {
212 213 214
  if (empty($db_host)) {
    $db_host = 'localhost';
  }
215 216 217
  $db_types = drupal_detect_database_types();
  if (count($db_types) == 0) {
    $form['no_db_types'] = array(
drumm's avatar
drumm committed
218
      '#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')),
219 220 221 222 223
    );
  }
  else {
    $form['basic_options'] = array(
      '#type' => 'fieldset',
drumm's avatar
drumm committed
224
      '#title' => st('Basic options'),
225
      '#description' => '<p>'. st('To set up your @drupal database, enter the following information.', array('@drupal' => drupal_install_profile_name())) .'</p>',
226 227 228 229
    );

    if (count($db_types) > 1) {
      // Database type
230
      $db_types = drupal_detect_database_types();
231 232
      $form['basic_options']['db_type'] = array(
        '#type' => 'radios',
drumm's avatar
drumm committed
233
        '#title' => st('Database type'),
234
        '#required' => TRUE,
235 236
        '#options' => $db_types,
        '#default_value' => ($db_type ? $db_type : current($db_types)),
237
        '#description' => st('The type of database your @drupal data will be stored in.', array('@drupal' => drupal_install_profile_name())),
238
      );
239
      $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()));
240 241 242
    }
    else {
      if (count($db_types) == 1) {
243
        $db_types = array_values($db_types);
244 245 246 247
        $form['basic_options']['db_type'] = array(
          '#type' => 'hidden',
          '#value' => $db_types[0],
        );
248
        $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()));
249 250 251 252 253 254
      }
    }

    // Database name
    $form['basic_options']['db_path'] = array(
      '#type' => 'textfield',
drumm's avatar
drumm committed
255
      '#title' => st('Database name'),
256 257 258 259 260 261 262 263 264 265
      '#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
266
      '#title' => st('Database username'),
267 268 269 270 271 272 273 274 275
      '#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
276
      '#title' => st('Database password'),
277 278 279 280 281 282 283
      '#default_value' => $db_pass,
      '#size' => 45,
      '#maxlength' => 45,
    );

    $form['advanced_options'] = array(
      '#type' => 'fieldset',
drumm's avatar
drumm committed
284
      '#title' => st('Advanced options'),
285 286
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
287
      '#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.")
288 289 290 291 292
    );

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

301 302 303 304 305 306 307 308 309 310
    // 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.'),
    );

311
    // Table prefix
312 313
    $form['advanced_options']['db_prefix'] = array(
      '#type' => 'textfield',
314
      '#title' => st('Table prefix'),
315 316 317
      '#default_value' => $db_prefix,
      '#size' => 45,
      '#maxlength' => 45,
318
      '#description' => st('If more than one @drupal website will be sharing this database, enter a table prefix for your @drupal site here.', array('@drupal' => drupal_install_profile_name())),
319 320 321 322
    );

    $form['save'] = array(
      '#type' => 'submit',
drumm's avatar
drumm committed
323
      '#value' => st('Save configuration'),
324 325 326 327 328
    );

    $form['errors'] = array();
    $form['settings_file'] = array('#type' => 'value', '#value' => $settings_file);
    $form['_db_url'] = array('#type' => 'value');
drumm's avatar
drumm committed
329
    $form['#action'] = "install.php?profile=$profile" . ($install_locale ? "&locale=$install_locale" : '');
330
    $form['#redirect'] = FALSE;
331
  }
332
  return $form;
333
}
334

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

/**
 * Helper function for install_settings_validate.
 */
346
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) {
347 348
  global $db_url;

349
  // Verify the table prefix
350 351
  if (!empty($db_prefix) && is_string($db_prefix) && !preg_match('/^[A-Za-z0-9_.]+$/', $db_prefix)) {
    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, underscores or dots.', array('%db_prefix' => $db_prefix)), 'error');
352 353
  }

354 355 356 357
  if (!empty($db_port) && !is_numeric($db_port)) {
    form_set_error('db_port', st('Database port must be a number.'));
  }

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

    $function = 'drupal_test_'. $db_type;
    if (!$function($db_url, $success)) {
      if (isset($success['CONNECT'])) {
        form_set_error('db_type', st('In order for Drupal to work and to proceed 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, ', '))));
      }
      else {
        form_set_error('db_type', '');
      }
    }
  }
}

/**
 * Form API submit for install_settings form.
 */
390
function install_settings_form_submit($form, &$form_state, $form_values) {
drumm's avatar
drumm committed
391
  global $profile, $install_locale;
392 393 394 395 396 397 398 399 400 401 402 403 404

  // Update global settings array and save
  $settings['db_url'] = array(
    'value'    => $form_values['_db_url'],
    'required' => TRUE,
  );
  $settings['db_prefix'] = array(
    'value'    => $form_values['db_prefix'],
    'required' => TRUE,
  );
  drupal_rewrite_settings($settings);

  // Continue to install profile step
drumm's avatar
drumm committed
405
  install_goto("install.php?profile=$profile" . ($install_locale ? "&locale=$install_locale" : ''));
406 407 408
}

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

/**
 * Allow admin to select which profile to install.
417 418 419 420 421 422 423
 *
 * @return
 *   The selected profile.
 */
function install_select_profile() {
  include_once './includes/form.inc';

424
  $profiles = install_find_profiles();
425 426 427 428 429 430 431 432
  // 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) {
433
      if ($_POST['profile'] == $profile->name) {
434 435 436
        return $profile->name;
      }
    }
437 438

    drupal_maintenance_theme();
439
    install_task_list('profile-select');
440

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

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

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

492 493
  // Find all available locales.
  $locales = install_find_locales($profilename);
drumm's avatar
drumm committed
494

495 496 497 498 499 500 501 502 503
  // 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();
      install_task_list('profile-select');
      drupal_set_title(st('Localization of the Drupal installer'));
504 505 506 507 508 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>';
      $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('Reload this page 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>';
      $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>';
510 511 512 513 514 515
      $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('Reload this page to select a language') .'</a></li></ul>';
      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
516
    return FALSE;
517 518
  }
  else {
drumm's avatar
drumm committed
519 520 521 522 523 524 525
    foreach ($locales as $locale) {
      if ($_POST['locale'] == $locale->name) {
        return $locale->name;
      }
    }

    drupal_maintenance_theme();
526
    install_task_list('locale-select');
drumm's avatar
drumm committed
527 528 529 530 531 532 533 534 535

    drupal_set_title(st('Choose your preferred language'));
    print theme('install_page', drupal_get_form('install_select_locale_form', $locales));
    exit;
  }
}

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

558 559 560 561 562
/**
 * Show an error page when there are no profiles available.
 */
function install_no_profile_error() {
  drupal_maintenance_theme();
563
  install_task_list('profile-select');
drumm's avatar
drumm committed
564
  drupal_set_title(st('No profiles available'));
565
  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>');
566 567 568 569 570 571 572 573
  exit;
}


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

576
  drupal_maintenance_theme();
drumm's avatar
drumm committed
577 578
  drupal_set_title(st('Drupal already installed'));
  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></ul>', array('@base-url' => $base_url)));
579 580 581
  exit;
}

582 583 584 585 586 587 588
/**
 * Show an error page when Drupal is missing required modules.
 */
function install_missing_modules_error($profile) {
  global $base_url;

  drupal_maintenance_theme();
589
  install_task_list('requirements');
590 591 592 593 594
  drupal_set_title(st('Modules missing'));
  print theme('install_page', '<p>'. st('One or more required modules are missing. Please check the error messages and <a href="!url">try again</a>.', array('!url' => "install.php?profile=$profile")) .'</p>');
  exit;
}

595
/**
596
 * Tasks performed after the database is initialized. Called from install.php.
597
 */
598
function install_tasks($profile, $task) {
599
  global $base_url, $install_locale;
600
  $output = '';
601 602

  // Bootstrap newly installed Drupal, while preserving existing messages.
603
  $messages = isset($_SESSION['messages']) ? $_SESSION['messages'] : '';
604 605 606
  drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL);
  $_SESSION['messages'] = $messages;

607
  // Build a page for a final task.
608
  drupal_maintenance_theme();
609 610 611
  if (empty($task)) {
    variable_set('install_task', 'configure');
    $task = 'configure';
612 613
  }

614 615 616
  // We are using a list of if constructs here to allow for
  // passing from one task to the other in the same request.

617 618 619 620 621
  if ($task == 'configure') {
    drupal_set_title(st('Configure site'));

    // We break the form up so we can tell when it's been successfully
    // submitted.
622 623 624

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

625
    $form = drupal_retrieve_form('install_configure_form');
626 627 628
    $form_build_id = md5(mt_rand());
    $form['#build_id'] = $form_build_id;
    drupal_prepare_form('install_configure_form', $form, $form_state);
629 630 631 632

    // In order to find out if the form was successfully submitted or not,
    // we do a little song and dance to set the form to 'programmed' and check
    // to make sure this is really the form being submitted. It'd better be.
633
    if (!empty($_POST) && $_POST['form_id'] == 'install_configure_form') {
634 635 636
      $form['#programmed'] = TRUE;
      $form['#post'] = $_POST;
    }
637 638 639
    else {
      $form['#post'] = array();
    }
640

641 642
    drupal_process_form('install_configure_form', $form, $form_state);
    if (empty($form_state['redirect'])) {
643 644
      // Build menu to allow clean URL check.
      menu_rebuild();
645
      $output = drupal_render_form('install_configure_form', $form);
646 647 648
    }
    else {
      $task = 'profile';
649
    }
650
  }
651

652 653 654 655 656
  // 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';
657
    if (function_exists($function)) {
658
      // The profile needs to run more code, maybe even more tasks.
659 660 661 662
      // $task is sent through as a reference and may be changed!
      $output = $function($task);
    }

663 664 665 666 667
    // 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';
668
    }
669
  }
670

671 672 673 674 675 676 677 678
  // 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.
679
      $batch = locale_batch_by_language($install_locale);
680 681 682 683 684 685 686 687
      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);
      }
688
    }
689 690 691
    // Found nothing to import or not foreign language, go to next task.
   $task = 'finished';
  }
692

693 694 695 696 697 698 699 700 701
  // 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';
    $output .= _batch_page();
  }
702

703 704 705 706 707 708 709 710
  // 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';
  }
711

712 713 714 715 716 717
  // 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();
    variable_set('install_profile', $profile);
718
  }
719 720 721 722 723

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

724 725 726 727
  // Output page.
  print theme('maintenance_page', $output);
}

728 729 730 731 732 733 734
/**
 * The list of reserved tasks to run in the installer.
 */
function install_reserved_tasks() {
  return array('configure', 'locale-import', 'locale-batch', 'finished', 'done');
}

735 736 737 738 739 740 741 742 743 744
/**
 * Page to check installation requirements and report any errors.
 */
function install_check_requirements($profile) {
  $requirements = drupal_check_profile($profile);
  $severity = drupal_requirements_severity($requirements);

  // If there are issues, report them.
  if ($severity == REQUIREMENT_ERROR) {
    drupal_maintenance_theme();
745
    install_task_list('requirements');
746 747 748 749 750 751 752

    foreach ($requirements as $requirement) {
      if (isset($requirement['severity']) && $requirement['severity'] == REQUIREMENT_ERROR) {
        drupal_set_message($requirement['description'] .' ('. st('Currently using !item !version', array('!item' => $requirement['title'], '!version' => $requirement['value'])) .')', 'error');
      }
    }

753
    drupal_set_title(st('Incompatible environment'));
754 755 756 757 758
    print theme('install_page', '');
    exit;
  }
}

759 760 761 762 763 764
/**
 * Add the installation task list to the current page.
 */
function install_task_list($active = NULL) {
  // Default list of tasks.
  $tasks = array(
765 766 767 768 769
    'profile-select' => st('Choose profile'),
    'locale-select'  => st('Choose language'),
    'requirements'   => st('Verify requirements'),
    'database'       => st('Setup database'),
    'configure'      => st('Configure site'),
770
  );
Dries's avatar
Dries committed
771

772 773
  $profiles = install_find_profiles();
  $profile = isset($_GET['profile']) && isset($profiles[$_GET['profile']]) ? $_GET['profile'] : '.';
774 775 776 777 778 779 780 781 782 783
  $locales = install_find_locales($profile);

  // Keep the profile selection task if we have more profiles or only the
  // default profile is available and with only the built-in language, in
  // which case we use this screen to present information about translations.
  if (count($profiles) == 1) {
    $first_profile = array_shift($profiles);
    if ($first_profile->name != 'default' || count($locales) > 1) {
      unset($tasks['profile-select']);
    }
784 785
  }

786
  // Add tasks defined by the profile.
787 788 789 790 791 792 793 794 795 796 797
  if ($profile) {
    $function = $profile .'_profile_task_list';
    if (function_exists($function)) {
      $result = $function();
      if (is_array($result)) {
        $tasks += $result;
      }
    }
  }

  // Add finished step as the last task.
798 799 800 801 802 803 804 805 806 807
  $tasks += array(
    'locale-batch' => st('Import translations'),
    'finished'     => st('Finished')
  );

  // Remove locale related tasks if the install profile does not use them.
  if (count($locales) == 1) {
    unset($tasks['locale-select']);
    unset($tasks['locale-batch']);
  }
808 809 810 811 812 813

  // 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;
  }
814 815 816
  drupal_set_content('left', theme_task_list($tasks, $active));
}

817 818 819 820 821 822 823 824 825 826 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 854 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 919 920 921 922 923
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(
    '#value' => st('To configure your web site, please provide the following information.'),
    '#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,
  );

  $zones = _system_zonelist();

  $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),
    '#options' => $zones,
    '#description' => st('By default, dates in this site will be displayed in the chosen time zone.'),
    '#weight' => 5,
  );

  drupal_add_js(drupal_get_path('module', 'system') .'/system.js', 'module');
  drupal_add_js(array('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.installDefaultTimezone();
  });
}', 'inline');

  $form['server_settings']['clean_url'] = array(
    '#type' => 'radios',
    '#title' => st('Clean URLs'),
    '#default_value' => variable_get('clean_url', 0),
    '#options' => array(st('Disabled'), st('Enabled')),
    '#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,
  );

  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => st('Submit'),
    '#weight' => 15,
  );
  $hook_form_alter = $_GET['profile'] .'_form_alter';
  if (function_exists($hook_form_alter)) {
924
    $hook_form_alter($form, 'install_configure');
925 926 927 928
  }
  return $form;
}

929
function install_configure_form_validate($form, &$form_state, $form_values) {
930 931 932 933 934 935 936 937 938 939 940
  if ($error = user_validate_name($form_values['account']['name'])) {
    form_error($form['admin_account']['account']['name'], $error);
  }
  if ($error = user_validate_mail($form_values['account']['mail'])) {
    form_error($form['admin_account']['account']['mail'], $error);
  }
  if ($error = user_validate_mail($form_values['site_mail'])) {
    form_error($form['site_information']['site_mail'], $error);
  }
}

941
function install_configure_form_submit($form, &$form_state, $form_values) {
942 943
  global $user;

944 945 946 947 948
  variable_set('site_name', $form_values['site_name']);
  variable_set('site_mail', $form_values['site_mail']);
  variable_set('date_default_timezone', $form_values['date_default_timezone']);
  // Turn this off temporarily so that we can pass a password through.
  variable_set('user_email_verification', FALSE);
949
  user_register_submit($form, $form_state, $form_values['account']);
950 951 952 953
  variable_set('user_email_verification', TRUE);
  if (isset($form_values['clean_url'])) {
    variable_set('clean_url', $form_values['clean_url']);
  }
954 955 956
  // 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();
957 958 959 960

  return 'finished';
}

961
install_main();