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