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