includes/profiler/output/ProfilerOutputText.php

   1 <?php
   2 /**
   3  * Profiler showing output in page source.
   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  * @ingroup Profiler
  22  */
  23
  24 /**
  25  * The least sophisticated profiler output class possible, view your source! :)
  26  *
  27  * @ingroup Profiler
  28  * @since 1.25
  29  */
  30 class ProfilerOutputText extends ProfilerOutput {
  31         /** @var float Min real time display threshold */
  32         private $thresholdMs;
  33
  34         /** @var bool Whether to use visible text or a comment (for HTML responses) */
  35         private $visible;
  36
  37         function __construct( Profiler $collector, array $params ) {
  38                 parent::__construct( $collector, $params );
  39                 $this->thresholdMs = $params['thresholdMs'] ?? 1.0;
  40                 $this->visible = $params['visible'] ?? false;
  41         }
  42
  43         public function logsToOutput() {
  44                 return true;
  45         }
  46
  47         public function log( array $stats ) {
  48                 $out = '';
  49
  50                 // Filter out really tiny entries
  51                 $min = $this->thresholdMs;
  52                 $stats = array_filter( $stats, function ( $a ) use ( $min ) {
  53                         return $a['real'] > $min;
  54                 } );
  55                 // Sort descending by time elapsed
  56                 usort( $stats, function ( $a, $b ) {
  57                         return $b['real'] <=> $a['real'];
  58                 } );
  59
  60                 array_walk( $stats,
  61                         function ( $item ) use ( &$out ) {
  62                                 $out .= sprintf( "%6.2f%% %3.3f %6d - %s\n",
  63                                         $item['%real'], $item['real'], $item['calls'], $item['name'] );
  64                         }
  65                 );
  66
  67                 $contentType = $this->collector->getContentType();
  68                 if ( wfIsCLI() ) {
  69                         print "<!--\n{$out}\n-->\n";
  70                 } elseif ( $contentType === 'text/html' ) {
  71                         if ( $this->visible ) {
  72                                 print "<pre>{$out}</pre>";
  73                         } else {
  74                                 print "<!--\n{$out}\n-->\n";
  75                         }
  76                 } elseif ( $contentType === 'text/javascript' || $contentType === 'text/css' ) {
  77                         print "\n/*\n{$out}*/\n";
  78                 }
  79         }
  80 }