1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
|
<?php
namespace dokuwiki\Extension;
/**
* Provides standard DokuWiki plugin behaviour
*/
trait PluginTrait
{
protected $localised = false; // set to true by setupLocale() after loading language dependent strings
protected $lang = array(); // array to hold language dependent strings, best accessed via ->getLang()
protected $configloaded = false; // set to true by loadConfig() after loading plugin configuration variables
protected $conf = array(); // array to hold plugin settings, best accessed via ->getConf()
/**
* @see PluginInterface::getInfo()
*/
public function getInfo()
{
$parts = explode('_', get_class($this));
$info = DOKU_PLUGIN . '/' . $parts[2] . '/plugin.info.txt';
if (file_exists($info)) return confToHash($info);
msg(
'getInfo() not implemented in ' . get_class($this) . ' and ' . $info . ' not found.<br />' .
'Verify you\'re running the latest version of the plugin. If the problem persists, send a ' .
'bug report to the author of the ' . $parts[2] . ' plugin.', -1
);
return array(
'date' => '0000-00-00',
'name' => $parts[2] . ' plugin',
);
}
/**
* @see PluginInterface::isSingleton()
*/
public function isSingleton()
{
return true;
}
/**
* @see PluginInterface::loadHelper()
*/
public function loadHelper($name, $msg = true)
{
$obj = plugin_load('helper', $name);
if (is_null($obj) && $msg) msg("Helper plugin $name is not available or invalid.", -1);
return $obj;
}
// region introspection methods
/**
* @see PluginInterface::getPluginType()
*/
public function getPluginType()
{
list($t) = explode('_', get_class($this), 2);
return $t;
}
/**
* @see PluginInterface::getPluginName()
*/
public function getPluginName()
{
list(/* $t */, /* $p */, $n) = explode('_', get_class($this), 4);
return $n;
}
/**
* @see PluginInterface::getPluginComponent()
*/
public function getPluginComponent()
{
list(/* $t */, /* $p */, /* $n */, $c) = explode('_', get_class($this), 4);
return (isset($c) ? $c : '');
}
// endregion
// region localization methods
/**
* @see PluginInterface::getLang()
*/
public function getLang($id)
{
if (!$this->localised) $this->setupLocale();
return (isset($this->lang[$id]) ? $this->lang[$id] : '');
}
/**
* @see PluginInterface::locale_xhtml()
*/
public function locale_xhtml($id)
{
return p_cached_output($this->localFN($id));
}
/**
* @see PluginInterface::localFN()
*/
public function localFN($id, $ext = 'txt')
{
global $conf;
$plugin = $this->getPluginName();
$file = DOKU_CONF . 'plugin_lang/' . $plugin . '/' . $conf['lang'] . '/' . $id . '.' . $ext;
if (!file_exists($file)) {
$file = DOKU_PLUGIN . $plugin . '/lang/' . $conf['lang'] . '/' . $id . '.' . $ext;
if (!file_exists($file)) {
//fall back to english
$file = DOKU_PLUGIN . $plugin . '/lang/en/' . $id . '.' . $ext;
}
}
return $file;
}
/**
* @see PluginInterface::setupLocale()
*/
public function setupLocale()
{
if ($this->localised) return;
global $conf, $config_cascade; // definitely don't invoke "global $lang"
$path = DOKU_PLUGIN . $this->getPluginName() . '/lang/';
$lang = array();
// don't include once, in case several plugin components require the same language file
@include($path . 'en/lang.php');
foreach ($config_cascade['lang']['plugin'] as $config_file) {
if (file_exists($config_file . $this->getPluginName() . '/en/lang.php')) {
include($config_file . $this->getPluginName() . '/en/lang.php');
}
}
if ($conf['lang'] != 'en') {
@include($path . $conf['lang'] . '/lang.php');
foreach ($config_cascade['lang']['plugin'] as $config_file) {
if (file_exists($config_file . $this->getPluginName() . '/' . $conf['lang'] . '/lang.php')) {
include($config_file . $this->getPluginName() . '/' . $conf['lang'] . '/lang.php');
}
}
}
$this->lang = $lang;
$this->localised = true;
}
// endregion
// region configuration methods
/**
* @see PluginInterface::getConf()
*/
public function getConf($setting, $notset = false)
{
if (!$this->configloaded) {
$this->loadConfig();
}
if (isset($this->conf[$setting])) {
return $this->conf[$setting];
} else {
return $notset;
}
}
/**
* @see PluginInterface::loadConfig()
*/
public function loadConfig()
{
global $conf;
$defaults = $this->readDefaultSettings();
$plugin = $this->getPluginName();
foreach ($defaults as $key => $value) {
if (isset($conf['plugin'][$plugin][$key])) continue;
$conf['plugin'][$plugin][$key] = $value;
}
$this->configloaded = true;
$this->conf =& $conf['plugin'][$plugin];
}
/**
* read the plugin's default configuration settings from conf/default.php
* this function is automatically called through getConf()
*
* @return array setting => value
*/
protected function readDefaultSettings()
{
$path = DOKU_PLUGIN . $this->getPluginName() . '/conf/';
$conf = array();
if (file_exists($path . 'default.php')) {
include($path . 'default.php');
}
return $conf;
}
// endregion
// region output methods
/**
* @see PluginInterface::email()
*/
public function email($email, $name = '', $class = '', $more = '')
{
if (!$email) return $name;
$email = obfuscate($email);
if (!$name) $name = $email;
$class = "class='" . ($class ? $class : 'mail') . "'";
return "<a href='mailto:$email' $class title='$email' $more>$name</a>";
}
/**
* @see PluginInterface::external_link()
*/
public function external_link($link, $title = '', $class = '', $target = '', $more = '')
{
global $conf;
$link = htmlentities($link);
if (!$title) $title = $link;
if (!$target) $target = $conf['target']['extern'];
if ($conf['relnofollow']) $more .= ' rel="nofollow"';
if ($class) $class = " class='$class'";
if ($target) $target = " target='$target'";
if ($more) $more = " " . trim($more);
return "<a href='$link'$class$target$more>$title</a>";
}
/**
* @see PluginInterface::render_text()
*/
public function render_text($text, $format = 'xhtml')
{
return p_render($format, p_get_instructions($text), $info);
}
// endregion
}
|
