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