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