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