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