xref: /dokuwiki/inc/common.php (revision b796e32e30bfcda629ebcf2a86550c6371839b0d) 
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 */
26function hsc($string){
27    return htmlspecialchars($string, ENT_QUOTES, 'UTF-8');
28}
29
30/**
31 * print a newline terminated string
32 *
33 * You can give an indention as optional parameter
34 *
35 * @author Andreas Gohr <andi@splitbrain.org>
36 */
37function ptln($string,$indent=0){
38    echo str_repeat(' ', $indent)."$string\n";
39}
40
41/**
42 * strips control characters (<32) from the given string
43 *
44 * @author Andreas Gohr <andi@splitbrain.org>
45 */
46function stripctl($string){
47    return preg_replace('/[\x00-\x1F]+/s','',$string);
48}
49
50/**
51 * Return a secret token to be used for CSRF attack prevention
52 *
53 * @author  Andreas Gohr <andi@splitbrain.org>
54 * @link    http://en.wikipedia.org/wiki/Cross-site_request_forgery
55 * @link    http://christ1an.blogspot.com/2007/04/preventing-csrf-efficiently.html
56 * @return  string
57 */
58function getSecurityToken(){
59    return md5(auth_cookiesalt().session_id().$_SERVER['REMOTE_USER']);
60}
61
62/**
63 * Check the secret CSRF token
64 */
65function checkSecurityToken($token=null){
66    if(!$_SERVER['REMOTE_USER']) return true; // no logged in user, no need for a check
67
68    if(is_null($token)) $token = $_REQUEST['sectok'];
69    if(getSecurityToken() != $token){
70        msg('Security Token did not match. Possible CSRF attack.',-1);
71        return false;
72    }
73    return true;
74}
75
76/**
77 * Print a hidden form field with a secret CSRF token
78 *
79 * @author  Andreas Gohr <andi@splitbrain.org>
80 */
81function formSecurityToken($print=true){
82    $ret = '<div class="no"><input type="hidden" name="sectok" value="'.getSecurityToken().'" /></div>'."\n";
83    if($print){
84        echo $ret;
85    }else{
86        return $ret;
87    }
88}
89
90/**
91 * Return info about the current document as associative
92 * array.
93 *
94 * @author Andreas Gohr <andi@splitbrain.org>
95 */
96function pageinfo(){
97    global $ID;
98    global $REV;
99    global $RANGE;
100    global $USERINFO;
101    global $lang;
102
103    // include ID & REV not redundant, as some parts of DokuWiki may temporarily change $ID, e.g. p_wiki_xhtml
104    // FIXME ... perhaps it would be better to ensure the temporary changes weren't necessary
105    $info['id'] = $ID;
106    $info['rev'] = $REV;
107
108    // set info about manager/admin status.
109    $info['isadmin']   = false;
110    $info['ismanager'] = false;
111    if(isset($_SERVER['REMOTE_USER'])){
112        $info['userinfo']     = $USERINFO;
113        $info['perm']         = auth_quickaclcheck($ID);
114        $info['subscribed']   = get_info_subscribed();
115        $info['client']       = $_SERVER['REMOTE_USER'];
116
117        if($info['perm'] == AUTH_ADMIN){
118            $info['isadmin']   = true;
119            $info['ismanager'] = true;
120        }elseif(auth_ismanager()){
121            $info['ismanager'] = true;
122        }
123
124        // if some outside auth were used only REMOTE_USER is set
125        if(!$info['userinfo']['name']){
126            $info['userinfo']['name'] = $_SERVER['REMOTE_USER'];
127        }
128
129    }else{
130        $info['perm']       = auth_aclcheck($ID,'',null);
131        $info['subscribed'] = false;
132        $info['client']     = clientIP(true);
133    }
134
135    $info['namespace'] = getNS($ID);
136    $info['locked']    = checklock($ID);
137    $info['filepath']  = fullpath(wikiFN($ID));
138    $info['exists']    = @file_exists($info['filepath']);
139    if($REV){
140        //check if current revision was meant
141        if($info['exists'] && (@filemtime($info['filepath'])==$REV)){
142            $REV = '';
143        }elseif($RANGE){
144            //section editing does not work with old revisions!
145            $REV   = '';
146            $RANGE = '';
147            msg($lang['nosecedit'],0);
148        }else{
149            //really use old revision
150            $info['filepath'] = fullpath(wikiFN($ID,$REV));
151            $info['exists']   = @file_exists($info['filepath']);
152        }
153    }
154    $info['rev'] = $REV;
155    if($info['exists']){
156        $info['writable'] = (is_writable($info['filepath']) &&
157                ($info['perm'] >= AUTH_EDIT));
158    }else{
159        $info['writable'] = ($info['perm'] >= AUTH_CREATE);
160    }
161    $info['editable']  = ($info['writable'] && empty($info['locked']));
162    $info['lastmod']   = @filemtime($info['filepath']);
163
164    //load page meta data
165    $info['meta'] = p_get_metadata($ID);
166
167    //who's the editor
168    if($REV){
169        $revinfo = getRevisionInfo($ID, $REV, 1024);
170    }else{
171        if (is_array($info['meta']['last_change'])) {
172            $revinfo = $info['meta']['last_change'];
173        } else {
174            $revinfo = getRevisionInfo($ID, $info['lastmod'], 1024);
175            // cache most recent changelog line in metadata if missing and still valid
176            if ($revinfo!==false) {
177                $info['meta']['last_change'] = $revinfo;
178                p_set_metadata($ID, array('last_change' => $revinfo));
179            }
180        }
181    }
182    //and check for an external edit
183    if($revinfo!==false && $revinfo['date']!=$info['lastmod']){
184        // cached changelog line no longer valid
185        $revinfo = false;
186        $info['meta']['last_change'] = $revinfo;
187        p_set_metadata($ID, array('last_change' => $revinfo));
188    }
189
190    $info['ip']     = $revinfo['ip'];
191    $info['user']   = $revinfo['user'];
192    $info['sum']    = $revinfo['sum'];
193    // See also $INFO['meta']['last_change'] which is the most recent log line for page $ID.
194    // Use $INFO['meta']['last_change']['type']===DOKU_CHANGE_TYPE_MINOR_EDIT in place of $info['minor'].
195
196    if($revinfo['user']){
197        $info['editor'] = $revinfo['user'];
198    }else{
199        $info['editor'] = $revinfo['ip'];
200    }
201
202    // draft
203    $draft = getCacheName($info['client'].$ID,'.draft');
204    if(@file_exists($draft)){
205        if(@filemtime($draft) < @filemtime(wikiFN($ID))){
206            // remove stale draft
207            @unlink($draft);
208        }else{
209            $info['draft'] = $draft;
210        }
211    }
212
213    // mobile detection
214    $info['ismobile'] = clientismobile();
215
216    return $info;
217}
218
219/**
220 * Build an string of URL parameters
221 *
222 * @author Andreas Gohr
223 */
224function buildURLparams($params, $sep='&amp;'){
225    $url = '';
226    $amp = false;
227    foreach($params as $key => $val){
228        if($amp) $url .= $sep;
229
230        $url .= rawurlencode($key).'=';
231        $url .= rawurlencode((string)$val);
232        $amp = true;
233    }
234    return $url;
235}
236
237/**
238 * Build an string of html tag attributes
239 *
240 * Skips keys starting with '_', values get HTML encoded
241 *
242 * @author Andreas Gohr
243 */
244function buildAttributes($params,$skipempty=false){
245    $url = '';
246    $white = false;
247    foreach($params as $key => $val){
248        if($key{0} == '_') continue;
249        if($val === '' && $skipempty) continue;
250        if($white) $url .= ' ';
251
252        $url .= $key.'="';
253        $url .= htmlspecialchars ($val);
254        $url .= '"';
255        $white = true;
256    }
257    return $url;
258}
259
260
261/**
262 * This builds the breadcrumb trail and returns it as array
263 *
264 * @author Andreas Gohr <andi@splitbrain.org>
265 */
266function breadcrumbs(){
267    // we prepare the breadcrumbs early for quick session closing
268    static $crumbs = null;
269    if($crumbs != null) return $crumbs;
270
271    global $ID;
272    global $ACT;
273    global $conf;
274
275    //first visit?
276    $crumbs = isset($_SESSION[DOKU_COOKIE]['bc']) ? $_SESSION[DOKU_COOKIE]['bc'] : array();
277    //we only save on show and existing wiki documents
278    $file = wikiFN($ID);
279    if($ACT != 'show' || !@file_exists($file)){
280        $_SESSION[DOKU_COOKIE]['bc'] = $crumbs;
281        return $crumbs;
282    }
283
284    // page names
285    $name = noNSorNS($ID);
286    if (useHeading('navigation')) {
287        // get page title
288        $title = p_get_first_heading($ID,METADATA_RENDER_USING_SIMPLE_CACHE);
289        if ($title) {
290            $name = $title;
291        }
292    }
293
294    //remove ID from array
295    if (isset($crumbs[$ID])) {
296        unset($crumbs[$ID]);
297    }
298
299    //add to array
300    $crumbs[$ID] = $name;
301    //reduce size
302    while(count($crumbs) > $conf['breadcrumbs']){
303        array_shift($crumbs);
304    }
305    //save to session
306    $_SESSION[DOKU_COOKIE]['bc'] = $crumbs;
307    return $crumbs;
308}
309
310/**
311 * Filter for page IDs
312 *
313 * This is run on a ID before it is outputted somewhere
314 * currently used to replace the colon with something else
315 * on Windows systems and to have proper URL encoding
316 *
317 * Urlencoding is ommitted when the second parameter is false
318 *
319 * @author Andreas Gohr <andi@splitbrain.org>
320 */
321function idfilter($id,$ue=true){
322    global $conf;
323    if ($conf['useslash'] && $conf['userewrite']){
324        $id = strtr($id,':','/');
325    }elseif (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN' &&
326            $conf['userewrite']) {
327        $id = strtr($id,':',';');
328    }
329    if($ue){
330        $id = rawurlencode($id);
331        $id = str_replace('%3A',':',$id); //keep as colon
332        $id = str_replace('%2F','/',$id); //keep as slash
333    }
334    return $id;
335}
336
337/**
338 * This builds a link to a wikipage
339 *
340 * It handles URL rewriting and adds additional parameter if
341 * given in $more
342 *
343 * @author Andreas Gohr <andi@splitbrain.org>
344 */
345function wl($id='',$more='',$abs=false,$sep='&amp;'){
346    global $conf;
347    if(is_array($more)){
348        $more = buildURLparams($more,$sep);
349    }else{
350        $more = str_replace(',',$sep,$more);
351    }
352
353    $id    = idfilter($id);
354    if($abs){
355        $xlink = DOKU_URL;
356    }else{
357        $xlink = DOKU_BASE;
358    }
359
360    if($conf['userewrite'] == 2){
361        $xlink .= DOKU_SCRIPT.'/'.$id;
362        if($more) $xlink .= '?'.$more;
363    }elseif($conf['userewrite']){
364        $xlink .= $id;
365        if($more) $xlink .= '?'.$more;
366    }elseif($id){
367        $xlink .= DOKU_SCRIPT.'?id='.$id;
368        if($more) $xlink .= $sep.$more;
369    }else{
370        $xlink .= DOKU_SCRIPT;
371        if($more) $xlink .= '?'.$more;
372    }
373
374    return $xlink;
375}
376
377/**
378 * This builds a link to an alternate page format
379 *
380 * Handles URL rewriting if enabled. Follows the style of wl().
381 *
382 * @author Ben Coburn <btcoburn@silicodon.net>
383 */
384function exportlink($id='',$format='raw',$more='',$abs=false,$sep='&amp;'){
385    global $conf;
386    if(is_array($more)){
387        $more = buildURLparams($more,$sep);
388    }else{
389        $more = str_replace(',',$sep,$more);
390    }
391
392    $format = rawurlencode($format);
393    $id = idfilter($id);
394    if($abs){
395        $xlink = DOKU_URL;
396    }else{
397        $xlink = DOKU_BASE;
398    }
399
400    if($conf['userewrite'] == 2){
401        $xlink .= DOKU_SCRIPT.'/'.$id.'?do=export_'.$format;
402        if($more) $xlink .= $sep.$more;
403    }elseif($conf['userewrite'] == 1){
404        $xlink .= '_export/'.$format.'/'.$id;
405        if($more) $xlink .= '?'.$more;
406    }else{
407        $xlink .= DOKU_SCRIPT.'?do=export_'.$format.$sep.'id='.$id;
408        if($more) $xlink .= $sep.$more;
409    }
410
411    return $xlink;
412}
413
414/**
415 * Build a link to a media file
416 *
417 * Will return a link to the detail page if $direct is false
418 *
419 * The $more parameter should always be given as array, the function then
420 * will strip default parameters to produce even cleaner URLs
421 *
422 * @param string  $id     - the media file id or URL
423 * @param mixed   $more   - string or array with additional parameters
424 * @param boolean $direct - link to detail page if false
425 * @param string  $sep    - URL parameter separator
426 * @param boolean $abs    - Create an absolute URL
427 */
428function ml($id='',$more='',$direct=true,$sep='&amp;',$abs=false){
429    global $conf;
430    if(is_array($more)){
431        // strip defaults for shorter URLs
432        if(isset($more['cache']) && $more['cache'] == 'cache') unset($more['cache']);
433        if(!$more['w']) unset($more['w']);
434        if(!$more['h']) unset($more['h']);
435        if(isset($more['id']) && $direct) unset($more['id']);
436        $more = buildURLparams($more,$sep);
437    }else{
438        $more = str_replace('cache=cache','',$more); //skip default
439        $more = str_replace(',,',',',$more);
440        $more = str_replace(',',$sep,$more);
441    }
442
443    if($abs){
444        $xlink = DOKU_URL;
445    }else{
446        $xlink = DOKU_BASE;
447    }
448
449    // external URLs are always direct without rewriting
450    if(preg_match('#^(https?|ftp)://#i',$id)){
451        $xlink .= 'lib/exe/fetch.php';
452        // add hash:
453        $xlink .= '?hash='.substr(md5(auth_cookiesalt().$id),0,6);
454        if($more){
455            $xlink .= $sep.$more;
456            $xlink .= $sep.'media='.rawurlencode($id);
457        }else{
458            $xlink .= $sep.'media='.rawurlencode($id);
459        }
460        return $xlink;
461    }
462
463    $id = idfilter($id);
464
465    // decide on scriptname
466    if($direct){
467        if($conf['userewrite'] == 1){
468            $script = '_media';
469        }else{
470            $script = 'lib/exe/fetch.php';
471        }
472    }else{
473        if($conf['userewrite'] == 1){
474            $script = '_detail';
475        }else{
476            $script = 'lib/exe/detail.php';
477        }
478    }
479
480    // build URL based on rewrite mode
481    if($conf['userewrite']){
482        $xlink .= $script.'/'.$id;
483        if($more) $xlink .= '?'.$more;
484    }else{
485        if($more){
486            $xlink .= $script.'?'.$more;
487            $xlink .= $sep.'media='.$id;
488        }else{
489            $xlink .= $script.'?media='.$id;
490        }
491    }
492
493    return $xlink;
494}
495
496
497
498/**
499 * Just builds a link to a script
500 *
501 * @todo   maybe obsolete
502 * @author Andreas Gohr <andi@splitbrain.org>
503 */
504function script($script='doku.php'){
505    return DOKU_BASE.DOKU_SCRIPT;
506}
507
508/**
509 * Spamcheck against wordlist
510 *
511 * Checks the wikitext against a list of blocked expressions
512 * returns true if the text contains any bad words
513 *
514 * Triggers COMMON_WORDBLOCK_BLOCKED
515 *
516 *  Action Plugins can use this event to inspect the blocked data
517 *  and gain information about the user who was blocked.
518 *
519 *  Event data:
520 *    data['matches']  - array of matches
521 *    data['userinfo'] - information about the blocked user
522 *      [ip]           - ip address
523 *      [user]         - username (if logged in)
524 *      [mail]         - mail address (if logged in)
525 *      [name]         - real name (if logged in)
526 *
527 * @author Andreas Gohr <andi@splitbrain.org>
528 * @author Michael Klier <chi@chimeric.de>
529 * @param  string $text - optional text to check, if not given the globals are used
530 * @return bool         - true if a spam word was found
531 */
532function checkwordblock($text=''){
533    global $TEXT;
534    global $PRE;
535    global $SUF;
536    global $conf;
537    global $INFO;
538
539    if(!$conf['usewordblock']) return false;
540
541    if(!$text) $text = "$PRE $TEXT $SUF";
542
543    // we prepare the text a tiny bit to prevent spammers circumventing URL checks
544    $text = preg_replace('!(\b)(www\.[\w.:?\-;,]+?\.[\w.:?\-;,]+?[\w/\#~:.?+=&%@\!\-.:?\-;,]+?)([.:?\-;,]*[^\w/\#~:.?+=&%@\!\-.:?\-;,])!i','\1http://\2 \2\3',$text);
545
546    $wordblocks = getWordblocks();
547    // how many lines to read at once (to work around some PCRE limits)
548    if(version_compare(phpversion(),'4.3.0','<')){
549        // old versions of PCRE define a maximum of parenthesises even if no
550        // backreferences are used - the maximum is 99
551        // this is very bad performancewise and may even be too high still
552        $chunksize = 40;
553    }else{
554        // read file in chunks of 200 - this should work around the
555        // MAX_PATTERN_SIZE in modern PCRE
556        $chunksize = 200;
557    }
558    while($blocks = array_splice($wordblocks,0,$chunksize)){
559        $re = array();
560        // build regexp from blocks
561        foreach($blocks as $block){
562            $block = preg_replace('/#.*$/','',$block);
563            $block = trim($block);
564            if(empty($block)) continue;
565            $re[]  = $block;
566        }
567        if(count($re) && preg_match('#('.join('|',$re).')#si',$text,$matches)) {
568            // prepare event data
569            $data['matches'] = $matches;
570            $data['userinfo']['ip'] = $_SERVER['REMOTE_ADDR'];
571            if($_SERVER['REMOTE_USER']) {
572                $data['userinfo']['user'] = $_SERVER['REMOTE_USER'];
573                $data['userinfo']['name'] = $INFO['userinfo']['name'];
574                $data['userinfo']['mail'] = $INFO['userinfo']['mail'];
575            }
576            $callback = create_function('', 'return true;');
577            return trigger_event('COMMON_WORDBLOCK_BLOCKED', $data, $callback, true);
578        }
579    }
580    return false;
581}
582
583/**
584 * Return the IP of the client
585 *
586 * Honours X-Forwarded-For and X-Real-IP Proxy Headers
587 *
588 * It returns a comma separated list of IPs if the above mentioned
589 * headers are set. If the single parameter is set, it tries to return
590 * a routable public address, prefering the ones suplied in the X
591 * headers
592 *
593 * @param  boolean $single If set only a single IP is returned
594 * @author Andreas Gohr <andi@splitbrain.org>
595 */
596function clientIP($single=false){
597    $ip = array();
598    $ip[] = $_SERVER['REMOTE_ADDR'];
599    if(!empty($_SERVER['HTTP_X_FORWARDED_FOR']))
600        $ip = array_merge($ip,explode(',',str_replace(' ','',$_SERVER['HTTP_X_FORWARDED_FOR'])));
601    if(!empty($_SERVER['HTTP_X_REAL_IP']))
602        $ip = array_merge($ip,explode(',',str_replace(' ','',$_SERVER['HTTP_X_REAL_IP'])));
603
604    // some IPv4/v6 regexps borrowed from Feyd
605    // see: http://forums.devnetwork.net/viewtopic.php?f=38&t=53479
606    $dec_octet = '(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|[0-9])';
607    $hex_digit = '[A-Fa-f0-9]';
608    $h16 = "{$hex_digit}{1,4}";
609    $IPv4Address = "$dec_octet\\.$dec_octet\\.$dec_octet\\.$dec_octet";
610    $ls32 = "(?:$h16:$h16|$IPv4Address)";
611    $IPv6Address =
612        "(?:(?:{$IPv4Address})|(?:".
613        "(?:$h16:){6}$ls32" .
614        "|::(?:$h16:){5}$ls32" .
615        "|(?:$h16)?::(?:$h16:){4}$ls32" .
616        "|(?:(?:$h16:){0,1}$h16)?::(?:$h16:){3}$ls32" .
617        "|(?:(?:$h16:){0,2}$h16)?::(?:$h16:){2}$ls32" .
618        "|(?:(?:$h16:){0,3}$h16)?::(?:$h16:){1}$ls32" .
619        "|(?:(?:$h16:){0,4}$h16)?::$ls32" .
620        "|(?:(?:$h16:){0,5}$h16)?::$h16" .
621        "|(?:(?:$h16:){0,6}$h16)?::" .
622        ")(?:\\/(?:12[0-8]|1[0-1][0-9]|[1-9][0-9]|[0-9]))?)";
623
624    // remove any non-IP stuff
625    $cnt = count($ip);
626    $match = array();
627    for($i=0; $i<$cnt; $i++){
628        if(preg_match("/^$IPv4Address$/",$ip[$i],$match) || preg_match("/^$IPv6Address$/",$ip[$i],$match)) {
629            $ip[$i] = $match[0];
630        } else {
631            $ip[$i] = '';
632        }
633        if(empty($ip[$i])) unset($ip[$i]);
634    }
635    $ip = array_values(array_unique($ip));
636    if(!$ip[0]) $ip[0] = '0.0.0.0'; // for some strange reason we don't have a IP
637
638    if(!$single) return join(',',$ip);
639
640    // decide which IP to use, trying to avoid local addresses
641    $ip = array_reverse($ip);
642    foreach($ip as $i){
643        if(preg_match('/^(::1|[fF][eE]80:|127\.|10\.|192\.168\.|172\.((1[6-9])|(2[0-9])|(3[0-1]))\.)/',$i)){
644            continue;
645        }else{
646            return $i;
647        }
648    }
649    // still here? just use the first (last) address
650    return $ip[0];
651}
652
653/**
654 * Check if the browser is on a mobile device
655 *
656 * Adapted from the example code at url below
657 *
658 * @link http://www.brainhandles.com/2007/10/15/detecting-mobile-browsers/#code
659 */
660function clientismobile(){
661
662    if(isset($_SERVER['HTTP_X_WAP_PROFILE'])) return true;
663
664    if(preg_match('/wap\.|\.wap/i',$_SERVER['HTTP_ACCEPT'])) return true;
665
666    if(!isset($_SERVER['HTTP_USER_AGENT'])) return false;
667
668    $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';
669
670    if(preg_match("/$uamatches/i",$_SERVER['HTTP_USER_AGENT'])) return true;
671
672    return false;
673}
674
675
676/**
677 * Convert one or more comma separated IPs to hostnames
678 *
679 * @author Glen Harris <astfgl@iamnota.org>
680 * @returns a comma separated list of hostnames
681 */
682function gethostsbyaddrs($ips){
683    $hosts = array();
684    $ips = explode(',',$ips);
685
686    if(is_array($ips)) {
687        foreach($ips as $ip){
688            $hosts[] = gethostbyaddr(trim($ip));
689        }
690        return join(',',$hosts);
691    } else {
692        return gethostbyaddr(trim($ips));
693    }
694}
695
696/**
697 * Checks if a given page is currently locked.
698 *
699 * removes stale lockfiles
700 *
701 * @author Andreas Gohr <andi@splitbrain.org>
702 */
703function checklock($id){
704    global $conf;
705    $lock = wikiLockFN($id);
706
707    //no lockfile
708    if(!@file_exists($lock)) return false;
709
710    //lockfile expired
711    if((time() - filemtime($lock)) > $conf['locktime']){
712        @unlink($lock);
713        return false;
714    }
715
716    //my own lock
717    list($ip,$session) = explode("\n",io_readFile($lock));
718    if($ip == $_SERVER['REMOTE_USER'] || $ip == clientIP() || $session == session_id()){
719        return false;
720    }
721
722    return $ip;
723}
724
725/**
726 * Lock a page for editing
727 *
728 * @author Andreas Gohr <andi@splitbrain.org>
729 */
730function lock($id){
731    global $conf;
732
733    if($conf['locktime'] == 0){
734        return;
735    }
736
737    $lock = wikiLockFN($id);
738    if($_SERVER['REMOTE_USER']){
739        io_saveFile($lock,$_SERVER['REMOTE_USER']);
740    }else{
741        io_saveFile($lock,clientIP()."\n".session_id());
742    }
743}
744
745/**
746 * Unlock a page if it was locked by the user
747 *
748 * @author Andreas Gohr <andi@splitbrain.org>
749 * @return bool true if a lock was removed
750 */
751function unlock($id){
752    $lock = wikiLockFN($id);
753    if(@file_exists($lock)){
754        list($ip,$session) = explode("\n",io_readFile($lock));
755        if($ip == $_SERVER['REMOTE_USER'] || $ip == clientIP() || $session == session_id()){
756            @unlink($lock);
757            return true;
758        }
759    }
760    return false;
761}
762
763/**
764 * convert line ending to unix format
765 *
766 * @see    formText() for 2crlf conversion
767 * @author Andreas Gohr <andi@splitbrain.org>
768 */
769function cleanText($text){
770    $text = preg_replace("/(\015\012)|(\015)/","\012",$text);
771    return $text;
772}
773
774/**
775 * Prepares text for print in Webforms by encoding special chars.
776 * It also converts line endings to Windows format which is
777 * pseudo standard for webforms.
778 *
779 * @see    cleanText() for 2unix conversion
780 * @author Andreas Gohr <andi@splitbrain.org>
781 */
782function formText($text){
783    $text = str_replace("\012","\015\012",$text);
784    return htmlspecialchars($text);
785}
786
787/**
788 * Returns the specified local text in raw format
789 *
790 * @author Andreas Gohr <andi@splitbrain.org>
791 */
792function rawLocale($id,$ext='txt'){
793    return io_readFile(localeFN($id,$ext));
794}
795
796/**
797 * Returns the raw WikiText
798 *
799 * @author Andreas Gohr <andi@splitbrain.org>
800 */
801function rawWiki($id,$rev=''){
802    return io_readWikiPage(wikiFN($id, $rev), $id, $rev);
803}
804
805/**
806 * Returns the pagetemplate contents for the ID's namespace
807 *
808 * @triggers COMMON_PAGETPL_LOAD
809 * @author Andreas Gohr <andi@splitbrain.org>
810 */
811function pageTemplate($id){
812    global $conf;
813
814    if (is_array($id)) $id = $id[0];
815
816    // prepare initial event data
817    $data = array(
818        'id'        => $id,   // the id of the page to be created
819        'tpl'       => '',    // the text used as template
820        'tplfile'   => '',    // the file above text was/should be loaded from
821        'doreplace' => true   // should wildcard replacements be done on the text?
822    );
823
824    $evt = new Doku_Event('COMMON_PAGETPL_LOAD',$data);
825    if($evt->advise_before(true)){
826        // the before event might have loaded the content already
827        if(empty($data['tpl'])){
828            // if the before event did not set a template file, try to find one
829            if(empty($data['tplfile'])){
830                $path = dirname(wikiFN($id));
831                $tpl = '';
832                if(@file_exists($path.'/_template.txt')){
833                    $data['tplfile'] = $path.'/_template.txt';
834                }else{
835                    // search upper namespaces for templates
836                    $len = strlen(rtrim($conf['datadir'],'/'));
837                    while (strlen($path) >= $len){
838                        if(@file_exists($path.'/__template.txt')){
839                            $data['tplfile'] = $path.'/__template.txt';
840                            break;
841                        }
842                        $path = substr($path, 0, strrpos($path, '/'));
843                    }
844                }
845            }
846            // load the content
847            $data['tpl'] = io_readFile($data['tplfile']);
848        }
849        if($data['doreplace']) parsePageTemplate($data);
850    }
851    $evt->advise_after();
852    unset($evt);
853
854    return $data['tpl'];
855}
856
857/**
858 * Performs common page template replacements
859 * This works on data from COMMON_PAGETPL_LOAD
860 *
861 * @author Andreas Gohr <andi@splitbrain.org>
862 */
863function parsePageTemplate(&$data) {
864    extract($data);
865
866    global $USERINFO;
867    global $conf;
868
869    // replace placeholders
870    $file = noNS($id);
871    $page = strtr($file, $conf['sepchar'], ' ');
872
873    $tpl = str_replace(array(
874                '@ID@',
875                '@NS@',
876                '@FILE@',
877                '@!FILE@',
878                '@!FILE!@',
879                '@PAGE@',
880                '@!PAGE@',
881                '@!!PAGE@',
882                '@!PAGE!@',
883                '@USER@',
884                '@NAME@',
885                '@MAIL@',
886                '@DATE@',
887                ),
888            array(
889                $id,
890                getNS($id),
891                $file,
892                utf8_ucfirst($file),
893                utf8_strtoupper($file),
894                $page,
895                utf8_ucfirst($page),
896                utf8_ucwords($page),
897                utf8_strtoupper($page),
898                $_SERVER['REMOTE_USER'],
899                $USERINFO['name'],
900                $USERINFO['mail'],
901                $conf['dformat'],
902                ), $tpl);
903
904    // we need the callback to work around strftime's char limit
905    $tpl = preg_replace_callback('/%./',create_function('$m','return strftime($m[0]);'),$tpl);
906    $data['tpl'] = $tpl;
907    return $tpl;
908}
909
910/**
911 * Returns the raw Wiki Text in three slices.
912 *
913 * The range parameter needs to have the form "from-to"
914 * and gives the range of the section in bytes - no
915 * UTF-8 awareness is needed.
916 * The returned order is prefix, section and suffix.
917 *
918 * @author Andreas Gohr <andi@splitbrain.org>
919 */
920function rawWikiSlices($range,$id,$rev=''){
921    $text = io_readWikiPage(wikiFN($id, $rev), $id, $rev);
922
923    // Parse range
924    list($from,$to) = explode('-',$range,2);
925    // Make range zero-based, use defaults if marker is missing
926    $from = !$from ? 0 : ($from - 1);
927    $to   = !$to ? strlen($text) : ($to - 1);
928
929    $slices[0] = substr($text, 0, $from);
930    $slices[1] = substr($text, $from, $to-$from);
931    $slices[2] = substr($text, $to);
932    return $slices;
933}
934
935/**
936 * Joins wiki text slices
937 *
938 * function to join the text slices.
939 * When the pretty parameter is set to true it adds additional empty
940 * lines between sections if needed (used on saving).
941 *
942 * @author Andreas Gohr <andi@splitbrain.org>
943 */
944function con($pre,$text,$suf,$pretty=false){
945    if($pretty){
946        if ($pre !== '' && substr($pre, -1) !== "\n" &&
947            substr($text, 0, 1) !== "\n") {
948            $pre .= "\n";
949        }
950        if ($suf !== '' && substr($text, -1) !== "\n" &&
951            substr($suf, 0, 1) !== "\n") {
952            $text .= "\n";
953        }
954    }
955
956    return $pre.$text.$suf;
957}
958
959/**
960 * Saves a wikitext by calling io_writeWikiPage.
961 * Also directs changelog and attic updates.
962 *
963 * @author Andreas Gohr <andi@splitbrain.org>
964 * @author Ben Coburn <btcoburn@silicodon.net>
965 */
966function saveWikiText($id,$text,$summary,$minor=false){
967    /* Note to developers:
968       This code is subtle and delicate. Test the behavior of
969       the attic and changelog with dokuwiki and external edits
970       after any changes. External edits change the wiki page
971       directly without using php or dokuwiki.
972     */
973    global $conf;
974    global $lang;
975    global $REV;
976    // ignore if no changes were made
977    if($text == rawWiki($id,'')){
978        return;
979    }
980
981    $file = wikiFN($id);
982    $old = @filemtime($file); // from page
983    $wasRemoved = (trim($text) == ''); // check for empty or whitespace only
984    $wasCreated = !@file_exists($file);
985    $wasReverted = ($REV==true);
986    $newRev = false;
987    $oldRev = getRevisions($id, -1, 1, 1024); // from changelog
988    $oldRev = (int)(empty($oldRev)?0:$oldRev[0]);
989    if(!@file_exists(wikiFN($id, $old)) && @file_exists($file) && $old>=$oldRev) {
990        // add old revision to the attic if missing
991        saveOldRevision($id);
992        // add a changelog entry if this edit came from outside dokuwiki
993        if ($old>$oldRev) {
994            addLogEntry($old, $id, DOKU_CHANGE_TYPE_EDIT, $lang['external_edit'], '', array('ExternalEdit'=>true));
995            // remove soon to be stale instructions
996            $cache = new cache_instructions($id, $file);
997            $cache->removeCache();
998        }
999    }
1000
1001    if ($wasRemoved){
1002        // Send "update" event with empty data, so plugins can react to page deletion
1003        $data = array(array($file, '', false), getNS($id), noNS($id), false);
1004        trigger_event('IO_WIKIPAGE_WRITE', $data);
1005        // pre-save deleted revision
1006        @touch($file);
1007        clearstatcache();
1008        $newRev = saveOldRevision($id);
1009        // remove empty file
1010        @unlink($file);
1011        // don't remove old meta info as it should be saved, plugins can use IO_WIKIPAGE_WRITE for removing their metadata...
1012        // purge non-persistant meta data
1013        p_purge_metadata($id);
1014        $del = true;
1015        // autoset summary on deletion
1016        if(empty($summary)) $summary = $lang['deleted'];
1017        // remove empty namespaces
1018        io_sweepNS($id, 'datadir');
1019        io_sweepNS($id, 'mediadir');
1020    }else{
1021        // save file (namespace dir is created in io_writeWikiPage)
1022        io_writeWikiPage($file, $text, $id);
1023        // pre-save the revision, to keep the attic in sync
1024        $newRev = saveOldRevision($id);
1025        $del = false;
1026    }
1027
1028    // select changelog line type
1029    $extra = '';
1030    $type = DOKU_CHANGE_TYPE_EDIT;
1031    if ($wasReverted) {
1032        $type = DOKU_CHANGE_TYPE_REVERT;
1033        $extra = $REV;
1034    }
1035    else if ($wasCreated) { $type = DOKU_CHANGE_TYPE_CREATE; }
1036    else if ($wasRemoved) { $type = DOKU_CHANGE_TYPE_DELETE; }
1037    else if ($minor && $conf['useacl'] && $_SERVER['REMOTE_USER']) { $type = DOKU_CHANGE_TYPE_MINOR_EDIT; } //minor edits only for logged in users
1038
1039    addLogEntry($newRev, $id, $type, $summary, $extra);
1040    // send notify mails
1041    notify($id,'admin',$old,$summary,$minor);
1042    notify($id,'subscribers',$old,$summary,$minor);
1043
1044    // update the purgefile (timestamp of the last time anything within the wiki was changed)
1045    io_saveFile($conf['cachedir'].'/purgefile',time());
1046
1047    // if useheading is enabled, purge the cache of all linking pages
1048    if(useHeading('content')){
1049        $pages = ft_backlinks($id);
1050        foreach ($pages as $page) {
1051            $cache = new cache_renderer($page, wikiFN($page), 'xhtml');
1052            $cache->removeCache();
1053        }
1054    }
1055}
1056
1057/**
1058 * moves the current version to the attic and returns its
1059 * revision date
1060 *
1061 * @author Andreas Gohr <andi@splitbrain.org>
1062 */
1063function saveOldRevision($id){
1064    global $conf;
1065    $oldf = wikiFN($id);
1066    if(!@file_exists($oldf)) return '';
1067    $date = filemtime($oldf);
1068    $newf = wikiFN($id,$date);
1069    io_writeWikiPage($newf, rawWiki($id), $id, $date);
1070    return $date;
1071}
1072
1073/**
1074 * Sends a notify mail on page change or registration
1075 *
1076 * @param  string  $id       The changed page
1077 * @param  string  $who      Who to notify (admin|subscribers|register)
1078 * @param  int     $rev      Old page revision
1079 * @param  string  $summary  What changed
1080 * @param  boolean $minor    Is this a minor edit?
1081 * @param  array   $replace  Additional string substitutions, @KEY@ to be replaced by value
1082 *
1083 * @author Andreas Gohr <andi@splitbrain.org>
1084 */
1085function notify($id,$who,$rev='',$summary='',$minor=false,$replace=array()){
1086    global $lang;
1087    global $conf;
1088    global $INFO;
1089
1090    // decide if there is something to do, eg. whom to mail
1091    if($who == 'admin'){
1092        if(empty($conf['notify'])) return; //notify enabled?
1093        $text = rawLocale('mailtext');
1094        $to   = $conf['notify'];
1095        $bcc  = '';
1096    }elseif($who == 'subscribers'){
1097        if(!$conf['subscribers']) return; //subscribers enabled?
1098        if($conf['useacl'] && $_SERVER['REMOTE_USER'] && $minor) return; //skip minors
1099        $data = array('id' => $id, 'addresslist' => '', 'self' => false);
1100        trigger_event('COMMON_NOTIFY_ADDRESSLIST', $data,
1101                      'subscription_addresslist');
1102        $bcc = $data['addresslist'];
1103        if(empty($bcc)) return;
1104        $to   = '';
1105        $text = rawLocale('subscr_single');
1106    }elseif($who == 'register'){
1107        if(empty($conf['registernotify'])) return;
1108        $text = rawLocale('registermail');
1109        $to   = $conf['registernotify'];
1110        $bcc  = '';
1111    }else{
1112        return; //just to be safe
1113    }
1114
1115    // prepare replacements (keys not set in hrep will be taken from trep)
1116    $trep = array(
1117        'NEWPAGE' => wl($id,'',true,'&'),
1118        'PAGE'    => $id,
1119        'SUMMARY' => $summary
1120    );
1121    $trep = array_merge($trep,$replace);
1122    $hrep = array();
1123
1124    // prepare content
1125    if($who == 'register'){
1126        $subject         = $lang['mail_new_user'].' '.$summary;
1127    }elseif($rev){
1128        $subject         = $lang['mail_changed'].' '.$id;
1129        $trep['OLDPAGE'] = wl($id,"rev=$rev",true,'&');
1130        $df              = new Diff(explode("\n",rawWiki($id,$rev)),
1131                                    explode("\n",rawWiki($id)));
1132        $dformat         = new UnifiedDiffFormatter();
1133        $tdiff           = $dformat->format($df);
1134        $dformat         = new InlineDiffFormatter();
1135        $hdiff           = $dformat->format($df);
1136    }else{
1137        $subject         = $lang['mail_newpage'].' '.$id;
1138        $trep['OLDPAGE'] = '---';
1139        $tdiff           = rawWiki($id);
1140        $hdiff           = nl2br(hsc($tdiff));
1141    }
1142    $trep['DIFF'] = $tdiff;
1143    $hrep['DIFF'] = $hdiff;
1144
1145    // send mail
1146    $mail = new Mailer();
1147    $mail->to($to);
1148    $mail->bcc($bcc);
1149    $mail->subject($subject);
1150    $mail->setBody($text,$trep,$hrep);
1151    return $mail->send();
1152}
1153
1154/**
1155 * extracts the query from a search engine referrer
1156 *
1157 * @author Andreas Gohr <andi@splitbrain.org>
1158 * @author Todd Augsburger <todd@rollerorgans.com>
1159 */
1160function getGoogleQuery(){
1161    if (!isset($_SERVER['HTTP_REFERER'])) {
1162        return '';
1163    }
1164    $url = parse_url($_SERVER['HTTP_REFERER']);
1165
1166    $query = array();
1167
1168    // temporary workaround against PHP bug #49733
1169    // see http://bugs.php.net/bug.php?id=49733
1170    if(UTF8_MBSTRING) $enc = mb_internal_encoding();
1171    parse_str($url['query'],$query);
1172    if(UTF8_MBSTRING) mb_internal_encoding($enc);
1173
1174    $q = '';
1175    if(isset($query['q']))
1176        $q = $query['q'];        // google, live/msn, aol, ask, altavista, alltheweb, gigablast
1177    elseif(isset($query['p']))
1178        $q = $query['p'];        // yahoo
1179    elseif(isset($query['query']))
1180        $q = $query['query'];    // lycos, netscape, clusty, hotbot
1181    elseif(preg_match("#a9\.com#i",$url['host'])) // a9
1182        $q = urldecode(ltrim($url['path'],'/'));
1183
1184    if($q === '') return '';
1185    $q = preg_split('/[\s\'"\\\\`()\]\[?:!\.{};,#+*<>\\/]+/',$q,-1,PREG_SPLIT_NO_EMPTY);
1186    return $q;
1187}
1188
1189/**
1190 * Try to set correct locale
1191 *
1192 * @deprecated No longer used
1193 * @author     Andreas Gohr <andi@splitbrain.org>
1194 */
1195function setCorrectLocale(){
1196    global $conf;
1197    global $lang;
1198
1199    $enc = strtoupper($lang['encoding']);
1200    foreach ($lang['locales'] as $loc){
1201        //try locale
1202        if(@setlocale(LC_ALL,$loc)) return;
1203        //try loceale with encoding
1204        if(@setlocale(LC_ALL,"$loc.$enc")) return;
1205    }
1206    //still here? try to set from environment
1207    @setlocale(LC_ALL,"");
1208}
1209
1210/**
1211 * Return the human readable size of a file
1212 *
1213 * @param       int    $size   A file size
1214 * @param       int    $dec    A number of decimal places
1215 * @author      Martin Benjamin <b.martin@cybernet.ch>
1216 * @author      Aidan Lister <aidan@php.net>
1217 * @version     1.0.0
1218 */
1219function filesize_h($size, $dec = 1){
1220    $sizes = array('B', 'KB', 'MB', 'GB');
1221    $count = count($sizes);
1222    $i = 0;
1223
1224    while ($size >= 1024 && ($i < $count - 1)) {
1225        $size /= 1024;
1226        $i++;
1227    }
1228
1229    return round($size, $dec) . ' ' . $sizes[$i];
1230}
1231
1232/**
1233 * Return the given timestamp as human readable, fuzzy age
1234 *
1235 * @author Andreas Gohr <gohr@cosmocode.de>
1236 */
1237function datetime_h($dt){
1238    global $lang;
1239
1240    $ago = time() - $dt;
1241    if($ago > 24*60*60*30*12*2){
1242        return sprintf($lang['years'], round($ago/(24*60*60*30*12)));
1243    }
1244    if($ago > 24*60*60*30*2){
1245        return sprintf($lang['months'], round($ago/(24*60*60*30)));
1246    }
1247    if($ago > 24*60*60*7*2){
1248        return sprintf($lang['weeks'], round($ago/(24*60*60*7)));
1249    }
1250    if($ago > 24*60*60*2){
1251        return sprintf($lang['days'], round($ago/(24*60*60)));
1252    }
1253    if($ago > 60*60*2){
1254        return sprintf($lang['hours'], round($ago/(60*60)));
1255    }
1256    if($ago > 60*2){
1257        return sprintf($lang['minutes'], round($ago/(60)));
1258    }
1259    return sprintf($lang['seconds'], $ago);
1260}
1261
1262/**
1263 * Wraps around strftime but provides support for fuzzy dates
1264 *
1265 * The format default to $conf['dformat']. It is passed to
1266 * strftime - %f can be used to get the value from datetime_h()
1267 *
1268 * @see datetime_h
1269 * @author Andreas Gohr <gohr@cosmocode.de>
1270 */
1271function dformat($dt=null,$format=''){
1272    global $conf;
1273
1274    if(is_null($dt)) $dt = time();
1275    $dt = (int) $dt;
1276    if(!$format) $format = $conf['dformat'];
1277
1278    $format = str_replace('%f',datetime_h($dt),$format);
1279    return strftime($format,$dt);
1280}
1281
1282/**
1283 * Formats a timestamp as ISO 8601 date
1284 *
1285 * @author <ungu at terong dot com>
1286 * @link http://www.php.net/manual/en/function.date.php#54072
1287 */
1288function date_iso8601($int_date) {
1289   //$int_date: current date in UNIX timestamp
1290   $date_mod = date('Y-m-d\TH:i:s', $int_date);
1291   $pre_timezone = date('O', $int_date);
1292   $time_zone = substr($pre_timezone, 0, 3).":".substr($pre_timezone, 3, 2);
1293   $date_mod .= $time_zone;
1294   return $date_mod;
1295}
1296
1297/**
1298 * return an obfuscated email address in line with $conf['mailguard'] setting
1299 *
1300 * @author Harry Fuecks <hfuecks@gmail.com>
1301 * @author Christopher Smith <chris@jalakai.co.uk>
1302 */
1303function obfuscate($email) {
1304    global $conf;
1305
1306    switch ($conf['mailguard']) {
1307        case 'visible' :
1308            $obfuscate = array('@' => ' [at] ', '.' => ' [dot] ', '-' => ' [dash] ');
1309            return strtr($email, $obfuscate);
1310
1311        case 'hex' :
1312            $encode = '';
1313            $len = strlen($email);
1314            for ($x=0; $x < $len; $x++){
1315                $encode .= '&#x' . bin2hex($email{$x}).';';
1316            }
1317            return $encode;
1318
1319        case 'none' :
1320        default :
1321            return $email;
1322    }
1323}
1324
1325/**
1326 * Removes quoting backslashes
1327 *
1328 * @author Andreas Gohr <andi@splitbrain.org>
1329 */
1330function unslash($string,$char="'"){
1331    return str_replace('\\'.$char,$char,$string);
1332}
1333
1334/**
1335 * Convert php.ini shorthands to byte
1336 *
1337 * @author <gilthans dot NO dot SPAM at gmail dot com>
1338 * @link   http://de3.php.net/manual/en/ini.core.php#79564
1339 */
1340function php_to_byte($v){
1341    $l = substr($v, -1);
1342    $ret = substr($v, 0, -1);
1343    switch(strtoupper($l)){
1344        case 'P':
1345            $ret *= 1024;
1346        case 'T':
1347            $ret *= 1024;
1348        case 'G':
1349            $ret *= 1024;
1350        case 'M':
1351            $ret *= 1024;
1352        case 'K':
1353            $ret *= 1024;
1354        break;
1355        default;
1356            $ret *= 10;
1357        break;
1358    }
1359    return $ret;
1360}
1361
1362/**
1363 * Wrapper around preg_quote adding the default delimiter
1364 */
1365function preg_quote_cb($string){
1366    return preg_quote($string,'/');
1367}
1368
1369/**
1370 * Shorten a given string by removing data from the middle
1371 *
1372 * You can give the string in two parts, the first part $keep
1373 * will never be shortened. The second part $short will be cut
1374 * in the middle to shorten but only if at least $min chars are
1375 * left to display it. Otherwise it will be left off.
1376 *
1377 * @param string $keep   the part to keep
1378 * @param string $short  the part to shorten
1379 * @param int    $max    maximum chars you want for the whole string
1380 * @param int    $min    minimum number of chars to have left for middle shortening
1381 * @param string $char   the shortening character to use
1382 */
1383function shorten($keep,$short,$max,$min=9,$char='…'){
1384    $max = $max - utf8_strlen($keep);
1385    if($max < $min) return $keep;
1386    $len = utf8_strlen($short);
1387    if($len <= $max) return $keep.$short;
1388    $half = floor($max/2);
1389    return $keep.utf8_substr($short,0,$half-1).$char.utf8_substr($short,$len-$half);
1390}
1391
1392/**
1393 * Return the users realname or e-mail address for use
1394 * in page footer and recent changes pages
1395 *
1396 * @author Andy Webber <dokuwiki AT andywebber DOT com>
1397 */
1398function editorinfo($username){
1399    global $conf;
1400    global $auth;
1401
1402    switch($conf['showuseras']){
1403        case 'username':
1404        case 'email':
1405        case 'email_link':
1406            if($auth) $info = $auth->getUserData($username);
1407            break;
1408        default:
1409            return hsc($username);
1410    }
1411
1412    if(isset($info) && $info) {
1413        switch($conf['showuseras']){
1414            case 'username':
1415                return hsc($info['name']);
1416            case 'email':
1417                return obfuscate($info['mail']);
1418            case 'email_link':
1419                $mail=obfuscate($info['mail']);
1420                return '<a href="mailto:'.$mail.'">'.$mail.'</a>';
1421            default:
1422                return hsc($username);
1423        }
1424    } else {
1425        return hsc($username);
1426    }
1427}
1428
1429/**
1430 * Returns the path to a image file for the currently chosen license.
1431 * When no image exists, returns an empty string
1432 *
1433 * @author Andreas Gohr <andi@splitbrain.org>
1434 * @param  string $type - type of image 'badge' or 'button'
1435 */
1436function license_img($type){
1437    global $license;
1438    global $conf;
1439    if(!$conf['license']) return '';
1440    if(!is_array($license[$conf['license']])) return '';
1441    $lic = $license[$conf['license']];
1442    $try = array();
1443    $try[] = 'lib/images/license/'.$type.'/'.$conf['license'].'.png';
1444    $try[] = 'lib/images/license/'.$type.'/'.$conf['license'].'.gif';
1445    if(substr($conf['license'],0,3) == 'cc-'){
1446        $try[] = 'lib/images/license/'.$type.'/cc.png';
1447    }
1448    foreach($try as $src){
1449        if(@file_exists(DOKU_INC.$src)) return $src;
1450    }
1451    return '';
1452}
1453
1454/**
1455 * Checks if the given amount of memory is available
1456 *
1457 * If the memory_get_usage() function is not available the
1458 * function just assumes $bytes of already allocated memory
1459 *
1460 * @param  int $mem  Size of memory you want to allocate in bytes
1461 * @param  int $used already allocated memory (see above)
1462 * @author Filip Oscadal <webmaster@illusionsoftworks.cz>
1463 * @author Andreas Gohr <andi@splitbrain.org>
1464 */
1465function is_mem_available($mem,$bytes=1048576){
1466    $limit = trim(ini_get('memory_limit'));
1467    if(empty($limit)) return true; // no limit set!
1468
1469    // parse limit to bytes
1470    $limit = php_to_byte($limit);
1471
1472    // get used memory if possible
1473    if(function_exists('memory_get_usage')){
1474        $used = memory_get_usage();
1475    }else{
1476        $used = $bytes;
1477    }
1478
1479    if($used+$mem > $limit){
1480        return false;
1481    }
1482
1483    return true;
1484}
1485
1486/**
1487 * Send a HTTP redirect to the browser
1488 *
1489 * Works arround Microsoft IIS cookie sending bug. Exits the script.
1490 *
1491 * @link   http://support.microsoft.com/kb/q176113/
1492 * @author Andreas Gohr <andi@splitbrain.org>
1493 */
1494function send_redirect($url){
1495    //are there any undisplayed messages? keep them in session for display
1496    global $MSG;
1497    if (isset($MSG) && count($MSG) && !defined('NOSESSION')){
1498        //reopen session, store data and close session again
1499        @session_start();
1500        $_SESSION[DOKU_COOKIE]['msg'] = $MSG;
1501    }
1502
1503    // always close the session
1504    session_write_close();
1505
1506    // work around IE bug
1507    // http://www.ianhoar.com/2008/11/16/internet-explorer-6-and-redirected-anchor-links/
1508    list($url,$hash) = explode('#',$url);
1509    if($hash){
1510        if(strpos($url,'?')){
1511            $url = $url.'&#'.$hash;
1512        }else{
1513            $url = $url.'?&#'.$hash;
1514        }
1515    }
1516
1517    // check if running on IIS < 6 with CGI-PHP
1518    if( isset($_SERVER['SERVER_SOFTWARE']) && isset($_SERVER['GATEWAY_INTERFACE']) &&
1519        (strpos($_SERVER['GATEWAY_INTERFACE'],'CGI') !== false) &&
1520        (preg_match('|^Microsoft-IIS/(\d)\.\d$|', trim($_SERVER['SERVER_SOFTWARE']), $matches)) &&
1521        $matches[1] < 6 ){
1522        header('Refresh: 0;url='.$url);
1523    }else{
1524        header('Location: '.$url);
1525    }
1526    exit;
1527}
1528
1529/**
1530 * Validate a value using a set of valid values
1531 *
1532 * This function checks whether a specified value is set and in the array
1533 * $valid_values. If not, the function returns a default value or, if no
1534 * default is specified, throws an exception.
1535 *
1536 * @param string $param        The name of the parameter
1537 * @param array  $valid_values A set of valid values; Optionally a default may
1538 *                             be marked by the key “default”.
1539 * @param array  $array        The array containing the value (typically $_POST
1540 *                             or $_GET)
1541 * @param string $exc          The text of the raised exception
1542 *
1543 * @author Adrian Lang <lang@cosmocode.de>
1544 */
1545function valid_input_set($param, $valid_values, $array, $exc = '') {
1546    if (isset($array[$param]) && in_array($array[$param], $valid_values)) {
1547        return $array[$param];
1548    } elseif (isset($valid_values['default'])) {
1549        return $valid_values['default'];
1550    } else {
1551        throw new Exception($exc);
1552    }
1553}
1554
1555function get_doku_pref($pref, $default) {
1556    if (strpos($_COOKIE['DOKU_PREFS'], $pref) !== false) {
1557        $parts = explode('#', $_COOKIE['DOKU_PREFS']);
1558        for ($i = 0; $i < count($parts); $i+=2){
1559            if ($parts[$i] == $pref) {
1560                return $parts[$i+1];
1561            }
1562        }
1563    }
1564    return $default;
1565}
1566
1567//Setup VIM: ex: et ts=2 :
1568