infoutils.php ➔ debug_guard() - Code Metrics - Inspection of "Release candidate 2020-06-01 "Hogfather" RC2" - splitbrain/dokuwiki - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — stable ( 017e16...b83837 )

unknown

created 2020-06-03 13:51 UTC

infoutils.php ➔ debug_guard() A

↳ Parent: Project

Complexity

Conditions	4
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
nc	4
nop	1
dl	0
loc	9
rs	9.9666
c	0
b	0
f	0

<?php
/**
 * Information and debugging functions
 *
 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
 * @author     Andreas Gohr <[email protected]>
 */

use dokuwiki\HTTP\DokuHTTPClient;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

if(!defined('DOKU_MESSAGEURL')){
    if(in_array('ssl', stream_get_transports())) {
        define('DOKU_MESSAGEURL','https://update.dokuwiki.org/check/');
    }else{
        define('DOKU_MESSAGEURL','http://update.dokuwiki.org/check/');
    }
}

/**
 * Check for new messages from upstream
 *
 * @author Andreas Gohr <[email protected]>
 */
function checkUpdateMessages(){
    global $conf;
    global $INFO;
    global $updateVersion;
    if(!$conf['updatecheck']) return;
    if($conf['useacl'] && !$INFO['ismanager']) return;

    $cf = getCacheName($updateVersion, '.updmsg');
    $lm = @filemtime($cf);
    $is_http = substr(DOKU_MESSAGEURL, 0, 5) != 'https';

    // check if new messages needs to be fetched
    if($lm < time()-(60*60*24) || $lm < @filemtime(DOKU_INC.DOKU_SCRIPT)){
        @touch($cf);
        dbglog("checkUpdateMessages(): downloading messages to ".$cf.($is_http?' (without SSL)':' (with SSL)'));
        $http = new DokuHTTPClient();
        $http->timeout = 12;
        $resp = $http->get(DOKU_MESSAGEURL.$updateVersion);
        if(is_string($resp) && ($resp == "" || substr(trim($resp), -1) == '%')) {
            // basic sanity check that this is either an empty string response (ie "no messages")
            // or it looks like one of our messages, not WiFi login or other interposed response
            io_saveFile($cf,$resp);
        } else {
            dbglog("checkUpdateMessages(): unexpected HTTP response received");
        }
    }else{
        dbglog("checkUpdateMessages(): messages up to date");
    }

    $data = io_readFile($cf);
    // show messages through the usual message mechanism
    $msgs = explode("\n%\n",$data);
    foreach($msgs as $msg){
        if($msg) msg($msg,2);
    }
}


/**
 * Return DokuWiki's version (split up in date and type)
 *
 * @author Andreas Gohr <[email protected]>
 */
function getVersionData(){
    $version = array();
    //import version string
    if(file_exists(DOKU_INC.'VERSION')){
        //official release
        $version['date'] = trim(io_readFile(DOKU_INC.'VERSION'));
        $version['type'] = 'Release';
    }elseif(is_dir(DOKU_INC.'.git')){
        $version['type'] = 'Git';
        $version['date'] = 'unknown';

        $inventory = DOKU_INC.'.git/logs/HEAD';
        if(is_file($inventory)){
            $sz   = filesize($inventory);
            $seek = max(0,$sz-2000); // read from back of the file
            $fh   = fopen($inventory,'rb');
            fseek($fh,$seek);
            $chunk = fread($fh,2000);
            fclose($fh);
            $chunk = trim($chunk);
            $chunk = @array_pop(explode("\n",$chunk));   //last log line

            $chunk = @array_shift(explode("\t",$chunk)); //strip commit msg

            $chunk = explode(" ",$chunk);
            array_pop($chunk); //strip timezone
            $date = date('Y-m-d',array_pop($chunk));
            if($date) $version['date'] = $date;
        }
    }else{
        global $updateVersion;
        $version['date'] = 'update version '.$updateVersion;
        $version['type'] = 'snapshot?';
    }
    return $version;
}

/**
 * Return DokuWiki's version (as a string)
 *
 * @author Anika Henke <[email protected]>
 */
function getVersion(){
    $version = getVersionData();
    return $version['type'].' '.$version['date'];
}

/**
 * Run a few sanity checks
 *
 * @author Andreas Gohr <[email protected]>
 */
function check(){
    global $conf;
    global $INFO;
    /* @var Input $INPUT */
    global $INPUT;

    if ($INFO['isadmin'] || $INFO['ismanager']){
        msg('DokuWiki version: '.getVersion(),1);

        if(version_compare(phpversion(),'5.6.0','<')){
            msg('Your PHP version is too old ('.phpversion().' vs. 5.6.0+ needed)',-1);
        }else{
            msg('PHP version '.phpversion(),1);
        }
    } else {
        if(version_compare(phpversion(),'5.6.0','<')){
            msg('Your PHP version is too old',-1);
        }
    }

    $mem = (int) php_to_byte(ini_get('memory_limit'));
    if($mem){
        if ($mem === -1) {
            msg('PHP memory is unlimited', 1);
        } else if ($mem < 16777216) {
            msg('PHP is limited to less than 16MB RAM (' . filesize_h($mem) . ').
            Increase memory_limit in php.ini', -1);
        } else if ($mem < 20971520) {
            msg('PHP is limited to less than 20MB RAM (' . filesize_h($mem) . '),
                you might encounter problems with bigger pages. Increase memory_limit in php.ini', -1);
        } else if ($mem < 33554432) {
            msg('PHP is limited to less than 32MB RAM (' . filesize_h($mem) . '),
                but that should be enough in most cases. If not, increase memory_limit in php.ini', 0);
        } else {
            msg('More than 32MB RAM (' . filesize_h($mem) . ') available.', 1);
        }
    }

    if(is_writable($conf['changelog'])){
        msg('Changelog is writable',1);
    }else{
        if (file_exists($conf['changelog'])) {
            msg('Changelog is not writable',-1);
        }
    }

    if (isset($conf['changelog_old']) && file_exists($conf['changelog_old'])) {
        msg('Old changelog exists', 0);
    }

    if (file_exists($conf['changelog'].'_failed')) {
        msg('Importing old changelog failed', -1);
    } else if (file_exists($conf['changelog'].'_importing')) {
        msg('Importing old changelog now.', 0);
    } else if (file_exists($conf['changelog'].'_import_ok')) {
        msg('Old changelog imported', 1);
        if (!plugin_isdisabled('importoldchangelog')) {
            msg('Importoldchangelog plugin not disabled after import', -1);
        }
    }

    if(is_writable(DOKU_CONF)){
        msg('conf directory is writable',1);
    }else{
        msg('conf directory is not writable',-1);
    }

    if($conf['authtype'] == 'plain'){
        global $config_cascade;
        if(is_writable($config_cascade['plainauth.users']['default'])){
            msg('conf/users.auth.php is writable',1);
        }else{
            msg('conf/users.auth.php is not writable',0);
        }
    }

    if(function_exists('mb_strpos')){
        if(defined('UTF8_NOMBSTRING')){
            msg('mb_string extension is available but will not be used',0);
        }else{
            msg('mb_string extension is available and will be used',1);
            if(ini_get('mbstring.func_overload') != 0){
                msg('mb_string function overloading is enabled, this will cause problems and should be disabled',-1);
            }
        }
    }else{
        msg('mb_string extension not available - PHP only replacements will be used',0);
    }

    if (!UTF8_PREGSUPPORT) {
        msg('PHP is missing UTF-8 support in Perl-Compatible Regular Expressions (PCRE)', -1);
    }
    if (!UTF8_PROPERTYSUPPORT) {
        msg('PHP is missing Unicode properties support in Perl-Compatible Regular Expressions (PCRE)', -1);
    }

    $loc = setlocale(LC_ALL, 0);
    if(!$loc){
        msg('No valid locale is set for your PHP setup. You should fix this',-1);
    }elseif(stripos($loc,'utf') === false){
        msg('Your locale <code>'.hsc($loc).'</code> seems not to be a UTF-8 locale,
             you should fix this if you encounter problems.',0);
    }else{
        msg('Valid locale '.hsc($loc).' found.', 1);
    }

    if($conf['allowdebug']){
        msg('Debugging support is enabled. If you don\'t need it you should set $conf[\'allowdebug\'] = 0',-1);
    }else{
        msg('Debugging support is disabled',1);
    }

    if($INFO['userinfo']['name']){
        msg('You are currently logged in as '.$INPUT->server->str('REMOTE_USER').' ('.$INFO['userinfo']['name'].')',0);
        msg('You are part of the groups '.join($INFO['userinfo']['grps'],', '),0);
    }else{
        msg('You are currently not logged in',0);
    }

    msg('Your current permission for this page is '.$INFO['perm'],0);

    if (file_exists($INFO['filepath']) && is_writable($INFO['filepath'])) {
        msg('The current page is writable by the webserver', 1);
    } elseif (!file_exists($INFO['filepath']) && is_writable(dirname($INFO['filepath']))) {
        msg('The current page can be created by the webserver', 1);
    } else {
        msg('The current page is not writable by the webserver', -1);
    }

    if ($INFO['writable']) {
        msg('The current page is writable by you', 1);
    } else {
        msg('The current page is not writable by you', -1);
    }

    // Check for corrupted search index
    $lengths = idx_listIndexLengths();
    $index_corrupted = false;
    foreach ($lengths as $length) {
        if (count(idx_getIndex('w', $length)) != count(idx_getIndex('i', $length))) {
            $index_corrupted = true;
            break;
        }
    }

    foreach (idx_getIndex('metadata', '') as $index) {
        if (count(idx_getIndex($index.'_w', '')) != count(idx_getIndex($index.'_i', ''))) {
            $index_corrupted = true;
            break;
        }
    }

    if($index_corrupted) {
        msg(
            'The search index is corrupted. It might produce wrong results and most
                probably needs to be rebuilt. See
                <a href="http://www.dokuwiki.org/faq:searchindex">faq:searchindex</a>
                for ways to rebuild the search index.', -1
        );
    } elseif(!empty($lengths)) {
        msg('The search index seems to be working', 1);
    } else {
        msg(
            'The search index is empty. See
                <a href="http://www.dokuwiki.org/faq:searchindex">faq:searchindex</a>
                for help on how to fix the search index. If the default indexer
                isn\'t used or the wiki is actually empty this is normal.'
        );
    }

    // rough time check
    $http = new DokuHTTPClient();
    $http->max_redirect = 0;
    $http->timeout = 3;
    $http->sendRequest('http://www.dokuwiki.org', '', 'HEAD');
    $now = time();
    if(isset($http->resp_headers['date'])) {
        $time = strtotime($http->resp_headers['date']);
        $diff = $time - $now;

        if(abs($diff) < 4) {
            msg("Server time seems to be okay. Diff: {$diff}s", 1);
        } else {
            msg("Your server's clock seems to be out of sync!
                 Consider configuring a sync with a NTP server.  Diff: {$diff}s");
        }
    }

}

/**
 * print a message
 *
 * If HTTP headers were not sent yet the message is added
 * to the global message array else it's printed directly
 * using html_msgarea()
 *
 *
 * Levels can be:
 *
 * -1 error
 *  0 info
 *  1 success
 *
 * @author Andreas Gohr <[email protected]>
 * @see    html_msgarea
 */

define('MSG_PUBLIC', 0);
define('MSG_USERS_ONLY', 1);
define('MSG_MANAGERS_ONLY',2);
define('MSG_ADMINS_ONLY',4);

/**
 * Display a message to the user
 *
 * Triggers INFOUTIL_MSG_SHOW
 *
 * @param string $message
 * @param int    $lvl   -1 = error, 0 = info, 1 = success, 2 = notify
 * @param string $line  line number
 * @param string $file  file number
 * @param int    $allow who's allowed to see the message, see MSG_* constants
 */
function msg($message,$lvl=0,$line='',$file='',$allow=MSG_PUBLIC){
    global $MSG, $MSG_shown;
    static $errors = [
        -1 => 'error',
        0 => 'info',
        1 => 'success',
        2 => 'notify',
    ];

    $msgdata = [
        'msg' => $message,
        'lvl' => $errors[$lvl],
        'allow' => $allow,
        'line' => $line,
        'file' => $file,
    ];

    $evt = new \dokuwiki\Extension\Event('INFOUTIL_MSG_SHOW', $msgdata);
    if ($evt->advise_before()) {
        /* Show msg normally - event could suppress message show */
        if($msgdata['line'] || $msgdata['file']) {
            $basename = \dokuwiki\Utf8\PhpString::basename($msgdata['file']);
            $msgdata['msg'] .=' ['.$basename.':'.$msgdata['line'].']';
        }

        if(!isset($MSG)) $MSG = array();
        $MSG[] = $msgdata;
        if(isset($MSG_shown) || headers_sent()){
            if(function_exists('html_msgarea')){
                html_msgarea();
            }else{
                print "ERROR(".$msgdata['lvl'].") ".$msgdata['msg']."\n";
            }
            unset($GLOBALS['MSG']);
        }
    }
    $evt->advise_after();
    unset($evt);
}
/**
 * Determine whether the current user is allowed to view the message
 * in the $msg data structure
 *
 * @param  $msg   array    dokuwiki msg structure
 *                         msg   => string, the message
 *                         lvl   => int, level of the message (see msg() function)
 *                         allow => int, flag used to determine who is allowed to see the message
 *                                       see MSG_* constants
 * @return bool
 */
function info_msg_allowed($msg){
    global $INFO, $auth;

    // is the message public? - everyone and anyone can see it
    if (empty($msg['allow']) || ($msg['allow'] == MSG_PUBLIC)) return true;

    // restricted msg, but no authentication
    if (empty($auth)) return false;

    switch ($msg['allow']){
        case MSG_USERS_ONLY:
            return !empty($INFO['userinfo']);

        case MSG_MANAGERS_ONLY:
            return $INFO['ismanager'];

        case MSG_ADMINS_ONLY:
            return $INFO['isadmin'];

        default:
            trigger_error('invalid msg allow restriction.  msg="'.$msg['msg'].'" allow='.$msg['allow'].'"',
                          E_USER_WARNING);
            return $INFO['isadmin'];
    }

    return false;
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
}

/**
 * print debug messages
 *
 * little function to print the content of a var
 *
 * @author Andreas Gohr <[email protected]>
 *
 * @param string $msg
 * @param bool $hidden
 */
function dbg($msg,$hidden=false){
    if($hidden){
        echo "<!--\n";
        print_r($msg);
        echo "\n-->";
    }else{
        echo '<pre class="dbg">';
        echo hsc(print_r($msg,true));
        echo '</pre>';
    }
}

/**
 * Print info to a log file
 *
 * @author Andreas Gohr <[email protected]>
 *
 * @param string $msg
 * @param string $header
 */
function dbglog($msg,$header=''){
    global $conf;
    /* @var Input $INPUT */
    global $INPUT;

    // The debug log isn't automatically cleaned thus only write it when
    // debugging has been enabled by the user.
    if($conf['allowdebug'] !== 1) return;
    if(is_object($msg) || is_array($msg)){
        $msg = print_r($msg,true);
    }

    if($header) $msg = "$header\n$msg";

    $file = $conf['cachedir'].'/debug.log';
    $fh = fopen($file,'a');
    if($fh){
        fwrite($fh,date('H:i:s ').$INPUT->server->str('REMOTE_ADDR').': '.$msg."\n");
        fclose($fh);
    }
}

/**
 * Log accesses to deprecated fucntions to the debug log
 *
 * @param string $alternative The function or method that should be used instead
 * @triggers INFO_DEPRECATION_LOG
 */
function dbg_deprecated($alternative = '') {
    \dokuwiki\Debug\DebugHelper::dbgDeprecatedFunction($alternative, 2);
}

/**
 * Print a reversed, prettyprinted backtrace
 *
 * @author Gary Owen <[email protected]>
 */
function dbg_backtrace(){
    // Get backtrace
    $backtrace = debug_backtrace();

    // Unset call to debug_print_backtrace
    array_shift($backtrace);

    // Iterate backtrace
    $calls = array();
    $depth = count($backtrace) - 1;
    foreach ($backtrace as $i => $call) {
        $location = $call['file'] . ':' . $call['line'];
        $function = (isset($call['class'])) ?
            $call['class'] . $call['type'] . $call['function'] : $call['function'];

        $params = array();
        if (isset($call['args'])){
            foreach($call['args'] as $arg){
                if(is_object($arg)){
                    $params[] = '[Object '.get_class($arg).']';
                }elseif(is_array($arg)){
                    $params[] = '[Array]';
                }elseif(is_null($arg)){
                    $params[] = '[NULL]';
                }else{
                    $params[] = (string) '"'.$arg.'"';
                }
            }
        }
        $params = implode(', ',$params);

        $calls[$depth - $i] = sprintf('%s(%s) called at %s',
                $function,
                str_replace("\n", '\n', $params),
                $location);
    }
    ksort($calls);

    return implode("\n", $calls);
}

/**
 * Remove all data from an array where the key seems to point to sensitive data
 *
 * This is used to remove passwords, mail addresses and similar data from the
 * debug output
 *
 * @author Andreas Gohr <[email protected]>
 *
 * @param array $data
 */
function debug_guard(&$data){
    foreach($data as $key => $value){
        if(preg_match('/(notify|pass|auth|secret|ftp|userinfo|token|buid|mail|proxy)/i',$key)){
            $data[$key] = '***';
            continue;
        }
        if(is_array($value)) debug_guard($data[$key]);
    }
}


1			<?php
2			/**
3			* Information and debugging functions
4			*
5			* @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
6			* @author Andreas Gohr <[email protected]>
7			*/
8
9			use dokuwiki\HTTP\DokuHTTPClient;
			0 ignored issues – show Bug introduced 2019-03-26 23:08 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `DokuHTTPClient`. Let’s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let’s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
10
11			if(!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 <[email protected]>
23			*/
24			function 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()-(606024) \|\| $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 <[email protected]>
66			*/
67			function 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
			0 ignored issues – show Bug introduced 2015-11-25 07:06 UTC by Report Bug Copy Issue Report `explode(' ', $chunk)` cannot be passed to `array_pop()` as the parameter `$array` expects a reference. Loading history...
88			$chunk = @array_shift(explode("\t",$chunk)); //strip commit msg
			0 ignored issues – show Bug introduced 2015-11-25 07:06 UTC by Report Bug Copy Issue Report `explode(' ', $chunk)` cannot be passed to `array_shift()` as the parameter `$array` expects a reference. Loading history...
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 <[email protected]>
106			*/
107			function getVersion(){
108			$version = getVersionData();
109			return $version['type'].' '.$version['date'];
110			}
111
112			/**
113			* Run a few sanity checks
114			*
115			* @author Andreas Gohr <[email protected]>
116			*/
117			function 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 (file_exists($INFO['filepath']) && is_writable($INFO['filepath'])) {
239			msg('The current page is writable by the webserver', 1);
240			} elseif (!file_exists($INFO['filepath']) && is_writable(dirname($INFO['filepath']))) {
241			msg('The current page can be created by the webserver', 1);
242			} else {
243			msg('The current page is not writable by the webserver', -1);
244			}
245
246			if ($INFO['writable']) {
247			msg('The current page is writable by you', 1);
248			} else {
249			msg('The current page is not writable by you', -1);
250			}
251
252			// Check for corrupted search index
253			$lengths = idx_listIndexLengths();
254			$index_corrupted = false;
255			foreach ($lengths as $length) {
256			if (count(idx_getIndex('w', $length)) != count(idx_getIndex('i', $length))) {
257			$index_corrupted = true;
258			break;
259			}
260			}
261
262			foreach (idx_getIndex('metadata', '') as $index) {
263			if (count(idx_getIndex($index.'_w', '')) != count(idx_getIndex($index.'_i', ''))) {
264			$index_corrupted = true;
265			break;
266			}
267			}
268
269			if($index_corrupted) {
270			msg(
271			'The search index is corrupted. It might produce wrong results and most
272			probably needs to be rebuilt. See
273			<a href="http://www.dokuwiki.org/faq:searchindex">faq:searchindex</a>
274			for ways to rebuild the search index.', -1
275			);
276			} elseif(!empty($lengths)) {
277			msg('The search index seems to be working', 1);
278			} else {
279			msg(
280			'The search index is empty. See
281			<a href="http://www.dokuwiki.org/faq:searchindex">faq:searchindex</a>
282			for help on how to fix the search index. If the default indexer
283			isn\'t used or the wiki is actually empty this is normal.'
284			);
285			}
286
287			// rough time check
288			$http = new DokuHTTPClient();
289			$http->max_redirect = 0;
290			$http->timeout = 3;
291			$http->sendRequest('http://www.dokuwiki.org', '', 'HEAD');
292			$now = time();
293			if(isset($http->resp_headers['date'])) {
294			$time = strtotime($http->resp_headers['date']);
295			$diff = $time - $now;
296
297			if(abs($diff) < 4) {
298			msg("Server time seems to be okay. Diff: {$diff}s", 1);
299			} else {
300			msg("Your server's clock seems to be out of sync!
301			Consider configuring a sync with a NTP server. Diff: {$diff}s");
302			}
303			}
304
305			}
306
307			/**
308			* print a message
309			*
310			* If HTTP headers were not sent yet the message is added
311			* to the global message array else it's printed directly
312			* using html_msgarea()
313			*
314			*
315			* Levels can be:
316			*
317			* -1 error
318			* 0 info
319			* 1 success
320			*
321			* @author Andreas Gohr <[email protected]>
322			* @see html_msgarea
323			*/
324
325			define('MSG_PUBLIC', 0);
326			define('MSG_USERS_ONLY', 1);
327			define('MSG_MANAGERS_ONLY',2);
328			define('MSG_ADMINS_ONLY',4);
329
330			/**
331			* Display a message to the user
332			*
333			* Triggers INFOUTIL_MSG_SHOW
334			*
335			* @param string $message
336			* @param int $lvl -1 = error, 0 = info, 1 = success, 2 = notify
337			* @param string $line line number
338			* @param string $file file number
339			* @param int $allow who's allowed to see the message, see MSG_* constants
340			*/
341			function msg($message,$lvl=0,$line='',$file='',$allow=MSG_PUBLIC){
342			global $MSG, $MSG_shown;
343			static $errors = [
344			-1 => 'error',
345			0 => 'info',
346			1 => 'success',
347			2 => 'notify',
348			];
349
350			$msgdata = [
351			'msg' => $message,
352			'lvl' => $errors[$lvl],
353			'allow' => $allow,
354			'line' => $line,
355			'file' => $file,
356			];
357
358			$evt = new \dokuwiki\Extension\Event('INFOUTIL_MSG_SHOW', $msgdata);
359			if ($evt->advise_before()) {
360			/* Show msg normally - event could suppress message show */
361			if($msgdata['line'] \|\| $msgdata['file']) {
362			$basename = \dokuwiki\Utf8\PhpString::basename($msgdata['file']);
363			$msgdata['msg'] .=' ['.$basename.':'.$msgdata['line'].']';
364			}
365
366			if(!isset($MSG)) $MSG = array();
367			$MSG[] = $msgdata;
368			if(isset($MSG_shown) \|\| headers_sent()){
369			if(function_exists('html_msgarea')){
370			html_msgarea();
371			}else{
372			print "ERROR(".$msgdata['lvl'].") ".$msgdata['msg']."\n";
373			}
374			unset($GLOBALS['MSG']);
375			}
376			}
377			$evt->advise_after();
378			unset($evt);
379			}
380			/**
381			* Determine whether the current user is allowed to view the message
382			* in the $msg data structure
383			*
384			* @param $msg array dokuwiki msg structure
385			* msg => string, the message
386			* lvl => int, level of the message (see msg() function)
387			* allow => int, flag used to determine who is allowed to see the message
388			* see MSG_* constants
389			* @return bool
390			*/
391			function info_msg_allowed($msg){
392			global $INFO, $auth;
393
394			// is the message public? - everyone and anyone can see it
395			if (empty($msg['allow']) \|\| ($msg['allow'] == MSG_PUBLIC)) return true;
396
397			// restricted msg, but no authentication
398			if (empty($auth)) return false;
399
400			switch ($msg['allow']){
401			case MSG_USERS_ONLY:
402			return !empty($INFO['userinfo']);
403
404			case MSG_MANAGERS_ONLY:
405			return $INFO['ismanager'];
406
407			case MSG_ADMINS_ONLY:
408			return $INFO['isadmin'];
409
410			default:
411			trigger_error('invalid msg allow restriction. msg="'.$msg['msg'].'" allow='.$msg['allow'].'"',
412			E_USER_WARNING);
413			return $INFO['isadmin'];
414			}
415
416			return false;
			0 ignored issues – show Unused Code introduced 2015-11-25 07:06 UTC by Report Bug Copy Issue Report `return false;` does not seem to be reachable. This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed. Unreachable code is most often the result of `return`, `die` or `exit` statements that have been added for debug purposes. function fx() { try { doSomething(); return true; } catch (\Exception $e) { return false; } return false; } In the above example, the last `return false` will never be executed, because a return statement has already been met in every possible execution path. Loading history...
417			}
418
419			/**
420			* print debug messages
421			*
422			* little function to print the content of a var
423			*
424			* @author Andreas Gohr <[email protected]>
425			*
426			* @param string $msg
427			* @param bool $hidden
428			*/
429			function dbg($msg,$hidden=false){
430			if($hidden){
431			echo "<!--\n";
432			print_r($msg);
433			echo "\n-->";
434			}else{
435			echo '<pre class="dbg">';
436			echo hsc(print_r($msg,true));
437			echo '</pre>';
438			}
439			}
440
441			/**
442			* Print info to a log file
443			*
444			* @author Andreas Gohr <[email protected]>
445			*
446			* @param string $msg
447			* @param string $header
448			*/
449			function dbglog($msg,$header=''){
450			global $conf;
451			/* @var Input $INPUT */
452			global $INPUT;
453
454			// The debug log isn't automatically cleaned thus only write it when
455			// debugging has been enabled by the user.
456			if($conf['allowdebug'] !== 1) return;
457			if(is_object($msg) \|\| is_array($msg)){
458			$msg = print_r($msg,true);
459			}
460
461			if($header) $msg = "$header\n$msg";
462
463			$file = $conf['cachedir'].'/debug.log';
464			$fh = fopen($file,'a');
465			if($fh){
466			fwrite($fh,date('H:i:s ').$INPUT->server->str('REMOTE_ADDR').': '.$msg."\n");
467			fclose($fh);
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			*/
477			function dbg_deprecated($alternative = '') {
478			\dokuwiki\Debug\DebugHelper::dbgDeprecatedFunction($alternative, 2);
479			}
480
481			/**
482			* Print a reversed, prettyprinted backtrace
483			*
484			* @author Gary Owen <[email protected]>
485			*/
486			function 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 <[email protected]>
534			*
535			* @param array $data
536			*/
537			function 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

splitbrain / dokuwiki

Push — stable ( 017e16...b83837 )

infoutils.php ➔ debug_guard() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like