1 | <?php
|
---|
2 | /**
|
---|
3 | * Syntax Plugin Prototype
|
---|
4 | *
|
---|
5 | * @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
|
---|
6 | * @author Andreas Gohr <[email protected]>
|
---|
7 | */
|
---|
8 | // must be run within Dokuwiki
|
---|
9 | if(!defined('DOKU_INC')) die();
|
---|
10 |
|
---|
11 | /**
|
---|
12 | * All DokuWiki plugins to extend the parser/rendering mechanism
|
---|
13 | * need to inherit from this class
|
---|
14 | */
|
---|
15 | class DokuWiki_Syntax_Plugin extends Doku_Parser_Mode {
|
---|
16 |
|
---|
17 | var $allowedModesSetup = false;
|
---|
18 | var $localised = false; // set to true by setupLocale() after loading language dependent strings
|
---|
19 | var $lang = array(); // array to hold language dependent strings, best accessed via ->getLang()
|
---|
20 | var $configloaded = false; // set to true by loadConfig() after loading plugin configuration variables
|
---|
21 | var $conf = array(); // array to hold plugin settings, best accessed via ->getConf()
|
---|
22 |
|
---|
23 | /**
|
---|
24 | * General Info
|
---|
25 | *
|
---|
26 | * Needs to return a associative array with the following values:
|
---|
27 | *
|
---|
28 | * author - Author of the plugin
|
---|
29 | * email - Email address to contact the author
|
---|
30 | * date - Last modified date of the plugin in YYYY-MM-DD format
|
---|
31 | * name - Name of the plugin
|
---|
32 | * desc - Short description of the plugin (Text only)
|
---|
33 | * url - Website with more information on the plugin (eg. syntax description)
|
---|
34 | */
|
---|
35 | function getInfo(){
|
---|
36 | $parts = explode('_',get_class($this));
|
---|
37 | $info = DOKU_PLUGIN.'/'.$parts[2].'/plugin.info.txt';
|
---|
38 | if(@file_exists($info)) return confToHash($info);
|
---|
39 | trigger_error('getInfo() not implemented in '.get_class($this).' and '.$info.' not found', E_USER_WARNING);
|
---|
40 | }
|
---|
41 |
|
---|
42 | /**
|
---|
43 | * Syntax Type
|
---|
44 | *
|
---|
45 | * Needs to return one of the mode types defined in $PARSER_MODES in parser.php
|
---|
46 | */
|
---|
47 | function getType(){
|
---|
48 | trigger_error('getType() not implemented in '.get_class($this), E_USER_WARNING);
|
---|
49 | }
|
---|
50 |
|
---|
51 | /**
|
---|
52 | * Allowed Mode Types
|
---|
53 | *
|
---|
54 | * Defines the mode types for other dokuwiki markup that maybe nested within the
|
---|
55 | * plugin's own markup. Needs to return an array of one or more of the mode types
|
---|
56 | * defined in $PARSER_MODES in parser.php
|
---|
57 | */
|
---|
58 | function getAllowedTypes() {
|
---|
59 | return array();
|
---|
60 | }
|
---|
61 |
|
---|
62 | /**
|
---|
63 | * Paragraph Type
|
---|
64 | *
|
---|
65 | * Defines how this syntax is handled regarding paragraphs. This is important
|
---|
66 | * for correct XHTML nesting. Should return one of the following:
|
---|
67 | *
|
---|
68 | * 'normal' - The plugin can be used inside paragraphs
|
---|
69 | * 'block' - Open paragraphs need to be closed before plugin output
|
---|
70 | * 'stack' - Special case. Plugin wraps other paragraphs.
|
---|
71 | *
|
---|
72 | * @see Doku_Handler_Block
|
---|
73 | */
|
---|
74 | function getPType(){
|
---|
75 | return 'normal';
|
---|
76 | }
|
---|
77 |
|
---|
78 | /**
|
---|
79 | * Handler to prepare matched data for the rendering process
|
---|
80 | *
|
---|
81 | * This function can only pass data to render() via its return value - render()
|
---|
82 | * may be not be run during the object's current life.
|
---|
83 | *
|
---|
84 | * Usually you should only need the $match param.
|
---|
85 | *
|
---|
86 | * @param $match string The text matched by the patterns
|
---|
87 | * @param $state int The lexer state for the match
|
---|
88 | * @param $pos int The character position of the matched text
|
---|
89 | * @param $handler ref Reference to the Doku_Handler object
|
---|
90 | * @return array Return an array with all data you want to use in render
|
---|
91 | */
|
---|
92 | function handle($match, $state, $pos, &$handler){
|
---|
93 | trigger_error('handle() not implemented in '.get_class($this), E_USER_WARNING);
|
---|
94 | }
|
---|
95 |
|
---|
96 | /**
|
---|
97 | * Handles the actual output creation.
|
---|
98 | *
|
---|
99 | * The function must not assume any other of the classes methods have been run
|
---|
100 | * during the object's current life. The only reliable data it receives are its
|
---|
101 | * parameters.
|
---|
102 | *
|
---|
103 | * The function should always check for the given output format and return false
|
---|
104 | * when a format isn't supported.
|
---|
105 | *
|
---|
106 | * $renderer contains a reference to the renderer object which is
|
---|
107 | * currently handling the rendering. You need to use it for writing
|
---|
108 | * the output. How this is done depends on the renderer used (specified
|
---|
109 | * by $format
|
---|
110 | *
|
---|
111 | * The contents of the $data array depends on what the handler() function above
|
---|
112 | * created
|
---|
113 | *
|
---|
114 | * @param $format string output format being rendered
|
---|
115 | * @param $renderer ref reference to the current renderer object
|
---|
116 | * @param $data array data created by handler()
|
---|
117 | * @return boolean rendered correctly?
|
---|
118 | */
|
---|
119 | function render($format, &$renderer, $data) {
|
---|
120 | trigger_error('render() not implemented in '.get_class($this), E_USER_WARNING);
|
---|
121 |
|
---|
122 | }
|
---|
123 |
|
---|
124 | /**
|
---|
125 | * There should be no need to override these functions
|
---|
126 | */
|
---|
127 | function accepts($mode) {
|
---|
128 |
|
---|
129 | if (!$this->allowedModesSetup) {
|
---|
130 | global $PARSER_MODES;
|
---|
131 |
|
---|
132 | $allowedModeTypes = $this->getAllowedTypes();
|
---|
133 | foreach($allowedModeTypes as $mt) {
|
---|
134 | $this->allowedModes = array_merge($this->allowedModes, $PARSER_MODES[$mt]);
|
---|
135 | }
|
---|
136 |
|
---|
137 | $idx = array_search(substr(get_class($this), 7), (array) $this->allowedModes);
|
---|
138 | if ($idx !== false) {
|
---|
139 | unset($this->allowedModes[$idx]);
|
---|
140 | }
|
---|
141 | $this->allowedModesSetup = true;
|
---|
142 | }
|
---|
143 |
|
---|
144 | return parent::accepts($mode);
|
---|
145 | }
|
---|
146 |
|
---|
147 | // plugin introspection methods
|
---|
148 | // extract from class name, format = <plugin type>_plugin_<name>[_<component name>]
|
---|
149 | function getPluginType() { list($t) = explode('_', get_class($this), 2); return $t; }
|
---|
150 | function getPluginName() { list($t, $p, $n) = explode('_', get_class($this), 4); return $n; }
|
---|
151 | function getPluginComponent() { list($t, $p, $n, $c) = explode('_', get_class($this), 4); return (isset($c)?$c:''); }
|
---|
152 |
|
---|
153 | // localisation methods
|
---|
154 | /**
|
---|
155 | * getLang($id)
|
---|
156 | *
|
---|
157 | * use this function to access plugin language strings
|
---|
158 | * to try to minimise unnecessary loading of the strings when the plugin doesn't require them
|
---|
159 | * e.g. when info plugin is querying plugins for information about themselves.
|
---|
160 | *
|
---|
161 | * @param $id id of the string to be retrieved
|
---|
162 | * @return string string in appropriate language or english if not available
|
---|
163 | */
|
---|
164 | function getLang($id) {
|
---|
165 | if (!$this->localised) $this->setupLocale();
|
---|
166 |
|
---|
167 | return (isset($this->lang[$id]) ? $this->lang[$id] : '');
|
---|
168 | }
|
---|
169 |
|
---|
170 | /**
|
---|
171 | * locale_xhtml($id)
|
---|
172 | *
|
---|
173 | * retrieve a language dependent wiki page and pass to xhtml renderer for display
|
---|
174 | * plugin equivalent of p_locale_xhtml()
|
---|
175 | *
|
---|
176 | * @param $id id of language dependent wiki page
|
---|
177 | * @return string parsed contents of the wiki page in xhtml format
|
---|
178 | */
|
---|
179 | function locale_xhtml($id) {
|
---|
180 | return p_cached_output($this->localFN($id));
|
---|
181 | }
|
---|
182 |
|
---|
183 | /**
|
---|
184 | * localFN($id)
|
---|
185 | * prepends appropriate path for a language dependent filename
|
---|
186 | * plugin equivalent of localFN()
|
---|
187 | */
|
---|
188 | function localFN($id) {
|
---|
189 | global $conf;
|
---|
190 | $plugin = $this->getPluginName();
|
---|
191 | $file = DOKU_CONF.'/plugin_lang/'.$plugin.'/'.$conf['lang'].'/'.$id.'.txt';
|
---|
192 | if (!@file_exists($file)){
|
---|
193 | $file = DOKU_PLUGIN.$plugin.'/lang/'.$conf['lang'].'/'.$id.'.txt';
|
---|
194 | if(!@file_exists($file)){
|
---|
195 | //fall back to english
|
---|
196 | $file = DOKU_PLUGIN.$plugin.'/lang/en/'.$id.'.txt';
|
---|
197 | }
|
---|
198 | }
|
---|
199 | return $file;
|
---|
200 | }
|
---|
201 |
|
---|
202 | /**
|
---|
203 | * setupLocale()
|
---|
204 | * reads all the plugins language dependent strings into $this->lang
|
---|
205 | * this function is automatically called by getLang()
|
---|
206 | */
|
---|
207 | function setupLocale() {
|
---|
208 | if ($this->localised) return;
|
---|
209 |
|
---|
210 | global $conf; // definitely don't invoke "global $lang"
|
---|
211 | $path = DOKU_PLUGIN.$this->getPluginName().'/lang/';
|
---|
212 |
|
---|
213 | // don't include once, in case several plugin components require the same language file
|
---|
214 | @include($path.'en/lang.php');
|
---|
215 | if ($conf['lang'] != 'en') @include($path.$conf['lang'].'/lang.php');
|
---|
216 |
|
---|
217 | $this->lang = $lang;
|
---|
218 | $this->localised = true;
|
---|
219 | }
|
---|
220 |
|
---|
221 | // configuration methods
|
---|
222 | /**
|
---|
223 | * getConf($setting)
|
---|
224 | *
|
---|
225 | * use this function to access plugin configuration variables
|
---|
226 | */
|
---|
227 | function getConf($setting){
|
---|
228 |
|
---|
229 | if (!$this->configloaded){ $this->loadConfig(); }
|
---|
230 |
|
---|
231 | return $this->conf[$setting];
|
---|
232 | }
|
---|
233 |
|
---|
234 | /**
|
---|
235 | * loadConfig()
|
---|
236 | * merges the plugin's default settings with any local settings
|
---|
237 | * this function is automatically called through getConf()
|
---|
238 | */
|
---|
239 | function loadConfig(){
|
---|
240 | global $conf;
|
---|
241 |
|
---|
242 | $defaults = $this->readDefaultSettings();
|
---|
243 | $plugin = $this->getPluginName();
|
---|
244 |
|
---|
245 | foreach ($defaults as $key => $value) {
|
---|
246 | if (isset($conf['plugin'][$plugin][$key])) continue;
|
---|
247 | $conf['plugin'][$plugin][$key] = $value;
|
---|
248 | }
|
---|
249 |
|
---|
250 | $this->configloaded = true;
|
---|
251 | $this->conf =& $conf['plugin'][$plugin];
|
---|
252 | }
|
---|
253 |
|
---|
254 | /**
|
---|
255 | * read the plugin's default configuration settings from conf/default.php
|
---|
256 | * this function is automatically called through getConf()
|
---|
257 | *
|
---|
258 | * @return array setting => value
|
---|
259 | */
|
---|
260 | function readDefaultSettings() {
|
---|
261 |
|
---|
262 | $path = DOKU_PLUGIN.$this->getPluginName().'/conf/';
|
---|
263 | $conf = array();
|
---|
264 |
|
---|
265 | if (@file_exists($path.'default.php')) {
|
---|
266 | include($path.'default.php');
|
---|
267 | }
|
---|
268 |
|
---|
269 | return $conf;
|
---|
270 | }
|
---|
271 |
|
---|
272 | /**
|
---|
273 | * Allow the plugin to prevent DokuWiki from reusing an instance
|
---|
274 | *
|
---|
275 | * @return bool false if the plugin has to be instantiated
|
---|
276 | */
|
---|
277 | function isSingleton() {
|
---|
278 | return true;
|
---|
279 | }
|
---|
280 |
|
---|
281 | }
|
---|
282 | //Setup VIM: ex: et ts=4 :
|
---|