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