c5028b16e7aa897dc5286d11f51a987ad2749acd
[moodle.git] / lib / classes / component.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  * Components (core subsystems + plugins) related code.
19  *
20  * @package    core
21  * @copyright  2013 Petr Skoda {@link http://skodak.org}
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
27 // Constants used in version.php files, these must exist when core_component executes.
29 /** Software maturity level - internals can be tested using white box techniques. */
30 define('MATURITY_ALPHA',    50);
31 /** Software maturity level - feature complete, ready for preview and testing. */
32 define('MATURITY_BETA',     100);
33 /** Software maturity level - tested, will be released unless there are fatal bugs. */
34 define('MATURITY_RC',       150);
35 /** Software maturity level - ready for production deployment. */
36 define('MATURITY_STABLE',   200);
37 /** Any version - special value that can be used in $plugin->dependencies in version.php files. */
38 define('ANY_VERSION', 'any');
41 /**
42  * Collection of components related methods.
43  */
44 class core_component {
45     /** @var array list of ignored directories - watch out for auth/db exception */
46     protected static $ignoreddirs = array('CVS'=>true, '_vti_cnf'=>true, 'simpletest'=>true, 'db'=>true, 'yui'=>true, 'tests'=>true, 'classes'=>true, 'fonts'=>true);
47     /** @var array list plugin types that support subplugins, do not add more here unless absolutely necessary */
48     protected static $supportsubplugins = array('mod', 'editor', 'tool', 'local');
50     /** @var array cache of plugin types */
51     protected static $plugintypes = null;
52     /** @var array cache of plugin locations */
53     protected static $plugins = null;
54     /** @var array cache of core subsystems */
55     protected static $subsystems = null;
56     /** @var array subplugin type parents */
57     protected static $parents = null;
58     /** @var array subplugins */
59     protected static $subplugins = null;
60     /** @var array list of all known classes that can be autoloaded */
61     protected static $classmap = null;
62     /** @var array list of all classes that have been renamed to be autoloaded */
63     protected static $classmaprenames = null;
64     /** @var array list of some known files that can be included. */
65     protected static $filemap = null;
66     /** @var int|float core version. */
67     protected static $version = null;
68     /** @var array list of the files to map. */
69     protected static $filestomap = array('lib.php', 'settings.php');
70     /** @var array associative array of PSR-0 namespaces and corresponding paths. */
71     protected static $psr0namespaces = array(
72         'Horde' => 'lib/horde/framework/Horde',
73         'Mustache' => 'lib/mustache/src/Mustache',
74     );
75     /** @var array associative array of PRS-4 namespaces and corresponding paths. */
76     protected static $psr4namespaces = array(
77         'MaxMind' => 'lib/maxmind/MaxMind',
78         'GeoIp2' => 'lib/maxmind/GeoIp2',
79         'Sabberworm\\CSS' => 'lib/php-css-parser',
80         'MoodleHQ\\RTLCSS' => 'lib/rtlcss',
81         'Leafo\\ScssPhp' => 'lib/scssphp',
82         'Box\\Spout' => 'lib/spout/src/Spout',
83         'MatthiasMullie\\Minify' => 'lib/minify/matthiasmullie-minify/src/',
84         'MatthiasMullie\\PathConverter' => 'lib/minify/matthiasmullie-pathconverter/src/',
85         'IMSGlobal\LTI' => 'lib/ltiprovider/src',
86         'Phpml' => 'lib/mlbackend/php/phpml/src/Phpml',
87         'PHPMailer\\PHPMailer' => 'lib/phpmailer/src',
88         'RedeyeVentures\\GeoPattern' => 'lib/geopattern-php/GeoPattern',
89     );
91     /**
92      * Class loader for Frankenstyle named classes in standard locations.
93      * Frankenstyle namespaces are supported.
94      *
95      * The expected location for core classes is:
96      *    1/ core_xx_yy_zz ---> lib/classes/xx_yy_zz.php
97      *    2/ \core\xx_yy_zz ---> lib/classes/xx_yy_zz.php
98      *    3/ \core\xx\yy_zz ---> lib/classes/xx/yy_zz.php
99      *
100      * The expected location for plugin classes is:
101      *    1/ mod_name_xx_yy_zz ---> mod/name/classes/xx_yy_zz.php
102      *    2/ \mod_name\xx_yy_zz ---> mod/name/classes/xx_yy_zz.php
103      *    3/ \mod_name\xx\yy_zz ---> mod/name/classes/xx/yy_zz.php
104      *
105      * @param string $classname
106      */
107     public static function classloader($classname) {
108         self::init();
110         if (isset(self::$classmap[$classname])) {
111             // Global $CFG is expected in included scripts.
112             global $CFG;
113             // Function include would be faster, but for BC it is better to include only once.
114             include_once(self::$classmap[$classname]);
115             return;
116         }
117         if (isset(self::$classmaprenames[$classname]) && isset(self::$classmap[self::$classmaprenames[$classname]])) {
118             $newclassname = self::$classmaprenames[$classname];
119             $debugging = "Class '%s' has been renamed for the autoloader and is now deprecated. Please use '%s' instead.";
120             debugging(sprintf($debugging, $classname, $newclassname), DEBUG_DEVELOPER);
121             if (PHP_VERSION_ID >= 70000 && preg_match('#\\\null(\\\|$)#', $classname)) {
122                 throw new \coding_exception("Cannot alias $classname to $newclassname");
123             }
124             class_alias($newclassname, $classname);
125             return;
126         }
128         $file = self::psr_classloader($classname);
129         // If the file is found, require it.
130         if (!empty($file)) {
131             require($file);
132             return;
133         }
134     }
136     /**
137      * Return the path to a class from our defined PSR-0 or PSR-4 standard namespaces on
138      * demand. Only returns paths to files that exist.
139      *
140      * Adapated from http://www.php-fig.org/psr/psr-4/examples/ and made PSR-0
141      * compatible.
142      *
143      * @param string $class the name of the class.
144      * @return string|bool The full path to the file defining the class. Or false if it could not be resolved or does not exist.
145      */
146     protected static function psr_classloader($class) {
147         // Iterate through each PSR-4 namespace prefix.
148         foreach (self::$psr4namespaces as $prefix => $path) {
149             $file = self::get_class_file($class, $prefix, $path, array('\\'));
150             if (!empty($file) && file_exists($file)) {
151                 return $file;
152             }
153         }
155         // Iterate through each PSR-0 namespace prefix.
156         foreach (self::$psr0namespaces as $prefix => $path) {
157             $file = self::get_class_file($class, $prefix, $path, array('\\', '_'));
158             if (!empty($file) && file_exists($file)) {
159                 return $file;
160             }
161         }
163         return false;
164     }
166     /**
167      * Return the path to the class based on the given namespace prefix and path it corresponds to.
168      *
169      * Will return the path even if the file does not exist. Check the file esists before requiring.
170      *
171      * @param string $class the name of the class.
172      * @param string $prefix The namespace prefix used to identify the base directory of the source files.
173      * @param string $path The relative path to the base directory of the source files.
174      * @param string[] $separators The characters that should be used for separating.
175      * @return string|bool The full path to the file defining the class. Or false if it could not be resolved.
176      */
177     protected static function get_class_file($class, $prefix, $path, $separators) {
178         global $CFG;
180         // Does the class use the namespace prefix?
181         $len = strlen($prefix);
182         if (strncmp($prefix, $class, $len) !== 0) {
183             // No, move to the next prefix.
184             return false;
185         }
186         $path = $CFG->dirroot . '/' . $path;
188         // Get the relative class name.
189         $relativeclass = substr($class, $len);
191         // Replace the namespace prefix with the base directory, replace namespace
192         // separators with directory separators in the relative class name, append
193         // with .php.
194         $file = $path . str_replace($separators, '/', $relativeclass) . '.php';
196         return $file;
197     }
200     /**
201      * Initialise caches, always call before accessing self:: caches.
202      */
203     protected static function init() {
204         global $CFG;
206         // Init only once per request/CLI execution, we ignore changes done afterwards.
207         if (isset(self::$plugintypes)) {
208             return;
209         }
211         if (defined('IGNORE_COMPONENT_CACHE') and IGNORE_COMPONENT_CACHE) {
212             self::fill_all_caches();
213             return;
214         }
216         if (!empty($CFG->alternative_component_cache)) {
217             // Hack for heavily clustered sites that want to manage component cache invalidation manually.
218             $cachefile = $CFG->alternative_component_cache;
220             if (file_exists($cachefile)) {
221                 if (CACHE_DISABLE_ALL) {
222                     // Verify the cache state only on upgrade pages.
223                     $content = self::get_cache_content();
224                     if (sha1_file($cachefile) !== sha1($content)) {
225                         die('Outdated component cache file defined in $CFG->alternative_component_cache, can not continue');
226                     }
227                     return;
228                 }
229                 $cache = array();
230                 include($cachefile);
231                 self::$plugintypes      = $cache['plugintypes'];
232                 self::$plugins          = $cache['plugins'];
233                 self::$subsystems       = $cache['subsystems'];
234                 self::$parents          = $cache['parents'];
235                 self::$subplugins       = $cache['subplugins'];
236                 self::$classmap         = $cache['classmap'];
237                 self::$classmaprenames  = $cache['classmaprenames'];
238                 self::$filemap          = $cache['filemap'];
239                 return;
240             }
242             if (!is_writable(dirname($cachefile))) {
243                 die('Can not create alternative component cache file defined in $CFG->alternative_component_cache, can not continue');
244             }
246             // Lets try to create the file, it might be in some writable directory or a local cache dir.
248         } else {
249             // Note: $CFG->cachedir MUST be shared by all servers in a cluster,
250             //       use $CFG->alternative_component_cache if you do not like it.
251             $cachefile = "$CFG->cachedir/core_component.php";
252         }
254         if (!CACHE_DISABLE_ALL and !self::is_developer()) {
255             // 1/ Use the cache only outside of install and upgrade.
256             // 2/ Let developers add/remove classes in developer mode.
257             if (is_readable($cachefile)) {
258                 $cache = false;
259                 include($cachefile);
260                 if (!is_array($cache)) {
261                     // Something is very wrong.
262                 } else if (!isset($cache['version'])) {
263                     // Something is very wrong.
264                 } else if ((float) $cache['version'] !== (float) self::fetch_core_version()) {
265                     // Outdated cache. We trigger an error log to track an eventual repetitive failure of float comparison.
266                     error_log('Resetting core_component cache after core upgrade to version ' . self::fetch_core_version());
267                 } else if ($cache['plugintypes']['mod'] !== "$CFG->dirroot/mod") {
268                     // $CFG->dirroot was changed.
269                 } else {
270                     // The cache looks ok, let's use it.
271                     self::$plugintypes      = $cache['plugintypes'];
272                     self::$plugins          = $cache['plugins'];
273                     self::$subsystems       = $cache['subsystems'];
274                     self::$parents          = $cache['parents'];
275                     self::$subplugins       = $cache['subplugins'];
276                     self::$classmap         = $cache['classmap'];
277                     self::$classmaprenames  = $cache['classmaprenames'];
278                     self::$filemap          = $cache['filemap'];
279                     return;
280                 }
281                 // Note: we do not verify $CFG->admin here intentionally,
282                 //       they must visit admin/index.php after any change.
283             }
284         }
286         if (!isset(self::$plugintypes)) {
287             // This needs to be atomic and self-fixing as much as possible.
289             $content = self::get_cache_content();
290             if (file_exists($cachefile)) {
291                 if (sha1_file($cachefile) === sha1($content)) {
292                     return;
293                 }
294                 // Stale cache detected!
295                 unlink($cachefile);
296             }
298             // Permissions might not be setup properly in installers.
299             $dirpermissions = !isset($CFG->directorypermissions) ? 02777 : $CFG->directorypermissions;
300             $filepermissions = !isset($CFG->filepermissions) ? ($dirpermissions & 0666) : $CFG->filepermissions;
302             clearstatcache();
303             $cachedir = dirname($cachefile);
304             if (!is_dir($cachedir)) {
305                 mkdir($cachedir, $dirpermissions, true);
306             }
308             if ($fp = @fopen($cachefile.'.tmp', 'xb')) {
309                 fwrite($fp, $content);
310                 fclose($fp);
311                 @rename($cachefile.'.tmp', $cachefile);
312                 @chmod($cachefile, $filepermissions);
313             }
314             @unlink($cachefile.'.tmp'); // Just in case anything fails (race condition).
315             self::invalidate_opcode_php_cache($cachefile);
316         }
317     }
319     /**
320      * Are we in developer debug mode?
321      *
322      * Note: You need to set "$CFG->debug = (E_ALL | E_STRICT);" in config.php,
323      *       the reason is we need to use this before we setup DB connection or caches for CFG.
324      *
325      * @return bool
326      */
327     protected static function is_developer() {
328         global $CFG;
330         // Note we can not rely on $CFG->debug here because DB is not initialised yet.
331         if (isset($CFG->config_php_settings['debug'])) {
332             $debug = (int)$CFG->config_php_settings['debug'];
333         } else {
334             return false;
335         }
337         if ($debug & E_ALL and $debug & E_STRICT) {
338             return true;
339         }
341         return false;
342     }
344     /**
345      * Create cache file content.
346      *
347      * @private this is intended for $CFG->alternative_component_cache only.
348      *
349      * @return string
350      */
351     public static function get_cache_content() {
352         if (!isset(self::$plugintypes)) {
353             self::fill_all_caches();
354         }
356         $cache = array(
357             'subsystems'        => self::$subsystems,
358             'plugintypes'       => self::$plugintypes,
359             'plugins'           => self::$plugins,
360             'parents'           => self::$parents,
361             'subplugins'        => self::$subplugins,
362             'classmap'          => self::$classmap,
363             'classmaprenames'   => self::$classmaprenames,
364             'filemap'           => self::$filemap,
365             'version'           => self::$version,
366         );
368         return '<?php
369 $cache = '.var_export($cache, true).';
370 ';
371     }
373     /**
374      * Fill all caches.
375      */
376     protected static function fill_all_caches() {
377         self::$subsystems = self::fetch_subsystems();
379         list(self::$plugintypes, self::$parents, self::$subplugins) = self::fetch_plugintypes();
381         self::$plugins = array();
382         foreach (self::$plugintypes as $type => $fulldir) {
383             self::$plugins[$type] = self::fetch_plugins($type, $fulldir);
384         }
386         self::fill_classmap_cache();
387         self::fill_classmap_renames_cache();
388         self::fill_filemap_cache();
389         self::fetch_core_version();
390     }
392     /**
393      * Get the core version.
394      *
395      * In order for this to work properly, opcache should be reset beforehand.
396      *
397      * @return float core version.
398      */
399     protected static function fetch_core_version() {
400         global $CFG;
401         if (self::$version === null) {
402             $version = null; // Prevent IDE complaints.
403             require($CFG->dirroot . '/version.php');
404             self::$version = $version;
405         }
406         return self::$version;
407     }
409     /**
410      * Returns list of core subsystems.
411      * @return array
412      */
413     protected static function fetch_subsystems() {
414         global $CFG;
416         // NOTE: Any additions here must be verified to not collide with existing add-on modules and subplugins!!!
418         $info = array(
419             'access'      => null,
420             'admin'       => $CFG->dirroot.'/'.$CFG->admin,
421             'analytics'   => $CFG->dirroot . '/analytics',
422             'antivirus'   => $CFG->dirroot . '/lib/antivirus',
423             'auth'        => $CFG->dirroot.'/auth',
424             'availability' => $CFG->dirroot . '/availability',
425             'backup'      => $CFG->dirroot.'/backup/util/ui',
426             'badges'      => $CFG->dirroot.'/badges',
427             'block'       => $CFG->dirroot.'/blocks',
428             'blog'        => $CFG->dirroot.'/blog',
429             'bulkusers'   => null,
430             'cache'       => $CFG->dirroot.'/cache',
431             'calendar'    => $CFG->dirroot.'/calendar',
432             'cohort'      => $CFG->dirroot.'/cohort',
433             'comment'     => $CFG->dirroot.'/comment',
434             'competency'  => $CFG->dirroot.'/competency',
435             'completion'  => $CFG->dirroot.'/completion',
436             'countries'   => null,
437             'course'      => $CFG->dirroot.'/course',
438             'currencies'  => null,
439             'dbtransfer'  => null,
440             'debug'       => null,
441             'editor'      => $CFG->dirroot.'/lib/editor',
442             'edufields'   => null,
443             'enrol'       => $CFG->dirroot.'/enrol',
444             'error'       => null,
445             'filepicker'  => null,
446             'fileconverter' => $CFG->dirroot.'/files/converter',
447             'files'       => $CFG->dirroot.'/files',
448             'filters'     => $CFG->dirroot.'/filter',
449             //'fonts'       => null, // Bogus.
450             'form'        => $CFG->dirroot.'/lib/form',
451             'grades'      => $CFG->dirroot.'/grade',
452             'grading'     => $CFG->dirroot.'/grade/grading',
453             'group'       => $CFG->dirroot.'/group',
454             'help'        => null,
455             'hub'         => null,
456             'imscc'       => null,
457             'install'     => null,
458             'iso6392'     => null,
459             'langconfig'  => null,
460             'license'     => null,
461             'mathslib'    => null,
462             'media'       => $CFG->dirroot.'/media',
463             'message'     => $CFG->dirroot.'/message',
464             'mimetypes'   => null,
465             'mnet'        => $CFG->dirroot.'/mnet',
466             //'moodle.org'  => null, // Not used any more.
467             'my'          => $CFG->dirroot.'/my',
468             'notes'       => $CFG->dirroot.'/notes',
469             'pagetype'    => null,
470             'pix'         => null,
471             'plagiarism'  => $CFG->dirroot.'/plagiarism',
472             'plugin'      => null,
473             'portfolio'   => $CFG->dirroot.'/portfolio',
474             'privacy'     => $CFG->dirroot . '/privacy',
475             'publish'     => $CFG->dirroot.'/course/publish',
476             'question'    => $CFG->dirroot.'/question',
477             'rating'      => $CFG->dirroot.'/rating',
478             'register'    => $CFG->dirroot.'/'.$CFG->admin.'/registration', // Broken badly if $CFG->admin changed.
479             'repository'  => $CFG->dirroot.'/repository',
480             'rss'         => $CFG->dirroot.'/rss',
481             'role'        => $CFG->dirroot.'/'.$CFG->admin.'/roles',
482             'search'      => $CFG->dirroot.'/search',
483             'table'       => null,
484             'tag'         => $CFG->dirroot.'/tag',
485             'timezones'   => null,
486             'user'        => $CFG->dirroot.'/user',
487             'userkey'     => $CFG->dirroot.'/lib/userkey',
488             'webservice'  => $CFG->dirroot.'/webservice',
489         );
491         return $info;
492     }
494     /**
495      * Returns list of known plugin types.
496      * @return array
497      */
498     protected static function fetch_plugintypes() {
499         global $CFG;
501         $types = array(
502             'antivirus'     => $CFG->dirroot . '/lib/antivirus',
503             'availability'  => $CFG->dirroot . '/availability/condition',
504             'qtype'         => $CFG->dirroot.'/question/type',
505             'mod'           => $CFG->dirroot.'/mod',
506             'auth'          => $CFG->dirroot.'/auth',
507             'calendartype'  => $CFG->dirroot.'/calendar/type',
508             'enrol'         => $CFG->dirroot.'/enrol',
509             'message'       => $CFG->dirroot.'/message/output',
510             'block'         => $CFG->dirroot.'/blocks',
511             'media'         => $CFG->dirroot.'/media/player',
512             'filter'        => $CFG->dirroot.'/filter',
513             'editor'        => $CFG->dirroot.'/lib/editor',
514             'format'        => $CFG->dirroot.'/course/format',
515             'dataformat'    => $CFG->dirroot.'/dataformat',
516             'profilefield'  => $CFG->dirroot.'/user/profile/field',
517             'report'        => $CFG->dirroot.'/report',
518             'coursereport'  => $CFG->dirroot.'/course/report', // Must be after system reports.
519             'gradeexport'   => $CFG->dirroot.'/grade/export',
520             'gradeimport'   => $CFG->dirroot.'/grade/import',
521             'gradereport'   => $CFG->dirroot.'/grade/report',
522             'gradingform'   => $CFG->dirroot.'/grade/grading/form',
523             'mlbackend'     => $CFG->dirroot.'/lib/mlbackend',
524             'mnetservice'   => $CFG->dirroot.'/mnet/service',
525             'webservice'    => $CFG->dirroot.'/webservice',
526             'repository'    => $CFG->dirroot.'/repository',
527             'portfolio'     => $CFG->dirroot.'/portfolio',
528             'search'        => $CFG->dirroot.'/search/engine',
529             'qbehaviour'    => $CFG->dirroot.'/question/behaviour',
530             'qformat'       => $CFG->dirroot.'/question/format',
531             'plagiarism'    => $CFG->dirroot.'/plagiarism',
532             'tool'          => $CFG->dirroot.'/'.$CFG->admin.'/tool',
533             'cachestore'    => $CFG->dirroot.'/cache/stores',
534             'cachelock'     => $CFG->dirroot.'/cache/locks',
535             'fileconverter' => $CFG->dirroot.'/files/converter',
536         );
537         $parents = array();
538         $subplugins = array();
540         if (!empty($CFG->themedir) and is_dir($CFG->themedir) ) {
541             $types['theme'] = $CFG->themedir;
542         } else {
543             $types['theme'] = $CFG->dirroot.'/theme';
544         }
546         foreach (self::$supportsubplugins as $type) {
547             if ($type === 'local') {
548                 // Local subplugins must be after local plugins.
549                 continue;
550             }
551             $plugins = self::fetch_plugins($type, $types[$type]);
552             foreach ($plugins as $plugin => $fulldir) {
553                 $subtypes = self::fetch_subtypes($fulldir);
554                 if (!$subtypes) {
555                     continue;
556                 }
557                 $subplugins[$type.'_'.$plugin] = array();
558                 foreach($subtypes as $subtype => $subdir) {
559                     if (isset($types[$subtype])) {
560                         error_log("Invalid subtype '$subtype', duplicate detected.");
561                         continue;
562                     }
563                     $types[$subtype] = $subdir;
564                     $parents[$subtype] = $type.'_'.$plugin;
565                     $subplugins[$type.'_'.$plugin][$subtype] = array_keys(self::fetch_plugins($subtype, $subdir));
566                 }
567             }
568         }
569         // Local is always last!
570         $types['local'] = $CFG->dirroot.'/local';
572         if (in_array('local', self::$supportsubplugins)) {
573             $type = 'local';
574             $plugins = self::fetch_plugins($type, $types[$type]);
575             foreach ($plugins as $plugin => $fulldir) {
576                 $subtypes = self::fetch_subtypes($fulldir);
577                 if (!$subtypes) {
578                     continue;
579                 }
580                 $subplugins[$type.'_'.$plugin] = array();
581                 foreach($subtypes as $subtype => $subdir) {
582                     if (isset($types[$subtype])) {
583                         error_log("Invalid subtype '$subtype', duplicate detected.");
584                         continue;
585                     }
586                     $types[$subtype] = $subdir;
587                     $parents[$subtype] = $type.'_'.$plugin;
588                     $subplugins[$type.'_'.$plugin][$subtype] = array_keys(self::fetch_plugins($subtype, $subdir));
589                 }
590             }
591         }
593         return array($types, $parents, $subplugins);
594     }
596     /**
597      * Returns list of subtypes.
598      * @param string $ownerdir
599      * @return array
600      */
601     protected static function fetch_subtypes($ownerdir) {
602         global $CFG;
604         $types = array();
605         if (file_exists("$ownerdir/db/subplugins.php")) {
606             $subplugins = array();
607             include("$ownerdir/db/subplugins.php");
608             foreach ($subplugins as $subtype => $dir) {
609                 if (!preg_match('/^[a-z][a-z0-9]*$/', $subtype)) {
610                     error_log("Invalid subtype '$subtype'' detected in '$ownerdir', invalid characters present.");
611                     continue;
612                 }
613                 if (isset(self::$subsystems[$subtype])) {
614                     error_log("Invalid subtype '$subtype'' detected in '$ownerdir', duplicates core subsystem.");
615                     continue;
616                 }
617                 if ($CFG->admin !== 'admin' and strpos($dir, 'admin/') === 0) {
618                     $dir = preg_replace('|^admin/|', "$CFG->admin/", $dir);
619                 }
620                 if (!is_dir("$CFG->dirroot/$dir")) {
621                     error_log("Invalid subtype directory '$dir' detected in '$ownerdir'.");
622                     continue;
623                 }
624                 $types[$subtype] = "$CFG->dirroot/$dir";
625             }
626         }
627         return $types;
628     }
630     /**
631      * Returns list of plugins of given type in given directory.
632      * @param string $plugintype
633      * @param string $fulldir
634      * @return array
635      */
636     protected static function fetch_plugins($plugintype, $fulldir) {
637         global $CFG;
639         $fulldirs = (array)$fulldir;
640         if ($plugintype === 'theme') {
641             if (realpath($fulldir) !== realpath($CFG->dirroot.'/theme')) {
642                 // Include themes in standard location too.
643                 array_unshift($fulldirs, $CFG->dirroot.'/theme');
644             }
645         }
647         $result = array();
649         foreach ($fulldirs as $fulldir) {
650             if (!is_dir($fulldir)) {
651                 continue;
652             }
653             $items = new \DirectoryIterator($fulldir);
654             foreach ($items as $item) {
655                 if ($item->isDot() or !$item->isDir()) {
656                     continue;
657                 }
658                 $pluginname = $item->getFilename();
659                 if ($plugintype === 'auth' and $pluginname === 'db') {
660                     // Special exception for this wrong plugin name.
661                 } else if (isset(self::$ignoreddirs[$pluginname])) {
662                     continue;
663                 }
664                 if (!self::is_valid_plugin_name($plugintype, $pluginname)) {
665                     // Always ignore plugins with problematic names here.
666                     continue;
667                 }
668                 $result[$pluginname] = $fulldir.'/'.$pluginname;
669                 unset($item);
670             }
671             unset($items);
672         }
674         ksort($result);
675         return $result;
676     }
678     /**
679      * Find all classes that can be autoloaded including frankenstyle namespaces.
680      */
681     protected static function fill_classmap_cache() {
682         global $CFG;
684         self::$classmap = array();
686         self::load_classes('core', "$CFG->dirroot/lib/classes");
688         foreach (self::$subsystems as $subsystem => $fulldir) {
689             if (!$fulldir) {
690                 continue;
691             }
692             self::load_classes('core_'.$subsystem, "$fulldir/classes");
693         }
695         foreach (self::$plugins as $plugintype => $plugins) {
696             foreach ($plugins as $pluginname => $fulldir) {
697                 self::load_classes($plugintype.'_'.$pluginname, "$fulldir/classes");
698             }
699         }
700         ksort(self::$classmap);
701     }
703     /**
704      * Fills up the cache defining what plugins have certain files.
705      *
706      * @see self::get_plugin_list_with_file
707      * @return void
708      */
709     protected static function fill_filemap_cache() {
710         global $CFG;
712         self::$filemap = array();
714         foreach (self::$filestomap as $file) {
715             if (!isset(self::$filemap[$file])) {
716                 self::$filemap[$file] = array();
717             }
718             foreach (self::$plugins as $plugintype => $plugins) {
719                 if (!isset(self::$filemap[$file][$plugintype])) {
720                     self::$filemap[$file][$plugintype] = array();
721                 }
722                 foreach ($plugins as $pluginname => $fulldir) {
723                     if (file_exists("$fulldir/$file")) {
724                         self::$filemap[$file][$plugintype][$pluginname] = "$fulldir/$file";
725                     }
726                 }
727             }
728         }
729     }
731     /**
732      * Find classes in directory and recurse to subdirs.
733      * @param string $component
734      * @param string $fulldir
735      * @param string $namespace
736      */
737     protected static function load_classes($component, $fulldir, $namespace = '') {
738         if (!is_dir($fulldir)) {
739             return;
740         }
742         if (!is_readable($fulldir)) {
743             // TODO: MDL-51711 We should generate some diagnostic debugging information in this case
744             // because its pretty likely to lead to a missing class error further down the line.
745             // But our early setup code can't handle errors this early at the moment.
746             return;
747         }
749         $items = new \DirectoryIterator($fulldir);
750         foreach ($items as $item) {
751             if ($item->isDot()) {
752                 continue;
753             }
754             if ($item->isDir()) {
755                 $dirname = $item->getFilename();
756                 self::load_classes($component, "$fulldir/$dirname", $namespace.'\\'.$dirname);
757                 continue;
758             }
760             $filename = $item->getFilename();
761             $classname = preg_replace('/\.php$/', '', $filename);
763             if ($filename === $classname) {
764                 // Not a php file.
765                 continue;
766             }
767             if ($namespace === '') {
768                 // Legacy long frankenstyle class name.
769                 self::$classmap[$component.'_'.$classname] = "$fulldir/$filename";
770             }
771             // New namespaced classes.
772             self::$classmap[$component.$namespace.'\\'.$classname] = "$fulldir/$filename";
773         }
774         unset($item);
775         unset($items);
776     }
779     /**
780      * List all core subsystems and their location
781      *
782      * This is a whitelist of components that are part of the core and their
783      * language strings are defined in /lang/en/<<subsystem>>.php. If a given
784      * plugin is not listed here and it does not have proper plugintype prefix,
785      * then it is considered as course activity module.
786      *
787      * The location is absolute file path to dir. NULL means there is no special
788      * directory for this subsystem. If the location is set, the subsystem's
789      * renderer.php is expected to be there.
790      *
791      * @return array of (string)name => (string|null)full dir location
792      */
793     public static function get_core_subsystems() {
794         self::init();
795         return self::$subsystems;
796     }
798     /**
799      * Get list of available plugin types together with their location.
800      *
801      * @return array as (string)plugintype => (string)fulldir
802      */
803     public static function get_plugin_types() {
804         self::init();
805         return self::$plugintypes;
806     }
808     /**
809      * Get list of plugins of given type.
810      *
811      * @param string $plugintype
812      * @return array as (string)pluginname => (string)fulldir
813      */
814     public static function get_plugin_list($plugintype) {
815         self::init();
817         if (!isset(self::$plugins[$plugintype])) {
818             return array();
819         }
820         return self::$plugins[$plugintype];
821     }
823     /**
824      * Get a list of all the plugins of a given type that define a certain class
825      * in a certain file. The plugin component names and class names are returned.
826      *
827      * @param string $plugintype the type of plugin, e.g. 'mod' or 'report'.
828      * @param string $class the part of the name of the class after the
829      *      frankenstyle prefix. e.g 'thing' if you are looking for classes with
830      *      names like report_courselist_thing. If you are looking for classes with
831      *      the same name as the plugin name (e.g. qtype_multichoice) then pass ''.
832      *      Frankenstyle namespaces are also supported.
833      * @param string $file the name of file within the plugin that defines the class.
834      * @return array with frankenstyle plugin names as keys (e.g. 'report_courselist', 'mod_forum')
835      *      and the class names as values (e.g. 'report_courselist_thing', 'qtype_multichoice').
836      */
837     public static function get_plugin_list_with_class($plugintype, $class, $file = null) {
838         global $CFG; // Necessary in case it is referenced by included PHP scripts.
840         if ($class) {
841             $suffix = '_' . $class;
842         } else {
843             $suffix = '';
844         }
846         $pluginclasses = array();
847         $plugins = self::get_plugin_list($plugintype);
848         foreach ($plugins as $plugin => $fulldir) {
849             // Try class in frankenstyle namespace.
850             if ($class) {
851                 $classname = '\\' . $plugintype . '_' . $plugin . '\\' . $class;
852                 if (class_exists($classname, true)) {
853                     $pluginclasses[$plugintype . '_' . $plugin] = $classname;
854                     continue;
855                 }
856             }
858             // Try autoloading of class with frankenstyle prefix.
859             $classname = $plugintype . '_' . $plugin . $suffix;
860             if (class_exists($classname, true)) {
861                 $pluginclasses[$plugintype . '_' . $plugin] = $classname;
862                 continue;
863             }
865             // Fall back to old file location and class name.
866             if ($file and file_exists("$fulldir/$file")) {
867                 include_once("$fulldir/$file");
868                 if (class_exists($classname, false)) {
869                     $pluginclasses[$plugintype . '_' . $plugin] = $classname;
870                     continue;
871                 }
872             }
873         }
875         return $pluginclasses;
876     }
878     /**
879      * Get a list of all the plugins of a given type that contain a particular file.
880      *
881      * @param string $plugintype the type of plugin, e.g. 'mod' or 'report'.
882      * @param string $file the name of file that must be present in the plugin.
883      *                     (e.g. 'view.php', 'db/install.xml').
884      * @param bool $include if true (default false), the file will be include_once-ed if found.
885      * @return array with plugin name as keys (e.g. 'forum', 'courselist') and the path
886      *               to the file relative to dirroot as value (e.g. "$CFG->dirroot/mod/forum/view.php").
887      */
888     public static function get_plugin_list_with_file($plugintype, $file, $include = false) {
889         global $CFG; // Necessary in case it is referenced by included PHP scripts.
890         $pluginfiles = array();
892         if (isset(self::$filemap[$file])) {
893             // If the file was supposed to be mapped, then it should have been set in the array.
894             if (isset(self::$filemap[$file][$plugintype])) {
895                 $pluginfiles = self::$filemap[$file][$plugintype];
896             }
897         } else {
898             // Old-style search for non-cached files.
899             $plugins = self::get_plugin_list($plugintype);
900             foreach ($plugins as $plugin => $fulldir) {
901                 $path = $fulldir . '/' . $file;
902                 if (file_exists($path)) {
903                     $pluginfiles[$plugin] = $path;
904                 }
905             }
906         }
908         if ($include) {
909             foreach ($pluginfiles as $path) {
910                 include_once($path);
911             }
912         }
914         return $pluginfiles;
915     }
917     /**
918      * Returns all classes in a component matching the provided namespace.
919      *
920      * It checks that the class exists.
921      *
922      * e.g. get_component_classes_in_namespace('mod_forum', 'event')
923      *
924      * @param string $component A valid moodle component (frankenstyle)
925      * @param string $namespace Namespace from the component name or empty if all $component namespace classes.
926      * @return array The full class name as key and the class path as value.
927      */
928     public static function get_component_classes_in_namespace($component, $namespace = '') {
930         $component = self::normalize_componentname($component);
932         if ($namespace) {
934             // We will add them later.
935             $namespace = trim($namespace, '\\');
937             // We need add double backslashes as it is how classes are stored into self::$classmap.
938             $namespace = implode('\\\\', explode('\\', $namespace));
939             $namespace = $namespace . '\\\\';
940         }
942         $regex = '|^' . $component . '\\\\' . $namespace . '|';
943         $it = new RegexIterator(new ArrayIterator(self::$classmap), $regex, RegexIterator::GET_MATCH, RegexIterator::USE_KEY);
945         // We want to be sure that they exist.
946         $classes = array();
947         foreach ($it as $classname => $classpath) {
948             if (class_exists($classname)) {
949                 $classes[$classname] = $classpath;
950             }
951         }
953         return $classes;
954     }
956     /**
957      * Returns the exact absolute path to plugin directory.
958      *
959      * @param string $plugintype type of plugin
960      * @param string $pluginname name of the plugin
961      * @return string full path to plugin directory; null if not found
962      */
963     public static function get_plugin_directory($plugintype, $pluginname) {
964         if (empty($pluginname)) {
965             // Invalid plugin name, sorry.
966             return null;
967         }
969         self::init();
971         if (!isset(self::$plugins[$plugintype][$pluginname])) {
972             return null;
973         }
974         return self::$plugins[$plugintype][$pluginname];
975     }
977     /**
978      * Returns the exact absolute path to plugin directory.
979      *
980      * @param string $subsystem type of core subsystem
981      * @return string full path to subsystem directory; null if not found
982      */
983     public static function get_subsystem_directory($subsystem) {
984         self::init();
986         if (!isset(self::$subsystems[$subsystem])) {
987             return null;
988         }
989         return self::$subsystems[$subsystem];
990     }
992     /**
993      * This method validates a plug name. It is much faster than calling clean_param.
994      *
995      * @param string $plugintype type of plugin
996      * @param string $pluginname a string that might be a plugin name.
997      * @return bool if this string is a valid plugin name.
998      */
999     public static function is_valid_plugin_name($plugintype, $pluginname) {
1000         if ($plugintype === 'mod') {
1001             // Modules must not have the same name as core subsystems.
1002             if (!isset(self::$subsystems)) {
1003                 // Watch out, this is called from init!
1004                 self::init();
1005             }
1006             if (isset(self::$subsystems[$pluginname])) {
1007                 return false;
1008             }
1009             // Modules MUST NOT have any underscores,
1010             // component normalisation would break very badly otherwise!
1011             return (bool)preg_match('/^[a-z][a-z0-9]*$/', $pluginname);
1013         } else {
1014             return (bool)preg_match('/^[a-z](?:[a-z0-9_](?!__))*[a-z0-9]+$/', $pluginname);
1015         }
1016     }
1018     /**
1019      * Normalize the component name.
1020      *
1021      * Note: this does not verify the validity of the plugin or component.
1022      *
1023      * @param string $component
1024      * @return string
1025      */
1026     public static function normalize_componentname($componentname) {
1027         list($plugintype, $pluginname) = self::normalize_component($componentname);
1028         if ($plugintype === 'core' && is_null($pluginname)) {
1029             return $plugintype;
1030         }
1031         return $plugintype . '_' . $pluginname;
1032     }
1034     /**
1035      * Normalize the component name using the "frankenstyle" rules.
1036      *
1037      * Note: this does not verify the validity of plugin or type names.
1038      *
1039      * @param string $component
1040      * @return array two-items list of [(string)type, (string|null)name]
1041      */
1042     public static function normalize_component($component) {
1043         if ($component === 'moodle' or $component === 'core' or $component === '') {
1044             return array('core', null);
1045         }
1047         if (strpos($component, '_') === false) {
1048             self::init();
1049             if (array_key_exists($component, self::$subsystems)) {
1050                 $type   = 'core';
1051                 $plugin = $component;
1052             } else {
1053                 // Everything else without underscore is a module.
1054                 $type   = 'mod';
1055                 $plugin = $component;
1056             }
1058         } else {
1059             list($type, $plugin) = explode('_', $component, 2);
1060             if ($type === 'moodle') {
1061                 $type = 'core';
1062             }
1063             // Any unknown type must be a subplugin.
1064         }
1066         return array($type, $plugin);
1067     }
1069     /**
1070      * Return exact absolute path to a plugin directory.
1071      *
1072      * @param string $component name such as 'moodle', 'mod_forum'
1073      * @return string full path to component directory; NULL if not found
1074      */
1075     public static function get_component_directory($component) {
1076         global $CFG;
1078         list($type, $plugin) = self::normalize_component($component);
1080         if ($type === 'core') {
1081             if ($plugin === null) {
1082                 return $path = $CFG->libdir;
1083             }
1084             return self::get_subsystem_directory($plugin);
1085         }
1087         return self::get_plugin_directory($type, $plugin);
1088     }
1090     /**
1091      * Returns list of plugin types that allow subplugins.
1092      * @return array as (string)plugintype => (string)fulldir
1093      */
1094     public static function get_plugin_types_with_subplugins() {
1095         self::init();
1097         $return = array();
1098         foreach (self::$supportsubplugins as $type) {
1099             $return[$type] = self::$plugintypes[$type];
1100         }
1101         return $return;
1102     }
1104     /**
1105      * Returns parent of this subplugin type.
1106      *
1107      * @param string $type
1108      * @return string parent component or null
1109      */
1110     public static function get_subtype_parent($type) {
1111         self::init();
1113         if (isset(self::$parents[$type])) {
1114             return self::$parents[$type];
1115         }
1117         return null;
1118     }
1120     /**
1121      * Return all subplugins of this component.
1122      * @param string $component.
1123      * @return array $subtype=>array($component, ..), null if no subtypes defined
1124      */
1125     public static function get_subplugins($component) {
1126         self::init();
1128         if (isset(self::$subplugins[$component])) {
1129             return self::$subplugins[$component];
1130         }
1132         return null;
1133     }
1135     /**
1136      * Returns hash of all versions including core and all plugins.
1137      *
1138      * This is relatively slow and not fully cached, use with care!
1139      *
1140      * @return string sha1 hash
1141      */
1142     public static function get_all_versions_hash() {
1143         global $CFG;
1145         self::init();
1147         $versions = array();
1149         // Main version first.
1150         $versions['core'] = self::fetch_core_version();
1152         // The problem here is tha the component cache might be stable,
1153         // we want this to work also on frontpage without resetting the component cache.
1154         $usecache = false;
1155         if (CACHE_DISABLE_ALL or (defined('IGNORE_COMPONENT_CACHE') and IGNORE_COMPONENT_CACHE)) {
1156             $usecache = true;
1157         }
1159         // Now all plugins.
1160         $plugintypes = core_component::get_plugin_types();
1161         foreach ($plugintypes as $type => $typedir) {
1162             if ($usecache) {
1163                 $plugs = core_component::get_plugin_list($type);
1164             } else {
1165                 $plugs = self::fetch_plugins($type, $typedir);
1166             }
1167             foreach ($plugs as $plug => $fullplug) {
1168                 $plugin = new stdClass();
1169                 $plugin->version = null;
1170                 $module = $plugin;
1171                 include($fullplug.'/version.php');
1172                 $versions[$type.'_'.$plug] = $plugin->version;
1173             }
1174         }
1176         return sha1(serialize($versions));
1177     }
1179     /**
1180      * Invalidate opcode cache for given file, this is intended for
1181      * php files that are stored in dataroot.
1182      *
1183      * Note: we need it here because this class must be self-contained.
1184      *
1185      * @param string $file
1186      */
1187     public static function invalidate_opcode_php_cache($file) {
1188         if (function_exists('opcache_invalidate')) {
1189             if (!file_exists($file)) {
1190                 return;
1191             }
1192             opcache_invalidate($file, true);
1193         }
1194     }
1196     /**
1197      * Return true if subsystemname is core subsystem.
1198      *
1199      * @param string $subsystemname name of the subsystem.
1200      * @return bool true if core subsystem.
1201      */
1202     public static function is_core_subsystem($subsystemname) {
1203         return isset(self::$subsystems[$subsystemname]);
1204     }
1206     /**
1207      * Records all class renames that have been made to facilitate autoloading.
1208      */
1209     protected static function fill_classmap_renames_cache() {
1210         global $CFG;
1212         self::$classmaprenames = array();
1214         self::load_renamed_classes("$CFG->dirroot/lib/");
1216         foreach (self::$subsystems as $subsystem => $fulldir) {
1217             self::load_renamed_classes($fulldir);
1218         }
1220         foreach (self::$plugins as $plugintype => $plugins) {
1221             foreach ($plugins as $pluginname => $fulldir) {
1222                 self::load_renamed_classes($fulldir);
1223             }
1224         }
1225     }
1227     /**
1228      * Loads the db/renamedclasses.php file from the given directory.
1229      *
1230      * The renamedclasses.php should contain a key => value array ($renamedclasses) where the key is old class name,
1231      * and the value is the new class name.
1232      * It is only included when we are populating the component cache. After that is not needed.
1233      *
1234      * @param string $fulldir
1235      */
1236     protected static function load_renamed_classes($fulldir) {
1237         $file = $fulldir . '/db/renamedclasses.php';
1238         if (is_readable($file)) {
1239             $renamedclasses = null;
1240             require($file);
1241             if (is_array($renamedclasses)) {
1242                 foreach ($renamedclasses as $oldclass => $newclass) {
1243                     self::$classmaprenames[(string)$oldclass] = (string)$newclass;
1244                 }
1245             }
1246         }
1247     }
1249     /**
1250      * Returns a list of frankenstyle component names and their paths, for all components (plugins and subsystems).
1251      *
1252      * E.g.
1253      *  [
1254      *      'mod' => [
1255      *          'mod_forum' => FORUM_PLUGIN_PATH,
1256      *          ...
1257      *      ],
1258      *      ...
1259      *      'core' => [
1260      *          'core_comment' => COMMENT_SUBSYSTEM_PATH,
1261      *          ...
1262      *      ]
1263      * ]
1264      *
1265      * @return array an associative array of components and their corresponding paths.
1266      */
1267     public static function get_component_list() : array {
1268         $components = [];
1269         // Get all plugins.
1270         foreach (self::get_plugin_types() as $plugintype => $typedir) {
1271             $components[$plugintype] = [];
1272             foreach (self::get_plugin_list($plugintype) as $pluginname => $plugindir) {
1273                 $components[$plugintype][$plugintype . '_' . $pluginname] = $plugindir;
1274             }
1275         }
1276         // Get all subsystems.
1277         foreach (self::get_core_subsystems() as $subsystemname => $subsystempath) {
1278             $components['core']['core_' . $subsystemname] = $subsystempath;
1279         }
1280         return $components;
1281     }