xref: /dokuwiki/inc/confutils.php (revision fb90e1322abcb4a003f8056341e6be95a0e52c5e) 
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($line === '') continue;
222        $line = preg_split('/\s+/', $line, 2);
223        $line = array_pad($line, 2, '');
224        // Build the associative array
225        if($lower) {
226            $conf[strtolower($line[0])] = $line[1];
227        } else {
228            $conf[$line[0]] = $line[1];
229        }
230    }
231
232    return $conf;
233}
234
235/**
236 * Builds a hash from a configfile
237 *
238 * If $lower is set to true all hash keys are converted to
239 * lower case.
240 *
241 * @author Harry Fuecks <hfuecks@gmail.com>
242 * @author Andreas Gohr <andi@splitbrain.org>
243 * @author Gina Haeussge <gina@foosel.net>
244 *
245 * @param string $file
246 * @param bool $lower
247 *
248 * @return array
249 */
250function confToHash($file,$lower=false) {
251    $conf = array();
252    $lines = @file( $file );
253    if ( !$lines ) return $conf;
254
255    return linesToHash($lines, $lower);
256}
257
258/**
259 * Retrieve the requested configuration information
260 *
261 * @author Chris Smith <chris@jalakai.co.uk>
262 *
263 * @param  string   $type     the configuration settings to be read, must correspond to a key/array in $config_cascade
264 * @param  callback $fn       the function used to process the configuration file into an array
265 * @param  array    $params   optional additional params to pass to the callback
266 * @param  callback $combine  the function used to combine arrays of values read from different configuration files;
267 *                            the function takes two parameters,
268 *                               $combined - the already read & merged configuration values
269 *                               $new - array of config values from the config cascade file being currently processed
270 *                            and returns an array of the merged configuration values.
271 * @return array    configuration values
272 */
273function retrieveConfig($type,$fn,$params=null,$combine='array_merge') {
274    global $config_cascade;
275
276    if(!is_array($params)) $params = array();
277
278    $combined = array();
279    if (!is_array($config_cascade[$type])) trigger_error('Missing config cascade for "'.$type.'"',E_USER_WARNING);
280    foreach (array('default','local','protected') as $config_group) {
281        if (empty($config_cascade[$type][$config_group])) continue;
282        foreach ($config_cascade[$type][$config_group] as $file) {
283            if (file_exists($file)) {
284                $config = call_user_func_array($fn,array_merge(array($file),$params));
285                $combined = $combine($combined, $config);
286            }
287        }
288    }
289
290    return $combined;
291}
292
293/**
294 * Include the requested configuration information
295 *
296 * @author Chris Smith <chris@jalakai.co.uk>
297 *
298 * @param  string   $type     the configuration settings to be read, must correspond to a key/array in $config_cascade
299 * @return array              list of files, default before local before protected
300 */
301function getConfigFiles($type) {
302    global $config_cascade;
303    $files = array();
304
305    if (!is_array($config_cascade[$type])) trigger_error('Missing config cascade for "'.$type.'"',E_USER_WARNING);
306    foreach (array('default','local','protected') as $config_group) {
307        if (empty($config_cascade[$type][$config_group])) continue;
308        $files = array_merge($files, $config_cascade[$type][$config_group]);
309    }
310
311    return $files;
312}
313
314/**
315 * check if the given action was disabled in config
316 *
317 * @author Andreas Gohr <andi@splitbrain.org>
318 * @param string $action
319 * @returns boolean true if enabled, false if disabled
320 */
321function actionOK($action){
322    static $disabled = null;
323    if(is_null($disabled) || defined('SIMPLE_TEST')){
324        global $conf;
325        /** @var DokuWiki_Auth_Plugin $auth */
326        global $auth;
327
328        // prepare disabled actions array and handle legacy options
329        $disabled = explode(',',$conf['disableactions']);
330        $disabled = array_map('trim',$disabled);
331        if((isset($conf['openregister']) && !$conf['openregister']) || is_null($auth) || !$auth->canDo('addUser')) {
332            $disabled[] = 'register';
333        }
334        if((isset($conf['resendpasswd']) && !$conf['resendpasswd']) || is_null($auth) || !$auth->canDo('modPass')) {
335            $disabled[] = 'resendpwd';
336        }
337        if((isset($conf['subscribers']) && !$conf['subscribers']) || is_null($auth)) {
338            $disabled[] = 'subscribe';
339        }
340        if (is_null($auth) || !$auth->canDo('Profile')) {
341            $disabled[] = 'profile';
342        }
343        if (is_null($auth) || !$auth->canDo('delUser')) {
344            $disabled[] = 'profile_delete';
345        }
346        if (is_null($auth)) {
347            $disabled[] = 'login';
348        }
349        if (is_null($auth) || !$auth->canDo('logout')) {
350            $disabled[] = 'logout';
351        }
352        $disabled = array_unique($disabled);
353    }
354
355    return !in_array($action,$disabled);
356}
357
358/**
359 * check if headings should be used as link text for the specified link type
360 *
361 * @author Chris Smith <chris@jalakai.co.uk>
362 *
363 * @param   string  $linktype   'content'|'navigation', content applies to links in wiki text
364 *                                                      navigation applies to all other links
365 * @return  boolean             true if headings should be used for $linktype, false otherwise
366 */
367function useHeading($linktype) {
368    static $useHeading = null;
369    if(defined('DOKU_UNITTEST')) $useHeading = null; // don't cache during unit tests
370
371    if (is_null($useHeading)) {
372        global $conf;
373
374        if (!empty($conf['useheading'])) {
375            switch ($conf['useheading']) {
376                case 'content':
377                    $useHeading['content'] = true;
378                    break;
379
380                case 'navigation':
381                    $useHeading['navigation'] = true;
382                    break;
383                default:
384                    $useHeading['content'] = true;
385                    $useHeading['navigation'] = true;
386            }
387        } else {
388            $useHeading = array();
389        }
390    }
391
392    return (!empty($useHeading[$linktype]));
393}
394
395/**
396 * obscure config data so information isn't plain text
397 *
398 * @param string       $str     data to be encoded
399 * @param string       $code    encoding method, values: plain, base64, uuencode.
400 * @return string               the encoded value
401 */
402function conf_encodeString($str,$code) {
403    switch ($code) {
404        case 'base64'   : return '<b>'.base64_encode($str);
405        case 'uuencode' : return '<u>'.convert_uuencode($str);
406        case 'plain':
407        default:
408                          return $str;
409    }
410}
411/**
412 * return obscured data as plain text
413 *
414 * @param  string      $str   encoded data
415 * @return string             plain text
416 */
417function conf_decodeString($str) {
418    switch (substr($str,0,3)) {
419        case '<b>' : return base64_decode(substr($str,3));
420        case '<u>' : return convert_uudecode(substr($str,3));
421        default:  // not encoded (or unknown)
422                     return $str;
423    }
424}
425
426/**
427 * array combination function to remove negated values (prefixed by !)
428 *
429 * @param  array $current
430 * @param  array $new
431 *
432 * @return array the combined array, numeric keys reset
433 */
434function array_merge_with_removal($current, $new) {
435    foreach ($new as $val) {
436        if (substr($val,0,1) == DOKU_CONF_NEGATION) {
437            $idx = array_search(trim(substr($val,1)),$current);
438            if ($idx !== false) {
439                unset($current[$idx]);
440            }
441        } else {
442            $current[] = trim($val);
443        }
444    }
445
446    return array_slice($current,0);
447}
448//Setup VIM: ex: et ts=4 :
449