3 // This file is part of Moodle - http://moodle.org/
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.
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/>.
19 * This script creates config.php file during installation.
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']);
33 if (isset($_REQUEST['admin'])) {
34 $admin = preg_replace('/[^A-Za-z0-9_-]/i', '', $_REQUEST['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");
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 "Moodle 2.1 or later requires at least PHP 5.3.2 (currently using version $phpversion).<br />";
66 echo "Please upgrade your server software or install older Moodle version.";
70 // make sure iconv is available and actually works
71 if (!function_exists('iconv')) {
72 // this should not happen, this must be very borked install
73 echo 'Moodle requires the iconv PHP extension. Please install or enable the iconv extension.';
76 if (iconv('UTF-8', 'UTF-8//IGNORE', 'abc') !== 'abc') {
77 // known to be broken in mid-2011 MAMP installations
78 echo 'Broken iconv PHP extension detected, installation can not continue.';
82 if (PHP_INT_SIZE > 4) {
83 // most probably 64bit PHP - we need a lot more memory
84 $minrequiredmemory = '70M';
87 $minrequiredmemory = '40M';
89 // increase or decrease available memory - we need to make sure moodle
90 // installs even with low memory, otherwise developers would overlook
91 // sudden increases of memory needs ;-)
92 @ini_set('memory_limit', $minrequiredmemory);
94 /** Used by library scripts to check they are being called by Moodle */
95 define('MOODLE_INTERNAL', true);
97 require dirname(__FILE__).'/lib/installlib.php';
99 // TODO: add lang detection here if empty $_REQUEST['lang']
101 // distro specific customisation
103 if (file_exists('install/distrolib.php')) {
104 require_once('install/distrolib.php');
105 if (function_exists('distro_get_config')) {
106 $distro = distro_get_config();
110 $config = new stdClass();
111 $config->lang = $lang;
113 if (!empty($_POST)) {
114 if (install_ini_get_bool('magic_quotes_gpc')) {
115 $_POST = array_map('stripslashes', $_POST);
118 $config->stage = (int)$_POST['stage'];
120 if (isset($_POST['previous'])) {
122 if (INSTALL_DATABASETYPE and !empty($distro->dbtype)) {
125 if ($config->stage == INSTALL_ENVIRONMENT or $config->stage == INSTALL_DOWNLOADLANG) {
128 } else if (isset($_POST['next'])) {
132 $config->dbtype = trim($_POST['dbtype']);
133 $config->dbhost = trim($_POST['dbhost']);
134 $config->dbuser = trim($_POST['dbuser']);
135 $config->dbpass = trim($_POST['dbpass']);
136 $config->dbname = trim($_POST['dbname']);
137 $config->prefix = trim($_POST['prefix']);
138 $config->dbsocket = (int)(!empty($_POST['dbsocket']));
140 $config->admin = empty($_POST['admin']) ? 'admin' : trim($_POST['admin']);
142 $config->dataroot = trim($_POST['dataroot']);
145 $config->stage = INSTALL_WELCOME;
147 $config->dbtype = empty($distro->dbtype) ? '' : $distro->dbtype; // let distro skip dbtype selection
148 $config->dbhost = empty($distro->dbhost) ? 'localhost' : $distro->dbhost; // let distros set dbhost
149 $config->dbuser = empty($distro->dbuser) ? '' : $distro->dbuser; // let distros set dbuser
150 $config->dbpass = '';
151 $config->dbname = 'moodle';
152 $config->prefix = 'mdl_';
153 $config->dbsocket = 0;
155 $config->admin = 'admin';
157 $config->dataroot = empty($distro->dataroot) ? null : $distro->dataroot; // initialised later after including libs or by distro
160 // Fake some settings so that we can use selected functions from moodlelib.php and weblib.php
161 $CFG = new stdClass();
162 $CFG->lang = $config->lang;
163 $CFG->dirroot = dirname(__FILE__);
164 $CFG->libdir = "$CFG->dirroot/lib";
165 $CFG->wwwroot = install_guess_wwwroot(); // can not be changed - ppl must use the real address when installing
166 $CFG->httpswwwroot = $CFG->wwwroot;
167 $CFG->dataroot = $config->dataroot;
168 $CFG->admin = $config->admin;
169 $CFG->docroot = 'http://docs.moodle.org';
170 $CFG->langotherroot = $CFG->dataroot.'/lang';
171 $CFG->langlocalroot = $CFG->dataroot.'/lang';
172 $CFG->directorypermissions = isset($distro->directorypermissions) ? $distro->directorypermissions : 00777; // let distros set dir permissions
173 $CFG->running_installer = true;
174 $CFG->early_install_lang = true;
176 // Require all needed libs
177 require_once($CFG->libdir.'/setuplib.php');
179 // we need to make sure we have enough memory to load all libraries
180 $memlimit = @ini_get('memory_limit');
181 if (!empty($memlimit) and $memlimit != -1) {
182 if (get_real_size($memlimit) < get_real_size($minrequiredmemory)) {
183 // do NOT localise - lang strings would not work here and we CAN not move it to later place
184 echo "Moodle requires at least {$minrequiredmemory}B of PHP memory.<br />";
185 echo "Please contact server administrator to fix PHP.ini memory settings.";
190 // Continue with lib loading
191 require_once($CFG->libdir.'/textlib.class.php');
192 require_once($CFG->libdir.'/weblib.php');
193 require_once($CFG->libdir.'/outputlib.php');
194 require_once($CFG->libdir.'/dmllib.php');
195 require_once($CFG->libdir.'/moodlelib.php');
196 require_once($CFG->libdir .'/pagelib.php');
197 require_once($CFG->libdir.'/deprecatedlib.php');
198 require_once($CFG->libdir.'/adminlib.php');
199 require_once($CFG->libdir.'/environmentlib.php');
200 require_once($CFG->libdir.'/componentlib.class.php');
202 //point pear include path to moodles lib/pear so that includes and requires will search there for files before anywhere else
203 //the problem is that we need specific version of quickforms and hacked excel files :-(
204 ini_set('include_path', $CFG->libdir.'/pear' . PATH_SEPARATOR . ini_get('include_path'));
205 //point zend include path to moodles lib/zend so that includes and requires will search there for files before anywhere else
206 ini_set('include_path', $CFG->libdir.'/zend' . PATH_SEPARATOR . ini_get('include_path'));
208 require('version.php');
209 $CFG->target_release = $release;
211 $SESSION = new stdClass();
212 $SESSION->lang = $CFG->lang;
214 $USER = new stdClass();
217 $COURSE = new stdClass();
227 // Are we in help mode?
228 if (isset($_GET['help'])) {
229 install_print_help_page($_GET['help']);
232 //first time here? find out suitable dataroot
233 if (is_null($CFG->dataroot)) {
234 $CFG->dataroot = dirname(dirname(__FILE__)).DIRECTORY_SEPARATOR.'moodledata';
236 $i = 0; //safety check - dirname might return some unexpected results
237 while(is_dataroot_insecure()) {
238 $parrent = dirname($CFG->dataroot);
240 if ($parrent == '/' or $parrent == '.' or preg_match('/^[a-z]:\\\?$/i', $parrent) or ($i > 100)) {
241 $CFG->dataroot = ''; //can not find secure location for dataroot
244 $CFG->dataroot = dirname($parrent).DIRECTORY_SEPARATOR.'moodledata';
246 $config->dataroot = $CFG->dataroot;
247 $config->stage = INSTALL_WELCOME;
250 // now let's do the stage work
251 if ($config->stage < INSTALL_WELCOME) {
252 $config->stage = INSTALL_WELCOME;
254 if ($config->stage > INSTALL_SAVE) {
255 $config->stage = INSTALL_SAVE;
260 if ($config->stage == INSTALL_SAVE) {
261 $CFG->early_install_lang = false;
263 $database = moodle_database::get_driver_instance($config->dbtype, 'native');
264 if (!$database->driver_installed()) {
265 $config->stage = INSTALL_DATABASETYPE;
267 if (function_exists('distro_pre_create_db')) { // Hook for distros needing to do something before DB creation
268 $distro = distro_pre_create_db($database, $config->dbhost, $config->dbuser, $config->dbpass, $config->dbname, $config->prefix, array('dbpersist'=>0, 'dbsocket'=>$config->dbsocket), $distro);
270 $hint_database = install_db_validate($database, $config->dbhost, $config->dbuser, $config->dbpass, $config->dbname, $config->prefix, array('dbpersist'=>0, 'dbsocket'=>$config->dbsocket));
272 if ($hint_database === '') {
273 $configphp = install_generate_configphp($database, $CFG);
276 if (($fh = @fopen($configfile, 'w')) !== false) {
277 fwrite($fh, $configphp);
281 if (file_exists($configfile)) {
282 // config created, let's continue!
283 redirect("$CFG->wwwroot/$config->admin/index.php?lang=$config->lang");
286 install_print_header($config, 'config.php',
287 get_string('configurationcompletehead', 'install'),
288 get_string('configurationcompletesub', 'install').get_string('configfilenotwritten', 'install'));
289 echo '<div class="configphp"><pre>';
293 install_print_footer($config);
297 $config->stage = INSTALL_DATABASE;
304 if ($config->stage == INSTALL_DOWNLOADLANG) {
305 if (empty($CFG->dataroot)) {
306 $config->stage = INSTALL_PATHS;
308 } else if (is_dataroot_insecure()) {
309 $hint_dataroot = get_string('pathsunsecuredataroot', 'install');
310 $config->stage = INSTALL_PATHS;
312 } else if (!file_exists($CFG->dataroot)) {
314 $a->parent = dirname($CFG->dataroot);
315 $a->dataroot = $CFG->dataroot;
316 if (!is_writable($a->parent)) {
317 $hint_dataroot = get_string('pathsroparentdataroot', 'install', $a);
318 $config->stage = INSTALL_PATHS;
320 if (!install_init_dataroot($CFG->dataroot, $CFG->directorypermissions)) {
321 $hint_dataroot = get_string('pathserrcreatedataroot', 'install', $a);
322 $config->stage = INSTALL_PATHS;
326 } else if (!install_init_dataroot($CFG->dataroot, $CFG->directorypermissions)) {
327 $hint_dataroot = get_string('pathserrcreatedataroot', 'install', array('dataroot' => $CFG->dataroot));
328 $config->stage = INSTALL_PATHS;
331 if (empty($hint_dataroot) and !is_writable($CFG->dataroot)) {
332 $hint_dataroot = get_string('pathsrodataroot', 'install');
333 $config->stage = INSTALL_PATHS;
336 if ($config->admin === '' or !file_exists($CFG->dirroot.'/'.$config->admin.'/environment.xml')) {
337 $hint_admindir = get_string('pathswrongadmindir', 'install');
338 $config->stage = INSTALL_PATHS;
344 if ($config->stage == INSTALL_DOWNLOADLANG) {
345 // no need to download anything if en lang selected
346 if ($CFG->lang == 'en') {
347 $config->stage = INSTALL_DATABASETYPE;
353 if ($config->stage == INSTALL_DATABASETYPE) {
354 // skip db selection if distro package supports only one db
355 if (!empty($distro->dbtype)) {
356 $config->stage = INSTALL_DATABASE;
361 if ($config->stage == INSTALL_DOWNLOADLANG) {
364 // download and install required lang packs, the lang dir has already been created in install_init_dataroot
365 $installer = new lang_installer($CFG->lang);
366 $results = $installer->run();
367 foreach ($results as $langcode => $langstatus) {
368 if ($langstatus === lang_installer::RESULT_DOWNLOADERROR) {
370 $a->url = $installer->lang_pack_url($langcode);
371 $a->dest = $CFG->dataroot.'/lang';
372 $downloaderror = get_string('remotedownloaderror', 'error', $a);
376 if ($downloaderror !== '') {
377 install_print_header($config, get_string('language'), get_string('langdownloaderror', 'install', $CFG->lang), $downloaderror);
378 install_print_footer($config);
381 if (empty($distro->dbtype)) {
382 $config->stage = INSTALL_DATABASETYPE;
384 $config->stage = INSTALL_DATABASE;
388 // switch the string_manager instance to stop using install/lang/
389 $CFG->early_install_lang = false;
390 $CFG->langotherroot = $CFG->dataroot.'/lang';
391 $CFG->langlocalroot = $CFG->dataroot.'/lang';
392 get_string_manager(true);
396 if ($config->stage == INSTALL_DATABASE) {
397 $CFG->early_install_lang = false;
399 $database = moodle_database::get_driver_instance($config->dbtype, 'native');
401 $sub = '<h3>'.$database->get_name().'</h3>'.$database->get_configuration_help();
403 install_print_header($config, get_string('database', 'install'), get_string('databasehead', 'install'), $sub);
405 $strdbhost = get_string('databasehost', 'install');
406 $strdbname = get_string('databasename', 'install');
407 $strdbuser = get_string('databaseuser', 'install');
408 $strdbpass = get_string('databasepass', 'install');
409 $strprefix = get_string('dbprefix', 'install');
410 $strdbsocket = get_string('databasesocket', 'install');
412 echo '<div class="userinput">';
414 $disabled = empty($distro->dbhost) ? '' : 'disabled="disabled';
415 echo '<div class="formrow"><label for="id_dbhost" class="formlabel">'.$strdbhost.'</label>';
416 echo '<input id="id_dbhost" name="dbhost" '.$disabled.' type="text" value="'.s($config->dbhost).'" size="50" class="forminput" />';
419 echo '<div class="formrow"><label for="id_dbname" class="formlabel">'.$strdbname.'</label>';
420 echo '<input id="id_dbname" name="dbname" type="text" value="'.s($config->dbname).'" size="30" class="forminput" />';
423 $disabled = empty($distro->dbuser) ? '' : 'disabled="disabled';
424 echo '<div class="formrow"><label for="id_dbuser" class="formlabel">'.$strdbuser.'</label>';
425 echo '<input id="id_dbuser" name="dbuser" '.$disabled.' type="text" value="'.s($config->dbuser).'" size="30" class="forminput" />';
428 echo '<div class="formrow"><label for="id_dbpass" class="formlabel">'.$strdbpass.'</label>';
429 // no password field here, the password may be visible in config.php if we can not write it to disk
430 echo '<input id="id_dbpass" name="dbpass" type="text" value="'.s($config->dbpass).'" size="30" class="forminput" />';
433 echo '<div class="formrow"><label for="id_prefix" class="formlabel">'.$strprefix.'</label>';
434 echo '<input id="id_prefix" name="prefix" type="text" value="'.s($config->prefix).'" size="10" class="forminput" />';
437 if (!(stristr(PHP_OS, 'win') && !stristr(PHP_OS, 'darwin'))) {
438 $checked = $config->dbsocket ? 'checked="checked' : '';
439 echo '<div class="formrow"><label for="id_dbsocket" class="formlabel">'.$strdbsocket.'</label>';
440 echo '<input type="hidden" value="0" name="dbsocket" />';
441 echo '<input type="checkbox" id="id_dbsocket" value="1" name="dbsocket" '.$checked.' class="forminput" />';
445 echo '<div class="hint">'.$hint_database.'</div>';
447 install_print_footer($config);
452 if ($config->stage == INSTALL_DATABASETYPE) {
453 $CFG->early_install_lang = false;
455 // Finally ask for DB type
456 install_print_header($config, get_string('database', 'install'),
457 get_string('databasetypehead', 'install'),
458 get_string('databasetypesub', 'install'));
460 $databases = array('mysqli' => moodle_database::get_driver_instance('mysqli', 'native'),
461 'pgsql' => moodle_database::get_driver_instance('pgsql', 'native'),
462 'oci' => moodle_database::get_driver_instance('oci', 'native'),
463 'sqlsrv' => moodle_database::get_driver_instance('sqlsrv', 'native'), // MS SQL*Server PHP driver
464 'mssql' => moodle_database::get_driver_instance('mssql', 'native'), // FreeTDS driver
467 echo '<div class="userinput">';
468 echo '<div class="formrow"><label class="formlabel" for="dbtype">'.get_string('dbtype', 'install').'</label>';
469 echo '<select id="dbtype" name="dbtype" class="forminput">';
472 foreach ($databases as $type=>$database) {
473 if ($database->driver_installed() !== true) {
474 $disabled[$type] = $database;
477 echo '<option value="'.s($type).'">'.$database->get_name().'</option>';
480 echo '<optgroup label="'.s(get_string('notavailable')).'">';
481 foreach ($disabled as $type=>$database) {
482 echo '<option value="'.s($type).'" class="notavailable">'.$database->get_name().'</option>';
486 echo '</select></div>';
489 install_print_footer($config);
495 if ($config->stage == INSTALL_ENVIRONMENT or $config->stage == INSTALL_PATHS) {
496 $version_fail = (version_compare(phpversion(), "5.3.2") < 0);
497 $curl_fail = ($lang !== 'en' and !extension_loaded('curl')); // needed for lang pack download
498 $zip_fail = ($lang !== 'en' and !extension_loaded('zip')); // needed for lang pack download
500 if ($version_fail or $curl_fail or $zip_fail) {
501 $config->stage = INSTALL_ENVIRONMENT;
503 install_print_header($config, get_string('environmenthead', 'install'),
504 get_string('errorsinenvironment', 'install'),
505 get_string('environmentsub2', 'install'));
507 echo '<div id="envresult"><dl>';
509 $a = (object)array('needed'=>'5.3.2', 'current'=>phpversion());
510 echo '<dt>'.get_string('phpversion', 'install').'</dt><dd>'.get_string('environmentrequireversion', 'admin', $a).'</dd>';
513 echo '<dt>'.get_string('phpextension', 'install', 'cURL').'</dt><dd>'.get_string('environmentrequireinstall', 'admin').'</dd>';
516 echo '<dt>'.get_string('phpextension', 'install', 'Zip').'</dt><dd>'.get_string('environmentrequireinstall', 'admin').'</dd>';
520 install_print_footer($config, true);
524 $config->stage = INSTALL_PATHS;
530 if ($config->stage == INSTALL_PATHS) {
531 $paths = array('wwwroot' => get_string('wwwroot', 'install'),
532 'dirroot' => get_string('dirroot', 'install'),
533 'dataroot' => get_string('dataroot', 'install'));
536 foreach ($paths as $path=>$name) {
537 $sub .= '<dt>'.$name.'</dt><dd>'.get_string('pathssub'.$path, 'install').'</dd>';
539 if (!file_exists("$CFG->dirroot/admin/environment.xml")) {
540 $sub .= '<dt>'.get_string('admindirname', 'install').'</dt><dd>'.get_string('pathssubadmindir', 'install').'</dd>';
544 install_print_header($config, get_string('paths', 'install'), get_string('pathshead', 'install'), $sub);
546 $strwwwroot = get_string('wwwroot', 'install');
547 $strdirroot = get_string('dirroot', 'install');
548 $strdataroot = get_string('dataroot', 'install');
549 $stradmindirname = get_string('admindirname', 'install');
551 echo '<div class="userinput">';
552 echo '<div class="formrow"><label for="id_wwwroot" class="formlabel">'.$paths['wwwroot'].'</label>';
553 echo '<input id="id_wwwroot" name="wwwroot" type="text" value="'.s($CFG->wwwroot).'" disabled="disabled" size="70" class="forminput" />';
556 echo '<div class="formrow"><label for="id_dirroot" class="formlabel">'.$paths['dirroot'].'</label>';
557 echo '<input id="id_dirroot" name="dirroot" type="text" value="'.s($CFG->dirroot).'" disabled="disabled" size="70"class="forminput" />';
560 echo '<div class="formrow"><label for="id_dataroot" class="formlabel">'.$paths['dataroot'].'</label>';
561 echo '<input id="id_dataroot" name="dataroot" type="text" value="'.s($config->dataroot).'" size="70" class="forminput" />';
562 if ($hint_dataroot !== '') {
563 echo '<div class="hint">'.$hint_dataroot.'</div>';
568 if (!file_exists("$CFG->dirroot/admin/environment.xml")) {
569 echo '<div class="formrow"><label for="id_admin" class="formlabel">'.$paths['admindir'].'</label>';
570 echo '<input id="id_admin" name="admin" type="text" value="'.s($config->admin).'" size="10" class="forminput" />';
571 if ($hint_admindir !== '') {
572 echo '<div class="hint">'.$hint_admindir.'</div>';
579 install_print_footer($config);
585 $config->stage = INSTALL_WELCOME;
589 include('install/distribution.html');
590 $sub = ob_get_clean();
592 install_print_header($config, get_string('language'),
593 get_string('chooselanguagehead', 'install'),
597 install_print_header($config, get_string('language'),
598 get_string('chooselanguagehead', 'install'),
599 get_string('chooselanguagesub', 'install'));
602 $languages = get_string_manager()->get_list_of_translations();
603 echo '<div class="userinput">';
604 echo '<div class="formrow"><label class="formlabel" for="langselect">'.get_string('language').'</label>';
605 echo '<select id="langselect" name="lang" class="forminput" onchange="this.form.submit()">';
606 foreach ($languages as $name=>$value) {
607 $selected = ($name == $CFG->lang) ? 'selected="selected"' : '';
608 echo '<option value="'.s($name).'" '.$selected.'>'.$value.'</option>';
610 echo '</select></div>';
613 install_print_footer($config);