cd265676af5e63c835f677623404f1fba60cae23
[moodle.git] / admin / cli / upgrade.php
1 <?php
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/>.
18 /**
19  * This script creates config.php file and prepares database.
20  *
21  * This script is not intended for beginners!
22  * Potential problems:
23  * - su to apache account or sudo before execution
24  * - not compatible with Windows platform
25  *
26  * @package    core
27  * @subpackage cli
28  * @copyright  2009 Petr Skoda (http://skodak.org)
29  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
30  */
32 // Force OPcache reset if used, we do not want any stale caches
33 // when detecting if upgrade necessary or when running upgrade.
34 if (function_exists('opcache_reset') and !isset($_SERVER['REMOTE_ADDR'])) {
35     opcache_reset();
36 }
38 define('CLI_SCRIPT', true);
39 define('CACHE_DISABLE_ALL', true);
41 require(dirname(dirname(dirname(__FILE__))).'/config.php');
42 require_once($CFG->libdir.'/adminlib.php');       // various admin-only functions
43 require_once($CFG->libdir.'/upgradelib.php');     // general upgrade/install related functions
44 require_once($CFG->libdir.'/clilib.php');         // cli only functions
45 require_once($CFG->libdir.'/environmentlib.php');
47 // now get cli options
48 list($options, $unrecognized) = cli_get_params(
49     array(
50         'non-interactive'   => false,
51         'allow-unstable'    => false,
52         'help'              => false,
53         'lang'              => 'en'
54     ),
55     array(
56         'h' => 'help'
57     )
58 );
60 global $SESSION;
61 if ($options['lang']) {
62     $SESSION->lang = $options['lang'];
63 } else {
64     $SESSION->lang = 'en';
65 }
67 $interactive = empty($options['non-interactive']);
69 if ($unrecognized) {
70     $unrecognized = implode("\n  ", $unrecognized);
71     cli_error(get_string('cliunknowoption', 'admin', $unrecognized));
72 }
74 if ($options['help']) {
75     $help =
76 "Command line Moodle upgrade.
77 Please note you must execute this script with the same uid as apache!
79 Site defaults may be changed via local/defaults.php.
81 Options:
82 --non-interactive     No interactive questions or confirmations
83 --allow-unstable      Upgrade even if the version is not marked as stable yet,
84                       required in non-interactive mode.
85 --lang=CODE           Set preferred language for CLI output, during upgrade process (default:en).
86 -h, --help            Print out this help
88 Example:
89 \$sudo -u www-data /usr/bin/php admin/cli/upgrade.php
90 "; //TODO: localize - to be translated later when everything is finished
92     echo $help;
93     die;
94 }
96 if (empty($CFG->version)) {
97     cli_error(get_string('missingconfigversion', 'debug'));
98 }
100 require("$CFG->dirroot/version.php");       // defines $version, $release, $branch and $maturity
101 $CFG->target_release = $release;            // used during installation and upgrades
103 if ($version < $CFG->version) {
104     cli_error(get_string('downgradedcore', 'error'));
107 $oldversion = "$CFG->release ($CFG->version)";
108 $newversion = "$release ($version)";
110 if (!moodle_needs_upgrading()) {
111     cli_error(get_string('cliupgradenoneed', 'core_admin', $newversion), 0);
114 // Test environment first.
115 list($envstatus, $environment_results) = check_moodle_environment(normalize_version($release), ENV_SELECT_RELEASE);
116 if (!$envstatus) {
117     $errors = environment_get_errors($environment_results);
118     cli_heading(get_string('environment', 'admin'));
119     foreach ($errors as $error) {
120         list($info, $report) = $error;
121         echo "!! $info !!\n$report\n\n";
122     }
123     exit(1);
126 // Test plugin dependencies.
127 $failed = array();
128 if (!core_plugin_manager::instance()->all_plugins_ok($version, $failed)) {
129     cli_problem(get_string('pluginscheckfailed', 'admin', array('pluginslist' => implode(', ', array_unique($failed)))));
130     cli_error(get_string('pluginschecktodo', 'admin'));
133 if ($interactive) {
134     $a = new stdClass();
135     $a->oldversion = $oldversion;
136     $a->newversion = $newversion;
137     echo cli_heading(get_string('databasechecking', '', $a)) . PHP_EOL;
140 // make sure we are upgrading to a stable release or display a warning
141 if (isset($maturity)) {
142     if (($maturity < MATURITY_STABLE) and !$options['allow-unstable']) {
143         $maturitylevel = get_string('maturity'.$maturity, 'admin');
145         if ($interactive) {
146             cli_separator();
147             cli_heading(get_string('notice'));
148             echo get_string('maturitycorewarning', 'admin', $maturitylevel) . PHP_EOL;
149             echo get_string('morehelp') . ': ' . get_docs_url('admin/versions') . PHP_EOL;
150             cli_separator();
151         } else {
152             cli_problem(get_string('maturitycorewarning', 'admin', $maturitylevel));
153             cli_error(get_string('maturityallowunstable', 'admin'));
154         }
155     }
158 if ($interactive) {
159     echo html_to_text(get_string('upgradesure', 'admin', $newversion))."\n";
160     $prompt = get_string('cliyesnoprompt', 'admin');
161     $input = cli_input($prompt, '', array(get_string('clianswerno', 'admin'), get_string('cliansweryes', 'admin')));
162     if ($input == get_string('clianswerno', 'admin')) {
163         exit(1);
164     }
167 if ($version > $CFG->version) {
168     // We purge all of MUC's caches here.
169     // Caches are disabled for upgrade by CACHE_DISABLE_ALL so we must set the first arg to true.
170     // This ensures a real config object is loaded and the stores will be purged.
171     // This is the only way we can purge custom caches such as memcache or APC.
172     // Note: all other calls to caches will still used the disabled API.
173     cache_helper::purge_all(true);
174     upgrade_core($version, true);
176 set_config('release', $release);
177 set_config('branch', $branch);
179 // unconditionally upgrade
180 upgrade_noncore(true);
182 // log in as admin - we need doanything permission when applying defaults
183 \core\session\manager::set_user(get_admin());
185 // apply all default settings, just in case do it twice to fill all defaults
186 admin_apply_default_settings(NULL, false);
187 admin_apply_default_settings(NULL, false);
189 echo get_string('cliupgradefinished', 'admin')."\n";
190 exit(0); // 0 means success