lib/installlib.php

   1 <?php
   2
   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.
  14 //
  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/>.
  17
  18 /**
  19  * Functions to support installation process
  20  *
  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
  25  */
  26
  27 defined('MOODLE_INTERNAL') || die();
  28
  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);
  43
  44 /**
  45  * Tries to detect the right www root setting.
  46  * @return string detected www root
  47  */
  48 function install_guess_wwwroot() {
  49     $wwwroot = '';
  50     if (empty($_SERVER['HTTPS']) or $_SERVER['HTTPS'] == 'off') {
  51         $wwwroot .= 'http://';
  52     } else {
  53         $wwwroot .= 'https://';
  54     }
  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'];
  59     }
  60     $wwwroot .= $_SERVER['SCRIPT_NAME'];
  61
  62     list($wwwroot, $xtra) = explode('/install.php', $wwwroot);
  63
  64     return $wwwroot;
  65 }
  66
  67 /**
  68  * Copy of @see{ini_get_bool()}
  69  * @param string $ini_get_arg
  70  * @return bool
  71  */
  72 function install_ini_get_bool($ini_get_arg) {
  73     $temp = ini_get($ini_get_arg);
  74
  75     if ($temp == '1' or strtolower($temp) == 'on') {
  76         return true;
  77     }
  78     return false;
  79 }
  80
  81 /**
  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.
  85  *
  86  * @param string $dataroot full path to dataroot
  87  * @param int $dirpermissions
  88  * @return bool success
  89  */
  90 function install_init_dataroot($dataroot, $dirpermissions) {
  91     if (file_exists($dataroot) and !is_dir($dataroot)) {
  92         // file with the same name exists
  93         return false;
  94     }
  95
  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
 100             return false;
 101         }
 102     }
 103     @chmod($dataroot, $dirpermissions);
 104
 105     if (!is_writable($dataroot)) {
 106         return false; // we can not continue
 107     }
 108
 109     // create the directory for $CFG->tempdir
 110     if (!is_dir("$dataroot/temp")) {
 111         if (!mkdir("$dataroot/temp", $dirpermissions, true)) {
 112             return false;
 113         }
 114     }
 115     if (!is_writable("$dataroot/temp")) {
 116         return false; // we can not continue
 117     }
 118
 119     // create the directory for $CFG->cachedir
 120     if (!is_dir("$dataroot/cache")) {
 121         if (!mkdir("$dataroot/cache", $dirpermissions, true)) {
 122             return false;
 123         }
 124     }
 125     if (!is_writable("$dataroot/cache")) {
 126         return false; // we can not continue
 127     }
 128
 129     // create the directory for $CFG->langotherroot
 130     if (!is_dir("$dataroot/lang")) {
 131         if (!mkdir("$dataroot/lang", $dirpermissions, true)) {
 132             return false;
 133         }
 134     }
 135     if (!is_writable("$dataroot/lang")) {
 136         return false; // we can not continue
 137     }
 138
 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");
 143             fclose($handle);
 144         } else {
 145             return false;
 146         }
 147     }
 148
 149     return true;
 150 }
 151
 152 /**
 153  * Print help button
 154  * @param string $url
 155  * @param string $titel
 156  * @return void
 157  */
 158 function install_helpbutton($url, $title='') {
 159     if ($title == '') {
 160         $title = get_string('help');
 161     }
 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')\"";
 164     echo ">";
 165     echo "<img src=\"pix/help.gif\" class=\"iconhelp\" alt=\"$title\" title=\"$title\"/>";
 166     echo "</a>\n";
 167 }
 168
 169 /**
 170  * This is in function because we want the /install.php to parse in PHP4
 171  *
 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
 179  * @return string
 180  */
 181 function install_db_validate($database, $dbhost, $dbuser, $dbpass, $dbname, $prefix, $dboptions) {
 182     try {
 183         try {
 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);
 189             } else {
 190                 throw $e;
 191             }
 192         }
 193         return '';
 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             $returnstring = $stringmanager->get_string($errorstring, $ex->module, $ex->a);
 201             if ($ex->debuginfo) {
 202                 $returnstring .= '<br />'.$ex->debuginfo;
 203             }
 204
 205             return $returnstring;
 206         } else if ($stringmanager->string_exists($legacystring, $ex->module)) {
 207             // There are some DML exceptions that may be thrown here as well as during normal operation.
 208             // If we have a translated message already we still want to serve it here.
 209             // However it is not the preferred way.
 210             $returnstring = $stringmanager->get_string($legacystring, $ex->module, $ex->a);
 211             if ($ex->debuginfo) {
 212                 $returnstring .= '<br />'.$ex->debuginfo;
 213             }
 214
 215             return $returnstring;
 216         }
 217         // No specific translation. Deliver a generic error message.
 218         return $stringmanager->get_string('dmlexceptiononinstall', 'error', $ex);
 219     }
 220 }
 221
 222 /**
 223  * Returns content of config.php file.
 224  *
 225  * Uses PHP_EOL for generating proper end of lines for the given platform.
 226  *
 227  * @param moodle_database $database database instance
 228  * @param object $cfg copy of $CFG
 229  * @return string
 230  */
 231 function install_generate_configphp($database, $cfg) {
 232     $configphp = '<?php  // Moodle configuration file' . PHP_EOL . PHP_EOL;
 233
 234     $configphp .= 'unset($CFG);' . PHP_EOL;
 235     $configphp .= 'global $CFG;' . PHP_EOL;
 236     $configphp .= '$CFG = new stdClass();' . PHP_EOL . PHP_EOL; // prevent PHP5 strict warnings
 237
 238     $dbconfig = $database->export_dbconfig();
 239
 240     foreach ($dbconfig as $key=>$value) {
 241         $key = str_pad($key, 9);
 242         $configphp .= '$CFG->'.$key.' = '.var_export($value, true) . ';' . PHP_EOL;
 243     }
 244     $configphp .= PHP_EOL;
 245
 246     $configphp .= '$CFG->wwwroot   = '.var_export($cfg->wwwroot, true) . ';' . PHP_EOL ;
 247
 248     $configphp .= '$CFG->dataroot  = '.var_export($cfg->dataroot, true) . ';' . PHP_EOL;
 249
 250     $configphp .= '$CFG->admin     = '.var_export($cfg->admin, true) . ';' . PHP_EOL . PHP_EOL;
 251
 252     if (empty($cfg->directorypermissions)) {
 253         $chmod = '02777';
 254     } else {
 255         $chmod = '0' . decoct($cfg->directorypermissions);
 256     }
 257     $configphp .= '$CFG->directorypermissions = ' . $chmod . ';' . PHP_EOL . PHP_EOL;
 258
 259     if (isset($cfg->upgradekey) and $cfg->upgradekey !== '') {
 260         $configphp .= '$CFG->upgradekey = ' . var_export($cfg->upgradekey, true) . ';' . PHP_EOL . PHP_EOL;
 261     }
 262
 263     $configphp .= 'require_once(__DIR__ . \'/lib/setup.php\');' . PHP_EOL . PHP_EOL;
 264     $configphp .= '// There is no php closing tag in this file,' . PHP_EOL;
 265     $configphp .= '// it is intentional because it prevents trailing whitespace problems!' . PHP_EOL;
 266
 267     return $configphp;
 268 }
 269
 270 /**
 271  * Prints complete help page used during installation.
 272  * Does not return.
 273  *
 274  * @global object
 275  * @param string $help
 276  */
 277 function install_print_help_page($help) {
 278     global $CFG, $OUTPUT; //TODO: MUST NOT USE $OUTPUT HERE!!!
 279
 280     @header('Content-Type: text/html; charset=UTF-8');
 281     @header('X-UA-Compatible: IE=edge');
 282     @header('Cache-Control: no-store, no-cache, must-revalidate');
 283     @header('Cache-Control: post-check=0, pre-check=0', false);
 284     @header('Pragma: no-cache');
 285     @header('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
 286     @header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
 287
 288     echo '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">';
 289     echo '<html dir="'.(right_to_left() ? 'rtl' : 'ltr').'">
 290           <head>
 291           <link rel="shortcut icon" href="theme/clean/pix/favicon.ico" />
 292           <link rel="stylesheet" type="text/css" href="'.$CFG->wwwroot.'/install/css.php" />
 293           <title>'.get_string('installation','install').'</title>
 294           <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
 295           </head><body>';
 296     switch ($help) {
 297         case 'phpversionhelp':
 298             print_string($help, 'install', phpversion());
 299             break;
 300         case 'memorylimithelp':
 301             print_string($help, 'install', @ini_get('memory_limit'));
 302             break;
 303         default:
 304             print_string($help, 'install');
 305     }
 306     echo $OUTPUT->close_window_button(); //TODO: MUST NOT USE $OUTPUT HERE!!!
 307     echo '</body></html>';
 308     die;
 309 }
 310
 311 /**
 312  * Prints installation page header, we can no use weblib yet in installer.
 313  *
 314  * @global object
 315  * @param array $config
 316  * @param string $stagename
 317  * @param string $heading
 318  * @param string $stagetext
 319  * @param string $stageclass
 320  * @return void
 321  */
 322 function install_print_header($config, $stagename, $heading, $stagetext, $stageclass = "alert-info") {
 323     global $CFG;
 324
 325     @header('Content-Type: text/html; charset=UTF-8');
 326     @header('X-UA-Compatible: IE=edge');
 327     @header('Cache-Control: no-store, no-cache, must-revalidate');
 328     @header('Cache-Control: post-check=0, pre-check=0', false);
 329     @header('Pragma: no-cache');
 330     @header('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
 331     @header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
 332
 333     echo '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">';
 334     echo '<html dir="'.(right_to_left() ? 'rtl' : 'ltr').'">
 335           <head>
 336           <link rel="shortcut icon" href="theme/clean/pix/favicon.ico" />';
 337
 338     echo '<link rel="stylesheet" type="text/css" href="'.$CFG->wwwroot.'/install/css.php" />
 339           <title>'.get_string('installation','install').' - Moodle '.$CFG->target_release.'</title>
 340           <meta name="robots" content="noindex">
 341           <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
 342           <meta http-equiv="pragma" content="no-cache" />
 343           <meta http-equiv="expires" content="0" />';
 344
 345     echo '</head><body class="notloggedin">
 346             <div id="page" class="stage'.$config->stage.'">
 347                 <div id="page-header">
 348                     <div id="header" class=" clearfix">
 349                         <h1 class="headermain">'.get_string('installation','install').'</h1>
 350                         <div class="headermenu">&nbsp;</div>
 351                     </div>
 352                     <div class="navbar clearfix">
 353                         <nav class="breadcrumb-nav">
 354                             <ul class="breadcrumb"><li class="first">'.$stagename.'</li></ul>
 355                         </nav>
 356                         <div class="navbutton">&nbsp;</div>
 357                     </div>
 358                 </div>
 359           <!-- END OF HEADER -->
 360           <div id="installdiv">';
 361
 362     echo '<h2>'.$heading.'</h2>';
 363
 364     if ($stagetext !== '') {
 365         echo '<div class="alert ' . $stageclass . '">';
 366         echo $stagetext;
 367         echo '</div>';
 368     }
 369     // main
 370     echo '<form id="installform" method="post" action="install.php"><fieldset>';
 371     foreach ($config as $name=>$value) {
 372         echo '<input type="hidden" name="'.$name.'" value="'.s($value).'" />';
 373     }
 374 }
 375
 376 /**
 377  * Prints installation page header, we can no use weblib yet in isntaller.
 378  *
 379  * @global object
 380  * @param array $config
 381  * @param bool $reload print reload button instead of next
 382  * @return void
 383  */
 384 function install_print_footer($config, $reload=false) {
 385     global $CFG;
 386
 387     if ($config->stage > INSTALL_WELCOME) {
 388         $first = '<input type="submit" id="previousbutton" name="previous" value="&laquo; '.s(get_string('previous')).'" />';
 389     } else {
 390         $first = '<input type="submit" id="previousbutton" name="next" value="'.s(get_string('reload')).'" />';
 391         $first .= '<script type="text/javascript">
 392 //<![CDATA[
 393     var first = document.getElementById("previousbutton");
 394     first.style.visibility = "hidden";
 395 //]]>
 396 </script>
 397 ';
 398     }
 399
 400     if ($reload) {
 401         $next = '<input type="submit" id="nextbutton" class="btn btn-primary" name="next" value="'.s(get_string('reload')).'" />';
 402     } else {
 403         $next = '<input type="submit" id="nextbutton" class="btn btn-primary" name="next" value="'.s(get_string('next')).' &raquo;" />';
 404     }
 405
 406     echo '</fieldset><fieldset id="nav_buttons">'.$first.$next.'</fieldset>';
 407
 408     $homelink  = '<div class="sitelink">'.
 409        '<a title="Moodle '. $CFG->target_release .'" href="http://docs.moodle.org/en/Administrator_documentation" onclick="this.target=\'_blank\'">'.
 410        '<img src="pix/moodlelogo.png" alt="'.get_string('moodlelogo').'" /></a></div>';
 411
 412     echo '</form></div>';
 413     echo '<div id="page-footer">'.$homelink.'</div>';
 414     echo '</div></body></html>';
 415 }
 416
 417 /**
 418  * Install Moodle DB,
 419  * config.php must exist, there must not be any tables in db yet.
 420  *
 421  * @param array $options adminpass is mandatory
 422  * @param bool $interactive
 423  * @return void
 424  */
 425 function install_cli_database(array $options, $interactive) {
 426     global $CFG, $DB;
 427     require_once($CFG->libdir.'/environmentlib.php');
 428     require_once($CFG->libdir.'/upgradelib.php');
 429
 430     // show as much debug as possible
 431     @error_reporting(E_ALL | E_STRICT);
 432     @ini_set('display_errors', '1');
 433     $CFG->debug = (E_ALL | E_STRICT);
 434     $CFG->debugdisplay = true;
 435     $CFG->debugdeveloper = true;
 436
 437     $CFG->version = '';
 438     $CFG->release = '';
 439     $CFG->branch = '';
 440
 441     $version = null;
 442     $release = null;
 443     $branch = null;
 444
 445     // read $version and $release
 446     require($CFG->dirroot.'/version.php');
 447
 448     if ($DB->get_tables() ) {
 449         cli_error(get_string('clitablesexist', 'install'));
 450     }
 451
 452     if (empty($options['adminpass'])) {
 453         cli_error('Missing required admin password');
 454     }
 455
 456     // test environment first
 457     list($envstatus, $environment_results) = check_moodle_environment(normalize_version($release), ENV_SELECT_RELEASE);
 458     if (!$envstatus) {
 459         $errors = environment_get_errors($environment_results);
 460         cli_heading(get_string('environment', 'admin'));
 461         foreach ($errors as $error) {
 462             list($info, $report) = $error;
 463             echo "!! $info !!\n$report\n\n";
 464         }
 465         exit(1);
 466     }
 467
 468     if (!$DB->setup_is_unicodedb()) {
 469         if (!$DB->change_db_encoding()) {
 470             // If could not convert successfully, throw error, and prevent installation
 471             cli_error(get_string('unicoderequired', 'admin'));
 472         }
 473     }
 474
 475     if ($interactive) {
 476         cli_separator();
 477         cli_heading(get_string('databasesetup'));
 478     }
 479
 480     // install core
 481     install_core($version, true);
 482     set_config('release', $release);
 483     set_config('branch', $branch);
 484
 485     if (PHPUNIT_TEST) {
 486         // mark as test database as soon as possible
 487         set_config('phpunittest', 'na');
 488     }
 489
 490     // install all plugins types, local, etc.
 491     upgrade_noncore(true);
 492
 493     // set up admin user password
 494     $DB->set_field('user', 'password', hash_internal_user_password($options['adminpass']), array('username' => 'admin'));
 495
 496     // Set the admin email address if specified.
 497     if (isset($options['adminemail'])) {
 498         $DB->set_field('user', 'email', $options['adminemail'], array('username' => 'admin'));
 499     }
 500
 501     // rename admin username if needed
 502     if (isset($options['adminuser']) and $options['adminuser'] !== 'admin' and $options['adminuser'] !== 'guest') {
 503         $DB->set_field('user', 'username', $options['adminuser'], array('username' => 'admin'));
 504     }
 505
 506     // indicate that this site is fully configured
 507     set_config('rolesactive', 1);
 508     upgrade_finished();
 509
 510     // log in as admin - we need do anything when applying defaults
 511     \core\session\manager::set_user(get_admin());
 512
 513     // apply all default settings, do it twice to fill all defaults - some settings depend on other setting
 514     admin_apply_default_settings(NULL, true);
 515     admin_apply_default_settings(NULL, true);
 516     set_config('registerauth', '');
 517
 518     // set the site name
 519     if (isset($options['shortname']) and $options['shortname'] !== '') {
 520         $DB->set_field('course', 'shortname', $options['shortname'], array('format' => 'site'));
 521     }
 522     if (isset($options['fullname']) and $options['fullname'] !== '') {
 523         $DB->set_field('course', 'fullname', $options['fullname'], array('format' => 'site'));
 524     }
 525     if (isset($options['summary'])) {
 526         $DB->set_field('course', 'summary', $options['summary'], array('format' => 'site'));
 527     }
 528
 529     // Redirect to site registration on first login.
 530     set_config('registrationpending', 1);
 531 }