Debug.php

Go to the documentation of this file.

<?php

class MWDebug {

        protected static $log = array();

        protected static $debug = array();

        protected static $query = array();

        protected static $enabled = false;

        protected static $deprecationWarnings = array();

        public static function init() {
                self::$enabled = true;
        }

        public static function addModules( OutputPage $out ) {
                if ( self::$enabled ) {
                        $out->addModules( 'mediawiki.debug.init' );
                }
        }

        public static function log( $str ) {
                if ( !self::$enabled ) {
                        return;
                }

                self::$log[] = array(
                        'msg' => htmlspecialchars( $str ),
                        'type' => 'log',
                        'caller' => wfGetCaller(),
                );
        }

        public static function getLog() {
                return self::$log;
        }

        public static function clearLog() {
                self::$log = array();
                self::$deprecationWarnings = array();
        }

        public static function warning( $msg, $callerOffset = 1 ) {
                if ( !self::$enabled ) {
                        return;
                }

                // Check to see if there was already a deprecation notice, so not to
                // get a duplicate warning
                $logCount = count( self::$log );
                if ( $logCount ) {
                        $lastLog = self::$log[ $logCount - 1 ];
                        if ( $lastLog['type'] == 'deprecated' && $lastLog['caller'] == wfGetCaller( $callerOffset + 1 ) ) {
                                return;
                        }
                }

                self::$log[] = array(
                        'msg' => htmlspecialchars( $msg ),
                        'type' => 'warn',
                        'caller' => wfGetCaller( $callerOffset ),
                );
        }

        public static function deprecated( $function, $version, $component ) {
                if ( !self::$enabled ) {
                        return;
                }

                // Chain: This function -> wfDeprecated -> deprecatedFunction -> caller
                $caller = wfGetCaller( 4 );

                // Check to see if there already was a warning about this function
                $functionString = "$function-$caller";
                if ( in_array( $functionString, self::$deprecationWarnings ) ) {
                        return;
                }

                $version = $version === false ? '(unknown version)' : $version;
                $component = $component === false ? 'MediaWiki' : $component;
                $msg = htmlspecialchars( "Use of function $function was deprecated in $component $version" );
                $msg .= Html::rawElement( 'div', array( 'class' => 'mw-debug-backtrace' ),
                        Html::element( 'span', array(), 'Backtrace:' )
                         . wfBacktrace()
                );

                self::$deprecationWarnings[] = $functionString;
                self::$log[] = array(
                        'msg' => $msg,
                        'type' => 'deprecated',
                        'caller' => $caller,
                );
        }

        public static function debugMsg( $str ) {
                if ( !self::$enabled ) {
                        return;
                }

                self::$debug[] = trim( $str );
        }

        public static function query( $sql, $function, $isMaster ) {
                if ( !self::$enabled ) {
                        return -1;
                }

                self::$query[] = array(
                        'sql' => $sql,
                        'function' => $function,
                        'master' => (bool) $isMaster,
                        'time' => 0.0,
                        '_start' => microtime( true ),
                );

                return count( self::$query ) - 1;
        }

        public static function queryTime( $id ) {
                if ( $id === -1 || !self::$enabled ) {
                        return;
                }

                self::$query[$id]['time'] = microtime( true ) - self::$query[$id]['_start'];
                unset( self::$query[$id]['_start'] );
        }

        protected static function getFilesIncluded( IContextSource $context ) {
                $files = get_included_files();
                $fileList = array();
                foreach ( $files as $file ) {
                        $size = filesize( $file );
                        $fileList[] = array(
                                'name' => $file,
                                'size' => $context->getLanguage()->formatSize( $size ),
                        );
                }

                return $fileList;
        }

        public static function getDebugHTML( IContextSource $context ) {
                if ( !self::$enabled ) {
                        return '';
                }

                global $wgVersion, $wgRequestTime;
                MWDebug::log( 'MWDebug output complete' );
                $request = $context->getRequest();
                $debugInfo = array(
                        'mwVersion' => $wgVersion,
                        'phpVersion' => PHP_VERSION,
                        'time' => microtime( true ) - $wgRequestTime,
                        'log' => self::$log,
                        'debugLog' => self::$debug,
                        'queries' => self::$query,
                        'request' => array(
                                'method' => $_SERVER['REQUEST_METHOD'],
                                'url' => $request->getRequestURL(),
                                'headers' => $request->getAllHeaders(),
                                'params' => $request->getValues(),
                        ),
                        'memory' => $context->getLanguage()->formatSize( memory_get_usage() ),
                        'memoryPeak' => $context->getLanguage()->formatSize( memory_get_peak_usage() ),
                        'includes' => self::getFilesIncluded( $context ),
                );

                // Cannot use OutputPage::addJsConfigVars because those are already outputted
                // by the time this method is called.
                $html = Html::inlineScript(
                        ResourceLoader::makeLoaderConditionalScript(
                                ResourceLoader::makeConfigSetScript( array( 'debugInfo' => $debugInfo ) )
                        )
                );

                return $html;
        }
}