weekly release 3.4dev
[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     );
89     /**
90      * Class loader for Frankenstyle named classes in standard locations.
91      * Frankenstyle namespaces are supported.
92      *
93      * The expected location for core classes is:
94      *    1/ core_xx_yy_zz ---> lib/classes/xx_yy_zz.php
95      *    2/ \core\xx_yy_zz ---> lib/classes/xx_yy_zz.php
96      *    3/ \core\xx\yy_zz ---> lib/classes/xx/yy_zz.php
97      *
98      * The expected location for plugin classes is:
99      *    1/ mod_name_xx_yy_zz ---> mod/name/classes/xx_yy_zz.php
100      *    2/ \mod_name\xx_yy_zz ---> mod/name/classes/xx_yy_zz.php
101      *    3/ \mod_name\xx\yy_zz ---> mod/name/classes/xx/yy_zz.php
102      *
103      * @param string $classname
104      */
105     public static function classloader($classname) {
106         self::init();
108         if (isset(self::$classmap[$classname])) {
109             // Global $CFG is expected in included scripts.
110             global $CFG;
111             // Function include would be faster, but for BC it is better to include only once.
112             include_once(self::$classmap[$classname]);
113             return;
114         }
115         if (isset(self::$classmaprenames[$classname]) && isset(self::$classmap[self::$classmaprenames[$classname]])) {
116             $newclassname = self::$classmaprenames[$classname];
117             $debugging = "Class '%s' has been renamed for the autoloader and is now deprecated. Please use '%s' instead.";
118             debugging(sprintf($debugging, $classname, $newclassname), DEBUG_DEVELOPER);
119             if (PHP_VERSION_ID >= 70000 && preg_match('#\\\null(\\\|$)#', $classname)) {
120                 throw new \coding_exception("Cannot alias $classname to $newclassname");
121             }
122             class_alias($newclassname, $classname);
123             return;
124         }
126         $file = self::psr_classloader($classname);
127         // If the file is found, require it.
128         if (!empty($file)) {
129             require($file);
130             return;
131         }
132     }
134     /**
135      * Return the path to a class from our defined PSR-0 or PSR-4 standard namespaces on
136      * demand. Only returns paths to files that exist.
137      *
138      * Adapated from http://www.php-fig.org/psr/psr-4/examples/ and made PSR-0
139      * compatible.
140      *
141      * @param string $class the name of the class.
142      * @return string|bool The full path to the file defining the class. Or false if it could not be resolved or does not exist.
143      */
144     protected static function psr_classloader($class) {
145         // Iterate through each PSR-4 namespace prefix.
146         foreach (self::$psr4namespaces as $prefix => $path) {
147             $file = self::get_class_file($class, $prefix, $path, array('\\'));
148             if (!empty($file) && file_exists($file)) {
149                 return $file;
150             }
151         }
153         // Iterate through each PSR-0 namespace prefix.
154         foreach (self::$psr0namespaces as $prefix => $path) {
155             $file = self::get_class_file($class, $prefix, $path, array('\\', '_'));
156             if (!empty($file) && file_exists($file)) {
157                 return $file;
158             }
159         }
161         return false;
162     }
164     /**
165      * Return the path to the class based on the given namespace prefix and path it corresponds to.
166      *
167      * Will return the path even if the file does not exist. Check the file esists before requiring.
168      *
169      * @param string $class the name of the class.
170      * @param string $prefix The namespace prefix used to identify the base directory of the source files.
171      * @param string $path The relative path to the base directory of the source files.
172      * @param string[] $separators The characters that should be used for separating.
173      * @return string|bool The full path to the file defining the class. Or false if it could not be resolved.
174      */
175     protected static function get_class_file($class, $prefix, $path, $separators) {
176         global $CFG;
178         // Does the class use the namespace prefix?
179         $len = strlen($prefix);
180         if (strncmp($prefix, $class, $len) !== 0) {
181             // No, move to the next prefix.
182             return false;
183         }
184         $path = $CFG->dirroot . '/' . $path;
186         // Get the relative class name.
187         $relativeclass = substr($class, $len);
189         // Replace the namespace prefix with the base directory, replace namespace
190         // separators with directory separators in the relative class name, append
191         // with .php.
192         $file = $path . str_replace($separators, '/', $relativeclass) . '.php';
194         return $file;
195     }
198     /**
199      * Initialise caches, always call before accessing self:: caches.
200      */
201     protected static function init() {
202         global $CFG;
204         // Init only once per request/CLI execution, we ignore changes done afterwards.
205         if (isset(self::$plugintypes)) {
206             return;
207         }
209         if (defined('IGNORE_COMPONENT_CACHE') and IGNORE_COMPONENT_CACHE) {
210             self::fill_all_caches();
211             return;
212         }
214         if (!empty($CFG->alternative_component_cache)) {
215             // Hack for heavily clustered sites that want to manage component cache invalidation manually.
216             $cachefile = $CFG->alternative_component_cache;
218             if (file_exists($cachefile)) {
219                 if (CACHE_DISABLE_ALL) {
220                     // Verify the cache state only on upgrade pages.
221                     $content = self::get_cache_content();
222                     if (sha1_file($cachefile) !== sha1($content)) {
223                         die('Outdated component cache file defined in $CFG->alternative_component_cache, can not continue');
224                     }
225                     return;
226                 }
227                 $cache = array();
228                 include($cachefile);
229                 self::$plugintypes      = $cache['plugintypes'];
230                 self::$plugins          = $cache['plugins'];
231                 self::$subsystems       = $cache['subsystems'];
232                 self::$parents          = $cache['parents'];
233                 self::$subplugins       = $cache['subplugins'];
234                 self::$classmap         = $cache['classmap'];
235                 self::$classmaprenames  = $cache['classmaprenames'];
236                 self::$filemap          = $cache['filemap'];
237                 return;
238             }
240             if (!is_writable(dirname($cachefile))) {
241                 die('Can not create alternative component cache file defined in $CFG->alternative_component_cache, can not continue');
242             }
244             // Lets try to create the file, it might be in some writable directory or a local cache dir.
246         } else {
247             // Note: $CFG->cachedir MUST be shared by all servers in a cluster,
248             //       use $CFG->alternative_component_cache if you do not like it.
249             $cachefile = "$CFG->cachedir/core_component.php";
250         }
252         if (!CACHE_DISABLE_ALL and !self::is_developer()) {
253             // 1/ Use the cache only outside of install and upgrade.
254             // 2/ Let developers add/remove classes in developer mode.
255             if (is_readable($cachefile)) {
256                 $cache = false;
257                 include($cachefile);
258                 if (!is_array($cache)) {
259                     // Something is very wrong.
260                 } else if (!isset($cache['version'])) {
261                     // Something is very wrong.
262                 } else if ((float) $cache['version'] !== (float) self::fetch_core_version()) {
263                     // Outdated cache. We trigger an error log to track an eventual repetitive failure of float comparison.
264                     error_log('Resetting core_component cache after core upgrade to version ' . self::fetch_core_version());
265                 } else if ($cache['plugintypes']['mod'] !== "$CFG->dirroot/mod") {
266                     // $CFG->dirroot was changed.
267                 } else {
268                     // The cache looks ok, let's use it.
269                     self::$plugintypes      = $cache['plugintypes'];
270                     self::$plugins          = $cache['plugins'];
271                     self::$subsystems       = $cache['subsystems'];
272                     self::$parents          = $cache['parents'];
273                     self::$subplugins       = $cache['subplugins'];
274                     self::$classmap         = $cache['classmap'];
275                     self::$classmaprenames  = $cache['classmaprenames'];
276                     self::$filemap          = $cache['filemap'];
277                     return;
278                 }
279                 // Note: we do not verify $CFG->admin here intentionally,
280                 //       they must visit admin/index.php after any change.
281             }
282         }
284         if (!isset(self::$plugintypes)) {
285             // This needs to be atomic and self-fixing as much as possible.
287             $content = self::get_cache_content();
288             if (file_exists($cachefile)) {
289                 if (sha1_file($cachefile) === sha1($content)) {
290                     return;
291                 }
292                 // Stale cache detected!
293                 unlink($cachefile);
294             }
296             // Permissions might not be setup properly in installers.
297             $dirpermissions = !isset($CFG->directorypermissions) ? 02777 : $CFG->directorypermissions;
298             $filepermissions = !isset($CFG->filepermissions) ? ($dirpermissions & 0666) : $CFG->filepermissions;
300             clearstatcache();
301             $cachedir = dirname($cachefile);
302             if (!is_dir($cachedir)) {
303                 mkdir($cachedir, $dirpermissions, true);
304             }
306             if ($fp = @fopen($cachefile.'.tmp', 'xb')) {
307                 fwrite($fp, $content);
308                 fclose($fp);
309                 @rename($cachefile.'.tmp', $cachefile);
310                 @chmod($cachefile, $filepermissions);
311             }
312             @unlink($cachefile.'.tmp'); // Just in case anything fails (race condition).
313             self::invalidate_opcode_php_cache($cachefile);
314         }
315     }
317     /**
318      * Are we in developer debug mode?
319      *
320      * Note: You need to set "$CFG->debug = (E_ALL | E_STRICT);" in config.php,
321      *       the reason is we need to use this before we setup DB connection or caches for CFG.
322      *
323      * @return bool
324      */
325     protected static function is_developer() {
326         global $CFG;
328         // Note we can not rely on $CFG->debug here because DB is not initialised yet.
329         if (isset($CFG->config_php_settings['debug'])) {
330             $debug = (int)$CFG->config_php_settings['debug'];
331         } else {
332             return false;
333         }
335         if ($debug & E_ALL and $debug & E_STRICT) {
336             return true;
337         }
339         return false;
340     }
342     /**
343      * Create cache file content.
344      *
345      * @private this is intended for $CFG->alternative_component_cache only.
346      *
347      * @return string
348      */
349     public static function get_cache_content() {
350         if (!isset(self::$plugintypes)) {
351             self::fill_all_caches();
352         }
354         $cache = array(
355             'subsystems'        => self::$subsystems,
356             'plugintypes'       => self::$plugintypes,
357             'plugins'           => self::$plugins,
358             'parents'           => self::$parents,
359             'subplugins'        => self::$subplugins,
360             'classmap'          => self::$classmap,
361             'classmaprenames'   => self::$classmaprenames,
362             'filemap'           => self::$filemap,
363             'version'           => self::$version,
364         );
366         return '<?php
367 $cache = '.var_export($cache, true).';
368 ';
369     }
371     /**
372      * Fill all caches.
373      */
374     protected static function fill_all_caches() {
375         self::$subsystems = self::fetch_subsystems();
377         list(self::$plugintypes, self::$parents, self::$subplugins) = self::fetch_plugintypes();
379         self::$plugins = array();
380         foreach (self::$plugintypes as $type => $fulldir) {
381             self::$plugins[$type] = self::fetch_plugins($type, $fulldir);
382         }
384         self::fill_classmap_cache();
385         self::fill_classmap_renames_cache();
386         self::fill_filemap_cache();
387         self::fetch_core_version();
388     }
390     /**
391      * Get the core version.
392      *
393      * In order for this to work properly, opcache should be reset beforehand.
394      *
395      * @return float core version.
396      */
397     protected static function fetch_core_version() {
398         global $CFG;
399         if (self::$version === null) {
400             $version = null; // Prevent IDE complaints.
401             require($CFG->dirroot . '/version.php');
402             self::$version = $version;
403         }
404         return self::$version;
405     }
407     /**
408      * Returns list of core subsystems.
409      * @return array
410      */
411     protected static function fetch_subsystems() {
412         global $CFG;
414         // NOTE: Any additions here must be verified to not collide with existing add-on modules and subplugins!!!
416         $info = array(
417             'access'      => null,
418             'admin'       => $CFG->dirroot.'/'.$CFG->admin,
419             'analytics'   => $CFG->dirroot . '/analytics',
420             'antivirus'   => $CFG->dirroot . '/lib/antivirus',
421             'auth'        => $CFG->dirroot.'/auth',
422             'availability' => $CFG->dirroot . '/availability',
423             'backup'      => $CFG->dirroot.'/backup/util/ui',
424             'badges'      => $CFG->dirroot.'/badges',
425             'block'       => $CFG->dirroot.'/blocks',
426             'blog'        => $CFG->dirroot.'/blog',
427             'bulkusers'   => null,
428             'cache'       => $CFG->dirroot.'/cache',
429             'calendar'    => $CFG->dirroot.'/calendar',
430             'cohort'      => $CFG->dirroot.'/cohort',
431             'comment'     => $CFG->dirroot.'/comment',
432             'competency'  => $CFG->dirroot.'/competency',
433             'completion'  => $CFG->dirroot.'/completion',
434             'countries'   => null,
435             'course'      => $CFG->dirroot.'/course',
436             'currencies'  => null,
437             'dbtransfer'  => null,
438             'debug'       => null,
439             'editor'      => $CFG->dirroot.'/lib/editor',
440             'edufields'   => null,
441             'enrol'       => $CFG->dirroot.'/enrol',
442             'error'       => null,
443             'filepicker'  => null,
444             'fileconverter' => $CFG->dirroot.'/files/converter',
445             'files'       => $CFG->dirroot.'/files',
446             'filters'     => null,
447             //'fonts'       => null, // Bogus.
448             'form'        => $CFG->dirroot.'/lib/form',
449             'grades'      => $CFG->dirroot.'/grade',
450             'grading'     => $CFG->dirroot.'/grade/grading',
451             'group'       => $CFG->dirroot.'/group',
452             'help'        => null,
453             'hub'         => null,
454             'imscc'       => null,
455             'install'     => null,
456             'iso6392'     => null,
457             'langconfig'  => null,
458             'license'     => null,
459             'mathslib'    => null,
460             'media'       => $CFG->dirroot.'/media',
461             'message'     => $CFG->dirroot.'/message',
462             'mimetypes'   => null,
463             'mnet'        => $CFG->dirroot.'/mnet',
464             //'moodle.org'  => null, // Not used any more.
465             'my'          => $CFG->dirroot.'/my',
466             'notes'       => $CFG->dirroot.'/notes',
467             'pagetype'    => null,
468             'pix'         => null,
469             'plagiarism'  => $CFG->dirroot.'/plagiarism',
470             'plugin'      => null,
471             'portfolio'   => $CFG->dirroot.'/portfolio',
472             'publish'     => $CFG->dirroot.'/course/publish',
473             'question'    => $CFG->dirroot.'/question',
474             'rating'      => $CFG->dirroot.'/rating',
475             'register'    => $CFG->dirroot.'/'.$CFG->admin.'/registration', // Broken badly if $CFG->admin changed.
476             'repository'  => $CFG->dirroot.'/repository',
477             'rss'         => $CFG->dirroot.'/rss',
478             'role'        => $CFG->dirroot.'/'.$CFG->admin.'/roles',
479             'search'      => $CFG->dirroot.'/search',
480             'table'       => null,
481             'tag'         => $CFG->dirroot.'/tag',
482             'timezones'   => null,
483             'user'        => $CFG->dirroot.'/user',
484             'userkey'     => null,
485             'webservice'  => $CFG->dirroot.'/webservice',
486         );
488         return $info;
489     }
491     /**
492      * Returns list of known plugin types.
493      * @return array
494      */
495     protected static function fetch_plugintypes() {
496         global $CFG;
498         $types = array(
499             'antivirus'     => $CFG->dirroot . '/lib/antivirus',
500             'availability'  => $CFG->dirroot . '/availability/condition',
501             'qtype'         => $CFG->dirroot.'/question/type',
502             'mod'           => $CFG->dirroot.'/mod',
503             'auth'          => $CFG->dirroot.'/auth',
504             'calendartype'  => $CFG->dirroot.'/calendar/type',
505             'enrol'         => $CFG->dirroot.'/enrol',
506             'message'       => $CFG->dirroot.'/message/output',
507             'block'         => $CFG->dirroot.'/blocks',
508             'media'         => $CFG->dirroot.'/media/player',
509             'filter'        => $CFG->dirroot.'/filter',
510             'editor'        => $CFG->dirroot.'/lib/editor',
511             'format'        => $CFG->dirroot.'/course/format',
512             'dataformat'    => $CFG->dirroot.'/dataformat',
513             'profilefield'  => $CFG->dirroot.'/user/profile/field',
514             'report'        => $CFG->dirroot.'/report',
515             'coursereport'  => $CFG->dirroot.'/course/report', // Must be after system reports.
516             'gradeexport'   => $CFG->dirroot.'/grade/export',
517             'gradeimport'   => $CFG->dirroot.'/grade/import',
518             'gradereport'   => $CFG->dirroot.'/grade/report',
519             'gradingform'   => $CFG->dirroot.'/grade/grading/form',
520             'mlbackend'     => $CFG->dirroot.'/lib/mlbackend',
521             'mnetservice'   => $CFG->dirroot.'/mnet/service',
522             'webservice'    => $CFG->dirroot.'/webservice',
523             'repository'    => $CFG->dirroot.'/repository',
524             'portfolio'     => $CFG->dirroot.'/portfolio',
525             'search'        => $CFG->dirroot.'/search/engine',
526             'qbehaviour'    => $CFG->dirroot.'/question/behaviour',
527             'qformat'       => $CFG->dirroot.'/question/format',
528             'plagiarism'    => $CFG->dirroot.'/plagiarism',
529             'tool'          => $CFG->dirroot.'/'.$CFG->admin.'/tool',
530             'cachestore'    => $CFG->dirroot.'/cache/stores',
531             'cachelock'     => $CFG->dirroot.'/cache/locks',
532             'fileconverter' => $CFG->dirroot.'/files/converter',
533         );
534         $parents = array();
535         $subplugins = array();
537         if (!empty($CFG->themedir) and is_dir($CFG->themedir) ) {
538             $types['theme'] = $CFG->themedir;
539         } else {
540             $types['theme'] = $CFG->dirroot.'/theme';
541         }
543         foreach (self::$supportsubplugins as $type) {
544             if ($type === 'local') {
545                 // Local subplugins must be after local plugins.
546                 continue;
547             }
548             $plugins = self::fetch_plugins($type, $types[$type]);
549             foreach ($plugins as $plugin => $fulldir) {
550                 $subtypes = self::fetch_subtypes($fulldir);
551                 if (!$subtypes) {
552                     continue;
553                 }
554                 $subplugins[$type.'_'.$plugin] = array();
555                 foreach($subtypes as $subtype => $subdir) {
556                     if (isset($types[$subtype])) {
557                         error_log("Invalid subtype '$subtype', duplicate detected.");
558                         continue;
559                     }
560                     $types[$subtype] = $subdir;
561                     $parents[$subtype] = $type.'_'.$plugin;
562                     $subplugins[$type.'_'.$plugin][$subtype] = array_keys(self::fetch_plugins($subtype, $subdir));
563                 }
564             }
565         }
566         // Local is always last!
567         $types['local'] = $CFG->dirroot.'/local';
569         if (in_array('local', self::$supportsubplugins)) {
570             $type = 'local';
571             $plugins = self::fetch_plugins($type, $types[$type]);
572             foreach ($plugins as $plugin => $fulldir) {
573                 $subtypes = self::fetch_subtypes($fulldir);
574                 if (!$subtypes) {
575                     continue;
576                 }
577                 $subplugins[$type.'_'.$plugin] = array();
578                 foreach($subtypes as $subtype => $subdir) {
579                     if (isset($types[$subtype])) {
580                         error_log("Invalid subtype '$subtype', duplicate detected.");
581                         continue;
582                     }
583                     $types[$subtype] = $subdir;
584                     $parents[$subtype] = $type.'_'.$plugin;
585                     $subplugins[$type.'_'.$plugin][$subtype] = array_keys(self::fetch_plugins($subtype, $subdir));
586                 }
587             }
588         }
590         return array($types, $parents, $subplugins);
591     }
593     /**
594      * Returns list of subtypes.
595      * @param string $ownerdir
596      * @return array
597      */
598     protected static function fetch_subtypes($ownerdir) {
599         global $CFG;
601         $types = array();
602         if (file_exists("$ownerdir/db/subplugins.php")) {
603             $subplugins = array();
604             include("$ownerdir/db/subplugins.php");
605             foreach ($subplugins as $subtype => $dir) {
606                 if (!preg_match('/^[a-z][a-z0-9]*$/', $subtype)) {
607                     error_log("Invalid subtype '$subtype'' detected in '$ownerdir', invalid characters present.");
608                     continue;
609                 }
610                 if (isset(self::$subsystems[$subtype])) {
611                     error_log("Invalid subtype '$subtype'' detected in '$ownerdir', duplicates core subsystem.");
612                     continue;
613                 }
614                 if ($CFG->admin !== 'admin' and strpos($dir, 'admin/') === 0) {
615                     $dir = preg_replace('|^admin/|', "$CFG->admin/", $dir);
616                 }
617                 if (!is_dir("$CFG->dirroot/$dir")) {
618                     error_log("Invalid subtype directory '$dir' detected in '$ownerdir'.");
619                     continue;
620                 }
621                 $types[$subtype] = "$CFG->dirroot/$dir";
622             }
623         }
624         return $types;
625     }
627     /**
628      * Returns list of plugins of given type in given directory.
629      * @param string $plugintype
630      * @param string $fulldir
631      * @return array
632      */
633     protected static function fetch_plugins($plugintype, $fulldir) {
634         global $CFG;
636         $fulldirs = (array)$fulldir;
637         if ($plugintype === 'theme') {
638             if (realpath($fulldir) !== realpath($CFG->dirroot.'/theme')) {
639                 // Include themes in standard location too.
640                 array_unshift($fulldirs, $CFG->dirroot.'/theme');
641             }
642         }
644         $result = array();
646         foreach ($fulldirs as $fulldir) {
647             if (!is_dir($fulldir)) {
648                 continue;
649             }
650             $items = new \DirectoryIterator($fulldir);
651             foreach ($items as $item) {
652                 if ($item->isDot() or !$item->isDir()) {
653                     continue;
654                 }
655                 $pluginname = $item->getFilename();
656                 if ($plugintype === 'auth' and $pluginname === 'db') {
657                     // Special exception for this wrong plugin name.
658                 } else if (isset(self::$ignoreddirs[$pluginname])) {
659                     continue;
660                 }
661                 if (!self::is_valid_plugin_name($plugintype, $pluginname)) {
662                     // Always ignore plugins with problematic names here.
663                     continue;
664                 }
665                 $result[$pluginname] = $fulldir.'/'.$pluginname;
666                 unset($item);
667             }
668             unset($items);
669         }
671         ksort($result);
672         return $result;
673     }
675     /**
676      * Find all classes that can be autoloaded including frankenstyle namespaces.
677      */
678     protected static function fill_classmap_cache() {
679         global $CFG;
681         self::$classmap = array();
683         self::load_classes('core', "$CFG->dirroot/lib/classes");
685         foreach (self::$subsystems as $subsystem => $fulldir) {
686             if (!$fulldir) {
687                 continue;
688             }
689             self::load_classes('core_'.$subsystem, "$fulldir/classes");
690         }
692         foreach (self::$plugins as $plugintype => $plugins) {
693             foreach ($plugins as $pluginname => $fulldir) {
694                 self::load_classes($plugintype.'_'.$pluginname, "$fulldir/classes");
695             }
696         }
697         ksort(self::$classmap);
698     }
700     /**
701      * Fills up the cache defining what plugins have certain files.
702      *
703      * @see self::get_plugin_list_with_file
704      * @return void
705      */
706     protected static function fill_filemap_cache() {
707         global $CFG;
709         self::$filemap = array();
711         foreach (self::$filestomap as $file) {
712             if (!isset(self::$filemap[$file])) {
713                 self::$filemap[$file] = array();
714             }
715             foreach (self::$plugins as $plugintype => $plugins) {
716                 if (!isset(self::$filemap[$file][$plugintype])) {
717                     self::$filemap[$file][$plugintype] = array();
718                 }
719                 foreach ($plugins as $pluginname => $fulldir) {
720                     if (file_exists("$fulldir/$file")) {
721                         self::$filemap[$file][$plugintype][$pluginname] = "$fulldir/$file";
722                     }
723                 }
724             }
725         }
726     }
728     /**
729      * Find classes in directory and recurse to subdirs.
730      * @param string $component
731      * @param string $fulldir
732      * @param string $namespace
733      */
734     protected static function load_classes($component, $fulldir, $namespace = '') {
735         if (!is_dir($fulldir)) {
736             return;
737         }
739         if (!is_readable($fulldir)) {
740             // TODO: MDL-51711 We should generate some diagnostic debugging information in this case
741             // because its pretty likely to lead to a missing class error further down the line.
742             // But our early setup code can't handle errors this early at the moment.
743             return;
744         }
746         $items = new \DirectoryIterator($fulldir);
747         foreach ($items as $item) {
748             if ($item->isDot()) {
749                 continue;
750             }
751             if ($item->isDir()) {
752                 $dirname = $item->getFilename();
753                 self::load_classes($component, "$fulldir/$dirname", $namespace.'\\'.$dirname);
754                 continue;
755             }
757             $filename = $item->getFilename();
758             $classname = preg_replace('/\.php$/', '', $filename);
760             if ($filename === $classname) {
761                 // Not a php file.
762                 continue;
763             }
764             if ($namespace === '') {
765                 // Legacy long frankenstyle class name.
766                 self::$classmap[$component.'_'.$classname] = "$fulldir/$filename";
767             }
768             // New namespaced classes.
769             self::$classmap[$component.$namespace.'\\'.$classname] = "$fulldir/$filename";
770         }
771         unset($item);
772         unset($items);
773     }
776     /**
777      * List all core subsystems and their location
778      *
779      * This is a whitelist of components that are part of the core and their
780      * language strings are defined in /lang/en/<<subsystem>>.php. If a given
781      * plugin is not listed here and it does not have proper plugintype prefix,
782      * then it is considered as course activity module.
783      *
784      * The location is absolute file path to dir. NULL means there is no special
785      * directory for this subsystem. If the location is set, the subsystem's
786      * renderer.php is expected to be there.
787      *
788      * @return array of (string)name => (string|null)full dir location
789      */
790     public static function get_core_subsystems() {
791         self::init();
792         return self::$subsystems;
793     }
795     /**
796      * Get list of available plugin types together with their location.
797      *
798      * @return array as (string)plugintype => (string)fulldir
799      */
800     public static function get_plugin_types() {
801         self::init();
802         return self::$plugintypes;
803     }
805     /**
806      * Get list of plugins of given type.
807      *
808      * @param string $plugintype
809      * @return array as (string)pluginname => (string)fulldir
810      */
811     public static function get_plugin_list($plugintype) {
812         self::init();
814         if (!isset(self::$plugins[$plugintype])) {
815             return array();
816         }
817         return self::$plugins[$plugintype];
818     }
820     /**
821      * Get a list of all the plugins of a given type that define a certain class
822      * in a certain file. The plugin component names and class names are returned.
823      *
824      * @param string $plugintype the type of plugin, e.g. 'mod' or 'report'.
825      * @param string $class the part of the name of the class after the
826      *      frankenstyle prefix. e.g 'thing' if you are looking for classes with
827      *      names like report_courselist_thing. If you are looking for classes with
828      *      the same name as the plugin name (e.g. qtype_multichoice) then pass ''.
829      *      Frankenstyle namespaces are also supported.
830      * @param string $file the name of file within the plugin that defines the class.
831      * @return array with frankenstyle plugin names as keys (e.g. 'report_courselist', 'mod_forum')
832      *      and the class names as values (e.g. 'report_courselist_thing', 'qtype_multichoice').
833      */
834     public static function get_plugin_list_with_class($plugintype, $class, $file = null) {
835         global $CFG; // Necessary in case it is referenced by included PHP scripts.
837         if ($class) {
838             $suffix = '_' . $class;
839         } else {
840             $suffix = '';
841         }
843         $pluginclasses = array();
844         $plugins = self::get_plugin_list($plugintype);
845         foreach ($plugins as $plugin => $fulldir) {
846             // Try class in frankenstyle namespace.
847             if ($class) {
848                 $classname = '\\' . $plugintype . '_' . $plugin . '\\' . $class;
849                 if (class_exists($classname, true)) {
850                     $pluginclasses[$plugintype . '_' . $plugin] = $classname;
851                     continue;
852                 }
853             }
855             // Try autoloading of class with frankenstyle prefix.
856             $classname = $plugintype . '_' . $plugin . $suffix;
857             if (class_exists($classname, true)) {
858                 $pluginclasses[$plugintype . '_' . $plugin] = $classname;
859                 continue;
860             }
862             // Fall back to old file location and class name.
863             if ($file and file_exists("$fulldir/$file")) {
864                 include_once("$fulldir/$file");
865                 if (class_exists($classname, false)) {
866                     $pluginclasses[$plugintype . '_' . $plugin] = $classname;
867                     continue;
868                 }
869             }
870         }
872         return $pluginclasses;
873     }
875     /**
876      * Get a list of all the plugins of a given type that contain a particular file.
877      *
878      * @param string $plugintype the type of plugin, e.g. 'mod' or 'report'.
879      * @param string $file the name of file that must be present in the plugin.
880      *                     (e.g. 'view.php', 'db/install.xml').
881      * @param bool $include if true (default false), the file will be include_once-ed if found.
882      * @return array with plugin name as keys (e.g. 'forum', 'courselist') and the path
883      *               to the file relative to dirroot as value (e.g. "$CFG->dirroot/mod/forum/view.php").
884      */
885     public static function get_plugin_list_with_file($plugintype, $file, $include = false) {
886         global $CFG; // Necessary in case it is referenced by included PHP scripts.
887         $pluginfiles = array();
889         if (isset(self::$filemap[$file])) {
890             // If the file was supposed to be mapped, then it should have been set in the array.
891             if (isset(self::$filemap[$file][$plugintype])) {
892                 $pluginfiles = self::$filemap[$file][$plugintype];
893             }
894         } else {
895             // Old-style search for non-cached files.
896             $plugins = self::get_plugin_list($plugintype);
897             foreach ($plugins as $plugin => $fulldir) {
898                 $path = $fulldir . '/' . $file;
899                 if (file_exists($path)) {
900                     $pluginfiles[$plugin] = $path;
901                 }
902             }
903         }
905         if ($include) {
906             foreach ($pluginfiles as $path) {
907                 include_once($path);
908             }
909         }
911         return $pluginfiles;
912     }
914     /**
915      * Returns all classes in a component matching the provided namespace.
916      *
917      * It checks that the class exists.
918      *
919      * e.g. get_component_classes_in_namespace('mod_forum', 'event')
920      *
921      * @param string $component A valid moodle component (frankenstyle)
922      * @param string $namespace Namespace from the component name or empty if all $component namespace classes.
923      * @return array The full class name as key and the class path as value.
924      */
925     public static function get_component_classes_in_namespace($component, $namespace = '') {
927         $component = self::normalize_componentname($component);
929         if ($namespace) {
931             // We will add them later.
932             $namespace = trim($namespace, '\\');
934             // We need add double backslashes as it is how classes are stored into self::$classmap.
935             $namespace = implode('\\\\', explode('\\', $namespace));
936             $namespace = $namespace . '\\\\';
937         }
939         $regex = '|^' . $component . '\\\\' . $namespace . '|';
940         $it = new RegexIterator(new ArrayIterator(self::$classmap), $regex, RegexIterator::GET_MATCH, RegexIterator::USE_KEY);
942         // We want to be sure that they exist.
943         $classes = array();
944         foreach ($it as $classname => $classpath) {
945             if (class_exists($classname)) {
946                 $classes[$classname] = $classpath;
947             }
948         }
950         return $classes;
951     }
953     /**
954      * Returns the exact absolute path to plugin directory.
955      *
956      * @param string $plugintype type of plugin
957      * @param string $pluginname name of the plugin
958      * @return string full path to plugin directory; null if not found
959      */
960     public static function get_plugin_directory($plugintype, $pluginname) {
961         if (empty($pluginname)) {
962             // Invalid plugin name, sorry.
963             return null;
964         }
966         self::init();
968         if (!isset(self::$plugins[$plugintype][$pluginname])) {
969             return null;
970         }
971         return self::$plugins[$plugintype][$pluginname];
972     }
974     /**
975      * Returns the exact absolute path to plugin directory.
976      *
977      * @param string $subsystem type of core subsystem
978      * @return string full path to subsystem directory; null if not found
979      */
980     public static function get_subsystem_directory($subsystem) {
981         self::init();
983         if (!isset(self::$subsystems[$subsystem])) {
984             return null;
985         }
986         return self::$subsystems[$subsystem];
987     }
989     /**
990      * This method validates a plug name. It is much faster than calling clean_param.
991      *
992      * @param string $plugintype type of plugin
993      * @param string $pluginname a string that might be a plugin name.
994      * @return bool if this string is a valid plugin name.
995      */
996     public static function is_valid_plugin_name($plugintype, $pluginname) {
997         if ($plugintype === 'mod') {
998             // Modules must not have the same name as core subsystems.
999             if (!isset(self::$subsystems)) {
1000                 // Watch out, this is called from init!
1001                 self::init();
1002             }
1003             if (isset(self::$subsystems[$pluginname])) {
1004                 return false;
1005             }
1006             // Modules MUST NOT have any underscores,
1007             // component normalisation would break very badly otherwise!
1008             return (bool)preg_match('/^[a-z][a-z0-9]*$/', $pluginname);
1010         } else {
1011             return (bool)preg_match('/^[a-z](?:[a-z0-9_](?!__))*[a-z0-9]+$/', $pluginname);
1012         }
1013     }
1015     /**
1016      * Normalize the component name.
1017      *
1018      * Note: this does not verify the validity of the plugin or component.
1019      *
1020      * @param string $component
1021      * @return string
1022      */
1023     public static function normalize_componentname($componentname) {
1024         list($plugintype, $pluginname) = self::normalize_component($componentname);
1025         if ($plugintype === 'core' && is_null($pluginname)) {
1026             return $plugintype;
1027         }
1028         return $plugintype . '_' . $pluginname;
1029     }
1031     /**
1032      * Normalize the component name using the "frankenstyle" rules.
1033      *
1034      * Note: this does not verify the validity of plugin or type names.
1035      *
1036      * @param string $component
1037      * @return array two-items list of [(string)type, (string|null)name]
1038      */
1039     public static function normalize_component($component) {
1040         if ($component === 'moodle' or $component === 'core' or $component === '') {
1041             return array('core', null);
1042         }
1044         if (strpos($component, '_') === false) {
1045             self::init();
1046             if (array_key_exists($component, self::$subsystems)) {
1047                 $type   = 'core';
1048                 $plugin = $component;
1049             } else {
1050                 // Everything else without underscore is a module.
1051                 $type   = 'mod';
1052                 $plugin = $component;
1053             }
1055         } else {
1056             list($type, $plugin) = explode('_', $component, 2);
1057             if ($type === 'moodle') {
1058                 $type = 'core';
1059             }
1060             // Any unknown type must be a subplugin.
1061         }
1063         return array($type, $plugin);
1064     }
1066     /**
1067      * Return exact absolute path to a plugin directory.
1068      *
1069      * @param string $component name such as 'moodle', 'mod_forum'
1070      * @return string full path to component directory; NULL if not found
1071      */
1072     public static function get_component_directory($component) {
1073         global $CFG;
1075         list($type, $plugin) = self::normalize_component($component);
1077         if ($type === 'core') {
1078             if ($plugin === null) {
1079                 return $path = $CFG->libdir;
1080             }
1081             return self::get_subsystem_directory($plugin);
1082         }
1084         return self::get_plugin_directory($type, $plugin);
1085     }
1087     /**
1088      * Returns list of plugin types that allow subplugins.
1089      * @return array as (string)plugintype => (string)fulldir
1090      */
1091     public static function get_plugin_types_with_subplugins() {
1092         self::init();
1094         $return = array();
1095         foreach (self::$supportsubplugins as $type) {
1096             $return[$type] = self::$plugintypes[$type];
1097         }
1098         return $return;
1099     }
1101     /**
1102      * Returns parent of this subplugin type.
1103      *
1104      * @param string $type
1105      * @return string parent component or null
1106      */
1107     public static function get_subtype_parent($type) {
1108         self::init();
1110         if (isset(self::$parents[$type])) {
1111             return self::$parents[$type];
1112         }
1114         return null;
1115     }
1117     /**
1118      * Return all subplugins of this component.
1119      * @param string $component.
1120      * @return array $subtype=>array($component, ..), null if no subtypes defined
1121      */
1122     public static function get_subplugins($component) {
1123         self::init();
1125         if (isset(self::$subplugins[$component])) {
1126             return self::$subplugins[$component];
1127         }
1129         return null;
1130     }
1132     /**
1133      * Returns hash of all versions including core and all plugins.
1134      *
1135      * This is relatively slow and not fully cached, use with care!
1136      *
1137      * @return string sha1 hash
1138      */
1139     public static function get_all_versions_hash() {
1140         global $CFG;
1142         self::init();
1144         $versions = array();
1146         // Main version first.
1147         $versions['core'] = self::fetch_core_version();
1149         // The problem here is tha the component cache might be stable,
1150         // we want this to work also on frontpage without resetting the component cache.
1151         $usecache = false;
1152         if (CACHE_DISABLE_ALL or (defined('IGNORE_COMPONENT_CACHE') and IGNORE_COMPONENT_CACHE)) {
1153             $usecache = true;
1154         }
1156         // Now all plugins.
1157         $plugintypes = core_component::get_plugin_types();
1158         foreach ($plugintypes as $type => $typedir) {
1159             if ($usecache) {
1160                 $plugs = core_component::get_plugin_list($type);
1161             } else {
1162                 $plugs = self::fetch_plugins($type, $typedir);
1163             }
1164             foreach ($plugs as $plug => $fullplug) {
1165                 $plugin = new stdClass();
1166                 $plugin->version = null;
1167                 $module = $plugin;
1168                 include($fullplug.'/version.php');
1169                 $versions[$type.'_'.$plug] = $plugin->version;
1170             }
1171         }
1173         return sha1(serialize($versions));
1174     }
1176     /**
1177      * Invalidate opcode cache for given file, this is intended for
1178      * php files that are stored in dataroot.
1179      *
1180      * Note: we need it here because this class must be self-contained.
1181      *
1182      * @param string $file
1183      */
1184     public static function invalidate_opcode_php_cache($file) {
1185         if (function_exists('opcache_invalidate')) {
1186             if (!file_exists($file)) {
1187                 return;
1188             }
1189             opcache_invalidate($file, true);
1190         }
1191     }
1193     /**
1194      * Return true if subsystemname is core subsystem.
1195      *
1196      * @param string $subsystemname name of the subsystem.
1197      * @return bool true if core subsystem.
1198      */
1199     public static function is_core_subsystem($subsystemname) {
1200         return isset(self::$subsystems[$subsystemname]);
1201     }
1203     /**
1204      * Records all class renames that have been made to facilitate autoloading.
1205      */
1206     protected static function fill_classmap_renames_cache() {
1207         global $CFG;
1209         self::$classmaprenames = array();
1211         self::load_renamed_classes("$CFG->dirroot/lib/");
1213         foreach (self::$subsystems as $subsystem => $fulldir) {
1214             self::load_renamed_classes($fulldir);
1215         }
1217         foreach (self::$plugins as $plugintype => $plugins) {
1218             foreach ($plugins as $pluginname => $fulldir) {
1219                 self::load_renamed_classes($fulldir);
1220             }
1221         }
1222     }
1224     /**
1225      * Loads the db/renamedclasses.php file from the given directory.
1226      *
1227      * The renamedclasses.php should contain a key => value array ($renamedclasses) where the key is old class name,
1228      * and the value is the new class name.
1229      * It is only included when we are populating the component cache. After that is not needed.
1230      *
1231      * @param string $fulldir
1232      */
1233     protected static function load_renamed_classes($fulldir) {
1234         $file = $fulldir . '/db/renamedclasses.php';
1235         if (is_readable($file)) {
1236             $renamedclasses = null;
1237             require($file);
1238             if (is_array($renamedclasses)) {
1239                 foreach ($renamedclasses as $oldclass => $newclass) {
1240                     self::$classmaprenames[(string)$oldclass] = (string)$newclass;
1241                 }
1242             }
1243         }
1244     }