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 // make sure PHP errors are displayed - helps with diagnosing of problems
50 @error_reporting(E_ALL);
51 @ini_set('display_errors', '1');
53 // Check that PHP is of a sufficient version
54 // PHP 5.2.0 is intentionally checked here even though a higher version is required by the environment
55 // check. This is not a typo - see MDL-18112
56 if (version_compare(phpversion(), "5.2.0") < 0) {
57 $phpversion = phpversion();
58 // do NOT localise - lang strings would not work here and we CAN not move it after installib
59 echo "Sorry, Moodle 2.0 requires PHP 5.2.8 or later (currently using version $phpversion).<br />";
60 echo "Please upgrade your server software or install latest Moodle 1.9.x instead.";
64 if (PHP_INT_SIZE > 4) {
65 // most probably 64bit PHP - we need a lot more memory
66 $minrequiredmemory = '70M';
69 $minrequiredmemory = '40M';
71 // increase or decrease available memory - we need to make sure moodle
72 // installs even with low memory, otherwise developers would overlook
73 // sudden increases of memory needs ;-)
74 @ini_set('memory_limit', $minrequiredmemory);
76 /** Used by library scripts to check they are being called by Moodle */
77 define('MOODLE_INTERNAL', true);
79 require dirname(__FILE__).'/lib/installlib.php';
81 // TODO: add lang detection here if empty $_REQUEST['lang']
83 // distro specific customisation
85 if (file_exists('install/distrolib.php')) {
86 require_once('install/distrolib.php');
87 if (function_exists('distro_get_config')) {
88 $distro = distro_get_config();
92 $config = new stdClass();
93 $config->lang = $lang;
96 if (install_ini_get_bool('magic_quotes_gpc')) {
97 $_POST = array_map('stripslashes', $_POST);
100 $config->stage = (int)$_POST['stage'];
102 if (isset($_POST['previous'])) {
104 if (INSTALL_DATABASETYPE and !empty($distro->dbtype)) {
107 if ($config->stage == INSTALL_ENVIRONMENT or $config->stage == INSTALL_DOWNLOADLANG) {
110 } else if (isset($_POST['next'])) {
114 $config->dbtype = trim($_POST['dbtype']);
115 $config->dbhost = trim($_POST['dbhost']);
116 $config->dbuser = trim($_POST['dbuser']);
117 $config->dbpass = trim($_POST['dbpass']);
118 $config->dbname = trim($_POST['dbname']);
119 $config->prefix = trim($_POST['prefix']);
120 $config->dbsocket = (int)(!empty($_POST['dbsocket']));
122 $config->admin = empty($_POST['admin']) ? 'admin' : trim($_POST['admin']);
124 $config->dataroot = trim($_POST['dataroot']);
127 $config->stage = INSTALL_WELCOME;
129 $config->dbtype = empty($distro->dbtype) ? '' : $distro->dbtype; // let distro skip dbtype selection
130 $config->dbhost = empty($distro->dbhost) ? 'localhost' : $distro->dbhost; // let distros set dbhost
131 $config->dbuser = empty($distro->dbuser) ? '' : $distro->dbuser; // let distros set dbuser
132 $config->dbpass = '';
133 $config->dbname = 'moodle';
134 $config->prefix = 'mdl_';
135 $config->dbsocket = 0;
137 $config->admin = 'admin';
139 $config->dataroot = empty($distro->dataroot) ? null : $distro->dataroot; // initialised later after including libs or by distro
142 // Fake some settings so that we can use selected functions from moodlelib.php and weblib.php
143 $CFG = new stdClass();
144 $CFG->lang = $config->lang;
145 $CFG->dirroot = dirname(__FILE__);
146 $CFG->libdir = "$CFG->dirroot/lib";
147 $CFG->wwwroot = install_guess_wwwroot(); // can not be changed - ppl must use the real address when installing
148 $CFG->httpswwwroot = $CFG->wwwroot;
149 $CFG->dataroot = $config->dataroot;
150 $CFG->admin = $config->admin;
151 $CFG->docroot = 'http://docs.moodle.org';
152 $CFG->langotherroot = $CFG->dataroot.'/lang';
153 $CFG->langlocalroot = $CFG->dataroot.'/lang';
154 $CFG->directorypermissions = 00777;
155 $CFG->running_installer = true;
156 $CFG->early_install_lang = true;
158 // Require all needed libs
159 require_once($CFG->libdir.'/setuplib.php');
161 // we need to make sure we have enough memory to load all libraries
162 $memlimit = @ini_get('memory_limit');
163 if (!empty($memlimit) and $memlimit != -1) {
164 if (get_real_size($memlimit) < get_real_size($minrequiredmemory)) {
165 // do NOT localise - lang strings would not work here and we CAN not move it to later place
166 echo "Sorry, Moodle 2.0 requires at least {$minrequiredmemory}B of PHP memory.<br />";
167 echo "Please contact server administrator to fix PHP.ini memory settings.";
172 // Continue with lib loading
173 require_once($CFG->libdir.'/textlib.class.php');
174 require_once($CFG->libdir.'/weblib.php');
175 require_once($CFG->libdir.'/outputlib.php');
176 require_once($CFG->libdir.'/dmllib.php');
177 require_once($CFG->libdir.'/moodlelib.php');
178 require_once($CFG->libdir .'/pagelib.php');
179 require_once($CFG->libdir.'/deprecatedlib.php');
180 require_once($CFG->libdir.'/adminlib.php');
181 require_once($CFG->libdir.'/environmentlib.php');
182 require_once($CFG->libdir.'/componentlib.class.php');
184 //point pear include path to moodles lib/pear so that includes and requires will search there for files before anywhere else
185 //the problem is that we need specific version of quickforms and hacked excel files :-(
186 ini_set('include_path', $CFG->libdir.'/pear' . PATH_SEPARATOR . ini_get('include_path'));
187 //point zend include path to moodles lib/zend so that includes and requires will search there for files before anywhere else
188 ini_set('include_path', $CFG->libdir.'/zend' . PATH_SEPARATOR . ini_get('include_path'));
190 require('version.php');
191 $CFG->target_release = $release;
193 $SESSION = new object();
194 $SESSION->lang = $CFG->lang;
196 $USER = new object();
199 $COURSE = new object();
209 // Are we in help mode?
210 if (isset($_GET['help'])) {
211 install_print_help_page($_GET['help']);
215 if (isset($_GET['css'])) {
216 install_css_styles();
219 //first time here? find out suitable dataroot
220 if (is_null($CFG->dataroot)) {
221 $CFG->dataroot = dirname(dirname(__FILE__)).DIRECTORY_SEPARATOR.'moodledata';
223 $i = 0; //safety check - dirname might return some unexpected results
224 while(is_dataroot_insecure()) {
225 $parrent = dirname($CFG->dataroot);
227 if ($parrent == '/' or $parrent == '.' or preg_match('/^[a-z]:\\\?$/i', $parrent) or ($i > 100)) {
228 $CFG->dataroot = ''; //can not find secure location for dataroot
231 $CFG->dataroot = dirname($parrent).DIRECTORY_SEPARATOR.'moodledata';
233 $config->dataroot = $CFG->dataroot;
234 $config->stage = INSTALL_WELCOME;
237 // now let's do the stage work
238 if ($config->stage < INSTALL_WELCOME) {
239 $config->stage = INSTALL_WELCOME;
241 if ($config->stage > INSTALL_SAVE) {
242 $config->stage = INSTALL_SAVE;
247 if ($config->stage == INSTALL_SAVE) {
248 $CFG->early_install_lang = false;
250 $database = moodle_database::get_driver_instance($config->dbtype, 'native');
251 if (!$database->driver_installed()) {
252 $config->stage = INSTALL_DATABASETYPE;
254 if (function_exists('distro_pre_create_db')) { // Hook for distros needing to do something before DB creation
255 $distro = distro_pre_create_db($database, $config->dbhost, $config->dbuser, $config->dbpass, $config->dbname, $config->prefix, array('dbpersist'=>0, 'dbsocket'=>$config->dbsocket), $distro);
257 $hint_database = install_db_validate($database, $config->dbhost, $config->dbuser, $config->dbpass, $config->dbname, $config->prefix, array('dbpersist'=>0, 'dbsocket'=>$config->dbsocket));
259 if ($hint_database === '') {
260 $configphp = install_generate_configphp($database, $CFG);
263 if (($fh = @fopen($configfile, 'w')) !== false) {
264 fwrite($fh, $configphp);
268 if (file_exists($configfile)) {
269 // config created, let's continue!
270 redirect("$CFG->wwwroot/$config->admin/index.php?lang=$config->lang");
273 install_print_header($config, 'config.php',
274 get_string('configurationcompletehead', 'install'),
275 get_string('configurationcompletesub', 'install').get_string('configfilenotwritten', 'install'));
276 echo '<div class="configphp"><pre>';
280 install_print_footer($config);
284 $config->stage = INSTALL_DATABASE;
291 if ($config->stage == INSTALL_DOWNLOADLANG) {
292 if (empty($CFG->dataroot)) {
293 $config->stage = INSTALL_PATHS;
295 } else if (is_dataroot_insecure()) {
296 $hint_dataroot = get_string('pathsunsecuredataroot', 'install');
297 $config->stage = INSTALL_PATHS;
299 } else if (!file_exists($CFG->dataroot)) {
301 $a->parent = dirname($CFG->dataroot);
302 $a->dataroot = $CFG->dataroot;
303 if (!is_writable(dirname($CFG->dataroot))) {
304 $hint_dataroot = get_string('pathsroparentdataroot', 'install', $a);
305 $config->stage = INSTALL_PATHS;
307 if (!make_upload_directory('lang', false)) {
308 $hint_dataroot = get_string('pathserrcreatedataroot', 'install', $a);
309 $config->stage = INSTALL_PATHS;
314 if (empty($hint_dataroot) and !is_writable($CFG->dataroot)) {
315 $hint_dataroot = get_string('pathsrodataroot', 'install');
316 $config->stage = INSTALL_PATHS;
319 if ($config->admin === '' or !file_exists($CFG->dirroot.'/'.$config->admin.'/environment.xml')) {
320 $hint_admindir = get_string('pathswrongadmindir', 'install');
321 $config->stage = INSTALL_PATHS;
327 if ($config->stage == INSTALL_DOWNLOADLANG) {
328 // no need to download anything if en lang selected
329 if ($CFG->lang == 'en') {
330 $config->stage = INSTALL_DATABASETYPE;
336 if ($config->stage == INSTALL_DATABASETYPE) {
337 // skip db selection if distro package supports only one db
338 if (!empty($distro->dbtype)) {
339 $config->stage = INSTALL_DATABASE;
344 if ($config->stage == INSTALL_DOWNLOADLANG) {
347 // Create necessary lang dir
348 if (!make_upload_directory('lang', false)) {
349 $downloaderror = get_string('cannotcreatelangdir', 'error');
351 // Download and install lang component
352 } else if ($cd = new component_installer('http://download.moodle.org', 'langpack/2.0', $CFG->lang.'.zip', 'languages.md5', 'lang')) {
353 if ($cd->install() == COMPONENT_ERROR) {
354 if ($cd->get_error() == 'remotedownloaderror') {
356 $a->url = 'http://download.moodle.org/langpack/2.0/'.$config->lang.'.zip';
357 $a->dest = $CFG->dataroot.'/lang';
358 $downloaderror = get_string($cd->get_error(), 'error', $a);
360 $downloaderror = get_string($cd->get_error(), 'error');
363 // install parent lang if defined
364 if ($parentlang = get_parent_language()) {
365 if ($cd = new component_installer('http://download.moodle.org', 'langpack/2.0', $parentlang.'.zip', 'languages.md5', 'lang')) {
371 // switch the string_manager instance to stop using install/lang/
372 $CFG->early_install_lang = false;
373 $CFG->langotherroot = $CFG->dataroot.'/lang';
374 $CFG->langlocalroot = $CFG->dataroot.'/lang';
375 get_string_manager(true);
377 if ($downloaderror !== '') {
378 install_print_header($config, get_string('language'), get_string('langdownloaderror', 'install', $CFG->lang), $downloaderror);
379 install_print_footer($config);
382 if (empty($distro->dbtype)) {
383 $config->stage = INSTALL_DATABASETYPE;
385 $config->stage = INSTALL_DATABASE;
391 if ($config->stage == INSTALL_DATABASE) {
392 $CFG->early_install_lang = false;
394 $database = moodle_database::get_driver_instance($config->dbtype, 'native');
396 $sub = '<h3>'.$database->get_name().'</h3>'.$database->get_configuration_help();
398 install_print_header($config, get_string('database', 'install'), get_string('databasehead', 'install'), $sub);
400 $strdbhost = get_string('databasehost', 'install');
401 $strdbname = get_string('databasename', 'install');
402 $strdbuser = get_string('databaseuser', 'install');
403 $strdbpass = get_string('databasepass', 'install');
404 $strprefix = get_string('dbprefix', 'install');
405 $strdbsocket = get_string('databasesocket', 'install');
407 echo '<div class="userinput">';
409 $disabled = empty($distro->dbhost) ? '' : 'disabled="disabled';
410 echo '<div class="formrow"><label for="id_dbhost" class="formlabel">'.$strdbhost.'</label>';
411 echo '<input id="id_dbhost" name="dbhost" '.$disabled.' type="text" value="'.s($config->dbhost).'" size="30" class="forminput" />';
414 echo '<div class="formrow"><label for="id_dbname" class="formlabel">'.$strdbname.'</label>';
415 echo '<input id="id_dbname" name="dbname" type="text" value="'.s($config->dbname).'" size="30" class="forminput" />';
418 $disabled = empty($distro->dbuser) ? '' : 'disabled="disabled';
419 echo '<div class="formrow"><label for="id_dbuser" class="formlabel">'.$strdbuser.'</label>';
420 echo '<input id="id_dbuser" name="dbuser" '.$disabled.' type="text" value="'.s($config->dbuser).'" size="30" class="forminput" />';
423 echo '<div class="formrow"><label for="id_dbpass" class="formlabel">'.$strdbpass.'</label>';
424 // no password field here, the password may be visible in config.php if we can not write it to disk
425 echo '<input id="id_dbpass" name="dbpass" type="text" value="'.s($config->dbpass).'" size="30" class="forminput" />';
428 echo '<div class="formrow"><label for="id_prefix" class="formlabel">'.$strprefix.'</label>';
429 echo '<input id="id_prefix" name="prefix" type="text" value="'.s($config->prefix).'" size="10" class="forminput" />';
432 if (!(stristr(PHP_OS, 'win') && !stristr(PHP_OS, 'darwin'))) {
433 $checked = $config->dbsocket ? 'checked="checked' : '';
434 echo '<div class="formrow"><label for="id_dbsocket" class="formlabel">'.$strdbsocket.'</label>';
435 echo '<input type="hidden" value="0" name="dbsocket" />';
436 echo '<input type="checkbox" id="id_dbsocket" value="1" name="dbsocket" '.$checked.' class="forminput" />';
440 echo '<div class="hint">'.$hint_database.'</div>';
442 install_print_footer($config);
447 if ($config->stage == INSTALL_DATABASETYPE) {
448 $CFG->early_install_lang = false;
450 // Finally ask for DB type
451 install_print_header($config, get_string('database', 'install'),
452 get_string('databasetypehead', 'install'),
453 get_string('databasetypesub', 'install'));
455 // TODO: move this PHP5 code to lib/installib.php so that this file parses in PHP4
456 $databases = array('mysqli' => moodle_database::get_driver_instance('mysqli', 'native'),
457 'pgsql' => moodle_database::get_driver_instance('pgsql', 'native'),
458 'oci' => moodle_database::get_driver_instance('oci', 'native'),
459 'sqlsrv' => moodle_database::get_driver_instance('sqlsrv', 'native'), // MS SQL*Server PHP driver
460 'mssql' => moodle_database::get_driver_instance('mssql', 'native'), // FreeTDS driver
463 echo '<div class="userinput">';
464 echo '<div class="formrow"><label class="formlabel" for="dbtype">'.get_string('dbtype', 'install').'</label>';
465 echo '<select id="dbtype" name="dbtype" class="forminput">';
468 foreach ($databases as $type=>$database) {
469 if ($database->driver_installed() !== true) {
470 $disabled[$type] = $database;
473 echo '<option value="'.s($type).'">'.$database->get_name().'</option>';
476 echo '<optgroup label="'.s(get_string('notavailable')).'">';
477 foreach ($disabled as $type=>$database) {
478 echo '<option value="'.s($type).'" class="notavailable">'.$database->get_name().'</option>';
482 echo '</select></div>';
485 install_print_footer($config);
491 if ($config->stage == INSTALL_ENVIRONMENT or $config->stage == INSTALL_PATHS) {
492 $version_fail = (version_compare(phpversion(), "5.2.8") < 0);
493 $curl_fail = ($lang !== 'en' and !extension_loaded('curl')); // needed for lang pack download
494 $zip_fail = ($lang !== 'en' and !extension_loaded('zip')); // needed for lang pack download
496 if ($version_fail or $curl_fail or $zip_fail) {
497 $config->stage = INSTALL_ENVIRONMENT;
499 install_print_header($config, get_string('environmenthead', 'install'),
500 get_string('errorsinenvironment', 'install'),
501 get_string('environmentsub2', 'install'));
503 echo '<div id="envresult"><dl>';
505 $a = (object)array('needed'=>'5.2.8', 'current'=>phpversion());
506 echo '<dt>'.get_string('phpversion', 'install').'</dt><dd>'.get_string('environmentrequireversion', 'admin', $a).'</dd>';
509 echo '<dt>'.get_string('phpextension', 'install', 'cURL').'</dt><dd>'.get_string('environmentrequireinstall', 'admin').'</dd>';
512 echo '<dt>'.get_string('phpextension', 'install', 'Zip').'</dt><dd>'.get_string('environmentrequireinstall', 'admin').'</dd>';
516 install_print_footer($config, true);
520 $config->stage = INSTALL_PATHS;
526 if ($config->stage == INSTALL_PATHS) {
527 $paths = array('wwwroot' => get_string('wwwroot', 'install'),
528 'dirroot' => get_string('dirroot', 'install'),
529 'dataroot' => get_string('dataroot', 'install'));
532 foreach ($paths as $path=>$name) {
533 $sub .= '<dt>'.$name.'</dt><dd>'.get_string('pathssub'.$path, 'install').'</dd>';
535 if (!file_exists("$CFG->dirroot/admin/environment.xml")) {
536 $sub .= '<dt>'.get_string('admindirname', 'install').'</dt><dd>'.get_string('pathssubadmindir', 'install').'</dd>';
540 install_print_header($config, get_string('paths', 'install'), get_string('pathshead', 'install'), $sub);
542 $strwwwroot = get_string('wwwroot', 'install');
543 $strdirroot = get_string('dirroot', 'install');
544 $strdataroot = get_string('dataroot', 'install');
545 $stradmindirname = get_string('admindirname', 'install');
547 echo '<div class="userinput">';
548 echo '<div class="formrow"><label for="id_wwwroot" class="formlabel">'.$paths['wwwroot'].'</label>';
549 echo '<input id="id_wwwroot" name="wwwroot" type="text" value="'.s($CFG->wwwroot).'" disabled="disabled" size="45" class="forminput" />';
552 echo '<div class="formrow"><label for="id_dirroot" class="formlabel">'.$paths['dirroot'].'</label>';
553 echo '<input id="id_dirroot" name="dirroot" type="text" value="'.s($CFG->dirroot).'" disabled="disabled" size="45"class="forminput" />';
556 echo '<div class="formrow"><label for="id_dataroot" class="formlabel">'.$paths['dataroot'].'</label>';
557 echo '<input id="id_dataroot" name="dataroot" type="text" value="'.s($config->dataroot).'" size="45" class="forminput" />';
558 if ($hint_dataroot !== '') {
559 echo '<div class="hint">'.$hint_dataroot.'</div>';
564 if (!file_exists("$CFG->dirroot/admin/environment.xml")) {
565 echo '<div class="formrow"><label for="id_admin" class="formlabel">'.$paths['admindir'].'</label>';
566 echo '<input id="id_admin" name="admin" type="text" value="'.s($config->admin).'" size="10" class="forminput" />';
567 if ($hint_admindir !== '') {
568 echo '<div class="hint">'.$hint_admindir.'</div>';
575 install_print_footer($config);
581 $config->stage = INSTALL_WELCOME;
585 include('install/distribution.html');
586 $sub = ob_get_clean();
588 install_print_header($config, get_string('language'),
589 get_string('chooselanguagehead', 'install'),
593 install_print_header($config, get_string('language'),
594 get_string('chooselanguagehead', 'install'),
595 get_string('chooselanguagesub', 'install'));
598 $languages = get_string_manager()->get_list_of_translations();
599 echo '<div class="userinput">';
600 echo '<div class="formrow"><label class="formlabel" for="langselect">'.get_string('language').'</label>';
601 echo '<select id="langselect" name="lang" class="forminput" onchange="this.form.submit()">';
602 foreach ($languages as $name=>$value) {
603 $selected = ($name == $CFG->lang) ? 'selected="selected"' : '';
604 echo '<option value="'.s($name).'" '.$selected.'>'.$value.'</option>';
606 echo '</select></div>';
609 install_print_footer($config);