1ed7b5f09Sandi<?php 215fae107Sandi/** 315fae107Sandi * Common DokuWiki functions 415fae107Sandi * 515fae107Sandi * @license GPL 2 (http://www.gnu.org/licenses/gpl.html) 615fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 715fae107Sandi */ 815fae107Sandi 9ed7b5f09Sandi if(!defined('DOKU_INC')) define('DOKU_INC',realpath(dirname(__FILE__).'/../').'/'); 10ed7b5f09Sandi require_once(DOKU_INC.'conf/dokuwiki.php'); 11ed7b5f09Sandi require_once(DOKU_INC.'inc/io.php'); 12ed7b5f09Sandi require_once(DOKU_INC.'inc/utf8.php'); 13ed7b5f09Sandi require_once(DOKU_INC.'inc/mail.php'); 14c112d578Sandi require_once(DOKU_INC.'inc/parserutils.php'); 15f3f0262cSandi 16f3f0262cSandi/** 1715fae107Sandi * Return info about the current document as associative 18f3f0262cSandi * array. 1915fae107Sandi * 2015fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 21f3f0262cSandi */ 22f3f0262cSandifunction pageinfo(){ 23f3f0262cSandi global $ID; 24f3f0262cSandi global $REV; 25f3f0262cSandi global $USERINFO; 26f3f0262cSandi global $conf; 27f3f0262cSandi 28f3f0262cSandi if($_SERVER['REMOTE_USER']){ 29f3f0262cSandi $info['user'] = $_SERVER['REMOTE_USER']; 30f3f0262cSandi $info['userinfo'] = $USERINFO; 31f3f0262cSandi $info['perm'] = auth_quickaclcheck($ID); 32f3f0262cSandi }else{ 33f3f0262cSandi $info['user'] = ''; 34f3f0262cSandi $info['perm'] = auth_aclcheck($ID,'',null); 35f3f0262cSandi } 36f3f0262cSandi 37f3f0262cSandi $info['namespace'] = getNS($ID); 38f3f0262cSandi $info['locked'] = checklock($ID); 39f3f0262cSandi $info['filepath'] = realpath(wikiFN($ID,$REV)); 40f3f0262cSandi $info['exists'] = @file_exists($info['filepath']); 41f3f0262cSandi if($REV && !$info['exists']){ 42f3f0262cSandi //check if current revision was meant 43f3f0262cSandi $cur = wikiFN($ID); 44f3f0262cSandi if(@file_exists($cur) && (@filemtime($cur) == $REV)){ 45f3f0262cSandi $info['filepath'] = realpath($cur); 46f3f0262cSandi $info['exists'] = true; 47f3f0262cSandi $REV = ''; 48f3f0262cSandi } 49f3f0262cSandi } 50c112d578Sandi $info['rev'] = $REV; 51f3f0262cSandi if($info['exists']){ 52f3f0262cSandi $info['writable'] = (is_writable($info['filepath']) && 53f3f0262cSandi ($info['perm'] >= AUTH_EDIT)); 54f3f0262cSandi }else{ 55f3f0262cSandi $info['writable'] = ($info['perm'] >= AUTH_CREATE); 56f3f0262cSandi } 57f3f0262cSandi $info['editable'] = ($info['writable'] && empty($info['lock'])); 58f3f0262cSandi $info['lastmod'] = @filemtime($info['filepath']); 59f3f0262cSandi 60652610a2Sandi //who's the editor 61652610a2Sandi if($REV){ 62652610a2Sandi $revinfo = getRevisionInfo($ID,$REV); 63652610a2Sandi }else{ 64652610a2Sandi $revinfo = getRevisionInfo($ID,$info['lastmod']); 65652610a2Sandi } 66652610a2Sandi $info['ip'] = $revinfo['ip']; 67652610a2Sandi $info['user'] = $revinfo['user']; 68652610a2Sandi $info['sum'] = $revinfo['sum']; 69652610a2Sandi $info['editor'] = $revinfo['ip']; 7088f522e9Sandi if($revinfo['user']){ 7188f522e9Sandi $info['editor'] = $revinfo['user']; 7288f522e9Sandi }else{ 7388f522e9Sandi $info['editor'] = $revinfo['ip']; 7488f522e9Sandi } 75652610a2Sandi 76f3f0262cSandi return $info; 77f3f0262cSandi} 78f3f0262cSandi 79f3f0262cSandi/** 80*2684e50aSAndreas Gohr * Build an string of URL parameters 81*2684e50aSAndreas Gohr * 82*2684e50aSAndreas Gohr * @author Andreas Gohr 83*2684e50aSAndreas Gohr */ 84*2684e50aSAndreas Gohrfunction buildURLparams($params){ 85*2684e50aSAndreas Gohr $url = ''; 86*2684e50aSAndreas Gohr $amp = false; 87*2684e50aSAndreas Gohr foreach($params as $key => $val){ 88*2684e50aSAndreas Gohr if($amp) $url .= '&'; 89*2684e50aSAndreas Gohr 90*2684e50aSAndreas Gohr $url .= $key.'='; 91*2684e50aSAndreas Gohr $url .= urlencode($val); 92*2684e50aSAndreas Gohr $amp = true; 93*2684e50aSAndreas Gohr } 94*2684e50aSAndreas Gohr return $url; 95*2684e50aSAndreas Gohr} 96*2684e50aSAndreas Gohr 97*2684e50aSAndreas Gohr/** 98*2684e50aSAndreas Gohr * Build an string of html tag attributes 99*2684e50aSAndreas Gohr * 100*2684e50aSAndreas Gohr * @author Andreas Gohr 101*2684e50aSAndreas Gohr */ 102*2684e50aSAndreas Gohrfunction buildAttributes($params){ 103*2684e50aSAndreas Gohr $url = ''; 104*2684e50aSAndreas Gohr foreach($params as $key => $val){ 105*2684e50aSAndreas Gohr $url .= $key.'="'; 106*2684e50aSAndreas Gohr $url .= htmlspecialchars ($val); 107*2684e50aSAndreas Gohr $url .= '" '; 108*2684e50aSAndreas Gohr } 109*2684e50aSAndreas Gohr return $url; 110*2684e50aSAndreas Gohr} 111*2684e50aSAndreas Gohr 112*2684e50aSAndreas Gohr 113*2684e50aSAndreas Gohr/** 1140396becbSandi * print a message 1150396becbSandi * 1160396becbSandi * If HTTP headers were not sent yet the message is added 1170396becbSandi * to the global message array else it's printed directly 1180396becbSandi * using html_msgarea() 1190396becbSandi * 120f3f0262cSandi * 121f3f0262cSandi * Levels can be: 122f3f0262cSandi * 123f3f0262cSandi * -1 error 124f3f0262cSandi * 0 info 125f3f0262cSandi * 1 success 12615fae107Sandi * 12715fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 1280396becbSandi * @see html_msgarea 129f3f0262cSandi */ 130f3f0262cSandifunction msg($message,$lvl=0){ 131f3f0262cSandi global $MSG; 132f3f0262cSandi $errors[-1] = 'error'; 133f3f0262cSandi $errors[0] = 'info'; 134f3f0262cSandi $errors[1] = 'success'; 135f3f0262cSandi 136cc20ad51Sandi if(!headers_sent()){ 137f3f0262cSandi if(!isset($MSG)) $MSG = array(); 138f3f0262cSandi $MSG[]=array('lvl' => $errors[$lvl], 'msg' => $message); 1390396becbSandi }else{ 1400396becbSandi $MSG = array(); 1410396becbSandi $MSG[]=array('lvl' => $errors[$lvl], 'msg' => $message); 142f62ea8a1Sandi if(function_exists('html_msgarea')){ 1430396becbSandi html_msgarea(); 144f62ea8a1Sandi }else{ 145f62ea8a1Sandi print "ERROR($lvl) $message"; 146f62ea8a1Sandi } 1470396becbSandi } 148f3f0262cSandi} 149f3f0262cSandi 150f3f0262cSandi/** 15115fae107Sandi * This builds the breadcrumb trail and returns it as array 15215fae107Sandi * 15315fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 154f3f0262cSandi */ 155f3f0262cSandifunction breadcrumbs(){ 1568746e727Sandi // we prepare the breadcrumbs early for quick session closing 1578746e727Sandi static $crumbs = null; 1588746e727Sandi if($crumbs != null) return $crumbs; 1598746e727Sandi 160f3f0262cSandi global $ID; 161f3f0262cSandi global $ACT; 162f3f0262cSandi global $conf; 163f3f0262cSandi $crumbs = $_SESSION[$conf['title']]['bc']; 164f3f0262cSandi 165f3f0262cSandi //first visit? 166f3f0262cSandi if (!is_array($crumbs)){ 167f3f0262cSandi $crumbs = array(); 168f3f0262cSandi } 169f3f0262cSandi //we only save on show and existing wiki documents 170a77f5846Sjan $file = wikiFN($ID); 171a77f5846Sjan if($ACT != 'show' || !@file_exists($file)){ 172f3f0262cSandi $_SESSION[$conf['title']]['bc'] = $crumbs; 173f3f0262cSandi return $crumbs; 174f3f0262cSandi } 175a77f5846Sjan 176a77f5846Sjan // page names 177a77f5846Sjan $name = noNS($ID); 178a77f5846Sjan if ($conf['useheading']) { 179a77f5846Sjan // get page title 180bb0a59d4Sjan $title = p_get_first_heading($ID); 181a77f5846Sjan if ($title) { 182a77f5846Sjan $name = $title; 183a77f5846Sjan } 184a77f5846Sjan } 185a77f5846Sjan 186f3f0262cSandi //remove ID from array 187a77f5846Sjan if (isset($crumbs[$ID])) { 188a77f5846Sjan unset($crumbs[$ID]); 189f3f0262cSandi } 190f3f0262cSandi 191f3f0262cSandi //add to array 192a77f5846Sjan $crumbs[$ID] = $name; 193f3f0262cSandi //reduce size 194f3f0262cSandi while(count($crumbs) > $conf['breadcrumbs']){ 195f3f0262cSandi array_shift($crumbs); 196f3f0262cSandi } 197f3f0262cSandi //save to session 198f3f0262cSandi $_SESSION[$conf['title']]['bc'] = $crumbs; 199f3f0262cSandi return $crumbs; 200f3f0262cSandi} 201f3f0262cSandi 202f3f0262cSandi/** 20315fae107Sandi * Filter for page IDs 20415fae107Sandi * 205f3f0262cSandi * This is run on a ID before it is outputted somewhere 206f3f0262cSandi * currently used to replace the colon with something else 207f3f0262cSandi * on Windows systems and to have proper URL encoding 20815fae107Sandi * 20949c713a3Sandi * Urlencoding is ommitted when the second parameter is false 21049c713a3Sandi * 21115fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 212f3f0262cSandi */ 21349c713a3Sandifunction idfilter($id,$ue=true){ 214f3f0262cSandi global $conf; 215f3f0262cSandi if ($conf['useslash'] && $conf['userewrite']){ 216f3f0262cSandi $id = strtr($id,':','/'); 217f3f0262cSandi }elseif (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN' && 218f3f0262cSandi $conf['userewrite']) { 219f3f0262cSandi $id = strtr($id,':',';'); 220f3f0262cSandi } 22149c713a3Sandi if($ue){ 222f3f0262cSandi $id = urlencode($id); 223f3f0262cSandi $id = str_replace('%3A',':',$id); //keep as colon 224f3f0262cSandi $id = str_replace('%2F','/',$id); //keep as slash 22549c713a3Sandi } 226f3f0262cSandi return $id; 227f3f0262cSandi} 228f3f0262cSandi 229f3f0262cSandi/** 230ed7b5f09Sandi * This builds a link to a wikipage 23115fae107Sandi * 2326c7843b5Sandi * It handles URL rewriting and adds additional parameter if 2336c7843b5Sandi * given in $more 2346c7843b5Sandi * 23515fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 236f3f0262cSandi */ 237ed7b5f09Sandifunction wl($id='',$more='',$abs=false){ 238f3f0262cSandi global $conf; 239f3f0262cSandi $more = str_replace(',','&',$more); 240f3f0262cSandi 241f3f0262cSandi $id = idfilter($id); 242ed7b5f09Sandi if($abs){ 243ed7b5f09Sandi $xlink = DOKU_URL; 244ed7b5f09Sandi }else{ 245ed7b5f09Sandi $xlink = DOKU_BASE; 246ed7b5f09Sandi } 247f3f0262cSandi 2486c7843b5Sandi if($conf['userewrite'] == 2){ 2496c7843b5Sandi $xlink .= DOKU_SCRIPT.'/'.$id; 2506c7843b5Sandi if($more) $xlink .= '?'.$more; 2516c7843b5Sandi }elseif($conf['userewrite']){ 252f3f0262cSandi $xlink .= $id; 253f3f0262cSandi if($more) $xlink .= '?'.$more; 2546c7843b5Sandi }else{ 2556c7843b5Sandi $xlink .= DOKU_SCRIPT.'?id='.$id; 2566c7843b5Sandi if($more) $xlink .= '&'.$more; 257f3f0262cSandi } 258f3f0262cSandi 259f3f0262cSandi return $xlink; 260f3f0262cSandi} 261f3f0262cSandi 262f3f0262cSandi/** 263f3f0262cSandi * Just builds a link to a script 26415fae107Sandi * 265ed7b5f09Sandi * @todo maybe obsolete 26615fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 267f3f0262cSandi */ 268f3f0262cSandifunction script($script='doku.php'){ 269ed7b5f09Sandi# $link = getBaseURL(); 270ed7b5f09Sandi# $link .= $script; 271ed7b5f09Sandi# return $link; 272ed7b5f09Sandi return DOKU_BASE.DOKU_SCRIPT; 273f3f0262cSandi} 274f3f0262cSandi 275f3f0262cSandi/** 27615fae107Sandi * Spamcheck against wordlist 27715fae107Sandi * 278f3f0262cSandi * Checks the wikitext against a list of blocked expressions 279f3f0262cSandi * returns true if the text contains any bad words 28015fae107Sandi * 28115fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 282f3f0262cSandi */ 283f3f0262cSandifunction checkwordblock(){ 284f3f0262cSandi global $TEXT; 285f3f0262cSandi global $conf; 286f3f0262cSandi 287f3f0262cSandi if(!$conf['usewordblock']) return false; 288f3f0262cSandi 289f62ea8a1Sandi $blockfile = file(DOKU_INC.'conf/wordblock.conf'); 2903e2965d7Sandi //how many lines to read at once (to work around some PCRE limits) 2913e2965d7Sandi if(version_compare(phpversion(),'4.3.0','<')){ 2923e2965d7Sandi //old versions of PCRE define a maximum of parenthesises even if no 2933e2965d7Sandi //backreferences are used - the maximum is 99 2943e2965d7Sandi //this is very bad performancewise and may even be too high still 2953e2965d7Sandi $chunksize = 40; 2963e2965d7Sandi }else{ 297703f6fdeSandi //read file in chunks of 600 - this should work around the 2983e2965d7Sandi //MAX_PATTERN_SIZE in modern PCRE 2993e2965d7Sandi $chunksize = 600; 3003e2965d7Sandi } 3013e2965d7Sandi while($blocks = array_splice($blockfile,0,$chunksize)){ 302f3f0262cSandi $re = array(); 303f3f0262cSandi #build regexp from blocks 304f3f0262cSandi foreach($blocks as $block){ 305f3f0262cSandi $block = preg_replace('/#.*$/','',$block); 306f3f0262cSandi $block = trim($block); 307f3f0262cSandi if(empty($block)) continue; 308f3f0262cSandi $re[] = $block; 309f3f0262cSandi } 310f3f0262cSandi if(preg_match('#('.join('|',$re).')#si',$TEXT)) return true; 311703f6fdeSandi } 312f3f0262cSandi return false; 313f3f0262cSandi} 314f3f0262cSandi 315f3f0262cSandi/** 31615fae107Sandi * Return the IP of the client 31715fae107Sandi * 31815fae107Sandi * Honours X-Forwarded-For Proxy Headers 31915fae107Sandi * 32015fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 321f3f0262cSandi */ 322f3f0262cSandifunction clientIP(){ 323f3f0262cSandi $my = $_SERVER['REMOTE_ADDR']; 324f3f0262cSandi if($_SERVER['HTTP_X_FORWARDED_FOR']){ 325f3f0262cSandi $my .= ' ('.$_SERVER['HTTP_X_FORWARDED_FOR'].')'; 326f3f0262cSandi } 327f3f0262cSandi return $my; 328f3f0262cSandi} 329f3f0262cSandi 330f3f0262cSandi/** 33115fae107Sandi * Checks if a given page is currently locked. 33215fae107Sandi * 333f3f0262cSandi * removes stale lockfiles 33415fae107Sandi * 33515fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 336f3f0262cSandi */ 337f3f0262cSandifunction checklock($id){ 338f3f0262cSandi global $conf; 339f3f0262cSandi $lock = wikiFN($id).'.lock'; 340f3f0262cSandi 341f3f0262cSandi //no lockfile 342f3f0262cSandi if(!@file_exists($lock)) return false; 343f3f0262cSandi 344f3f0262cSandi //lockfile expired 345f3f0262cSandi if((time() - filemtime($lock)) > $conf['locktime']){ 346f3f0262cSandi unlink($lock); 347f3f0262cSandi return false; 348f3f0262cSandi } 349f3f0262cSandi 350f3f0262cSandi //my own lock 351f3f0262cSandi $ip = io_readFile($lock); 352f3f0262cSandi if( ($ip == clientIP()) || ($ip == $_SERVER['REMOTE_USER']) ){ 353f3f0262cSandi return false; 354f3f0262cSandi } 355f3f0262cSandi 356f3f0262cSandi return $ip; 357f3f0262cSandi} 358f3f0262cSandi 359f3f0262cSandi/** 36015fae107Sandi * Lock a page for editing 36115fae107Sandi * 36215fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 363f3f0262cSandi */ 364f3f0262cSandifunction lock($id){ 365f3f0262cSandi $lock = wikiFN($id).'.lock'; 366f3f0262cSandi if($_SERVER['REMOTE_USER']){ 367f3f0262cSandi io_saveFile($lock,$_SERVER['REMOTE_USER']); 368f3f0262cSandi }else{ 369f3f0262cSandi io_saveFile($lock,clientIP()); 370f3f0262cSandi } 371f3f0262cSandi} 372f3f0262cSandi 373f3f0262cSandi/** 37415fae107Sandi * Unlock a page if it was locked by the user 375f3f0262cSandi * 37615fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 37715fae107Sandi * @return bool true if a lock was removed 378f3f0262cSandi */ 379f3f0262cSandifunction unlock($id){ 380f3f0262cSandi $lock = wikiFN($id).'.lock'; 381f3f0262cSandi if(@file_exists($lock)){ 382f3f0262cSandi $ip = io_readFile($lock); 383f3f0262cSandi if( ($ip == clientIP()) || ($ip == $_SERVER['REMOTE_USER']) ){ 384f3f0262cSandi @unlink($lock); 385f3f0262cSandi return true; 386f3f0262cSandi } 387f3f0262cSandi } 388f3f0262cSandi return false; 389f3f0262cSandi} 390f3f0262cSandi 391f3f0262cSandi/** 392f3f0262cSandi * convert line ending to unix format 393f3f0262cSandi * 39415fae107Sandi * @see formText() for 2crlf conversion 39515fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 396f3f0262cSandi */ 397f3f0262cSandifunction cleanText($text){ 398f3f0262cSandi $text = preg_replace("/(\015\012)|(\015)/","\012",$text); 399f3f0262cSandi return $text; 400f3f0262cSandi} 401f3f0262cSandi 402f3f0262cSandi/** 403f3f0262cSandi * Prepares text for print in Webforms by encoding special chars. 404f3f0262cSandi * It also converts line endings to Windows format which is 405f3f0262cSandi * pseudo standard for webforms. 406f3f0262cSandi * 40715fae107Sandi * @see cleanText() for 2unix conversion 40815fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 409f3f0262cSandi */ 410f3f0262cSandifunction formText($text){ 411f3f0262cSandi $text = preg_replace("/\012/","\015\012",$text); 412f3f0262cSandi return htmlspecialchars($text); 413f3f0262cSandi} 414f3f0262cSandi 415f3f0262cSandi/** 41615fae107Sandi * Returns the specified local text in raw format 41715fae107Sandi * 41815fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 419f3f0262cSandi */ 420f3f0262cSandifunction rawLocale($id){ 421f3f0262cSandi return io_readFile(localeFN($id)); 422f3f0262cSandi} 423f3f0262cSandi 424f3f0262cSandi/** 425f3f0262cSandi * Returns the raw WikiText 42615fae107Sandi * 42715fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 428f3f0262cSandi */ 429f3f0262cSandifunction rawWiki($id,$rev=''){ 430f3f0262cSandi return io_readFile(wikiFN($id,$rev)); 431f3f0262cSandi} 432f3f0262cSandi 433f3f0262cSandi/** 4347146cee2SAndreas Gohr * Returns the pagetemplate contents for the ID's namespace 4357146cee2SAndreas Gohr * 4367146cee2SAndreas Gohr * @author Andreas Gohr <andi@splitbrain.org> 4377146cee2SAndreas Gohr */ 4387146cee2SAndreas Gohrfunction pageTemplate($id){ 4397146cee2SAndreas Gohr return io_readFile(dirname(wikiFN($id)).'/_template.txt'); 4407146cee2SAndreas Gohr} 4417146cee2SAndreas Gohr 4427146cee2SAndreas Gohr 4437146cee2SAndreas Gohr/** 44415fae107Sandi * Returns the raw Wiki Text in three slices. 44515fae107Sandi * 44615fae107Sandi * The range parameter needs to have the form "from-to" 44715cfe303Sandi * and gives the range of the section in bytes - no 44815cfe303Sandi * UTF-8 awareness is needed. 449f3f0262cSandi * The returned order is prefix, section and suffix. 45015fae107Sandi * 45115fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 452f3f0262cSandi */ 453f3f0262cSandifunction rawWikiSlices($range,$id,$rev=''){ 454f3f0262cSandi list($from,$to) = split('-',$range,2); 455f3f0262cSandi $text = io_readFile(wikiFN($id,$rev)); 456f3f0262cSandi if(!$from) $from = 0; 457c3d8e19bSandi if(!$to) $to = strlen($text)+1; 458f3f0262cSandi 45915cfe303Sandi $slices[0] = substr($text,0,$from-1); 46015cfe303Sandi $slices[1] = substr($text,$from-1,$to-$from); 46115cfe303Sandi $slices[2] = substr($text,$to); 462f3f0262cSandi 463f3f0262cSandi return $slices; 464f3f0262cSandi} 465f3f0262cSandi 466f3f0262cSandi/** 46715fae107Sandi * Joins wiki text slices 46815fae107Sandi * 469f3f0262cSandi * function to join the text slices with correct lineendings again. 470f3f0262cSandi * When the pretty parameter is set to true it adds additional empty 471f3f0262cSandi * lines between sections if needed (used on saving). 47215fae107Sandi * 47315fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 474f3f0262cSandi */ 475f3f0262cSandifunction con($pre,$text,$suf,$pretty=false){ 476f3f0262cSandi 477f3f0262cSandi if($pretty){ 478f3f0262cSandi if($pre && substr($pre,-1) != "\n") $pre .= "\n"; 479f3f0262cSandi if($suf && substr($text,-1) != "\n") $text .= "\n"; 480f3f0262cSandi } 481f3f0262cSandi 482f3f0262cSandi if($pre) $pre .= "\n"; 483f3f0262cSandi if($suf) $text .= "\n"; 484f3f0262cSandi return $pre.$text.$suf; 485f3f0262cSandi} 486f3f0262cSandi 487f3f0262cSandi/** 48815fae107Sandi * print debug messages 48915fae107Sandi * 490f3f0262cSandi * little function to print the content of a var 49115fae107Sandi * 49215fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 493f3f0262cSandi */ 494f3f0262cSandifunction dbg($msg,$hidden=false){ 495f3f0262cSandi (!$hidden) ? print '<pre class="dbg">' : print "<!--\n"; 496f3f0262cSandi print_r($msg); 497f3f0262cSandi (!$hidden) ? print '</pre>' : print "\n-->"; 498f3f0262cSandi} 499f3f0262cSandi 500f3f0262cSandi/** 501f3f0262cSandi * Add's an entry to the changelog 50215fae107Sandi * 50315fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 504f3f0262cSandi */ 505652610a2Sandifunction addLogEntry($date,$id,$summary=""){ 506f3f0262cSandi global $conf; 507c1049928Sandi $id = cleanID($id);//FIXME not needed anymore? 508c1049928Sandi 509c1049928Sandi if(!@is_writable($conf['changelog'])){ 510c1049928Sandi msg($conf['changelog'].' is not writable!',-1); 511c1049928Sandi return; 512c1049928Sandi } 513c1049928Sandi 514652610a2Sandi if(!$date) $date = time(); //use current time if none supplied 515f3f0262cSandi $remote = $_SERVER['REMOTE_ADDR']; 516f3f0262cSandi $user = $_SERVER['REMOTE_USER']; 517f3f0262cSandi 518f3f0262cSandi $logline = join("\t",array($date,$remote,$id,$user,$summary))."\n"; 519f3f0262cSandi 520c1049928Sandi //FIXME: use adjusted io_saveFile instead 521f3f0262cSandi $fh = fopen($conf['changelog'],'a'); 522f3f0262cSandi if($fh){ 523f3f0262cSandi fwrite($fh,$logline); 524f3f0262cSandi fclose($fh); 525f3f0262cSandi } 526f3f0262cSandi} 527f3f0262cSandi 528f3f0262cSandi/** 529f3f0262cSandi * returns an array of recently changed files using the 530f3f0262cSandi * changelog 5315749f1ceSmatthiasgrimm * first : first entry in array returned 532a39955b0Smatthiasgrimm * num : return 'num' entries 53315fae107Sandi * 53415fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 535f3f0262cSandi */ 5365749f1ceSmatthiasgrimmfunction getRecents($first,$num,$incdel=false){ 537f3f0262cSandi global $conf; 538f3f0262cSandi $recent = array(); 5395749f1ceSmatthiasgrimm $names = array(); 5405749f1ceSmatthiasgrimm 5415749f1ceSmatthiasgrimm if(!$num) 5425749f1ceSmatthiasgrimm return $recent; 543f3f0262cSandi 544c1049928Sandi if(!@is_readable($conf['changelog'])){ 545c1049928Sandi msg($conf['changelog'].' is not readable',-1); 546c1049928Sandi return $recent; 547c1049928Sandi } 548c1049928Sandi 549f3f0262cSandi $loglines = file($conf['changelog']); 550f3f0262cSandi rsort($loglines); //reverse sort on timestamp 551f3f0262cSandi 552f3f0262cSandi foreach ($loglines as $line){ 553f3f0262cSandi $line = rtrim($line); //remove newline 554f3f0262cSandi if(empty($line)) continue; //skip empty lines 555f3f0262cSandi $info = split("\t",$line); //split into parts 556f3f0262cSandi //add id if not in yet and file still exists and is allowed to read 5575749f1ceSmatthiasgrimm if(!$names[$info[2]] && 558f3f0262cSandi (@file_exists(wikiFN($info[2])) || $incdel) && 559f3f0262cSandi (auth_quickaclcheck($info[2]) >= AUTH_READ) 560f3f0262cSandi ){ 5615749f1ceSmatthiasgrimm $names[$info[2]] = 1; 5625749f1ceSmatthiasgrimm if(--$first >= 0) continue; /* skip "first" entries */ 5635749f1ceSmatthiasgrimm 564f3f0262cSandi $recent[$info[2]]['date'] = $info[0]; 565f3f0262cSandi $recent[$info[2]]['ip'] = $info[1]; 566f3f0262cSandi $recent[$info[2]]['user'] = $info[3]; 567f3f0262cSandi $recent[$info[2]]['sum'] = $info[4]; 568f3f0262cSandi $recent[$info[2]]['del'] = !@file_exists(wikiFN($info[2])); 569f3f0262cSandi } 5705749f1ceSmatthiasgrimm if(count($recent) >= $num){ 571f3f0262cSandi break; //finish if enough items found 572f3f0262cSandi } 573f3f0262cSandi } 574f3f0262cSandi return $recent; 575f3f0262cSandi} 576f3f0262cSandi 577f3f0262cSandi/** 578652610a2Sandi * gets additonal informations for a certain pagerevison 579652610a2Sandi * from the changelog 580652610a2Sandi * 581652610a2Sandi * @author Andreas Gohr <andi@splitbrain.org> 582652610a2Sandi */ 583652610a2Sandifunction getRevisionInfo($id,$rev){ 584652610a2Sandi global $conf; 585258641c6Sandi 586258641c6Sandi if(!$rev) return(null); 587258641c6Sandi 588c1049928Sandi $info = array(); 589c1049928Sandi if(!@is_readable($conf['changelog'])){ 590c1049928Sandi msg($conf['changelog'].' is not readable',-1); 591c1049928Sandi return $recent; 592c1049928Sandi } 593652610a2Sandi $loglines = file($conf['changelog']); 594652610a2Sandi $loglines = preg_grep("/$rev\t\d+\.\d+\.\d+\.\d+\t$id\t/",$loglines); 595dc42ff59Sandi $loglines = array_reverse($loglines); //reverse sort on timestamp (shouldn't be needed) 596652610a2Sandi $line = split("\t",$loglines[0]); 597652610a2Sandi $info['date'] = $line[0]; 598652610a2Sandi $info['ip'] = $line[1]; 599652610a2Sandi $info['user'] = $line[3]; 600652610a2Sandi $info['sum'] = $line[4]; 601652610a2Sandi return $info; 602652610a2Sandi} 603652610a2Sandi 604652610a2Sandi/** 605f3f0262cSandi * Saves a wikitext by calling io_saveFile 60615fae107Sandi * 60715fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 608f3f0262cSandi */ 609f3f0262cSandifunction saveWikiText($id,$text,$summary){ 610f3f0262cSandi global $conf; 611f3f0262cSandi global $lang; 612f3f0262cSandi umask($conf['umask']); 613f3f0262cSandi // ignore if no changes were made 614f3f0262cSandi if($text == rawWiki($id,'')){ 615f3f0262cSandi return; 616f3f0262cSandi } 617f3f0262cSandi 618f3f0262cSandi $file = wikiFN($id); 619f3f0262cSandi $old = saveOldRevision($id); 620f3f0262cSandi 621f3f0262cSandi if (empty($text)){ 622f3f0262cSandi // remove empty files 623f3f0262cSandi @unlink($file); 624f3f0262cSandi $del = true; 6253ce054b3Sandi //autoset summary on deletion 6263ce054b3Sandi if(empty($summary)) $summary = $lang['deleted']; 62753d6ccfeSandi //remove empty namespaces 62853d6ccfeSandi io_sweepNS($id); 629f3f0262cSandi }else{ 630f3f0262cSandi // save file (datadir is created in io_saveFile) 631f3f0262cSandi io_saveFile($file,$text); 632f3f0262cSandi $del = false; 633f3f0262cSandi } 634f3f0262cSandi 635652610a2Sandi addLogEntry(@filemtime($file),$id,$summary); 636f3f0262cSandi notify($id,$old,$summary); 637f3f0262cSandi 638f3f0262cSandi //purge cache on add by updating the purgefile 639f3f0262cSandi if($conf['purgeonadd'] && (!$old || $del)){ 64098407a7aSandi io_saveFile($conf['cachedir'].'/purgefile',time()); 641f3f0262cSandi } 642f3f0262cSandi} 643f3f0262cSandi 644f3f0262cSandi/** 645f3f0262cSandi * moves the current version to the attic and returns its 646f3f0262cSandi * revision date 64715fae107Sandi * 64815fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 649f3f0262cSandi */ 650f3f0262cSandifunction saveOldRevision($id){ 651f3f0262cSandi global $conf; 652f3f0262cSandi umask($conf['umask']); 653f3f0262cSandi $oldf = wikiFN($id); 654f3f0262cSandi if(!@file_exists($oldf)) return ''; 655f3f0262cSandi $date = filemtime($oldf); 656f3f0262cSandi $newf = wikiFN($id,$date); 657f3f0262cSandi if(substr($newf,-3)=='.gz'){ 658f3f0262cSandi io_saveFile($newf,rawWiki($id)); 659f3f0262cSandi }else{ 660f3f0262cSandi io_makeFileDir($newf); 661f3f0262cSandi copy($oldf, $newf); 662f3f0262cSandi } 663f3f0262cSandi return $date; 664f3f0262cSandi} 665f3f0262cSandi 666f3f0262cSandi/** 667f3f0262cSandi * Sends a notify mail to the wikiadmin when a page was 668f3f0262cSandi * changed 66915fae107Sandi * 67015fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 671f3f0262cSandi */ 672f3f0262cSandifunction notify($id,$rev="",$summary=""){ 673f3f0262cSandi global $lang; 674f3f0262cSandi global $conf; 675f3f0262cSandi $hdrs =''; 676f3f0262cSandi if(empty($conf['notify'])) return; //notify enabled? 677f3f0262cSandi 678f3f0262cSandi $text = rawLocale('mailtext'); 679f3f0262cSandi $text = str_replace('@DATE@',date($conf['dformat']),$text); 680f3f0262cSandi $text = str_replace('@BROWSER@',$_SERVER['HTTP_USER_AGENT'],$text); 681f3f0262cSandi $text = str_replace('@IPADDRESS@',$_SERVER['REMOTE_ADDR'],$text); 682f3f0262cSandi $text = str_replace('@HOSTNAME@',gethostbyaddr($_SERVER['REMOTE_ADDR']),$text); 683ed7b5f09Sandi $text = str_replace('@NEWPAGE@',wl($id,'',true),$text); 684ed7b5f09Sandi $text = str_replace('@DOKUWIKIURL@',DOKU_URL,$text); 685f3f0262cSandi $text = str_replace('@SUMMARY@',$summary,$text); 6867a82afdcSandi $text = str_replace('@USER@',$_SERVER['REMOTE_USER'],$text); 687f3f0262cSandi 688f3f0262cSandi if($rev){ 689f3f0262cSandi $subject = $lang['mail_changed'].' '.$id; 690ed7b5f09Sandi $text = str_replace('@OLDPAGE@',wl($id,"rev=$rev",true),$text); 691f3f0262cSandi require_once("inc/DifferenceEngine.php"); 692f3f0262cSandi $df = new Diff(split("\n",rawWiki($id,$rev)), 693f3f0262cSandi split("\n",rawWiki($id))); 694f3f0262cSandi $dformat = new UnifiedDiffFormatter(); 695f3f0262cSandi $diff = $dformat->format($df); 696f3f0262cSandi }else{ 697f3f0262cSandi $subject=$lang['mail_newpage'].' '.$id; 698f3f0262cSandi $text = str_replace('@OLDPAGE@','none',$text); 699f3f0262cSandi $diff = rawWiki($id); 700f3f0262cSandi } 701f3f0262cSandi $text = str_replace('@DIFF@',$diff,$text); 702241f3a36Sandi $subject = '['.$conf['title'].'] '.$subject; 703f3f0262cSandi 70444f669e9Sandi mail_send($conf['notify'],$subject,$text,$conf['mailfrom']); 705f3f0262cSandi} 706f3f0262cSandi 70715fae107Sandi/** 70815fae107Sandi * Return a list of available page revisons 70915fae107Sandi * 71015fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 71115fae107Sandi */ 712f3f0262cSandifunction getRevisions($id){ 713f3f0262cSandi $revd = dirname(wikiFN($id,'foo')); 714f3f0262cSandi $revs = array(); 715f3f0262cSandi $clid = cleanID($id); 716f3f0262cSandi if(strrpos($clid,':')) $clid = substr($clid,strrpos($clid,':')+1); //remove path 717493a6929SKobaYY $clid = utf8_encodeFN($clid); 718f3f0262cSandi 719f3f0262cSandi if (is_dir($revd) && $dh = opendir($revd)) { 720f3f0262cSandi while (($file = readdir($dh)) !== false) { 721f3f0262cSandi if (is_dir($revd.'/'.$file)) continue; 722f3f0262cSandi if (preg_match('/^'.$clid.'\.(\d+)\.txt(\.gz)?$/',$file,$match)){ 723f3f0262cSandi $revs[]=$match[1]; 724f3f0262cSandi } 725f3f0262cSandi } 726f3f0262cSandi closedir($dh); 727f3f0262cSandi } 728f3f0262cSandi rsort($revs); 729f3f0262cSandi return $revs; 730f3f0262cSandi} 731f3f0262cSandi 732f3f0262cSandi/** 733f3f0262cSandi * extracts the query from a google referer 73415fae107Sandi * 7356b13307fSandi * @todo should be more generic and support yahoo et al 73615fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 737f3f0262cSandi */ 738f3f0262cSandifunction getGoogleQuery(){ 739f3f0262cSandi $url = parse_url($_SERVER['HTTP_REFERER']); 7405c3f206fSandi if(!$url) return ''; 741f3f0262cSandi 742f3f0262cSandi if(!preg_match("#google\.#i",$url['host'])) return ''; 743f3f0262cSandi $query = array(); 744f3f0262cSandi parse_str($url['query'],$query); 745f3f0262cSandi 746f3f0262cSandi return $query['q']; 747f3f0262cSandi} 748f3f0262cSandi 749f3f0262cSandi/** 75015fae107Sandi * Try to set correct locale 75115fae107Sandi * 752095bfd5cSandi * @deprecated No longer used 75315fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 754f3f0262cSandi */ 755f3f0262cSandifunction setCorrectLocale(){ 756f3f0262cSandi global $conf; 757f3f0262cSandi global $lang; 758f3f0262cSandi 759f3f0262cSandi $enc = strtoupper($lang['encoding']); 760f3f0262cSandi foreach ($lang['locales'] as $loc){ 761f3f0262cSandi //try locale 762f3f0262cSandi if(@setlocale(LC_ALL,$loc)) return; 763f3f0262cSandi //try loceale with encoding 764f3f0262cSandi if(@setlocale(LC_ALL,"$loc.$enc")) return; 765f3f0262cSandi } 766f3f0262cSandi //still here? try to set from environment 767f3f0262cSandi @setlocale(LC_ALL,""); 768f3f0262cSandi} 769f3f0262cSandi 770f3f0262cSandi/** 771f3f0262cSandi * Return the human readable size of a file 772f3f0262cSandi * 773f3f0262cSandi * @param int $size A file size 774f3f0262cSandi * @param int $dec A number of decimal places 775f3f0262cSandi * @author Martin Benjamin <b.martin@cybernet.ch> 776f3f0262cSandi * @author Aidan Lister <aidan@php.net> 777f3f0262cSandi * @version 1.0.0 778f3f0262cSandi */ 779f31d5b73Sandifunction filesize_h($size, $dec = 1){ 780f3f0262cSandi $sizes = array('B', 'KB', 'MB', 'GB'); 781f3f0262cSandi $count = count($sizes); 782f3f0262cSandi $i = 0; 783f3f0262cSandi 784f3f0262cSandi while ($size >= 1024 && ($i < $count - 1)) { 785f3f0262cSandi $size /= 1024; 786f3f0262cSandi $i++; 787f3f0262cSandi } 788f3f0262cSandi 789f3f0262cSandi return round($size, $dec) . ' ' . $sizes[$i]; 790f3f0262cSandi} 791f3f0262cSandi 79215fae107Sandi/** 793dc57ef04Sandi * Return DokuWikis version 79415fae107Sandi * 79515fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 79615fae107Sandi */ 797f31d5b73Sandifunction getVersion(){ 798f31d5b73Sandi //import version string 799f31d5b73Sandi if(@file_exists('VERSION')){ 800f31d5b73Sandi //official release 801ec052310Sandi return 'Release '.trim(io_readfile('VERSION')); 802f31d5b73Sandi }elseif(is_dir('_darcs')){ 803f31d5b73Sandi //darcs checkout 804f31d5b73Sandi $inv = file('_darcs/inventory'); 805f31d5b73Sandi $inv = preg_grep('#andi@splitbrain\.org\*\*\d{14}#',$inv); 806f31d5b73Sandi $cur = array_pop($inv); 807f31d5b73Sandi preg_match('#\*\*(\d{4})(\d{2})(\d{2})#',$cur,$matches); 808f31d5b73Sandi return 'Darcs '.$matches[1].'-'.$matches[2].'-'.$matches[3]; 809f31d5b73Sandi }else{ 810f31d5b73Sandi return 'snapshot?'; 811f31d5b73Sandi } 812f31d5b73Sandi} 813f31d5b73Sandi 814f31d5b73Sandi/** 815f31d5b73Sandi * Run a few sanity checks 816f31d5b73Sandi * 817f31d5b73Sandi * @author Andreas Gohr <andi@splitbrain.org> 818f31d5b73Sandi */ 819f3f0262cSandifunction check(){ 820f3f0262cSandi global $conf; 821f3f0262cSandi global $INFO; 822f3f0262cSandi 823f31d5b73Sandi msg('DokuWiki version: '.getVersion(),1); 824f31d5b73Sandi 82549022a38Sandi if(version_compare(phpversion(),'4.3.0','<')){ 82649022a38Sandi msg('Your PHP version is too old ('.phpversion().' vs. 4.3.+ recommended)',-1); 82749022a38Sandi }elseif(version_compare(phpversion(),'4.3.10','<')){ 82849022a38Sandi msg('Consider upgrading PHP to 4.3.10 or higher for security reasons (your version: '.phpversion().')',0); 82949022a38Sandi }else{ 83049022a38Sandi msg('PHP version '.phpversion(),1); 83149022a38Sandi } 83249022a38Sandi 833f3f0262cSandi if(is_writable($conf['changelog'])){ 834f3f0262cSandi msg('Changelog is writable',1); 835f3f0262cSandi }else{ 836f3f0262cSandi msg('Changelog is not writable',-1); 837f3f0262cSandi } 838f3f0262cSandi 839f3f0262cSandi if(is_writable($conf['datadir'])){ 840f3f0262cSandi msg('Datadir is writable',1); 841f3f0262cSandi }else{ 842f3f0262cSandi msg('Datadir is not writable',-1); 843f3f0262cSandi } 844f3f0262cSandi 845f3f0262cSandi if(is_writable($conf['olddir'])){ 846f3f0262cSandi msg('Attic is writable',1); 847f3f0262cSandi }else{ 848f3f0262cSandi msg('Attic is not writable',-1); 849f3f0262cSandi } 850f3f0262cSandi 851f3f0262cSandi if(is_writable($conf['mediadir'])){ 852f3f0262cSandi msg('Mediadir is writable',1); 853f3f0262cSandi }else{ 854f3f0262cSandi msg('Mediadir is not writable',-1); 855f3f0262cSandi } 856f3f0262cSandi 85798407a7aSandi if(is_writable($conf['cachedir'])){ 85898407a7aSandi msg('Cachedir is writable',1); 85998407a7aSandi }else{ 86098407a7aSandi msg('Cachedir is not writable',-1); 86198407a7aSandi } 86298407a7aSandi 863f62ea8a1Sandi if(is_writable(DOKU_INC.'conf/users.auth.php')){ 8648c4f28e8Sjan msg('conf/users.auth.php is writable',1); 865f3f0262cSandi }else{ 8668c4f28e8Sjan msg('conf/users.auth.php is not writable',0); 867f3f0262cSandi } 86893a9e835Sandi 86993a9e835Sandi if(function_exists('mb_strpos')){ 87093a9e835Sandi if(defined('UTF8_NOMBSTRING')){ 87193a9e835Sandi msg('mb_string extension is available but will not be used',0); 87293a9e835Sandi }else{ 87393a9e835Sandi msg('mb_string extension is available and will be used',1); 87493a9e835Sandi } 87593a9e835Sandi }else{ 87693a9e835Sandi msg('mb_string extension not available - PHP only replacements will be used',0); 87793a9e835Sandi } 878f3f0262cSandi 879f3f0262cSandi msg('Your current permission for this page is '.$INFO['perm'],0); 880f3f0262cSandi 881f3f0262cSandi if(is_writable($INFO['filepath'])){ 882f3f0262cSandi msg('The current page is writable by the webserver',0); 883f3f0262cSandi }else{ 884f3f0262cSandi msg('The current page is not writable by the webserver',0); 885f3f0262cSandi } 886f3f0262cSandi 887f3f0262cSandi if($INFO['writable']){ 888f3f0262cSandi msg('The current page is writable by you',0); 889f3f0262cSandi }else{ 890f3f0262cSandi msg('The current page is not writable you',0); 891f3f0262cSandi } 892f3f0262cSandi} 893340756e4Sandi 894340756e4Sandi 895340756e4Sandi//Setup VIM: ex: et ts=2 enc=utf-8 : 896