xref: /dokuwiki/inc/common.php (revision 099ada41d07014c78fb3945a40077dd01ee08c45)
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");
11c41c03f3Sandi  require_once('inc/utf8.php');
1244f669e9Sandi  require_once('inc/mail.php');
13f3f0262cSandi
14f3f0262cSandi  //set up error reporting to sane values
15f3f0262cSandi  error_reporting(E_ALL ^ E_NOTICE);
16f3f0262cSandi
17f3f0262cSandi  //make session rewrites XHTML compliant
18f3f0262cSandi  ini_set('arg_separator.output', '&amp;');
19f3f0262cSandi
20f3f0262cSandi  //init session
21f3f0262cSandi  session_name("DokuWiki");
22f3f0262cSandi  session_start();
23f3f0262cSandi
24f3f0262cSandi  //kill magic quotes
25f3f0262cSandi  if (get_magic_quotes_gpc()) {
26f3f0262cSandi    if (!empty($_GET))    remove_magic_quotes($_GET);
27f3f0262cSandi    if (!empty($_POST))   remove_magic_quotes($_POST);
28f3f0262cSandi    if (!empty($_COOKIE)) remove_magic_quotes($_COOKIE);
29f3f0262cSandi    if (!empty($_REQUEST)) remove_magic_quotes($_REQUEST);
30f3f0262cSandi    if (!empty($_SESSION)) remove_magic_quotes($_SESSION);
31f3f0262cSandi    ini_set('magic_quotes_gpc', 0);
32f3f0262cSandi  }
33f3f0262cSandi  set_magic_quotes_runtime(0);
34f3f0262cSandi  ini_set('magic_quotes_sybase',0);
35f3f0262cSandi
3615fae107Sandi  //disable gzip if not available
3715fae107Sandi  if($conf['usegzip'] && !function_exists('gzopen')){
3815fae107Sandi    $conf['usegzip'] = 0;
3915fae107Sandi  }
4015fae107Sandi
41b3222a5cSandi  //remember original umask
42b3222a5cSandi  $conf['oldumask'] = umask();
43b3222a5cSandi
44d7afada1Sandi  //make absolute mediaweb
45d7afada1Sandi  if(!preg_match('#^(https?://|/)#i',$conf['mediaweb'])){
46d7afada1Sandi    $conf['mediaweb'] = getBaseURL().$conf['mediaweb'];
47d7afada1Sandi  }
48d7afada1Sandi
4915fae107Sandi/**
5015fae107Sandi * remove magic quotes recursivly
5115fae107Sandi *
5215fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
5315fae107Sandi */
54f3f0262cSandifunction remove_magic_quotes(&$array) {
55f3f0262cSandi  foreach (array_keys($array) as $key) {
56f3f0262cSandi    if (is_array($array[$key])) {
57f3f0262cSandi      remove_magic_quotes($array[$key]);
58f3f0262cSandi    }else {
59f3f0262cSandi      $array[$key] = stripslashes($array[$key]);
60f3f0262cSandi    }
61f3f0262cSandi  }
62f3f0262cSandi}
63f3f0262cSandi
64f3f0262cSandi/**
6515fae107Sandi * Returns the full absolute URL to the directory where
66f3f0262cSandi * DokuWiki is installed in (includes a trailing slash)
6715fae107Sandi *
6815fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
69f3f0262cSandi */
70f3f0262cSandifunction getBaseURL($abs=false){
71f3f0262cSandi  global $conf;
72f3f0262cSandi  //if canonical url enabled always return absolute
73f3f0262cSandi  if($conf['canonical']) $abs = true;
74f3f0262cSandi
75f3f0262cSandi  //relative URLs are easy
76f3f0262cSandi  if(!$abs){
77f3f0262cSandi    $dir = dirname($_SERVER['PHP_SELF']).'/';
78f3f0262cSandi    $dir = preg_replace('#//#','/',$dir);
79ed847f2fSandi    $dir = preg_replace('#\\\/#','/',$dir); #bugfix for weird WIN behaviour
80f3f0262cSandi    return $dir;
81f3f0262cSandi  }
82f3f0262cSandi
83f3f0262cSandi  $port = ':'.$_SERVER['SERVER_PORT'];
84f3f0262cSandi  //remove port from hostheader as sent by IE
85f3f0262cSandi  $host = preg_replace('/:.*$/','',$_SERVER['HTTP_HOST']);
86f3f0262cSandi
87f3f0262cSandi  // see if HTTPS is enabled - apache leaves this empty when not available,
88f3f0262cSandi  // IIS sets it to 'off', 'false' and 'disabled' are just guessing
89f3f0262cSandi  if (preg_match('/^(|off|false|disabled)$/i',$_SERVER['HTTPS'])){
90f3f0262cSandi    $proto = 'http://';
91f3f0262cSandi    if ($_SERVER['SERVER_PORT'] == '80') {
92f3f0262cSandi      $port='';
93f3f0262cSandi    }
94f3f0262cSandi  }else{
95f3f0262cSandi    $proto = 'https://';
96f3f0262cSandi    if ($_SERVER['SERVER_PORT'] == '443') {
97f3f0262cSandi      $port='';
98f3f0262cSandi    }
99f3f0262cSandi  }
100f3f0262cSandi  $dir = (dirname($_SERVER['PHP_SELF'])).'/';
101f3f0262cSandi  $dir = preg_replace('#//#','/',$dir);
102f3f0262cSandi  $dir = preg_replace('#\/$#','/',$dir); #bugfix for weird WIN behaviour
103f3f0262cSandi
104f3f0262cSandi  return $proto.$host.$port.$dir;
105f3f0262cSandi}
106f3f0262cSandi
107f3f0262cSandi/**
10815fae107Sandi * Return info about the current document as associative
109f3f0262cSandi * array.
11015fae107Sandi *
11115fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
112f3f0262cSandi */
113f3f0262cSandifunction pageinfo(){
114f3f0262cSandi  global $ID;
115f3f0262cSandi  global $REV;
116f3f0262cSandi  global $USERINFO;
117f3f0262cSandi  global $conf;
118f3f0262cSandi
119f3f0262cSandi  if($_SERVER['REMOTE_USER']){
120f3f0262cSandi    $info['user']     = $_SERVER['REMOTE_USER'];
121f3f0262cSandi    $info['userinfo'] = $USERINFO;
122f3f0262cSandi    $info['perm']     = auth_quickaclcheck($ID);
123f3f0262cSandi  }else{
124f3f0262cSandi    $info['user']     = '';
125f3f0262cSandi    $info['perm']     = auth_aclcheck($ID,'',null);
126f3f0262cSandi  }
127f3f0262cSandi
128f3f0262cSandi  $info['namespace'] = getNS($ID);
129f3f0262cSandi  $info['locked']    = checklock($ID);
130f3f0262cSandi  $info['filepath']  = realpath(wikiFN($ID,$REV));
131f3f0262cSandi  $info['exists']    = @file_exists($info['filepath']);
132f3f0262cSandi  if($REV && !$info['exists']){
133f3f0262cSandi    //check if current revision was meant
134f3f0262cSandi    $cur = wikiFN($ID);
135f3f0262cSandi    if(@file_exists($cur) && (@filemtime($cur) == $REV)){
136f3f0262cSandi      $info['filepath'] = realpath($cur);
137f3f0262cSandi      $info['exists']   = true;
138f3f0262cSandi      $REV = '';
139f3f0262cSandi    }
140f3f0262cSandi  }
141f3f0262cSandi  if($info['exists']){
142f3f0262cSandi    $info['writable'] = (is_writable($info['filepath']) &&
143f3f0262cSandi                         ($info['perm'] >= AUTH_EDIT));
144f3f0262cSandi  }else{
145f3f0262cSandi    $info['writable'] = ($info['perm'] >= AUTH_CREATE);
146f3f0262cSandi  }
147f3f0262cSandi  $info['editable']  = ($info['writable'] && empty($info['lock']));
148f3f0262cSandi  $info['lastmod']   = @filemtime($info['filepath']);
149f3f0262cSandi
150652610a2Sandi  //who's the editor
151652610a2Sandi  if($REV){
152652610a2Sandi    $revinfo = getRevisionInfo($ID,$REV);
153652610a2Sandi  }else{
154652610a2Sandi    $revinfo = getRevisionInfo($ID,$info['lastmod']);
155652610a2Sandi  }
156652610a2Sandi  $info['ip']     = $revinfo['ip'];
157652610a2Sandi  $info['user']   = $revinfo['user'];
158652610a2Sandi  $info['sum']    = $revinfo['sum'];
159652610a2Sandi  $info['editor'] = $revinfo['ip'];
160652610a2Sandi  if($revinfo['user']) $info['editor'].= ' ('.$revinfo['user'].')';
161652610a2Sandi
162f3f0262cSandi  return $info;
163f3f0262cSandi}
164f3f0262cSandi
165f3f0262cSandi/**
1660396becbSandi * print a message
1670396becbSandi *
1680396becbSandi * If HTTP headers were not sent yet the message is added
1690396becbSandi * to the global message array else it's printed directly
1700396becbSandi * using html_msgarea()
1710396becbSandi *
172f3f0262cSandi *
173f3f0262cSandi * Levels can be:
174f3f0262cSandi *
175f3f0262cSandi * -1 error
176f3f0262cSandi *  0 info
177f3f0262cSandi *  1 success
17815fae107Sandi *
17915fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
1800396becbSandi * @see    html_msgarea
181f3f0262cSandi */
182f3f0262cSandifunction msg($message,$lvl=0){
183f3f0262cSandi  global $MSG;
184f3f0262cSandi  $errors[-1] = 'error';
185f3f0262cSandi  $errors[0]  = 'info';
186f3f0262cSandi  $errors[1]  = 'success';
187f3f0262cSandi
188cc20ad51Sandi  if(!headers_sent()){
189f3f0262cSandi    if(!isset($MSG)) $MSG = array();
190f3f0262cSandi    $MSG[]=array('lvl' => $errors[$lvl], 'msg' => $message);
1910396becbSandi  }else{
1920396becbSandi    $MSG = array();
1930396becbSandi    $MSG[]=array('lvl' => $errors[$lvl], 'msg' => $message);
1940396becbSandi    html_msgarea();
1950396becbSandi  }
196f3f0262cSandi}
197f3f0262cSandi
198f3f0262cSandi/**
19915fae107Sandi * This builds the breadcrumb trail and returns it as array
20015fae107Sandi *
20115fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
202f3f0262cSandi */
203f3f0262cSandifunction breadcrumbs(){
204f3f0262cSandi  global $ID;
205f3f0262cSandi  global $ACT;
206f3f0262cSandi  global $conf;
207f3f0262cSandi  $crumbs = $_SESSION[$conf['title']]['bc'];
208f3f0262cSandi
209f3f0262cSandi  //first visit?
210f3f0262cSandi  if (!is_array($crumbs)){
211f3f0262cSandi    $crumbs = array();
212f3f0262cSandi  }
213f3f0262cSandi  //we only save on show and existing wiki documents
214f3f0262cSandi  if($ACT != 'show' || !@file_exists(wikiFN($ID))){
215f3f0262cSandi    $_SESSION[$conf['title']]['bc'] = $crumbs;
216f3f0262cSandi    return $crumbs;
217f3f0262cSandi  }
218f3f0262cSandi  //remove ID from array
219f3f0262cSandi  $pos = array_search($ID,$crumbs);
220f3f0262cSandi  if($pos !== false && $pos !== null){
221f3f0262cSandi    array_splice($crumbs,$pos,1);
222f3f0262cSandi  }
223f3f0262cSandi
224f3f0262cSandi  //add to array
225f3f0262cSandi  $crumbs[] =$ID;
226f3f0262cSandi  //reduce size
227f3f0262cSandi  while(count($crumbs) > $conf['breadcrumbs']){
228f3f0262cSandi    array_shift($crumbs);
229f3f0262cSandi  }
230f3f0262cSandi  //save to session
231f3f0262cSandi  $_SESSION[$conf['title']]['bc'] = $crumbs;
232f3f0262cSandi  return $crumbs;
233f3f0262cSandi}
234f3f0262cSandi
235f3f0262cSandi/**
23615fae107Sandi * Filter for page IDs
23715fae107Sandi *
238f3f0262cSandi * This is run on a ID before it is outputted somewhere
239f3f0262cSandi * currently used to replace the colon with something else
240f3f0262cSandi * on Windows systems and to have proper URL encoding
24115fae107Sandi *
24249c713a3Sandi * Urlencoding is ommitted when the second parameter is false
24349c713a3Sandi *
24415fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
245f3f0262cSandi */
24649c713a3Sandifunction idfilter($id,$ue=true){
247f3f0262cSandi  global $conf;
248f3f0262cSandi  if ($conf['useslash'] && $conf['userewrite']){
249f3f0262cSandi    $id = strtr($id,':','/');
250f3f0262cSandi  }elseif (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN' &&
251f3f0262cSandi      $conf['userewrite']) {
252f3f0262cSandi    $id = strtr($id,':',';');
253f3f0262cSandi  }
25449c713a3Sandi  if($ue){
255f3f0262cSandi    $id = urlencode($id);
256f3f0262cSandi    $id = str_replace('%3A',':',$id); //keep as colon
257f3f0262cSandi    $id = str_replace('%2F','/',$id); //keep as slash
25849c713a3Sandi  }
259f3f0262cSandi  return $id;
260f3f0262cSandi}
261f3f0262cSandi
262f3f0262cSandi/**
263f3f0262cSandi * This builds a link to a wikipage (using getBaseURL)
26415fae107Sandi *
26515fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
266f3f0262cSandi */
267f3f0262cSandifunction wl($id='',$more='',$script='doku.php',$canonical=false){
268f3f0262cSandi  global $conf;
269f3f0262cSandi  $more = str_replace(',','&amp;',$more);
270f3f0262cSandi
271f3f0262cSandi  $id    = idfilter($id);
272f3f0262cSandi  $xlink = getBaseURL($canonical);
273f3f0262cSandi
274f3f0262cSandi  if(!$conf['userewrite']){
275f3f0262cSandi    $xlink .= $script;
276f3f0262cSandi    $xlink .= '?id='.$id;
277f3f0262cSandi    if($more) $xlink .= '&amp;'.$more;
278f3f0262cSandi  }else{
279f3f0262cSandi    $xlink .= $id;
280f3f0262cSandi    if($more) $xlink .= '?'.$more;
281f3f0262cSandi  }
282f3f0262cSandi
283f3f0262cSandi  return $xlink;
284f3f0262cSandi}
285f3f0262cSandi
286f3f0262cSandi/**
287f3f0262cSandi * Just builds a link to a script
28815fae107Sandi *
28915fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
290f3f0262cSandi */
291f3f0262cSandifunction script($script='doku.php'){
292f3f0262cSandi  $link = getBaseURL();
293f3f0262cSandi  $link .= $script;
294f3f0262cSandi  return $link;
295f3f0262cSandi}
296f3f0262cSandi
297f3f0262cSandi/**
298f3f0262cSandi * Return namespacepart of a wiki ID
29915fae107Sandi *
30015fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
301f3f0262cSandi */
302f3f0262cSandifunction getNS($id){
303f3f0262cSandi if(strpos($id,':')!==false){
304f3f0262cSandi   return substr($id,0,strrpos($id,':'));
305f3f0262cSandi }
306f3f0262cSandi return false;
307f3f0262cSandi}
308f3f0262cSandi
309f3f0262cSandi/**
31015fae107Sandi * Returns the ID without the namespace
31115fae107Sandi *
31215fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
313f3f0262cSandi */
314f3f0262cSandifunction noNS($id){
315f3f0262cSandi  return preg_replace('/.*:/','',$id);
316f3f0262cSandi}
317f3f0262cSandi
318f3f0262cSandi/**
31915fae107Sandi * Spamcheck against wordlist
32015fae107Sandi *
321f3f0262cSandi * Checks the wikitext against a list of blocked expressions
322f3f0262cSandi * returns true if the text contains any bad words
32315fae107Sandi *
32415fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
325f3f0262cSandi */
326f3f0262cSandifunction checkwordblock(){
327f3f0262cSandi  global $TEXT;
328f3f0262cSandi  global $conf;
329f3f0262cSandi
330f3f0262cSandi  if(!$conf['usewordblock']) return false;
331f3f0262cSandi
332703f6fdeSandi  $blockfile = file('conf/wordblock.conf');
3333e2965d7Sandi  //how many lines to read at once (to work around some PCRE limits)
3343e2965d7Sandi  if(version_compare(phpversion(),'4.3.0','<')){
3353e2965d7Sandi    //old versions of PCRE define a maximum of parenthesises even if no
3363e2965d7Sandi    //backreferences are used - the maximum is 99
3373e2965d7Sandi    //this is very bad performancewise and may even be too high still
3383e2965d7Sandi    $chunksize = 40;
3393e2965d7Sandi  }else{
340703f6fdeSandi    //read file in chunks of 600 - this should work around the
3413e2965d7Sandi    //MAX_PATTERN_SIZE in modern PCRE
3423e2965d7Sandi    $chunksize = 600;
3433e2965d7Sandi  }
3443e2965d7Sandi  while($blocks = array_splice($blockfile,0,$chunksize)){
345f3f0262cSandi    $re = array();
346f3f0262cSandi    #build regexp from blocks
347f3f0262cSandi    foreach($blocks as $block){
348f3f0262cSandi      $block = preg_replace('/#.*$/','',$block);
349f3f0262cSandi      $block = trim($block);
350f3f0262cSandi      if(empty($block)) continue;
351f3f0262cSandi      $re[]  = $block;
352f3f0262cSandi    }
353f3f0262cSandi    if(preg_match('#('.join('|',$re).')#si',$TEXT)) return true;
354703f6fdeSandi  }
355f3f0262cSandi  return false;
356f3f0262cSandi}
357f3f0262cSandi
358f3f0262cSandi/**
35915fae107Sandi * Return the IP of the client
36015fae107Sandi *
36115fae107Sandi * Honours X-Forwarded-For Proxy Headers
36215fae107Sandi *
36315fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
364f3f0262cSandi */
365f3f0262cSandifunction clientIP(){
366f3f0262cSandi  $my = $_SERVER['REMOTE_ADDR'];
367f3f0262cSandi  if($_SERVER['HTTP_X_FORWARDED_FOR']){
368f3f0262cSandi    $my .= ' ('.$_SERVER['HTTP_X_FORWARDED_FOR'].')';
369f3f0262cSandi  }
370f3f0262cSandi  return $my;
371f3f0262cSandi}
372f3f0262cSandi
373f3f0262cSandi/**
37415fae107Sandi * Checks if a given page is currently locked.
37515fae107Sandi *
376f3f0262cSandi * removes stale lockfiles
37715fae107Sandi *
37815fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
379f3f0262cSandi */
380f3f0262cSandifunction checklock($id){
381f3f0262cSandi  global $conf;
382f3f0262cSandi  $lock = wikiFN($id).'.lock';
383f3f0262cSandi
384f3f0262cSandi  //no lockfile
385f3f0262cSandi  if(!@file_exists($lock)) return false;
386f3f0262cSandi
387f3f0262cSandi  //lockfile expired
388f3f0262cSandi  if((time() - filemtime($lock)) > $conf['locktime']){
389f3f0262cSandi    unlink($lock);
390f3f0262cSandi    return false;
391f3f0262cSandi  }
392f3f0262cSandi
393f3f0262cSandi  //my own lock
394f3f0262cSandi  $ip = io_readFile($lock);
395f3f0262cSandi  if( ($ip == clientIP()) || ($ip == $_SERVER['REMOTE_USER']) ){
396f3f0262cSandi    return false;
397f3f0262cSandi  }
398f3f0262cSandi
399f3f0262cSandi  return $ip;
400f3f0262cSandi}
401f3f0262cSandi
402f3f0262cSandi/**
40315fae107Sandi * Lock a page for editing
40415fae107Sandi *
40515fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
406f3f0262cSandi */
407f3f0262cSandifunction lock($id){
408f3f0262cSandi  $lock = wikiFN($id).'.lock';
409f3f0262cSandi  if($_SERVER['REMOTE_USER']){
410f3f0262cSandi    io_saveFile($lock,$_SERVER['REMOTE_USER']);
411f3f0262cSandi  }else{
412f3f0262cSandi    io_saveFile($lock,clientIP());
413f3f0262cSandi  }
414f3f0262cSandi}
415f3f0262cSandi
416f3f0262cSandi/**
41715fae107Sandi * Unlock a page if it was locked by the user
418f3f0262cSandi *
41915fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
42015fae107Sandi * @return bool true if a lock was removed
421f3f0262cSandi */
422f3f0262cSandifunction unlock($id){
423f3f0262cSandi  $lock = wikiFN($id).'.lock';
424f3f0262cSandi  if(@file_exists($lock)){
425f3f0262cSandi    $ip = io_readFile($lock);
426f3f0262cSandi    if( ($ip == clientIP()) || ($ip == $_SERVER['REMOTE_USER']) ){
427f3f0262cSandi      @unlink($lock);
428f3f0262cSandi      return true;
429f3f0262cSandi    }
430f3f0262cSandi  }
431f3f0262cSandi  return false;
432f3f0262cSandi}
433f3f0262cSandi
434f3f0262cSandi/**
43515fae107Sandi * Remove unwanted chars from ID
43615fae107Sandi *
437f3f0262cSandi * Cleans a given ID to only use allowed characters. Accented characters are
438f3f0262cSandi * converted to unaccented ones
43915fae107Sandi *
44015fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
441f3f0262cSandi */
442f3f0262cSandifunction cleanID($id){
443f3f0262cSandi  global $conf;
444f3f0262cSandi  global $lang;
445f3f0262cSandi  $id = trim($id);
446c41c03f3Sandi  $id = utf8_strtolower($id);
447f3f0262cSandi
448f3f0262cSandi  //alternative namespace seperator
449f3f0262cSandi  $id = strtr($id,';',':');
4503021e063Sandi  if($conf['useslash']){
4513021e063Sandi    $id = strtr($id,'/',':');
4523021e063Sandi  }else{
4533021e063Sandi    $id = strtr($id,'/','_');
4543021e063Sandi  }
455f3f0262cSandi
4568b709e9dSandi  if($conf['deaccent']) $id = utf8_deaccent($id,-1);
457c41c03f3Sandi
458*099ada41Sandi  //remove specials
459*099ada41Sandi  //$id = preg_replace('#[\x00-\x20 ¡!"§$%&()\[\]{}¿\\?`\'\#~*+=,<>\|^°@µ¹²³¼½¬]#u','_',$id);
460*099ada41Sandi  $id = utf8_stripspecials($id,'_','_:.-');
461c41c03f3Sandi
462c41c03f3Sandi  //clean up
463f3f0262cSandi  $id = preg_replace('#__#','_',$id);
464f3f0262cSandi  $id = preg_replace('#:+#',':',$id);
465f3f0262cSandi  $id = trim($id,':._-');
466f3f0262cSandi  $id = preg_replace('#:[:\._\-]+#',':',$id);
467f3f0262cSandi
468f3f0262cSandi  return($id);
469f3f0262cSandi}
470f3f0262cSandi
471f3f0262cSandi/**
472f3f0262cSandi * returns the full path to the datafile specified by ID and
473f3f0262cSandi * optional revision
47415fae107Sandi *
47549c713a3Sandi * The filename is URL encoded to protect Unicode chars
47649c713a3Sandi *
47715fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
478f3f0262cSandi */
479f3f0262cSandifunction wikiFN($id,$rev=''){
480f3f0262cSandi  global $conf;
481f3f0262cSandi  $id = cleanID($id);
482f3f0262cSandi  $id = str_replace(':','/',$id);
483f3f0262cSandi  if(empty($rev)){
48449c713a3Sandi    $fn = $conf['datadir'].'/'.$id.'.txt';
485f3f0262cSandi  }else{
486f3f0262cSandi    $fn = $conf['olddir'].'/'.$id.'.'.$rev.'.txt';
48749c713a3Sandi    if($conf['usegzip'] && !@file_exists($fn)){
48849c713a3Sandi      //return gzip if enabled and plaintext doesn't exist
48949c713a3Sandi      $fn .= '.gz';
49049c713a3Sandi    }
49149c713a3Sandi  }
49249c713a3Sandi  $fn = utf8_encodeFN($fn);
493f3f0262cSandi  return $fn;
494f3f0262cSandi}
495f3f0262cSandi
496f3f0262cSandi/**
497f3f0262cSandi * Returns the full filepath to a localized textfile if local
498f3f0262cSandi * version isn't found the english one is returned
49915fae107Sandi *
50015fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
501f3f0262cSandi */
502f3f0262cSandifunction localeFN($id){
503f3f0262cSandi  global $conf;
504f3f0262cSandi  $file = './lang/'.$conf['lang'].'/'.$id.'.txt';
505f3f0262cSandi  if(!@file_exists($file)){
506f3f0262cSandi    //fall back to english
507f3f0262cSandi    $file = './lang/en/'.$id.'.txt';
508f3f0262cSandi  }
509f3f0262cSandi  return cleanText($file);
510f3f0262cSandi}
511f3f0262cSandi
512f3f0262cSandi/**
513f3f0262cSandi * convert line ending to unix format
514f3f0262cSandi *
51515fae107Sandi * @see    formText() for 2crlf conversion
51615fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
517f3f0262cSandi */
518f3f0262cSandifunction cleanText($text){
519f3f0262cSandi  $text = preg_replace("/(\015\012)|(\015)/","\012",$text);
520f3f0262cSandi  return $text;
521f3f0262cSandi}
522f3f0262cSandi
523f3f0262cSandi/**
524f3f0262cSandi * Prepares text for print in Webforms by encoding special chars.
525f3f0262cSandi * It also converts line endings to Windows format which is
526f3f0262cSandi * pseudo standard for webforms.
527f3f0262cSandi *
52815fae107Sandi * @see    cleanText() for 2unix conversion
52915fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
530f3f0262cSandi */
531f3f0262cSandifunction formText($text){
532f3f0262cSandi  $text = preg_replace("/\012/","\015\012",$text);
533f3f0262cSandi  return htmlspecialchars($text);
534f3f0262cSandi}
535f3f0262cSandi
536f3f0262cSandi/**
53715fae107Sandi * Returns the specified local text in parsed format
53815fae107Sandi *
53915fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
540f3f0262cSandi */
541f3f0262cSandifunction parsedLocale($id){
542f3f0262cSandi  //disable section editing
543f3f0262cSandi  global $parser;
544f3f0262cSandi  $se = $parser['secedit'];
545f3f0262cSandi  $parser['secedit'] = false;
546f3f0262cSandi  //fetch parsed locale
547f3f0262cSandi  $html = io_cacheParse(localeFN($id));
548f3f0262cSandi  //reset section editing
549f3f0262cSandi  $parser['secedit'] = $se;
550f3f0262cSandi  return $html;
551f3f0262cSandi}
552f3f0262cSandi
553f3f0262cSandi/**
55415fae107Sandi * Returns the specified local text in raw format
55515fae107Sandi *
55615fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
557f3f0262cSandi */
558f3f0262cSandifunction rawLocale($id){
559f3f0262cSandi  return io_readFile(localeFN($id));
560f3f0262cSandi}
561f3f0262cSandi
562f3f0262cSandi
563f3f0262cSandi/**
56415fae107Sandi * Returns the parsed Wikitext for the given id and revision.
56515fae107Sandi *
56615fae107Sandi * If $excuse is true an explanation is returned if the file
56715fae107Sandi * wasn't found
56815fae107Sandi *
56915fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
570f3f0262cSandi */
571f3f0262cSandifunction parsedWiki($id,$rev='',$excuse=true){
572f3f0262cSandi  $file = wikiFN($id,$rev);
573f3f0262cSandi  $ret  = '';
574f3f0262cSandi
575f3f0262cSandi  //ensure $id is in global $ID (needed for parsing)
576f3f0262cSandi  global $ID;
577f3f0262cSandi  $ID = $id;
578f3f0262cSandi
579f3f0262cSandi  if($rev){
580f3f0262cSandi    if(@file_exists($file)){
581f3f0262cSandi      $ret = parse(io_readFile($file));
582f3f0262cSandi    }elseif($excuse){
583f3f0262cSandi      $ret = parsedLocale('norev');
584f3f0262cSandi    }
585f3f0262cSandi  }else{
586f3f0262cSandi    if(@file_exists($file)){
587f3f0262cSandi      $ret = io_cacheParse($file);
588f3f0262cSandi    }elseif($excuse){
589f3f0262cSandi      $ret = parsedLocale('newpage');
590f3f0262cSandi    }
591f3f0262cSandi  }
592f3f0262cSandi  return $ret;
593f3f0262cSandi}
594f3f0262cSandi
595f3f0262cSandi/**
596f3f0262cSandi * Returns the raw WikiText
59715fae107Sandi *
59815fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
599f3f0262cSandi */
600f3f0262cSandifunction rawWiki($id,$rev=''){
601f3f0262cSandi  return io_readFile(wikiFN($id,$rev));
602f3f0262cSandi}
603f3f0262cSandi
604f3f0262cSandi/**
60515fae107Sandi * Returns the raw Wiki Text in three slices.
60615fae107Sandi *
60715fae107Sandi * The range parameter needs to have the form "from-to"
60815fae107Sandi * and gives the range of the section.
609f3f0262cSandi * The returned order is prefix, section and suffix.
61015fae107Sandi *
61115fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
612f3f0262cSandi */
613f3f0262cSandifunction rawWikiSlices($range,$id,$rev=''){
614f3f0262cSandi  list($from,$to) = split('-',$range,2);
615f3f0262cSandi  $text = io_readFile(wikiFN($id,$rev));
616f3f0262cSandi  $text = split("\n",$text);
617f3f0262cSandi  if(!$from) $from = 0;
618f3f0262cSandi  if(!$to)   $to   = count($text);
619f3f0262cSandi
620f3f0262cSandi  $slices[0] = join("\n",array_slice($text,0,$from));
621f3f0262cSandi  $slices[1] = join("\n",array_slice($text,$from,$to + 1  - $from));
622f3f0262cSandi  $slices[2] = join("\n",array_slice($text,$to+1));
623f3f0262cSandi
624f3f0262cSandi  return $slices;
625f3f0262cSandi}
626f3f0262cSandi
627f3f0262cSandi/**
62815fae107Sandi * Joins wiki text slices
62915fae107Sandi *
630f3f0262cSandi * function to join the text slices with correct lineendings again.
631f3f0262cSandi * When the pretty parameter is set to true it adds additional empty
632f3f0262cSandi * lines between sections if needed (used on saving).
63315fae107Sandi *
63415fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
635f3f0262cSandi */
636f3f0262cSandifunction con($pre,$text,$suf,$pretty=false){
637f3f0262cSandi
638f3f0262cSandi  if($pretty){
639f3f0262cSandi    if($pre && substr($pre,-1) != "\n") $pre .= "\n";
640f3f0262cSandi    if($suf && substr($text,-1) != "\n") $text .= "\n";
641f3f0262cSandi  }
642f3f0262cSandi
643f3f0262cSandi  if($pre) $pre .= "\n";
644f3f0262cSandi  if($suf) $text .= "\n";
645f3f0262cSandi  return $pre.$text.$suf;
646f3f0262cSandi}
647f3f0262cSandi
648f3f0262cSandi/**
64915fae107Sandi * print debug messages
65015fae107Sandi *
651f3f0262cSandi * little function to print the content of a var
65215fae107Sandi *
65315fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
654f3f0262cSandi */
655f3f0262cSandifunction dbg($msg,$hidden=false){
656f3f0262cSandi  (!$hidden) ? print '<pre class="dbg">' : print "<!--\n";
657f3f0262cSandi  print_r($msg);
658f3f0262cSandi  (!$hidden) ? print '</pre>' : print "\n-->";
659f3f0262cSandi}
660f3f0262cSandi
661f3f0262cSandi/**
662f3f0262cSandi * Add's an entry to the changelog
66315fae107Sandi *
66415fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
665f3f0262cSandi */
666652610a2Sandifunction addLogEntry($date,$id,$summary=""){
667f3f0262cSandi  global $conf;
668f3f0262cSandi  $id     = cleanID($id);
669652610a2Sandi  if(!$date) $date = time(); //use current time if none supplied
670f3f0262cSandi  $remote = $_SERVER['REMOTE_ADDR'];
671f3f0262cSandi  $user   = $_SERVER['REMOTE_USER'];
672f3f0262cSandi
673f3f0262cSandi  $logline = join("\t",array($date,$remote,$id,$user,$summary))."\n";
674f3f0262cSandi
675f3f0262cSandi  $fh = fopen($conf['changelog'],'a');
676f3f0262cSandi  if($fh){
677f3f0262cSandi    fwrite($fh,$logline);
678f3f0262cSandi    fclose($fh);
679f3f0262cSandi  }
680f3f0262cSandi}
681f3f0262cSandi
682f3f0262cSandi/**
683f3f0262cSandi * returns an array of recently changed files using the
684f3f0262cSandi * changelog
68515fae107Sandi *
68615fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
687f3f0262cSandi */
688f3f0262cSandifunction getRecents($num=0,$incdel=false){
689f3f0262cSandi  global $conf;
690f3f0262cSandi  $recent = array();
691f3f0262cSandi  if(!$num) $num = $conf['recent'];
692f3f0262cSandi
693f3f0262cSandi  $loglines = file($conf['changelog']);
694f3f0262cSandi  rsort($loglines); //reverse sort on timestamp
695f3f0262cSandi
696f3f0262cSandi  foreach ($loglines as $line){
697f3f0262cSandi    $line = rtrim($line);        //remove newline
698f3f0262cSandi    if(empty($line)) continue;   //skip empty lines
699f3f0262cSandi    $info = split("\t",$line);   //split into parts
700f3f0262cSandi    //add id if not in yet and file still exists and is allowed to read
701f3f0262cSandi    if(!$recent[$info[2]] &&
702f3f0262cSandi       (@file_exists(wikiFN($info[2])) || $incdel) &&
703f3f0262cSandi       (auth_quickaclcheck($info[2]) >= AUTH_READ)
704f3f0262cSandi      ){
705f3f0262cSandi      $recent[$info[2]]['date'] = $info[0];
706f3f0262cSandi      $recent[$info[2]]['ip']   = $info[1];
707f3f0262cSandi      $recent[$info[2]]['user'] = $info[3];
708f3f0262cSandi      $recent[$info[2]]['sum']  = $info[4];
709f3f0262cSandi      $recent[$info[2]]['del']  = !@file_exists(wikiFN($info[2]));
710f3f0262cSandi    }
711f3f0262cSandi    if(count($recent) >= $num){
712f3f0262cSandi      break; //finish if enough items found
713f3f0262cSandi    }
714f3f0262cSandi  }
715f3f0262cSandi  return $recent;
716f3f0262cSandi}
717f3f0262cSandi
718f3f0262cSandi/**
719652610a2Sandi * gets additonal informations for a certain pagerevison
720652610a2Sandi * from the changelog
721652610a2Sandi *
722652610a2Sandi * @author Andreas Gohr <andi@splitbrain.org>
723652610a2Sandi */
724652610a2Sandifunction getRevisionInfo($id,$rev){
725652610a2Sandi  global $conf;
726652610a2Sandi  $loglines = file($conf['changelog']);
727652610a2Sandi  $loglines = preg_grep("/$rev\t\d+\.\d+\.\d+\.\d+\t$id\t/",$loglines);
728652610a2Sandi  rsort($loglines); //reverse sort on timestamp (shouldn't be needed)
729652610a2Sandi  $line = split("\t",$loglines[0]);
730652610a2Sandi  $info['date'] = $line[0];
731652610a2Sandi  $info['ip']   = $line[1];
732652610a2Sandi  $info['user'] = $line[3];
733652610a2Sandi  $info['sum']   = $line[4];
734652610a2Sandi  return $info;
735652610a2Sandi}
736652610a2Sandi
737652610a2Sandi/**
738f3f0262cSandi * Saves a wikitext by calling io_saveFile
73915fae107Sandi *
74015fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
741f3f0262cSandi */
742f3f0262cSandifunction saveWikiText($id,$text,$summary){
743f3f0262cSandi  global $conf;
744f3f0262cSandi  global $lang;
745f3f0262cSandi  umask($conf['umask']);
746f3f0262cSandi  // ignore if no changes were made
747f3f0262cSandi  if($text == rawWiki($id,'')){
748f3f0262cSandi    return;
749f3f0262cSandi  }
750f3f0262cSandi
751f3f0262cSandi  $file = wikiFN($id);
752f3f0262cSandi  $old  = saveOldRevision($id);
753f3f0262cSandi
754f3f0262cSandi  if (empty($text)){
755f3f0262cSandi    // remove empty files
756f3f0262cSandi    @unlink($file);
757f3f0262cSandi    $del = true;
7583ce054b3Sandi    //autoset summary on deletion
7593ce054b3Sandi    if(empty($summary)) $summary = $lang['deleted'];
760f3f0262cSandi  }else{
761f3f0262cSandi    // save file (datadir is created in io_saveFile)
762f3f0262cSandi    io_saveFile($file,$text);
763f3f0262cSandi    $del = false;
764f3f0262cSandi  }
765f3f0262cSandi
766652610a2Sandi  addLogEntry(@filemtime($file),$id,$summary);
767f3f0262cSandi  notify($id,$old,$summary);
768f3f0262cSandi
769f3f0262cSandi  //purge cache on add by updating the purgefile
770f3f0262cSandi  if($conf['purgeonadd'] && (!$old || $del)){
771f3f0262cSandi    io_saveFile($conf['datadir'].'/.cache/purgefile',time());
772f3f0262cSandi  }
773f3f0262cSandi}
774f3f0262cSandi
775f3f0262cSandi/**
776f3f0262cSandi * moves the current version to the attic and returns its
777f3f0262cSandi * revision date
77815fae107Sandi *
77915fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
780f3f0262cSandi */
781f3f0262cSandifunction saveOldRevision($id){
782f3f0262cSandi	global $conf;
783f3f0262cSandi  umask($conf['umask']);
784f3f0262cSandi  $oldf = wikiFN($id);
785f3f0262cSandi  if(!@file_exists($oldf)) return '';
786f3f0262cSandi  $date = filemtime($oldf);
787f3f0262cSandi  $newf = wikiFN($id,$date);
788f3f0262cSandi  if(substr($newf,-3)=='.gz'){
789f3f0262cSandi    io_saveFile($newf,rawWiki($id));
790f3f0262cSandi  }else{
791f3f0262cSandi    io_makeFileDir($newf);
792f3f0262cSandi    copy($oldf, $newf);
793f3f0262cSandi  }
794f3f0262cSandi  return $date;
795f3f0262cSandi}
796f3f0262cSandi
797f3f0262cSandi/**
798f3f0262cSandi * Sends a notify mail to the wikiadmin when a page was
799f3f0262cSandi * changed
80015fae107Sandi *
80115fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
802f3f0262cSandi */
803f3f0262cSandifunction notify($id,$rev="",$summary=""){
804f3f0262cSandi  global $lang;
805f3f0262cSandi  global $conf;
806f3f0262cSandi  $hdrs ='';
807f3f0262cSandi  if(empty($conf['notify'])) return; //notify enabled?
808f3f0262cSandi
809f3f0262cSandi  $text = rawLocale('mailtext');
810f3f0262cSandi  $text = str_replace('@DATE@',date($conf['dformat']),$text);
811f3f0262cSandi  $text = str_replace('@BROWSER@',$_SERVER['HTTP_USER_AGENT'],$text);
812f3f0262cSandi  $text = str_replace('@IPADDRESS@',$_SERVER['REMOTE_ADDR'],$text);
813f3f0262cSandi  $text = str_replace('@HOSTNAME@',gethostbyaddr($_SERVER['REMOTE_ADDR']),$text);
814baf8cb38Sandi  $text = str_replace('@NEWPAGE@',wl($id,'','doku.php',true),$text);
815f3f0262cSandi  $text = str_replace('@DOKUWIKIURL@',getBaseURL(true),$text);
816f3f0262cSandi  $text = str_replace('@SUMMARY@',$summary,$text);
8177a82afdcSandi  $text = str_replace('@USER@',$_SERVER['REMOTE_USER'],$text);
818f3f0262cSandi
819f3f0262cSandi  if($rev){
820f3f0262cSandi    $subject = $lang['mail_changed'].' '.$id;
821baf8cb38Sandi    $text = str_replace('@OLDPAGE@',wl($id,"rev=$rev",'doku.php',true),$text);
822f3f0262cSandi    require_once("inc/DifferenceEngine.php");
823f3f0262cSandi    $df  = new Diff(split("\n",rawWiki($id,$rev)),
824f3f0262cSandi                    split("\n",rawWiki($id)));
825f3f0262cSandi    $dformat = new UnifiedDiffFormatter();
826f3f0262cSandi    $diff    = $dformat->format($df);
827f3f0262cSandi  }else{
828f3f0262cSandi    $subject=$lang['mail_newpage'].' '.$id;
829f3f0262cSandi    $text = str_replace('@OLDPAGE@','none',$text);
830f3f0262cSandi    $diff = rawWiki($id);
831f3f0262cSandi  }
832f3f0262cSandi  $text = str_replace('@DIFF@',$diff,$text);
833f3f0262cSandi
83444f669e9Sandi  mail_send($conf['notify'],$subject,$text,$conf['mailfrom']);
835f3f0262cSandi}
836f3f0262cSandi
83715fae107Sandi/**
83815fae107Sandi * Return a list of available page revisons
83915fae107Sandi *
84015fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
84115fae107Sandi */
842f3f0262cSandifunction getRevisions($id){
843f3f0262cSandi  $revd = dirname(wikiFN($id,'foo'));
844f3f0262cSandi  $revs = array();
845f3f0262cSandi  $clid = cleanID($id);
846f3f0262cSandi  if(strrpos($clid,':')) $clid = substr($clid,strrpos($clid,':')+1); //remove path
847f3f0262cSandi
848f3f0262cSandi  if (is_dir($revd) && $dh = opendir($revd)) {
849f3f0262cSandi    while (($file = readdir($dh)) !== false) {
850f3f0262cSandi      if (is_dir($revd.'/'.$file)) continue;
851f3f0262cSandi      if (preg_match('/^'.$clid.'\.(\d+)\.txt(\.gz)?$/',$file,$match)){
852f3f0262cSandi        $revs[]=$match[1];
853f3f0262cSandi      }
854f3f0262cSandi    }
855f3f0262cSandi    closedir($dh);
856f3f0262cSandi  }
857f3f0262cSandi  rsort($revs);
858f3f0262cSandi  return $revs;
859f3f0262cSandi}
860f3f0262cSandi
861f3f0262cSandi/**
862f3f0262cSandi * downloads a file from the net and saves it to the given location
86315fae107Sandi *
86415fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
865f3f0262cSandi */
866f3f0262cSandifunction download($url,$file){
867f3f0262cSandi  $fp = @fopen($url,"rb");
868f3f0262cSandi  if(!$fp) return false;
869f3f0262cSandi
870f3f0262cSandi  while(!feof($fp)){
871f3f0262cSandi    $cont.= fread($fp,1024);
872f3f0262cSandi  }
873f3f0262cSandi  fclose($fp);
874f3f0262cSandi
875f3f0262cSandi  $fp2 = @fopen($file,"w");
876f3f0262cSandi  if(!$fp2) return false;
877f3f0262cSandi  fwrite($fp2,$cont);
878f3f0262cSandi  fclose($fp2);
879f3f0262cSandi  return true;
880f3f0262cSandi}
881f3f0262cSandi
882f3f0262cSandi/**
883f3f0262cSandi * extracts the query from a google referer
88415fae107Sandi *
88515fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
886f3f0262cSandi */
887f3f0262cSandifunction getGoogleQuery(){
888f3f0262cSandi  $url = parse_url($_SERVER['HTTP_REFERER']);
889f3f0262cSandi
890f3f0262cSandi  if(!preg_match("#google\.#i",$url['host'])) return '';
891f3f0262cSandi  $query = array();
892f3f0262cSandi  parse_str($url['query'],$query);
893f3f0262cSandi
894f3f0262cSandi  return $query['q'];
895f3f0262cSandi}
896f3f0262cSandi
897f3f0262cSandi/**
89815fae107Sandi * Try to set correct locale
89915fae107Sandi *
900095bfd5cSandi * @deprecated No longer used
90115fae107Sandi * @author     Andreas Gohr <andi@splitbrain.org>
902f3f0262cSandi */
903f3f0262cSandifunction setCorrectLocale(){
904f3f0262cSandi  global $conf;
905f3f0262cSandi  global $lang;
906f3f0262cSandi
907f3f0262cSandi  $enc = strtoupper($lang['encoding']);
908f3f0262cSandi  foreach ($lang['locales'] as $loc){
909f3f0262cSandi    //try locale
910f3f0262cSandi    if(@setlocale(LC_ALL,$loc)) return;
911f3f0262cSandi    //try loceale with encoding
912f3f0262cSandi    if(@setlocale(LC_ALL,"$loc.$enc")) return;
913f3f0262cSandi  }
914f3f0262cSandi  //still here? try to set from environment
915f3f0262cSandi  @setlocale(LC_ALL,"");
916f3f0262cSandi}
917f3f0262cSandi
918f3f0262cSandi/**
919f3f0262cSandi * Return the human readable size of a file
920f3f0262cSandi *
921f3f0262cSandi * @param       int    $size   A file size
922f3f0262cSandi * @param       int    $dec    A number of decimal places
923f3f0262cSandi * @author      Martin Benjamin <b.martin@cybernet.ch>
924f3f0262cSandi * @author      Aidan Lister <aidan@php.net>
925f3f0262cSandi * @version     1.0.0
926f3f0262cSandi */
927f31d5b73Sandifunction filesize_h($size, $dec = 1){
928f3f0262cSandi  $sizes = array('B', 'KB', 'MB', 'GB');
929f3f0262cSandi  $count = count($sizes);
930f3f0262cSandi  $i = 0;
931f3f0262cSandi
932f3f0262cSandi  while ($size >= 1024 && ($i < $count - 1)) {
933f3f0262cSandi    $size /= 1024;
934f3f0262cSandi    $i++;
935f3f0262cSandi  }
936f3f0262cSandi
937f3f0262cSandi  return round($size, $dec) . ' ' . $sizes[$i];
938f3f0262cSandi}
939f3f0262cSandi
94015fae107Sandi/**
94115fae107Sandi * Run a few sanity checks
94215fae107Sandi *
94315fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
94415fae107Sandi */
945f31d5b73Sandifunction getVersion(){
946f31d5b73Sandi  //import version string
947f31d5b73Sandi  if(@file_exists('VERSION')){
948f31d5b73Sandi    //official release
949f31d5b73Sandi    return 'Release '.io_readfile('VERSION');
950f31d5b73Sandi  }elseif(is_dir('_darcs')){
951f31d5b73Sandi    //darcs checkout
952f31d5b73Sandi    $inv = file('_darcs/inventory');
953f31d5b73Sandi    $inv = preg_grep('#andi@splitbrain\.org\*\*\d{14}#',$inv);
954f31d5b73Sandi    $cur = array_pop($inv);
955f31d5b73Sandi    preg_match('#\*\*(\d{4})(\d{2})(\d{2})#',$cur,$matches);
956f31d5b73Sandi    return 'Darcs '.$matches[1].'-'.$matches[2].'-'.$matches[3];
957f31d5b73Sandi  }else{
958f31d5b73Sandi    return 'snapshot?';
959f31d5b73Sandi  }
960f31d5b73Sandi}
961f31d5b73Sandi
962f31d5b73Sandi/**
963f31d5b73Sandi * Run a few sanity checks
964f31d5b73Sandi *
965f31d5b73Sandi * @author Andreas Gohr <andi@splitbrain.org>
966f31d5b73Sandi */
967f3f0262cSandifunction check(){
968f3f0262cSandi  global $conf;
969f3f0262cSandi  global $INFO;
970f3f0262cSandi
971f31d5b73Sandi  msg('DokuWiki version: '.getVersion(),1);
972f31d5b73Sandi
97349022a38Sandi  if(version_compare(phpversion(),'4.3.0','<')){
97449022a38Sandi    msg('Your PHP version is too old ('.phpversion().' vs. 4.3.+ recommended)',-1);
97549022a38Sandi  }elseif(version_compare(phpversion(),'4.3.10','<')){
97649022a38Sandi    msg('Consider upgrading PHP to 4.3.10 or higher for security reasons (your version: '.phpversion().')',0);
97749022a38Sandi  }else{
97849022a38Sandi    msg('PHP version '.phpversion(),1);
97949022a38Sandi  }
98049022a38Sandi
981f3f0262cSandi  if(is_writable($conf['changelog'])){
982f3f0262cSandi    msg('Changelog is writable',1);
983f3f0262cSandi  }else{
984f3f0262cSandi    msg('Changelog is not writable',-1);
985f3f0262cSandi  }
986f3f0262cSandi
987f3f0262cSandi  if(is_writable($conf['datadir'])){
988f3f0262cSandi    msg('Datadir is writable',1);
989f3f0262cSandi  }else{
990f3f0262cSandi    msg('Datadir is not writable',-1);
991f3f0262cSandi  }
992f3f0262cSandi
993f3f0262cSandi  if(is_writable($conf['olddir'])){
994f3f0262cSandi    msg('Attic is writable',1);
995f3f0262cSandi  }else{
996f3f0262cSandi    msg('Attic is not writable',-1);
997f3f0262cSandi  }
998f3f0262cSandi
999f3f0262cSandi  if(is_writable($conf['mediadir'])){
1000f3f0262cSandi    msg('Mediadir is writable',1);
1001f3f0262cSandi  }else{
1002f3f0262cSandi    msg('Mediadir is not writable',-1);
1003f3f0262cSandi  }
1004f3f0262cSandi
1005f3f0262cSandi  if(is_writable('conf/users.auth')){
1006f3f0262cSandi    msg('conf/users.auth is writable',1);
1007f3f0262cSandi  }else{
1008f3f0262cSandi    msg('conf/users.auth is not writable',0);
1009f3f0262cSandi  }
101093a9e835Sandi
101193a9e835Sandi  if(function_exists('mb_strpos')){
101293a9e835Sandi    if(defined('UTF8_NOMBSTRING')){
101393a9e835Sandi      msg('mb_string extension is available but will not be used',0);
101493a9e835Sandi    }else{
101593a9e835Sandi      msg('mb_string extension is available and will be used',1);
101693a9e835Sandi    }
101793a9e835Sandi  }else{
101893a9e835Sandi    msg('mb_string extension not available - PHP only replacements will be used',0);
101993a9e835Sandi  }
1020f3f0262cSandi
1021f3f0262cSandi  msg('Your current permission for this page is '.$INFO['perm'],0);
1022f3f0262cSandi
1023f3f0262cSandi  if(is_writable($INFO['filepath'])){
1024f3f0262cSandi    msg('The current page is writable by the webserver',0);
1025f3f0262cSandi  }else{
1026f3f0262cSandi    msg('The current page is not writable by the webserver',0);
1027f3f0262cSandi  }
1028f3f0262cSandi
1029f3f0262cSandi  if($INFO['writable']){
1030f3f0262cSandi    msg('The current page is writable by you',0);
1031f3f0262cSandi  }else{
1032f3f0262cSandi    msg('The current page is not writable you',0);
1033f3f0262cSandi  }
1034f3f0262cSandi}
1035f3f0262cSandi?>
1036