xref: /dokuwiki/inc/confutils.php (revision badb3b57090d676d4332f4ffe9bb18c0fcfa16e5) 
1<?php
2/**
3 * Utilities for collecting data from config files
4 *
5 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
6 * @author     Harry Fuecks <hfuecks@gmail.com>
7 */
8
9/*
10 * line prefix used to negate single value config items
11 * (scheme.conf & stopwords.conf), e.g.
12 * !gopher
13 */
14const DOKU_CONF_NEGATION = '!';
15
16/**
17 * Returns the (known) extension and mimetype of a given filename
18 *
19 * If $knownonly is true (the default), then only known extensions
20 * are returned.
21 *
22 * @author Andreas Gohr <andi@splitbrain.org>
23 *
24 * @param string $file file name
25 * @param bool   $knownonly
26 * @return array with extension, mimetype and if it should be downloaded
27 */
28function mimetype($file, $knownonly=true){
29    $mtypes = getMimeTypes();     // known mimetypes
30    $ext    = strrpos($file, '.');
31    if ($ext === false) {
32        return array(false, false, false);
33    }
34    $ext = strtolower(substr($file, $ext + 1));
35    if (!isset($mtypes[$ext])){
36        if ($knownonly) {
37            return array(false, false, false);
38        } else {
39            return array($ext, 'application/octet-stream', true);
40        }
41    }
42    if($mtypes[$ext][0] == '!'){
43        return array($ext, substr($mtypes[$ext],1), true);
44    }else{
45        return array($ext, $mtypes[$ext], false);
46    }
47}
48
49/**
50 * returns a hash of mimetypes
51 *
52 * @author Andreas Gohr <andi@splitbrain.org>
53 */
54function getMimeTypes() {
55    static $mime = null;
56    if ( !$mime ) {
57        $mime = retrieveConfig('mime','confToHash');
58        $mime = array_filter($mime);
59    }
60    return $mime;
61}
62
63/**
64 * returns a hash of acronyms
65 *
66 * @author Harry Fuecks <hfuecks@gmail.com>
67 */
68function getAcronyms() {
69    static $acronyms = null;
70    if ( !$acronyms ) {
71        $acronyms = retrieveConfig('acronyms','confToHash');
72        $acronyms = array_filter($acronyms, 'strlen');
73    }
74    return $acronyms;
75}
76
77/**
78 * returns a hash of smileys
79 *
80 * @author Harry Fuecks <hfuecks@gmail.com>
81 */
82function getSmileys() {
83    static $smileys = null;
84    if ( !$smileys ) {
85        $smileys = retrieveConfig('smileys','confToHash');
86        $smileys = array_filter($smileys, 'strlen');
87    }
88    return $smileys;
89}
90
91/**
92 * returns a hash of entities
93 *
94 * @author Harry Fuecks <hfuecks@gmail.com>
95 */
96function getEntities() {
97    static $entities = null;
98    if ( !$entities ) {
99        $entities = retrieveConfig('entities','confToHash');
100        $entities = array_filter($entities, 'strlen');
101    }
102    return $entities;
103}
104
105/**
106 * returns a hash of interwikilinks
107 *
108 * @author Harry Fuecks <hfuecks@gmail.com>
109 */
110function getInterwiki() {
111    static $wikis = null;
112    if ( !$wikis ) {
113        $wikis = retrieveConfig('interwiki','confToHash',array(true));
114        $wikis = array_filter($wikis, 'strlen');
115
116        //add sepecial case 'this'
117        $wikis['this'] = DOKU_URL.'{NAME}';
118    }
119    return $wikis;
120}
121
122/**
123 * Returns the jquery script URLs for the versions defined in lib/scripts/jquery/versions
124 *
125 * @trigger CONFUTIL_CDN_SELECT
126 * @return array
127 */
128function getCdnUrls() {
129    global $conf;
130
131    // load version info
132    $versions = array();
133    $lines = file(DOKU_INC . 'lib/scripts/jquery/versions');
134    foreach($lines as $line) {
135        $line = trim(preg_replace('/#.*$/', '', $line));
136        if($line === '') continue;
137        list($key, $val) = explode('=', $line, 2);
138        $key = trim($key);
139        $val = trim($val);
140        $versions[$key] = $val;
141    }
142
143    $src = array();
144    $data = array(
145        'versions' => $versions,
146        'src' => &$src
147    );
148    $event = new Doku_Event('CONFUTIL_CDN_SELECT', $data);
149    if($event->advise_before()) {
150        if(!$conf['jquerycdn']) {
151            $jqmod = md5(join('-', $versions));
152            $src[] = DOKU_BASE . 'lib/exe/jquery.php' . '?tseed=' . $jqmod;
153        } elseif($conf['jquerycdn'] == 'jquery') {
154            $src[] = sprintf('https://code.jquery.com/jquery-%s.min.js', $versions['JQ_VERSION']);
155            $src[] = sprintf('https://code.jquery.com/jquery-migrate-%s.min.js', $versions['JQM_VERSION']);
156            $src[] = sprintf('https://code.jquery.com/ui/%s/jquery-ui.min.js', $versions['JQUI_VERSION']);
157        } elseif($conf['jquerycdn'] == 'cdnjs') {
158            $src[] = sprintf('https://cdnjs.cloudflare.com/ajax/libs/jquery/%s/jquery.min.js', $versions['JQ_VERSION']);
159            $src[] = sprintf('https://cdnjs.cloudflare.com/ajax/libs/jquery-migrate/%s/jquery-migrate.min.js', $versions['JQM_VERSION']);
160            $src[] = sprintf('https://cdnjs.cloudflare.com/ajax/libs/jqueryui/%s/jquery-ui.min.js', $versions['JQUI_VERSION']);
161        }
162    }
163    $event->advise_after();
164
165    return $src;
166}
167
168/**
169 * returns array of wordblock patterns
170 *
171 */
172function getWordblocks() {
173    static $wordblocks = null;
174    if ( !$wordblocks ) {
175        $wordblocks = retrieveConfig('wordblock','file',null,'array_merge_with_removal');
176    }
177    return $wordblocks;
178}
179
180/**
181 * Gets the list of configured schemes
182 *
183 * @return array the schemes
184 */
185function getSchemes() {
186    static $schemes = null;
187    if ( !$schemes ) {
188        $schemes = retrieveConfig('scheme','file',null,'array_merge_with_removal');
189        $schemes = array_map('trim', $schemes);
190        $schemes = preg_replace('/^#.*/', '', $schemes);
191        $schemes = array_filter($schemes);
192    }
193    return $schemes;
194}
195
196/**
197 * Builds a hash from an array of lines
198 *
199 * If $lower is set to true all hash keys are converted to
200 * lower case.
201 *
202 * @author Harry Fuecks <hfuecks@gmail.com>
203 * @author Andreas Gohr <andi@splitbrain.org>
204 * @author Gina Haeussge <gina@foosel.net>
205 *
206 * @param array $lines
207 * @param bool $lower
208 *
209 * @return array
210 */
211function linesToHash($lines, $lower=false) {
212    $conf = array();
213    // remove BOM
214    if (isset($lines[0]) && substr($lines[0],0,3) == pack('CCC',0xef,0xbb,0xbf))
215        $lines[0] = substr($lines[0],3);
216    foreach ( $lines as $line ) {
217        //ignore comments (except escaped ones)
218        $line = preg_replace('/(?<![&\\\\])#.*$/','',$line);
219        $line = str_replace('\\#','#',$line);
220        $line = trim($line);
221        if(empty($line)) continue;
222        $line = preg_split('/\s+/',$line,2);
223        // Build the associative array
224        if($lower){
225            $conf[strtolower($line[0])] = $line[1];
226        }else{
227            $conf[$line[0]] = $line[1];
228        }
229    }
230
231    return $conf;
232}
233
234/**
235 * Builds a hash from a configfile
236 *
237 * If $lower is set to true all hash keys are converted to
238 * lower case.
239 *
240 * @author Harry Fuecks <hfuecks@gmail.com>
241 * @author Andreas Gohr <andi@splitbrain.org>
242 * @author Gina Haeussge <gina@foosel.net>
243 *
244 * @param string $file
245 * @param bool $lower
246 *
247 * @return array
248 */
249function confToHash($file,$lower=false) {
250    $conf = array();
251    $lines = @file( $file );
252    if ( !$lines ) return $conf;
253
254    return linesToHash($lines, $lower);
255}
256
257/**
258 * Retrieve the requested configuration information
259 *
260 * @author Chris Smith <chris@jalakai.co.uk>
261 *
262 * @param  string   $type     the configuration settings to be read, must correspond to a key/array in $config_cascade
263 * @param  callback $fn       the function used to process the configuration file into an array
264 * @param  array    $params   optional additional params to pass to the callback
265 * @param  callback $combine  the function used to combine arrays of values read from different configuration files;
266 *                            the function takes two parameters,
267 *                               $combined - the already read & merged configuration values
268 *                               $new - array of config values from the config cascade file being currently processed
269 *                            and returns an array of the merged configuration values.
270 * @return array    configuration values
271 */
272function retrieveConfig($type,$fn,$params=null,$combine='array_merge') {
273    global $config_cascade;
274
275    if(!is_array($params)) $params = array();
276
277    $combined = array();
278    if (!is_array($config_cascade[$type])) trigger_error('Missing config cascade for "'.$type.'"',E_USER_WARNING);
279    foreach (array('default','local','protected') as $config_group) {
280        if (empty($config_cascade[$type][$config_group])) continue;
281        foreach ($config_cascade[$type][$config_group] as $file) {
282            if (file_exists($file)) {
283                $config = call_user_func_array($fn,array_merge(array($file),$params));
284                $combined = $combine($combined, $config);
285            }
286        }
287    }
288
289    return $combined;
290}
291
292/**
293 * Include the requested configuration information
294 *
295 * @author Chris Smith <chris@jalakai.co.uk>
296 *
297 * @param  string   $type     the configuration settings to be read, must correspond to a key/array in $config_cascade
298 * @return array              list of files, default before local before protected
299 */
300function getConfigFiles($type) {
301    global $config_cascade;
302    $files = array();
303
304    if (!is_array($config_cascade[$type])) trigger_error('Missing config cascade for "'.$type.'"',E_USER_WARNING);
305    foreach (array('default','local','protected') as $config_group) {
306        if (empty($config_cascade[$type][$config_group])) continue;
307        $files = array_merge($files, $config_cascade[$type][$config_group]);
308    }
309
310    return $files;
311}
312
313/**
314 * check if the given action was disabled in config
315 *
316 * @author Andreas Gohr <andi@splitbrain.org>
317 * @param string $action
318 * @returns boolean true if enabled, false if disabled
319 */
320function actionOK($action){
321    static $disabled = null;
322    if(is_null($disabled) || defined('SIMPLE_TEST')){
323        global $conf;
324        /** @var DokuWiki_Auth_Plugin $auth */
325        global $auth;
326
327        // prepare disabled actions array and handle legacy options
328        $disabled = explode(',',$conf['disableactions']);
329        $disabled = array_map('trim',$disabled);
330        if((isset($conf['openregister']) && !$conf['openregister']) || is_null($auth) || !$auth->canDo('addUser')) {
331            $disabled[] = 'register';
332        }
333        if((isset($conf['resendpasswd']) && !$conf['resendpasswd']) || is_null($auth) || !$auth->canDo('modPass')) {
334            $disabled[] = 'resendpwd';
335        }
336        if((isset($conf['subscribers']) && !$conf['subscribers']) || is_null($auth)) {
337            $disabled[] = 'subscribe';
338        }
339        if (is_null($auth) || !$auth->canDo('Profile')) {
340            $disabled[] = 'profile';
341        }
342        if (is_null($auth) || !$auth->canDo('delUser')) {
343            $disabled[] = 'profile_delete';
344        }
345        if (is_null($auth)) {
346            $disabled[] = 'login';
347        }
348        if (is_null($auth) || !$auth->canDo('logout')) {
349            $disabled[] = 'logout';
350        }
351        $disabled = array_unique($disabled);
352    }
353
354    return !in_array($action,$disabled);
355}
356
357/**
358 * check if headings should be used as link text for the specified link type
359 *
360 * @author Chris Smith <chris@jalakai.co.uk>
361 *
362 * @param   string  $linktype   'content'|'navigation', content applies to links in wiki text
363 *                                                      navigation applies to all other links
364 * @return  boolean             true if headings should be used for $linktype, false otherwise
365 */
366function useHeading($linktype) {
367    static $useHeading = null;
368    if(defined('DOKU_UNITTEST')) $useHeading = null; // don't cache during unit tests
369
370    if (is_null($useHeading)) {
371        global $conf;
372
373        if (!empty($conf['useheading'])) {
374            switch ($conf['useheading']) {
375                case 'content':
376                    $useHeading['content'] = true;
377                    break;
378
379                case 'navigation':
380                    $useHeading['navigation'] = true;
381                    break;
382                default:
383                    $useHeading['content'] = true;
384                    $useHeading['navigation'] = true;
385            }
386        } else {
387            $useHeading = array();
388        }
389    }
390
391    return (!empty($useHeading[$linktype]));
392}
393
394/**
395 * obscure config data so information isn't plain text
396 *
397 * @param string       $str     data to be encoded
398 * @param string       $code    encoding method, values: plain, base64, uuencode.
399 * @return string               the encoded value
400 */
401function conf_encodeString($str,$code) {
402    switch ($code) {
403        case 'base64'   : return '<b>'.base64_encode($str);
404        case 'uuencode' : return '<u>'.convert_uuencode($str);
405        case 'plain':
406        default:
407                          return $str;
408    }
409}
410/**
411 * return obscured data as plain text
412 *
413 * @param  string      $str   encoded data
414 * @return string             plain text
415 */
416function conf_decodeString($str) {
417    switch (substr($str,0,3)) {
418        case '<b>' : return base64_decode(substr($str,3));
419        case '<u>' : return convert_uudecode(substr($str,3));
420        default:  // not encoded (or unknown)
421                     return $str;
422    }
423}
424
425/**
426 * array combination function to remove negated values (prefixed by !)
427 *
428 * @param  array $current
429 * @param  array $new
430 *
431 * @return array the combined array, numeric keys reset
432 */
433function array_merge_with_removal($current, $new) {
434    foreach ($new as $val) {
435        if (substr($val,0,1) == DOKU_CONF_NEGATION) {
436            $idx = array_search(trim(substr($val,1)),$current);
437            if ($idx !== false) {
438                unset($current[$idx]);
439            }
440        } else {
441            $current[] = trim($val);
442        }
443    }
444
445    return array_slice($current,0);
446}
447//Setup VIM: ex: et ts=4 :
448