860af8a3b22a9d90e310a1b6121286141bdcb490
[moodle.git] / lib / classes / plugin_manager.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Defines classes used for plugins management
19  *
20  * This library provides a unified interface to various plugin types in
21  * Moodle. It is mainly used by the plugins management admin page and the
22  * plugins check page during the upgrade.
23  *
24  * @package    core
25  * @copyright  2011 David Mudrak <david@moodle.com>
26  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27  */
29 defined('MOODLE_INTERNAL') || die();
31 /**
32  * Singleton class providing general plugins management functionality.
33  */
34 class core_plugin_manager {
36     /** the plugin is shipped with standard Moodle distribution */
37     const PLUGIN_SOURCE_STANDARD    = 'std';
38     /** the plugin is added extension */
39     const PLUGIN_SOURCE_EXTENSION   = 'ext';
41     /** the plugin uses neither database nor capabilities, no versions */
42     const PLUGIN_STATUS_NODB        = 'nodb';
43     /** the plugin is up-to-date */
44     const PLUGIN_STATUS_UPTODATE    = 'uptodate';
45     /** the plugin is about to be installed */
46     const PLUGIN_STATUS_NEW         = 'new';
47     /** the plugin is about to be upgraded */
48     const PLUGIN_STATUS_UPGRADE     = 'upgrade';
49     /** the standard plugin is about to be deleted */
50     const PLUGIN_STATUS_DELETE     = 'delete';
51     /** the version at the disk is lower than the one already installed */
52     const PLUGIN_STATUS_DOWNGRADE   = 'downgrade';
53     /** the plugin is installed but missing from disk */
54     const PLUGIN_STATUS_MISSING     = 'missing';
56     /** the given requirement/dependency is fulfilled */
57     const REQUIREMENT_STATUS_OK = 'ok';
58     /** the plugin requires higher core/other plugin version than is currently installed */
59     const REQUIREMENT_STATUS_OUTDATED = 'outdated';
60     /** the required dependency is not installed */
61     const REQUIREMENT_STATUS_MISSING = 'missing';
63     /** the required dependency is available in the plugins directory */
64     const REQUIREMENT_AVAILABLE = 'available';
65     /** the required dependency is available in the plugins directory */
66     const REQUIREMENT_UNAVAILABLE = 'unavailable';
68     /** @var core_plugin_manager holds the singleton instance */
69     protected static $singletoninstance;
70     /** @var array of raw plugins information */
71     protected $pluginsinfo = null;
72     /** @var array of raw subplugins information */
73     protected $subpluginsinfo = null;
74     /** @var array cache information about availability in the plugins directory if requesting "at least" version */
75     protected $remotepluginsinfoatleast = null;
76     /** @var array cache information about availability in the plugins directory if requesting exact version */
77     protected $remotepluginsinfoexact = null;
78     /** @var array list of installed plugins $name=>$version */
79     protected $installedplugins = null;
80     /** @var array list of all enabled plugins $name=>$name */
81     protected $enabledplugins = null;
82     /** @var array list of all enabled plugins $name=>$diskversion */
83     protected $presentplugins = null;
84     /** @var array reordered list of plugin types */
85     protected $plugintypes = null;
86     /** @var \core\update\code_manager code manager to use for plugins code operations */
87     protected $codemanager = null;
88     /** @var \core\update\api client instance to use for accessing download.moodle.org/api/ */
89     protected $updateapiclient = null;
91     /**
92      * Direct initiation not allowed, use the factory method {@link self::instance()}
93      */
94     protected function __construct() {
95     }
97     /**
98      * Sorry, this is singleton
99      */
100     protected function __clone() {
101     }
103     /**
104      * Factory method for this class
105      *
106      * @return core_plugin_manager the singleton instance
107      */
108     public static function instance() {
109         if (is_null(static::$singletoninstance)) {
110             static::$singletoninstance = new static();
111         }
112         return static::$singletoninstance;
113     }
115     /**
116      * Reset all caches.
117      * @param bool $phpunitreset
118      */
119     public static function reset_caches($phpunitreset = false) {
120         if ($phpunitreset) {
121             static::$singletoninstance = null;
122         } else {
123             if (static::$singletoninstance) {
124                 static::$singletoninstance->pluginsinfo = null;
125                 static::$singletoninstance->subpluginsinfo = null;
126                 static::$singletoninstance->remotepluginsinfoatleast = null;
127                 static::$singletoninstance->remotepluginsinfoexact = null;
128                 static::$singletoninstance->installedplugins = null;
129                 static::$singletoninstance->enabledplugins = null;
130                 static::$singletoninstance->presentplugins = null;
131                 static::$singletoninstance->plugintypes = null;
132                 static::$singletoninstance->codemanager = null;
133                 static::$singletoninstance->updateapiclient = null;
134             }
135         }
136         $cache = cache::make('core', 'plugin_manager');
137         $cache->purge();
138     }
140     /**
141      * Returns the result of {@link core_component::get_plugin_types()} ordered for humans
142      *
143      * @see self::reorder_plugin_types()
144      * @return array (string)name => (string)location
145      */
146     public function get_plugin_types() {
147         if (func_num_args() > 0) {
148             if (!func_get_arg(0)) {
149                 throw coding_exception('core_plugin_manager->get_plugin_types() does not support relative paths.');
150             }
151         }
152         if ($this->plugintypes) {
153             return $this->plugintypes;
154         }
156         $this->plugintypes = $this->reorder_plugin_types(core_component::get_plugin_types());
157         return $this->plugintypes;
158     }
160     /**
161      * Load list of installed plugins,
162      * always call before using $this->installedplugins.
163      *
164      * This method is caching results for all plugins.
165      */
166     protected function load_installed_plugins() {
167         global $DB, $CFG;
169         if ($this->installedplugins) {
170             return;
171         }
173         if (empty($CFG->version)) {
174             // Nothing installed yet.
175             $this->installedplugins = array();
176             return;
177         }
179         $cache = cache::make('core', 'plugin_manager');
180         $installed = $cache->get('installed');
182         if (is_array($installed)) {
183             $this->installedplugins = $installed;
184             return;
185         }
187         $this->installedplugins = array();
189         // TODO: Delete this block once Moodle 2.6 or later becomes minimum required version to upgrade.
190         if ($CFG->version < 2013092001.02) {
191             // We did not upgrade the database yet.
192             $modules = $DB->get_records('modules', array(), 'name ASC', 'id, name, version');
193             foreach ($modules as $module) {
194                 $this->installedplugins['mod'][$module->name] = $module->version;
195             }
196             $blocks = $DB->get_records('block', array(), 'name ASC', 'id, name, version');
197             foreach ($blocks as $block) {
198                 $this->installedplugins['block'][$block->name] = $block->version;
199             }
200         }
202         $versions = $DB->get_records('config_plugins', array('name'=>'version'));
203         foreach ($versions as $version) {
204             $parts = explode('_', $version->plugin, 2);
205             if (!isset($parts[1])) {
206                 // Invalid component, there must be at least one "_".
207                 continue;
208             }
209             // Do not verify here if plugin type and name are valid.
210             $this->installedplugins[$parts[0]][$parts[1]] = $version->value;
211         }
213         foreach ($this->installedplugins as $key => $value) {
214             ksort($this->installedplugins[$key]);
215         }
217         $cache->set('installed', $this->installedplugins);
218     }
220     /**
221      * Return list of installed plugins of given type.
222      * @param string $type
223      * @return array $name=>$version
224      */
225     public function get_installed_plugins($type) {
226         $this->load_installed_plugins();
227         if (isset($this->installedplugins[$type])) {
228             return $this->installedplugins[$type];
229         }
230         return array();
231     }
233     /**
234      * Load list of all enabled plugins,
235      * call before using $this->enabledplugins.
236      *
237      * This method is caching results from individual plugin info classes.
238      */
239     protected function load_enabled_plugins() {
240         global $CFG;
242         if ($this->enabledplugins) {
243             return;
244         }
246         if (empty($CFG->version)) {
247             $this->enabledplugins = array();
248             return;
249         }
251         $cache = cache::make('core', 'plugin_manager');
252         $enabled = $cache->get('enabled');
254         if (is_array($enabled)) {
255             $this->enabledplugins = $enabled;
256             return;
257         }
259         $this->enabledplugins = array();
261         require_once($CFG->libdir.'/adminlib.php');
263         $plugintypes = core_component::get_plugin_types();
264         foreach ($plugintypes as $plugintype => $fulldir) {
265             $plugininfoclass = static::resolve_plugininfo_class($plugintype);
266             if (class_exists($plugininfoclass)) {
267                 $enabled = $plugininfoclass::get_enabled_plugins();
268                 if (!is_array($enabled)) {
269                     continue;
270                 }
271                 $this->enabledplugins[$plugintype] = $enabled;
272             }
273         }
275         $cache->set('enabled', $this->enabledplugins);
276     }
278     /**
279      * Get list of enabled plugins of given type,
280      * the result may contain missing plugins.
281      *
282      * @param string $type
283      * @return array|null  list of enabled plugins of this type, null if unknown
284      */
285     public function get_enabled_plugins($type) {
286         $this->load_enabled_plugins();
287         if (isset($this->enabledplugins[$type])) {
288             return $this->enabledplugins[$type];
289         }
290         return null;
291     }
293     /**
294      * Load list of all present plugins - call before using $this->presentplugins.
295      */
296     protected function load_present_plugins() {
297         if ($this->presentplugins) {
298             return;
299         }
301         $cache = cache::make('core', 'plugin_manager');
302         $present = $cache->get('present');
304         if (is_array($present)) {
305             $this->presentplugins = $present;
306             return;
307         }
309         $this->presentplugins = array();
311         $plugintypes = core_component::get_plugin_types();
312         foreach ($plugintypes as $type => $typedir) {
313             $plugs = core_component::get_plugin_list($type);
314             foreach ($plugs as $plug => $fullplug) {
315                 $module = new stdClass();
316                 $plugin = new stdClass();
317                 $plugin->version = null;
318                 include($fullplug.'/version.php');
320                 // Check if the legacy $module syntax is still used.
321                 if (!is_object($module) or (count((array)$module) > 0)) {
322                     debugging('Unsupported $module syntax detected in version.php of the '.$type.'_'.$plug.' plugin.');
323                     $skipcache = true;
324                 }
326                 // Check if the component is properly declared.
327                 if (empty($plugin->component) or ($plugin->component !== $type.'_'.$plug)) {
328                     debugging('Plugin '.$type.'_'.$plug.' does not declare valid $plugin->component in its version.php.');
329                     $skipcache = true;
330                 }
332                 $this->presentplugins[$type][$plug] = $plugin;
333             }
334         }
336         if (empty($skipcache)) {
337             $cache->set('present', $this->presentplugins);
338         }
339     }
341     /**
342      * Get list of present plugins of given type.
343      *
344      * @param string $type
345      * @return array|null  list of presnet plugins $name=>$diskversion, null if unknown
346      */
347     public function get_present_plugins($type) {
348         $this->load_present_plugins();
349         if (isset($this->presentplugins[$type])) {
350             return $this->presentplugins[$type];
351         }
352         return null;
353     }
355     /**
356      * Returns a tree of known plugins and information about them
357      *
358      * @return array 2D array. The first keys are plugin type names (e.g. qtype);
359      *      the second keys are the plugin local name (e.g. multichoice); and
360      *      the values are the corresponding objects extending {@link \core\plugininfo\base}
361      */
362     public function get_plugins() {
363         $this->init_pluginsinfo_property();
365         // Make sure all types are initialised.
366         foreach ($this->pluginsinfo as $plugintype => $list) {
367             if ($list === null) {
368                 $this->get_plugins_of_type($plugintype);
369             }
370         }
372         return $this->pluginsinfo;
373     }
375     /**
376      * Returns list of known plugins of the given type.
377      *
378      * This method returns the subset of the tree returned by {@link self::get_plugins()}.
379      * If the given type is not known, empty array is returned.
380      *
381      * @param string $type plugin type, e.g. 'mod' or 'workshopallocation'
382      * @return \core\plugininfo\base[] (string)plugin name (e.g. 'workshop') => corresponding subclass of {@link \core\plugininfo\base}
383      */
384     public function get_plugins_of_type($type) {
385         global $CFG;
387         $this->init_pluginsinfo_property();
389         if (!array_key_exists($type, $this->pluginsinfo)) {
390             return array();
391         }
393         if (is_array($this->pluginsinfo[$type])) {
394             return $this->pluginsinfo[$type];
395         }
397         $types = core_component::get_plugin_types();
399         if (!isset($types[$type])) {
400             // Orphaned subplugins!
401             $plugintypeclass = static::resolve_plugininfo_class($type);
402             $this->pluginsinfo[$type] = $plugintypeclass::get_plugins($type, null, $plugintypeclass, $this);
403             return $this->pluginsinfo[$type];
404         }
406         /** @var \core\plugininfo\base $plugintypeclass */
407         $plugintypeclass = static::resolve_plugininfo_class($type);
408         $plugins = $plugintypeclass::get_plugins($type, $types[$type], $plugintypeclass, $this);
409         $this->pluginsinfo[$type] = $plugins;
411         return $this->pluginsinfo[$type];
412     }
414     /**
415      * Init placeholder array for plugin infos.
416      */
417     protected function init_pluginsinfo_property() {
418         if (is_array($this->pluginsinfo)) {
419             return;
420         }
421         $this->pluginsinfo = array();
423         $plugintypes = $this->get_plugin_types();
425         foreach ($plugintypes as $plugintype => $plugintyperootdir) {
426             $this->pluginsinfo[$plugintype] = null;
427         }
429         // Add orphaned subplugin types.
430         $this->load_installed_plugins();
431         foreach ($this->installedplugins as $plugintype => $unused) {
432             if (!isset($plugintypes[$plugintype])) {
433                 $this->pluginsinfo[$plugintype] = null;
434             }
435         }
436     }
438     /**
439      * Find the plugin info class for given type.
440      *
441      * @param string $type
442      * @return string name of pluginfo class for give plugin type
443      */
444     public static function resolve_plugininfo_class($type) {
445         $plugintypes = core_component::get_plugin_types();
446         if (!isset($plugintypes[$type])) {
447             return '\core\plugininfo\orphaned';
448         }
450         $parent = core_component::get_subtype_parent($type);
452         if ($parent) {
453             $class = '\\'.$parent.'\plugininfo\\' . $type;
454             if (class_exists($class)) {
455                 $plugintypeclass = $class;
456             } else {
457                 if ($dir = core_component::get_component_directory($parent)) {
458                     // BC only - use namespace instead!
459                     if (file_exists("$dir/adminlib.php")) {
460                         global $CFG;
461                         include_once("$dir/adminlib.php");
462                     }
463                     if (class_exists('plugininfo_' . $type)) {
464                         $plugintypeclass = 'plugininfo_' . $type;
465                         debugging('Class "'.$plugintypeclass.'" is deprecated, migrate to "'.$class.'"', DEBUG_DEVELOPER);
466                     } else {
467                         debugging('Subplugin type "'.$type.'" should define class "'.$class.'"', DEBUG_DEVELOPER);
468                         $plugintypeclass = '\core\plugininfo\general';
469                     }
470                 } else {
471                     $plugintypeclass = '\core\plugininfo\general';
472                 }
473             }
474         } else {
475             $class = '\core\plugininfo\\' . $type;
476             if (class_exists($class)) {
477                 $plugintypeclass = $class;
478             } else {
479                 debugging('All standard types including "'.$type.'" should have plugininfo class!', DEBUG_DEVELOPER);
480                 $plugintypeclass = '\core\plugininfo\general';
481             }
482         }
484         if (!in_array('core\plugininfo\base', class_parents($plugintypeclass))) {
485             throw new coding_exception('Class ' . $plugintypeclass . ' must extend \core\plugininfo\base');
486         }
488         return $plugintypeclass;
489     }
491     /**
492      * Returns list of all known subplugins of the given plugin.
493      *
494      * For plugins that do not provide subplugins (i.e. there is no support for it),
495      * empty array is returned.
496      *
497      * @param string $component full component name, e.g. 'mod_workshop'
498      * @return array (string) component name (e.g. 'workshopallocation_random') => subclass of {@link \core\plugininfo\base}
499      */
500     public function get_subplugins_of_plugin($component) {
502         $pluginfo = $this->get_plugin_info($component);
504         if (is_null($pluginfo)) {
505             return array();
506         }
508         $subplugins = $this->get_subplugins();
510         if (!isset($subplugins[$pluginfo->component])) {
511             return array();
512         }
514         $list = array();
516         foreach ($subplugins[$pluginfo->component] as $subdata) {
517             foreach ($this->get_plugins_of_type($subdata->type) as $subpluginfo) {
518                 $list[$subpluginfo->component] = $subpluginfo;
519             }
520         }
522         return $list;
523     }
525     /**
526      * Returns list of plugins that define their subplugins and the information
527      * about them from the db/subplugins.php file.
528      *
529      * @return array with keys like 'mod_quiz', and values the data from the
530      *      corresponding db/subplugins.php file.
531      */
532     public function get_subplugins() {
534         if (is_array($this->subpluginsinfo)) {
535             return $this->subpluginsinfo;
536         }
538         $plugintypes = core_component::get_plugin_types();
540         $this->subpluginsinfo = array();
541         foreach (core_component::get_plugin_types_with_subplugins() as $type => $ignored) {
542             foreach (core_component::get_plugin_list($type) as $plugin => $componentdir) {
543                 $component = $type.'_'.$plugin;
544                 $subplugins = core_component::get_subplugins($component);
545                 if (!$subplugins) {
546                     continue;
547                 }
548                 $this->subpluginsinfo[$component] = array();
549                 foreach ($subplugins as $subplugintype => $ignored) {
550                     $subplugin = new stdClass();
551                     $subplugin->type = $subplugintype;
552                     $subplugin->typerootdir = $plugintypes[$subplugintype];
553                     $this->subpluginsinfo[$component][$subplugintype] = $subplugin;
554                 }
555             }
556         }
557         return $this->subpluginsinfo;
558     }
560     /**
561      * Returns the name of the plugin that defines the given subplugin type
562      *
563      * If the given subplugin type is not actually a subplugin, returns false.
564      *
565      * @param string $subplugintype the name of subplugin type, eg. workshopform or quiz
566      * @return false|string the name of the parent plugin, eg. mod_workshop
567      */
568     public function get_parent_of_subplugin($subplugintype) {
569         $parent = core_component::get_subtype_parent($subplugintype);
570         if (!$parent) {
571             return false;
572         }
573         return $parent;
574     }
576     /**
577      * Returns a localized name of a given plugin
578      *
579      * @param string $component name of the plugin, eg mod_workshop or auth_ldap
580      * @return string
581      */
582     public function plugin_name($component) {
584         $pluginfo = $this->get_plugin_info($component);
586         if (is_null($pluginfo)) {
587             throw new moodle_exception('err_unknown_plugin', 'core_plugin', '', array('plugin' => $component));
588         }
590         return $pluginfo->displayname;
591     }
593     /**
594      * Returns a localized name of a plugin typed in singular form
595      *
596      * Most plugin types define their names in core_plugin lang file. In case of subplugins,
597      * we try to ask the parent plugin for the name. In the worst case, we will return
598      * the value of the passed $type parameter.
599      *
600      * @param string $type the type of the plugin, e.g. mod or workshopform
601      * @return string
602      */
603     public function plugintype_name($type) {
605         if (get_string_manager()->string_exists('type_' . $type, 'core_plugin')) {
606             // For most plugin types, their names are defined in core_plugin lang file.
607             return get_string('type_' . $type, 'core_plugin');
609         } else if ($parent = $this->get_parent_of_subplugin($type)) {
610             // If this is a subplugin, try to ask the parent plugin for the name.
611             if (get_string_manager()->string_exists('subplugintype_' . $type, $parent)) {
612                 return $this->plugin_name($parent) . ' / ' . get_string('subplugintype_' . $type, $parent);
613             } else {
614                 return $this->plugin_name($parent) . ' / ' . $type;
615             }
617         } else {
618             return $type;
619         }
620     }
622     /**
623      * Returns a localized name of a plugin type in plural form
624      *
625      * Most plugin types define their names in core_plugin lang file. In case of subplugins,
626      * we try to ask the parent plugin for the name. In the worst case, we will return
627      * the value of the passed $type parameter.
628      *
629      * @param string $type the type of the plugin, e.g. mod or workshopform
630      * @return string
631      */
632     public function plugintype_name_plural($type) {
634         if (get_string_manager()->string_exists('type_' . $type . '_plural', 'core_plugin')) {
635             // For most plugin types, their names are defined in core_plugin lang file.
636             return get_string('type_' . $type . '_plural', 'core_plugin');
638         } else if ($parent = $this->get_parent_of_subplugin($type)) {
639             // If this is a subplugin, try to ask the parent plugin for the name.
640             if (get_string_manager()->string_exists('subplugintype_' . $type . '_plural', $parent)) {
641                 return $this->plugin_name($parent) . ' / ' . get_string('subplugintype_' . $type . '_plural', $parent);
642             } else {
643                 return $this->plugin_name($parent) . ' / ' . $type;
644             }
646         } else {
647             return $type;
648         }
649     }
651     /**
652      * Returns information about the known plugin, or null
653      *
654      * @param string $component frankenstyle component name.
655      * @return \core\plugininfo\base|null the corresponding plugin information.
656      */
657     public function get_plugin_info($component) {
658         list($type, $name) = core_component::normalize_component($component);
659         $plugins = $this->get_plugins_of_type($type);
660         if (isset($plugins[$name])) {
661             return $plugins[$name];
662         } else {
663             return null;
664         }
665     }
667     /**
668      * Check to see if the current version of the plugin seems to be a checkout of an external repository.
669      *
670      * @param string $component frankenstyle component name
671      * @return false|string
672      */
673     public function plugin_external_source($component) {
675         $plugininfo = $this->get_plugin_info($component);
677         if (is_null($plugininfo)) {
678             return false;
679         }
681         $pluginroot = $plugininfo->rootdir;
683         if (is_dir($pluginroot.'/.git')) {
684             return 'git';
685         }
687         if (is_file($pluginroot.'/.git')) {
688             return 'git-submodule';
689         }
691         if (is_dir($pluginroot.'/CVS')) {
692             return 'cvs';
693         }
695         if (is_dir($pluginroot.'/.svn')) {
696             return 'svn';
697         }
699         if (is_dir($pluginroot.'/.hg')) {
700             return 'mercurial';
701         }
703         return false;
704     }
706     /**
707      * Get a list of any other plugins that require this one.
708      * @param string $component frankenstyle component name.
709      * @return array of frankensyle component names that require this one.
710      */
711     public function other_plugins_that_require($component) {
712         $others = array();
713         foreach ($this->get_plugins() as $type => $plugins) {
714             foreach ($plugins as $plugin) {
715                 $required = $plugin->get_other_required_plugins();
716                 if (isset($required[$component])) {
717                     $others[] = $plugin->component;
718                 }
719             }
720         }
721         return $others;
722     }
724     /**
725      * Check a dependencies list against the list of installed plugins.
726      * @param array $dependencies compenent name to required version or ANY_VERSION.
727      * @return bool true if all the dependencies are satisfied.
728      */
729     public function are_dependencies_satisfied($dependencies) {
730         foreach ($dependencies as $component => $requiredversion) {
731             $otherplugin = $this->get_plugin_info($component);
732             if (is_null($otherplugin)) {
733                 return false;
734             }
736             if ($requiredversion != ANY_VERSION and $otherplugin->versiondisk < $requiredversion) {
737                 return false;
738             }
739         }
741         return true;
742     }
744     /**
745      * Checks all dependencies for all installed plugins
746      *
747      * This is used by install and upgrade. The array passed by reference as the second
748      * argument is populated with the list of plugins that have failed dependencies (note that
749      * a single plugin can appear multiple times in the $failedplugins).
750      *
751      * @param int $moodleversion the version from version.php.
752      * @param array $failedplugins to return the list of plugins with non-satisfied dependencies
753      * @return bool true if all the dependencies are satisfied for all plugins.
754      */
755     public function all_plugins_ok($moodleversion, &$failedplugins = array()) {
757         $return = true;
758         foreach ($this->get_plugins() as $type => $plugins) {
759             foreach ($plugins as $plugin) {
761                 if (!$plugin->is_core_dependency_satisfied($moodleversion)) {
762                     $return = false;
763                     $failedplugins[] = $plugin->component;
764                 }
766                 if (!$this->are_dependencies_satisfied($plugin->get_other_required_plugins())) {
767                     $return = false;
768                     $failedplugins[] = $plugin->component;
769                 }
770             }
771         }
773         return $return;
774     }
776     /**
777      * Resolve requirements and dependencies of a plugin.
778      *
779      * Returns an array of objects describing the requirement/dependency,
780      * indexed by the frankenstyle name of the component. The returned array
781      * can be empty. The objects in the array have following properties:
782      *
783      *  ->(numeric)hasver
784      *  ->(numeric)reqver
785      *  ->(string)status
786      *  ->(string)availability
787      *
788      * @param \core\plugininfo\base $plugin the plugin we are checking
789      * @param null|string|int|double $moodleversion explicit moodle core version to check against, defaults to $CFG->version
790      * @param null|string|int $moodlebranch explicit moodle core branch to check against, defaults to $CFG->branch
791      * @return array of objects
792      */
793     public function resolve_requirements(\core\plugininfo\base $plugin, $moodleversion=null, $moodlebranch=null) {
794         global $CFG;
796         if ($plugin->versiondisk === null) {
797             // Missing from disk, we have no version.php to read from.
798             return array();
799         }
801         if ($moodleversion === null) {
802             $moodleversion = $CFG->version;
803         }
805         if ($moodlebranch === null) {
806             $moodlebranch = $CFG->branch;
807         }
809         $reqs = array();
810         $reqcore = $this->resolve_core_requirements($plugin, $moodleversion);
812         if (!empty($reqcore)) {
813             $reqs['core'] = $reqcore;
814         }
816         foreach ($plugin->get_other_required_plugins() as $reqplug => $reqver) {
817             $reqs[$reqplug] = $this->resolve_dependency_requirements($plugin, $reqplug, $reqver, $moodlebranch);
818         }
820         return $reqs;
821     }
823     /**
824      * Helper method to resolve plugin's requirements on the moodle core.
825      *
826      * @param \core\plugininfo\base $plugin the plugin we are checking
827      * @param string|int|double $moodleversion moodle core branch to check against
828      * @return stdObject
829      */
830     protected function resolve_core_requirements(\core\plugininfo\base $plugin, $moodleversion) {
832         $reqs = (object)array(
833             'hasver' => null,
834             'reqver' => null,
835             'status' => null,
836             'availability' => null,
837         );
839         $reqs->hasver = $moodleversion;
841         if (empty($plugin->versionrequires)) {
842             $reqs->reqver = ANY_VERSION;
843         } else {
844             $reqs->reqver = $plugin->versionrequires;
845         }
847         if ($plugin->is_core_dependency_satisfied($moodleversion)) {
848             $reqs->status = self::REQUIREMENT_STATUS_OK;
849         } else {
850             $reqs->status = self::REQUIREMENT_STATUS_OUTDATED;
851         }
853         return $reqs;
854     }
856     /**
857      * Helper method to resolve plugin's dependecies on other plugins.
858      *
859      * @param \core\plugininfo\base $plugin the plugin we are checking
860      * @param string $otherpluginname
861      * @param string|int $requiredversion
862      * @param string|int $moodlebranch explicit moodle core branch to check against, defaults to $CFG->branch
863      * @return stdClass
864      */
865     protected function resolve_dependency_requirements(\core\plugininfo\base $plugin, $otherpluginname,
866             $requiredversion, $moodlebranch) {
868         $reqs = (object)array(
869             'hasver' => null,
870             'reqver' => null,
871             'status' => null,
872             'availability' => null,
873         );
875         $otherplugin = $this->get_plugin_info($otherpluginname);
877         if ($otherplugin !== null) {
878             // The required plugin is installed.
879             $reqs->hasver = $otherplugin->versiondisk;
880             $reqs->reqver = $requiredversion;
881             // Check it has sufficient version.
882             if ($requiredversion == ANY_VERSION or $otherplugin->versiondisk >= $requiredversion) {
883                 $reqs->status = self::REQUIREMENT_STATUS_OK;
884             } else {
885                 $reqs->status = self::REQUIREMENT_STATUS_OUTDATED;
886             }
888         } else {
889             // The required plugin is not installed.
890             $reqs->hasver = null;
891             $reqs->reqver = $requiredversion;
892             $reqs->status = self::REQUIREMENT_STATUS_MISSING;
893         }
895         if ($reqs->status !== self::REQUIREMENT_STATUS_OK) {
896             if ($this->is_remote_plugin_available($otherpluginname, $requiredversion, false)) {
897                 $reqs->availability = self::REQUIREMENT_AVAILABLE;
898             } else {
899                 $reqs->availability = self::REQUIREMENT_UNAVAILABLE;
900             }
901         }
903         return $reqs;
904     }
906     /**
907      * Is the given plugin version available in the plugins directory?
908      *
909      * See {@link self::get_remote_plugin_info()} for the full explanation of how the $version
910      * parameter is interpretted.
911      *
912      * @param string $component plugin frankenstyle name
913      * @param string|int $version ANY_VERSION or the version number
914      * @param bool $exactmatch false if "given version or higher" is requested
915      * @return boolean
916      */
917     public function is_remote_plugin_available($component, $version, $exactmatch) {
919         $info = $this->get_remote_plugin_info($component, $version, $exactmatch);
921         if (empty($info)) {
922             // There is no available plugin of that name.
923             return false;
924         }
926         if (empty($info->version)) {
927             // Plugin is known, but no suitable version was found.
928             return false;
929         }
931         return true;
932     }
934     /**
935      * Can the given plugin version be installed via the admin UI?
936      *
937      * This check should be used whenever attempting to install a plugin from
938      * the plugins directory (new install, available update, missing dependency).
939      *
940      * @param string $component
941      * @param int $version version number
942      * $param string $reason returned code of the reason why it is not
943      * @return boolean
944      */
945     public function is_remote_plugin_installable($component, $version, &$reason=null) {
946         global $CFG;
948         // Make sure the feature is not disabled.
949         if (!empty($CFG->disableonclickaddoninstall)) {
950             $reason = 'disabled';
951             return false;
952         }
954         // Make sure the version is available.
955         if (!$this->is_remote_plugin_available($component, $version, true)) {
956             $reason = 'remoteunavailable';
957             return false;
958         }
960         // Make sure the plugin type root directory is writable.
961         list($plugintype, $pluginname) = core_component::normalize_component($component);
962         if (!$this->is_plugintype_writable($plugintype)) {
963             $reason = 'notwritableplugintype';
964             return false;
965         }
967         $remoteinfo = $this->get_remote_plugin_info($component, $version, true);
968         $localinfo = $this->get_plugin_info($component);
970         if ($localinfo) {
971             // If the plugin is already present, prevent downgrade.
972             if ($localinfo->versiondb > $remoteinfo->version->version) {
973                 $reason = 'cannotdowngrade';
974                 return false;
975             }
977             // Make sure we have write access to all the existing code.
978             if (is_dir($localinfo->rootdir)) {
979                 if (!$this->is_plugin_folder_removable($component)) {
980                     $reason = 'notwritableplugin';
981                     return false;
982                 }
983             }
984         }
986         // Looks like it could work.
987         return true;
988     }
990     /**
991      * Returns information about a plugin in the plugins directory.
992      *
993      * This is typically used when checking for available dependencies (in
994      * which case the $version represents minimal version we need), or
995      * when installing an available update or a new plugin from the plugins
996      * directory (in which case the $version is exact version we are
997      * interested in). The interpretation of the $version is controlled
998      * by the $exactmatch argument.
999      *
1000      * If a plugin with the given component name is found, data about the
1001      * plugin are returned as an object. The ->version property of the object
1002      * contains the information about the particular plugin version that
1003      * matches best the given critera. The ->version property is false if no
1004      * suitable version of the plugin was found (yet the plugin itself is
1005      * known).
1006      *
1007      * See {@link \core\update\api::validate_pluginfo_format()} for the
1008      * returned data structure.
1009      *
1010      * @param string $component plugin frankenstyle name
1011      * @param string|int $version ANY_VERSION or the version number
1012      * @param bool $exactmatch false if "given version or higher" is requested
1013      * @return \core\update\remote_info|bool
1014      */
1015     public function get_remote_plugin_info($component, $version, $exactmatch) {
1017         if ($exactmatch and $version == ANY_VERSION) {
1018             throw new coding_exception('Invalid request for exactly any version, it does not make sense.');
1019         }
1021         $client = $this->get_update_api_client();
1023         if ($exactmatch) {
1024             // Use client's get_plugin_info() method.
1025             if (!isset($this->remotepluginsinfoexact[$component][$version])) {
1026                 $this->remotepluginsinfoexact[$component][$version] = $client->get_plugin_info($component, $version);
1027             }
1028             return $this->remotepluginsinfoexact[$component][$version];
1030         } else {
1031             // Use client's find_plugin() method.
1032             if (!isset($this->remotepluginsinfoatleast[$component][$version])) {
1033                 $this->remotepluginsinfoatleast[$component][$version] = $client->find_plugin($component, $version);
1034             }
1035             return $this->remotepluginsinfoatleast[$component][$version];
1036         }
1037     }
1039     /**
1040      * Obtain the plugin ZIP file from the given URL
1041      *
1042      * The caller is supposed to know both downloads URL and the MD5 hash of
1043      * the ZIP contents in advance, typically by using the API requests against
1044      * the plugins directory.
1045      *
1046      * @param string $url
1047      * @param string $md5
1048      * @return string|bool full path to the file, false on error
1049      */
1050     public function get_remote_plugin_zip($url, $md5) {
1051         return $this->get_code_manager()->get_remote_plugin_zip($url, $md5);
1052     }
1054     /**
1055      * Extracts the saved plugin ZIP file.
1056      *
1057      * Returns the list of files found in the ZIP. The format of that list is
1058      * array of (string)filerelpath => (bool|string) where the array value is
1059      * either true or a string describing the problematic file.
1060      *
1061      * @see zip_packer::extract_to_pathname()
1062      * @param string $zipfilepath full path to the saved ZIP file
1063      * @param string $targetdir full path to the directory to extract the ZIP file to
1064      * @param string $rootdir explicitly rename the root directory of the ZIP into this non-empty value
1065      * @param array list of extracted files as returned by {@link zip_packer::extract_to_pathname()}
1066      */
1067     public function unzip_plugin_file($zipfilepath, $targetdir, $rootdir = '') {
1068         return $this->get_code_manager()->unzip_plugin_file($zipfilepath, $targetdir, $rootdir);
1069     }
1071     /**
1072      * Return a list of missing dependencies.
1073      *
1074      * This should provide the full list of plugins that should be installed to
1075      * fulfill the requirements of all plugins, if possible.
1076      *
1077      * @param bool $availableonly return only available missing dependencies
1078      * @return array of \core\update\remote_info|bool indexed by the component name
1079      */
1080     public function missing_dependencies($availableonly=false) {
1082         $dependencies = array();
1084         foreach ($this->get_plugins() as $plugintype => $pluginfos) {
1085             foreach ($pluginfos as $pluginname => $pluginfo) {
1086                 foreach ($this->resolve_requirements($pluginfo) as $reqname => $reqinfo) {
1087                     if ($reqname === 'core') {
1088                         continue;
1089                     }
1090                     if ($reqinfo->status != self::REQUIREMENT_STATUS_OK) {
1091                         if ($reqinfo->availability == self::REQUIREMENT_AVAILABLE) {
1092                             $remoteinfo = $this->get_remote_plugin_info($reqname, $reqinfo->reqver, false);
1094                             if (empty($dependencies[$reqname])) {
1095                                 $dependencies[$reqname] = $remoteinfo;
1096                             } else {
1097                                 // If resolving requirements has led to two different versions of the same
1098                                 // remote plugin, pick the higher version. This can happen in cases like one
1099                                 // plugin requiring ANY_VERSION and another plugin requiring specific higher
1100                                 // version with lower maturity of a remote plugin.
1101                                 if ($remoteinfo->version->version > $dependencies[$reqname]->version->version) {
1102                                     $dependencies[$reqname] = $remoteinfo;
1103                                 }
1104                             }
1106                         } else {
1107                             if (!isset($dependencies[$reqname])) {
1108                                 // Unable to find a plugin fulfilling the requirements.
1109                                 $dependencies[$reqname] = false;
1110                             }
1111                         }
1112                     }
1113                 }
1114             }
1115         }
1117         if ($availableonly) {
1118             foreach ($dependencies as $component => $info) {
1119                 if (empty($info) or empty($info->version)) {
1120                     unset($dependencies[$component]);
1121                 }
1122             }
1123         }
1125         return $dependencies;
1126     }
1128     /**
1129      * Is it possible to uninstall the given plugin?
1130      *
1131      * False is returned if the plugininfo subclass declares the uninstall should
1132      * not be allowed via {@link \core\plugininfo\base::is_uninstall_allowed()} or if the
1133      * core vetoes it (e.g. becase the plugin or some of its subplugins is required
1134      * by some other installed plugin).
1135      *
1136      * @param string $component full frankenstyle name, e.g. mod_foobar
1137      * @return bool
1138      */
1139     public function can_uninstall_plugin($component) {
1141         $pluginfo = $this->get_plugin_info($component);
1143         if (is_null($pluginfo)) {
1144             return false;
1145         }
1147         if (!$this->common_uninstall_check($pluginfo)) {
1148             return false;
1149         }
1151         // Verify only if something else requires the subplugins, do not verify their common_uninstall_check()!
1152         $subplugins = $this->get_subplugins_of_plugin($pluginfo->component);
1153         foreach ($subplugins as $subpluginfo) {
1154             // Check if there are some other plugins requiring this subplugin
1155             // (but the parent and siblings).
1156             foreach ($this->other_plugins_that_require($subpluginfo->component) as $requiresme) {
1157                 $ismyparent = ($pluginfo->component === $requiresme);
1158                 $ismysibling = in_array($requiresme, array_keys($subplugins));
1159                 if (!$ismyparent and !$ismysibling) {
1160                     return false;
1161                 }
1162             }
1163         }
1165         // Check if there are some other plugins requiring this plugin
1166         // (but its subplugins).
1167         foreach ($this->other_plugins_that_require($pluginfo->component) as $requiresme) {
1168             $ismysubplugin = in_array($requiresme, array_keys($subplugins));
1169             if (!$ismysubplugin) {
1170                 return false;
1171             }
1172         }
1174         return true;
1175     }
1177     /**
1178      * Returns uninstall URL if exists.
1179      *
1180      * @param string $component
1181      * @param string $return either 'overview' or 'manage'
1182      * @return moodle_url uninstall URL, null if uninstall not supported
1183      */
1184     public function get_uninstall_url($component, $return = 'overview') {
1185         if (!$this->can_uninstall_plugin($component)) {
1186             return null;
1187         }
1189         $pluginfo = $this->get_plugin_info($component);
1191         if (is_null($pluginfo)) {
1192             return null;
1193         }
1195         if (method_exists($pluginfo, 'get_uninstall_url')) {
1196             debugging('plugininfo method get_uninstall_url() is deprecated, all plugins should be uninstalled via standard URL only.');
1197             return $pluginfo->get_uninstall_url($return);
1198         }
1200         return $pluginfo->get_default_uninstall_url($return);
1201     }
1203     /**
1204      * Uninstall the given plugin.
1205      *
1206      * Automatically cleans-up all remaining configuration data, log records, events,
1207      * files from the file pool etc.
1208      *
1209      * In the future, the functionality of {@link uninstall_plugin()} function may be moved
1210      * into this method and all the code should be refactored to use it. At the moment, we
1211      * mimic this future behaviour by wrapping that function call.
1212      *
1213      * @param string $component
1214      * @param progress_trace $progress traces the process
1215      * @return bool true on success, false on errors/problems
1216      */
1217     public function uninstall_plugin($component, progress_trace $progress) {
1219         $pluginfo = $this->get_plugin_info($component);
1221         if (is_null($pluginfo)) {
1222             return false;
1223         }
1225         // Give the pluginfo class a chance to execute some steps.
1226         $result = $pluginfo->uninstall($progress);
1227         if (!$result) {
1228             return false;
1229         }
1231         // Call the legacy core function to uninstall the plugin.
1232         ob_start();
1233         uninstall_plugin($pluginfo->type, $pluginfo->name);
1234         $progress->output(ob_get_clean());
1236         return true;
1237     }
1239     /**
1240      * Checks if there are some plugins with a known available update
1241      *
1242      * @return bool true if there is at least one available update
1243      */
1244     public function some_plugins_updatable() {
1245         foreach ($this->get_plugins() as $type => $plugins) {
1246             foreach ($plugins as $plugin) {
1247                 if ($plugin->available_updates()) {
1248                     return true;
1249                 }
1250             }
1251         }
1253         return false;
1254     }
1256     /**
1257      * Returns list of available updates for the given component.
1258      *
1259      * This method should be considered as internal API and is supposed to be
1260      * called by {@link \core\plugininfo\base::available_updates()} only
1261      * to lazy load the data once they are first requested.
1262      *
1263      * @param string $component frankenstyle name of the plugin
1264      * @return null|array array of \core\update\info objects or null
1265      */
1266     public function load_available_updates_for_plugin($component) {
1267         global $CFG;
1269         $provider = \core\update\checker::instance();
1271         if (!$provider->enabled() or during_initial_install()) {
1272             return null;
1273         }
1275         if (isset($CFG->updateminmaturity)) {
1276             $minmaturity = $CFG->updateminmaturity;
1277         } else {
1278             // This can happen during the very first upgrade to 2.3.
1279             $minmaturity = MATURITY_STABLE;
1280         }
1282         return $provider->get_update_info($component, array('minmaturity' => $minmaturity));
1283     }
1285     /**
1286      * Returns a list of all available updates to be installed.
1287      *
1288      * This is used when "update all plugins" action is performed at the
1289      * administration UI screen.
1290      *
1291      * Returns array of remote info objects indexed by the plugin
1292      * component. If there are multiple updates available (typically a mix of
1293      * stable and non-stable ones), we pick the most mature most recent one.
1294      *
1295      * Plugins without explicit maturity are considered more mature than
1296      * release candidates but less mature than explicit stable (this should be
1297      * pretty rare case).
1298      *
1299      * @return array (string)component => (\core\update\remote_info)remoteinfo
1300      */
1301     public function available_updates() {
1303         $updates = array();
1305         foreach ($this->get_plugins() as $type => $plugins) {
1306             foreach ($plugins as $plugin) {
1307                 $availableupdates = $plugin->available_updates();
1308                 if (empty($availableupdates)) {
1309                     continue;
1310                 }
1311                 foreach ($availableupdates as $update) {
1312                     if (empty($updates[$plugin->component])) {
1313                         $updates[$plugin->component] = $update;
1314                         continue;
1315                     }
1316                     $maturitycurrent = $updates[$plugin->component]->maturity;
1317                     if (empty($maturitycurrent)) {
1318                         $maturitycurrent = MATURITY_STABLE - 25;
1319                     }
1320                     $maturityremote = $update->maturity;
1321                     if (empty($maturityremote)) {
1322                         $maturityremote = MATURITY_STABLE - 25;
1323                     }
1324                     if ($maturityremote < $maturitycurrent) {
1325                         continue;
1326                     }
1327                     if ($maturityremote > $maturitycurrent) {
1328                         $updates[$plugin->component] = $update;
1329                         continue;
1330                     }
1331                     if ($update->version > $updates[$plugin->component]->version) {
1332                         $updates[$plugin->component] = $update;
1333                         continue;
1334                     }
1335                 }
1336             }
1337         }
1339         foreach ($updates as $component => $update) {
1340             $remoteinfo = $this->get_remote_plugin_info($component, $update->version, true);
1341             if (empty($remoteinfo) or empty($remoteinfo->version)) {
1342                 unset($updates[$component]);
1343             } else {
1344                 $updates[$component] = $remoteinfo;
1345             }
1346         }
1348         return $updates;
1349     }
1351     /**
1352      * Check to see if the given plugin folder can be removed by the web server process.
1353      *
1354      * @param string $component full frankenstyle component
1355      * @return bool
1356      */
1357     public function is_plugin_folder_removable($component) {
1359         $pluginfo = $this->get_plugin_info($component);
1361         if (is_null($pluginfo)) {
1362             return false;
1363         }
1365         // To be able to remove the plugin folder, its parent must be writable, too.
1366         if (!is_writable(dirname($pluginfo->rootdir))) {
1367             return false;
1368         }
1370         // Check that the folder and all its content is writable (thence removable).
1371         return $this->is_directory_removable($pluginfo->rootdir);
1372     }
1374     /**
1375      * Is it possible to create a new plugin directory for the given plugin type?
1376      *
1377      * @throws coding_exception for invalid plugin types or non-existing plugin type locations
1378      * @param string $plugintype
1379      * @return boolean
1380      */
1381     public function is_plugintype_writable($plugintype) {
1383         $plugintypepath = $this->get_plugintype_root($plugintype);
1385         if (is_null($plugintypepath)) {
1386             throw new coding_exception('Unknown plugin type: '.$plugintype);
1387         }
1389         if ($plugintypepath === false) {
1390             throw new coding_exception('Plugin type location does not exist: '.$plugintype);
1391         }
1393         return is_writable($plugintypepath);
1394     }
1396     /**
1397      * Returns the full path of the root of the given plugin type
1398      *
1399      * Null is returned if the plugin type is not known. False is returned if
1400      * the plugin type root is expected but not found. Otherwise, string is
1401      * returned.
1402      *
1403      * @param string $plugintype
1404      * @return string|bool|null
1405      */
1406     public function get_plugintype_root($plugintype) {
1408         $plugintypepath = null;
1409         foreach (core_component::get_plugin_types() as $type => $fullpath) {
1410             if ($type === $plugintype) {
1411                 $plugintypepath = $fullpath;
1412                 break;
1413             }
1414         }
1415         if (is_null($plugintypepath)) {
1416             return null;
1417         }
1418         if (!is_dir($plugintypepath)) {
1419             return false;
1420         }
1422         return $plugintypepath;
1423     }
1425     /**
1426      * Defines a list of all plugins that were originally shipped in the standard Moodle distribution,
1427      * but are not anymore and are deleted during upgrades.
1428      *
1429      * The main purpose of this list is to hide missing plugins during upgrade.
1430      *
1431      * @param string $type plugin type
1432      * @param string $name plugin name
1433      * @return bool
1434      */
1435     public static function is_deleted_standard_plugin($type, $name) {
1436         // Do not include plugins that were removed during upgrades to versions that are
1437         // not supported as source versions for upgrade any more. For example, at MOODLE_23_STABLE
1438         // branch, listed should be no plugins that were removed at 1.9.x - 2.1.x versions as
1439         // Moodle 2.3 supports upgrades from 2.2.x only.
1440         $plugins = array(
1441             'qformat' => array('blackboard', 'learnwise'),
1442             'enrol' => array('authorize'),
1443             'tinymce' => array('dragmath'),
1444             'tool' => array('bloglevelupgrade', 'qeupgradehelper', 'timezoneimport'),
1445             'theme' => array('mymobile', 'afterburner', 'anomaly', 'arialist', 'binarius', 'boxxie', 'brick', 'formal_white',
1446                 'formfactor', 'fusion', 'leatherbound', 'magazine', 'nimble', 'nonzero', 'overlay', 'serenity', 'sky_high',
1447                 'splash', 'standard', 'standardold'),
1448         );
1450         if (!isset($plugins[$type])) {
1451             return false;
1452         }
1453         return in_array($name, $plugins[$type]);
1454     }
1456     /**
1457      * Defines a white list of all plugins shipped in the standard Moodle distribution
1458      *
1459      * @param string $type
1460      * @return false|array array of standard plugins or false if the type is unknown
1461      */
1462     public static function standard_plugins_list($type) {
1464         $standard_plugins = array(
1466             'atto' => array(
1467                 'accessibilitychecker', 'accessibilityhelper', 'align',
1468                 'backcolor', 'bold', 'charmap', 'clear', 'collapse', 'emoticon',
1469                 'equation', 'fontcolor', 'html', 'image', 'indent', 'italic',
1470                 'link', 'managefiles', 'media', 'noautolink', 'orderedlist',
1471                 'rtl', 'strike', 'subscript', 'superscript', 'table', 'title',
1472                 'underline', 'undo', 'unorderedlist'
1473             ),
1475             'assignment' => array(
1476                 'offline', 'online', 'upload', 'uploadsingle'
1477             ),
1479             'assignsubmission' => array(
1480                 'comments', 'file', 'onlinetext'
1481             ),
1483             'assignfeedback' => array(
1484                 'comments', 'file', 'offline', 'editpdf'
1485             ),
1487             'auth' => array(
1488                 'cas', 'db', 'email', 'fc', 'imap', 'ldap', 'manual', 'mnet',
1489                 'nntp', 'nologin', 'none', 'pam', 'pop3', 'radius',
1490                 'shibboleth', 'webservice'
1491             ),
1493             'availability' => array(
1494                 'completion', 'date', 'grade', 'group', 'grouping', 'profile'
1495             ),
1497             'block' => array(
1498                 'activity_modules', 'activity_results', 'admin_bookmarks', 'badges',
1499                 'blog_menu', 'blog_recent', 'blog_tags', 'calendar_month',
1500                 'calendar_upcoming', 'comments', 'community',
1501                 'completionstatus', 'course_list', 'course_overview',
1502                 'course_summary', 'feedback', 'glossary_random', 'html',
1503                 'login', 'mentees', 'messages', 'mnet_hosts', 'myprofile',
1504                 'navigation', 'news_items', 'online_users', 'participants',
1505                 'private_files', 'quiz_results', 'recent_activity',
1506                 'rss_client', 'search_forums', 'section_links',
1507                 'selfcompletion', 'settings', 'site_main_menu',
1508                 'social_activities', 'tag_flickr', 'tag_youtube', 'tags'
1509             ),
1511             'booktool' => array(
1512                 'exportimscp', 'importhtml', 'print'
1513             ),
1515             'cachelock' => array(
1516                 'file'
1517             ),
1519             'cachestore' => array(
1520                 'file', 'memcache', 'memcached', 'mongodb', 'session', 'static'
1521             ),
1523             'calendartype' => array(
1524                 'gregorian'
1525             ),
1527             'coursereport' => array(
1528                 // Deprecated!
1529             ),
1531             'datafield' => array(
1532                 'checkbox', 'date', 'file', 'latlong', 'menu', 'multimenu',
1533                 'number', 'picture', 'radiobutton', 'text', 'textarea', 'url'
1534             ),
1536             'datapreset' => array(
1537                 'imagegallery'
1538             ),
1540             'editor' => array(
1541                 'atto', 'textarea', 'tinymce'
1542             ),
1544             'enrol' => array(
1545                 'category', 'cohort', 'database', 'flatfile',
1546                 'guest', 'imsenterprise', 'ldap', 'manual', 'meta', 'mnet',
1547                 'paypal', 'self'
1548             ),
1550             'filter' => array(
1551                 'activitynames', 'algebra', 'censor', 'emailprotect',
1552                 'emoticon', 'mathjaxloader', 'mediaplugin', 'multilang', 'tex', 'tidy',
1553                 'urltolink', 'data', 'glossary'
1554             ),
1556             'format' => array(
1557                 'singleactivity', 'social', 'topics', 'weeks'
1558             ),
1560             'gradeexport' => array(
1561                 'ods', 'txt', 'xls', 'xml'
1562             ),
1564             'gradeimport' => array(
1565                 'csv', 'direct', 'xml'
1566             ),
1568             'gradereport' => array(
1569                 'grader', 'history', 'outcomes', 'overview', 'user', 'singleview'
1570             ),
1572             'gradingform' => array(
1573                 'rubric', 'guide'
1574             ),
1576             'local' => array(
1577             ),
1579             'logstore' => array(
1580                 'database', 'legacy', 'standard',
1581             ),
1583             'ltiservice' => array(
1584                 'memberships', 'profile', 'toolproxy', 'toolsettings'
1585             ),
1587             'message' => array(
1588                 'airnotifier', 'email', 'jabber', 'popup'
1589             ),
1591             'mnetservice' => array(
1592                 'enrol'
1593             ),
1595             'mod' => array(
1596                 'assign', 'assignment', 'book', 'chat', 'choice', 'data', 'feedback', 'folder',
1597                 'forum', 'glossary', 'imscp', 'label', 'lesson', 'lti', 'page',
1598                 'quiz', 'resource', 'scorm', 'survey', 'url', 'wiki', 'workshop'
1599             ),
1601             'plagiarism' => array(
1602             ),
1604             'portfolio' => array(
1605                 'boxnet', 'download', 'flickr', 'googledocs', 'mahara', 'picasa'
1606             ),
1608             'profilefield' => array(
1609                 'checkbox', 'datetime', 'menu', 'text', 'textarea'
1610             ),
1612             'qbehaviour' => array(
1613                 'adaptive', 'adaptivenopenalty', 'deferredcbm',
1614                 'deferredfeedback', 'immediatecbm', 'immediatefeedback',
1615                 'informationitem', 'interactive', 'interactivecountback',
1616                 'manualgraded', 'missing'
1617             ),
1619             'qformat' => array(
1620                 'aiken', 'blackboard_six', 'examview', 'gift',
1621                 'missingword', 'multianswer', 'webct',
1622                 'xhtml', 'xml'
1623             ),
1625             'qtype' => array(
1626                 'calculated', 'calculatedmulti', 'calculatedsimple',
1627                 'ddimageortext', 'ddmarker', 'ddwtos', 'description',
1628                 'essay', 'gapselect', 'match', 'missingtype', 'multianswer',
1629                 'multichoice', 'numerical', 'random', 'randomsamatch',
1630                 'shortanswer', 'truefalse'
1631             ),
1633             'quiz' => array(
1634                 'grading', 'overview', 'responses', 'statistics'
1635             ),
1637             'quizaccess' => array(
1638                 'delaybetweenattempts', 'ipaddress', 'numattempts', 'openclosedate',
1639                 'password', 'safebrowser', 'securewindow', 'timelimit'
1640             ),
1642             'report' => array(
1643                 'backups', 'completion', 'configlog', 'courseoverview', 'eventlist',
1644                 'log', 'loglive', 'outline', 'participation', 'progress', 'questioninstances', 'security', 'stats', 'performance',
1645                 'usersessions',
1646             ),
1648             'repository' => array(
1649                 'alfresco', 'areafiles', 'boxnet', 'coursefiles', 'dropbox', 'equella', 'filesystem',
1650                 'flickr', 'flickr_public', 'googledocs', 'local', 'merlot',
1651                 'picasa', 'recent', 'skydrive', 's3', 'upload', 'url', 'user', 'webdav',
1652                 'wikimedia', 'youtube'
1653             ),
1655             'scormreport' => array(
1656                 'basic',
1657                 'interactions',
1658                 'graphs',
1659                 'objectives'
1660             ),
1662             'tinymce' => array(
1663                 'ctrlhelp', 'managefiles', 'moodleemoticon', 'moodleimage',
1664                 'moodlemedia', 'moodlenolink', 'pdw', 'spellchecker', 'wrap'
1665             ),
1667             'theme' => array(
1668                 'base', 'bootstrapbase', 'canvas', 'clean', 'more'
1669             ),
1671             'tool' => array(
1672                 'assignmentupgrade', 'availabilityconditions', 'behat', 'capability', 'customlang',
1673                 'dbtransfer', 'filetypes', 'generator', 'health', 'innodb', 'installaddon',
1674                 'langimport', 'log', 'messageinbound', 'multilangupgrade', 'monitor', 'phpunit', 'profiling',
1675                 'replace', 'spamcleaner', 'task', 'templatelibrary',
1676                 'unittest', 'uploadcourse', 'uploaduser', 'unsuproles', 'xmldb'
1677             ),
1679             'webservice' => array(
1680                 'amf', 'rest', 'soap', 'xmlrpc'
1681             ),
1683             'workshopallocation' => array(
1684                 'manual', 'random', 'scheduled'
1685             ),
1687             'workshopeval' => array(
1688                 'best'
1689             ),
1691             'workshopform' => array(
1692                 'accumulative', 'comments', 'numerrors', 'rubric'
1693             )
1694         );
1696         if (isset($standard_plugins[$type])) {
1697             return $standard_plugins[$type];
1698         } else {
1699             return false;
1700         }
1701     }
1703     /**
1704      * Removes the plugin code directory if it is not installed yet.
1705      *
1706      * This is intended for the plugins check screen to give the admin a chance
1707      * to cancel the installation of just unzipped plugin before the database
1708      * upgrade happens.
1709      *
1710      * @param string $component
1711      * @return bool
1712      */
1713     public function cancel_plugin_installation($component) {
1715         $plugin = $this->get_plugin_info($component);
1717         if (empty($plugin) or $plugin->is_standard() or $plugin->get_status() !== self::PLUGIN_STATUS_NEW
1718                 or !$this->is_plugin_folder_removable($plugin->component)) {
1719             return false;
1720         }
1722         return remove_dir($plugin->rootdir);
1723     }
1725     /**
1726      * Cancels installation of all new additional plugins.
1727      */
1728     public function cancel_all_plugin_installations() {
1730         foreach ($this->get_plugins() as $type => $plugins) {
1731             foreach ($plugins as $plugin) {
1732                 if (!$plugin->is_standard() and $plugin->get_status() === self::PLUGIN_STATUS_NEW
1733                         and $this->is_plugin_folder_removable($plugin->component)) {
1734                     $this->cancel_plugin_installation($plugin->component);
1735                 }
1736             }
1737         }
1738     }
1740     /**
1741      * Reorders plugin types into a sequence to be displayed
1742      *
1743      * For technical reasons, plugin types returned by {@link core_component::get_plugin_types()} are
1744      * in a certain order that does not need to fit the expected order for the display.
1745      * Particularly, activity modules should be displayed first as they represent the
1746      * real heart of Moodle. They should be followed by other plugin types that are
1747      * used to build the courses (as that is what one expects from LMS). After that,
1748      * other supportive plugin types follow.
1749      *
1750      * @param array $types associative array
1751      * @return array same array with altered order of items
1752      */
1753     protected function reorder_plugin_types(array $types) {
1754         $fix = array('mod' => $types['mod']);
1755         foreach (core_component::get_plugin_list('mod') as $plugin => $fulldir) {
1756             if (!$subtypes = core_component::get_subplugins('mod_'.$plugin)) {
1757                 continue;
1758             }
1759             foreach ($subtypes as $subtype => $ignored) {
1760                 $fix[$subtype] = $types[$subtype];
1761             }
1762         }
1764         $fix['mod']        = $types['mod'];
1765         $fix['block']      = $types['block'];
1766         $fix['qtype']      = $types['qtype'];
1767         $fix['qbehaviour'] = $types['qbehaviour'];
1768         $fix['qformat']    = $types['qformat'];
1769         $fix['filter']     = $types['filter'];
1771         $fix['editor']     = $types['editor'];
1772         foreach (core_component::get_plugin_list('editor') as $plugin => $fulldir) {
1773             if (!$subtypes = core_component::get_subplugins('editor_'.$plugin)) {
1774                 continue;
1775             }
1776             foreach ($subtypes as $subtype => $ignored) {
1777                 $fix[$subtype] = $types[$subtype];
1778             }
1779         }
1781         $fix['enrol'] = $types['enrol'];
1782         $fix['auth']  = $types['auth'];
1783         $fix['tool']  = $types['tool'];
1784         foreach (core_component::get_plugin_list('tool') as $plugin => $fulldir) {
1785             if (!$subtypes = core_component::get_subplugins('tool_'.$plugin)) {
1786                 continue;
1787             }
1788             foreach ($subtypes as $subtype => $ignored) {
1789                 $fix[$subtype] = $types[$subtype];
1790             }
1791         }
1793         foreach ($types as $type => $path) {
1794             if (!isset($fix[$type])) {
1795                 $fix[$type] = $path;
1796             }
1797         }
1798         return $fix;
1799     }
1801     /**
1802      * Check if the given directory can be removed by the web server process.
1803      *
1804      * This recursively checks that the given directory and all its contents
1805      * it writable.
1806      *
1807      * @param string $fullpath
1808      * @return boolean
1809      */
1810     protected function is_directory_removable($fullpath) {
1812         if (!is_writable($fullpath)) {
1813             return false;
1814         }
1816         if (is_dir($fullpath)) {
1817             $handle = opendir($fullpath);
1818         } else {
1819             return false;
1820         }
1822         $result = true;
1824         while ($filename = readdir($handle)) {
1826             if ($filename === '.' or $filename === '..') {
1827                 continue;
1828             }
1830             $subfilepath = $fullpath.'/'.$filename;
1832             if (is_dir($subfilepath)) {
1833                 $result = $result && $this->is_directory_removable($subfilepath);
1835             } else {
1836                 $result = $result && is_writable($subfilepath);
1837             }
1838         }
1840         closedir($handle);
1842         return $result;
1843     }
1845     /**
1846      * Helper method that implements common uninstall prerequisites
1847      *
1848      * @param \core\plugininfo\base $pluginfo
1849      * @return bool
1850      */
1851     protected function common_uninstall_check(\core\plugininfo\base $pluginfo) {
1853         if (!$pluginfo->is_uninstall_allowed()) {
1854             // The plugin's plugininfo class declares it should not be uninstalled.
1855             return false;
1856         }
1858         if ($pluginfo->get_status() === static::PLUGIN_STATUS_NEW) {
1859             // The plugin is not installed. It should be either installed or removed from the disk.
1860             // Relying on this temporary state may be tricky.
1861             return false;
1862         }
1864         if (method_exists($pluginfo, 'get_uninstall_url') and is_null($pluginfo->get_uninstall_url())) {
1865             // Backwards compatibility.
1866             debugging('\core\plugininfo\base subclasses should use is_uninstall_allowed() instead of returning null in get_uninstall_url()',
1867                 DEBUG_DEVELOPER);
1868             return false;
1869         }
1871         return true;
1872     }
1874     /**
1875      * Returns a code_manager instance to be used for the plugins code operations.
1876      *
1877      * @return \core\update\code_manager
1878      */
1879     protected function get_code_manager() {
1881         if ($this->codemanager === null) {
1882             $this->codemanager = new \core\update\code_manager();
1883         }
1885         return $this->codemanager;
1886     }
1888     /**
1889      * Returns a client for https://download.moodle.org/api/
1890      *
1891      * @return \core\update\api
1892      */
1893     protected function get_update_api_client() {
1895         if ($this->updateapiclient === null) {
1896             $this->updateapiclient = \core\update\api::client();
1897         }
1899         return $this->updateapiclient;
1900     }