4 * Created on Sep 5, 2006
6 * API for MediaWiki 1.8+
8 * Copyright © 2006, 2010 Yuri Astrakhan <Firstname><Lastname>@gmail.com
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23 * http://www.gnu.org/copyleft/gpl.html
27 * This abstract class implements many basic API functions, and is the base of
29 * The class functions are divided into several areas of functionality:
31 * Module parameters: Derived classes can define getAllowedParams() to specify
32 * which parameters to expect,h ow to parse and validate them.
34 * Profiling: various methods to allow keeping tabs on various tasks and their
37 * Self-documentation: code to allow the API to document its own state
41 abstract class ApiBase
{
43 // These constants allow modules to specify exactly how to treat incoming parameters.
45 const PARAM_DFLT
= 0; // Default value of the parameter
46 const PARAM_ISMULTI
= 1; // Boolean, do we accept more than one item for this parameter (e.g.: titles)?
47 const PARAM_TYPE
= 2; // Can be either a string type (e.g.: 'integer') or an array of allowed values
48 const PARAM_MAX
= 3; // Max value allowed for a parameter. Only applies if TYPE='integer'
49 const PARAM_MAX2
= 4; // Max value allowed for a parameter for bots and sysops. Only applies if TYPE='integer'
50 const PARAM_MIN
= 5; // Lowest value allowed for a parameter. Only applies if TYPE='integer'
51 const PARAM_ALLOW_DUPLICATES
= 6; // Boolean, do we allow the same value to be set more than once when ISMULTI=true
52 const PARAM_DEPRECATED
= 7; // Boolean, is the parameter deprecated (will show a warning)
53 const PARAM_REQUIRED
= 8; // Boolean, is the parameter required?
55 const LIMIT_BIG1
= 500; // Fast query, std user limit
56 const LIMIT_BIG2
= 5000; // Fast query, bot/sysop limit
57 const LIMIT_SML1
= 50; // Slow query, std user limit
58 const LIMIT_SML2
= 500; // Slow query, bot/sysop limit
60 private $mMainModule, $mModuleName, $mModulePrefix;
61 private $mParamCache = array();
65 * @param $mainModule ApiMain object
66 * @param $moduleName string Name of this module
67 * @param $modulePrefix string Prefix to use for parameter names
69 public function __construct( $mainModule, $moduleName, $modulePrefix = '' ) {
70 $this->mMainModule
= $mainModule;
71 $this->mModuleName
= $moduleName;
72 $this->mModulePrefix
= $modulePrefix;
75 /*****************************************************************************
77 *****************************************************************************/
80 * Evaluates the parameters, performs the requested query, and sets up
81 * the result. Concrete implementations of ApiBase must override this
82 * method to provide whatever functionality their module offers.
83 * Implementations must not produce any output on their own and are not
84 * expected to handle any errors.
86 * The execute() method will be invoked directly by ApiMain immediately
87 * before the result of the module is output. Aside from the
88 * constructor, implementations should assume that no other methods
89 * will be called externally on the module before the result is
92 * The result data should be stored in the ApiResult object available
93 * through getResult().
95 public abstract function execute();
98 * Returns a string that identifies the version of the extending class.
99 * Typically includes the class name, the svn revision, timestamp, and
100 * last author. Usually done with SVN's Id keyword
103 public abstract function getVersion();
106 * Get the name of the module being executed by this instance
109 public function getModuleName() {
110 return $this->mModuleName
;
114 * Get parameter prefix (usually two letters or an empty string).
117 public function getModulePrefix() {
118 return $this->mModulePrefix
;
122 * Get the name of the module as shown in the profiler log
125 public function getModuleProfileName( $db = false ) {
127 return 'API:' . $this->mModuleName
. '-DB';
129 return 'API:' . $this->mModuleName
;
134 * Get the main module
135 * @return ApiMain object
137 public function getMain() {
138 return $this->mMainModule
;
142 * Returns true if this module is the main module ($this === $this->mMainModule),
146 public function isMain() {
147 return $this === $this->mMainModule
;
151 * Get the result object
154 public function getResult() {
155 // Main module has getResult() method overriden
156 // Safety - avoid infinite loop:
157 if ( $this->isMain() ) {
158 ApiBase
::dieDebug( __METHOD__
, 'base method was called on main module. ' );
160 return $this->getMain()->getResult();
164 * Get the result data array (read-only)
167 public function getResultData() {
168 return $this->getResult()->getData();
172 * Set warning section for this module. Users should monitor this
173 * section to notice any changes in API. Multiple calls to this
174 * function will result in the warning messages being separated by
176 * @param $warning string Warning message
178 public function setWarning( $warning ) {
179 $data = $this->getResult()->getData();
180 if ( isset( $data['warnings'][$this->getModuleName()] ) ) {
181 // Don't add duplicate warnings
182 $warn_regex = preg_quote( $warning, '/' );
183 if ( preg_match( "/{$warn_regex}(\\n|$)/", $data['warnings'][$this->getModuleName()]['*'] ) )
187 $oldwarning = $data['warnings'][$this->getModuleName()]['*'];
188 // If there is a warning already, append it to the existing one
189 $warning = "$oldwarning\n$warning";
190 $this->getResult()->unsetValue( 'warnings', $this->getModuleName() );
193 ApiResult
::setContent( $msg, $warning );
194 $this->getResult()->disableSizeCheck();
195 $this->getResult()->addValue( 'warnings', $this->getModuleName(), $msg );
196 $this->getResult()->enableSizeCheck();
200 * If the module may only be used with a certain format module,
201 * it should override this method to return an instance of that formatter.
202 * A value of null means the default format will be used.
203 * @return mixed instance of a derived class of ApiFormatBase, or null
205 public function getCustomPrinter() {
210 * Generates help message for this module, or false if there is no description
211 * @return mixed string or false
213 public function makeHelpMsg() {
214 static $lnPrfx = "\n ";
216 $msg = $this->getDescription();
218 if ( $msg !== false ) {
220 if ( !is_array( $msg ) ) {
225 $msg = $lnPrfx . implode( $lnPrfx, $msg ) . "\n";
227 if ( $this->isReadMode() ) {
228 $msg .= "\nThis module requires read rights";
230 if ( $this->isWriteMode() ) {
231 $msg .= "\nThis module requires write rights";
233 if ( $this->mustBePosted() ) {
234 $msg .= "\nThis module only accepts POST requests";
236 if ( $this->isReadMode() ||
$this->isWriteMode() ||
237 $this->mustBePosted() )
243 $paramsMsg = $this->makeHelpMsgParameters();
244 if ( $paramsMsg !== false ) {
245 $msg .= "Parameters:\n$paramsMsg";
249 $examples = $this->getExamples();
250 if ( $examples !== false ) {
251 if ( !is_array( $examples ) ) {
256 $msg .= 'Example' . ( count( $examples ) > 1 ?
's' : '' ) . ":\n ";
257 $msg .= implode( $lnPrfx, $examples ) . "\n";
260 if ( $this->getMain()->getShowVersions() ) {
261 $versions = $this->getVersion();
262 $pattern = '/(\$.*) ([0-9a-z_]+\.php) (.*\$)/i';
263 $callback = array( $this, 'makeHelpMsg_callback' );
265 if ( is_array( $versions ) ) {
266 foreach ( $versions as &$v ) {
267 $v = preg_replace_callback( $pattern, $callback, $v );
269 $versions = implode( "\n ", $versions );
271 $versions = preg_replace_callback( $pattern, $callback, $versions );
274 $msg .= "Version:\n $versions\n";
282 * Generates the parameter descriptions for this module, to be displayed in the
286 public function makeHelpMsgParameters() {
287 $params = $this->getFinalParams();
290 $paramsDescription = $this->getFinalParamDescription();
292 $paramPrefix = "\n" . str_repeat( ' ', 19 );
293 foreach ( $params as $paramName => $paramSettings ) {
294 $desc = isset( $paramsDescription[$paramName] ) ?
$paramsDescription[$paramName] : '';
295 if ( is_array( $desc ) ) {
296 $desc = implode( $paramPrefix, $desc );
299 if ( !is_array( $paramSettings ) ) {
300 $paramSettings = array(
301 self
::PARAM_DFLT
=> $paramSettings,
305 $deprecated = isset( $paramSettings[self
::PARAM_DEPRECATED
] ) ?
306 $paramSettings[self
::PARAM_DEPRECATED
] : false;
308 $desc = "DEPRECATED! $desc";
311 $required = isset( $paramSettings[self
::PARAM_REQUIRED
] ) ?
312 $paramSettings[self
::PARAM_REQUIRED
] : false;
314 $desc .= $paramPrefix . "This parameter is required";
317 $type = isset( $paramSettings[self
::PARAM_TYPE
] ) ?
$paramSettings[self
::PARAM_TYPE
] : null;
318 if ( isset( $type ) ) {
319 if ( isset( $paramSettings[self
::PARAM_ISMULTI
] ) ) {
320 $prompt = 'Values (separate with \'|\'): ';
322 $prompt = 'One value: ';
325 if ( is_array( $type ) ) {
327 $nothingPrompt = false;
328 foreach ( $type as $t ) {
330 $nothingPrompt = 'Can be empty, or ';
335 $desc .= $paramPrefix . $nothingPrompt . $prompt . implode( ', ', $choices );
339 // Special handling because namespaces are type-limited, yet they are not given
340 $desc .= $paramPrefix . $prompt . implode( ', ', MWNamespace
::getValidNamespaces() );
343 $desc .= $paramPrefix . "No more than {$paramSettings[self :: PARAM_MAX]} ({$paramSettings[self::PARAM_MAX2]} for bots) allowed";
346 $hasMin = isset( $paramSettings[self
::PARAM_MIN
] );
347 $hasMax = isset( $paramSettings[self
::PARAM_MAX
] );
348 if ( $hasMin ||
$hasMax ) {
350 $intRangeStr = "The value must be no less than {$paramSettings[self::PARAM_MIN]}";
351 } elseif ( !$hasMin ) {
352 $intRangeStr = "The value must be no more than {$paramSettings[self::PARAM_MAX]}";
354 $intRangeStr = "The value must be between {$paramSettings[self::PARAM_MIN]} and {$paramSettings[self::PARAM_MAX]}";
357 $desc .= $paramPrefix . $intRangeStr;
364 $default = is_array( $paramSettings ) ?
( isset( $paramSettings[self
::PARAM_DFLT
] ) ?
$paramSettings[self
::PARAM_DFLT
] : null ) : $paramSettings;
365 if ( !is_null( $default ) && $default !== false ) {
366 $desc .= $paramPrefix . "Default: $default";
369 $msg .= sprintf( " %-14s - %s\n", $this->encodeParamName( $paramName ), $desc );
379 * Callback for preg_replace_callback() call in makeHelpMsg().
380 * Replaces a source file name with a link to ViewVC
382 public function makeHelpMsg_callback( $matches ) {
383 global $wgAutoloadClasses, $wgAutoloadLocalClasses;
384 if ( isset( $wgAutoloadLocalClasses[get_class( $this )] ) ) {
385 $file = $wgAutoloadLocalClasses[get_class( $this )];
386 } elseif ( isset( $wgAutoloadClasses[get_class( $this )] ) ) {
387 $file = $wgAutoloadClasses[get_class( $this )];
390 // Do some guesswork here
391 $path = strstr( $file, 'includes/api/' );
392 if ( $path === false ) {
393 $path = strstr( $file, 'extensions/' );
395 $path = 'phase3/' . $path;
398 // Get the filename from $matches[2] instead of $file
399 // If they're not the same file, they're assumed to be in the
401 // This is necessary to make stuff like ApiMain::getVersion()
402 // returning the version string for ApiBase work
404 return "{$matches[0]}\n http://svn.wikimedia.org/" .
405 "viewvc/mediawiki/trunk/" . dirname( $path ) .
412 * Returns the description string for this module
413 * @return mixed string or array of strings
415 protected function getDescription() {
420 * Returns usage examples for this module. Return null if no examples are available.
421 * @return mixed string or array of strings
423 protected function getExamples() {
428 * Returns an array of allowed parameters (parameter name) => (default
429 * value) or (parameter name) => (array with PARAM_* constants as keys)
430 * Don't call this function directly: use getFinalParams() to allow
431 * hooks to modify parameters as needed.
434 protected function getAllowedParams() {
439 * Returns an array of parameter descriptions.
440 * Don't call this functon directly: use getFinalParamDescription() to
441 * allow hooks to modify descriptions as needed.
444 protected function getParamDescription() {
449 * Get final list of parameters, after hooks have had a chance to
450 * tweak it as needed.
453 public function getFinalParams() {
454 $params = $this->getAllowedParams();
455 wfRunHooks( 'APIGetAllowedParams', array( &$this, &$params ) );
460 * Get final description, after hooks have had a chance to tweak it as
464 public function getFinalParamDescription() {
465 $desc = $this->getParamDescription();
466 wfRunHooks( 'APIGetParamDescription', array( &$this, &$desc ) );
471 * This method mangles parameter name based on the prefix supplied to the constructor.
472 * Override this method to change parameter name during runtime
473 * @param $paramName string Parameter name
474 * @return string Prefixed parameter name
476 public function encodeParamName( $paramName ) {
477 return $this->mModulePrefix
. $paramName;
481 * Using getAllowedParams(), this function makes an array of the values
482 * provided by the user, with key being the name of the variable, and
483 * value - validated value from user or default. limits will not be
484 * parsed if $parseLimit is set to false; use this when the max
485 * limit is not definitive yet, e.g. when getting revisions.
486 * @param $parseLimit Boolean: true by default
489 public function extractRequestParams( $parseLimit = true ) {
490 // Cache parameters, for performance and to avoid bug 24564.
491 if ( !isset( $this->mParamCache
[$parseLimit] ) ) {
492 $params = $this->getFinalParams();
495 if ( $params ) { // getFinalParams() can return false
496 foreach ( $params as $paramName => $paramSettings ) {
497 $results[$paramName] = $this->getParameterFromSettings(
498 $paramName, $paramSettings, $parseLimit );
501 $this->mParamCache
[$parseLimit] = $results;
503 return $this->mParamCache
[$parseLimit];
507 * Get a value for the given parameter
508 * @param $paramName string Parameter name
509 * @param $parseLimit bool see extractRequestParams()
510 * @return mixed Parameter value
512 protected function getParameter( $paramName, $parseLimit = true ) {
513 $params = $this->getFinalParams();
514 $paramSettings = $params[$paramName];
515 return $this->getParameterFromSettings( $paramName, $paramSettings, $parseLimit );
519 * Die if none or more than one of a certain set of parameters is set and not false.
520 * @param $params array of parameter names
522 public function requireOnlyOneParameter( $params ) {
523 $required = func_get_args();
524 array_shift( $required );
526 $intersection = array_intersect( array_keys( array_filter( $params,
527 create_function( '$x', 'return !is_null($x) && $x !== false;' )
529 if ( count( $intersection ) > 1 ) {
530 $this->dieUsage( 'The parameters ' . implode( ', ', $intersection ) . ' can not be used together', 'invalidparammix' );
531 } elseif ( count( $intersection ) == 0 ) {
532 $this->dieUsage( 'One of the parameters ' . implode( ', ', $required ) . ' is required', 'missingparam' );
537 * @deprecated use MWNamespace::getValidNamespaces()
539 public static function getValidNamespaces() {
540 return MWNamespace
::getValidNamespaces();
544 * Return true if we're to watch the page, false if not, null if no change.
545 * @param $watchlist String Valid values: 'watch', 'unwatch', 'preferences', 'nochange'
546 * @param $titleObj Title the page under consideration
547 * @param $userOption The user option to consider when $watchlist=preferences.
548 * If not set will magically default to either watchdefault or watchcreations
551 protected function getWatchlistValue ( $watchlist, $titleObj, $userOption = null ) {
552 switch ( $watchlist ) {
561 # If the user is already watching, don't bother checking
562 if ( $titleObj->userIsWatching() ) {
565 # If no user option was passed, use watchdefault or watchcreation
566 if ( is_null( $userOption ) ) {
567 $userOption = $titleObj->exists()
568 ?
'watchdefault' : 'watchcreations';
570 # If the corresponding user option is true, watch, else no change
571 return $wgUser->getOption( $userOption ) ?
true : null;
582 * Set a watch (or unwatch) based the based on a watchlist parameter.
583 * @param $watch String Valid values: 'watch', 'unwatch', 'preferences', 'nochange'
584 * @param $titleObj Title the article's title to change
585 * @param $userOption The user option to consider when $watch=preferences
587 protected function setWatch ( $watch, $titleObj, $userOption = null ) {
588 $value = $this->getWatchlistValue( $watch, $titleObj, $userOption );
589 if ( $value === null ) {
593 $articleObj = new Article( $titleObj );
595 $articleObj->doWatch();
597 $articleObj->doUnwatch();
602 * Using the settings determine the value for the given parameter
604 * @param $paramName String: parameter name
605 * @param $paramSettings Mixed: default value or an array of settings
606 * using PARAM_* constants.
607 * @param $parseLimit Boolean: parse limit?
608 * @return mixed Parameter value
610 protected function getParameterFromSettings( $paramName, $paramSettings, $parseLimit ) {
611 // Some classes may decide to change parameter names
612 $encParamName = $this->encodeParamName( $paramName );
614 if ( !is_array( $paramSettings ) ) {
615 $default = $paramSettings;
617 $type = gettype( $paramSettings );
622 $default = isset( $paramSettings[self
::PARAM_DFLT
] ) ?
$paramSettings[self
::PARAM_DFLT
] : null;
623 $multi = isset( $paramSettings[self
::PARAM_ISMULTI
] ) ?
$paramSettings[self
::PARAM_ISMULTI
] : false;
624 $type = isset( $paramSettings[self
::PARAM_TYPE
] ) ?
$paramSettings[self
::PARAM_TYPE
] : null;
625 $dupes = isset( $paramSettings[self
::PARAM_ALLOW_DUPLICATES
] ) ?
$paramSettings[self
::PARAM_ALLOW_DUPLICATES
] : false;
626 $deprecated = isset( $paramSettings[self
::PARAM_DEPRECATED
] ) ?
$paramSettings[self
::PARAM_DEPRECATED
] : false;
627 $required = isset( $paramSettings[self
::PARAM_REQUIRED
] ) ?
$paramSettings[self
::PARAM_REQUIRED
] : false;
629 // When type is not given, and no choices, the type is the same as $default
630 if ( !isset( $type ) ) {
631 if ( isset( $default ) ) {
632 $type = gettype( $default );
634 $type = 'NULL'; // allow everything
639 if ( $type == 'boolean' ) {
640 if ( isset( $default ) && $default !== false ) {
641 // Having a default value of anything other than 'false' is pointless
642 ApiBase
::dieDebug( __METHOD__
, "Boolean param $encParamName's default is set to '$default'" );
645 $value = $this->getMain()->getRequest()->getCheck( $encParamName );
647 $value = $this->getMain()->getRequest()->getVal( $encParamName, $default );
649 if ( isset( $value ) && $type == 'namespace' ) {
650 $type = MWNamespace
::getValidNamespaces();
654 if ( isset( $value ) && ( $multi ||
is_array( $type ) ) ) {
655 $value = $this->parseMultiValue( $encParamName, $value, $multi, is_array( $type ) ?
$type : null );
658 // More validation only when choices were not given
659 // choices were validated in parseMultiValue()
660 if ( isset( $value ) ) {
661 if ( !is_array( $type ) ) {
663 case 'NULL': // nothing to do
666 if ( $value === '' ) {
667 $this->dieUsageMsg( array( 'missingparam', $paramName ) );
671 case 'integer': // Force everything using intval() and optionally validate limits
673 $value = is_array( $value ) ?
array_map( 'intval', $value ) : intval( $value );
674 $min = isset ( $paramSettings[self
::PARAM_MIN
] ) ?
$paramSettings[self
::PARAM_MIN
] : null;
675 $max = isset ( $paramSettings[self
::PARAM_MAX
] ) ?
$paramSettings[self
::PARAM_MAX
] : null;
677 if ( !is_null( $min ) ||
!is_null( $max ) ) {
678 $values = is_array( $value ) ?
$value : array( $value );
679 foreach ( $values as &$v ) {
680 $this->validateLimit( $paramName, $v, $min, $max );
685 if ( !$parseLimit ) {
686 // Don't do any validation whatsoever
689 if ( !isset( $paramSettings[self
::PARAM_MAX
] ) ||
!isset( $paramSettings[self
::PARAM_MAX2
] ) ) {
690 ApiBase
::dieDebug( __METHOD__
, "MAX1 or MAX2 are not defined for the limit $encParamName" );
693 ApiBase
::dieDebug( __METHOD__
, "Multi-values not supported for $encParamName" );
695 $min = isset( $paramSettings[self
::PARAM_MIN
] ) ?
$paramSettings[self
::PARAM_MIN
] : 0;
696 if ( $value == 'max' ) {
697 $value = $this->getMain()->canApiHighLimits() ?
$paramSettings[self
::PARAM_MAX2
] : $paramSettings[self
::PARAM_MAX
];
698 $this->getResult()->setParsedLimit( $this->getModuleName(), $value );
700 $value = intval( $value );
701 $this->validateLimit( $paramName, $value, $min, $paramSettings[self
::PARAM_MAX
], $paramSettings[self
::PARAM_MAX2
] );
706 ApiBase
::dieDebug( __METHOD__
, "Multi-values not supported for $encParamName" );
711 ApiBase
::dieDebug( __METHOD__
, "Multi-values not supported for $encParamName" );
713 $value = wfTimestamp( TS_UNIX
, $value );
714 if ( $value === 0 ) {
715 $this->dieUsage( "Invalid value '$value' for timestamp parameter $encParamName", "badtimestamp_{$encParamName}" );
717 $value = wfTimestamp( TS_MW
, $value );
720 if ( !is_array( $value ) ) {
721 $value = array( $value );
724 foreach ( $value as $key => $val ) {
725 $title = Title
::makeTitleSafe( NS_USER
, $val );
726 if ( is_null( $title ) ) {
727 $this->dieUsage( "Invalid value for user parameter $encParamName", "baduser_{$encParamName}" );
729 $value[$key] = $title->getText();
737 ApiBase
::dieDebug( __METHOD__
, "Param $encParamName's type is unknown - $type" );
739 } else if ( !$dupes ) {
740 // Throw out duplicates if requested
741 $value = array_unique( $value );
744 // Set a warning if a deprecated parameter has been passed
745 if ( $deprecated && $value !== false ) {
746 $this->setWarning( "The $encParamName parameter has been deprecated." );
748 } else if ( $required ) {
749 $this->dieUsageMsg( array( 'missingparam', $paramName ) );
756 * Return an array of values that were given in a 'a|b|c' notation,
757 * after it optionally validates them against the list allowed values.
759 * @param $valueName string The name of the parameter (for error
761 * @param $value mixed The value being parsed
762 * @param $allowMultiple bool Can $value contain more than one value
764 * @param $allowedValues mixed An array of values to check against. If
765 * null, all values are accepted.
766 * @return mixed (allowMultiple ? an_array_of_values : a_single_value)
768 protected function parseMultiValue( $valueName, $value, $allowMultiple, $allowedValues ) {
769 if ( trim( $value ) === '' && $allowMultiple ) {
773 // This is a bit awkward, but we want to avoid calling canApiHighLimits() because it unstubs $wgUser
774 $valuesList = explode( '|', $value, self
::LIMIT_SML2 +
1 );
775 $sizeLimit = count( $valuesList ) > self
::LIMIT_SML1
&& $this->mMainModule
->canApiHighLimits() ?
776 self
::LIMIT_SML2
: self
::LIMIT_SML1
;
778 if ( self
::truncateArray( $valuesList, $sizeLimit ) ) {
779 $this->setWarning( "Too many values supplied for parameter '$valueName': the limit is $sizeLimit" );
782 if ( !$allowMultiple && count( $valuesList ) != 1 ) {
783 $possibleValues = is_array( $allowedValues ) ?
"of '" . implode( "', '", $allowedValues ) . "'" : '';
784 $this->dieUsage( "Only one $possibleValues is allowed for parameter '$valueName'", "multival_$valueName" );
787 if ( is_array( $allowedValues ) ) {
788 // Check for unknown values
789 $unknown = array_diff( $valuesList, $allowedValues );
790 if ( count( $unknown ) ) {
791 if ( $allowMultiple ) {
792 $s = count( $unknown ) > 1 ?
's' : '';
793 $vals = implode( ", ", $unknown );
794 $this->setWarning( "Unrecognized value$s for parameter '$valueName': $vals" );
796 $this->dieUsage( "Unrecognized value for parameter '$valueName': {$valuesList[0]}", "unknown_$valueName" );
799 // Now throw them out
800 $valuesList = array_intersect( $valuesList, $allowedValues );
803 return $allowMultiple ?
$valuesList : $valuesList[0];
807 * Validate the value against the minimum and user/bot maximum limits.
808 * Prints usage info on failure.
809 * @param $paramName string Parameter name
810 * @param $value int Parameter value
811 * @param $min int Minimum value
812 * @param $max int Maximum value for users
813 * @param $botMax int Maximum value for sysops/bots
815 function validateLimit( $paramName, &$value, $min, $max, $botMax = null ) {
816 if ( !is_null( $min ) && $value < $min ) {
817 $this->setWarning( $this->encodeParamName( $paramName ) . " may not be less than $min (set to $value)" );
821 // Minimum is always validated, whereas maximum is checked only if not running in internal call mode
822 if ( $this->getMain()->isInternalMode() ) {
826 // Optimization: do not check user's bot status unless really needed -- skips db query
827 // assumes $botMax >= $max
828 if ( !is_null( $max ) && $value > $max ) {
829 if ( !is_null( $botMax ) && $this->getMain()->canApiHighLimits() ) {
830 if ( $value > $botMax ) {
831 $this->setWarning( $this->encodeParamName( $paramName ) . " may not be over $botMax (set to $value) for bots or sysops" );
835 $this->setWarning( $this->encodeParamName( $paramName ) . " may not be over $max (set to $value) for users" );
842 * Truncate an array to a certain length.
843 * @param $arr array Array to truncate
844 * @param $limit int Maximum length
845 * @return bool True if the array was truncated, false otherwise
847 public static function truncateArray( &$arr, $limit ) {
849 while ( count( $arr ) > $limit ) {
857 * Throw a UsageException, which will (if uncaught) call the main module's
858 * error handler and die with an error message.
860 * @param $description string One-line human-readable description of the
861 * error condition, e.g., "The API requires a valid action parameter"
862 * @param $errorCode string Brief, arbitrary, stable string to allow easy
863 * automated identification of the error, e.g., 'unknown_action'
864 * @param $httpRespCode int HTTP response code
865 * @param $extradata array Data to add to the <error> element; array in ApiResult format
867 public function dieUsage( $description, $errorCode, $httpRespCode = 0, $extradata = null ) {
869 throw new UsageException( $description, $this->encodeParamName( $errorCode ), $httpRespCode, $extradata );
873 * Array that maps message keys to error messages. $1 and friends are replaced.
875 public static $messageMap = array(
876 // This one MUST be present, or dieUsageMsg() will recurse infinitely
877 'unknownerror' => array( 'code' => 'unknownerror', 'info' => "Unknown error: ``\$1''" ),
878 'unknownerror-nocode' => array( 'code' => 'unknownerror', 'info' => 'Unknown error' ),
880 // Messages from Title::getUserPermissionsErrors()
881 'ns-specialprotected' => array( 'code' => 'unsupportednamespace', 'info' => "Pages in the Special namespace can't be edited" ),
882 'protectedinterface' => array( 'code' => 'protectednamespace-interface', 'info' => "You're not allowed to edit interface messages" ),
883 'namespaceprotected' => array( 'code' => 'protectednamespace', 'info' => "You're not allowed to edit pages in the ``\$1'' namespace" ),
884 'customcssjsprotected' => array( 'code' => 'customcssjsprotected', 'info' => "You're not allowed to edit custom CSS and JavaScript pages" ),
885 'cascadeprotected' => array( 'code' => 'cascadeprotected', 'info' => "The page you're trying to edit is protected because it's included in a cascade-protected page" ),
886 'protectedpagetext' => array( 'code' => 'protectedpage', 'info' => "The ``\$1'' right is required to edit this page" ),
887 'protect-cantedit' => array( 'code' => 'cantedit', 'info' => "You can't protect this page because you can't edit it" ),
888 'badaccess-group0' => array( 'code' => 'permissiondenied', 'info' => "Permission denied" ), // Generic permission denied message
889 'badaccess-groups' => array( 'code' => 'permissiondenied', 'info' => "Permission denied" ),
890 'titleprotected' => array( 'code' => 'protectedtitle', 'info' => "This title has been protected from creation" ),
891 'nocreate-loggedin' => array( 'code' => 'cantcreate', 'info' => "You don't have permission to create new pages" ),
892 'nocreatetext' => array( 'code' => 'cantcreate-anon', 'info' => "Anonymous users can't create new pages" ),
893 'movenologintext' => array( 'code' => 'cantmove-anon', 'info' => "Anonymous users can't move pages" ),
894 'movenotallowed' => array( 'code' => 'cantmove', 'info' => "You don't have permission to move pages" ),
895 'confirmedittext' => array( 'code' => 'confirmemail', 'info' => "You must confirm your e-mail address before you can edit" ),
896 'blockedtext' => array( 'code' => 'blocked', 'info' => "You have been blocked from editing" ),
897 'autoblockedtext' => array( 'code' => 'autoblocked', 'info' => "Your IP address has been blocked automatically, because it was used by a blocked user" ),
899 // Miscellaneous interface messages
900 'actionthrottledtext' => array( 'code' => 'ratelimited', 'info' => "You've exceeded your rate limit. Please wait some time and try again" ),
901 'alreadyrolled' => array( 'code' => 'alreadyrolled', 'info' => "The page you tried to rollback was already rolled back" ),
902 'cantrollback' => array( 'code' => 'onlyauthor', 'info' => "The page you tried to rollback only has one author" ),
903 'readonlytext' => array( 'code' => 'readonly', 'info' => "The wiki is currently in read-only mode" ),
904 'sessionfailure' => array( 'code' => 'badtoken', 'info' => "Invalid token" ),
905 'cannotdelete' => array( 'code' => 'cantdelete', 'info' => "Couldn't delete ``\$1''. Maybe it was deleted already by someone else" ),
906 'notanarticle' => array( 'code' => 'missingtitle', 'info' => "The page you requested doesn't exist" ),
907 'selfmove' => array( 'code' => 'selfmove', 'info' => "Can't move a page to itself" ),
908 'immobile_namespace' => array( 'code' => 'immobilenamespace', 'info' => "You tried to move pages from or to a namespace that is protected from moving" ),
909 'articleexists' => array( 'code' => 'articleexists', 'info' => "The destination article already exists and is not a redirect to the source article" ),
910 'protectedpage' => array( 'code' => 'protectedpage', 'info' => "You don't have permission to perform this move" ),
911 'hookaborted' => array( 'code' => 'hookaborted', 'info' => "The modification you tried to make was aborted by an extension hook" ),
912 'cantmove-titleprotected' => array( 'code' => 'protectedtitle', 'info' => "The destination article has been protected from creation" ),
913 'imagenocrossnamespace' => array( 'code' => 'nonfilenamespace', 'info' => "Can't move a file to a non-file namespace" ),
914 'imagetypemismatch' => array( 'code' => 'filetypemismatch', 'info' => "The new file extension doesn't match its type" ),
915 // 'badarticleerror' => shouldn't happen
916 // 'badtitletext' => shouldn't happen
917 'ip_range_invalid' => array( 'code' => 'invalidrange', 'info' => "Invalid IP range" ),
918 'range_block_disabled' => array( 'code' => 'rangedisabled', 'info' => "Blocking IP ranges has been disabled" ),
919 'nosuchusershort' => array( 'code' => 'nosuchuser', 'info' => "The user you specified doesn't exist" ),
920 'badipaddress' => array( 'code' => 'invalidip', 'info' => "Invalid IP address specified" ),
921 'ipb_expiry_invalid' => array( 'code' => 'invalidexpiry', 'info' => "Invalid expiry time" ),
922 'ipb_already_blocked' => array( 'code' => 'alreadyblocked', 'info' => "The user you tried to block was already blocked" ),
923 'ipb_blocked_as_range' => array( 'code' => 'blockedasrange', 'info' => "IP address ``\$1'' was blocked as part of range ``\$2''. You can't unblock the IP invidually, but you can unblock the range as a whole." ),
924 'ipb_cant_unblock' => array( 'code' => 'cantunblock', 'info' => "The block you specified was not found. It may have been unblocked already" ),
925 'mailnologin' => array( 'code' => 'cantsend', 'info' => "You are not logged in, you do not have a confirmed e-mail address, or you are not allowed to send e-mail to other users, so you cannot send e-mail" ),
926 'ipbblocked' => array( 'code' => 'ipbblocked', 'info' => 'You cannot block or unblock users while you are yourself blocked' ),
927 'ipbnounblockself' => array( 'code' => 'ipbnounblockself', 'info' => 'You are not allowed to unblock yourself' ),
928 'usermaildisabled' => array( 'code' => 'usermaildisabled', 'info' => "User email has been disabled" ),
929 'blockedemailuser' => array( 'code' => 'blockedfrommail', 'info' => "You have been blocked from sending e-mail" ),
930 'notarget' => array( 'code' => 'notarget', 'info' => "You have not specified a valid target for this action" ),
931 'noemail' => array( 'code' => 'noemail', 'info' => "The user has not specified a valid e-mail address, or has chosen not to receive e-mail from other users" ),
932 'rcpatroldisabled' => array( 'code' => 'patroldisabled', 'info' => "Patrolling is disabled on this wiki" ),
933 'markedaspatrollederror-noautopatrol' => array( 'code' => 'noautopatrol', 'info' => "You don't have permission to patrol your own changes" ),
934 'delete-toobig' => array( 'code' => 'bigdelete', 'info' => "You can't delete this page because it has more than \$1 revisions" ),
935 'movenotallowedfile' => array( 'code' => 'cantmovefile', 'info' => "You don't have permission to move files" ),
936 'userrights-no-interwiki' => array( 'code' => 'nointerwikiuserrights', 'info' => "You don't have permission to change user rights on other wikis" ),
937 'userrights-nodatabase' => array( 'code' => 'nosuchdatabase', 'info' => "Database ``\$1'' does not exist or is not local" ),
938 'nouserspecified' => array( 'code' => 'invaliduser', 'info' => "Invalid username ``\$1''" ),
939 'noname' => array( 'code' => 'invaliduser', 'info' => "Invalid username ``\$1''" ),
940 'summaryrequired' => array( 'code' => 'summaryrequired', 'info' => 'Summary required' ),
942 // API-specific messages
943 'readrequired' => array( 'code' => 'readapidenied', 'info' => "You need read permission to use this module" ),
944 'writedisabled' => array( 'code' => 'noapiwrite', 'info' => "Editing of this wiki through the API is disabled. Make sure the \$wgEnableWriteAPI=true; statement is included in the wiki's LocalSettings.php file" ),
945 'writerequired' => array( 'code' => 'writeapidenied', 'info' => "You're not allowed to edit this wiki through the API" ),
946 'missingparam' => array( 'code' => 'no$1', 'info' => "The \$1 parameter must be set" ),
947 'invalidtitle' => array( 'code' => 'invalidtitle', 'info' => "Bad title ``\$1''" ),
948 'nosuchpageid' => array( 'code' => 'nosuchpageid', 'info' => "There is no page with ID \$1" ),
949 'nosuchrevid' => array( 'code' => 'nosuchrevid', 'info' => "There is no revision with ID \$1" ),
950 'nosuchuser' => array( 'code' => 'nosuchuser', 'info' => "User ``\$1'' doesn't exist" ),
951 'invaliduser' => array( 'code' => 'invaliduser', 'info' => "Invalid username ``\$1''" ),
952 'invalidexpiry' => array( 'code' => 'invalidexpiry', 'info' => "Invalid expiry time ``\$1''" ),
953 'pastexpiry' => array( 'code' => 'pastexpiry', 'info' => "Expiry time ``\$1'' is in the past" ),
954 'create-titleexists' => array( 'code' => 'create-titleexists', 'info' => "Existing titles can't be protected with 'create'" ),
955 'missingtitle-createonly' => array( 'code' => 'missingtitle-createonly', 'info' => "Missing titles can only be protected with 'create'" ),
956 'cantblock' => array( 'code' => 'cantblock', 'info' => "You don't have permission to block users" ),
957 'canthide' => array( 'code' => 'canthide', 'info' => "You don't have permission to hide user names from the block log" ),
958 'cantblock-email' => array( 'code' => 'cantblock-email', 'info' => "You don't have permission to block users from sending e-mail through the wiki" ),
959 'unblock-notarget' => array( 'code' => 'notarget', 'info' => "Either the id or the user parameter must be set" ),
960 'unblock-idanduser' => array( 'code' => 'idanduser', 'info' => "The id and user parameters can't be used together" ),
961 'cantunblock' => array( 'code' => 'permissiondenied', 'info' => "You don't have permission to unblock users" ),
962 'cannotundelete' => array( 'code' => 'cantundelete', 'info' => "Couldn't undelete: the requested revisions may not exist, or may have been undeleted already" ),
963 'permdenied-undelete' => array( 'code' => 'permissiondenied', 'info' => "You don't have permission to restore deleted revisions" ),
964 'createonly-exists' => array( 'code' => 'articleexists', 'info' => "The article you tried to create has been created already" ),
965 'nocreate-missing' => array( 'code' => 'missingtitle', 'info' => "The article you tried to edit doesn't exist" ),
966 'nosuchrcid' => array( 'code' => 'nosuchrcid', 'info' => "There is no change with rcid ``\$1''" ),
967 'cantpurge' => array( 'code' => 'cantpurge', 'info' => "Only users with the 'purge' right can purge pages via the API" ),
968 'protect-invalidaction' => array( 'code' => 'protect-invalidaction', 'info' => "Invalid protection type ``\$1''" ),
969 'protect-invalidlevel' => array( 'code' => 'protect-invalidlevel', 'info' => "Invalid protection level ``\$1''" ),
970 'toofewexpiries' => array( 'code' => 'toofewexpiries', 'info' => "\$1 expiry timestamps were provided where \$2 were needed" ),
971 'cantimport' => array( 'code' => 'cantimport', 'info' => "You don't have permission to import pages" ),
972 'cantimport-upload' => array( 'code' => 'cantimport-upload', 'info' => "You don't have permission to import uploaded pages" ),
973 'nouploadmodule' => array( 'code' => 'nomodule', 'info' => 'No upload module set' ),
974 'importnofile' => array( 'code' => 'nofile', 'info' => "You didn't upload a file" ),
975 'importuploaderrorsize' => array( 'code' => 'filetoobig', 'info' => 'The file you uploaded is bigger than the maximum upload size' ),
976 'importuploaderrorpartial' => array( 'code' => 'partialupload', 'info' => 'The file was only partially uploaded' ),
977 'importuploaderrortemp' => array( 'code' => 'notempdir', 'info' => 'The temporary upload directory is missing' ),
978 'importcantopen' => array( 'code' => 'cantopenfile', 'info' => "Couldn't open the uploaded file" ),
979 'import-noarticle' => array( 'code' => 'badinterwiki', 'info' => 'Invalid interwiki title specified' ),
980 'importbadinterwiki' => array( 'code' => 'badinterwiki', 'info' => 'Invalid interwiki title specified' ),
981 'import-unknownerror' => array( 'code' => 'import-unknownerror', 'info' => "Unknown error on import: ``\$1''" ),
982 'cantoverwrite-sharedfile' => array( 'code' => 'cantoverwrite-sharedfile', 'info' => 'The target file exists on a shared repository and you do not have permission to override it' ),
983 'sharedfile-exists' => array( 'code' => 'fileexists-sharedrepo-perm', 'info' => 'The target file exists on a shared repository. Use the ignorewarnings parameter to override it.' ),
984 'mustbeposted' => array( 'code' => 'mustbeposted', 'info' => "The \$1 module requires a POST request" ),
985 'show' => array( 'code' => 'show', 'info' => 'Incorrect parameter - mutually exclusive values may not be supplied' ),
987 // ApiEditPage messages
988 'noimageredirect-anon' => array( 'code' => 'noimageredirect-anon', 'info' => "Anonymous users can't create image redirects" ),
989 'noimageredirect-logged' => array( 'code' => 'noimageredirect', 'info' => "You don't have permission to create image redirects" ),
990 'spamdetected' => array( 'code' => 'spamdetected', 'info' => "Your edit was refused because it contained a spam fragment: ``\$1''" ),
991 'filtered' => array( 'code' => 'filtered', 'info' => "The filter callback function refused your edit" ),
992 'contenttoobig' => array( 'code' => 'contenttoobig', 'info' => "The content you supplied exceeds the article size limit of \$1 kilobytes" ),
993 'noedit-anon' => array( 'code' => 'noedit-anon', 'info' => "Anonymous users can't edit pages" ),
994 'noedit' => array( 'code' => 'noedit', 'info' => "You don't have permission to edit pages" ),
995 'wasdeleted' => array( 'code' => 'pagedeleted', 'info' => "The page has been deleted since you fetched its timestamp" ),
996 'blankpage' => array( 'code' => 'emptypage', 'info' => "Creating new, empty pages is not allowed" ),
997 'editconflict' => array( 'code' => 'editconflict', 'info' => "Edit conflict detected" ),
998 'hashcheckfailed' => array( 'code' => 'badmd5', 'info' => "The supplied MD5 hash was incorrect" ),
999 'missingtext' => array( 'code' => 'notext', 'info' => "One of the text, appendtext, prependtext and undo parameters must be set" ),
1000 'emptynewsection' => array( 'code' => 'emptynewsection', 'info' => 'Creating empty new sections is not possible.' ),
1001 'revwrongpage' => array( 'code' => 'revwrongpage', 'info' => "r\$1 is not a revision of ``\$2''" ),
1002 'undo-failure' => array( 'code' => 'undofailure', 'info' => 'Undo failed due to conflicting intermediate edits' ),
1005 'invalid-session-key' => array( 'code' => 'invalid-session-key', 'info' => 'Not a valid session key' ),
1006 'nouploadmodule' => array( 'code' => 'nouploadmodule', 'info' => 'No upload module set' ),
1007 'uploaddisabled' => array( 'code' => 'uploaddisabled', 'info' => 'Uploads are not enabled. Make sure $wgEnableUploads is set to true in LocalSettings.php and the PHP ini setting file_uploads is true' ),
1008 'copyuploaddisabled' => array( 'code' => 'copyuploaddisabled', 'info' => 'Uploads by URL is not enabled. Make sure $wgAllowCopyUploads is set to true in LocalSettings.php.' ),
1012 * Helper function for readonly errors
1014 public function dieReadOnly() {
1015 $parsed = $this->parseMsg( array( 'readonlytext' ) );
1016 $this->dieUsage( $parsed['info'], $parsed['code'], /* http error */ 0,
1017 array( 'readonlyreason' => wfReadOnlyReason() ) );
1021 * Output the error message related to a certain array
1022 * @param $error array Element of a getUserPermissionsErrors()-style array
1024 public function dieUsageMsg( $error ) {
1025 $parsed = $this->parseMsg( $error );
1026 $this->dieUsage( $parsed['info'], $parsed['code'] );
1030 * Return the error message related to a certain array
1031 * @param $error array Element of a getUserPermissionsErrors()-style array
1032 * @return array('code' => code, 'info' => info)
1034 public function parseMsg( $error ) {
1035 $key = array_shift( $error );
1036 if ( isset( self
::$messageMap[$key] ) ) {
1037 return array( 'code' =>
1038 wfMsgReplaceArgs( self
::$messageMap[$key]['code'], $error ),
1040 wfMsgReplaceArgs( self
::$messageMap[$key]['info'], $error )
1043 // If the key isn't present, throw an "unknown error"
1044 return $this->parseMsg( array( 'unknownerror', $key ) );
1048 * Internal code errors should be reported with this method
1049 * @param $method string Method or function name
1050 * @param $message string Error message
1052 protected static function dieDebug( $method, $message ) {
1053 wfDebugDieBacktrace( "Internal error in $method: $message" );
1057 * Indicates if this module needs maxlag to be checked
1060 public function shouldCheckMaxlag() {
1065 * Indicates whether this module requires read rights
1068 public function isReadMode() {
1072 * Indicates whether this module requires write mode
1075 public function isWriteMode() {
1080 * Indicates whether this module must be called with a POST request
1083 public function mustBePosted() {
1088 * Returns the token salt if there is one, '' if the module doesn't require a salt, else false if the module doesn't need a token
1091 public function getTokenSalt() {
1096 * Gets the user for whom to get the watchlist
1100 public function getWatchlistUser( $params ) {
1102 if ( !is_null( $params['owner'] ) && !is_null( $params['token'] ) ) {
1103 $user = User
::newFromName( $params['owner'], false );
1104 if ( !$user->getId() ) {
1105 $this->dieUsage( 'Specified user does not exist', 'bad_wlowner' );
1107 $token = $user->getOption( 'watchlisttoken' );
1108 if ( $token == '' ||
$token != $params['token'] ) {
1109 $this->dieUsage( 'Incorrect watchlist token provided -- please set a correct token in Special:Preferences', 'bad_wltoken' );
1112 if ( !$wgUser->isLoggedIn() ) {
1113 $this->dieUsage( 'You must be logged-in to have a watchlist', 'notloggedin' );
1121 * Returns a list of all possible errors returned by the module
1122 * @return array in the format of array( key, param1, param2, ... ) or array( 'code' => ..., 'info' => ... )
1124 public function getPossibleErrors() {
1127 $params = $this->getFinalParams();
1129 foreach ( $params as $paramName => $paramSettings ) {
1130 if( isset( $paramSettings[ApiBase
::PARAM_REQUIRED
] ) ) {
1131 $ret[] = array( 'missingparam', $paramName );
1136 if ( $this->mustBePosted() ) {
1137 $ret[] = array( 'mustbeposted', $this->getModuleName() );
1140 if ( $this->isReadMode() ) {
1141 $ret[] = array( 'readrequired' );
1144 if ( $this->isWriteMode() ) {
1145 $ret[] = array( 'writerequired' );
1146 $ret[] = array( 'writedisabled' );
1149 if ( $this->getTokenSalt() !== false ) {
1150 $ret[] = array( 'missingparam', 'token' );
1151 $ret[] = array( 'sessionfailure' );
1158 * Parses a list of errors into a standardised format
1159 * @param $errors array List of errors. Items can be in the for array( key, param1, param2, ... ) or array( 'code' => ..., 'info' => ... )
1160 * @return array Parsed list of errors with items in the form array( 'code' => ..., 'info' => ... )
1162 public function parseErrors( $errors ) {
1165 foreach ( $errors as $row ) {
1166 if ( isset( $row['code'] ) && isset( $row['info'] ) ) {
1169 $ret[] = $this->parseMsg( $row );
1176 * Profiling: total module execution time
1178 private $mTimeIn = 0, $mModuleTime = 0;
1181 * Start module profiling
1183 public function profileIn() {
1184 if ( $this->mTimeIn
!== 0 ) {
1185 ApiBase
::dieDebug( __METHOD__
, 'called twice without calling profileOut()' );
1187 $this->mTimeIn
= microtime( true );
1188 wfProfileIn( $this->getModuleProfileName() );
1192 * End module profiling
1194 public function profileOut() {
1195 if ( $this->mTimeIn
=== 0 ) {
1196 ApiBase
::dieDebug( __METHOD__
, 'called without calling profileIn() first' );
1198 if ( $this->mDBTimeIn
!== 0 ) {
1199 ApiBase
::dieDebug( __METHOD__
, 'must be called after database profiling is done with profileDBOut()' );
1202 $this->mModuleTime +
= microtime( true ) - $this->mTimeIn
;
1204 wfProfileOut( $this->getModuleProfileName() );
1208 * When modules crash, sometimes it is needed to do a profileOut() regardless
1209 * of the profiling state the module was in. This method does such cleanup.
1211 public function safeProfileOut() {
1212 if ( $this->mTimeIn
!== 0 ) {
1213 if ( $this->mDBTimeIn
!== 0 ) {
1214 $this->profileDBOut();
1216 $this->profileOut();
1221 * Total time the module was executed
1224 public function getProfileTime() {
1225 if ( $this->mTimeIn
!== 0 ) {
1226 ApiBase
::dieDebug( __METHOD__
, 'called without calling profileOut() first' );
1228 return $this->mModuleTime
;
1232 * Profiling: database execution time
1234 private $mDBTimeIn = 0, $mDBTime = 0;
1237 * Start module profiling
1239 public function profileDBIn() {
1240 if ( $this->mTimeIn
=== 0 ) {
1241 ApiBase
::dieDebug( __METHOD__
, 'must be called while profiling the entire module with profileIn()' );
1243 if ( $this->mDBTimeIn
!== 0 ) {
1244 ApiBase
::dieDebug( __METHOD__
, 'called twice without calling profileDBOut()' );
1246 $this->mDBTimeIn
= microtime( true );
1247 wfProfileIn( $this->getModuleProfileName( true ) );
1251 * End database profiling
1253 public function profileDBOut() {
1254 if ( $this->mTimeIn
=== 0 ) {
1255 ApiBase
::dieDebug( __METHOD__
, 'must be called while profiling the entire module with profileIn()' );
1257 if ( $this->mDBTimeIn
=== 0 ) {
1258 ApiBase
::dieDebug( __METHOD__
, 'called without calling profileDBIn() first' );
1261 $time = microtime( true ) - $this->mDBTimeIn
;
1262 $this->mDBTimeIn
= 0;
1264 $this->mDBTime +
= $time;
1265 $this->getMain()->mDBTime +
= $time;
1266 wfProfileOut( $this->getModuleProfileName( true ) );
1270 * Total time the module used the database
1273 public function getProfileDBTime() {
1274 if ( $this->mDBTimeIn
!== 0 ) {
1275 ApiBase
::dieDebug( __METHOD__
, 'called without calling profileDBOut() first' );
1277 return $this->mDBTime
;
1281 * Debugging function that prints a value and an optional backtrace
1282 * @param $value mixed Value to print
1283 * @param $name string Description of the printed value
1284 * @param $backtrace bool If true, print a backtrace
1286 public static function debugPrint( $value, $name = 'unknown', $backtrace = false ) {
1287 print "\n\n<pre><b>Debugging value '$name':</b>\n\n";
1288 var_export( $value );
1290 print "\n" . wfBacktrace();
1296 * Returns a string that identifies the version of this class.
1299 public static function getBaseVersion() {
1300 return __CLASS__
. ': $Id$';