f75cb0e5b0bf342e70de742a5d95ad1f7fea35e1
[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      * @see \core\update\deployer::plugin_external_source()
671      * @param string $component frankenstyle component name
672      * @return false|string
673      */
674     public function plugin_external_source($component) {
676         $plugininfo = $this->get_plugin_info($component);
678         if (is_null($plugininfo)) {
679             return false;
680         }
682         $pluginroot = $plugininfo->rootdir;
684         if (is_dir($pluginroot.'/.git')) {
685             return 'git';
686         }
688         if (is_file($pluginroot.'/.git')) {
689             return 'git-submodule';
690         }
692         if (is_dir($pluginroot.'/CVS')) {
693             return 'cvs';
694         }
696         if (is_dir($pluginroot.'/.svn')) {
697             return 'svn';
698         }
700         if (is_dir($pluginroot.'/.hg')) {
701             return 'mercurial';
702         }
704         return false;
705     }
707     /**
708      * Get a list of any other plugins that require this one.
709      * @param string $component frankenstyle component name.
710      * @return array of frankensyle component names that require this one.
711      */
712     public function other_plugins_that_require($component) {
713         $others = array();
714         foreach ($this->get_plugins() as $type => $plugins) {
715             foreach ($plugins as $plugin) {
716                 $required = $plugin->get_other_required_plugins();
717                 if (isset($required[$component])) {
718                     $others[] = $plugin->component;
719                 }
720             }
721         }
722         return $others;
723     }
725     /**
726      * Check a dependencies list against the list of installed plugins.
727      * @param array $dependencies compenent name to required version or ANY_VERSION.
728      * @return bool true if all the dependencies are satisfied.
729      */
730     public function are_dependencies_satisfied($dependencies) {
731         foreach ($dependencies as $component => $requiredversion) {
732             $otherplugin = $this->get_plugin_info($component);
733             if (is_null($otherplugin)) {
734                 return false;
735             }
737             if ($requiredversion != ANY_VERSION and $otherplugin->versiondisk < $requiredversion) {
738                 return false;
739             }
740         }
742         return true;
743     }
745     /**
746      * Checks all dependencies for all installed plugins
747      *
748      * This is used by install and upgrade. The array passed by reference as the second
749      * argument is populated with the list of plugins that have failed dependencies (note that
750      * a single plugin can appear multiple times in the $failedplugins).
751      *
752      * @param int $moodleversion the version from version.php.
753      * @param array $failedplugins to return the list of plugins with non-satisfied dependencies
754      * @return bool true if all the dependencies are satisfied for all plugins.
755      */
756     public function all_plugins_ok($moodleversion, &$failedplugins = array()) {
758         $return = true;
759         foreach ($this->get_plugins() as $type => $plugins) {
760             foreach ($plugins as $plugin) {
762                 if (!$plugin->is_core_dependency_satisfied($moodleversion)) {
763                     $return = false;
764                     $failedplugins[] = $plugin->component;
765                 }
767                 if (!$this->are_dependencies_satisfied($plugin->get_other_required_plugins())) {
768                     $return = false;
769                     $failedplugins[] = $plugin->component;
770                 }
771             }
772         }
774         return $return;
775     }
777     /**
778      * Resolve requirements and dependencies of a plugin.
779      *
780      * Returns an array of objects describing the requirement/dependency,
781      * indexed by the frankenstyle name of the component. The returned array
782      * can be empty. The objects in the array have following properties:
783      *
784      *  ->(numeric)hasver
785      *  ->(numeric)reqver
786      *  ->(string)status
787      *  ->(string)availability
788      *
789      * @param \core\plugininfo\base $plugin the plugin we are checking
790      * @param null|string|int|double $moodleversion explicit moodle core version to check against, defaults to $CFG->version
791      * @param null|string|int $moodlebranch explicit moodle core branch to check against, defaults to $CFG->branch
792      * @return array of objects
793      */
794     public function resolve_requirements(\core\plugininfo\base $plugin, $moodleversion=null, $moodlebranch=null) {
795         global $CFG;
797         if ($plugin->versiondisk === null) {
798             // Missing from disk, we have no version.php to read from.
799             return array();
800         }
802         if ($moodleversion === null) {
803             $moodleversion = $CFG->version;
804         }
806         if ($moodlebranch === null) {
807             $moodlebranch = $CFG->branch;
808         }
810         $reqs = array();
811         $reqcore = $this->resolve_core_requirements($plugin, $moodleversion);
813         if (!empty($reqcore)) {
814             $reqs['core'] = $reqcore;
815         }
817         foreach ($plugin->get_other_required_plugins() as $reqplug => $reqver) {
818             $reqs[$reqplug] = $this->resolve_dependency_requirements($plugin, $reqplug, $reqver, $moodlebranch);
819         }
821         return $reqs;
822     }
824     /**
825      * Helper method to resolve plugin's requirements on the moodle core.
826      *
827      * @param \core\plugininfo\base $plugin the plugin we are checking
828      * @param string|int|double $moodleversion moodle core branch to check against
829      * @return stdObject
830      */
831     protected function resolve_core_requirements(\core\plugininfo\base $plugin, $moodleversion) {
833         $reqs = (object)array(
834             'hasver' => null,
835             'reqver' => null,
836             'status' => null,
837             'availability' => null,
838         );
840         $reqs->hasver = $moodleversion;
842         if (empty($plugin->versionrequires)) {
843             $reqs->reqver = ANY_VERSION;
844         } else {
845             $reqs->reqver = $plugin->versionrequires;
846         }
848         if ($plugin->is_core_dependency_satisfied($moodleversion)) {
849             $reqs->status = self::REQUIREMENT_STATUS_OK;
850         } else {
851             $reqs->status = self::REQUIREMENT_STATUS_OUTDATED;
852         }
854         return $reqs;
855     }
857     /**
858      * Helper method to resolve plugin's dependecies on other plugins.
859      *
860      * @param \core\plugininfo\base $plugin the plugin we are checking
861      * @param string $otherpluginname
862      * @param string|int $requiredversion
863      * @param string|int $moodlebranch explicit moodle core branch to check against, defaults to $CFG->branch
864      * @return stdClass
865      */
866     protected function resolve_dependency_requirements(\core\plugininfo\base $plugin, $otherpluginname,
867             $requiredversion, $moodlebranch) {
869         $reqs = (object)array(
870             'hasver' => null,
871             'reqver' => null,
872             'status' => null,
873             'availability' => null,
874         );
876         $otherplugin = $this->get_plugin_info($otherpluginname);
878         if ($otherplugin !== null) {
879             // The required plugin is installed.
880             $reqs->hasver = $otherplugin->versiondisk;
881             $reqs->reqver = $requiredversion;
882             // Check it has sufficient version.
883             if ($requiredversion == ANY_VERSION or $otherplugin->versiondisk >= $requiredversion) {
884                 $reqs->status = self::REQUIREMENT_STATUS_OK;
885             } else {
886                 $reqs->status = self::REQUIREMENT_STATUS_OUTDATED;
887             }
889         } else {
890             // The required plugin is not installed.
891             $reqs->hasver = null;
892             $reqs->reqver = $requiredversion;
893             $reqs->status = self::REQUIREMENT_STATUS_MISSING;
894         }
896         if ($reqs->status !== self::REQUIREMENT_STATUS_OK) {
897             if ($this->is_remote_plugin_available($otherpluginname, $requiredversion, false)) {
898                 $reqs->availability = self::REQUIREMENT_AVAILABLE;
899             } else {
900                 $reqs->availability = self::REQUIREMENT_UNAVAILABLE;
901             }
902         }
904         return $reqs;
905     }
907     /**
908      * Is the given plugin version available in the plugins directory?
909      *
910      * See {@link self::get_remote_plugin_info()} for the full explanation of how the $version
911      * parameter is interpretted.
912      *
913      * @param string $component plugin frankenstyle name
914      * @param string|int $version ANY_VERSION or the version number
915      * @param bool $exactmatch false if "given version or higher" is requested
916      * @return boolean
917      */
918     public function is_remote_plugin_available($component, $version, $exactmatch) {
920         $info = $this->get_remote_plugin_info($component, $version, $exactmatch);
922         if (empty($info)) {
923             // There is no available plugin of that name.
924             return false;
925         }
927         if (empty($info->version)) {
928             // Plugin is known, but no suitable version was found.
929             return false;
930         }
932         return true;
933     }
935     /**
936      * Can the given plugin version be installed via the admin UI?
937      *
938      * This check should be used whenever attempting to install a plugin from
939      * the plugins directory (new install, available update, missing dependency).
940      *
941      * @param string $component
942      * @param int $version version number
943      * $param string $reason returned code of the reason why it is not
944      * @return boolean
945      */
946     public function is_remote_plugin_installable($component, $version, &$reason=null) {
947         global $CFG;
949         // Make sure the feature is not disabled.
950         if (!empty($CFG->disableonclickaddoninstall)) {
951             $reason = 'disabled';
952             return false;
953         }
955         // Make sure the version is available.
956         if (!$this->is_remote_plugin_available($component, $version, true)) {
957             $reason = 'remoteunavailable';
958             return false;
959         }
961         // Make sure the plugin type root directory is writable.
962         list($plugintype, $pluginname) = core_component::normalize_component($component);
963         if (!$this->is_plugintype_writable($plugintype)) {
964             $reason = 'notwritableplugintype';
965             return false;
966         }
968         $remoteinfo = $this->get_remote_plugin_info($component, $version, true);
969         $localinfo = $this->get_plugin_info($component);
971         if ($localinfo) {
972             // If the plugin is already present, prevent downgrade.
973             if ($localinfo->versiondb > $remoteinfo->version->version) {
974                 $reason = 'cannotdowngrade';
975                 return false;
976             }
978             // Make sure we have write access to all the existing code.
979             if (is_dir($localinfo->rootdir)) {
980                 if (!$this->is_plugin_folder_removable($component)) {
981                     $reason = 'notwritableplugin';
982                     return false;
983                 }
984             }
985         }
987         // Looks like it could work.
988         return true;
989     }
991     /**
992      * Returns information about a plugin in the plugins directory.
993      *
994      * This is typically used when checking for available dependencies (in
995      * which case the $version represents minimal version we need), or
996      * when installing an available update or a new plugin from the plugins
997      * directory (in which case the $version is exact version we are
998      * interested in). The interpretation of the $version is controlled
999      * by the $exactmatch argument.
1000      *
1001      * If a plugin with the given component name is found, data about the
1002      * plugin are returned as an object. The ->version property of the object
1003      * contains the information about the particular plugin version that
1004      * matches best the given critera. The ->version property is false if no
1005      * suitable version of the plugin was found (yet the plugin itself is
1006      * known).
1007      *
1008      * See {@link \core\update\api::validate_pluginfo_format()} for the
1009      * returned data structure.
1010      *
1011      * @param string $component plugin frankenstyle name
1012      * @param string|int $version ANY_VERSION or the version number
1013      * @param bool $exactmatch false if "given version or higher" is requested
1014      * @return stdClass|bool false or data object
1015      */
1016     public function get_remote_plugin_info($component, $version, $exactmatch) {
1018         if ($exactmatch and $version == ANY_VERSION) {
1019             throw new coding_exception('Invalid request for exactly any version, it does not make sense.');
1020         }
1022         $client = $this->get_update_api_client();
1024         if ($exactmatch) {
1025             // Use client's get_plugin_info() method.
1026             if (!isset($this->remotepluginsinfoexact[$component][$version])) {
1027                 $this->remotepluginsinfoexact[$component][$version] = $client->get_plugin_info($component, $version);
1028             }
1029             return $this->remotepluginsinfoexact[$component][$version];
1031         } else {
1032             // Use client's find_plugin() method.
1033             if (!isset($this->remotepluginsinfoatleast[$component][$version])) {
1034                 $this->remotepluginsinfoatleast[$component][$version] = $client->find_plugin($component, $version);
1035             }
1036             return $this->remotepluginsinfoatleast[$component][$version];
1037         }
1038     }
1040     /**
1041      * Obtain the plugin ZIP file from the given URL
1042      *
1043      * The caller is supposed to know both downloads URL and the MD5 hash of
1044      * the ZIP contents in advance, typically by using the API requests against
1045      * the plugins directory.
1046      *
1047      * @param string $url
1048      * @param string $md5
1049      * @return string|bool full path to the file, false on error
1050      */
1051     public function get_remote_plugin_zip($url, $md5) {
1052         return $this->get_code_manager()->get_remote_plugin_zip($url, $md5);
1053     }
1055     /**
1056      * Extracts the saved plugin ZIP file.
1057      *
1058      * Returns the list of files found in the ZIP. The format of that list is
1059      * array of (string)filerelpath => (bool|string) where the array value is
1060      * either true or a string describing the problematic file.
1061      *
1062      * @see zip_packer::extract_to_pathname()
1063      * @param string $zipfilepath full path to the saved ZIP file
1064      * @param string $targetdir full path to the directory to extract the ZIP file to
1065      * @param string $rootdir explicitly rename the root directory of the ZIP into this non-empty value
1066      * @param array list of extracted files as returned by {@link zip_packer::extract_to_pathname()}
1067      */
1068     public function unzip_plugin_file($zipfilepath, $targetdir, $rootdir = '') {
1069         return $this->get_code_manager()->unzip_plugin_file($zipfilepath, $targetdir, $rootdir);
1070     }
1072     /**
1073      * Return a list of missing dependencies.
1074      *
1075      * This should provide the full list of plugins that should be installed to
1076      * fulfill the requirements of all plugins, if possible.
1077      *
1078      * @param bool $availableonly return only available missing dependencies
1079      * @return array of stdClass|bool indexed by the component name
1080      */
1081     public function missing_dependencies($availableonly=false) {
1083         $dependencies = array();
1085         foreach ($this->get_plugins() as $plugintype => $pluginfos) {
1086             foreach ($pluginfos as $pluginname => $pluginfo) {
1087                 foreach ($this->resolve_requirements($pluginfo) as $reqname => $reqinfo) {
1088                     if ($reqname === 'core') {
1089                         continue;
1090                     }
1091                     if ($reqinfo->status != self::REQUIREMENT_STATUS_OK) {
1092                         if ($reqinfo->availability == self::REQUIREMENT_AVAILABLE) {
1093                             $remoteinfo = $this->get_remote_plugin_info($reqname, $reqinfo->reqver, false);
1095                             if (empty($dependencies[$reqname])) {
1096                                 $dependencies[$reqname] = $remoteinfo;
1097                             } else {
1098                                 // If resolving requirements has led to two different versions of the same
1099                                 // remote plugin, pick the higher version. This can happen in cases like one
1100                                 // plugin requiring ANY_VERSION and another plugin requiring specific higher
1101                                 // version with lower maturity of a remote plugin.
1102                                 if ($remoteinfo->version->version > $dependencies[$reqname]->version->version) {
1103                                     $dependencies[$reqname] = $remoteinfo;
1104                                 }
1105                             }
1107                         } else {
1108                             if (!isset($dependencies[$reqname])) {
1109                                 // Unable to find a plugin fulfilling the requirements.
1110                                 $dependencies[$reqname] = false;
1111                             }
1112                         }
1113                     }
1114                 }
1115             }
1116         }
1118         if ($availableonly) {
1119             foreach ($dependencies as $component => $info) {
1120                 if (empty($info) or empty($info->version)) {
1121                     unset($dependencies[$component]);
1122                 }
1123             }
1124         }
1126         return $dependencies;
1127     }
1129     /**
1130      * Is it possible to uninstall the given plugin?
1131      *
1132      * False is returned if the plugininfo subclass declares the uninstall should
1133      * not be allowed via {@link \core\plugininfo\base::is_uninstall_allowed()} or if the
1134      * core vetoes it (e.g. becase the plugin or some of its subplugins is required
1135      * by some other installed plugin).
1136      *
1137      * @param string $component full frankenstyle name, e.g. mod_foobar
1138      * @return bool
1139      */
1140     public function can_uninstall_plugin($component) {
1142         $pluginfo = $this->get_plugin_info($component);
1144         if (is_null($pluginfo)) {
1145             return false;
1146         }
1148         if (!$this->common_uninstall_check($pluginfo)) {
1149             return false;
1150         }
1152         // Verify only if something else requires the subplugins, do not verify their common_uninstall_check()!
1153         $subplugins = $this->get_subplugins_of_plugin($pluginfo->component);
1154         foreach ($subplugins as $subpluginfo) {
1155             // Check if there are some other plugins requiring this subplugin
1156             // (but the parent and siblings).
1157             foreach ($this->other_plugins_that_require($subpluginfo->component) as $requiresme) {
1158                 $ismyparent = ($pluginfo->component === $requiresme);
1159                 $ismysibling = in_array($requiresme, array_keys($subplugins));
1160                 if (!$ismyparent and !$ismysibling) {
1161                     return false;
1162                 }
1163             }
1164         }
1166         // Check if there are some other plugins requiring this plugin
1167         // (but its subplugins).
1168         foreach ($this->other_plugins_that_require($pluginfo->component) as $requiresme) {
1169             $ismysubplugin = in_array($requiresme, array_keys($subplugins));
1170             if (!$ismysubplugin) {
1171                 return false;
1172             }
1173         }
1175         return true;
1176     }
1178     /**
1179      * Returns uninstall URL if exists.
1180      *
1181      * @param string $component
1182      * @param string $return either 'overview' or 'manage'
1183      * @return moodle_url uninstall URL, null if uninstall not supported
1184      */
1185     public function get_uninstall_url($component, $return = 'overview') {
1186         if (!$this->can_uninstall_plugin($component)) {
1187             return null;
1188         }
1190         $pluginfo = $this->get_plugin_info($component);
1192         if (is_null($pluginfo)) {
1193             return null;
1194         }
1196         if (method_exists($pluginfo, 'get_uninstall_url')) {
1197             debugging('plugininfo method get_uninstall_url() is deprecated, all plugins should be uninstalled via standard URL only.');
1198             return $pluginfo->get_uninstall_url($return);
1199         }
1201         return $pluginfo->get_default_uninstall_url($return);
1202     }
1204     /**
1205      * Uninstall the given plugin.
1206      *
1207      * Automatically cleans-up all remaining configuration data, log records, events,
1208      * files from the file pool etc.
1209      *
1210      * In the future, the functionality of {@link uninstall_plugin()} function may be moved
1211      * into this method and all the code should be refactored to use it. At the moment, we
1212      * mimic this future behaviour by wrapping that function call.
1213      *
1214      * @param string $component
1215      * @param progress_trace $progress traces the process
1216      * @return bool true on success, false on errors/problems
1217      */
1218     public function uninstall_plugin($component, progress_trace $progress) {
1220         $pluginfo = $this->get_plugin_info($component);
1222         if (is_null($pluginfo)) {
1223             return false;
1224         }
1226         // Give the pluginfo class a chance to execute some steps.
1227         $result = $pluginfo->uninstall($progress);
1228         if (!$result) {
1229             return false;
1230         }
1232         // Call the legacy core function to uninstall the plugin.
1233         ob_start();
1234         uninstall_plugin($pluginfo->type, $pluginfo->name);
1235         $progress->output(ob_get_clean());
1237         return true;
1238     }
1240     /**
1241      * Checks if there are some plugins with a known available update
1242      *
1243      * @return bool true if there is at least one available update
1244      */
1245     public function some_plugins_updatable() {
1246         foreach ($this->get_plugins() as $type => $plugins) {
1247             foreach ($plugins as $plugin) {
1248                 if ($plugin->available_updates()) {
1249                     return true;
1250                 }
1251             }
1252         }
1254         return false;
1255     }
1257     /**
1258      * Returns list of available updates for the given component.
1259      *
1260      * This method should be considered as internal API and is supposed to be
1261      * called by {@link \core\plugininfo\base::available_updates()} only
1262      * to lazy load the data once they are first requested.
1263      *
1264      * @param string $component frankenstyle name of the plugin
1265      * @return null|array array of \core\update\info objects or null
1266      */
1267     public function load_available_updates_for_plugin($component) {
1268         global $CFG;
1270         $provider = \core\update\checker::instance();
1272         if (!$provider->enabled() or during_initial_install()) {
1273             return null;
1274         }
1276         if (isset($CFG->updateminmaturity)) {
1277             $minmaturity = $CFG->updateminmaturity;
1278         } else {
1279             // This can happen during the very first upgrade to 2.3.
1280             $minmaturity = MATURITY_STABLE;
1281         }
1283         return $provider->get_update_info($component, array('minmaturity' => $minmaturity));
1284     }
1286     /**
1287      * Check to see if the given plugin folder can be removed by the web server process.
1288      *
1289      * @param string $component full frankenstyle component
1290      * @return bool
1291      */
1292     public function is_plugin_folder_removable($component) {
1294         $pluginfo = $this->get_plugin_info($component);
1296         if (is_null($pluginfo)) {
1297             return false;
1298         }
1300         // To be able to remove the plugin folder, its parent must be writable, too.
1301         if (!is_writable(dirname($pluginfo->rootdir))) {
1302             return false;
1303         }
1305         // Check that the folder and all its content is writable (thence removable).
1306         return $this->is_directory_removable($pluginfo->rootdir);
1307     }
1309     /**
1310      * Is it possible to create a new plugin directory for the given plugin type?
1311      *
1312      * @throws coding_exception for invalid plugin types or non-existing plugin type locations
1313      * @param string $plugintype
1314      * @return boolean
1315      */
1316     public function is_plugintype_writable($plugintype) {
1318         $plugintypepath = $this->get_plugintype_root($plugintype);
1320         if (is_null($plugintypepath)) {
1321             throw new coding_exception('Unknown plugin type: '.$plugintype);
1322         }
1324         if ($plugintypepath === false) {
1325             throw new coding_exception('Plugin type location does not exist: '.$plugintype);
1326         }
1328         return is_writable($plugintypepath);
1329     }
1331     /**
1332      * Returns the full path of the root of the given plugin type
1333      *
1334      * Null is returned if the plugin type is not known. False is returned if
1335      * the plugin type root is expected but not found. Otherwise, string is
1336      * returned.
1337      *
1338      * @param string $plugintype
1339      * @return string|bool|null
1340      */
1341     public function get_plugintype_root($plugintype) {
1343         $plugintypepath = null;
1344         foreach (core_component::get_plugin_types() as $type => $fullpath) {
1345             if ($type === $plugintype) {
1346                 $plugintypepath = $fullpath;
1347                 break;
1348             }
1349         }
1350         if (is_null($plugintypepath)) {
1351             return null;
1352         }
1353         if (!is_dir($plugintypepath)) {
1354             return false;
1355         }
1357         return $plugintypepath;
1358     }
1360     /**
1361      * Defines a list of all plugins that were originally shipped in the standard Moodle distribution,
1362      * but are not anymore and are deleted during upgrades.
1363      *
1364      * The main purpose of this list is to hide missing plugins during upgrade.
1365      *
1366      * @param string $type plugin type
1367      * @param string $name plugin name
1368      * @return bool
1369      */
1370     public static function is_deleted_standard_plugin($type, $name) {
1371         // Do not include plugins that were removed during upgrades to versions that are
1372         // not supported as source versions for upgrade any more. For example, at MOODLE_23_STABLE
1373         // branch, listed should be no plugins that were removed at 1.9.x - 2.1.x versions as
1374         // Moodle 2.3 supports upgrades from 2.2.x only.
1375         $plugins = array(
1376             'qformat' => array('blackboard', 'learnwise'),
1377             'enrol' => array('authorize'),
1378             'tinymce' => array('dragmath'),
1379             'tool' => array('bloglevelupgrade', 'qeupgradehelper', 'timezoneimport'),
1380             'theme' => array('mymobile', 'afterburner', 'anomaly', 'arialist', 'binarius', 'boxxie', 'brick', 'formal_white',
1381                 'formfactor', 'fusion', 'leatherbound', 'magazine', 'nimble', 'nonzero', 'overlay', 'serenity', 'sky_high',
1382                 'splash', 'standard', 'standardold'),
1383         );
1385         if (!isset($plugins[$type])) {
1386             return false;
1387         }
1388         return in_array($name, $plugins[$type]);
1389     }
1391     /**
1392      * Defines a white list of all plugins shipped in the standard Moodle distribution
1393      *
1394      * @param string $type
1395      * @return false|array array of standard plugins or false if the type is unknown
1396      */
1397     public static function standard_plugins_list($type) {
1399         $standard_plugins = array(
1401             'atto' => array(
1402                 'accessibilitychecker', 'accessibilityhelper', 'align',
1403                 'backcolor', 'bold', 'charmap', 'clear', 'collapse', 'emoticon',
1404                 'equation', 'fontcolor', 'html', 'image', 'indent', 'italic',
1405                 'link', 'managefiles', 'media', 'noautolink', 'orderedlist',
1406                 'rtl', 'strike', 'subscript', 'superscript', 'table', 'title',
1407                 'underline', 'undo', 'unorderedlist'
1408             ),
1410             'assignment' => array(
1411                 'offline', 'online', 'upload', 'uploadsingle'
1412             ),
1414             'assignsubmission' => array(
1415                 'comments', 'file', 'onlinetext'
1416             ),
1418             'assignfeedback' => array(
1419                 'comments', 'file', 'offline', 'editpdf'
1420             ),
1422             'auth' => array(
1423                 'cas', 'db', 'email', 'fc', 'imap', 'ldap', 'manual', 'mnet',
1424                 'nntp', 'nologin', 'none', 'pam', 'pop3', 'radius',
1425                 'shibboleth', 'webservice'
1426             ),
1428             'availability' => array(
1429                 'completion', 'date', 'grade', 'group', 'grouping', 'profile'
1430             ),
1432             'block' => array(
1433                 'activity_modules', 'activity_results', 'admin_bookmarks', 'badges',
1434                 'blog_menu', 'blog_recent', 'blog_tags', 'calendar_month',
1435                 'calendar_upcoming', 'comments', 'community',
1436                 'completionstatus', 'course_list', 'course_overview',
1437                 'course_summary', 'feedback', 'glossary_random', 'html',
1438                 'login', 'mentees', 'messages', 'mnet_hosts', 'myprofile',
1439                 'navigation', 'news_items', 'online_users', 'participants',
1440                 'private_files', 'quiz_results', 'recent_activity',
1441                 'rss_client', 'search_forums', 'section_links',
1442                 'selfcompletion', 'settings', 'site_main_menu',
1443                 'social_activities', 'tag_flickr', 'tag_youtube', 'tags'
1444             ),
1446             'booktool' => array(
1447                 'exportimscp', 'importhtml', 'print'
1448             ),
1450             'cachelock' => array(
1451                 'file'
1452             ),
1454             'cachestore' => array(
1455                 'file', 'memcache', 'memcached', 'mongodb', 'session', 'static'
1456             ),
1458             'calendartype' => array(
1459                 'gregorian'
1460             ),
1462             'coursereport' => array(
1463                 // Deprecated!
1464             ),
1466             'datafield' => array(
1467                 'checkbox', 'date', 'file', 'latlong', 'menu', 'multimenu',
1468                 'number', 'picture', 'radiobutton', 'text', 'textarea', 'url'
1469             ),
1471             'datapreset' => array(
1472                 'imagegallery'
1473             ),
1475             'editor' => array(
1476                 'atto', 'textarea', 'tinymce'
1477             ),
1479             'enrol' => array(
1480                 'category', 'cohort', 'database', 'flatfile',
1481                 'guest', 'imsenterprise', 'ldap', 'manual', 'meta', 'mnet',
1482                 'paypal', 'self'
1483             ),
1485             'filter' => array(
1486                 'activitynames', 'algebra', 'censor', 'emailprotect',
1487                 'emoticon', 'mathjaxloader', 'mediaplugin', 'multilang', 'tex', 'tidy',
1488                 'urltolink', 'data', 'glossary'
1489             ),
1491             'format' => array(
1492                 'singleactivity', 'social', 'topics', 'weeks'
1493             ),
1495             'gradeexport' => array(
1496                 'ods', 'txt', 'xls', 'xml'
1497             ),
1499             'gradeimport' => array(
1500                 'csv', 'direct', 'xml'
1501             ),
1503             'gradereport' => array(
1504                 'grader', 'history', 'outcomes', 'overview', 'user', 'singleview'
1505             ),
1507             'gradingform' => array(
1508                 'rubric', 'guide'
1509             ),
1511             'local' => array(
1512             ),
1514             'logstore' => array(
1515                 'database', 'legacy', 'standard',
1516             ),
1518             'ltiservice' => array(
1519                 'memberships', 'profile', 'toolproxy', 'toolsettings'
1520             ),
1522             'message' => array(
1523                 'airnotifier', 'email', 'jabber', 'popup'
1524             ),
1526             'mnetservice' => array(
1527                 'enrol'
1528             ),
1530             'mod' => array(
1531                 'assign', 'assignment', 'book', 'chat', 'choice', 'data', 'feedback', 'folder',
1532                 'forum', 'glossary', 'imscp', 'label', 'lesson', 'lti', 'page',
1533                 'quiz', 'resource', 'scorm', 'survey', 'url', 'wiki', 'workshop'
1534             ),
1536             'plagiarism' => array(
1537             ),
1539             'portfolio' => array(
1540                 'boxnet', 'download', 'flickr', 'googledocs', 'mahara', 'picasa'
1541             ),
1543             'profilefield' => array(
1544                 'checkbox', 'datetime', 'menu', 'text', 'textarea'
1545             ),
1547             'qbehaviour' => array(
1548                 'adaptive', 'adaptivenopenalty', 'deferredcbm',
1549                 'deferredfeedback', 'immediatecbm', 'immediatefeedback',
1550                 'informationitem', 'interactive', 'interactivecountback',
1551                 'manualgraded', 'missing'
1552             ),
1554             'qformat' => array(
1555                 'aiken', 'blackboard_six', 'examview', 'gift',
1556                 'missingword', 'multianswer', 'webct',
1557                 'xhtml', 'xml'
1558             ),
1560             'qtype' => array(
1561                 'calculated', 'calculatedmulti', 'calculatedsimple',
1562                 'ddimageortext', 'ddmarker', 'ddwtos', 'description',
1563                 'essay', 'gapselect', 'match', 'missingtype', 'multianswer',
1564                 'multichoice', 'numerical', 'random', 'randomsamatch',
1565                 'shortanswer', 'truefalse'
1566             ),
1568             'quiz' => array(
1569                 'grading', 'overview', 'responses', 'statistics'
1570             ),
1572             'quizaccess' => array(
1573                 'delaybetweenattempts', 'ipaddress', 'numattempts', 'openclosedate',
1574                 'password', 'safebrowser', 'securewindow', 'timelimit'
1575             ),
1577             'report' => array(
1578                 'backups', 'completion', 'configlog', 'courseoverview', 'eventlist',
1579                 'log', 'loglive', 'outline', 'participation', 'progress', 'questioninstances', 'security', 'stats', 'performance',
1580                 'usersessions',
1581             ),
1583             'repository' => array(
1584                 'alfresco', 'areafiles', 'boxnet', 'coursefiles', 'dropbox', 'equella', 'filesystem',
1585                 'flickr', 'flickr_public', 'googledocs', 'local', 'merlot',
1586                 'picasa', 'recent', 'skydrive', 's3', 'upload', 'url', 'user', 'webdav',
1587                 'wikimedia', 'youtube'
1588             ),
1590             'scormreport' => array(
1591                 'basic',
1592                 'interactions',
1593                 'graphs',
1594                 'objectives'
1595             ),
1597             'tinymce' => array(
1598                 'ctrlhelp', 'managefiles', 'moodleemoticon', 'moodleimage',
1599                 'moodlemedia', 'moodlenolink', 'pdw', 'spellchecker', 'wrap'
1600             ),
1602             'theme' => array(
1603                 'base', 'bootstrapbase', 'canvas', 'clean', 'more'
1604             ),
1606             'tool' => array(
1607                 'assignmentupgrade', 'availabilityconditions', 'behat', 'capability', 'customlang',
1608                 'dbtransfer', 'filetypes', 'generator', 'health', 'innodb', 'installaddon',
1609                 'langimport', 'log', 'messageinbound', 'multilangupgrade', 'monitor', 'phpunit', 'profiling',
1610                 'replace', 'spamcleaner', 'task', 'templatelibrary',
1611                 'unittest', 'uploadcourse', 'uploaduser', 'unsuproles', 'xmldb'
1612             ),
1614             'webservice' => array(
1615                 'amf', 'rest', 'soap', 'xmlrpc'
1616             ),
1618             'workshopallocation' => array(
1619                 'manual', 'random', 'scheduled'
1620             ),
1622             'workshopeval' => array(
1623                 'best'
1624             ),
1626             'workshopform' => array(
1627                 'accumulative', 'comments', 'numerrors', 'rubric'
1628             )
1629         );
1631         if (isset($standard_plugins[$type])) {
1632             return $standard_plugins[$type];
1633         } else {
1634             return false;
1635         }
1636     }
1638     /**
1639      * Removes the plugin code directory if it is not installed yet.
1640      *
1641      * This is intended for the plugins check screen to give the admin a chance
1642      * to cancel the installation of just unzipped plugin before the database
1643      * upgrade happens.
1644      *
1645      * @param string $component
1646      * @return bool
1647      */
1648     public function cancel_plugin_installation($component) {
1650         $plugin = $this->get_plugin_info($component);
1652         if (empty($plugin) or $plugin->is_standard() or $plugin->get_status() !== self::PLUGIN_STATUS_NEW
1653                 or !$this->is_plugin_folder_removable($plugin->component)) {
1654             return false;
1655         }
1657         return remove_dir($plugin->rootdir);
1658     }
1660     /**
1661      * Cancels installation of all new additional plugins.
1662      */
1663     public function cancel_all_plugin_installations() {
1665         foreach ($this->get_plugins() as $type => $plugins) {
1666             foreach ($plugins as $plugin) {
1667                 if (!$plugin->is_standard() and $plugin->get_status() === self::PLUGIN_STATUS_NEW
1668                         and $this->is_plugin_folder_removable($plugin->component)) {
1669                     $this->cancel_plugin_installation($plugin->component);
1670                 }
1671             }
1672         }
1673     }
1675     /**
1676      * Reorders plugin types into a sequence to be displayed
1677      *
1678      * For technical reasons, plugin types returned by {@link core_component::get_plugin_types()} are
1679      * in a certain order that does not need to fit the expected order for the display.
1680      * Particularly, activity modules should be displayed first as they represent the
1681      * real heart of Moodle. They should be followed by other plugin types that are
1682      * used to build the courses (as that is what one expects from LMS). After that,
1683      * other supportive plugin types follow.
1684      *
1685      * @param array $types associative array
1686      * @return array same array with altered order of items
1687      */
1688     protected function reorder_plugin_types(array $types) {
1689         $fix = array('mod' => $types['mod']);
1690         foreach (core_component::get_plugin_list('mod') as $plugin => $fulldir) {
1691             if (!$subtypes = core_component::get_subplugins('mod_'.$plugin)) {
1692                 continue;
1693             }
1694             foreach ($subtypes as $subtype => $ignored) {
1695                 $fix[$subtype] = $types[$subtype];
1696             }
1697         }
1699         $fix['mod']        = $types['mod'];
1700         $fix['block']      = $types['block'];
1701         $fix['qtype']      = $types['qtype'];
1702         $fix['qbehaviour'] = $types['qbehaviour'];
1703         $fix['qformat']    = $types['qformat'];
1704         $fix['filter']     = $types['filter'];
1706         $fix['editor']     = $types['editor'];
1707         foreach (core_component::get_plugin_list('editor') as $plugin => $fulldir) {
1708             if (!$subtypes = core_component::get_subplugins('editor_'.$plugin)) {
1709                 continue;
1710             }
1711             foreach ($subtypes as $subtype => $ignored) {
1712                 $fix[$subtype] = $types[$subtype];
1713             }
1714         }
1716         $fix['enrol'] = $types['enrol'];
1717         $fix['auth']  = $types['auth'];
1718         $fix['tool']  = $types['tool'];
1719         foreach (core_component::get_plugin_list('tool') as $plugin => $fulldir) {
1720             if (!$subtypes = core_component::get_subplugins('tool_'.$plugin)) {
1721                 continue;
1722             }
1723             foreach ($subtypes as $subtype => $ignored) {
1724                 $fix[$subtype] = $types[$subtype];
1725             }
1726         }
1728         foreach ($types as $type => $path) {
1729             if (!isset($fix[$type])) {
1730                 $fix[$type] = $path;
1731             }
1732         }
1733         return $fix;
1734     }
1736     /**
1737      * Check if the given directory can be removed by the web server process.
1738      *
1739      * This recursively checks that the given directory and all its contents
1740      * it writable.
1741      *
1742      * @param string $fullpath
1743      * @return boolean
1744      */
1745     protected function is_directory_removable($fullpath) {
1747         if (!is_writable($fullpath)) {
1748             return false;
1749         }
1751         if (is_dir($fullpath)) {
1752             $handle = opendir($fullpath);
1753         } else {
1754             return false;
1755         }
1757         $result = true;
1759         while ($filename = readdir($handle)) {
1761             if ($filename === '.' or $filename === '..') {
1762                 continue;
1763             }
1765             $subfilepath = $fullpath.'/'.$filename;
1767             if (is_dir($subfilepath)) {
1768                 $result = $result && $this->is_directory_removable($subfilepath);
1770             } else {
1771                 $result = $result && is_writable($subfilepath);
1772             }
1773         }
1775         closedir($handle);
1777         return $result;
1778     }
1780     /**
1781      * Helper method that implements common uninstall prerequisites
1782      *
1783      * @param \core\plugininfo\base $pluginfo
1784      * @return bool
1785      */
1786     protected function common_uninstall_check(\core\plugininfo\base $pluginfo) {
1788         if (!$pluginfo->is_uninstall_allowed()) {
1789             // The plugin's plugininfo class declares it should not be uninstalled.
1790             return false;
1791         }
1793         if ($pluginfo->get_status() === static::PLUGIN_STATUS_NEW) {
1794             // The plugin is not installed. It should be either installed or removed from the disk.
1795             // Relying on this temporary state may be tricky.
1796             return false;
1797         }
1799         if (method_exists($pluginfo, 'get_uninstall_url') and is_null($pluginfo->get_uninstall_url())) {
1800             // Backwards compatibility.
1801             debugging('\core\plugininfo\base subclasses should use is_uninstall_allowed() instead of returning null in get_uninstall_url()',
1802                 DEBUG_DEVELOPER);
1803             return false;
1804         }
1806         return true;
1807     }
1809     /**
1810      * Returns a code_manager instance to be used for the plugins code operations.
1811      *
1812      * @return \core\update\code_manager
1813      */
1814     protected function get_code_manager() {
1816         if ($this->codemanager === null) {
1817             $this->codemanager = new \core\update\code_manager();
1818         }
1820         return $this->codemanager;
1821     }
1823     /**
1824      * Returns a client for https://download.moodle.org/api/
1825      *
1826      * @return \core\update\api
1827      */
1828     protected function get_update_api_client() {
1830         if ($this->updateapiclient === null) {
1831             $this->updateapiclient = \core\update\api::client();
1832         }
1834         return $this->updateapiclient;
1835     }