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