REL1_33/php/profileinfo_8php_source.html

<?php

// This endpoint is supposed to be independent of request cookies and other

// details of the session. Enforce this constraint with respect to session use.

define( 'MW_NO_SESSION', 1 );


ini_set( 'zlib.output_compression', 'off' );


require __DIR__ . '/includes/WebStart.php';


header( 'Content-Type: text/html; charset=utf-8' );


?>

<!DOCTYPE html>

<html>

<head>

    <meta charset="UTF-8" />

    <title>Profiling data</title>

    <style>

        /* noc.wikimedia.org/base.css */


        * {

            margin: 0;

            padding: 0;

        }


        body {

            padding: 0.5em 1em;

            background: #fff;

            font: 14px/1.6 sans-serif;

            color: #333;

        }


        p, ul, ol, table {

            margin: 0.5em 0;

        }


        a {

            color: #0645AD;

            text-decoration: none;

        }


        a:hover {

            text-decoration: underline;

        }


        table {

            max-width: 100%;

            background-color: transparent;

            border-collapse: collapse;

            border-spacing: 0;

        }


        .table {

            width: 100%;

            margin-bottom: 20px;

        }


        .table th,

        .table td {

            padding: 0.1em;

            text-align: left;

            vertical-align: top;

            border-top: 1px solid #ddd;

        }


        .table th {

            font-weight: bold;

        }


        .table thead th {

            vertical-align: bottom;

        }


        .table thead:first-child tr:first-child th,

        .table thead:first-child tr:first-child td {

            border-top: 0;

        }


        .table tbody + tbody {

            border-top: 2px solid #ddd;

        }


        .table-condensed th,

        .table-condensed td {

            padding: 4px 5px;

        }


        .table-striped tbody tr:nth-child(odd) td,

        .table-striped tbody tr:nth-child(odd) th {

            background-color: #f9f9f9;

        }


        .table-hover tbody tr:hover td,

        .table-hover tbody tr:hover th {

            background-color: #f5f5f5;

        }


        hr {

            margin: 20px 0;

            border: 0;

            border-top: 1px solid #eee;

            border-bottom: 1px solid #fff;

        }

    </style>

</head>

<body>

<?php


if ( !$wgEnableProfileInfo ) {

    echo '<p>Disabled</p>'

        . '</body></html>';

    exit( 1 );

}


$dbr = wfGetDB( DB_REPLICA );


if ( !$dbr->tableExists( 'profiling' ) ) {

    echo '<p>No <code>profiling</code> table exists, so we can\'t show you anything.</p>'

        . '<p>If you want to log profiling data, enable <code>$wgProfiler[\'output\'] = \'db\'</code>'

        . ' in LocalSettings.php and run <code>maintenance/update.php</code> to'

        . ' create the profiling table.'

        . '</body></html>';

    exit( 1 );

}


$expand = [];

if ( isset( $_REQUEST['expand'] ) ) {

    foreach ( explode( ',', $_REQUEST['expand'] ) as $f ) {

        $expand[$f] = true;

    }

}


// phpcs:ignore Squiz.Classes.ValidClassName.NotCamelCaps


class profile_point {


    public $name;

    public $count;

    public $time;

    public $children;


    public static $totaltime, $totalmemory, $totalcount;


    public function __construct( $name, $count, $time, $memory ) {

        $this->name = $name;

        $this->count = $count;

        $this->time = $time;

        $this->memory = $memory;

        $this->children = [];

    }


    public function add_child( $child ) {

        $this->children[] = $child;

    }


    public function display( $expand, $indent = 0.0 ) {

        usort( $this->children, 'compare_point' );


        $ex = isset( $expand[$this->name()] );


        $anchor = str_replace( '"', '', $this->name() );


        if ( !$ex ) {

            if ( count( $this->children ) ) {

                $url = getEscapedProfileUrl( false, false, $expand + [ $this->name() => true ] );

                $extet = " <a id=\"{$anchor}\" href=\"{$url}#{$anchor}\">[+]</a>";

            } else {

                $extet = '';

            }

        } else {

            $e = [];

            foreach ( $expand as $name => $ep ) {

                if ( $name != $this->name() ) {

                    $e += [ $name => $ep ];

                }

            }

            $url = getEscapedProfileUrl( false, false, $e );

            $extet = " <a id=\"{$anchor}\" href=\"{$url}#{$anchor}\">[–]</a>";

        }

        ?>

    <tr>

        <th>

            <div style="margin-left: <?php echo (int)$indent; ?>em;">

                <?php echo htmlspecialchars( str_replace( ',', ', ', $this->name() ) ) . $extet ?>

            </div>

        </th>

        <?php // phpcs:disable Generic.Files.LineLength,Generic.PHP.NoSilencedErrors ?>

        <td class="mw-profileinfo-timep"><?php echo @wfPercent( $this->time() / self::$totaltime * 100 ); ?></td>

        <td class="mw-profileinfo-memoryp"><?php echo @wfPercent( $this->memory() / self::$totalmemory * 100 ); ?></td>

        <td class="mw-profileinfo-count"><?php echo $this->count(); ?></td>

        <td class="mw-profileinfo-cpr"><?php echo round( sprintf( '%.2f', $this->callsPerRequest() ), 2 ); ?></td>

        <td class="mw-profileinfo-tpc"><?php echo round( sprintf( '%.2f', $this->timePerCall() ), 2 ); ?></td>

        <td class="mw-profileinfo-mpc"><?php echo round( sprintf( '%.2f', $this->memoryPerCall() / 1024 ), 2 ); ?></td>

        <td class="mw-profileinfo-tpr"><?php echo @round( sprintf( '%.2f', $this->time() / self::$totalcount ), 2 ); ?></td>

        <td class="mw-profileinfo-mpr"><?php echo @round( sprintf( '%.2f', $this->memory() / self::$totalcount / 1024 ), 2 ); ?></td>

        <?php // phpcs:enable ?>

    </tr>

        <?php

        if ( $ex ) {

            foreach ( $this->children as $child ) {

                $child->display( $expand, $indent + 2 );

            }

        }

    }


    public function name() {

        return $this->name;

    }


    public function count() {

        return $this->count;

    }


    public function time() {

        return $this->time;

    }


    public function memory() {

        return $this->memory;

    }


    public function timePerCall() {

        // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged

        return @( $this->time / $this->count );

    }


    public function memoryPerCall() {

        // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged

        return @( $this->memory / $this->count );

    }


    public function callsPerRequest() {

        // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged

        return @( $this->count / self::$totalcount );

    }


    public function timePerRequest() {

        // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged

        return @( $this->time / self::$totalcount );

    }


    public function memoryPerRequest() {

        // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged

        return @( $this->memory / self::$totalcount );

    }


    public function fmttime() {

        return sprintf( '%5.02f', $this->time );

    }


}


function compare_point( profile_point $a, profile_point $b ) {

    // phpcs:ignore MediaWiki.NamingConventions.ValidGlobalName.wgPrefix

    global $sort;


    switch ( $sort ) {

        // Sorted ascending:

        case 'name':

            return strcmp( $a->name(), $b->name() );

        // Sorted descending:

        case 'time':

            return $b->time() <=> $a->time();

        case 'memory':

            return $b->memory() <=> $a->memory();

        case 'count':

            return $b->count() <=> $a->count();

        case 'time_per_call':

            return $b->timePerCall() <=> $a->timePerCall();

        case 'memory_per_call':

            return $b->memoryPerCall() <=> $a->memoryPerCall();

        case 'calls_per_req':

            return $b->callsPerRequest() <=> $a->callsPerRequest();

        case 'time_per_req':

            return $b->timePerRequest() <=> $a->timePerRequest();

        case 'memory_per_req':

            return $b->memoryPerRequest() <=> $a->memoryPerRequest();

    }

}


$sorts = [ 'time', 'memory', 'count', 'calls_per_req', 'name',

    'time_per_call', 'memory_per_call', 'time_per_req', 'memory_per_req' ];

$sort = 'time';

if ( isset( $_REQUEST['sort'] ) && in_array( $_REQUEST['sort'], $sorts ) ) {

    $sort = $_REQUEST['sort'];

}


$res = $dbr->select(

    'profiling',

    '*',

    [],

    'profileinfo.php',

    [ 'ORDER BY' => 'pf_name ASC' ]

);


$filter = $_REQUEST['filter'] ?? '';


?>

<form method="get" action="profileinfo.php">

    <p>

        <input type="text" name="filter" value="<?php echo htmlspecialchars( $filter ); ?>">

        <input type="hidden" name="sort" value="<?php echo htmlspecialchars( $sort ); ?>">

        <input type="hidden" name="expand" value="<?php

            echo htmlspecialchars( implode( ",", array_keys( $expand ) ) );

        ?>">

        <input type="submit" value="Filter">

    </p>

</form>


<table class="mw-profileinfo-table table table-striped table-hover">

    <thead>

    <tr>

        <th><a href="<?php

            echo getEscapedProfileUrl( false, 'name' );

        ?>">Name</a></th>

        <th><a href="<?php

            echo getEscapedProfileUrl( false, 'time' );

        ?>">Time (%)</a></th>

        <th><a href="<?php

            echo getEscapedProfileUrl( false, 'memory' );

        ?>">Memory (%)</a></th>

        <th><a href="<?php

            echo getEscapedProfileUrl( false, 'count' );

        ?>">Count</a></th>

        <th><a href="<?php

            echo getEscapedProfileUrl( false, 'calls_per_req' );

        ?>">Calls/req</a></th>

        <th><a href="<?php

            echo getEscapedProfileUrl( false, 'time_per_call' );

        ?>">ms/call</a></th>

        <th><a href="<?php

            echo getEscapedProfileUrl( false, 'memory_per_call' );

        ?>">kb/call</a></th>

        <th><a href="<?php

            echo getEscapedProfileUrl( false, 'time_per_req' );

        ?>">ms/req</a></th>

        <th><a href="<?php

            echo getEscapedProfileUrl( false, 'memory_per_req' );

        ?>">kb/req</a></th>

    </tr>

    </thead>

    <tbody>

    <?php

    profile_point::$totaltime = 0.0;

    profile_point::$totalcount = 0;

    profile_point::$totalmemory = 0.0;


    function getEscapedProfileUrl( $_filter = false, $_sort = false, $_expand = false ) {

        // phpcs:ignore MediaWiki.NamingConventions.ValidGlobalName.wgPrefix

        global $filter, $sort, $expand;


        if ( $_expand === false ) {

            $_expand = $expand;

        }


        return htmlspecialchars(

            '?' .

                wfArrayToCgi( [

                    'filter' => $_filter ?: $filter,

                    'sort' => $_sort ?: $sort,

                    'expand' => implode( ',', array_keys( $_expand ) )

                ] )

        );

    }


    $points = [];

    $queries = [];

    $sqltotal = 0.0;


    $last = false;

    foreach ( $res as $o ) {

        $next = new profile_point( $o->pf_name, $o->pf_count, $o->pf_time, $o->pf_memory );

        if ( $next->name() == '-total' || $next->name() == 'main()' ) {

            profile_point::$totaltime = $next->time();

            profile_point::$totalcount = $next->count();

            profile_point::$totalmemory = $next->memory();

        }

        if ( $last !== false ) {

            if ( preg_match( '/^' . preg_quote( $last->name(), '/' ) . '/', $next->name() ) ) {

                $last->add_child( $next );

                continue;

            }

        }

        $last = $next;

        if ( preg_match( '/^query: /', $next->name() ) || preg_match( '/^query-m: /', $next->name() ) ) {

            $sqltotal += $next->time();

            $queries[] = $next;

        } else {

            $points[] = $next;

        }

    }


    $s = new profile_point( 'SQL Queries', 0, $sqltotal, 0 );

    foreach ( $queries as $q ) {

        $s->add_child( $q );

    }

    $points[] = $s;


    // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged

    @usort( $points, 'compare_point' );


    foreach ( $points as $point ) {

        if ( strlen( $filter ) && !strstr( $point->name(), $filter ) ) {

            continue;

        }


        $point->display( $expand );

    }

    ?>

    </tbody>

</table>

<hr />

<p>Total time: <code><?php printf( '%5.02f', profile_point::$totaltime ); ?></code></p>


<p>Total memory: <code><?php printf( '%5.02f', profile_point::$totalmemory / 1024 ); ?></code></p>

<hr />

</body>

</html>

href
shown</td >< td > a href
Definition All_system_messages.txt:2667

color
in the sidebar</td >< td > font color
Definition All_system_messages.txt:425

text
This list may contain false positives That usually means there is additional text with links below the first Each row contains links to the first and second as well as the first line of the second redirect text
Definition All_system_messages.txt:1267

$wgEnableProfileInfo
$wgEnableProfileInfo
Allow the profileinfo.php entrypoint to be used.
Definition DefaultSettings.php:6404

wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition GlobalFunctions.php:2648

wfPercent
wfPercent( $nr, $acc=2, $round=true)
Definition GlobalFunctions.php:2088

wfArrayToCgi
wfArrayToCgi( $array1, $array2=null, $prefix='')
This function takes one or two arrays as input, and returns a CGI-style string, e....
Definition GlobalFunctions.php:371

profile_point
Definition profileinfo.php:181

profile_point\count
count()
Definition profileinfo.php:256

profile_point\time
time()
Definition profileinfo.php:260

profile_point\memoryPerRequest
memoryPerRequest()
Definition profileinfo.php:288

profile_point\$totalmemory
static $totalmemory
Definition profileinfo.php:188

profile_point\timePerRequest
timePerRequest()
Definition profileinfo.php:283

profile_point\name
name()
Definition profileinfo.php:252

profile_point\memoryPerCall
memoryPerCall()
Definition profileinfo.php:273

profile_point\$children
$children
Definition profileinfo.php:186

profile_point\$name
$name
Definition profileinfo.php:183

profile_point\$count
$count
Definition profileinfo.php:184

profile_point\display
display( $expand, $indent=0.0)
Definition profileinfo.php:202

profile_point\memory
memory()
Definition profileinfo.php:264

profile_point\timePerCall
timePerCall()
Definition profileinfo.php:268

profile_point\callsPerRequest
callsPerRequest()
Definition profileinfo.php:278

profile_point\$totaltime
static $totaltime
Definition profileinfo.php:188

profile_point\__construct
__construct( $name, $count, $time, $memory)
Definition profileinfo.php:190

profile_point\add_child
add_child( $child)
Definition profileinfo.php:198

profile_point\fmttime
fmttime()
Definition profileinfo.php:293

profile_point\$time
$time
Definition profileinfo.php:185

profile_point\$totalcount
static $totalcount
Definition profileinfo.php:188

table
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global then executing the whole list after the page is displayed We don t do anything smart like collating updates to the same table or such because the list is almost always going to have just one item on if so it s not worth the trouble Since there is a job queue in the jobs table
Definition deferred.txt:16

as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition distributors.txt:22

form
null means default in associative array form
Definition hooks.txt:1994

code
and how to run hooks for an and one after Each event has a preferably in CamelCase For ArticleDelete hook A clump of code and data that should be run when an event happens This can be either a function and a chunk of or an object and a method hook function The function part of a third party developers and local administrators to define code that will be run at certain points in the mainline code
Definition hooks.txt:28

name
and how to run hooks for an and one after Each event has a name
Definition hooks.txt:12

$e
returning false will NOT prevent logging $e
Definition hooks.txt:2175

php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37

memory
MediaWiki has optional support for a high distributed memory object caching system For general information on but for a larger site with heavy like it should help lighten the load on the database servers by caching data and objects in memory
Definition memcached.txt:10

div
div
Definition parserTests.txt:6850

title
title
Definition parserTests.txt:245

f9f9f9
f9f9f9
Definition parserTests.txt:183

style
Bar style
Definition parserTests.txt:218

width
width
Definition parserTests.txt:189

data
This document describes the state of Postgres support in and is fairly well maintained The main code is very well while extensions are very hit and miss it is probably the most supported database after MySQL Much of the work in making MediaWiki database agnostic came about through the work of creating Postgres but without copying over all the usage comments General notes on the but these can almost always be programmed around *Although Postgres has a true BOOLEAN boolean columns are always mapped to as the code does not always treat the column as a and VARBINARY columns should simply be TEXT The only exception is when VARBINARY is used to store true binary data
Definition postgres.txt:37

type
This document describes the state of Postgres support in and is fairly well maintained The main code is very well while extensions are very hit and miss it is probably the most supported database after MySQL Much of the work in making MediaWiki database agnostic came about through the work of creating Postgres but without copying over all the usage comments General notes on the but these can almost always be programmed around *Although Postgres has a true BOOLEAN type
Definition postgres.txt:30

$res
if(isset( $_REQUEST['sort']) &&in_array( $_REQUEST['sort'], $sorts)) $res
Definition profileinfo.php:333

$points
$points
Definition profileinfo.php:411

$queries
$queries
Definition profileinfo.php:412

$sort
$sort
Definition profileinfo.php:328

compare_point
compare_point(profile_point $a, profile_point $b)
Definition profileinfo.php:298

$last
$last
Definition profileinfo.php:416

$s
foreach( $res as $o) $s
Definition profileinfo.php:439

getEscapedProfileUrl
getEscapedProfileUrl( $_filter=false, $_sort=false, $_expand=false)
Definition profileinfo.php:393

$filter
$filter
Definition profileinfo.php:341

$sorts
$sorts
Definition profileinfo.php:326

$dbr
if(! $wgEnableProfileInfo) $dbr
Definition profileinfo.php:162

$sqltotal
$sqltotal
Definition profileinfo.php:413

$expand
if(! $dbr->tableExists( 'profiling')) $expand
Definition profileinfo.php:173

DB_REPLICA
const DB_REPLICA
Definition defines.php:25

$f
$f
Definition router.php:79