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 * Functions to support installation process
23 * @copyright 2009 Petr Skoda (http://skodak.org)
24 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27 defined('MOODLE_INTERNAL') ||
die();
29 /** INSTALL_WELCOME = 0 */
30 define('INSTALL_WELCOME', 0);
31 /** INSTALL_ENVIRONMENT = 1 */
32 define('INSTALL_ENVIRONMENT', 1);
33 /** INSTALL_PATHS = 2 */
34 define('INSTALL_PATHS', 2);
35 /** INSTALL_DOWNLOADLANG = 3 */
36 define('INSTALL_DOWNLOADLANG', 3);
37 /** INSTALL_DATABASETYPE = 4 */
38 define('INSTALL_DATABASETYPE', 4);
39 /** INSTALL_DATABASE = 5 */
40 define('INSTALL_DATABASE', 5);
41 /** INSTALL_SAVE = 6 */
42 define('INSTALL_SAVE', 6);
45 * Tries to detect the right www root setting.
46 * @return string detected www root
48 function install_guess_wwwroot() {
50 if (empty($_SERVER['HTTPS']) or $_SERVER['HTTPS'] == 'off') {
51 $wwwroot .= 'http://';
53 $wwwroot .= 'https://';
55 $hostport = explode(':', $_SERVER['HTTP_HOST']);
56 $wwwroot .= reset($hostport);
57 if ($_SERVER['SERVER_PORT'] != 80 and $_SERVER['SERVER_PORT'] != '443') {
58 $wwwroot .= ':'.$_SERVER['SERVER_PORT'];
60 $wwwroot .= $_SERVER['SCRIPT_NAME'];
62 list($wwwroot, $xtra) = explode('/install.php', $wwwroot);
68 * Copy of @see{ini_get_bool()}
69 * @param string $ini_get_arg
72 function install_ini_get_bool($ini_get_arg) {
73 $temp = ini_get($ini_get_arg);
75 if ($temp == '1' or strtolower($temp) == 'on') {
82 * Creates dataroot if not exists yet,
83 * makes sure it is writable, add lang directory
84 * and add .htaccess just in case it works.
86 * @param string $dataroot full path to dataroot
87 * @param int $dirpermissions
88 * @return bool success
90 function install_init_dataroot($dataroot, $dirpermissions) {
91 if (file_exists($dataroot) and !is_dir($dataroot)) {
92 // file with the same name exists
96 umask(0000); // $CFG->umaskpermissions is not set yet.
97 if (!file_exists($dataroot)) {
98 if (!mkdir($dataroot, $dirpermissions, true)) {
99 // most probably this does not work, but anyway
103 @chmod
($dataroot, $dirpermissions);
105 if (!is_writable($dataroot)) {
106 return false; // we can not continue
109 // create the directory for $CFG->tempdir
110 if (!is_dir("$dataroot/temp")) {
111 if (!mkdir("$dataroot/temp", $dirpermissions, true)) {
115 if (!is_writable("$dataroot/temp")) {
116 return false; // we can not continue
119 // create the directory for $CFG->cachedir
120 if (!is_dir("$dataroot/cache")) {
121 if (!mkdir("$dataroot/cache", $dirpermissions, true)) {
125 if (!is_writable("$dataroot/cache")) {
126 return false; // we can not continue
129 // create the directory for $CFG->langotherroot
130 if (!is_dir("$dataroot/lang")) {
131 if (!mkdir("$dataroot/lang", $dirpermissions, true)) {
135 if (!is_writable("$dataroot/lang")) {
136 return false; // we can not continue
139 // finally just in case some broken .htaccess that prevents access just in case it is allowed
140 if (!file_exists("$dataroot/.htaccess")) {
141 if ($handle = fopen("$dataroot/.htaccess", 'w')) {
142 fwrite($handle, "deny from all\r\nAllowOverride None\r\nNote: this file is broken intentionally, we do not want anybody to undo it in subdirectory!\r\n");
155 * @param string $titel
158 function install_helpbutton($url, $title='') {
160 $title = get_string('help');
162 echo "<a href=\"javascript:void(0)\" ";
163 echo "onclick=\"return window.open('$url','Help','menubar=0,location=0,scrollbars,resizable,width=500,height=400')\"";
165 echo "<img src=\"pix/help.gif\" class=\"iconhelp\" alt=\"$title\" title=\"$title\"/>";
170 * This is in function because we want the /install.php to parse in PHP4
172 * @param object $database
173 * @param string $dbhsot
174 * @param string $dbuser
175 * @param string $dbpass
176 * @param string $dbname
177 * @param string $prefix
178 * @param mixed $dboptions
181 function install_db_validate($database, $dbhost, $dbuser, $dbpass, $dbname, $prefix, $dboptions) {
184 $database->connect($dbhost, $dbuser, $dbpass, $dbname, $prefix, $dboptions);
185 } catch (moodle_exception
$e) {
186 // let's try to create new database
187 if ($database->create_database($dbhost, $dbuser, $dbpass, $dbname, $dboptions)) {
188 $database->connect($dbhost, $dbuser, $dbpass, $dbname, $prefix, $dboptions);
194 } catch (dml_exception
$ex) {
195 $stringmanager = get_string_manager();
196 $errorstring = $ex->errorcode
.'oninstall';
197 $legacystring = $ex->errorcode
;
198 if ($stringmanager->string_exists($errorstring, $ex->module
)) {
199 // By using a different string id from the error code we are separating exception handling and output.
200 return $stringmanager->get_string($errorstring, $ex->module
, $ex->a
).'<br />'.$ex->debuginfo
;
201 } else if ($stringmanager->string_exists($legacystring, $ex->module
)) {
202 // There are some DML exceptions that may be thrown here as well as during normal operation.
203 // If we have a translated message already we still want to serve it here.
204 // However it is not the preferred way.
205 return $stringmanager->get_string($legacystring, $ex->module
, $ex->a
).'<br />'.$ex->debuginfo
;
207 // No specific translation. Deliver a generic error message.
208 return $stringmanager->get_string('dmlexceptiononinstall', 'error', $ex);
213 * Returns content of config.php file.
215 * Uses PHP_EOL for generating proper end of lines for the given platform.
217 * @param moodle_database $database database instance
218 * @param object $cfg copy of $CFG
221 function install_generate_configphp($database, $cfg) {
222 $configphp = '<?php // Moodle configuration file' . PHP_EOL
. PHP_EOL
;
224 $configphp .= 'unset($CFG);' . PHP_EOL
;
225 $configphp .= 'global $CFG;' . PHP_EOL
;
226 $configphp .= '$CFG = new stdClass();' . PHP_EOL
. PHP_EOL
; // prevent PHP5 strict warnings
228 $dbconfig = $database->export_dbconfig();
230 foreach ($dbconfig as $key=>$value) {
231 $key = str_pad($key, 9);
232 $configphp .= '$CFG->'.$key.' = '.var_export($value, true) . ';' . PHP_EOL
;
234 $configphp .= PHP_EOL
;
236 $configphp .= '$CFG->wwwroot = '.var_export($cfg->wwwroot
, true) . ';' . PHP_EOL
;
238 $configphp .= '$CFG->dataroot = '.var_export($cfg->dataroot
, true) . ';' . PHP_EOL
;
240 $configphp .= '$CFG->admin = '.var_export($cfg->admin
, true) . ';' . PHP_EOL
. PHP_EOL
;
242 if (empty($cfg->directorypermissions
)) {
245 $chmod = '0' . decoct($cfg->directorypermissions
);
247 $configphp .= '$CFG->directorypermissions = ' . $chmod . ';' . PHP_EOL
. PHP_EOL
;
249 // A site-wide salt is only needed if bcrypt is not properly supported by the current version of PHP.
250 if (password_compat_not_supported()) {
251 $configphp .= '$CFG->passwordsaltmain = '.var_export(complex_random_string(), true) . ';' . PHP_EOL
. PHP_EOL
;
254 $configphp .= 'require_once(dirname(__FILE__) . \'/lib/setup.php\');' . PHP_EOL
. PHP_EOL
;
255 $configphp .= '// There is no php closing tag in this file,' . PHP_EOL
;
256 $configphp .= '// it is intentional because it prevents trailing whitespace problems!' . PHP_EOL
;
262 * Prints complete help page used during installation.
266 * @param string $help
268 function install_print_help_page($help) {
269 global $CFG, $OUTPUT; //TODO: MUST NOT USE $OUTPUT HERE!!!
271 @header
('Content-Type: text/html; charset=UTF-8');
272 @header
('X-UA-Compatible: IE=edge');
273 @header
('Cache-Control: no-store, no-cache, must-revalidate');
274 @header
('Cache-Control: post-check=0, pre-check=0', false);
275 @header
('Pragma: no-cache');
276 @header
('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
277 @header
('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
279 echo '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">';
280 echo '<html dir="'.(right_to_left() ?
'rtl' : 'ltr').'">
282 <link rel="shortcut icon" href="theme/standard/pix/favicon.ico" />
283 <link rel="stylesheet" type="text/css" href="'.$CFG->wwwroot
.'/install/css.php" />
284 <title>'.get_string('installation','install').'</title>
285 <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
286 <meta http-equiv="pragma" content="no-cache" />
287 <meta http-equiv="expires" content="0" />';
289 echo '</head><body>';
291 case 'phpversionhelp':
292 print_string($help, 'install', phpversion());
294 case 'memorylimithelp':
295 print_string($help, 'install', @ini_get
('memory_limit'));
298 print_string($help, 'install');
300 echo $OUTPUT->close_window_button(); //TODO: MUST NOT USE $OUTPUT HERE!!!
301 echo '</body></html>';
306 * Prints installation page header, we can no use weblib yet in installer.
309 * @param array $config
310 * @param string $stagename
311 * @param string $heading
312 * @param string $stagetext
315 function install_print_header($config, $stagename, $heading, $stagetext) {
318 @header
('Content-Type: text/html; charset=UTF-8');
319 @header
('X-UA-Compatible: IE=edge');
320 @header
('Cache-Control: no-store, no-cache, must-revalidate');
321 @header
('Cache-Control: post-check=0, pre-check=0', false);
322 @header
('Pragma: no-cache');
323 @header
('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
324 @header
('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
326 echo '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">';
327 echo '<html dir="'.(right_to_left() ?
'rtl' : 'ltr').'">
329 <link rel="shortcut icon" href="theme/standard/pix/favicon.ico" />';
331 echo '<link rel="stylesheet" type="text/css" href="'.$CFG->wwwroot
.'/install/css.php" />
332 <title>'.get_string('installation','install').' - Moodle '.$CFG->target_release
.'</title>
333 <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
334 <meta http-equiv="pragma" content="no-cache" />
335 <meta http-equiv="expires" content="0" />';
337 echo '</head><body class="notloggedin">
338 <div id="page" class="stage'.$config->stage
.'">
339 <div id="page-header">
340 <div id="header" class=" clearfix">
341 <h1 class="headermain">'.get_string('installation','install').'</h1>
342 <div class="headermenu"> </div>
344 <div class="navbar clearfix">
345 <div class="breadcrumb">
346 <ul><li class="first">'.$stagename.'</li></ul>
348 <div class="navbutton"> </div>
351 <!-- END OF HEADER -->
352 <div id="installdiv">';
354 echo '<h2>'.$heading.'</h2>';
356 if ($stagetext !== '') {
357 echo '<div class="stage generalbox box">';
362 echo '<form id="installform" method="post" action="install.php"><fieldset>';
363 foreach ($config as $name=>$value) {
364 echo '<input type="hidden" name="'.$name.'" value="'.s($value).'" />';
369 * Prints installation page header, we can no use weblib yet in isntaller.
372 * @param array $config
373 * @param bool $reload print reload button instead of next
376 function install_print_footer($config, $reload=false) {
379 if ($config->stage
> INSTALL_WELCOME
) {
380 $first = '<input type="submit" id="previousbutton" name="previous" value="« '.s(get_string('previous')).'" />';
382 $first = '<input type="submit" id="previousbutton" name="next" value="'.s(get_string('reload')).'" />';
383 $first .= '<script type="text/javascript">
385 var first = document.getElementById("previousbutton");
386 first.style.visibility = "hidden";
393 $next = '<input type="submit" id="nextbutton" name="next" value="'.s(get_string('reload')).'" />';
395 $next = '<input type="submit" id="nextbutton" name="next" value="'.s(get_string('next')).' »" />';
398 echo '</fieldset><fieldset id="nav_buttons">'.$first.$next.'</fieldset>';
400 $homelink = '<div class="sitelink">'.
401 '<a title="Moodle '. $CFG->target_release
.'" href="http://docs.moodle.org/en/Administrator_documentation" onclick="this.target=\'_blank\'">'.
402 '<img style="width:100px;height:30px" src="pix/moodlelogo.gif" alt="moodlelogo" /></a></div>';
404 echo '</form></div>';
405 echo '<div id="footer"><hr />'.$homelink.'</div>';
406 echo '</div></body></html>';
411 * config.php must exist, there must not be any tables in db yet.
413 * @param array $options adminpass is mandatory
414 * @param bool $interactive
417 function install_cli_database(array $options, $interactive) {
419 require_once($CFG->libdir
.'/environmentlib.php');
420 require_once($CFG->libdir
.'/upgradelib.php');
422 // show as much debug as possible
423 @error_reporting
(E_ALL | E_STRICT
);
424 @ini_set
('display_errors', '1');
425 $CFG->debug
= (E_ALL | E_STRICT
);
426 $CFG->debugdisplay
= true;
427 $CFG->debugdeveloper
= true;
437 // read $version and $release
438 require($CFG->dirroot
.'/version.php');
440 if ($DB->get_tables() ) {
441 cli_error(get_string('clitablesexist', 'install'));
444 if (empty($options['adminpass'])) {
445 cli_error('Missing required admin password');
448 // test environment first
449 list($envstatus, $environment_results) = check_moodle_environment(normalize_version($release), ENV_SELECT_RELEASE
);
451 $errors = environment_get_errors($environment_results);
452 cli_heading(get_string('environment', 'admin'));
453 foreach ($errors as $error) {
454 list($info, $report) = $error;
455 echo "!! $info !!\n$report\n\n";
460 if (!$DB->setup_is_unicodedb()) {
461 if (!$DB->change_db_encoding()) {
462 // If could not convert successfully, throw error, and prevent installation
463 cli_error(get_string('unicoderequired', 'admin'));
469 cli_heading(get_string('databasesetup'));
473 install_core($version, true);
474 set_config('release', $release);
475 set_config('branch', $branch);
478 // mark as test database as soon as possible
479 set_config('phpunittest', 'na');
482 // install all plugins types, local, etc.
483 upgrade_noncore(true);
485 // set up admin user password
486 $DB->set_field('user', 'password', hash_internal_user_password($options['adminpass']), array('username' => 'admin'));
488 // rename admin username if needed
489 if (isset($options['adminuser']) and $options['adminuser'] !== 'admin' and $options['adminuser'] !== 'guest') {
490 $DB->set_field('user', 'username', $options['adminuser'], array('username' => 'admin'));
493 // indicate that this site is fully configured
494 set_config('rolesactive', 1);
497 // log in as admin - we need do anything when applying defaults
498 \core\session\manager
::set_user(get_admin());
500 // apply all default settings, do it twice to fill all defaults - some settings depend on other setting
501 admin_apply_default_settings(NULL, true);
502 admin_apply_default_settings(NULL, true);
503 set_config('registerauth', '');
506 if (isset($options['shortname']) and $options['shortname'] !== '') {
507 $DB->set_field('course', 'shortname', $options['shortname'], array('format' => 'site'));
509 if (isset($options['fullname']) and $options['fullname'] !== '') {
510 $DB->set_field('course', 'fullname', $options['fullname'], array('format' => 'site'));