xref: /dokuwiki/inc/common.php (revision 6723420421f809bba2008fec5f15bf8190216130) 
1<?php
2/**
3 * Common DokuWiki functions
4 *
5 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
6 * @author     Andreas Gohr <andi@splitbrain.org>
7 */
8
9if(!defined('DOKU_INC')) die('meh.');
10
11/**
12 * These constants are used with the recents function
13 */
14define('RECENTS_SKIP_DELETED', 2);
15define('RECENTS_SKIP_MINORS', 4);
16define('RECENTS_SKIP_SUBSPACES', 8);
17define('RECENTS_MEDIA_CHANGES', 16);
18define('RECENTS_MEDIA_PAGES_MIXED', 32);
19
20/**
21 * Wrapper around htmlspecialchars()
22 *
23 * @author Andreas Gohr <andi@splitbrain.org>
24 * @see    htmlspecialchars()
25 *
26 * @param string $string the string being converted
27 * @return string converted string
28 */
29function hsc($string) {
30    return htmlspecialchars($string, ENT_QUOTES, 'UTF-8');
31}
32
33/**
34 * Checks if the given input is blank
35 *
36 * This is similar to empty() but will return false for "0".
37 *
38 * Please note: when you pass uninitialized variables, they will implicitly be created
39 * with a NULL value without warning.
40 *
41 * To avoid this it's recommended to guard the call with isset like this:
42 *
43 * (isset($foo) && !blank($foo))
44 * (!isset($foo) || blank($foo))
45 *
46 * @param $in
47 * @param bool $trim Consider a string of whitespace to be blank
48 * @return bool
49 */
50function blank(&$in, $trim = false) {
51    if(is_null($in)) return true;
52    if(is_array($in)) return empty($in);
53    if($in === "\0") return true;
54    if($trim && trim($in) === '') return true;
55    if(strlen($in) > 0) return false;
56    return empty($in);
57}
58
59/**
60 * print a newline terminated string
61 *
62 * You can give an indention as optional parameter
63 *
64 * @author Andreas Gohr <andi@splitbrain.org>
65 *
66 * @param string $string  line of text
67 * @param int    $indent  number of spaces indention
68 */
69function ptln($string, $indent = 0) {
70    echo str_repeat(' ', $indent)."$string\n";
71}
72
73/**
74 * strips control characters (<32) from the given string
75 *
76 * @author Andreas Gohr <andi@splitbrain.org>
77 *
78 * @param string $string being stripped
79 * @return string
80 */
81function stripctl($string) {
82    return preg_replace('/[\x00-\x1F]+/s', '', $string);
83}
84
85/**
86 * Return a secret token to be used for CSRF attack prevention
87 *
88 * @author  Andreas Gohr <andi@splitbrain.org>
89 * @link    http://en.wikipedia.org/wiki/Cross-site_request_forgery
90 * @link    http://christ1an.blogspot.com/2007/04/preventing-csrf-efficiently.html
91 *
92 * @return  string
93 */
94function getSecurityToken() {
95    /** @var Input $INPUT */
96    global $INPUT;
97    return PassHash::hmac('md5', session_id().$INPUT->server->str('REMOTE_USER'), auth_cookiesalt());
98}
99
100/**
101 * Check the secret CSRF token
102 *
103 * @param null|string $token security token or null to read it from request variable
104 * @return bool success if the token matched
105 */
106function checkSecurityToken($token = null) {
107    /** @var Input $INPUT */
108    global $INPUT;
109    if(!$INPUT->server->str('REMOTE_USER')) return true; // no logged in user, no need for a check
110
111    if(is_null($token)) $token = $INPUT->str('sectok');
112    if(getSecurityToken() != $token) {
113        msg('Security Token did not match. Possible CSRF attack.', -1);
114        return false;
115    }
116    return true;
117}
118
119/**
120 * Print a hidden form field with a secret CSRF token
121 *
122 * @author  Andreas Gohr <andi@splitbrain.org>
123 *
124 * @param bool $print  if true print the field, otherwise html of the field is returned
125 * @return string html of hidden form field
126 */
127function formSecurityToken($print = true) {
128    $ret = '<div class="no"><input type="hidden" name="sectok" value="'.getSecurityToken().'" /></div>'."\n";
129    if($print) echo $ret;
130    return $ret;
131}
132
133/**
134 * Determine basic information for a request of $id
135 *
136 * @author Andreas Gohr <andi@splitbrain.org>
137 * @author Chris Smith <chris@jalakai.co.uk>
138 *
139 * @param string $id         pageid
140 * @param bool   $htmlClient add info about whether is mobile browser
141 * @return array with info for a request of $id
142 *
143 */
144function basicinfo($id, $htmlClient=true){
145    global $USERINFO;
146    /* @var Input $INPUT */
147    global $INPUT;
148
149    // set info about manager/admin status.
150    $info = array();
151    $info['isadmin']   = false;
152    $info['ismanager'] = false;
153    if($INPUT->server->has('REMOTE_USER')) {
154        $info['userinfo']   = $USERINFO;
155        $info['perm']       = auth_quickaclcheck($id);
156        $info['client']     = $INPUT->server->str('REMOTE_USER');
157
158        if($info['perm'] == AUTH_ADMIN) {
159            $info['isadmin']   = true;
160            $info['ismanager'] = true;
161        } elseif(auth_ismanager()) {
162            $info['ismanager'] = true;
163        }
164
165        // if some outside auth were used only REMOTE_USER is set
166        if(!$info['userinfo']['name']) {
167            $info['userinfo']['name'] = $INPUT->server->str('REMOTE_USER');
168        }
169
170    } else {
171        $info['perm']       = auth_aclcheck($id, '', null);
172        $info['client']     = clientIP(true);
173    }
174
175    $info['namespace'] = getNS($id);
176
177    // mobile detection
178    if ($htmlClient) {
179        $info['ismobile'] = clientismobile();
180    }
181
182    return $info;
183 }
184
185/**
186 * Return info about the current document as associative
187 * array.
188 *
189 * @author Andreas Gohr <andi@splitbrain.org>
190 *
191 * @return array with info about current document
192 */
193function pageinfo() {
194    global $ID;
195    global $REV;
196    global $RANGE;
197    global $lang;
198    /* @var Input $INPUT */
199    global $INPUT;
200
201    $info = basicinfo($ID);
202
203    // include ID & REV not redundant, as some parts of DokuWiki may temporarily change $ID, e.g. p_wiki_xhtml
204    // FIXME ... perhaps it would be better to ensure the temporary changes weren't necessary
205    $info['id']  = $ID;
206    $info['rev'] = $REV;
207
208    if($INPUT->server->has('REMOTE_USER')) {
209        $sub = new Subscription();
210        $info['subscribed'] = $sub->user_subscription();
211    } else {
212        $info['subscribed'] = false;
213    }
214
215    $info['locked']     = checklock($ID);
216    $info['filepath']   = fullpath(wikiFN($ID));
217    $info['exists']     = file_exists($info['filepath']);
218    $info['currentrev'] = @filemtime($info['filepath']);
219    if($REV) {
220        //check if current revision was meant
221        if($info['exists'] && ($info['currentrev'] == $REV)) {
222            $REV = '';
223        } elseif($RANGE) {
224            //section editing does not work with old revisions!
225            $REV   = '';
226            $RANGE = '';
227            msg($lang['nosecedit'], 0);
228        } else {
229            //really use old revision
230            $info['filepath'] = fullpath(wikiFN($ID, $REV));
231            $info['exists']   = file_exists($info['filepath']);
232        }
233    }
234    $info['rev'] = $REV;
235    if($info['exists']) {
236        $info['writable'] = (is_writable($info['filepath']) &&
237            ($info['perm'] >= AUTH_EDIT));
238    } else {
239        $info['writable'] = ($info['perm'] >= AUTH_CREATE);
240    }
241    $info['editable'] = ($info['writable'] && empty($info['locked']));
242    $info['lastmod']  = @filemtime($info['filepath']);
243
244    //load page meta data
245    $info['meta'] = p_get_metadata($ID);
246
247    //who's the editor
248    $pagelog = new PageChangeLog($ID, 1024);
249    if($REV) {
250        $revinfo = $pagelog->getRevisionInfo($REV);
251    } else {
252        if(!empty($info['meta']['last_change']) && is_array($info['meta']['last_change'])) {
253            $revinfo = $info['meta']['last_change'];
254        } else {
255            $revinfo = $pagelog->getRevisionInfo($info['lastmod']);
256            // cache most recent changelog line in metadata if missing and still valid
257            if($revinfo !== false) {
258                $info['meta']['last_change'] = $revinfo;
259                p_set_metadata($ID, array('last_change' => $revinfo));
260            }
261        }
262    }
263    //and check for an external edit
264    if($revinfo !== false && $revinfo['date'] != $info['lastmod']) {
265        // cached changelog line no longer valid
266        $revinfo                     = false;
267        $info['meta']['last_change'] = $revinfo;
268        p_set_metadata($ID, array('last_change' => $revinfo));
269    }
270
271    $info['ip']   = $revinfo['ip'];
272    $info['user'] = $revinfo['user'];
273    $info['sum']  = $revinfo['sum'];
274    // See also $INFO['meta']['last_change'] which is the most recent log line for page $ID.
275    // Use $INFO['meta']['last_change']['type']===DOKU_CHANGE_TYPE_MINOR_EDIT in place of $info['minor'].
276
277    if($revinfo['user']) {
278        $info['editor'] = $revinfo['user'];
279    } else {
280        $info['editor'] = $revinfo['ip'];
281    }
282
283    // draft
284    $draft = getCacheName($info['client'].$ID, '.draft');
285    if(file_exists($draft)) {
286        if(@filemtime($draft) < @filemtime(wikiFN($ID))) {
287            // remove stale draft
288            @unlink($draft);
289        } else {
290            $info['draft'] = $draft;
291        }
292    }
293
294    return $info;
295}
296
297/**
298 * Return information about the current media item as an associative array.
299 *
300 * @return array with info about current media item
301 */
302function mediainfo(){
303    global $NS;
304    global $IMG;
305
306    $info = basicinfo("$NS:*");
307    $info['image'] = $IMG;
308
309    return $info;
310}
311
312/**
313 * Build an string of URL parameters
314 *
315 * @author Andreas Gohr
316 *
317 * @param array  $params    array with key-value pairs
318 * @param string $sep       series of pairs are separated by this character
319 * @return string query string
320 */
321function buildURLparams($params, $sep = '&amp;') {
322    $url = '';
323    $amp = false;
324    foreach($params as $key => $val) {
325        if($amp) $url .= $sep;
326
327        $url .= rawurlencode($key).'=';
328        $url .= rawurlencode((string) $val);
329        $amp = true;
330    }
331    return $url;
332}
333
334/**
335 * Build an string of html tag attributes
336 *
337 * Skips keys starting with '_', values get HTML encoded
338 *
339 * @author Andreas Gohr
340 *
341 * @param array $params    array with (attribute name-attribute value) pairs
342 * @param bool  $skipempty skip empty string values?
343 * @return string
344 */
345function buildAttributes($params, $skipempty = false) {
346    $url   = '';
347    $white = false;
348    foreach($params as $key => $val) {
349        if($key{0} == '_') continue;
350        if($val === '' && $skipempty) continue;
351        if($white) $url .= ' ';
352
353        $url .= $key.'="';
354        $url .= htmlspecialchars($val);
355        $url .= '"';
356        $white = true;
357    }
358    return $url;
359}
360
361/**
362 * This builds the breadcrumb trail and returns it as array
363 *
364 * @author Andreas Gohr <andi@splitbrain.org>
365 *
366 * @return string[] with the data: array(pageid=>name, ... )
367 */
368function breadcrumbs() {
369    // we prepare the breadcrumbs early for quick session closing
370    static $crumbs = null;
371    if($crumbs != null) return $crumbs;
372
373    global $ID;
374    global $ACT;
375    global $conf;
376
377    //first visit?
378    $crumbs = isset($_SESSION[DOKU_COOKIE]['bc']) ? $_SESSION[DOKU_COOKIE]['bc'] : array();
379    //we only save on show and existing wiki documents
380    $file = wikiFN($ID);
381    if($ACT != 'show' || !file_exists($file)) {
382        $_SESSION[DOKU_COOKIE]['bc'] = $crumbs;
383        return $crumbs;
384    }
385
386    // page names
387    $name = noNSorNS($ID);
388    if(useHeading('navigation')) {
389        // get page title
390        $title = p_get_first_heading($ID, METADATA_RENDER_USING_SIMPLE_CACHE);
391        if($title) {
392            $name = $title;
393        }
394    }
395
396    //remove ID from array
397    if(isset($crumbs[$ID])) {
398        unset($crumbs[$ID]);
399    }
400
401    //add to array
402    $crumbs[$ID] = $name;
403    //reduce size
404    while(count($crumbs) > $conf['breadcrumbs']) {
405        array_shift($crumbs);
406    }
407    //save to session
408    $_SESSION[DOKU_COOKIE]['bc'] = $crumbs;
409    return $crumbs;
410}
411
412/**
413 * Filter for page IDs
414 *
415 * This is run on a ID before it is outputted somewhere
416 * currently used to replace the colon with something else
417 * on Windows (non-IIS) systems and to have proper URL encoding
418 *
419 * See discussions at https://github.com/splitbrain/dokuwiki/pull/84 and
420 * https://github.com/splitbrain/dokuwiki/pull/173 why we use a whitelist of
421 * unaffected servers instead of blacklisting affected servers here.
422 *
423 * Urlencoding is ommitted when the second parameter is false
424 *
425 * @author Andreas Gohr <andi@splitbrain.org>
426 *
427 * @param string $id pageid being filtered
428 * @param bool   $ue apply urlencoding?
429 * @return string
430 */
431function idfilter($id, $ue = true) {
432    global $conf;
433    /* @var Input $INPUT */
434    global $INPUT;
435
436    if($conf['useslash'] && $conf['userewrite']) {
437        $id = strtr($id, ':', '/');
438    } elseif(strtoupper(substr(PHP_OS, 0, 3)) === 'WIN' &&
439        $conf['userewrite'] &&
440        strpos($INPUT->server->str('SERVER_SOFTWARE'), 'Microsoft-IIS') === false
441    ) {
442        $id = strtr($id, ':', ';');
443    }
444    if($ue) {
445        $id = rawurlencode($id);
446        $id = str_replace('%3A', ':', $id); //keep as colon
447        $id = str_replace('%3B', ';', $id); //keep as semicolon
448        $id = str_replace('%2F', '/', $id); //keep as slash
449    }
450    return $id;
451}
452
453/**
454 * This builds a link to a wikipage
455 *
456 * It handles URL rewriting and adds additional parameters
457 *
458 * @author Andreas Gohr <andi@splitbrain.org>
459 *
460 * @param string       $id             page id, defaults to start page
461 * @param string|array $urlParameters  URL parameters, associative array recommended
462 * @param bool         $absolute       request an absolute URL instead of relative
463 * @param string       $separator      parameter separator
464 * @return string
465 */
466function wl($id = '', $urlParameters = '', $absolute = false, $separator = '&amp;') {
467    global $conf;
468    if(is_array($urlParameters)) {
469        if(isset($urlParameters['rev']) && !$urlParameters['rev']) unset($urlParameters['rev']);
470        if(isset($urlParameters['at']) && $conf['date_at_format']) $urlParameters['at'] = date($conf['date_at_format'],$urlParameters['at']);
471        $urlParameters = buildURLparams($urlParameters, $separator);
472    } else {
473        $urlParameters = str_replace(',', $separator, $urlParameters);
474    }
475    if($id === '') {
476        $id = $conf['start'];
477    }
478    $id = idfilter($id);
479    if($absolute) {
480        $xlink = DOKU_URL;
481    } else {
482        $xlink = DOKU_BASE;
483    }
484
485    if($conf['userewrite'] == 2) {
486        $xlink .= DOKU_SCRIPT.'/'.$id;
487        if($urlParameters) $xlink .= '?'.$urlParameters;
488    } elseif($conf['userewrite']) {
489        $xlink .= $id;
490        if($urlParameters) $xlink .= '?'.$urlParameters;
491    } elseif($id) {
492        $xlink .= DOKU_SCRIPT.'?id='.$id;
493        if($urlParameters) $xlink .= $separator.$urlParameters;
494    } else {
495        $xlink .= DOKU_SCRIPT;
496        if($urlParameters) $xlink .= '?'.$urlParameters;
497    }
498
499    return $xlink;
500}
501
502/**
503 * This builds a link to an alternate page format
504 *
505 * Handles URL rewriting if enabled. Follows the style of wl().
506 *
507 * @author Ben Coburn <btcoburn@silicodon.net>
508 * @param string       $id             page id, defaults to start page
509 * @param string       $format         the export renderer to use
510 * @param string|array $urlParameters  URL parameters, associative array recommended
511 * @param bool         $abs            request an absolute URL instead of relative
512 * @param string       $sep            parameter separator
513 * @return string
514 */
515function exportlink($id = '', $format = 'raw', $urlParameters = '', $abs = false, $sep = '&amp;') {
516    global $conf;
517    if(is_array($urlParameters)) {
518        $urlParameters = buildURLparams($urlParameters, $sep);
519    } else {
520        $urlParameters = str_replace(',', $sep, $urlParameters);
521    }
522
523    $format = rawurlencode($format);
524    $id     = idfilter($id);
525    if($abs) {
526        $xlink = DOKU_URL;
527    } else {
528        $xlink = DOKU_BASE;
529    }
530
531    if($conf['userewrite'] == 2) {
532        $xlink .= DOKU_SCRIPT.'/'.$id.'?do=export_'.$format;
533        if($urlParameters) $xlink .= $sep.$urlParameters;
534    } elseif($conf['userewrite'] == 1) {
535        $xlink .= '_export/'.$format.'/'.$id;
536        if($urlParameters) $xlink .= '?'.$urlParameters;
537    } else {
538        $xlink .= DOKU_SCRIPT.'?do=export_'.$format.$sep.'id='.$id;
539        if($urlParameters) $xlink .= $sep.$urlParameters;
540    }
541
542    return $xlink;
543}
544
545/**
546 * Build a link to a media file
547 *
548 * Will return a link to the detail page if $direct is false
549 *
550 * The $more parameter should always be given as array, the function then
551 * will strip default parameters to produce even cleaner URLs
552 *
553 * @param string  $id     the media file id or URL
554 * @param mixed   $more   string or array with additional parameters
555 * @param bool    $direct link to detail page if false
556 * @param string  $sep    URL parameter separator
557 * @param bool    $abs    Create an absolute URL
558 * @return string
559 */
560function ml($id = '', $more = '', $direct = true, $sep = '&amp;', $abs = false) {
561    global $conf;
562    $isexternalimage = media_isexternal($id);
563    if(!$isexternalimage) {
564        $id = cleanID($id);
565    }
566
567    if(is_array($more)) {
568        // add token for resized images
569        if(!empty($more['w']) || !empty($more['h']) || $isexternalimage){
570            $more['tok'] = media_get_token($id,$more['w'],$more['h']);
571        }
572        // strip defaults for shorter URLs
573        if(isset($more['cache']) && $more['cache'] == 'cache') unset($more['cache']);
574        if(empty($more['w'])) unset($more['w']);
575        if(empty($more['h'])) unset($more['h']);
576        if(isset($more['id']) && $direct) unset($more['id']);
577        if(isset($more['rev']) && !$more['rev']) unset($more['rev']);
578        $more = buildURLparams($more, $sep);
579    } else {
580        $matches = array();
581        if (preg_match_all('/\b(w|h)=(\d*)\b/',$more,$matches,PREG_SET_ORDER) || $isexternalimage){
582            $resize = array('w'=>0, 'h'=>0);
583            foreach ($matches as $match){
584                $resize[$match[1]] = $match[2];
585            }
586            $more .= $more === '' ? '' : $sep;
587            $more .= 'tok='.media_get_token($id,$resize['w'],$resize['h']);
588        }
589        $more = str_replace('cache=cache', '', $more); //skip default
590        $more = str_replace(',,', ',', $more);
591        $more = str_replace(',', $sep, $more);
592    }
593
594    if($abs) {
595        $xlink = DOKU_URL;
596    } else {
597        $xlink = DOKU_BASE;
598    }
599
600    // external URLs are always direct without rewriting
601    if($isexternalimage) {
602        $xlink .= 'lib/exe/fetch.php';
603        $xlink .= '?'.$more;
604        $xlink .= $sep.'media='.rawurlencode($id);
605        return $xlink;
606    }
607
608    $id = idfilter($id);
609
610    // decide on scriptname
611    if($direct) {
612        if($conf['userewrite'] == 1) {
613            $script = '_media';
614        } else {
615            $script = 'lib/exe/fetch.php';
616        }
617    } else {
618        if($conf['userewrite'] == 1) {
619            $script = '_detail';
620        } else {
621            $script = 'lib/exe/detail.php';
622        }
623    }
624
625    // build URL based on rewrite mode
626    if($conf['userewrite']) {
627        $xlink .= $script.'/'.$id;
628        if($more) $xlink .= '?'.$more;
629    } else {
630        if($more) {
631            $xlink .= $script.'?'.$more;
632            $xlink .= $sep.'media='.$id;
633        } else {
634            $xlink .= $script.'?media='.$id;
635        }
636    }
637
638    return $xlink;
639}
640
641/**
642 * Returns the URL to the DokuWiki base script
643 *
644 * Consider using wl() instead, unless you absoutely need the doku.php endpoint
645 *
646 * @author Andreas Gohr <andi@splitbrain.org>
647 *
648 * @return string
649 */
650function script() {
651    return DOKU_BASE.DOKU_SCRIPT;
652}
653
654/**
655 * Spamcheck against wordlist
656 *
657 * Checks the wikitext against a list of blocked expressions
658 * returns true if the text contains any bad words
659 *
660 * Triggers COMMON_WORDBLOCK_BLOCKED
661 *
662 *  Action Plugins can use this event to inspect the blocked data
663 *  and gain information about the user who was blocked.
664 *
665 *  Event data:
666 *    data['matches']  - array of matches
667 *    data['userinfo'] - information about the blocked user
668 *      [ip]           - ip address
669 *      [user]         - username (if logged in)
670 *      [mail]         - mail address (if logged in)
671 *      [name]         - real name (if logged in)
672 *
673 * @author Andreas Gohr <andi@splitbrain.org>
674 * @author Michael Klier <chi@chimeric.de>
675 *
676 * @param  string $text - optional text to check, if not given the globals are used
677 * @return bool         - true if a spam word was found
678 */
679function checkwordblock($text = '') {
680    global $TEXT;
681    global $PRE;
682    global $SUF;
683    global $SUM;
684    global $conf;
685    global $INFO;
686    /* @var Input $INPUT */
687    global $INPUT;
688
689    if(!$conf['usewordblock']) return false;
690
691    if(!$text) $text = "$PRE $TEXT $SUF $SUM";
692
693    // we prepare the text a tiny bit to prevent spammers circumventing URL checks
694    $text = preg_replace('!(\b)(www\.[\w.:?\-;,]+?\.[\w.:?\-;,]+?[\w/\#~:.?+=&%@\!\-.:?\-;,]+?)([.:?\-;,]*[^\w/\#~:.?+=&%@\!\-.:?\-;,])!i', '\1http://\2 \2\3', $text);
695
696    $wordblocks = getWordblocks();
697    // how many lines to read at once (to work around some PCRE limits)
698    if(version_compare(phpversion(), '4.3.0', '<')) {
699        // old versions of PCRE define a maximum of parenthesises even if no
700        // backreferences are used - the maximum is 99
701        // this is very bad performancewise and may even be too high still
702        $chunksize = 40;
703    } else {
704        // read file in chunks of 200 - this should work around the
705        // MAX_PATTERN_SIZE in modern PCRE
706        $chunksize = 200;
707    }
708    while($blocks = array_splice($wordblocks, 0, $chunksize)) {
709        $re = array();
710        // build regexp from blocks
711        foreach($blocks as $block) {
712            $block = preg_replace('/#.*$/', '', $block);
713            $block = trim($block);
714            if(empty($block)) continue;
715            $re[] = $block;
716        }
717        if(count($re) && preg_match('#('.join('|', $re).')#si', $text, $matches)) {
718            // prepare event data
719            $data = array();
720            $data['matches']        = $matches;
721            $data['userinfo']['ip'] = $INPUT->server->str('REMOTE_ADDR');
722            if($INPUT->server->str('REMOTE_USER')) {
723                $data['userinfo']['user'] = $INPUT->server->str('REMOTE_USER');
724                $data['userinfo']['name'] = $INFO['userinfo']['name'];
725                $data['userinfo']['mail'] = $INFO['userinfo']['mail'];
726            }
727            $callback = create_function('', 'return true;');
728            return trigger_event('COMMON_WORDBLOCK_BLOCKED', $data, $callback, true);
729        }
730    }
731    return false;
732}
733
734/**
735 * Return the IP of the client
736 *
737 * Honours X-Forwarded-For and X-Real-IP Proxy Headers
738 *
739 * It returns a comma separated list of IPs if the above mentioned
740 * headers are set. If the single parameter is set, it tries to return
741 * a routable public address, prefering the ones suplied in the X
742 * headers
743 *
744 * @author Andreas Gohr <andi@splitbrain.org>
745 *
746 * @param  boolean $single If set only a single IP is returned
747 * @return string
748 */
749function clientIP($single = false) {
750    /* @var Input $INPUT */
751    global $INPUT;
752
753    $ip   = array();
754    $ip[] = $INPUT->server->str('REMOTE_ADDR');
755    if($INPUT->server->str('HTTP_X_FORWARDED_FOR')) {
756        $ip = array_merge($ip, explode(',', str_replace(' ', '', $INPUT->server->str('HTTP_X_FORWARDED_FOR'))));
757    }
758    if($INPUT->server->str('HTTP_X_REAL_IP')) {
759        $ip = array_merge($ip, explode(',', str_replace(' ', '', $INPUT->server->str('HTTP_X_REAL_IP'))));
760    }
761
762    // some IPv4/v6 regexps borrowed from Feyd
763    // see: http://forums.devnetwork.net/viewtopic.php?f=38&t=53479
764    $dec_octet   = '(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|[0-9])';
765    $hex_digit   = '[A-Fa-f0-9]';
766    $h16         = "{$hex_digit}{1,4}";
767    $IPv4Address = "$dec_octet\\.$dec_octet\\.$dec_octet\\.$dec_octet";
768    $ls32        = "(?:$h16:$h16|$IPv4Address)";
769    $IPv6Address =
770        "(?:(?:{$IPv4Address})|(?:".
771            "(?:$h16:){6}$ls32".
772            "|::(?:$h16:){5}$ls32".
773            "|(?:$h16)?::(?:$h16:){4}$ls32".
774            "|(?:(?:$h16:){0,1}$h16)?::(?:$h16:){3}$ls32".
775            "|(?:(?:$h16:){0,2}$h16)?::(?:$h16:){2}$ls32".
776            "|(?:(?:$h16:){0,3}$h16)?::(?:$h16:){1}$ls32".
777            "|(?:(?:$h16:){0,4}$h16)?::$ls32".
778            "|(?:(?:$h16:){0,5}$h16)?::$h16".
779            "|(?:(?:$h16:){0,6}$h16)?::".
780            ")(?:\\/(?:12[0-8]|1[0-1][0-9]|[1-9][0-9]|[0-9]))?)";
781
782    // remove any non-IP stuff
783    $cnt   = count($ip);
784    $match = array();
785    for($i = 0; $i < $cnt; $i++) {
786        if(preg_match("/^$IPv4Address$/", $ip[$i], $match) || preg_match("/^$IPv6Address$/", $ip[$i], $match)) {
787            $ip[$i] = $match[0];
788        } else {
789            $ip[$i] = '';
790        }
791        if(empty($ip[$i])) unset($ip[$i]);
792    }
793    $ip = array_values(array_unique($ip));
794    if(!$ip[0]) $ip[0] = '0.0.0.0'; // for some strange reason we don't have a IP
795
796    if(!$single) return join(',', $ip);
797
798    // decide which IP to use, trying to avoid local addresses
799    $ip = array_reverse($ip);
800    foreach($ip as $i) {
801        if(preg_match('/^(::1|[fF][eE]80:|127\.|10\.|192\.168\.|172\.((1[6-9])|(2[0-9])|(3[0-1]))\.)/', $i)) {
802            continue;
803        } else {
804            return $i;
805        }
806    }
807    // still here? just use the first (last) address
808    return $ip[0];
809}
810
811/**
812 * Check if the browser is on a mobile device
813 *
814 * Adapted from the example code at url below
815 *
816 * @link http://www.brainhandles.com/2007/10/15/detecting-mobile-browsers/#code
817 *
818 * @return bool if true, client is mobile browser; otherwise false
819 */
820function clientismobile() {
821    /* @var Input $INPUT */
822    global $INPUT;
823
824    if($INPUT->server->has('HTTP_X_WAP_PROFILE')) return true;
825
826    if(preg_match('/wap\.|\.wap/i', $INPUT->server->str('HTTP_ACCEPT'))) return true;
827
828    if(!$INPUT->server->has('HTTP_USER_AGENT')) return false;
829
830    $uamatches = 'midp|j2me|avantg|docomo|novarra|palmos|palmsource|240x320|opwv|chtml|pda|windows ce|mmp\/|blackberry|mib\/|symbian|wireless|nokia|hand|mobi|phone|cdm|up\.b|audio|SIE\-|SEC\-|samsung|HTC|mot\-|mitsu|sagem|sony|alcatel|lg|erics|vx|NEC|philips|mmm|xx|panasonic|sharp|wap|sch|rover|pocket|benq|java|pt|pg|vox|amoi|bird|compal|kg|voda|sany|kdd|dbt|sendo|sgh|gradi|jb|\d\d\di|moto';
831
832    if(preg_match("/$uamatches/i", $INPUT->server->str('HTTP_USER_AGENT'))) return true;
833
834    return false;
835}
836
837/**
838 * Convert one or more comma separated IPs to hostnames
839 *
840 * If $conf['dnslookups'] is disabled it simply returns the input string
841 *
842 * @author Glen Harris <astfgl@iamnota.org>
843 *
844 * @param  string $ips comma separated list of IP addresses
845 * @return string a comma separated list of hostnames
846 */
847function gethostsbyaddrs($ips) {
848    global $conf;
849    if(!$conf['dnslookups']) return $ips;
850
851    $hosts = array();
852    $ips   = explode(',', $ips);
853
854    if(is_array($ips)) {
855        foreach($ips as $ip) {
856            $hosts[] = gethostbyaddr(trim($ip));
857        }
858        return join(',', $hosts);
859    } else {
860        return gethostbyaddr(trim($ips));
861    }
862}
863
864/**
865 * Checks if a given page is currently locked.
866 *
867 * removes stale lockfiles
868 *
869 * @author Andreas Gohr <andi@splitbrain.org>
870 *
871 * @param string $id page id
872 * @return bool page is locked?
873 */
874function checklock($id) {
875    global $conf;
876    /* @var Input $INPUT */
877    global $INPUT;
878
879    $lock = wikiLockFN($id);
880
881    //no lockfile
882    if(!file_exists($lock)) return false;
883
884    //lockfile expired
885    if((time() - filemtime($lock)) > $conf['locktime']) {
886        @unlink($lock);
887        return false;
888    }
889
890    //my own lock
891    @list($ip, $session) = explode("\n", io_readFile($lock));
892    if($ip == $INPUT->server->str('REMOTE_USER') || $ip == clientIP() || (session_id() && $session == session_id())) {
893        return false;
894    }
895
896    return $ip;
897}
898
899/**
900 * Lock a page for editing
901 *
902 * @author Andreas Gohr <andi@splitbrain.org>
903 *
904 * @param string $id page id to lock
905 */
906function lock($id) {
907    global $conf;
908    /* @var Input $INPUT */
909    global $INPUT;
910
911    if($conf['locktime'] == 0) {
912        return;
913    }
914
915    $lock = wikiLockFN($id);
916    if($INPUT->server->str('REMOTE_USER')) {
917        io_saveFile($lock, $INPUT->server->str('REMOTE_USER'));
918    } else {
919        io_saveFile($lock, clientIP()."\n".session_id());
920    }
921}
922
923/**
924 * Unlock a page if it was locked by the user
925 *
926 * @author Andreas Gohr <andi@splitbrain.org>
927 *
928 * @param string $id page id to unlock
929 * @return bool true if a lock was removed
930 */
931function unlock($id) {
932    /* @var Input $INPUT */
933    global $INPUT;
934
935    $lock = wikiLockFN($id);
936    if(file_exists($lock)) {
937        @list($ip, $session) = explode("\n", io_readFile($lock));
938        if($ip == $INPUT->server->str('REMOTE_USER') || $ip == clientIP() || $session == session_id()) {
939            @unlink($lock);
940            return true;
941        }
942    }
943    return false;
944}
945
946/**
947 * convert line ending to unix format
948 *
949 * also makes sure the given text is valid UTF-8
950 *
951 * @see    formText() for 2crlf conversion
952 * @author Andreas Gohr <andi@splitbrain.org>
953 *
954 * @param string $text
955 * @return string
956 */
957function cleanText($text) {
958    $text = preg_replace("/(\015\012)|(\015)/", "\012", $text);
959
960    // if the text is not valid UTF-8 we simply assume latin1
961    // this won't break any worse than it breaks with the wrong encoding
962    // but might actually fix the problem in many cases
963    if(!utf8_check($text)) $text = utf8_encode($text);
964
965    return $text;
966}
967
968/**
969 * Prepares text for print in Webforms by encoding special chars.
970 * It also converts line endings to Windows format which is
971 * pseudo standard for webforms.
972 *
973 * @see    cleanText() for 2unix conversion
974 * @author Andreas Gohr <andi@splitbrain.org>
975 *
976 * @param string $text
977 * @return string
978 */
979function formText($text) {
980    $text = str_replace("\012", "\015\012", $text);
981    return htmlspecialchars($text);
982}
983
984/**
985 * Returns the specified local text in raw format
986 *
987 * @author Andreas Gohr <andi@splitbrain.org>
988 *
989 * @param string $id   page id
990 * @param string $ext  extension of file being read, default 'txt'
991 * @return string
992 */
993function rawLocale($id, $ext = 'txt') {
994    return io_readFile(localeFN($id, $ext));
995}
996
997/**
998 * Returns the raw WikiText
999 *
1000 * @author Andreas Gohr <andi@splitbrain.org>
1001 *
1002 * @param string $id   page id
1003 * @param string|int $rev  timestamp when a revision of wikitext is desired
1004 * @return string
1005 */
1006function rawWiki($id, $rev = '') {
1007    return io_readWikiPage(wikiFN($id, $rev), $id, $rev);
1008}
1009
1010/**
1011 * Returns the pagetemplate contents for the ID's namespace
1012 *
1013 * @triggers COMMON_PAGETPL_LOAD
1014 * @author Andreas Gohr <andi@splitbrain.org>
1015 *
1016 * @param string $id the id of the page to be created
1017 * @return string parsed pagetemplate content
1018 */
1019function pageTemplate($id) {
1020    global $conf;
1021
1022    if(is_array($id)) $id = $id[0];
1023
1024    // prepare initial event data
1025    $data = array(
1026        'id'        => $id, // the id of the page to be created
1027        'tpl'       => '', // the text used as template
1028        'tplfile'   => '', // the file above text was/should be loaded from
1029        'doreplace' => true // should wildcard replacements be done on the text?
1030    );
1031
1032    $evt = new Doku_Event('COMMON_PAGETPL_LOAD', $data);
1033    if($evt->advise_before(true)) {
1034        // the before event might have loaded the content already
1035        if(empty($data['tpl'])) {
1036            // if the before event did not set a template file, try to find one
1037            if(empty($data['tplfile'])) {
1038                $path = dirname(wikiFN($id));
1039                if(file_exists($path.'/_template.txt')) {
1040                    $data['tplfile'] = $path.'/_template.txt';
1041                } else {
1042                    // search upper namespaces for templates
1043                    $len = strlen(rtrim($conf['datadir'], '/'));
1044                    while(strlen($path) >= $len) {
1045                        if(file_exists($path.'/__template.txt')) {
1046                            $data['tplfile'] = $path.'/__template.txt';
1047                            break;
1048                        }
1049                        $path = substr($path, 0, strrpos($path, '/'));
1050                    }
1051                }
1052            }
1053            // load the content
1054            $data['tpl'] = io_readFile($data['tplfile']);
1055        }
1056        if($data['doreplace']) parsePageTemplate($data);
1057    }
1058    $evt->advise_after();
1059    unset($evt);
1060
1061    return $data['tpl'];
1062}
1063
1064/**
1065 * Performs common page template replacements
1066 * This works on data from COMMON_PAGETPL_LOAD
1067 *
1068 * @author Andreas Gohr <andi@splitbrain.org>
1069 *
1070 * @param array $data array with event data
1071 * @return string
1072 */
1073function parsePageTemplate(&$data) {
1074    /**
1075     * @var string $id        the id of the page to be created
1076     * @var string $tpl       the text used as template
1077     * @var string $tplfile   the file above text was/should be loaded from
1078     * @var bool   $doreplace should wildcard replacements be done on the text?
1079     */
1080    extract($data);
1081
1082    global $USERINFO;
1083    global $conf;
1084    /* @var Input $INPUT */
1085    global $INPUT;
1086
1087    // replace placeholders
1088    $file = noNS($id);
1089    $page = strtr($file, $conf['sepchar'], ' ');
1090
1091    $tpl = str_replace(
1092        array(
1093             '@ID@',
1094             '@NS@',
1095             '@FILE@',
1096             '@!FILE@',
1097             '@!FILE!@',
1098             '@PAGE@',
1099             '@!PAGE@',
1100             '@!!PAGE@',
1101             '@!PAGE!@',
1102             '@USER@',
1103             '@NAME@',
1104             '@MAIL@',
1105             '@DATE@',
1106        ),
1107        array(
1108             $id,
1109             getNS($id),
1110             $file,
1111             utf8_ucfirst($file),
1112             utf8_strtoupper($file),
1113             $page,
1114             utf8_ucfirst($page),
1115             utf8_ucwords($page),
1116             utf8_strtoupper($page),
1117             $INPUT->server->str('REMOTE_USER'),
1118             $USERINFO['name'],
1119             $USERINFO['mail'],
1120             $conf['dformat'],
1121        ), $tpl
1122    );
1123
1124    // we need the callback to work around strftime's char limit
1125    $tpl         = preg_replace_callback('/%./', create_function('$m', 'return strftime($m[0]);'), $tpl);
1126    $data['tpl'] = $tpl;
1127    return $tpl;
1128}
1129
1130/**
1131 * Returns the raw Wiki Text in three slices.
1132 *
1133 * The range parameter needs to have the form "from-to"
1134 * and gives the range of the section in bytes - no
1135 * UTF-8 awareness is needed.
1136 * The returned order is prefix, section and suffix.
1137 *
1138 * @author Andreas Gohr <andi@splitbrain.org>
1139 *
1140 * @param string $range in form "from-to"
1141 * @param string $id    page id
1142 * @param string $rev   optional, the revision timestamp
1143 * @return string[] with three slices
1144 */
1145function rawWikiSlices($range, $id, $rev = '') {
1146    $text = io_readWikiPage(wikiFN($id, $rev), $id, $rev);
1147
1148    // Parse range
1149    list($from, $to) = explode('-', $range, 2);
1150    // Make range zero-based, use defaults if marker is missing
1151    $from = !$from ? 0 : ($from - 1);
1152    $to   = !$to ? strlen($text) : ($to - 1);
1153
1154    $slices = array();
1155    $slices[0] = substr($text, 0, $from);
1156    $slices[1] = substr($text, $from, $to - $from);
1157    $slices[2] = substr($text, $to);
1158    return $slices;
1159}
1160
1161/**
1162 * Joins wiki text slices
1163 *
1164 * function to join the text slices.
1165 * When the pretty parameter is set to true it adds additional empty
1166 * lines between sections if needed (used on saving).
1167 *
1168 * @author Andreas Gohr <andi@splitbrain.org>
1169 *
1170 * @param string $pre   prefix
1171 * @param string $text  text in the middle
1172 * @param string $suf   suffix
1173 * @param bool $pretty add additional empty lines between sections
1174 * @return string
1175 */
1176function con($pre, $text, $suf, $pretty = false) {
1177    if($pretty) {
1178        if($pre !== '' && substr($pre, -1) !== "\n" &&
1179            substr($text, 0, 1) !== "\n"
1180        ) {
1181            $pre .= "\n";
1182        }
1183        if($suf !== '' && substr($text, -1) !== "\n" &&
1184            substr($suf, 0, 1) !== "\n"
1185        ) {
1186            $text .= "\n";
1187        }
1188    }
1189
1190    return $pre.$text.$suf;
1191}
1192
1193/**
1194 * Saves a wikitext by calling io_writeWikiPage.
1195 * Also directs changelog and attic updates.
1196 *
1197 * @author Andreas Gohr <andi@splitbrain.org>
1198 * @author Ben Coburn <btcoburn@silicodon.net>
1199 *
1200 * @param string $id       page id
1201 * @param string $text     wikitext being saved
1202 * @param string $summary  summary of text update
1203 * @param bool   $minor    mark this saved version as minor update
1204 */
1205function saveWikiText($id, $text, $summary, $minor = false) {
1206    /* Note to developers:
1207       This code is subtle and delicate. Test the behavior of
1208       the attic and changelog with dokuwiki and external edits
1209       after any changes. External edits change the wiki page
1210       directly without using php or dokuwiki.
1211     */
1212    global $conf;
1213    global $lang;
1214    global $REV;
1215    /* @var Input $INPUT */
1216    global $INPUT;
1217
1218    // ignore if no changes were made
1219    if($text == rawWiki($id, '')) {
1220        return;
1221    }
1222
1223    $file        = wikiFN($id);
1224    $old         = @filemtime($file); // from page
1225    $wasRemoved  = (trim($text) == ''); // check for empty or whitespace only
1226    $wasCreated  = !file_exists($file);
1227    $wasReverted = ($REV == true);
1228    $pagelog     = new PageChangeLog($id, 1024);
1229    $newRev      = false;
1230    $oldRev      = $pagelog->getRevisions(-1, 1); // from changelog
1231    $oldRev      = (int) (empty($oldRev) ? 0 : $oldRev[0]);
1232    if(!file_exists(wikiFN($id, $old)) && file_exists($file) && $old >= $oldRev) {
1233        // add old revision to the attic if missing
1234        saveOldRevision($id);
1235        // add a changelog entry if this edit came from outside dokuwiki
1236        if($old > $oldRev) {
1237            addLogEntry($old, $id, DOKU_CHANGE_TYPE_EDIT, $lang['external_edit'], '', array('ExternalEdit'=> true));
1238            // remove soon to be stale instructions
1239            $cache = new cache_instructions($id, $file);
1240            $cache->removeCache();
1241        }
1242    }
1243
1244    if($wasRemoved) {
1245        // Send "update" event with empty data, so plugins can react to page deletion
1246        $data = array(array($file, '', false), getNS($id), noNS($id), false);
1247        trigger_event('IO_WIKIPAGE_WRITE', $data);
1248        // pre-save deleted revision
1249        @touch($file);
1250        clearstatcache();
1251        $newRev = saveOldRevision($id);
1252        // remove empty file
1253        @unlink($file);
1254        // don't remove old meta info as it should be saved, plugins can use IO_WIKIPAGE_WRITE for removing their metadata...
1255        // purge non-persistant meta data
1256        p_purge_metadata($id);
1257        $del = true;
1258        // autoset summary on deletion
1259        if(empty($summary)) $summary = $lang['deleted'];
1260        // remove empty namespaces
1261        io_sweepNS($id, 'datadir');
1262        io_sweepNS($id, 'mediadir');
1263    } else {
1264        // save file (namespace dir is created in io_writeWikiPage)
1265        io_writeWikiPage($file, $text, $id);
1266        // pre-save the revision, to keep the attic in sync
1267        $newRev = saveOldRevision($id);
1268        $del    = false;
1269    }
1270
1271    // select changelog line type
1272    $extra = '';
1273    $type  = DOKU_CHANGE_TYPE_EDIT;
1274    if($wasReverted) {
1275        $type  = DOKU_CHANGE_TYPE_REVERT;
1276        $extra = $REV;
1277    } else if($wasCreated) {
1278        $type = DOKU_CHANGE_TYPE_CREATE;
1279    } else if($wasRemoved) {
1280        $type = DOKU_CHANGE_TYPE_DELETE;
1281    } else if($minor && $conf['useacl'] && $INPUT->server->str('REMOTE_USER')) {
1282        $type = DOKU_CHANGE_TYPE_MINOR_EDIT;
1283    } //minor edits only for logged in users
1284
1285    addLogEntry($newRev, $id, $type, $summary, $extra);
1286    // send notify mails
1287    notify($id, 'admin', $old, $summary, $minor);
1288    notify($id, 'subscribers', $old, $summary, $minor);
1289
1290    // update the purgefile (timestamp of the last time anything within the wiki was changed)
1291    io_saveFile($conf['cachedir'].'/purgefile', time());
1292
1293    // if useheading is enabled, purge the cache of all linking pages
1294    if(useHeading('content')) {
1295        $pages = ft_backlinks($id, true);
1296        foreach($pages as $page) {
1297            $cache = new cache_renderer($page, wikiFN($page), 'xhtml');
1298            $cache->removeCache();
1299        }
1300    }
1301}
1302
1303/**
1304 * moves the current version to the attic and returns its
1305 * revision date
1306 *
1307 * @author Andreas Gohr <andi@splitbrain.org>
1308 *
1309 * @param string $id page id
1310 * @return int|string revision timestamp
1311 */
1312function saveOldRevision($id) {
1313    $oldf = wikiFN($id);
1314    if(!file_exists($oldf)) return '';
1315    $date = filemtime($oldf);
1316    $newf = wikiFN($id, $date);
1317    io_writeWikiPage($newf, rawWiki($id), $id, $date);
1318    return $date;
1319}
1320
1321/**
1322 * Sends a notify mail on page change or registration
1323 *
1324 * @param string     $id       The changed page
1325 * @param string     $who      Who to notify (admin|subscribers|register)
1326 * @param int|string $rev Old page revision
1327 * @param string     $summary  What changed
1328 * @param boolean    $minor    Is this a minor edit?
1329 * @param string[]   $replace  Additional string substitutions, @KEY@ to be replaced by value
1330 * @return bool
1331 *
1332 * @author Andreas Gohr <andi@splitbrain.org>
1333 */
1334function notify($id, $who, $rev = '', $summary = '', $minor = false, $replace = array()) {
1335    global $conf;
1336    /* @var Input $INPUT */
1337    global $INPUT;
1338
1339    // decide if there is something to do, eg. whom to mail
1340    if($who == 'admin') {
1341        if(empty($conf['notify'])) return false; //notify enabled?
1342        $tpl = 'mailtext';
1343        $to  = $conf['notify'];
1344    } elseif($who == 'subscribers') {
1345        if(!actionOK('subscribe')) return false; //subscribers enabled?
1346        if($conf['useacl'] && $INPUT->server->str('REMOTE_USER') && $minor) return false; //skip minors
1347        $data = array('id' => $id, 'addresslist' => '', 'self' => false, 'replacements' => $replace);
1348        trigger_event(
1349            'COMMON_NOTIFY_ADDRESSLIST', $data,
1350            array(new Subscription(), 'notifyaddresses')
1351        );
1352        $to = $data['addresslist'];
1353        if(empty($to)) return false;
1354        $tpl = 'subscr_single';
1355    } else {
1356        return false; //just to be safe
1357    }
1358
1359    // prepare content
1360    $subscription = new Subscription();
1361    return $subscription->send_diff($to, $tpl, $id, $rev, $summary);
1362}
1363
1364/**
1365 * extracts the query from a search engine referrer
1366 *
1367 * @author Andreas Gohr <andi@splitbrain.org>
1368 * @author Todd Augsburger <todd@rollerorgans.com>
1369 *
1370 * @return array|string
1371 */
1372function getGoogleQuery() {
1373    /* @var Input $INPUT */
1374    global $INPUT;
1375
1376    if(!$INPUT->server->has('HTTP_REFERER')) {
1377        return '';
1378    }
1379    $url = parse_url($INPUT->server->str('HTTP_REFERER'));
1380
1381    // only handle common SEs
1382    if(!preg_match('/(google|bing|yahoo|ask|duckduckgo|babylon|aol|yandex)/',$url['host'])) return '';
1383
1384    $query = array();
1385    // temporary workaround against PHP bug #49733
1386    // see http://bugs.php.net/bug.php?id=49733
1387    if(UTF8_MBSTRING) $enc = mb_internal_encoding();
1388    parse_str($url['query'], $query);
1389    if(UTF8_MBSTRING) mb_internal_encoding($enc);
1390
1391    $q = '';
1392    if(isset($query['q'])){
1393        $q = $query['q'];
1394    }elseif(isset($query['p'])){
1395        $q = $query['p'];
1396    }elseif(isset($query['query'])){
1397        $q = $query['query'];
1398    }
1399    $q = trim($q);
1400
1401    if(!$q) return '';
1402    $q = preg_split('/[\s\'"\\\\`()\]\[?:!\.{};,#+*<>\\/]+/', $q, -1, PREG_SPLIT_NO_EMPTY);
1403    return $q;
1404}
1405
1406/**
1407 * Return the human readable size of a file
1408 *
1409 * @param int $size A file size
1410 * @param int $dec A number of decimal places
1411 * @return string human readable size
1412 *
1413 * @author      Martin Benjamin <b.martin@cybernet.ch>
1414 * @author      Aidan Lister <aidan@php.net>
1415 * @version     1.0.0
1416 */
1417function filesize_h($size, $dec = 1) {
1418    $sizes = array('B', 'KB', 'MB', 'GB');
1419    $count = count($sizes);
1420    $i     = 0;
1421
1422    while($size >= 1024 && ($i < $count - 1)) {
1423        $size /= 1024;
1424        $i++;
1425    }
1426
1427    return round($size, $dec).' '.$sizes[$i];
1428}
1429
1430/**
1431 * Return the given timestamp as human readable, fuzzy age
1432 *
1433 * @author Andreas Gohr <gohr@cosmocode.de>
1434 *
1435 * @param int $dt timestamp
1436 * @return string
1437 */
1438function datetime_h($dt) {
1439    global $lang;
1440
1441    $ago = time() - $dt;
1442    if($ago > 24 * 60 * 60 * 30 * 12 * 2) {
1443        return sprintf($lang['years'], round($ago / (24 * 60 * 60 * 30 * 12)));
1444    }
1445    if($ago > 24 * 60 * 60 * 30 * 2) {
1446        return sprintf($lang['months'], round($ago / (24 * 60 * 60 * 30)));
1447    }
1448    if($ago > 24 * 60 * 60 * 7 * 2) {
1449        return sprintf($lang['weeks'], round($ago / (24 * 60 * 60 * 7)));
1450    }
1451    if($ago > 24 * 60 * 60 * 2) {
1452        return sprintf($lang['days'], round($ago / (24 * 60 * 60)));
1453    }
1454    if($ago > 60 * 60 * 2) {
1455        return sprintf($lang['hours'], round($ago / (60 * 60)));
1456    }
1457    if($ago > 60 * 2) {
1458        return sprintf($lang['minutes'], round($ago / (60)));
1459    }
1460    return sprintf($lang['seconds'], $ago);
1461}
1462
1463/**
1464 * Wraps around strftime but provides support for fuzzy dates
1465 *
1466 * The format default to $conf['dformat']. It is passed to
1467 * strftime - %f can be used to get the value from datetime_h()
1468 *
1469 * @see datetime_h
1470 * @author Andreas Gohr <gohr@cosmocode.de>
1471 *
1472 * @param int|null $dt      timestamp when given, null will take current timestamp
1473 * @param string   $format  empty default to $conf['dformat'], or provide format as recognized by strftime()
1474 * @return string
1475 */
1476function dformat($dt = null, $format = '') {
1477    global $conf;
1478
1479    if(is_null($dt)) $dt = time();
1480    $dt = (int) $dt;
1481    if(!$format) $format = $conf['dformat'];
1482
1483    $format = str_replace('%f', datetime_h($dt), $format);
1484    return strftime($format, $dt);
1485}
1486
1487/**
1488 * Formats a timestamp as ISO 8601 date
1489 *
1490 * @author <ungu at terong dot com>
1491 * @link http://www.php.net/manual/en/function.date.php#54072
1492 *
1493 * @param int $int_date current date in UNIX timestamp
1494 * @return string
1495 */
1496function date_iso8601($int_date) {
1497    $date_mod     = date('Y-m-d\TH:i:s', $int_date);
1498    $pre_timezone = date('O', $int_date);
1499    $time_zone    = substr($pre_timezone, 0, 3).":".substr($pre_timezone, 3, 2);
1500    $date_mod .= $time_zone;
1501    return $date_mod;
1502}
1503
1504/**
1505 * return an obfuscated email address in line with $conf['mailguard'] setting
1506 *
1507 * @author Harry Fuecks <hfuecks@gmail.com>
1508 * @author Christopher Smith <chris@jalakai.co.uk>
1509 *
1510 * @param string $email email address
1511 * @return string
1512 */
1513function obfuscate($email) {
1514    global $conf;
1515
1516    switch($conf['mailguard']) {
1517        case 'visible' :
1518            $obfuscate = array('@' => ' [at] ', '.' => ' [dot] ', '-' => ' [dash] ');
1519            return strtr($email, $obfuscate);
1520
1521        case 'hex' :
1522            $encode = '';
1523            $len    = strlen($email);
1524            for($x = 0; $x < $len; $x++) {
1525                $encode .= '&#x'.bin2hex($email{$x}).';';
1526            }
1527            return $encode;
1528
1529        case 'none' :
1530        default :
1531            return $email;
1532    }
1533}
1534
1535/**
1536 * Removes quoting backslashes
1537 *
1538 * @author Andreas Gohr <andi@splitbrain.org>
1539 *
1540 * @param string $string
1541 * @param string $char backslashed character
1542 * @return string
1543 */
1544function unslash($string, $char = "'") {
1545    return str_replace('\\'.$char, $char, $string);
1546}
1547
1548/**
1549 * Convert php.ini shorthands to byte
1550 *
1551 * @author <gilthans dot NO dot SPAM at gmail dot com>
1552 * @link   http://de3.php.net/manual/en/ini.core.php#79564
1553 *
1554 * @param string $v shorthands
1555 * @return int|string
1556 */
1557function php_to_byte($v) {
1558    $l   = substr($v, -1);
1559    $ret = substr($v, 0, -1);
1560    switch(strtoupper($l)) {
1561        /** @noinspection PhpMissingBreakStatementInspection */
1562        case 'P':
1563            $ret *= 1024;
1564        /** @noinspection PhpMissingBreakStatementInspection */
1565        case 'T':
1566            $ret *= 1024;
1567        /** @noinspection PhpMissingBreakStatementInspection */
1568        case 'G':
1569            $ret *= 1024;
1570        /** @noinspection PhpMissingBreakStatementInspection */
1571        case 'M':
1572            $ret *= 1024;
1573        /** @noinspection PhpMissingBreakStatementInspection */
1574        case 'K':
1575            $ret *= 1024;
1576            break;
1577        default;
1578            $ret *= 10;
1579            break;
1580    }
1581    return $ret;
1582}
1583
1584/**
1585 * Wrapper around preg_quote adding the default delimiter
1586 *
1587 * @param string $string
1588 * @return string
1589 */
1590function preg_quote_cb($string) {
1591    return preg_quote($string, '/');
1592}
1593
1594/**
1595 * Shorten a given string by removing data from the middle
1596 *
1597 * You can give the string in two parts, the first part $keep
1598 * will never be shortened. The second part $short will be cut
1599 * in the middle to shorten but only if at least $min chars are
1600 * left to display it. Otherwise it will be left off.
1601 *
1602 * @param string $keep   the part to keep
1603 * @param string $short  the part to shorten
1604 * @param int    $max    maximum chars you want for the whole string
1605 * @param int    $min    minimum number of chars to have left for middle shortening
1606 * @param string $char   the shortening character to use
1607 * @return string
1608 */
1609function shorten($keep, $short, $max, $min = 9, $char = '…') {
1610    $max = $max - utf8_strlen($keep);
1611    if($max < $min) return $keep;
1612    $len = utf8_strlen($short);
1613    if($len <= $max) return $keep.$short;
1614    $half = floor($max / 2);
1615    return $keep.utf8_substr($short, 0, $half - 1).$char.utf8_substr($short, $len - $half);
1616}
1617
1618/**
1619 * Return the users real name or e-mail address for use
1620 * in page footer and recent changes pages
1621 *
1622 * @param string|null $username or null when currently logged-in user should be used
1623 * @param bool $textonly true returns only plain text, true allows returning html
1624 * @return string html or plain text(not escaped) of formatted user name
1625 *
1626 * @author Andy Webber <dokuwiki AT andywebber DOT com>
1627 */
1628function editorinfo($username, $textonly = false) {
1629    return userlink($username, $textonly);
1630}
1631
1632/**
1633 * Returns users realname w/o link
1634 *
1635 * @param string|null $username or null when currently logged-in user should be used
1636 * @param bool $textonly true returns only plain text, true allows returning html
1637 * @return string html or plain text(not escaped) of formatted user name
1638 *
1639 * @triggers COMMON_USER_LINK
1640 */
1641function userlink($username = null, $textonly = false) {
1642    global $conf, $INFO;
1643    /** @var DokuWiki_Auth_Plugin $auth */
1644    global $auth;
1645    /** @var Input $INPUT */
1646    global $INPUT;
1647
1648    // prepare initial event data
1649    $data = array(
1650        'username' => $username, // the unique user name
1651        'name' => '',
1652        'link' => array( //setting 'link' to false disables linking
1653                         'target' => '',
1654                         'pre' => '',
1655                         'suf' => '',
1656                         'style' => '',
1657                         'more' => '',
1658                         'url' => '',
1659                         'title' => '',
1660                         'class' => ''
1661        ),
1662        'userlink' => '', // formatted user name as will be returned
1663        'textonly' => $textonly
1664    );
1665    if($username === null) {
1666        $data['username'] = $username = $INPUT->server->str('REMOTE_USER');
1667        if($textonly){
1668            $data['name'] = $INFO['userinfo']['name']. ' (' . $INPUT->server->str('REMOTE_USER') . ')';
1669        }else {
1670            $data['name'] = '<bdi>' . hsc($INFO['userinfo']['name']) . '</bdi> (<bdi>' . hsc($INPUT->server->str('REMOTE_USER')) . '</bdi>)';
1671        }
1672    }
1673
1674    $evt = new Doku_Event('COMMON_USER_LINK', $data);
1675    if($evt->advise_before(true)) {
1676        if(empty($data['name'])) {
1677            if($auth) $info = $auth->getUserData($username);
1678            if($conf['showuseras'] != 'loginname' && isset($info) && $info) {
1679                switch($conf['showuseras']) {
1680                    case 'username':
1681                    case 'username_link':
1682                        $data['name'] = $textonly ? $info['name'] : hsc($info['name']);
1683                        break;
1684                    case 'email':
1685                    case 'email_link':
1686                        $data['name'] = obfuscate($info['mail']);
1687                        break;
1688                }
1689            } else {
1690                $data['name'] = $textonly ? $data['username'] : hsc($data['username']);
1691            }
1692        }
1693
1694        /** @var Doku_Renderer_xhtml $xhtml_renderer */
1695        static $xhtml_renderer = null;
1696
1697        if(!$data['textonly'] && empty($data['link']['url'])) {
1698
1699            if(in_array($conf['showuseras'], array('email_link', 'username_link'))) {
1700                if(!isset($info)) {
1701                    if($auth) $info = $auth->getUserData($username);
1702                }
1703                if(isset($info) && $info) {
1704                    if($conf['showuseras'] == 'email_link') {
1705                        $data['link']['url'] = 'mailto:' . obfuscate($info['mail']);
1706                    } else {
1707                        if(is_null($xhtml_renderer)) {
1708                            $xhtml_renderer = p_get_renderer('xhtml');
1709                        }
1710                        if(empty($xhtml_renderer->interwiki)) {
1711                            $xhtml_renderer->interwiki = getInterwiki();
1712                        }
1713                        $shortcut = 'user';
1714                        $exists = null;
1715                        $data['link']['url'] = $xhtml_renderer->_resolveInterWiki($shortcut, $username, $exists);
1716                        $data['link']['class'] .= ' interwiki iw_user';
1717                        if($exists !== null) {
1718                            if($exists) {
1719                                $data['link']['class'] .= ' wikilink1';
1720                            } else {
1721                                $data['link']['class'] .= ' wikilink2';
1722                                $data['link']['rel'] = 'nofollow';
1723                            }
1724                        }
1725                    }
1726                } else {
1727                    $data['textonly'] = true;
1728                }
1729
1730            } else {
1731                $data['textonly'] = true;
1732            }
1733        }
1734
1735        if($data['textonly']) {
1736            $data['userlink'] = $data['name'];
1737        } else {
1738            $data['link']['name'] = $data['name'];
1739            if(is_null($xhtml_renderer)) {
1740                $xhtml_renderer = p_get_renderer('xhtml');
1741            }
1742            $data['userlink'] = $xhtml_renderer->_formatLink($data['link']);
1743        }
1744    }
1745    $evt->advise_after();
1746    unset($evt);
1747
1748    return $data['userlink'];
1749}
1750
1751/**
1752 * Returns the path to a image file for the currently chosen license.
1753 * When no image exists, returns an empty string
1754 *
1755 * @author Andreas Gohr <andi@splitbrain.org>
1756 *
1757 * @param  string $type - type of image 'badge' or 'button'
1758 * @return string
1759 */
1760function license_img($type) {
1761    global $license;
1762    global $conf;
1763    if(!$conf['license']) return '';
1764    if(!is_array($license[$conf['license']])) return '';
1765    $try   = array();
1766    $try[] = 'lib/images/license/'.$type.'/'.$conf['license'].'.png';
1767    $try[] = 'lib/images/license/'.$type.'/'.$conf['license'].'.gif';
1768    if(substr($conf['license'], 0, 3) == 'cc-') {
1769        $try[] = 'lib/images/license/'.$type.'/cc.png';
1770    }
1771    foreach($try as $src) {
1772        if(file_exists(DOKU_INC.$src)) return $src;
1773    }
1774    return '';
1775}
1776
1777/**
1778 * Checks if the given amount of memory is available
1779 *
1780 * If the memory_get_usage() function is not available the
1781 * function just assumes $bytes of already allocated memory
1782 *
1783 * @author Filip Oscadal <webmaster@illusionsoftworks.cz>
1784 * @author Andreas Gohr <andi@splitbrain.org>
1785 *
1786 * @param int  $mem    Size of memory you want to allocate in bytes
1787 * @param int  $bytes  already allocated memory (see above)
1788 * @return bool
1789 */
1790function is_mem_available($mem, $bytes = 1048576) {
1791    $limit = trim(ini_get('memory_limit'));
1792    if(empty($limit)) return true; // no limit set!
1793
1794    // parse limit to bytes
1795    $limit = php_to_byte($limit);
1796
1797    // get used memory if possible
1798    if(function_exists('memory_get_usage')) {
1799        $used = memory_get_usage();
1800    } else {
1801        $used = $bytes;
1802    }
1803
1804    if($used + $mem > $limit) {
1805        return false;
1806    }
1807
1808    return true;
1809}
1810
1811/**
1812 * Send a HTTP redirect to the browser
1813 *
1814 * Works arround Microsoft IIS cookie sending bug. Exits the script.
1815 *
1816 * @link   http://support.microsoft.com/kb/q176113/
1817 * @author Andreas Gohr <andi@splitbrain.org>
1818 *
1819 * @param string $url url being directed to
1820 */
1821function send_redirect($url) {
1822    /* @var Input $INPUT */
1823    global $INPUT;
1824
1825    //are there any undisplayed messages? keep them in session for display
1826    global $MSG;
1827    if(isset($MSG) && count($MSG) && !defined('NOSESSION')) {
1828        //reopen session, store data and close session again
1829        @session_start();
1830        $_SESSION[DOKU_COOKIE]['msg'] = $MSG;
1831    }
1832
1833    // always close the session
1834    session_write_close();
1835
1836    // check if running on IIS < 6 with CGI-PHP
1837    if($INPUT->server->has('SERVER_SOFTWARE') && $INPUT->server->has('GATEWAY_INTERFACE') &&
1838        (strpos($INPUT->server->str('GATEWAY_INTERFACE'), 'CGI') !== false) &&
1839        (preg_match('|^Microsoft-IIS/(\d)\.\d$|', trim($INPUT->server->str('SERVER_SOFTWARE')), $matches)) &&
1840        $matches[1] < 6
1841    ) {
1842        header('Refresh: 0;url='.$url);
1843    } else {
1844        header('Location: '.$url);
1845    }
1846
1847    if(defined('DOKU_UNITTEST')) return; // no exits during unit tests
1848    exit;
1849}
1850
1851/**
1852 * Validate a value using a set of valid values
1853 *
1854 * This function checks whether a specified value is set and in the array
1855 * $valid_values. If not, the function returns a default value or, if no
1856 * default is specified, throws an exception.
1857 *
1858 * @param string $param        The name of the parameter
1859 * @param array  $valid_values A set of valid values; Optionally a default may
1860 *                             be marked by the key “default”.
1861 * @param array  $array        The array containing the value (typically $_POST
1862 *                             or $_GET)
1863 * @param string $exc          The text of the raised exception
1864 *
1865 * @throws Exception
1866 * @return mixed
1867 * @author Adrian Lang <lang@cosmocode.de>
1868 */
1869function valid_input_set($param, $valid_values, $array, $exc = '') {
1870    if(isset($array[$param]) && in_array($array[$param], $valid_values)) {
1871        return $array[$param];
1872    } elseif(isset($valid_values['default'])) {
1873        return $valid_values['default'];
1874    } else {
1875        throw new Exception($exc);
1876    }
1877}
1878
1879/**
1880 * Read a preference from the DokuWiki cookie
1881 * (remembering both keys & values are urlencoded)
1882 *
1883 * @param string $pref     preference key
1884 * @param mixed  $default  value returned when preference not found
1885 * @return string preference value
1886 */
1887function get_doku_pref($pref, $default) {
1888    $enc_pref = urlencode($pref);
1889    if(isset($_COOKIE['DOKU_PREFS']) && strpos($_COOKIE['DOKU_PREFS'], $enc_pref) !== false) {
1890        $parts = explode('#', $_COOKIE['DOKU_PREFS']);
1891        $cnt   = count($parts);
1892        for($i = 0; $i < $cnt; $i += 2) {
1893            if($parts[$i] == $enc_pref) {
1894                return urldecode($parts[$i + 1]);
1895            }
1896        }
1897    }
1898    return $default;
1899}
1900
1901/**
1902 * Add a preference to the DokuWiki cookie
1903 * (remembering $_COOKIE['DOKU_PREFS'] is urlencoded)
1904 * Remove it by setting $val to false
1905 *
1906 * @param string $pref  preference key
1907 * @param string $val   preference value
1908 */
1909function set_doku_pref($pref, $val) {
1910    global $conf;
1911    $orig = get_doku_pref($pref, false);
1912    $cookieVal = '';
1913
1914    if($orig && ($orig != $val)) {
1915        $parts = explode('#', $_COOKIE['DOKU_PREFS']);
1916        $cnt   = count($parts);
1917        // urlencode $pref for the comparison
1918        $enc_pref = rawurlencode($pref);
1919        for($i = 0; $i < $cnt; $i += 2) {
1920            if($parts[$i] == $enc_pref) {
1921                if ($val !== false) {
1922                    $parts[$i + 1] = rawurlencode($val);
1923                } else {
1924                    unset($parts[$i]);
1925                    unset($parts[$i + 1]);
1926                }
1927                break;
1928            }
1929        }
1930        $cookieVal = implode('#', $parts);
1931    } else if (!$orig && $val !== false) {
1932        $cookieVal = ($_COOKIE['DOKU_PREFS'] ? $_COOKIE['DOKU_PREFS'].'#' : '').rawurlencode($pref).'#'.rawurlencode($val);
1933    }
1934
1935    if (!empty($cookieVal)) {
1936        $cookieDir = empty($conf['cookiedir']) ? DOKU_REL : $conf['cookiedir'];
1937        setcookie('DOKU_PREFS', $cookieVal, time()+365*24*3600, $cookieDir, '', ($conf['securecookie'] && is_ssl()));
1938    }
1939}
1940
1941/**
1942 * Strips source mapping declarations from given text #601
1943 *
1944 * @param string &$text reference to the CSS or JavaScript code to clean
1945 */
1946function stripsourcemaps(&$text){
1947    $text = preg_replace('/^(\/\/|\/\*)[@#]\s+sourceMappingURL=.*?(\*\/)?$/im', '\\1\\2', $text);
1948}
1949
1950//Setup VIM: ex: et ts=2 :
1951