bf8829f81883b7402c814145ce49a345668eb04c
[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  * Upgrade savepoint, marks end of each upgrade block.
102  * It stores new main version, resets upgrade timeout
103  * and abort upgrade if user cancels page loading.
104  *
105  * Please do not make large upgrade blocks with lots of operations,
106  * for example when adding tables keep only one table operation per block.
107  *
108  * @global object
109  * @param bool $result false if upgrade step failed, true if completed
110  * @param string or float $version main version
111  * @param bool $allowabort allow user to abort script execution here
112  * @return void
113  */
114 function upgrade_main_savepoint($result, $version, $allowabort=true) {
115     global $CFG;
117     //sanity check to avoid confusion with upgrade_mod_savepoint usage.
118     if (!is_bool($allowabort)) {
119         $errormessage = 'Parameter type mismatch. Are you mixing up upgrade_main_savepoint() and upgrade_mod_savepoint()?';
120         throw new coding_exception($errormessage);
121     }
123     if (!$result) {
124         throw new upgrade_exception(null, $version);
125     }
127     if ($CFG->version >= $version) {
128         // something really wrong is going on in main upgrade script
129         throw new downgrade_exception(null, $CFG->version, $version);
130     }
132     set_config('version', $version);
133     upgrade_log(UPGRADE_LOG_NORMAL, null, 'Upgrade savepoint reached');
135     // reset upgrade timeout to default
136     upgrade_set_timeout();
138     // this is a safe place to stop upgrades if user aborts page loading
139     if ($allowabort and connection_aborted()) {
140         die;
141     }
144 /**
145  * Module upgrade savepoint, marks end of module upgrade blocks
146  * It stores module version, resets upgrade timeout
147  * and abort upgrade if user cancels page loading.
148  *
149  * @global object
150  * @param bool $result false if upgrade step failed, true if completed
151  * @param string or float $version main version
152  * @param string $modname name of module
153  * @param bool $allowabort allow user to abort script execution here
154  * @return void
155  */
156 function upgrade_mod_savepoint($result, $version, $modname, $allowabort=true) {
157     global $DB;
159     if (!$result) {
160         throw new upgrade_exception("mod_$modname", $version);
161     }
163     if (!$module = $DB->get_record('modules', array('name'=>$modname))) {
164         print_error('modulenotexist', 'debug', '', $modname);
165     }
167     if ($module->version >= $version) {
168         // something really wrong is going on in upgrade script
169         throw new downgrade_exception("mod_$modname", $module->version, $version);
170     }
171     $module->version = $version;
172     $DB->update_record('modules', $module);
173     upgrade_log(UPGRADE_LOG_NORMAL, "mod_$modname", 'Upgrade savepoint reached');
175     // reset upgrade timeout to default
176     upgrade_set_timeout();
178     // this is a safe place to stop upgrades if user aborts page loading
179     if ($allowabort and connection_aborted()) {
180         die;
181     }
184 /**
185  * Blocks upgrade savepoint, marks end of blocks upgrade blocks
186  * It stores block version, resets upgrade timeout
187  * and abort upgrade if user cancels page loading.
188  *
189  * @global object
190  * @param bool $result false if upgrade step failed, true if completed
191  * @param string or float $version main version
192  * @param string $blockname name of block
193  * @param bool $allowabort allow user to abort script execution here
194  * @return void
195  */
196 function upgrade_block_savepoint($result, $version, $blockname, $allowabort=true) {
197     global $DB;
199     if (!$result) {
200         throw new upgrade_exception("block_$blockname", $version);
201     }
203     if (!$block = $DB->get_record('block', array('name'=>$blockname))) {
204         print_error('blocknotexist', 'debug', '', $blockname);
205     }
207     if ($block->version >= $version) {
208         // something really wrong is going on in upgrade script
209         throw new downgrade_exception("block_$blockname", $block->version, $version);
210     }
211     $block->version = $version;
212     $DB->update_record('block', $block);
213     upgrade_log(UPGRADE_LOG_NORMAL, "block_$blockname", 'Upgrade savepoint reached');
215     // reset upgrade timeout to default
216     upgrade_set_timeout();
218     // this is a safe place to stop upgrades if user aborts page loading
219     if ($allowabort and connection_aborted()) {
220         die;
221     }
224 /**
225  * Plugins upgrade savepoint, marks end of blocks upgrade blocks
226  * It stores plugin version, resets upgrade timeout
227  * and abort upgrade if user cancels page loading.
228  *
229  * @param bool $result false if upgrade step failed, true if completed
230  * @param string or float $version main version
231  * @param string $type name of plugin
232  * @param string $dir location of plugin
233  * @param bool $allowabort allow user to abort script execution here
234  * @return void
235  */
236 function upgrade_plugin_savepoint($result, $version, $type, $plugin, $allowabort=true) {
237     $component = $type.'_'.$plugin;
239     if (!$result) {
240         throw new upgrade_exception($component, $version);
241     }
243     $installedversion = get_config($component, 'version');
244     if ($installedversion >= $version) {
245         // Something really wrong is going on in the upgrade script
246         throw new downgrade_exception($component, $installedversion, $version);
247     }
248     set_config('version', $version, $component);
249     upgrade_log(UPGRADE_LOG_NORMAL, $component, 'Upgrade savepoint reached');
251     // Reset upgrade timeout to default
252     upgrade_set_timeout();
254     // This is a safe place to stop upgrades if user aborts page loading
255     if ($allowabort and connection_aborted()) {
256         die;
257     }
261 /**
262  * Upgrade plugins
263  * @param string $type The type of plugins that should be updated (e.g. 'enrol', 'qtype')
264  * return void
265  */
266 function upgrade_plugins($type, $startcallback, $endcallback, $verbose) {
267     global $CFG, $DB;
269 /// special cases
270     if ($type === 'mod') {
271         return upgrade_plugins_modules($startcallback, $endcallback, $verbose);
272     } else if ($type === 'block') {
273         return upgrade_plugins_blocks($startcallback, $endcallback, $verbose);
274     }
276     $plugs = get_plugin_list($type);
278     foreach ($plugs as $plug=>$fullplug) {
279         $component = clean_param($type.'_'.$plug, PARAM_COMPONENT); // standardised plugin name
281         // check plugin dir is valid name
282         if (empty($component)) {
283             throw new plugin_defective_exception($type.'_'.$plug, 'Invalid plugin directory name.');
284         }
286         if (!is_readable($fullplug.'/version.php')) {
287             continue;
288         }
290         $plugin = new stdClass();
291         require($fullplug.'/version.php');  // defines $plugin with version etc
293         // if plugin tells us it's full name we may check the location
294         if (isset($plugin->component)) {
295             if ($plugin->component !== $component) {
296                 throw new plugin_defective_exception($component, 'Plugin installed in wrong folder.');
297             }
298         }
300         if (empty($plugin->version)) {
301             throw new plugin_defective_exception($component, 'Missing version value in version.php');
302         }
304         $plugin->name     = $plug;
305         $plugin->fullname = $component;
308         if (!empty($plugin->requires)) {
309             if ($plugin->requires > $CFG->version) {
310                 throw new upgrade_requires_exception($component, $plugin->version, $CFG->version, $plugin->requires);
311             } else if ($plugin->requires < 2010000000) {
312                 throw new plugin_defective_exception($component, 'Plugin is not compatible with Moodle 2.x or later.');
313             }
314         }
316         // try to recover from interrupted install.php if needed
317         if (file_exists($fullplug.'/db/install.php')) {
318             if (get_config($plugin->fullname, 'installrunning')) {
319                 require_once($fullplug.'/db/install.php');
320                 $recover_install_function = 'xmldb_'.$plugin->fullname.'_install_recovery';
321                 if (function_exists($recover_install_function)) {
322                     $startcallback($component, true, $verbose);
323                     $recover_install_function();
324                     unset_config('installrunning', $plugin->fullname);
325                     update_capabilities($component);
326                     log_update_descriptions($component);
327                     external_update_descriptions($component);
328                     events_update_definition($component);
329                     message_update_providers($component);
330                     if ($type === 'message') {
331                         message_update_processors($plug);
332                     }
333                     upgrade_plugin_mnet_functions($component);
334                     $endcallback($component, true, $verbose);
335                 }
336             }
337         }
339         $installedversion = get_config($plugin->fullname, 'version');
340         if (empty($installedversion)) { // new installation
341             $startcallback($component, true, $verbose);
343         /// Install tables if defined
344             if (file_exists($fullplug.'/db/install.xml')) {
345                 $DB->get_manager()->install_from_xmldb_file($fullplug.'/db/install.xml');
346             }
348         /// store version
349             upgrade_plugin_savepoint(true, $plugin->version, $type, $plug, false);
351         /// execute post install file
352             if (file_exists($fullplug.'/db/install.php')) {
353                 require_once($fullplug.'/db/install.php');
354                 set_config('installrunning', 1, $plugin->fullname);
355                 $post_install_function = 'xmldb_'.$plugin->fullname.'_install';
356                 $post_install_function();
357                 unset_config('installrunning', $plugin->fullname);
358             }
360         /// Install various components
361             update_capabilities($component);
362             log_update_descriptions($component);
363             external_update_descriptions($component);
364             events_update_definition($component);
365             message_update_providers($component);
366             if ($type === 'message') {
367                 message_update_processors($plug);
368             }
369             upgrade_plugin_mnet_functions($component);
371             purge_all_caches();
372             $endcallback($component, true, $verbose);
374         } else if ($installedversion < $plugin->version) { // upgrade
375         /// Run the upgrade function for the plugin.
376             $startcallback($component, false, $verbose);
378             if (is_readable($fullplug.'/db/upgrade.php')) {
379                 require_once($fullplug.'/db/upgrade.php');  // defines upgrading function
381                 $newupgrade_function = 'xmldb_'.$plugin->fullname.'_upgrade';
382                 $result = $newupgrade_function($installedversion);
383             } else {
384                 $result = true;
385             }
387             $installedversion = get_config($plugin->fullname, 'version');
388             if ($installedversion < $plugin->version) {
389                 // store version if not already there
390                 upgrade_plugin_savepoint($result, $plugin->version, $type, $plug, false);
391             }
393         /// Upgrade various components
394             update_capabilities($component);
395             log_update_descriptions($component);
396             external_update_descriptions($component);
397             events_update_definition($component);
398             message_update_providers($component);
399             if ($type === 'message') {
400                 message_update_processors($plug);
401             }
402             upgrade_plugin_mnet_functions($component);
404             purge_all_caches();
405             $endcallback($component, false, $verbose);
407         } else if ($installedversion > $plugin->version) {
408             throw new downgrade_exception($component, $installedversion, $plugin->version);
409         }
410     }
413 /**
414  * Find and check all modules and load them up or upgrade them if necessary
415  *
416  * @global object
417  * @global object
418  */
419 function upgrade_plugins_modules($startcallback, $endcallback, $verbose) {
420     global $CFG, $DB;
422     $mods = get_plugin_list('mod');
424     foreach ($mods as $mod=>$fullmod) {
426         if ($mod === 'NEWMODULE') {   // Someone has unzipped the template, ignore it
427             continue;
428         }
430         $component = clean_param('mod_'.$mod, PARAM_COMPONENT);
432         // check module dir is valid name
433         if (empty($component)) {
434             throw new plugin_defective_exception('mod_'.$mod, 'Invalid plugin directory name.');
435         }
437         if (!is_readable($fullmod.'/version.php')) {
438             throw new plugin_defective_exception($component, 'Missing version.php');
439         }
441         $module = new stdClass();
442         require($fullmod .'/version.php');  // defines $module with version etc
444         // if plugin tells us it's full name we may check the location
445         if (isset($module->component)) {
446             if ($module->component !== $component) {
447                 throw new plugin_defective_exception($component, 'Plugin installed in wrong folder.');
448             }
449         }
451         if (empty($module->version)) {
452             if (isset($module->version)) {
453                 // Version is empty but is set - it means its value is 0 or ''. Let us skip such module.
454                 // This is intended for developers so they can work on the early stages of the module.
455                 continue;
456             }
457             throw new plugin_defective_exception($component, 'Missing version value in version.php');
458         }
460         if (!empty($module->requires)) {
461             if ($module->requires > $CFG->version) {
462                 throw new upgrade_requires_exception($component, $module->version, $CFG->version, $module->requires);
463             } else if ($module->requires < 2010000000) {
464                 throw new plugin_defective_exception($component, 'Plugin is not compatible with Moodle 2.x or later.');
465             }
466         }
468         // all modules must have en lang pack
469         if (!is_readable("$fullmod/lang/en/$mod.php")) {
470             throw new plugin_defective_exception($component, 'Missing mandatory en language pack.');
471         }
473         $module->name = $mod;   // The name MUST match the directory
475         $currmodule = $DB->get_record('modules', array('name'=>$module->name));
477         if (file_exists($fullmod.'/db/install.php')) {
478             if (get_config($module->name, 'installrunning')) {
479                 require_once($fullmod.'/db/install.php');
480                 $recover_install_function = 'xmldb_'.$module->name.'_install_recovery';
481                 if (function_exists($recover_install_function)) {
482                     $startcallback($component, true, $verbose);
483                     $recover_install_function();
484                     unset_config('installrunning', $module->name);
485                     // Install various components too
486                     update_capabilities($component);
487                     log_update_descriptions($component);
488                     external_update_descriptions($component);
489                     events_update_definition($component);
490                     message_update_providers($component);
491                     upgrade_plugin_mnet_functions($component);
492                     $endcallback($component, true, $verbose);
493                 }
494             }
495         }
497         if (empty($currmodule->version)) {
498             $startcallback($component, true, $verbose);
500         /// Execute install.xml (XMLDB) - must be present in all modules
501             $DB->get_manager()->install_from_xmldb_file($fullmod.'/db/install.xml');
503         /// Add record into modules table - may be needed in install.php already
504             $module->id = $DB->insert_record('modules', $module);
506         /// Post installation hook - optional
507             if (file_exists("$fullmod/db/install.php")) {
508                 require_once("$fullmod/db/install.php");
509                 // Set installation running flag, we need to recover after exception or error
510                 set_config('installrunning', 1, $module->name);
511                 $post_install_function = 'xmldb_'.$module->name.'_install';
512                 $post_install_function();
513                 unset_config('installrunning', $module->name);
514             }
516         /// Install various components
517             update_capabilities($component);
518             log_update_descriptions($component);
519             external_update_descriptions($component);
520             events_update_definition($component);
521             message_update_providers($component);
522             upgrade_plugin_mnet_functions($component);
524             purge_all_caches();
525             $endcallback($component, true, $verbose);
527         } else if ($currmodule->version < $module->version) {
528         /// If versions say that we need to upgrade but no upgrade files are available, notify and continue
529             $startcallback($component, false, $verbose);
531             if (is_readable($fullmod.'/db/upgrade.php')) {
532                 require_once($fullmod.'/db/upgrade.php');  // defines new upgrading function
533                 $newupgrade_function = 'xmldb_'.$module->name.'_upgrade';
534                 $result = $newupgrade_function($currmodule->version, $module);
535             } else {
536                 $result = true;
537             }
539             $currmodule = $DB->get_record('modules', array('name'=>$module->name));
540             if ($currmodule->version < $module->version) {
541                 // store version if not already there
542                 upgrade_mod_savepoint($result, $module->version, $mod, false);
543             }
545             // update cron flag if needed
546             if ($currmodule->cron != $module->cron) {
547                 $DB->set_field('modules', 'cron', $module->cron, array('name' => $module->name));
548             }
550             // Upgrade various components
551             update_capabilities($component);
552             log_update_descriptions($component);
553             external_update_descriptions($component);
554             events_update_definition($component);
555             message_update_providers($component);
556             upgrade_plugin_mnet_functions($component);
558             purge_all_caches();
560             $endcallback($component, false, $verbose);
562         } else if ($currmodule->version > $module->version) {
563             throw new downgrade_exception($component, $currmodule->version, $module->version);
564         }
565     }
569 /**
570  * This function finds all available blocks and install them
571  * into blocks table or do all the upgrade process if newer.
572  *
573  * @global object
574  * @global object
575  */
576 function upgrade_plugins_blocks($startcallback, $endcallback, $verbose) {
577     global $CFG, $DB;
579     require_once($CFG->dirroot.'/blocks/moodleblock.class.php');
581     $blocktitles   = array(); // we do not want duplicate titles
583     //Is this a first install
584     $first_install = null;
586     $blocks = get_plugin_list('block');
588     foreach ($blocks as $blockname=>$fullblock) {
590         if (is_null($first_install)) {
591             $first_install = ($DB->count_records('block_instances') == 0);
592         }
594         if ($blockname === 'NEWBLOCK') {   // Someone has unzipped the template, ignore it
595             continue;
596         }
598         $component = clean_param('block_'.$blockname, PARAM_COMPONENT);
600         // check block dir is valid name
601         if (empty($component)) {
602             throw new plugin_defective_exception('block_'.$blockname, 'Invalid plugin directory name.');
603         }
605         if (!is_readable($fullblock.'/version.php')) {
606             throw new plugin_defective_exception('block/'.$blockname, 'Missing version.php file.');
607         }
608         $plugin = new stdClass();
609         $plugin->version = NULL;
610         $plugin->cron    = 0;
611         include($fullblock.'/version.php');
612         $block = $plugin;
614         // if plugin tells us it's full name we may check the location
615         if (isset($block->component)) {
616             if ($block->component !== $component) {
617                 throw new plugin_defective_exception($component, 'Plugin installed in wrong folder.');
618             }
619         }
621         if (!empty($plugin->requires)) {
622             if ($plugin->requires > $CFG->version) {
623                 throw new upgrade_requires_exception($component, $plugin->version, $CFG->version, $plugin->requires);
624             } else if ($plugin->requires < 2010000000) {
625                 throw new plugin_defective_exception($component, 'Plugin is not compatible with Moodle 2.x or later.');
626             }
627         }
629         if (!is_readable($fullblock.'/block_'.$blockname.'.php')) {
630             throw new plugin_defective_exception('block/'.$blockname, 'Missing main block class file.');
631         }
632         include_once($fullblock.'/block_'.$blockname.'.php');
634         $classname = 'block_'.$blockname;
636         if (!class_exists($classname)) {
637             throw new plugin_defective_exception($component, 'Can not load main class.');
638         }
640         $blockobj    = new $classname;   // This is what we'll be testing
641         $blocktitle  = $blockobj->get_title();
643         // OK, it's as we all hoped. For further tests, the object will do them itself.
644         if (!$blockobj->_self_test()) {
645             throw new plugin_defective_exception($component, 'Self test failed.');
646         }
648         $block->name     = $blockname;   // The name MUST match the directory
650         if (empty($block->version)) {
651             throw new plugin_defective_exception($component, 'Missing block version.');
652         }
654         $currblock = $DB->get_record('block', array('name'=>$block->name));
656         if (file_exists($fullblock.'/db/install.php')) {
657             if (get_config('block_'.$blockname, 'installrunning')) {
658                 require_once($fullblock.'/db/install.php');
659                 $recover_install_function = 'xmldb_block_'.$blockname.'_install_recovery';
660                 if (function_exists($recover_install_function)) {
661                     $startcallback($component, true, $verbose);
662                     $recover_install_function();
663                     unset_config('installrunning', 'block_'.$blockname);
664                     // Install various components
665                     update_capabilities($component);
666                     log_update_descriptions($component);
667                     external_update_descriptions($component);
668                     events_update_definition($component);
669                     message_update_providers($component);
670                     upgrade_plugin_mnet_functions($component);
671                     $endcallback($component, true, $verbose);
672                 }
673             }
674         }
676         if (empty($currblock->version)) { // block not installed yet, so install it
677             $conflictblock = array_search($blocktitle, $blocktitles);
678             if ($conflictblock !== false) {
679                 // Duplicate block titles are not allowed, they confuse people
680                 // AND PHP's associative arrays ;)
681                 throw new plugin_defective_exception($component, get_string('blocknameconflict', 'error', (object)array('name'=>$block->name, 'conflict'=>$conflictblock)));
682             }
683             $startcallback($component, true, $verbose);
685             if (file_exists($fullblock.'/db/install.xml')) {
686                 $DB->get_manager()->install_from_xmldb_file($fullblock.'/db/install.xml');
687             }
688             $block->id = $DB->insert_record('block', $block);
690             if (file_exists($fullblock.'/db/install.php')) {
691                 require_once($fullblock.'/db/install.php');
692                 // Set installation running flag, we need to recover after exception or error
693                 set_config('installrunning', 1, 'block_'.$blockname);
694                 $post_install_function = 'xmldb_block_'.$blockname.'_install';;
695                 $post_install_function();
696                 unset_config('installrunning', 'block_'.$blockname);
697             }
699             $blocktitles[$block->name] = $blocktitle;
701             // Install various components
702             update_capabilities($component);
703             log_update_descriptions($component);
704             external_update_descriptions($component);
705             events_update_definition($component);
706             message_update_providers($component);
707             upgrade_plugin_mnet_functions($component);
709             purge_all_caches();
710             $endcallback($component, true, $verbose);
712         } else if ($currblock->version < $block->version) {
713             $startcallback($component, false, $verbose);
715             if (is_readable($fullblock.'/db/upgrade.php')) {
716                 require_once($fullblock.'/db/upgrade.php');  // defines new upgrading function
717                 $newupgrade_function = 'xmldb_block_'.$blockname.'_upgrade';
718                 $result = $newupgrade_function($currblock->version, $block);
719             } else {
720                 $result = true;
721             }
723             $currblock = $DB->get_record('block', array('name'=>$block->name));
724             if ($currblock->version < $block->version) {
725                 // store version if not already there
726                 upgrade_block_savepoint($result, $block->version, $block->name, false);
727             }
729             if ($currblock->cron != $block->cron) {
730                 // update cron flag if needed
731                 $currblock->cron = $block->cron;
732                 $DB->update_record('block', $currblock);
733             }
735             // Upgrade various components
736             update_capabilities($component);
737             log_update_descriptions($component);
738             external_update_descriptions($component);
739             events_update_definition($component);
740             message_update_providers($component);
741             upgrade_plugin_mnet_functions($component);
743             purge_all_caches();
744             $endcallback($component, false, $verbose);
746         } else if ($currblock->version > $block->version) {
747             throw new downgrade_exception($component, $currblock->version, $block->version);
748         }
749     }
752     // Finally, if we are in the first_install of BLOCKS setup frontpage and admin page blocks
753     if ($first_install) {
754         //Iterate over each course - there should be only site course here now
755         if ($courses = $DB->get_records('course')) {
756             foreach ($courses as $course) {
757                 blocks_add_default_course_blocks($course);
758             }
759         }
761         blocks_add_default_system_blocks();
762     }
766 /**
767  * Log_display description function used during install and upgrade.
768  *
769  * @param string $component name of component (moodle, mod_assignment, etc.)
770  * @return void
771  */
772 function log_update_descriptions($component) {
773     global $DB;
775     $defpath = get_component_directory($component).'/db/log.php';
777     if (!file_exists($defpath)) {
778         $DB->delete_records('log_display', array('component'=>$component));
779         return;
780     }
782     // load new info
783     $logs = array();
784     include($defpath);
785     $newlogs = array();
786     foreach ($logs as $log) {
787         $newlogs[$log['module'].'-'.$log['action']] = $log; // kind of unique name
788     }
789     unset($logs);
790     $logs = $newlogs;
792     $fields = array('module', 'action', 'mtable', 'field');
793     // update all log fist
794     $dblogs = $DB->get_records('log_display', array('component'=>$component));
795     foreach ($dblogs as $dblog) {
796         $name = $dblog->module.'-'.$dblog->action;
798         if (empty($logs[$name])) {
799             $DB->delete_records('log_display', array('id'=>$dblog->id));
800             continue;
801         }
803         $log = $logs[$name];
804         unset($logs[$name]);
806         $update = false;
807         foreach ($fields as $field) {
808             if ($dblog->$field != $log[$field]) {
809                 $dblog->$field = $log[$field];
810                 $update = true;
811             }
812         }
813         if ($update) {
814             $DB->update_record('log_display', $dblog);
815         }
816     }
817     foreach ($logs as $log) {
818         $dblog = (object)$log;
819         $dblog->component = $component;
820         $DB->insert_record('log_display', $dblog);
821     }
824 /**
825  * Web service discovery function used during install and upgrade.
826  * @param string $component name of component (moodle, mod_assignment, etc.)
827  * @return void
828  */
829 function external_update_descriptions($component) {
830     global $DB;
832     $defpath = get_component_directory($component).'/db/services.php';
834     if (!file_exists($defpath)) {
835         external_delete_descriptions($component);
836         return;
837     }
839     // load new info
840     $functions = array();
841     $services = array();
842     include($defpath);
844     // update all function fist
845     $dbfunctions = $DB->get_records('external_functions', array('component'=>$component));
846     foreach ($dbfunctions as $dbfunction) {
847         if (empty($functions[$dbfunction->name])) {
848             $DB->delete_records('external_functions', array('id'=>$dbfunction->id));
849             // do not delete functions from external_services_functions, beacuse
850             // we want to notify admins when functions used in custom services disappear
852             //TODO: this looks wrong, we have to delete it eventually (skodak)
853             continue;
854         }
856         $function = $functions[$dbfunction->name];
857         unset($functions[$dbfunction->name]);
858         $function['classpath'] = empty($function['classpath']) ? null : $function['classpath'];
860         $update = false;
861         if ($dbfunction->classname != $function['classname']) {
862             $dbfunction->classname = $function['classname'];
863             $update = true;
864         }
865         if ($dbfunction->methodname != $function['methodname']) {
866             $dbfunction->methodname = $function['methodname'];
867             $update = true;
868         }
869         if ($dbfunction->classpath != $function['classpath']) {
870             $dbfunction->classpath = $function['classpath'];
871             $update = true;
872         }
873         $functioncapabilities = key_exists('capabilities', $function)?$function['capabilities']:'';
874         if ($dbfunction->capabilities != $functioncapabilities) {
875             $dbfunction->capabilities = $functioncapabilities;
876             $update = true;
877         }
878         if ($update) {
879             $DB->update_record('external_functions', $dbfunction);
880         }
881     }
882     foreach ($functions as $fname => $function) {
883         $dbfunction = new stdClass();
884         $dbfunction->name       = $fname;
885         $dbfunction->classname  = $function['classname'];
886         $dbfunction->methodname = $function['methodname'];
887         $dbfunction->classpath  = empty($function['classpath']) ? null : $function['classpath'];
888         $dbfunction->component  = $component;
889         $dbfunction->capabilities = key_exists('capabilities', $function)?$function['capabilities']:'';
890         $dbfunction->id = $DB->insert_record('external_functions', $dbfunction);
891     }
892     unset($functions);
894     // now deal with services
895     $dbservices = $DB->get_records('external_services', array('component'=>$component));
896     foreach ($dbservices as $dbservice) {
897         if (empty($services[$dbservice->name])) {
898             $DB->delete_records('external_services_functions', array('externalserviceid'=>$dbservice->id));
899             $DB->delete_records('external_services_users', array('externalserviceid'=>$dbservice->id));
900             $DB->delete_records('external_services', array('id'=>$dbservice->id));
901             continue;
902         }
903         $service = $services[$dbservice->name];
904         unset($services[$dbservice->name]);
905         $service['enabled'] = empty($service['enabled']) ? 0 : $service['enabled'];
906         $service['requiredcapability'] = empty($service['requiredcapability']) ? null : $service['requiredcapability'];
907         $service['restrictedusers'] = !isset($service['restrictedusers']) ? 1 : $service['restrictedusers'];
908         $service['downloadfiles'] = !isset($service['downloadfiles']) ? 0 : $service['downloadfiles'];
909         $service['shortname'] = !isset($service['shortname']) ? null : $service['shortname'];
911         $update = false;
912         if ($dbservice->requiredcapability != $service['requiredcapability']) {
913             $dbservice->requiredcapability = $service['requiredcapability'];
914             $update = true;
915         }
916         if ($dbservice->restrictedusers != $service['restrictedusers']) {
917             $dbservice->restrictedusers = $service['restrictedusers'];
918             $update = true;
919         }
920         if ($dbservice->downloadfiles != $service['downloadfiles']) {
921             $dbservice->downloadfiles = $service['downloadfiles'];
922             $update = true;
923         }
924         //if shortname is not a PARAM_ALPHANUMEXT, fail (tested here for service update and creation)
925         if (isset($service['shortname']) and
926                 (clean_param($service['shortname'], PARAM_ALPHANUMEXT) != $service['shortname'])) {
927             throw new moodle_exception('installserviceshortnameerror', 'webservice', '', $service['shortname']);
928         }
929         if ($dbservice->shortname != $service['shortname']) {
930             //check that shortname is unique
931             if (isset($service['shortname'])) { //we currently accepts multiple shortname == null
932                 $existingservice = $DB->get_record('external_services',
933                         array('shortname' => $service['shortname']));
934                 if (!empty($existingservice)) {
935                     throw new moodle_exception('installexistingserviceshortnameerror', 'webservice', '', $service['shortname']);
936                 }
937             }
938             $dbservice->shortname = $service['shortname'];
939             $update = true;
940         }
941         if ($update) {
942             $DB->update_record('external_services', $dbservice);
943         }
945         $functions = $DB->get_records('external_services_functions', array('externalserviceid'=>$dbservice->id));
946         foreach ($functions as $function) {
947             $key = array_search($function->functionname, $service['functions']);
948             if ($key === false) {
949                 $DB->delete_records('external_services_functions', array('id'=>$function->id));
950             } else {
951                 unset($service['functions'][$key]);
952             }
953         }
954         foreach ($service['functions'] as $fname) {
955             $newf = new stdClass();
956             $newf->externalserviceid = $dbservice->id;
957             $newf->functionname      = $fname;
958             $DB->insert_record('external_services_functions', $newf);
959         }
960         unset($functions);
961     }
962     foreach ($services as $name => $service) {
963         //check that shortname is unique
964         if (isset($service['shortname'])) { //we currently accepts multiple shortname == null
965             $existingservice = $DB->get_record('external_services',
966                     array('shortname' => $service['shortname']));
967             if (!empty($existingservice)) {
968                 throw new moodle_exception('installserviceshortnameerror', 'webservice');
969             }
970         }
972         $dbservice = new stdClass();
973         $dbservice->name               = $name;
974         $dbservice->enabled            = empty($service['enabled']) ? 0 : $service['enabled'];
975         $dbservice->requiredcapability = empty($service['requiredcapability']) ? null : $service['requiredcapability'];
976         $dbservice->restrictedusers    = !isset($service['restrictedusers']) ? 1 : $service['restrictedusers'];
977         $dbservice->downloadfiles      = !isset($service['downloadfiles']) ? 0 : $service['downloadfiles'];
978         $dbservice->shortname          = !isset($service['shortname']) ? null : $service['shortname'];
979         $dbservice->component          = $component;
980         $dbservice->timecreated        = time();
981         $dbservice->id = $DB->insert_record('external_services', $dbservice);
982         foreach ($service['functions'] as $fname) {
983             $newf = new stdClass();
984             $newf->externalserviceid = $dbservice->id;
985             $newf->functionname      = $fname;
986             $DB->insert_record('external_services_functions', $newf);
987         }
988     }
991 /**
992  * Delete all service and external functions information defined in the specified component.
993  * @param string $component name of component (moodle, mod_assignment, etc.)
994  * @return void
995  */
996 function external_delete_descriptions($component) {
997     global $DB;
999     $params = array($component);
1001     $DB->delete_records_select('external_services_users', "externalserviceid IN (SELECT id FROM {external_services} WHERE component = ?)", $params);
1002     $DB->delete_records_select('external_services_functions', "externalserviceid IN (SELECT id FROM {external_services} WHERE component = ?)", $params);
1003     $DB->delete_records('external_services', array('component'=>$component));
1004     $DB->delete_records('external_functions', array('component'=>$component));
1007 /**
1008  * upgrade logging functions
1009  */
1010 function upgrade_handle_exception($ex, $plugin = null) {
1011     global $CFG;
1013     // rollback everything, we need to log all upgrade problems
1014     abort_all_db_transactions();
1016     $info = get_exception_info($ex);
1018     // First log upgrade error
1019     upgrade_log(UPGRADE_LOG_ERROR, $plugin, 'Exception: ' . get_class($ex), $info->message, $info->backtrace);
1021     // Always turn on debugging - admins need to know what is going on
1022     $CFG->debug = DEBUG_DEVELOPER;
1024     default_exception_handler($ex, true, $plugin);
1027 /**
1028  * Adds log entry into upgrade_log table
1029  *
1030  * @param int $type UPGRADE_LOG_NORMAL, UPGRADE_LOG_NOTICE or UPGRADE_LOG_ERROR
1031  * @param string $plugin frankenstyle component name
1032  * @param string $info short description text of log entry
1033  * @param string $details long problem description
1034  * @param string $backtrace string used for errors only
1035  * @return void
1036  */
1037 function upgrade_log($type, $plugin, $info, $details=null, $backtrace=null) {
1038     global $DB, $USER, $CFG;
1040     if (empty($plugin)) {
1041         $plugin = 'core';
1042     }
1044     list($plugintype, $pluginname) = normalize_component($plugin);
1045     $component = is_null($pluginname) ? $plugintype : $plugintype . '_' . $pluginname;
1047     $backtrace = format_backtrace($backtrace, true);
1049     $currentversion = null;
1050     $targetversion  = null;
1052     //first try to find out current version number
1053     if ($plugintype === 'core') {
1054         //main
1055         $currentversion = $CFG->version;
1057         $version = null;
1058         include("$CFG->dirroot/version.php");
1059         $targetversion = $version;
1061     } else if ($plugintype === 'mod') {
1062         try {
1063             $currentversion = $DB->get_field('modules', 'version', array('name'=>$pluginname));
1064             $currentversion = ($currentversion === false) ? null : $currentversion;
1065         } catch (Exception $ignored) {
1066         }
1067         $cd = get_component_directory($component);
1068         if (file_exists("$cd/version.php")) {
1069             $module = new stdClass();
1070             $module->version = null;
1071             include("$cd/version.php");
1072             $targetversion = $module->version;
1073         }
1075     } else if ($plugintype === 'block') {
1076         try {
1077             if ($block = $DB->get_record('block', array('name'=>$pluginname))) {
1078                 $currentversion = $block->version;
1079             }
1080         } catch (Exception $ignored) {
1081         }
1082         $cd = get_component_directory($component);
1083         if (file_exists("$cd/version.php")) {
1084             $plugin = new stdClass();
1085             $plugin->version = null;
1086             include("$cd/version.php");
1087             $targetversion = $plugin->version;
1088         }
1090     } else {
1091         $pluginversion = get_config($component, 'version');
1092         if (!empty($pluginversion)) {
1093             $currentversion = $pluginversion;
1094         }
1095         $cd = get_component_directory($component);
1096         if (file_exists("$cd/version.php")) {
1097             $plugin = new stdClass();
1098             $plugin->version = null;
1099             include("$cd/version.php");
1100             $targetversion = $plugin->version;
1101         }
1102     }
1104     $log = new stdClass();
1105     $log->type          = $type;
1106     $log->plugin        = $component;
1107     $log->version       = $currentversion;
1108     $log->targetversion = $targetversion;
1109     $log->info          = $info;
1110     $log->details       = $details;
1111     $log->backtrace     = $backtrace;
1112     $log->userid        = $USER->id;
1113     $log->timemodified  = time();
1114     try {
1115         $DB->insert_record('upgrade_log', $log);
1116     } catch (Exception $ignored) {
1117         // possible during install or 2.0 upgrade
1118     }
1121 /**
1122  * Marks start of upgrade, blocks any other access to site.
1123  * The upgrade is finished at the end of script or after timeout.
1124  *
1125  * @global object
1126  * @global object
1127  * @global object
1128  */
1129 function upgrade_started($preinstall=false) {
1130     global $CFG, $DB, $PAGE, $OUTPUT;
1132     static $started = false;
1134     if ($preinstall) {
1135         ignore_user_abort(true);
1136         upgrade_setup_debug(true);
1138     } else if ($started) {
1139         upgrade_set_timeout(120);
1141     } else {
1142         if (!CLI_SCRIPT and !$PAGE->headerprinted) {
1143             $strupgrade  = get_string('upgradingversion', 'admin');
1144             $PAGE->set_pagelayout('maintenance');
1145             upgrade_init_javascript();
1146             $PAGE->set_title($strupgrade.' - Moodle '.$CFG->target_release);
1147             $PAGE->set_heading($strupgrade);
1148             $PAGE->navbar->add($strupgrade);
1149             $PAGE->set_cacheable(false);
1150             echo $OUTPUT->header();
1151         }
1153         ignore_user_abort(true);
1154         register_shutdown_function('upgrade_finished_handler');
1155         upgrade_setup_debug(true);
1156         set_config('upgraderunning', time()+300);
1157         $started = true;
1158     }
1161 /**
1162  * Internal function - executed if upgrade interrupted.
1163  */
1164 function upgrade_finished_handler() {
1165     upgrade_finished();
1168 /**
1169  * Indicates upgrade is finished.
1170  *
1171  * This function may be called repeatedly.
1172  *
1173  * @global object
1174  * @global object
1175  */
1176 function upgrade_finished($continueurl=null) {
1177     global $CFG, $DB, $OUTPUT;
1179     if (!empty($CFG->upgraderunning)) {
1180         unset_config('upgraderunning');
1181         upgrade_setup_debug(false);
1182         ignore_user_abort(false);
1183         if ($continueurl) {
1184             echo $OUTPUT->continue_button($continueurl);
1185             echo $OUTPUT->footer();
1186             die;
1187         }
1188     }
1191 /**
1192  * @global object
1193  * @global object
1194  */
1195 function upgrade_setup_debug($starting) {
1196     global $CFG, $DB;
1198     static $originaldebug = null;
1200     if ($starting) {
1201         if ($originaldebug === null) {
1202             $originaldebug = $DB->get_debug();
1203         }
1204         if (!empty($CFG->upgradeshowsql)) {
1205             $DB->set_debug(true);
1206         }
1207     } else {
1208         $DB->set_debug($originaldebug);
1209     }
1212 function print_upgrade_separator() {
1213     if (!CLI_SCRIPT) {
1214         echo '<hr />';
1215     }
1218 /**
1219  * Default start upgrade callback
1220  * @param string $plugin
1221  * @param bool $installation true if installation, false means upgrade
1222  */
1223 function print_upgrade_part_start($plugin, $installation, $verbose) {
1224     global $OUTPUT;
1225     if (empty($plugin) or $plugin == 'moodle') {
1226         upgrade_started($installation); // does not store upgrade running flag yet
1227         if ($verbose) {
1228             echo $OUTPUT->heading(get_string('coresystem'));
1229         }
1230     } else {
1231         upgrade_started();
1232         if ($verbose) {
1233             echo $OUTPUT->heading($plugin);
1234         }
1235     }
1236     if ($installation) {
1237         if (empty($plugin) or $plugin == 'moodle') {
1238             // no need to log - log table not yet there ;-)
1239         } else {
1240             upgrade_log(UPGRADE_LOG_NORMAL, $plugin, 'Starting plugin installation');
1241         }
1242     } else {
1243         if (empty($plugin) or $plugin == 'moodle') {
1244             upgrade_log(UPGRADE_LOG_NORMAL, $plugin, 'Starting core upgrade');
1245         } else {
1246             upgrade_log(UPGRADE_LOG_NORMAL, $plugin, 'Starting plugin upgrade');
1247         }
1248     }
1251 /**
1252  * Default end upgrade callback
1253  * @param string $plugin
1254  * @param bool $installation true if installation, false means upgrade
1255  */
1256 function print_upgrade_part_end($plugin, $installation, $verbose) {
1257     global $OUTPUT;
1258     upgrade_started();
1259     if ($installation) {
1260         if (empty($plugin) or $plugin == 'moodle') {
1261             upgrade_log(UPGRADE_LOG_NORMAL, $plugin, 'Core installed');
1262         } else {
1263             upgrade_log(UPGRADE_LOG_NORMAL, $plugin, 'Plugin installed');
1264         }
1265     } else {
1266         if (empty($plugin) or $plugin == 'moodle') {
1267             upgrade_log(UPGRADE_LOG_NORMAL, $plugin, 'Core upgraded');
1268         } else {
1269             upgrade_log(UPGRADE_LOG_NORMAL, $plugin, 'Plugin upgraded');
1270         }
1271     }
1272     if ($verbose) {
1273         echo $OUTPUT->notification(get_string('success'), 'notifysuccess');
1274         print_upgrade_separator();
1275     }
1278 /**
1279  * Sets up JS code required for all upgrade scripts.
1280  * @global object
1281  */
1282 function upgrade_init_javascript() {
1283     global $PAGE;
1284     // scroll to the end of each upgrade page so that ppl see either error or continue button,
1285     // no need to scroll continuously any more, it is enough to jump to end once the footer is printed ;-)
1286     $js = "window.scrollTo(0, 5000000);";
1287     $PAGE->requires->js_init_code($js);
1290 /**
1291  * Try to upgrade the given language pack (or current language)
1292  *
1293  * @param string $lang the code of the language to update, defaults to the current language
1294  */
1295 function upgrade_language_pack($lang = null) {
1296     global $CFG;
1298     if (!empty($CFG->skiplangupgrade)) {
1299         return;
1300     }
1302     if (!file_exists("$CFG->dirroot/$CFG->admin/tool/langimport/lib.php")) {
1303         // weird, somebody uninstalled the import utility
1304         return;
1305     }
1307     if (!$lang) {
1308         $lang = current_language();
1309     }
1311     if (!get_string_manager()->translation_exists($lang)) {
1312         return;
1313     }
1315     get_string_manager()->reset_caches();
1317     if ($lang === 'en') {
1318         return;  // Nothing to do
1319     }
1321     upgrade_started(false);
1323     require_once("$CFG->dirroot/$CFG->admin/tool/langimport/lib.php");
1324     tool_langimport_preupgrade_update($lang);
1326     get_string_manager()->reset_caches();
1328     print_upgrade_separator();
1331 /**
1332  * Install core moodle tables and initialize
1333  * @param float $version target version
1334  * @param bool $verbose
1335  * @return void, may throw exception
1336  */
1337 function install_core($version, $verbose) {
1338     global $CFG, $DB;
1340     try {
1341         set_time_limit(600);
1342         print_upgrade_part_start('moodle', true, $verbose); // does not store upgrade running flag
1344         $DB->get_manager()->install_from_xmldb_file("$CFG->libdir/db/install.xml");
1345         upgrade_started();     // we want the flag to be stored in config table ;-)
1347         // set all core default records and default settings
1348         require_once("$CFG->libdir/db/install.php");
1349         xmldb_main_install(); // installs the capabilities too
1351         // store version
1352         upgrade_main_savepoint(true, $version, false);
1354         // Continue with the installation
1355         log_update_descriptions('moodle');
1356         external_update_descriptions('moodle');
1357         events_update_definition('moodle');
1358         message_update_providers('moodle');
1360         // Write default settings unconditionally
1361         admin_apply_default_settings(NULL, true);
1363         print_upgrade_part_end(null, true, $verbose);
1364     } catch (exception $ex) {
1365         upgrade_handle_exception($ex);
1366     }
1369 /**
1370  * Upgrade moodle core
1371  * @param float $version target version
1372  * @param bool $verbose
1373  * @return void, may throw exception
1374  */
1375 function upgrade_core($version, $verbose) {
1376     global $CFG;
1378     raise_memory_limit(MEMORY_EXTRA);
1380     require_once($CFG->libdir.'/db/upgrade.php');    // Defines upgrades
1382     try {
1383         // Reset caches before any output
1384         purge_all_caches();
1386         // Upgrade current language pack if we can
1387         upgrade_language_pack();
1389         print_upgrade_part_start('moodle', false, $verbose);
1391         // one time special local migration pre 2.0 upgrade script
1392         if ($CFG->version < 2007101600) {
1393             $pre20upgradefile = "$CFG->dirroot/local/upgrade_pre20.php";
1394             if (file_exists($pre20upgradefile)) {
1395                 set_time_limit(0);
1396                 require($pre20upgradefile);
1397                 // reset upgrade timeout to default
1398                 upgrade_set_timeout();
1399             }
1400         }
1402         $result = xmldb_main_upgrade($CFG->version);
1403         if ($version > $CFG->version) {
1404             // store version if not already there
1405             upgrade_main_savepoint($result, $version, false);
1406         }
1408         // perform all other component upgrade routines
1409         update_capabilities('moodle');
1410         log_update_descriptions('moodle');
1411         external_update_descriptions('moodle');
1412         events_update_definition('moodle');
1413         message_update_providers('moodle');
1415         // Reset caches again, just to be sure
1416         purge_all_caches();
1418         // Clean up contexts - more and more stuff depends on existence of paths and contexts
1419         context_helper::cleanup_instances();
1420         context_helper::create_instances(null, false);
1421         context_helper::build_all_paths(false);
1422         $syscontext = context_system::instance();
1423         $syscontext->mark_dirty();
1425         print_upgrade_part_end('moodle', false, $verbose);
1426     } catch (Exception $ex) {
1427         upgrade_handle_exception($ex);
1428     }
1431 /**
1432  * Upgrade/install other parts of moodle
1433  * @param bool $verbose
1434  * @return void, may throw exception
1435  */
1436 function upgrade_noncore($verbose) {
1437     global $CFG;
1439     raise_memory_limit(MEMORY_EXTRA);
1441     // upgrade all plugins types
1442     try {
1443         $plugintypes = get_plugin_types();
1444         foreach ($plugintypes as $type=>$location) {
1445             upgrade_plugins($type, 'print_upgrade_part_start', 'print_upgrade_part_end', $verbose);
1446         }
1447     } catch (Exception $ex) {
1448         upgrade_handle_exception($ex);
1449     }
1452 /**
1453  * Checks if the main tables have been installed yet or not.
1454  * @return bool
1455  */
1456 function core_tables_exist() {
1457     global $DB;
1459     if (!$tables = $DB->get_tables() ) {    // No tables yet at all.
1460         return false;
1462     } else {                                 // Check for missing main tables
1463         $mtables = array('config', 'course', 'groupings'); // some tables used in 1.9 and 2.0, preferable something from the start and end of install.xml
1464         foreach ($mtables as $mtable) {
1465             if (!in_array($mtable, $tables)) {
1466                 return false;
1467             }
1468         }
1469         return true;
1470     }
1473 /**
1474  * upgrades the mnet rpc definitions for the given component.
1475  * this method doesn't return status, an exception will be thrown in the case of an error
1476  *
1477  * @param string $component the plugin to upgrade, eg auth_mnet
1478  */
1479 function upgrade_plugin_mnet_functions($component) {
1480     global $DB, $CFG;
1482     list($type, $plugin) = explode('_', $component);
1483     $path = get_plugin_directory($type, $plugin);
1485     $publishes = array();
1486     $subscribes = array();
1487     if (file_exists($path . '/db/mnet.php')) {
1488         require_once($path . '/db/mnet.php'); // $publishes comes from this file
1489     }
1490     if (empty($publishes)) {
1491         $publishes = array(); // still need this to be able to disable stuff later
1492     }
1493     if (empty($subscribes)) {
1494         $subscribes = array(); // still need this to be able to disable stuff later
1495     }
1497     static $servicecache = array();
1499     // rekey an array based on the rpc method for easy lookups later
1500     $publishmethodservices = array();
1501     $subscribemethodservices = array();
1502     foreach($publishes as $servicename => $service) {
1503         if (is_array($service['methods'])) {
1504             foreach($service['methods'] as $methodname) {
1505                 $service['servicename'] = $servicename;
1506                 $publishmethodservices[$methodname][] = $service;
1507             }
1508         }
1509     }
1511     // Disable functions that don't exist (any more) in the source
1512     // Should these be deleted? What about their permissions records?
1513     foreach ($DB->get_records('mnet_rpc', array('pluginname'=>$plugin, 'plugintype'=>$type), 'functionname ASC ') as $rpc) {
1514         if (!array_key_exists($rpc->functionname, $publishmethodservices) && $rpc->enabled) {
1515             $DB->set_field('mnet_rpc', 'enabled', 0, array('id' => $rpc->id));
1516         } else if (array_key_exists($rpc->functionname, $publishmethodservices) && !$rpc->enabled) {
1517             $DB->set_field('mnet_rpc', 'enabled', 1, array('id' => $rpc->id));
1518         }
1519     }
1521     // reflect all the services we're publishing and save them
1522     require_once($CFG->dirroot . '/lib/zend/Zend/Server/Reflection.php');
1523     static $cachedclasses = array(); // to store reflection information in
1524     foreach ($publishes as $service => $data) {
1525         $f = $data['filename'];
1526         $c = $data['classname'];
1527         foreach ($data['methods'] as $method) {
1528             $dataobject = new stdClass();
1529             $dataobject->plugintype  = $type;
1530             $dataobject->pluginname  = $plugin;
1531             $dataobject->enabled     = 1;
1532             $dataobject->classname   = $c;
1533             $dataobject->filename    = $f;
1535             if (is_string($method)) {
1536                 $dataobject->functionname = $method;
1538             } else if (is_array($method)) { // wants to override file or class
1539                 $dataobject->functionname = $method['method'];
1540                 $dataobject->classname     = $method['classname'];
1541                 $dataobject->filename      = $method['filename'];
1542             }
1543             $dataobject->xmlrpcpath = $type.'/'.$plugin.'/'.$dataobject->filename.'/'.$method;
1544             $dataobject->static = false;
1546             require_once($path . '/' . $dataobject->filename);
1547             $functionreflect = null; // slightly different ways to get this depending on whether it's a class method or a function
1548             if (!empty($dataobject->classname)) {
1549                 if (!class_exists($dataobject->classname)) {
1550                     throw new moodle_exception('installnosuchmethod', 'mnet', '', (object)array('method' => $dataobject->functionname, 'class' => $dataobject->classname));
1551                 }
1552                 $key = $dataobject->filename . '|' . $dataobject->classname;
1553                 if (!array_key_exists($key, $cachedclasses)) { // look to see if we've already got a reflection object
1554                     try {
1555                         $cachedclasses[$key] = Zend_Server_Reflection::reflectClass($dataobject->classname);
1556                     } catch (Zend_Server_Reflection_Exception $e) { // catch these and rethrow them to something more helpful
1557                         throw new moodle_exception('installreflectionclasserror', 'mnet', '', (object)array('method' => $dataobject->functionname, 'class' => $dataobject->classname, 'error' => $e->getMessage()));
1558                     }
1559                 }
1560                 $r =& $cachedclasses[$key];
1561                 if (!$r->hasMethod($dataobject->functionname)) {
1562                     throw new moodle_exception('installnosuchmethod', 'mnet', '', (object)array('method' => $dataobject->functionname, 'class' => $dataobject->classname));
1563                 }
1564                 // stupid workaround for zend not having a getMethod($name) function
1565                 $ms = $r->getMethods();
1566                 foreach ($ms as $m) {
1567                     if ($m->getName() == $dataobject->functionname) {
1568                         $functionreflect = $m;
1569                         break;
1570                     }
1571                 }
1572                 $dataobject->static = (int)$functionreflect->isStatic();
1573             } else {
1574                 if (!function_exists($dataobject->functionname)) {
1575                     throw new moodle_exception('installnosuchfunction', 'mnet', '', (object)array('method' => $dataobject->functionname, 'file' => $dataobject->filename));
1576                 }
1577                 try {
1578                     $functionreflect = Zend_Server_Reflection::reflectFunction($dataobject->functionname);
1579                 } catch (Zend_Server_Reflection_Exception $e) { // catch these and rethrow them to something more helpful
1580                     throw new moodle_exception('installreflectionfunctionerror', 'mnet', '', (object)array('method' => $dataobject->functionname, '' => $dataobject->filename, 'error' => $e->getMessage()));
1581                 }
1582             }
1583             $dataobject->profile =  serialize(admin_mnet_method_profile($functionreflect));
1584             $dataobject->help = $functionreflect->getDescription();
1586             if ($record_exists = $DB->get_record('mnet_rpc', array('xmlrpcpath'=>$dataobject->xmlrpcpath))) {
1587                 $dataobject->id      = $record_exists->id;
1588                 $dataobject->enabled = $record_exists->enabled;
1589                 $DB->update_record('mnet_rpc', $dataobject);
1590             } else {
1591                 $dataobject->id = $DB->insert_record('mnet_rpc', $dataobject, true);
1592             }
1594             // TODO this API versioning must be reworked, here the recently processed method
1595             // sets the service API which may not be correct
1596             foreach ($publishmethodservices[$dataobject->functionname] as $service) {
1597                 if ($serviceobj = $DB->get_record('mnet_service', array('name'=>$service['servicename']))) {
1598                     $serviceobj->apiversion = $service['apiversion'];
1599                     $DB->update_record('mnet_service', $serviceobj);
1600                 } else {
1601                     $serviceobj = new stdClass();
1602                     $serviceobj->name        = $service['servicename'];
1603                     $serviceobj->description = empty($service['description']) ? '' : $service['description'];
1604                     $serviceobj->apiversion  = $service['apiversion'];
1605                     $serviceobj->offer       = 1;
1606                     $serviceobj->id          = $DB->insert_record('mnet_service', $serviceobj);
1607                 }
1608                 $servicecache[$service['servicename']] = $serviceobj;
1609                 if (!$DB->record_exists('mnet_service2rpc', array('rpcid'=>$dataobject->id, 'serviceid'=>$serviceobj->id))) {
1610                     $obj = new stdClass();
1611                     $obj->rpcid = $dataobject->id;
1612                     $obj->serviceid = $serviceobj->id;
1613                     $DB->insert_record('mnet_service2rpc', $obj, true);
1614                 }
1615             }
1616         }
1617     }
1618     // finished with methods we publish, now do subscribable methods
1619     foreach($subscribes as $service => $methods) {
1620         if (!array_key_exists($service, $servicecache)) {
1621             if (!$serviceobj = $DB->get_record('mnet_service', array('name' =>  $service))) {
1622                 debugging("TODO: skipping unknown service $service - somebody needs to fix MDL-21993");
1623                 continue;
1624             }
1625             $servicecache[$service] = $serviceobj;
1626         } else {
1627             $serviceobj = $servicecache[$service];
1628         }
1629         foreach ($methods as $method => $xmlrpcpath) {
1630             if (!$rpcid = $DB->get_field('mnet_remote_rpc', 'id', array('xmlrpcpath'=>$xmlrpcpath))) {
1631                 $remoterpc = (object)array(
1632                     'functionname' => $method,
1633                     'xmlrpcpath' => $xmlrpcpath,
1634                     'plugintype' => $type,
1635                     'pluginname' => $plugin,
1636                     'enabled'    => 1,
1637                 );
1638                 $rpcid = $remoterpc->id = $DB->insert_record('mnet_remote_rpc', $remoterpc, true);
1639             }
1640             if (!$DB->record_exists('mnet_remote_service2rpc', array('rpcid'=>$rpcid, 'serviceid'=>$serviceobj->id))) {
1641                 $obj = new stdClass();
1642                 $obj->rpcid = $rpcid;
1643                 $obj->serviceid = $serviceobj->id;
1644                 $DB->insert_record('mnet_remote_service2rpc', $obj, true);
1645             }
1646             $subscribemethodservices[$method][] = $service;
1647         }
1648     }
1650     foreach ($DB->get_records('mnet_remote_rpc', array('pluginname'=>$plugin, 'plugintype'=>$type), 'functionname ASC ') as $rpc) {
1651         if (!array_key_exists($rpc->functionname, $subscribemethodservices) && $rpc->enabled) {
1652             $DB->set_field('mnet_remote_rpc', 'enabled', 0, array('id' => $rpc->id));
1653         } else if (array_key_exists($rpc->functionname, $subscribemethodservices) && !$rpc->enabled) {
1654             $DB->set_field('mnet_remote_rpc', 'enabled', 1, array('id' => $rpc->id));
1655         }
1656     }
1658     return true;
1661 /**
1662  * Given some sort of Zend Reflection function/method object, return a profile array, ready to be serialized and stored
1663  *
1664  * @param Zend_Server_Reflection_Function_Abstract $function can be any subclass of this object type
1665  *
1666  * @return array
1667  */
1668 function admin_mnet_method_profile(Zend_Server_Reflection_Function_Abstract $function) {
1669     $proto = array_pop($function->getPrototypes());
1670     $ret = $proto->getReturnValue();
1671     $profile = array(
1672         'parameters' =>  array(),
1673         'return'     =>  array(
1674             'type'        => $ret->getType(),
1675             'description' => $ret->getDescription(),
1676         ),
1677     );
1678     foreach ($proto->getParameters() as $p) {
1679         $profile['parameters'][] = array(
1680             'name' => $p->getName(),
1681             'type' => $p->getType(),
1682             'description' => $p->getDescription(),
1683         );
1684     }
1685     return $profile;