includes/debug/Debug.php

   1 <?php
   2 /**
   3  * Debug toolbar related code.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22
  23 /**
  24  * New debugger system that outputs a toolbar on page view.
  25  *
  26  * By default, most methods do nothing ( self::$enabled = false ). You have
  27  * to explicitly call MWDebug::init() to enabled them.
  28  *
  29  * @todo Profiler support
  30  *
  31  * @since 1.19
  32  */
  33 class MWDebug {
  34         /**
  35          * Log lines
  36          *
  37          * @var array $log
  38          */
  39         protected static $log = array();
  40
  41         /**
  42          * Debug messages from wfDebug().
  43          *
  44          * @var array $debug
  45          */
  46         protected static $debug = array();
  47
  48         /**
  49          * SQL statements of the databses queries.
  50          *
  51          * @var array $query
  52          */
  53         protected static $query = array();
  54
  55         /**
  56          * Is the debugger enabled?
  57          *
  58          * @var bool $enabled
  59          */
  60         protected static $enabled = false;
  61
  62         /**
  63          * Array of functions that have already been warned, formatted
  64          * function-caller to prevent a buttload of warnings
  65          *
  66          * @var array $deprecationWarnings
  67          */
  68         protected static $deprecationWarnings = array();
  69
  70         /**
  71          * Enabled the debugger and load resource module.
  72          * This is called by Setup.php when $wgDebugToolbar is true.
  73          *
  74          * @since 1.19
  75          */
  76         public static function init() {
  77                 self::$enabled = true;
  78         }
  79
  80         /**
  81          * Add ResourceLoader modules to the OutputPage object if debugging is
  82          * enabled.
  83          *
  84          * @since 1.19
  85          * @param $out OutputPage
  86          */
  87         public static function addModules( OutputPage $out ) {
  88                 if ( self::$enabled ) {
  89                         $out->addModules( 'mediawiki.debug.init' );
  90                 }
  91         }
  92
  93         /**
  94          * Adds a line to the log
  95          *
  96          * @todo Add support for passing objects
  97          *
  98          * @since 1.19
  99          * @param $str string
 100          */
 101         public static function log( $str ) {
 102                 if ( !self::$enabled ) {
 103                         return;
 104                 }
 105
 106                 self::$log[] = array(
 107                         'msg' => htmlspecialchars( $str ),
 108                         'type' => 'log',
 109                         'caller' => wfGetCaller(),
 110                 );
 111         }
 112
 113         /**
 114          * Returns internal log array
 115          * @since 1.19
 116          * @return array
 117          */
 118         public static function getLog() {
 119                 return self::$log;
 120         }
 121
 122         /**
 123          * Clears internal log array and deprecation tracking
 124          * @since 1.19
 125          */
 126         public static function clearLog() {
 127                 self::$log = array();
 128                 self::$deprecationWarnings = array();
 129         }
 130
 131         /**
 132          * Adds a warning entry to the log
 133          *
 134          * @since 1.19
 135          * @param $msg string
 136          * @param $callerOffset int
 137          * @param $level int A PHP error level. See sendWarning()
 138          * @param $log string: 'production' will always trigger a php error, 'auto'
 139          *        will trigger an error if $wgDevelopmentWarnings is true, and 'debug'
 140          *        will only write to the debug log(s).
 141          *
 142          * @return mixed
 143          */
 144         public static function warning( $msg, $callerOffset = 1, $level = E_USER_NOTICE, $log = 'auto' ) {
 145                 global $wgDevelopmentWarnings;
 146
 147                 if ( $log === 'auto' && !$wgDevelopmentWarnings ) {
 148                         $log = 'debug';
 149                 }
 150
 151                 if ( $log === 'debug' ) {
 152                         $level = false;
 153                 }
 154
 155                 $callerDescription = self::getCallerDescription( $callerOffset );
 156
 157                 self::sendWarning( $msg, $callerDescription, $level );
 158
 159                 if ( self::$enabled ) {
 160                         self::$log[] = array(
 161                                 'msg' => htmlspecialchars( $msg ),
 162                                 'type' => 'warn',
 163                                 'caller' => $callerDescription['func'],
 164                         );
 165                 }
 166         }
 167
 168         /**
 169          * Show a warning that $function is deprecated.
 170          * This will send it to the following locations:
 171          * - Debug toolbar, with one item per function and caller, if $wgDebugToolbar
 172          *   is set to true.
 173          * - PHP's error log, with level E_USER_DEPRECATED, if $wgDevelopmentWarnings
 174          *   is set to true.
 175          * - MediaWiki's debug log, if $wgDevelopmentWarnings is set to false.
 176          *
 177          * @since 1.19
 178          * @param string $function Function that is deprecated.
 179          * @param string|bool $version Version in which the function was deprecated.
 180          * @param string|bool $component Component to which the function belongs.
 181          *     If false, it is assumbed the function is in MediaWiki core.
 182          * @param $callerOffset integer: How far up the callstack is the original
 183          *    caller. 2 = function that called the function that called
 184          *    MWDebug::deprecated() (Added in 1.20).
 185          * @return mixed
 186          */
 187         public static function deprecated( $function, $version = false,
 188                 $component = false, $callerOffset = 2
 189         ) {
 190                 $callerDescription = self::getCallerDescription( $callerOffset );
 191                 $callerFunc = $callerDescription['func'];
 192
 193                 $sendToLog = true;
 194
 195                 // Check to see if there already was a warning about this function
 196                 if ( isset( self::$deprecationWarnings[$function][$callerFunc] ) ) {
 197                         return;
 198                 } elseif ( isset( self::$deprecationWarnings[$function] ) ) {
 199                         if ( self::$enabled ) {
 200                                 $sendToLog = false;
 201                         } else {
 202                                 return;
 203                         }
 204                 }
 205
 206                 self::$deprecationWarnings[$function][$callerFunc] = true;
 207
 208                 if ( $version ) {
 209                         global $wgDeprecationReleaseLimit;
 210                         if ( $wgDeprecationReleaseLimit && $component === false ) {
 211                                 # Strip -* off the end of $version so that branches can use the
 212                                 # format #.##-branchname to avoid issues if the branch is merged into
 213                                 # a version of MediaWiki later than what it was branched from
 214                                 $comparableVersion = preg_replace( '/-.*$/', '', $version );
 215
 216                                 # If the comparableVersion is larger than our release limit then
 217                                 # skip the warning message for the deprecation
 218                                 if ( version_compare( $wgDeprecationReleaseLimit, $comparableVersion, '<' ) ) {
 219                                         $sendToLog = false;
 220                                 }
 221                         }
 222
 223                         $component = $component === false ? 'MediaWiki' : $component;
 224                         $msg = "Use of $function was deprecated in $component $version.";
 225                 } else {
 226                         $msg = "Use of $function is deprecated.";
 227                 }
 228
 229                 if ( $sendToLog ) {
 230                         global $wgDevelopmentWarnings; // we could have a more specific $wgDeprecationWarnings setting.
 231                         self::sendWarning(
 232                                 $msg,
 233                                 $callerDescription,
 234                                 $wgDevelopmentWarnings ? E_USER_DEPRECATED : false
 235                         );
 236                 }
 237
 238                 if ( self::$enabled ) {
 239                         $logMsg = htmlspecialchars( $msg ) .
 240                                 Html::rawElement( 'div', array( 'class' => 'mw-debug-backtrace' ),
 241                                         Html::element( 'span', array(), 'Backtrace:' ) . wfBacktrace()
 242                                 );
 243
 244                         self::$log[] = array(
 245                                 'msg' => $logMsg,
 246                                 'type' => 'deprecated',
 247                                 'caller' => $callerFunc,
 248                         );
 249                 }
 250         }
 251
 252         /**
 253          * Get an array describing the calling function at a specified offset.
 254          *
 255          * @param $callerOffset integer: How far up the callstack is the original
 256          *    caller. 0 = function that called getCallerDescription()
 257          * @return array with two keys: 'file' and 'func'
 258          */
 259         private static function getCallerDescription( $callerOffset ) {
 260                 $callers = wfDebugBacktrace();
 261
 262                 if ( isset( $callers[$callerOffset] ) ) {
 263                         $callerfile = $callers[$callerOffset];
 264                         if ( isset( $callerfile['file'] ) && isset( $callerfile['line'] ) ) {
 265                                 $file = $callerfile['file'] . ' at line ' . $callerfile['line'];
 266                         } else {
 267                                 $file = '(internal function)';
 268                         }
 269                 } else {
 270                         $file = '(unknown location)';
 271                 }
 272
 273                 if ( isset( $callers[$callerOffset + 1] ) ) {
 274                         $callerfunc = $callers[$callerOffset + 1];
 275                         $func = '';
 276                         if ( isset( $callerfunc['class'] ) ) {
 277                                 $func .= $callerfunc['class'] . '::';
 278                         }
 279                         if ( isset( $callerfunc['function'] ) ) {
 280                                 $func .= $callerfunc['function'];
 281                         }
 282                 } else {
 283                         $func = 'unknown';
 284                 }
 285
 286                 return array( 'file' => $file, 'func' => $func );
 287         }
 288
 289         /**
 290          * Send a warning to the debug log and optionally also trigger a PHP
 291          * error, depending on the $level argument.
 292          *
 293          * @param $msg string Message to send
 294          * @param $caller array caller description get from getCallerDescription()
 295          * @param $level int|bool error level to use; set to false to not trigger an error
 296          */
 297         private static function sendWarning( $msg, $caller, $level ) {
 298                 $msg .= ' [Called from ' . $caller['func'] . ' in ' . $caller['file'] . ']';
 299
 300                 if ( $level !== false ) {
 301                         trigger_error( $msg, $level );
 302                 }
 303
 304                 wfDebug( "$msg\n" );
 305         }
 306
 307         /**
 308          * This is a method to pass messages from wfDebug to the pretty debugger.
 309          * Do NOT use this method, use MWDebug::log or wfDebug()
 310          *
 311          * @since 1.19
 312          * @param $str string
 313          */
 314         public static function debugMsg( $str ) {
 315                 global $wgDebugComments, $wgShowDebug;
 316
 317                 if ( self::$enabled || $wgDebugComments || $wgShowDebug ) {
 318                         self::$debug[] = rtrim( UtfNormal::cleanUp( $str ) );
 319                 }
 320         }
 321
 322         /**
 323          * Begins profiling on a database query
 324          *
 325          * @since 1.19
 326          * @param $sql string
 327          * @param $function string
 328          * @param $isMaster bool
 329          * @return int ID number of the query to pass to queryTime or -1 if the
 330          *  debugger is disabled
 331          */
 332         public static function query( $sql, $function, $isMaster ) {
 333                 if ( !self::$enabled ) {
 334                         return -1;
 335                 }
 336
 337                 self::$query[] = array(
 338                         'sql' => $sql,
 339                         'function' => $function,
 340                         'master' => (bool)$isMaster,
 341                         'time' => 0.0,
 342                         '_start' => microtime( true ),
 343                 );
 344
 345                 return count( self::$query ) - 1;
 346         }
 347
 348         /**
 349          * Calculates how long a query took.
 350          *
 351          * @since 1.19
 352          * @param $id int
 353          */
 354         public static function queryTime( $id ) {
 355                 if ( $id === -1 || !self::$enabled ) {
 356                         return;
 357                 }
 358
 359                 self::$query[$id]['time'] = microtime( true ) - self::$query[$id]['_start'];
 360                 unset( self::$query[$id]['_start'] );
 361         }
 362
 363         /**
 364          * Returns a list of files included, along with their size
 365          *
 366          * @param $context IContextSource
 367          * @return array
 368          */
 369         protected static function getFilesIncluded( IContextSource $context ) {
 370                 $files = get_included_files();
 371                 $fileList = array();
 372                 foreach ( $files as $file ) {
 373                         $size = filesize( $file );
 374                         $fileList[] = array(
 375                                 'name' => $file,
 376                                 'size' => $context->getLanguage()->formatSize( $size ),
 377                         );
 378                 }
 379
 380                 return $fileList;
 381         }
 382
 383         /**
 384          * Returns the HTML to add to the page for the toolbar
 385          *
 386          * @since 1.19
 387          * @param $context IContextSource
 388          * @return string
 389          */
 390         public static function getDebugHTML( IContextSource $context ) {
 391                 global $wgDebugComments;
 392
 393                 $html = '';
 394
 395                 if ( self::$enabled ) {
 396                         MWDebug::log( 'MWDebug output complete' );
 397                         $debugInfo = self::getDebugInfo( $context );
 398
 399                         // Cannot use OutputPage::addJsConfigVars because those are already outputted
 400                         // by the time this method is called.
 401                         $html = Html::inlineScript(
 402                                 ResourceLoader::makeLoaderConditionalScript(
 403                                         ResourceLoader::makeConfigSetScript( array( 'debugInfo' => $debugInfo ) )
 404                                 )
 405                         );
 406                 }
 407
 408                 if ( $wgDebugComments ) {
 409                         $html .= "<!-- Debug output:\n" .
 410                                 htmlspecialchars( implode( "\n", self::$debug ) ) .
 411                                 "\n\n-->";
 412                 }
 413
 414                 return $html;
 415         }
 416
 417         /**
 418          * Generate debug log in HTML for displaying at the bottom of the main
 419          * content area.
 420          * If $wgShowDebug is false, an empty string is always returned.
 421          *
 422          * @since 1.20
 423          * @return string HTML fragment
 424          */
 425         public static function getHTMLDebugLog() {
 426                 global $wgDebugTimestamps, $wgShowDebug;
 427
 428                 if ( !$wgShowDebug ) {
 429                         return '';
 430                 }
 431
 432                 $curIdent = 0;
 433                 $ret = "\n<hr />\n<strong>Debug data:</strong><ul id=\"mw-debug-html\">\n<li>";
 434
 435                 foreach ( self::$debug as $line ) {
 436                         $pre = '';
 437                         if ( $wgDebugTimestamps ) {
 438                                 $matches = array();
 439                                 if ( preg_match( '/^(\d+\.\d+ {1,3}\d+.\dM\s{2})/', $line, $matches ) ) {
 440                                         $pre = $matches[1];
 441                                         $line = substr( $line, strlen( $pre ) );
 442                                 }
 443                         }
 444                         $display = ltrim( $line );
 445                         $ident = strlen( $line ) - strlen( $display );
 446                         $diff = $ident - $curIdent;
 447
 448                         $display = $pre . $display;
 449                         if ( $display == '' ) {
 450                                 $display = "\xc2\xa0";
 451                         }
 452
 453                         if ( !$ident
 454                                 && $diff < 0
 455                                 && substr( $display, 0, 9 ) != 'Entering '
 456                                 && substr( $display, 0, 8 ) != 'Exiting '
 457                         ) {
 458                                 $ident = $curIdent;
 459                                 $diff = 0;
 460                                 $display = '<span style="background:yellow;">' .
 461                                         nl2br( htmlspecialchars( $display ) ) . '</span>';
 462                         } else {
 463                                 $display = nl2br( htmlspecialchars( $display ) );
 464                         }
 465
 466                         if ( $diff < 0 ) {
 467                                 $ret .= str_repeat( "</li></ul>\n", -$diff ) . "</li><li>\n";
 468                         } elseif ( $diff == 0 ) {
 469                                 $ret .= "</li><li>\n";
 470                         } else {
 471                                 $ret .= str_repeat( "<ul><li>\n", $diff );
 472                         }
 473                         $ret .= "<code>$display</code>\n";
 474
 475                         $curIdent = $ident;
 476                 }
 477
 478                 $ret .= str_repeat( '</li></ul>', $curIdent ) . "</li>\n</ul>\n";
 479
 480                 return $ret;
 481         }
 482
 483         /**
 484          * Append the debug info to given ApiResult
 485          *
 486          * @param $context IContextSource
 487          * @param $result ApiResult
 488          */
 489         public static function appendDebugInfoToApiResult( IContextSource $context, ApiResult $result ) {
 490                 if ( !self::$enabled ) {
 491                         return;
 492                 }
 493
 494                 // output errors as debug info, when display_errors is on
 495                 // this is necessary for all non html output of the api, because that clears all errors first
 496                 $obContents = ob_get_contents();
 497                 if ( $obContents ) {
 498                         $obContentArray = explode( '<br />', $obContents );
 499                         foreach ( $obContentArray as $obContent ) {
 500                                 if ( trim( $obContent ) ) {
 501                                         self::debugMsg( Sanitizer::stripAllTags( $obContent ) );
 502                                 }
 503                         }
 504                 }
 505
 506                 MWDebug::log( 'MWDebug output complete' );
 507                 $debugInfo = self::getDebugInfo( $context );
 508
 509                 $result->setIndexedTagName( $debugInfo, 'debuginfo' );
 510                 $result->setIndexedTagName( $debugInfo['log'], 'line' );
 511                 $result->setIndexedTagName( $debugInfo['debugLog'], 'msg' );
 512                 $result->setIndexedTagName( $debugInfo['queries'], 'query' );
 513                 $result->setIndexedTagName( $debugInfo['includes'], 'queries' );
 514                 $result->addValue( null, 'debuginfo', $debugInfo );
 515         }
 516
 517         /**
 518          * Returns the HTML to add to the page for the toolbar
 519          *
 520          * @param $context IContextSource
 521          * @return array
 522          */
 523         public static function getDebugInfo( IContextSource $context ) {
 524                 if ( !self::$enabled ) {
 525                         return array();
 526                 }
 527
 528                 global $wgVersion, $wgRequestTime;
 529                 $request = $context->getRequest();
 530
 531                 return array(
 532                         'mwVersion' => $wgVersion,
 533                         'phpVersion' => PHP_VERSION,
 534                         'gitRevision' => GitInfo::headSHA1(),
 535                         'gitBranch' => GitInfo::currentBranch(),
 536                         'gitViewUrl' => GitInfo::headViewUrl(),
 537                         'time' => microtime( true ) - $wgRequestTime,
 538                         'log' => self::$log,
 539                         'debugLog' => self::$debug,
 540                         'queries' => self::$query,
 541                         'request' => array(
 542                                 'method' => $request->getMethod(),
 543                                 'url' => $request->getRequestURL(),
 544                                 'headers' => $request->getAllHeaders(),
 545                                 'params' => $request->getValues(),
 546                         ),
 547                         'memory' => $context->getLanguage()->formatSize( memory_get_usage() ),
 548                         'memoryPeak' => $context->getLanguage()->formatSize( memory_get_peak_usage() ),
 549                         'includes' => self::getFilesIncluded( $context ),
 550                 );
 551         }
 552 }