admin/cli/install_database.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  * This installs Moodle into empty database, config.php must already exist.
  20  *
  21  * This script is intended for advanced usage such as in Debian packages.
  22  * - sudo to www-data (apache account) before
  23  * - not compatible with Windows platform
  24  *
  25  * @package    core
  26  * @subpackage cli
  27  * @copyright  2010 Petr Skoda (http://skodak.org)
  28  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  29  */
  30
  31 define('CLI_SCRIPT', true);
  32 define('CACHE_DISABLE_ALL', true);
  33
  34 // extra execution prevention - we can not just require config.php here
  35 if (isset($_SERVER['REMOTE_ADDR'])) {
  36     exit(1);
  37 }
  38
  39 // Force OPcache reset if used, we do not want any stale caches
  40 // when preparing test environment.
  41 if (function_exists('opcache_reset')) {
  42     opcache_reset();
  43 }
  44
  45 $help =
  46 "Advanced command line Moodle database installer.
  47 Please note you must execute this script with the same uid as apache.
  48
  49 Site defaults may be changed via local/defaults.php.
  50
  51 Options:
  52 --lang=CODE           Installation and default site language. Default is en.
  53 --adminuser=USERNAME  Username for the moodle admin account. Default is admin.
  54 --adminpass=PASSWORD  Password for the moodle admin account.
  55 --adminemail=STRING   Email address for the moodle admin account.
  56 --agree-license       Indicates agreement with software license.
  57 --fullname=STRING     Name of the site
  58 --shortname=STRING    Name of the site
  59 --summary=STRING      The summary to be displayed on the front page
  60 -h, --help            Print out this help
  61
  62 Example:
  63 \$sudo -u www-data /usr/bin/php admin/cli/install_database.php --lang=cs --adminpass=soMePass123 --agree-license
  64 ";
  65
  66 // Check that PHP is of a sufficient version as soon as possible.
  67 require_once(__DIR__.'/../../lib/phpminimumversionlib.php');
  68 moodle_require_minimum_php_version();
  69
  70 // Nothing to do if config.php does not exist
  71 $configfile = __DIR__.'/../../config.php';
  72 if (!file_exists($configfile)) {
  73     fwrite(STDERR, 'config.php does not exist, can not continue'); // do not localize
  74     fwrite(STDERR, "\n");
  75     exit(1);
  76 }
  77
  78 // Include necessary libs
  79 require($configfile);
  80
  81 require_once($CFG->libdir.'/clilib.php');
  82 require_once($CFG->libdir.'/installlib.php');
  83 require_once($CFG->libdir.'/adminlib.php');
  84 require_once($CFG->libdir.'/componentlib.class.php');
  85
  86 $CFG->early_install_lang = true;
  87 get_string_manager(true);
  88
  89 raise_memory_limit(MEMORY_EXTRA);
  90
  91 // now get cli options
  92 list($options, $unrecognized) = cli_get_params(
  93     array(
  94         'lang'              => 'en',
  95         'adminuser'         => 'admin',
  96         'adminpass'         => '',
  97         'adminemail'        => '',
  98         'fullname'          => '',
  99         'shortname'         => '',
 100         'summary'           => '',
 101         'agree-license'     => false,
 102         'help'              => false
 103     ),
 104     array(
 105         'h' => 'help'
 106     )
 107 );
 108
 109 if ($unrecognized) {
 110     $unrecognized = implode("\n  ", $unrecognized);
 111     cli_error(get_string('cliunknowoption', 'admin', $unrecognized));
 112 }
 113
 114 // We show help text even if tables are installed.
 115 if ($options['help']) {
 116     echo $help;
 117     die;
 118 }
 119
 120 // Make sure no tables are installed yet.
 121 if ($DB->get_tables() ) {
 122     cli_error(get_string('clitablesexist', 'install'));
 123 }
 124
 125 if (!$options['agree-license']) {
 126     cli_error('You have to agree to the license. --help prints out the help'); // TODO: localize
 127 }
 128
 129 if ($options['adminpass'] === true or $options['adminpass'] === '') {
 130     cli_error('You have to specify admin password. --help prints out the help'); // TODO: localize
 131 }
 132
 133 // Validate that the address provided was an e-mail address.
 134 if (!empty($options['adminemail']) && !validate_email($options['adminemail'])) {
 135     $a = (object) array('option' => 'adminemail', 'value' => $options['adminemail']);
 136     cli_error(get_string('cliincorrectvalueerror', 'admin', $a));
 137 }
 138
 139 $options['lang'] = clean_param($options['lang'], PARAM_SAFEDIR);
 140 if (!file_exists($CFG->dirroot.'/install/lang/'.$options['lang'])) {
 141     $options['lang'] = 'en';
 142 }
 143 $CFG->lang = $options['lang'];
 144
 145 // download required lang packs
 146 if ($CFG->lang !== 'en') {
 147     make_upload_directory('lang');
 148     $installer = new lang_installer($CFG->lang);
 149     $results = $installer->run();
 150     foreach ($results as $langcode => $langstatus) {
 151         if ($langstatus === lang_installer::RESULT_DOWNLOADERROR) {
 152             $a       = new stdClass();
 153             $a->url  = $installer->lang_pack_url($langcode);
 154             $a->dest = $CFG->dataroot.'/lang';
 155             cli_problem(get_string('remotedownloaderror', 'error', $a));
 156         }
 157     }
 158 }
 159
 160 // switch the string_manager instance to stop using install/lang/
 161 $CFG->early_install_lang = false;
 162 get_string_manager(true);
 163
 164 require("$CFG->dirroot/version.php");
 165
 166 // Test environment first.
 167 require_once($CFG->libdir . '/environmentlib.php');
 168 list($envstatus, $environment_results) = check_moodle_environment(normalize_version($release), ENV_SELECT_RELEASE);
 169 if (!$envstatus) {
 170     $errors = environment_get_errors($environment_results);
 171     cli_heading(get_string('environment', 'admin'));
 172     foreach ($errors as $error) {
 173         list($info, $report) = $error;
 174         echo "!! $info !!\n$report\n\n";
 175     }
 176     exit(1);
 177 }
 178
 179 // Test plugin dependencies.
 180 $failed = array();
 181 if (!core_plugin_manager::instance()->all_plugins_ok($version, $failed)) {
 182     cli_problem(get_string('pluginscheckfailed', 'admin', array('pluginslist' => implode(', ', array_unique($failed)))));
 183     cli_error(get_string('pluginschecktodo', 'admin'));
 184 }
 185
 186 install_cli_database($options, true);
 187
 188 // This needs to happen at the end to ensure it occurs after all caches
 189 // have been purged for the last time.
 190 // This will build a cached version of the current theme for the user
 191 // to immediately start browsing the site.
 192 require_once($CFG->libdir.'/upgradelib.php');
 193 upgrade_themes();
 194
 195 echo get_string('cliinstallfinished', 'install')."\n";
 196 exit(0); // 0 means success