xref: /dokuwiki/inc/common.php (revision 15fae1076f4439c7cd1302494a48e24f707a3020)
1f3f0262cSandi<?
2*15fae107Sandi/**
3*15fae107Sandi * Common DokuWiki functions
4*15fae107Sandi *
5*15fae107Sandi * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
6*15fae107Sandi * @author     Andreas Gohr <andi@splitbrain.org>
7*15fae107Sandi */
8*15fae107Sandi
9f3f0262cSandi  require_once("conf/dokuwiki.php");
10f3f0262cSandi  require_once("inc/io.php");
11f3f0262cSandi
12f3f0262cSandi  //set up error reporting to sane values
13f3f0262cSandi  error_reporting(E_ALL ^ E_NOTICE);
14f3f0262cSandi
15f3f0262cSandi  //make session rewrites XHTML compliant
16f3f0262cSandi  ini_set('arg_separator.output', '&amp;');
17f3f0262cSandi
18f3f0262cSandi  //init session
19f3f0262cSandi  session_name("DokuWiki");
20f3f0262cSandi  session_start();
21f3f0262cSandi
22f3f0262cSandi  //kill magic quotes
23f3f0262cSandi  if (get_magic_quotes_gpc()) {
24f3f0262cSandi    if (!empty($_GET))    remove_magic_quotes($_GET);
25f3f0262cSandi    if (!empty($_POST))   remove_magic_quotes($_POST);
26f3f0262cSandi    if (!empty($_COOKIE)) remove_magic_quotes($_COOKIE);
27f3f0262cSandi    if (!empty($_REQUEST)) remove_magic_quotes($_REQUEST);
28f3f0262cSandi    if (!empty($_SESSION)) remove_magic_quotes($_SESSION);
29f3f0262cSandi    ini_set('magic_quotes_gpc', 0);
30f3f0262cSandi  }
31f3f0262cSandi  set_magic_quotes_runtime(0);
32f3f0262cSandi  ini_set('magic_quotes_sybase',0);
33f3f0262cSandi
34*15fae107Sandi  //disable gzip if not available
35*15fae107Sandi  if($conf['usegzip'] && !function_exists('gzopen')){
36*15fae107Sandi    $conf['usegzip'] = 0;
37*15fae107Sandi  }
38*15fae107Sandi
39*15fae107Sandi/**
40*15fae107Sandi * remove magic quotes recursivly
41*15fae107Sandi *
42*15fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
43*15fae107Sandi */
44f3f0262cSandifunction remove_magic_quotes(&$array) {
45f3f0262cSandi  foreach (array_keys($array) as $key) {
46f3f0262cSandi    if (is_array($array[$key])) {
47f3f0262cSandi      remove_magic_quotes($array[$key]);
48f3f0262cSandi    }else {
49f3f0262cSandi      $array[$key] = stripslashes($array[$key]);
50f3f0262cSandi    }
51f3f0262cSandi  }
52f3f0262cSandi}
53f3f0262cSandi
54f3f0262cSandi/**
55*15fae107Sandi * Returns the full absolute URL to the directory where
56f3f0262cSandi * DokuWiki is installed in (includes a trailing slash)
57*15fae107Sandi *
58*15fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
59f3f0262cSandi */
60f3f0262cSandifunction getBaseURL($abs=false){
61f3f0262cSandi  global $conf;
62f3f0262cSandi  //if canonical url enabled always return absolute
63f3f0262cSandi  if($conf['canonical']) $abs = true;
64f3f0262cSandi
65f3f0262cSandi  //relative URLs are easy
66f3f0262cSandi  if(!$abs){
67f3f0262cSandi    $dir = dirname($_SERVER['PHP_SELF']).'/';
68f3f0262cSandi    $dir = preg_replace('#//#','/',$dir);
69f3f0262cSandi    $dir = preg_replace('#\/$#','/',$dir); #bugfix for weird WIN behaviour
70f3f0262cSandi    return $dir;
71f3f0262cSandi  }
72f3f0262cSandi
73f3f0262cSandi  $port = ':'.$_SERVER['SERVER_PORT'];
74f3f0262cSandi  //remove port from hostheader as sent by IE
75f3f0262cSandi  $host = preg_replace('/:.*$/','',$_SERVER['HTTP_HOST']);
76f3f0262cSandi
77f3f0262cSandi  // see if HTTPS is enabled - apache leaves this empty when not available,
78f3f0262cSandi  // IIS sets it to 'off', 'false' and 'disabled' are just guessing
79f3f0262cSandi  if (preg_match('/^(|off|false|disabled)$/i',$_SERVER['HTTPS'])){
80f3f0262cSandi    $proto = 'http://';
81f3f0262cSandi    if ($_SERVER['SERVER_PORT'] == '80') {
82f3f0262cSandi      $port='';
83f3f0262cSandi    }
84f3f0262cSandi  }else{
85f3f0262cSandi    $proto = 'https://';
86f3f0262cSandi    if ($_SERVER['SERVER_PORT'] == '443') {
87f3f0262cSandi      $port='';
88f3f0262cSandi    }
89f3f0262cSandi  }
90f3f0262cSandi  $dir = (dirname($_SERVER['PHP_SELF'])).'/';
91f3f0262cSandi  $dir = preg_replace('#//#','/',$dir);
92f3f0262cSandi  $dir = preg_replace('#\/$#','/',$dir); #bugfix for weird WIN behaviour
93f3f0262cSandi
94f3f0262cSandi  return $proto.$host.$port.$dir;
95f3f0262cSandi}
96f3f0262cSandi
97f3f0262cSandi/**
98*15fae107Sandi * Return info about the current document as associative
99f3f0262cSandi * array.
100*15fae107Sandi *
101*15fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
102f3f0262cSandi */
103f3f0262cSandifunction pageinfo(){
104f3f0262cSandi  global $ID;
105f3f0262cSandi  global $REV;
106f3f0262cSandi  global $USERINFO;
107f3f0262cSandi  global $conf;
108f3f0262cSandi
109f3f0262cSandi  if($_SERVER['REMOTE_USER']){
110f3f0262cSandi    $info['user']     = $_SERVER['REMOTE_USER'];
111f3f0262cSandi    $info['userinfo'] = $USERINFO;
112f3f0262cSandi    $info['perm']     = auth_quickaclcheck($ID);
113f3f0262cSandi  }else{
114f3f0262cSandi    $info['user']     = '';
115f3f0262cSandi    $info['perm']     = auth_aclcheck($ID,'',null);
116f3f0262cSandi  }
117f3f0262cSandi
118f3f0262cSandi  $info['namespace'] = getNS($ID);
119f3f0262cSandi  $info['locked']    = checklock($ID);
120f3f0262cSandi  $info['filepath']  = realpath(wikiFN($ID,$REV));
121f3f0262cSandi  $info['exists']    = @file_exists($info['filepath']);
122f3f0262cSandi  if($REV && !$info['exists']){
123f3f0262cSandi    //check if current revision was meant
124f3f0262cSandi    $cur = wikiFN($ID);
125f3f0262cSandi    if(@file_exists($cur) && (@filemtime($cur) == $REV)){
126f3f0262cSandi      $info['filepath'] = realpath($cur);
127f3f0262cSandi      $info['exists']   = true;
128f3f0262cSandi      $REV = '';
129f3f0262cSandi    }
130f3f0262cSandi  }
131f3f0262cSandi  if($info['exists']){
132f3f0262cSandi    $info['writable'] = (is_writable($info['filepath']) &&
133f3f0262cSandi                         ($info['perm'] >= AUTH_EDIT));
134f3f0262cSandi  }else{
135f3f0262cSandi    $info['writable'] = ($info['perm'] >= AUTH_CREATE);
136f3f0262cSandi  }
137f3f0262cSandi  $info['editable']  = ($info['writable'] && empty($info['lock']));
138f3f0262cSandi  $info['lastmod']   = @filemtime($info['filepath']);
139f3f0262cSandi
140f3f0262cSandi  return $info;
141f3f0262cSandi}
142f3f0262cSandi
143f3f0262cSandi/**
144f3f0262cSandi * adds a message to the global message array
145f3f0262cSandi *
146f3f0262cSandi * Levels can be:
147f3f0262cSandi *
148f3f0262cSandi * -1 error
149f3f0262cSandi *  0 info
150f3f0262cSandi *  1 success
151*15fae107Sandi *
152*15fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
153f3f0262cSandi */
154f3f0262cSandifunction msg($message,$lvl=0){
155f3f0262cSandi  global $MSG;
156f3f0262cSandi  $errors[-1] = 'error';
157f3f0262cSandi  $errors[0]  = 'info';
158f3f0262cSandi  $errors[1]  = 'success';
159f3f0262cSandi
160f3f0262cSandi  if(!isset($MSG)) $MSG = array();
161f3f0262cSandi  $MSG[]=array('lvl' => $errors[$lvl], 'msg' => $message);
162f3f0262cSandi}
163f3f0262cSandi
164f3f0262cSandi/**
165*15fae107Sandi * This builds the breadcrumb trail and returns it as array
166*15fae107Sandi *
167*15fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
168f3f0262cSandi */
169f3f0262cSandifunction breadcrumbs(){
170f3f0262cSandi  global $ID;
171f3f0262cSandi  global $ACT;
172f3f0262cSandi  global $conf;
173f3f0262cSandi  $crumbs = $_SESSION[$conf['title']]['bc'];
174f3f0262cSandi
175f3f0262cSandi  //first visit?
176f3f0262cSandi  if (!is_array($crumbs)){
177f3f0262cSandi    $crumbs = array();
178f3f0262cSandi  }
179f3f0262cSandi  //we only save on show and existing wiki documents
180f3f0262cSandi  if($ACT != 'show' || !@file_exists(wikiFN($ID))){
181f3f0262cSandi    $_SESSION[$conf['title']]['bc'] = $crumbs;
182f3f0262cSandi    return $crumbs;
183f3f0262cSandi  }
184f3f0262cSandi  //remove ID from array
185f3f0262cSandi  $pos = array_search($ID,$crumbs);
186f3f0262cSandi  if($pos !== false && $pos !== null){
187f3f0262cSandi    array_splice($crumbs,$pos,1);
188f3f0262cSandi  }
189f3f0262cSandi
190f3f0262cSandi  //add to array
191f3f0262cSandi  $crumbs[] =$ID;
192f3f0262cSandi  //reduce size
193f3f0262cSandi  while(count($crumbs) > $conf['breadcrumbs']){
194f3f0262cSandi    array_shift($crumbs);
195f3f0262cSandi  }
196f3f0262cSandi  //save to session
197f3f0262cSandi  $_SESSION[$conf['title']]['bc'] = $crumbs;
198f3f0262cSandi  return $crumbs;
199f3f0262cSandi}
200f3f0262cSandi
201f3f0262cSandi/**
202*15fae107Sandi * Filter for page IDs
203*15fae107Sandi *
204f3f0262cSandi * This is run on a ID before it is outputted somewhere
205f3f0262cSandi * currently used to replace the colon with something else
206f3f0262cSandi * on Windows systems and to have proper URL encoding
207*15fae107Sandi *
208*15fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
209f3f0262cSandi */
210f3f0262cSandifunction idfilter($id){
211f3f0262cSandi  global $conf;
212f3f0262cSandi  if ($conf['useslash'] && $conf['userewrite']){
213f3f0262cSandi    $id = strtr($id,':','/');
214f3f0262cSandi  }elseif (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN' &&
215f3f0262cSandi      $conf['userewrite']) {
216f3f0262cSandi    $id = strtr($id,':',';');
217f3f0262cSandi  }
218f3f0262cSandi  $id = urlencode($id);
219f3f0262cSandi  $id = str_replace('%3A',':',$id); //keep as colon
220f3f0262cSandi  $id = str_replace('%2F','/',$id); //keep as slash
221f3f0262cSandi  return $id;
222f3f0262cSandi}
223f3f0262cSandi
224f3f0262cSandi/**
225f3f0262cSandi * This builds a link to a wikipage (using getBaseURL)
226*15fae107Sandi *
227*15fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
228f3f0262cSandi */
229f3f0262cSandifunction wl($id='',$more='',$script='doku.php',$canonical=false){
230f3f0262cSandi  global $conf;
231f3f0262cSandi  $more = str_replace(',','&amp;',$more);
232f3f0262cSandi
233f3f0262cSandi  $id    = idfilter($id);
234f3f0262cSandi  $xlink = getBaseURL($canonical);
235f3f0262cSandi
236f3f0262cSandi  if(!$conf['userewrite']){
237f3f0262cSandi    $xlink .= $script;
238f3f0262cSandi    $xlink .= '?id='.$id;
239f3f0262cSandi    if($more) $xlink .= '&amp;'.$more;
240f3f0262cSandi  }else{
241f3f0262cSandi    $xlink .= $id;
242f3f0262cSandi    if($more) $xlink .= '?'.$more;
243f3f0262cSandi  }
244f3f0262cSandi
245f3f0262cSandi  return $xlink;
246f3f0262cSandi}
247f3f0262cSandi
248f3f0262cSandi/**
249f3f0262cSandi * Just builds a link to a script
250*15fae107Sandi *
251*15fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
252f3f0262cSandi */
253f3f0262cSandifunction script($script='doku.php'){
254f3f0262cSandi  $link = getBaseURL();
255f3f0262cSandi  $link .= $script;
256f3f0262cSandi  return $link;
257f3f0262cSandi}
258f3f0262cSandi
259f3f0262cSandi/**
260f3f0262cSandi * Return namespacepart of a wiki ID
261*15fae107Sandi *
262*15fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
263f3f0262cSandi */
264f3f0262cSandifunction getNS($id){
265f3f0262cSandi if(strpos($id,':')!==false){
266f3f0262cSandi   return substr($id,0,strrpos($id,':'));
267f3f0262cSandi }
268f3f0262cSandi return false;
269f3f0262cSandi}
270f3f0262cSandi
271f3f0262cSandi/**
272*15fae107Sandi * Returns the ID without the namespace
273*15fae107Sandi *
274*15fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
275f3f0262cSandi */
276f3f0262cSandifunction noNS($id){
277f3f0262cSandi  return preg_replace('/.*:/','',$id);
278f3f0262cSandi}
279f3f0262cSandi
280f3f0262cSandi/**
281*15fae107Sandi * Spamcheck against wordlist
282*15fae107Sandi *
283f3f0262cSandi * Checks the wikitext against a list of blocked expressions
284f3f0262cSandi * returns true if the text contains any bad words
285*15fae107Sandi *
286*15fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
287f3f0262cSandi */
288f3f0262cSandifunction checkwordblock(){
289f3f0262cSandi  global $TEXT;
290f3f0262cSandi  global $conf;
291f3f0262cSandi
292f3f0262cSandi  if(!$conf['usewordblock']) return false;
293f3f0262cSandi
294f3f0262cSandi  $blocks = file('conf/wordblock.conf');
295f3f0262cSandi  $re = array();
296f3f0262cSandi  #build regexp from blocks
297f3f0262cSandi  foreach($blocks as $block){
298f3f0262cSandi    $block = preg_replace('/#.*$/','',$block);
299f3f0262cSandi    $block = trim($block);
300f3f0262cSandi    if(empty($block)) continue;
301f3f0262cSandi    $re[]  = $block;
302f3f0262cSandi  }
303f3f0262cSandi  if(preg_match('#('.join('|',$re).')#si',$TEXT)) return true;
304f3f0262cSandi  return false;
305f3f0262cSandi}
306f3f0262cSandi
307f3f0262cSandi/**
308*15fae107Sandi * Return the IP of the client
309*15fae107Sandi *
310*15fae107Sandi * Honours X-Forwarded-For Proxy Headers
311*15fae107Sandi *
312*15fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
313f3f0262cSandi */
314f3f0262cSandifunction clientIP(){
315f3f0262cSandi  $my = $_SERVER['REMOTE_ADDR'];
316f3f0262cSandi  if($_SERVER['HTTP_X_FORWARDED_FOR']){
317f3f0262cSandi    $my .= ' ('.$_SERVER['HTTP_X_FORWARDED_FOR'].')';
318f3f0262cSandi  }
319f3f0262cSandi  return $my;
320f3f0262cSandi}
321f3f0262cSandi
322f3f0262cSandi/**
323*15fae107Sandi * Checks if a given page is currently locked.
324*15fae107Sandi *
325f3f0262cSandi * removes stale lockfiles
326*15fae107Sandi *
327*15fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
328f3f0262cSandi */
329f3f0262cSandifunction checklock($id){
330f3f0262cSandi  global $conf;
331f3f0262cSandi  $lock = wikiFN($id).'.lock';
332f3f0262cSandi
333f3f0262cSandi  //no lockfile
334f3f0262cSandi  if(!@file_exists($lock)) return false;
335f3f0262cSandi
336f3f0262cSandi  //lockfile expired
337f3f0262cSandi  if((time() - filemtime($lock)) > $conf['locktime']){
338f3f0262cSandi    unlink($lock);
339f3f0262cSandi    return false;
340f3f0262cSandi  }
341f3f0262cSandi
342f3f0262cSandi  //my own lock
343f3f0262cSandi  $ip = io_readFile($lock);
344f3f0262cSandi  if( ($ip == clientIP()) || ($ip == $_SERVER['REMOTE_USER']) ){
345f3f0262cSandi    return false;
346f3f0262cSandi  }
347f3f0262cSandi
348f3f0262cSandi  return $ip;
349f3f0262cSandi}
350f3f0262cSandi
351f3f0262cSandi/**
352*15fae107Sandi * Lock a page for editing
353*15fae107Sandi *
354*15fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
355f3f0262cSandi */
356f3f0262cSandifunction lock($id){
357f3f0262cSandi  $lock = wikiFN($id).'.lock';
358f3f0262cSandi  if($_SERVER['REMOTE_USER']){
359f3f0262cSandi    io_saveFile($lock,$_SERVER['REMOTE_USER']);
360f3f0262cSandi  }else{
361f3f0262cSandi    io_saveFile($lock,clientIP());
362f3f0262cSandi  }
363f3f0262cSandi}
364f3f0262cSandi
365f3f0262cSandi/**
366*15fae107Sandi * Unlock a page if it was locked by the user
367f3f0262cSandi *
368*15fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
369*15fae107Sandi * @return bool true if a lock was removed
370f3f0262cSandi */
371f3f0262cSandifunction unlock($id){
372f3f0262cSandi  $lock = wikiFN($id).'.lock';
373f3f0262cSandi  if(@file_exists($lock)){
374f3f0262cSandi    $ip = io_readFile($lock);
375f3f0262cSandi    if( ($ip == clientIP()) || ($ip == $_SERVER['REMOTE_USER']) ){
376f3f0262cSandi      @unlink($lock);
377f3f0262cSandi      return true;
378f3f0262cSandi    }
379f3f0262cSandi  }
380f3f0262cSandi  return false;
381f3f0262cSandi}
382f3f0262cSandi
383f3f0262cSandi/**
384*15fae107Sandi * Remove unwanted chars from ID
385*15fae107Sandi *
386f3f0262cSandi * Cleans a given ID to only use allowed characters. Accented characters are
387f3f0262cSandi * converted to unaccented ones
388*15fae107Sandi *
389*15fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
390f3f0262cSandi */
391f3f0262cSandifunction cleanID($id){
392f3f0262cSandi  global $conf;
393f3f0262cSandi  global $lang;
394f3f0262cSandi  $id = trim($id);
395f3f0262cSandi  $id = strtolower($id);
396f3f0262cSandi
397f3f0262cSandi  //alternative namespace seperator
398f3f0262cSandi  $id = strtr($id,';',':');
399f3f0262cSandi  $id = strtr($id,'/',':');
400f3f0262cSandi
401f3f0262cSandi  if(!$conf['localnames']){
402f3f0262cSandi    if($lang['encoding'] == 'iso-8859-15'){
403f3f0262cSandi      // replace accented chars with unaccented ones
404f3f0262cSandi      // this may look strange on your terminal - just don't touch
405f3f0262cSandi      $id = strtr(
406f3f0262cSandi      strtr($id,
407f3f0262cSandi       '������������������������������������������������������',
408f3f0262cSandi       'szszyaaaaaceeeeiiiinooooouuuyaaaaaceeeeiiiinooooouuuyy'),
409f3f0262cSandi       array('�' => 'th', '�' => 'th', '�' => 'dh', '�' => 'dh', '�' => 'ss',
410f3f0262cSandi             '�' => 'oe', '�' => 'oe', '�' => 'ae', '�' => 'ae', '�' => 'u',
411f3f0262cSandi             '�' => 'ue', '�' => 'oe', '�' => 'ae', '�' => 'ue', '�' => '�',
412f3f0262cSandi             '�' => 'ae'));
413f3f0262cSandi    }
414f3f0262cSandi    $WORD = 'a-z';
415f3f0262cSandi  }else{
416f3f0262cSandi    $WORD = '\w';
417f3f0262cSandi  }
418f3f0262cSandi
419f3f0262cSandi  //special chars left will be converted to _
420f3f0262cSandi  $id = preg_replace('#[^'.$WORD.'0-9:\-\.]#','_',$id);
421f3f0262cSandi  $id = preg_replace('#__#','_',$id);
422f3f0262cSandi  $id = preg_replace('#:+#',':',$id);
423f3f0262cSandi  $id = trim($id,':._-');
424f3f0262cSandi  $id = preg_replace('#:[:\._\-]+#',':',$id);
425f3f0262cSandi
426f3f0262cSandi  return($id);
427f3f0262cSandi}
428f3f0262cSandi
429f3f0262cSandi/**
430f3f0262cSandi * returns the full path to the datafile specified by ID and
431f3f0262cSandi * optional revision
432*15fae107Sandi *
433*15fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
434f3f0262cSandi */
435f3f0262cSandifunction wikiFN($id,$rev=''){
436f3f0262cSandi  global $conf;
437f3f0262cSandi  $id = cleanID($id);
438f3f0262cSandi  $id = str_replace(':','/',$id);
439f3f0262cSandi  if(empty($rev)){
440f3f0262cSandi    return $conf['datadir'].'/'.$id.'.txt';
441f3f0262cSandi  }else{
442f3f0262cSandi    $fn = $conf['olddir'].'/'.$id.'.'.$rev.'.txt';
443f3f0262cSandi    if(!$conf['usegzip'] || @file_exists($fn)){
444f3f0262cSandi      //return plaintext if exists or gzip is disabled
445f3f0262cSandi      return $fn;
446f3f0262cSandi    }else{
447f3f0262cSandi      return $fn.'.gz';
448f3f0262cSandi    }
449f3f0262cSandi  }
450f3f0262cSandi}
451f3f0262cSandi
452f3f0262cSandi/**
453f3f0262cSandi * Returns the full filepath to a localized textfile if local
454f3f0262cSandi * version isn't found the english one is returned
455*15fae107Sandi *
456*15fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
457f3f0262cSandi */
458f3f0262cSandifunction localeFN($id){
459f3f0262cSandi  global $conf;
460f3f0262cSandi  $file = './lang/'.$conf['lang'].'/'.$id.'.txt';
461f3f0262cSandi  if(!@file_exists($file)){
462f3f0262cSandi    //fall back to english
463f3f0262cSandi    $file = './lang/en/'.$id.'.txt';
464f3f0262cSandi  }
465f3f0262cSandi  return cleanText($file);
466f3f0262cSandi}
467f3f0262cSandi
468f3f0262cSandi/**
469f3f0262cSandi * convert line ending to unix format
470f3f0262cSandi *
471*15fae107Sandi * @see    formText() for 2crlf conversion
472*15fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
473f3f0262cSandi */
474f3f0262cSandifunction cleanText($text){
475f3f0262cSandi  $text = preg_replace("/(\015\012)|(\015)/","\012",$text);
476f3f0262cSandi  return $text;
477f3f0262cSandi}
478f3f0262cSandi
479f3f0262cSandi/**
480f3f0262cSandi * Prepares text for print in Webforms by encoding special chars.
481f3f0262cSandi * It also converts line endings to Windows format which is
482f3f0262cSandi * pseudo standard for webforms.
483f3f0262cSandi *
484*15fae107Sandi * @see    cleanText() for 2unix conversion
485*15fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
486f3f0262cSandi */
487f3f0262cSandifunction formText($text){
488f3f0262cSandi  $text = preg_replace("/\012/","\015\012",$text);
489f3f0262cSandi  return htmlspecialchars($text);
490f3f0262cSandi}
491f3f0262cSandi
492f3f0262cSandi/**
493*15fae107Sandi * Returns the specified local text in parsed format
494*15fae107Sandi *
495*15fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
496f3f0262cSandi */
497f3f0262cSandifunction parsedLocale($id){
498f3f0262cSandi  //disable section editing
499f3f0262cSandi  global $parser;
500f3f0262cSandi  $se = $parser['secedit'];
501f3f0262cSandi  $parser['secedit'] = false;
502f3f0262cSandi  //fetch parsed locale
503f3f0262cSandi  $html = io_cacheParse(localeFN($id));
504f3f0262cSandi  //reset section editing
505f3f0262cSandi  $parser['secedit'] = $se;
506f3f0262cSandi  return $html;
507f3f0262cSandi}
508f3f0262cSandi
509f3f0262cSandi/**
510*15fae107Sandi * Returns the specified local text in raw format
511*15fae107Sandi *
512*15fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
513f3f0262cSandi */
514f3f0262cSandifunction rawLocale($id){
515f3f0262cSandi  return io_readFile(localeFN($id));
516f3f0262cSandi}
517f3f0262cSandi
518f3f0262cSandi
519f3f0262cSandi/**
520*15fae107Sandi * Returns the parsed Wikitext for the given id and revision.
521*15fae107Sandi *
522*15fae107Sandi * If $excuse is true an explanation is returned if the file
523*15fae107Sandi * wasn't found
524*15fae107Sandi *
525*15fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
526f3f0262cSandi */
527f3f0262cSandifunction parsedWiki($id,$rev='',$excuse=true){
528f3f0262cSandi  $file = wikiFN($id,$rev);
529f3f0262cSandi  $ret  = '';
530f3f0262cSandi
531f3f0262cSandi  //ensure $id is in global $ID (needed for parsing)
532f3f0262cSandi  global $ID;
533f3f0262cSandi  $ID = $id;
534f3f0262cSandi
535f3f0262cSandi  if($rev){
536f3f0262cSandi    if(@file_exists($file)){
537f3f0262cSandi      $ret = parse(io_readFile($file));
538f3f0262cSandi    }elseif($excuse){
539f3f0262cSandi      $ret = parsedLocale('norev');
540f3f0262cSandi    }
541f3f0262cSandi  }else{
542f3f0262cSandi    if(@file_exists($file)){
543f3f0262cSandi      $ret = io_cacheParse($file);
544f3f0262cSandi    }elseif($excuse){
545f3f0262cSandi      $ret = parsedLocale('newpage');
546f3f0262cSandi    }
547f3f0262cSandi  }
548f3f0262cSandi  return $ret;
549f3f0262cSandi}
550f3f0262cSandi
551f3f0262cSandi/**
552f3f0262cSandi * Returns the raw WikiText
553*15fae107Sandi *
554*15fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
555f3f0262cSandi */
556f3f0262cSandifunction rawWiki($id,$rev=''){
557f3f0262cSandi  return io_readFile(wikiFN($id,$rev));
558f3f0262cSandi}
559f3f0262cSandi
560f3f0262cSandi/**
561*15fae107Sandi * Returns the raw Wiki Text in three slices.
562*15fae107Sandi *
563*15fae107Sandi * The range parameter needs to have the form "from-to"
564*15fae107Sandi * and gives the range of the section.
565f3f0262cSandi * The returned order is prefix, section and suffix.
566*15fae107Sandi *
567*15fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
568f3f0262cSandi */
569f3f0262cSandifunction rawWikiSlices($range,$id,$rev=''){
570f3f0262cSandi  list($from,$to) = split('-',$range,2);
571f3f0262cSandi  $text = io_readFile(wikiFN($id,$rev));
572f3f0262cSandi  $text = split("\n",$text);
573f3f0262cSandi  if(!$from) $from = 0;
574f3f0262cSandi  if(!$to)   $to   = count($text);
575f3f0262cSandi
576f3f0262cSandi  $slices[0] = join("\n",array_slice($text,0,$from));
577f3f0262cSandi  $slices[1] = join("\n",array_slice($text,$from,$to + 1  - $from));
578f3f0262cSandi  $slices[2] = join("\n",array_slice($text,$to+1));
579f3f0262cSandi
580f3f0262cSandi  return $slices;
581f3f0262cSandi}
582f3f0262cSandi
583f3f0262cSandi/**
584*15fae107Sandi * Joins wiki text slices
585*15fae107Sandi *
586f3f0262cSandi * function to join the text slices with correct lineendings again.
587f3f0262cSandi * When the pretty parameter is set to true it adds additional empty
588f3f0262cSandi * lines between sections if needed (used on saving).
589*15fae107Sandi *
590*15fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
591f3f0262cSandi */
592f3f0262cSandifunction con($pre,$text,$suf,$pretty=false){
593f3f0262cSandi
594f3f0262cSandi  if($pretty){
595f3f0262cSandi    if($pre && substr($pre,-1) != "\n") $pre .= "\n";
596f3f0262cSandi    if($suf && substr($text,-1) != "\n") $text .= "\n";
597f3f0262cSandi  }
598f3f0262cSandi
599f3f0262cSandi  if($pre) $pre .= "\n";
600f3f0262cSandi  if($suf) $text .= "\n";
601f3f0262cSandi  return $pre.$text.$suf;
602f3f0262cSandi}
603f3f0262cSandi
604f3f0262cSandi/**
605*15fae107Sandi * print debug messages
606*15fae107Sandi *
607f3f0262cSandi * little function to print the content of a var
608*15fae107Sandi *
609*15fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
610f3f0262cSandi */
611f3f0262cSandifunction dbg($msg,$hidden=false){
612f3f0262cSandi  (!$hidden) ? print '<pre class="dbg">' : print "<!--\n";
613f3f0262cSandi  print_r($msg);
614f3f0262cSandi  (!$hidden) ? print '</pre>' : print "\n-->";
615f3f0262cSandi}
616f3f0262cSandi
617f3f0262cSandi/**
618f3f0262cSandi * Add's an entry to the changelog
619*15fae107Sandi *
620*15fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
621f3f0262cSandi */
622f3f0262cSandifunction addLogEntry($id,$summary=""){
623f3f0262cSandi  global $conf;
624f3f0262cSandi  $id     = cleanID($id);
625f3f0262cSandi  $date   = time();
626f3f0262cSandi  $remote = $_SERVER['REMOTE_ADDR'];
627f3f0262cSandi  $user   = $_SERVER['REMOTE_USER'];
628f3f0262cSandi
629f3f0262cSandi  $logline = join("\t",array($date,$remote,$id,$user,$summary))."\n";
630f3f0262cSandi
631f3f0262cSandi  $fh = fopen($conf['changelog'],'a');
632f3f0262cSandi  if($fh){
633f3f0262cSandi    fwrite($fh,$logline);
634f3f0262cSandi    fclose($fh);
635f3f0262cSandi  }
636f3f0262cSandi}
637f3f0262cSandi
638f3f0262cSandi/**
639f3f0262cSandi * returns an array of recently changed files using the
640f3f0262cSandi * changelog
641*15fae107Sandi *
642*15fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
643f3f0262cSandi */
644f3f0262cSandifunction getRecents($num=0,$incdel=false){
645f3f0262cSandi  global $conf;
646f3f0262cSandi  $recent = array();
647f3f0262cSandi  if(!$num) $num = $conf['recent'];
648f3f0262cSandi
649f3f0262cSandi  $loglines = file($conf['changelog']);
650f3f0262cSandi  rsort($loglines); //reverse sort on timestamp
651f3f0262cSandi
652f3f0262cSandi  foreach ($loglines as $line){
653f3f0262cSandi    $line = rtrim($line);        //remove newline
654f3f0262cSandi    if(empty($line)) continue;   //skip empty lines
655f3f0262cSandi    $info = split("\t",$line);   //split into parts
656f3f0262cSandi    //add id if not in yet and file still exists and is allowed to read
657f3f0262cSandi    if(!$recent[$info[2]] &&
658f3f0262cSandi       (@file_exists(wikiFN($info[2])) || $incdel) &&
659f3f0262cSandi       (auth_quickaclcheck($info[2]) >= AUTH_READ)
660f3f0262cSandi      ){
661f3f0262cSandi      $recent[$info[2]]['date'] = $info[0];
662f3f0262cSandi      $recent[$info[2]]['ip']   = $info[1];
663f3f0262cSandi      $recent[$info[2]]['user'] = $info[3];
664f3f0262cSandi      $recent[$info[2]]['sum']  = $info[4];
665f3f0262cSandi      $recent[$info[2]]['del']  = !@file_exists(wikiFN($info[2]));
666f3f0262cSandi    }
667f3f0262cSandi    if(count($recent) >= $num){
668f3f0262cSandi      break; //finish if enough items found
669f3f0262cSandi    }
670f3f0262cSandi  }
671f3f0262cSandi  return $recent;
672f3f0262cSandi}
673f3f0262cSandi
674f3f0262cSandi/**
675f3f0262cSandi * Saves a wikitext by calling io_saveFile
676*15fae107Sandi *
677*15fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
678f3f0262cSandi */
679f3f0262cSandifunction saveWikiText($id,$text,$summary){
680f3f0262cSandi  global $conf;
681f3f0262cSandi  global $lang;
682f3f0262cSandi  umask($conf['umask']);
683f3f0262cSandi  // ignore if no changes were made
684f3f0262cSandi  if($text == rawWiki($id,'')){
685f3f0262cSandi    return;
686f3f0262cSandi  }
687f3f0262cSandi
688f3f0262cSandi  $file = wikiFN($id);
689f3f0262cSandi  $old  = saveOldRevision($id);
690f3f0262cSandi
691f3f0262cSandi  if (empty($text)){
692f3f0262cSandi    // remove empty files
693f3f0262cSandi    @unlink($file);
694f3f0262cSandi    $del = true;
695f3f0262cSandi    $summary = $lang['deleted']; //autoset summary on deletion
696f3f0262cSandi  }else{
697f3f0262cSandi    // save file (datadir is created in io_saveFile)
698f3f0262cSandi    io_saveFile($file,$text);
699f3f0262cSandi    $del = false;
700f3f0262cSandi  }
701f3f0262cSandi
702f3f0262cSandi  addLogEntry($id,$summary);
703f3f0262cSandi  notify($id,$old,$summary);
704f3f0262cSandi
705f3f0262cSandi  //purge cache on add by updating the purgefile
706f3f0262cSandi  if($conf['purgeonadd'] && (!$old || $del)){
707f3f0262cSandi    io_saveFile($conf['datadir'].'/.cache/purgefile',time());
708f3f0262cSandi  }
709f3f0262cSandi}
710f3f0262cSandi
711f3f0262cSandi/**
712f3f0262cSandi * moves the current version to the attic and returns its
713f3f0262cSandi * revision date
714*15fae107Sandi *
715*15fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
716f3f0262cSandi */
717f3f0262cSandifunction saveOldRevision($id){
718f3f0262cSandi	global $conf;
719f3f0262cSandi  umask($conf['umask']);
720f3f0262cSandi  $oldf = wikiFN($id);
721f3f0262cSandi  if(!@file_exists($oldf)) return '';
722f3f0262cSandi  $date = filemtime($oldf);
723f3f0262cSandi  $newf = wikiFN($id,$date);
724f3f0262cSandi  if(substr($newf,-3)=='.gz'){
725f3f0262cSandi    io_saveFile($newf,rawWiki($id));
726f3f0262cSandi  }else{
727f3f0262cSandi    io_makeFileDir($newf);
728f3f0262cSandi    copy($oldf, $newf);
729f3f0262cSandi  }
730f3f0262cSandi  return $date;
731f3f0262cSandi}
732f3f0262cSandi
733f3f0262cSandi/**
734f3f0262cSandi * Sends a notify mail to the wikiadmin when a page was
735f3f0262cSandi * changed
736*15fae107Sandi *
737*15fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
738f3f0262cSandi */
739f3f0262cSandifunction notify($id,$rev="",$summary=""){
740f3f0262cSandi  global $lang;
741f3f0262cSandi  global $conf;
742f3f0262cSandi  $hdrs ='';
743f3f0262cSandi  if(empty($conf['notify'])) return; //notify enabled?
744f3f0262cSandi
745f3f0262cSandi  $text = rawLocale('mailtext');
746f3f0262cSandi  $text = str_replace('@DATE@',date($conf['dformat']),$text);
747f3f0262cSandi  $text = str_replace('@BROWSER@',$_SERVER['HTTP_USER_AGENT'],$text);
748f3f0262cSandi  $text = str_replace('@IPADDRESS@',$_SERVER['REMOTE_ADDR'],$text);
749f3f0262cSandi  $text = str_replace('@HOSTNAME@',gethostbyaddr($_SERVER['REMOTE_ADDR']),$text);
750f3f0262cSandi  $text = str_replace('@NEWPAGE@',wl($id,'','',true),$text);
751f3f0262cSandi  $text = str_replace('@DOKUWIKIURL@',getBaseURL(true),$text);
752f3f0262cSandi  $text = str_replace('@SUMMARY@',$summary,$text);
753f3f0262cSandi
754f3f0262cSandi  if($rev){
755f3f0262cSandi    $subject = $lang['mail_changed'].' '.$id;
756f3f0262cSandi    $text = str_replace('@OLDPAGE@',wl($id,"rev=$rev",'',true),$text);
757f3f0262cSandi    require_once("inc/DifferenceEngine.php");
758f3f0262cSandi    $df  = new Diff(split("\n",rawWiki($id,$rev)),
759f3f0262cSandi                    split("\n",rawWiki($id)));
760f3f0262cSandi    $dformat = new UnifiedDiffFormatter();
761f3f0262cSandi    $diff    = $dformat->format($df);
762f3f0262cSandi  }else{
763f3f0262cSandi    $subject=$lang['mail_newpage'].' '.$id;
764f3f0262cSandi    $text = str_replace('@OLDPAGE@','none',$text);
765f3f0262cSandi    $diff = rawWiki($id);
766f3f0262cSandi  }
767f3f0262cSandi  $text = str_replace('@DIFF@',$diff,$text);
768f3f0262cSandi
769f3f0262cSandi  if (!empty($conf['mailfrom'])) {
770f3f0262cSandi    $hdrs = 'From: '.$conf['mailfrom']."\n";
771f3f0262cSandi  }
772f3f0262cSandi  @mail($conf['notify'],$subject,$text,$hdrs);
773f3f0262cSandi}
774f3f0262cSandi
775*15fae107Sandi/**
776*15fae107Sandi * Return a list of available page revisons
777*15fae107Sandi *
778*15fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
779*15fae107Sandi */
780f3f0262cSandifunction getRevisions($id){
781f3f0262cSandi  $revd = dirname(wikiFN($id,'foo'));
782f3f0262cSandi  $revs = array();
783f3f0262cSandi  $clid = cleanID($id);
784f3f0262cSandi  if(strrpos($clid,':')) $clid = substr($clid,strrpos($clid,':')+1); //remove path
785f3f0262cSandi
786f3f0262cSandi  if (is_dir($revd) && $dh = opendir($revd)) {
787f3f0262cSandi    while (($file = readdir($dh)) !== false) {
788f3f0262cSandi      if (is_dir($revd.'/'.$file)) continue;
789f3f0262cSandi      if (preg_match('/^'.$clid.'\.(\d+)\.txt(\.gz)?$/',$file,$match)){
790f3f0262cSandi        $revs[]=$match[1];
791f3f0262cSandi      }
792f3f0262cSandi    }
793f3f0262cSandi    closedir($dh);
794f3f0262cSandi  }
795f3f0262cSandi  rsort($revs);
796f3f0262cSandi  return $revs;
797f3f0262cSandi}
798f3f0262cSandi
799f3f0262cSandi/**
800f3f0262cSandi * downloads a file from the net and saves it to the given location
801*15fae107Sandi *
802*15fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
803f3f0262cSandi */
804f3f0262cSandifunction download($url,$file){
805f3f0262cSandi  $fp = @fopen($url,"rb");
806f3f0262cSandi  if(!$fp) return false;
807f3f0262cSandi
808f3f0262cSandi  while(!feof($fp)){
809f3f0262cSandi    $cont.= fread($fp,1024);
810f3f0262cSandi  }
811f3f0262cSandi  fclose($fp);
812f3f0262cSandi
813f3f0262cSandi  $fp2 = @fopen($file,"w");
814f3f0262cSandi  if(!$fp2) return false;
815f3f0262cSandi  fwrite($fp2,$cont);
816f3f0262cSandi  fclose($fp2);
817f3f0262cSandi  return true;
818f3f0262cSandi}
819f3f0262cSandi
820f3f0262cSandi/**
821f3f0262cSandi * extracts the query from a google referer
822*15fae107Sandi *
823*15fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
824f3f0262cSandi */
825f3f0262cSandifunction getGoogleQuery(){
826f3f0262cSandi  $url = parse_url($_SERVER['HTTP_REFERER']);
827f3f0262cSandi
828f3f0262cSandi  if(!preg_match("#google\.#i",$url['host'])) return '';
829f3f0262cSandi  $query = array();
830f3f0262cSandi  parse_str($url['query'],$query);
831f3f0262cSandi
832f3f0262cSandi  return $query['q'];
833f3f0262cSandi}
834f3f0262cSandi
835f3f0262cSandi/**
836*15fae107Sandi * Try to set correct locale
837*15fae107Sandi *
838*15fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
839f3f0262cSandi */
840f3f0262cSandifunction setCorrectLocale(){
841f3f0262cSandi  global $conf;
842f3f0262cSandi  global $lang;
843f3f0262cSandi
844f3f0262cSandi  $enc = strtoupper($lang['encoding']);
845f3f0262cSandi  foreach ($lang['locales'] as $loc){
846f3f0262cSandi    //try locale
847f3f0262cSandi    if(@setlocale(LC_ALL,$loc)) return;
848f3f0262cSandi    //try loceale with encoding
849f3f0262cSandi    if(@setlocale(LC_ALL,"$loc.$enc")) return;
850f3f0262cSandi  }
851f3f0262cSandi  //still here? try to set from environment
852f3f0262cSandi  @setlocale(LC_ALL,"");
853f3f0262cSandi}
854f3f0262cSandi
855f3f0262cSandi/**
856f3f0262cSandi * Return the human readable size of a file
857f3f0262cSandi *
858f3f0262cSandi * @param       int    $size   A file size
859f3f0262cSandi * @param       int    $dec    A number of decimal places
860f3f0262cSandi * @author      Martin Benjamin <b.martin@cybernet.ch>
861f3f0262cSandi * @author      Aidan Lister <aidan@php.net>
862f3f0262cSandi * @version     1.0.0
863f3f0262cSandi */
864f3f0262cSandifunction filesize_h($size, $dec = 1)
865f3f0262cSandi{
866f3f0262cSandi  $sizes = array('B', 'KB', 'MB', 'GB');
867f3f0262cSandi  $count = count($sizes);
868f3f0262cSandi  $i = 0;
869f3f0262cSandi
870f3f0262cSandi  while ($size >= 1024 && ($i < $count - 1)) {
871f3f0262cSandi    $size /= 1024;
872f3f0262cSandi    $i++;
873f3f0262cSandi  }
874f3f0262cSandi
875f3f0262cSandi  return round($size, $dec) . ' ' . $sizes[$i];
876f3f0262cSandi}
877f3f0262cSandi
878*15fae107Sandi/**
879*15fae107Sandi * Run a few sanity checks
880*15fae107Sandi *
881*15fae107Sandi * @author Andreas Gohr <andi@splitbrain.org>
882*15fae107Sandi */
883f3f0262cSandifunction check(){
884f3f0262cSandi  global $conf;
885f3f0262cSandi  global $INFO;
886f3f0262cSandi
887f3f0262cSandi  if(is_writable($conf['changelog'])){
888f3f0262cSandi    msg('Changelog is writable',1);
889f3f0262cSandi  }else{
890f3f0262cSandi    msg('Changelog is not writable',-1);
891f3f0262cSandi  }
892f3f0262cSandi
893f3f0262cSandi  if(is_writable($conf['datadir'])){
894f3f0262cSandi    msg('Datadir is writable',1);
895f3f0262cSandi  }else{
896f3f0262cSandi    msg('Datadir is not writable',-1);
897f3f0262cSandi  }
898f3f0262cSandi
899f3f0262cSandi  if(is_writable($conf['olddir'])){
900f3f0262cSandi    msg('Attic is writable',1);
901f3f0262cSandi  }else{
902f3f0262cSandi    msg('Attic is not writable',-1);
903f3f0262cSandi  }
904f3f0262cSandi
905f3f0262cSandi  if(is_writable($conf['mediadir'])){
906f3f0262cSandi    msg('Mediadir is writable',1);
907f3f0262cSandi  }else{
908f3f0262cSandi    msg('Mediadir is not writable',-1);
909f3f0262cSandi  }
910f3f0262cSandi
911f3f0262cSandi  if(is_writable('conf/users.auth')){
912f3f0262cSandi    msg('conf/users.auth is writable',1);
913f3f0262cSandi  }else{
914f3f0262cSandi    msg('conf/users.auth is not writable',0);
915f3f0262cSandi  }
916f3f0262cSandi
917f3f0262cSandi  msg('Your current permission for this page is '.$INFO['perm'],0);
918f3f0262cSandi
919f3f0262cSandi  if(is_writable($INFO['filepath'])){
920f3f0262cSandi    msg('The current page is writable by the webserver',0);
921f3f0262cSandi  }else{
922f3f0262cSandi    msg('The current page is not writable by the webserver',0);
923f3f0262cSandi  }
924f3f0262cSandi
925f3f0262cSandi  if($INFO['writable']){
926f3f0262cSandi    msg('The current page is writable by you',0);
927f3f0262cSandi  }else{
928f3f0262cSandi    msg('The current page is not writable you',0);
929f3f0262cSandi  }
930f3f0262cSandi}
931f3f0262cSandi?>
932