weekly on-sync release 3.3dev
[moodle.git] / lib / upgradelib.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  * Various upgrade/install related functions and classes.
20  *
21  * @package    core
22  * @subpackage upgrade
23  * @copyright  1999 onwards Martin Dougiamas (http://dougiamas.com)
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 defined('MOODLE_INTERNAL') || die();
29 /** UPGRADE_LOG_NORMAL = 0 */
30 define('UPGRADE_LOG_NORMAL', 0);
31 /** UPGRADE_LOG_NOTICE = 1 */
32 define('UPGRADE_LOG_NOTICE', 1);
33 /** UPGRADE_LOG_ERROR = 2 */
34 define('UPGRADE_LOG_ERROR',  2);
36 /**
37  * Exception indicating unknown error during upgrade.
38  *
39  * @package    core
40  * @subpackage upgrade
41  * @copyright  2009 Petr Skoda {@link http://skodak.org}
42  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
43  */
44 class upgrade_exception extends moodle_exception {
45     function __construct($plugin, $version, $debuginfo=NULL) {
46         global $CFG;
47         $a = (object)array('plugin'=>$plugin, 'version'=>$version);
48         parent::__construct('upgradeerror', 'admin', "$CFG->wwwroot/$CFG->admin/index.php", $a, $debuginfo);
49     }
50 }
52 /**
53  * Exception indicating downgrade error during upgrade.
54  *
55  * @package    core
56  * @subpackage upgrade
57  * @copyright  2009 Petr Skoda {@link http://skodak.org}
58  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
59  */
60 class downgrade_exception extends moodle_exception {
61     function __construct($plugin, $oldversion, $newversion) {
62         global $CFG;
63         $plugin = is_null($plugin) ? 'moodle' : $plugin;
64         $a = (object)array('plugin'=>$plugin, 'oldversion'=>$oldversion, 'newversion'=>$newversion);
65         parent::__construct('cannotdowngrade', 'debug', "$CFG->wwwroot/$CFG->admin/index.php", $a);
66     }
67 }
69 /**
70  * @package    core
71  * @subpackage upgrade
72  * @copyright  2009 Petr Skoda {@link http://skodak.org}
73  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
74  */
75 class upgrade_requires_exception extends moodle_exception {
76     function __construct($plugin, $pluginversion, $currentmoodle, $requiremoodle) {
77         global $CFG;
78         $a = new stdClass();
79         $a->pluginname     = $plugin;
80         $a->pluginversion  = $pluginversion;
81         $a->currentmoodle  = $currentmoodle;
82         $a->requiremoodle  = $requiremoodle;
83         parent::__construct('pluginrequirementsnotmet', 'error', "$CFG->wwwroot/$CFG->admin/index.php", $a);
84     }
85 }
87 /**
88  * @package    core
89  * @subpackage upgrade
90  * @copyright  2009 Petr Skoda {@link http://skodak.org}
91  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
92  */
93 class plugin_defective_exception extends moodle_exception {
94     function __construct($plugin, $details) {
95         global $CFG;
96         parent::__construct('detectedbrokenplugin', 'error', "$CFG->wwwroot/$CFG->admin/index.php", $plugin, $details);
97     }
98 }
100 /**
101  * Misplaced plugin exception.
102  *
103  * Note: this should be used only from the upgrade/admin code.
104  *
105  * @package    core
106  * @subpackage upgrade
107  * @copyright  2009 Petr Skoda {@link http://skodak.org}
108  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
109  */
110 class plugin_misplaced_exception extends moodle_exception {
111     /**
112      * Constructor.
113      * @param string $component the component from version.php
114      * @param string $expected expected directory, null means calculate
115      * @param string $current plugin directory path
116      */
117     public function __construct($component, $expected, $current) {
118         global $CFG;
119         if (empty($expected)) {
120             list($type, $plugin) = core_component::normalize_component($component);
121             $plugintypes = core_component::get_plugin_types();
122             if (isset($plugintypes[$type])) {
123                 $expected = $plugintypes[$type] . '/' . $plugin;
124             }
125         }
126         if (strpos($expected, '$CFG->dirroot') !== 0) {
127             $expected = str_replace($CFG->dirroot, '$CFG->dirroot', $expected);
128         }
129         if (strpos($current, '$CFG->dirroot') !== 0) {
130             $current = str_replace($CFG->dirroot, '$CFG->dirroot', $current);
131         }
132         $a = new stdClass();
133         $a->component = $component;
134         $a->expected  = $expected;
135         $a->current   = $current;
136         parent::__construct('detectedmisplacedplugin', 'core_plugin', "$CFG->wwwroot/$CFG->admin/index.php", $a);
137     }
140 /**
141  * Sets maximum expected time needed for upgrade task.
142  * Please always make sure that upgrade will not run longer!
143  *
144  * The script may be automatically aborted if upgrade times out.
145  *
146  * @category upgrade
147  * @param int $max_execution_time in seconds (can not be less than 60 s)
148  */
149 function upgrade_set_timeout($max_execution_time=300) {
150     global $CFG;
152     if (!isset($CFG->upgraderunning) or $CFG->upgraderunning < time()) {
153         $upgraderunning = get_config(null, 'upgraderunning');
154     } else {
155         $upgraderunning = $CFG->upgraderunning;
156     }
158     if (!$upgraderunning) {
159         if (CLI_SCRIPT) {
160             // never stop CLI upgrades
161             $upgraderunning = 0;
162         } else {
163             // web upgrade not running or aborted
164             print_error('upgradetimedout', 'admin', "$CFG->wwwroot/$CFG->admin/");
165         }
166     }
168     if ($max_execution_time < 60) {
169         // protection against 0 here
170         $max_execution_time = 60;
171     }
173     $expected_end = time() + $max_execution_time;
175     if ($expected_end < $upgraderunning + 10 and $expected_end > $upgraderunning - 10) {
176         // no need to store new end, it is nearly the same ;-)
177         return;
178     }
180     if (CLI_SCRIPT) {
181         // there is no point in timing out of CLI scripts, admins can stop them if necessary
182         core_php_time_limit::raise();
183     } else {
184         core_php_time_limit::raise($max_execution_time);
185     }
186     set_config('upgraderunning', $expected_end); // keep upgrade locked until this time
189 /**
190  * Upgrade savepoint, marks end of each upgrade block.
191  * It stores new main version, resets upgrade timeout
192  * and abort upgrade if user cancels page loading.
193  *
194  * Please do not make large upgrade blocks with lots of operations,
195  * for example when adding tables keep only one table operation per block.
196  *
197  * @category upgrade
198  * @param bool $result false if upgrade step failed, true if completed
199  * @param string or float $version main version
200  * @param bool $allowabort allow user to abort script execution here
201  * @return void
202  */
203 function upgrade_main_savepoint($result, $version, $allowabort=true) {
204     global $CFG;
206     //sanity check to avoid confusion with upgrade_mod_savepoint usage.
207     if (!is_bool($allowabort)) {
208         $errormessage = 'Parameter type mismatch. Are you mixing up upgrade_main_savepoint() and upgrade_mod_savepoint()?';
209         throw new coding_exception($errormessage);
210     }
212     if (!$result) {
213         throw new upgrade_exception(null, $version);
214     }
216     if ($CFG->version >= $version) {
217         // something really wrong is going on in main upgrade script
218         throw new downgrade_exception(null, $CFG->version, $version);
219     }
221     set_config('version', $version);
222     upgrade_log(UPGRADE_LOG_NORMAL, null, 'Upgrade savepoint reached');
224     // reset upgrade timeout to default
225     upgrade_set_timeout();
227     // this is a safe place to stop upgrades if user aborts page loading
228     if ($allowabort and connection_aborted()) {
229         die;
230     }
233 /**
234  * Module upgrade savepoint, marks end of module upgrade blocks
235  * It stores module version, resets upgrade timeout
236  * and abort upgrade if user cancels page loading.
237  *
238  * @category upgrade
239  * @param bool $result false if upgrade step failed, true if completed
240  * @param string or float $version main version
241  * @param string $modname name of module
242  * @param bool $allowabort allow user to abort script execution here
243  * @return void
244  */
245 function upgrade_mod_savepoint($result, $version, $modname, $allowabort=true) {
246     global $DB;
248     $component = 'mod_'.$modname;
250     if (!$result) {
251         throw new upgrade_exception($component, $version);
252     }
254     $dbversion = $DB->get_field('config_plugins', 'value', array('plugin'=>$component, 'name'=>'version'));
256     if (!$module = $DB->get_record('modules', array('name'=>$modname))) {
257         print_error('modulenotexist', 'debug', '', $modname);
258     }
260     if ($dbversion >= $version) {
261         // something really wrong is going on in upgrade script
262         throw new downgrade_exception($component, $dbversion, $version);
263     }
264     set_config('version', $version, $component);
266     upgrade_log(UPGRADE_LOG_NORMAL, $component, 'Upgrade savepoint reached');
268     // reset upgrade timeout to default
269     upgrade_set_timeout();
271     // this is a safe place to stop upgrades if user aborts page loading
272     if ($allowabort and connection_aborted()) {
273         die;
274     }
277 /**
278  * Blocks upgrade savepoint, marks end of blocks upgrade blocks
279  * It stores block version, resets upgrade timeout
280  * and abort upgrade if user cancels page loading.
281  *
282  * @category upgrade
283  * @param bool $result false if upgrade step failed, true if completed
284  * @param string or float $version main version
285  * @param string $blockname name of block
286  * @param bool $allowabort allow user to abort script execution here
287  * @return void
288  */
289 function upgrade_block_savepoint($result, $version, $blockname, $allowabort=true) {
290     global $DB;
292     $component = 'block_'.$blockname;
294     if (!$result) {
295         throw new upgrade_exception($component, $version);
296     }
298     $dbversion = $DB->get_field('config_plugins', 'value', array('plugin'=>$component, 'name'=>'version'));
300     if (!$block = $DB->get_record('block', array('name'=>$blockname))) {
301         print_error('blocknotexist', 'debug', '', $blockname);
302     }
304     if ($dbversion >= $version) {
305         // something really wrong is going on in upgrade script
306         throw new downgrade_exception($component, $dbversion, $version);
307     }
308     set_config('version', $version, $component);
310     upgrade_log(UPGRADE_LOG_NORMAL, $component, 'Upgrade savepoint reached');
312     // reset upgrade timeout to default
313     upgrade_set_timeout();
315     // this is a safe place to stop upgrades if user aborts page loading
316     if ($allowabort and connection_aborted()) {
317         die;
318     }
321 /**
322  * Plugins upgrade savepoint, marks end of blocks upgrade blocks
323  * It stores plugin version, resets upgrade timeout
324  * and abort upgrade if user cancels page loading.
325  *
326  * @category upgrade
327  * @param bool $result false if upgrade step failed, true if completed
328  * @param string or float $version main version
329  * @param string $type name of plugin
330  * @param string $dir location of plugin
331  * @param bool $allowabort allow user to abort script execution here
332  * @return void
333  */
334 function upgrade_plugin_savepoint($result, $version, $type, $plugin, $allowabort=true) {
335     global $DB;
337     $component = $type.'_'.$plugin;
339     if (!$result) {
340         throw new upgrade_exception($component, $version);
341     }
343     $dbversion = $DB->get_field('config_plugins', 'value', array('plugin'=>$component, 'name'=>'version'));
345     if ($dbversion >= $version) {
346         // Something really wrong is going on in the upgrade script
347         throw new downgrade_exception($component, $dbversion, $version);
348     }
349     set_config('version', $version, $component);
350     upgrade_log(UPGRADE_LOG_NORMAL, $component, 'Upgrade savepoint reached');
352     // Reset upgrade timeout to default
353     upgrade_set_timeout();
355     // This is a safe place to stop upgrades if user aborts page loading
356     if ($allowabort and connection_aborted()) {
357         die;
358     }
361 /**
362  * Detect if there are leftovers in PHP source files.
363  *
364  * During main version upgrades administrators MUST move away
365  * old PHP source files and start from scratch (or better
366  * use git).
367  *
368  * @return bool true means borked upgrade, false means previous PHP files were properly removed
369  */
370 function upgrade_stale_php_files_present() {
371     global $CFG;
373     $someexamplesofremovedfiles = array(
374         // Removed in 3.2.
375         '/calendar/preferences.php',
376         '/lib/alfresco/',
377         '/lib/jquery/jquery-1.12.1.min.js',
378         '/lib/password_compat/tests/',
379         '/lib/phpunit/classes/unittestcase.php',
380         // Removed in 3.1.
381         '/lib/classes/log/sql_internal_reader.php',
382         '/lib/zend/',
383         '/mod/forum/pix/icon.gif',
384         '/tag/templates/tagname.mustache',
385         // Removed in 3.0.
386         '/mod/lti/grade.php',
387         '/tag/coursetagslib.php',
388         // Removed in 2.9.
389         '/lib/timezone.txt',
390         // Removed in 2.8.
391         '/course/delete_category_form.php',
392         // Removed in 2.7.
393         '/admin/tool/qeupgradehelper/version.php',
394         // Removed in 2.6.
395         '/admin/block.php',
396         '/admin/oacleanup.php',
397         // Removed in 2.5.
398         '/backup/lib.php',
399         '/backup/bb/README.txt',
400         '/lib/excel/test.php',
401         // Removed in 2.4.
402         '/admin/tool/unittest/simpletestlib.php',
403         // Removed in 2.3.
404         '/lib/minify/builder/',
405         // Removed in 2.2.
406         '/lib/yui/3.4.1pr1/',
407         // Removed in 2.2.
408         '/search/cron_php5.php',
409         '/course/report/log/indexlive.php',
410         '/admin/report/backups/index.php',
411         '/admin/generator.php',
412         // Removed in 2.1.
413         '/lib/yui/2.8.0r4/',
414         // Removed in 2.0.
415         '/blocks/admin/block_admin.php',
416         '/blocks/admin_tree/block_admin_tree.php',
417     );
419     foreach ($someexamplesofremovedfiles as $file) {
420         if (file_exists($CFG->dirroot.$file)) {
421             return true;
422         }
423     }
425     return false;
428 /**
429  * Upgrade plugins
430  * @param string $type The type of plugins that should be updated (e.g. 'enrol', 'qtype')
431  * return void
432  */
433 function upgrade_plugins($type, $startcallback, $endcallback, $verbose) {
434     global $CFG, $DB;
436 /// special cases
437     if ($type === 'mod') {
438         return upgrade_plugins_modules($startcallback, $endcallback, $verbose);
439     } else if ($type === 'block') {
440         return upgrade_plugins_blocks($startcallback, $endcallback, $verbose);
441     }
443     $plugs = core_component::get_plugin_list($type);
445     foreach ($plugs as $plug=>$fullplug) {
446         // Reset time so that it works when installing a large number of plugins
447         core_php_time_limit::raise(600);
448         $component = clean_param($type.'_'.$plug, PARAM_COMPONENT); // standardised plugin name
450         // check plugin dir is valid name
451         if (empty($component)) {
452             throw new plugin_defective_exception($type.'_'.$plug, 'Invalid plugin directory name.');
453         }
455         if (!is_readable($fullplug.'/version.php')) {
456             continue;
457         }
459         $plugin = new stdClass();
460         $plugin->version = null;
461         $module = $plugin; // Prevent some notices when plugin placed in wrong directory.
462         require($fullplug.'/version.php');  // defines $plugin with version etc
463         unset($module);
465         if (empty($plugin->version)) {
466             throw new plugin_defective_exception($component, 'Missing $plugin->version number in version.php.');
467         }
469         if (empty($plugin->component)) {
470             throw new plugin_defective_exception($component, 'Missing $plugin->component declaration in version.php.');
471         }
473         if ($plugin->component !== $component) {
474             throw new plugin_misplaced_exception($plugin->component, null, $fullplug);
475         }
477         $plugin->name     = $plug;
478         $plugin->fullname = $component;
480         if (!empty($plugin->requires)) {
481             if ($plugin->requires > $CFG->version) {
482                 throw new upgrade_requires_exception($component, $plugin->version, $CFG->version, $plugin->requires);
483             } else if ($plugin->requires < 2010000000) {
484                 throw new plugin_defective_exception($component, 'Plugin is not compatible with Moodle 2.x or later.');
485             }
486         }
488         // try to recover from interrupted install.php if needed
489         if (file_exists($fullplug.'/db/install.php')) {
490             if (get_config($plugin->fullname, 'installrunning')) {
491                 require_once($fullplug.'/db/install.php');
492                 $recover_install_function = 'xmldb_'.$plugin->fullname.'_install_recovery';
493                 if (function_exists($recover_install_function)) {
494                     $startcallback($component, true, $verbose);
495                     $recover_install_function();
496                     unset_config('installrunning', $plugin->fullname);
497                     update_capabilities($component);
498                     log_update_descriptions($component);
499                     external_update_descriptions($component);
500                     events_update_definition($component);
501                     \core\task\manager::reset_scheduled_tasks_for_component($component);
502                     message_update_providers($component);
503                     \core\message\inbound\manager::update_handlers_for_component($component);
504                     if ($type === 'message') {
505                         message_update_processors($plug);
506                     }
507                     upgrade_plugin_mnet_functions($component);
508                     core_tag_area::reset_definitions_for_component($component);
509                     $endcallback($component, true, $verbose);
510                 }
511             }
512         }
514         $installedversion = $DB->get_field('config_plugins', 'value', array('name'=>'version', 'plugin'=>$component)); // No caching!
515         if (empty($installedversion)) { // new installation
516             $startcallback($component, true, $verbose);
518         /// Install tables if defined
519             if (file_exists($fullplug.'/db/install.xml')) {
520                 $DB->get_manager()->install_from_xmldb_file($fullplug.'/db/install.xml');
521             }
523         /// store version
524             upgrade_plugin_savepoint(true, $plugin->version, $type, $plug, false);
526         /// execute post install file
527             if (file_exists($fullplug.'/db/install.php')) {
528                 require_once($fullplug.'/db/install.php');
529                 set_config('installrunning', 1, $plugin->fullname);
530                 $post_install_function = 'xmldb_'.$plugin->fullname.'_install';
531                 $post_install_function();
532                 unset_config('installrunning', $plugin->fullname);
533             }
535         /// Install various components
536             update_capabilities($component);
537             log_update_descriptions($component);
538             external_update_descriptions($component);
539             events_update_definition($component);
540             \core\task\manager::reset_scheduled_tasks_for_component($component);
541             message_update_providers($component);
542             \core\message\inbound\manager::update_handlers_for_component($component);
543             if ($type === 'message') {
544                 message_update_processors($plug);
545             }
546             upgrade_plugin_mnet_functions($component);
547             core_tag_area::reset_definitions_for_component($component);
548             $endcallback($component, true, $verbose);
550         } else if ($installedversion < $plugin->version) { // upgrade
551         /// Run the upgrade function for the plugin.
552             $startcallback($component, false, $verbose);
554             if (is_readable($fullplug.'/db/upgrade.php')) {
555                 require_once($fullplug.'/db/upgrade.php');  // defines upgrading function
557                 $newupgrade_function = 'xmldb_'.$plugin->fullname.'_upgrade';
558                 $result = $newupgrade_function($installedversion);
559             } else {
560                 $result = true;
561             }
563             $installedversion = $DB->get_field('config_plugins', 'value', array('name'=>'version', 'plugin'=>$component)); // No caching!
564             if ($installedversion < $plugin->version) {
565                 // store version if not already there
566                 upgrade_plugin_savepoint($result, $plugin->version, $type, $plug, false);
567             }
569         /// Upgrade various components
570             update_capabilities($component);
571             log_update_descriptions($component);
572             external_update_descriptions($component);
573             events_update_definition($component);
574             \core\task\manager::reset_scheduled_tasks_for_component($component);
575             message_update_providers($component);
576             \core\message\inbound\manager::update_handlers_for_component($component);
577             if ($type === 'message') {
578                 // Ugly hack!
579                 message_update_processors($plug);
580             }
581             upgrade_plugin_mnet_functions($component);
582             core_tag_area::reset_definitions_for_component($component);
583             $endcallback($component, false, $verbose);
585         } else if ($installedversion > $plugin->version) {
586             throw new downgrade_exception($component, $installedversion, $plugin->version);
587         }
588     }
591 /**
592  * Find and check all modules and load them up or upgrade them if necessary
593  *
594  * @global object
595  * @global object
596  */
597 function upgrade_plugins_modules($startcallback, $endcallback, $verbose) {
598     global $CFG, $DB;
600     $mods = core_component::get_plugin_list('mod');
602     foreach ($mods as $mod=>$fullmod) {
604         if ($mod === 'NEWMODULE') {   // Someone has unzipped the template, ignore it
605             continue;
606         }
608         $component = clean_param('mod_'.$mod, PARAM_COMPONENT);
610         // check module dir is valid name
611         if (empty($component)) {
612             throw new plugin_defective_exception('mod_'.$mod, 'Invalid plugin directory name.');
613         }
615         if (!is_readable($fullmod.'/version.php')) {
616             throw new plugin_defective_exception($component, 'Missing version.php');
617         }
619         $module = new stdClass();
620         $plugin = new stdClass();
621         $plugin->version = null;
622         require($fullmod .'/version.php');  // Defines $plugin with version etc.
624         // Check if the legacy $module syntax is still used.
625         if (!is_object($module) or (count((array)$module) > 0)) {
626             throw new plugin_defective_exception($component, 'Unsupported $module syntax detected in version.php');
627         }
629         // Prepare the record for the {modules} table.
630         $module = clone($plugin);
631         unset($module->version);
632         unset($module->component);
633         unset($module->dependencies);
634         unset($module->release);
636         if (empty($plugin->version)) {
637             throw new plugin_defective_exception($component, 'Missing $plugin->version number in version.php.');
638         }
640         if (empty($plugin->component)) {
641             throw new plugin_defective_exception($component, 'Missing $plugin->component declaration in version.php.');
642         }
644         if ($plugin->component !== $component) {
645             throw new plugin_misplaced_exception($plugin->component, null, $fullmod);
646         }
648         if (!empty($plugin->requires)) {
649             if ($plugin->requires > $CFG->version) {
650                 throw new upgrade_requires_exception($component, $plugin->version, $CFG->version, $plugin->requires);
651             } else if ($plugin->requires < 2010000000) {
652                 throw new plugin_defective_exception($component, 'Plugin is not compatible with Moodle 2.x or later.');
653             }
654         }
656         if (empty($module->cron)) {
657             $module->cron = 0;
658         }
660         // all modules must have en lang pack
661         if (!is_readable("$fullmod/lang/en/$mod.php")) {
662             throw new plugin_defective_exception($component, 'Missing mandatory en language pack.');
663         }
665         $module->name = $mod;   // The name MUST match the directory
667         $installedversion = $DB->get_field('config_plugins', 'value', array('name'=>'version', 'plugin'=>$component)); // No caching!
669         if (file_exists($fullmod.'/db/install.php')) {
670             if (get_config($module->name, 'installrunning')) {
671                 require_once($fullmod.'/db/install.php');
672                 $recover_install_function = 'xmldb_'.$module->name.'_install_recovery';
673                 if (function_exists($recover_install_function)) {
674                     $startcallback($component, true, $verbose);
675                     $recover_install_function();
676                     unset_config('installrunning', $module->name);
677                     // Install various components too
678                     update_capabilities($component);
679                     log_update_descriptions($component);
680                     external_update_descriptions($component);
681                     events_update_definition($component);
682                     \core\task\manager::reset_scheduled_tasks_for_component($component);
683                     message_update_providers($component);
684                     \core\message\inbound\manager::update_handlers_for_component($component);
685                     upgrade_plugin_mnet_functions($component);
686                     core_tag_area::reset_definitions_for_component($component);
687                     $endcallback($component, true, $verbose);
688                 }
689             }
690         }
692         if (empty($installedversion)) {
693             $startcallback($component, true, $verbose);
695         /// Execute install.xml (XMLDB) - must be present in all modules
696             $DB->get_manager()->install_from_xmldb_file($fullmod.'/db/install.xml');
698         /// Add record into modules table - may be needed in install.php already
699             $module->id = $DB->insert_record('modules', $module);
700             upgrade_mod_savepoint(true, $plugin->version, $module->name, false);
702         /// Post installation hook - optional
703             if (file_exists("$fullmod/db/install.php")) {
704                 require_once("$fullmod/db/install.php");
705                 // Set installation running flag, we need to recover after exception or error
706                 set_config('installrunning', 1, $module->name);
707                 $post_install_function = 'xmldb_'.$module->name.'_install';
708                 $post_install_function();
709                 unset_config('installrunning', $module->name);
710             }
712         /// Install various components
713             update_capabilities($component);
714             log_update_descriptions($component);
715             external_update_descriptions($component);
716             events_update_definition($component);
717             \core\task\manager::reset_scheduled_tasks_for_component($component);
718             message_update_providers($component);
719             \core\message\inbound\manager::update_handlers_for_component($component);
720             upgrade_plugin_mnet_functions($component);
721             core_tag_area::reset_definitions_for_component($component);
723             $endcallback($component, true, $verbose);
725         } else if ($installedversion < $plugin->version) {
726         /// If versions say that we need to upgrade but no upgrade files are available, notify and continue
727             $startcallback($component, false, $verbose);
729             if (is_readable($fullmod.'/db/upgrade.php')) {
730                 require_once($fullmod.'/db/upgrade.php');  // defines new upgrading function
731                 $newupgrade_function = 'xmldb_'.$module->name.'_upgrade';
732                 $result = $newupgrade_function($installedversion, $module);
733             } else {
734                 $result = true;
735             }
737             $installedversion = $DB->get_field('config_plugins', 'value', array('name'=>'version', 'plugin'=>$component)); // No caching!
738             $currmodule = $DB->get_record('modules', array('name'=>$module->name));
739             if ($installedversion < $plugin->version) {
740                 // store version if not already there
741                 upgrade_mod_savepoint($result, $plugin->version, $mod, false);
742             }
744             // update cron flag if needed
745             if ($currmodule->cron != $module->cron) {
746                 $DB->set_field('modules', 'cron', $module->cron, array('name' => $module->name));
747             }
749             // Upgrade various components
750             update_capabilities($component);
751             log_update_descriptions($component);
752             external_update_descriptions($component);
753             events_update_definition($component);
754             \core\task\manager::reset_scheduled_tasks_for_component($component);
755             message_update_providers($component);
756             \core\message\inbound\manager::update_handlers_for_component($component);
757             upgrade_plugin_mnet_functions($component);
758             core_tag_area::reset_definitions_for_component($component);
760             $endcallback($component, false, $verbose);
762         } else if ($installedversion > $plugin->version) {
763             throw new downgrade_exception($component, $installedversion, $plugin->version);
764         }
765     }
769 /**
770  * This function finds all available blocks and install them
771  * into blocks table or do all the upgrade process if newer.
772  *
773  * @global object
774  * @global object
775  */
776 function upgrade_plugins_blocks($startcallback, $endcallback, $verbose) {
777     global $CFG, $DB;
779     require_once($CFG->dirroot.'/blocks/moodleblock.class.php');
781     $blocktitles   = array(); // we do not want duplicate titles
783     //Is this a first install
784     $first_install = null;
786     $blocks = core_component::get_plugin_list('block');
788     foreach ($blocks as $blockname=>$fullblock) {
790         if (is_null($first_install)) {
791             $first_install = ($DB->count_records('block_instances') == 0);
792         }
794         if ($blockname === 'NEWBLOCK') {   // Someone has unzipped the template, ignore it
795             continue;
796         }
798         $component = clean_param('block_'.$blockname, PARAM_COMPONENT);
800         // check block dir is valid name
801         if (empty($component)) {
802             throw new plugin_defective_exception('block_'.$blockname, 'Invalid plugin directory name.');
803         }
805         if (!is_readable($fullblock.'/version.php')) {
806             throw new plugin_defective_exception('block/'.$blockname, 'Missing version.php file.');
807         }
808         $plugin = new stdClass();
809         $plugin->version = null;
810         $plugin->cron    = 0;
811         $module = $plugin; // Prevent some notices when module placed in wrong directory.
812         include($fullblock.'/version.php');
813         unset($module);
814         $block = clone($plugin);
815         unset($block->version);
816         unset($block->component);
817         unset($block->dependencies);
818         unset($block->release);
820         if (empty($plugin->version)) {
821             throw new plugin_defective_exception($component, 'Missing block version number in version.php.');
822         }
824         if (empty($plugin->component)) {
825             throw new plugin_defective_exception($component, 'Missing $plugin->component declaration in version.php.');
826         }
828         if ($plugin->component !== $component) {
829             throw new plugin_misplaced_exception($plugin->component, null, $fullblock);
830         }
832         if (!empty($plugin->requires)) {
833             if ($plugin->requires > $CFG->version) {
834                 throw new upgrade_requires_exception($component, $plugin->version, $CFG->version, $plugin->requires);
835             } else if ($plugin->requires < 2010000000) {
836                 throw new plugin_defective_exception($component, 'Plugin is not compatible with Moodle 2.x or later.');
837             }
838         }
840         if (!is_readable($fullblock.'/block_'.$blockname.'.php')) {
841             throw new plugin_defective_exception('block/'.$blockname, 'Missing main block class file.');
842         }
843         include_once($fullblock.'/block_'.$blockname.'.php');
845         $classname = 'block_'.$blockname;
847         if (!class_exists($classname)) {
848             throw new plugin_defective_exception($component, 'Can not load main class.');
849         }
851         $blockobj    = new $classname;   // This is what we'll be testing
852         $blocktitle  = $blockobj->get_title();
854         // OK, it's as we all hoped. For further tests, the object will do them itself.
855         if (!$blockobj->_self_test()) {
856             throw new plugin_defective_exception($component, 'Self test failed.');
857         }
859         $block->name     = $blockname;   // The name MUST match the directory
861         $installedversion = $DB->get_field('config_plugins', 'value', array('name'=>'version', 'plugin'=>$component)); // No caching!
863         if (file_exists($fullblock.'/db/install.php')) {
864             if (get_config('block_'.$blockname, 'installrunning')) {
865                 require_once($fullblock.'/db/install.php');
866                 $recover_install_function = 'xmldb_block_'.$blockname.'_install_recovery';
867                 if (function_exists($recover_install_function)) {
868                     $startcallback($component, true, $verbose);
869                     $recover_install_function();
870                     unset_config('installrunning', 'block_'.$blockname);
871                     // Install various components
872                     update_capabilities($component);
873                     log_update_descriptions($component);
874                     external_update_descriptions($component);
875                     events_update_definition($component);
876                     \core\task\manager::reset_scheduled_tasks_for_component($component);
877                     message_update_providers($component);
878                     \core\message\inbound\manager::update_handlers_for_component($component);
879                     upgrade_plugin_mnet_functions($component);
880                     core_tag_area::reset_definitions_for_component($component);
881                     $endcallback($component, true, $verbose);
882                 }
883             }
884         }
886         if (empty($installedversion)) { // block not installed yet, so install it
887             $conflictblock = array_search($blocktitle, $blocktitles);
888             if ($conflictblock !== false) {
889                 // Duplicate block titles are not allowed, they confuse people
890                 // AND PHP's associative arrays ;)
891                 throw new plugin_defective_exception($component, get_string('blocknameconflict', 'error', (object)array('name'=>$block->name, 'conflict'=>$conflictblock)));
892             }
893             $startcallback($component, true, $verbose);
895             if (file_exists($fullblock.'/db/install.xml')) {
896                 $DB->get_manager()->install_from_xmldb_file($fullblock.'/db/install.xml');
897             }
898             $block->id = $DB->insert_record('block', $block);
899             upgrade_block_savepoint(true, $plugin->version, $block->name, false);
901             if (file_exists($fullblock.'/db/install.php')) {
902                 require_once($fullblock.'/db/install.php');
903                 // Set installation running flag, we need to recover after exception or error
904                 set_config('installrunning', 1, 'block_'.$blockname);
905                 $post_install_function = 'xmldb_block_'.$blockname.'_install';
906                 $post_install_function();
907                 unset_config('installrunning', 'block_'.$blockname);
908             }
910             $blocktitles[$block->name] = $blocktitle;
912             // Install various components
913             update_capabilities($component);
914             log_update_descriptions($component);
915             external_update_descriptions($component);
916             events_update_definition($component);
917             \core\task\manager::reset_scheduled_tasks_for_component($component);
918             message_update_providers($component);
919             \core\message\inbound\manager::update_handlers_for_component($component);
920             core_tag_area::reset_definitions_for_component($component);
921             upgrade_plugin_mnet_functions($component);
923             $endcallback($component, true, $verbose);
925         } else if ($installedversion < $plugin->version) {
926             $startcallback($component, false, $verbose);
928             if (is_readable($fullblock.'/db/upgrade.php')) {
929                 require_once($fullblock.'/db/upgrade.php');  // defines new upgrading function
930                 $newupgrade_function = 'xmldb_block_'.$blockname.'_upgrade';
931                 $result = $newupgrade_function($installedversion, $block);
932             } else {
933                 $result = true;
934             }
936             $installedversion = $DB->get_field('config_plugins', 'value', array('name'=>'version', 'plugin'=>$component)); // No caching!
937             $currblock = $DB->get_record('block', array('name'=>$block->name));
938             if ($installedversion < $plugin->version) {
939                 // store version if not already there
940                 upgrade_block_savepoint($result, $plugin->version, $block->name, false);
941             }
943             if ($currblock->cron != $block->cron) {
944                 // update cron flag if needed
945                 $DB->set_field('block', 'cron', $block->cron, array('id' => $currblock->id));
946             }
948             // Upgrade various components
949             update_capabilities($component);
950             log_update_descriptions($component);
951             external_update_descriptions($component);
952             events_update_definition($component);
953             \core\task\manager::reset_scheduled_tasks_for_component($component);
954             message_update_providers($component);
955             \core\message\inbound\manager::update_handlers_for_component($component);
956             upgrade_plugin_mnet_functions($component);
957             core_tag_area::reset_definitions_for_component($component);
959             $endcallback($component, false, $verbose);
961         } else if ($installedversion > $plugin->version) {
962             throw new downgrade_exception($component, $installedversion, $plugin->version);
963         }
964     }
967     // Finally, if we are in the first_install of BLOCKS setup frontpage and admin page blocks
968     if ($first_install) {
969         //Iterate over each course - there should be only site course here now
970         if ($courses = $DB->get_records('course')) {
971             foreach ($courses as $course) {
972                 blocks_add_default_course_blocks($course);
973             }
974         }
976         blocks_add_default_system_blocks();
977     }
981 /**
982  * Log_display description function used during install and upgrade.
983  *
984  * @param string $component name of component (moodle, mod_assignment, etc.)
985  * @return void
986  */
987 function log_update_descriptions($component) {
988     global $DB;
990     $defpath = core_component::get_component_directory($component).'/db/log.php';
992     if (!file_exists($defpath)) {
993         $DB->delete_records('log_display', array('component'=>$component));
994         return;
995     }
997     // load new info
998     $logs = array();
999     include($defpath);
1000     $newlogs = array();
1001     foreach ($logs as $log) {
1002         $newlogs[$log['module'].'-'.$log['action']] = $log; // kind of unique name
1003     }
1004     unset($logs);
1005     $logs = $newlogs;
1007     $fields = array('module', 'action', 'mtable', 'field');
1008     // update all log fist
1009     $dblogs = $DB->get_records('log_display', array('component'=>$component));
1010     foreach ($dblogs as $dblog) {
1011         $name = $dblog->module.'-'.$dblog->action;
1013         if (empty($logs[$name])) {
1014             $DB->delete_records('log_display', array('id'=>$dblog->id));
1015             continue;
1016         }
1018         $log = $logs[$name];
1019         unset($logs[$name]);
1021         $update = false;
1022         foreach ($fields as $field) {
1023             if ($dblog->$field != $log[$field]) {
1024                 $dblog->$field = $log[$field];
1025                 $update = true;
1026             }
1027         }
1028         if ($update) {
1029             $DB->update_record('log_display', $dblog);
1030         }
1031     }
1032     foreach ($logs as $log) {
1033         $dblog = (object)$log;
1034         $dblog->component = $component;
1035         $DB->insert_record('log_display', $dblog);
1036     }
1039 /**
1040  * Web service discovery function used during install and upgrade.
1041  * @param string $component name of component (moodle, mod_assignment, etc.)
1042  * @return void
1043  */
1044 function external_update_descriptions($component) {
1045     global $DB, $CFG;
1047     $defpath = core_component::get_component_directory($component).'/db/services.php';
1049     if (!file_exists($defpath)) {
1050         require_once($CFG->dirroot.'/lib/externallib.php');
1051         external_delete_descriptions($component);
1052         return;
1053     }
1055     // load new info
1056     $functions = array();
1057     $services = array();
1058     include($defpath);
1060     // update all function fist
1061     $dbfunctions = $DB->get_records('external_functions', array('component'=>$component));
1062     foreach ($dbfunctions as $dbfunction) {
1063         if (empty($functions[$dbfunction->name])) {
1064             $DB->delete_records('external_functions', array('id'=>$dbfunction->id));
1065             // do not delete functions from external_services_functions, beacuse
1066             // we want to notify admins when functions used in custom services disappear
1068             //TODO: this looks wrong, we have to delete it eventually (skodak)
1069             continue;
1070         }
1072         $function = $functions[$dbfunction->name];
1073         unset($functions[$dbfunction->name]);
1074         $function['classpath'] = empty($function['classpath']) ? null : $function['classpath'];
1076         $update = false;
1077         if ($dbfunction->classname != $function['classname']) {
1078             $dbfunction->classname = $function['classname'];
1079             $update = true;
1080         }
1081         if ($dbfunction->methodname != $function['methodname']) {
1082             $dbfunction->methodname = $function['methodname'];
1083             $update = true;
1084         }
1085         if ($dbfunction->classpath != $function['classpath']) {
1086             $dbfunction->classpath = $function['classpath'];
1087             $update = true;
1088         }
1089         $functioncapabilities = array_key_exists('capabilities', $function)?$function['capabilities']:'';
1090         if ($dbfunction->capabilities != $functioncapabilities) {
1091             $dbfunction->capabilities = $functioncapabilities;
1092             $update = true;
1093         }
1095         if (isset($function['services']) and is_array($function['services'])) {
1096             sort($function['services']);
1097             $functionservices = implode(',', $function['services']);
1098         } else {
1099             // Force null values in the DB.
1100             $functionservices = null;
1101         }
1103         if ($dbfunction->services != $functionservices) {
1104             // Now, we need to check if services were removed, in that case we need to remove the function from them.
1105             $servicesremoved = array_diff(explode(",", $dbfunction->services), explode(",", $functionservices));
1106             foreach ($servicesremoved as $removedshortname) {
1107                 if ($externalserviceid = $DB->get_field('external_services', 'id', array("shortname" => $removedshortname))) {
1108                     $DB->delete_records('external_services_functions', array('functionname' => $dbfunction->name,
1109                                                                                 'externalserviceid' => $externalserviceid));
1110                 }
1111             }
1113             $dbfunction->services = $functionservices;
1114             $update = true;
1115         }
1116         if ($update) {
1117             $DB->update_record('external_functions', $dbfunction);
1118         }
1119     }
1120     foreach ($functions as $fname => $function) {
1121         $dbfunction = new stdClass();
1122         $dbfunction->name       = $fname;
1123         $dbfunction->classname  = $function['classname'];
1124         $dbfunction->methodname = $function['methodname'];
1125         $dbfunction->classpath  = empty($function['classpath']) ? null : $function['classpath'];
1126         $dbfunction->component  = $component;
1127         $dbfunction->capabilities = array_key_exists('capabilities', $function)?$function['capabilities']:'';
1129         if (isset($function['services']) and is_array($function['services'])) {
1130             sort($function['services']);
1131             $dbfunction->services = implode(',', $function['services']);
1132         } else {
1133             // Force null values in the DB.
1134             $dbfunction->services = null;
1135         }
1137         $dbfunction->id = $DB->insert_record('external_functions', $dbfunction);
1138     }
1139     unset($functions);
1141     // now deal with services
1142     $dbservices = $DB->get_records('external_services', array('component'=>$component));
1143     foreach ($dbservices as $dbservice) {
1144         if (empty($services[$dbservice->name])) {
1145             $DB->delete_records('external_tokens', array('externalserviceid'=>$dbservice->id));
1146             $DB->delete_records('external_services_functions', array('externalserviceid'=>$dbservice->id));
1147             $DB->delete_records('external_services_users', array('externalserviceid'=>$dbservice->id));
1148             $DB->delete_records('external_services', array('id'=>$dbservice->id));
1149             continue;
1150         }
1151         $service = $services[$dbservice->name];
1152         unset($services[$dbservice->name]);
1153         $service['enabled'] = empty($service['enabled']) ? 0 : $service['enabled'];
1154         $service['requiredcapability'] = empty($service['requiredcapability']) ? null : $service['requiredcapability'];
1155         $service['restrictedusers'] = !isset($service['restrictedusers']) ? 1 : $service['restrictedusers'];
1156         $service['downloadfiles'] = !isset($service['downloadfiles']) ? 0 : $service['downloadfiles'];
1157         $service['uploadfiles'] = !isset($service['uploadfiles']) ? 0 : $service['uploadfiles'];
1158         $service['shortname'] = !isset($service['shortname']) ? null : $service['shortname'];
1160         $update = false;
1161         if ($dbservice->requiredcapability != $service['requiredcapability']) {
1162             $dbservice->requiredcapability = $service['requiredcapability'];
1163             $update = true;
1164         }
1165         if ($dbservice->restrictedusers != $service['restrictedusers']) {
1166             $dbservice->restrictedusers = $service['restrictedusers'];
1167             $update = true;
1168         }
1169         if ($dbservice->downloadfiles != $service['downloadfiles']) {
1170             $dbservice->downloadfiles = $service['downloadfiles'];
1171             $update = true;
1172         }
1173         if ($dbservice->uploadfiles != $service['uploadfiles']) {
1174             $dbservice->uploadfiles = $service['uploadfiles'];
1175             $update = true;
1176         }
1177         //if shortname is not a PARAM_ALPHANUMEXT, fail (tested here for service update and creation)
1178         if (isset($service['shortname']) and
1179                 (clean_param($service['shortname'], PARAM_ALPHANUMEXT) != $service['shortname'])) {
1180             throw new moodle_exception('installserviceshortnameerror', 'webservice', '', $service['shortname']);
1181         }
1182         if ($dbservice->shortname != $service['shortname']) {
1183             //check that shortname is unique
1184             if (isset($service['shortname'])) { //we currently accepts multiple shortname == null
1185                 $existingservice = $DB->get_record('external_services',
1186                         array('shortname' => $service['shortname']));
1187                 if (!empty($existingservice)) {
1188                     throw new moodle_exception('installexistingserviceshortnameerror', 'webservice', '', $service['shortname']);
1189                 }
1190             }
1191             $dbservice->shortname = $service['shortname'];
1192             $update = true;
1193         }
1194         if ($update) {
1195             $DB->update_record('external_services', $dbservice);
1196         }
1198         $functions = $DB->get_records('external_services_functions', array('externalserviceid'=>$dbservice->id));
1199         foreach ($functions as $function) {
1200             $key = array_search($function->functionname, $service['functions']);
1201             if ($key === false) {
1202                 $DB->delete_records('external_services_functions', array('id'=>$function->id));
1203             } else {
1204                 unset($service['functions'][$key]);
1205             }
1206         }
1207         foreach ($service['functions'] as $fname) {
1208             $newf = new stdClass();
1209             $newf->externalserviceid = $dbservice->id;
1210             $newf->functionname      = $fname;
1211             $DB->insert_record('external_services_functions', $newf);
1212         }
1213         unset($functions);
1214     }
1215     foreach ($services as $name => $service) {
1216         //check that shortname is unique
1217         if (isset($service['shortname'])) { //we currently accepts multiple shortname == null
1218             $existingservice = $DB->get_record('external_services',
1219                     array('shortname' => $service['shortname']));
1220             if (!empty($existingservice)) {
1221                 throw new moodle_exception('installserviceshortnameerror', 'webservice');
1222             }
1223         }
1225         $dbservice = new stdClass();
1226         $dbservice->name               = $name;
1227         $dbservice->enabled            = empty($service['enabled']) ? 0 : $service['enabled'];
1228         $dbservice->requiredcapability = empty($service['requiredcapability']) ? null : $service['requiredcapability'];
1229         $dbservice->restrictedusers    = !isset($service['restrictedusers']) ? 1 : $service['restrictedusers'];
1230         $dbservice->downloadfiles      = !isset($service['downloadfiles']) ? 0 : $service['downloadfiles'];
1231         $dbservice->uploadfiles        = !isset($service['uploadfiles']) ? 0 : $service['uploadfiles'];
1232         $dbservice->shortname          = !isset($service['shortname']) ? null : $service['shortname'];
1233         $dbservice->component          = $component;
1234         $dbservice->timecreated        = time();
1235         $dbservice->id = $DB->insert_record('external_services', $dbservice);
1236         foreach ($service['functions'] as $fname) {
1237             $newf = new stdClass();
1238             $newf->externalserviceid = $dbservice->id;
1239             $newf->functionname      = $fname;
1240             $DB->insert_record('external_services_functions', $newf);
1241         }
1242     }
1245 /**
1246  * Allow plugins and subsystems to add external functions to other plugins or built-in services.
1247  * This function is executed just after all the plugins have been updated.
1248  */
1249 function external_update_services() {
1250     global $DB;
1252     // Look for external functions that want to be added in existing services.
1253     $functions = $DB->get_records_select('external_functions', 'services IS NOT NULL');
1255     $servicescache = array();
1256     foreach ($functions as $function) {
1257         // Prevent edge cases.
1258         if (empty($function->services)) {
1259             continue;
1260         }
1261         $services = explode(',', $function->services);
1263         foreach ($services as $serviceshortname) {
1264             // Get the service id by shortname.
1265             if (!empty($servicescache[$serviceshortname])) {
1266                 $serviceid = $servicescache[$serviceshortname];
1267             } else if ($service = $DB->get_record('external_services', array('shortname' => $serviceshortname))) {
1268                 // If the component is empty, it means that is not a built-in service.
1269                 // We don't allow functions to inject themselves in services created by an user in Moodle.
1270                 if (empty($service->component)) {
1271                     continue;
1272                 }
1273                 $serviceid = $service->id;
1274                 $servicescache[$serviceshortname] = $serviceid;
1275             } else {
1276                 // Service not found.
1277                 continue;
1278             }
1279             // Finally add the function to the service.
1280             $newf = new stdClass();
1281             $newf->externalserviceid = $serviceid;
1282             $newf->functionname      = $function->name;
1284             if (!$DB->record_exists('external_services_functions', (array)$newf)) {
1285                 $DB->insert_record('external_services_functions', $newf);
1286             }
1287         }
1288     }
1291 /**
1292  * upgrade logging functions
1293  */
1294 function upgrade_handle_exception($ex, $plugin = null) {
1295     global $CFG;
1297     // rollback everything, we need to log all upgrade problems
1298     abort_all_db_transactions();
1300     $info = get_exception_info($ex);
1302     // First log upgrade error
1303     upgrade_log(UPGRADE_LOG_ERROR, $plugin, 'Exception: ' . get_class($ex), $info->message, $info->backtrace);
1305     // Always turn on debugging - admins need to know what is going on
1306     set_debugging(DEBUG_DEVELOPER, true);
1308     default_exception_handler($ex, true, $plugin);
1311 /**
1312  * Adds log entry into upgrade_log table
1313  *
1314  * @param int $type UPGRADE_LOG_NORMAL, UPGRADE_LOG_NOTICE or UPGRADE_LOG_ERROR
1315  * @param string $plugin frankenstyle component name
1316  * @param string $info short description text of log entry
1317  * @param string $details long problem description
1318  * @param string $backtrace string used for errors only
1319  * @return void
1320  */
1321 function upgrade_log($type, $plugin, $info, $details=null, $backtrace=null) {
1322     global $DB, $USER, $CFG;
1324     if (empty($plugin)) {
1325         $plugin = 'core';
1326     }
1328     list($plugintype, $pluginname) = core_component::normalize_component($plugin);
1329     $component = is_null($pluginname) ? $plugintype : $plugintype . '_' . $pluginname;
1331     $backtrace = format_backtrace($backtrace, true);
1333     $currentversion = null;
1334     $targetversion  = null;
1336     //first try to find out current version number
1337     if ($plugintype === 'core') {
1338         //main
1339         $currentversion = $CFG->version;
1341         $version = null;
1342         include("$CFG->dirroot/version.php");
1343         $targetversion = $version;
1345     } else {
1346         $pluginversion = get_config($component, 'version');
1347         if (!empty($pluginversion)) {
1348             $currentversion = $pluginversion;
1349         }
1350         $cd = core_component::get_component_directory($component);
1351         if (file_exists("$cd/version.php")) {
1352             $plugin = new stdClass();
1353             $plugin->version = null;
1354             $module = $plugin;
1355             include("$cd/version.php");
1356             $targetversion = $plugin->version;
1357         }
1358     }
1360     $log = new stdClass();
1361     $log->type          = $type;
1362     $log->plugin        = $component;
1363     $log->version       = $currentversion;
1364     $log->targetversion = $targetversion;
1365     $log->info          = $info;
1366     $log->details       = $details;
1367     $log->backtrace     = $backtrace;
1368     $log->userid        = $USER->id;
1369     $log->timemodified  = time();
1370     try {
1371         $DB->insert_record('upgrade_log', $log);
1372     } catch (Exception $ignored) {
1373         // possible during install or 2.0 upgrade
1374     }
1377 /**
1378  * Marks start of upgrade, blocks any other access to site.
1379  * The upgrade is finished at the end of script or after timeout.
1380  *
1381  * @global object
1382  * @global object
1383  * @global object
1384  */
1385 function upgrade_started($preinstall=false) {
1386     global $CFG, $DB, $PAGE, $OUTPUT;
1388     static $started = false;
1390     if ($preinstall) {
1391         ignore_user_abort(true);
1392         upgrade_setup_debug(true);
1394     } else if ($started) {
1395         upgrade_set_timeout(120);
1397     } else {
1398         if (!CLI_SCRIPT and !$PAGE->headerprinted) {
1399             $strupgrade  = get_string('upgradingversion', 'admin');
1400             $PAGE->set_pagelayout('maintenance');
1401             upgrade_init_javascript();
1402             $PAGE->set_title($strupgrade.' - Moodle '.$CFG->target_release);
1403             $PAGE->set_heading($strupgrade);
1404             $PAGE->navbar->add($strupgrade);
1405             $PAGE->set_cacheable(false);
1406             echo $OUTPUT->header();
1407         }
1409         ignore_user_abort(true);
1410         core_shutdown_manager::register_function('upgrade_finished_handler');
1411         upgrade_setup_debug(true);
1412         set_config('upgraderunning', time()+300);
1413         $started = true;
1414     }
1417 /**
1418  * Internal function - executed if upgrade interrupted.
1419  */
1420 function upgrade_finished_handler() {
1421     upgrade_finished();
1424 /**
1425  * Indicates upgrade is finished.
1426  *
1427  * This function may be called repeatedly.
1428  *
1429  * @global object
1430  * @global object
1431  */
1432 function upgrade_finished($continueurl=null) {
1433     global $CFG, $DB, $OUTPUT;
1435     if (!empty($CFG->upgraderunning)) {
1436         unset_config('upgraderunning');
1437         // We have to forcefully purge the caches using the writer here.
1438         // This has to be done after we unset the config var. If someone hits the site while this is set they will
1439         // cause the config values to propogate to the caches.
1440         // Caches are purged after the last step in an upgrade but there is several code routines that exceute between
1441         // then and now that leaving a window for things to fall out of sync.
1442         cache_helper::purge_all(true);
1443         upgrade_setup_debug(false);
1444         ignore_user_abort(false);
1445         if ($continueurl) {
1446             echo $OUTPUT->continue_button($continueurl);
1447             echo $OUTPUT->footer();
1448             die;
1449         }
1450     }
1453 /**
1454  * @global object
1455  * @global object
1456  */
1457 function upgrade_setup_debug($starting) {
1458     global $CFG, $DB;
1460     static $originaldebug = null;
1462     if ($starting) {
1463         if ($originaldebug === null) {
1464             $originaldebug = $DB->get_debug();
1465         }
1466         if (!empty($CFG->upgradeshowsql)) {
1467             $DB->set_debug(true);
1468         }
1469     } else {
1470         $DB->set_debug($originaldebug);
1471     }
1474 function print_upgrade_separator() {
1475     if (!CLI_SCRIPT) {
1476         echo '<hr />';
1477     }
1480 /**
1481  * Default start upgrade callback
1482  * @param string $plugin
1483  * @param bool $installation true if installation, false means upgrade
1484  */
1485 function print_upgrade_part_start($plugin, $installation, $verbose) {
1486     global $OUTPUT;
1487     if (empty($plugin) or $plugin == 'moodle') {
1488         upgrade_started($installation); // does not store upgrade running flag yet
1489         if ($verbose) {
1490             echo $OUTPUT->heading(get_string('coresystem'));
1491         }
1492     } else {
1493         upgrade_started();
1494         if ($verbose) {
1495             echo $OUTPUT->heading($plugin);
1496         }
1497     }
1498     if ($installation) {
1499         if (empty($plugin) or $plugin == 'moodle') {
1500             // no need to log - log table not yet there ;-)
1501         } else {
1502             upgrade_log(UPGRADE_LOG_NORMAL, $plugin, 'Starting plugin installation');
1503         }
1504     } else {
1505         if (empty($plugin) or $plugin == 'moodle') {
1506             upgrade_log(UPGRADE_LOG_NORMAL, $plugin, 'Starting core upgrade');
1507         } else {
1508             upgrade_log(UPGRADE_LOG_NORMAL, $plugin, 'Starting plugin upgrade');
1509         }
1510     }
1513 /**
1514  * Default end upgrade callback
1515  * @param string $plugin
1516  * @param bool $installation true if installation, false means upgrade
1517  */
1518 function print_upgrade_part_end($plugin, $installation, $verbose) {
1519     global $OUTPUT;
1520     upgrade_started();
1521     if ($installation) {
1522         if (empty($plugin) or $plugin == 'moodle') {
1523             upgrade_log(UPGRADE_LOG_NORMAL, $plugin, 'Core installed');
1524         } else {
1525             upgrade_log(UPGRADE_LOG_NORMAL, $plugin, 'Plugin installed');
1526         }
1527     } else {
1528         if (empty($plugin) or $plugin == 'moodle') {
1529             upgrade_log(UPGRADE_LOG_NORMAL, $plugin, 'Core upgraded');
1530         } else {
1531             upgrade_log(UPGRADE_LOG_NORMAL, $plugin, 'Plugin upgraded');
1532         }
1533     }
1534     if ($verbose) {
1535         $notification = new \core\output\notification(get_string('success'), \core\output\notification::NOTIFY_SUCCESS);
1536         $notification->set_show_closebutton(false);
1537         echo $OUTPUT->render($notification);
1538         print_upgrade_separator();
1539     }
1542 /**
1543  * Sets up JS code required for all upgrade scripts.
1544  * @global object
1545  */
1546 function upgrade_init_javascript() {
1547     global $PAGE;
1548     // scroll to the end of each upgrade page so that ppl see either error or continue button,
1549     // no need to scroll continuously any more, it is enough to jump to end once the footer is printed ;-)
1550     $js = "window.scrollTo(0, 5000000);";
1551     $PAGE->requires->js_init_code($js);
1554 /**
1555  * Try to upgrade the given language pack (or current language)
1556  *
1557  * @param string $lang the code of the language to update, defaults to the current language
1558  */
1559 function upgrade_language_pack($lang = null) {
1560     global $CFG;
1562     if (!empty($CFG->skiplangupgrade)) {
1563         return;
1564     }
1566     if (!file_exists("$CFG->dirroot/$CFG->admin/tool/langimport/lib.php")) {
1567         // weird, somebody uninstalled the import utility
1568         return;
1569     }
1571     if (!$lang) {
1572         $lang = current_language();
1573     }
1575     if (!get_string_manager()->translation_exists($lang)) {
1576         return;
1577     }
1579     get_string_manager()->reset_caches();
1581     if ($lang === 'en') {
1582         return;  // Nothing to do
1583     }
1585     upgrade_started(false);
1587     require_once("$CFG->dirroot/$CFG->admin/tool/langimport/lib.php");
1588     tool_langimport_preupgrade_update($lang);
1590     get_string_manager()->reset_caches();
1592     print_upgrade_separator();
1595 /**
1596  * Install core moodle tables and initialize
1597  * @param float $version target version
1598  * @param bool $verbose
1599  * @return void, may throw exception
1600  */
1601 function install_core($version, $verbose) {
1602     global $CFG, $DB;
1604     // We can not call purge_all_caches() yet, make sure the temp and cache dirs exist and are empty.
1605     remove_dir($CFG->cachedir.'', true);
1606     make_cache_directory('', true);
1608     remove_dir($CFG->localcachedir.'', true);
1609     make_localcache_directory('', true);
1611     remove_dir($CFG->tempdir.'', true);
1612     make_temp_directory('', true);
1614     remove_dir($CFG->dataroot.'/muc', true);
1615     make_writable_directory($CFG->dataroot.'/muc', true);
1617     try {
1618         core_php_time_limit::raise(600);
1619         print_upgrade_part_start('moodle', true, $verbose); // does not store upgrade running flag
1621         $DB->get_manager()->install_from_xmldb_file("$CFG->libdir/db/install.xml");
1622         upgrade_started();     // we want the flag to be stored in config table ;-)
1624         // set all core default records and default settings
1625         require_once("$CFG->libdir/db/install.php");
1626         xmldb_main_install(); // installs the capabilities too
1628         // store version
1629         upgrade_main_savepoint(true, $version, false);
1631         // Continue with the installation
1632         log_update_descriptions('moodle');
1633         external_update_descriptions('moodle');
1634         events_update_definition('moodle');
1635         \core\task\manager::reset_scheduled_tasks_for_component('moodle');
1636         message_update_providers('moodle');
1637         \core\message\inbound\manager::update_handlers_for_component('moodle');
1638         core_tag_area::reset_definitions_for_component('moodle');
1640         // Write default settings unconditionally
1641         admin_apply_default_settings(NULL, true);
1643         print_upgrade_part_end(null, true, $verbose);
1645         // Purge all caches. They're disabled but this ensures that we don't have any persistent data just in case something
1646         // during installation didn't use APIs.
1647         cache_helper::purge_all();
1648     } catch (exception $ex) {
1649         upgrade_handle_exception($ex);
1650     } catch (Throwable $ex) {
1651         // Engine errors in PHP7 throw exceptions of type Throwable (this "catch" will be ignored in PHP5).
1652         upgrade_handle_exception($ex);
1653     }
1656 /**
1657  * Upgrade moodle core
1658  * @param float $version target version
1659  * @param bool $verbose
1660  * @return void, may throw exception
1661  */
1662 function upgrade_core($version, $verbose) {
1663     global $CFG, $SITE, $DB, $COURSE;
1665     raise_memory_limit(MEMORY_EXTRA);
1667     require_once($CFG->libdir.'/db/upgrade.php');    // Defines upgrades
1669     try {
1670         // Reset caches before any output.
1671         cache_helper::purge_all(true);
1672         purge_all_caches();
1674         // Upgrade current language pack if we can
1675         upgrade_language_pack();
1677         print_upgrade_part_start('moodle', false, $verbose);
1679         // Pre-upgrade scripts for local hack workarounds.
1680         $preupgradefile = "$CFG->dirroot/local/preupgrade.php";
1681         if (file_exists($preupgradefile)) {
1682             core_php_time_limit::raise();
1683             require($preupgradefile);
1684             // Reset upgrade timeout to default.
1685             upgrade_set_timeout();
1686         }
1688         $result = xmldb_main_upgrade($CFG->version);
1689         if ($version > $CFG->version) {
1690             // store version if not already there
1691             upgrade_main_savepoint($result, $version, false);
1692         }
1694         // In case structure of 'course' table has been changed and we forgot to update $SITE, re-read it from db.
1695         $SITE = $DB->get_record('course', array('id' => $SITE->id));
1696         $COURSE = clone($SITE);
1698         // perform all other component upgrade routines
1699         update_capabilities('moodle');
1700         log_update_descriptions('moodle');
1701         external_update_descriptions('moodle');
1702         events_update_definition('moodle');
1703         \core\task\manager::reset_scheduled_tasks_for_component('moodle');
1704         message_update_providers('moodle');
1705         \core\message\inbound\manager::update_handlers_for_component('moodle');
1706         core_tag_area::reset_definitions_for_component('moodle');
1707         // Update core definitions.
1708         cache_helper::update_definitions(true);
1710         // Purge caches again, just to be sure we arn't holding onto old stuff now.
1711         cache_helper::purge_all(true);
1712         purge_all_caches();
1714         // Clean up contexts - more and more stuff depends on existence of paths and contexts
1715         context_helper::cleanup_instances();
1716         context_helper::create_instances(null, false);
1717         context_helper::build_all_paths(false);
1718         $syscontext = context_system::instance();
1719         $syscontext->mark_dirty();
1721         print_upgrade_part_end('moodle', false, $verbose);
1722     } catch (Exception $ex) {
1723         upgrade_handle_exception($ex);
1724     } catch (Throwable $ex) {
1725         // Engine errors in PHP7 throw exceptions of type Throwable (this "catch" will be ignored in PHP5).
1726         upgrade_handle_exception($ex);
1727     }
1730 /**
1731  * Upgrade/install other parts of moodle
1732  * @param bool $verbose
1733  * @return void, may throw exception
1734  */
1735 function upgrade_noncore($verbose) {
1736     global $CFG;
1738     raise_memory_limit(MEMORY_EXTRA);
1740     // upgrade all plugins types
1741     try {
1742         // Reset caches before any output.
1743         cache_helper::purge_all(true);
1744         purge_all_caches();
1746         $plugintypes = core_component::get_plugin_types();
1747         foreach ($plugintypes as $type=>$location) {
1748             upgrade_plugins($type, 'print_upgrade_part_start', 'print_upgrade_part_end', $verbose);
1749         }
1750         // Upgrade services.
1751         // This function gives plugins and subsystems a chance to add functions to existing built-in services.
1752         external_update_services();
1754         // Update cache definitions. Involves scanning each plugin for any changes.
1755         cache_helper::update_definitions();
1756         // Mark the site as upgraded.
1757         set_config('allversionshash', core_component::get_all_versions_hash());
1759         // Purge caches again, just to be sure we arn't holding onto old stuff now.
1760         cache_helper::purge_all(true);
1761         purge_all_caches();
1763     } catch (Exception $ex) {
1764         upgrade_handle_exception($ex);
1765     } catch (Throwable $ex) {
1766         // Engine errors in PHP7 throw exceptions of type Throwable (this "catch" will be ignored in PHP5).
1767         upgrade_handle_exception($ex);
1768     }
1771 /**
1772  * Checks if the main tables have been installed yet or not.
1773  *
1774  * Note: we can not use caches here because they might be stale,
1775  *       use with care!
1776  *
1777  * @return bool
1778  */
1779 function core_tables_exist() {
1780     global $DB;
1782     if (!$tables = $DB->get_tables(false) ) {    // No tables yet at all.
1783         return false;
1785     } else {                                 // Check for missing main tables
1786         $mtables = array('config', 'course', 'groupings'); // some tables used in 1.9 and 2.0, preferable something from the start and end of install.xml
1787         foreach ($mtables as $mtable) {
1788             if (!in_array($mtable, $tables)) {
1789                 return false;
1790             }
1791         }
1792         return true;
1793     }
1796 /**
1797  * upgrades the mnet rpc definitions for the given component.
1798  * this method doesn't return status, an exception will be thrown in the case of an error
1799  *
1800  * @param string $component the plugin to upgrade, eg auth_mnet
1801  */
1802 function upgrade_plugin_mnet_functions($component) {
1803     global $DB, $CFG;
1805     list($type, $plugin) = core_component::normalize_component($component);
1806     $path = core_component::get_plugin_directory($type, $plugin);
1808     $publishes = array();
1809     $subscribes = array();
1810     if (file_exists($path . '/db/mnet.php')) {
1811         require_once($path . '/db/mnet.php'); // $publishes comes from this file
1812     }
1813     if (empty($publishes)) {
1814         $publishes = array(); // still need this to be able to disable stuff later
1815     }
1816     if (empty($subscribes)) {
1817         $subscribes = array(); // still need this to be able to disable stuff later
1818     }
1820     static $servicecache = array();
1822     // rekey an array based on the rpc method for easy lookups later
1823     $publishmethodservices = array();
1824     $subscribemethodservices = array();
1825     foreach($publishes as $servicename => $service) {
1826         if (is_array($service['methods'])) {
1827             foreach($service['methods'] as $methodname) {
1828                 $service['servicename'] = $servicename;
1829                 $publishmethodservices[$methodname][] = $service;
1830             }
1831         }
1832     }
1834     // Disable functions that don't exist (any more) in the source
1835     // Should these be deleted? What about their permissions records?
1836     foreach ($DB->get_records('mnet_rpc', array('pluginname'=>$plugin, 'plugintype'=>$type), 'functionname ASC ') as $rpc) {
1837         if (!array_key_exists($rpc->functionname, $publishmethodservices) && $rpc->enabled) {
1838             $DB->set_field('mnet_rpc', 'enabled', 0, array('id' => $rpc->id));
1839         } else if (array_key_exists($rpc->functionname, $publishmethodservices) && !$rpc->enabled) {
1840             $DB->set_field('mnet_rpc', 'enabled', 1, array('id' => $rpc->id));
1841         }
1842     }
1844     // reflect all the services we're publishing and save them
1845     static $cachedclasses = array(); // to store reflection information in
1846     foreach ($publishes as $service => $data) {
1847         $f = $data['filename'];
1848         $c = $data['classname'];
1849         foreach ($data['methods'] as $method) {
1850             $dataobject = new stdClass();
1851             $dataobject->plugintype  = $type;
1852             $dataobject->pluginname  = $plugin;
1853             $dataobject->enabled     = 1;
1854             $dataobject->classname   = $c;
1855             $dataobject->filename    = $f;
1857             if (is_string($method)) {
1858                 $dataobject->functionname = $method;
1860             } else if (is_array($method)) { // wants to override file or class
1861                 $dataobject->functionname = $method['method'];
1862                 $dataobject->classname     = $method['classname'];
1863                 $dataobject->filename      = $method['filename'];
1864             }
1865             $dataobject->xmlrpcpath = $type.'/'.$plugin.'/'.$dataobject->filename.'/'.$method;
1866             $dataobject->static = false;
1868             require_once($path . '/' . $dataobject->filename);
1869             $functionreflect = null; // slightly different ways to get this depending on whether it's a class method or a function
1870             if (!empty($dataobject->classname)) {
1871                 if (!class_exists($dataobject->classname)) {
1872                     throw new moodle_exception('installnosuchmethod', 'mnet', '', (object)array('method' => $dataobject->functionname, 'class' => $dataobject->classname));
1873                 }
1874                 $key = $dataobject->filename . '|' . $dataobject->classname;
1875                 if (!array_key_exists($key, $cachedclasses)) { // look to see if we've already got a reflection object
1876                     try {
1877                         $cachedclasses[$key] = new ReflectionClass($dataobject->classname);
1878                     } catch (ReflectionException $e) { // catch these and rethrow them to something more helpful
1879                         throw new moodle_exception('installreflectionclasserror', 'mnet', '', (object)array('method' => $dataobject->functionname, 'class' => $dataobject->classname, 'error' => $e->getMessage()));
1880                     }
1881                 }
1882                 $r =& $cachedclasses[$key];
1883                 if (!$r->hasMethod($dataobject->functionname)) {
1884                     throw new moodle_exception('installnosuchmethod', 'mnet', '', (object)array('method' => $dataobject->functionname, 'class' => $dataobject->classname));
1885                 }
1886                 $functionreflect = $r->getMethod($dataobject->functionname);
1887                 $dataobject->static = (int)$functionreflect->isStatic();
1888             } else {
1889                 if (!function_exists($dataobject->functionname)) {
1890                     throw new moodle_exception('installnosuchfunction', 'mnet', '', (object)array('method' => $dataobject->functionname, 'file' => $dataobject->filename));
1891                 }
1892                 try {
1893                     $functionreflect = new ReflectionFunction($dataobject->functionname);
1894                 } catch (ReflectionException $e) { // catch these and rethrow them to something more helpful
1895                     throw new moodle_exception('installreflectionfunctionerror', 'mnet', '', (object)array('method' => $dataobject->functionname, '' => $dataobject->filename, 'error' => $e->getMessage()));
1896                 }
1897             }
1898             $dataobject->profile =  serialize(admin_mnet_method_profile($functionreflect));
1899             $dataobject->help = admin_mnet_method_get_help($functionreflect);
1901             if ($record_exists = $DB->get_record('mnet_rpc', array('xmlrpcpath'=>$dataobject->xmlrpcpath))) {
1902                 $dataobject->id      = $record_exists->id;
1903                 $dataobject->enabled = $record_exists->enabled;
1904                 $DB->update_record('mnet_rpc', $dataobject);
1905             } else {
1906                 $dataobject->id = $DB->insert_record('mnet_rpc', $dataobject, true);
1907             }
1909             // TODO this API versioning must be reworked, here the recently processed method
1910             // sets the service API which may not be correct
1911             foreach ($publishmethodservices[$dataobject->functionname] as $service) {
1912                 if ($serviceobj = $DB->get_record('mnet_service', array('name'=>$service['servicename']))) {
1913                     $serviceobj->apiversion = $service['apiversion'];
1914                     $DB->update_record('mnet_service', $serviceobj);
1915                 } else {
1916                     $serviceobj = new stdClass();
1917                     $serviceobj->name        = $service['servicename'];
1918                     $serviceobj->description = empty($service['description']) ? '' : $service['description'];
1919                     $serviceobj->apiversion  = $service['apiversion'];
1920                     $serviceobj->offer       = 1;
1921                     $serviceobj->id          = $DB->insert_record('mnet_service', $serviceobj);
1922                 }
1923                 $servicecache[$service['servicename']] = $serviceobj;
1924                 if (!$DB->record_exists('mnet_service2rpc', array('rpcid'=>$dataobject->id, 'serviceid'=>$serviceobj->id))) {
1925                     $obj = new stdClass();
1926                     $obj->rpcid = $dataobject->id;
1927                     $obj->serviceid = $serviceobj->id;
1928                     $DB->insert_record('mnet_service2rpc', $obj, true);
1929                 }
1930             }
1931         }
1932     }
1933     // finished with methods we publish, now do subscribable methods
1934     foreach($subscribes as $service => $methods) {
1935         if (!array_key_exists($service, $servicecache)) {
1936             if (!$serviceobj = $DB->get_record('mnet_service', array('name' =>  $service))) {
1937                 debugging("TODO: skipping unknown service $service - somebody needs to fix MDL-21993");
1938                 continue;
1939             }
1940             $servicecache[$service] = $serviceobj;
1941         } else {
1942             $serviceobj = $servicecache[$service];
1943         }
1944         foreach ($methods as $method => $xmlrpcpath) {
1945             if (!$rpcid = $DB->get_field('mnet_remote_rpc', 'id', array('xmlrpcpath'=>$xmlrpcpath))) {
1946                 $remoterpc = (object)array(
1947                     'functionname' => $method,
1948                     'xmlrpcpath' => $xmlrpcpath,
1949                     'plugintype' => $type,
1950                     'pluginname' => $plugin,
1951                     'enabled'    => 1,
1952                 );
1953                 $rpcid = $remoterpc->id = $DB->insert_record('mnet_remote_rpc', $remoterpc, true);
1954             }
1955             if (!$DB->record_exists('mnet_remote_service2rpc', array('rpcid'=>$rpcid, 'serviceid'=>$serviceobj->id))) {
1956                 $obj = new stdClass();
1957                 $obj->rpcid = $rpcid;
1958                 $obj->serviceid = $serviceobj->id;
1959                 $DB->insert_record('mnet_remote_service2rpc', $obj, true);
1960             }
1961             $subscribemethodservices[$method][] = $service;
1962         }
1963     }
1965     foreach ($DB->get_records('mnet_remote_rpc', array('pluginname'=>$plugin, 'plugintype'=>$type), 'functionname ASC ') as $rpc) {
1966         if (!array_key_exists($rpc->functionname, $subscribemethodservices) && $rpc->enabled) {
1967             $DB->set_field('mnet_remote_rpc', 'enabled', 0, array('id' => $rpc->id));
1968         } else if (array_key_exists($rpc->functionname, $subscribemethodservices) && !$rpc->enabled) {
1969             $DB->set_field('mnet_remote_rpc', 'enabled', 1, array('id' => $rpc->id));
1970         }
1971     }
1973     return true;
1976 /**
1977  * Given some sort of reflection function/method object, return a profile array, ready to be serialized and stored
1978  *
1979  * @param ReflectionFunctionAbstract $function reflection function/method object from which to extract information
1980  *
1981  * @return array associative array with function/method information
1982  */
1983 function admin_mnet_method_profile(ReflectionFunctionAbstract $function) {
1984     $commentlines = admin_mnet_method_get_docblock($function);
1985     $getkey = function($key) use ($commentlines) {
1986         return array_values(array_filter($commentlines, function($line) use ($key) {
1987             return $line[0] == $key;
1988         }));
1989     };
1990     $returnline = $getkey('@return');
1991     return array (
1992         'parameters' => array_map(function($line) {
1993             return array(
1994                 'name' => trim($line[2], " \t\n\r\0\x0B$"),
1995                 'type' => $line[1],
1996                 'description' => $line[3]
1997             );
1998         }, $getkey('@param')),
2000         'return' => array(
2001             'type' => !empty($returnline[0][1]) ? $returnline[0][1] : 'void',
2002             'description' => !empty($returnline[0][2]) ? $returnline[0][2] : ''
2003         )
2004     );
2007 /**
2008  * Given some sort of reflection function/method object, return an array of docblock lines, where each line is an array of
2009  * keywords/descriptions
2010  *
2011  * @param ReflectionFunctionAbstract $function reflection function/method object from which to extract information
2012  *
2013  * @return array docblock converted in to an array
2014  */
2015 function admin_mnet_method_get_docblock(ReflectionFunctionAbstract $function) {
2016     return array_map(function($line) {
2017         $text = trim($line, " \t\n\r\0\x0B*/");
2018         if (strpos($text, '@param') === 0) {
2019             return preg_split('/\s+/', $text, 4);
2020         }
2022         if (strpos($text, '@return') === 0) {
2023             return preg_split('/\s+/', $text, 3);
2024         }
2026         return array($text);
2027     }, explode("\n", $function->getDocComment()));
2030 /**
2031  * Given some sort of reflection function/method object, return just the help text
2032  *
2033  * @param ReflectionFunctionAbstract $function reflection function/method object from which to extract information
2034  *
2035  * @return string docblock help text
2036  */
2037 function admin_mnet_method_get_help(ReflectionFunctionAbstract $function) {
2038     $helplines = array_map(function($line) {
2039         return implode(' ', $line);
2040     }, array_values(array_filter(admin_mnet_method_get_docblock($function), function($line) {
2041         return strpos($line[0], '@') !== 0 && !empty($line[0]);
2042     })));
2044     return implode("\n", $helplines);
2047 /**
2048  * Detect draft file areas with missing root directory records and add them.
2049  */
2050 function upgrade_fix_missing_root_folders_draft() {
2051     global $DB;
2053     $transaction = $DB->start_delegated_transaction();
2055     $sql = "SELECT contextid, itemid, MAX(timecreated) AS timecreated, MAX(timemodified) AS timemodified
2056               FROM {files}
2057              WHERE (component = 'user' AND filearea = 'draft')
2058           GROUP BY contextid, itemid
2059             HAVING MAX(CASE WHEN filename = '.' AND filepath = '/' THEN 1 ELSE 0 END) = 0";
2061     $rs = $DB->get_recordset_sql($sql);
2062     $defaults = array('component' => 'user',
2063         'filearea' => 'draft',
2064         'filepath' => '/',
2065         'filename' => '.',
2066         'userid' => 0, // Don't rely on any particular user for these system records.
2067         'filesize' => 0,
2068         'contenthash' => sha1(''));
2069     foreach ($rs as $r) {
2070         $r->pathnamehash = sha1("/$r->contextid/user/draft/$r->itemid/.");
2071         $DB->insert_record('files', (array)$r + $defaults);
2072     }
2073     $rs->close();
2074     $transaction->allow_commit();
2077 /**
2078  * This function verifies that the database is not using an unsupported storage engine.
2079  *
2080  * @param environment_results $result object to update, if relevant
2081  * @return environment_results|null updated results object, or null if the storage engine is supported
2082  */
2083 function check_database_storage_engine(environment_results $result) {
2084     global $DB;
2086     // Check if MySQL is the DB family (this will also be the same for MariaDB).
2087     if ($DB->get_dbfamily() == 'mysql') {
2088         // Get the database engine we will either be using to install the tables, or what we are currently using.
2089         $engine = $DB->get_dbengine();
2090         // Check if MyISAM is the storage engine that will be used, if so, do not proceed and display an error.
2091         if ($engine == 'MyISAM') {
2092             $result->setInfo('unsupported_db_storage_engine');
2093             $result->setStatus(false);
2094             return $result;
2095         }
2096     }
2098     return null;
2101 /**
2102  * Method used to check the usage of slasharguments config and display a warning message.
2103  *
2104  * @param environment_results $result object to update, if relevant.
2105  * @return environment_results|null updated results or null if slasharguments is disabled.
2106  */
2107 function check_slasharguments(environment_results $result){
2108     global $CFG;
2110     if (!during_initial_install() && empty($CFG->slasharguments)) {
2111         $result->setInfo('slasharguments');
2112         $result->setStatus(false);
2113         return $result;
2114     }
2116     return null;
2119 /**
2120  * This function verifies if the database has tables using innoDB Antelope row format.
2121  *
2122  * @param environment_results $result
2123  * @return environment_results|null updated results object, or null if no Antelope table has been found.
2124  */
2125 function check_database_tables_row_format(environment_results $result) {
2126     global $DB;
2128     if ($DB->get_dbfamily() == 'mysql') {
2129         $generator = $DB->get_manager()->generator;
2131         foreach ($DB->get_tables(false) as $table) {
2132             $columns = $DB->get_columns($table, false);
2133             $size = $generator->guess_antelope_row_size($columns);
2134             $format = $DB->get_row_format($table);
2136             if ($size <= $generator::ANTELOPE_MAX_ROW_SIZE) {
2137                 continue;
2138             }
2140             if ($format === 'Compact' or $format === 'Redundant') {
2141                 $result->setInfo('unsupported_db_table_row_format');
2142                 $result->setStatus(false);
2143                 return $result;
2144             }
2145         }
2146     }
2148     return null;
2151 /**
2152  * Upgrade the minmaxgrade setting.
2153  *
2154  * This step should only be run for sites running 2.8 or later. Sites using 2.7 will be fine
2155  * using the new default system setting $CFG->grade_minmaxtouse.
2156  *
2157  * @return void
2158  */
2159 function upgrade_minmaxgrade() {
2160     global $CFG, $DB;
2162     // 2 is a copy of GRADE_MIN_MAX_FROM_GRADE_GRADE.
2163     $settingvalue = 2;
2165     // Set the course setting when:
2166     // - The system setting does not exist yet.
2167     // - The system seeting is not set to what we'd set the course setting.
2168     $setcoursesetting = !isset($CFG->grade_minmaxtouse) || $CFG->grade_minmaxtouse != $settingvalue;
2170     // Identify the courses that have inconsistencies grade_item vs grade_grade.
2171     $sql = "SELECT DISTINCT(gi.courseid)
2172               FROM {grade_grades} gg
2173               JOIN {grade_items} gi
2174                 ON gg.itemid = gi.id
2175              WHERE gi.itemtype NOT IN (?, ?)
2176                AND (gg.rawgrademax != gi.grademax OR gg.rawgrademin != gi.grademin)";
2178     $rs = $DB->get_recordset_sql($sql, array('course', 'category'));
2179     foreach ($rs as $record) {
2180         // Flag the course to show a notice in the gradebook.
2181         set_config('show_min_max_grades_changed_' . $record->courseid, 1);
2183         // Set the appropriate course setting so that grades displayed are not changed.
2184         $configname = 'minmaxtouse';
2185         if ($setcoursesetting &&
2186                 !$DB->record_exists('grade_settings', array('courseid' => $record->courseid, 'name' => $configname))) {
2187             // Do not set the setting when the course already defines it.
2188             $data = new stdClass();
2189             $data->courseid = $record->courseid;
2190             $data->name     = $configname;
2191             $data->value    = $settingvalue;
2192             $DB->insert_record('grade_settings', $data);
2193         }
2195         // Mark the grades to be regraded.
2196         $DB->set_field('grade_items', 'needsupdate', 1, array('courseid' => $record->courseid));
2197     }
2198     $rs->close();
2202 /**
2203  * Assert the upgrade key is provided, if it is defined.
2204  *
2205  * The upgrade key can be defined in the main config.php as $CFG->upgradekey. If
2206  * it is defined there, then its value must be provided every time the site is
2207  * being upgraded, regardless the administrator is logged in or not.
2208  *
2209  * This is supposed to be used at certain places in /admin/index.php only.
2210  *
2211  * @param string|null $upgradekeyhash the SHA-1 of the value provided by the user
2212  */
2213 function check_upgrade_key($upgradekeyhash) {
2214     global $CFG, $PAGE;
2216     if (isset($CFG->config_php_settings['upgradekey'])) {
2217         if ($upgradekeyhash === null or $upgradekeyhash !== sha1($CFG->config_php_settings['upgradekey'])) {
2218             if (!$PAGE->headerprinted) {
2219                 $output = $PAGE->get_renderer('core', 'admin');
2220                 echo $output->upgradekey_form_page(new moodle_url('/admin/index.php', array('cache' => 0)));
2221                 die();
2222             } else {
2223                 // This should not happen.
2224                 die('Upgrade locked');
2225             }
2226         }
2227     }
2230 /**
2231  * Helper procedure/macro for installing remote plugins at admin/index.php
2232  *
2233  * Does not return, always redirects or exits.
2234  *
2235  * @param array $installable list of \core\update\remote_info
2236  * @param bool $confirmed false: display the validation screen, true: proceed installation
2237  * @param string $heading validation screen heading
2238  * @param moodle_url|string|null $continue URL to proceed with installation at the validation screen
2239  * @param moodle_url|string|null $return URL to go back on cancelling at the validation screen
2240  */
2241 function upgrade_install_plugins(array $installable, $confirmed, $heading='', $continue=null, $return=null) {
2242     global $CFG, $PAGE;
2244     if (empty($return)) {
2245         $return = $PAGE->url;
2246     }
2248     if (!empty($CFG->disableupdateautodeploy)) {
2249         redirect($return);
2250     }
2252     if (empty($installable)) {
2253         redirect($return);
2254     }
2256     $pluginman = core_plugin_manager::instance();
2258     if ($confirmed) {
2259         // Installation confirmed at the validation results page.
2260         if (!$pluginman->install_plugins($installable, true, true)) {
2261             throw new moodle_exception('install_plugins_failed', 'core_plugin', $return);
2262         }
2264         // Always redirect to admin/index.php to perform the database upgrade.
2265         // Do not throw away the existing $PAGE->url parameters such as
2266         // confirmupgrade or confirmrelease if $PAGE->url is a superset of the
2267         // URL we must go to.
2268         $mustgoto = new moodle_url('/admin/index.php', array('cache' => 0, 'confirmplugincheck' => 0));
2269         if ($mustgoto->compare($PAGE->url, URL_MATCH_PARAMS)) {
2270             redirect($PAGE->url);
2271         } else {
2272             redirect($mustgoto);
2273         }
2275     } else {
2276         $output = $PAGE->get_renderer('core', 'admin');
2277         echo $output->header();
2278         if ($heading) {
2279             echo $output->heading($heading, 3);
2280         }
2281         echo html_writer::start_tag('pre', array('class' => 'plugin-install-console'));
2282         $validated = $pluginman->install_plugins($installable, false, false);
2283         echo html_writer::end_tag('pre');
2284         if ($validated) {
2285             echo $output->plugins_management_confirm_buttons($continue, $return);
2286         } else {
2287             echo $output->plugins_management_confirm_buttons(null, $return);
2288         }
2289         echo $output->footer();
2290         die();
2291     }
2293 /**
2294  * Method used to check the installed unoconv version.
2295  *
2296  * @param environment_results $result object to update, if relevant.
2297  * @return environment_results|null updated results or null if unoconv path is not executable.
2298  */
2299 function check_unoconv_version(environment_results $result) {
2300     global $CFG;
2302     if (!during_initial_install() && !empty($CFG->pathtounoconv) && file_is_executable(trim($CFG->pathtounoconv))) {
2303         $currentversion = 0;
2304         $supportedversion = 0.7;
2305         $unoconvbin = \escapeshellarg($CFG->pathtounoconv);
2306         $command = "$unoconvbin --version";
2307         exec($command, $output);
2309         // If the command execution returned some output, then get the unoconv version.
2310         if ($output) {
2311             foreach ($output as $response) {
2312                 if (preg_match('/unoconv (\\d+\\.\\d+)/', $response, $matches)) {
2313                     $currentversion = (float)$matches[1];
2314                 }
2315             }
2316         }
2318         if ($currentversion < $supportedversion) {
2319             $result->setInfo('unoconv version not supported');
2320             $result->setStatus(false);
2321             return $result;
2322         }
2323     }
2324     return null;
2327 /**
2328  * Checks for up-to-date TLS libraries.
2329  *
2330  * @param environment_results $result object to update, if relevant.
2331  * @return environment_results|null updated results or null if unoconv path is not executable.
2332  */
2333 function check_tls_libraries(environment_results $result) {
2334     global $CFG;
2336     if (!function_exists('curl_version')) {
2337         $result->setInfo('cURL PHP extension is not installed');
2338         $result->setStatus(false);
2339         return $result;
2340     }
2342     if (!\core\upgrade\util::validate_php_curl_tls(curl_version(), PHP_ZTS)) {
2343         $result->setInfo('invalid ssl/tls configuration');
2344         $result->setStatus(false);
2345         return $result;
2346     }
2348     if (!\core\upgrade\util::can_use_tls12(curl_version(), php_uname('r'))) {
2349         $result->setInfo('ssl/tls configuration not supported');
2350         $result->setStatus(false);
2351         return $result;
2352     }
2354     return null;
2357 /**
2358  * Check if recommended version of libcurl is installed or not.
2359  *
2360  * @param environment_results $result object to update, if relevant.
2361  * @return environment_results|null updated results or null.
2362  */
2363 function check_libcurl_version(environment_results $result) {
2365     if (!function_exists('curl_version')) {
2366         $result->setInfo('cURL PHP extension is not installed');
2367         $result->setStatus(false);
2368         return $result;
2369     }
2371     // Supported version and version number.
2372     $supportedversion = 0x071304;
2373     $supportedversionstring = "7.19.4";
2375     // Installed version.
2376     $curlinfo = curl_version();
2377     $currentversion = $curlinfo['version_number'];
2379     if ($currentversion < $supportedversion) {
2380         // Test fail.
2381         // Set info, we want to let user know how to resolve the problem.
2382         $result->setInfo('Libcurl version check');
2383         $result->setNeededVersion($supportedversionstring);
2384         $result->setCurrentVersion($curlinfo['version']);
2385         $result->setStatus(false);
2386         return $result;
2387     }
2389     return null;