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