MDL-28655 qtype_calculated question engine upgrade: fix return value
[moodle.git] / install.php
blob3ff618b0b47b2762c7da89718c4813e31a0dc952
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 // GNU General Public License for more details.
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
18 /**
19 * This script creates config.php file during installation.
21 * @package core
22 * @subpackage install
23 * @copyright 2009 Petr Skoda (http://skodak.org)
24 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27 if (isset($_REQUEST['lang'])) {
28 $lang = preg_replace('/[^A-Za-z0-9_-]/i', '', $_REQUEST['lang']);
29 } else {
30 $lang = 'en';
33 if (isset($_REQUEST['admin'])) {
34 $admin = preg_replace('/[^A-Za-z0-9_-]/i', '', $_REQUEST['admin']);
35 } else {
36 $admin = 'admin';
39 // If config.php exists we just created config.php and need to redirect to continue installation
40 $configfile = './config.php';
41 if (file_exists($configfile)) {
42 header("Location: $admin/index.php?lang=$lang");
43 die;
46 define('CLI_SCRIPT', false); // prevents some warnings later
47 define('AJAX_SCRIPT', false); // prevents some warnings later
49 // Servers should define a default timezone in php.ini, but if they don't then make sure something is defined.
50 // This is a quick hack. Ideally we should ask the admin for a value. See MDL-22625 for more on this.
51 if (function_exists('date_default_timezone_set') and function_exists('date_default_timezone_get')) {
52 @date_default_timezone_set(@date_default_timezone_get());
55 // make sure PHP errors are displayed - helps with diagnosing of problems
56 @error_reporting(E_ALL);
57 @ini_set('display_errors', '1');
59 // Check that PHP is of a sufficient version
60 // PHP 5.2.0 is intentionally checked here even though a higher version is required by the environment
61 // check. This is not a typo - see MDL-18112
62 if (version_compare(phpversion(), "5.2.0") < 0) {
63 $phpversion = phpversion();
64 // do NOT localise - lang strings would not work here and we CAN not move it after installib
65 echo "Sorry, Moodle 2.0 requires PHP 5.2.8 or later (currently using version $phpversion).<br />";
66 echo "Please upgrade your server software or install latest Moodle 1.9.x instead.";
67 die;
70 if (PHP_INT_SIZE > 4) {
71 // most probably 64bit PHP - we need a lot more memory
72 $minrequiredmemory = '70M';
73 } else {
74 // 32bit PHP
75 $minrequiredmemory = '40M';
77 // increase or decrease available memory - we need to make sure moodle
78 // installs even with low memory, otherwise developers would overlook
79 // sudden increases of memory needs ;-)
80 @ini_set('memory_limit', $minrequiredmemory);
82 /** Used by library scripts to check they are being called by Moodle */
83 define('MOODLE_INTERNAL', true);
85 require dirname(__FILE__).'/lib/installlib.php';
87 // TODO: add lang detection here if empty $_REQUEST['lang']
89 // distro specific customisation
90 $distro = null;
91 if (file_exists('install/distrolib.php')) {
92 require_once('install/distrolib.php');
93 if (function_exists('distro_get_config')) {
94 $distro = distro_get_config();
98 $config = new stdClass();
99 $config->lang = $lang;
101 if (!empty($_POST)) {
102 if (install_ini_get_bool('magic_quotes_gpc')) {
103 $_POST = array_map('stripslashes', $_POST);
106 $config->stage = (int)$_POST['stage'];
108 if (isset($_POST['previous'])) {
109 $config->stage--;
110 if (INSTALL_DATABASETYPE and !empty($distro->dbtype)) {
111 $config->stage--;
113 if ($config->stage == INSTALL_ENVIRONMENT or $config->stage == INSTALL_DOWNLOADLANG) {
114 $config->stage--;
116 } else if (isset($_POST['next'])) {
117 $config->stage++;
120 $config->dbtype = trim($_POST['dbtype']);
121 $config->dbhost = trim($_POST['dbhost']);
122 $config->dbuser = trim($_POST['dbuser']);
123 $config->dbpass = trim($_POST['dbpass']);
124 $config->dbname = trim($_POST['dbname']);
125 $config->prefix = trim($_POST['prefix']);
126 $config->dbsocket = (int)(!empty($_POST['dbsocket']));
128 $config->admin = empty($_POST['admin']) ? 'admin' : trim($_POST['admin']);
130 $config->dataroot = trim($_POST['dataroot']);
132 } else {
133 $config->stage = INSTALL_WELCOME;
135 $config->dbtype = empty($distro->dbtype) ? '' : $distro->dbtype; // let distro skip dbtype selection
136 $config->dbhost = empty($distro->dbhost) ? 'localhost' : $distro->dbhost; // let distros set dbhost
137 $config->dbuser = empty($distro->dbuser) ? '' : $distro->dbuser; // let distros set dbuser
138 $config->dbpass = '';
139 $config->dbname = 'moodle';
140 $config->prefix = 'mdl_';
141 $config->dbsocket = 0;
143 $config->admin = 'admin';
145 $config->dataroot = empty($distro->dataroot) ? null : $distro->dataroot; // initialised later after including libs or by distro
148 // Fake some settings so that we can use selected functions from moodlelib.php and weblib.php
149 $CFG = new stdClass();
150 $CFG->lang = $config->lang;
151 $CFG->dirroot = dirname(__FILE__);
152 $CFG->libdir = "$CFG->dirroot/lib";
153 $CFG->wwwroot = install_guess_wwwroot(); // can not be changed - ppl must use the real address when installing
154 $CFG->httpswwwroot = $CFG->wwwroot;
155 $CFG->dataroot = $config->dataroot;
156 $CFG->admin = $config->admin;
157 $CFG->docroot = 'http://docs.moodle.org';
158 $CFG->langotherroot = $CFG->dataroot.'/lang';
159 $CFG->langlocalroot = $CFG->dataroot.'/lang';
160 $CFG->directorypermissions = 00777;
161 $CFG->running_installer = true;
162 $CFG->early_install_lang = true;
164 // Require all needed libs
165 require_once($CFG->libdir.'/setuplib.php');
167 // we need to make sure we have enough memory to load all libraries
168 $memlimit = @ini_get('memory_limit');
169 if (!empty($memlimit) and $memlimit != -1) {
170 if (get_real_size($memlimit) < get_real_size($minrequiredmemory)) {
171 // do NOT localise - lang strings would not work here and we CAN not move it to later place
172 echo "Sorry, Moodle 2.0 requires at least {$minrequiredmemory}B of PHP memory.<br />";
173 echo "Please contact server administrator to fix PHP.ini memory settings.";
174 die;
178 // Continue with lib loading
179 require_once($CFG->libdir.'/textlib.class.php');
180 require_once($CFG->libdir.'/weblib.php');
181 require_once($CFG->libdir.'/outputlib.php');
182 require_once($CFG->libdir.'/dmllib.php');
183 require_once($CFG->libdir.'/moodlelib.php');
184 require_once($CFG->libdir .'/pagelib.php');
185 require_once($CFG->libdir.'/deprecatedlib.php');
186 require_once($CFG->libdir.'/adminlib.php');
187 require_once($CFG->libdir.'/environmentlib.php');
188 require_once($CFG->libdir.'/componentlib.class.php');
190 //point pear include path to moodles lib/pear so that includes and requires will search there for files before anywhere else
191 //the problem is that we need specific version of quickforms and hacked excel files :-(
192 ini_set('include_path', $CFG->libdir.'/pear' . PATH_SEPARATOR . ini_get('include_path'));
193 //point zend include path to moodles lib/zend so that includes and requires will search there for files before anywhere else
194 ini_set('include_path', $CFG->libdir.'/zend' . PATH_SEPARATOR . ini_get('include_path'));
196 require('version.php');
197 $CFG->target_release = $release;
199 $SESSION = new stdClass();
200 $SESSION->lang = $CFG->lang;
202 $USER = new stdClass();
203 $USER->id = 0;
205 $COURSE = new stdClass();
206 $COURSE->id = 0;
208 $SITE = $COURSE;
209 define('SITEID', 0);
211 $hint_dataroot = '';
212 $hint_admindir = '';
213 $hint_database = '';
215 // Are we in help mode?
216 if (isset($_GET['help'])) {
217 install_print_help_page($_GET['help']);
220 //first time here? find out suitable dataroot
221 if (is_null($CFG->dataroot)) {
222 $CFG->dataroot = dirname(dirname(__FILE__)).DIRECTORY_SEPARATOR.'moodledata';
224 $i = 0; //safety check - dirname might return some unexpected results
225 while(is_dataroot_insecure()) {
226 $parrent = dirname($CFG->dataroot);
227 $i++;
228 if ($parrent == '/' or $parrent == '.' or preg_match('/^[a-z]:\\\?$/i', $parrent) or ($i > 100)) {
229 $CFG->dataroot = ''; //can not find secure location for dataroot
230 break;
232 $CFG->dataroot = dirname($parrent).DIRECTORY_SEPARATOR.'moodledata';
234 $config->dataroot = $CFG->dataroot;
235 $config->stage = INSTALL_WELCOME;
238 // now let's do the stage work
239 if ($config->stage < INSTALL_WELCOME) {
240 $config->stage = INSTALL_WELCOME;
242 if ($config->stage > INSTALL_SAVE) {
243 $config->stage = INSTALL_SAVE;
248 if ($config->stage == INSTALL_SAVE) {
249 $CFG->early_install_lang = false;
251 $database = moodle_database::get_driver_instance($config->dbtype, 'native');
252 if (!$database->driver_installed()) {
253 $config->stage = INSTALL_DATABASETYPE;
254 } else {
255 if (function_exists('distro_pre_create_db')) { // Hook for distros needing to do something before DB creation
256 $distro = distro_pre_create_db($database, $config->dbhost, $config->dbuser, $config->dbpass, $config->dbname, $config->prefix, array('dbpersist'=>0, 'dbsocket'=>$config->dbsocket), $distro);
258 $hint_database = install_db_validate($database, $config->dbhost, $config->dbuser, $config->dbpass, $config->dbname, $config->prefix, array('dbpersist'=>0, 'dbsocket'=>$config->dbsocket));
260 if ($hint_database === '') {
261 $configphp = install_generate_configphp($database, $CFG);
263 umask(0137);
264 if (($fh = @fopen($configfile, 'w')) !== false) {
265 fwrite($fh, $configphp);
266 fclose($fh);
269 if (file_exists($configfile)) {
270 // config created, let's continue!
271 redirect("$CFG->wwwroot/$config->admin/index.php?lang=$config->lang");
274 install_print_header($config, 'config.php',
275 get_string('configurationcompletehead', 'install'),
276 get_string('configurationcompletesub', 'install').get_string('configfilenotwritten', 'install'));
277 echo '<div class="configphp"><pre>';
278 echo p($configphp);
279 echo '</pre></div>';
281 install_print_footer($config);
282 die;
284 } else {
285 $config->stage = INSTALL_DATABASE;
292 if ($config->stage == INSTALL_DOWNLOADLANG) {
293 if (empty($CFG->dataroot)) {
294 $config->stage = INSTALL_PATHS;
296 } else if (is_dataroot_insecure()) {
297 $hint_dataroot = get_string('pathsunsecuredataroot', 'install');
298 $config->stage = INSTALL_PATHS;
300 } else if (!file_exists($CFG->dataroot)) {
301 $a = new stdClass();
302 $a->parent = dirname($CFG->dataroot);
303 $a->dataroot = $CFG->dataroot;
304 if (!is_writable($a->parent)) {
305 $hint_dataroot = get_string('pathsroparentdataroot', 'install', $a);
306 $config->stage = INSTALL_PATHS;
307 } else {
308 if (!install_init_dataroot($CFG->dataroot, $CFG->directorypermissions)) {
309 $hint_dataroot = get_string('pathserrcreatedataroot', 'install', $a);
310 $config->stage = INSTALL_PATHS;
314 } else if (!install_init_dataroot($CFG->dataroot, $CFG->directorypermissions)) {
315 $hint_dataroot = get_string('pathserrcreatedataroot', 'install', array('dataroot' => $CFG->dataroot));
316 $config->stage = INSTALL_PATHS;
319 if (empty($hint_dataroot) and !is_writable($CFG->dataroot)) {
320 $hint_dataroot = get_string('pathsrodataroot', 'install');
321 $config->stage = INSTALL_PATHS;
324 if ($config->admin === '' or !file_exists($CFG->dirroot.'/'.$config->admin.'/environment.xml')) {
325 $hint_admindir = get_string('pathswrongadmindir', 'install');
326 $config->stage = INSTALL_PATHS;
332 if ($config->stage == INSTALL_DOWNLOADLANG) {
333 // no need to download anything if en lang selected
334 if ($CFG->lang == 'en') {
335 $config->stage = INSTALL_DATABASETYPE;
341 if ($config->stage == INSTALL_DATABASETYPE) {
342 // skip db selection if distro package supports only one db
343 if (!empty($distro->dbtype)) {
344 $config->stage = INSTALL_DATABASE;
349 if ($config->stage == INSTALL_DOWNLOADLANG) {
350 $downloaderror = '';
352 // download and install required lang packs, the lang dir has already been created in install_init_dataroot
353 $installer = new lang_installer($CFG->lang);
354 $results = $installer->run();
355 foreach ($results as $langcode => $langstatus) {
356 if ($langstatus === lang_installer::RESULT_DOWNLOADERROR) {
357 $a = new stdClass();
358 $a->url = $installer->lang_pack_url($langcode);
359 $a->dest = $CFG->dataroot.'/lang';
360 $downloaderror = get_string('remotedownloaderror', 'error', $a);
364 if ($downloaderror !== '') {
365 install_print_header($config, get_string('language'), get_string('langdownloaderror', 'install', $CFG->lang), $downloaderror);
366 install_print_footer($config);
367 die;
368 } else {
369 if (empty($distro->dbtype)) {
370 $config->stage = INSTALL_DATABASETYPE;
371 } else {
372 $config->stage = INSTALL_DATABASE;
376 // switch the string_manager instance to stop using install/lang/
377 $CFG->early_install_lang = false;
378 $CFG->langotherroot = $CFG->dataroot.'/lang';
379 $CFG->langlocalroot = $CFG->dataroot.'/lang';
380 get_string_manager(true);
384 if ($config->stage == INSTALL_DATABASE) {
385 $CFG->early_install_lang = false;
387 $database = moodle_database::get_driver_instance($config->dbtype, 'native');
389 $sub = '<h3>'.$database->get_name().'</h3>'.$database->get_configuration_help();
391 install_print_header($config, get_string('database', 'install'), get_string('databasehead', 'install'), $sub);
393 $strdbhost = get_string('databasehost', 'install');
394 $strdbname = get_string('databasename', 'install');
395 $strdbuser = get_string('databaseuser', 'install');
396 $strdbpass = get_string('databasepass', 'install');
397 $strprefix = get_string('dbprefix', 'install');
398 $strdbsocket = get_string('databasesocket', 'install');
400 echo '<div class="userinput">';
402 $disabled = empty($distro->dbhost) ? '' : 'disabled="disabled';
403 echo '<div class="formrow"><label for="id_dbhost" class="formlabel">'.$strdbhost.'</label>';
404 echo '<input id="id_dbhost" name="dbhost" '.$disabled.' type="text" value="'.s($config->dbhost).'" size="50" class="forminput" />';
405 echo '</div>';
407 echo '<div class="formrow"><label for="id_dbname" class="formlabel">'.$strdbname.'</label>';
408 echo '<input id="id_dbname" name="dbname" type="text" value="'.s($config->dbname).'" size="30" class="forminput" />';
409 echo '</div>';
411 $disabled = empty($distro->dbuser) ? '' : 'disabled="disabled';
412 echo '<div class="formrow"><label for="id_dbuser" class="formlabel">'.$strdbuser.'</label>';
413 echo '<input id="id_dbuser" name="dbuser" '.$disabled.' type="text" value="'.s($config->dbuser).'" size="30" class="forminput" />';
414 echo '</div>';
416 echo '<div class="formrow"><label for="id_dbpass" class="formlabel">'.$strdbpass.'</label>';
417 // no password field here, the password may be visible in config.php if we can not write it to disk
418 echo '<input id="id_dbpass" name="dbpass" type="text" value="'.s($config->dbpass).'" size="30" class="forminput" />';
419 echo '</div>';
421 echo '<div class="formrow"><label for="id_prefix" class="formlabel">'.$strprefix.'</label>';
422 echo '<input id="id_prefix" name="prefix" type="text" value="'.s($config->prefix).'" size="10" class="forminput" />';
423 echo '</div>';
425 if (!(stristr(PHP_OS, 'win') && !stristr(PHP_OS, 'darwin'))) {
426 $checked = $config->dbsocket ? 'checked="checked' : '';
427 echo '<div class="formrow"><label for="id_dbsocket" class="formlabel">'.$strdbsocket.'</label>';
428 echo '<input type="hidden" value="0" name="dbsocket" />';
429 echo '<input type="checkbox" id="id_dbsocket" value="1" name="dbsocket" '.$checked.' class="forminput" />';
430 echo '</div>';
433 echo '<div class="hint">'.$hint_database.'</div>';
434 echo '</div>';
435 install_print_footer($config);
436 die;
440 if ($config->stage == INSTALL_DATABASETYPE) {
441 $CFG->early_install_lang = false;
443 // Finally ask for DB type
444 install_print_header($config, get_string('database', 'install'),
445 get_string('databasetypehead', 'install'),
446 get_string('databasetypesub', 'install'));
448 $databases = array('mysqli' => moodle_database::get_driver_instance('mysqli', 'native'),
449 'pgsql' => moodle_database::get_driver_instance('pgsql', 'native'),
450 'oci' => moodle_database::get_driver_instance('oci', 'native'),
451 'sqlsrv' => moodle_database::get_driver_instance('sqlsrv', 'native'), // MS SQL*Server PHP driver
452 'mssql' => moodle_database::get_driver_instance('mssql', 'native'), // FreeTDS driver
455 echo '<div class="userinput">';
456 echo '<div class="formrow"><label class="formlabel" for="dbtype">'.get_string('dbtype', 'install').'</label>';
457 echo '<select id="dbtype" name="dbtype" class="forminput">';
458 $disabled = array();
459 $options = array();
460 foreach ($databases as $type=>$database) {
461 if ($database->driver_installed() !== true) {
462 $disabled[$type] = $database;
463 continue;
465 echo '<option value="'.s($type).'">'.$database->get_name().'</option>';
467 if ($disabled) {
468 echo '<optgroup label="'.s(get_string('notavailable')).'">';
469 foreach ($disabled as $type=>$database) {
470 echo '<option value="'.s($type).'" class="notavailable">'.$database->get_name().'</option>';
472 echo '</optgroup>';
474 echo '</select></div>';
475 echo '</div>';
477 install_print_footer($config);
478 die;
483 if ($config->stage == INSTALL_ENVIRONMENT or $config->stage == INSTALL_PATHS) {
484 $version_fail = (version_compare(phpversion(), "5.2.8") < 0);
485 $curl_fail = ($lang !== 'en' and !extension_loaded('curl')); // needed for lang pack download
486 $zip_fail = ($lang !== 'en' and !extension_loaded('zip')); // needed for lang pack download
488 if ($version_fail or $curl_fail or $zip_fail) {
489 $config->stage = INSTALL_ENVIRONMENT;
491 install_print_header($config, get_string('environmenthead', 'install'),
492 get_string('errorsinenvironment', 'install'),
493 get_string('environmentsub2', 'install'));
495 echo '<div id="envresult"><dl>';
496 if ($version_fail) {
497 $a = (object)array('needed'=>'5.2.8', 'current'=>phpversion());
498 echo '<dt>'.get_string('phpversion', 'install').'</dt><dd>'.get_string('environmentrequireversion', 'admin', $a).'</dd>';
500 if ($curl_fail) {
501 echo '<dt>'.get_string('phpextension', 'install', 'cURL').'</dt><dd>'.get_string('environmentrequireinstall', 'admin').'</dd>';
503 if ($zip_fail) {
504 echo '<dt>'.get_string('phpextension', 'install', 'Zip').'</dt><dd>'.get_string('environmentrequireinstall', 'admin').'</dd>';
506 echo '</dl></div>';
508 install_print_footer($config, true);
509 die;
511 } else {
512 $config->stage = INSTALL_PATHS;
518 if ($config->stage == INSTALL_PATHS) {
519 $paths = array('wwwroot' => get_string('wwwroot', 'install'),
520 'dirroot' => get_string('dirroot', 'install'),
521 'dataroot' => get_string('dataroot', 'install'));
523 $sub = '<dl>';
524 foreach ($paths as $path=>$name) {
525 $sub .= '<dt>'.$name.'</dt><dd>'.get_string('pathssub'.$path, 'install').'</dd>';
527 if (!file_exists("$CFG->dirroot/admin/environment.xml")) {
528 $sub .= '<dt>'.get_string('admindirname', 'install').'</dt><dd>'.get_string('pathssubadmindir', 'install').'</dd>';
530 $sub .= '</dl>';
532 install_print_header($config, get_string('paths', 'install'), get_string('pathshead', 'install'), $sub);
534 $strwwwroot = get_string('wwwroot', 'install');
535 $strdirroot = get_string('dirroot', 'install');
536 $strdataroot = get_string('dataroot', 'install');
537 $stradmindirname = get_string('admindirname', 'install');
539 echo '<div class="userinput">';
540 echo '<div class="formrow"><label for="id_wwwroot" class="formlabel">'.$paths['wwwroot'].'</label>';
541 echo '<input id="id_wwwroot" name="wwwroot" type="text" value="'.s($CFG->wwwroot).'" disabled="disabled" size="70" class="forminput" />';
542 echo '</div>';
544 echo '<div class="formrow"><label for="id_dirroot" class="formlabel">'.$paths['dirroot'].'</label>';
545 echo '<input id="id_dirroot" name="dirroot" type="text" value="'.s($CFG->dirroot).'" disabled="disabled" size="70"class="forminput" />';
546 echo '</div>';
548 echo '<div class="formrow"><label for="id_dataroot" class="formlabel">'.$paths['dataroot'].'</label>';
549 echo '<input id="id_dataroot" name="dataroot" type="text" value="'.s($config->dataroot).'" size="70" class="forminput" />';
550 if ($hint_dataroot !== '') {
551 echo '<div class="hint">'.$hint_dataroot.'</div>';
553 echo '</div>';
556 if (!file_exists("$CFG->dirroot/admin/environment.xml")) {
557 echo '<div class="formrow"><label for="id_admin" class="formlabel">'.$paths['admindir'].'</label>';
558 echo '<input id="id_admin" name="admin" type="text" value="'.s($config->admin).'" size="10" class="forminput" />';
559 if ($hint_admindir !== '') {
560 echo '<div class="hint">'.$hint_admindir.'</div>';
562 echo '</div>';
565 echo '</div>';
567 install_print_footer($config);
568 die;
573 $config->stage = INSTALL_WELCOME;
575 if ($distro) {
576 ob_start();
577 include('install/distribution.html');
578 $sub = ob_get_clean();
580 install_print_header($config, get_string('language'),
581 get_string('chooselanguagehead', 'install'),
582 $sub);
584 } else {
585 install_print_header($config, get_string('language'),
586 get_string('chooselanguagehead', 'install'),
587 get_string('chooselanguagesub', 'install'));
590 $languages = get_string_manager()->get_list_of_translations();
591 echo '<div class="userinput">';
592 echo '<div class="formrow"><label class="formlabel" for="langselect">'.get_string('language').'</label>';
593 echo '<select id="langselect" name="lang" class="forminput" onchange="this.form.submit()">';
594 foreach ($languages as $name=>$value) {
595 $selected = ($name == $CFG->lang) ? 'selected="selected"' : '';
596 echo '<option value="'.s($name).'" '.$selected.'>'.$value.'</option>';
598 echo '</select></div>';
599 echo '</div>';
601 install_print_footer($config);
602 die;