1f3f0262cSandi<? 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 9f3f0262cSandi require_once("conf/dokuwiki.php"); 10f3f0262cSandi require_once("inc/io.php"); 11*c41c03f3Sandi require_once('inc/utf8.php'); 12f3f0262cSandi 13f3f0262cSandi //set up error reporting to sane values 14f3f0262cSandi error_reporting(E_ALL ^ E_NOTICE); 15f3f0262cSandi 16f3f0262cSandi //make session rewrites XHTML compliant 17f3f0262cSandi ini_set('arg_separator.output', '&'); 18f3f0262cSandi 19f3f0262cSandi //init session 20f3f0262cSandi session_name("DokuWiki"); 21f3f0262cSandi session_start(); 22f3f0262cSandi 23f3f0262cSandi //kill magic quotes 24f3f0262cSandi if (get_magic_quotes_gpc()) { 25f3f0262cSandi if (!empty($_GET)) remove_magic_quotes($_GET); 26f3f0262cSandi if (!empty($_POST)) remove_magic_quotes($_POST); 27f3f0262cSandi if (!empty($_COOKIE)) remove_magic_quotes($_COOKIE); 28f3f0262cSandi if (!empty($_REQUEST)) remove_magic_quotes($_REQUEST); 29f3f0262cSandi if (!empty($_SESSION)) remove_magic_quotes($_SESSION); 30f3f0262cSandi ini_set('magic_quotes_gpc', 0); 31f3f0262cSandi } 32f3f0262cSandi set_magic_quotes_runtime(0); 33f3f0262cSandi ini_set('magic_quotes_sybase',0); 34f3f0262cSandi 3515fae107Sandi //disable gzip if not available 3615fae107Sandi if($conf['usegzip'] && !function_exists('gzopen')){ 3715fae107Sandi $conf['usegzip'] = 0; 3815fae107Sandi } 3915fae107Sandi 4015fae107Sandi/** 4115fae107Sandi * remove magic quotes recursivly 4215fae107Sandi * 4315fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 4415fae107Sandi */ 45f3f0262cSandifunction remove_magic_quotes(&$array) { 46f3f0262cSandi foreach (array_keys($array) as $key) { 47f3f0262cSandi if (is_array($array[$key])) { 48f3f0262cSandi remove_magic_quotes($array[$key]); 49f3f0262cSandi }else { 50f3f0262cSandi $array[$key] = stripslashes($array[$key]); 51f3f0262cSandi } 52f3f0262cSandi } 53f3f0262cSandi} 54f3f0262cSandi 55f3f0262cSandi/** 5615fae107Sandi * Returns the full absolute URL to the directory where 57f3f0262cSandi * DokuWiki is installed in (includes a trailing slash) 5815fae107Sandi * 5915fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 60f3f0262cSandi */ 61f3f0262cSandifunction getBaseURL($abs=false){ 62f3f0262cSandi global $conf; 63f3f0262cSandi //if canonical url enabled always return absolute 64f3f0262cSandi if($conf['canonical']) $abs = true; 65f3f0262cSandi 66f3f0262cSandi //relative URLs are easy 67f3f0262cSandi if(!$abs){ 68f3f0262cSandi $dir = dirname($_SERVER['PHP_SELF']).'/'; 69f3f0262cSandi $dir = preg_replace('#//#','/',$dir); 70f3f0262cSandi $dir = preg_replace('#\/$#','/',$dir); #bugfix for weird WIN behaviour 71f3f0262cSandi return $dir; 72f3f0262cSandi } 73f3f0262cSandi 74f3f0262cSandi $port = ':'.$_SERVER['SERVER_PORT']; 75f3f0262cSandi //remove port from hostheader as sent by IE 76f3f0262cSandi $host = preg_replace('/:.*$/','',$_SERVER['HTTP_HOST']); 77f3f0262cSandi 78f3f0262cSandi // see if HTTPS is enabled - apache leaves this empty when not available, 79f3f0262cSandi // IIS sets it to 'off', 'false' and 'disabled' are just guessing 80f3f0262cSandi if (preg_match('/^(|off|false|disabled)$/i',$_SERVER['HTTPS'])){ 81f3f0262cSandi $proto = 'http://'; 82f3f0262cSandi if ($_SERVER['SERVER_PORT'] == '80') { 83f3f0262cSandi $port=''; 84f3f0262cSandi } 85f3f0262cSandi }else{ 86f3f0262cSandi $proto = 'https://'; 87f3f0262cSandi if ($_SERVER['SERVER_PORT'] == '443') { 88f3f0262cSandi $port=''; 89f3f0262cSandi } 90f3f0262cSandi } 91f3f0262cSandi $dir = (dirname($_SERVER['PHP_SELF'])).'/'; 92f3f0262cSandi $dir = preg_replace('#//#','/',$dir); 93f3f0262cSandi $dir = preg_replace('#\/$#','/',$dir); #bugfix for weird WIN behaviour 94f3f0262cSandi 95f3f0262cSandi return $proto.$host.$port.$dir; 96f3f0262cSandi} 97f3f0262cSandi 98f3f0262cSandi/** 9915fae107Sandi * Return info about the current document as associative 100f3f0262cSandi * array. 10115fae107Sandi * 10215fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 103f3f0262cSandi */ 104f3f0262cSandifunction pageinfo(){ 105f3f0262cSandi global $ID; 106f3f0262cSandi global $REV; 107f3f0262cSandi global $USERINFO; 108f3f0262cSandi global $conf; 109f3f0262cSandi 110f3f0262cSandi if($_SERVER['REMOTE_USER']){ 111f3f0262cSandi $info['user'] = $_SERVER['REMOTE_USER']; 112f3f0262cSandi $info['userinfo'] = $USERINFO; 113f3f0262cSandi $info['perm'] = auth_quickaclcheck($ID); 114f3f0262cSandi }else{ 115f3f0262cSandi $info['user'] = ''; 116f3f0262cSandi $info['perm'] = auth_aclcheck($ID,'',null); 117f3f0262cSandi } 118f3f0262cSandi 119f3f0262cSandi $info['namespace'] = getNS($ID); 120f3f0262cSandi $info['locked'] = checklock($ID); 121f3f0262cSandi $info['filepath'] = realpath(wikiFN($ID,$REV)); 122f3f0262cSandi $info['exists'] = @file_exists($info['filepath']); 123f3f0262cSandi if($REV && !$info['exists']){ 124f3f0262cSandi //check if current revision was meant 125f3f0262cSandi $cur = wikiFN($ID); 126f3f0262cSandi if(@file_exists($cur) && (@filemtime($cur) == $REV)){ 127f3f0262cSandi $info['filepath'] = realpath($cur); 128f3f0262cSandi $info['exists'] = true; 129f3f0262cSandi $REV = ''; 130f3f0262cSandi } 131f3f0262cSandi } 132f3f0262cSandi if($info['exists']){ 133f3f0262cSandi $info['writable'] = (is_writable($info['filepath']) && 134f3f0262cSandi ($info['perm'] >= AUTH_EDIT)); 135f3f0262cSandi }else{ 136f3f0262cSandi $info['writable'] = ($info['perm'] >= AUTH_CREATE); 137f3f0262cSandi } 138f3f0262cSandi $info['editable'] = ($info['writable'] && empty($info['lock'])); 139f3f0262cSandi $info['lastmod'] = @filemtime($info['filepath']); 140f3f0262cSandi 141f3f0262cSandi return $info; 142f3f0262cSandi} 143f3f0262cSandi 144f3f0262cSandi/** 145f3f0262cSandi * adds a message to the global message array 146f3f0262cSandi * 147f3f0262cSandi * Levels can be: 148f3f0262cSandi * 149f3f0262cSandi * -1 error 150f3f0262cSandi * 0 info 151f3f0262cSandi * 1 success 15215fae107Sandi * 15315fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 154f3f0262cSandi */ 155f3f0262cSandifunction msg($message,$lvl=0){ 156f3f0262cSandi global $MSG; 157f3f0262cSandi $errors[-1] = 'error'; 158f3f0262cSandi $errors[0] = 'info'; 159f3f0262cSandi $errors[1] = 'success'; 160f3f0262cSandi 161f3f0262cSandi if(!isset($MSG)) $MSG = array(); 162f3f0262cSandi $MSG[]=array('lvl' => $errors[$lvl], 'msg' => $message); 163f3f0262cSandi} 164f3f0262cSandi 165f3f0262cSandi/** 16615fae107Sandi * This builds the breadcrumb trail and returns it as array 16715fae107Sandi * 16815fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 169f3f0262cSandi */ 170f3f0262cSandifunction breadcrumbs(){ 171f3f0262cSandi global $ID; 172f3f0262cSandi global $ACT; 173f3f0262cSandi global $conf; 174f3f0262cSandi $crumbs = $_SESSION[$conf['title']]['bc']; 175f3f0262cSandi 176f3f0262cSandi //first visit? 177f3f0262cSandi if (!is_array($crumbs)){ 178f3f0262cSandi $crumbs = array(); 179f3f0262cSandi } 180f3f0262cSandi //we only save on show and existing wiki documents 181f3f0262cSandi if($ACT != 'show' || !@file_exists(wikiFN($ID))){ 182f3f0262cSandi $_SESSION[$conf['title']]['bc'] = $crumbs; 183f3f0262cSandi return $crumbs; 184f3f0262cSandi } 185f3f0262cSandi //remove ID from array 186f3f0262cSandi $pos = array_search($ID,$crumbs); 187f3f0262cSandi if($pos !== false && $pos !== null){ 188f3f0262cSandi array_splice($crumbs,$pos,1); 189f3f0262cSandi } 190f3f0262cSandi 191f3f0262cSandi //add to array 192f3f0262cSandi $crumbs[] =$ID; 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 * 20915fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 210f3f0262cSandi */ 211f3f0262cSandifunction idfilter($id){ 212f3f0262cSandi global $conf; 213f3f0262cSandi if ($conf['useslash'] && $conf['userewrite']){ 214f3f0262cSandi $id = strtr($id,':','/'); 215f3f0262cSandi }elseif (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN' && 216f3f0262cSandi $conf['userewrite']) { 217f3f0262cSandi $id = strtr($id,':',';'); 218f3f0262cSandi } 219f3f0262cSandi $id = urlencode($id); 220f3f0262cSandi $id = str_replace('%3A',':',$id); //keep as colon 221f3f0262cSandi $id = str_replace('%2F','/',$id); //keep as slash 222f3f0262cSandi return $id; 223f3f0262cSandi} 224f3f0262cSandi 225f3f0262cSandi/** 226f3f0262cSandi * This builds a link to a wikipage (using getBaseURL) 22715fae107Sandi * 22815fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 229f3f0262cSandi */ 230f3f0262cSandifunction wl($id='',$more='',$script='doku.php',$canonical=false){ 231f3f0262cSandi global $conf; 232f3f0262cSandi $more = str_replace(',','&',$more); 233f3f0262cSandi 234f3f0262cSandi $id = idfilter($id); 235f3f0262cSandi $xlink = getBaseURL($canonical); 236f3f0262cSandi 237f3f0262cSandi if(!$conf['userewrite']){ 238f3f0262cSandi $xlink .= $script; 239f3f0262cSandi $xlink .= '?id='.$id; 240f3f0262cSandi if($more) $xlink .= '&'.$more; 241f3f0262cSandi }else{ 242f3f0262cSandi $xlink .= $id; 243f3f0262cSandi if($more) $xlink .= '?'.$more; 244f3f0262cSandi } 245f3f0262cSandi 246f3f0262cSandi return $xlink; 247f3f0262cSandi} 248f3f0262cSandi 249f3f0262cSandi/** 250f3f0262cSandi * Just builds a link to a script 25115fae107Sandi * 25215fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 253f3f0262cSandi */ 254f3f0262cSandifunction script($script='doku.php'){ 255f3f0262cSandi $link = getBaseURL(); 256f3f0262cSandi $link .= $script; 257f3f0262cSandi return $link; 258f3f0262cSandi} 259f3f0262cSandi 260f3f0262cSandi/** 261f3f0262cSandi * Return namespacepart of a wiki ID 26215fae107Sandi * 26315fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 264f3f0262cSandi */ 265f3f0262cSandifunction getNS($id){ 266f3f0262cSandi if(strpos($id,':')!==false){ 267f3f0262cSandi return substr($id,0,strrpos($id,':')); 268f3f0262cSandi } 269f3f0262cSandi return false; 270f3f0262cSandi} 271f3f0262cSandi 272f3f0262cSandi/** 27315fae107Sandi * Returns the ID without the namespace 27415fae107Sandi * 27515fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 276f3f0262cSandi */ 277f3f0262cSandifunction noNS($id){ 278f3f0262cSandi return preg_replace('/.*:/','',$id); 279f3f0262cSandi} 280f3f0262cSandi 281f3f0262cSandi/** 28215fae107Sandi * Spamcheck against wordlist 28315fae107Sandi * 284f3f0262cSandi * Checks the wikitext against a list of blocked expressions 285f3f0262cSandi * returns true if the text contains any bad words 28615fae107Sandi * 28715fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 288f3f0262cSandi */ 289f3f0262cSandifunction checkwordblock(){ 290f3f0262cSandi global $TEXT; 291f3f0262cSandi global $conf; 292f3f0262cSandi 293f3f0262cSandi if(!$conf['usewordblock']) return false; 294f3f0262cSandi 295f3f0262cSandi $blocks = file('conf/wordblock.conf'); 296f3f0262cSandi $re = array(); 297f3f0262cSandi #build regexp from blocks 298f3f0262cSandi foreach($blocks as $block){ 299f3f0262cSandi $block = preg_replace('/#.*$/','',$block); 300f3f0262cSandi $block = trim($block); 301f3f0262cSandi if(empty($block)) continue; 302f3f0262cSandi $re[] = $block; 303f3f0262cSandi } 304f3f0262cSandi if(preg_match('#('.join('|',$re).')#si',$TEXT)) return true; 305f3f0262cSandi return false; 306f3f0262cSandi} 307f3f0262cSandi 308f3f0262cSandi/** 30915fae107Sandi * Return the IP of the client 31015fae107Sandi * 31115fae107Sandi * Honours X-Forwarded-For Proxy Headers 31215fae107Sandi * 31315fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 314f3f0262cSandi */ 315f3f0262cSandifunction clientIP(){ 316f3f0262cSandi $my = $_SERVER['REMOTE_ADDR']; 317f3f0262cSandi if($_SERVER['HTTP_X_FORWARDED_FOR']){ 318f3f0262cSandi $my .= ' ('.$_SERVER['HTTP_X_FORWARDED_FOR'].')'; 319f3f0262cSandi } 320f3f0262cSandi return $my; 321f3f0262cSandi} 322f3f0262cSandi 323f3f0262cSandi/** 32415fae107Sandi * Checks if a given page is currently locked. 32515fae107Sandi * 326f3f0262cSandi * removes stale lockfiles 32715fae107Sandi * 32815fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 329f3f0262cSandi */ 330f3f0262cSandifunction checklock($id){ 331f3f0262cSandi global $conf; 332f3f0262cSandi $lock = wikiFN($id).'.lock'; 333f3f0262cSandi 334f3f0262cSandi //no lockfile 335f3f0262cSandi if(!@file_exists($lock)) return false; 336f3f0262cSandi 337f3f0262cSandi //lockfile expired 338f3f0262cSandi if((time() - filemtime($lock)) > $conf['locktime']){ 339f3f0262cSandi unlink($lock); 340f3f0262cSandi return false; 341f3f0262cSandi } 342f3f0262cSandi 343f3f0262cSandi //my own lock 344f3f0262cSandi $ip = io_readFile($lock); 345f3f0262cSandi if( ($ip == clientIP()) || ($ip == $_SERVER['REMOTE_USER']) ){ 346f3f0262cSandi return false; 347f3f0262cSandi } 348f3f0262cSandi 349f3f0262cSandi return $ip; 350f3f0262cSandi} 351f3f0262cSandi 352f3f0262cSandi/** 35315fae107Sandi * Lock a page for editing 35415fae107Sandi * 35515fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 356f3f0262cSandi */ 357f3f0262cSandifunction lock($id){ 358f3f0262cSandi $lock = wikiFN($id).'.lock'; 359f3f0262cSandi if($_SERVER['REMOTE_USER']){ 360f3f0262cSandi io_saveFile($lock,$_SERVER['REMOTE_USER']); 361f3f0262cSandi }else{ 362f3f0262cSandi io_saveFile($lock,clientIP()); 363f3f0262cSandi } 364f3f0262cSandi} 365f3f0262cSandi 366f3f0262cSandi/** 36715fae107Sandi * Unlock a page if it was locked by the user 368f3f0262cSandi * 36915fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 37015fae107Sandi * @return bool true if a lock was removed 371f3f0262cSandi */ 372f3f0262cSandifunction unlock($id){ 373f3f0262cSandi $lock = wikiFN($id).'.lock'; 374f3f0262cSandi if(@file_exists($lock)){ 375f3f0262cSandi $ip = io_readFile($lock); 376f3f0262cSandi if( ($ip == clientIP()) || ($ip == $_SERVER['REMOTE_USER']) ){ 377f3f0262cSandi @unlink($lock); 378f3f0262cSandi return true; 379f3f0262cSandi } 380f3f0262cSandi } 381f3f0262cSandi return false; 382f3f0262cSandi} 383f3f0262cSandi 384f3f0262cSandi/** 38515fae107Sandi * Remove unwanted chars from ID 38615fae107Sandi * 387f3f0262cSandi * Cleans a given ID to only use allowed characters. Accented characters are 388f3f0262cSandi * converted to unaccented ones 38915fae107Sandi * 39015fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 391f3f0262cSandi */ 392f3f0262cSandifunction cleanID($id){ 393f3f0262cSandi global $conf; 394f3f0262cSandi global $lang; 395f3f0262cSandi $id = trim($id); 396*c41c03f3Sandi $id = utf8_strtolower($id); 397f3f0262cSandi 398f3f0262cSandi //alternative namespace seperator 399f3f0262cSandi $id = strtr($id,';',':'); 400fbe55665Sandi if($conf['useslash']) $id = strtr($id,'/',':'); 401f3f0262cSandi 402*c41c03f3Sandi //FIXME use config to ask for deaccenting 403*c41c03f3Sandi $id = utf8_deaccent($id,-1); 404*c41c03f3Sandi 405*c41c03f3Sandi //remove specials (only ascii specials are removed) 406*c41c03f3Sandi $id = preg_replace('#[ !"§$%&()\[\]{}\\?`\'\#~*+=,<>\|^°@µ¹²³¼½¬]#u','_',$id); 407*c41c03f3Sandi 408*c41c03f3Sandi/* DELETEME legacy code 409f3f0262cSandi if(!$conf['localnames']){ 410f3f0262cSandi if($lang['encoding'] == 'iso-8859-15'){ 411f3f0262cSandi // replace accented chars with unaccented ones 412f3f0262cSandi // this may look strange on your terminal - just don't touch 413f3f0262cSandi $id = strtr( 414f3f0262cSandi strtr($id, 415*c41c03f3Sandi 'ÀÁÂÃÅÇÈÉÊËÌÍÎÏÑÒÓÔÕØÙÚÛÝàáâãåçèéêëìíîïñòóôõøùúûýÿ', 416f3f0262cSandi 'szszyaaaaaceeeeiiiinooooouuuyaaaaaceeeeiiiinooooouuuyy'), 417*c41c03f3Sandi array('Þ' => 'th', 'þ' => 'th', 'Ð' => 'dh', 'ð' => 'dh', 'ß' => 'ss', 418*c41c03f3Sandi '' => 'oe', '' => 'oe', 'Æ' => 'ae', 'æ' => 'ae', 'µ' => 'u', 419*c41c03f3Sandi 'ü' => 'ue', 'ö' => 'oe', 'ä' => 'ae', 'Ü' => 'ue', 'Ö' => 'ö', 420*c41c03f3Sandi 'Ä' => 'ae')); 421f3f0262cSandi } 422f3f0262cSandi $WORD = 'a-z'; 423f3f0262cSandi }else{ 424f3f0262cSandi $WORD = '\w'; 425f3f0262cSandi } 426f3f0262cSandi //special chars left will be converted to _ 427f3f0262cSandi $id = preg_replace('#[^'.$WORD.'0-9:\-\.]#','_',$id); 428*c41c03f3Sandi*/ 429*c41c03f3Sandi 430*c41c03f3Sandi //clean up 431f3f0262cSandi $id = preg_replace('#__#','_',$id); 432f3f0262cSandi $id = preg_replace('#:+#',':',$id); 433f3f0262cSandi $id = trim($id,':._-'); 434f3f0262cSandi $id = preg_replace('#:[:\._\-]+#',':',$id); 435f3f0262cSandi 436f3f0262cSandi return($id); 437f3f0262cSandi} 438f3f0262cSandi 439f3f0262cSandi/** 440f3f0262cSandi * returns the full path to the datafile specified by ID and 441f3f0262cSandi * optional revision 44215fae107Sandi * 44315fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 444f3f0262cSandi */ 445f3f0262cSandifunction wikiFN($id,$rev=''){ 446f3f0262cSandi global $conf; 447f3f0262cSandi $id = cleanID($id); 448f3f0262cSandi $id = str_replace(':','/',$id); 449f3f0262cSandi if(empty($rev)){ 450f3f0262cSandi return $conf['datadir'].'/'.$id.'.txt'; 451f3f0262cSandi }else{ 452f3f0262cSandi $fn = $conf['olddir'].'/'.$id.'.'.$rev.'.txt'; 453f3f0262cSandi if(!$conf['usegzip'] || @file_exists($fn)){ 454f3f0262cSandi //return plaintext if exists or gzip is disabled 455f3f0262cSandi return $fn; 456f3f0262cSandi }else{ 457f3f0262cSandi return $fn.'.gz'; 458f3f0262cSandi } 459f3f0262cSandi } 460f3f0262cSandi} 461f3f0262cSandi 462f3f0262cSandi/** 463f3f0262cSandi * Returns the full filepath to a localized textfile if local 464f3f0262cSandi * version isn't found the english one is returned 46515fae107Sandi * 46615fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 467f3f0262cSandi */ 468f3f0262cSandifunction localeFN($id){ 469f3f0262cSandi global $conf; 470f3f0262cSandi $file = './lang/'.$conf['lang'].'/'.$id.'.txt'; 471f3f0262cSandi if(!@file_exists($file)){ 472f3f0262cSandi //fall back to english 473f3f0262cSandi $file = './lang/en/'.$id.'.txt'; 474f3f0262cSandi } 475f3f0262cSandi return cleanText($file); 476f3f0262cSandi} 477f3f0262cSandi 478f3f0262cSandi/** 479f3f0262cSandi * convert line ending to unix format 480f3f0262cSandi * 48115fae107Sandi * @see formText() for 2crlf conversion 48215fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 483f3f0262cSandi */ 484f3f0262cSandifunction cleanText($text){ 485f3f0262cSandi $text = preg_replace("/(\015\012)|(\015)/","\012",$text); 486f3f0262cSandi return $text; 487f3f0262cSandi} 488f3f0262cSandi 489f3f0262cSandi/** 490f3f0262cSandi * Prepares text for print in Webforms by encoding special chars. 491f3f0262cSandi * It also converts line endings to Windows format which is 492f3f0262cSandi * pseudo standard for webforms. 493f3f0262cSandi * 49415fae107Sandi * @see cleanText() for 2unix conversion 49515fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 496f3f0262cSandi */ 497f3f0262cSandifunction formText($text){ 498f3f0262cSandi $text = preg_replace("/\012/","\015\012",$text); 499f3f0262cSandi return htmlspecialchars($text); 500f3f0262cSandi} 501f3f0262cSandi 502f3f0262cSandi/** 50315fae107Sandi * Returns the specified local text in parsed format 50415fae107Sandi * 50515fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 506f3f0262cSandi */ 507f3f0262cSandifunction parsedLocale($id){ 508f3f0262cSandi //disable section editing 509f3f0262cSandi global $parser; 510f3f0262cSandi $se = $parser['secedit']; 511f3f0262cSandi $parser['secedit'] = false; 512f3f0262cSandi //fetch parsed locale 513f3f0262cSandi $html = io_cacheParse(localeFN($id)); 514f3f0262cSandi //reset section editing 515f3f0262cSandi $parser['secedit'] = $se; 516f3f0262cSandi return $html; 517f3f0262cSandi} 518f3f0262cSandi 519f3f0262cSandi/** 52015fae107Sandi * Returns the specified local text in raw format 52115fae107Sandi * 52215fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 523f3f0262cSandi */ 524f3f0262cSandifunction rawLocale($id){ 525f3f0262cSandi return io_readFile(localeFN($id)); 526f3f0262cSandi} 527f3f0262cSandi 528f3f0262cSandi 529f3f0262cSandi/** 53015fae107Sandi * Returns the parsed Wikitext for the given id and revision. 53115fae107Sandi * 53215fae107Sandi * If $excuse is true an explanation is returned if the file 53315fae107Sandi * wasn't found 53415fae107Sandi * 53515fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 536f3f0262cSandi */ 537f3f0262cSandifunction parsedWiki($id,$rev='',$excuse=true){ 538f3f0262cSandi $file = wikiFN($id,$rev); 539f3f0262cSandi $ret = ''; 540f3f0262cSandi 541f3f0262cSandi //ensure $id is in global $ID (needed for parsing) 542f3f0262cSandi global $ID; 543f3f0262cSandi $ID = $id; 544f3f0262cSandi 545f3f0262cSandi if($rev){ 546f3f0262cSandi if(@file_exists($file)){ 547f3f0262cSandi $ret = parse(io_readFile($file)); 548f3f0262cSandi }elseif($excuse){ 549f3f0262cSandi $ret = parsedLocale('norev'); 550f3f0262cSandi } 551f3f0262cSandi }else{ 552f3f0262cSandi if(@file_exists($file)){ 553f3f0262cSandi $ret = io_cacheParse($file); 554f3f0262cSandi }elseif($excuse){ 555f3f0262cSandi $ret = parsedLocale('newpage'); 556f3f0262cSandi } 557f3f0262cSandi } 558f3f0262cSandi return $ret; 559f3f0262cSandi} 560f3f0262cSandi 561f3f0262cSandi/** 562f3f0262cSandi * Returns the raw WikiText 56315fae107Sandi * 56415fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 565f3f0262cSandi */ 566f3f0262cSandifunction rawWiki($id,$rev=''){ 567f3f0262cSandi return io_readFile(wikiFN($id,$rev)); 568f3f0262cSandi} 569f3f0262cSandi 570f3f0262cSandi/** 57115fae107Sandi * Returns the raw Wiki Text in three slices. 57215fae107Sandi * 57315fae107Sandi * The range parameter needs to have the form "from-to" 57415fae107Sandi * and gives the range of the section. 575f3f0262cSandi * The returned order is prefix, section and suffix. 57615fae107Sandi * 57715fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 578f3f0262cSandi */ 579f3f0262cSandifunction rawWikiSlices($range,$id,$rev=''){ 580f3f0262cSandi list($from,$to) = split('-',$range,2); 581f3f0262cSandi $text = io_readFile(wikiFN($id,$rev)); 582f3f0262cSandi $text = split("\n",$text); 583f3f0262cSandi if(!$from) $from = 0; 584f3f0262cSandi if(!$to) $to = count($text); 585f3f0262cSandi 586f3f0262cSandi $slices[0] = join("\n",array_slice($text,0,$from)); 587f3f0262cSandi $slices[1] = join("\n",array_slice($text,$from,$to + 1 - $from)); 588f3f0262cSandi $slices[2] = join("\n",array_slice($text,$to+1)); 589f3f0262cSandi 590f3f0262cSandi return $slices; 591f3f0262cSandi} 592f3f0262cSandi 593f3f0262cSandi/** 59415fae107Sandi * Joins wiki text slices 59515fae107Sandi * 596f3f0262cSandi * function to join the text slices with correct lineendings again. 597f3f0262cSandi * When the pretty parameter is set to true it adds additional empty 598f3f0262cSandi * lines between sections if needed (used on saving). 59915fae107Sandi * 60015fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 601f3f0262cSandi */ 602f3f0262cSandifunction con($pre,$text,$suf,$pretty=false){ 603f3f0262cSandi 604f3f0262cSandi if($pretty){ 605f3f0262cSandi if($pre && substr($pre,-1) != "\n") $pre .= "\n"; 606f3f0262cSandi if($suf && substr($text,-1) != "\n") $text .= "\n"; 607f3f0262cSandi } 608f3f0262cSandi 609f3f0262cSandi if($pre) $pre .= "\n"; 610f3f0262cSandi if($suf) $text .= "\n"; 611f3f0262cSandi return $pre.$text.$suf; 612f3f0262cSandi} 613f3f0262cSandi 614f3f0262cSandi/** 61515fae107Sandi * print debug messages 61615fae107Sandi * 617f3f0262cSandi * little function to print the content of a var 61815fae107Sandi * 61915fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 620f3f0262cSandi */ 621f3f0262cSandifunction dbg($msg,$hidden=false){ 622f3f0262cSandi (!$hidden) ? print '<pre class="dbg">' : print "<!--\n"; 623f3f0262cSandi print_r($msg); 624f3f0262cSandi (!$hidden) ? print '</pre>' : print "\n-->"; 625f3f0262cSandi} 626f3f0262cSandi 627f3f0262cSandi/** 628f3f0262cSandi * Add's an entry to the changelog 62915fae107Sandi * 63015fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 631f3f0262cSandi */ 632f3f0262cSandifunction addLogEntry($id,$summary=""){ 633f3f0262cSandi global $conf; 634f3f0262cSandi $id = cleanID($id); 635f3f0262cSandi $date = time(); 636f3f0262cSandi $remote = $_SERVER['REMOTE_ADDR']; 637f3f0262cSandi $user = $_SERVER['REMOTE_USER']; 638f3f0262cSandi 639f3f0262cSandi $logline = join("\t",array($date,$remote,$id,$user,$summary))."\n"; 640f3f0262cSandi 641f3f0262cSandi $fh = fopen($conf['changelog'],'a'); 642f3f0262cSandi if($fh){ 643f3f0262cSandi fwrite($fh,$logline); 644f3f0262cSandi fclose($fh); 645f3f0262cSandi } 646f3f0262cSandi} 647f3f0262cSandi 648f3f0262cSandi/** 649f3f0262cSandi * returns an array of recently changed files using the 650f3f0262cSandi * changelog 65115fae107Sandi * 65215fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 653f3f0262cSandi */ 654f3f0262cSandifunction getRecents($num=0,$incdel=false){ 655f3f0262cSandi global $conf; 656f3f0262cSandi $recent = array(); 657f3f0262cSandi if(!$num) $num = $conf['recent']; 658f3f0262cSandi 659f3f0262cSandi $loglines = file($conf['changelog']); 660f3f0262cSandi rsort($loglines); //reverse sort on timestamp 661f3f0262cSandi 662f3f0262cSandi foreach ($loglines as $line){ 663f3f0262cSandi $line = rtrim($line); //remove newline 664f3f0262cSandi if(empty($line)) continue; //skip empty lines 665f3f0262cSandi $info = split("\t",$line); //split into parts 666f3f0262cSandi //add id if not in yet and file still exists and is allowed to read 667f3f0262cSandi if(!$recent[$info[2]] && 668f3f0262cSandi (@file_exists(wikiFN($info[2])) || $incdel) && 669f3f0262cSandi (auth_quickaclcheck($info[2]) >= AUTH_READ) 670f3f0262cSandi ){ 671f3f0262cSandi $recent[$info[2]]['date'] = $info[0]; 672f3f0262cSandi $recent[$info[2]]['ip'] = $info[1]; 673f3f0262cSandi $recent[$info[2]]['user'] = $info[3]; 674f3f0262cSandi $recent[$info[2]]['sum'] = $info[4]; 675f3f0262cSandi $recent[$info[2]]['del'] = !@file_exists(wikiFN($info[2])); 676f3f0262cSandi } 677f3f0262cSandi if(count($recent) >= $num){ 678f3f0262cSandi break; //finish if enough items found 679f3f0262cSandi } 680f3f0262cSandi } 681f3f0262cSandi return $recent; 682f3f0262cSandi} 683f3f0262cSandi 684f3f0262cSandi/** 685f3f0262cSandi * Saves a wikitext by calling io_saveFile 68615fae107Sandi * 68715fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 688f3f0262cSandi */ 689f3f0262cSandifunction saveWikiText($id,$text,$summary){ 690f3f0262cSandi global $conf; 691f3f0262cSandi global $lang; 692f3f0262cSandi umask($conf['umask']); 693f3f0262cSandi // ignore if no changes were made 694f3f0262cSandi if($text == rawWiki($id,'')){ 695f3f0262cSandi return; 696f3f0262cSandi } 697f3f0262cSandi 698f3f0262cSandi $file = wikiFN($id); 699f3f0262cSandi $old = saveOldRevision($id); 700f3f0262cSandi 701f3f0262cSandi if (empty($text)){ 702f3f0262cSandi // remove empty files 703f3f0262cSandi @unlink($file); 704f3f0262cSandi $del = true; 705f3f0262cSandi $summary = $lang['deleted']; //autoset summary on deletion 706f3f0262cSandi }else{ 707f3f0262cSandi // save file (datadir is created in io_saveFile) 708f3f0262cSandi io_saveFile($file,$text); 709f3f0262cSandi $del = false; 710f3f0262cSandi } 711f3f0262cSandi 712f3f0262cSandi addLogEntry($id,$summary); 713f3f0262cSandi notify($id,$old,$summary); 714f3f0262cSandi 715f3f0262cSandi //purge cache on add by updating the purgefile 716f3f0262cSandi if($conf['purgeonadd'] && (!$old || $del)){ 717f3f0262cSandi io_saveFile($conf['datadir'].'/.cache/purgefile',time()); 718f3f0262cSandi } 719f3f0262cSandi} 720f3f0262cSandi 721f3f0262cSandi/** 722f3f0262cSandi * moves the current version to the attic and returns its 723f3f0262cSandi * revision date 72415fae107Sandi * 72515fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 726f3f0262cSandi */ 727f3f0262cSandifunction saveOldRevision($id){ 728f3f0262cSandi global $conf; 729f3f0262cSandi umask($conf['umask']); 730f3f0262cSandi $oldf = wikiFN($id); 731f3f0262cSandi if(!@file_exists($oldf)) return ''; 732f3f0262cSandi $date = filemtime($oldf); 733f3f0262cSandi $newf = wikiFN($id,$date); 734f3f0262cSandi if(substr($newf,-3)=='.gz'){ 735f3f0262cSandi io_saveFile($newf,rawWiki($id)); 736f3f0262cSandi }else{ 737f3f0262cSandi io_makeFileDir($newf); 738f3f0262cSandi copy($oldf, $newf); 739f3f0262cSandi } 740f3f0262cSandi return $date; 741f3f0262cSandi} 742f3f0262cSandi 743f3f0262cSandi/** 744f3f0262cSandi * Sends a notify mail to the wikiadmin when a page was 745f3f0262cSandi * changed 74615fae107Sandi * 74715fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 748f3f0262cSandi */ 749f3f0262cSandifunction notify($id,$rev="",$summary=""){ 750f3f0262cSandi global $lang; 751f3f0262cSandi global $conf; 752f3f0262cSandi $hdrs =''; 753f3f0262cSandi if(empty($conf['notify'])) return; //notify enabled? 754f3f0262cSandi 755f3f0262cSandi $text = rawLocale('mailtext'); 756f3f0262cSandi $text = str_replace('@DATE@',date($conf['dformat']),$text); 757f3f0262cSandi $text = str_replace('@BROWSER@',$_SERVER['HTTP_USER_AGENT'],$text); 758f3f0262cSandi $text = str_replace('@IPADDRESS@',$_SERVER['REMOTE_ADDR'],$text); 759f3f0262cSandi $text = str_replace('@HOSTNAME@',gethostbyaddr($_SERVER['REMOTE_ADDR']),$text); 760f3f0262cSandi $text = str_replace('@NEWPAGE@',wl($id,'','',true),$text); 761f3f0262cSandi $text = str_replace('@DOKUWIKIURL@',getBaseURL(true),$text); 762f3f0262cSandi $text = str_replace('@SUMMARY@',$summary,$text); 763f3f0262cSandi 764f3f0262cSandi if($rev){ 765f3f0262cSandi $subject = $lang['mail_changed'].' '.$id; 766f3f0262cSandi $text = str_replace('@OLDPAGE@',wl($id,"rev=$rev",'',true),$text); 767f3f0262cSandi require_once("inc/DifferenceEngine.php"); 768f3f0262cSandi $df = new Diff(split("\n",rawWiki($id,$rev)), 769f3f0262cSandi split("\n",rawWiki($id))); 770f3f0262cSandi $dformat = new UnifiedDiffFormatter(); 771f3f0262cSandi $diff = $dformat->format($df); 772f3f0262cSandi }else{ 773f3f0262cSandi $subject=$lang['mail_newpage'].' '.$id; 774f3f0262cSandi $text = str_replace('@OLDPAGE@','none',$text); 775f3f0262cSandi $diff = rawWiki($id); 776f3f0262cSandi } 777f3f0262cSandi $text = str_replace('@DIFF@',$diff,$text); 778f3f0262cSandi 779f3f0262cSandi if (!empty($conf['mailfrom'])) { 780f3f0262cSandi $hdrs = 'From: '.$conf['mailfrom']."\n"; 781f3f0262cSandi } 782f3f0262cSandi @mail($conf['notify'],$subject,$text,$hdrs); 783f3f0262cSandi} 784f3f0262cSandi 78515fae107Sandi/** 78615fae107Sandi * Return a list of available page revisons 78715fae107Sandi * 78815fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 78915fae107Sandi */ 790f3f0262cSandifunction getRevisions($id){ 791f3f0262cSandi $revd = dirname(wikiFN($id,'foo')); 792f3f0262cSandi $revs = array(); 793f3f0262cSandi $clid = cleanID($id); 794f3f0262cSandi if(strrpos($clid,':')) $clid = substr($clid,strrpos($clid,':')+1); //remove path 795f3f0262cSandi 796f3f0262cSandi if (is_dir($revd) && $dh = opendir($revd)) { 797f3f0262cSandi while (($file = readdir($dh)) !== false) { 798f3f0262cSandi if (is_dir($revd.'/'.$file)) continue; 799f3f0262cSandi if (preg_match('/^'.$clid.'\.(\d+)\.txt(\.gz)?$/',$file,$match)){ 800f3f0262cSandi $revs[]=$match[1]; 801f3f0262cSandi } 802f3f0262cSandi } 803f3f0262cSandi closedir($dh); 804f3f0262cSandi } 805f3f0262cSandi rsort($revs); 806f3f0262cSandi return $revs; 807f3f0262cSandi} 808f3f0262cSandi 809f3f0262cSandi/** 810f3f0262cSandi * downloads a file from the net and saves it to the given location 81115fae107Sandi * 81215fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 813f3f0262cSandi */ 814f3f0262cSandifunction download($url,$file){ 815f3f0262cSandi $fp = @fopen($url,"rb"); 816f3f0262cSandi if(!$fp) return false; 817f3f0262cSandi 818f3f0262cSandi while(!feof($fp)){ 819f3f0262cSandi $cont.= fread($fp,1024); 820f3f0262cSandi } 821f3f0262cSandi fclose($fp); 822f3f0262cSandi 823f3f0262cSandi $fp2 = @fopen($file,"w"); 824f3f0262cSandi if(!$fp2) return false; 825f3f0262cSandi fwrite($fp2,$cont); 826f3f0262cSandi fclose($fp2); 827f3f0262cSandi return true; 828f3f0262cSandi} 829f3f0262cSandi 830f3f0262cSandi/** 831f3f0262cSandi * extracts the query from a google referer 83215fae107Sandi * 83315fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 834f3f0262cSandi */ 835f3f0262cSandifunction getGoogleQuery(){ 836f3f0262cSandi $url = parse_url($_SERVER['HTTP_REFERER']); 837f3f0262cSandi 838f3f0262cSandi if(!preg_match("#google\.#i",$url['host'])) return ''; 839f3f0262cSandi $query = array(); 840f3f0262cSandi parse_str($url['query'],$query); 841f3f0262cSandi 842f3f0262cSandi return $query['q']; 843f3f0262cSandi} 844f3f0262cSandi 845f3f0262cSandi/** 84615fae107Sandi * Try to set correct locale 84715fae107Sandi * 84815fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 849f3f0262cSandi */ 850f3f0262cSandifunction setCorrectLocale(){ 851f3f0262cSandi global $conf; 852f3f0262cSandi global $lang; 853f3f0262cSandi 854f3f0262cSandi $enc = strtoupper($lang['encoding']); 855f3f0262cSandi foreach ($lang['locales'] as $loc){ 856f3f0262cSandi //try locale 857f3f0262cSandi if(@setlocale(LC_ALL,$loc)) return; 858f3f0262cSandi //try loceale with encoding 859f3f0262cSandi if(@setlocale(LC_ALL,"$loc.$enc")) return; 860f3f0262cSandi } 861f3f0262cSandi //still here? try to set from environment 862f3f0262cSandi @setlocale(LC_ALL,""); 863f3f0262cSandi} 864f3f0262cSandi 865f3f0262cSandi/** 866f3f0262cSandi * Return the human readable size of a file 867f3f0262cSandi * 868f3f0262cSandi * @param int $size A file size 869f3f0262cSandi * @param int $dec A number of decimal places 870f3f0262cSandi * @author Martin Benjamin <b.martin@cybernet.ch> 871f3f0262cSandi * @author Aidan Lister <aidan@php.net> 872f3f0262cSandi * @version 1.0.0 873f3f0262cSandi */ 874f3f0262cSandifunction filesize_h($size, $dec = 1) 875f3f0262cSandi{ 876f3f0262cSandi $sizes = array('B', 'KB', 'MB', 'GB'); 877f3f0262cSandi $count = count($sizes); 878f3f0262cSandi $i = 0; 879f3f0262cSandi 880f3f0262cSandi while ($size >= 1024 && ($i < $count - 1)) { 881f3f0262cSandi $size /= 1024; 882f3f0262cSandi $i++; 883f3f0262cSandi } 884f3f0262cSandi 885f3f0262cSandi return round($size, $dec) . ' ' . $sizes[$i]; 886f3f0262cSandi} 887f3f0262cSandi 88815fae107Sandi/** 88915fae107Sandi * Run a few sanity checks 89015fae107Sandi * 89115fae107Sandi * @author Andreas Gohr <andi@splitbrain.org> 89215fae107Sandi */ 893f3f0262cSandifunction check(){ 894f3f0262cSandi global $conf; 895f3f0262cSandi global $INFO; 896f3f0262cSandi 89749022a38Sandi if(version_compare(phpversion(),'4.3.0','<')){ 89849022a38Sandi msg('Your PHP version is too old ('.phpversion().' vs. 4.3.+ recommended)',-1); 89949022a38Sandi }elseif(version_compare(phpversion(),'4.3.10','<')){ 90049022a38Sandi msg('Consider upgrading PHP to 4.3.10 or higher for security reasons (your version: '.phpversion().')',0); 90149022a38Sandi }else{ 90249022a38Sandi msg('PHP version '.phpversion(),1); 90349022a38Sandi } 90449022a38Sandi 905f3f0262cSandi if(is_writable($conf['changelog'])){ 906f3f0262cSandi msg('Changelog is writable',1); 907f3f0262cSandi }else{ 908f3f0262cSandi msg('Changelog is not writable',-1); 909f3f0262cSandi } 910f3f0262cSandi 911f3f0262cSandi if(is_writable($conf['datadir'])){ 912f3f0262cSandi msg('Datadir is writable',1); 913f3f0262cSandi }else{ 914f3f0262cSandi msg('Datadir is not writable',-1); 915f3f0262cSandi } 916f3f0262cSandi 917f3f0262cSandi if(is_writable($conf['olddir'])){ 918f3f0262cSandi msg('Attic is writable',1); 919f3f0262cSandi }else{ 920f3f0262cSandi msg('Attic is not writable',-1); 921f3f0262cSandi } 922f3f0262cSandi 923f3f0262cSandi if(is_writable($conf['mediadir'])){ 924f3f0262cSandi msg('Mediadir is writable',1); 925f3f0262cSandi }else{ 926f3f0262cSandi msg('Mediadir is not writable',-1); 927f3f0262cSandi } 928f3f0262cSandi 929f3f0262cSandi if(is_writable('conf/users.auth')){ 930f3f0262cSandi msg('conf/users.auth is writable',1); 931f3f0262cSandi }else{ 932f3f0262cSandi msg('conf/users.auth is not writable',0); 933f3f0262cSandi } 934f3f0262cSandi 935f3f0262cSandi msg('Your current permission for this page is '.$INFO['perm'],0); 936f3f0262cSandi 937f3f0262cSandi if(is_writable($INFO['filepath'])){ 938f3f0262cSandi msg('The current page is writable by the webserver',0); 939f3f0262cSandi }else{ 940f3f0262cSandi msg('The current page is not writable by the webserver',0); 941f3f0262cSandi } 942f3f0262cSandi 943f3f0262cSandi if($INFO['writable']){ 944f3f0262cSandi msg('The current page is writable by you',0); 945f3f0262cSandi }else{ 946f3f0262cSandi msg('The current page is not writable you',0); 947f3f0262cSandi } 948f3f0262cSandi} 949f3f0262cSandi?> 950