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 installs Moodle into empty database, config.php must already exist.
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
27 * @copyright 2010 Petr Skoda (http://skodak.org)
28 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
31 define('CLI_SCRIPT', true);
32 define('CACHE_DISABLE_ALL', true);
34 // extra execution prevention - we can not just require config.php here
35 if (isset($_SERVER['REMOTE_ADDR'])) {
39 // Force OPcache reset if used, we do not want any stale caches
40 // when preparing test environment.
41 if (function_exists('opcache_reset')) {
46 "Advanced command line Moodle database installer.
47 Please note you must execute this script with the same uid as apache.
49 Site defaults may be changed via local/defaults.php.
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 -h, --help Print out this help
62 \$sudo -u www-data /usr/bin/php admin/cli/install_database.php --lang=cs --adminpass=soMePass123 --agree-license
65 // Check that PHP is of a sufficient version as soon as possible.
66 require_once(__DIR__
.'/../../lib/phpminimumversionlib.php');
67 moodle_require_minimum_php_version();
69 // Nothing to do if config.php does not exist
70 $configfile = __DIR__
.'/../../config.php';
71 if (!file_exists($configfile)) {
72 fwrite(STDERR
, 'config.php does not exist, can not continue'); // do not localize
77 // Include necessary libs
80 require_once($CFG->libdir
.'/clilib.php');
81 require_once($CFG->libdir
.'/installlib.php');
82 require_once($CFG->libdir
.'/adminlib.php');
83 require_once($CFG->libdir
.'/componentlib.class.php');
85 // make sure no tables are installed yet
86 if ($DB->get_tables() ) {
87 cli_error(get_string('clitablesexist', 'install'));
90 $CFG->early_install_lang
= true;
91 get_string_manager(true);
93 raise_memory_limit(MEMORY_EXTRA
);
95 // now get cli options
96 list($options, $unrecognized) = cli_get_params(
99 'adminuser' => 'admin',
104 'agree-license' => false,
113 if ($options['help']) {
118 if (!$options['agree-license']) {
119 cli_error('You have to agree to the license. --help prints out the help'); // TODO: localize
122 if ($options['adminpass'] === true or $options['adminpass'] === '') {
123 cli_error('You have to specify admin password. --help prints out the help'); // TODO: localize
126 // Validate that the address provided was an e-mail address.
127 if (!empty($options['adminemail']) && !validate_email($options['adminemail'])) {
128 $a = (object) array('option' => 'adminemail', 'value' => $options['adminemail']);
129 cli_error(get_string('cliincorrectvalueerror', 'admin', $a));
132 $options['lang'] = clean_param($options['lang'], PARAM_SAFEDIR
);
133 if (!file_exists($CFG->dirroot
.'/install/lang/'.$options['lang'])) {
134 $options['lang'] = 'en';
136 $CFG->lang
= $options['lang'];
138 // download required lang packs
139 if ($CFG->lang
!== 'en') {
140 make_upload_directory('lang');
141 $installer = new lang_installer($CFG->lang
);
142 $results = $installer->run();
143 foreach ($results as $langcode => $langstatus) {
144 if ($langstatus === lang_installer
::RESULT_DOWNLOADERROR
) {
146 $a->url
= $installer->lang_pack_url($langcode);
147 $a->dest
= $CFG->dataroot
.'/lang';
148 cli_problem(get_string('remotedownloaderror', 'error', $a));
153 // switch the string_manager instance to stop using install/lang/
154 $CFG->early_install_lang
= false;
155 get_string_manager(true);
157 require("$CFG->dirroot/version.php");
159 // Test environment first.
160 require_once($CFG->libdir
. '/environmentlib.php');
161 list($envstatus, $environment_results) = check_moodle_environment(normalize_version($release), ENV_SELECT_RELEASE
);
163 $errors = environment_get_errors($environment_results);
164 cli_heading(get_string('environment', 'admin'));
165 foreach ($errors as $error) {
166 list($info, $report) = $error;
167 echo "!! $info !!\n$report\n\n";
172 // Test plugin dependencies.
174 if (!core_plugin_manager
::instance()->all_plugins_ok($version, $failed)) {
175 cli_problem(get_string('pluginscheckfailed', 'admin', array('pluginslist' => implode(', ', array_unique($failed)))));
176 cli_error(get_string('pluginschecktodo', 'admin'));
179 install_cli_database($options, true);
181 // This needs to happen at the end to ensure it occurs after all caches
182 // have been purged for the last time.
183 // This will build a cached version of the current theme for the user
184 // to immediately start browsing the site.
185 require_once($CFG->libdir
.'/upgradelib.php');
188 echo get_string('cliinstallfinished', 'install')."\n";
189 exit(0); // 0 means success