xref: /dokuwiki/inc/load.php (revision e3c3abf1ebade68a06abb03d098d58afda87b317) 
1<?php
2/**
3 * Load all internal libraries and setup class autoloader
4 *
5 * @author Andreas Gohr <andi@splitbrain.org>
6 */
7use dokuwiki\ErrorHandler;
8use dokuwiki\Extension\PluginController;
9
10// setup class autoloader
11spl_autoload_register('load_autoload');
12
13// require all the common libraries
14// for a few of these order does matter
15require_once(DOKU_INC.'inc/defines.php');
16require_once(DOKU_INC.'inc/actions.php');
17require_once(DOKU_INC.'inc/changelog.php');
18require_once(DOKU_INC.'inc/common.php');
19require_once(DOKU_INC.'inc/confutils.php');
20require_once(DOKU_INC.'inc/pluginutils.php');
21require_once(DOKU_INC.'inc/form.php');
22require_once(DOKU_INC.'inc/fulltext.php');
23require_once(DOKU_INC.'inc/html.php');
24require_once(DOKU_INC.'inc/httputils.php');
25require_once(DOKU_INC.'inc/indexer.php');
26require_once(DOKU_INC.'inc/infoutils.php');
27require_once(DOKU_INC.'inc/io.php');
28require_once(DOKU_INC.'inc/mail.php');
29require_once(DOKU_INC.'inc/media.php');
30require_once(DOKU_INC.'inc/pageutils.php');
31require_once(DOKU_INC.'inc/parserutils.php');
32require_once(DOKU_INC.'inc/search.php');
33require_once(DOKU_INC.'inc/template.php');
34require_once(DOKU_INC.'inc/toolbar.php');
35require_once(DOKU_INC.'inc/utf8.php');
36require_once(DOKU_INC.'inc/auth.php');
37require_once(DOKU_INC.'inc/compatibility.php');
38require_once(DOKU_INC.'inc/deprecated.php');
39require_once(DOKU_INC.'inc/legacy.php');
40
41/**
42 * spl_autoload_register callback
43 *
44 * Contains a static list of DokuWiki's core classes and automatically
45 * require()s their associated php files when an object is instantiated.
46 *
47 * @author Andreas Gohr <andi@splitbrain.org>
48 * @todo   add generic loading of renderers and auth backends
49 *
50 * @param string $name
51 *
52 * @return bool
53 */
54function load_autoload($name){
55    static $classes = null;
56    if($classes === null) $classes = [
57        'Diff'                  => DOKU_INC.'inc/DifferenceEngine.php',
58        'UnifiedDiffFormatter'  => DOKU_INC.'inc/DifferenceEngine.php',
59        'TableDiffFormatter'    => DOKU_INC.'inc/DifferenceEngine.php',
60        'cache'                 => DOKU_INC.'inc/cache.php',
61        'cache_parser'          => DOKU_INC.'inc/cache.php',
62        'cache_instructions'    => DOKU_INC.'inc/cache.php',
63        'cache_renderer'        => DOKU_INC.'inc/cache.php',
64        'Input'                 => DOKU_INC.'inc/Input.class.php',
65        'JpegMeta'              => DOKU_INC.'inc/JpegMeta.php',
66        'SimplePie'             => DOKU_INC.'inc/SimplePie.php',
67        'FeedParser'            => DOKU_INC.'inc/FeedParser.php',
68        'SafeFN'                => DOKU_INC.'inc/SafeFN.class.php',
69        'Mailer'                => DOKU_INC.'inc/Mailer.class.php',
70        'Doku_Handler'          => DOKU_INC.'inc/parser/handler.php',
71        'Doku_Renderer'          => DOKU_INC.'inc/parser/renderer.php',
72        'Doku_Renderer_xhtml'    => DOKU_INC.'inc/parser/xhtml.php',
73        'Doku_Renderer_code'     => DOKU_INC.'inc/parser/code.php',
74        'Doku_Renderer_xhtmlsummary' => DOKU_INC.'inc/parser/xhtmlsummary.php',
75        'Doku_Renderer_metadata' => DOKU_INC.'inc/parser/metadata.php'
76    ];
77
78    if(isset($classes[$name])){
79        require ($classes[$name]);
80        return true;
81    }
82
83    // namespace to directory conversion
84    $name = str_replace('\\', '/', $name);
85
86    // test mock namespace
87    if (substr($name, 0, 19) === 'dokuwiki/test/mock/') {
88        $file = DOKU_INC . '_test/mock/' . substr($name, 19) . '.php';
89        if (file_exists($file)) {
90            require $file;
91            return true;
92        }
93    }
94
95    // tests namespace
96    if (substr($name, 0, 14) === 'dokuwiki/test/') {
97        $file = DOKU_INC . '_test/tests/' . substr($name, 14) . '.php';
98        if (file_exists($file)) {
99            require $file;
100            return true;
101        }
102    }
103
104    // plugin namespace
105    if(substr($name, 0, 16) === 'dokuwiki/plugin/') {
106        $name = str_replace('/test/', '/_test/', $name); // no underscore in test namespace
107        $file = DOKU_PLUGIN . substr($name, 16) . '.php';
108        if(file_exists($file)) {
109            try {
110                require $file;
111            } catch (\Throwable $e) {
112                ErrorHandler::showExceptionMsg($e, "Error loading plugin $name");
113            }
114            return true;
115        }
116    }
117
118    // template namespace
119    if(substr($name, 0, 18) === 'dokuwiki/template/') {
120        $name = str_replace('/test/', '/_test/', $name); // no underscore in test namespace
121        $file = DOKU_INC.'lib/tpl/' . substr($name, 18) . '.php';
122        if(file_exists($file)) {
123            try {
124                require $file;
125            } catch (\Throwable $e) {
126                ErrorHandler::showExceptionMsg($e, "Error loading template $name");
127            }
128            return true;
129        }
130    }
131
132    // our own namespace
133    if(substr($name, 0, 9) === 'dokuwiki/') {
134        $file = DOKU_INC . 'inc/' . substr($name, 9) . '.php';
135        if(file_exists($file)) {
136            require $file;
137            return true;
138        }
139    }
140
141    // Plugin loading
142    if(preg_match(
143        '/^(' . implode('|', PluginController::PLUGIN_TYPES) . ')_plugin_(' .
144        DOKU_PLUGIN_NAME_REGEX .
145        ')(?:_([^_]+))?$/',
146        $name,
147        $m
148    )) {
149        // try to load the wanted plugin file
150        $c = ((count($m) === 4) ? "/{$m[3]}" : '');
151        $plg = DOKU_PLUGIN . "{$m[2]}/{$m[1]}$c.php";
152        if(file_exists($plg)){
153            try {
154                require $plg;
155            } catch (\Throwable $e) {
156                ErrorHandler::showExceptionMsg($e, "Error loading plugin {$m[2]}");
157            }
158        }
159        return true;
160    }
161    return false;
162}
163
164