80d6088334de2abf9fdd7d18f922cb3a9a29f0b6
[moodle.git] / lib / pluginlib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Defines classes used for plugins management
19  *
20  * This library provides a unified interface to various plugin types in
21  * Moodle. It is mainly used by the plugins management admin page and the
22  * plugins check page during the upgrade.
23  *
24  * @package    core
25  * @subpackage admin
26  * @copyright  2011 David Mudrak <david@moodle.com>
27  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
28  */
30 defined('MOODLE_INTERNAL') || die();
32 /**
33  * Singleton class providing general plugins management functionality
34  */
35 class plugin_manager {
37     /** the plugin is shipped with standard Moodle distribution */
38     const PLUGIN_SOURCE_STANDARD    = 'std';
39     /** the plugin is added extension */
40     const PLUGIN_SOURCE_EXTENSION   = 'ext';
42     /** the plugin uses neither database nor capabilities, no versions */
43     const PLUGIN_STATUS_NODB        = 'nodb';
44     /** the plugin is up-to-date */
45     const PLUGIN_STATUS_UPTODATE    = 'uptodate';
46     /** the plugin is about to be installed */
47     const PLUGIN_STATUS_NEW         = 'new';
48     /** the plugin is about to be upgraded */
49     const PLUGIN_STATUS_UPGRADE     = 'upgrade';
50     /** the version at the disk is lower than the one already installed */
51     const PLUGIN_STATUS_DOWNGRADE   = 'downgrade';
52     /** the plugin is installed but missing from disk */
53     const PLUGIN_STATUS_MISSING     = 'missing';
55     /** @var plugin_manager holds the singleton instance */
56     protected static $singletoninstance;
57     /** @var array of raw plugins information */
58     protected $pluginsinfo = null;
59     /** @var array of raw subplugins information */
60     protected $subpluginsinfo = null;
62     /**
63      * Direct initiation not allowed, use the factory method {@link self::instance()}
64      *
65      * @todo we might want to specify just a single plugin type to work with
66      */
67     protected function __construct() {
68         $this->get_plugins(true);
69     }
71     /**
72      * Sorry, this is singleton
73      */
74     protected function __clone() {
75     }
77     /**
78      * Factory method for this class
79      *
80      * @return plugin_manager the singleton instance
81      */
82     public static function instance() {
83         global $CFG;
85         if (is_null(self::$singletoninstance)) {
86             self::$singletoninstance = new self();
87         }
88         return self::$singletoninstance;
89     }
91     /**
92      * Returns a tree of known plugins and information about them
93      *
94      * @param bool $disablecache force reload, cache can be used otherwise
95      * @return array
96      */
97     public function get_plugins($disablecache=false) {
99         if ($disablecache or is_null($this->pluginsinfo)) {
100             $this->pluginsinfo = array();
101             $plugintypes = get_plugin_types();
102             foreach ($plugintypes as $plugintype => $plugintyperootdir) {
103                 if (in_array($plugintype, array('base', 'general'))) {
104                     throw new coding_exception('Illegal usage of reserved word for plugin type');
105                 }
106                 if (class_exists('plugintype_' . $plugintype)) {
107                     $plugintypeclass = 'plugintype_' . $plugintype;
108                 } else {
109                     $plugintypeclass = 'plugintype_general';
110                 }
111                 if (!in_array('plugintype_interface', class_implements($plugintypeclass))) {
112                     throw new coding_exception('Class ' . $plugintypeclass . ' must implement plugintype_interface');
113                 }
114                 $plugins = call_user_func(array($plugintypeclass, 'get_plugins'), $plugintype, $plugintyperootdir, $plugintypeclass);
115                 $this->pluginsinfo[$plugintype] = $plugins;
116             }
117         }
119         return $this->pluginsinfo;
120     }
122     /**
123      * Returns list of plugins that define their subplugins and information about them
124      *
125      * At the moment, only activity modules can define subplugins.
126      *
127      * @param double $disablecache force reload, cache can be used otherwise
128      * @return array
129      */
130     public function get_subplugins($disablecache=false) {
132         if ($disablecache or is_null($this->subpluginsinfo)) {
133             $this->subpluginsinfo = array();
134             $mods = get_plugin_list('mod');
135             foreach ($mods as $mod => $moddir) {
136                 $modsubplugins = array();
137                 if (file_exists($moddir . '/db/subplugins.php')) {
138                     include($moddir . '/db/subplugins.php');
139                     foreach ($subplugins as $subplugintype => $subplugintyperootdir) {
140                         $subplugin = new stdClass();
141                         $subplugin->type = $subplugintype;
142                         $subplugin->typerootdir = $subplugintyperootdir;
143                         $modsubplugins[$subplugintype] = $subplugin;
144                     }
145                 $this->subpluginsinfo['mod_' . $mod] = $modsubplugins;
146                 }
147             }
148         }
150         return $this->subpluginsinfo;
151     }
153     /**
154      * Returns the name of the plugin that defines the given subplugin type
155      *
156      * If the given subplugin type is not actually a subplugin, returns false.
157      *
158      * @param string $subplugintype the name of subplugin type, eg. workshopform or quiz
159      * @return false|string the name of the parent plugin, eg. mod_workshop
160      */
161     public function get_parent_of_subplugin($subplugintype) {
163         $parent = false;
164         foreach ($this->get_subplugins() as $pluginname => $subplugintypes) {
165             if (isset($subplugintypes[$subplugintype])) {
166                 $parent = $pluginname;
167                 break;
168             }
169         }
171         return $parent;
172     }
174     /**
175      * Returns a localized name of a given plugin
176      *
177      * @param string $plugin name of the plugin, eg mod_workshop or auth_ldap
178      * @return string
179      */
180     public function plugin_name($plugin) {
181         list($type, $name) = normalize_component($plugin);
182         return $this->pluginsinfo[$type][$name]->displayname;
183     }
185     /**
186      * Returns a localized name of a plugin type in plural form
187      *
188      * Most plugin types define their names in core_plugin lang file. In case of subplugins,
189      * we try to ask the parent plugin for the name. In the worst case, we will return
190      * the value of the passed $type parameter.
191      *
192      * @param string $type the type of the plugin, e.g. mod or workshopform
193      * @return string
194      */
195     public function plugintype_name_plural($type) {
197         if (get_string_manager()->string_exists('type_' . $type . '_plural', 'core_plugin')) {
198             // for most plugin types, their names are defined in core_plugin lang file
199             return get_string('type_' . $type . '_plural', 'core_plugin');
201         } else if ($parent = $this->get_parent_of_subplugin($type)) {
202             // if this is a subplugin, try to ask the parent plugin for the name
203             if (get_string_manager()->string_exists('subplugintype_' . $type . '_plural', $parent)) {
204                 return $this->plugin_name($parent) . ' / ' . get_string('subplugintype_' . $type . '_plural', $parent);
205             } else {
206                 return $this->plugin_name($parent) . ' / ' . $type;
207             }
209         } else {
210             return $type;
211         }
212     }
214     /**
215      * Defines a white list of all plugins shipped in the standard Moodle distribution
216      *
217      * @return false|array array of standard plugins or false if the type is unknown
218      */
219     public static function standard_plugins_list($type) {
220         static $standard_plugins = array(
222             'assignment' => array(
223                 'offline', 'online', 'upload', 'uploadsingle'
224             ),
226             'auth' => array(
227                 'cas', 'db', 'email', 'fc', 'imap', 'ldap', 'manual', 'mnet',
228                 'nntp', 'nologin', 'none', 'pam', 'pop3', 'radius',
229                 'shibboleth', 'webservice'
230             ),
232             'block' => array(
233                 'activity_modules', 'admin_bookmarks', 'blog_menu',
234                 'blog_recent', 'blog_tags', 'calendar_month',
235                 'calendar_upcoming', 'comments', 'community',
236                 'completionstatus', 'course_list', 'course_overview',
237                 'course_summary', 'feedback', 'glossary_random', 'html',
238                 'login', 'mentees', 'messages', 'mnet_hosts', 'myprofile',
239                 'navigation', 'news_items', 'online_users', 'participants',
240                 'private_files', 'quiz_results', 'recent_activity',
241                 'rss_client', 'search', 'search_forums', 'section_links',
242                 'selfcompletion', 'settings', 'site_main_menu',
243                 'social_activities', 'tag_flickr', 'tag_youtube', 'tags'
244             ),
246             'coursereport' => array(
247                 'completion', 'log', 'outline', 'participation', 'progress', 'stats'
248             ),
250             'datafield' => array(
251                 'checkbox', 'date', 'file', 'latlong', 'menu', 'multimenu',
252                 'number', 'picture', 'radiobutton', 'text', 'textarea', 'url'
253             ),
255             'datapreset' => array(
256                 'imagegallery'
257             ),
259             'editor' => array(
260                 'textarea', 'tinymce'
261             ),
263             'enrol' => array(
264                 'authorize', 'category', 'cohort', 'database', 'flatfile',
265                 'guest', 'imsenterprise', 'ldap', 'manual', 'meta', 'mnet',
266                 'paypal', 'self'
267             ),
269             'filter' => array(
270                 'activitynames', 'algebra', 'censor', 'emailprotect',
271                 'emoticon', 'mediaplugin', 'multilang', 'tex', 'tidy',
272                 'urltolink', 'mod_data', 'mod_glossary'
273             ),
275             'format' => array(
276                 'scorm', 'social', 'topics', 'weeks'
277             ),
279             'gradeexport' => array(
280                 'ods', 'txt', 'xls', 'xml'
281             ),
283             'gradeimport' => array(
284                 'csv', 'xml'
285             ),
287             'gradereport' => array(
288                 'grader', 'outcomes', 'overview', 'user'
289             ),
291             'local' => array(
292                 'qeupgradehelper'
293             ),
295             'message' => array(
296                 'email', 'jabber', 'popup'
297             ),
299             'mnetservice' => array(
300                 'enrol'
301             ),
303             'mod' => array(
304                 'assignment', 'chat', 'choice', 'data', 'feedback', 'folder',
305                 'forum', 'glossary', 'imscp', 'label', 'lesson', 'page',
306                 'quiz', 'resource', 'scorm', 'survey', 'url', 'wiki', 'workshop'
307             ),
309             'plagiarism' => array(
310             ),
312             'portfolio' => array(
313                 'boxnet', 'download', 'flickr', 'googledocs', 'mahara', 'picasa'
314             ),
316             'profilefield' => array(
317                 'checkbox', 'datetime', 'menu', 'text', 'textarea'
318             ),
320             'qbehaviour' => array(
321                 'adaptive', 'adaptivenopenalty', 'deferredcbm',
322                 'deferredfeedback', 'immediatecbm', 'immediatefeedback',
323                 'informationitem', 'interactive', 'interactivecountback',
324                 'manualgraded', 'missing'
325             ),
327             'qformat' => array(
328                 'aiken', 'blackboard', 'blackboard_six', 'examview', 'gift',
329                 'learnwise', 'missingword', 'multianswer', 'qti_two', 'webct',
330                 'xhtml', 'xml'
331             ),
333             'qtype' => array(
334                 'calculated', 'calculatedmulti', 'calculatedsimple',
335                 'description', 'essay', 'match', 'missingtype', 'multianswer',
336                 'multichoice', 'numerical', 'random', 'randomsamatch',
337                 'shortanswer', 'truefalse'
338             ),
340             'quiz' => array(
341                 'grading', 'overview', 'responses', 'statistics'
342             ),
344             'report' => array(
345                 'backups', 'capability', 'configlog', 'courseoverview',
346                 'customlang', 'log', 'profiling', 'questioninstances',
347                 'security', 'spamcleaner', 'stats', 'unittest', 'unsuproles'
348             ),
350             'repository' => array(
351                 'alfresco', 'boxnet', 'coursefiles', 'dropbox', 'filesystem',
352                 'flickr', 'flickr_public', 'googledocs', 'local', 'merlot',
353                 'picasa', 'recent', 's3', 'upload', 'url', 'user', 'webdav',
354                 'wikimedia', 'youtube'
355             ),
357             'scormreport' => array(
358                 'basic'
359             ),
361             'theme' => array(
362                 'afterburner', 'anomaly', 'arialist', 'base', 'binarius',
363                 'boxxie', 'brick', 'canvas', 'formal_white', 'formfactor',
364                 'fusion', 'leatherbound', 'magazine', 'nimble', 'nonzero',
365                 'overlay', 'serenity', 'sky_high', 'splash', 'standard',
366                 'standardold'
367             ),
369             'webservice' => array(
370                 'amf', 'rest', 'soap', 'xmlrpc'
371             ),
373             'workshopallocation' => array(
374                 'manual', 'random'
375             ),
377             'workshopeval' => array(
378                 'best'
379             ),
381             'workshopform' => array(
382                 'accumulative', 'comments', 'numerrors', 'rubric'
383             )
384         );
386         if (isset($standard_plugins[$type])) {
387             return $standard_plugins[$type];
389         } else {
390             return false;
391         }
392     }
395 /**
396  * All classes that represent a plugin of some type must implement this interface
397  */
398 interface plugintype_interface {
400     /**
401      * Gathers and returns the information about all plugins of the given type
402      *
403      * Passing the parameter $typeclass allows us to reach the same effect as with the
404      * late binding in PHP 5.3. Once PHP 5.3 is required, we can refactor this to use
405      * {@example $plugin = new static();} instead of {@example $plugin = new $typeclass()}
406      *
407      * @param string $type the name of the plugintype, eg. mod, auth or workshopform
408      * @param string $typerootdir full path to the location of the plugin dir
409      * @param string $typeclass the name of the actually called class
410      * @return array of plugintype classes, indexed by the plugin name
411      */
412     public static function get_plugins($type, $typerootdir, $typeclass);
414     /**
415      * Sets $displayname property to a localized name of the plugin
416      *
417      * @return void
418      */
419     public function set_display_name();
421     /**
422      * Sets $versiondisk property to a numerical value representing the
423      * version of the plugin's source code.
424      *
425      * If the value is null after calling this method, either the plugin
426      * does not use versioning (typically does not have any database
427      * data) or is missing from disk.
428      *
429      * @return void
430      */
431     public function set_version_disk();
433     /**
434      * Sets $versiondb property to a numerical value representing the
435      * currently installed version of the plugin.
436      *
437      * If the value is null after calling this method, either the plugin
438      * does not use versioning (typically does not have any database
439      * data) or has not been installed yet.
440      *
441      * @return void
442      */
443     public function set_version_db();
445     /**
446      * Sets $versionrequires property to a numerical value representing
447      * the version of Moodle core that this plugin requires.
448      *
449      * @return void
450      */
451     public function set_version_requires();
453     /**
454      * Sets $source property to one of plugin_manager::PLUGIN_SOURCE_xxx
455      * constants.
456      *
457      * If the property's value is null after calling this method, then
458      * the type of the plugin has not been recognized and you should throw
459      * an exception.
460      *
461      * @return void
462      */
463     public function set_source();
465     /**
466      * Returns true if the plugin is shipped with the official distribution
467      * of the current Moodle version, false otherwise.
468      *
469      * @return bool
470      */
471     public function is_standard();
473     /**
474      * Returns the status of the plugin
475      *
476      * @return string one of plugin_manager::PLUGIN_STATUS_xxx constants
477      */
478     public function get_status();
480     /**
481      * Returns the information about plugin availability
482      *
483      * True means that the plugin is enabled. False means that the plugin is
484      * disabled. Null means that the information is not available, or the
485      * plugin does not support configurable availability or the availability
486      * can not be changed.
487      *
488      * @return null|bool
489      */
490     public function is_enabled();
492     /**
493      * Returns the URL of the plugin settings screen
494      *
495      * Null value means that the plugin either does not have the settings screen
496      * or its location is not available via this library.
497      *
498      * @return null|moodle_url
499      */
500     public function get_settings_url();
502     /**
503      * Returns the URL of the screen where this plugin can be uninstalled
504      *
505      * Visiting that URL must be safe, that is a manual confirmation is needed
506      * for actual uninstallation of the plugin. Null value means that the
507      * plugin either does not support uninstallation, or does not require any
508      * database cleanup or the location of the screen is not available via this
509      * library.
510      *
511      * @return null|moodle_url
512      */
513     public function get_uninstall_url();
515     /**
516      * Returns relative directory of the plugin with heading '/'
517      *
518      * @example /mod/workshop
519      * @return string
520      */
521     public function get_dir();
524 /**
525  * Defines public properties that all plugintype classes must have
526  * and provides default implementation of required methods.
527  */
528 abstract class plugintype_base {
530     /** @var string the plugintype name, eg. mod, auth or workshopform */
531     public $type;
532     /** @var string full path to the location of all the plugins of this type */
533     public $typerootdir;
534     /** @var string the plugin name, eg. assignment, ldap */
535     public $name;
536     /** @var string the localized plugin name */
537     public $displayname;
538     /** @var string the plugin source, one of plugin_manager::PLUGIN_SOURCE_xxx constants */
539     public $source;
540     /** @var fullpath to the location of this plugin */
541     public $rootdir;
542     /** @var int|string the version of the plugin's source code */
543     public $versiondisk;
544     /** @var int|string the version of the installed plugin */
545     public $versiondb;
546     /** @var int|float|string required version of Moodle core  */
547     public $versionrequires;
548     /** @var int number of instances of the plugin - not supported yet */
549     public $instances;
550     /** @var int order of the plugin among other plugins of the same type - not supported yet */
551     public $sortorder;
553     /**
554      * @see plugintype_interface::get_plugins()
555      */
556     public static function get_plugins($type, $typerootdir, $typeclass) {
558         // get the information about plugins at the disk
559         $plugins = get_plugin_list($type);
560         $ondisk = array();
561         foreach ($plugins as $pluginname => $pluginrootdir) {
562             $plugin                 = new $typeclass();
563             $plugin->type           = $type;
564             $plugin->typerootdir    = $typerootdir;
565             $plugin->name           = $pluginname;
566             $plugin->rootdir        = $pluginrootdir;
568             $plugin->set_display_name();
569             $plugin->set_version_disk();
570             $plugin->set_version_db();
571             $plugin->set_version_requires();
572             $plugin->set_source();
574             $ondisk[$pluginname] = $plugin;
575         }
576         return $ondisk;
577     }
579     /**
580      * @see plugintype_interface::set_display_name()
581      */
582     public function set_display_name() {
583         if (! get_string_manager()->string_exists('pluginname', $this->type . '_' . $this->name)) {
584             $this->displayname = '[pluginname,' . $this->type . '_' . $this->name . ']';
585         } else {
586             $this->displayname = get_string('pluginname', $this->type . '_' . $this->name);
587         }
588     }
590     /**
591      * @see plugintype_interface::set_version_disk()
592      */
593     public function set_version_disk() {
595         if (empty($this->rootdir)) {
596             return;
597         }
599         $versionfile = $this->rootdir . '/version.php';
601         if (is_readable($versionfile)) {
602             include($versionfile);
603             if (isset($plugin->version)) {
604                 $this->versiondisk = $plugin->version;
605             }
606         }
607     }
609     /**
610      * @see plugintype_interface::set_version_db()
611      */
612     public function set_version_db() {
614         if ($ver = self::get_version_from_config_plugins($this->type . '_' . $this->name)) {
615             $this->versiondb = $ver;
616         }
617     }
619     /**
620      * @see plugintype_interface::set_version_requires()
621      */
622     public function set_version_requires() {
624         if (empty($this->rootdir)) {
625             return;
626         }
628         $versionfile = $this->rootdir . '/version.php';
630         if (is_readable($versionfile)) {
631             include($versionfile);
632             if (isset($plugin->requires)) {
633                 $this->versionrequires = $plugin->requires;
634             }
635         }
636     }
638     /**
639      * @see plugintype_interface::set_source()
640      */
641     public function set_source() {
643         $standard = plugin_manager::standard_plugins_list($this->type);
645         if ($standard !== false) {
646             $standard = array_flip($standard);
647             if (isset($standard[$this->name])) {
648                 $this->source = plugin_manager::PLUGIN_SOURCE_STANDARD;
649             } else {
650                 $this->source = plugin_manager::PLUGIN_SOURCE_EXTENSION;
651             }
652         }
653     }
655     /**
656      * @see plugintype_interface::is_standard()
657      */
658     public function is_standard() {
659         return $this->source === plugin_manager::PLUGIN_SOURCE_STANDARD;
660     }
662     /**
663      * @see plugintype_interface::get_status()
664      */
665     public function get_status() {
667         if (is_null($this->versiondb) and is_null($this->versiondisk)) {
668             return plugin_manager::PLUGIN_STATUS_NODB;
670         } else if (is_null($this->versiondb) and !is_null($this->versiondisk)) {
671             return plugin_manager::PLUGIN_STATUS_NEW;
673         } else if (!is_null($this->versiondb) and is_null($this->versiondisk)) {
674             return plugin_manager::PLUGIN_STATUS_MISSING;
676         } else if ((string)$this->versiondb === (string)$this->versiondisk) {
677             return plugin_manager::PLUGIN_STATUS_UPTODATE;
679         } else if ($this->versiondb < $this->versiondisk) {
680             return plugin_manager::PLUGIN_STATUS_UPGRADE;
682         } else if ($this->versiondb > $this->versiondisk) {
683             return plugin_manager::PLUGIN_STATUS_DOWNGRADE;
685         } else {
686             // $version = pi(); and similar funny jokes - hopefully Donald E. Knuth will never contribute to Moodle ;-)
687             throw new coding_exception('Unable to determine plugin state, check the plugin versions');
688         }
689     }
691     /**
692      * @see plugintype_interface::is_enabled()
693      */
694     public function is_enabled() {
695         return null;
696     }
698     /**
699      * @see plugintype_interface::get_settings_url()
700      */
701     public function get_settings_url() {
702         return null;
703     }
705     /**
706      * @see plugintype_interface::get_uninstall_url()
707      */
708     public function get_uninstall_url() {
709         return null;
710     }
712     /**
713      * @see plugintype_interface::get_dir()
714      */
715     public function get_dir() {
716         global $CFG;
718         return substr($this->rootdir, strlen($CFG->dirroot));
719     }
721     /**
722      * Provides access to plugin versions from {config_plugins}
723      *
724      * @param string $plugin plugin name
725      * @param double $disablecache optional, defaults to false
726      * @return int|false the stored value or false if not found
727      */
728     protected function get_version_from_config_plugins($plugin, $disablecache=false) {
729         global $DB;
730         static $pluginversions = null;
732         if (is_null($pluginversions) or $disablecache) {
733             $pluginversions = $DB->get_records_menu('config_plugins', array('name' => 'version'), 'plugin', 'plugin,value');
734         }
736         if (!array_key_exists($plugin, $pluginversions)) {
737             return false;
738         }
740         return $pluginversions[$plugin];
741     }
744 /**
745  * General class for all plugin types that do not have their own class
746  */
747 class plugintype_general extends plugintype_base implements plugintype_interface {
751 /**
752  * Class for page side blocks
753  */
754 class plugintype_block extends plugintype_base implements plugintype_interface {
756     /**
757      * @see plugintype_interface::get_plugins()
758      */
759     public static function get_plugins($type, $typerootdir, $typeclass) {
761         // get the information about blocks at the disk
762         $blocks = parent::get_plugins($type, $typerootdir, $typeclass);
764         // add blocks missing from disk
765         $blocksinfo = self::get_blocks_info();
766         foreach ($blocksinfo as $blockname => $blockinfo) {
767             if (isset($blocks[$blockname])) {
768                 continue;
769             }
770             $plugin                 = new $typeclass();
771             $plugin->type           = $type;
772             $plugin->typerootdir    = $typerootdir;
773             $plugin->name           = $blockname;
774             $plugin->rootdir        = null;
775             $plugin->displayname    = $blockname;
776             $plugin->versiondb      = $blockinfo->version;
777             $plugin->set_source();
779             $blocks[$blockname]   = $plugin;
780         }
782         return $blocks;
783     }
785     /**
786      * @see plugintype_interface::set_display_name()
787      */
788     public function set_display_name() {
790         if (get_string_manager()->string_exists('pluginname', 'block_' . $this->name)) {
791             $this->displayname = get_string('pluginname', 'block_' . $this->name);
793         } else if (($block = block_instance($this->name)) !== false) {
794             $this->displayname = $block->get_title();
796         } else {
797             parent::set_display_name();
798         }
799     }
801     /**
802      * @see plugintype_interface::set_version_db()
803      */
804     public function set_version_db() {
805         global $DB;
807         $blocksinfo = self::get_blocks_info();
808         if (isset($blocksinfo[$this->name]->version)) {
809             $this->versiondb = $blocksinfo[$this->name]->version;
810         }
811     }
813     /**
814      * @see plugintype_interface::is_enabled()
815      */
816     public function is_enabled() {
818         $blocksinfo = self::get_blocks_info();
819         if (isset($blocksinfo[$this->name]->visible)) {
820             if ($blocksinfo[$this->name]->visible) {
821                 return true;
822             } else {
823                 return false;
824             }
825         } else {
826             return parent::is_enabled();
827         }
828     }
830     /**
831      * @see plugintype_interface::get_settings_url()
832      */
833     public function get_settings_url() {
835         if (($block = block_instance($this->name)) === false) {
836             return parent::get_settings_url();
838         } else if ($block->has_config()) {
839             if (!empty($this->rootdir) and file_exists($this->rootdir . '/settings.php')) {
840                 return new moodle_url('/admin/settings.php', array('section' => 'blocksetting' . $this->name));
841             } else {
842                 $blocksinfo = self::get_blocks_info();
843                 return new moodle_url('/admin/block.php', array('block' => $blocksinfo[$this->name]->id));
844             }
846         } else {
847             return parent::get_settings_url();
848         }
849     }
851     /**
852      * @see plugintype_interface::get_uninstall_url()
853      */
854     public function get_uninstall_url() {
856         $blocksinfo = self::get_blocks_info();
857         return new moodle_url('/admin/blocks.php', array('delete' => $blocksinfo[$this->name]->id, 'sesskey' => sesskey()));
858     }
860     /**
861      * Provides access to the records in {block} table
862      *
863      * @param bool $disablecache do not use internal static cache
864      * @return array array of stdClasses
865      */
866     protected static function get_blocks_info($disablecache=false) {
867         global $DB;
868         static $blocksinfocache = null;
870         if (is_null($blocksinfocache) or $disablecache) {
871             $blocksinfocache = $DB->get_records('block', null, 'name', 'name,id,version,visible');
872         }
874         return $blocksinfocache;
875     }
878 /**
879  * Class for text filters
880  */
881 class plugintype_filter extends plugintype_base implements plugintype_interface {
883     /**
884      * @see plugintype_interface::get_plugins()
885      */
886     public static function get_plugins($type, $typerootdir, $typeclass) {
887         global $CFG, $DB;
889         $filters = array();
891         // get the list of filters from both /filter and /mod location
892         $installed = filter_get_all_installed();
894         foreach ($installed as $filterlegacyname => $displayname) {
895             $plugin                 = new $typeclass();
896             $plugin->type           = $type;
897             $plugin->typerootdir    = $typerootdir;
898             $plugin->name           = self::normalize_legacy_name($filterlegacyname);
899             $plugin->rootdir        = $CFG->dirroot . '/' . $filterlegacyname;
900             $plugin->displayname    = $displayname;
902             $plugin->set_version_disk();
903             $plugin->set_version_db();
904             $plugin->set_version_requires();
905             $plugin->set_source();
907             $filters[$plugin->name] = $plugin;
908         }
910         $globalstates = self::get_global_states();
912         if ($DB->get_manager()->table_exists('filter_active')) {
913             // if we're upgrading from 1.9, the table does not exist yet
914             // if it does, make sure that all installed filters are registered
915             $needsreload  = false;
916             foreach (array_keys($installed) as $filterlegacyname) {
917                 if (!isset($globalstates[self::normalize_legacy_name($filterlegacyname)])) {
918                     filter_set_global_state($filterlegacyname, TEXTFILTER_DISABLED);
919                     $needsreload = true;
920                 }
921             }
922             if ($needsreload) {
923                 $globalstates = self::get_global_states(true);
924             }
925         }
927         // make sure that all registered filters are installed, just in case
928         foreach ($globalstates as $name => $info) {
929             if (!isset($filters[$name])) {
930                 // oops, there is a record in filter_active but the filter is not installed
931                 $plugin                 = new $typeclass();
932                 $plugin->type           = $type;
933                 $plugin->typerootdir    = $typerootdir;
934                 $plugin->name           = $name;
935                 $plugin->rootdir        = $CFG->dirroot . '/' . $info->legacyname;
936                 $plugin->displayname    = $info->legacyname;
938                 $plugin->set_version_db();
940                 if (is_null($plugin->versiondb)) {
941                     // this is a hack to stimulate 'Missing from disk' error
942                     // because $plugin->versiondisk will be null !== false
943                     $plugin->versiondb = false;
944                 }
946                 $filters[$plugin->name] = $plugin;
947             }
948         }
950         return $filters;
951     }
953     /**
954      * @see plugintype_interface::set_display_name()
955      */
956     public function set_display_name() {
957         // do nothing, the name is set in self::get_plugins()
958     }
960     /**
961      * @see plugintype_interface::set_version_disk()
962      */
963     public function set_version_disk() {
965         if (strpos($this->name, 'mod_') === 0) {
966             // filters bundled with modules do not use versioning
967             return;
968         }
970         return parent::set_version_disk();
971     }
973     /**
974      * @see plugintype_interface::set_version_requires()
975      */
976     public function set_version_requires() {
978         if (strpos($this->name, 'mod_') === 0) {
979             // filters bundled with modules do not use versioning
980             return;
981         }
983         return parent::set_version_requires();
984     }
986     /**
987      * @see plugintype_interface::is_enabled()
988      */
989     public function is_enabled() {
991         $globalstates = self::get_global_states();
993         foreach ($globalstates as $filterlegacyname => $info) {
994             $name = self::normalize_legacy_name($filterlegacyname);
995             if ($name === $this->name) {
996                 if ($info->active == TEXTFILTER_DISABLED) {
997                     return false;
998                 } else {
999                     // it may be 'On' or 'Off, but available'
1000                     return null;
1001                 }
1002             }
1003         }
1005         return null;
1006     }
1008     /**
1009      * @see plugintype_interface::get_settings_url()
1010      */
1011     public function get_settings_url() {
1013         $globalstates = self::get_global_states();
1014         $legacyname = $globalstates[$this->name]->legacyname;
1015         if (filter_has_global_settings($legacyname)) {
1016             return new moodle_url('/admin/settings.php', array('section' => 'filtersetting' . str_replace('/', '', $legacyname)));
1017         } else {
1018             return null;
1019         }
1020     }
1022     /**
1023      * @see plugintype_interface::get_uninstall_url()
1024      */
1025     public function get_uninstall_url() {
1027         if (strpos($this->name, 'mod_') === 0) {
1028             return null;
1029         } else {
1030             $globalstates = self::get_global_states();
1031             $legacyname = $globalstates[$this->name]->legacyname;
1032             return new moodle_url('/admin/filters.php', array('sesskey' => sesskey(), 'filterpath' => $legacyname, 'action' => 'delete'));
1033         }
1034     }
1036     /**
1037      * Convert legacy filter names like 'filter/foo' or 'mod/bar' into frankenstyle
1038      *
1039      * @param string $legacyfiltername legacy filter name
1040      * @return string frankenstyle-like name
1041      */
1042     protected static function normalize_legacy_name($legacyfiltername) {
1044         $name = str_replace('/', '_', $legacyfiltername);
1045         if (strpos($name, 'filter_') === 0) {
1046             $name = substr($name, 7);
1047             if (empty($name)) {
1048                 throw new coding_exception('Unable to determine filter name: ' . $legacyfiltername);
1049             }
1050         }
1052         return $name;
1053     }
1055     /**
1056      * Provides access to the results of {@link filter_get_global_states()}
1057      * but indexed by the normalized filter name
1058      *
1059      * The legacy filter name is available as ->legacyname property.
1060      *
1061      * @param bool $disablecache
1062      * @return array
1063      */
1064     protected static function get_global_states($disablecache=false) {
1065         global $DB;
1066         static $globalstatescache = null;
1068         if ($disablecache or is_null($globalstatescache)) {
1070             if (!$DB->get_manager()->table_exists('filter_active')) {
1071                 // we're upgrading from 1.9 and the table used by {@link filter_get_global_states()}
1072                 // does not exist yet
1073                 $globalstatescache = array();
1075             } else {
1076                 foreach (filter_get_global_states() as $legacyname => $info) {
1077                     $name                       = self::normalize_legacy_name($legacyname);
1078                     $filterinfo                 = new stdClass();
1079                     $filterinfo->legacyname     = $legacyname;
1080                     $filterinfo->active         = $info->active;
1081                     $filterinfo->sortorder      = $info->sortorder;
1082                     $globalstatescache[$name]   = $filterinfo;
1083                 }
1084             }
1085         }
1087         return $globalstatescache;
1088     }
1091 /**
1092  * Class for activity modules
1093  */
1094 class plugintype_mod extends plugintype_base implements plugintype_interface {
1096     /**
1097      * @see plugintype_interface::get_plugins()
1098      */
1099     public static function get_plugins($type, $typerootdir, $typeclass) {
1101         // get the information about plugins at the disk
1102         $modules = parent::get_plugins($type, $typerootdir, $typeclass);
1104         // add modules missing from disk
1105         $modulesinfo = self::get_modules_info();
1106         foreach ($modulesinfo as $modulename => $moduleinfo) {
1107             if (isset($modules[$modulename])) {
1108                 continue;
1109             }
1110             $plugin                 = new $typeclass();
1111             $plugin->type           = $type;
1112             $plugin->typerootdir    = $typerootdir;
1113             $plugin->name           = $modulename;
1114             $plugin->rootdir        = null;
1115             $plugin->displayname    = $modulename;
1116             $plugin->versiondb      = $moduleinfo->version;
1117             $plugin->set_source();
1119             $modules[$modulename]   = $plugin;
1120         }
1122         return $modules;
1123     }
1125     /**
1126      * @see plugintype_interface::set_display_name()
1127      */
1128     public function set_display_name() {
1129         if (get_string_manager()->string_exists('pluginname', $this->type . '_' . $this->name)) {
1130             $this->displayname = get_string('pluginname', $this->type . '_' . $this->name);
1131         } else {
1132             $this->displayname = get_string('modulename', $this->type . '_' . $this->name);
1133         }
1134     }
1136     /**
1137      * @see plugintype_interface::set_version_disk()
1138      */
1139     public function set_version_disk() {
1141         if (empty($this->rootdir)) {
1142             return;
1143         }
1145         $versionfile = $this->rootdir . '/version.php';
1147         if (is_readable($versionfile)) {
1148             include($versionfile);
1149             if (isset($module->version)) {
1150                 $this->versiondisk = $module->version;
1151             }
1152         }
1153     }
1155     /**
1156      * @see plugintype_interface::set_version_db()
1157      */
1158     public function set_version_db() {
1159         global $DB;
1161         $modulesinfo = self::get_modules_info();
1162         if (isset($modulesinfo[$this->name]->version)) {
1163             $this->versiondb = $modulesinfo[$this->name]->version;
1164         }
1165     }
1167     /**
1168      * @see plugintype_interface::set_version_requires()
1169      */
1170     public function set_version_requires() {
1172         if (empty($this->rootdir)) {
1173             return;
1174         }
1176         $versionfile = $this->rootdir . '/version.php';
1178         if (is_readable($versionfile)) {
1179             include($versionfile);
1180             if (isset($module->requires)) {
1181                 $this->versionrequires = $module->requires;
1182             }
1183         }
1184     }
1186     /**
1187      * @see plugintype_interface::is_enabled()
1188      */
1189     public function is_enabled() {
1191         $modulesinfo = self::get_modules_info();
1192         if (isset($modulesinfo[$this->name]->visible)) {
1193             if ($modulesinfo[$this->name]->visible) {
1194                 return true;
1195             } else {
1196                 return false;
1197             }
1198         } else {
1199             return parent::is_enabled();
1200         }
1201     }
1203     /**
1204      * @see plugintype_interface::get_settings_url()
1205      */
1206     public function get_settings_url() {
1208         if (!empty($this->rootdir) and (file_exists($this->rootdir . '/settings.php') or file_exists($this->rootdir . '/settingstree.php'))) {
1209             return new moodle_url('/admin/settings.php', array('section' => 'modsetting' . $this->name));
1210         } else {
1211             return parent::get_settings_url();
1212         }
1213     }
1215     /**
1216      * @see plugintype_interface::get_uninstall_url()
1217      */
1218     public function get_uninstall_url() {
1220         if ($this->name !== 'forum') {
1221             return new moodle_url('/admin/modules.php', array('delete' => $this->name, 'sesskey' => sesskey()));
1222         } else {
1223             return null;
1224         }
1225     }
1227     /**
1228      * Provides access to the records in {modules} table
1229      *
1230      * @param bool $disablecache do not use internal static cache
1231      * @return array array of stdClasses
1232      */
1233     protected static function get_modules_info($disablecache=false) {
1234         global $DB;
1235         static $modulesinfocache = null;
1237         if (is_null($modulesinfocache) or $disablecache) {
1238             $modulesinfocache = $DB->get_records('modules', null, 'name', 'name,id,version,visible');
1239         }
1241         return $modulesinfocache;
1242     }
1245 /**
1246  * Class for question types
1247  */
1248 class plugintype_qtype extends plugintype_base implements plugintype_interface {
1250     /**
1251      * @see plugintype_interface::set_display_name()
1252      */
1253     public function set_display_name() {
1254         $this->displayname = get_string($this->name, 'qtype_' . $this->name);
1255     }
1258 /**
1259  * Class for question formats
1260  */
1261 class plugintype_qformat extends plugintype_base implements plugintype_interface {
1263     /**
1264      * @see plugintype_interface::set_display_name()
1265      */
1266     public function set_display_name() {
1267         $this->displayname = get_string($this->name, 'qformat_' . $this->name);
1268     }
1271 /**
1272  * Class for authentication plugins
1273  */
1274 class plugintype_auth extends plugintype_base implements plugintype_interface {
1276     /**
1277      * @see plugintype_interface::is_enabled()
1278      */
1279     public function is_enabled() {
1280         global $CFG;
1281         /** @var null|array list of enabled authentication plugins */
1282         static $enabled = null;
1284         if (in_array($this->name, array('nologin', 'manual'))) {
1285             // these two are always enabled and can't be disabled
1286             return null;
1287         }
1289         if (is_null($enabled)) {
1290             $enabled = explode(',', $CFG->auth);
1291         }
1293         return isset($enabled[$this->name]);
1294     }
1296     /**
1297      * @see plugintype_interface::get_settings_url()
1298      */
1299     public function get_settings_url() {
1301         if (!empty($this->rootdir) and file_exists($this->rootdir . '/settings.php')) {
1302             return new moodle_url('/admin/settings.php', array('section' => 'authsetting' . $this->name));
1303         } else {
1304             return new moodle_url('/admin/auth_config.php', array('auth' => $this->name));
1305         }
1306     }
1309 /**
1310  * Class for enrolment plugins
1311  */
1312 class plugintype_enrol extends plugintype_base implements plugintype_interface {
1314     /**
1315      * We do not actually need whole enrolment classes here so we do not call
1316      * {@link enrol_get_plugins()}. Note that this may produce slightly different
1317      * results, for example if the enrolment plugin does not contain lib.php
1318      * but it is listed in $CFG->enrol_plugins_enabled
1319      *
1320      * @see plugintype_interface::is_enabled()
1321      */
1322     public function is_enabled() {
1323         global $CFG;
1324         /** @var null|array list of enabled enrolment plugins */
1325         static $enabled = null;
1327         if (is_null($enabled)) {
1328             $enabled = explode(',', $CFG->enrol_plugins_enabled);
1329         }
1331         return isset($enabled[$this->name]);
1332     }
1334     /**
1335      * @see plugintype_interface::get_settings_url()
1336      */
1337     public function get_settings_url() {
1339         if ($this->is_enabled() or (!empty($this->rootdir) and file_exists($this->rootdir . '/settings.php'))) {
1340             return new moodle_url('/admin/settings.php', array('section' => 'enrolsettings' . $this->name));
1341         } else {
1342             return parent::get_settings_url();
1343         }
1344     }
1346     /**
1347      * @see plugintype_interface::get_uninstall_url()
1348      */
1349     public function get_uninstall_url() {
1350         return new moodle_url('/admin/enrol.php', array('action' => 'uninstall', 'enrol' => $this->name, 'sesskey' => sesskey()));
1351     }
1354 /**
1355  * Class for messaging processors
1356  */
1357 class plugintype_message extends plugintype_base implements plugintype_interface {
1359     /**
1360      * @see plugintype_interface::get_settings_url()
1361      */
1362     public function get_settings_url() {
1364         if ($this->name === 'jabber') {
1365             return new moodle_url('/admin/settings.php', array('section' => 'jabber'));
1366         }
1368         if ($this->name === 'email') {
1369             return new moodle_url('/admin/settings.php', array('section' => 'mail'));
1370         }
1372     }
1375 /**
1376  * Class for repositories
1377  */
1378 class plugintype_repository extends plugintype_base implements plugintype_interface {
1380     /**
1381      * @see plugintype_interface::is_enabled()
1382      */
1383     public function is_enabled() {
1385         $enabled = self::get_enabled_repositories();
1387         return isset($enabled[$this->name]);
1388     }
1390     /**
1391      * @see plugintype_interface::get_settings_url()
1392      */
1393     public function get_settings_url() {
1395         if ($this->is_enabled()) {
1396             return new moodle_url('/admin/repository.php', array('sesskey' => sesskey(), 'action' => 'edit', 'repos' => $this->name));
1397         } else {
1398             return parent::get_settings_url();
1399         }
1400     }
1402     /**
1403      * Provides access to the records in {repository} table
1404      *
1405      * @param bool $disablecache do not use internal static cache
1406      * @return array array of stdClasses
1407      */
1408     protected static function get_enabled_repositories($disablecache=false) {
1409         global $DB;
1410         static $repositories = null;
1412         if (is_null($repositories) or $disablecache) {
1413             $repositories = $DB->get_records('repository', null, 'type', 'type,visible,sortorder');
1414         }
1416         return $repositories;
1417     }
1420 /**
1421  * Class for portfolios
1422  */
1423 class plugintype_portfolio extends plugintype_base implements plugintype_interface {
1425     /**
1426      * @see plugintype_interface::is_enabled()
1427      */
1428     public function is_enabled() {
1430         $enabled = self::get_enabled_portfolios();
1432         return isset($enabled[$this->name]);
1433     }
1435     /**
1436      * Provides access to the records in {portfolio_instance} table
1437      *
1438      * @param bool $disablecache do not use internal static cache
1439      * @return array array of stdClasses
1440      */
1441     protected static function get_enabled_portfolios($disablecache=false) {
1442         global $DB;
1443         static $portfolios = null;
1445         if (is_null($portfolios) or $disablecache) {
1446             $portfolios = array();
1447             $instances  = $DB->get_recordset('portfolio_instance', null, 'plugin');
1448             foreach ($instances as $instance) {
1449                 if (isset($portfolios[$instance->plugin])) {
1450                     if ($instance->visible) {
1451                         $portfolios[$instance->plugin]->visible = $instance->visible;
1452                     }
1453                 } else {
1454                     $portfolios[$instance->plugin] = $instance;
1455                 }
1456             }
1457         }
1459         return $portfolios;
1460     }
1463 /**
1464  * Class for themes
1465  */
1466 class plugintype_theme extends plugintype_base implements plugintype_interface {
1468     /**
1469      * @see plugintype_interface::is_enabled()
1470      */
1471     public function is_enabled() {
1472         global $CFG;
1474         if ((!empty($CFG->theme) and $CFG->theme === $this->name) or
1475             (!empty($CFG->themelegacy) and $CFG->themelegacy === $this->name)) {
1476             return true;
1477         } else {
1478             return parent::is_enabled();
1479         }
1480     }
1483 /**
1484  * Class representing an MNet service
1485  */
1486 class plugintype_mnetservice extends plugintype_base implements plugintype_interface {
1488     /**
1489      * @see plugintype_interface::is_enabled()
1490      */
1491     public function is_enabled() {
1492         global $CFG;
1494         if (empty($CFG->mnet_dispatcher_mode) || $CFG->mnet_dispatcher_mode !== 'strict') {
1495             return false;
1496         } else {
1497             return parent::is_enabled();
1498         }
1499     }