MediaWiki REL1_27
benchmarkParse.php
Go to the documentation of this file.
1<?php
25require __DIR__ . '/../Maintenance.php';
26
35 private $templateTimestamp = null;
36
38 private $idCache = [];
39
40 function __construct() {
41 parent::__construct();
42 $this->addDescription( 'Benchmark parse operation' );
43 $this->addArg( 'title', 'The name of the page to parse' );
44 $this->addOption( 'warmup', 'Repeat the parse operation this number of times to warm the cache',
45 false, true );
46 $this->addOption( 'loops', 'Number of times to repeat parse operation post-warmup',
47 false, true );
48 $this->addOption( 'page-time',
49 'Use the version of the page which was current at the given time',
50 false, true );
51 $this->addOption( 'tpl-time',
52 'Use templates which were current at the given time (except that moves and ' .
53 'deletes are not handled properly)',
54 false, true );
55 }
56
57 function execute() {
58 if ( $this->hasOption( 'tpl-time' ) ) {
59 $this->templateTimestamp = wfTimestamp( TS_MW, strtotime( $this->getOption( 'tpl-time' ) ) );
60 Hooks::register( 'BeforeParserFetchTemplateAndtitle', [ $this, 'onFetchTemplate' ] );
61 }
62
63 $title = Title::newFromText( $this->getArg() );
64 if ( !$title ) {
65 $this->error( "Invalid title" );
66 exit( 1 );
67 }
68
69 if ( $this->hasOption( 'page-time' ) ) {
70 $pageTimestamp = wfTimestamp( TS_MW, strtotime( $this->getOption( 'page-time' ) ) );
71 $id = $this->getRevIdForTime( $title, $pageTimestamp );
72 if ( !$id ) {
73 $this->error( "The page did not exist at that time" );
74 exit( 1 );
75 }
76
77 $revision = Revision::newFromId( $id );
78 } else {
79 $revision = Revision::newFromTitle( $title );
80 }
81
82 if ( !$revision ) {
83 $this->error( "Unable to load revision, incorrect title?" );
84 exit( 1 );
85 }
86
87 $warmup = $this->getOption( 'warmup', 1 );
88 for ( $i = 0; $i < $warmup; $i++ ) {
89 $this->runParser( $revision );
90 }
91
92 $loops = $this->getOption( 'loops', 1 );
93 if ( $loops < 1 ) {
94 $this->error( 'Invalid number of loops specified', true );
95 }
96 $startUsage = getrusage();
97 $startTime = microtime( true );
98 for ( $i = 0; $i < $loops; $i++ ) {
99 $this->runParser( $revision );
100 }
101 $endUsage = getrusage();
102 $endTime = microtime( true );
103
104 printf( "CPU time = %.3f s, wall clock time = %.3f s\n",
105 // CPU time
106 ( $endUsage['ru_utime.tv_sec'] + $endUsage['ru_utime.tv_usec'] * 1e-6
107 - $startUsage['ru_utime.tv_sec'] - $startUsage['ru_utime.tv_usec'] * 1e-6 ) / $loops,
108 // Wall clock time
109 ( $endTime - $startTime ) / $loops
110 );
111 }
112
120 function getRevIdForTime( Title $title, $timestamp ) {
121 $dbr = $this->getDB( DB_SLAVE );
122
123 $id = $dbr->selectField(
124 [ 'revision', 'page' ],
125 'rev_id',
126 [
127 'page_namespace' => $title->getNamespace(),
128 'page_title' => $title->getDBkey(),
129 'rev_timestamp <= ' . $dbr->addQuotes( $timestamp )
130 ],
131 __METHOD__,
132 [ 'ORDER BY' => 'rev_timestamp DESC', 'LIMIT' => 1 ],
133 [ 'revision' => [ 'INNER JOIN', 'rev_page=page_id' ] ]
134 );
135
136 return $id;
137 }
138
144 function runParser( Revision $revision ) {
145 $content = $revision->getContent();
146 $content->getParserOutput( $revision->getTitle(), $revision->getId() );
147 }
148
159 function onFetchTemplate( Parser $parser, Title $title, &$skip, &$id ) {
160 $pdbk = $title->getPrefixedDBkey();
161 if ( !isset( $this->idCache[$pdbk] ) ) {
162 $proposedId = $this->getRevIdForTime( $title, $this->templateTimestamp );
163 $this->idCache[$pdbk] = $proposedId;
164 }
165 if ( $this->idCache[$pdbk] !== false ) {
166 $id = $this->idCache[$pdbk];
167 }
168
169 return true;
170 }
171}
172
173$maintClass = 'BenchmarkParse';
const TS_MW
MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
$i
Definition Parser.php:1694
$maintClass
Maintenance script to benchmark how long it takes to parse a given title at an optionally specified t...
getRevIdForTime(Title $title, $timestamp)
Fetch the ID of the revision of a Title that occurred.
onFetchTemplate(Parser $parser, Title $title, &$skip, &$id)
Hook into the parser's revision ID fetcher.
__construct()
Default constructor.
runParser(Revision $revision)
Parse the text from a given Revision.
execute()
Do the actual work.
array $idCache
Cache that maps a Title DB key to revision ID for the requested timestamp.
string $templateTimestamp
MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
error( $err, $die=0)
Throw an error to the user.
addArg( $arg, $description, $required=true)
Add some args that are needed.
getDB( $db, $groups=[], $wiki=false)
Returns a database to be used by current maintenance script.
hasOption( $name)
Checks to see if a particular param exists.
getArg( $argId=0, $default=null)
Get an argument.
addDescription( $text)
Set the description text.
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
getOption( $name, $default=null)
Get an option, or return the default.
PHP Parser - Processes wiki markup (which uses a more user-friendly syntax, such as "[[link]]" for ma...
Definition Parser.php:67
getTitle()
Returns the title of the page associated with this entry or null.
Definition Revision.php:773
getId()
Get revision ID.
Definition Revision.php:716
getContent( $audience=self::FOR_PUBLIC, User $user=null)
Fetch revision content if it's available to the specified audience.
static newFromTitle(LinkTarget $linkTarget, $id=0, $flags=0)
Load either the current, or a specified, revision that's attached to a given link target.
Definition Revision.php:117
static newFromId( $id, $flags=0)
Load a page revision from a given revision ID number.
Definition Revision.php:99
Represents a title within MediaWiki.
Definition Title.php:34
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition Title.php:277
const DB_SLAVE
Definition Defines.php:47
the array() calling protocol came about after MediaWiki 1.4rc1.
in this case you re responsible for computing and outputting the entire conflict i e
Definition hooks.txt:1243
do that in ParserLimitReportFormat instead $parser
Definition hooks.txt:2341
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content $content
Definition hooks.txt:1040
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:944
if( $limit) $timestamp
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
require_once RUN_MAINTENANCE_IF_MAIN