xref: /dokuwiki/inc/infoutils.php (revision 94070874cc8d8702821161dbaa291e8b2d043ad3) 
1<?php
2/**
3 * Information and debugging functions
4 *
5 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
6 * @author     Andreas Gohr <andi@splitbrain.org>
7 */
8if(!defined('DOKU_INC')) die('meh.');
9if(!defined('DOKU_MESSAGEURL')) define('DOKU_MESSAGEURL','http://update.dokuwiki.org/check/');
10
11/**
12 * Check for new messages from upstream
13 *
14 * @author Andreas Gohr <andi@splitbrain.org>
15 */
16function checkUpdateMessages(){
17    global $conf;
18    global $INFO;
19    global $updateVersion;
20    if(!$conf['updatecheck']) return;
21    if($conf['useacl'] && !$INFO['ismanager']) return;
22
23    $cf = $conf['cachedir'].'/messages.txt';
24    $lm = @filemtime($cf);
25
26    // check if new messages needs to be fetched
27    if($lm < time()-(60*60*24) || $lm < @filemtime(DOKU_INC.DOKU_SCRIPT)){
28        @touch($cf);
29        dbglog("checkUpdateMessages(): downloading messages.txt");
30        $http = new DokuHTTPClient();
31        $http->timeout = 12;
32        $data = $http->get(DOKU_MESSAGEURL.$updateVersion);
33        io_saveFile($cf,$data);
34    }else{
35        dbglog("checkUpdateMessages(): messages.txt up to date");
36        $data = io_readFile($cf);
37    }
38
39    // show messages through the usual message mechanism
40    $msgs = explode("\n%\n",$data);
41    foreach($msgs as $msg){
42        if($msg) msg($msg,2);
43    }
44}
45
46
47/**
48 * Return DokuWiki's version (split up in date and type)
49 *
50 * @author Andreas Gohr <andi@splitbrain.org>
51 */
52function getVersionData(){
53    $version = array();
54    //import version string
55    if(@file_exists(DOKU_INC.'VERSION')){
56        //official release
57        $version['date'] = trim(io_readfile(DOKU_INC.'VERSION'));
58        $version['type'] = 'Release';
59    }elseif(is_dir(DOKU_INC.'.git')){
60        $version['type'] = 'Git';
61        $version['date'] = 'unknown';
62
63        $inventory = DOKU_INC.'.git/logs/HEAD';
64        if(is_file($inventory)){
65            $sz   = filesize($inventory);
66            $seek = max(0,$sz-2000); // read from back of the file
67            $fh   = fopen($inventory,'rb');
68            fseek($fh,$seek);
69            $chunk = fread($fh,2000);
70            fclose($fh);
71            $chunk = trim($chunk);
72            $chunk = @array_pop(explode("\n",$chunk));   //last log line
73            $chunk = @array_shift(explode("\t",$chunk)); //strip commit msg
74            $chunk = explode(" ",$chunk);
75            array_pop($chunk); //strip timezone
76            $date = date('Y-m-d',array_pop($chunk));
77            if($date) $version['date'] = $date;
78        }
79    }else{
80        global $updateVersion;
81        $version['date'] = 'update version '.$updateVersion;
82        $version['type'] = 'snapshot?';
83    }
84    return $version;
85}
86
87/**
88 * Return DokuWiki's version (as a string)
89 *
90 * @author Anika Henke <anika@selfthinker.org>
91 */
92function getVersion(){
93    $version = getVersionData();
94    return $version['type'].' '.$version['date'];
95}
96
97/**
98 * Run a few sanity checks
99 *
100 * @author Andreas Gohr <andi@splitbrain.org>
101 */
102function check(){
103    global $conf;
104    global $INFO;
105
106    if ($INFO['isadmin'] || $INFO['ismanager']){
107        msg('DokuWiki version: '.getVersion(),1);
108    }
109
110    if(version_compare(phpversion(),'5.2.0','<')){
111        msg('Your PHP version is too old ('.phpversion().' vs. 5.2.0+ needed)',-1);
112    }else{
113        msg('PHP version '.phpversion(),1);
114    }
115
116    $mem = (int) php_to_byte(ini_get('memory_limit'));
117    if($mem){
118        if($mem < 16777216){
119            msg('PHP is limited to less than 16MB RAM ('.$mem.' bytes). Increase memory_limit in php.ini',-1);
120        }elseif($mem < 20971520){
121            msg('PHP is limited to less than 20MB RAM ('.$mem.' bytes), you might encounter problems with bigger pages. Increase memory_limit in php.ini',-1);
122        }elseif($mem < 33554432){
123            msg('PHP is limited to less than 32MB RAM ('.$mem.' bytes), but that should be enough in most cases. If not, increase memory_limit in php.ini',0);
124        }else{
125            msg('More than 32MB RAM ('.$mem.' bytes) available.',1);
126        }
127    }
128
129    if(is_writable($conf['changelog'])){
130        msg('Changelog is writable',1);
131    }else{
132        if (@file_exists($conf['changelog'])) {
133            msg('Changelog is not writable',-1);
134        }
135    }
136
137    if (isset($conf['changelog_old']) && @file_exists($conf['changelog_old'])) {
138        msg('Old changelog exists', 0);
139    }
140
141    if (@file_exists($conf['changelog'].'_failed')) {
142        msg('Importing old changelog failed', -1);
143    } else if (@file_exists($conf['changelog'].'_importing')) {
144        msg('Importing old changelog now.', 0);
145    } else if (@file_exists($conf['changelog'].'_import_ok')) {
146        msg('Old changelog imported', 1);
147        if (!plugin_isdisabled('importoldchangelog')) {
148            msg('Importoldchangelog plugin not disabled after import', -1);
149        }
150    }
151
152    if(is_writable(DOKU_CONF)){
153        msg('conf directory is writable',1);
154    }else{
155        msg('conf directory is not writable',-1);
156    }
157
158    if($conf['authtype'] == 'plain'){
159        global $config_cascade;
160        if(is_writable($config_cascade['plainauth.users']['default'])){
161            msg('conf/users.auth.php is writable',1);
162        }else{
163            msg('conf/users.auth.php is not writable',0);
164        }
165    }
166
167    if(function_exists('mb_strpos')){
168        if(defined('UTF8_NOMBSTRING')){
169            msg('mb_string extension is available but will not be used',0);
170        }else{
171            msg('mb_string extension is available and will be used',1);
172            if(ini_get('mbstring.func_overload') != 0){
173                msg('mb_string function overloading is enabled, this will cause problems and should be disabled',-1);
174            }
175        }
176    }else{
177        msg('mb_string extension not available - PHP only replacements will be used',0);
178    }
179
180    if (!UTF8_PREGSUPPORT) {
181        msg('PHP is missing UTF-8 support in Perl-Compatible Regular Expressions (PCRE)', -1);
182    }
183    if (!UTF8_PROPERTYSUPPORT) {
184        msg('PHP is missing Unicode properties support in Perl-Compatible Regular Expressions (PCRE)', -1);
185    }
186
187    $loc = setlocale(LC_ALL, 0);
188    if(!$loc){
189        msg('No valid locale is set for your PHP setup. You should fix this',-1);
190    }elseif(stripos($loc,'utf') === false){
191        msg('Your locale <code>'.hsc($loc).'</code> seems not to be a UTF-8 locale, you should fix this if you encounter problems.',0);
192    }else{
193        msg('Valid locale '.hsc($loc).' found.', 1);
194    }
195
196    if($conf['allowdebug']){
197        msg('Debugging support is enabled. If you don\'t need it you should set $conf[\'allowdebug\'] = 0',-1);
198    }else{
199        msg('Debugging support is disabled',1);
200    }
201
202    if($INFO['userinfo']['name']){
203        msg('You are currently logged in as '.$_SERVER['REMOTE_USER'].' ('.$INFO['userinfo']['name'].')',0);
204        msg('You are part of the groups '.join($INFO['userinfo']['grps'],', '),0);
205    }else{
206        msg('You are currently not logged in',0);
207    }
208
209    msg('Your current permission for this page is '.$INFO['perm'],0);
210
211    if(is_writable($INFO['filepath'])){
212        msg('The current page is writable by the webserver',0);
213    }else{
214        msg('The current page is not writable by the webserver',0);
215    }
216
217    if($INFO['writable']){
218        msg('The current page is writable by you',0);
219    }else{
220        msg('The current page is not writable by you',0);
221    }
222
223    // Check for corrupted search index
224    $lengths = idx_listIndexLengths();
225    $index_corrupted = false;
226    foreach ($lengths as $length) {
227        if (count(idx_getIndex('w', $length)) != count(idx_getIndex('i', $length))) {
228            $index_corrupted = true;
229            break;
230        }
231    }
232
233    foreach (idx_getIndex('metadata', '') as $index) {
234        if (count(idx_getIndex($index.'_w', '')) != count(idx_getIndex($index.'_i', ''))) {
235            $index_corrupted = true;
236            break;
237        }
238    }
239
240    if ($index_corrupted)
241        msg('The search index is corrupted. It might produce wrong results and most
242                probably needs to be rebuilt. See
243                <a href="http://www.dokuwiki.org/faq:searchindex">faq:searchindex</a>
244                for ways to rebuild the search index.', -1);
245    elseif (!empty($lengths))
246        msg('The search index seems to be working', 1);
247    else
248        msg('The search index is empty. See
249                <a href="http://www.dokuwiki.org/faq:searchindex">faq:searchindex</a>
250                for help on how to fix the search index. If the default indexer
251                isn\'t used or the wiki is actually empty this is normal.');
252}
253
254/**
255 * print a message
256 *
257 * If HTTP headers were not sent yet the message is added
258 * to the global message array else it's printed directly
259 * using html_msgarea()
260 *
261 *
262 * Levels can be:
263 *
264 * -1 error
265 *  0 info
266 *  1 success
267 *
268 * @author Andreas Gohr <andi@splitbrain.org>
269 * @see    html_msgarea
270 */
271
272define('MSG_PUBLIC', 0);
273define('MSG_USERS_ONLY', 1);
274define('MSG_MANAGERS_ONLY',2);
275define('MSG_ADMINS_ONLY',4);
276
277function msg($message,$lvl=0,$line='',$file='',$allow=MSG_PUBLIC){
278    global $MSG, $MSG_shown;
279    $errors[-1] = 'error';
280    $errors[0]  = 'info';
281    $errors[1]  = 'success';
282    $errors[2]  = 'notify';
283
284    if($line || $file) $message.=' ['.utf8_basename($file).':'.$line.']';
285
286    if(!isset($MSG)) $MSG = array();
287    $MSG[]=array('lvl' => $errors[$lvl], 'msg' => $message, 'allow' => $allow);
288    if(isset($MSG_shown) || headers_sent()){
289        if(function_exists('html_msgarea')){
290            html_msgarea();
291        }else{
292            print "ERROR($lvl) $message";
293        }
294        unset($GLOBALS['MSG']);
295    }
296}
297/**
298 * Determine whether the current user is allowed to view the message
299 * in the $msg data structure
300 *
301 * @param  $msg   array    dokuwiki msg structure
302 *                         msg   => string, the message
303 *                         lvl   => int, level of the message (see msg() function)
304 *                         allow => int, flag used to determine who is allowed to see the message
305 *                                       see MSG_* constants
306 */
307function info_msg_allowed($msg){
308    global $INFO, $auth;
309
310    // is the message public? - everyone and anyone can see it
311    if (empty($msg['allow']) || ($msg['allow'] == MSG_PUBLIC)) return true;
312
313    // restricted msg, but no authentication
314    if (empty($auth)) return false;
315
316    switch ($msg['allow']){
317        case MSG_USERS_ONLY:
318            return !empty($INFO['userinfo']);
319
320        case MSG_MANAGERS_ONLY:
321            return $INFO['ismanager'];
322
323        case MSG_ADMINS_ONLY:
324            return $INFO['isadmin'];
325
326        default:
327            trigger_error('invalid msg allow restriction.  msg="'.$msg['msg'].'" allow='.$msg['allow'].'"', E_USER_WARNING);
328            return $INFO['isadmin'];
329    }
330
331    return false;
332}
333
334/**
335 * print debug messages
336 *
337 * little function to print the content of a var
338 *
339 * @author Andreas Gohr <andi@splitbrain.org>
340 */
341function dbg($msg,$hidden=false){
342    if($hidden){
343        echo "<!--\n";
344        print_r($msg);
345        echo "\n-->";
346    }else{
347        echo '<pre class="dbg">';
348        echo hsc(print_r($msg,true));
349        echo '</pre>';
350    }
351}
352
353/**
354 * Print info to a log file
355 *
356 * @author Andreas Gohr <andi@splitbrain.org>
357 */
358function dbglog($msg,$header=''){
359    global $conf;
360    // The debug log isn't automatically cleaned thus only write it when
361    // debugging has been enabled by the user.
362    if($conf['allowdebug'] !== 1) return;
363    if(is_object($msg) || is_array($msg)){
364        $msg = print_r($msg,true);
365    }
366
367    if($header) $msg = "$header\n$msg";
368
369    $file = $conf['cachedir'].'/debug.log';
370    $fh = fopen($file,'a');
371    if($fh){
372        fwrite($fh,date('H:i:s ').$_SERVER['REMOTE_ADDR'].': '.$msg."\n");
373        fclose($fh);
374    }
375}
376
377/**
378 * Print a reversed, prettyprinted backtrace
379 *
380 * @author Gary Owen <gary_owen@bigfoot.com>
381 */
382function dbg_backtrace(){
383    // Get backtrace
384    $backtrace = debug_backtrace();
385
386    // Unset call to debug_print_backtrace
387    array_shift($backtrace);
388
389    // Iterate backtrace
390    $calls = array();
391    $depth = count($backtrace) - 1;
392    foreach ($backtrace as $i => $call) {
393        $location = $call['file'] . ':' . $call['line'];
394        $function = (isset($call['class'])) ?
395            $call['class'] . $call['type'] . $call['function'] : $call['function'];
396
397        $params = array();
398        if (isset($call['args'])){
399            foreach($call['args'] as $arg){
400                if(is_object($arg)){
401                    $params[] = '[Object '.get_class($arg).']';
402                }elseif(is_array($arg)){
403                    $params[] = '[Array]';
404                }elseif(is_null($arg)){
405                    $param[] = '[NULL]';
406                }else{
407                    $params[] = (string) '"'.$arg.'"';
408                }
409            }
410        }
411        $params = implode(', ',$params);
412
413        $calls[$depth - $i] = sprintf('%s(%s) called at %s',
414                $function,
415                str_replace("\n", '\n', $params),
416                $location);
417    }
418    ksort($calls);
419
420    return implode("\n", $calls);
421}
422
423/**
424 * Remove all data from an array where the key seems to point to sensitive data
425 *
426 * This is used to remove passwords, mail addresses and similar data from the
427 * debug output
428 *
429 * @author Andreas Gohr <andi@splitbrain.org>
430 */
431function debug_guard(&$data){
432    foreach($data as $key => $value){
433        if(preg_match('/(notify|pass|auth|secret|ftp|userinfo|token|buid|mail|proxy)/i',$key)){
434            $data[$key] = '***';
435            continue;
436        }
437        if(is_array($value)) debug_guard($data[$key]);
438    }
439}
440