e8cb001ce7a521d91572ba93bde83c2a74c4a169
[moodle.git] / lib / pluginlib.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  * Defines classes used for plugins management
20  *
21  * This library provides a unified interface to various plugin types in
22  * Moodle. It is mainly used by the plugins management admin page and the
23  * plugins check page during the upgrade.
24  *
25  * @package    core
26  * @subpackage admin
27  * @copyright  2011 David Mudrak <david@moodle.com>
28  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
29  */
31 defined('MOODLE_INTERNAL') || die();
33 /**
34  * Singleton class providing general plugins management functionality
35  */
36 class plugin_manager {
38     /** the plugin is shipped with standard Moodle distribution */
39     const PLUGIN_SOURCE_STANDARD    = 'std';
40     /** the plugin is added extension */
41     const PLUGIN_SOURCE_EXTENSION   = 'ext';
43     /** the plugin uses neither database nor capabilities, no versions */
44     const PLUGIN_STATUS_NODB        = 'nodb';
45     /** the plugin is up-to-date */
46     const PLUGIN_STATUS_UPTODATE    = 'uptodate';
47     /** the plugin is about to be installed */
48     const PLUGIN_STATUS_NEW         = 'new';
49     /** the plugin is about to be upgraded */
50     const PLUGIN_STATUS_UPGRADE     = 'upgrade';
51     /** the standard plugin is about to be deleted */
52     const PLUGIN_STATUS_DELETE     = 'delete';
53     /** the version at the disk is lower than the one already installed */
54     const PLUGIN_STATUS_DOWNGRADE   = 'downgrade';
55     /** the plugin is installed but missing from disk */
56     const PLUGIN_STATUS_MISSING     = 'missing';
58     /** @var plugin_manager holds the singleton instance */
59     protected static $singletoninstance;
60     /** @var array of raw plugins information */
61     protected $pluginsinfo = null;
62     /** @var array of raw subplugins information */
63     protected $subpluginsinfo = null;
65     /**
66      * Direct initiation not allowed, use the factory method {@link self::instance()}
67      */
68     protected function __construct() {
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         if (is_null(self::$singletoninstance)) {
84             self::$singletoninstance = new self();
85         }
86         return self::$singletoninstance;
87     }
89     /**
90      * Reset any caches
91      * @param bool $phpunitreset
92      */
93     public static function reset_caches($phpunitreset = false) {
94         if ($phpunitreset) {
95             self::$singletoninstance = null;
96         }
97     }
99     /**
100      * Returns a tree of known plugins and information about them
101      *
102      * @param bool $disablecache force reload, cache can be used otherwise
103      * @return array 2D array. The first keys are plugin type names (e.g. qtype);
104      *      the second keys are the plugin local name (e.g. multichoice); and
105      *      the values are the corresponding objects extending {@link plugininfo_base}
106      */
107     public function get_plugins($disablecache=false) {
108         global $CFG;
110         if ($disablecache or is_null($this->pluginsinfo)) {
111             // Hack: include mod and editor subplugin management classes first,
112             //       the adminlib.php is supposed to contain extra admin settings too.
113             require_once($CFG->libdir.'/adminlib.php');
114             foreach(array('mod', 'editor') as $type) {
115                 foreach (get_plugin_list($type) as $dir) {
116                     if (file_exists("$dir/adminlib.php")) {
117                         include_once("$dir/adminlib.php");
118                     }
119                 }
120             }
121             $this->pluginsinfo = array();
122             $plugintypes = get_plugin_types();
123             $plugintypes = $this->reorder_plugin_types($plugintypes);
124             foreach ($plugintypes as $plugintype => $plugintyperootdir) {
125                 if (in_array($plugintype, array('base', 'general'))) {
126                     throw new coding_exception('Illegal usage of reserved word for plugin type');
127                 }
128                 if (class_exists('plugininfo_' . $plugintype)) {
129                     $plugintypeclass = 'plugininfo_' . $plugintype;
130                 } else {
131                     $plugintypeclass = 'plugininfo_general';
132                 }
133                 if (!in_array('plugininfo_base', class_parents($plugintypeclass))) {
134                     throw new coding_exception('Class ' . $plugintypeclass . ' must extend plugininfo_base');
135                 }
136                 $plugins = call_user_func(array($plugintypeclass, 'get_plugins'), $plugintype, $plugintyperootdir, $plugintypeclass);
137                 $this->pluginsinfo[$plugintype] = $plugins;
138             }
140             if (empty($CFG->disableupdatenotifications) and !during_initial_install()) {
141                 // append the information about available updates provided by {@link available_update_checker()}
142                 $provider = available_update_checker::instance();
143                 foreach ($this->pluginsinfo as $plugintype => $plugins) {
144                     foreach ($plugins as $plugininfoholder) {
145                         $plugininfoholder->check_available_updates($provider);
146                     }
147                 }
148             }
149         }
151         return $this->pluginsinfo;
152     }
154     /**
155      * Returns list of plugins that define their subplugins and the information
156      * about them from the db/subplugins.php file.
157      *
158      * At the moment, only activity modules and editors can define subplugins.
159      *
160      * @param bool $disablecache force reload, cache can be used otherwise
161      * @return array with keys like 'mod_quiz', and values the data from the
162      *      corresponding db/subplugins.php file.
163      */
164     public function get_subplugins($disablecache=false) {
166         if ($disablecache or is_null($this->subpluginsinfo)) {
167             $this->subpluginsinfo = array();
168             foreach (array('mod', 'editor') as $type) {
169                 $owners = get_plugin_list($type);
170                 foreach ($owners as $component => $ownerdir) {
171                     $componentsubplugins = array();
172                     if (file_exists($ownerdir . '/db/subplugins.php')) {
173                         $subplugins = array();
174                         include($ownerdir . '/db/subplugins.php');
175                         foreach ($subplugins as $subplugintype => $subplugintyperootdir) {
176                             $subplugin = new stdClass();
177                             $subplugin->type = $subplugintype;
178                             $subplugin->typerootdir = $subplugintyperootdir;
179                             $componentsubplugins[$subplugintype] = $subplugin;
180                         }
181                         $this->subpluginsinfo[$type . '_' . $component] = $componentsubplugins;
182                     }
183                 }
184             }
185         }
187         return $this->subpluginsinfo;
188     }
190     /**
191      * Returns the name of the plugin that defines the given subplugin type
192      *
193      * If the given subplugin type is not actually a subplugin, returns false.
194      *
195      * @param string $subplugintype the name of subplugin type, eg. workshopform or quiz
196      * @return false|string the name of the parent plugin, eg. mod_workshop
197      */
198     public function get_parent_of_subplugin($subplugintype) {
200         $parent = false;
201         foreach ($this->get_subplugins() as $pluginname => $subplugintypes) {
202             if (isset($subplugintypes[$subplugintype])) {
203                 $parent = $pluginname;
204                 break;
205             }
206         }
208         return $parent;
209     }
211     /**
212      * Returns a localized name of a given plugin
213      *
214      * @param string $plugin name of the plugin, eg mod_workshop or auth_ldap
215      * @return string
216      */
217     public function plugin_name($plugin) {
218         list($type, $name) = normalize_component($plugin);
219         return $this->pluginsinfo[$type][$name]->displayname;
220     }
222     /**
223      * Returns a localized name of a plugin type in plural form
224      *
225      * Most plugin types define their names in core_plugin lang file. In case of subplugins,
226      * we try to ask the parent plugin for the name. In the worst case, we will return
227      * the value of the passed $type parameter.
228      *
229      * @param string $type the type of the plugin, e.g. mod or workshopform
230      * @return string
231      */
232     public function plugintype_name_plural($type) {
234         if (get_string_manager()->string_exists('type_' . $type . '_plural', 'core_plugin')) {
235             // for most plugin types, their names are defined in core_plugin lang file
236             return get_string('type_' . $type . '_plural', 'core_plugin');
238         } else if ($parent = $this->get_parent_of_subplugin($type)) {
239             // if this is a subplugin, try to ask the parent plugin for the name
240             if (get_string_manager()->string_exists('subplugintype_' . $type . '_plural', $parent)) {
241                 return $this->plugin_name($parent) . ' / ' . get_string('subplugintype_' . $type . '_plural', $parent);
242             } else {
243                 return $this->plugin_name($parent) . ' / ' . $type;
244             }
246         } else {
247             return $type;
248         }
249     }
251     /**
252      * @param string $component frankenstyle component name.
253      * @return plugininfo_base|null the corresponding plugin information.
254      */
255     public function get_plugin_info($component) {
256         list($type, $name) = normalize_component($component);
257         $plugins = $this->get_plugins();
258         if (isset($plugins[$type][$name])) {
259             return $plugins[$type][$name];
260         } else {
261             return null;
262         }
263     }
265     /**
266      * Get a list of any other plugins that require this one.
267      * @param string $component frankenstyle component name.
268      * @return array of frankensyle component names that require this one.
269      */
270     public function other_plugins_that_require($component) {
271         $others = array();
272         foreach ($this->get_plugins() as $type => $plugins) {
273             foreach ($plugins as $plugin) {
274                 $required = $plugin->get_other_required_plugins();
275                 if (isset($required[$component])) {
276                     $others[] = $plugin->component;
277                 }
278             }
279         }
280         return $others;
281     }
283     /**
284      * Check a dependencies list against the list of installed plugins.
285      * @param array $dependencies compenent name to required version or ANY_VERSION.
286      * @return bool true if all the dependencies are satisfied.
287      */
288     public function are_dependencies_satisfied($dependencies) {
289         foreach ($dependencies as $component => $requiredversion) {
290             $otherplugin = $this->get_plugin_info($component);
291             if (is_null($otherplugin)) {
292                 return false;
293             }
295             if ($requiredversion != ANY_VERSION and $otherplugin->versiondisk < $requiredversion) {
296                 return false;
297             }
298         }
300         return true;
301     }
303     /**
304      * Checks all dependencies for all installed plugins
305      *
306      * This is used by install and upgrade. The array passed by reference as the second
307      * argument is populated with the list of plugins that have failed dependencies (note that
308      * a single plugin can appear multiple times in the $failedplugins).
309      *
310      * @param int $moodleversion the version from version.php.
311      * @param array $failedplugins to return the list of plugins with non-satisfied dependencies
312      * @return bool true if all the dependencies are satisfied for all plugins.
313      */
314     public function all_plugins_ok($moodleversion, &$failedplugins = array()) {
316         $return = true;
317         foreach ($this->get_plugins() as $type => $plugins) {
318             foreach ($plugins as $plugin) {
320                 if (!$plugin->is_core_dependency_satisfied($moodleversion)) {
321                     $return = false;
322                     $failedplugins[] = $plugin->component;
323                 }
325                 if (!$this->are_dependencies_satisfied($plugin->get_other_required_plugins())) {
326                     $return = false;
327                     $failedplugins[] = $plugin->component;
328                 }
329             }
330         }
332         return $return;
333     }
335     /**
336      * Checks if there are some plugins with a known available update
337      *
338      * @return bool true if there is at least one available update
339      */
340     public function some_plugins_updatable() {
341         foreach ($this->get_plugins() as $type => $plugins) {
342             foreach ($plugins as $plugin) {
343                 if ($plugin->available_updates()) {
344                     return true;
345                 }
346             }
347         }
349         return false;
350     }
352     /**
353      * Defines a list of all plugins that were originally shipped in the standard Moodle distribution,
354      * but are not anymore and are deleted during upgrades.
355      *
356      * The main purpose of this list is to hide missing plugins during upgrade.
357      *
358      * @param string $type plugin type
359      * @param string $name plugin name
360      * @return bool
361      */
362     public static function is_deleted_standard_plugin($type, $name) {
363         static $plugins = array(
364             // do not add 1.9-2.2 plugin removals here
365         );
367         if (!isset($plugins[$type])) {
368             return false;
369         }
370         return in_array($name, $plugins[$type]);
371     }
373     /**
374      * Defines a white list of all plugins shipped in the standard Moodle distribution
375      *
376      * @param string $type
377      * @return false|array array of standard plugins or false if the type is unknown
378      */
379     public static function standard_plugins_list($type) {
380         static $standard_plugins = array(
382             'assignment' => array(
383                 'offline', 'online', 'upload', 'uploadsingle'
384             ),
386             'assignsubmission' => array(
387                 'comments', 'file', 'onlinetext'
388             ),
390             'assignfeedback' => array(
391                 'comments', 'file', 'offline'
392             ),
394             'auth' => array(
395                 'cas', 'db', 'email', 'fc', 'imap', 'ldap', 'manual', 'mnet',
396                 'nntp', 'nologin', 'none', 'pam', 'pop3', 'radius',
397                 'shibboleth', 'webservice'
398             ),
400             'block' => array(
401                 'activity_modules', 'admin_bookmarks', 'blog_menu',
402                 'blog_recent', 'blog_tags', 'calendar_month',
403                 'calendar_upcoming', 'comments', 'community',
404                 'completionstatus', 'course_list', 'course_overview',
405                 'course_summary', 'feedback', 'glossary_random', 'html',
406                 'login', 'mentees', 'messages', 'mnet_hosts', 'myprofile',
407                 'navigation', 'news_items', 'online_users', 'participants',
408                 'private_files', 'quiz_results', 'recent_activity',
409                 'rss_client', 'search_forums', 'section_links',
410                 'selfcompletion', 'settings', 'site_main_menu',
411                 'social_activities', 'tag_flickr', 'tag_youtube', 'tags'
412             ),
414             'booktool' => array(
415                 'exportimscp', 'importhtml', 'print'
416             ),
418             'cachelock' => array(
419                 'file'
420             ),
422             'cachestore' => array(
423                 'file', 'memcache', 'memcached', 'mongodb', 'session', 'static'
424             ),
426             'coursereport' => array(
427                 //deprecated!
428             ),
430             'datafield' => array(
431                 'checkbox', 'date', 'file', 'latlong', 'menu', 'multimenu',
432                 'number', 'picture', 'radiobutton', 'text', 'textarea', 'url'
433             ),
435             'datapreset' => array(
436                 'imagegallery'
437             ),
439             'editor' => array(
440                 'textarea', 'tinymce'
441             ),
443             'enrol' => array(
444                 'authorize', 'category', 'cohort', 'database', 'flatfile',
445                 'guest', 'imsenterprise', 'ldap', 'manual', 'meta', 'mnet',
446                 'paypal', 'self'
447             ),
449             'filter' => array(
450                 'activitynames', 'algebra', 'censor', 'emailprotect',
451                 'emoticon', 'mediaplugin', 'multilang', 'tex', 'tidy',
452                 'urltolink', 'data', 'glossary'
453             ),
455             'format' => array(
456                 'scorm', 'social', 'topics', 'weeks'
457             ),
459             'gradeexport' => array(
460                 'ods', 'txt', 'xls', 'xml'
461             ),
463             'gradeimport' => array(
464                 'csv', 'xml'
465             ),
467             'gradereport' => array(
468                 'grader', 'outcomes', 'overview', 'user'
469             ),
471             'gradingform' => array(
472                 'rubric', 'guide'
473             ),
475             'local' => array(
476             ),
478             'message' => array(
479                 'email', 'jabber', 'popup'
480             ),
482             'mnetservice' => array(
483                 'enrol'
484             ),
486             'mod' => array(
487                 'assign', 'assignment', 'book', 'chat', 'choice', 'data', 'feedback', 'folder',
488                 'forum', 'glossary', 'imscp', 'label', 'lesson', 'lti', 'page',
489                 'quiz', 'resource', 'scorm', 'survey', 'url', 'wiki', 'workshop'
490             ),
492             'plagiarism' => array(
493             ),
495             'portfolio' => array(
496                 'boxnet', 'download', 'flickr', 'googledocs', 'mahara', 'picasa'
497             ),
499             'profilefield' => array(
500                 'checkbox', 'datetime', 'menu', 'text', 'textarea'
501             ),
503             'qbehaviour' => array(
504                 'adaptive', 'adaptivenopenalty', 'deferredcbm',
505                 'deferredfeedback', 'immediatecbm', 'immediatefeedback',
506                 'informationitem', 'interactive', 'interactivecountback',
507                 'manualgraded', 'missing'
508             ),
510             'qformat' => array(
511                 'aiken', 'blackboard', 'blackboard_six', 'examview', 'gift',
512                 'learnwise', 'missingword', 'multianswer', 'webct',
513                 'xhtml', 'xml'
514             ),
516             'qtype' => array(
517                 'calculated', 'calculatedmulti', 'calculatedsimple',
518                 'description', 'essay', 'match', 'missingtype', 'multianswer',
519                 'multichoice', 'numerical', 'random', 'randomsamatch',
520                 'shortanswer', 'truefalse'
521             ),
523             'quiz' => array(
524                 'grading', 'overview', 'responses', 'statistics'
525             ),
527             'quizaccess' => array(
528                 'delaybetweenattempts', 'ipaddress', 'numattempts', 'openclosedate',
529                 'password', 'safebrowser', 'securewindow', 'timelimit'
530             ),
532             'report' => array(
533                 'backups', 'completion', 'configlog', 'courseoverview',
534                 'log', 'loglive', 'outline', 'participation', 'progress', 'questioninstances', 'security', 'stats'
535             ),
537             'repository' => array(
538                 'alfresco', 'boxnet', 'coursefiles', 'dropbox', 'equella', 'filesystem',
539                 'flickr', 'flickr_public', 'googledocs', 'local', 'merlot',
540                 'picasa', 'recent', 's3', 'upload', 'url', 'user', 'webdav',
541                 'wikimedia', 'youtube'
542             ),
544             'scormreport' => array(
545                 'basic',
546                 'interactions',
547                 'graphs'
548             ),
550             'tinymce' => array(
551                 'dragmath', 'moodleemoticon', 'moodleimage', 'moodlemedia', 'moodlenolink', 'spellchecker',
552             ),
554             'theme' => array(
555                 'afterburner', 'anomaly', 'arialist', 'base', 'binarius',
556                 'boxxie', 'brick', 'canvas', 'formal_white', 'formfactor',
557                 'fusion', 'leatherbound', 'magazine', 'mymobile', 'nimble',
558                 'nonzero', 'overlay', 'serenity', 'sky_high', 'splash',
559                 'standard', 'standardold'
560             ),
562             'tool' => array(
563                 'assignmentupgrade', 'capability', 'customlang', 'dbtransfer', 'generator',
564                 'health', 'innodb', 'langimport', 'multilangupgrade', 'phpunit', 'profiling',
565                 'qeupgradehelper', 'replace', 'spamcleaner', 'timezoneimport', 'unittest',
566                 'uploaduser', 'unsuproles', 'xmldb'
567             ),
569             'webservice' => array(
570                 'amf', 'rest', 'soap', 'xmlrpc'
571             ),
573             'workshopallocation' => array(
574                 'manual', 'random', 'scheduled'
575             ),
577             'workshopeval' => array(
578                 'best'
579             ),
581             'workshopform' => array(
582                 'accumulative', 'comments', 'numerrors', 'rubric'
583             )
584         );
586         if (isset($standard_plugins[$type])) {
587             return $standard_plugins[$type];
588         } else {
589             return false;
590         }
591     }
593     /**
594      * Reorders plugin types into a sequence to be displayed
595      *
596      * For technical reasons, plugin types returned by {@link get_plugin_types()} are
597      * in a certain order that does not need to fit the expected order for the display.
598      * Particularly, activity modules should be displayed first as they represent the
599      * real heart of Moodle. They should be followed by other plugin types that are
600      * used to build the courses (as that is what one expects from LMS). After that,
601      * other supportive plugin types follow.
602      *
603      * @param array $types associative array
604      * @return array same array with altered order of items
605      */
606     protected function reorder_plugin_types(array $types) {
607         $fix = array(
608             'mod'        => $types['mod'],
609             'block'      => $types['block'],
610             'qtype'      => $types['qtype'],
611             'qbehaviour' => $types['qbehaviour'],
612             'qformat'    => $types['qformat'],
613             'filter'     => $types['filter'],
614             'enrol'      => $types['enrol'],
615         );
616         foreach ($types as $type => $path) {
617             if (!isset($fix[$type])) {
618                 $fix[$type] = $path;
619             }
620         }
621         return $fix;
622     }
626 /**
627  * General exception thrown by the {@link available_update_checker} class
628  */
629 class available_update_checker_exception extends moodle_exception {
631     /**
632      * @param string $errorcode exception description identifier
633      * @param mixed $debuginfo debugging data to display
634      */
635     public function __construct($errorcode, $debuginfo=null) {
636         parent::__construct($errorcode, 'core_plugin', '', null, print_r($debuginfo, true));
637     }
641 /**
642  * Singleton class that handles checking for available updates
643  */
644 class available_update_checker {
646     /** @var available_update_checker holds the singleton instance */
647     protected static $singletoninstance;
648     /** @var null|int the timestamp of when the most recent response was fetched */
649     protected $recentfetch = null;
650     /** @var null|array the recent response from the update notification provider */
651     protected $recentresponse = null;
652     /** @var null|string the numerical version of the local Moodle code */
653     protected $currentversion = null;
654     /** @var null|string the release info of the local Moodle code */
655     protected $currentrelease = null;
656     /** @var null|string branch of the local Moodle code */
657     protected $currentbranch = null;
658     /** @var array of (string)frankestyle => (string)version list of additional plugins deployed at this site */
659     protected $currentplugins = array();
661     /**
662      * Direct initiation not allowed, use the factory method {@link self::instance()}
663      */
664     protected function __construct() {
665     }
667     /**
668      * Sorry, this is singleton
669      */
670     protected function __clone() {
671     }
673     /**
674      * Factory method for this class
675      *
676      * @return available_update_checker the singleton instance
677      */
678     public static function instance() {
679         if (is_null(self::$singletoninstance)) {
680             self::$singletoninstance = new self();
681         }
682         return self::$singletoninstance;
683     }
685     /**
686      * Reset any caches
687      * @param bool $phpunitreset
688      */
689     public static function reset_caches($phpunitreset = false) {
690         if ($phpunitreset) {
691             self::$singletoninstance = null;
692         }
693     }
695     /**
696      * Returns the timestamp of the last execution of {@link fetch()}
697      *
698      * @return int|null null if it has never been executed or we don't known
699      */
700     public function get_last_timefetched() {
702         $this->restore_response();
704         if (!empty($this->recentfetch)) {
705             return $this->recentfetch;
707         } else {
708             return null;
709         }
710     }
712     /**
713      * Fetches the available update status from the remote site
714      *
715      * @throws available_update_checker_exception
716      */
717     public function fetch() {
718         $response = $this->get_response();
719         $this->validate_response($response);
720         $this->store_response($response);
721     }
723     /**
724      * Returns the available update information for the given component
725      *
726      * This method returns null if the most recent response does not contain any information
727      * about it. The returned structure is an array of available updates for the given
728      * component. Each update info is an object with at least one property called
729      * 'version'. Other possible properties are 'release', 'maturity', 'url' and 'downloadurl'.
730      *
731      * For the 'core' component, the method returns real updates only (those with higher version).
732      * For all other components, the list of all known remote updates is returned and the caller
733      * (usually the {@link plugin_manager}) is supposed to make the actual comparison of versions.
734      *
735      * @param string $component frankenstyle
736      * @param array $options with supported keys 'minmaturity' and/or 'notifybuilds'
737      * @return null|array null or array of available_update_info objects
738      */
739     public function get_update_info($component, array $options = array()) {
741         if (!isset($options['minmaturity'])) {
742             $options['minmaturity'] = 0;
743         }
745         if (!isset($options['notifybuilds'])) {
746             $options['notifybuilds'] = false;
747         }
749         if ($component == 'core') {
750             $this->load_current_environment();
751         }
753         $this->restore_response();
755         if (empty($this->recentresponse['updates'][$component])) {
756             return null;
757         }
759         $updates = array();
760         foreach ($this->recentresponse['updates'][$component] as $info) {
761             $update = new available_update_info($component, $info);
762             if (isset($update->maturity) and ($update->maturity < $options['minmaturity'])) {
763                 continue;
764             }
765             if ($component == 'core') {
766                 if ($update->version <= $this->currentversion) {
767                     continue;
768                 }
769                 if (empty($options['notifybuilds']) and $this->is_same_release($update->release)) {
770                     continue;
771                 }
772             }
773             $updates[] = $update;
774         }
776         if (empty($updates)) {
777             return null;
778         }
780         return $updates;
781     }
783     /**
784      * The method being run via cron.php
785      */
786     public function cron() {
787         global $CFG;
789         if (!$this->cron_autocheck_enabled()) {
790             $this->cron_mtrace('Automatic check for available updates not enabled, skipping.');
791             return;
792         }
794         $now = $this->cron_current_timestamp();
796         if ($this->cron_has_fresh_fetch($now)) {
797             $this->cron_mtrace('Recently fetched info about available updates is still fresh enough, skipping.');
798             return;
799         }
801         if ($this->cron_has_outdated_fetch($now)) {
802             $this->cron_mtrace('Outdated or missing info about available updates, forced fetching ... ', '');
803             $this->cron_execute();
804             return;
805         }
807         $offset = $this->cron_execution_offset();
808         $start = mktime(1, 0, 0, date('n', $now), date('j', $now), date('Y', $now)); // 01:00 AM today local time
809         if ($now > $start + $offset) {
810             $this->cron_mtrace('Regular daily check for available updates ... ', '');
811             $this->cron_execute();
812             return;
813         }
814     }
816     /// end of public API //////////////////////////////////////////////////////
818     /**
819      * Makes cURL request to get data from the remote site
820      *
821      * @return string raw request result
822      * @throws available_update_checker_exception
823      */
824     protected function get_response() {
825         global $CFG;
826         require_once($CFG->libdir.'/filelib.php');
828         $curl = new curl(array('proxy' => true));
829         $response = $curl->post($this->prepare_request_url(), $this->prepare_request_params());
830         $curlinfo = $curl->get_info();
831         if ($curlinfo['http_code'] != 200) {
832             throw new available_update_checker_exception('err_response_http_code', $curlinfo['http_code']);
833         }
834         return $response;
835     }
837     /**
838      * Makes sure the response is valid, has correct API format etc.
839      *
840      * @param string $response raw response as returned by the {@link self::get_response()}
841      * @throws available_update_checker_exception
842      */
843     protected function validate_response($response) {
845         $response = $this->decode_response($response);
847         if (empty($response)) {
848             throw new available_update_checker_exception('err_response_empty');
849         }
851         if (empty($response['status']) or $response['status'] !== 'OK') {
852             throw new available_update_checker_exception('err_response_status', $response['status']);
853         }
855         if (empty($response['apiver']) or $response['apiver'] !== '1.1') {
856             throw new available_update_checker_exception('err_response_format_version', $response['apiver']);
857         }
859         if (empty($response['forbranch']) or $response['forbranch'] !== moodle_major_version(true)) {
860             throw new available_update_checker_exception('err_response_target_version', $response['forbranch']);
861         }
862     }
864     /**
865      * Decodes the raw string response from the update notifications provider
866      *
867      * @param string $response as returned by {@link self::get_response()}
868      * @return array decoded response structure
869      */
870     protected function decode_response($response) {
871         return json_decode($response, true);
872     }
874     /**
875      * Stores the valid fetched response for later usage
876      *
877      * This implementation uses the config_plugins table as the permanent storage.
878      *
879      * @param string $response raw valid data returned by {@link self::get_response()}
880      */
881     protected function store_response($response) {
883         set_config('recentfetch', time(), 'core_plugin');
884         set_config('recentresponse', $response, 'core_plugin');
886         $this->restore_response(true);
887     }
889     /**
890      * Loads the most recent raw response record we have fetched
891      *
892      * After this method is called, $this->recentresponse is set to an array. If the
893      * array is empty, then either no data have been fetched yet or the fetched data
894      * do not have expected format (and thence they are ignored and a debugging
895      * message is displayed).
896      *
897      * This implementation uses the config_plugins table as the permanent storage.
898      *
899      * @param bool $forcereload reload even if it was already loaded
900      */
901     protected function restore_response($forcereload = false) {
903         if (!$forcereload and !is_null($this->recentresponse)) {
904             // we already have it, nothing to do
905             return;
906         }
908         $config = get_config('core_plugin');
910         if (!empty($config->recentresponse) and !empty($config->recentfetch)) {
911             try {
912                 $this->validate_response($config->recentresponse);
913                 $this->recentfetch = $config->recentfetch;
914                 $this->recentresponse = $this->decode_response($config->recentresponse);
915             } catch (available_update_checker_exception $e) {
916                 debugging('Invalid info about available updates detected and will be ignored: '.$e->getMessage(), DEBUG_ALL);
917                 $this->recentresponse = array();
918             }
920         } else {
921             $this->recentresponse = array();
922         }
923     }
925     /**
926      * Compares two raw {@link $recentresponse} records and returns the list of changed updates
927      *
928      * This method is used to populate potential update info to be sent to site admins.
929      *
930      * @param array $old
931      * @param array $new
932      * @throws available_update_checker_exception
933      * @return array parts of $new['updates'] that have changed
934      */
935     protected function compare_responses(array $old, array $new) {
937         if (empty($new)) {
938             return array();
939         }
941         if (!array_key_exists('updates', $new)) {
942             throw new available_update_checker_exception('err_response_format');
943         }
945         if (empty($old)) {
946             return $new['updates'];
947         }
949         if (!array_key_exists('updates', $old)) {
950             throw new available_update_checker_exception('err_response_format');
951         }
953         $changes = array();
955         foreach ($new['updates'] as $newcomponent => $newcomponentupdates) {
956             if (empty($old['updates'][$newcomponent])) {
957                 $changes[$newcomponent] = $newcomponentupdates;
958                 continue;
959             }
960             foreach ($newcomponentupdates as $newcomponentupdate) {
961                 $inold = false;
962                 foreach ($old['updates'][$newcomponent] as $oldcomponentupdate) {
963                     if ($newcomponentupdate['version'] == $oldcomponentupdate['version']) {
964                         $inold = true;
965                     }
966                 }
967                 if (!$inold) {
968                     if (!isset($changes[$newcomponent])) {
969                         $changes[$newcomponent] = array();
970                     }
971                     $changes[$newcomponent][] = $newcomponentupdate;
972                 }
973             }
974         }
976         return $changes;
977     }
979     /**
980      * Returns the URL to send update requests to
981      *
982      * During the development or testing, you can set $CFG->alternativeupdateproviderurl
983      * to a custom URL that will be used. Otherwise the standard URL will be returned.
984      *
985      * @return string URL
986      */
987     protected function prepare_request_url() {
988         global $CFG;
990         if (!empty($CFG->config_php_settings['alternativeupdateproviderurl'])) {
991             return $CFG->config_php_settings['alternativeupdateproviderurl'];
992         } else {
993             return 'http://download.moodle.org/api/1.1/updates.php';
994         }
995     }
997     /**
998      * Sets the properties currentversion, currentrelease, currentbranch and currentplugins
999      *
1000      * @param bool $forcereload
1001      */
1002     protected function load_current_environment($forcereload=false) {
1003         global $CFG;
1005         if (!is_null($this->currentversion) and !$forcereload) {
1006             // nothing to do
1007             return;
1008         }
1010         $version = null;
1011         $release = null;
1013         require($CFG->dirroot.'/version.php');
1014         $this->currentversion = $version;
1015         $this->currentrelease = $release;
1016         $this->currentbranch = moodle_major_version(true);
1018         $pluginman = plugin_manager::instance();
1019         foreach ($pluginman->get_plugins() as $type => $plugins) {
1020             foreach ($plugins as $plugin) {
1021                 if (!$plugin->is_standard()) {
1022                     $this->currentplugins[$plugin->component] = $plugin->versiondisk;
1023                 }
1024             }
1025         }
1026     }
1028     /**
1029      * Returns the list of HTTP params to be sent to the updates provider URL
1030      *
1031      * @return array of (string)param => (string)value
1032      */
1033     protected function prepare_request_params() {
1034         global $CFG;
1036         $this->load_current_environment();
1037         $this->restore_response();
1039         $params = array();
1040         $params['format'] = 'json';
1042         if (isset($this->recentresponse['ticket'])) {
1043             $params['ticket'] = $this->recentresponse['ticket'];
1044         }
1046         if (isset($this->currentversion)) {
1047             $params['version'] = $this->currentversion;
1048         } else {
1049             throw new coding_exception('Main Moodle version must be already known here');
1050         }
1052         if (isset($this->currentbranch)) {
1053             $params['branch'] = $this->currentbranch;
1054         } else {
1055             throw new coding_exception('Moodle release must be already known here');
1056         }
1058         $plugins = array();
1059         foreach ($this->currentplugins as $plugin => $version) {
1060             $plugins[] = $plugin.'@'.$version;
1061         }
1062         if (!empty($plugins)) {
1063             $params['plugins'] = implode(',', $plugins);
1064         }
1066         return $params;
1067     }
1069     /**
1070      * Returns the current timestamp
1071      *
1072      * @return int the timestamp
1073      */
1074     protected function cron_current_timestamp() {
1075         return time();
1076     }
1078     /**
1079      * Output cron debugging info
1080      *
1081      * @see mtrace()
1082      * @param string $msg output message
1083      * @param string $eol end of line
1084      */
1085     protected function cron_mtrace($msg, $eol = PHP_EOL) {
1086         mtrace($msg, $eol);
1087     }
1089     /**
1090      * Decide if the autocheck feature is disabled in the server setting
1091      *
1092      * @return bool true if autocheck enabled, false if disabled
1093      */
1094     protected function cron_autocheck_enabled() {
1095         global $CFG;
1097         if (empty($CFG->updateautocheck)) {
1098             return false;
1099         } else {
1100             return true;
1101         }
1102     }
1104     /**
1105      * Decide if the recently fetched data are still fresh enough
1106      *
1107      * @param int $now current timestamp
1108      * @return bool true if no need to re-fetch, false otherwise
1109      */
1110     protected function cron_has_fresh_fetch($now) {
1111         $recent = $this->get_last_timefetched();
1113         if (empty($recent)) {
1114             return false;
1115         }
1117         if ($now < $recent) {
1118             $this->cron_mtrace('The most recent fetch is reported to be in the future, this is weird!');
1119             return true;
1120         }
1122         if ($now - $recent > 24 * HOURSECS) {
1123             return false;
1124         }
1126         return true;
1127     }
1129     /**
1130      * Decide if the fetch is outadated or even missing
1131      *
1132      * @param int $now current timestamp
1133      * @return bool false if no need to re-fetch, true otherwise
1134      */
1135     protected function cron_has_outdated_fetch($now) {
1136         $recent = $this->get_last_timefetched();
1138         if (empty($recent)) {
1139             return true;
1140         }
1142         if ($now < $recent) {
1143             $this->cron_mtrace('The most recent fetch is reported to be in the future, this is weird!');
1144             return false;
1145         }
1147         if ($now - $recent > 48 * HOURSECS) {
1148             return true;
1149         }
1151         return false;
1152     }
1154     /**
1155      * Returns the cron execution offset for this site
1156      *
1157      * The main {@link self::cron()} is supposed to run every night in some random time
1158      * between 01:00 and 06:00 AM (local time). The exact moment is defined by so called
1159      * execution offset, that is the amount of time after 01:00 AM. The offset value is
1160      * initially generated randomly and then used consistently at the site. This way, the
1161      * regular checks against the download.moodle.org server are spread in time.
1162      *
1163      * @return int the offset number of seconds from range 1 sec to 5 hours
1164      */
1165     protected function cron_execution_offset() {
1166         global $CFG;
1168         if (empty($CFG->updatecronoffset)) {
1169             set_config('updatecronoffset', rand(1, 5 * HOURSECS));
1170         }
1172         return $CFG->updatecronoffset;
1173     }
1175     /**
1176      * Fetch available updates info and eventually send notification to site admins
1177      */
1178     protected function cron_execute() {
1180         try {
1181             $this->restore_response();
1182             $previous = $this->recentresponse;
1183             $this->fetch();
1184             $this->restore_response(true);
1185             $current = $this->recentresponse;
1186             $changes = $this->compare_responses($previous, $current);
1187             $notifications = $this->cron_notifications($changes);
1188             $this->cron_notify($notifications);
1189             $this->cron_mtrace('done');
1190         } catch (available_update_checker_exception $e) {
1191             $this->cron_mtrace('FAILED!');
1192         }
1193     }
1195     /**
1196      * Given the list of changes in available updates, pick those to send to site admins
1197      *
1198      * @param array $changes as returned by {@link self::compare_responses()}
1199      * @return array of available_update_info objects to send to site admins
1200      */
1201     protected function cron_notifications(array $changes) {
1202         global $CFG;
1204         $notifications = array();
1205         $pluginman = plugin_manager::instance();
1206         $plugins = $pluginman->get_plugins(true);
1208         foreach ($changes as $component => $componentchanges) {
1209             if (empty($componentchanges)) {
1210                 continue;
1211             }
1212             $componentupdates = $this->get_update_info($component,
1213                 array('minmaturity' => $CFG->updateminmaturity, 'notifybuilds' => $CFG->updatenotifybuilds));
1214             if (empty($componentupdates)) {
1215                 continue;
1216             }
1217             // notify only about those $componentchanges that are present in $componentupdates
1218             // to respect the preferences
1219             foreach ($componentchanges as $componentchange) {
1220                 foreach ($componentupdates as $componentupdate) {
1221                     if ($componentupdate->version == $componentchange['version']) {
1222                         if ($component == 'core') {
1223                             // in case of 'core' this is enough, we already know that the
1224                             // $componentupdate is a real update with higher version
1225                             $notifications[] = $componentupdate;
1226                         } else {
1227                             // use the plugin_manager to check if the reported $componentchange
1228                             // is a real update with higher version. such a real update must be
1229                             // present in the 'availableupdates' property of one of the component's
1230                             // available_update_info object
1231                             list($plugintype, $pluginname) = normalize_component($component);
1232                             if (!empty($plugins[$plugintype][$pluginname]->availableupdates)) {
1233                                 foreach ($plugins[$plugintype][$pluginname]->availableupdates as $availableupdate) {
1234                                     if ($availableupdate->version == $componentchange['version']) {
1235                                         $notifications[] = $componentupdate;
1236                                     }
1237                                 }
1238                             }
1239                         }
1240                     }
1241                 }
1242             }
1243         }
1245         return $notifications;
1246     }
1248     /**
1249      * Sends the given notifications to site admins via messaging API
1250      *
1251      * @param array $notifications array of available_update_info objects to send
1252      */
1253     protected function cron_notify(array $notifications) {
1254         global $CFG;
1256         if (empty($notifications)) {
1257             return;
1258         }
1260         $admins = get_admins();
1262         if (empty($admins)) {
1263             return;
1264         }
1266         $this->cron_mtrace('sending notifications ... ', '');
1268         $text = get_string('updatenotifications', 'core_admin') . PHP_EOL;
1269         $html = html_writer::tag('h1', get_string('updatenotifications', 'core_admin')) . PHP_EOL;
1271         $coreupdates = array();
1272         $pluginupdates = array();
1274         foreach ($notifications as $notification) {
1275             if ($notification->component == 'core') {
1276                 $coreupdates[] = $notification;
1277             } else {
1278                 $pluginupdates[] = $notification;
1279             }
1280         }
1282         if (!empty($coreupdates)) {
1283             $text .= PHP_EOL . get_string('updateavailable', 'core_admin') . PHP_EOL;
1284             $html .= html_writer::tag('h2', get_string('updateavailable', 'core_admin')) . PHP_EOL;
1285             $html .= html_writer::start_tag('ul') . PHP_EOL;
1286             foreach ($coreupdates as $coreupdate) {
1287                 $html .= html_writer::start_tag('li');
1288                 if (isset($coreupdate->release)) {
1289                     $text .= get_string('updateavailable_release', 'core_admin', $coreupdate->release);
1290                     $html .= html_writer::tag('strong', get_string('updateavailable_release', 'core_admin', $coreupdate->release));
1291                 }
1292                 if (isset($coreupdate->version)) {
1293                     $text .= ' '.get_string('updateavailable_version', 'core_admin', $coreupdate->version);
1294                     $html .= ' '.get_string('updateavailable_version', 'core_admin', $coreupdate->version);
1295                 }
1296                 if (isset($coreupdate->maturity)) {
1297                     $text .= ' ('.get_string('maturity'.$coreupdate->maturity, 'core_admin').')';
1298                     $html .= ' ('.get_string('maturity'.$coreupdate->maturity, 'core_admin').')';
1299                 }
1300                 $text .= PHP_EOL;
1301                 $html .= html_writer::end_tag('li') . PHP_EOL;
1302             }
1303             $text .= PHP_EOL;
1304             $html .= html_writer::end_tag('ul') . PHP_EOL;
1306             $a = array('url' => $CFG->wwwroot.'/'.$CFG->admin.'/index.php');
1307             $text .= get_string('updateavailabledetailslink', 'core_admin', $a) . PHP_EOL;
1308             $a = array('url' => html_writer::link($CFG->wwwroot.'/'.$CFG->admin.'/index.php', $CFG->wwwroot.'/'.$CFG->admin.'/index.php'));
1309             $html .= html_writer::tag('p', get_string('updateavailabledetailslink', 'core_admin', $a)) . PHP_EOL;
1310         }
1312         if (!empty($pluginupdates)) {
1313             $text .= PHP_EOL . get_string('updateavailableforplugin', 'core_admin') . PHP_EOL;
1314             $html .= html_writer::tag('h2', get_string('updateavailableforplugin', 'core_admin')) . PHP_EOL;
1316             $html .= html_writer::start_tag('ul') . PHP_EOL;
1317             foreach ($pluginupdates as $pluginupdate) {
1318                 $html .= html_writer::start_tag('li');
1319                 $text .= get_string('pluginname', $pluginupdate->component);
1320                 $html .= html_writer::tag('strong', get_string('pluginname', $pluginupdate->component));
1322                 $text .= ' ('.$pluginupdate->component.')';
1323                 $html .= ' ('.$pluginupdate->component.')';
1325                 $text .= ' '.get_string('updateavailable', 'core_plugin', $pluginupdate->version);
1326                 $html .= ' '.get_string('updateavailable', 'core_plugin', $pluginupdate->version);
1328                 $text .= PHP_EOL;
1329                 $html .= html_writer::end_tag('li') . PHP_EOL;
1330             }
1331             $text .= PHP_EOL;
1332             $html .= html_writer::end_tag('ul') . PHP_EOL;
1334             $a = array('url' => $CFG->wwwroot.'/'.$CFG->admin.'/plugins.php');
1335             $text .= get_string('updateavailabledetailslink', 'core_admin', $a) . PHP_EOL;
1336             $a = array('url' => html_writer::link($CFG->wwwroot.'/'.$CFG->admin.'/plugins.php', $CFG->wwwroot.'/'.$CFG->admin.'/plugins.php'));
1337             $html .= html_writer::tag('p', get_string('updateavailabledetailslink', 'core_admin', $a)) . PHP_EOL;
1338         }
1340         $a = array('siteurl' => $CFG->wwwroot);
1341         $text .= get_string('updatenotificationfooter', 'core_admin', $a) . PHP_EOL;
1342         $a = array('siteurl' => html_writer::link($CFG->wwwroot, $CFG->wwwroot));
1343         $html .= html_writer::tag('footer', html_writer::tag('p', get_string('updatenotificationfooter', 'core_admin', $a),
1344             array('style' => 'font-size:smaller; color:#333;')));
1346         foreach ($admins as $admin) {
1347             $message = new stdClass();
1348             $message->component         = 'moodle';
1349             $message->name              = 'availableupdate';
1350             $message->userfrom          = get_admin();
1351             $message->userto            = $admin;
1352             $message->subject           = get_string('updatenotificationsubject', 'core_admin', array('siteurl' => $CFG->wwwroot));
1353             $message->fullmessage       = $text;
1354             $message->fullmessageformat = FORMAT_PLAIN;
1355             $message->fullmessagehtml   = $html;
1356             $message->smallmessage      = get_string('updatenotifications', 'core_admin');
1357             $message->notification      = 1;
1358             message_send($message);
1359         }
1360     }
1362     /**
1363      * Compare two release labels and decide if they are the same
1364      *
1365      * @param string $remote release info of the available update
1366      * @param null|string $local release info of the local code, defaults to $release defined in version.php
1367      * @return boolean true if the releases declare the same minor+major version
1368      */
1369     protected function is_same_release($remote, $local=null) {
1371         if (is_null($local)) {
1372             $this->load_current_environment();
1373             $local = $this->currentrelease;
1374         }
1376         $pattern = '/^([0-9\.\+]+)([^(]*)/';
1378         preg_match($pattern, $remote, $remotematches);
1379         preg_match($pattern, $local, $localmatches);
1381         $remotematches[1] = str_replace('+', '', $remotematches[1]);
1382         $localmatches[1] = str_replace('+', '', $localmatches[1]);
1384         if ($remotematches[1] === $localmatches[1] and rtrim($remotematches[2]) === rtrim($localmatches[2])) {
1385             return true;
1386         } else {
1387             return false;
1388         }
1389     }
1393 /**
1394  * Defines the structure of objects returned by {@link available_update_checker::get_update_info()}
1395  */
1396 class available_update_info {
1398     /** @var string frankenstyle component name */
1399     public $component;
1400     /** @var int the available version of the component */
1401     public $version;
1402     /** @var string|null optional release name */
1403     public $release = null;
1404     /** @var int|null optional maturity info, eg {@link MATURITY_STABLE} */
1405     public $maturity = null;
1406     /** @var string|null optional URL of a page with more info about the update */
1407     public $url = null;
1408     /** @var string|null optional URL of a ZIP package that can be downloaded and installed */
1409     public $download = null;
1410     /** @var string|null of self::download is set, then this must be the MD5 hash of the ZIP */
1411     public $downloadmd5 = null;
1413     /**
1414      * Creates new instance of the class
1415      *
1416      * The $info array must provide at least the 'version' value and optionally all other
1417      * values to populate the object's properties.
1418      *
1419      * @param string $name the frankenstyle component name
1420      * @param array $info associative array with other properties
1421      */
1422     public function __construct($name, array $info) {
1423         $this->component = $name;
1424         foreach ($info as $k => $v) {
1425             if (property_exists('available_update_info', $k) and $k != 'component') {
1426                 $this->$k = $v;
1427             }
1428         }
1429     }
1433 /**
1434  * Implements a communication bridge to the mdeploy.php utility
1435  */
1436 class available_update_deployer {
1438     const HTTP_PARAM_PREFIX     = 'updteautodpldata_';  // Hey, even Google has not heard of such a prefix! So it MUST be safe :-p
1439     const HTTP_PARAM_CHECKER    = 'datapackagesize';    // Name of the parameter that holds the number of items in the received data items
1441     /** @var available_update_deployer holds the singleton instance */
1442     protected static $singletoninstance;
1443     /** @var moodle_url URL of a page that includes the deployer UI */
1444     protected $callerurl;
1445     /** @var moodle_url URL to return after the deployment */
1446     protected $returnurl;
1448     /**
1449      * Direct instantiation not allowed, use the factory method {@link self::instance()}
1450      */
1451     protected function __construct() {
1452     }
1454     /**
1455      * Sorry, this is singleton
1456      */
1457     protected function __clone() {
1458     }
1460     /**
1461      * Factory method for this class
1462      *
1463      * @return available_update_deployer the singleton instance
1464      */
1465     public static function instance() {
1466         if (is_null(self::$singletoninstance)) {
1467             self::$singletoninstance = new self();
1468         }
1469         return self::$singletoninstance;
1470     }
1472     /**
1473      * Reset caches used by this script
1474      *
1475      * @param bool $phpunitreset is this called as a part of PHPUnit reset?
1476      */
1477     public static function reset_caches($phpunitreset = false) {
1478         if ($phpunitreset) {
1479             self::$singletoninstance = null;
1480         }
1481     }
1483     /**
1484      * Is automatic deployment enabled?
1485      *
1486      * @return bool
1487      */
1488     public function enabled() {
1489         global $CFG;
1491         if (!empty($CFG->disableupdateautodeploy)) {
1492             // The feature is prohibited via config.php
1493             return false;
1494         }
1496         return get_config('updateautodeploy');
1497     }
1499     /**
1500      * Sets some base properties of the class to make it usable.
1501      *
1502      * @param moodle_url $callerurl the base URL of a script that will handle the class'es form data
1503      * @param moodle_url $returnurl the final URL to return to when the deployment is finished
1504      */
1505     public function initialize(moodle_url $callerurl, moodle_url $returnurl) {
1507         if (!$this->enabled()) {
1508             throw new coding_exception('Unable to initialize the deployer, the feature is not enabled.');
1509         }
1511         $this->callerurl = $callerurl;
1512         $this->returnurl = $returnurl;
1513     }
1515     /**
1516      * Has the deployer been initialized?
1517      *
1518      * Initialized deployer means that the following properties were set:
1519      * callerurl, returnurl
1520      *
1521      * @return bool
1522      */
1523     public function initialized() {
1525         if (!$this->enabled()) {
1526             return false;
1527         }
1529         if (empty($this->callerurl)) {
1530             return false;
1531         }
1533         if (empty($this->returnurl)) {
1534             return false;
1535         }
1537         return true;
1538     }
1540     /**
1541      * Returns a list of reasons why the deployment can not happen
1542      *
1543      * If the returned array is empty, the deployment seems to be possible. The returned
1544      * structure is an associative array with keys representing individual impediments.
1545      * Possible keys are: missingdownloadurl, missingdownloadmd5, notwritable.
1546      *
1547      * @param available_update_info $info
1548      * @return array
1549      */
1550     public function deployment_impediments(available_update_info $info) {
1552         $impediments = array();
1554         if (empty($info->download)) {
1555             $impediments['missingdownloadurl'] = true;
1556         }
1558         if (empty($info->downloadmd5)) {
1559             $impediments['missingdownloadmd5'] = true;
1560         }
1562         if (!$this->component_writable($info->component)) {
1563             $impediments['notwritable'] = true;
1564         }
1566         return $impediments;
1567     }
1569     /**
1570      * Check to see if the current version of the plugin seems to be a checkout of an external repository.
1571      *
1572      * @param available_update_info $info
1573      * @return false|string
1574      */
1575     public function plugin_external_source(available_update_info $info) {
1577         $paths = get_plugin_types(true);
1578         list($plugintype, $pluginname) = normalize_component($info->component);
1579         $pluginroot = $paths[$plugintype].'/'.$pluginname;
1581         if (is_dir($pluginroot.'/.git')) {
1582             return 'git';
1583         }
1585         if (is_dir($pluginroot.'/CVS')) {
1586             return 'cvs';
1587         }
1589         if (is_dir($pluginroot.'/.svn')) {
1590             return 'svn';
1591         }
1593         return false;
1594     }
1596     /**
1597      * Prepares a renderable widget to confirm installation of an available update.
1598      *
1599      * @param available_update_info $info component version to deploy
1600      * @return renderable
1601      */
1602     public function make_confirm_widget(available_update_info $info) {
1604         if (!$this->initialized()) {
1605             throw new coding_exception('Illegal method call - deployer not initialized.');
1606         }
1608         $params = $this->data_to_params(array(
1609             'updateinfo' => (array)$info,   // see http://www.php.net/manual/en/language.types.array.php#language.types.array.casting
1610         ));
1612         $widget = new single_button(
1613             new moodle_url($this->callerurl, $params),
1614             get_string('updateavailableinstall', 'core_admin'),
1615             'post'
1616         );
1618         return $widget;
1619     }
1621     /**
1622      * Prepares a renderable widget to execute installation of an available update.
1623      *
1624      * @param available_update_info $info component version to deploy
1625      * @return renderable
1626      */
1627     public function make_execution_widget(available_update_info $info) {
1628         global $CFG;
1630         if (!$this->initialized()) {
1631             throw new coding_exception('Illegal method call - deployer not initialized.');
1632         }
1634         $pluginrootpaths = get_plugin_types(true);
1636         list($plugintype, $pluginname) = normalize_component($info->component);
1638         if (empty($pluginrootpaths[$plugintype])) {
1639             throw new coding_exception('Unknown plugin type root location', $plugintype);
1640         }
1642         list($passfile, $password) = $this->prepare_authorization();
1644         $upgradeurl = new moodle_url('/admin');
1646         $params = array(
1647             'upgrade' => true,
1648             'type' => $plugintype,
1649             'name' => $pluginname,
1650             'typeroot' => $pluginrootpaths[$plugintype],
1651             'package' => $info->download,
1652             'md5' => $info->downloadmd5,
1653             'dataroot' => $CFG->dataroot,
1654             'dirroot' => $CFG->dirroot,
1655             'passfile' => $passfile,
1656             'password' => $password,
1657             'returnurl' => $upgradeurl->out(true),
1658         );
1660         $widget = new single_button(
1661             new moodle_url('/mdeploy.php', $params),
1662             get_string('updateavailableinstall', 'core_admin'),
1663             'post'
1664         );
1666         return $widget;
1667     }
1669     /**
1670      * Returns array of data objects passed to this tool.
1671      *
1672      * @return array
1673      */
1674     public function submitted_data() {
1676         $data = $this->params_to_data($_POST);
1678         if (empty($data) or empty($data[self::HTTP_PARAM_CHECKER])) {
1679             return false;
1680         }
1682         if (!empty($data['updateinfo']) and is_object($data['updateinfo'])) {
1683             $updateinfo = $data['updateinfo'];
1684             if (!empty($updateinfo->component) and !empty($updateinfo->version)) {
1685                 $data['updateinfo'] = new available_update_info($updateinfo->component, (array)$updateinfo);
1686             }
1687         }
1689         if (!empty($data['callerurl'])) {
1690             $data['callerurl'] = new moodle_url($data['callerurl']);
1691         }
1693         if (!empty($data['returnurl'])) {
1694             $data['returnurl'] = new moodle_url($data['returnurl']);
1695         }
1697         return $data;
1698     }
1700     /**
1701      * Handles magic getters and setters for protected properties.
1702      *
1703      * @param string $name method name, e.g. set_returnurl()
1704      * @param array $arguments arguments to be passed to the array
1705      */
1706     public function __call($name, array $arguments = array()) {
1708         if (substr($name, 0, 4) === 'set_') {
1709             $property = substr($name, 4);
1710             if (empty($property)) {
1711                 throw new coding_exception('Invalid property name (empty)');
1712             }
1713             if (empty($arguments)) {
1714                 $arguments = array(true); // Default value for flag-like properties.
1715             }
1716             // Make sure it is a protected property.
1717             $isprotected = false;
1718             $reflection = new ReflectionObject($this);
1719             foreach ($reflection->getProperties(ReflectionProperty::IS_PROTECTED) as $reflectionproperty) {
1720                 if ($reflectionproperty->getName() === $property) {
1721                     $isprotected = true;
1722                     break;
1723                 }
1724             }
1725             if (!$isprotected) {
1726                 throw new coding_exception('Unable to set property - it does not exist or it is not protected');
1727             }
1728             $value = reset($arguments);
1729             $this->$property = $value;
1730             return;
1731         }
1733         if (substr($name, 0, 4) === 'get_') {
1734             $property = substr($name, 4);
1735             if (empty($property)) {
1736                 throw new coding_exception('Invalid property name (empty)');
1737             }
1738             if (!empty($arguments)) {
1739                 throw new coding_exception('No parameter expected');
1740             }
1741             // Make sure it is a protected property.
1742             $isprotected = false;
1743             $reflection = new ReflectionObject($this);
1744             foreach ($reflection->getProperties(ReflectionProperty::IS_PROTECTED) as $reflectionproperty) {
1745                 if ($reflectionproperty->getName() === $property) {
1746                     $isprotected = true;
1747                     break;
1748                 }
1749             }
1750             if (!$isprotected) {
1751                 throw new coding_exception('Unable to get property - it does not exist or it is not protected');
1752             }
1753             return $this->$property;
1754         }
1755     }
1757     /**
1758      * Generates a random token and stores it in a file in moodledata directory.
1759      *
1760      * @return array of the (string)filename and (string)password in this order
1761      */
1762     public function prepare_authorization() {
1763         global $CFG;
1765         make_upload_directory('mdeploy/auth/');
1767         $attempts = 0;
1768         $success = false;
1770         while (!$success and $attempts < 5) {
1771             $attempts++;
1773             $passfile = $this->generate_passfile();
1774             $password = $this->generate_password();
1775             $now = time();
1777             $filepath = $CFG->dataroot.'/mdeploy/auth/'.$passfile;
1779             if (!file_exists($filepath)) {
1780                 $success = file_put_contents($filepath, $password . PHP_EOL . $now . PHP_EOL, LOCK_EX);
1781             }
1782         }
1784         if ($success) {
1785             return array($passfile, $password);
1787         } else {
1788             throw new moodle_exception('unable_prepare_authorization', 'core_plugin');
1789         }
1790     }
1792     // End of external API
1794     /**
1795      * Prepares an array of HTTP parameters that can be passed to another page.
1796      *
1797      * @param array|object $data associative array or an object holding the data, data JSON-able
1798      * @return array suitable as a param for moodle_url
1799      */
1800     protected function data_to_params($data) {
1802         // Append some our own data
1803         if (!empty($this->callerurl)) {
1804             $data['callerurl'] = $this->callerurl->out(false);
1805         }
1806         if (!empty($this->callerurl)) {
1807             $data['returnurl'] = $this->returnurl->out(false);
1808         }
1810         // Finally append the count of items in the package.
1811         $data[self::HTTP_PARAM_CHECKER] = count($data);
1813         // Generate params
1814         $params = array();
1815         foreach ($data as $name => $value) {
1816             $transname = self::HTTP_PARAM_PREFIX.$name;
1817             $transvalue = json_encode($value);
1818             $params[$transname] = $transvalue;
1819         }
1821         return $params;
1822     }
1824     /**
1825      * Converts HTTP parameters passed to the script into native PHP data
1826      *
1827      * @param array $params such as $_REQUEST or $_POST
1828      * @return array data passed for this class
1829      */
1830     protected function params_to_data(array $params) {
1832         if (empty($params)) {
1833             return array();
1834         }
1836         $data = array();
1837         foreach ($params as $name => $value) {
1838             if (strpos($name, self::HTTP_PARAM_PREFIX) === 0) {
1839                 $realname = substr($name, strlen(self::HTTP_PARAM_PREFIX));
1840                 $realvalue = json_decode($value);
1841                 $data[$realname] = $realvalue;
1842             }
1843         }
1845         return $data;
1846     }
1848     /**
1849      * Returns a random string to be used as a filename of the password storage.
1850      *
1851      * @return string
1852      */
1853     protected function generate_passfile() {
1854         return clean_param(uniqid('mdeploy_', true), PARAM_FILE);
1855     }
1857     /**
1858      * Returns a random string to be used as the authorization token
1859      *
1860      * @return string
1861      */
1862     protected function generate_password() {
1863         return complex_random_string();
1864     }
1866     /**
1867      * Checks if the given component's directory is writable
1868      *
1869      * For the purpose of the deployment, the web server process has to have
1870      * write access to all files in the component's directory (recursively) and for the
1871      * directory itself.
1872      *
1873      * @see worker::move_directory_source_precheck()
1874      * @param string $component normalized component name
1875      * @return boolean
1876      */
1877     protected function component_writable($component) {
1879         list($plugintype, $pluginname) = normalize_component($component);
1881         $directory = get_plugin_directory($plugintype, $pluginname);
1883         if (is_null($directory)) {
1884             throw new coding_exception('Unknown component location', $component);
1885         }
1887         return $this->directory_writable($directory);
1888     }
1890     /**
1891      * Checks if the directory and all its contents (recursively) is writable
1892      *
1893      * @param string $path full path to a directory
1894      * @return boolean
1895      */
1896     private function directory_writable($path) {
1898         if (!is_writable($path)) {
1899             return false;
1900         }
1902         if (is_dir($path)) {
1903             $handle = opendir($path);
1904         } else {
1905             return false;
1906         }
1908         $result = true;
1910         while ($filename = readdir($handle)) {
1911             $filepath = $path.'/'.$filename;
1913             if ($filename === '.' or $filename === '..') {
1914                 continue;
1915             }
1917             if (is_dir($filepath)) {
1918                 $result = $result && $this->directory_writable($filepath);
1920             } else {
1921                 $result = $result && is_writable($filepath);
1922             }
1923         }
1925         closedir($handle);
1927         return $result;
1928     }
1932 /**
1933  * Factory class producing required subclasses of {@link plugininfo_base}
1934  */
1935 class plugininfo_default_factory {
1937     /**
1938      * Makes a new instance of the plugininfo class
1939      *
1940      * @param string $type the plugin type, eg. 'mod'
1941      * @param string $typerootdir full path to the location of all the plugins of this type
1942      * @param string $name the plugin name, eg. 'workshop'
1943      * @param string $namerootdir full path to the location of the plugin
1944      * @param string $typeclass the name of class that holds the info about the plugin
1945      * @return plugininfo_base the instance of $typeclass
1946      */
1947     public static function make($type, $typerootdir, $name, $namerootdir, $typeclass) {
1948         $plugin              = new $typeclass();
1949         $plugin->type        = $type;
1950         $plugin->typerootdir = $typerootdir;
1951         $plugin->name        = $name;
1952         $plugin->rootdir     = $namerootdir;
1954         $plugin->init_display_name();
1955         $plugin->load_disk_version();
1956         $plugin->load_db_version();
1957         $plugin->load_required_main_version();
1958         $plugin->init_is_standard();
1960         return $plugin;
1961     }
1965 /**
1966  * Base class providing access to the information about a plugin
1967  *
1968  * @property-read string component the component name, type_name
1969  */
1970 abstract class plugininfo_base {
1972     /** @var string the plugintype name, eg. mod, auth or workshopform */
1973     public $type;
1974     /** @var string full path to the location of all the plugins of this type */
1975     public $typerootdir;
1976     /** @var string the plugin name, eg. assignment, ldap */
1977     public $name;
1978     /** @var string the localized plugin name */
1979     public $displayname;
1980     /** @var string the plugin source, one of plugin_manager::PLUGIN_SOURCE_xxx constants */
1981     public $source;
1982     /** @var fullpath to the location of this plugin */
1983     public $rootdir;
1984     /** @var int|string the version of the plugin's source code */
1985     public $versiondisk;
1986     /** @var int|string the version of the installed plugin */
1987     public $versiondb;
1988     /** @var int|float|string required version of Moodle core  */
1989     public $versionrequires;
1990     /** @var array other plugins that this one depends on, lazy-loaded by {@link get_other_required_plugins()} */
1991     public $dependencies;
1992     /** @var int number of instances of the plugin - not supported yet */
1993     public $instances;
1994     /** @var int order of the plugin among other plugins of the same type - not supported yet */
1995     public $sortorder;
1996     /** @var array|null array of {@link available_update_info} for this plugin */
1997     public $availableupdates;
1999     /**
2000      * Gathers and returns the information about all plugins of the given type
2001      *
2002      * @param string $type the name of the plugintype, eg. mod, auth or workshopform
2003      * @param string $typerootdir full path to the location of the plugin dir
2004      * @param string $typeclass the name of the actually called class
2005      * @return array of plugintype classes, indexed by the plugin name
2006      */
2007     public static function get_plugins($type, $typerootdir, $typeclass) {
2009         // get the information about plugins at the disk
2010         $plugins = get_plugin_list($type);
2011         $ondisk = array();
2012         foreach ($plugins as $pluginname => $pluginrootdir) {
2013             $ondisk[$pluginname] = plugininfo_default_factory::make($type, $typerootdir,
2014                 $pluginname, $pluginrootdir, $typeclass);
2015         }
2016         return $ondisk;
2017     }
2019     /**
2020      * Sets {@link $displayname} property to a localized name of the plugin
2021      */
2022     public function init_display_name() {
2023         if (!get_string_manager()->string_exists('pluginname', $this->component)) {
2024             $this->displayname = '[pluginname,' . $this->component . ']';
2025         } else {
2026             $this->displayname = get_string('pluginname', $this->component);
2027         }
2028     }
2030     /**
2031      * Magic method getter, redirects to read only values.
2032      *
2033      * @param string $name
2034      * @return mixed
2035      */
2036     public function __get($name) {
2037         switch ($name) {
2038             case 'component': return $this->type . '_' . $this->name;
2040             default:
2041                 debugging('Invalid plugin property accessed! '.$name);
2042                 return null;
2043         }
2044     }
2046     /**
2047      * Return the full path name of a file within the plugin.
2048      *
2049      * No check is made to see if the file exists.
2050      *
2051      * @param string $relativepath e.g. 'version.php'.
2052      * @return string e.g. $CFG->dirroot . '/mod/quiz/version.php'.
2053      */
2054     public function full_path($relativepath) {
2055         if (empty($this->rootdir)) {
2056             return '';
2057         }
2058         return $this->rootdir . '/' . $relativepath;
2059     }
2061     /**
2062      * Load the data from version.php.
2063      *
2064      * @return stdClass the object called $plugin defined in version.php
2065      */
2066     protected function load_version_php() {
2067         $versionfile = $this->full_path('version.php');
2069         $plugin = new stdClass();
2070         if (is_readable($versionfile)) {
2071             include($versionfile);
2072         }
2073         return $plugin;
2074     }
2076     /**
2077      * Sets {@link $versiondisk} property to a numerical value representing the
2078      * version of the plugin's source code.
2079      *
2080      * If the value is null after calling this method, either the plugin
2081      * does not use versioning (typically does not have any database
2082      * data) or is missing from disk.
2083      */
2084     public function load_disk_version() {
2085         $plugin = $this->load_version_php();
2086         if (isset($plugin->version)) {
2087             $this->versiondisk = $plugin->version;
2088         }
2089     }
2091     /**
2092      * Sets {@link $versionrequires} property to a numerical value representing
2093      * the version of Moodle core that this plugin requires.
2094      */
2095     public function load_required_main_version() {
2096         $plugin = $this->load_version_php();
2097         if (isset($plugin->requires)) {
2098             $this->versionrequires = $plugin->requires;
2099         }
2100     }
2102     /**
2103      * Initialise {@link $dependencies} to the list of other plugins (in any)
2104      * that this one requires to be installed.
2105      */
2106     protected function load_other_required_plugins() {
2107         $plugin = $this->load_version_php();
2108         if (!empty($plugin->dependencies)) {
2109             $this->dependencies = $plugin->dependencies;
2110         } else {
2111             $this->dependencies = array(); // By default, no dependencies.
2112         }
2113     }
2115     /**
2116      * Get the list of other plugins that this plugin requires to be installed.
2117      *
2118      * @return array with keys the frankenstyle plugin name, and values either
2119      *      a version string (like '2011101700') or the constant ANY_VERSION.
2120      */
2121     public function get_other_required_plugins() {
2122         if (is_null($this->dependencies)) {
2123             $this->load_other_required_plugins();
2124         }
2125         return $this->dependencies;
2126     }
2128     /**
2129      * Sets {@link $versiondb} property to a numerical value representing the
2130      * currently installed version of the plugin.
2131      *
2132      * If the value is null after calling this method, either the plugin
2133      * does not use versioning (typically does not have any database
2134      * data) or has not been installed yet.
2135      */
2136     public function load_db_version() {
2137         if ($ver = self::get_version_from_config_plugins($this->component)) {
2138             $this->versiondb = $ver;
2139         }
2140     }
2142     /**
2143      * Sets {@link $source} property to one of plugin_manager::PLUGIN_SOURCE_xxx
2144      * constants.
2145      *
2146      * If the property's value is null after calling this method, then
2147      * the type of the plugin has not been recognized and you should throw
2148      * an exception.
2149      */
2150     public function init_is_standard() {
2152         $standard = plugin_manager::standard_plugins_list($this->type);
2154         if ($standard !== false) {
2155             $standard = array_flip($standard);
2156             if (isset($standard[$this->name])) {
2157                 $this->source = plugin_manager::PLUGIN_SOURCE_STANDARD;
2158             } else if (!is_null($this->versiondb) and is_null($this->versiondisk)
2159                     and plugin_manager::is_deleted_standard_plugin($this->type, $this->name)) {
2160                 $this->source = plugin_manager::PLUGIN_SOURCE_STANDARD; // to be deleted
2161             } else {
2162                 $this->source = plugin_manager::PLUGIN_SOURCE_EXTENSION;
2163             }
2164         }
2165     }
2167     /**
2168      * Returns true if the plugin is shipped with the official distribution
2169      * of the current Moodle version, false otherwise.
2170      *
2171      * @return bool
2172      */
2173     public function is_standard() {
2174         return $this->source === plugin_manager::PLUGIN_SOURCE_STANDARD;
2175     }
2177     /**
2178      * Returns true if the the given Moodle version is enough to run this plugin
2179      *
2180      * @param string|int|double $moodleversion
2181      * @return bool
2182      */
2183     public function is_core_dependency_satisfied($moodleversion) {
2185         if (empty($this->versionrequires)) {
2186             return true;
2188         } else {
2189             return (double)$this->versionrequires <= (double)$moodleversion;
2190         }
2191     }
2193     /**
2194      * Returns the status of the plugin
2195      *
2196      * @return string one of plugin_manager::PLUGIN_STATUS_xxx constants
2197      */
2198     public function get_status() {
2200         if (is_null($this->versiondb) and is_null($this->versiondisk)) {
2201             return plugin_manager::PLUGIN_STATUS_NODB;
2203         } else if (is_null($this->versiondb) and !is_null($this->versiondisk)) {
2204             return plugin_manager::PLUGIN_STATUS_NEW;
2206         } else if (!is_null($this->versiondb) and is_null($this->versiondisk)) {
2207             if (plugin_manager::is_deleted_standard_plugin($this->type, $this->name)) {
2208                 return plugin_manager::PLUGIN_STATUS_DELETE;
2209             } else {
2210                 return plugin_manager::PLUGIN_STATUS_MISSING;
2211             }
2213         } else if ((string)$this->versiondb === (string)$this->versiondisk) {
2214             return plugin_manager::PLUGIN_STATUS_UPTODATE;
2216         } else if ($this->versiondb < $this->versiondisk) {
2217             return plugin_manager::PLUGIN_STATUS_UPGRADE;
2219         } else if ($this->versiondb > $this->versiondisk) {
2220             return plugin_manager::PLUGIN_STATUS_DOWNGRADE;
2222         } else {
2223             // $version = pi(); and similar funny jokes - hopefully Donald E. Knuth will never contribute to Moodle ;-)
2224             throw new coding_exception('Unable to determine plugin state, check the plugin versions');
2225         }
2226     }
2228     /**
2229      * Returns the information about plugin availability
2230      *
2231      * True means that the plugin is enabled. False means that the plugin is
2232      * disabled. Null means that the information is not available, or the
2233      * plugin does not support configurable availability or the availability
2234      * can not be changed.
2235      *
2236      * @return null|bool
2237      */
2238     public function is_enabled() {
2239         return null;
2240     }
2242     /**
2243      * Populates the property {@link $availableupdates} with the information provided by
2244      * available update checker
2245      *
2246      * @param available_update_checker $provider the class providing the available update info
2247      */
2248     public function check_available_updates(available_update_checker $provider) {
2249         global $CFG;
2251         if (isset($CFG->updateminmaturity)) {
2252             $minmaturity = $CFG->updateminmaturity;
2253         } else {
2254             // this can happen during the very first upgrade to 2.3
2255             $minmaturity = MATURITY_STABLE;
2256         }
2258         $this->availableupdates = $provider->get_update_info($this->component,
2259             array('minmaturity' => $minmaturity));
2260     }
2262     /**
2263      * If there are updates for this plugin available, returns them.
2264      *
2265      * Returns array of {@link available_update_info} objects, if some update
2266      * is available. Returns null if there is no update available or if the update
2267      * availability is unknown.
2268      *
2269      * @return array|null
2270      */
2271     public function available_updates() {
2273         if (empty($this->availableupdates) or !is_array($this->availableupdates)) {
2274             return null;
2275         }
2277         $updates = array();
2279         foreach ($this->availableupdates as $availableupdate) {
2280             if ($availableupdate->version > $this->versiondisk) {
2281                 $updates[] = $availableupdate;
2282             }
2283         }
2285         if (empty($updates)) {
2286             return null;
2287         }
2289         return $updates;
2290     }
2292     /**
2293      * Returns the node name used in admin settings menu for this plugin settings (if applicable)
2294      *
2295      * @return null|string node name or null if plugin does not create settings node (default)
2296      */
2297     public function get_settings_section_name() {
2298         return null;
2299     }
2301     /**
2302      * Returns the URL of the plugin settings screen
2303      *
2304      * Null value means that the plugin either does not have the settings screen
2305      * or its location is not available via this library.
2306      *
2307      * @return null|moodle_url
2308      */
2309     public function get_settings_url() {
2310         $section = $this->get_settings_section_name();
2311         if ($section === null) {
2312             return null;
2313         }
2314         $settings = admin_get_root()->locate($section);
2315         if ($settings && $settings instanceof admin_settingpage) {
2316             return new moodle_url('/admin/settings.php', array('section' => $section));
2317         } else if ($settings && $settings instanceof admin_externalpage) {
2318             return new moodle_url($settings->url);
2319         } else {
2320             return null;
2321         }
2322     }
2324     /**
2325      * Loads plugin settings to the settings tree
2326      *
2327      * This function usually includes settings.php file in plugins folder.
2328      * Alternatively it can create a link to some settings page (instance of admin_externalpage)
2329      *
2330      * @param part_of_admin_tree $adminroot
2331      * @param string $parentnodename
2332      * @param bool $hassiteconfig whether the current user has moodle/site:config capability
2333      */
2334     public function load_settings(part_of_admin_tree $adminroot, $parentnodename, $hassiteconfig) {
2335     }
2337     /**
2338      * Returns the URL of the screen where this plugin can be uninstalled
2339      *
2340      * Visiting that URL must be safe, that is a manual confirmation is needed
2341      * for actual uninstallation of the plugin. Null value means that the
2342      * plugin either does not support uninstallation, or does not require any
2343      * database cleanup or the location of the screen is not available via this
2344      * library.
2345      *
2346      * @return null|moodle_url
2347      */
2348     public function get_uninstall_url() {
2349         return null;
2350     }
2352     /**
2353      * Returns relative directory of the plugin with heading '/'
2354      *
2355      * @return string
2356      */
2357     public function get_dir() {
2358         global $CFG;
2360         return substr($this->rootdir, strlen($CFG->dirroot));
2361     }
2363     /**
2364      * Provides access to plugin versions from {config_plugins}
2365      *
2366      * @param string $plugin plugin name
2367      * @param double $disablecache optional, defaults to false
2368      * @return int|false the stored value or false if not found
2369      */
2370     protected function get_version_from_config_plugins($plugin, $disablecache=false) {
2371         global $DB;
2372         static $pluginversions = null;
2374         if (is_null($pluginversions) or $disablecache) {
2375             try {
2376                 $pluginversions = $DB->get_records_menu('config_plugins', array('name' => 'version'), 'plugin', 'plugin,value');
2377             } catch (dml_exception $e) {
2378                 // before install
2379                 $pluginversions = array();
2380             }
2381         }
2383         if (!array_key_exists($plugin, $pluginversions)) {
2384             return false;
2385         }
2387         return $pluginversions[$plugin];
2388     }
2392 /**
2393  * General class for all plugin types that do not have their own class
2394  */
2395 class plugininfo_general extends plugininfo_base {
2399 /**
2400  * Class for page side blocks
2401  */
2402 class plugininfo_block extends plugininfo_base {
2404     public static function get_plugins($type, $typerootdir, $typeclass) {
2406         // get the information about blocks at the disk
2407         $blocks = parent::get_plugins($type, $typerootdir, $typeclass);
2409         // add blocks missing from disk
2410         $blocksinfo = self::get_blocks_info();
2411         foreach ($blocksinfo as $blockname => $blockinfo) {
2412             if (isset($blocks[$blockname])) {
2413                 continue;
2414             }
2415             $plugin                 = new $typeclass();
2416             $plugin->type           = $type;
2417             $plugin->typerootdir    = $typerootdir;
2418             $plugin->name           = $blockname;
2419             $plugin->rootdir        = null;
2420             $plugin->displayname    = $blockname;
2421             $plugin->versiondb      = $blockinfo->version;
2422             $plugin->init_is_standard();
2424             $blocks[$blockname]   = $plugin;
2425         }
2427         return $blocks;
2428     }
2430     /**
2431      * Magic method getter, redirects to read only values.
2432      *
2433      * For block plugins pretends the object has 'visible' property for compatibility
2434      * with plugins developed for Moodle version below 2.4
2435      *
2436      * @param string $name
2437      * @return mixed
2438      */
2439     public function __get($name) {
2440         if ($name === 'visible') {
2441             debugging('This is now an instance of plugininfo_block, please use $block->is_enabled() instead of $block->visible', DEBUG_DEVELOPER);
2442             return ($this->is_enabled() !== false);
2443         }
2444         return parent::__get($name);
2445     }
2447     public function init_display_name() {
2449         if (get_string_manager()->string_exists('pluginname', 'block_' . $this->name)) {
2450             $this->displayname = get_string('pluginname', 'block_' . $this->name);
2452         } else if (($block = block_instance($this->name)) !== false) {
2453             $this->displayname = $block->get_title();
2455         } else {
2456             parent::init_display_name();
2457         }
2458     }
2460     public function load_db_version() {
2461         global $DB;
2463         $blocksinfo = self::get_blocks_info();
2464         if (isset($blocksinfo[$this->name]->version)) {
2465             $this->versiondb = $blocksinfo[$this->name]->version;
2466         }
2467     }
2469     public function is_enabled() {
2471         $blocksinfo = self::get_blocks_info();
2472         if (isset($blocksinfo[$this->name]->visible)) {
2473             if ($blocksinfo[$this->name]->visible) {
2474                 return true;
2475             } else {
2476                 return false;
2477             }
2478         } else {
2479             return parent::is_enabled();
2480         }
2481     }
2483     public function get_settings_section_name() {
2484         return 'blocksetting' . $this->name;
2485     }
2487     public function load_settings(part_of_admin_tree $adminroot, $parentnodename, $hassiteconfig) {
2488         global $CFG, $USER, $DB, $OUTPUT, $PAGE; // in case settings.php wants to refer to them
2489         $ADMIN = $adminroot; // may be used in settings.php
2490         $block = $this; // also can be used inside settings.php
2491         $section = $this->get_settings_section_name();
2493         if (!$hassiteconfig || (($blockinstance = block_instance($this->name)) === false)) {
2494             return;
2495         }
2497         $settings = null;
2498         if ($blockinstance->has_config()) {
2499             if (file_exists($this->full_path('settings.php'))) {
2500                 $settings = new admin_settingpage($section, $this->displayname,
2501                         'moodle/site:config', $this->is_enabled() === false);
2502                 include($this->full_path('settings.php')); // this may also set $settings to null
2503             } else {
2504                 $blocksinfo = self::get_blocks_info();
2505                 $settingsurl = new moodle_url('/admin/block.php', array('block' => $blocksinfo[$this->name]->id));
2506                 $settings = new admin_externalpage($section, $this->displayname,
2507                         $settingsurl, 'moodle/site:config', $this->is_enabled() === false);
2508             }
2509         }
2510         if ($settings) {
2511             $ADMIN->add($parentnodename, $settings);
2512         }
2513     }
2515     public function get_uninstall_url() {
2517         $blocksinfo = self::get_blocks_info();
2518         return new moodle_url('/admin/blocks.php', array('delete' => $blocksinfo[$this->name]->id, 'sesskey' => sesskey()));
2519     }
2521     /**
2522      * Provides access to the records in {block} table
2523      *
2524      * @param bool $disablecache do not use internal static cache
2525      * @return array array of stdClasses
2526      */
2527     protected static function get_blocks_info($disablecache=false) {
2528         global $DB;
2529         static $blocksinfocache = null;
2531         if (is_null($blocksinfocache) or $disablecache) {
2532             try {
2533                 $blocksinfocache = $DB->get_records('block', null, 'name', 'name,id,version,visible');
2534             } catch (dml_exception $e) {
2535                 // before install
2536                 $blocksinfocache = array();
2537             }
2538         }
2540         return $blocksinfocache;
2541     }
2545 /**
2546  * Class for text filters
2547  */
2548 class plugininfo_filter extends plugininfo_base {
2550     public static function get_plugins($type, $typerootdir, $typeclass) {
2551         global $CFG, $DB;
2553         $filters = array();
2555         // get the list of filters from both /filter and /mod location
2556         $installed = filter_get_all_installed();
2558         foreach ($installed as $filterlegacyname => $displayname) {
2559             $plugin                 = new $typeclass();
2560             $plugin->type           = $type;
2561             $plugin->typerootdir    = $typerootdir;
2562             $plugin->name           = self::normalize_legacy_name($filterlegacyname);
2563             $plugin->rootdir        = $CFG->dirroot . '/' . $filterlegacyname;
2564             $plugin->displayname    = $displayname;
2566             $plugin->load_disk_version();
2567             $plugin->load_db_version();
2568             $plugin->load_required_main_version();
2569             $plugin->init_is_standard();
2571             $filters[$plugin->name] = $plugin;
2572         }
2574         $globalstates = self::get_global_states();
2576         if ($DB->get_manager()->table_exists('filter_active')) {
2577             // if we're upgrading from 1.9, the table does not exist yet
2578             // if it does, make sure that all installed filters are registered
2579             $needsreload  = false;
2580             foreach (array_keys($installed) as $filterlegacyname) {
2581                 if (!isset($globalstates[self::normalize_legacy_name($filterlegacyname)])) {
2582                     filter_set_global_state($filterlegacyname, TEXTFILTER_DISABLED);
2583                     $needsreload = true;
2584                 }
2585             }
2586             if ($needsreload) {
2587                 $globalstates = self::get_global_states(true);
2588             }
2589         }
2591         // make sure that all registered filters are installed, just in case
2592         foreach ($globalstates as $name => $info) {
2593             if (!isset($filters[$name])) {
2594                 // oops, there is a record in filter_active but the filter is not installed
2595                 $plugin                 = new $typeclass();
2596                 $plugin->type           = $type;
2597                 $plugin->typerootdir    = $typerootdir;
2598                 $plugin->name           = $name;
2599                 $plugin->rootdir        = $CFG->dirroot . '/' . $info->legacyname;
2600                 $plugin->displayname    = $info->legacyname;
2602                 $plugin->load_db_version();
2604                 if (is_null($plugin->versiondb)) {
2605                     // this is a hack to stimulate 'Missing from disk' error
2606                     // because $plugin->versiondisk will be null !== false
2607                     $plugin->versiondb = false;
2608                 }
2610                 $filters[$plugin->name] = $plugin;
2611             }
2612         }
2614         return $filters;
2615     }
2617     public function init_display_name() {
2618         // do nothing, the name is set in self::get_plugins()
2619     }
2621     /**
2622      * @see load_version_php()
2623      */
2624     protected function load_version_php() {
2625         if (strpos($this->name, 'mod_') === 0) {
2626             // filters bundled with modules do not have a version.php and so
2627             // do not provide their own versioning information.
2628             return new stdClass();
2629         }
2630         return parent::load_version_php();
2631     }
2633     public function is_enabled() {
2635         $globalstates = self::get_global_states();
2637         foreach ($globalstates as $filterlegacyname => $info) {
2638             $name = self::normalize_legacy_name($filterlegacyname);
2639             if ($name === $this->name) {
2640                 if ($info->active == TEXTFILTER_DISABLED) {
2641                     return false;
2642                 } else {
2643                     // it may be 'On' or 'Off, but available'
2644                     return null;
2645                 }
2646             }
2647         }
2649         return null;
2650     }
2652     public function get_settings_section_name() {
2653         $globalstates = self::get_global_states();
2654         if (!isset($globalstates[$this->name])) {
2655             return parent::get_settings_section_name();
2656         }
2657         $legacyname = $globalstates[$this->name]->legacyname;
2658         return 'filtersetting' . str_replace('/', '', $legacyname);
2659     }
2661     public function load_settings(part_of_admin_tree $adminroot, $parentnodename, $hassiteconfig) {
2662         global $CFG, $USER, $DB, $OUTPUT, $PAGE; // in case settings.php wants to refer to them
2663         $ADMIN = $adminroot; // may be used in settings.php
2664         $filter = $this; // also can be used inside settings.php
2666         $globalstates = self::get_global_states();
2667         $settings = null;
2668         if ($hassiteconfig && isset($globalstates[$this->name]) && file_exists($this->full_path('filtersettings.php'))) {
2669             $section = $this->get_settings_section_name();
2670             $settings = new admin_settingpage($section, $this->displayname,
2671                     'moodle/site:config', $this->is_enabled() === false);
2672             include($this->full_path('filtersettings.php')); // this may also set $settings to null
2673         }
2674         if ($settings) {
2675             $ADMIN->add($parentnodename, $settings);
2676         }
2677     }
2679     public function get_uninstall_url() {
2681         if (strpos($this->name, 'mod_') === 0) {
2682             return null;
2683         } else {
2684             $globalstates = self::get_global_states();
2685             $legacyname = $globalstates[$this->name]->legacyname;
2686             return new moodle_url('/admin/filters.php', array('sesskey' => sesskey(), 'filterpath' => $legacyname, 'action' => 'delete'));
2687         }
2688     }
2690     /**
2691      * Convert legacy filter names like 'filter/foo' or 'mod/bar' into frankenstyle
2692      *
2693      * @param string $legacyfiltername legacy filter name
2694      * @return string frankenstyle-like name
2695      */
2696     protected static function normalize_legacy_name($legacyfiltername) {
2698         $name = str_replace('/', '_', $legacyfiltername);
2699         if (strpos($name, 'filter_') === 0) {
2700             $name = substr($name, 7);
2701             if (empty($name)) {
2702                 throw new coding_exception('Unable to determine filter name: ' . $legacyfiltername);
2703             }
2704         }
2706         return $name;
2707     }
2709     /**
2710      * Provides access to the results of {@link filter_get_global_states()}
2711      * but indexed by the normalized filter name
2712      *
2713      * The legacy filter name is available as ->legacyname property.
2714      *
2715      * @param bool $disablecache
2716      * @return array
2717      */
2718     protected static function get_global_states($disablecache=false) {
2719         global $DB;
2720         static $globalstatescache = null;
2722         if ($disablecache or is_null($globalstatescache)) {
2724             if (!$DB->get_manager()->table_exists('filter_active')) {
2725                 // we're upgrading from 1.9 and the table used by {@link filter_get_global_states()}
2726                 // does not exist yet
2727                 $globalstatescache = array();
2729             } else {
2730                 foreach (filter_get_global_states() as $legacyname => $info) {
2731                     $name                       = self::normalize_legacy_name($legacyname);
2732                     $filterinfo                 = new stdClass();
2733                     $filterinfo->legacyname     = $legacyname;
2734                     $filterinfo->active         = $info->active;
2735                     $filterinfo->sortorder      = $info->sortorder;
2736                     $globalstatescache[$name]   = $filterinfo;
2737                 }
2738             }
2739         }
2741         return $globalstatescache;
2742     }
2746 /**
2747  * Class for activity modules
2748  */
2749 class plugininfo_mod extends plugininfo_base {
2751     public static function get_plugins($type, $typerootdir, $typeclass) {
2753         // get the information about plugins at the disk
2754         $modules = parent::get_plugins($type, $typerootdir, $typeclass);
2756         // add modules missing from disk
2757         $modulesinfo = self::get_modules_info();
2758         foreach ($modulesinfo as $modulename => $moduleinfo) {
2759             if (isset($modules[$modulename])) {
2760                 continue;
2761             }
2762             $plugin                 = new $typeclass();
2763             $plugin->type           = $type;
2764             $plugin->typerootdir    = $typerootdir;
2765             $plugin->name           = $modulename;
2766             $plugin->rootdir        = null;
2767             $plugin->displayname    = $modulename;
2768             $plugin->versiondb      = $moduleinfo->version;
2769             $plugin->init_is_standard();
2771             $modules[$modulename]   = $plugin;
2772         }
2774         return $modules;
2775     }
2777     /**
2778      * Magic method getter, redirects to read only values.
2779      *
2780      * For module plugins we pretend the object has 'visible' property for compatibility
2781      * with plugins developed for Moodle version below 2.4
2782      *
2783      * @param string $name
2784      * @return mixed
2785      */
2786     public function __get($name) {
2787         if ($name === 'visible') {
2788             debugging('This is now an instance of plugininfo_mod, please use $module->is_enabled() instead of $module->visible', DEBUG_DEVELOPER);
2789             return ($this->is_enabled() !== false);
2790         }
2791         return parent::__get($name);
2792     }
2794     public function init_display_name() {
2795         if (get_string_manager()->string_exists('pluginname', $this->component)) {
2796             $this->displayname = get_string('pluginname', $this->component);
2797         } else {
2798             $this->displayname = get_string('modulename', $this->component);
2799         }
2800     }
2802     /**
2803      * Load the data from version.php.
2804      * @return object the data object defined in version.php.
2805      */
2806     protected function load_version_php() {
2807         $versionfile = $this->full_path('version.php');
2809         $module = new stdClass();
2810         if (is_readable($versionfile)) {
2811             include($versionfile);
2812         }
2813         return $module;
2814     }
2816     public function load_db_version() {
2817         global $DB;
2819         $modulesinfo = self::get_modules_info();
2820         if (isset($modulesinfo[$this->name]->version)) {
2821             $this->versiondb = $modulesinfo[$this->name]->version;
2822         }
2823     }
2825     public function is_enabled() {
2827         $modulesinfo = self::get_modules_info();
2828         if (isset($modulesinfo[$this->name]->visible)) {
2829             if ($modulesinfo[$this->name]->visible) {
2830                 return true;
2831             } else {
2832                 return false;
2833             }
2834         } else {
2835             return parent::is_enabled();
2836         }
2837     }
2839     public function get_settings_section_name() {
2840         return 'modsetting' . $this->name;
2841     }
2843     public function load_settings(part_of_admin_tree $adminroot, $parentnodename, $hassiteconfig) {
2844         global $CFG, $USER, $DB, $OUTPUT, $PAGE; // in case settings.php wants to refer to them
2845         $ADMIN = $adminroot; // may be used in settings.php
2846         $module = $this; // also can be used inside settings.php
2847         $section = $this->get_settings_section_name();
2849         $modulesinfo = self::get_modules_info();
2850         $settings = null;
2851         if ($hassiteconfig && isset($modulesinfo[$this->name]) && file_exists($this->full_path('settings.php'))) {
2852             $settings = new admin_settingpage($section, $this->displayname,
2853                     'moodle/site:config', $this->is_enabled() === false);
2854             include($this->full_path('settings.php')); // this may also set $settings to null
2855         }
2856         if ($settings) {
2857             $ADMIN->add($parentnodename, $settings);
2858         }
2859     }
2861     public function get_uninstall_url() {
2863         if ($this->name !== 'forum') {
2864             return new moodle_url('/admin/modules.php', array('delete' => $this->name, 'sesskey' => sesskey()));
2865         } else {
2866             return null;
2867         }
2868     }
2870     /**
2871      * Provides access to the records in {modules} table
2872      *
2873      * @param bool $disablecache do not use internal static cache
2874      * @return array array of stdClasses
2875      */
2876     protected static function get_modules_info($disablecache=false) {
2877         global $DB;
2878         static $modulesinfocache = null;
2880         if (is_null($modulesinfocache) or $disablecache) {
2881             try {
2882                 $modulesinfocache = $DB->get_records('modules', null, 'name', 'name,id,version,visible');
2883             } catch (dml_exception $e) {
2884                 // before install
2885                 $modulesinfocache = array();
2886             }
2887         }
2889         return $modulesinfocache;
2890     }
2894 /**
2895  * Class for question behaviours.
2896  */
2897 class plugininfo_qbehaviour extends plugininfo_base {
2899     public function get_uninstall_url() {
2900         return new moodle_url('/admin/qbehaviours.php',
2901                 array('delete' => $this->name, 'sesskey' => sesskey()));
2902     }
2906 /**
2907  * Class for question types
2908  */
2909 class plugininfo_qtype extends plugininfo_base {
2911     public function get_uninstall_url() {
2912         return new moodle_url('/admin/qtypes.php',
2913                 array('delete' => $this->name, 'sesskey' => sesskey()));
2914     }
2916     public function get_settings_section_name() {
2917         return 'qtypesetting' . $this->name;
2918     }
2920     public function load_settings(part_of_admin_tree $adminroot, $parentnodename, $hassiteconfig) {
2921         global $CFG, $USER, $DB, $OUTPUT, $PAGE; // in case settings.php wants to refer to them
2922         $ADMIN = $adminroot; // may be used in settings.php
2923         $qtype = $this; // also can be used inside settings.php
2924         $section = $this->get_settings_section_name();
2926         $settings = null;
2927         if ($hassiteconfig && file_exists($this->full_path('settings.php'))) {
2928             $settings = new admin_settingpage($section, $this->displayname,
2929                     'moodle/site:config', $this->is_enabled() === false);
2930             include($this->full_path('settings.php')); // this may also set $settings to null
2931         }
2932         if ($settings) {
2933             $ADMIN->add($parentnodename, $settings);
2934         }
2935     }
2939 /**
2940  * Class for authentication plugins
2941  */
2942 class plugininfo_auth extends plugininfo_base {
2944     public function is_enabled() {
2945         global $CFG;
2946         /** @var null|array list of enabled authentication plugins */
2947         static $enabled = null;
2949         if (in_array($this->name, array('nologin', 'manual'))) {
2950             // these two are always enabled and can't be disabled
2951             return null;
2952         }
2954         if (is_null($enabled)) {
2955             $enabled = array_flip(explode(',', $CFG->auth));
2956         }
2958         return isset($enabled[$this->name]);
2959     }
2961     public function get_settings_section_name() {
2962         return 'authsetting' . $this->name;
2963     }
2965     public function load_settings(part_of_admin_tree $adminroot, $parentnodename, $hassiteconfig) {
2966         global $CFG, $USER, $DB, $OUTPUT, $PAGE; // in case settings.php wants to refer to them
2967         $ADMIN = $adminroot; // may be used in settings.php
2968         $auth = $this; // also to be used inside settings.php
2969         $section = $this->get_settings_section_name();
2971         $settings = null;
2972         if ($hassiteconfig) {
2973             if (file_exists($this->full_path('settings.php'))) {
2974                 // TODO: finish implementation of common settings - locking, etc.
2975                 $settings = new admin_settingpage($section, $this->displayname,
2976                         'moodle/site:config', $this->is_enabled() === false);
2977                 include($this->full_path('settings.php')); // this may also set $settings to null
2978             } else {
2979                 $settingsurl = new moodle_url('/admin/auth_config.php', array('auth' => $this->name));
2980                 $settings = new admin_externalpage($section, $this->displayname,
2981                         $settingsurl, 'moodle/site:config', $this->is_enabled() === false);
2982             }
2983         }
2984         if ($settings) {
2985             $ADMIN->add($parentnodename, $settings);
2986         }
2987     }
2991 /**
2992  * Class for enrolment plugins
2993  */
2994 class plugininfo_enrol extends plugininfo_base {
2996     public function is_enabled() {
2997         global $CFG;
2998         /** @var null|array list of enabled enrolment plugins */
2999         static $enabled = null;
3001         // We do not actually need whole enrolment classes here so we do not call
3002         // {@link enrol_get_plugins()}. Note that this may produce slightly different
3003         // results, for example if the enrolment plugin does not contain lib.php
3004         // but it is listed in $CFG->enrol_plugins_enabled
3006         if (is_null($enabled)) {
3007             $enabled = array_flip(explode(',', $CFG->enrol_plugins_enabled));
3008         }
3010         return isset($enabled[$this->name]);
3011     }
3013     public function get_settings_section_name() {
3014         return 'enrolsettings' . $this->name;
3015     }
3017     public function load_settings(part_of_admin_tree $adminroot, $parentnodename, $hassiteconfig) {
3018         global $CFG, $USER, $DB, $OUTPUT, $PAGE; // in case settings.php wants to refer to them
3019         $ADMIN = $adminroot; // may be used in settings.php
3020         $enrol = $this; // also can be used inside settings.php
3021         $section = $this->get_settings_section_name();
3023         $settings = null;
3024         if ($hassiteconfig && file_exists($this->full_path('settings.php'))) {
3025             $settings = new admin_settingpage($section, $this->displayname,
3026                     'moodle/site:config', $this->is_enabled() === false);
3027             include($this->full_path('settings.php')); // this may also set $settings to null
3028         }
3029         if ($settings) {
3030             $ADMIN->add($parentnodename, $settings);
3031         }
3032     }
3034     public function get_uninstall_url() {
3035         return new moodle_url('/admin/enrol.php', array('action' => 'uninstall', 'enrol' => $this->name, 'sesskey' => sesskey()));
3036     }
3040 /**
3041  * Class for messaging processors
3042  */
3043 class plugininfo_message extends plugininfo_base {
3045     public function get_settings_section_name() {
3046         return 'messagesetting' . $this->name;
3047     }
3049     public function load_settings(part_of_admin_tree $adminroot, $parentnodename, $hassiteconfig) {
3050         global $CFG, $USER, $DB, $OUTPUT, $PAGE; // in case settings.php wants to refer to them
3051         $ADMIN = $adminroot; // may be used in settings.php
3052         if (!$hassiteconfig) {
3053             return;
3054         }
3055         $section = $this->get_settings_section_name();
3057         $settings = null;
3058         $processors = get_message_processors();
3059         if (isset($processors[$this->name])) {
3060             $processor = $processors[$this->name];
3061             if ($processor->available && $processor->hassettings) {
3062                 $settings = new admin_settingpage($section, $this->displayname,
3063                         'moodle/site:config', $this->is_enabled() === false);
3064                 include($this->full_path('settings.php')); // this may also set $settings to null
3065             }
3066         }
3067         if ($settings) {
3068             $ADMIN->add($parentnodename, $settings);
3069         }
3070     }
3072     /**
3073      * @see plugintype_interface::is_enabled()
3074      */
3075     public function is_enabled() {
3076         $processors = get_message_processors();
3077         if (isset($processors[$this->name])) {
3078             return $processors[$this->name]->configured && $processors[$this->name]->enabled;
3079         } else {
3080             return parent::is_enabled();
3081         }
3082     }
3084     /**
3085      * @see plugintype_interface::get_uninstall_url()
3086      */
3087     public function get_uninstall_url() {
3088         $processors = get_message_processors();
3089         if (isset($processors[$this->name])) {
3090             return new moodle_url('/admin/message.php', array('uninstall' => $processors[$this->name]->id, 'sesskey' => sesskey()));
3091         } else {
3092             return parent::get_uninstall_url();
3093         }
3094     }
3098 /**
3099  * Class for repositories
3100  */
3101 class plugininfo_repository extends plugininfo_base {
3103     public function is_enabled() {
3105         $enabled = self::get_enabled_repositories();
3107         return isset($enabled[$this->name]);
3108     }
3110     public function get_settings_section_name() {
3111         return 'repositorysettings'.$this->name;
3112     }
3114     public function load_settings(part_of_admin_tree $adminroot, $parentnodename, $hassiteconfig) {
3115         if ($hassiteconfig && $this->is_enabled()) {
3116             // completely no access to repository setting when it is not enabled
3117             $sectionname = $this->get_settings_section_name();
3118             $settingsurl = new moodle_url('/admin/repository.php',
3119                     array('sesskey' => sesskey(), 'action' => 'edit', 'repos' => $this->name));
3120             $settings = new admin_externalpage($sectionname, $this->displayname,
3121                     $settingsurl, 'moodle/site:config', false);
3122             $adminroot->add($parentnodename, $settings);
3123         }
3124     }
3126     /**
3127      * Provides access to the records in {repository} table
3128      *
3129      * @param bool $disablecache do not use internal static cache
3130      * @return array array of stdClasses
3131      */
3132     protected static function get_enabled_repositories($disablecache=false) {
3133         global $DB;
3134         static $repositories = null;
3136         if (is_null($repositories) or $disablecache) {
3137             $repositories = $DB->get_records('repository', null, 'type', 'type,visible,sortorder');
3138         }
3140         return $repositories;
3141     }
3145 /**
3146  * Class for portfolios
3147  */
3148 class plugininfo_portfolio extends plugininfo_base {
3150     public function is_enabled() {
3152         $enabled = self::get_enabled_portfolios();
3154         return isset($enabled[$this->name]);
3155     }
3157     /**
3158      * Provides access to the records in {portfolio_instance} table
3159      *
3160      * @param bool $disablecache do not use internal static cache
3161      * @return array array of stdClasses
3162      */
3163     protected static function get_enabled_portfolios($disablecache=false) {
3164         global $DB;
3165         static $portfolios = null;
3167         if (is_null($portfolios) or $disablecache) {
3168             $portfolios = array();
3169             $instances  = $DB->get_recordset('portfolio_instance', null, 'plugin');
3170             foreach ($instances as $instance) {
3171                 if (isset($portfolios[$instance->plugin])) {
3172                     if ($instance->visible) {
3173                         $portfolios[$instance->plugin]->visible = $instance->visible;
3174                     }
3175                 } else {
3176                     $portfolios[$instance->plugin] = $instance;
3177                 }
3178             }
3179         }
3181         return $portfolios;
3182     }
3186 /**
3187  * Class for themes
3188  */
3189 class plugininfo_theme extends plugininfo_base {
3191     public function is_enabled() {
3192         global $CFG;
3194         if ((!empty($CFG->theme) and $CFG->theme === $this->name) or
3195             (!empty($CFG->themelegacy) and $CFG->themelegacy === $this->name)) {
3196             return true;
3197         } else {
3198             return parent::is_enabled();
3199         }
3200     }
3204 /**
3205  * Class representing an MNet service
3206  */
3207 class plugininfo_mnetservice extends plugininfo_base {
3209     public function is_enabled() {
3210         global $CFG;
3212         if (empty($CFG->mnet_dispatcher_mode) || $CFG->mnet_dispatcher_mode !== 'strict') {
3213             return false;
3214         } else {
3215             return parent::is_enabled();
3216         }
3217     }
3221 /**
3222  * Class for admin tool plugins
3223  */
3224 class plugininfo_tool extends plugininfo_base {
3226     public function get_uninstall_url() {
3227         return new moodle_url('/admin/tools.php', array('delete' => $this->name, 'sesskey' => sesskey()));
3228     }
3232 /**
3233  * Class for admin tool plugins
3234  */
3235 class plugininfo_report extends plugininfo_base {
3237     public function get_uninstall_url() {
3238         return new moodle_url('/admin/reports.php', array('delete' => $this->name, 'sesskey' => sesskey()));
3239     }
3243 /**
3244  * Class for local plugins
3245  */
3246 class plugininfo_local extends plugininfo_base {
3248     public function get_uninstall_url() {
3249         return new moodle_url('/admin/localplugins.php', array('delete' => $this->name, 'sesskey' => sesskey()));
3250     }
3253 /**
3254  * Class for HTML editors
3255  */
3256 class plugininfo_editor extends plugininfo_base {
3258     public function get_settings_section_name() {
3259         return 'editorsettings' . $this->name;
3260     }
3262     public function load_settings(part_of_admin_tree $adminroot, $parentnodename, $hassiteconfig) {
3263         global $CFG, $USER, $DB, $OUTPUT, $PAGE; // in case settings.php wants to refer to them
3264         $ADMIN = $adminroot; // may be used in settings.php
3265         $editor = $this; // also can be used inside settings.php
3266         $section = $this->get_settings_section_name();
3268         $settings = null;
3269         if ($hassiteconfig && file_exists($this->full_path('settings.php'))) {
3270             $settings = new admin_settingpage($section, $this->displayname,
3271                     'moodle/site:config', $this->is_enabled() === false);
3272             include($this->full_path('settings.php')); // this may also set $settings to null
3273         }
3274         if ($settings) {
3275             $ADMIN->add($parentnodename, $settings);
3276         }
3277     }
3279     /**
3280      * Returns the information about plugin availability
3281      *
3282      * True means that the plugin is enabled. False means that the plugin is
3283      * disabled. Null means that the information is not available, or the
3284      * plugin does not support configurable availability or the availability
3285      * can not be changed.
3286      *
3287      * @return null|bool
3288      */
3289     public function is_enabled() {
3290         global $CFG;
3291         if (empty($CFG->texteditors)) {
3292             $CFG->texteditors = 'tinymce,textarea';
3293         }
3294         if (in_array($this->name, explode(',', $CFG->texteditors))) {
3295             return true;
3296         }
3297         return false;
3298     }
3301 /**
3302  * Class for plagiarism plugins
3303  */
3304 class plugininfo_plagiarism extends plugininfo_base {
3306     public function get_settings_section_name() {
3307         return 'plagiarism'. $this->name;
3308     }
3310     public function load_settings(part_of_admin_tree $adminroot, $parentnodename, $hassiteconfig) {
3311         // plagiarism plugin just redirect to settings.php in the plugins directory
3312         if ($hassiteconfig && file_exists($this->full_path('settings.php'))) {
3313             $section = $this->get_settings_section_name();
3314             $settingsurl = new moodle_url($this->get_dir().'/settings.php');
3315             $settings = new admin_externalpage($section, $this->displayname,
3316                     $settingsurl, 'moodle/site:config', $this->is_enabled() === false);
3317             $adminroot->add($parentnodename, $settings);
3318         }
3319     }
3322 /**
3323  * Class for webservice protocols
3324  */
3325 class plugininfo_webservice extends plugininfo_base {
3327     public function get_settings_section_name() {
3328         return 'webservicesetting' . $this->name;
3329     }
3331     public function load_settings(part_of_admin_tree $adminroot, $parentnodename, $hassiteconfig) {
3332         global $CFG, $USER, $DB, $OUTPUT, $PAGE; // in case settings.php wants to refer to them
3333         $ADMIN = $adminroot; // may be used in settings.php
3334         $webservice = $this; // also can be used inside settings.php
3335         $section = $this->get_settings_section_name();
3337         $settings = null;
3338         if ($hassiteconfig && file_exists($this->full_path('settings.php'))) {
3339             $settings = new admin_settingpage($section, $this->displayname,
3340                     'moodle/site:config', $this->is_enabled() === false);
3341             include($this->full_path('settings.php')); // this may also set $settings to null
3342         }
3343         if ($settings) {
3344             $ADMIN->add($parentnodename, $settings);
3345         }
3346     }
3348     public function is_enabled() {
3349         global $CFG;
3350         if (empty($CFG->enablewebservices)) {
3351             return false;
3352         }
3353         $active_webservices = empty($CFG->webserviceprotocols) ? array() : explode(',', $CFG->webserviceprotocols);
3354         if (in_array($this->name, $active_webservices)) {
3355             return true;
3356         }
3357         return false;
3358     }
3360     public function get_uninstall_url() {
3361         return new moodle_url('/admin/webservice/protocols.php',
3362                 array('sesskey' => sesskey(), 'action' => 'uninstall', 'webservice' => $this->name));
3363     }