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