1. 8.3.x core/includes/install.core.inc
  2. 8.0.x core/includes/install.core.inc
  3. 8.1.x core/includes/install.core.inc
  4. 8.2.x core/includes/install.core.inc
  5. 8.4.x core/includes/install.core.inc
  6. 7.x includes/install.core.inc

API functions for installing Drupal.

File

includes/install.core.inc
View source
  1. <?php
  2. /**
  3. * @file
  4. * API functions for installing Drupal.
  5. */
  6. /**
  7. * Do not run the task during the current installation request.
  8. *
  9. * This can be used to skip running an installation task when certain
  10. * conditions are met, even though the task may still show on the list of
  11. * installation tasks presented to the user. For example, the Drupal installer
  12. * uses this flag to skip over the database configuration form when valid
  13. * database connection information is already available from settings.php. It
  14. * also uses this flag to skip language import tasks when the installation is
  15. * being performed in English.
  16. */
  17. define('INSTALL_TASK_SKIP', 1);
  18. /**
  19. * Run the task on each installation request until the database is set up.
  20. *
  21. * This is primarily used by the Drupal installer for bootstrap-related tasks.
  22. */
  23. define('INSTALL_TASK_RUN_IF_REACHED', 2);
  24. /**
  25. * Global flag to indicate that a task should be run on each installation
  26. * request that reaches it, until the database is set up and we are able to
  27. * record the fact that it already ran.
  28. *
  29. * This is the default method for running tasks and should be used for most
  30. * tasks that occur after the database is set up; these tasks will then run
  31. * once and be marked complete once they are successfully finished. For
  32. * example, the Drupal installer uses this flag for the batch installation of
  33. * modules on the new site, and also for the configuration form that collects
  34. * basic site information and sets up the site maintenance account.
  35. */
  36. define('INSTALL_TASK_RUN_IF_NOT_COMPLETED', 3);
  37. /**
  38. * Installs Drupal either interactively or via an array of passed-in settings.
  39. *
  40. * The Drupal installation happens in a series of steps, which may be spread
  41. * out over multiple page requests. Each request begins by trying to determine
  42. * the last completed installation step (also known as a "task"), if one is
  43. * available from a previous request. Control is then passed to the task
  44. * handler, which processes the remaining tasks that need to be run until (a)
  45. * an error is thrown, (b) a new page needs to be displayed, or (c) the
  46. * installation finishes (whichever happens first).
  47. *
  48. * @param $settings
  49. * An optional array of installation settings. Leave this empty for a normal,
  50. * interactive, browser-based installation intended to occur over multiple
  51. * page requests. Alternatively, if an array of settings is passed in, the
  52. * installer will attempt to use it to perform the installation in a single
  53. * page request (optimized for the command line) and not send any output
  54. * intended for the web browser. See install_state_defaults() for a list of
  55. * elements that are allowed to appear in this array.
  56. *
  57. * @see install_state_defaults()
  58. */
  59. function install_drupal($settings = array()) {
  60. global $install_state;
  61. // Initialize the installation state with the settings that were passed in,
  62. // as well as a boolean indicating whether or not this is an interactive
  63. // installation.
  64. $interactive = empty($settings);
  65. $install_state = $settings + array('interactive' => $interactive) + install_state_defaults();
  66. try {
  67. // Begin the page request. This adds information about the current state of
  68. // the Drupal installation to the passed-in array.
  69. install_begin_request($install_state);
  70. // Based on the installation state, run the remaining tasks for this page
  71. // request, and collect any output.
  72. $output = install_run_tasks($install_state);
  73. }
  74. catch (Exception $e) {
  75. // When an installation error occurs, either send the error to the web
  76. // browser or pass on the exception so the calling script can use it.
  77. if ($install_state['interactive']) {
  78. install_display_output($e->getMessage(), $install_state);
  79. }
  80. else {
  81. throw $e;
  82. }
  83. }
  84. // All available tasks for this page request are now complete. Interactive
  85. // installations can send output to the browser or redirect the user to the
  86. // next page.
  87. if ($install_state['interactive']) {
  88. if ($install_state['parameters_changed']) {
  89. // Redirect to the correct page if the URL parameters have changed.
  90. install_goto(install_redirect_url($install_state));
  91. }
  92. elseif (isset($output)) {
  93. // Display a page only if some output is available. Otherwise it is
  94. // possible that we are printing a JSON page and theme output should
  95. // not be shown.
  96. install_display_output($output, $install_state);
  97. }
  98. }
  99. }
  100. /**
  101. * Returns an array of default settings for the global installation state.
  102. *
  103. * The installation state is initialized with these settings at the beginning
  104. * of each page request. They may evolve during the page request, but they are
  105. * initialized again once the next request begins.
  106. *
  107. * Non-interactive Drupal installations can override some of these default
  108. * settings by passing in an array to the installation script, most notably
  109. * 'parameters' (which contains one-time parameters such as 'profile' and
  110. * 'locale' that are normally passed in via the URL) and 'forms' (which can
  111. * be used to programmatically submit forms during the installation; the keys
  112. * of each element indicate the name of the installation task that the form
  113. * submission is for, and the values are used as the $form_state['values']
  114. * array that is passed on to the form submission via drupal_form_submit()).
  115. *
  116. * @see drupal_form_submit()
  117. */
  118. function install_state_defaults() {
  119. $defaults = array(
  120. // The current task being processed.
  121. 'active_task' => NULL,
  122. // The last task that was completed during the previous installation
  123. // request.
  124. 'completed_task' => NULL,
  125. // This becomes TRUE only when Drupal's system module is installed.
  126. 'database_tables_exist' => FALSE,
  127. // An array of forms to be programmatically submitted during the
  128. // installation. The keys of each element indicate the name of the
  129. // installation task that the form submission is for, and the values are
  130. // used as the $form_state['values'] array that is passed on to the form
  131. // submission via drupal_form_submit().
  132. 'forms' => array(),
  133. // This becomes TRUE only at the end of the installation process, after
  134. // all available tasks have been completed and Drupal is fully installed.
  135. // It is used by the installer to store correct information in the database
  136. // about the completed installation, as well as to inform theme functions
  137. // that all tasks are finished (so that the task list can be displayed
  138. // correctly).
  139. 'installation_finished' => FALSE,
  140. // Whether or not this installation is interactive. By default this will
  141. // be set to FALSE if settings are passed in to install_drupal().
  142. 'interactive' => TRUE,
  143. // An array of available languages for the installation.
  144. 'locales' => array(),
  145. // An array of parameters for the installation, pre-populated by the URL
  146. // or by the settings passed in to install_drupal(). This is primarily
  147. // used to store 'profile' (the name of the chosen installation profile)
  148. // and 'locale' (the name of the chosen installation language), since
  149. // these settings need to persist from page request to page request before
  150. // the database is available for storage.
  151. 'parameters' => array(),
  152. // Whether or not the parameters have changed during the current page
  153. // request. For interactive installations, this will trigger a page
  154. // redirect.
  155. 'parameters_changed' => FALSE,
  156. // An array of information about the chosen installation profile. This will
  157. // be filled in based on the profile's .info file.
  158. 'profile_info' => array(),
  159. // An array of available installation profiles.
  160. 'profiles' => array(),
  161. // An array of server variables that will be substituted into the global
  162. // $_SERVER array via drupal_override_server_variables(). Used by
  163. // non-interactive installations only.
  164. 'server' => array(),
  165. // This becomes TRUE only when a valid database connection can be
  166. // established.
  167. 'settings_verified' => FALSE,
  168. // Installation tasks can set this to TRUE to force the page request to
  169. // end (even if there is no themable output), in the case of an interactive
  170. // installation. This is needed only rarely; for example, it would be used
  171. // by an installation task that prints JSON output rather than returning a
  172. // themed page. The most common example of this is during batch processing,
  173. // but the Drupal installer automatically takes care of setting this
  174. // parameter properly in that case, so that individual installation tasks
  175. // which implement the batch API do not need to set it themselves.
  176. 'stop_page_request' => FALSE,
  177. // Installation tasks can set this to TRUE to indicate that the task should
  178. // be run again, even if it normally wouldn't be. This can be used, for
  179. // example, if a single task needs to be spread out over multiple page
  180. // requests, or if it needs to perform some validation before allowing
  181. // itself to be marked complete. The most common examples of this are batch
  182. // processing and form submissions, but the Drupal installer automatically
  183. // takes care of setting this parameter properly in those cases, so that
  184. // individual installation tasks which implement the batch API or form API
  185. // do not need to set it themselves.
  186. 'task_not_complete' => FALSE,
  187. // A list of installation tasks which have already been performed during
  188. // the current page request.
  189. 'tasks_performed' => array(),
  190. );
  191. return $defaults;
  192. }
  193. /**
  194. * Begins an installation request, modifying the installation state as needed.
  195. *
  196. * This function performs commands that must run at the beginning of every page
  197. * request. It throws an exception if the installation should not proceed.
  198. *
  199. * @param $install_state
  200. * An array of information about the current installation state. This is
  201. * modified with information gleaned from the beginning of the page request.
  202. */
  203. function install_begin_request(&$install_state) {
  204. // Add any installation parameters passed in via the URL.
  205. $install_state['parameters'] += $_GET;
  206. // Validate certain core settings that are used throughout the installation.
  207. if (!empty($install_state['parameters']['profile'])) {
  208. $install_state['parameters']['profile'] = preg_replace('/[^a-zA-Z_0-9]/', '', $install_state['parameters']['profile']);
  209. }
  210. if (!empty($install_state['parameters']['locale'])) {
  211. $install_state['parameters']['locale'] = preg_replace('/[^a-zA-Z_0-9\-]/', '', $install_state['parameters']['locale']);
  212. }
  213. // Allow command line scripts to override server variables used by Drupal.
  214. require_once DRUPAL_ROOT . '/includes/bootstrap.inc';
  215. if (!$install_state['interactive']) {
  216. drupal_override_server_variables($install_state['server']);
  217. }
  218. // The user agent header is used to pass a database prefix in the request when
  219. // running tests. However, for security reasons, it is imperative that no
  220. // installation be permitted using such a prefix.
  221. if (isset($_SERVER['HTTP_USER_AGENT']) && strpos($_SERVER['HTTP_USER_AGENT'], "simpletest") !== FALSE) {
  222. header($_SERVER['SERVER_PROTOCOL'] . ' 403 Forbidden');
  223. exit;
  224. }
  225. drupal_bootstrap(DRUPAL_BOOTSTRAP_CONFIGURATION);
  226. // This must go after drupal_bootstrap(), which unsets globals!
  227. global $conf;
  228. require_once DRUPAL_ROOT . '/modules/system/system.install';
  229. require_once DRUPAL_ROOT . '/includes/common.inc';
  230. require_once DRUPAL_ROOT . '/includes/file.inc';
  231. require_once DRUPAL_ROOT . '/includes/install.inc';
  232. require_once DRUPAL_ROOT . '/' . variable_get('path_inc', 'includes/path.inc');
  233. // Load module basics (needed for hook invokes).
  234. include_once DRUPAL_ROOT . '/includes/module.inc';
  235. include_once DRUPAL_ROOT . '/includes/session.inc';
  236. // Set up $language, so t() caller functions will still work.
  237. drupal_language_initialize();
  238. include_once DRUPAL_ROOT . '/includes/entity.inc';
  239. require_once DRUPAL_ROOT . '/includes/ajax.inc';
  240. $module_list['system']['filename'] = 'modules/system/system.module';
  241. $module_list['user']['filename'] = 'modules/user/user.module';
  242. module_list(TRUE, FALSE, FALSE, $module_list);
  243. drupal_load('module', 'system');
  244. drupal_load('module', 'user');
  245. // Load the cache infrastructure using a "fake" cache implementation that
  246. // does not attempt to write to the database. We need this during the initial
  247. // part of the installer because the database is not available yet. We
  248. // continue to use it even when the database does become available, in order
  249. // to preserve consistency between interactive and command-line installations
  250. // (the latter complete in one page request and therefore are forced to
  251. // continue using the cache implementation they started with) and also
  252. // because any data put in the cache during the installer is inherently
  253. // suspect, due to the fact that Drupal is not fully set up yet.
  254. require_once DRUPAL_ROOT . '/includes/cache.inc';
  255. require_once DRUPAL_ROOT . '/includes/cache-install.inc';
  256. $conf['cache_default_class'] = 'DrupalFakeCache';
  257. // Prepare for themed output. We need to run this at the beginning of the
  258. // page request to avoid a different theme accidentally getting set. (We also
  259. // need to run it even in the case of command-line installations, to prevent
  260. // any code in the installer that happens to initialize the theme system from
  261. // accessing the database before it is set up yet.)
  262. drupal_maintenance_theme();
  263. // Check existing settings.php.
  264. $install_state['settings_verified'] = install_verify_settings();
  265. if ($install_state['settings_verified']) {
  266. // Initialize the database system. Note that the connection
  267. // won't be initialized until it is actually requested.
  268. require_once DRUPAL_ROOT . '/includes/database/database.inc';
  269. // Verify the last completed task in the database, if there is one.
  270. $task = install_verify_completed_task();
  271. }
  272. else {
  273. $task = NULL;
  274. // Do not install over a configured settings.php. Check the 'db_url'
  275. // variable in addition to 'databases', since previous versions of Drupal
  276. // used that (and we do not want to allow installations on an existing site
  277. // whose settings file has not yet been updated).
  278. if (!empty($GLOBALS['databases']) || !empty($GLOBALS['db_url'])) {
  279. throw new Exception(install_already_done_error());
  280. }
  281. }
  282. // Modify the installation state as appropriate.
  283. $install_state['completed_task'] = $task;
  284. $install_state['database_tables_exist'] = !empty($task);
  285. }
  286. /**
  287. * Runs all tasks for the current installation request.
  288. *
  289. * In the case of an interactive installation, all tasks will be attempted
  290. * until one is reached that has output which needs to be displayed to the
  291. * user, or until a page redirect is required. Otherwise, tasks will be
  292. * attempted until the installation is finished.
  293. *
  294. * @param $install_state
  295. * An array of information about the current installation state. This is
  296. * passed along to each task, so it can be modified if necessary.
  297. *
  298. * @return
  299. * HTML output from the last completed task.
  300. */
  301. function install_run_tasks(&$install_state) {
  302. do {
  303. // Obtain a list of tasks to perform. The list of tasks itself can be
  304. // dynamic (e.g., some might be defined by the installation profile,
  305. // which is not necessarily known until the earlier tasks have run),
  306. // so we regenerate the remaining tasks based on the installation state,
  307. // each time through the loop.
  308. $tasks_to_perform = install_tasks_to_perform($install_state);
  309. // Run the first task on the list.
  310. reset($tasks_to_perform);
  311. $task_name = key($tasks_to_perform);
  312. $task = array_shift($tasks_to_perform);
  313. $install_state['active_task'] = $task_name;
  314. $original_parameters = $install_state['parameters'];
  315. $output = install_run_task($task, $install_state);
  316. $install_state['parameters_changed'] = ($install_state['parameters'] != $original_parameters);
  317. // Store this task as having been performed during the current request,
  318. // and save it to the database as completed, if we need to and if the
  319. // database is in a state that allows us to do so. Also mark the
  320. // installation as 'done' when we have run out of tasks.
  321. if (!$install_state['task_not_complete']) {
  322. $install_state['tasks_performed'][] = $task_name;
  323. $install_state['installation_finished'] = empty($tasks_to_perform);
  324. if ($install_state['database_tables_exist'] && ($task['run'] == INSTALL_TASK_RUN_IF_NOT_COMPLETED || $install_state['installation_finished'])) {
  325. variable_set('install_task', $install_state['installation_finished'] ? 'done' : $task_name);
  326. }
  327. }
  328. // Stop when there are no tasks left. In the case of an interactive
  329. // installation, also stop if we have some output to send to the browser,
  330. // the URL parameters have changed, or an end to the page request was
  331. // specifically called for.
  332. $finished = empty($tasks_to_perform) || ($install_state['interactive'] && (isset($output) || $install_state['parameters_changed'] || $install_state['stop_page_request']));
  333. } while (!$finished);
  334. return $output;
  335. }
  336. /**
  337. * Runs an individual installation task.
  338. *
  339. * @param $task
  340. * An array of information about the task to be run as returned by
  341. * hook_install_tasks().
  342. * @param $install_state
  343. * An array of information about the current installation state. This is
  344. * passed in by reference so that it can be modified by the task.
  345. *
  346. * @return
  347. * The output of the task function, if there is any.
  348. */
  349. function install_run_task($task, &$install_state) {
  350. $function = $task['function'];
  351. if ($task['type'] == 'form') {
  352. require_once DRUPAL_ROOT . '/includes/form.inc';
  353. if ($install_state['interactive']) {
  354. // For interactive forms, build the form and ensure that it will not
  355. // redirect, since the installer handles its own redirection only after
  356. // marking the form submission task complete.
  357. $form_state = array(
  358. // We need to pass $install_state by reference in order for forms to
  359. // modify it, since the form API will use it in call_user_func_array(),
  360. // which requires that referenced variables be passed explicitly.
  361. 'build_info' => array('args' => array(&$install_state)),
  362. 'no_redirect' => TRUE,
  363. );
  364. $form = drupal_build_form($function, $form_state);
  365. // If a successful form submission did not occur, the form needs to be
  366. // rendered, which means the task is not complete yet.
  367. if (empty($form_state['executed'])) {
  368. $install_state['task_not_complete'] = TRUE;
  369. return drupal_render($form);
  370. }
  371. // Otherwise, return nothing so the next task will run in the same
  372. // request.
  373. return;
  374. }
  375. else {
  376. // For non-interactive forms, submit the form programmatically with the
  377. // values taken from the installation state. Throw an exception if any
  378. // errors were encountered.
  379. $form_state = array(
  380. 'values' => !empty($install_state['forms'][$function]) ? $install_state['forms'][$function] : array(),
  381. // We need to pass $install_state by reference in order for forms to
  382. // modify it, since the form API will use it in call_user_func_array(),
  383. // which requires that referenced variables be passed explicitly.
  384. 'build_info' => array('args' => array(&$install_state)),
  385. );
  386. drupal_form_submit($function, $form_state);
  387. $errors = form_get_errors();
  388. if (!empty($errors)) {
  389. throw new Exception(implode("\n", $errors));
  390. }
  391. }
  392. }
  393. elseif ($task['type'] == 'batch') {
  394. // Start a new batch based on the task function, if one is not running
  395. // already.
  396. $current_batch = variable_get('install_current_batch');
  397. if (!$install_state['interactive'] || !$current_batch) {
  398. $batch = $function($install_state);
  399. if (empty($batch)) {
  400. // If the task did some processing and decided no batch was necessary,
  401. // there is nothing more to do here.
  402. return;
  403. }
  404. batch_set($batch);
  405. // For interactive batches, we need to store the fact that this batch
  406. // task is currently running. Otherwise, we need to make sure the batch
  407. // will complete in one page request.
  408. if ($install_state['interactive']) {
  409. variable_set('install_current_batch', $function);
  410. }
  411. else {
  412. $batch =& batch_get();
  413. $batch['progressive'] = FALSE;
  414. }
  415. // Process the batch. For progressive batches, this will redirect.
  416. // Otherwise, the batch will complete.
  417. batch_process(install_redirect_url($install_state), install_full_redirect_url($install_state));
  418. }
  419. // If we are in the middle of processing this batch, keep sending back
  420. // any output from the batch process, until the task is complete.
  421. elseif ($current_batch == $function) {
  422. include_once DRUPAL_ROOT . '/includes/batch.inc';
  423. $output = _batch_page();
  424. // The task is complete when we try to access the batch page and receive
  425. // FALSE in return, since this means we are at a URL where we are no
  426. // longer requesting a batch ID.
  427. if ($output === FALSE) {
  428. // Return nothing so the next task will run in the same request.
  429. variable_del('install_current_batch');
  430. return;
  431. }
  432. else {
  433. // We need to force the page request to end if the task is not
  434. // complete, since the batch API sometimes prints JSON output
  435. // rather than returning a themed page.
  436. $install_state['task_not_complete'] = $install_state['stop_page_request'] = TRUE;
  437. return $output;
  438. }
  439. }
  440. }
  441. else {
  442. // For normal tasks, just return the function result, whatever it is.
  443. return $function($install_state);
  444. }
  445. }
  446. /**
  447. * Returns a list of tasks to perform during the current installation request.
  448. *
  449. * Note that the list of tasks can change based on the installation state as
  450. * the page request evolves (for example, if an installation profile hasn't
  451. * been selected yet, we don't yet know which profile tasks need to be run).
  452. *
  453. * You can override this using hook_install_tasks() or
  454. * hook_install_tasks_alter().
  455. *
  456. * @param $install_state
  457. * An array of information about the current installation state.
  458. *
  459. * @return
  460. * A list of tasks to be performed, with associated metadata as returned by
  461. * hook_install_tasks().
  462. */
  463. function install_tasks_to_perform($install_state) {
  464. // Start with a list of all currently available tasks.
  465. $tasks = install_tasks($install_state);
  466. foreach ($tasks as $name => $task) {
  467. // Remove any tasks that were already performed or that never should run.
  468. // Also, if we started this page request with an indication of the last
  469. // task that was completed, skip that task and all those that come before
  470. // it, unless they are marked as always needing to run.
  471. if ($task['run'] == INSTALL_TASK_SKIP || in_array($name, $install_state['tasks_performed']) || (!empty($install_state['completed_task']) && empty($completed_task_found) && $task['run'] != INSTALL_TASK_RUN_IF_REACHED)) {
  472. unset($tasks[$name]);
  473. }
  474. if (!empty($install_state['completed_task']) && $name == $install_state['completed_task']) {
  475. $completed_task_found = TRUE;
  476. }
  477. }
  478. return $tasks;
  479. }
  480. /**
  481. * Returns a list of all tasks the installer currently knows about.
  482. *
  483. * This function will return tasks regardless of whether or not they are
  484. * intended to run on the current page request. However, the list can change
  485. * based on the installation state (for example, if an installation profile
  486. * hasn't been selected yet, we don't yet know which profile tasks will be
  487. * available).
  488. *
  489. * @param $install_state
  490. * An array of information about the current installation state.
  491. *
  492. * @return
  493. * A list of tasks, with associated metadata.
  494. */
  495. function install_tasks($install_state) {
  496. // Determine whether translation import tasks will need to be performed.
  497. $needs_translations = count($install_state['locales']) > 1 && !empty($install_state['parameters']['locale']) && $install_state['parameters']['locale'] != 'en';
  498. // Start with the core installation tasks that run before handing control
  499. // to the installation profile.
  500. $tasks = array(
  501. 'install_select_profile' => array(
  502. 'display_name' => st('Choose profile'),
  503. 'display' => count($install_state['profiles']) != 1,
  504. 'run' => INSTALL_TASK_RUN_IF_REACHED,
  505. ),
  506. 'install_select_locale' => array(
  507. 'display_name' => st('Choose language'),
  508. 'run' => INSTALL_TASK_RUN_IF_REACHED,
  509. ),
  510. 'install_load_profile' => array(
  511. 'run' => INSTALL_TASK_RUN_IF_REACHED,
  512. ),
  513. 'install_verify_requirements' => array(
  514. 'display_name' => st('Verify requirements'),
  515. ),
  516. 'install_settings_form' => array(
  517. 'display_name' => st('Set up database'),
  518. 'type' => 'form',
  519. 'run' => $install_state['settings_verified'] ? INSTALL_TASK_SKIP : INSTALL_TASK_RUN_IF_NOT_COMPLETED,
  520. ),
  521. 'install_system_module' => array(
  522. ),
  523. 'install_bootstrap_full' => array(
  524. 'run' => INSTALL_TASK_RUN_IF_REACHED,
  525. ),
  526. 'install_profile_modules' => array(
  527. 'display_name' => count($install_state['profiles']) == 1 ? st('Install site') : st('Install profile'),
  528. 'type' => 'batch',
  529. ),
  530. 'install_import_locales' => array(
  531. 'display_name' => st('Set up translations'),
  532. 'display' => $needs_translations,
  533. 'type' => 'batch',
  534. 'run' => $needs_translations ? INSTALL_TASK_RUN_IF_NOT_COMPLETED : INSTALL_TASK_SKIP,
  535. ),
  536. 'install_configure_form' => array(
  537. 'display_name' => st('Configure site'),
  538. 'type' => 'form',
  539. ),
  540. );
  541. // Now add any tasks defined by the installation profile.
  542. if (!empty($install_state['parameters']['profile'])) {
  543. // Load the profile install file, because it is not always loaded when
  544. // hook_install_tasks() is invoked (e.g. batch processing).
  545. $profile_install_file = DRUPAL_ROOT . '/profiles/' . $install_state['parameters']['profile'] . '/' . $install_state['parameters']['profile'] . '.install';
  546. if (file_exists($profile_install_file)) {
  547. include_once $profile_install_file;
  548. }
  549. $function = $install_state['parameters']['profile'] . '_install_tasks';
  550. if (function_exists($function)) {
  551. $result = $function($install_state);
  552. if (is_array($result)) {
  553. $tasks += $result;
  554. }
  555. }
  556. }
  557. // Finish by adding the remaining core tasks.
  558. $tasks += array(
  559. 'install_import_locales_remaining' => array(
  560. 'display_name' => st('Finish translations'),
  561. 'display' => $needs_translations,
  562. 'type' => 'batch',
  563. 'run' => $needs_translations ? INSTALL_TASK_RUN_IF_NOT_COMPLETED : INSTALL_TASK_SKIP,
  564. ),
  565. 'install_finished' => array(
  566. 'display_name' => st('Finished'),
  567. ),
  568. );
  569. // Allow the installation profile to modify the full list of tasks.
  570. if (!empty($install_state['parameters']['profile'])) {
  571. $profile_file = DRUPAL_ROOT . '/profiles/' . $install_state['parameters']['profile'] . '/' . $install_state['parameters']['profile'] . '.profile';
  572. if (file_exists($profile_file)) {
  573. include_once $profile_file;
  574. $function = $install_state['parameters']['profile'] . '_install_tasks_alter';
  575. if (function_exists($function)) {
  576. $function($tasks, $install_state);
  577. }
  578. }
  579. }
  580. // Fill in default parameters for each task before returning the list.
  581. foreach ($tasks as $task_name => &$task) {
  582. $task += array(
  583. 'display_name' => NULL,
  584. 'display' => !empty($task['display_name']),
  585. 'type' => 'normal',
  586. 'run' => INSTALL_TASK_RUN_IF_NOT_COMPLETED,
  587. 'function' => $task_name,
  588. );
  589. }
  590. return $tasks;
  591. }
  592. /**
  593. * Returns a list of tasks that should be displayed to the end user.
  594. *
  595. * The output of this function is a list suitable for sending to
  596. * theme_task_list().
  597. *
  598. * @param $install_state
  599. * An array of information about the current installation state.
  600. *
  601. * @return
  602. * A list of tasks, with keys equal to the machine-readable task name and
  603. * values equal to the name that should be displayed.
  604. *
  605. * @see theme_task_list()
  606. */
  607. function install_tasks_to_display($install_state) {
  608. $displayed_tasks = array();
  609. foreach (install_tasks($install_state) as $name => $task) {
  610. if ($task['display']) {
  611. $displayed_tasks[$name] = $task['display_name'];
  612. }
  613. }
  614. return $displayed_tasks;
  615. }
  616. /**
  617. * Returns the URL that should be redirected to during an installation request.
  618. *
  619. * The output of this function is suitable for sending to install_goto().
  620. *
  621. * @param $install_state
  622. * An array of information about the current installation state.
  623. *
  624. * @return
  625. * The URL to redirect to.
  626. *
  627. * @see install_full_redirect_url()
  628. */
  629. function install_redirect_url($install_state) {
  630. return 'install.php?' . drupal_http_build_query($install_state['parameters']);
  631. }
  632. /**
  633. * Returns the complete URL redirected to during an installation request.
  634. *
  635. * @param $install_state
  636. * An array of information about the current installation state.
  637. *
  638. * @return
  639. * The complete URL to redirect to.
  640. *
  641. * @see install_redirect_url()
  642. */
  643. function install_full_redirect_url($install_state) {
  644. global $base_url;
  645. return $base_url . '/' . install_redirect_url($install_state);
  646. }
  647. /**
  648. * Displays themed installer output and ends the page request.
  649. *
  650. * Installation tasks should use drupal_set_title() to set the desired page
  651. * title, but otherwise this function takes care of theming the overall page
  652. * output during every step of the installation.
  653. *
  654. * @param $output
  655. * The content to display on the main part of the page.
  656. * @param $install_state
  657. * An array of information about the current installation state.
  658. */
  659. function install_display_output($output, $install_state) {
  660. drupal_page_header();
  661. // Prevent install.php from being indexed when installed in a sub folder.
  662. // robots.txt rules are not read if the site is within domain.com/subfolder
  663. // resulting in /subfolder/install.php being found through search engines.
  664. // When settings.php is writeable this can be used via an external database
  665. // leading a malicious user to gain php access to the server.
  666. $noindex_meta_tag = array(
  667. '#tag' => 'meta',
  668. '#attributes' => array(
  669. 'name' => 'robots',
  670. 'content' => 'noindex, nofollow',
  671. ),
  672. );
  673. drupal_add_html_head($noindex_meta_tag, 'install_meta_robots');
  674. // Only show the task list if there is an active task; otherwise, the page
  675. // request has ended before tasks have even been started, so there is nothing
  676. // meaningful to show.
  677. if (isset($install_state['active_task'])) {
  678. // Let the theming function know when every step of the installation has
  679. // been completed.
  680. $active_task = $install_state['installation_finished'] ? NULL : $install_state['active_task'];
  681. drupal_add_region_content('sidebar_first', theme('task_list', array('items' => install_tasks_to_display($install_state), 'active' => $active_task)));
  682. }
  683. print theme('install_page', array('content' => $output));
  684. exit;
  685. }
  686. /**
  687. * Verifies the requirements for installing Drupal.
  688. *
  689. * @param $install_state
  690. * An array of information about the current installation state.
  691. *
  692. * @return
  693. * A themed status report, or an exception if there are requirement errors.
  694. * If there are only requirement warnings, a themed status report is shown
  695. * initially, but the user is allowed to bypass it by providing 'continue=1'
  696. * in the URL. Otherwise, no output is returned, so that the next task can be
  697. * run in the same page request.
  698. */
  699. function install_verify_requirements(&$install_state) {
  700. // Check the installation requirements for Drupal and this profile.
  701. $requirements = install_check_requirements($install_state);
  702. // Verify existence of all required modules.
  703. $requirements += drupal_verify_profile($install_state);
  704. // Check the severity of the requirements reported.
  705. $severity = drupal_requirements_severity($requirements);
  706. // If there are errors, always display them. If there are only warnings, skip
  707. // them if the user has provided a URL parameter acknowledging the warnings
  708. // and indicating a desire to continue anyway. See drupal_requirements_url().
  709. if ($severity == REQUIREMENT_ERROR || ($severity == REQUIREMENT_WARNING && empty($install_state['parameters']['continue']))) {
  710. if ($install_state['interactive']) {
  711. drupal_set_title(st('Requirements problem'));
  712. $status_report = theme('status_report', array('requirements' => $requirements));
  713. $status_report .= st('Check the error messages and <a href="!url">proceed with the installation</a>.', array('!url' => check_url(drupal_requirements_url($severity))));
  714. return $status_report;
  715. }
  716. else {
  717. // Throw an exception showing any unmet requirements.
  718. $failures = array();
  719. foreach ($requirements as $requirement) {
  720. // Skip warnings altogether for non-interactive installations; these
  721. // proceed in a single request so there is no good opportunity (and no
  722. // good method) to warn the user anyway.
  723. if (isset($requirement['severity']) && $requirement['severity'] == REQUIREMENT_ERROR) {
  724. $failures[] = $requirement['title'] . ': ' . $requirement['value'] . "\n\n" . $requirement['description'];
  725. }
  726. }
  727. if (!empty($failures)) {
  728. throw new Exception(implode("\n\n", $failures));
  729. }
  730. }
  731. }
  732. }
  733. /**
  734. * Installation task; install the Drupal system module.
  735. *
  736. * @param $install_state
  737. * An array of information about the current installation state.
  738. */
  739. function install_system_module(&$install_state) {
  740. // Install system.module.
  741. drupal_install_system();
  742. // Call file_ensure_htaccess() to ensure that all of Drupal's standard
  743. // directories (e.g., the public and private files directories) have
  744. // appropriate .htaccess files. These directories will have already been
  745. // created by this point in the installer, since Drupal creates them during
  746. // the install_verify_requirements() task. Note that we cannot call
  747. // file_ensure_htaccess() any earlier than this, since it relies on
  748. // system.module in order to work.
  749. file_ensure_htaccess();
  750. // Enable the user module so that sessions can be recorded during the
  751. // upcoming bootstrap step.
  752. module_enable(array('user'), FALSE);
  753. // Save the list of other modules to install for the upcoming tasks.
  754. // variable_set() can be used now that system.module is installed.
  755. $modules = $install_state['profile_info']['dependencies'];
  756. // The installation profile is also a module, which needs to be installed
  757. // after all the dependencies have been installed.
  758. $modules[] = drupal_get_profile();
  759. variable_set('install_profile_modules', array_diff($modules, array('system')));
  760. $install_state['database_tables_exist'] = TRUE;
  761. // Prevent the hook_requirements() check from telling us to convert the
  762. // database to utf8mb4.
  763. $connection = Database::getConnection();
  764. if ($connection->utf8mb4IsConfigurable() && $connection->utf8mb4IsActive()) {
  765. variable_set('drupal_all_databases_are_utf8mb4', TRUE);
  766. }
  767. }
  768. /**
  769. * Verifies and returns the last installation task that was completed.
  770. *
  771. * @return
  772. * The last completed task, if there is one. An exception is thrown if Drupal
  773. * is already installed.
  774. */
  775. function install_verify_completed_task() {
  776. try {
  777. if ($result = db_query("SELECT value FROM {variable} WHERE name = :name", array('name' => 'install_task'))) {
  778. $task = unserialize($result->fetchField());
  779. }
  780. }
  781. // Do not trigger an error if the database query fails, since the database
  782. // might not be set up yet.
  783. catch (Exception $e) {
  784. }
  785. if (isset($task)) {
  786. if ($task == 'done') {
  787. throw new Exception(install_already_done_error());
  788. }
  789. return $task;
  790. }
  791. }
  792. /**
  793. * Verifies the existing settings in settings.php.
  794. */
  795. function install_verify_settings() {
  796. global $databases;
  797. // Verify existing settings (if any).
  798. if (!empty($databases) && install_verify_pdo()) {
  799. $database = $databases['default']['default'];
  800. drupal_static_reset('conf_path');
  801. $settings_file = './' . conf_path(FALSE) . '/settings.php';
  802. $errors = install_database_errors($database, $settings_file);
  803. if (empty($errors)) {
  804. return TRUE;
  805. }
  806. }
  807. return FALSE;
  808. }
  809. /**
  810. * Verifies the PDO library.
  811. */
  812. function install_verify_pdo() {
  813. // PDO was moved to PHP core in 5.2.0, but the old extension (targeting 5.0
  814. // and 5.1) is still available from PECL, and can still be built without
  815. // errors. To verify that the correct version is in use, we check the
  816. // PDO::ATTR_DEFAULT_FETCH_MODE constant, which is not available in the
  817. // PECL extension.
  818. return extension_loaded('pdo') && defined('PDO::ATTR_DEFAULT_FETCH_MODE');
  819. }
  820. /**
  821. * Form constructor for a form to configure and rewrite settings.php.
  822. *
  823. * @param $install_state
  824. * An array of information about the current installation state.
  825. *
  826. * @see install_settings_form_validate()
  827. * @see install_settings_form_submit()
  828. * @ingroup forms
  829. */
  830. function install_settings_form($form, &$form_state, &$install_state) {
  831. global $databases;
  832. $profile = $install_state['parameters']['profile'];
  833. $install_locale = $install_state['parameters']['locale'];
  834. drupal_static_reset('conf_path');
  835. $conf_path = './' . conf_path(FALSE);
  836. $settings_file = $conf_path . '/settings.php';
  837. $database = isset($databases['default']['default']) ? $databases['default']['default'] : array();
  838. drupal_set_title(st('Database configuration'));
  839. $drivers = drupal_get_database_types();
  840. $drivers_keys = array_keys($drivers);
  841. $form['driver'] = array(
  842. '#type' => 'radios',
  843. '#title' => st('Database type'),
  844. '#required' => TRUE,
  845. '#default_value' => !empty($database['driver']) ? $database['driver'] : current($drivers_keys),
  846. '#description' => st('The type of database your @drupal data will be stored in.', array('@drupal' => drupal_install_profile_distribution_name())),
  847. );
  848. if (count($drivers) == 1) {
  849. $form['driver']['#disabled'] = TRUE;
  850. $form['driver']['#description'] .= ' ' . st('Your PHP configuration only supports a single database type, so it has been automatically selected.');
  851. }
  852. // Add driver specific configuration options.
  853. foreach ($drivers as $key => $driver) {
  854. $form['driver']['#options'][$key] = $driver->name();
  855. $form['settings'][$key] = $driver->getFormOptions($database);
  856. $form['settings'][$key]['#prefix'] = '<h2 class="js-hide">' . st('@driver_name settings', array('@driver_name' => $driver->name())) . '</h2>';
  857. $form['settings'][$key]['#type'] = 'container';
  858. $form['settings'][$key]['#tree'] = TRUE;
  859. $form['settings'][$key]['advanced_options']['#parents'] = array($key);
  860. $form['settings'][$key]['#states'] = array(
  861. 'visible' => array(
  862. ':input[name=driver]' => array('value' => $key),
  863. )
  864. );
  865. }
  866. $form['actions'] = array('#type' => 'actions');
  867. $form['actions']['save'] = array(
  868. '#type' => 'submit',
  869. '#value' => st('Save and continue'),
  870. '#limit_validation_errors' => array(
  871. array('driver'),
  872. array(isset($form_state['input']['driver']) ? $form_state['input']['driver'] : current($drivers_keys)),
  873. ),
  874. '#submit' => array('install_settings_form_submit'),
  875. );
  876. $form['errors'] = array();
  877. $form['settings_file'] = array('#type' => 'value', '#value' => $settings_file);
  878. return $form;
  879. }
  880. /**
  881. * Form validation handler for install_settings_form().
  882. *
  883. * @see install_settings_form_submit()
  884. */
  885. function install_settings_form_validate($form, &$form_state) {
  886. $driver = $form_state['values']['driver'];
  887. $database = $form_state['values'][$driver];
  888. $database['driver'] = $driver;
  889. // TODO: remove when PIFR will be updated to use 'db_prefix' instead of
  890. // 'prefix' in the database settings form.
  891. $database['prefix'] = $database['db_prefix'];
  892. unset($database['db_prefix']);
  893. $form_state['storage']['database'] = $database;
  894. $errors = install_database_errors($database, $form_state['values']['settings_file']);
  895. foreach ($errors as $name => $message) {
  896. form_set_error($name, $message);
  897. }
  898. }
  899. /**
  900. * Checks a database connection and returns any errors.
  901. */
  902. function install_database_errors($database, $settings_file) {
  903. global $databases;
  904. $errors = array();
  905. // Check database type.
  906. $database_types = drupal_get_database_types();
  907. $driver = $database['driver'];
  908. if (!isset($database_types[$driver])) {
  909. $errors['driver'] = st("In your %settings_file file you have configured @drupal to use a %driver server, however your PHP installation currently does not support this database type.", array('%settings_file' => $settings_file, '@drupal' => drupal_install_profile_distribution_name(), '%driver' => $driver));
  910. }
  911. else {
  912. // Run driver specific validation
  913. $errors += $database_types[$driver]->validateDatabaseSettings($database);
  914. // Run tasks associated with the database type. Any errors are caught in the
  915. // calling function.
  916. $databases['default']['default'] = $database;
  917. // Just changing the global doesn't get the new information processed.
  918. // We tell tell the Database class to re-parse $databases.
  919. Database::parseConnectionInfo();
  920. try {
  921. db_run_tasks($driver);
  922. }
  923. catch (DatabaseTaskException $e) {
  924. // These are generic errors, so we do not have any specific key of the
  925. // database connection array to attach them to; therefore, we just put
  926. // them in the error array with standard numeric keys.
  927. $errors[$driver . '][0'] = $e->getMessage();
  928. }
  929. }
  930. return $errors;
  931. }
  932. /**
  933. * Form submission handler for install_settings_form().
  934. *
  935. * @see install_settings_form_validate()
  936. */
  937. function install_settings_form_submit($form, &$form_state) {
  938. global $install_state;
  939. // Update global settings array and save.
  940. $settings['databases'] = array(
  941. 'value' => array('default' => array('default' => $form_state['storage']['database'])),
  942. 'required' => TRUE,
  943. );
  944. $settings['drupal_hash_salt'] = array(
  945. 'value' => drupal_random_key(),
  946. 'required' => TRUE,
  947. );
  948. drupal_rewrite_settings($settings);
  949. // Indicate that the settings file has been verified, and check the database
  950. // for the last completed task, now that we have a valid connection. This
  951. // last step is important since we want to trigger an error if the new
  952. // database already has Drupal installed.
  953. $install_state['settings_verified'] = TRUE;
  954. $install_state['completed_task'] = install_verify_completed_task();
  955. }
  956. /**
  957. * Finds all .profile files.
  958. */
  959. function install_find_profiles() {
  960. return file_scan_directory('./profiles', '/\.profile$/', array('key' => 'name'));
  961. }
  962. /**
  963. * Selects which profile to install.
  964. *
  965. * @param $install_state
  966. * An array of information about the current installation state. The chosen
  967. * profile will be added here, if it was not already selected previously, as
  968. * will a list of all available profiles.
  969. *
  970. * @return
  971. * For interactive installations, a form allowing the profile to be selected,
  972. * if the user has a choice that needs to be made. Otherwise, an exception is
  973. * thrown if a profile cannot be chosen automatically.
  974. */
  975. function install_select_profile(&$install_state) {
  976. $install_state['profiles'] += install_find_profiles();
  977. if (empty($install_state['parameters']['profile'])) {
  978. // Try to find a profile.
  979. $profile = _install_select_profile($install_state['profiles']);
  980. if (empty($profile)) {
  981. // We still don't have a profile, so display a form for selecting one.
  982. // Only do this in the case of interactive installations, since this is
  983. // not a real form with submit handlers (the database isn't even set up
  984. // yet), rather just a convenience method for setting parameters in the
  985. // URL.
  986. if ($install_state['interactive']) {
  987. include_once DRUPAL_ROOT . '/includes/form.inc';
  988. drupal_set_title(st('Select an installation profile'));
  989. $form = drupal_get_form('install_select_profile_form', $install_state['profiles']);
  990. return drupal_render($form);
  991. }
  992. else {
  993. throw new Exception(install_no_profile_error());
  994. }
  995. }
  996. else {
  997. $install_state['parameters']['profile'] = $profile;
  998. }
  999. }
  1000. }
  1001. /**
  1002. * Selects an installation profile.
  1003. *
  1004. * A profile will be selected if:
  1005. * - Only one profile is available,
  1006. * - A profile was submitted through $_POST,
  1007. * - Exactly one of the profiles is marked as "exclusive".
  1008. * If multiple profiles are marked as "exclusive" then no profile will be
  1009. * selected.
  1010. *
  1011. * @param array $profiles
  1012. * An associative array of profiles with the machine-readable names as keys.
  1013. *
  1014. * @return
  1015. * The machine-readable name of the selected profile or NULL if no profile was
  1016. * selected.
  1017. */
  1018. function _install_select_profile($profiles) {
  1019. if (sizeof($profiles) == 0) {
  1020. throw new Exception(install_no_profile_error());
  1021. }
  1022. // Don't need to choose profile if only one available.
  1023. if (sizeof($profiles) == 1) {
  1024. $profile = array_pop($profiles);
  1025. // TODO: is this right?
  1026. require_once DRUPAL_ROOT . '/' . $profile->uri;
  1027. return $profile->name;
  1028. }
  1029. else {
  1030. foreach ($profiles as $profile) {
  1031. if (!empty($_POST['profile']) && ($_POST['profile'] == $profile->name)) {
  1032. return $profile->name;
  1033. }
  1034. }
  1035. }
  1036. // Check for a profile marked as "exclusive" and ensure that only one
  1037. // profile is marked as such.
  1038. $exclusive_profile = NULL;
  1039. foreach ($profiles as $profile) {
  1040. $profile_info = install_profile_info($profile->name);
  1041. if (!empty($profile_info['exclusive'])) {
  1042. if (empty($exclusive_profile)) {
  1043. $exclusive_profile = $profile->name;
  1044. }
  1045. else {
  1046. // We found a second "exclusive" profile. There's no way to choose
  1047. // between them, so we ignore the property.
  1048. return;
  1049. }
  1050. }
  1051. }
  1052. return $exclusive_profile;
  1053. }
  1054. /**
  1055. * Form constructor for the profile selection form.
  1056. *
  1057. * @param $form_state
  1058. * Array of metadata about state of form processing.
  1059. * @param $profile_files
  1060. * Array of .profile files, as returned from file_scan_directory().
  1061. *
  1062. * @ingroup forms
  1063. */
  1064. function install_select_profile_form($form, &$form_state, $profile_files) {
  1065. $profiles = array();
  1066. $names = array();
  1067. foreach ($profile_files as $profile) {
  1068. // TODO: is this right?
  1069. include_once DRUPAL_ROOT . '/' . $profile->uri;
  1070. $details = install_profile_info($profile->name);
  1071. // Don't show hidden profiles. This is used by to hide the testing profile,
  1072. // which only exists to speed up test runs.
  1073. if ($details['hidden'] === TRUE) {
  1074. continue;
  1075. }
  1076. $profiles[$profile->name] = $details;
  1077. // Determine the name of the profile; default to file name if defined name
  1078. // is unspecified.
  1079. $name = isset($details['name']) ? $details['name'] : $profile->name;
  1080. $names[$profile->name] = $name;
  1081. }
  1082. // Display radio buttons alphabetically by human-readable name, but always
  1083. // put the core profiles first (if they are present in the filesystem).
  1084. natcasesort($names);
  1085. if (isset($names['minimal'])) {
  1086. // If the expert ("Minimal") core profile is present, put it in front of
  1087. // any non-core profiles rather than including it with them alphabetically,
  1088. // since the other profiles might be intended to group together in a
  1089. // particular way.
  1090. $names = array('minimal' => $names['minimal']) + $names;
  1091. }
  1092. if (isset($names['standard'])) {
  1093. // If the default ("Standard") core profile is present, put it at the very
  1094. // top of the list. This profile will have its radio button pre-selected,
  1095. // so we want it to always appear at the top.
  1096. $names = array('standard' => $names['standard']) + $names;
  1097. }
  1098. foreach ($names as $profile => $name) {
  1099. $form['profile'][$name] = array(
  1100. '#type' => 'radio',
  1101. '#value' => 'standard',
  1102. '#return_value' => $profile,
  1103. '#title' => $name,
  1104. '#description' => isset($profiles[$profile]['description']) ? $profiles[$profile]['description'] : '',
  1105. '#parents' => array('profile'),
  1106. );
  1107. }
  1108. $form['actions'] = array('#type' => 'actions');
  1109. $form['actions']['submit'] = array(
  1110. '#type' => 'submit',
  1111. '#value' => st('Save and continue'),
  1112. );
  1113. return $form;
  1114. }
  1115. /**
  1116. * Find all .po files for the current profile.
  1117. */
  1118. function install_find_locales($profilename) {
  1119. $locales = file_scan_directory('./profiles/' . $profilename . '/translations', '/\.po$/', array('recurse' => FALSE));
  1120. array_unshift($locales, (object) array('name' => 'en'));
  1121. foreach ($locales as $key => $locale) {
  1122. // The locale (file name) might be drupal-7.2.cs.po instead of cs.po.
  1123. $locales[$key]->langcode = preg_replace('!^(.+\.)?([^\.]+)$!', '\2', $locale->name);
  1124. // Language codes cannot exceed 12 characters to fit into the {languages}
  1125. // table.
  1126. if (strlen($locales[$key]->langcode) > 12) {
  1127. unset($locales[$key]);
  1128. }
  1129. }
  1130. return $locales;
  1131. }
  1132. /**
  1133. * Installation task; select which locale to use for the current profile.
  1134. *
  1135. * @param $install_state
  1136. * An array of information about the current installation state. The chosen
  1137. * locale will be added here, if it was not already selected previously, as
  1138. * will a list of all available locales.
  1139. *
  1140. * @return
  1141. * For interactive installations, a form or other page output allowing the
  1142. * locale to be selected or providing information about locale selection, if
  1143. * a locale has not been chosen. Otherwise, an exception is thrown if a
  1144. * locale cannot be chosen automatically.
  1145. */
  1146. function install_select_locale(&$install_state) {
  1147. // Find all available locales.
  1148. $profilename = $install_state['parameters']['profile'];
  1149. $locales = install_find_locales($profilename);
  1150. $install_state['locales'] += $locales;
  1151. if (!empty($_POST['locale'])) {
  1152. foreach ($locales as $locale) {
  1153. if ($_POST['locale'] == $locale->langcode) {
  1154. $install_state['parameters']['locale'] = $locale->langcode;
  1155. return;
  1156. }
  1157. }
  1158. }
  1159. if (empty($install_state['parameters']['locale'])) {
  1160. // If only the built-in (English) language is available, and we are
  1161. // performing an interactive installation, inform the user that the
  1162. // installer can be localized. Otherwise we assume the user knows what he
  1163. // is doing.
  1164. if (count($locales) == 1) {
  1165. if ($install_state['interactive']) {
  1166. drupal_set_title(st('Choose language'));
  1167. if (!empty($install_state['parameters']['localize'])) {
  1168. $output = '<p>Follow these steps to translate Drupal into your language:</p>';
  1169. $output .= '<ol>';
  1170. $output .= '<li>Download a translation from the <a href="http://localize.drupal.org/download" target="_blank">translation server</a>.</li>';
  1171. $output .= '<li>Place it into the following directory:
  1172. <pre>
  1173. /profiles/' . $profilename . '/translations/
  1174. </pre></li>';
  1175. $output .= '</ol>';
  1176. $output .= '<p>For more information on installing Drupal in different languages, visit the <a href="http://drupal.org/localize" target="_blank">drupal.org handbook page</a>.</p>';
  1177. $output .= '<p>How should the installation continue?</p>';
  1178. $output .= '<ul>';
  1179. $output .= '<li><a href="install.php?profile=' . $profilename . '">Reload the language selection page after adding translations</a></li>';
  1180. $output .= '<li><a href="install.php?profile=' . $profilename . '&amp;locale=en">Continue installation in English</a></li>';
  1181. $output .= '</ul>';
  1182. }
  1183. else {
  1184. include_once DRUPAL_ROOT . '/includes/form.inc';
  1185. $elements = drupal_get_form('install_select_locale_form', $locales, $profilename);
  1186. $output = drupal_render($elements);
  1187. }
  1188. return $output;
  1189. }
  1190. // One language, but not an interactive installation. Assume the user
  1191. // knows what he is doing.
  1192. $locale = current($locales);
  1193. $install_state['parameters']['locale'] = $locale->name;
  1194. return;
  1195. }
  1196. else {
  1197. // Allow profile to pre-select the language, skipping the selection.
  1198. $function = $profilename . '_profile_details';
  1199. if (function_exists($function)) {
  1200. $details = $function();
  1201. if (isset($details['language'])) {
  1202. foreach ($locales as $locale) {
  1203. if ($details['language'] == $locale->name) {
  1204. $install_state['parameters']['locale'] = $locale->name;
  1205. return;
  1206. }
  1207. }
  1208. }
  1209. }
  1210. // We still don't have a locale, so display a form for selecting one.
  1211. // Only do this in the case of interactive installations, since this is
  1212. // not a real form with submit handlers (the database isn't even set up
  1213. // yet), rather just a convenience method for setting parameters in the
  1214. // URL.
  1215. if ($install_state['interactive']) {
  1216. drupal_set_title(st('Choose language'));
  1217. include_once DRUPAL_ROOT . '/includes/form.inc';
  1218. $elements = drupal_get_form('install_select_locale_form', $locales, $profilename);
  1219. return drupal_render($elements);
  1220. }
  1221. else {
  1222. throw new Exception(st('Sorry, you must select a language to continue the installation.'));
  1223. }
  1224. }
  1225. }
  1226. }
  1227. /**
  1228. * Form constructor for the language selection form.
  1229. *
  1230. * @ingroup forms
  1231. */
  1232. function install_select_locale_form($form, &$form_state, $locales, $profilename) {
  1233. include_once DRUPAL_ROOT . '/includes/iso.inc';
  1234. $languages = _locale_get_predefined_list();
  1235. foreach ($locales as $locale) {
  1236. $name = $locale->langcode;
  1237. if (isset($languages[$name])) {
  1238. $name = $languages[$name][0] . (isset($languages[$name][1]) ? ' ' . st('(@language)', array('@language' => $languages[$name][1])) : '');
  1239. }
  1240. $form['locale'][$locale->langcode] = array(
  1241. '#type' => 'radio',
  1242. '#return_value' => $locale->langcode,
  1243. '#default_value' => $locale->langcode == 'en' ? 'en' : '',
  1244. '#title' => $name . ($locale->langcode == 'en' ? ' ' . st('(built-in)') : ''),
  1245. '#parents' => array('locale')
  1246. );
  1247. }
  1248. if (count($locales) == 1) {
  1249. $form['help'] = array(
  1250. '#markup' => '<p><a href="install.php?profile=' . $profilename . '&amp;localize=true">' . st('Learn how to install Drupal in other languages') . '</a></p>',
  1251. );
  1252. }
  1253. $form['actions'] = array('#type' => 'actions');
  1254. $form['actions']['submit'] = array(
  1255. '#type' => 'submit',
  1256. '#value' => st('Save and continue'),
  1257. );
  1258. return $form;
  1259. }
  1260. /**
  1261. * Indicates that there are no profiles available.
  1262. */
  1263. function install_no_profile_error() {
  1264. drupal_set_title(st('No profiles available'));
  1265. return st('We were unable to find any installation profiles. Installation 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.');
  1266. }
  1267. /**
  1268. * Indicates that Drupal has already been installed.
  1269. */
  1270. function install_already_done_error() {
  1271. global $base_url;
  1272. drupal_set_title(st('Drupal already installed'));
  1273. return 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));
  1274. }
  1275. /**
  1276. * Loads information about the chosen profile during installation.
  1277. *
  1278. * @param $install_state
  1279. * An array of information about the current installation state. The loaded
  1280. * profile information will be added here, or an exception will be thrown if
  1281. * the profile cannot be loaded.
  1282. */
  1283. function install_load_profile(&$install_state) {
  1284. $profile_file = DRUPAL_ROOT . '/profiles/' . $install_state['parameters']['profile'] . '/' . $install_state['parameters']['profile'] . '.profile';
  1285. if (file_exists($profile_file)) {
  1286. include_once $profile_file;
  1287. $install_state['profile_info'] = install_profile_info($install_state['parameters']['profile'], $install_state['parameters']['locale']);
  1288. }
  1289. else {
  1290. throw new Exception(st('Sorry, the profile you have chosen cannot be loaded.'));
  1291. }
  1292. }
  1293. /**
  1294. * Performs a full bootstrap of Drupal during installation.
  1295. *
  1296. * @param $install_state
  1297. * An array of information about the current installation state.
  1298. */
  1299. function install_bootstrap_full(&$install_state) {
  1300. drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL);
  1301. }
  1302. /**
  1303. * Installs required modules via a batch process.
  1304. *
  1305. * @param $install_state
  1306. * An array of information about the current installation state.
  1307. *
  1308. * @return
  1309. * The batch definition.
  1310. */
  1311. function install_profile_modules(&$install_state) {
  1312. $modules = variable_get('install_profile_modules', array());
  1313. $files = system_rebuild_module_data();
  1314. variable_del('install_profile_modules');
  1315. // Always install required modules first. Respect the dependencies between
  1316. // the modules.
  1317. $required = array();
  1318. $non_required = array();
  1319. // Although the profile module is marked as required, it needs to go after
  1320. // every dependency, including non-required ones. So clear its required
  1321. // flag for now to allow it to install late.
  1322. $files[$install_state['parameters']['profile']]->info['required'] = FALSE;
  1323. // Add modules that other modules depend on.
  1324. foreach ($modules as $module) {
  1325. if ($files[$module]->requires) {
  1326. $modules = array_merge($modules, array_keys($files[$module]->requires));
  1327. }
  1328. }
  1329. $modules = array_unique($modules);
  1330. foreach ($modules as $module) {
  1331. if (!empty($files[$module]->info['required'])) {
  1332. $required[$module] = $files[$module]->sort;
  1333. }
  1334. else {
  1335. $non_required[$module] = $files[$module]->sort;
  1336. }
  1337. }
  1338. arsort($required);
  1339. arsort($non_required);
  1340. $operations = array();
  1341. foreach ($required + $non_required as $module => $weight) {
  1342. $operations[] = array('_install_module_batch', array($module, $files[$module]->info['name']));
  1343. }
  1344. $batch = array(
  1345. 'operations' => $operations,
  1346. 'title' => st('Installing @drupal', array('@drupal' => drupal_install_profile_distribution_name())),
  1347. 'error_message' => st('The installation has encountered an error.'),
  1348. 'finished' => '_install_profile_modules_finished',
  1349. );
  1350. return $batch;
  1351. }
  1352. /**
  1353. * Imports languages via a batch process during installation.
  1354. *
  1355. * @param $install_state
  1356. * An array of information about the current installation state.
  1357. *
  1358. * @return
  1359. * The batch definition, if there are language files to import.
  1360. */
  1361. function install_import_locales(&$install_state) {
  1362. include_once DRUPAL_ROOT . '/includes/locale.inc';
  1363. $install_locale = $install_state['parameters']['locale'];
  1364. include_once DRUPAL_ROOT . '/includes/iso.inc';
  1365. $predefined = _locale_get_predefined_list();
  1366. if (!isset($predefined[$install_locale])) {
  1367. // Drupal does not know about this language, so we prefill its values with
  1368. // our best guess. The user will be able to edit afterwards.
  1369. locale_add_language($install_locale, $install_locale, $install_locale, LANGUAGE_LTR, '', '', TRUE, TRUE);
  1370. }
  1371. else {
  1372. // A known predefined language, details will be filled in properly.
  1373. locale_add_language($install_locale, NULL, NULL, NULL, '', '', TRUE, TRUE);
  1374. }
  1375. // Collect files to import for this language.
  1376. $batch = locale_batch_by_language($install_locale, NULL);
  1377. if (!empty($batch)) {
  1378. // Remember components we cover in this batch set.
  1379. variable_set('install_locale_batch_components', $batch['#components']);
  1380. return $batch;
  1381. }
  1382. }
  1383. /**
  1384. * Form constructor for a form to configure the new site.
  1385. *
  1386. * @param $install_state
  1387. * An array of information about the current installation state.
  1388. *
  1389. * @see install_configure_form_validate()
  1390. * @see install_configure_form_submit()
  1391. * @ingroup forms
  1392. */
  1393. function install_configure_form($form, &$form_state, &$install_state) {
  1394. drupal_set_title(st('Configure site'));
  1395. // Warn about settings.php permissions risk
  1396. $settings_dir = conf_path();
  1397. $settings_file = $settings_dir . '/settings.php';
  1398. // Check that $_POST is empty so we only show this message when the form is
  1399. // first displayed, not on the next page after it is submitted. (We do not
  1400. // want to repeat it multiple times because it is a general warning that is
  1401. // not related to the rest of the installation process; it would also be
  1402. // especially out of place on the last page of the installer, where it would
  1403. // distract from the message that the Drupal installation has completed
  1404. // successfully.)
  1405. if (empty($_POST) && (!drupal_verify_install_file(DRUPAL_ROOT . '/' . $settings_file, FILE_EXIST|FILE_READABLE|FILE_NOT_WRITABLE) || !drupal_verify_install_file(DRUPAL_ROOT . '/' . $settings_dir, FILE_NOT_WRITABLE, 'dir'))) {
  1406. 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, consult the <a href="@handbook_url">online handbook</a>.', array('%dir' => $settings_dir, '%file' => $settings_file, '@handbook_url' => 'http://drupal.org/server-permissions')), 'warning');
  1407. }
  1408. drupal_add_js(drupal_get_path('module', 'system') . '/system.js');
  1409. // Add JavaScript time zone detection.
  1410. drupal_add_js('misc/timezone.js');
  1411. // We add these strings as settings because JavaScript translation does not
  1412. // work during installation.
  1413. drupal_add_js(array('copyFieldValue' => array('edit-site-mail' => array('edit-account-mail'))), 'setting');
  1414. drupal_add_js('jQuery(function () { Drupal.cleanURLsInstallCheck(); });', 'inline');
  1415. // Add JS to show / hide the 'Email administrator about site updates' elements
  1416. drupal_add_js('jQuery(function () { Drupal.hideEmailAdministratorCheckbox() });', 'inline');
  1417. // Build menu to allow clean URL check.
  1418. menu_rebuild();
  1419. // Cache a fully-built schema. This is necessary for any invocation of
  1420. // index.php because: (1) setting cache table entries requires schema
  1421. // information, (2) that occurs during bootstrap before any module are
  1422. // loaded, so (3) if there is no cached schema, drupal_get_schema() will
  1423. // try to generate one but with no loaded modules will return nothing.
  1424. //
  1425. // This logically could be done during the 'install_finished' task, but the
  1426. // clean URL check requires it now.
  1427. drupal_get_schema(NULL, TRUE);
  1428. // Return the form.
  1429. return _install_configure_form($form, $form_state, $install_state);
  1430. }
  1431. /**
  1432. * Installation task; import remaining languages via a batch process.
  1433. *
  1434. * @param $install_state
  1435. * An array of information about the current installation state.
  1436. *
  1437. * @return
  1438. * The batch definition, if there are language files to import.
  1439. */
  1440. function install_import_locales_remaining(&$install_state) {
  1441. include_once DRUPAL_ROOT . '/includes/locale.inc';
  1442. // Collect files to import for this language. Skip components already covered
  1443. // in the initial batch set.
  1444. $install_locale = $install_state['parameters']['locale'];
  1445. $batch = locale_batch_by_language($install_locale, NULL, variable_get('install_locale_batch_components', array()));
  1446. // Remove temporary variable.
  1447. variable_del('install_locale_batch_components');
  1448. return $batch;
  1449. }
  1450. /**
  1451. * Finishes importing files at end of installation.
  1452. *
  1453. * @param $install_state
  1454. * An array of information about the current installation state.
  1455. *
  1456. * @return
  1457. * A message informing the user that the installation is complete.
  1458. */
  1459. function install_finished(&$install_state) {
  1460. drupal_set_title(st('@drupal installation complete', array('@drupal' => drupal_install_profile_distribution_name())), PASS_THROUGH);
  1461. $messages = drupal_set_message();
  1462. $output = '<p>' . st('Congratulations, you installed @drupal!', array('@drupal' => drupal_install_profile_distribution_name())) . '</p>';
  1463. $output .= '<p>' . (isset($messages['error']) ? st('Review the messages above before visiting <a href="@url">your new site</a>.', array('@url' => url(''))) : st('<a href="@url">Visit your new site</a>.', array('@url' => url('')))) . '</p>';
  1464. // Flush all caches to ensure that any full bootstraps during the installer
  1465. // do not leave stale cached data, and that any content types or other items
  1466. // registered by the installation profile are registered correctly.
  1467. drupal_flush_all_caches();
  1468. // Remember the profile which was used.
  1469. variable_set('install_profile', drupal_get_profile());
  1470. // Installation profiles are always loaded last
  1471. db_update('system')
  1472. ->fields(array('weight' => 1000))
  1473. ->condition('type', 'module')
  1474. ->condition('name', drupal_get_profile())
  1475. ->execute();
  1476. // Cache a fully-built schema.
  1477. drupal_get_schema(NULL, TRUE);
  1478. // Run cron to populate update status tables (if available) so that users
  1479. // will be warned if they've installed an out of date Drupal version.
  1480. // Will also trigger indexing of profile-supplied content or feeds.
  1481. drupal_cron_run();
  1482. return $output;
  1483. }
  1484. /**
  1485. * Implements callback_batch_operation().
  1486. *
  1487. * Performs batch installation of modules.
  1488. */
  1489. function _install_module_batch($module, $module_name, &$context) {
  1490. // Install and enable the module right away, so that the module will be
  1491. // loaded by drupal_bootstrap in subsequent batch requests, and other
  1492. // modules possibly depending on it can safely perform their installation
  1493. // steps.
  1494. module_enable(array($module), FALSE);
  1495. $context['results'][] = $module;
  1496. $context['message'] = st('Installed %module module.', array('%module' => $module_name));
  1497. }
  1498. /**
  1499. * Implements callback_batch_finished().
  1500. *
  1501. * 'Finished' callback for module installation batch.
  1502. */
  1503. function _install_profile_modules_finished($success, $results, $operations) {
  1504. // Flush all caches to complete the module installation process. Subsequent
  1505. // installation tasks will now have full access to the profile's modules.
  1506. drupal_flush_all_caches();
  1507. }
  1508. /**
  1509. * Checks installation requirements and reports any errors.
  1510. */
  1511. function install_check_requirements($install_state) {
  1512. $profile = $install_state['parameters']['profile'];
  1513. // Check the profile requirements.
  1514. $requirements = drupal_check_profile($profile);
  1515. // If Drupal is not set up already, we need to create a settings file.
  1516. if (!$install_state['settings_verified']) {
  1517. $writable = FALSE;
  1518. $conf_path = './' . conf_path(FALSE, TRUE);
  1519. $settings_file = $conf_path . '/settings.php';
  1520. $default_settings_file = './sites/default/default.settings.php';
  1521. $file = $conf_path;
  1522. $exists = FALSE;
  1523. // Verify that the directory exists.
  1524. if (drupal_verify_install_file($conf_path, FILE_EXIST, 'dir')) {
  1525. // Check if a settings.php file already exists.
  1526. $file = $settings_file;
  1527. if (drupal_verify_install_file($settings_file, FILE_EXIST)) {
  1528. // If it does, make sure it is writable.
  1529. $writable = drupal_verify_install_file($settings_file, FILE_READABLE|FILE_WRITABLE);
  1530. $exists = TRUE;
  1531. }
  1532. }
  1533. // If default.settings.php does not exist, or is not readable, throw an
  1534. // error.
  1535. if (!drupal_verify_install_file($default_settings_file, FILE_EXIST|FILE_READABLE)) {
  1536. $requirements['default settings file exists'] = array(
  1537. 'title' => st('Default settings file'),
  1538. 'value' => st('The default settings file does not exist.'),
  1539. 'severity' => REQUIREMENT_ERROR,
  1540. 'description' => st('The @drupal installer requires that the %default-file file not be modified in any way from the original download.', array('@drupal' => drupal_install_profile_distribution_name(), '%default-file' => $default_settings_file)),
  1541. );
  1542. }
  1543. // Otherwise, if settings.php does not exist yet, we can try to copy
  1544. // default.settings.php to create it.
  1545. elseif (!$exists) {
  1546. $copied = drupal_verify_install_file($conf_path, FILE_EXIST|FILE_WRITABLE, 'dir') && @copy($default_settings_file, $settings_file);
  1547. if ($copied) {
  1548. // If the new settings file has the same owner as default.settings.php,
  1549. // this means default.settings.php is owned by the webserver user.
  1550. // This is an inherent security weakness because it allows a malicious
  1551. // webserver process to append arbitrary PHP code and then execute it.
  1552. // However, it is also a common configuration on shared hosting, and
  1553. // there is nothing Drupal can do to prevent it. In this situation,
  1554. // having settings.php also owned by the webserver does not introduce
  1555. // any additional security risk, so we keep the file in place.
  1556. if (fileowner($default_settings_file) === fileowner($settings_file)) {
  1557. $writable = drupal_verify_install_file($settings_file, FILE_READABLE|FILE_WRITABLE);
  1558. $exists = TRUE;
  1559. }
  1560. // If settings.php and default.settings.php have different owners, this
  1561. // probably means the server is set up "securely" (with the webserver
  1562. // running as its own user, distinct from the user who owns all the
  1563. // Drupal PHP files), although with either a group or world writable
  1564. // sites directory. Keeping settings.php owned by the webserver would
  1565. // therefore introduce a security risk. It would also cause a usability
  1566. // problem, since site owners who do not have root access to the file
  1567. // system would be unable to edit their settings file later on. We
  1568. // therefore must delete the file we just created and force the
  1569. // administrator to log on to the server and create it manually.
  1570. else {
  1571. $deleted = @drupal_unlink($settings_file);
  1572. // We expect deleting the file to be successful (since we just
  1573. // created it ourselves above), but if it fails somehow, we set a
  1574. // variable so we can display a one-time error message to the
  1575. // administrator at the bottom of the requirements list. We also try
  1576. // to make the file writable, to eliminate any conflicting error
  1577. // messages in the requirements list.
  1578. $exists = !$deleted;
  1579. if ($exists) {
  1580. $settings_file_ownership_error = TRUE;
  1581. $writable = drupal_verify_install_file($settings_file, FILE_READABLE|FILE_WRITABLE);
  1582. }
  1583. }
  1584. }
  1585. }
  1586. // If settings.php does not exist, throw an error.
  1587. if (!$exists) {
  1588. $requirements['settings file exists'] = array(
  1589. 'title' => st('Settings file'),
  1590. 'value' => st('The settings file does not exist.'),
  1591. 'severity' => REQUIREMENT_ERROR,
  1592. 'description' => st('The @drupal installer requires that you create a settings file as part of the installation process. Copy the %default_file file to %file. More details about installing Drupal are available in <a href="@install_txt">INSTALL.txt</a>.', array('@drupal' => drupal_install_profile_distribution_name(), '%file' => $file, '%default_file' => $default_settings_file, '@install_txt' => base_path() . 'INSTALL.txt')),
  1593. );
  1594. }
  1595. else {
  1596. $requirements['settings file exists'] = array(
  1597. 'title' => st('Settings file'),
  1598. 'value' => st('The %file file exists.', array('%file' => $file)),
  1599. );
  1600. // If settings.php is not writable, throw an error.
  1601. if (!$writable) {
  1602. $requirements['settings file writable'] = array(
  1603. 'title' => st('Settings file'),
  1604. 'value' => st('The settings file is not writable.'),
  1605. 'severity' => REQUIREMENT_ERROR,
  1606. 'description' => st('The @drupal installer requires write permissions to %file during the installation process. If you are unsure how to grant file permissions, consult the <a href="@handbook_url">online handbook</a>.', array('@drupal' => drupal_install_profile_distribution_name(), '%file' => $file, '@handbook_url' => 'http://drupal.org/server-permissions')),
  1607. );
  1608. }
  1609. else {
  1610. $requirements['settings file'] = array(
  1611. 'title' => st('Settings file'),
  1612. 'value' => st('The settings file is writable.'),
  1613. );
  1614. }
  1615. if (!empty($settings_file_ownership_error)) {
  1616. $requirements['settings file ownership'] = array(
  1617. 'title' => st('Settings file'),
  1618. 'value' => st('The settings file is owned by the web server.'),
  1619. 'severity' => REQUIREMENT_ERROR,
  1620. 'description' => st('The @drupal installer failed to create a settings file with proper file ownership. Log on to your web server, remove the existing %file file, and create a new one by copying the %default_file file to %file. More details about installing Drupal are available in <a href="@install_txt">INSTALL.txt</a>. If you have problems with the file permissions on your server, consult the <a href="@handbook_url">online handbook</a>.', array('@drupal' => drupal_install_profile_distribution_name(), '%file' => $file, '%default_file' => $default_settings_file, '@install_txt' => base_path() . 'INSTALL.txt', '@handbook_url' => 'http://drupal.org/server-permissions')),
  1621. );
  1622. }
  1623. }
  1624. }
  1625. return $requirements;
  1626. }
  1627. /**
  1628. * Form constructor for a site configuration form.
  1629. *
  1630. * @param $install_state
  1631. * An array of information about the current installation state.
  1632. *
  1633. * @see install_configure_form()
  1634. * @see install_configure_form_validate()
  1635. * @see install_configure_form_submit()
  1636. * @ingroup forms
  1637. */
  1638. function _install_configure_form($form, &$form_state, &$install_state) {
  1639. include_once DRUPAL_ROOT . '/includes/locale.inc';
  1640. $form['site_information'] = array(
  1641. '#type' => 'fieldset',
  1642. '#title' => st('Site information'),
  1643. '#collapsible' => FALSE,
  1644. );
  1645. $form['site_information']['site_name'] = array(
  1646. '#type' => 'textfield',
  1647. '#title' => st('Site name'),
  1648. '#required' => TRUE,
  1649. '#weight' => -20,
  1650. );
  1651. $form['site_information']['site_mail'] = array(
  1652. '#type' => 'textfield',
  1653. '#title' => st('Site e-mail address'),
  1654. '#default_value' => ini_get('sendmail_from'),
  1655. '#description' => st("Automated e-mails, such as registration information, will be sent from this address. Use an address ending in your site's domain to help prevent these e-mails from being flagged as spam."),
  1656. '#required' => TRUE,
  1657. '#weight' => -15,
  1658. );
  1659. $form['admin_account'] = array(
  1660. '#type' => 'fieldset',
  1661. '#title' => st('Site maintenance account'),
  1662. '#collapsible' => FALSE,
  1663. );
  1664. $form['admin_account']['account']['#tree'] = TRUE;
  1665. $form['admin_account']['account']['name'] = array('#type' => 'textfield',
  1666. '#title' => st('Username'),
  1667. '#maxlength' => USERNAME_MAX_LENGTH,
  1668. '#description' => st('Spaces are allowed; punctuation is not allowed except for periods, hyphens, and underscores.'),
  1669. '#required' => TRUE,
  1670. '#weight' => -10,
  1671. '#attributes' => array('class' => array('username')),
  1672. );
  1673. $form['admin_account']['account']['mail'] = array('#type' => 'textfield',
  1674. '#title' => st('E-mail address'),
  1675. '#maxlength' => EMAIL_MAX_LENGTH,
  1676. '#required' => TRUE,
  1677. '#weight' => -5,
  1678. );
  1679. $form['admin_account']['account']['pass'] = array(
  1680. '#type' => 'password_confirm',
  1681. '#required' => TRUE,
  1682. '#size' => 25,
  1683. '#weight' => 0,
  1684. );
  1685. $form['server_settings'] = array(
  1686. '#type' => 'fieldset',
  1687. '#title' => st('Server settings'),
  1688. '#collapsible' => FALSE,
  1689. );
  1690. $countries = country_get_list();
  1691. $form['server_settings']['site_default_country'] = array(
  1692. '#type' => 'select',
  1693. '#title' => st('Default country'),
  1694. '#empty_value' => '',
  1695. '#default_value' => variable_get('site_default_country', NULL),
  1696. '#options' => $countries,
  1697. '#description' => st('Select the default country for the site.'),
  1698. '#weight' => 0,
  1699. );
  1700. $form['server_settings']['date_default_timezone'] = array(
  1701. '#type' => 'select',
  1702. '#title' => st('Default time zone'),
  1703. '#default_value' => date_default_timezone_get(),
  1704. '#options' => system_time_zones(),
  1705. '#description' => st('By default, dates in this site will be displayed in the chosen time zone.'),
  1706. '#weight' => 5,
  1707. '#attributes' => array('class' => array('timezone-detect')),
  1708. );
  1709. $form['server_settings']['clean_url'] = array(
  1710. '#type' => 'hidden',
  1711. '#default_value' => 0,
  1712. '#attributes' => array('id' => 'edit-clean-url', 'class' => array('install')),
  1713. );
  1714. $form['update_notifications'] = array(
  1715. '#type' => 'fieldset',
  1716. '#title' => st('Update notifications'),
  1717. '#collapsible' => FALSE,
  1718. );
  1719. $form['update_notifications']['update_status_module'] = array(
  1720. '#type' => 'checkboxes',
  1721. '#options' => array(
  1722. 1 => st('Check for updates automatically'),
  1723. 2 => st('Receive e-mail notifications'),
  1724. ),
  1725. '#default_value' => array(1, 2),
  1726. '#description' => st('The system will notify you when updates and important security releases are available for installed components. Anonymous information about your site is sent to <a href="@drupal">Drupal.org</a>.', array('@drupal' => 'http://drupal.org')),
  1727. '#weight' => 15,
  1728. );
  1729. $form['actions'] = array('#type' => 'actions');
  1730. $form['actions']['submit'] = array(
  1731. '#type' => 'submit',
  1732. '#value' => st('Save and continue'),
  1733. '#weight' => 15,
  1734. );
  1735. return $form;
  1736. }
  1737. /**
  1738. * Form validation handler for install_configure_form().
  1739. *
  1740. * @see install_configure_form_submit()
  1741. */
  1742. function install_configure_form_validate($form, &$form_state) {
  1743. if ($error = user_validate_name($form_state['values']['account']['name'])) {
  1744. form_error($form['admin_account']['account']['name'], $error);
  1745. }
  1746. if ($error = user_validate_mail($form_state['values']['account']['mail'])) {
  1747. form_error($form['admin_account']['account']['mail'], $error);
  1748. }
  1749. if ($error = user_validate_mail($form_state['values']['site_mail'])) {
  1750. form_error($form['site_information']['site_mail'], $error);
  1751. }
  1752. }
  1753. /**
  1754. * Form submission handler for install_configure_form().
  1755. *
  1756. * @see install_configure_form_validate()
  1757. */
  1758. function install_configure_form_submit($form, &$form_state) {
  1759. global $user;
  1760. variable_set('site_name', $form_state['values']['site_name']);
  1761. variable_set('site_mail', $form_state['values']['site_mail']);
  1762. variable_set('date_default_timezone', $form_state['values']['date_default_timezone']);
  1763. variable_set('site_default_country', $form_state['values']['site_default_country']);
  1764. // Enable update.module if this option was selected.
  1765. if ($form_state['values']['update_status_module'][1]) {
  1766. module_enable(array('update'), FALSE);
  1767. // Add the site maintenance account's email address to the list of
  1768. // addresses to be notified when updates are available, if selected.
  1769. if ($form_state['values']['update_status_module'][2]) {
  1770. variable_set('update_notify_emails', array($form_state['values']['account']['mail']));
  1771. }
  1772. }
  1773. // We precreated user 1 with placeholder values. Let's save the real values.
  1774. $account = user_load(1);
  1775. $merge_data = array('init' => $form_state['values']['account']['mail'], 'roles' => !empty($account->roles) ? $account->roles : array(), 'status' => 1, 'timezone' => $form_state['values']['date_default_timezone']);
  1776. user_save($account, array_merge($form_state['values']['account'], $merge_data));
  1777. // Load global $user and perform final login tasks.
  1778. $user = user_load(1);
  1779. user_login_finalize();
  1780. if (isset($form_state['values']['clean_url'])) {
  1781. variable_set('clean_url', $form_state['values']['clean_url']);
  1782. }
  1783. // Record when this install ran.
  1784. variable_set('install_time', $_SERVER['REQUEST_TIME']);
  1785. }

Functions

Namesort descending Description
install_already_done_error Indicates that Drupal has already been installed.
install_begin_request Begins an installation request, modifying the installation state as needed.
install_bootstrap_full Performs a full bootstrap of Drupal during installation.
install_check_requirements Checks installation requirements and reports any errors.
install_configure_form Form constructor for a form to configure the new site.
install_configure_form_submit Form submission handler for install_configure_form().
install_configure_form_validate Form validation handler for install_configure_form().
install_database_errors Checks a database connection and returns any errors.
install_display_output Displays themed installer output and ends the page request.
install_drupal Installs Drupal either interactively or via an array of passed-in settings.
install_find_locales Find all .po files for the current profile.
install_find_profiles Finds all .profile files.
install_finished Finishes importing files at end of installation.
install_full_redirect_url Returns the complete URL redirected to during an installation request.
install_import_locales Imports languages via a batch process during installation.
install_import_locales_remaining Installation task; import remaining languages via a batch process.
install_load_profile Loads information about the chosen profile during installation.
install_no_profile_error Indicates that there are no profiles available.
install_profile_modules Installs required modules via a batch process.
install_redirect_url Returns the URL that should be redirected to during an installation request.
install_run_task Runs an individual installation task.
install_run_tasks Runs all tasks for the current installation request.
install_select_locale Installation task; select which locale to use for the current profile.
install_select_locale_form Form constructor for the language selection form.
install_select_profile Selects which profile to install.
install_select_profile_form Form constructor for the profile selection form.
install_settings_form Form constructor for a form to configure and rewrite settings.php.
install_settings_form_submit Form submission handler for install_settings_form().
install_settings_form_validate Form validation handler for install_settings_form().
install_state_defaults Returns an array of default settings for the global installation state.
install_system_module Installation task; install the Drupal system module.
install_tasks Returns a list of all tasks the installer currently knows about.
install_tasks_to_display Returns a list of tasks that should be displayed to the end user.
install_tasks_to_perform Returns a list of tasks to perform during the current installation request.
install_verify_completed_task Verifies and returns the last installation task that was completed.
install_verify_pdo Verifies the PDO library.
install_verify_requirements Verifies the requirements for installing Drupal.
install_verify_settings Verifies the existing settings in settings.php.
_install_configure_form Form constructor for a site configuration form.
_install_module_batch Implements callback_batch_operation().
_install_profile_modules_finished Implements callback_batch_finished().
_install_select_profile Selects an installation profile.

Constants

Namesort descending Description
INSTALL_TASK_RUN_IF_NOT_COMPLETED Global flag to indicate that a task should be run on each installation request that reaches it, until the database is set up and we are able to record the fact that it already ran.
INSTALL_TASK_RUN_IF_REACHED Run the task on each installation request until the database is set up.
INSTALL_TASK_SKIP Do not run the task during the current installation request.